cpp-esphome-api/command__builder_8hpp_source.html

#pragma once


#include <esphome/api/client.hpp>

#include <esphome/api/model/entities/alarm_control_panel.hpp>

#include <esphome/api/model/entities/button.hpp>

#include <esphome/api/model/entities/climate.hpp>

#include <esphome/api/model/entities/cover.hpp>

#include <esphome/api/model/entities/date.hpp>

#include <esphome/api/model/entities/datetime.hpp>

#include <esphome/api/model/entities/fan.hpp>

#include <esphome/api/model/entities/light.hpp>

#include <esphome/api/model/entities/lock.hpp>

#include <esphome/api/model/entities/media_player.hpp>

#include <esphome/api/model/entities/number.hpp>

#include <esphome/api/model/entities/select.hpp>

#include <esphome/api/model/entities/siren.hpp>

#include <esphome/api/model/entities/switch.hpp>

#include <esphome/api/model/entities/text.hpp>

#include <esphome/api/model/entities/time.hpp>

#include <esphome/api/model/entities/update.hpp>

#include <esphome/api/model/entities/valve.hpp>

#include <esphome/api/model/entities/water_heater.hpp>


namespace esphome::api {


void request_camera_image(const Client& client, bool single, bool stream);


void send_command(const Client& client, const SwitchCommand& cmd);

void send_command(const Client& client, const ButtonCommand& cmd);

void send_command(const Client& client, const NumberCommand& cmd);

void send_command(const Client& client, const SelectCommand& cmd);

void send_command(const Client& client, const TextCommand& cmd);

void send_command(const Client& client, const LightCommand& cmd);

void send_command(const Client& client, const FanCommand& cmd);

void send_command(const Client& client, const CoverCommand& cmd);

void send_command(const Client& client, const ValveCommand& cmd);

void send_command(const Client& client, const LockCommandData& cmd);

void send_command(const Client& client, const SirenCommand& cmd);

void send_command(const Client& client, const ClimateCommand& cmd);

void send_command(const Client& client, const WaterHeaterCommand& cmd);

void send_command(const Client& client, const MediaPlayerControl& cmd);

void send_command(const Client& client, const AlarmControlPanelCommand& cmd);

void send_command(const Client& client, const DateCommand& cmd);

void send_command(const Client& client, const TimeCommand& cmd);

void send_command(const Client& client, const DateTimeCommand& cmd);

void send_command(const Client& client, const UpdateControl& cmd);


}  // namespace esphome::api

alarm_control_panel.hpp
Typed AlarmControlPanel entity (info + state + command).

button.hpp
Typed Button entity (info + command).

esphome::api::Client
Async client for a single device.
Definition client.hpp:38

client.hpp
Asynchronous orchestrator: owns the event loop and a Connection, and exposes connect/send/subscribe p...

climate.hpp
Typed Climate entity (info + state + command).

cover.hpp
Typed Cover entity (info + state + command).

date.hpp
Typed Date entity (info + state + command).

datetime.hpp
Typed DateTime entity (info + state + command).

fan.hpp
Typed Fan entity (info + state + command).

light.hpp
Typed Light entity (info + state + command).

lock.hpp
Typed Lock entity (info + state + command).

media_player.hpp
Typed MediaPlayer entity (info + state + command).

esphome::api
Definition bytes.hpp:10

esphome::api::send_command
void send_command(const Client &client, const SwitchCommand &cmd)
Send a SwitchCommand to the device.

esphome::api::request_camera_image
void request_camera_image(const Client &client, bool single, bool stream)
Request a camera still image (single) or start/stop a stream.

number.hpp
Typed Number entity (info + state + command).

select.hpp
Typed Select entity (info + state + command).

siren.hpp
Typed Siren entity (info + state + command).

esphome::api::AlarmControlPanelCommand
A command to change an alarm control panel's state.
Definition alarm_control_panel.hpp:39

esphome::api::ButtonCommand
A command to press a button.
Definition button.hpp:27

esphome::api::ClimateCommand
A command to mutate a climate entity. Each optional field is sent only when engaged.
Definition climate.hpp:61

esphome::api::CoverCommand
A command targeting a cover entity.
Definition cover.hpp:41

esphome::api::DateCommand
A command to set a date's value.
Definition date.hpp:35

esphome::api::DateTimeCommand
A command to set a datetime's value.
Definition datetime.hpp:33

esphome::api::FanCommand
A command to mutate a fan. Each optional field is sent only when engaged.
Definition fan.hpp:44

esphome::api::LightCommand
A command to mutate a light. Each optional field is sent only when engaged.
Definition light.hpp:57

esphome::api::LockCommandData
A command targeting a lock entity.
Definition lock.hpp:46

esphome::api::MediaPlayerControl
A command to mutate a media player.
Definition media_player.hpp:54

esphome::api::NumberCommand
A command to set a number's value.
Definition number.hpp:41

esphome::api::SelectCommand
A command to set a select's value.
Definition select.hpp:37

esphome::api::SirenCommand
A command targeting a siren entity.
Definition siren.hpp:38

esphome::api::SwitchCommand
A command to change a switch's state.
Definition switch.hpp:35

esphome::api::TextCommand
A command to set a text entity's value.
Definition text.hpp:39

esphome::api::TimeCommand
A command to set a time's value.
Definition time.hpp:35

esphome::api::UpdateControl
A command to control an update entity.
Definition update.hpp:44

esphome::api::ValveCommand
A command targeting a valve entity.
Definition valve.hpp:39

esphome::api::WaterHeaterCommand
A command to mutate a water heater.
Definition water_heater.hpp:50

switch.hpp
Typed Switch entity (info + state + command).

text.hpp
Typed Text entity (info + state + command).

time.hpp
Typed Time entity (info + state + command).

update.hpp
Typed Update entity (info + state + command).

valve.hpp
Typed Valve entity (info + state + command).

water_heater.hpp
Typed WaterHeater entity (info + state + command).