Skip to content

Class SerialStream

ClassList > SerialStream

Inherits the following classes: Duplex

Public Functions

Type Name
SerialStream (uart_port_t uartNum, int baudRate, int rxBufferSize, int txBufferSize, int txPin=UART_PIN_NO_CHANGE, int rxPin=UART_PIN_NO_CHANGE, int rtsPin=UART_PIN_NO_CHANGE, int ctsPin=UART_PIN_NO_CHANGE)
SerialStream (SerialStream &&) = delete
SerialStream (const SerialStream &) = delete
bool flush () override
int get () override
void onData (Func callback)
SerialStream & operator= (SerialStream &&) = delete
SerialStream & operator= (const SerialStream &) = delete
bool put (uint8_t c) override
size_t read (std::span< uint8_t > data) override
size_t write (std::span< const uint8_t > data) override
~SerialStream () override

Public Functions Documentation

function SerialStream [1/3]

inline SerialStream::SerialStream (
    uart_port_t uartNum,
    int baudRate,
    int rxBufferSize,
    int txBufferSize,
    int txPin=UART_PIN_NO_CHANGE,
    int rxPin=UART_PIN_NO_CHANGE,
    int rtsPin=UART_PIN_NO_CHANGE,
    int ctsPin=UART_PIN_NO_CHANGE
)

function SerialStream [2/3]

SerialStream::SerialStream (
    SerialStream &&
) = delete

function SerialStream [3/3]

SerialStream::SerialStream (
    const SerialStream &
) = delete

function flush

inline bool SerialStream::flush () override

function get

inline int SerialStream::get () override

function onData

template<typename Func typename Func>
inline void SerialStream::onData (
    Func callback
)

function operator=

SerialStream & SerialStream::operator= (
    SerialStream &&
) = delete

function operator=

SerialStream & SerialStream::operator= (
    const SerialStream &
) = delete

function put

inline bool SerialStream::put (
    uint8_t c
) override

function read

inline size_t SerialStream::read (
    std::span< uint8_t > data
) override

function write

inline size_t SerialStream::write (
    std::span< const uint8_t > data
) override

function ~SerialStream

inline SerialStream::~SerialStream () override

The documentation for this class was generated from the following file demo-projets/jaculus/main/serialStream.h