Notifs Config

Type: object

Notifs Config Documentation

 No Additional Properties

root timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the configuration was generated
Example:

"2019-01-17T14:02:29.364Z"

root version
Type: string

Version of the UDMI schema

root state_etag
Type: string

The state_etag of the last state message sent by the device. Writeback documentation

Must be at most 32 characters long

root set_value_expiry
Type: stringFormat: date-time

An expiry for the the device to revert to baseline (no set value). Writeback documentation

root sample_limit_sec
Type: integer

Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update.

Value must be greater or equal to 0 and lesser or equal to 86400

root sample_rate_sec
Type: integer Default: 300

Maximum time between samples for the device to send out a complete update. It can send out updates more frequently than this. Default to 300.

Value must be greater or equal to 1 and lesser or equal to 86400

root notifs
Type: object

The notifications defined in this dictionary indicate the configured notification targets for the device. Notifs documentation

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[0-9a-f]{8}$
root notifs Notif Notifs Config

Notif Notifs Config

Type: object
No Additional Properties

root notifs Notif Notifs Config ref
Type: string

Mapping for the notification target to an internal resource (e.g. BACnet object reference)
Example:

"AI1106"

root notifs Notif Notifs Config units
Type: string

If specified, indicates the units the device should report the data in.

root notifs Notif Notifs Config set_value

Used for cloud writeback functionality, this field specifies the value for a given notification target in the device's current units. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer
Example:

22.4

root notifs Notif Notifs Config stop_time
Type: stringFormat: date-time

RFC 3339 timestamp for the specified write easing to stop
Example:

"2019-01-17T14:02:29.364Z"

root notifs Notif Notifs Config cov_increment
Type: number

The CoV (change of value) increment, which when set, enables CoV on the notification target and defines the minimum change before an update is published

Value must be greater or equal to 0