Metadata is a description about the device: a specification about how the device should be configured and expectations about what the device should be doing. Defined by metadata.json
RFC 3339 timestamp UTC the data was generated
"2019-01-17T14:02:29.364Z"
Version of the UDMI schema for this file
Original version of the UDMI schema for this file
Automatically generated field that contains the hash of file contents.
Must match regular expression:^[0-9a-z]{8}$
Information specific to how the device communicates with the cloud.
No Additional PropertiesConnection 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
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 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]+$
High-level system information about the device. System Model Documentation
No Additional PropertiesFriendly name describing this device
Generic human-readable text describing the device
Version of schema supported by the device
"1.5.0"
Aggregation of spaces, partial spaces or other zones that the device is serving
Must match regular expression:^[-_a-zA-Z0-9]+$
"Zone1"
"Kitchen_101"
Properties of the expected physical location of the device
No Additional PropertiesThe site name according to the site model in which the device is installed in
Must match regular expression:^[A-Z]{2}-[A-Z]{3,4}-[A-Z0-9]{2,9}$
"US-SFO-XYY"
The reference of the panel where the device is installed in
Must match regular expression:^[-_a-zA-Z0-9]+$
"Panel123"
"CTRP-567"
^[A-Z0-9-]+$
^[-_a-zA-Z0-9]+$
Name of floor level
Must match regular expression:^[A-Z0-9-]+$
"1"
"1A"
"G"
"B1M"
"RF"
Sequential integer representation for a floor, primarily for comparisons when non integer floors are used, e.g. 1 and 1M
The x coordinate of the device location in a project specific coordinate system
The y coordinate of the device location in a project specific coordinate system
The z (height) coordinate of the device location in a project specific coordinate system
The latitude coordinate of the device in the WGS84 coordinate system
The longitude coordinate of the device in the WGS84 coordinate system
The altitude coordinate of the device in meters
The serial number of the physical device
"A1B2C3D4"
"00001"
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"
A collection of items which can be used to describe version of software running on a device
No Additional Properties"firmware"
"os"
"driver"
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[a-z_]+$
Information used to print a physical QR code label.
No Additional Properties^[a-z]+://[-0-9a-zA-Z_$]+$
^[A-Z]{2}-[A-Z]{3,4}-[A-Z0-9]{2,9}$
^[A-Z]{2,6}-[1-9][0-9]*$
^[a-zA-Z0-9-]+$
The minimum loglevel for reporting log messages below which log entries should not be sent. Default to 300.
Value must be greater or equal to 100 and lesser or equal to 800
The rate at which the system should send system event updates. 0 indicates no updates.
Value must be greater or equal to 0 and lesser or equal to 86400
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"
]
Discovery target parameters
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]+)*$
Generational marker for controlling discovery
"2018-08-26T21:00:13Z"
Period, in seconds, for automatic scanning
Value must be greater or equal to 0
Scan duration, in seconds
Value must be greater or equal to 0
Used to describe device local network parameters
No Additional PropertiesParent device to which the device is physically connected
No Additional PropertiesID of the parent device to which the device is physically connected
Must match regular expression:^[A-Z]{2,6}-[1-9][0-9]*$
"DDC-1"
"CGW-2"
Connection family/protocol of the parent device to which the device is physically connected
"bacnet_mstp"
"modbus_tcp"
"mqtt"
"bacnet"
"modbus"
"ether"
"ipv4"
"iot"
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[a-z0-9-]+$
The type of network
No Additional PropertiesThe address of a device on the fieldbus/local network
"0x414889"
Testing target parameters
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]+)*$
Point name used for testing
Value used for testing
Model of supported features
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
Pointset representing the abstract system expectation for what the device should be doing, and how it should be configured and operated. This block specifies the expected points that a device holds
No Additional PropertiesInformation 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"
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
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
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]+)*$
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 PropertiesConnection 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
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 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]+$
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 PropertiesConnection 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
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 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]+$
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 PropertiesConnection 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
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 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]+$
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"