Onvif¶
Capabilities¶
Capabilities |
Supported |
Comment |
---|---|---|
Onvif - profile compliance |
||
Door - support SSL |
||
Door controller connection monitoring state |
See documentation |
|
Door - fetch event state |
||
Door - open/close door |
See door control |
|
Door controller - support SSL |
||
Camera controller connection monitoring state |
See documentation |
Overview¶
ONVIF is an open industry interface to create interoperability between IP-based physical security products. The following ONVIF devices are supported :
Physical Access Control System (PACS)
IP cameras
Warning
OnSphere is not officially compliant with the ONVIF protocol (the conformity process was not done see Conformant products to more details).
OnSphere uses a subset of the ONVIF specification as a client. OnSphere cannot configure external devices, so the configuration must be done on the end-device.
Door¶
Connection state monitoring¶
OnSphere publishes the state of the connection in the value associated with the door controller.
State :
True
when the connection is established and validFalse
otherwise
Fetching door events¶
Overview¶
OnSphere has the capabilities of fetching the different state of a door connected to a door controller.
Use-case¶
Fetch people who are denied or allowed to open the door
Detect tampering on door
Usage¶
The state of a door is provided as TEXT
and can take the following value :
State |
Content |
---|---|
Door access granted |
$badge_identifier |
Door access denied |
$badge_identifier |
Door alarm |
NORMAL, DOOR_FORCED_OPEN, DOOR_OPEN_TOO_LONG |
Door mode |
UNKNOWN, LOCKED, UNLOCKED, ACCESSED, BLOCKED, LOCKED_DOWN, LOCKED_OPEN, DOUBLE_LOCKED |
Door physical state |
UNKNOWN, OPEN, CLOSED, FAULT |
Door tamper |
UNKNOWN, NOT_IN_TAMPER, TAMPER_DETECTED |
Controlling door¶
To control a door, the payload must be a TEXT
with the following value :
lock
unlock
open
Use-case¶
Locking a door (ex: closing the building)
Unlocking a door (ex: building is open)
Open the door for a short time
Camera¶
Camera connection monitoring state¶
Use-case¶
Check if a camera is connected
Control PTZ¶
Concept¶
PTZ allows to move a camera from the Onvif controller.
Use-case¶
Move a camera from front-end
Move a camera when an event occurs
Move a camera to a predefined position
Example¶
See example video with PTZ control
Fetch URL of a camera flux¶
Concept¶
Onvif camera allows streaming the video flux at a given URL, OnSphere allows to avoid having to hardcode this value but ask the controller for it.
Examples¶
The state of the camera are provided as TEXT
and can take the following value :
State |
Content |
---|---|
Camera PTZ position |
|
Camera stream url |
$protocol://$user:$pass@$host/$path |
To control a camera, the payload must be a TEXT
with the following :
Control |
Content |
---|---|
Camera PTZ move |
|
Camera PTZ position |
|
Camera PTZ preset |
|
Onvif Compliance¶
Capabilities |
Supported |
Comment |
---|---|---|
Onvif - Officially conformance |
This feature is currently not supported. In case of interest please contact us at info@swissdotnet.ch |
|
Onvif - profile A |
||
Onvif - profile C |
||
Onvif - profile G |
||
Onvif - profile Q |
||
Onvif - profile S |
||
Onvif - profile T |
For more information consult ONVIF profiles or see the Feature overview to consult ONVIF status.
Profile C¶
Name |
ONVIF mandatory status |
OSP Support |
---|---|---|
System settings |
Conditional |
No |
User authentication - Digest Authentication |
Mandatory |
Yes |
User Handling |
Conditional |
Yes |
Query Services and Capabilities |
Mandatory |
No |
Device Discovery |
Conditional |
No |
Network Configuration |
Mandatory |
No |
Event Handling - Pull-point |
Mandatory |
Yes |
Access Control Events - Doors |
Mandatory |
Yes |
External Authorization Events |
Conditional |
No |
Duress Events |
Conditional |
No |
Stored Events - Seek |
Conditional |
No |
System component information - Access points |
Mandatory |
No |
System component information - Doors |
Mandatory |
No |
System component information - Areas |
Mandatory |
No |
Component state - Access points |
Mandatory |
No |
Component state - Doors |
Mandatory |
Yes |
Component state - Areas |
Mandatory |
No |
Door control |
Mandatory |
Yes |
Access control decisions |
Mandatory |
No |
Configuration change notification - Access |
Conditional |
No |
Configuration change notification - Doors |
Conditional |
No |
Configuration change notification - Areas |
Conditional |
No |
Access point control |
Conditional |
Yes |
Profile Q¶
Name |
ONVIF mandatory status |
OSP Support |
---|---|---|
System settings |
Conditional |
No |
User authentication - Digest Authentication |
Mandatory |
Yes |
User Handling |
Conditional |
Yes |
Query Services and Capabilities |
Mandatory |
No |
Device Discovery |
Conditional |
No |
Network Configuration |
Conditional |
No |
Zero configuration |
Conditional |
No |
Firmware Upgrade |
Conditional |
No |
Backup and Restore |
Conditional |
No |
TLS Configuration |
Conditional |
No |
Automatic IP Assignment |
Conditional |
No |
Event Handling - Pull-point |
Mandatory |
Yes |
Standard Monitoring Events for Devices |
Conditional |
No |
Tested devices¶
List of all devices successfully used in our projects with ONVIF protocol. This list is not bullet-proof and does not assure the system is fully compatible with our product.
Doors controller
Model |
Firmware version |
Note |
---|---|---|
Axis A1001 |
1.65.4 |
None |