muCom
1.0
The reliable, fast and easy way to exchange binary data via UART
|
File containing the main class for the muCom interface when being used for an Arduino. More...
#include <muCom.h>
Public Member Functions | |
muCom (Stream &ser, uint8_t num_var, uint8_t num_func) | |
![]() | |
muComBase (uint8_t num_var, uint8_t num_func) | |
Constructor of the base class. More... | |
~muComBase (void) | |
Destructor of the base class. | |
int16_t | getLastCommTime (void) |
Get timestamp of last successful communication. More... | |
void | setTimeout (int16_t timeout) |
Set timeout for read requests. More... | |
uint8_t | handle (void) |
Handle the muCom interface. More... | |
int8_t | linkFunction (uint8_t index, muComFunc function) |
Link function to the muCom interface. More... | |
int8_t | linkVariable (uint8_t index, uint8_t *var, uint8_t size) |
Link a variable or a buffer to the muCom interface. More... | |
void | linkVariable (uint8_t index, uint8_t *var) |
void | linkVariable (uint8_t index, int8_t *var) |
void | linkVariable (uint8_t index, uint16_t *var) |
void | linkVariable (uint8_t index, int16_t *var) |
void | linkVariable (uint8_t index, uint32_t *var) |
void | linkVariable (uint8_t index, int32_t *var) |
void | linkVariable (uint8_t index, uint64_t *var) |
void | linkVariable (uint8_t index, int64_t *var) |
void | linkVariable (uint8_t index, float *var) |
void | invokeFunction (uint8_t index, uint8_t *data, uint8_t cnt) |
Invoke a function at the communication partner. More... | |
void | invokeFunction (uint8_t index) |
Invoke a function at the communication partner. More... | |
void | write (uint8_t index, uint8_t *data, uint8_t cnt) |
Write a data array to a remote variable. More... | |
void | writeByte (uint8_t index, uint8_t data) |
Write a byte (8 bit) to the communication partner. More... | |
void | writeShort (uint8_t index, uint16_t data) |
Write a short (16 bit) to the communication partner. More... | |
void | writeLong (uint8_t index, uint32_t data) |
Write a long (32 bit) to the communication partner. More... | |
void | writeLongLong (uint8_t index, uint64_t data) |
Write a long long (64 bit) to the communication partner. More... | |
void | writeFloat (uint8_t index, float data) |
Write a float to the communication partner. More... | |
int8_t | read (uint8_t index, uint8_t *data, uint8_t cnt) |
Read data from the communication partner. More... | |
int8_t | readByte (uint8_t index, uint8_t *data) |
Read a byte from the communication partner. More... | |
int8_t | readByte (uint8_t index, int8_t *data) |
int8_t | readShort (uint8_t index, uint16_t *data) |
Read a short from the communication partner. More... | |
int8_t | readShort (uint8_t index, int16_t *data) |
int8_t | readLong (uint8_t index, uint32_t *data) |
Read a long from the communication partner. More... | |
int8_t | readLong (uint8_t index, int32_t *data) |
int8_t | readLongLong (uint8_t index, uint64_t *data) |
Read a long long from the communication partner. More... | |
int8_t | readLongLong (uint8_t index, int64_t *data) |
int8_t | readFloat (uint8_t index, float *data) |
Read a float from the communication partner. More... | |
uint8_t | readByte (uint8_t index) |
Read a byte from the communication partner. More... | |
uint16_t | readShort (uint8_t index) |
Read a short from the communication partner. More... | |
uint32_t | readLong (uint8_t index) |
Read a long from the communication partner. More... | |
uint64_t | readLongLong (uint8_t index) |
Read a long long from the communication partner. More... | |
float | readFloat (uint8_t index) |
Read a float from the communication partner. More... | |
File containing the main class for the muCom interface when being used for an Arduino.
Main class for the muCom interface when being used for an Arduino
This class inherits all functions from the muCom base class (see muComBase) and additionally implements the interface for the HW access when using the muCom interface on an Arduino. It uses the Stream class for communication which can be implemented by the hardware and software UARTS, as well as USB serial emulations.