Struct homie_controller::HomieController

pub struct HomieController { /* private fields */ }

A Homie controller, which connects to an MQTT broker and interacts with Homie devices.

Implementations

impl HomieController

pub fn new(
    mqtt_options: MqttOptions,
    base_topic: &str
) -> (HomieController, HomieEventLoop)

Create a new HomieController connected to an MQTT broker.

Arguments

• base_topic: The Homie base topic under which to look for Homie devices. “homie” is the recommended default.
• mqtt_options: Options for the MQTT connection, including which broker to connect to.

pub fn devices(&self) -> Arc<HashMap<String, Device>>

Get a snapshot of the set of Homie devices which have been discovered so far, keyed by their IDs.

pub fn base_topic(&self) -> &str

Get the Homie base topic which the controller was configured to use.

pub async fn poll(
    &self,
    event_loop: &mut HomieEventLoop
) -> Result<Option<Event>, PollError>

Poll the EventLoop, and maybe return a Homie event.

pub async fn set(
    &self,
    device_id: &str,
    node_id: &str,
    property_id: &str,
    value: impl Value
) -> Result<(), ClientError>

Attempt to set the state of a settable property of a device. If this succeeds the device will update the value of the property.

pub async fn disconnect(&self) -> Result<(), ClientError>

Disconnect from the MQTT broker.

Trait Implementations

impl Debug for HomieController

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.