Discovery result with implicit discovery
No Additional PropertiesRFC 3339 UTC timestamp the discover telemetry event was generated
"2019-01-17T14:02:29.364Z"
Version of the UDMI schema
The event's discovery scan trigger's generation timestamp
"2019-01-17T14:02:29.364Z"
A human-readable one-line description of the entry
"Point is not writable"
An optional extensive entry which can include more detail, e.g. a complete program stack-trace
^system\.base\.start$
^system\.base\.shutdown$
^system\.base\.ready$
^system\.config\.receive$
^system\.config\.parse$
^system\.config\.apply$
^system\.auth\.login$
^system\.auth\.logout$
^system\.auth\.fail$
^pointset\.point\.nominal$
^pointset\.point\.applied$
^pointset\.point\.updating$
^pointset\.point\.overridden$
^pointset\.point\.failure$
^pointset\.point\.invalid$
^localnet\.network$
^localnet\.network\.connect$
^gateway\.setup\.attach$
^gateway\.proxy\.target$
^gateway\.proxy\.connect$
^discovery\.family\.scan$
^discovery\.device\.enumerate$
^discovery\.point\.describe$
^mapping\.device\.apply$
^blobset\.blob\.receive$
^blobset\.blob\.fetch$
^blobset\.blob\.apply$
^validation\.device\.receive$
^validation\.device\.schema$
^validation\.device\.content$
^validation\.device\.multiple$
^validation\.device\.extra$
^validation\.summary\.report$
^validation\.feature\.sequence$
^validation\.feature\.schema$
^validation\.feature\.capability$
^device(\.[a-z]+((_[a-z]+))*)+$
FC 3339 UTC timestamp the condition was triggered, or most recently updated
"2018-08-26T21:39:28.364Z"
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
600
The primary address of the device (for scan_family)
The active or passive series number of this result (matches reported state values)
Links to other address families (family and id)
No Additional PropertiesAll 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]+)*$
Discovery information for a protocol family.
No Additional PropertiesDevice addr in the namespace of the given family
Must match regular expression:^[-_.:0-9A-Z]+$
Registry discovery results.
No Additional PropertiesAll 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]*$
Information specific to how the device communicates with the cloud.
No Additional PropertiesFunction version of this request
Connection type for connecting to cloud
The key type used for cloud communication.
Indicates if the device private key is provided in the site model.
The resource type of this model
The device ID of the gateway the device is bound to
Must match regular expression:^[A-Z]{2,6}-[1-9][0-9]*$
"GAT-100"
The type of network
No Additional PropertiesThe address of a device on the fieldbus/local network
"0x414889"
An array of all the device IDs which are bound to the device
^[A-Z]{2,6}-[1-9][0-9]*$
[
"AHU-22"
]
Information specific to how the device communicates with the cloud.
No Additional PropertiesConfig file to use. Within the config directory in the device's metadata directory
Strigified version of the metadata object, used for internal backend processing
If operating on the entire registry, then this contains results for multiple devices (batched operation).
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[-._a-zA-Z0-9]+$
Device iot discovery scan results.
No Additional PropertiesAll 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]*$
Information specific to how the device communicates with the cloud.
No Additional PropertiesFunction version of this request
Connection type for connecting to cloud
The key type used for cloud communication.
Indicates if the device private key is provided in the site model.
The resource type of this model
The device ID of the gateway the device is bound to
Must match regular expression:^[A-Z]{2,6}-[1-9][0-9]*$
"GAT-100"
The type of network
No Additional PropertiesThe address of a device on the fieldbus/local network
"0x414889"
An array of all the device IDs which are bound to the device
^[A-Z]{2,6}-[1-9][0-9]*$
[
"AHU-22"
]
Information specific to how the device communicates with the cloud.
No Additional PropertiesConfig file to use. Within the config directory in the device's metadata directory
Strigified version of the metadata object, used for internal backend processing
If operating on the entire registry, then this contains results for multiple devices (batched operation).
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[-._a-zA-Z0-9]+$
Information about a specific point name of the device.
No Additional PropertiesAll 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]+)*$
Information about a specific point name of the device.
No Additional PropertiesExpected unit configuration for the point
Indicates if this point is writable (else read-only)
Represents the expected baseline value of the point
22
Maximum deviation from baseline_value
2
Expected state when baseline_value is set as the set_value for this point the config message
Represents the lower bound of the error threshold for a point
0
Represents the upper bound of the error threshold for a point
100
Triggering threshold for partial cov update publishing
1
Mapping for the point to an internal resource (e.g. BACnet object reference)
"AI3"
"400070"
Collection of point references discovered
No Additional PropertiesAll property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[-_.:/a-zA-Z0-9]+$
Object representation for for a single point reference discovery
No Additional PropertiesPoint descriptor for this point
Must match regular expression:^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Friendly name for the reference, if known
List of possible enumerated values for the point
Current or default unit for this point
Current or default type for this point
Indicates if this point is writable or not
Human-readable description of this point
A human-readable one-line description of the entry
"Point is not writable"
An optional extensive entry which can include more detail, e.g. a complete program stack-trace
^system\.base\.start$
^system\.base\.shutdown$
^system\.base\.ready$
^system\.config\.receive$
^system\.config\.parse$
^system\.config\.apply$
^system\.auth\.login$
^system\.auth\.logout$
^system\.auth\.fail$
^pointset\.point\.nominal$
^pointset\.point\.applied$
^pointset\.point\.updating$
^pointset\.point\.overridden$
^pointset\.point\.failure$
^pointset\.point\.invalid$
^localnet\.network$
^localnet\.network\.connect$
^gateway\.setup\.attach$
^gateway\.proxy\.target$
^gateway\.proxy\.connect$
^discovery\.family\.scan$
^discovery\.device\.enumerate$
^discovery\.point\.describe$
^mapping\.device\.apply$
^blobset\.blob\.receive$
^blobset\.blob\.fetch$
^blobset\.blob\.apply$
^validation\.device\.receive$
^validation\.device\.schema$
^validation\.device\.content$
^validation\.device\.multiple$
^validation\.device\.extra$
^validation\.summary\.report$
^validation\.feature\.sequence$
^validation\.feature\.schema$
^validation\.feature\.capability$
^device(\.[a-z]+((_[a-z]+))*)+$
FC 3339 UTC timestamp the condition was triggered, or most recently updated
"2018-08-26T21:39:28.364Z"
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
600
Arbitrary blob of json associated with this point
Discovery of features supported by this device.
No Additional PropertiesAll property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[._a-zA-Z]+$
Object representation for for a single feature
No Additional PropertiesStage of a feature implemenation
Information specific to how the device communicates with the cloud.
No Additional PropertiesFunction version of this request
Connection type for connecting to cloud
The key type used for cloud communication.
Indicates if the device private key is provided in the site model.
The resource type of this model
The device ID of the gateway the device is bound to
Must match regular expression:^[A-Z]{2,6}-[1-9][0-9]*$
"GAT-100"
The type of network
No Additional PropertiesThe address of a device on the fieldbus/local network
"0x414889"
An array of all the device IDs which are bound to the device
^[A-Z]{2,6}-[1-9][0-9]*$
[
"AHU-22"
]
Information specific to how the device communicates with the cloud.
No Additional PropertiesConfig file to use. Within the config directory in the device's metadata directory
Strigified version of the metadata object, used for internal backend processing
If operating on the entire registry, then this contains results for multiple devices (batched operation).
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[-._a-zA-Z0-9]+$
Full textual desctiiption of this device
Friendly name of this device
The serial number of the physical device
Arbitrary blob of json associated with this point
A collection of fields which describe the physical hardware of the device.
No Additional PropertiesThe manufacturer of the device
"Google"
The model of the device
"Pixel 5"
"Pixel 6"
"Pixel 6 Pro"
A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations
"GF5KQ"
"4215612"
Hardware revision of the device
"A"
"B"
"1"