ASCII Serial Com
Serial communication library between computers, microcontrollers, FPGAs, etc. Uses only ASCII. Not the most efficient protocol, but meant to be easy to read
|
ASCII Serial Com Device State struct. More...
#include <ascii_serial_com_device.h>
Public Attributes | |
ascii_serial_com | asc |
char | ascVersion |
char | appVersion |
char | command |
char | dataBuffer [MAXDATALEN] |
size_t | dataLen |
ascii_serial_com_device_config * | config |
ASCII Serial Com Device State struct.
Keeps track of the state of the ASCII Serial Com device
The functions take the stuff from ascii_serial_com_get_message_from_input_buffer plus a void pointer to possible state/configuration info. If the functions are null ptrs, an error message returned to host. This class owns the data buffer passed around.
Definition at line 46 of file ascii_serial_com_device.h.
char __ascii_serial_com_device::appVersion |
Definition at line 50 of file ascii_serial_com_device.h.
ascii_serial_com __ascii_serial_com_device::asc |
used to receive messages and reply
Definition at line 47 of file ascii_serial_com_device.h.
Referenced by ascii_serial_com_device_get_input_buffer(), ascii_serial_com_device_get_output_buffer(), ascii_serial_com_device_init(), ascii_serial_com_device_put_message_in_output_buffer(), ascii_serial_com_device_put_s_message_in_output_buffer(), and ascii_serial_com_device_receive().
char __ascii_serial_com_device::ascVersion |
This and next 4 variables just hold results, putting them here lets them be statically allocated
Definition at line 48 of file ascii_serial_com_device.h.
Referenced by ascii_serial_com_device_receive().
char __ascii_serial_com_device::command |
Definition at line 51 of file ascii_serial_com_device.h.
ascii_serial_com_device_config* __ascii_serial_com_device::config |
Definition at line 54 of file ascii_serial_com_device.h.
char __ascii_serial_com_device::dataBuffer[MAXDATALEN] |
data part of message received here
Definition at line 52 of file ascii_serial_com_device.h.
Referenced by ascii_serial_com_device_receive().
size_t __ascii_serial_com_device::dataLen |
Definition at line 53 of file ascii_serial_com_device.h.