Rover API Documentation
|
Crover::RoverBase | RoverBase class provides basic rover functions such as initialization, sleeping, and shutting down |
▼Crover::RoverCloud | RoverCloud defines the interfaces that can be used for classes that connect to a remote cloud server |
Crover::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 |
▼Crover::RoverPahoMQTT | RoverPahoMQTT contains member functions to use rover as a client and to publish / subscribe to Eclipse Paho MQTT server topics |
Crover::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 |
Crover::RoverControlData_t | Data type to store rover's control data |
Crover::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 |
Crover::RoverDriving | Contains the member functions to drive the rover using its motors |
▼Crover::RoverGpio | RoverGpio class provides the member functions related to basic GPIO operations. This class wraps wiringPi library |
Crover::RoverButton | RoverButton class contains member functions to access Shutdown button, User button, and customly installed buttons on the rover |
Crover::RoverBuzzer | RoverBuzzer class provides the member functions related to embedded buzzer on the rover |
Crover::RoverMQTT_Configure_t | Data type to store initial configuration information for MQTT communication |
Crover::RoverMQTT_ReturnCodes_t | Data type to store return codes that belong to member functions in RoverPahoMQTT class |
Crover::RoverMQTT_StatusFlags_t | Data type to store internal flags for MQTT communication |
Crover::RoverMQTT_SubscribeData_t | Data type to store subscribed data |
▼Crover::RoverSensor | RoverSensor class is an abstract class to define interface between common sensors used in the rover |
Crover::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 |
Crover::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 |
Crover::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 |
Crover::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 |
Crover::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 |
Crover::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 |
Crover::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 |
Crover::RoverSensorData_t | Data type to store rover's sensor data |
Crover::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 |