Metadata

Type: object

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

 No Additional Properties

root timestamp
Type: string

RFC 3339 timestamp UTC the data was generated
Example:

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

root version
Type: string

Version of the UDMI schema for this file

root upgraded_from
Type: string

Original version of the UDMI schema for this file

root hash
Type: string

Automatically generated field that contains the hash of file contents.

Must match regular expression: ^[0-9a-z]{8}$

root cloud
Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties

root cloud connection_type
Type: enum (of string)

Connection type for connecting to cloud

Must be one of:

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

root cloud auth_type
Type: enum (of string)

The key type used for cloud communication.

Must be one of:

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

root cloud device_key
Type: boolean

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

root cloud resource_type
Type: enum (of string)

The resource type of this model

Must be one of:

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

root cloud config
Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties

root cloud config static_file
Type: string

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

root cloud blocked
Type: boolean

root cloud detail
Type: string

root cloud updated_time
Type: string

root cloud last_state_time
Type: string

root cloud last_config_time
Type: string

root cloud last_error_time
Type: string

root cloud num_id
Type: string

root cloud operation
Type: enum (of string)

Must be one of:

  • "ERROR"
  • "FETCH"
  • "CREATE"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "BIND"
  • "ALLOW"
  • "BLOCK"

root cloud metadata_str
Type: string

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

root cloud device_ids
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]+$
root cloud device_ids ^[-_a-zA-Z0-9]+$
Type: object

root system
Type: object

High-level system information about the device. System Model Documentation

 No Additional Properties

root system description
Type: string

Generic human-readable text describing the device

root system device_version
Type: string

Version of schema supported by the device
Example:

"1.5.0"

root system zone
Type: string

Aggregation of spaces, partial spaces or other zones that the device is serving

Must match regular expression: ^[-_a-zA-Z0-9]+$
Examples:

"Zone1"

"Kitchen_101"

root system tags
Type: array

Tags associated with the device

All items must be unique

Each item of this array must be:

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

Examples:

[
    "lighting"
]

[
    "energy",
    "building"
]

root system location
Type: object

Properties of the expected physical location of the device

 No Additional Properties

root system location site
Type: string

The 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}$
Example:

"US-SFO-XYY"

root system location panel
Type: string

The reference of the panel where the device is installed in

Must match regular expression: ^[-_a-zA-Z0-9]+$
Examples:

"Panel123"

"CTRP-567"

root system location section
Type: string
Must match regular expression: ^[A-Z0-9-]+$

root system location room
Type: string
Must match regular expression: ^[-_a-zA-Z0-9]+$

root system location floor
Type: string

Name of floor level

Must match regular expression: ^[A-Z0-9-]+$
Examples:

"1"

"1A"

"G"

"B1M"

"RF"

root system location floor_seq
Type: integer

Sequential integer representation for a floor, primarily for comparisons when non integer floors are used, e.g. 1 and 1M

root system location position
Type: object
No Additional Properties

root system location position x
Type: number

The x coordinate of the device location in a project specific coordinate system

root system location position y
Type: number

The y coordinate of the device location in a project specific coordinate system

root system location position z
Type: number

The z (height) coordinate of the device location in a project specific coordinate system

root system location coordinates
Type: object
No Additional Properties

root system location coordinates lat
Type: number

The latitude coordinate of the device in the WGS84 coordinate system

root system location coordinates long
Type: number

The longitude coordinate of the device in the WGS84 coordinate system

root system location coordinates alt_m
Type: number

The altitude coordinate of the device in meters

root system serial_no
Type: string

The serial number of the physical device
Examples:

"A1B2C3D4"

"00001"

root system hardware
Type: object

A collection of fields which describe the physical hardware of the device.

 No Additional Properties

root system hardware make
Type: string

The manufacturer of the device
Example:

"Google"

root system hardware model
Type: string

The model of the device
Examples:

"Pixel 5"

"Pixel 6"

"Pixel 6 Pro"

root system hardware sku
Type: string

A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations
Examples:

"GF5KQ"

"4215612"

root system hardware rev
Type: string

Hardware revision of the device
Examples:

"A"

"B"

"1"

root system software
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_]+$
root system software ^[a-z_]+$
Type: string

root system physical_tag
Type: object

Information used to print a physical QR code label.

 No Additional Properties

