Roomba  Alpha
Documentation on our take on the Roomba open interface
Roomba::Roomba Class Reference

#include <Roomba.hpp>

Collaboration diagram for Roomba::Roomba:
Collaboration graph

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< sensorDatagetSensorDataList (std::vector< sensors > sensor)
 
void setSongNum (uint8_t songNum, const std::vector< uint8_t > &notesWithDuration)
 
void playSongNum (uint8_t songNum)
 
void turnOn ()
 
void turnOff ()
 
void setDirection (direction Direction)
 
 ~Roomba ()
 

Constructor & Destructor Documentation

◆ Roomba()

Roomba::Roomba::Roomba ( std::shared_ptr< UART::UART > &  UARTHandle)
inlineexplicit

◆ ~Roomba()

Roomba::Roomba::~Roomba ( )
inline

Member Function Documentation

◆ getSensorData()

sensorData Roomba::Roomba::getSensorData ( sensors  sensor)

◆ getSensorDataList()

std::vector< sensorData > Roomba::Roomba::getSensorDataList ( std::vector< sensors sensor)

◆ playSongNum()

void Roomba::Roomba::playSongNum ( uint8_t  songNum)

◆ setBaudRate()

void Roomba::Roomba::setBaudRate ( UART::Baudrates  baudRate)

◆ setControlMode()

void Roomba::Roomba::setControlMode ( control  ControlMode)

◆ setDirection()

void Roomba::Roomba::setDirection ( direction  Direction)

◆ setDockMode()

void Roomba::Roomba::setDockMode ( )

Roomba Dock mode which makes the Roomba go to his docking station.

This is the detailed description, more stuff here.

Parameters
Athis describes parameter A
Bthis describes parameter B
Returns
nothing important
See also
anotherfunction() anotherfunction2()
Note
a little side note
Attention
a little more important than a note
Warning
a warning is super important!

◆ setLed()

void Roomba::Roomba::setLed ( uint8_t  led,
ledState  state 
)

◆ setMotor()

void Roomba::Roomba::setMotor ( uint8_t  motor,
uint8_t  velocity 
)

◆ setPowerLed()

void Roomba::Roomba::setPowerLed ( uint8_t  color,
uint8_t  intensity 
)

◆ setSongNum()

void Roomba::Roomba::setSongNum ( uint8_t  songNum,
const std::vector< uint8_t > &  notesWithDuration 
)

◆ startCleaning()

void Roomba::Roomba::startCleaning ( cleaning  cleaningMode)

◆ turnOff()

void Roomba::Roomba::turnOff ( )

◆ turnOn()

void Roomba::Roomba::turnOn ( )