ServiceCapabilities structure reflects optional functionality of a service.
The information is static and does not change during device operation.
The following capabilities are available:
The maximum number of entries returned by a single Get<Entity>List or
Get<Entity> request. The device shall never return more than this number of entities
in a single response.
Indicates the maximum number of doors supported by the device.
Indicates that the client is allowed to supply the token when creating doors.
To enable the use of the command SetDoor, the value must be set to true.
Indicates that the client can perform CRUD operations (create, read, update and delete)
on doors. To enable the use of the commands GetDoors, GetDoorList, CreateDoor, ModifyDoor
and DeleteDoor, the value must be set to true.
Used as extension base.
A user readable name. It shall be up to 64 characters.
A user readable description. It shall be up to 1024 characters.
The DoorInfo type represents the Door as a physical object.
The structure contains information and capabilities of a specific door instance.
An ONVIF compliant device shall provide the following fields for each Door instance:
The capabilities of the Door.
The door structure shall include all properties of the DoorInfo structure and also a timings
structure.
The capabilities of the Door.
The type of door. Is of type text. Can be either one of the following reserved
ONVIF types: "pt:Door", "pt:ManTrap", "pt:Turnstile", "pt:RevolvingDoor",
"pt:Barrier", or a custom defined type.
A structure defining times such as how long the door is unlocked when
accessed, extended grant time, etc.
A structure defining times such as how long the door is unlocked when accessed,
extended grant time, etc.
When access is granted (door mode becomes Accessed), the latch is unlocked.
ReleaseTime is the time from when the latch is unlocked until it is
relocked again (unless the door is physically opened).
The time from when the door is physically opened until the door is set in the
DoorOpenTooLong alarm state.
Some individuals need extra time to open the door before the latch relocks.
If supported, ExtendedReleaseTime shall be added to ReleaseTime if UseExtendedTime
is set to true in the AccessDoor command.
If the door is physically opened after access is granted,
then DelayTimeBeforeRelock is the time from when the door is physically
opened until the latch goes back to locked state.
Some individuals need extra time to pass through the door. If supported,
ExtendedOpenTime shall be added to OpenTime if UseExtendedTime is set to true
in the AccessDoor command.
Before a DoorOpenTooLong alarm state is generated, a signal will sound to indicate
that the door must be closed. PreAlarmTime defines how long before DoorOpenTooLong
the warning signal shall sound.
DoorCapabilities reflect optional functionality of a particular physical entity.
Different door instances may have different set of capabilities.
This information may change during device operation, e.g. if hardware settings are changed.
The following capabilities are available:
Indicates whether or not this Door instance supports AccessDoor command to
perform momentary access.
Indicates that this Door instance supports overriding configured timing in the
AccessDoor command.
Indicates that this Door instance supports LockDoor command to lock the
door.
Indicates that this Door instance supports UnlockDoor command to unlock the
door.
Indicates that this Door instance supports BlockDoor command to block the
door.
Indicates that this Door instance supports DoubleLockDoor command to lock
multiple locks on the door.
Indicates that this Door instance supports LockDown (and LockDownRelease)
commands to lock the door and put it in LockedDown mode.
Indicates that this Door instance supports LockOpen (and LockOpenRelease)
commands to unlock the door and put it in LockedOpen mode.
Indicates that this Door instance has a DoorMonitor and supports the
DoorPhysicalState event.
Indicates that this Door instance has a LockMonitor and supports the
LockPhysicalState event.
Indicates that this Door instance has a DoubleLockMonitor and supports the
DoubleLockPhysicalState event.
Indicates that this Door instance supports door alarm and the DoorAlarm
event.
Indicates that this Door instance has a Tamper detector and supports the
DoorTamper event.
Indicates that this Door instance supports door fault and the DoorFault
event.
The DoorState structure contains current aggregate runtime status of Door.
Physical state of the Door; it is of type DoorPhysicalState. A device that
signals support for DoorMonitor capability for a particular door instance shall provide
this field.
Physical state of the Lock; it is of type LockPhysicalState. A device that
signals support for LockMonitor capability for a particular door instance shall provide
this field.
Physical state of the DoubleLock; it is of type LockPhysicalState. A
device that signals support for DoubleLockMonitor capability for a particular door
instance shall provide this field.
Alarm state of the door; it is of type DoorAlarmState. A device that
signals support for Alarm capability for a particular door instance shall provide this
field.
Tampering state of the door; it is of type DoorTamper. A device that
signals support for Tamper capability for a particular door instance shall provide this
field.
Fault information for door; it is of type DoorFault. A device that signals
support for Fault capability for a particular door instance shall provide this field.
The logical operating mode of the door; it is of type DoorMode. An ONVIF
compatible device shall report current operating mode in this field.
The physical state of a Door.
Value is currently unknown (possibly due to initialization or monitors not
giving a conclusive result).
Door is open.
Door is closed.
Door monitor fault is detected.
The physical state of a Lock (including Double Lock).
Value is currently not known.
Lock is activated.
Lock is not activated.
Lock fault is detected.
Describes the state of a Door with regard to alarms.
No alarm.
Door is forced open.
Door is held open too long.
Tampering information for a Door.
Optional field; Details describing tampering state change (e.g., reason,
place and time).
NOTE: All fields (including this one) which are designed to give
end-user prompts can be localized to the customer's native language.
State of the tamper detector; it is of type DoorTamperState.
Describes the state of a Tamper detector.
Value is currently not known.
No tampering is detected.
Tampering is detected.
Fault information for a Door.
This can be extended with optional attributes in the future.
Optional reason for fault.
Overall fault state for the door; it is of type DoorFaultState. If there
are any faults, the value shall be: FaultDetected. Details of the detected fault shall
be found in the Reason field, and/or the various DoorState fields and/or in extensions
to this structure.
Describes the state of a Door fault.
Fault state is unknown.
No fault is detected.
Fault is detected.
The DoorMode describe the mode of operation from a logical perspective.
Setting a door mode reflects the intent to set a door in a physical state.
The mode of operation is unknown.
The intention is to set the door to a physical locked state.
In this mode the device shall provide momentary access using the AccessDoor
method if supported by the door instance.
The intention is to set the door to a physical unlocked state.
Alarms related to door timing operations such as open too long
or forced open are masked in this mode.
The intention is to momentary set the door to a physical unlocked state.
After a predefined time the device shall revert the door to its previous mode.
Alarms related to timing operations such as door forced open are masked in this mode.
The intention is to set the door to a physical locked state and the
device shall not allow AccessDoor requests, i.e. it is not possible
for the door to go to the accessed mode.
All other requests to change the door mode are allowed.
The intention is to set the door to a physical locked state and the device
shall only allow the LockDownReleaseDoor request.
All other requests to change the door mode are not allowed.
The intention is to set the door to a physical unlocked state and the
device shall only allow the LockOpenReleaseDoor request.
All other requests to change the door mode are not allowed.
The intention is to set the door with multiple locks to a physical double locked state.
If the door does not support double locking the devices shall
treat this as a normal locked mode.
When changing to an unlocked mode from the double locked mode, the physical state
of the door may first go to locked state before unlocking.
Extension for the AccessDoor command.
The capability response message contains the requested DoorControl
service capabilities using a hierarchical XML capability structure.
Maximum number of entries to return. If Limit is omitted or if the
value of Limit is higher than what the device supports, then the device shall
return its maximum amount of entries.
Start returning entries from this start reference. If not specified,
entries shall start from the beginning of the dataset.
StartReference to use in next call to get the following items. If
absent, no more items to get.
List of DoorInfo items.
Tokens of DoorInfo items to get.
List of DoorInfo items.
Maximum number of entries to return. If not specified, less than one
or higher than what the device supports, the number of items is determined by the
device.
Start returning entries from this start reference. If not specified,
entries shall start from the beginning of the dataset.
StartReference to use in next call to get the following items. If
absent, no more items to get.
List of Door items.
Tokens of Door items to get.
List of Door items.
Door item to create
Token of created Door item
The Door item to create or modify
The details of the door
The Token of the door to delete.
Token of the Door instance to get the state for.
The state of the door.
Token of the Door instance to control.
Optional - Indicates that the configured extended time should be
used.
Optional - overrides ReleaseTime if specified.
Optional - overrides OpenTime if specified.
Optional - overrides PreAlarmTime if specified.
Future extension.
Token of the Door instance to control.
Token of the Door instance to control.
Token of the Door instance to control.
Token of the Door instance to control.
Token of the Door instance to control.
Token of the Door instance to control.
Token of the Door instance to control.
Token of the Door instance to control.
This operation returns the capabilities of the service.
An ONVIF compliant device which provides the Door Control service shall implement this method.
This operation requests a list of all DoorInfo items provided by the device.
An ONVIF compliant device that provides Door Control service shall implement
this method.
A call to this method shall return a StartReference when not all data is returned and more data is
available.
The reference shall be valid for retrieving the next set of data.
The number of items returned shall not be greater than Limit parameter.
This operation requests a list of DoorInfo items matching the given tokens.
An ONVIF-compliant device that provides Door Control service shall implement this method.
The device shall ignore tokens it cannot resolve and shall return an empty list
if there are no items matching specified tokens.
If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.
This operation requests a list of all Door items provided by the device.
A call to this method shall return a StartReference when not all data is returned and more data is
available. The reference shall be valid for retrieving the next set of data.
Please refer to section 4.8.3 in [Access Control Service Specification] for more details.
The number of items returned shall not be greater than the Limit parameter.
This operation requests a list of Door items matching the given tokens.
The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items
matching specified tokens. The device shall not return a fault in this case.
If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.
This operation creates the specified door in the device.
The token field of the Door structure shall be empty and the device shall allocate a token for
the door. The allocated token shall be returned in the response.
If the client sends any value in the token field, the device shall return
InvalidArgVal as a generic fault code.
This method is used to synchronize a door in a client with the device.
If a door with the specified token does not exist in the device, the door is created.
If a door with the specified token exists, then the door is modified.
A call to this method takes a door structure as input parameter. The token field of the Door
structure shall not be empty.
A device that signals support for the ClientSuppliedTokenSupported capability shall
implement this command.
If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.
This operation modifies the specified door.
The token of the door to modify is specified in the token field of the Door structure and shall
not be empty. All other fields in the structure shall overwrite the fields in the specified door.
If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.
This operation deletes the specified door.
If it is associated with one or more entities some devices may not be able to delete the door,
and consequently a ReferenceInUse fault shall be generated.
If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.
This operation requests the state of a Door specified by the Token.
A device implementing the Door Control service shall be capable of reporting
the status of a door using a DoorState structure available from the
GetDoorState command.
This operation allows momentarily accessing a Door.
It invokes the functionality typically used when a card holder presents a
card to a card reader at the door and is granted access.
The DoorMode shall change to Accessed state. Please refer to Accessed mode in section [DoorMode] for
more details.
The Door shall remain accessible for the defined time. When the time span
elapses, the DoorMode shall change back to its previous state.
If the request cannot be fulfilled, a Failure fault shall be returned.
Please refer to section [DoorMode] for details about Door Modes restrictions.
A device that signals support for Access capability for a particular Door
instance shall implement this method. A device that signals support for
AccessTimingOverride capability for a particular Door instance shall also
provide optional timing parameters (AccessTime, OpenTooLongTime and
PreAlarmTime) when performing AccessDoor command.
The device shall take the best effort approach for parameters not supported,
it must fallback to preconfigured time or limit the time to the closest
supported time if the specified time is out of range.
This operation allows locking a Door.
The DoorMode shall change to Locked state.
Please refer to Locked mode in section [DoorMode] for more details.
A device that signals support for Lock capability for a particular Door
instance shall implement this method.
If the request cannot be fulfilled, a Failure fault shall be returned.
Please refer to section [DoorMode] for more details about Door Modes restrictions.
This operation allows unlocking a Door.
The DoorMode shall change to Unlocked state.
Please refer to Unlocked mode in section [DoorMode] for more details.
A device that signals support for Unlock capability for a particular Door
instance shall implement this method.
If the request cannot be fulfilled, a Failure fault shall be returned.
Please refer to section [DoorMode] for more details about Door Modes restrictions.
This operation allows blocking a Door and preventing momentary access (AccessDoor command).
The DoorMode shall change to Blocked state.
Please refer to Blocked mode in section [DoorMode] for more details.
A device that signals support for Block capability for a particular Door
instance shall implement this method.
If the request cannot be fulfilled, a Failure fault shall be returned.
Please refer to section [DoorMode] for more details about Door Modes restrictions.
This operation allows locking and preventing other actions until a LockDownRelease command is invoked.
The DoorMode shall change to LockedDown state.
Please refer to LockedDown mode in section [DoorMode] for more details.
The device shall ignore other door control commands until a LockDownRelease command is performed.
A device that signals support for LockDown capability for a particular Door
instance shall implement this method.
If a device supports DoubleLock capability for a particular Door instance,
that operation may be engaged as well.
If the request cannot be fulfilled, a Failure fault shall be returned.
Please refer to section [DoorMode] for more details about Door Modes restrictions.
This operation allows releasing the LockedDown state of a Door.
The DoorMode shall change back to its previous/next state.
It is not defined what the previous/next state shall be, but typically - Locked.
This method shall only succeed if the current DoorMode is LockedDown.
This operation allows unlocking a Door and preventing other actions until LockOpenRelease method is
invoked.
The DoorMode shall change to LockedOpen state.
Please refer to LockedOpen mode in section [DoorMode] for more details.
The device shall ignore other door control commands until a LockOpenRelease command is performed.
A device that signals support for LockOpen capability for a particular Door instance shall implement
this method.
If the request cannot be fulfilled, a Failure fault shall be returned.
Please refer to section [DoorMode] for more details about Door Modes restrictions.
This operation allows releasing the LockedOpen state of a Door.
The DoorMode shall change state from the LockedOpen state back to its previous/next state.
It is not defined what the previous/next state shall be, but typically - Unlocked.
A device that signals support for LockOpen capability for a particular Door instance shall support
this command.
This method shall only succeed if the current DoorMode is LockedOpen.
This operation is used for securely locking a Door.
A call to this method shall change DoorMode state to DoubleLocked.
Please refer to DoubleLocked mode in section [DoorMode] for more details.
A device that signals support for DoubleLock capability for a particular
Door instance shall implement this method. Otherwise this method can be
performed as a standard Lock operation (see [LockDoor command]).
If the door has an extra lock that shall be locked as well.
If the request cannot be fulfilled, a Failure fault shall be returned.
Copyright (c) 2010-2013 by ONVIF: Open Network Video Interface Forum. All rights reserved.