mirror of
https://github.com/esphome/esphome.git
synced 2025-09-02 11:22:24 +01:00
206 lines
6.4 KiB
C++
206 lines
6.4 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/defines.h"
|
|
#ifdef USE_API
|
|
#include "api_noise_context.h"
|
|
#include "api_pb2.h"
|
|
#include "api_pb2_service.h"
|
|
#include "esphome/components/socket/socket.h"
|
|
#include "esphome/core/automation.h"
|
|
#include "esphome/core/component.h"
|
|
#include "esphome/core/controller.h"
|
|
#include "esphome/core/log.h"
|
|
#include "list_entities.h"
|
|
#include "subscribe_state.h"
|
|
#ifdef USE_API_SERVICES
|
|
#include "user_services.h"
|
|
#endif
|
|
|
|
#include <vector>
|
|
|
|
namespace esphome::api {
|
|
|
|
#ifdef USE_API_NOISE
|
|
struct SavedNoisePsk {
|
|
psk_t psk;
|
|
} PACKED; // NOLINT
|
|
#endif
|
|
|
|
class APIServer : public Component, public Controller {
|
|
public:
|
|
APIServer();
|
|
void setup() override;
|
|
uint16_t get_port() const;
|
|
float get_setup_priority() const override;
|
|
void loop() override;
|
|
void dump_config() override;
|
|
void on_shutdown() override;
|
|
bool teardown() override;
|
|
#ifdef USE_API_PASSWORD
|
|
bool check_password(const std::string &password) const;
|
|
void set_password(const std::string &password);
|
|
#endif
|
|
void set_port(uint16_t port);
|
|
void set_reboot_timeout(uint32_t reboot_timeout);
|
|
void set_batch_delay(uint16_t batch_delay);
|
|
uint16_t get_batch_delay() const { return batch_delay_; }
|
|
|
|
// Get reference to shared buffer for API connections
|
|
std::vector<uint8_t> &get_shared_buffer_ref() { return shared_write_buffer_; }
|
|
|
|
#ifdef USE_API_NOISE
|
|
bool save_noise_psk(psk_t psk, bool make_active = true);
|
|
void set_noise_psk(psk_t psk) { noise_ctx_->set_psk(psk); }
|
|
std::shared_ptr<APINoiseContext> get_noise_ctx() { return noise_ctx_; }
|
|
#endif // USE_API_NOISE
|
|
|
|
void handle_disconnect(APIConnection *conn);
|
|
#ifdef USE_BINARY_SENSOR
|
|
void on_binary_sensor_update(binary_sensor::BinarySensor *obj) override;
|
|
#endif
|
|
#ifdef USE_COVER
|
|
void on_cover_update(cover::Cover *obj) override;
|
|
#endif
|
|
#ifdef USE_FAN
|
|
void on_fan_update(fan::Fan *obj) override;
|
|
#endif
|
|
#ifdef USE_LIGHT
|
|
void on_light_update(light::LightState *obj) override;
|
|
#endif
|
|
#ifdef USE_SENSOR
|
|
void on_sensor_update(sensor::Sensor *obj, float state) override;
|
|
#endif
|
|
#ifdef USE_SWITCH
|
|
void on_switch_update(switch_::Switch *obj, bool state) override;
|
|
#endif
|
|
#ifdef USE_TEXT_SENSOR
|
|
void on_text_sensor_update(text_sensor::TextSensor *obj, const std::string &state) override;
|
|
#endif
|
|
#ifdef USE_CLIMATE
|
|
void on_climate_update(climate::Climate *obj) override;
|
|
#endif
|
|
#ifdef USE_NUMBER
|
|
void on_number_update(number::Number *obj, float state) override;
|
|
#endif
|
|
#ifdef USE_DATETIME_DATE
|
|
void on_date_update(datetime::DateEntity *obj) override;
|
|
#endif
|
|
#ifdef USE_DATETIME_TIME
|
|
void on_time_update(datetime::TimeEntity *obj) override;
|
|
#endif
|
|
#ifdef USE_DATETIME_DATETIME
|
|
void on_datetime_update(datetime::DateTimeEntity *obj) override;
|
|
#endif
|
|
#ifdef USE_TEXT
|
|
void on_text_update(text::Text *obj, const std::string &state) override;
|
|
#endif
|
|
#ifdef USE_SELECT
|
|
void on_select_update(select::Select *obj, const std::string &state, size_t index) override;
|
|
#endif
|
|
#ifdef USE_LOCK
|
|
void on_lock_update(lock::Lock *obj) override;
|
|
#endif
|
|
#ifdef USE_VALVE
|
|
void on_valve_update(valve::Valve *obj) override;
|
|
#endif
|
|
#ifdef USE_MEDIA_PLAYER
|
|
void on_media_player_update(media_player::MediaPlayer *obj) override;
|
|
#endif
|
|
#ifdef USE_API_HOMEASSISTANT_SERVICES
|
|
void send_homeassistant_service_call(const HomeassistantServiceResponse &call);
|
|
#endif
|
|
#ifdef USE_API_SERVICES
|
|
void register_user_service(UserServiceDescriptor *descriptor) { this->user_services_.push_back(descriptor); }
|
|
#endif
|
|
#ifdef USE_HOMEASSISTANT_TIME
|
|
void request_time();
|
|
#endif
|
|
|
|
#ifdef USE_ALARM_CONTROL_PANEL
|
|
void on_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj) override;
|
|
#endif
|
|
#ifdef USE_EVENT
|
|
void on_event(event::Event *obj, const std::string &event_type) override;
|
|
#endif
|
|
#ifdef USE_UPDATE
|
|
void on_update(update::UpdateEntity *obj) override;
|
|
#endif
|
|
|
|
bool is_connected() const;
|
|
|
|
#ifdef USE_API_HOMEASSISTANT_STATES
|
|
struct HomeAssistantStateSubscription {
|
|
std::string entity_id;
|
|
optional<std::string> attribute;
|
|
std::function<void(std::string)> callback;
|
|
bool once;
|
|
};
|
|
|
|
void subscribe_home_assistant_state(std::string entity_id, optional<std::string> attribute,
|
|
std::function<void(std::string)> f);
|
|
void get_home_assistant_state(std::string entity_id, optional<std::string> attribute,
|
|
std::function<void(std::string)> f);
|
|
const std::vector<HomeAssistantStateSubscription> &get_state_subs() const;
|
|
#endif
|
|
#ifdef USE_API_SERVICES
|
|
const std::vector<UserServiceDescriptor *> &get_user_services() const { return this->user_services_; }
|
|
#endif
|
|
|
|
#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
|
|
Trigger<std::string, std::string> *get_client_connected_trigger() const { return this->client_connected_trigger_; }
|
|
#endif
|
|
#ifdef USE_API_CLIENT_DISCONNECTED_TRIGGER
|
|
Trigger<std::string, std::string> *get_client_disconnected_trigger() const {
|
|
return this->client_disconnected_trigger_;
|
|
}
|
|
#endif
|
|
|
|
protected:
|
|
void schedule_reboot_timeout_();
|
|
// Pointers and pointer-like types first (4 bytes each)
|
|
std::unique_ptr<socket::Socket> socket_ = nullptr;
|
|
#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
|
|
Trigger<std::string, std::string> *client_connected_trigger_ = new Trigger<std::string, std::string>();
|
|
#endif
|
|
#ifdef USE_API_CLIENT_DISCONNECTED_TRIGGER
|
|
Trigger<std::string, std::string> *client_disconnected_trigger_ = new Trigger<std::string, std::string>();
|
|
#endif
|
|
|
|
// 4-byte aligned types
|
|
uint32_t reboot_timeout_{300000};
|
|
|
|
// Vectors and strings (12 bytes each on 32-bit)
|
|
std::vector<std::unique_ptr<APIConnection>> clients_;
|
|
#ifdef USE_API_PASSWORD
|
|
std::string password_;
|
|
#endif
|
|
std::vector<uint8_t> shared_write_buffer_; // Shared proto write buffer for all connections
|
|
#ifdef USE_API_HOMEASSISTANT_STATES
|
|
std::vector<HomeAssistantStateSubscription> state_subs_;
|
|
#endif
|
|
#ifdef USE_API_SERVICES
|
|
std::vector<UserServiceDescriptor *> user_services_;
|
|
#endif
|
|
|
|
// Group smaller types together
|
|
uint16_t port_{6053};
|
|
uint16_t batch_delay_{100};
|
|
bool shutting_down_ = false;
|
|
// 5 bytes used, 3 bytes padding
|
|
|
|
#ifdef USE_API_NOISE
|
|
std::shared_ptr<APINoiseContext> noise_ctx_ = std::make_shared<APINoiseContext>();
|
|
ESPPreferenceObject noise_pref_;
|
|
#endif // USE_API_NOISE
|
|
};
|
|
|
|
extern APIServer *global_api_server; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
|
|
|
template<typename... Ts> class APIConnectedCondition : public Condition<Ts...> {
|
|
public:
|
|
bool check(Ts... x) override { return global_api_server->is_connected(); }
|
|
};
|
|
|
|
} // namespace esphome::api
|
|
#endif
|