Struct TelemetryClient

pub struct TelemetryClient<C: Clock, S: TcpClientStack> { /* private fields */ }

The telemetry client for reporting telemetry data over MQTT.

Implementations

impl<C: Clock, S: TcpClientStack<Error = NetworkError> + Dns> TelemetryClient<C, S>

pub fn new( mqtt: Minimq<'static, S, C, NamedBroker<S>>, prefix: &'static str, metadata: &'static ApplicationMetadata, ) -> Self

Construct a new telemetry client.

Args

• mqtt - The MQTT client
• prefix - The device prefix to use for MQTT telemetry reporting.

Returns

A new telemetry client.

pub fn publish_telemetry<T: Serialize>(&mut self, suffix: &str, telemetry: &T)

Publish telemetry over MQTT

Note

Telemetry is reported in a “best-effort” fashion. Failure to transmit telemetry will cause it to be silently dropped.

Args

• telemetry - The telemetry to report

pub fn publish<T: Serialize>( &mut self, topic: &str, payload: &T, ) -> Result<(), PubError<NetworkError, Error>>

pub fn update(&mut self)

Update the telemetry client

Note

This function is provided to force the underlying MQTT state machine to process incoming and outgoing messages. Without this, the client will never connect to the broker. This should be called regularly.