State

Type: object

State message, defined by [state.json]

No Additional Properties

Type: string

RFC 3339 UTC Timestamp the state 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: object

System State Documentation

No Additional Properties

Type: string

Time from the timestamp field of the last successfully parsed config message (not the timestamp the message was received/processed). Part of the config state sequence


Example:

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

Type: object

A collection of state fields that describes the system operation

No Additional Properties

Type: boolean

Operational status of the device.

Type: string

Last time the system started up.

Type: integer

Number of system restarts

Type: enum (of string)

Operating mode for the device. Default is 'active'.

Must be one of:

  • "initial"
  • "active"
  • "restart"
  • "terminate"
  • "shutdown"

Type: string

The serial number of the physical device


Examples:

"A1B2C3D4"
"00001"

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"

Type: object

A collection of items which can be used to describe version of software running on a device

No Additional Properties
Examples:

"firmware"
"os"
"driver"

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

Property name regular expression: ^[a-z_]+$
Type: string

Type: object
No Additional Properties

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

Property name regular expression: ^[a-z_]+$
Type: string

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

Gateway Documentation

No Additional Properties

Type: object

Each additional property must conform to the following schema

Type: object
No Additional Properties

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

State for discovery

No Additional Properties

Type: string

Generational marker for enumeration

Type: object

Discovery protocol families

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

State for discovery

No Additional Properties

Type: string

Generational marker for reporting discovery

Type: boolean

Indicates if the discovery process is currently active

Type: object

Status information about the discovery operation

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
No Additional Properties

Type: object
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
No Additional Properties

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
No Additional Properties

Type: object
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
No Additional Properties

Type: enum (of string)

Phase for the management of a configuration blob.

Must be one of:

  • "apply"
  • "final"

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 timestamp of the blob generation


Example:

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

Type: object

A set of points reporting telemetry data.

No Additional Properties

Type: string

An identifier which uniquely represents the state, and used by a device avoid race conditions where the incoming config is based off an obsolete state. Additional information on implementation

Must be at most 32 characters long

Type: object

Optional status information about pointset

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

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: string

If specified, indicates a programmed point unit. If empty, means unspecified or matches configured point.

Type: enum (of string)

Optional enumeration indicating the state of the points value.

Must be one of:

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

Type: object

Optional status information about this point, subject to log severity level

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