EV3UartGenerator  prerel
Enumerations
EV3UartGenerator::Magics Namespace Reference

Enumerations

enum  SYS : uint8_t {
  SYS::SYS_BASE = 0x00, SYS::SYNC = 0x00, SYS::NACK = 0x02, SYS::ACK = 0x04,
  SYS::ESC = 0x06
}
 
enum  CMD : uint8_t {
  CMD::CMD_BASE = 0x40, CMD::TYPE = 0x00, CMD::MODES = 0x01, CMD::SPEED = 0x02,
  CMD::SELECT = 0x03, CMD::WRITE = 0x04
}
 
enum  INFO : uint8_t { INFO::INFO_BASE = 0x80 }
 
enum  INFO_SPAN : uint8_t { INFO_SPAN::RAW = 0x01, INFO_SPAN::PCT = 0x02, INFO_SPAN::SI = 0x03 }
 
enum  INFO_DTYPE : uint8_t { INFO_DTYPE::S8 = 0x00, INFO_DTYPE::S16 = 0x01, INFO_DTYPE::S32 = 0X02, INFO_DTYPE::F32 = 0x03 }
 
enum  DATA : uint8_t { DATA::DATA_BASE = 0xc0 }
 

Enumeration Type Documentation

◆ CMD

enum EV3UartGenerator::Magics::CMD : uint8_t
strong

Magic values used in forming Command messages for the EV3

CMD_BASE is bitwise OR'd with other enumeration values in this enumeration, as well as the length of the payload, in order to create the magic byte identifying the type of message.

Enumerator
CMD_BASE 

Base magic value for CMD messages.

TYPE 

Type message magic value - used in messages specifying device type to the EV3.

MODES 

Modes message magic value - used in messages specifying number of device modes to the EV3.

SPEED 

Speed message magic value - used in messages specifying the maximum baud rate supported by a device.

SELECT 

Select message magic value - used in messages requesting a device to operate in a particular mode.

WRITE 

Write message magic value - used in messages sending data from the EV3 to the device.

Definition at line 53 of file magics.hpp.

◆ DATA

enum EV3UartGenerator::Magics::DATA : uint8_t
strong

Magic values used in forming Data messages for the EV3

DATA_BASE is bitwise OR'd with the length of the payload as well as the mode number the data message is for to create the magic byte identifying the type of message.

Enumerator
DATA_BASE 

Base magic value for DATA messages.

Definition at line 101 of file magics.hpp.

◆ INFO

enum EV3UartGenerator::Magics::INFO : uint8_t
strong

Magic values used in forming Information messages for the EV3

INFO_BASE is bitwise OR'd with the length of the payload as well as the mode number the information message is for to create the magic byte identifying the type of message.

Enumerator
INFO_BASE 

Base magic value for INFO messages.

Definition at line 69 of file magics.hpp.

◆ INFO_DTYPE

enum EV3UartGenerator::Magics::INFO_DTYPE : uint8_t
strong

Data type magic values used in forming Information messages for the EV3.

Enumerator
S8 

Magic byte to indicate 8 bit signed integers.

S16 

Magic byte to indicate 16 bit signed integers.

S32 

Magic byte to indicate 32 bit signed integers.

F32 

Magic byte to indicate 32 bit IEEE floating points.

Definition at line 87 of file magics.hpp.

◆ INFO_SPAN

enum EV3UartGenerator::Magics::INFO_SPAN : uint8_t
strong

Span type magic values used in forming Information messages for the EV3.

Enumerator
RAW 

Magic byte to indicate RAW span message.

PCT 

Magic byte to indicate PCT span message.

SI 

Magic byte to indicate SI span message.

Definition at line 77 of file magics.hpp.

◆ SYS

enum EV3UartGenerator::Magics::SYS : uint8_t
strong

Magic values used in forming System messages for the EV3

SYS_BASE is bitwise OR'd with other enumeration values in this enumeration in order to create the magic byte identifying the type of message.

Enumerator
SYS_BASE 

Base magic value for SYS messages.

SYNC 

Sync message magic value - used for clock syncs.

NACK 

NACK message magic value.

ACK 

ACK message magic value.

ESC 

ESC message magic value - currently unused.

Definition at line 37 of file magics.hpp.