Event

Type: object

Container object for all event schemas, not directly used.

No Additional Properties

Type: object

Used for system events such as logging. System Event Documentation

No Additional Properties

Type: string

RFC 3339 UTC timestamp the event payload was generated


Example:

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

Type: string

Version of the UDMI schema

Type: string

Original version of schema pre-upgrade

Type: string

Last config received


Example:

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

Type: array

Each item of this array must be:

Type: object
No Additional Properties

Type: string

A human-readable one-line description of the entry


Example:

"Point is not writable"

Type: string

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

Type: string

Type: object
Must match regular expression: ^system\.base\.start$
Type: object
Must match regular expression: ^system\.base\.shutdown$
Type: object
Must match regular expression: ^system\.base\.ready$
Type: object
Must match regular expression: ^system\.config\.receive$
Type: object
Must match regular expression: ^system\.config\.parse$
Type: object
Must match regular expression: ^system\.config\.apply$
Type: object
Must match regular expression: ^system\.network\.connection$
Type: object
Must match regular expression: ^system\.network\.disconnect$
Type: object
Must match regular expression: ^system\.auth\.login$
Type: object
Must match regular expression: ^system\.auth\.logout$
Type: object
Must match regular expression: ^system\.auth\.fail$
Type: object
Must match regular expression: ^pointset\.point\.nominal$
Type: object
Must match regular expression: ^pointset\.point\.applied$
Type: object
Must match regular expression: ^pointset\.point\.updating$
Type: object
Must match regular expression: ^pointset\.point\.overridden$
Type: object
Must match regular expression: ^pointset\.point\.failure$
Type: object
Must match regular expression: ^pointset\.point\.invalid$
Type: object
Must match regular expression: ^localnet\.network$
Type: object
Must match regular expression: ^discovery\.family\.scan$
Type: object
Must match regular expression: ^discovery\.device\.enumerate$
Type: object
Must match regular expression: ^discovery\.point\.describe$
Type: object
Must match regular expression: ^mapping\.device\.apply$
Type: object
Must match regular expression: ^blobset\.blob\.receive$
Type: object
Must match regular expression: ^blobset\.blob\.fetch$
Type: object
Must match regular expression: ^blobset\.blob\.apply$
Type: object
Must match regular expression: ^validation\.device\.receive$
Type: object
Must match regular expression: ^validation\.device\.schema$
Type: object
Must match regular expression: ^validation\.device\.content$
Type: object
Must match regular expression: ^validation\.device\.multiple$
Type: object
Must match regular expression: ^validation\.device\.extra$
Type: object
Must match regular expression: ^validation\.summary\.report$
Type: object
Must match regular expression: ^validation\.feature\.sequence$
Type: object
Must match regular expression: ^validation\.feature\.schema$
Type: object
Must match regular expression: ^validation\.feature\.capability$
Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$

Type: string

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


Example:

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

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

Type: integer

Accumulated count of the number of system event messages sent.

Type: object
No Additional Properties

Type: number

Type: number

Type: number

Type: number

Type: number

Type: object

A set of points reporting telemetry data. Pointset Event Documentation

No Additional Properties

Type: string

RFC 3339 UTC timestamp the telemetry event was generated


Example:

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

Type: string

Version of the UDMI schema

Type: string

Original version of schema pre-upgrade

Type: boolean

Indicates if this is a partial update (only some points may be included)

Type: object

Collection of point names, defining the representative point set for this device.

No Additional Properties

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

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Type: object

Object representation for for a single point

No Additional Properties

Type: object

The specific point data reading


Examples:

24.1
"running"
4

Type: object

Discovery result with implicit enumeration

No Additional Properties

Type: string

RFC 3339 UTC timestamp the discover telemetry event was generated


Example:

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

Type: string

Version of the UDMI schema

Type: string

The event's discovery scan trigger's generation timestamp


Example:

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

Type: object
No Additional Properties

Type: string

A human-readable one-line description of the entry


Example:

"Point is not writable"

Type: string

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

Type: string

Type: object
Must match regular expression: ^system\.base\.start$
Type: object
Must match regular expression: ^system\.base\.shutdown$
Type: object
Must match regular expression: ^system\.base\.ready$
Type: object
Must match regular expression: ^system\.config\.receive$
Type: object
Must match regular expression: ^system\.config\.parse$
Type: object
Must match regular expression: ^system\.config\.apply$
Type: object
Must match regular expression: ^system\.network\.connection$
Type: object
Must match regular expression: ^system\.network\.disconnect$
Type: object
Must match regular expression: ^system\.auth\.login$
Type: object
Must match regular expression: ^system\.auth\.logout$
Type: object
Must match regular expression: ^system\.auth\.fail$
Type: object
Must match regular expression: ^pointset\.point\.nominal$
Type: object
Must match regular expression: ^pointset\.point\.applied$
Type: object
Must match regular expression: ^pointset\.point\.updating$
Type: object
Must match regular expression: ^pointset\.point\.overridden$
Type: object
Must match regular expression: ^pointset\.point\.failure$
Type: object
Must match regular expression: ^pointset\.point\.invalid$
Type: object
Must match regular expression: ^localnet\.network$
Type: object
Must match regular expression: ^discovery\.family\.scan$
Type: object
Must match regular expression: ^discovery\.device\.enumerate$
Type: object
Must match regular expression: ^discovery\.point\.describe$
Type: object
Must match regular expression: ^mapping\.device\.apply$
Type: object
Must match regular expression: ^blobset\.blob\.receive$
Type: object
Must match regular expression: ^blobset\.blob\.fetch$
Type: object
Must match regular expression: ^blobset\.blob\.apply$
Type: object
Must match regular expression: ^validation\.device\.receive$
Type: object
Must match regular expression: ^validation\.device\.schema$
Type: object
Must match regular expression: ^validation\.device\.content$
Type: object
Must match regular expression: ^validation\.device\.multiple$
Type: object
Must match regular expression: ^validation\.device\.extra$
Type: object
Must match regular expression: ^validation\.summary\.report$
Type: object
Must match regular expression: ^validation\.feature\.sequence$
Type: object
Must match regular expression: ^validation\.feature\.schema$
Type: object
Must match regular expression: ^validation\.feature\.capability$
Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$

