arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ReadioHeadStream Class Reference

Arduino Stream which is using the RadioHead library to send and receive data. We use the river API directly. More...

#include <RadioHeadStream.h>

Inheritance diagram for ReadioHeadStream:
Stream Print

Public Member Functions

 ReadioHeadStream (RHGenericDriver &driver)
 
int available () override
 
int availableForWrite () override
 
bool begin ()
 
void end ()
 
virtual void flush ()
 
 operator bool ()
 
size_t readBytes (uint8_t *data, size_t len) override
 
void setDriver (RHGenericDriver &driver)
 
size_t write (const uint8_t *data, size_t len) override
 

Protected Attributes

int _timeout = 10
 
RxTxMode mode
 
RHGenericDriverp_driver = nullptr
 

Detailed Description

Arduino Stream which is using the RadioHead library to send and receive data. We use the river API directly.

Note
Supported only on Arduino platforms with support for the RadioHead library and the related hardware (e.g. ESP32 with LoRa, nRF24L01, etc.)!
Requires: 👉 https://www.airspayce.com/mikem/arduino/RadioHead/
Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ ReadioHeadStream()

ReadioHeadStream ( RHGenericDriver driver)
inline

Member Function Documentation

◆ available()

int available ( )
inlineoverridevirtual

Reimplemented from Stream.

◆ availableForWrite()

int availableForWrite ( )
inlineoverridevirtual

Reimplemented from Print.

◆ begin()

bool begin ( )
inline

◆ end()

void end ( )
inline

◆ flush()

virtual void flush ( )
inlinevirtualinherited

◆ operator bool()

operator bool ( )
inlineinherited

◆ readBytes()

size_t readBytes ( uint8_t data,
size_t  len 
)
inlineoverridevirtual

Reimplemented from Stream.

◆ setDriver()

void setDriver ( RHGenericDriver driver)
inline

◆ write()

size_t write ( const uint8_t data,
size_t  len 
)
inlineoverridevirtual

Reimplemented from Print.

Member Data Documentation

◆ _timeout

int _timeout = 10
protectedinherited

◆ mode

RxTxMode mode
protected

◆ p_driver

RHGenericDriver* p_driver = nullptr
protected

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