Shinobi
Documentation

Scheduling for Monitors

Scheduling for Monitors allows you to manage multiple monitor's settings together based on time. This feature works in conjunction with Monitor States

http://xxx.xxx.xxx.xxx/[API KEY]/schedule/[GROUP KEY]
http://xxx.xxx.xxx.xxx/[API KEY]/schedule/[GROUP KEY]/[SCHEDULE_NAME]

The data query string needs to contain the start, end, enabled, and monitorsStates array. Running an Insert action will modify any existing with the same name.

Example of data form structure can be seen below

{
   "start": "[HH:mm]",
   "end": "[HH:mm]",
   "details": {
      "monitorStates": [
         "[PRESET_NAME]",
         "[PRESET_NAME]",
         "[PRESET_NAME]"
      ]
   },
   "enabled": 1
}

Here is an example of a Schedule that starts at 10:00 AM and ends at 9:00 PM. It will activate a Monitor State Preset named detectorsOn. With the enabled variable set to 1, which means yes.

{
   "start": "10:00",
   "end": "21:00",
   "details": {
      "monitorStates": [
         "detectorsOn"
      ]
   },
   "enabled": 1
}
http://xxx.xxx.xxx.xxx/[API KEY]/schedule/[GROUP KEY]/[SCHEDULE_NAME]/insert?data={...}

Deleting a Schedule does not revert the changes of a schedule that has already activated.

http://xxx.xxx.xxx.xxx/[API KEY]/schedule/[GROUP KEY]/[SCHEDULE_NAME]/delete

ShinobiDocs

All content is property of their respective owners.