How to use Events API

This article provides python samples and instructions on how to create custom events, trigger events, and view events in corresponding database

Instructions

Download python samples related to events API

	File	Modified

No files shared here yet.

Access tokens for cameras can be found on the integrations page of the VXG Cloud One web client.

Creating a Custom Event

Get camera’s access token. (located in integrations page of Cloud One)
From the directory containing the python samples, call cameras_create_custom_event.py to create a custom event.
```
python3 ./cameras_create_custom_event.py -a dfasdfasdfasrwecsdcsdf= -e test
```
Where -a is the camera’s access token and -e is the name of the new event being created.

Enabling Motion Detector Event

From the directory containing the python samples, call cameras_enable_motion_detector.py to enable motion detection events.
```
python3 ./cameras_enable_motion_detector.py -access_token dfasdfasdfasrwecsdcsdf= -enabled true
```
Where enabled is either true or false depending on if you would like to enable or disable motion detection.

How to Start and Stop Recording Events

To begin recording events call cameras_event_processing_events.py with the parameter record_stat=on.
```
python3 ./cameras_event_processing_events.py -access_token sdafasdfasdfasdfasdfasrwecsdcsdf= -ename motion -record_stat on
```
Where access_token is the camera’s access token and ename is the name of the event.
To stop recording events call cameras_event_processing_events.py with the parameter record_stat=off.
```
python3 ./cameras_event_processing_events.py -access_token sdafasdfasdfasdfasdfasrwecsdcsdf= -ename motion -record_stat off
```
Where access_token is the camera’s access token and ename is the name of the event.

How to View Event Records

Call storage_api_get_events.py to view recorded events within a specified time interval.

python3 ./storage_api_get_events.py -access_token sdafasdfasdfasdfasdfasrwecsdcsdf= -start 2022-12-01T08:30:00 -end 2022-12-02T08:30:00 -limit 10

Where access_token is the camera’s access token, start is the beginning of the time interval, end is the end of the time interval, and limit is the maximum number of events to include in response.
Event data is of shape:

{
  'camid': int,
  'id': int, 
  'name': str, 
  'thumb': {
    'height': int, 
    'id': int, 
    'size': int, 
    'time': 'str', 
    'url': str, 
    'width': int
  }, 
  'time': str
}