Notifs Model

Type: object

Notifications block representing the abstract system expectation for device notification configuration and operation.

 No Additional Properties

root notifs
Type: object

Information about a specific notification name of the device.

 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 Model

Notif Notifs Model

Type: object

Information about a specific notification target of the device.

 No Additional Properties

root notifs Notif Notifs Model units
Type: string

Expected unit configuration for the notification target

root notifs Notif Notifs Model type
Type: enum (of string)

Expected data type for the notification target

Must be one of:

  • "string"
  • "boolean"
  • "number"

root notifs Notif Notifs Model description
Type: string

Detailed description of this notification target

root notifs Notif Notifs Model writable
Type: boolean

Indicates if this notification target is writable (else read-only)

root notifs Notif Notifs Model baseline_value
Type: object

Represents the expected baseline value of the notification target
Example:

22

root notifs Notif Notifs Model baseline_tolerance
Type: number

Maximum deviation from baseline_value
Example:

2

root notifs Notif Notifs Model baseline_state
Type: enum (of string)

Expected state when baseline_value is set as the set_value in the config message

Must be one of:

  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"

root notifs Notif Notifs Model range_min
Type: number

Represents the lower bound of the error threshold
Example:

0

root notifs Notif Notifs Model range_max
Type: number

Represents the upper bound of the error threshold
Example:

100

root notifs Notif Notifs Model unchanged_limit_sec
Type: integer

Represents the limit in seconds that the target can be unchanged for
Example:

3600

root notifs Notif Notifs Model cov_increment
Type: number

Triggering threshold for partial cov update publishing
Example:

1

root notifs Notif Notifs Model ref
Type: string

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

"AI3"

"400070"

root notifs Notif Notifs Model adjunct
Type: object
No Additional Properties

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

Property name regular expression: ^[a-z_]+$
root notifs Notif Notifs Model adjunct ^[a-z_]+$
Type: string

root notifs Notif Notifs Model tags
Type: array

Tags associated with the notification target

All items must be unique

No Additional Items

Each item of this array must be:

root notifs Notif Notifs Model tags tags items
Type: object
Must match regular expression: ^[a-z0-9]+$

Examples:

[
    "lighting"
]

[
    "energy",
    "hvac"
]

root notifs Notif Notifs Model structure
Type: object

Collection of family notification information

 No Additional Properties

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

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
root notifs Notif Notifs Model structure Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties

root notifs Notif Notifs Model structure Ref Discovery point
Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

root notifs Notif Notifs Model structure Ref Discovery name
Type: string

Friendly name for the reference, if known

root notifs Notif Notifs Model structure Ref Discovery possible_values
Type: array of string

List of possible enumerated values for the point

 No Additional Items

Each item of this array must be:

root notifs Notif Notifs Model structure Ref Discovery possible_values possible_values items
Type: string

root notifs Notif Notifs Model structure Ref Discovery units
Type: string

Current or default unit for this point

root notifs Notif Notifs Model structure Ref Discovery ref
Type: string

Family reference for structures

root notifs Notif Notifs Model structure Ref Discovery type
Type: string

Current or default type for this point

root notifs Notif Notifs Model structure Ref Discovery writable
Type: boolean

Indicates if this point is writable or not

root notifs Notif Notifs Model structure Ref Discovery description
Type: string

Human-readable description of this point

root notifs Notif Notifs Model structure Ref Discovery status

Entry

Type: object
No Additional Properties

root notifs Notif Notifs Model structure Ref Discovery status message
Type: string

A human-readable one-line description of the entry
Example:

"Point is not writable"

root notifs Notif Notifs Model structure Ref Discovery status detail
Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

root notifs Notif Notifs Model structure Ref Discovery status category

Category

Type: string

