Config

Type: object

The config block controls a device's intended behavior. Config Documentation

 No Additional Properties

root timestamp
Type: string

RFC 3339 UTC timestamp the configuration was generated
Example:

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

root version
Type: string

Version of the UDMI schema

root downgraded_from
Type: string

Original version of schema pre-downgrade

root system
Type: object

System Config Documentation

 No Additional Properties

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 Default: 10

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 system operation
Type: object
No Additional Properties

root system operation mode
Type: enum (of string)

Operating mode for the device. Default is 'active'.

Must be one of:

  • "initial"
  • "active"
  • "updating"
  • "restart"
  • "terminate"
  • "shutdown"

root system operation last_start
Type: string

Last time a device with this id said it restarted: being later than status-supplied last_start indicates resource conflict.

root system testing
Type: object

Configuration parameters for device-under-test

 No Additional Properties

root system testing sequence_name
Type: string

The sequence name currently being tested (for debug logging)

root system testing transaction_id
Type: string

The transaction id used to generate this config update

root system testing config_base
Type: integer

The configuration version that this update was based on

root system testing endpoint_type
Type: string

Designator for the kind of endpoint being used for this test

root gateway
Type: object

Configuration for gateways. Only required for devices which are acting as gateways

 No Additional Properties

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 gateway target
Type: object

For proxied devices, this represents the target proxy device address for use by its gateway

 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 discovery
Type: object

Configuration for discovery

 No Additional Properties

root discovery generation
Type: string

Generational marker for controlling enumeration

root discovery enumerations
Type: object

Enumeration depth for self-enumerations.

 No Additional Properties

root discovery enumerations families
Type: enum (of string)

Must be one of:

  • "buckets"
  • "entries"
  • "details"
  • "parts"

root discovery enumerations devices
Type: enum (of string)

Must be one of:

  • "buckets"
  • "entries"
  • "details"
  • "parts"

root discovery enumerations points
Type: enum (of string)

Must be one of:

  • "buckets"
  • "entries"
  • "details"
  • "parts"

root discovery enumerations features
Type: enum (of string)

Must be one of:

  • "buckets"
  • "entries"
  • "details"
  • "parts"

root discovery families
Type: object

Address family configs for discovery scans.

 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 discovery families config_discovery_family.json
Type: object

Configuration for discovery

 No Additional Properties

root discovery families Family Discovery Config generation
Type: string

Generational marker for controlling discovery

root discovery families Family Discovery Config scan_interval_sec
Type: integer

Period, in seconds, for automatic scanning

Value must be greater or equal to 0

root discovery families Family Discovery Config scan_duration_sec
Type: integer

Scan duration, in seconds

Value must be greater or equal to 0

root discovery families Family Discovery Config passive_sec
Type: integer

Holdoff time for passively discovered devices

Value must be greater or equal to 0

root discovery families Family Discovery Config depth
Type: enum (of string)

Indicates implicit enumeration of discovered devices

Must be one of:

  • "buckets"
  • "entries"
  • "details"
  • "parts"

root localnet
Type: object

Currently unused: request local network configuration

 No Additional Properties

root localnet families
Type: object

Address family config for reporting.

 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 localnet families config_localnet_family.json
Type: object

root blobset
Type: object
No Additional Properties

root blobset blobsets
Type: enum (of string)

Placeholder to create generated code enum

Must be one of:

  • "_iot_endpoint_config"

root blobset blobs
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 blobset blobs config_blobset_blob.json#
Type: object
No Additional Properties

root blobset blobs Blob Blobset Config phase
Type: enum (of string)

Phase for the management of a configuration blob.

Must be one of:

  • "apply"
  • "final"

root blobset blobs Blob Blobset Config sha256
Type: string

Expected hash of the retrieved resource

Must match regular expression: ^[0-9a-f]{64}$

root blobset blobs Blob Blobset Config generation
Type: string

RFC 3339 UTC timestamp of the blob generation
Example:

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

root pointset
Type: object

Pointset Config Documentation

 No Additional Properties

root pointset timestamp
Type: string

RFC 3339 UTC timestamp the configuration was generated
Example:

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

root pointset version
Type: string

Version of the UDMI schema

root pointset state_etag
Type: string

The state_etag of the last state message sent by the device. Writeback documentation

Must be at most 32 characters long

root pointset set_value_expiry
Type: string

An expiry for the the device to revert to baseline (no set value). Writeback documentation

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

root pointset points
Type: object

The points defined in this dictionary is the authoritative source indicating the representative points for the device (in both telemetry and state messages). Pointset doumentation

 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 config_pointset_point.json#
Type: object
No Additional Properties

root pointset points Point Pointset Config ref
Type: string

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

"AI1106"

root pointset points Point Pointset Config units
Type: string

If specified, indicates the units the device should report the data in.

root pointset points Point Pointset Config set_value
Type: object

Used for cloud writeback functionality, this field specifies the value for a given point in the device's current units.
Example:

22.4

root pointset points Point Pointset Config stop_time
Type: string

RFC 3339 timestamp for the specified point write easing to stop
Example:

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

root pointset points Point Pointset Config cov_increment
Type: number

The CoV (change of value) increment, which when set, enables CoV on the point and defines the minimum change in present value of the respective point before an update is published

Value must be greater or equal to 0