protocol_codec.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_RF433_CODEC_PROTOCOL_CODEC_HPP
#define M5_UNIT_RF433_CODEC_PROTOCOL_CODEC_HPP
 
#include "../rmt_item_types.hpp"
 
namespace m5 {
namespace unit {
namespace rf433 {
 
struct DecodeResult {
    communication_identifier_t id{};  
    uint8_t send_count{};             
    uint8_t payload_length{};         
    uint16_t payload_offset{};        
};
 
enum class CodecType : uint8_t {
    M5RF433 = 0,  
    // Future protocol support (not yet implemented):
    // EV1527,     //!< EV1527 / HS1527 / RT1527 (24-bit code + sync)
    // PT2262,     //!< PT2262 / PT2272 (tri-state encoding)
    // RadioHead,  //!< RadioHead / VirtualWire ASK compatible
    Custom = 255,  
};
 
class ProtocolCodec {
public:
    explicit ProtocolCodec(CodecType t) : _type(t)
    {
    }
    virtual ~ProtocolCodec() = default;
 
    CodecType type() const
    {
        return _type;
    }
 
 
    virtual item_container_type encode(const uint8_t* payload, uint32_t payload_len) = 0;
 
 
    virtual bool decode(const gpio::m5_rmt_item_t* items, uint32_t num, uint8_t* work_buf, uint16_t work_buf_size,
                        DecodeResult& result) = 0;
 
 
    virtual uint8_t overhead() const = 0;
 
private:
    CodecType _type;
};
 
}  // namespace rf433
}  // namespace unit
}  // namespace m5
#endif