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:

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
RHGenericDriver *	p_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

Copyright

GPLv3

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

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ReformatBaseStream, MultiOutput, AudioOutput, AudioStreamWrapper, ResampleStream, EncodedAudioStream, HDLCStream, URLStream, BufferedTaskStream, AutomaticGainControlStream, MeasuringStream, QualityAnalysisStream, VolumeStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3BandsT< T >, Equalizer3BandsPerChannelT< T >, I2SStream, TimedStream, HexDumpOutput, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, BaseStream, QueueStream< T >, QueueStream< uint8_t >, FadeStream, Pipeline::ModifyingStreamAdapter, SupportedRatesStream, NamePrinter, VFSFile, ZephyrFile, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

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:

• src/AudioTools/Communication/RadioHeadStream.h