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
Generic human-readable text describing the device
Automatically generated field that contains the hash of file contents.
Must match regular expression:^[0-9a-z]{8}$
Version of schema supported by the device
Information specific to how the device communicates with the cloud.
No Additional PropertiesNot published by devices which publish , appended to message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated
"2019-01-17T14:02:29.364Z"
Version of the UDMI schema
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 key type used for cloud communication.
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[-_a-zA-Z0-9]+$
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 PropertiesProperties the expected physical location of the device.
No Additional PropertiesThe site name according to the site model in which a device is installed in
Must match regular expression:^[A-Z]{2}-[A-Z]{3}-[A-Z0-9]{2,9}$
"US-SFO-XYY"
^[A-Z0-9-]+$
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
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}-[A-Z0-9]{2,9}$
^[A-Z]{2,6}-[0-9]{1,6}$
^[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 device ID of the gateway the device is bound to
Must match regular expression:^[A-Z]{2,6}-[0-9]{1,6}$
"GAT-100"
Protocol family used for connecting to the proxy device
An array of all the device IDs which are bound to the device
^[A-Z]{2,6}-[0-9]{1,6}$
[
"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]+)*$
Used to describe device local network parameters
No Additional PropertiesAll 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 Properties"bacnet"
"modbus"
The address of a device on the 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 enumeration
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
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