Struct hass_mqtt_discovery::entity::Switch

pub struct Switch<'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 command_topic: Topic<'a>,
    pub device_class: DeviceClass,
    pub optimistic: Option<bool>,
    pub payload_off: Option<Payload<'a>>,
    pub payload_on: Option<Payload<'a>>,
    pub retain: Option<bool>,
    pub state_off: Option<Payload<'a>>,
    pub state_on: Option<Payload<'a>>,
    pub state_topic: Option<Topic<'a>>,
    pub value_template: Option<Template<'a>>,
}

The mqtt switch platform lets you control your MQTT enabled switches.

See: https://www.home-assistant.io/integrations/switch.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.

command_topic: Topic<'a>

The MQTT topic to publish commands to change the switch state.

device_class: DeviceClass

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

optimistic: Option<bool>

Flag that defines if switch works in optimistic mode. Defaults to true if no state_topic defined, else false.

payload_off: Option<Payload<'a>>

The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic. Defaults to "OFF".

payload_on: Option<Payload<'a>>

The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic. Defaults to "ON".

retain: Option<bool>

If the published message should have the retain flag on or not. Defaults to false.

state_off: Option<Payload<'a>>

The payload that represents the off state. Used when value that represents off state in the state_topic is different from value that should be sent to the command_topic to turn the device off. Defaults to payload_off if defined, else "OFF".

state_on: Option<Payload<'a>>

The payload that represents the on state. Used when value that represents on state in the state_topic is different from value that should be sent to the command_topic to turn the device on. Defaults to payload_on if defined, else "ON".

state_topic: Option<Topic<'a>>

The MQTT topic subscribed to receive state updates.

value_template: Option<Template<'a>>

Defines a template to extract device’s state from the state_topic. To determine the switches’s state result of this template will be compared to state_on and state_off.

Implementations

impl<'a> Switch<'a>

pub fn new(command_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 command_topic(self, command_topic: impl Into<Topic<'a>>) -> Self

The MQTT topic to publish commands to change the switch state.

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

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

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

Flag that defines if switch works in optimistic mode. Defaults to true if no state_topic defined, else false.

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

Flag that defines if switch works in optimistic mode. Defaults to true if no state_topic defined, else false.

pub fn payload_off(self, payload_off: impl Into<Payload<'a>>) -> Self

The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic. Defaults to "OFF".

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

The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic. Defaults to "OFF".

pub fn payload_on(self, payload_on: impl Into<Payload<'a>>) -> Self

The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic. Defaults to "ON".

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

The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic. Defaults to "ON".

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

If the published message should have the retain flag on or not. Defaults to false.

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

If the published message should have the retain flag on or not. Defaults to false.

pub fn state_off(self, state_off: impl Into<Payload<'a>>) -> Self

The payload that represents the off state. Used when value that represents off state in the state_topic is different from value that should be sent to the command_topic to turn the device off. Defaults to payload_off if defined, else "OFF".

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

The payload that represents the off state. Used when value that represents off state in the state_topic is different from value that should be sent to the command_topic to turn the device off. Defaults to payload_off if defined, else "OFF".

pub fn state_on(self, state_on: impl Into<Payload<'a>>) -> Self

The payload that represents the on state. Used when value that represents on state in the state_topic is different from value that should be sent to the command_topic to turn the device on. Defaults to payload_on if defined, else "ON".

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

The payload that represents the on state. Used when value that represents on state in the state_topic is different from value that should be sent to the command_topic to turn the device on. Defaults to payload_on if defined, else "ON".

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

The MQTT topic subscribed to receive state updates.

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

The MQTT topic subscribed to receive state updates.

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

Defines a template to extract device’s state from the state_topic. To determine the switches’s state result of this template will be compared to state_on and state_off.

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

Defines a template to extract device’s state from the state_topic. To determine the switches’s state result of this template will be compared to state_on and state_off.

Trait Implementations

impl<'a> Clone for Switch<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Switch<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Switch<'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 Switch<'a>

fn serialize_validated<S>(
    validated: Validated<&Switch<'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<Switch<'a>> for Switch<'a>

fn eq(&self, other: &Switch<'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 Switch<'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 Switch<'a>

type Invalidity = SwitchInvalidity

Invalidity objectives

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

Perform the validation

impl<'a> Eq for Switch<'a>

impl<'a> StructuralEq for Switch<'a>

impl<'a> StructuralPartialEq for Switch<'a>