rover Namespace Reference

rover Namespace contains classes to manage Rover sensors, gpio, buzzer, buttons, driving, utilities, and cloud. More...

Classes
class	RoverBase
	RoverBase class provides basic rover functions such as initialization, sleeping, and shutting down. More...
class	RoverButton
	RoverButton class contains member functions to access Shutdown button, User button, and customly installed buttons on the rover. More...
class	RoverBuzzer
	RoverBuzzer class provides the member functions related to embedded buzzer on the rover. More...
class	RoverCloud
	RoverCloud defines the interfaces that can be used for classes that connect to a remote cloud server. More...
struct	RoverControlData_t
	Data type to store rover's control data. More...
class	RoverDHT22
	RoverDHT22 is a class that is inherited from RoverSensor abstract class. RoverDHT22 class contains member functions and variables to set up and read from DHT22 temperature and humidity sensor that is embedded on the rover. More...
class	RoverDisplay
	Contains the member functions to control OLED display on the Rover. This class is a wrapper API for Adafruit_GFX and Adafruit_SSD1306 libraries. More...
class	RoverDriving
	Contains the member functions to drive the rover using its motors. More...
class	RoverGpio
	RoverGpio class provides the member functions related to basic GPIO operations. This class wraps wiringPi library. More...
class	RoverGrooveUltrasonic
	RoverGrooveUltrasonic is a class that is inherited from RoverSensor abstract class. RoverGrooveUltrasonic class contains member functions and variables to set up and read from Groove ultrasonic sensors that are embedded on the rover. More...
class	RoverGY521
	RoverGY521 is a class that is inherited from RoverSensor abstract class. RoverGY521 class contains member functions and variables to set up and read from GY521 accelerometer that is embedded on the rover. More...
class	RoverHCSR04
	RoverHCSR04 is a class that is inherited from RoverSensor abstract class. RoverHCSR04 class contains member functions and variables to set up and read from HCSR-04 ultrasonic sensors that are embedded on the rover. More...
class	RoverHMC5883L
	RoverHMC5883L is a class that is inherited from RoverSensor abstract class. RoverHMC5883L class contains member functions and variables to set up and read from HMC5883L bearing sensor that is embedded on the rover. More...
class	RoverHonoCloud
	Contains the member functions to connect and send data to Eclipse Hono instance using several parameters such as host name, port, tenant name, user name, and password. This class wraps hono_interaction library for Rover-specific interactions. More...
class	RoverInfraredSensor
	RoverInfraredSensor is a class that is inherited from RoverSensor abstract class. RoverInfraredSensor class contains member functions and variables to set up and read from SHARP infrared sensors that are embedded on the rover. More...
struct	RoverMQTT_Configure_t
	Data type to store initial configuration information for MQTT communication. More...
struct	RoverMQTT_ReturnCodes_t
	Data type to store return codes that belong to member functions in RoverPahoMQTT class. More...
struct	RoverMQTT_StatusFlags_t
	Data type to store internal flags for MQTT communication. More...
struct	RoverMQTT_SubscribeData_t
	Data type to store subscribed data. More...
class	RoverMQTTCommand
	RoverMQTTCommand class is an implementation class extending RoverPahoMQTT for rover-specific topic subscription and publishing using JSON for parsing and using predefined type variables such as RoverControlData_t and RoverSensorData_t. More...
class	RoverPahoMQTT
	RoverPahoMQTT contains member functions to use rover as a client and to publish / subscribe to Eclipse Paho MQTT server topics. More...
class	RoverQMC5883L
	RoverQMC5883L is a class that is inherited from RoverSensor abstract class. RoverQMC5883L class contains member functions and variables to set up and read from QMC5883L bearing sensor that is embedded on the rover. More...
class	RoverSensor
	RoverSensor class is an abstract class to define interface between common sensors used in the rover. More...
struct	RoverSensorData_t
	Data type to store rover's sensor data. More...
class	RoverUtils
	RoverUtils contains member functions to retrieve connectivity status and core utilization of the rover. This class wraps status_library lib, developed for the rover-app. More...

Enumerations
enum	RoverButtonType_t { USER_BUTTON = 0, SHUTDOWN_BUTTON = 1, CUSTOM_BUTTON = 2 }
	Button type. More...
enum	RoverDrivingMode_t {   NONE_ = 0, MANUAL_ = 0, ACC_, PARKING_LEFT_,   PARKING_RIGHT_, BOOTH_MODE_1_, BOOTH_MODE_2_ }
	Data type to indicate rover's driving mode. More...
enum	RoverSensorID_t {   ROVER_REAR_RIGHT = 0, ROVER_REAR_LEFT = 1, ROVER_FRONT_RIGHT = 2, ROVER_FRONT_LEFT = 3,   ROVER_FRONT = 4, ROVER_REAR = 5 }
	RoverSensorID_t defines the sensor location ID of the proximity sensors on the rover. More...

Variables
static const int	LOWEST_SPEED = 360
	Static definition to hold lowest driving speed for rover. More...
static const int	HIGHEST_SPEED = 480
	Static definition to hold highest driving speed for rover. More...
static const int	STOPPING_SPEED = 0
	Static definition to hold stopping speed for rover. More...

Detailed Description

rover Namespace contains classes to manage Rover sensors, gpio, buzzer, buttons, driving, utilities, and cloud.

Enumeration Type Documentation

enum rover::RoverButtonType_t

Button type.

Enumerator
USER_BUTTON
SHUTDOWN_BUTTON
CUSTOM_BUTTON

enum rover::RoverDrivingMode_t

Data type to indicate rover's driving mode.

Enumerator
NONE_
MANUAL_
ACC_
PARKING_LEFT_
PARKING_RIGHT_
BOOTH_MODE_1_
BOOTH_MODE_2_

enum rover::RoverSensorID_t

RoverSensorID_t defines the sensor location ID of the proximity sensors on the rover.

Enumerator
ROVER_REAR_RIGHT
ROVER_REAR_LEFT
ROVER_FRONT_RIGHT
ROVER_FRONT_LEFT
ROVER_FRONT
ROVER_REAR

Variable Documentation

const int rover::HIGHEST_SPEED = 480

static

Static definition to hold highest driving speed for rover.

const int rover::LOWEST_SPEED = 360

static

Static definition to hold lowest driving speed for rover.

const int rover::STOPPING_SPEED = 0

static

Static definition to hold stopping speed for rover.