udmi

UDMI / Docs / Messages / Config

Config

Schema Definition: config.json (🧬View)

The UDMI config block specifies information that controls a device’s intended behavior. It is composed of specific sub-entries for each sub-system { system, pointset, gateway, etc… }. This working example shows how a typical config message is constructed.

Config Parameters

System

• min_loglevel: Indicates the minimum loglevel for reporting log messages below which log entries should not be sent. See note below for a description of the level value.

Pointset

• sample_rate_sec: Sampling rate for the system, which should proactively send an update (e.g. pointset, logentry, discover message) at this interval.
• sample_limit_sec: Minimum time between sample updates. Updates that happen faster than this time (e.g. due to cov events) should be coalesced so that only the most recent update is sent.

Point

• set_value: Set a value to be used during diagnostics and operational use. Should override any operational values, but not override alarm conditions.

Config Log Entries

During a config receive/up sequence, the system should produce the following log/status update entries:

• system.config.receive: (DEBUG) Receiving a config message
• system.config.parse: (DEBUG) Parsing a received message
• system.config.apply: (NOTICE) Application of a parsed config message

This site is open source. Improve this page.