client.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <esphome/api/bytes.hpp>
#include <esphome/api/client_options.hpp>
#include <esphome/api/connection/connection.hpp>
#include <esphome/api/connection/connection_state.hpp>
#include <esphome/api/proto/proto_message.hpp>
 
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <system_error>
 
namespace esphome::api {
 
struct DeviceInfo;
class EntityStore;
class EntityRegistry;
class BluetoothProxy;
class LogStream;
class HomeAssistantServices;
class VoiceAssistant;
class ZWaveProxy;
class SerialProxy;
class SerialPort;
 
class Client {
public:
    using ConnectHandler = std::function<void(std::error_code)>;
    using MessageHandler = std::function<void(const ProtoMessage&)>;
    using RawHandler = std::function<void(std::uint32_t msg_type, ByteView payload)>;
    using StateHandler = std::function<void(ConnectionState)>;
    using ErrorHandler = std::function<void(std::error_code, const std::string&)>;
 
    explicit Client(ClientOptions options);
    ~Client();
 
    Client(const Client&) = delete;
    Client& operator=(const Client&) = delete;
 
    // --- Connection lifecycle ------------------------------------------------
    void async_connect(ConnectHandler on_done) const;
 
    void disconnect() const;
 
    [[nodiscard]] ConnectionState state() const;
    [[nodiscard]] bool is_connected() const;
    [[nodiscard]] const ServerHello& server_hello() const;
 
    // --- Messaging -----------------------------------------------------------
    void send(const ProtoMessage& msg) const;
    void send_raw(std::uint32_t msg_type, ByteView payload) const;
 
    void on(std::uint32_t msg_type, MessageHandler handler) const;
    void on_any(MessageHandler handler) const;
    void on_raw(RawHandler handler) const;
    void on_state(StateHandler handler) const;
    void on_error(ErrorHandler handler) const;
 
    // --- Event loop ----------------------------------------------------------
    void run() const;
    std::size_t run_for(std::chrono::milliseconds duration) const;
    std::size_t run_one() const;
    std::size_t poll() const;
    void stop() const;
    void restart() const;
    void post(std::function<void()> fn) const;
 
    [[nodiscard]] Connection& connection() const;
 
    // --- Entities ------------------------------------------------------------
    [[nodiscard]] EntityStore& store();
    [[nodiscard]] const EntityStore& store() const;
 
    [[nodiscard]] EntityRegistry entities();
 
    void request_entity_list() const;
    void subscribe_to_states() const;
 
    // --- Subsystems (lazily created, owned by the client) --------------------
    [[nodiscard]] BluetoothProxy& bluetooth();
    [[nodiscard]] LogStream& logs();
    [[nodiscard]] HomeAssistantServices& home_assistant();
    [[nodiscard]] VoiceAssistant& voice();
    [[nodiscard]] ZWaveProxy& zwave();
    [[nodiscard]] SerialProxy& serial();
 
    [[nodiscard]] SerialPort serial_proxy(std::uint32_t instance);
 
    [[nodiscard]] SerialPort serial_proxy(const std::string& name);
 
    [[nodiscard]] bool has_device_info() const;
    [[nodiscard]] const DeviceInfo& device_info() const;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace esphome::api