esphome-api-client 0.5.0
Modern C++17 client for the ESPHome native API (plaintext + Noise)
Loading...
Searching...
No Matches
Public Attributes | List of all members
esphome::api::WaterHeaterCommand Struct Reference

A command to mutate a water heater. More...

#include <water_heater.hpp>

Public Attributes

std::uint32_t key = 0
 
std::optional< WaterHeaterModemode
 
std::optional< float > target_temperature
 
std::optional< float > target_temperature_low
 
std::optional< float > target_temperature_high
 
std::optional< bool > on_state
 On/off flag (bit 1 of the state bitmask).
 
std::optional< bool > away_state
 Away flag (bit 0 of the state bitmask).
 

Detailed Description

A command to mutate a water heater.

The command signals which fields are set via the has_fields bitmask (see WaterHeaterCommandHasField); here each set field is represented by an engaged optional, mapped to the matching bit in to_message.

Member Data Documentation

◆ away_state

std::optional<bool> esphome::api::WaterHeaterCommand::away_state

Away flag (bit 0 of the state bitmask).

◆ key

std::uint32_t esphome::api::WaterHeaterCommand::key = 0

◆ mode

std::optional<WaterHeaterMode> esphome::api::WaterHeaterCommand::mode

◆ on_state

std::optional<bool> esphome::api::WaterHeaterCommand::on_state

On/off flag (bit 1 of the state bitmask).

◆ target_temperature

std::optional<float> esphome::api::WaterHeaterCommand::target_temperature

◆ target_temperature_high

std::optional<float> esphome::api::WaterHeaterCommand::target_temperature_high

◆ target_temperature_low

std::optional<float> esphome::api::WaterHeaterCommand::target_temperature_low

The documentation for this struct was generated from the following file: