onvif
    Preparing search index...

    Interface DoorControl

    DoorControl service

    import { Onvif } from 'onvif';

    const onvif = new Onvif({ hostname: '192.168.1.13', username: 'admin', password: 'admin' });
    await onvif.connect();

    const caps = await onvif.doorControl.getServiceCapabilities();
    const list = await onvif.doorControl.getDoorList();
    const token = list.door![0].token;
    console.log(caps, await onvif.doorControl.getDoorInfo({ token: [token] }));

    console.log((await onvif.doorControl.getDoorState({ token })).doorMode);
    await onvif.doorControl.unlockDoor({ token });
    await new Promise((r) => setTimeout(r, 2000));
    await onvif.doorControl.lockDoor({ token });
    console.log((await onvif.doorControl.getDoorState({ token })).doorMode);
    interface DoorControl {
        onvif: Onvif;
        service: keyof OnvifServices;
        xmlns: string;
        accessDoor(options: AccessDoor): Promise<void>;
        blockDoor(options: BlockDoor): Promise<void>;
        createDoor(options: CreateDoor): Promise<string>;
        deleteDoor(options: DeleteDoor): Promise<void>;
        doubleLockDoor(options: DoubleLockDoor): Promise<void>;
        getDoorInfo(options: GetDoorInfo): Promise<DoorInfo[]>;
        getDoorInfoList(
            options?: GetDoorInfoList,
        ): Promise<GetDoorInfoListResponse>;
        getDoorList(options?: GetDoorList): Promise<GetDoorListResponse>;
        getDoors(options: GetDoors): Promise<Door[]>;
        getDoorState(options: GetDoorState): Promise<DoorState>;
        getServiceCapabilities(): Promise<Capabilities>;
        lockDoor(options: LockDoor): Promise<void>;
        lockDownDoor(options: LockDownDoor): Promise<void>;
        lockDownReleaseDoor(options: LockDownReleaseDoor): Promise<void>;
        lockOpenDoor(options: LockOpenDoor): Promise<void>;
        lockOpenReleaseDoor(options: LockOpenReleaseDoor): Promise<void>;
        modifyDoor(options: ModifyDoor): Promise<void>;
        request<T = any>(
            body: OnvifSoapBody,
            options?: LineraseOptions,
        ): Promise<T>;
        setDoor(options: SetDoor): Promise<void>;
        unlockDoor(options: UnlockDoor): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    onvif service xmlns
    accessDoor blockDoor createDoor deleteDoor doubleLockDoor getDoorInfo getDoorInfoList getDoorList getDoors getDoorState getServiceCapabilities lockDoor lockDownDoor lockDownReleaseDoor lockOpenDoor lockOpenReleaseDoor modifyDoor request setDoor unlockDoor
    onvif: Onvif
    service: keyof OnvifServices
    xmlns: string

    • Creates or replaces a door (requires ClientSuppliedTokenSupported).

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods