Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
openmrn_arduino::Esp32HardwareSerialAdapter Class Reference

Public Member Functions

 Esp32HardwareSerialAdapter (HardwareSerial &serial)
 Constructor.
 
size_t availableForWrite ()
 Returns the usable capacity of the underlying HardwareSerial transmit buffer.
 
size_t write (const char *buffer, size_t len)
 Writes a byte stream to the underlying HardwareSerial device.
 
size_t available ()
 
size_t read (const char *buffer, size_t len)
 Reads a byte stream from the underlying HardwareSerial device.
 

Private Attributes

HardwareSerial & serial_
 HardwareSerial device being wrapped.
 

Detailed Description

Definition at line 43 of file Esp32HardwareSerialAdapter.hxx.

Constructor & Destructor Documentation

◆ Esp32HardwareSerialAdapter()

openmrn_arduino::Esp32HardwareSerialAdapter::Esp32HardwareSerialAdapter ( HardwareSerial &  serial)
inline

Constructor.

Parameters
serialHardwareSerial device to use as a bridge to the OpenMRN system.

Definition at line 49 of file Esp32HardwareSerialAdapter.hxx.

Member Function Documentation

◆ available()

size_t openmrn_arduino::Esp32HardwareSerialAdapter::available ( )
inline
Returns
the number of bytes available to read from the underlying HardwareSerial device.

Definition at line 70 of file Esp32HardwareSerialAdapter.hxx.

◆ availableForWrite()

size_t openmrn_arduino::Esp32HardwareSerialAdapter::availableForWrite ( )
inline

Returns the usable capacity of the underlying HardwareSerial transmit buffer.

Definition at line 55 of file Esp32HardwareSerialAdapter.hxx.

◆ read()

size_t openmrn_arduino::Esp32HardwareSerialAdapter::read ( const char *  buffer,
size_t  len 
)
inline

Reads a byte stream from the underlying HardwareSerial device.

Parameters
bufferbuffer to read into.
lensize of the buffer to read into.

Definition at line 79 of file Esp32HardwareSerialAdapter.hxx.

◆ write()

size_t openmrn_arduino::Esp32HardwareSerialAdapter::write ( const char *  buffer,
size_t  len 
)
inline

Writes a byte stream to the underlying HardwareSerial device.

Parameters
bufferbyte stream to be transmitted.
lenlength of byte stream to be transmitted.

Definition at line 64 of file Esp32HardwareSerialAdapter.hxx.

Member Data Documentation

◆ serial_

HardwareSerial& openmrn_arduino::Esp32HardwareSerialAdapter::serial_
private

HardwareSerial device being wrapped.

Definition at line 86 of file Esp32HardwareSerialAdapter.hxx.


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