Recordings & Retention

For compliance and privacy you can adjust the recording and retention settings of various (alarm) events.

Set Settings

Topic

Publish to: api_client/<client_name>/<location_id>/<device_id>/retention_policy/set

Payload

{
  "fall": {
    "secondsBefore": 30,
    "secondsAfter": 30,
    "retentionHours": 72
  },
  "helpCall": {
    "secondsBefore": 30,
    "secondsAfter": 30,
    "retentionHours": 72
  },
  "noise": {
    "secondsBefore": 30,
    "secondsAfter": 30,
    "retentionHours": 72
  },
  "outOfBed": {
    "secondsBefore": 30,
    "secondsAfter": 30,
    "retentionHours": 72
  },
  "outOfRoom": {
    "secondsBefore": 30,
    "secondsAfter": 30,
    "retentionHours": 72
  },
  "outOfSeat": {
    "secondsBefore": 30,
    "secondsAfter": 30,
    "retentionHours": 72
  },
  "wandering": {
    "secondsBefore": 30,
    "secondsAfter": 30,
    "retentionHours": 72
  },
  "roomStateChange": {
    "retentionHours": 72
  }
}

• secondsBefore: Number of seconds to record before the event was detected. How much footage is kept in a ringbuffer before and after the event depends on the detection type. All detections allow for at least 10 seconds before the event. If you set the secondsBefore to a value higher than the respective maximum for the detection, the maximum will be used.
• secondsAfter: Number of seconds to record after the event was detected. Not all detections allow for after-event footage. If you set the secondsAfter to a value higher than the respective maximum for the service, the maximum will be used.
• retentionHours: Number of hours to retain the recording. For internal compliance reaons the maximum retention is two years. If you set the retentionHours to a value higher than 17520, the maximum will be used.

Note that roomStateChange does not have secondsBefore nor secondsAfter. Room state changes are not necessarily linked to an alarm or event and are so frequent, that only 15 secons prior to the change are stored.

Get Settings

Topic

Subscribe to: api_client/<client_name>/<location_id>/<device_id>/retention_policy Publish to api_client/<client_name>/<location_id>/<device_id>/retention_policy/get

Playload

Publish an empyt payload.

Response

Not Retained
QoS: 1

See the payload of the “Set Settings” section above. The response will contain the current settings.