pulsewire::TxProtocol Class Reference

Abstract base class for defining transmission protocols. More...

#include <TxProtocol.h>

Inheritance diagram for pulsewire::TxProtocol:

Public Member Functions
virtual bool	begin (uint16_t bitFrequencyHz, Codec *p_codec, uint8_t pin)=0
virtual void	setFrameSize (uint16_t size)=0
virtual void	sendPreamble ()=0
virtual void	sendData (const uint8_t *data, uint8_t len)=0
virtual void	sendEnd (bool &_useChecksum, bool isDelayAfterFrame)=0
virtual bool	isFrameClosed () const =0

Detailed Description

Abstract base class for defining transmission protocols.

The TxProtocol class provides an interface for implementing various transmission protocols. It defines the essential methods required for managing the transmission of data, including preamble, data, and end signals.

Responsibilities of the TxProtocol class include:

• Initializing the protocol with a codec and transmission pin.
• Configuring the size of the data to be transmitted.
• Sending preambles, data, and end signals based on the protocol's requirements.
• Managing the state of the transmission frame.

This class is designed to be extended by specific protocol implementations that define the behavior of these methods.

Definition at line 125 of file TxProtocol.h.

Member Function Documentation

begin()

virtual bool pulsewire::TxProtocol::begin ( uint16_t  bitFrequencyHz, Codec *  p_codec, uint8_t  pin  )

pure virtual

Implemented in pulsewire::TxProtocolGeneric.

isFrameClosed()

virtual bool pulsewire::TxProtocol::isFrameClosed ( ) const

pure virtual

Implemented in pulsewire::TxProtocolGeneric.

sendData()

virtual void pulsewire::TxProtocol::sendData ( const uint8_t *  data, uint8_t  len  )

pure virtual

Implemented in pulsewire::TxProtocolGeneric.

sendEnd()

virtual void pulsewire::TxProtocol::sendEnd ( bool &  _useChecksum, bool  isDelayAfterFrame  )

pure virtual

Implemented in pulsewire::TxProtocolGeneric.

sendPreamble()

virtual void pulsewire::TxProtocol::sendPreamble ( )

pure virtual

Implemented in pulsewire::TxProtocolGeneric.

setFrameSize()

virtual void pulsewire::TxProtocol::setFrameSize ( uint16_t  size )

pure virtual

Implemented in pulsewire::TxProtocolGeneric.

---

The documentation for this class was generated from the following file:

• src/pulse/TxProtocol.h