cornelluniversity::vetserial Namespace Reference

Classes
class	asynch_serial
	An asynchronous serial object based on the boost::asio library utilizing asynch reads. More...
class	base_command
	A pure virtual abstraction which serves as the basis of the vet serial protocol command structure. More...
class	control_request
	base_command Implements a control (or header-only) command. More...
class	status_request
	base_command Implements a control command soliciting a status check from the remote machine. More...
class	status_response
	base_command Implements a control command responding to another machine's request for a status check. More...
class	mp3_play_request
	base_command Implements a request to initiate the playing of an MP3 device on the remote device. More...
class	mp3_stop_request
	base_command Implements a request to to stop the playing of a track that is currently in playback on the remote device. More...
Typedefs
typedef enum cornelluniversity::vetserial::STATUS_TYPE	status_t
typedef enum cornelluniversity::vetserial::COMMAND_ID	cmnd_id
typedef enum cornelluniversity::vetserial::ERROR_CODE	err_code
typedef enum cornelluniversity::vetserial::FLAG_TYPE	flag_t
Enumerations
enum	STATUS_TYPE { STATUS_ERROR = 0x10, STATUS_READY = 0x20, STATUS_BUSY = 0x40 }
	System status flags. More...
enum	COMMAND_ID {   CMD_CNTRL = 0x00, CMD_REQSTAT = 0x01, CMD_RSPSTAT = 0x02, CMD_PLAY_MP3 = 0x03,   CMD_STOP_MP3 = 0x04, CMD_MAXCMD = 0xFF }
	System command identifiers. More...
enum	ERROR_CODE {   E_NOERROR = 0x00, E_DATAOOB = 0x01, E_NULLPTR = 0x02, E_CHKSUM = 0x03,   E_NONPROTO = 0xFE, E_UNKNOWN = 0xFF }
	System error codes. More...
enum	FLAG_TYPE {   FLAG_REQ = 0x01, FLAG_ACK = 0x02, FLAG_NAK = 0x04, FLAG_DATA = 0x08,   FLAG_ERR = 0x10, FLAG_RDY = 0x20, FLAG_BUSY = 0x40, FLAG_RESRVD = 0x80 }
	System control flags (a bit field). More...

---

Enumeration Type Documentation

enum cornelluniversity::vetserial::STATUS_TYPE

System status flags.

Enumerator:

STATUS_ERROR	the system is in an error state
STATUS_READY	the system is in ready state
STATUS_BUSY	the system is in a busy state, and may be unresponsive

Definition at line 78 of file vetprot.h.

enum cornelluniversity::vetserial::COMMAND_ID

System command identifiers.

Enumerator:

CMD_CNTRL	header-only control message
CMD_REQSTAT	status request
CMD_RSPSTAT	status response
CMD_PLAY_MP3	request to play an mp3 track
CMD_STOP_MP3	stop an mp3 track that is currently playing
CMD_MAXCMD	upper-bound limit for command identifiers, establishes an 8-bit limit

Definition at line 88 of file vetprot.h.

enum cornelluniversity::vetserial::ERROR_CODE

System error codes.

Enumerator:

E_NOERROR	operation completed successfully
E_DATAOOB	data values out of bounds for protocol defined constraints
E_NULLPTR	a null pointer was supplied where data was required
E_CHKSUM	bad checksum received
E_NONPROTO	a non-protocol related error has occured
E_UNKNOWN	no such error value, servers as upper-bound limit and establishes an 8-bit limit

Definition at line 101 of file vetprot.h.

enum cornelluniversity::vetserial::FLAG_TYPE

System control flags (a bit field).

Enumerator:

FLAG_REQ	OR with ACK, NAK, DATA to turn the call into a request for those operations
FLAG_ACK	enable to acknowledge a request or OR with FLAG_REQ to request a call be acknowledged
FLAG_NAK	enable to negatively acknowledge a request or OR with FLAG_REQ to request a call be negatively acknowledged
FLAG_DATA	enable to indicate the data-id field is populated or OR with FLAG_REQ to request the contents of the data-id field be echoed
FLAG_ERR	enable to indicate an error state. populate or interrogate (as appropriate) the error_code byte if this flag is set
FLAG_RDY	enable to indicate the system is in a ready state; able to receive and transmit commands
FLAG_BUSY	enable to indicate that the system is in a busy state is unable to participate in normal protocol semantics
FLAG_RESRVD	reserved for future use

Definition at line 114 of file vetprot.h.

---