Get camera events using WebSocket

To get the camera events using WebSocket, do the following:

Connect to ws://[user_name]:[password]@[IP address]:[port]/[prefix]/events.
Send a JSON command to subscribe to event notification from the specified cameras (see Get list of telemetry devices for specified video source). This subscription allows you to receive all events listed in the table below.
```
{
"include":
["hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", "hosts/Server1/DeviceIpint.6/SourceEndpoint.video:0:0"],
"exclude":[]
}
```
include—subscribe to event notification;
exclude—disable the events notification.

The response will contain the following JSON:

   {
    objecs: [
    {type: "devicestatechanged", name: "hosts/Server1/DeviceIpint.1", state: "signal restored"}
    ]
    }

List of event types and camera states:

Event type	Description	States
devicestatechanged	Camera state	signal restored—connected, signal restored signal lost—signal lost
alert	Alarm	No states
alert_state	Alarm state	processing—the alarm is being processed closed—alarm is processed reaction—alarm is initiated
detector_event	Detection tool triggering	No states
camera_record_state	State of recording to archive	on—the camera is recording to the archive off—the camera isn't linked to the archive gray—the camera is linked to the archive, but isn't recording

Note

If the camera is disabled in Axxon One, no events are received from it using WebSocket, including the signal lost event.

Example of a message:

objects: [{name: "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", state: "signal restored",…},…]
0: {name: "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", state: "signal restored",…}
name: "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0"
state: "signal restored"
type: "devicestatechanged"

Sample request to receive events via Web-Socket:

ws://root:root@localhost/events?schema=proto

Parameter	Description
schema	schema=proto means detailed response

Sample detailed response:

{
    "objects": [
        {
            "body": {
                "@type": "type.googleapis.com/axxonsoft.bl.events.DetectorEvent",
                "details": [
                    {
                        "autoRecognitionResultEx": {
                            "direction": {
                                "value": "Outgoing"
                            },
                            "headlightsStatus": {
                                "value": "Disabled"
                            },
                            "hypotheses": [
                                {
                                    "country": "Denmark",
                                    "ocrQuality": 99,
                                    "plateFull": "CJ97139",
                                    "plateRectangle": {
                                        "h": 0.03703703703703709,
                                        "w": 0.067708333333333315,
                                        "x": 0.31302083333333336,
                                        "y": 0.96296296296296291
                                    },
                                    "plateState": "NA",
                                    "timeBest": "20230623T124816.295000"
                                }
                            ],
                            "plateType": {
                                "value": "EUnitedNations"
                            },
                            "timeBegin": "2023-06-23T12:48:16.295Z",
                            "timeEnd": "2023-06-23T12:48:16.295Z",
                            "vehicleBrand": {
                                "value": "Mercedes Benz"
                            },
                            "vehicleClass": {
                                "value": "Car"
                            },
                            "vehicleColor": {
                                "value": "Gray"
                            },
                            "vehicleModel": {
                                "value": "GLS Klasse"
                            }
                        }
                    },
                    {
                        "autoRecognitionResult": {
                            "direction": "Outgoing",
                            "headlightsStatus": "Disabled",
                            "hypotheses": [
                                {
                                    "country": "Denmark",
                                    "ocrQuality": 99,
                                    "plateFull": "CJ97139",
                                    "plateRectangle": {
                                        "h": 0.03703703703703709,
                                        "w": 0.067708333333333315,
                                        "x": 0.31302083333333336,
                                        "y": 0.96296296296296291
                                    },
                                    "plateState": "NA",
                                    "timeBest": "20230623T124816.295000"
                                }
                            ],
                            "plateType": "EUnitedNations",
                            "timeBegin": "20230623T124816.295000",
                            "timeEnd": "20230623T124816.295000",
                            "vehicleBrand": "Mercedes Benz",
                            "vehicleClass": "Car",
                            "vehicleColor": "Gray",
                            "vehicleModel": "GLS Klasse"
                        }
                    }
                ],
                "detectorDeprecated": "hosts/TEST/AVDetector.1/EventSupplier",
                "detectorExt": {
                    "accessPoint": "hosts/TEST/AVDetector.1/EventSupplier",
                    "friendlyName": "1.\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u0432\u0430\u043d\u0438\u0435 \u043d\u043e\u043c\u0435\u0440\u043e\u0432 \u0430\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u0435\u0439 (RR)"
                },
                "detectorsGroup": [
                    "DG_LPR_DETECTOR"
                ],
                "eventType": "plateRecognized",
                "guid": "d6650759-e89b-43dd-a610-459a6e421ccc",
                "nodeInfo": {
                    "friendlyName": "TEST",
                    "name": "TEST"
                },
                "originDeprecated": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                "originExt": {
                    "accessPoint": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                    "friendlyName": "1.\u041a\u0430\u043c\u0435\u0440\u0430"
                },
                "timestamp": "20230623T124816.295000"
            },
            "eventName": "axxonsoft.bl.events.DetectorEvent",
            "eventType": "ET_DetectorEvent",
            "localization": {
                "text": "\u041a\u0430\u043c\u0435\u0440\u0430 \"1.\u041a\u0430\u043c\u0435\u0440\u0430\". \u0421\u0440\u0430\u0431\u0430\u0442\u044b\u0432\u0430\u043d\u0438\u0435 \u0434\u0435\u0442\u0435\u043a\u0442\u043e\u0440\u0430 \"1.\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u0432\u0430\u043d\u0438\u0435 \u043d\u043e\u043c\u0435\u0440\u043e\u0432 \u0430\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u0435\u0439 (RR)\", \u041d\u043e\u043c\u0435\u0440 \"CJ97139\", \u0441\u0442\u0440\u0430\u043d\u0430 \"Denmark\", \u043a\u043b\u0430\u0441\u0441 \"\u0410\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u044c\", \u0446\u0432\u0435\u0442 \"Gray\", \u043f\u0440\u043e\u0438\u0437\u0432\u043e\u0434\u0438\u0442\u0435\u043b\u044c \"Mercedes Benz\", \u043c\u043e\u0434\u0435\u043b\u044c \"GLS Klasse\", \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0435 \u0444\u0430\u0440 \"\u0412\u044b\u043a\u043b\u044e\u0447\u0435\u043d\u044b\" \u0420\u0430\u0441\u0448\u0438\u0440\u0435\u043d\u043d\u0430\u044f \u0438\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u044f: \u0422\u0438\u043f \u0434\u0435\u0442\u0435\u043a\u0442\u043e\u0440\u0430 = \"\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u043d\u043d\u044b\u0439 \u043d\u043e\u043c\u0435\u0440\""
            },
            "requiredPermissions": {
                "requiredObjectPermissions": [
                    {
                        "accessPoint": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                        "cameraAccess": "CAMERA_ACCESS_ONLY_ARCHIVE"
                    }
                ]
            },
            "subjects": [
                "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                "hosts/TEST/AVDetector.1/EventSupplier"
            ]
        }
    ]
}

Parameter	Description
vehicleBrand	Vehicle manufacturer
vehicleClass	Vehicle class
vehicleColor	Vehicle color
vehicleModel	Vehicle model

Managing the subscription to event notification about changes in camera configuration

Using WebSocket, you can subscribe and unsubscribe to event notification about changes in camera configuration using the track and untrack commands.

Example of subscription to event notification about changes in camera configuration:

{
"track": ["hosts/Server/DeviceIpint.1"]
}

Example of a message after subscription:

{
   "objects" : [
      {
         "name" : "hosts/Server/DeviceIpint.1",
         "type" : "itemstatuschanged"
      }
   ]
}
{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}
{
   "objects" : [
      {
         "name" : "hosts/Server/DeviceIpint.1",
         "type" : "itemstatuschanged"
      }
   ]
}
{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}

where the type parameter will display the itemstatuschanged value when the configuration is changed.

Example of unsubscription to event notification about changes in camera configuration:

{
"untrack": ["hosts/Server/DeviceIpint.1"]
}

Example of a response message:

{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}
{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}

Page tree

Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.

Managing the subscription to event notification about changes in camera configuration