Firmware
Classes | Functions | Variables
rm3100_main.h File Reference
#include "rm3100.h"

Go to the source code of this file.

Classes

struct  rm3100::rm3100_bus_option
 

Functions

rm3100_bus_option & rm3100::find_bus (RM3100_BUS bus_id)
 Finds a bus structure for a bus_id.
 
int rm3100::info (RM3100_BUS bus_id)
 Prints info about the driver.
 
bool rm3100::init (RM3100_BUS bus_id)
 Initializes the driver – sets defaults and starts a cycle.
 
bool rm3100::reset (RM3100_BUS bus_id)
 Resets the driver.
 
bool rm3100::start_bus (struct rm3100_bus_option &bus, Rotation rotation)
 Starts the driver for a specific bus option.
 
int rm3100::start (RM3100_BUS bus_id, Rotation rotation)
 Starts the driver. More...
 
int rm3100::stop ()
 Stop the driver. More...
 
bool rm3100::test (RM3100_BUS bus_id)
 Perform some basic functional tests on the driver; make sure we can collect data from the sensor in polled and automatic modes.
 
void rm3100::usage ()
 Prints info about the driver argument usage. More...
 

Variables

struct rm3100::rm3100_bus_option rm3100::bus_options []
 

Function Documentation

§ start()

int rm3100::start ( RM3100_BUS  bus_id,
Rotation  rotation 
)

Starts the driver.

This function call only returns once the driver is either successfully up and running or failed to start.

§ stop()

int rm3100::stop ( )

Stop the driver.

Stop the driver.

§ usage()

void rm3100::usage ( )

Prints info about the driver argument usage.

Prints info about the driver argument usage.

Variable Documentation

§ bus_options

struct rm3100::rm3100_bus_option rm3100::bus_options[]
Initial value:
= {
}