root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 0
Type: object
Must match regular expression: ^system\.base\.start$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 1
Type: object
Must match regular expression: ^system\.base\.shutdown$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 2
Type: object
Must match regular expression: ^system\.base\.ready$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 3
Type: object
Must match regular expression: ^system\.config\.receive$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 4
Type: object
Must match regular expression: ^system\.config\.parse$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 5
Type: object
Must match regular expression: ^system\.config\.apply$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 6
Type: object
Must match regular expression: ^system\.auth\.login$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 7
Type: object
Must match regular expression: ^system\.auth\.logout$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 8
Type: object
Must match regular expression: ^system\.auth\.fail$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 9
Type: object
Must match regular expression: ^pointset\.point\.nominal$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 10
Type: object
Must match regular expression: ^pointset\.point\.applied$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 11
Type: object
Must match regular expression: ^pointset\.point\.updating$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 12
Type: object
Must match regular expression: ^pointset\.point\.overridden$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 13
Type: object
Must match regular expression: ^pointset\.point\.failure$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 14
Type: object
Must match regular expression: ^pointset\.point\.invalid$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 15
Type: object
Must match regular expression: ^localnet\.network$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 16
Type: object
Must match regular expression: ^localnet\.network\.connect$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 17
Type: object
Must match regular expression: ^gateway\.setup\.attach$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 18
Type: object
Must match regular expression: ^gateway\.proxy\.target$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 19
Type: object
Must match regular expression: ^gateway\.proxy\.connect$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 20
Type: object
Must match regular expression: ^discovery\.family\.scan$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 21
Type: object
Must match regular expression: ^discovery\.device\.enumerate$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 22
Type: object
Must match regular expression: ^discovery\.point\.describe$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 23
Type: object
Must match regular expression: ^mapping\.device\.apply$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 24
Type: object
Must match regular expression: ^blobset\.blob$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 25
Type: object
Must match regular expression: ^blobset\.blob\.update$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 26
Type: object
Must match regular expression: ^blobset\.blob\.receive$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 27
Type: object
Must match regular expression: ^blobset\.blob\.fetch$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 28
Type: object
Must match regular expression: ^blobset\.blob\.parse$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 29
Type: object
Must match regular expression: ^blobset\.blob\.apply$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 30
Type: object
Must match regular expression: ^blobset\.blob\.abort$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 31
Type: object
Must match regular expression: ^blobset\.blob\.rollback$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 32
Type: object
Must match regular expression: ^validation\.device\.receive$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 33
Type: object
Must match regular expression: ^validation\.device\.schema$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 34
Type: object
Must match regular expression: ^validation\.device\.content$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 35
Type: object
Must match regular expression: ^validation\.device\.multiple$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 36
Type: object
Must match regular expression: ^validation\.device\.extra$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 37
Type: object
Must match regular expression: ^validation\.summary\.report$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 38
Type: object
Must match regular expression: ^validation\.feature\.sequence$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 39
Type: object
Must match regular expression: ^validation\.feature\.schema$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 40
Type: object
Must match regular expression: ^validation\.feature\.capability$
root notifs Notif Notifs Model structure Ref Discovery status category oneOf item 41
Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$

root notifs Notif Notifs Model structure Ref Discovery status timestamp
Type: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated
Example:

"2018-08-26T21:39:28.364Z"

root notifs Notif Notifs Model structure Ref Discovery status level
Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1


Example:

600

root notifs Notif Notifs Model structure Ref Discovery ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

root notifs Notif Notifs Model structure Ref Discovery adjunct
Type: object
No Additional Properties

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

Property name regular expression: ^[a-z_]+$
root notifs Notif Notifs Model structure Ref Discovery adjunct ^[a-z_]+$
Type: string

root notifs Notif Notifs Model structure Ref Discovery structure
Type: object

root notifs Notif Notifs Model structure Ref Discovery structure point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties

root notifs Notif Notifs Model structure Ref Discovery structure point addr
Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Za-z]+$

root notifs Notif Notifs Model structure Ref Discovery structure point port
Type: integer

Port number for the family connection (e.g. UDP port for BACnet/IP)

root notifs Notif Notifs Model structure Ref Discovery structure point ref
Type: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:/#0-9A-Za-z]+$

root notifs Notif Notifs Model structure Ref Discovery structure families
Type: object

Reference links to alternate families

 No Additional Properties

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

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
root notifs Notif Notifs Model structure Ref Discovery structure families Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties

root notifs Notif Notifs Model structure Ref Discovery structure families Family Discovery addr
Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Za-z]+$

root notifs Notif Notifs Model structure Ref Discovery structure families Family Discovery port
Type: integer

Port number for the family connection (e.g. UDP port for BACnet/IP)

root notifs Notif Notifs Model structure Ref Discovery structure families Family Discovery ref
Type: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:/#0-9A-Za-z]+$

root exclude_units_from_config
Type: boolean

root exclude_notifs_from_config
Type: boolean

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

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

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