Struct hass_mqtt_discovery::entity::Sensor

pub struct Sensor<'a> {

    pub availability: Cow<'a, [Availability<'a>]>,
    pub availability_mode: AvailabilityMode,
    pub device: Option<Device<'a>>,
    pub enabled_by_default: Option<bool>,
    pub encoding: Option<Cow<'a, str>>,
    pub entity_category: EntityCategory,
    pub icon: Option<Icon<'a>>,
    pub json_attributes_template: Option<Template<'a>>,
    pub json_attributes_topic: Option<Topic<'a>>,
    pub name: Option<Name<'a>>,
    pub object_id: Option<Cow<'a, str>>,
    pub qos: MqttQoS,
    pub unique_id: Option<UniqueId<'a>>,
    pub device_class: DeviceClass,
    pub expire_after: Option<NonZeroU32>,
    pub force_update: Option<bool>,
    pub last_reset_value_template: Option<Template<'a>>,
    pub state_class: StateClass,
    pub state_topic: Topic<'a>,
    pub unit_of_measurement: Option<Cow<'a, str>>,
    pub value_template: Option<Template<'a>>,
}

This mqtt sensor platform uses the MQTT message payload as the sensor value. If messages in this state_topic are published with RETAIN flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined.

See: https://www.home-assistant.io/integrations/sensor.mqtt/

Fields

availability: Cow<'a, [Availability<'a>]>

A list of MQTT topics subscribed to receive availability (online/offline) updates.

availability_mode: AvailabilityMode

When availability is configured, this controls the conditions needed to set the entity to available.

device: Option<Device<'a>>

Information about the device this entity is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.

enabled_by_default: Option<bool>

Flag which defines if the entity should be enabled when first added. Defaults to true.

encoding: Option<Cow<'a, str>>

The encoding of the payloads received and published messages. Set to “” to disable decoding of incoming payload. Defaults to "utf-8".

entity_category: EntityCategory

The category of the entity.

icon: Option<Icon<'a>>

Icon for the entity.

json_attributes_template: Option<Template<'a>>

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.

json_attributes_topic: Option<Topic<'a>>

The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes.

Implies force_update of the current state when a message is received on this topic.

name: Option<Name<'a>>

The name of the MQTT entity.

object_id: Option<Cow<'a, str>>

Used instead of name for automatic generation of entity_id.

qos: MqttQoS

The maximum QoS level of the state topic.

unique_id: Option<UniqueId<'a>>

An ID that uniquely identifies this entity. If two entities have the same unique ID, Home Assistant will raise an exception.

device_class: DeviceClass

The type/class of the sensor to set the icon in the frontend.

expire_after: Option<NonZeroU32>

Defines the number of seconds after the value expires if it’s not updated. After expiry, the sensor’s state becomes unavailable.

force_update: Option<bool>

Sends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history. Defaults to false.

last_reset_value_template: Option<Template<'a>>

Defines a template to extract the last_reset. Available variables: entity_id. The entity_id can be used to reference the entity’s attributes.

state_class: StateClass

The state_class of the sensor.

state_topic: Topic<'a>

The MQTT topic subscribed to receive sensor values.

unit_of_measurement: Option<Cow<'a, str>>

Defines the units of measurement of the sensor, if any.

value_template: Option<Template<'a>>

Defines a template to extract the value. Available variables: entity_id. The entity_id can be used to reference the entity’s attributes.

Implementations

impl<'a> Sensor<'a>

pub fn new(state_topic: impl Into<Topic<'a>>) -> Self

pub fn availability(
    self,
    availability: impl Into<Cow<'a, [Availability<'a>]>>
) -> Self

A list of MQTT topics subscribed to receive availability (online/offline) updates.

pub fn availability_mode(
    self,
    availability_mode: impl Into<AvailabilityMode>
) -> Self

When availability is configured, this controls the conditions needed to set the entity to available.

