embvm::comm Namespace Reference

Definitions, functions, and classes related to communication busses. More...

Enumerations
enum	status {   status::ok = 0, status::enqueued, status::busy, status::error,   status::unknown }
	Generic communication bus status. More...

Detailed Description

Definitions, functions, and classes related to communication busses.

Enumeration Type Documentation

status

enum embvm::comm::status

strong

Generic communication bus status.

This enumeration represents the status of a communication bus. These states are generally found in a variety of communication busses. If they do not apply to the bus you are developing, feel free to ignore them.

You can create your own bus status enumeration for use with the commBus class instead of using the default. However, the types represented here must be included because they are used automatically by the driver. See i2c.hpp for an example.

Enumerator
ok	The operation completed successfully.
enqueued	The operation was enqueued for later processing.
busy	The device cannot handle the request at this time; try again.
error	An error occurred with this transaction.
unknown	The success/failure status of the transaction could not be determined.