Page History

Add a recurring event to a schedule

The connector can add a recurring event by sending a CREATE_RECURRING_EVENT command to any schedule in a device.

Prerequisite

You must target:

• an existing Device with a DeviceExt through the deviceId.
• an existing ControlSchedule (BooleanSchedule, EnumSchedule, NumericSchedule or StringSchedule) with a ScheduleExt through the scheduleId.

You must also provide an unique id to the event.

Example

{
  "type": "CREATE_RECURRING_EVENT",
  "deviceId": "Folder_I0Stk9eSboFsjerkRdyA6",
  "scheduleId": "BooleanSchedule_l0StkHQXUQFVrZuej7UiA",
  "payload": {
    "eventId": "MyId",
    "weekday": "monday",
    "startTime": "09:03:48Z",
    "endTime": "10:03:48Z",
    "value": true
  }
}

The way that the different values are extracted from the Json can be changed in the connector advanced config.

EventId

...

Update a recurring event to a schedule

The connector can add a recurring event by sending a UPDATE_RECURRING_EVENT command to any schedule in a device.

Prerequisite

You must target:

• an existing Device with a DeviceExt through the deviceId.
• an existing ControlSchedule (BooleanSchedule, EnumSchedule, NumericSchedule or StringSchedule) with a ScheduleExt through the scheduleId.
• an existing recurrent event through the eventId.

Example

{
  "type": "UPDATE_RECURRING_EVENT",
  "deviceId": "Folder_I0Stk9eSboFsjerkRdyA6",
  "scheduleId": "BooleanSchedule_l0StkHQXUQFVrZuej7UiA",
  "eventId": "MyId"
  "payload": {
    "weekday": "monday",
    "startTime": "09:03:48Z",
    "endTime": "10:03:48Z",
    "value": true
  }
}

The way that the different values are extracted from the Json can be changed in the connector advanced config.

Delete a recurring event

The connector can add a special event by sending a DELETE_RECURRING_EVENT command to any schedule in a device.

Prerequisite

You must target:

• an existing Device with a DeviceExt through the deviceId.
• an existing ControlSchedule (BooleanSchedule, EnumSchedule, NumericSchedule or StringSchedule) with a ScheduleExt through the scheduleId.
• an existing recurring event through the eventId.

Example

{
  "type": "DELETE_RECURRING_EVENT",
  "deviceId": "Folder_I0Stk9eSboFsjerkRdyA6",
  "scheduleId": "BooleanSchedule_l0StkHQXUQFVrZuej7UiA",
  "eventId": "MyId"
}

The way that the different values are extracted from the Json can be changed in the connector advanced config.

Add a special event to a schedule

The connector can add a special event by sending a CREATE_SPECIAL_EVENT command to any schedule in a device.

Prerequisite

You must target:

• an existing Device with a DeviceExt through the deviceId.
• an existing ControlSchedule (BooleanSchedule, EnumSchedule, NumericSchedule or StringSchedule) with a ScheduleExt through the scheduleId.

You must also provide an unique id to the event.

Example

{
  "type": "CREATE_SPECIAL_EVENT",
  "deviceId": "Folder_I0Stk9eSboFsjerkRdyA6",
  "scheduleId": "BooleanSchedule_l0StkHQXUQFVrZuej7UiA",
  "payload": {
    "eventId": "MyId",
    "eventName": "MyEvent",
    "startDate": "2022-01-07T09:03:48Z",
    "endDate": "2022-01-07T10:03:48Z",
    "value": true
  }
}

The way that the different values are extracted from the Json can be changed in the connector advanced config.

EventId

...

Update a special event 

The connector can update a special event by sending a UPDATE_SPECIAL_EVENT command to any schedule in a device.

Prerequisite

You must target:

• an existing Device with a DeviceExt through the deviceId.
• an existing ControlSchedule (BooleanSchedule, EnumSchedule, NumericSchedule or StringSchedule) with a ScheduleExt through the scheduleId.
• an existing time slot in a special event through the eventId.

Example

{
  "type": "UPDATE_SPECIAL_EVENT",
  "deviceId": "Folder_I0Stk9eSboFsjerkRdyA6",
  "scheduleId": "BooleanSchedule_l0StkHQXUQFVrZuej7UiA",
  "eventId": "MyId"
  "payload": {
    "startTime": "09:03:48Z",
    "endTime": "10:03:48Z",
    "value": true
  }
}

The way that the different values are extracted from the Json can be changed in the connector advanced config.

Delete a special event to a schedule

The connector can add a recurring event by sending a DELETE_SPECIAL_EVENT command to any schedule in a device.

Prerequisite

You must target:

• an existing Device with a DeviceExt through the deviceId.
• an existing ControlSchedule (BooleanSchedule, EnumSchedule, NumericSchedule or StringSchedule) with a ScheduleExt through the scheduleId.
• an existing time slot in a special event through the eventId.

Example

{
  "type": "DELETE_SPECIAL_EVENT",
  "deviceId": "Folder_I0Stk9eSboFsjerkRdyA6",
  "scheduleId": "BooleanSchedule_l0StkHQXUQFVrZuej7UiA",   
  "eventId": "MyId" 
}

The way that the different values are extracted from the Json can be changed in the connector advanced config.