Discovery Events

Type: object

Discovery result with implicit discovery

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\.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: ^localnet\.network\.connect$
Type: object
Must match regular expression: ^gateway\.setup\.attach$
Type: object
Must match regular expression: ^gateway\.proxy\.target$
Type: object
Must match regular expression: ^gateway\.proxy\.connect$
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

Type: string

The primary address of the device (for scan_family)

Type: integer

The active or passive series number of this result (matches reported state values)

Type: object

Links to other address families (family and id)

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 a 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

Registry 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]{2,6}-[1-9][0-9]*$
Type: object

Information specific to how the device communicates with the cloud.

No Additional Properties

Type: enum (of string)

Connection type for connecting to cloud

Must be one of:

  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"

Type: enum (of string)

The key type used for cloud communication.

Must be one of:

  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"

Type: boolean

Indicates if the device private key is provided in the site model.

Type: enum (of string)

The resource type of this model

Must be one of:

  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"

Type: object

Information specific to how the device communicates with the cloud.

No Additional Properties

Type: string

Config file to use. Within the config directory in the device's metadata directory

Type: boolean

Type: string

Type: string

Type: enum (of string)

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "ALLOW"
  • "BLOCK"

Type: string

Strigified version of the metadata object, used for internal backend processing

Type: object

If operating on the entire registry, then this manifests as a map of devices not just one device.

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

Property name regular expression: ^[-_a-zA-Z0-9]+$
Type: object

Type: object

Device iot discovery scan results.

No Additional Properties

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

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
Type: object

Information specific to how the device communicates with the cloud.

No Additional Properties

Type: enum (of string)

Connection type for connecting to cloud

Must be one of:

  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"

Type: enum (of string)

The key type used for cloud communication.

Must be one of:

  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"

Type: boolean

Indicates if the device private key is provided in the site model.

Type: enum (of string)

The resource type of this model

Must be one of:

  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"

Type: object

Information specific to how the device communicates with the cloud.

No Additional Properties

Type: string

Config file to use. Within the config directory in the device's metadata directory

Type: boolean

Type: string

Type: string

Type: string

Type: enum (of string)

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "ALLOW"
  • "BLOCK"

Type: string

Strigified version of the metadata object, used for internal backend processing

Type: object

If operating on the entire registry, then this manifests as a map of devices not just one device.

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

Property name regular expression: ^[-_a-zA-Z0-9]+$
Type: object

Type: object

Information about a specific point name of the 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

Information about a specific point name of the device.

No Additional Properties

Type: string

Expected unit configuration for the point

Type: boolean

Indicates if this point is writable (else read-only)

Type: object

Represents the expected baseline value of the point


Example:

22

Type: number

Maximum deviation from baseline_value


Example:

2

Type: enum (of string)

Expected state when baseline_value is set as the set_value for this point the config message

Must be one of:

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

Type: number

Represents the lower bound of the error threshold for a point


Example:

0

Type: number

Represents the upper bound of the error threshold for a point


Example:

100

Type: number

Triggering threshold for partial cov update publishing


Example:

1

Type: string

Mapping for the point to an internal resource (e.g. BACnet object reference)


Examples:

"AI3"
"400070"

Type: array

Tags assosciated with the point

All items must be unique

Each item of this array must be:

Type: object
Must match regular expression: ^[a-z0-9]+$

Examples:

[
    "lighting"
]
[
    "energy",
    "hvac"
]

Type: object

Collection of point references discovered

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 reference discovery

No Additional Properties

Type: string

Point descriptor for this point

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

Type: string

Friendly name for the reference, 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: 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\.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: ^localnet\.network\.connect$
Type: object
Must match regular expression: ^gateway\.setup\.attach$
Type: object
Must match regular expression: ^gateway\.proxy\.target$
Type: object
Must match regular expression: ^gateway\.proxy\.connect$
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

Discovery 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

No Additional Properties

Type: enum (of string)

Stage of a feature implemenation

Must be one of:

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

Type: object

Information specific to how the device communicates with the cloud.

No Additional Properties

Type: enum (of string)

Connection type for connecting to cloud

Must be one of:

  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"

Type: enum (of string)

The key type used for cloud communication.

Must be one of:

  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"

Type: boolean

Indicates if the device private key is provided in the site model.

Type: enum (of string)

The resource type of this model

Must be one of:

  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"

Type: object

Information specific to how the device communicates with the cloud.

No Additional Properties

Type: string

Config file to use. Within the config directory in the device's metadata directory

Type: boolean

Type: string

Type: string

Type: string

Type: string

Type: string

Type: string

Type: enum (of string)

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "ALLOW"
  • "BLOCK"

Type: string

Strigified version of the metadata object, used for internal backend processing

Type: object

If operating on the entire registry, then this manifests as a map of devices not just one device.

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

Property name regular expression: ^[-_a-zA-Z0-9]+$
Type: object

Type: object
No Additional Properties

Type: string

Full textual desctiiption of this device

Type: string

Friendly name of this device

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"