cs_SerialTypes.h File Reference

#include <stdint.h>

Include dependency graph for cs_SerialTypes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SERIAL_NONE   0
	The log levels follow more or less common conventions with a few exceptions. More...
#define	SERIAL_READ_ONLY   1
#define	SERIAL_BYTE_PROTOCOL_ONLY   2
#define	SERIAL_FATAL   3
#define	SERIAL_ERROR   4
#define	SERIAL_WARN   5
#define	SERIAL_INFO   6
#define	SERIAL_DEBUG   7
#define	SERIAL_VERBOSE   8
#define	SERIAL_VERY_VERBOSE   9
#define	SERIAL_CRLF   "\r\n"
#define	SERIAL_VERBOSITY   SERIAL_NONE

Typedefs
typedef void(*	serial_read_callback) (uint8_t val)

Enumerations
enum	serial_enable_t { SERIAL_ENABLE_NONE = 0 , SERIAL_ENABLE_RX_ONLY = 1 , SERIAL_ENABLE_RX_AND_TX = 3 }

Macro Definition Documentation

SERIAL_BYTE_PROTOCOL_ONLY

#define SERIAL_BYTE_PROTOCOL_ONLY   2

SERIAL_CRLF

#define SERIAL_CRLF   "\r\n"

SERIAL_DEBUG

#define SERIAL_DEBUG   7

SERIAL_ERROR

#define SERIAL_ERROR   4

SERIAL_FATAL

#define SERIAL_FATAL   3

SERIAL_INFO

#define SERIAL_INFO   6

SERIAL_NONE

#define SERIAL_NONE   0

The log levels follow more or less common conventions with a few exceptions.

There are some modes in which we run where even fatal messages will not be written to console. In production we use SERIAL_NONE, SERIAL_READ_ONLY, or SERIAL_BYTE_PROTOCOL_ONLY.

SERIAL_READ_ONLY

#define SERIAL_READ_ONLY   1

SERIAL_VERBOSE

#define SERIAL_VERBOSE   8

SERIAL_VERBOSITY

#define SERIAL_VERBOSITY   SERIAL_NONE

SERIAL_VERY_VERBOSE

#define SERIAL_VERY_VERBOSE   9

SERIAL_WARN

#define SERIAL_WARN   5

Typedef Documentation

serial_read_callback

typedef void(* serial_read_callback) (uint8_t val)

Enumeration Type Documentation

serial_enable_t

enum serial_enable_t

Enumerator
SERIAL_ENABLE_NONE
SERIAL_ENABLE_RX_ONLY
SERIAL_ENABLE_RX_AND_TX