Skip to content

barrier:mode_change

The barrier:mode_change event is emitted when a barrier's logical operation mode has changed.

The logical operation mode should not be confused with the physical state of the barrier or its locks. For more information, see Section 5.3 in the ONVIF Door Control Service specification.

While the nature of the event is stateful, it is not reset by any other event as the event itself carries the state and there's no natural normal state available.

Event specific attributes

  • Mode (name: mode, type: string:enum, values: unknown|locked|unlocked|accessed|blocked|locked_down|locked_open)

INFO

The blocked, locked_down and locked_open values of the mode attribute are reserved for future use.

Payload example

json
{
    "eventTopic": "barrier",
    "eventCode": "mode_change",
    "eventDescription": "Barrier changed mode",
    "eventOccurred": "2023-09-07T10:18:41+02:00",
    "eventId": "1ee4d572-7b62-6136-86c8-35b55032bfe2",
    "eventData": {
        "barrierId": "6630e036-ee13-11ef-bc15-b33a54d715fa",
        "barrierName": "The barrier name",
        "barrierDescription": "The barrier description",
        "deviceId": "0eeb5774-e88d-11ef-95f8-afbaa9403ab9",
        "deviceName": "The controller name",
        "deviceDescription": "The controller description",
        "siteId": "182140d9-d99c-4dc8-ae14-0071a01d7e98",
        "siteName": "The site name",
        "siteDescription": "The site description",
        "groupId": "cf84e116-ee61-4bd8-b078-3d2fadfcc9ac",
        "groupName": "The alarm group name",
        "groupDescription": "The alarm group description",
        "groupActive": true,
        "groupState": "schedule",
        "mode": "unknown|locked|...", # See above
    }
}

This site is in beta and under active development. Links may break.