Lamp-Da/serial_8h_source.html

#ifndef HAL_SERIAL_H

#define HAL_SERIAL_H


#include <cstddef>

#include <cstdint>


namespace lampda {

namespace hal {

namespace serial {


extern void init();


extern bool is_activated();


extern bool is_available();


extern char read();


extern size_t write(const char* const buffer, size_t bufferSize);


uint16_t mtu_size();


} // namespace serial

} // namespace hal

} // namespace lampda


#endif

lampda::hal::serial::is_activated
bool is_activated()
Return true if the serial port is active.
Definition: serial.cpp:14

lampda::hal::serial::is_available
bool is_available()
Return true if a char is available to read.
Definition: serial.cpp:15

lampda::hal::serial::mtu_size
uint16_t mtu_size()
Return the usable MTU size.
Definition: serial.cpp:19

lampda::hal::serial::init
void init()
call once at program start
Definition: serial.cpp:13

lampda::hal::serial::read
char read()
Read a character (blocking)
Definition: serial.cpp:16

lampda::hal::serial::write
size_t write(const char *const buffer, size_t bufferSize)
Write a char buffer to the serial port.
Definition: serial.cpp:17

lampda
Program scope.
Definition: control_fixed_modes.hpp:12