Roomba  Alpha
Documentation on our take on the Roomba open interface
Roomba Namespace Reference

Classes

class  Roomba
 
union  sensorData
 

Enumerations

enum  direction { Forward, Left, Right, Backward }
 
enum  cleaning { Spot, Clean, cleaning::Max }
 
enum  control { control::No_init, control::Passive, Safe, Full }
 
enum  sensors : uint8_t {
  Bumps_wheeldrop = 7, Wall = 8, Cliff_Left = 9, Cliff_Front_Left = 10,
  Cliff_Front_Right = 11, Cliff_Right = 12, VirtualWall = 13, MotorOvercurrent = 14,
  RCM = 17, sButtons = 18, Distance = 19, Angle = 20,
  ChargingState = 21, Voltage = 22, Current = 23, Temperature = 24,
  Charge = 25, Capacity = 26
}
 
enum  leds : uint8_t { LED_Debris = 1, LED_Spot = 2, LED_Dock = 4, LED_Check_Robot = 8 }
 
enum  command : uint8_t {
  Start = 128, Baud, Control, Safe,
  Safe, Full, Full, Power,
  Spot, Spot, Clean, Clean,
  Max_Clean, Drive, Motors, Leds,
  Song, Play, Query, Dock,
  Motor_PWM, Drive_Wheels, Stream = 148, Query_List,
  Do_Stream, Schedule_Leds = 162, Digit_Leds_Raw, Digit_Leds_Ascii,
  Buttons, Schedule = 167, Set_Date_Time, Stop = 173,
  Sensor = 142, SensorList = 149
}
 
enum  ledState { ledState::On, ledState::Off }
 

Enumeration Type Documentation

◆ cleaning

enum Roomba::cleaning
strong
Enumerator
Spot 
Clean 
Max 

◆ command

enum Roomba::command : uint8_t
Enumerator
Start 
Baud 
Control 
Safe 
Safe 
Full 
Full 
Power 
Spot 
Spot 
Clean 
Clean 
Max_Clean 
Drive 
Motors 
Leds 
Song 
Play 
Query 
Dock 
Motor_PWM 
Drive_Wheels 
Stream 
Query_List 
Do_Stream 
Schedule_Leds 
Digit_Leds_Raw 
Digit_Leds_Ascii 
Buttons 
Schedule 
Set_Date_Time 
Stop 
Sensor 
SensorList 

◆ control

enum Roomba::control
strong
Enumerator
No_init 
Passive 
Safe 
Full 

◆ direction

Enumerator
Forward 
Left 
Right 
Backward 

◆ leds

enum Roomba::leds : uint8_t
Enumerator
LED_Debris 
LED_Spot 
LED_Dock 
LED_Check_Robot 

◆ ledState

enum Roomba::ledState
strong
Enumerator
On 
Off 

◆ sensors

enum Roomba::sensors : uint8_t
Enumerator
Bumps_wheeldrop 
Wall 
Cliff_Left 
Cliff_Front_Left 
Cliff_Front_Right 
Cliff_Right 
VirtualWall 
MotorOvercurrent 
RCM 
sButtons 
Distance 
Angle 
ChargingState 
Voltage 
Current 
Temperature 
Charge 
Capacity