State

Leafs

class TelemetrySystem.Subscriptions.Persistent.Subscription.SensorProfiles.SensorProfile.State

Bases: Entity

Class Hierarchy: TelemetrySystem Subscriptions Persistent Subscription SensorProfiles SensorProfile State

This class represents state data.

State information relating to the sensor profile

for a subscription

sensor_group

Reference to the sensor group which is used in the profile

type: str

refers to: sensor_group_id

config: False

sample_interval

Time in milliseconds between the device’s sample of a telemetry data source. For example, setting this to 100 would require the local device to collect the telemetry data every 100 milliseconds. There can be latency or jitter in transmitting the data, but the sample must occur at the specified interval. The timestamp must reflect the actual time when the data was sampled, not simply the previous sample timestamp + sample-interval. If sample-interval is set to 0, the telemetry sensor becomes event based. The sensor must then emit data upon every change of the underlying data source

type: int

range: 0..18446744073709551615

config: False

heartbeat_interval

Maximum time interval in seconds that may pass between updates from a device to a telemetry collector. If this interval expires, but there is no updated data to send (such as if suppress_updates has been configured), the device must send a telemetry message to the collector

type: int

range: 0..18446744073709551615

config: False

suppress_redundant

Boolean flag to control suppression of redundant telemetry updates to the collector platform. If this flag is set to TRUE, then the collector will only send an update at the configured interval if a subscribed data value has changed. Otherwise, the device will not send an update to the collector until expiration of the heartbeat interval

type: bool

config: False