m5::unit::UnitSYN115 Class Reference

SYN115 unit. More...

#include <unit_SYN115.hpp>

Inheritance diagram for m5::unit::UnitSYN115:

Classes
struct	config_t
	Settings for begin. More...

Public Member Functions
virtual bool	begin () override
	Initialize the transmitter unit.
virtual void	update (const bool force=false) override
	Update the transmitter unit.
rf433::ProtocolCodec &	codec ()
	Get codec (for codec-specific configuration)
const rf433::ProtocolCodec &	codec () const
	Get codec (for codec-specific configuration)
bool	push_back (const uint8_t *data, const uint32_t len)
	Push back data to payload.
bool	send (const uint8_t burst_transmission_count=0)
	Send force if exists payload.
void	clear ()
	Clear inner buffer.
void	setCodec (rf433::ProtocolCodec &codec)
	Set protocol codec.
void	resetCodec ()
	Reset to default M5Codec.
Configuration for begin
config_t	config ()
	Gets the configuration.
void	config (const config_t &cfg)
	Set the configuration.

Protected Member Functions
TickType_t	estimate_tx_timeout_ticks (const rf433::item_container_type &items, const uint32_t margin_ms=10) const

Detailed Description

SYN115 unit.

RF433 Transmitter

Member Function Documentation

codec() [1/2]

rf433::ProtocolCodec & m5::unit::UnitSYN115::codec ( )

inline

Get codec (for codec-specific configuration)

Returns

The codec set by setCodec(), or the built-in M5Codec if none is set

codec() [2/2]

const rf433::ProtocolCodec & m5::unit::UnitSYN115::codec ( ) const

inline

Get codec (for codec-specific configuration)

Returns

The codec set by setCodec(), or the built-in M5Codec if none is set

push_back()

bool m5::unit::UnitSYN115::push_back	(	const uint8_t *	data,
		const uint32_t	len )

Push back data to payload.

Parameters

data	Input data buffer
len	Length of data buffer

Returns

True if successful

Warning

Total payload size is limited to 255 bytes. The receiver side has a stricter limit based on RMT hardware (rf433::MaxPayloadSize).

See also

rf433::MaxPayloadSize

send()

bool m5::unit::UnitSYN115::send

(

const uint8_t

burst_transmission_count = 0

)

Send force if exists payload.

Parameters

burst_transmission_count

Count of burst transmission (0 = use config_t::burst_transmission_count)

Returns

True if successful

Note

The payload will be empty if successful

setCodec()

void m5::unit::UnitSYN115::setCodec ( rf433::ProtocolCodec & codec )

inline

Set protocol codec.

Parameters

codec

Codec to use. Passing the unit's own built-in codec is the same as resetCodec()

Warning

Caller must ensure the codec outlives this unit