arduino-emulator
Loading...
Searching...
No Matches
arduino::RemoteSerialClass Class Reference

Remote Serial implementation that operates over a communication stream. More...

#include <RemoteSerial.h>

Inheritance diagram for arduino::RemoteSerialClass:
arduino::Stream arduino::Print

Public Member Functions

 RemoteSerialClass (Stream &stream, uint8_t no)
virtual int available ()
virtual void begin (unsigned long baudrate)
virtual void begin (unsigned long baudrate, uint16_t config)
virtual void end ()
void flush ()
 operator bool ()
virtual int peek ()
virtual int read ()
virtual size_t readBytes (uint8_t *buffer, size_t length)
size_t write (const uint8_t *str, size_t len) override
virtual size_t write (uint8_t c)
Public Member Functions inherited from arduino::Stream
bool find (char target)
bool find (const char *target)
bool find (const char *target, size_t length)
bool find (const uint8_t *target)
bool find (const uint8_t *target, size_t length)
bool findUntil (const char *target, const char *terminator)
bool findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
bool findUntil (const uint8_t *target, const char *terminator)
bool findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
unsigned long getTimeout (void)
float parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
long parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
size_t readBytes (char *buffer, size_t length)
size_t readBytes (uint8_t *buffer, size_t length)
size_t readBytesUntil (char terminator, char *buffer, size_t length)
size_t readBytesUntil (char terminator, uint8_t *buffer, size_t length)
String readString ()
String readStringUntil (char terminator)
void setTimeout (unsigned long timeout)
Public Member Functions inherited from arduino::Print
virtual int availableForWrite ()
void clearWriteError ()
int getWriteError ()
size_t print (char)
size_t print (const __FlashStringHelper *)
size_t print (const char[])
size_t print (const Printable &)
size_t print (const String &)
size_t print (double, int=2)
size_t print (int, int=DEC)
size_t print (long long, int=DEC)
size_t print (long, int=DEC)
size_t print (unsigned char, int=DEC)
size_t print (unsigned int, int=DEC)
size_t print (unsigned long long, int=DEC)
size_t print (unsigned long, int=DEC)
size_t println (char)
size_t println (const __FlashStringHelper *)
size_t println (const char[])
size_t println (const Printable &)
size_t println (const String &s)
size_t println (double, int=2)
size_t println (int, int=DEC)
size_t println (long long, int=DEC)
size_t println (long, int=DEC)
size_t println (unsigned char, int=DEC)
size_t println (unsigned int, int=DEC)
size_t println (unsigned long long, int=DEC)
size_t println (unsigned long, int=DEC)
size_t println (void)
size_t write (const char *buffer, size_t size)
size_t write (const char *str)

Protected Attributes

int max_buffer_len = 512
uint8_t no
RingBufferExt read_buffer
HardwareService service
RingBufferExt write_buffer
Protected Attributes inherited from arduino::Stream
unsigned long _startMillis
unsigned long _timeout

Static Protected Attributes

static constexpr int max_buffer_len = 512

Additional Inherited Members

Protected Member Functions inherited from arduino::Stream
int findMulti (struct MultiTarget *targets, int tCount)
float parseFloat (char ignore)
long parseInt (char ignore)
int peekNextDigit (LookaheadMode lookahead, bool detectDecimal)
int timedPeek ()
int timedRead ()
Protected Member Functions inherited from arduino::Print
void setWriteError (int err=1)

Detailed Description

Remote Serial implementation that operates over a communication stream.

RemoteSerialClass provides Serial/UART functionality by forwarding all operations to a remote Serial controller via a communication stream. This enables Serial communication to be performed on remote hardware while maintaining the standard Stream interface with buffering capabilities.

Key features:

  • Complete Stream interface implementation
  • Stream-based remote communication protocol
  • Bidirectional buffering for read and write operations
  • Support for multiple serial ports via port numbering
  • Standard Serial operations (begin, end, baud rate configuration)
  • Optimized buffering for single character and bulk operations
  • Real-time bidirectional communication with remote Serial hardware

The class uses HardwareService for protocol handling and maintains separate read and write buffers for efficient data transfer. It can work with any Stream implementation (Serial, TCP, etc.) for remote connectivity.

See also
Stream
HardwareService
RingBufferExt

Member Function Documentation

◆ available()

virtual int arduino::RemoteSerialClass::available ( void )
inlinevirtual

Implements arduino::Stream.

◆ flush()

void arduino::RemoteSerialClass::flush ( void )
inlinevirtual

Reimplemented from arduino::Print.

◆ peek()

virtual int arduino::RemoteSerialClass::peek ( void )
inlinevirtual

Implements arduino::Stream.

◆ read()

virtual int arduino::RemoteSerialClass::read ( void )
inlinevirtual

Implements arduino::Stream.

◆ write() [1/2]

size_t arduino::RemoteSerialClass::write ( const uint8_t * str,
size_t len )
inlineoverridevirtual

Reimplemented from arduino::Print.

◆ write() [2/2]

virtual size_t arduino::RemoteSerialClass::write ( uint8_t c)
inlinevirtual

Implements arduino::Print.


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