Rover API Documentation
rover::RoverUtils Class Reference

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...

#include <rover_utils.hpp>

Public Member Functions

void getCoreUtilization (float coreUtil[numberOfCores])
 Obtain the core utilization of each core in rover's Raspberry Pi. Uses an external script called read_core_usage.py which must be installed within rover-app. More...
 
int getWlanStatus (void)
 Returns whether the wlan0 interface is on (1) or off (0). More...
 
int getEthernetStatus (void)
 Returns whether the eth0 interface is on (1) or off (0). More...
 
int getInternetStatus (void)
 Returns whether the internet is on (1) or off (0). More...
 
int getBluetoothStatus (void)
 Returns whether the bluetooth is on (1) or off (0). More...
 
int getHonoCloudStatus (char *host_name, int port, char *tenant_name, char *device_id, char *user, char *password)
 Returns whether the remote Eclipse Hono instance is on (1) or off (0). More...
 

Static Public Attributes

static const int numberOfCores = 4
 

Detailed Description

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.

Member Function Documentation

int rover::RoverUtils::getBluetoothStatus ( void  )

Returns whether the bluetooth is on (1) or off (0).

Returns
status bluetooth status : on (1) or off (0)
void rover::RoverUtils::getCoreUtilization ( float  coreUtil[numberOfCores])

Obtain the core utilization of each core in rover's Raspberry Pi. Uses an external script called read_core_usage.py which must be installed within rover-app.

Parameters
coreUtilis a float array that contains core usage of each core in rover's Raspberry Pi.
int rover::RoverUtils::getEthernetStatus ( void  )

Returns whether the eth0 interface is on (1) or off (0).

Returns
status eth0 interface status : on (1) or off (0)
int rover::RoverUtils::getHonoCloudStatus ( char *  host_name,
int  port,
char *  tenant_name,
char *  device_id,
char *  user,
char *  password 
)

Returns whether the remote Eclipse Hono instance is on (1) or off (0).

Returns
status remote Eclipse Hono instance status : on (1) or off (0)
int rover::RoverUtils::getInternetStatus ( void  )

Returns whether the internet is on (1) or off (0).

Returns
status internet status : on (1) or off (0)
int rover::RoverUtils::getWlanStatus ( void  )

Returns whether the wlan0 interface is on (1) or off (0).

Returns
status wlan0 interface status : on (1) or off (0)

Member Data Documentation

const int rover::RoverUtils::numberOfCores = 4
static

Number of cores available in the rover's Raspberry Pi


The documentation for this class was generated from the following files: