ESPHome  2023.9.1
api_server.h
Go to the documentation of this file.
1 #pragma once
2 
5 #include "esphome/core/defines.h"
6 #include "esphome/core/log.h"
8 #include "api_pb2.h"
9 #include "api_pb2_service.h"
10 #include "list_entities.h"
11 #include "subscribe_state.h"
12 #include "user_services.h"
13 #include "api_noise_context.h"
14 
15 #include <vector>
16 
17 namespace esphome {
18 namespace api {
19 
20 class APIServer : public Component, public Controller {
21  public:
22  APIServer();
23  void setup() override;
24  uint16_t get_port() const;
25  float get_setup_priority() const override;
26  void loop() override;
27  void dump_config() override;
28  void on_shutdown() override;
29  bool check_password(const std::string &password) const;
30  bool uses_password() const;
31  void set_port(uint16_t port);
32  void set_password(const std::string &password);
33  void set_reboot_timeout(uint32_t reboot_timeout);
34 
35 #ifdef USE_API_NOISE
36  void set_noise_psk(psk_t psk) { noise_ctx_->set_psk(psk); }
37  std::shared_ptr<APINoiseContext> get_noise_ctx() { return noise_ctx_; }
38 #endif // USE_API_NOISE
39 
40  void handle_disconnect(APIConnection *conn);
41 #ifdef USE_BINARY_SENSOR
43 #endif
44 #ifdef USE_COVER
45  void on_cover_update(cover::Cover *obj) override;
46 #endif
47 #ifdef USE_FAN
48  void on_fan_update(fan::Fan *obj) override;
49 #endif
50 #ifdef USE_LIGHT
51  void on_light_update(light::LightState *obj) override;
52 #endif
53 #ifdef USE_SENSOR
54  void on_sensor_update(sensor::Sensor *obj, float state) override;
55 #endif
56 #ifdef USE_SWITCH
57  void on_switch_update(switch_::Switch *obj, bool state) override;
58 #endif
59 #ifdef USE_TEXT_SENSOR
60  void on_text_sensor_update(text_sensor::TextSensor *obj, const std::string &state) override;
61 #endif
62 #ifdef USE_CLIMATE
63  void on_climate_update(climate::Climate *obj) override;
64 #endif
65 #ifdef USE_NUMBER
66  void on_number_update(number::Number *obj, float state) override;
67 #endif
68 #ifdef USE_SELECT
69  void on_select_update(select::Select *obj, const std::string &state, size_t index) override;
70 #endif
71 #ifdef USE_LOCK
72  void on_lock_update(lock::Lock *obj) override;
73 #endif
74 #ifdef USE_MEDIA_PLAYER
76 #endif
78  void register_user_service(UserServiceDescriptor *descriptor) { this->user_services_.push_back(descriptor); }
79 #ifdef USE_HOMEASSISTANT_TIME
80  void request_time();
81 #endif
82 
83 #ifdef USE_VOICE_ASSISTANT
84  bool start_voice_assistant(const std::string &conversation_id, bool use_vad);
85  void stop_voice_assistant();
86 #endif
87 
88 #ifdef USE_ALARM_CONTROL_PANEL
90 #endif
91 
92  bool is_connected() const;
93 
95  std::string entity_id;
97  std::function<void(std::string)> callback;
98  };
99 
101  std::function<void(std::string)> f);
102  const std::vector<HomeAssistantStateSubscription> &get_state_subs() const;
103  const std::vector<UserServiceDescriptor *> &get_user_services() const { return this->user_services_; }
104 
105  protected:
106  std::unique_ptr<socket::Socket> socket_ = nullptr;
107  uint16_t port_{6053};
108  uint32_t reboot_timeout_{300000};
109  uint32_t last_connected_{0};
110  std::vector<std::unique_ptr<APIConnection>> clients_;
111  std::string password_;
112  std::vector<HomeAssistantStateSubscription> state_subs_;
113  std::vector<UserServiceDescriptor *> user_services_;
114 
115 #ifdef USE_API_NOISE
116  std::shared_ptr<APINoiseContext> noise_ctx_ = std::make_shared<APINoiseContext>();
117 #endif // USE_API_NOISE
118 };
119 
120 extern APIServer *global_api_server; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
121 
122 template<typename... Ts> class APIConnectedCondition : public Condition<Ts...> {
123  public:
124  bool check(Ts... x) override { return global_api_server->is_connected(); }
125 };
126 
127 } // namespace api
128 } // namespace esphome
Base class for all switches.
Definition: switch.h:39
void handle_disconnect(APIConnection *conn)
Definition: api_server.cpp:175
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition: light_state.h:34
bool is_connected() const
Definition: api_server.cpp:317
Base class for all cover devices.
Definition: cover.h:111
const std::vector< UserServiceDescriptor * > & get_user_services() const
Definition: api_server.h:103
void on_media_player_update(media_player::MediaPlayer *obj) override
Definition: api_server.cpp:276
uint16_t x
Definition: tt21100.cpp:17
void on_select_update(select::Select *obj, const std::string &state, size_t index) override
Definition: api_server.cpp:258
std::function< void(std::string)> callback
Definition: api_server.h:97
bool check_password(const std::string &password) const
Definition: api_server.cpp:147
std::vector< HomeAssistantStateSubscription > state_subs_
Definition: api_server.h:112
void on_light_update(light::LightState *obj) override
Definition: api_server.cpp:204
void set_noise_psk(psk_t psk)
Definition: api_server.h:36
void on_lock_update(lock::Lock *obj) override
Definition: api_server.cpp:267
void send_homeassistant_service_call(const HomeassistantServiceResponse &call)
Definition: api_server.cpp:289
void on_cover_update(cover::Cover *obj) override
Definition: api_server.cpp:186
void on_binary_sensor_update(binary_sensor::BinarySensor *obj, bool state) override
Definition: api_server.cpp:177
void loop() override
Definition: api_server.cpp:94
void on_fan_update(fan::Fan *obj) override
Definition: api_server.cpp:195
void setup() override
Definition: api_server.cpp:24
void on_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj) override
Definition: api_server.cpp:342
std::shared_ptr< APINoiseContext > noise_ctx_
Definition: api_server.h:116
void on_switch_update(switch_::Switch *obj, bool state) override
Definition: api_server.cpp:222
std::shared_ptr< APINoiseContext > get_noise_ctx()
Definition: api_server.h:37
void dump_config() override
Definition: api_server.cpp:137
Base class for all automation conditions.
Definition: automation.h:74
void on_number_update(number::Number *obj, float state) override
Definition: api_server.cpp:249
Base-class for all numbers.
Definition: number.h:39
void set_reboot_timeout(uint32_t reboot_timeout)
Definition: api_server.cpp:308
void on_climate_update(climate::Climate *obj) override
Definition: api_server.cpp:240
void on_text_sensor_update(text_sensor::TextSensor *obj, const std::string &state) override
Definition: api_server.cpp:231
void register_user_service(UserServiceDescriptor *descriptor)
Definition: api_server.h:78
std::vector< UserServiceDescriptor * > user_services_
Definition: api_server.h:113
void set_port(uint16_t port)
Definition: api_server.cpp:285
const std::vector< HomeAssistantStateSubscription > & get_state_subs() const
Definition: api_server.cpp:304
void on_sensor_update(sensor::Sensor *obj, float state) override
Definition: api_server.cpp:213
bool uses_password() const
Definition: api_server.cpp:146
Base-class for all selects.
Definition: select.h:31
std::vector< std::unique_ptr< APIConnection > > clients_
Definition: api_server.h:110
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
Base class for all binary_sensor-type classes.
Definition: binary_sensor.h:37
bool check(Ts... x) override
Definition: api_server.h:124
float get_setup_priority() const override
Definition: api_server.cpp:284
void subscribe_home_assistant_state(std::string entity_id, optional< std::string > attribute, std::function< void(std::string)> f)
Definition: api_server.cpp:296
void on_shutdown() override
Definition: api_server.cpp:318
Base-class for all sensors.
Definition: sensor.h:57
uint16_t get_port() const
Definition: api_server.cpp:307
std::array< uint8_t, 32 > psk_t
void set_password(const std::string &password)
Definition: api_server.cpp:288
APIServer * global_api_server
Definition: api_server.cpp:286
std::unique_ptr< socket::Socket > socket_
Definition: api_server.h:106
Base class for all locks.
Definition: lock.h:103
bool start_voice_assistant(const std::string &conversation_id, bool use_vad)
Definition: api_server.cpp:326
ClimateDevice - This is the base class for all climate integrations.
Definition: climate.h:161
bool state
Definition: fan.h:34