mirror of
https://github.com/esphome/esphome.git
synced 2026-09-21 12:08:38 +00:00
62 lines
2.4 KiB
C++
62 lines
2.4 KiB
C++
#pragma once
|
|
#include "api_frame_helper.h"
|
|
#ifdef USE_API
|
|
#ifdef USE_API_PLAINTEXT
|
|
|
|
namespace esphome::api {
|
|
|
|
class APIPlaintextFrameHelper final : public APIFrameHelper {
|
|
public:
|
|
// Plaintext header structure (worst case):
|
|
// Pos 0: indicator (0x00)
|
|
// Pos 1-3: payload size varint (up to 3 bytes)
|
|
// Pos 4-5: message type varint (up to 2 bytes; covers message IDs up to
|
|
// 16383, enforced by the proto codegen)
|
|
// Pos 6+: actual payload data
|
|
static constexpr uint8_t HEADER_PADDING = 1 + 3 + 2; // indicator + size varint + type varint
|
|
|
|
explicit APIPlaintextFrameHelper(std::unique_ptr<socket::Socket> socket) : APIFrameHelper(std::move(socket)) {
|
|
frame_header_padding_ = HEADER_PADDING;
|
|
}
|
|
~APIPlaintextFrameHelper() override = default;
|
|
APIError init() override;
|
|
APIError loop() override;
|
|
APIError read_packet(ReadPacketBuffer *buffer) override;
|
|
APIError write_protobuf_packet(uint16_t type, ProtoWriteBuffer buffer) override;
|
|
APIError write_protobuf_messages(ProtoWriteBuffer buffer, std::span<const MessageInfo> messages) override;
|
|
#ifdef USE_API_NOISE
|
|
// After try_read_frame_ returned PROTOCOL_SWITCH_TO_NOISE: copy out the
|
|
// header bytes already consumed from the socket (at most 3, the size of the
|
|
// Noise fixed header) so the replacement Noise helper can be seeded with them.
|
|
uint8_t get_consumed_header(uint8_t out[3]) const {
|
|
memcpy(out, this->rx_header_buf_, this->rx_header_buf_pos_);
|
|
return this->rx_header_buf_pos_;
|
|
}
|
|
#endif
|
|
|
|
protected:
|
|
APIError try_read_frame_();
|
|
|
|
// Group 2-byte aligned types
|
|
uint16_t rx_header_parsed_type_ = 0;
|
|
uint16_t rx_header_parsed_len_ = 0;
|
|
|
|
// Group 1-byte types together
|
|
// Fixed-size header buffer for plaintext protocol:
|
|
// We now store the indicator byte + the two varints.
|
|
// To match noise protocol's maximum message size (UINT16_MAX = 65535), we need:
|
|
// 1 byte for indicator + 3 bytes for message size varint (supports up to 2097151) + 2 bytes for message type varint
|
|
//
|
|
// While varints could theoretically be up to 10 bytes each for 64-bit values,
|
|
// attempting to process messages with headers that large would likely crash the
|
|
// ESP32 due to memory constraints.
|
|
uint8_t rx_header_buf_[6]; // 1 byte indicator + 5 bytes for varints (3 for size + 2 for type)
|
|
uint8_t rx_header_buf_pos_ = 0;
|
|
bool rx_header_parsed_ = false;
|
|
// 8 bytes total, no padding needed
|
|
};
|
|
|
|
} // namespace esphome::api
|
|
#endif // USE_API_PLAINTEXT
|
|
#endif // USE_API
|