Struct homie_device::Property

pub struct Property {
    pub id: String,
    pub name: String,
    pub datatype: Datatype,
    pub settable: bool,
    pub unit: Option<String>,
    pub format: Option<String>,
}

A property of a Homie node.

Fields

id: String

name: String

datatype: Datatype

settable: bool

unit: Option<String>

format: Option<String>

Implementations

impl Property

pub fn new(
    id: &str,
    name: &str,
    datatype: Datatype,
    settable: bool,
    unit: Option<&str>,
    format: Option<&str>
) -> Property

Create a new property with the given attributes.

Arguments

• id: The topic ID for the property. This must be unique per node, and follow the Homie ID format.
• name: The human-readable name of the property.
• datatype: The data type of the property.
• settable: Whether the property can be set by the Homie controller. This should be true for properties like the brightness or power state of a light, and false for things like the temperature reading of a sensor.
• unit: The unit for the property, if any. This may be one of the recommended units, or any other custom unit.
• format: The format for the property, if any. This must be specified if the datatype is Enum or Color, and may be specified if the datatype is Integer or Float.

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.