Arduino PulseWire Transceiver Library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes
pulsewire::IRReceiver Class Reference

Receiver class for IR communication. More...

#include <IRTransceiver.h>

Inheritance diagram for pulsewire::IRReceiver:
Inheritance graph
[legend]
Collaboration diagram for pulsewire::IRReceiver:
Collaboration graph
[legend]

Public Member Functions

 IRReceiver (IRProtocol info, uint8_t rxPin)
 
 IRReceiver (uint8_t rxPin)
 
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 IRProtocolgetInfo () const
 
void setIRProtocol (IRProtocol &info)
 
void begin ()
 

Static Public Member Functions

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

Protected Attributes

IRMultiProtocol multi_protocol
 

Detailed Description

Receiver class for IR communication.

The IRReceiver class is a specialized version of the IRTransceiver class designed for reception-only operations. It provides a simplified interface for receiving IR signals using an RX driver.

Definition at line 142 of file IRTransceiver.h.

Constructor & Destructor Documentation

◆ IRReceiver() [1/2]

pulsewire::IRReceiver::IRReceiver ( IRProtocol  info,
uint8_t  rxPin 
)
inline

Definition at line 144 of file IRTransceiver.h.

◆ IRReceiver() [2/2]

pulsewire::IRReceiver::IRReceiver ( uint8_t  rxPin)
inline

Definition at line 146 of file IRTransceiver.h.

Member Function Documentation

◆ available()

int pulsewire::IRTransceiver::available ( )
inlineoverrideinherited

Definition at line 62 of file IRTransceiver.h.

◆ begin()

void pulsewire::IRTransceiver::begin ( )
inlineinherited

Definition at line 103 of file IRTransceiver.h.

◆ flush()

void pulsewire::IRTransceiver::flush ( )
inlineoverrideinherited

Definition at line 68 of file IRTransceiver.h.

◆ getInfo()

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

Definition at line 74 of file IRTransceiver.h.

◆ onChange()

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

Definition at line 98 of file IRTransceiver.h.

◆ peek()

int pulsewire::IRTransceiver::peek ( )
inlineoverrideinherited

Definition at line 67 of file IRTransceiver.h.

◆ read()

int pulsewire::IRTransceiver::read ( )
inlineoverrideinherited

Definition at line 66 of file IRTransceiver.h.

◆ readBytes()

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

Definition at line 63 of file IRTransceiver.h.

◆ setIRProtocol()

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

Definition at line 77 of file IRTransceiver.h.

◆ write() [1/2]

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

Definition at line 70 of file IRTransceiver.h.

◆ write() [2/2]

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

Definition at line 69 of file IRTransceiver.h.

Field Documentation

◆ multi_protocol

IRMultiProtocol pulsewire::IRReceiver::multi_protocol
protected

Definition at line 149 of file IRTransceiver.h.


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