root system physical_tag asset
Type: object
No Additional Properties

root system physical_tag asset guid
Type: string
Must match regular expression: ^[a-z]+://[-0-9a-zA-Z_$]+$

root system physical_tag asset site
Type: string
Must match regular expression: ^[A-Z]{2}-[A-Z]{3,4}-[A-Z0-9]{2,9}$

root system physical_tag asset name
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$

root system adjunct
Type: object
No Additional Properties

root system adjunct suffix
Type: string
Must match regular expression: ^[a-zA-Z0-9-]+$

root system min_loglevel
Type: integer Default: 300

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

root system metrics_rate_sec
Type: integer

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

root gateway
Type: object

Gateway Documentation

 No Additional Properties

root gateway gateway_id
Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
Example:

"GAT-100"

root gateway target
Type: object

The type of network

 No Additional Properties

root gateway target addr
Type: string

The address of a device on the fieldbus/local network
Example:

"0x414889"

root gateway target family
Type: string

root gateway proxy_ids
Type: array of string

An array of all the device IDs which are bound to the device

Each item of this array must be:

root gateway proxy_ids proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$

Example:

[
    "AHU-22"
]

root discovery
Type: object

Discovery target parameters

 No Additional Properties

root discovery families
Type: object

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]+)*$
root discovery families model_discovery_family.json#
Type: object

root localnet
Type: object

Used to describe device local network parameters

 No Additional Properties

root localnet parent
Type: object

Parent device to which the device is physically connected

 No Additional Properties

root localnet parent target
Type: string

ID of the parent device to which the device is physically connected

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
Examples:

"DDC-1"

"CGW-2"

root localnet parent family
Type: string

Connection family/protocol of the parent device to which the device is physically connected
Examples:

"bacnet_mstp"

"modbus_tcp"

"mqtt"

root localnet families
Type: object
No Additional Properties
Examples:

"bacnet"

"modbus"

"ether"

"ipv4"

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

Property name regular expression: ^[a-z0-9-]+$
root localnet families model_localnet_family.json
Type: object

The type of network

 No Additional Properties

root localnet families Family Localnet Model addr
Type: string

The address of a device on the fieldbus/local network
Example:

"0x414889"

root testing
Type: object

Testing target parameters

 No Additional Properties

root testing nostate
Type: boolean

root testing targets
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]+)*$
root testing targets model_testing_target.json#
Type: object
No Additional Properties

root testing targets Target Testing Model target_point
Type: string

Point name used for testing

root testing targets Target Testing Model target_value
Type: object

Value used for testing

root features
Type: object

Model of supported features

 No Additional Properties

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

Property name regular expression: ^[._a-zA-Z]+$
root features discovery_feature.json
Type: object

Object representation for for a single feature

 No Additional Properties

root features Feature Discovery stage
Type: enum (of string)

Stage of a feature implemenation

Must be one of:

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

root pointset
Type: object

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 Properties

root pointset points
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]+)*$
root pointset points model_pointset_point.json#
Type: object

Information about a specific point name of the device.

 No Additional Properties

root pointset points Point Pointset Model units
Type: string

Expected unit configuration for the point

root pointset points Point Pointset Model writable
Type: boolean

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

root pointset points Point Pointset Model baseline_value
Type: object

Represents the expected baseline value of the point
Example:

22

root pointset points Point Pointset Model baseline_tolerance
Type: number

Maximum deviation from baseline_value
Example:

2

root pointset points Point Pointset Model baseline_state
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"

root pointset points Point Pointset Model range_min
Type: number

Represents the lower bound of the error threshold for a point
Example:

0

root pointset points Point Pointset Model range_max
Type: number

Represents the upper bound of the error threshold for a point
Example:

100

root pointset points Point Pointset Model cov_increment
Type: number

Triggering threshold for partial cov update publishing
Example:

1

root pointset points Point Pointset Model ref
Type: string

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

"AI3"

"400070"

root pointset points Point Pointset Model tags
Type: array

Tags assosciated with the point

All items must be unique

Each item of this array must be:

root pointset points Point Pointset Model tags tags items
Type: object
Must match regular expression: ^[a-z0-9]+$

Examples:

[
    "lighting"
]

[
    "energy",
    "hvac"
]

root pointset sample_limit_sec
Type: integer

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

root pointset sample_rate_sec
Type: integer

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