Type: string

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


Example:

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

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

Type: string

The primary scan discovery address family

Type: string

The primary address of the device (for scan_family)

Type: object

Address family discovery results.

No Additional Properties

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

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Type: object

Discovery information for an individual protocol family.

No Additional Properties

Type: string

Device addr in the namespace of the given family

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

Type: object

Collection of unique data points available for this device.

No Additional Properties

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

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
Type: object

Object representation for for a single point enumeration

No Additional Properties

Type: string

Friendly name for the point, if known

Type: array of string

List of possible enumerated values for the point

Each item of this array must be:

Type: string

Current or default unit for this point

Type: string

Current or default type for this point

Type: string

Reference parameter for this point (e.g. BACnet object)

Type: boolean

Indicates if this point is writable or not

Type: string

Human-readable description of this point

Type: object
No Additional Properties

Type: string

A human-readable one-line description of the entry


Example:

"Point is not writable"

Type: string

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

Type: string

Type: object
Must match regular expression: ^system\.base\.start$
Type: object
Must match regular expression: ^system\.base\.shutdown$
Type: object
Must match regular expression: ^system\.base\.ready$
Type: object
Must match regular expression: ^system\.config\.receive$
Type: object
Must match regular expression: ^system\.config\.parse$
Type: object
Must match regular expression: ^system\.config\.apply$
Type: object
Must match regular expression: ^system\.network\.connection$
Type: object
Must match regular expression: ^system\.network\.disconnect$
Type: object
Must match regular expression: ^system\.auth\.login$
Type: object
Must match regular expression: ^system\.auth\.logout$
Type: object
Must match regular expression: ^system\.auth\.fail$
Type: object
Must match regular expression: ^pointset\.point\.nominal$
Type: object
Must match regular expression: ^pointset\.point\.applied$
Type: object
Must match regular expression: ^pointset\.point\.updating$
Type: object
Must match regular expression: ^pointset\.point\.overridden$
Type: object
Must match regular expression: ^pointset\.point\.failure$
Type: object
Must match regular expression: ^pointset\.point\.invalid$
Type: object
Must match regular expression: ^localnet\.network$
Type: object
Must match regular expression: ^discovery\.family\.scan$
Type: object
Must match regular expression: ^discovery\.device\.enumerate$
Type: object
Must match regular expression: ^discovery\.point\.describe$
Type: object
Must match regular expression: ^mapping\.device\.apply$
Type: object
Must match regular expression: ^blobset\.blob\.receive$
Type: object
Must match regular expression: ^blobset\.blob\.fetch$
Type: object
Must match regular expression: ^blobset\.blob\.apply$
Type: object
Must match regular expression: ^validation\.device\.receive$
Type: object
Must match regular expression: ^validation\.device\.schema$
Type: object
Must match regular expression: ^validation\.device\.content$
Type: object
Must match regular expression: ^validation\.device\.multiple$
Type: object
Must match regular expression: ^validation\.device\.extra$
Type: object
Must match regular expression: ^validation\.summary\.report$
Type: object
Must match regular expression: ^validation\.feature\.sequence$
Type: object
Must match regular expression: ^validation\.feature\.schema$
Type: object
Must match regular expression: ^validation\.feature\.capability$
Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$

Type: string

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


Example:

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

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

Type: object

Arbitrary blob of json associated with this point

Type: object

Enumeration of features supported by this device.

No Additional Properties

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

Property name regular expression: ^[._a-zA-Z]+$
Type: object

Object representation for for a single feature enumeration

No Additional Properties

Type: enum (of string)

Stage of a feature implemenation

Must be one of:

  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"

Type: object
No Additional Properties

Type: string

The serial number of the physical device

Type: object

Arbitrary blob of json associated with this point

Type: object

A collection of fields which describe the physical hardware of the device.

No Additional Properties

Type: string

The manufacturer of the device


Example:

"Google"

Type: string

The model of the device


Examples:

"Pixel 5"
"Pixel 6"
"Pixel 6 Pro"

Type: string

A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations


Examples:

"GF5KQ"
"4215612"

Type: string

Hardware revision of the device


Examples:

"A"
"B"
"1"