pulsewire::RxDriver Class Reference

Abstract base class for IR receivers. More...

#include <RxDriver.h>

Inheritance diagram for pulsewire::RxDriver:

Public Member Functions
virtual void	setFrameSize (uint16_t size)=0
	Set the expected frame size for dynamic data reception.
virtual bool	begin (uint16_t bitFrequencyHz)=0
	Start the receiver.
virtual void	end ()=0
	Stop the receiver.
virtual size_t	readBytes (uint8_t *data, size_t size)=0
virtual int	available ()=0
	Get the number of bytes available in the internal buffer.
virtual void	setRxBufferSize (size_t size)=0
	Set the size of the internal RX buffer.

Detailed Description

Abstract base class for IR receivers.

Definition at line 10 of file RxDriver.h.

Member Function Documentation

available()

virtual int pulsewire::RxDriver::available ( )

pure virtual

Get the number of bytes available in the internal buffer.

Implemented in pulsewire::RxDriverArduino, pulsewire::RxDriverESP32, and pulsewire::RxDriverRP2040.

begin()

virtual bool pulsewire::RxDriver::begin ( uint16_t  bitFrequencyHz )

pure virtual

Start the receiver.

Implemented in pulsewire::RxDriverArduino.

end()

virtual void pulsewire::RxDriver::end ( )

pure virtual

Stop the receiver.

Implemented in pulsewire::RxDriverArduino, and pulsewire::RxDriverESP32.

readBytes()

virtual size_t pulsewire::RxDriver::readBytes ( uint8_t *  data, size_t  size  )

pure virtual

Read up to 'size' bytes from the internal buffer into 'data'. Returns number of bytes read.

Implemented in pulsewire::RxDriverArduino, pulsewire::RxDriverESP32, and pulsewire::RxDriverRP2040.

setFrameSize()

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

pure virtual

Set the expected frame size for dynamic data reception.

Implemented in pulsewire::RxDriverArduino.

setRxBufferSize()

virtual void pulsewire::RxDriver::setRxBufferSize ( size_t  size )

pure virtual

Set the size of the internal RX buffer.

Implemented in pulsewire::RxDriverArduino, and pulsewire::RxDriverESP32.

---

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

• src/pulse/RxDriver.h