pub fn device(self, device: impl Into<Device<'a>>) -> Self

Information about the device this entity is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.

pub fn unset_device(&mut self) -> &mut Self

Information about the device this entity is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.

pub fn enabled_by_default(self, enabled_by_default: impl Into<bool>) -> Self

Flag which defines if the entity should be enabled when first added. Defaults to true.

pub fn unset_enabled_by_default(&mut self) -> &mut Self

Flag which defines if the entity should be enabled when first added. Defaults to true.

pub fn encoding(self, encoding: impl Into<Cow<'a, str>>) -> Self

The encoding of the payloads received and published messages. Set to “” to disable decoding of incoming payload. Defaults to "utf-8".

pub fn unset_encoding(&mut self) -> &mut Self

The encoding of the payloads received and published messages. Set to “” to disable decoding of incoming payload. Defaults to "utf-8".

pub fn entity_category(self, entity_category: impl Into<EntityCategory>) -> Self

The category of the entity.

pub fn icon(self, icon: impl Into<Icon<'a>>) -> Self

Icon for the entity.

pub fn unset_icon(&mut self) -> &mut Self

Icon for the entity.

pub fn json_attributes_template(
    self,
    json_attributes_template: impl Into<Template<'a>>
) -> Self

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.

pub fn unset_json_attributes_template(&mut self) -> &mut Self

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.

pub fn json_attributes_topic(
    self,
    json_attributes_topic: impl Into<Topic<'a>>
) -> Self

The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes.

Implies force_update of the current state when a message is received on this topic.

pub fn unset_json_attributes_topic(&mut self) -> &mut Self

The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes.

Implies force_update of the current state when a message is received on this topic.

pub fn name(self, name: impl Into<Name<'a>>) -> Self

The name of the MQTT entity.

pub fn unset_name(&mut self) -> &mut Self

The name of the MQTT entity.

pub fn object_id(self, object_id: impl Into<Cow<'a, str>>) -> Self

Used instead of name for automatic generation of entity_id.

pub fn unset_object_id(&mut self) -> &mut Self

Used instead of name for automatic generation of entity_id.

pub fn qos(self, qos: impl Into<MqttQoS>) -> Self

The maximum QoS level of the state topic.

pub fn unique_id(self, unique_id: impl Into<UniqueId<'a>>) -> Self

An ID that uniquely identifies this entity. If two entities have the same unique ID, Home Assistant will raise an exception.

pub fn unset_unique_id(&mut self) -> &mut Self

An ID that uniquely identifies this entity. If two entities have the same unique ID, Home Assistant will raise an exception.

pub fn device_class(self, device_class: impl Into<DeviceClass>) -> Self

The type/class of the sensor to set the icon in the frontend.

pub fn expire_after(self, expire_after: impl Into<NonZeroU32>) -> Self

Defines the number of seconds after the value expires if it’s not updated. After expiry, the sensor’s state becomes unavailable.

pub fn unset_expire_after(&mut self) -> &mut Self

Defines the number of seconds after the value expires if it’s not updated. After expiry, the sensor’s state becomes unavailable.

pub fn force_update(self, force_update: impl Into<bool>) -> Self

Sends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history. Defaults to false.

pub fn unset_force_update(&mut self) -> &mut Self

Sends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history. Defaults to false.

pub fn last_reset_value_template(
    self,
    last_reset_value_template: impl Into<Template<'a>>
) -> Self

Defines a template to extract the last_reset. Available variables: entity_id. The entity_id can be used to reference the entity’s attributes.

pub fn unset_last_reset_value_template(&mut self) -> &mut Self

Defines a template to extract the last_reset. Available variables: entity_id. The entity_id can be used to reference the entity’s attributes.

pub fn state_class(self, state_class: impl Into<StateClass>) -> Self

The state_class of the sensor.

pub fn state_topic(self, state_topic: impl Into<Topic<'a>>) -> Self

The MQTT topic subscribed to receive sensor values.

pub fn unit_of_measurement(
    self,
    unit_of_measurement: impl Into<Cow<'a, str>>
) -> Self

Defines the units of measurement of the sensor, if any.

pub fn unset_unit_of_measurement(&mut self) -> &mut Self

Defines the units of measurement of the sensor, if any.

pub fn value_template(self, value_template: impl Into<Template<'a>>) -> Self

Defines a template to extract the value. Available variables: entity_id. The entity_id can be used to reference the entity’s attributes.

pub fn unset_value_template(&mut self) -> &mut Self

Defines a template to extract the value. Available variables: entity_id. The entity_id can be used to reference the entity’s attributes.

Trait Implementations

impl<'a> Clone for Sensor<'a>

fn clone(&self) -> Sensor<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Sensor<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Sensor<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Document for Sensor<'a>

fn serialize_validated<S>(
    validated: Validated<&Sensor<'a>>,
    serializer: S
) -> Result<S::Ok, S::Error>where
    S: Serializer,

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

impl<'a> PartialEq<Sensor<'a>> for Sensor<'a>

fn eq(&self, other: &Sensor<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for Sensor<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Validate for Sensor<'a>

type Invalidity = SensorInvalidity

Invalidity objectives

fn validate(&self) -> ValidationResult<Self::Invalidity>

Perform the validation

impl<'a> Eq for Sensor<'a>

impl<'a> StructuralEq for Sensor<'a>

impl<'a> StructuralPartialEq for Sensor<'a>