protocol_codec.hpp File Reference

Protocol codec base class for RF433. More...

#include "../rmt_item_types.hpp"

Go to the source code of this file.

Classes
struct	m5::unit::rf433::DecodeResult
	Result of decoding a received frame. More...
class	m5::unit::rf433::ProtocolCodec
	Abstract base class for RF433 protocol encoding/decoding. More...

Namespaces
namespace	m5
	Top level namespace of M5Stack.

Enumerations
enum class	m5::unit::rf433::CodecType : uint8_t { M5RF433 = 0 , Custom = 255 }
	Identifies the protocol codec implementation. More...

Detailed Description

Protocol codec base class for RF433.

Enumeration Type Documentation

CodecType

enum class m5::unit::rf433::CodecType : uint8_t

strong

Identifies the protocol codec implementation.

To create a custom protocol, derive from ProtocolCodec with CodecType::Custom and implement encode()/decode()/overhead(). See M5Codec (m5_codec.hpp) as a reference.

Enumerator
M5RF433	M5Unit-RF433 original protocol (. See also M5Codec)
Custom	User-defined custom protocol.