Roomba
Alpha
Documentation on our take on the Roomba open interface
|
#include <Roomba.hpp>
Public Member Functions | |
Roomba (std::shared_ptr< UART::UART > &UARTHandle) | |
void | setMotor (uint8_t motor, uint8_t velocity) |
void | startCleaning (cleaning cleaningMode) |
void | setDockMode () |
Roomba Dock mode which makes the Roomba go to his docking station. More... | |
void | setControlMode (control ControlMode) |
void | setLed (uint8_t led, ledState state) |
void | setPowerLed (uint8_t color, uint8_t intensity) |
void | setBaudRate (UART::Baudrates baudRate) |
sensorData | getSensorData (sensors sensor) |
std::vector< sensorData > | getSensorDataList (std::vector< sensors > sensor) |
void | setSongNum (uint8_t songNum, const std::vector< uint8_t > ¬esWithDuration) |
void | playSongNum (uint8_t songNum) |
void | turnOn () |
void | turnOff () |
void | setDirection (direction Direction) |
~Roomba () | |
|
inlineexplicit |
|
inline |
sensorData Roomba::Roomba::getSensorData | ( | sensors | sensor | ) |
std::vector< sensorData > Roomba::Roomba::getSensorDataList | ( | std::vector< sensors > | sensor | ) |
void Roomba::Roomba::playSongNum | ( | uint8_t | songNum | ) |
void Roomba::Roomba::setBaudRate | ( | UART::Baudrates | baudRate | ) |
void Roomba::Roomba::setControlMode | ( | control | ControlMode | ) |
void Roomba::Roomba::setDirection | ( | direction | Direction | ) |
void Roomba::Roomba::setDockMode | ( | ) |
Roomba Dock mode which makes the Roomba go to his docking station.
This is the detailed description, more stuff here.
A | this describes parameter A |
B | this describes parameter B |
void Roomba::Roomba::setLed | ( | uint8_t | led, |
ledState | state | ||
) |
void Roomba::Roomba::setMotor | ( | uint8_t | motor, |
uint8_t | velocity | ||
) |
void Roomba::Roomba::setPowerLed | ( | uint8_t | color, |
uint8_t | intensity | ||
) |
void Roomba::Roomba::setSongNum | ( | uint8_t | songNum, |
const std::vector< uint8_t > & | notesWithDuration | ||
) |
void Roomba::Roomba::startCleaning | ( | cleaning | cleaningMode | ) |
void Roomba::Roomba::turnOff | ( | ) |
void Roomba::Roomba::turnOn | ( | ) |