EV3UartGenerator
/home/shenghao/eclipse-workspace/EV3UartGenerator/magics.hpp File Reference
#include <stdint.h>
Include dependency graph for magics.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

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

Detailed Description

Magic values that are used to construct the body of a particular UART message.

See LICENSE for more details

Definition in file magics.hpp.

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.

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.

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.

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.

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.

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.

Definition at line 37 of file magics.hpp.