pulsewire::IRTransceiver Class Reference

IRTransceiver: High-level interface for sending and receiving IR signals. More...

#include <IRTransceiver.h>

Inheritance diagram for pulsewire::IRTransceiver:

Collaboration diagram for pulsewire::IRTransceiver:

Public Member Functions
	IRTransceiver (IRProtocol &protocol, uint8_t rxPin, uint8_t txPin)
	Constructor for defined Protocol.
	IRTransceiver (IRMultiProtocol &protocol, uint8_t rxPin, uint8_t txPin)
	Constructor for Multiple Protocols.
int	available () override
size_t	readBytes (uint8_t *data, size_t len)
int	read () override
int	peek () override
void	flush () override
size_t	write (uint8_t b) override
size_t	write (const uint8_t *data, size_t len)
const IRProtocol &	getInfo () const
void	setIRProtocol (IRProtocol &info)
void	begin ()

Static Public Member Functions
static void	onChange (IRProtocolEnum proto, IRProtocol &info, void *ref)

Detailed Description

IRTransceiver: High-level interface for sending and receiving IR signals.

This class manages the encoding, decoding, and transmission of IR signals using supported protocols. It provides methods to configure protocol parameters, handle input/output pins, and process IR data streams. The class abstracts the details of protocol detection and signal timing, allowing users to easily integrate IR communication into their applications.

Features:

• Supports multiple IR protocols (NEC, Sony, RC5, etc.)
• Handles both transmission and reception of IR signals
• Configurable timing and protocol parameters
• Designed for use with Arduino-compatible hardware

Definition at line 26 of file IRTransceiver.h.

Constructor & Destructor Documentation

IRTransceiver() [1/2]

pulsewire::IRTransceiver::IRTransceiver ( IRProtocol &  protocol, uint8_t  rxPin, uint8_t  txPin  )

inline

Constructor for defined Protocol.

Definition at line 29 of file IRTransceiver.h.

IRTransceiver() [2/2]

pulsewire::IRTransceiver::IRTransceiver ( IRMultiProtocol &  protocol, uint8_t  rxPin, uint8_t  txPin  )

inline

Constructor for Multiple Protocols.

Definition at line 44 of file IRTransceiver.h.

Member Function Documentation

available()

int pulsewire::IRTransceiver::available ( )

inlineoverride

Definition at line 62 of file IRTransceiver.h.

begin()

void pulsewire::IRTransceiver::begin ( )

inline

Definition at line 103 of file IRTransceiver.h.

flush()

void pulsewire::IRTransceiver::flush ( )

inlineoverride

Definition at line 68 of file IRTransceiver.h.

getInfo()

const IRProtocol & pulsewire::IRTransceiver::getInfo ( ) const

inline

Definition at line 74 of file IRTransceiver.h.

onChange()

static void pulsewire::IRTransceiver::onChange ( IRProtocolEnum  proto, IRProtocol &  info, void *  ref  )

inlinestatic

Definition at line 98 of file IRTransceiver.h.

peek()

int pulsewire::IRTransceiver::peek ( )

inlineoverride

Definition at line 67 of file IRTransceiver.h.

read()

int pulsewire::IRTransceiver::read ( )

inlineoverride

Definition at line 66 of file IRTransceiver.h.

readBytes()

size_t pulsewire::IRTransceiver::readBytes ( uint8_t *  data, size_t  len  )

inline

Definition at line 63 of file IRTransceiver.h.

setIRProtocol()

void pulsewire::IRTransceiver::setIRProtocol ( IRProtocol &  info )

inline

Definition at line 77 of file IRTransceiver.h.

write() [1/2]

size_t pulsewire::IRTransceiver::write ( const uint8_t *  data, size_t  len  )

inline

Definition at line 70 of file IRTransceiver.h.

write() [2/2]

size_t pulsewire::IRTransceiver::write ( uint8_t  b )

inlineoverride

Definition at line 69 of file IRTransceiver.h.

---

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

• src/IRTransceiver.h