Rover API Documentation
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
 NroverRover Namespace contains classes to manage Rover sensors, gpio, buzzer, buttons, driving, utilities, and cloud
 CRoverBaseRoverBase class provides basic rover functions such as initialization, sleeping, and shutting down
 CRoverButtonRoverButton class contains member functions to access Shutdown button, User button, and customly installed buttons on the rover
 CRoverBuzzerRoverBuzzer class provides the member functions related to embedded buzzer on the rover
 CRoverCloudRoverCloud defines the interfaces that can be used for classes that connect to a remote cloud server
 CRoverControlData_tData type to store rover's control data
 CRoverDHT22RoverDHT22 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
 CRoverDisplayContains the member functions to control OLED display on the Rover. This class is a wrapper API for Adafruit_GFX and Adafruit_SSD1306 libraries
 CRoverDrivingContains the member functions to drive the rover using its motors
 CRoverGpioRoverGpio class provides the member functions related to basic GPIO operations. This class wraps wiringPi library
 CRoverGrooveUltrasonicRoverGrooveUltrasonic 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
 CRoverGY521RoverGY521 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
 CRoverHCSR04RoverHCSR04 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
 CRoverHMC5883LRoverHMC5883L 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
 CRoverHonoCloudContains 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
 CRoverInfraredSensorRoverInfraredSensor 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
 CRoverMQTT_Configure_tData type to store initial configuration information for MQTT communication
 CRoverMQTT_ReturnCodes_tData type to store return codes that belong to member functions in RoverPahoMQTT class
 CRoverMQTT_StatusFlags_tData type to store internal flags for MQTT communication
 CRoverMQTT_SubscribeData_tData type to store subscribed data
 CRoverMQTTCommandRoverMQTTCommand 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
 CRoverPahoMQTTRoverPahoMQTT contains member functions to use rover as a client and to publish / subscribe to Eclipse Paho MQTT server topics
 CRoverQMC5883LRoverQMC5883L 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
 CRoverSensorRoverSensor class is an abstract class to define interface between common sensors used in the rover
 CRoverSensorData_tData type to store rover's sensor data
 CRoverUtilsRoverUtils contains member functions to retrieve connectivity status and core utilization of the rover. This class wraps status_library lib, developed for the rover-app