Struct RegistrationDescriptor

pub struct RegistrationDescriptor { /* private fields */ }

Registration descriptor sent to Home Assistant

This describes the device and its components (the sensors that are configured)

Implementations

impl RegistrationDescriptor

pub fn new(name: &str) -> RegistrationDescriptor

Creates a new registration descriptor, with no sensor configured.

Example

use mqtt_system_monitor::{ RegistrationDescriptor, Sensor };

let mut descriptor = RegistrationDescriptor::new("test_entity");
assert!(!descriptor.has_sensor(Sensor::CpuUsage));

descriptor.add_component(Sensor::CpuUsage);
assert!(descriptor.has_sensor(Sensor::CpuUsage));

pub fn add_component(&mut self, sensor: Sensor)

Adds a component to the descriptor

Example

use mqtt_system_monitor::{ RegistrationDescriptor, Sensor };

let mut descriptor = RegistrationDescriptor::new("test_entity");
assert!(!descriptor.has_sensor(Sensor::CpuUsage));

descriptor.add_component(Sensor::CpuUsage);
assert!(descriptor.has_sensor(Sensor::CpuUsage));

pub fn has_sensor(&self, sensor: Sensor) -> bool

Returns true if the sensor is configured

pub fn remove_sensor(&mut self, sensor: Sensor)

Removes the sensor from this descriptor

pub fn discovery_topic(&self, prefix: &str) -> String

Discovery topic for this sensor if individual updates are sent

pub fn state_topic(&self) -> &str

Discovery topic for this sensor if individual updates are sent

Trait Implementations

impl Debug for RegistrationDescriptor

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

Formats the value using the given formatter.

impl Display for RegistrationDescriptor

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

Formats the descriptor in JSON format

impl Serialize for RegistrationDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.