Rover API Documentation
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 123]
 Crover::RoverBaseRoverBase class provides basic rover functions such as initialization, sleeping, and shutting down
 Crover::RoverCloudRoverCloud defines the interfaces that can be used for classes that connect to a remote cloud server
 Crover::RoverHonoCloudContains 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
 Crover::RoverPahoMQTTRoverPahoMQTT contains member functions to use rover as a client and to publish / subscribe to Eclipse Paho MQTT server topics
 Crover::RoverMQTTCommandRoverMQTTCommand 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
 Crover::RoverControlData_tData type to store rover's control data
 Crover::RoverDisplayContains the member functions to control OLED display on the Rover. This class is a wrapper API for Adafruit_GFX and Adafruit_SSD1306 libraries
 Crover::RoverDrivingContains the member functions to drive the rover using its motors
 Crover::RoverGpioRoverGpio class provides the member functions related to basic GPIO operations. This class wraps wiringPi library
 Crover::RoverButtonRoverButton class contains member functions to access Shutdown button, User button, and customly installed buttons on the rover
 Crover::RoverBuzzerRoverBuzzer class provides the member functions related to embedded buzzer on the rover
 Crover::RoverMQTT_Configure_tData type to store initial configuration information for MQTT communication
 Crover::RoverMQTT_ReturnCodes_tData type to store return codes that belong to member functions in RoverPahoMQTT class
 Crover::RoverMQTT_StatusFlags_tData type to store internal flags for MQTT communication
 Crover::RoverMQTT_SubscribeData_tData type to store subscribed data
 Crover::RoverSensorRoverSensor class is an abstract class to define interface between common sensors used in the rover
 Crover::RoverDHT22RoverDHT22 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
 Crover::RoverGrooveUltrasonicRoverGrooveUltrasonic 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
 Crover::RoverGY521RoverGY521 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
 Crover::RoverHCSR04RoverHCSR04 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
 Crover::RoverHMC5883LRoverHMC5883L 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
 Crover::RoverInfraredSensorRoverInfraredSensor 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
 Crover::RoverQMC5883LRoverQMC5883L 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
 Crover::RoverSensorData_tData type to store rover's sensor data
 Crover::RoverUtilsRoverUtils contains member functions to retrieve connectivity status and core utilization of the rover. This class wraps status_library lib, developed for the rover-app