SensorTemplate Class Reference

Short class/sensor description. More...

Detailed Description

• ID: Usually the chip number used by the sensor. When this is not available or relevant, use a unique descriptor that makes sense. Must match class name. Mandatory
• Name: Short, Title-Case Description from Datasheet. Manditory
• Other Names: Alternative names that your sensor driver might have. This may include manufacturer's name. Optional
• Other Chips: Alternative chip-ids that your sensor driver supports. Optional
• Category: One or more of: accelerometer,ainput,button,color,compass,digipot, display,electric,flexfor,gaseous,gps,led,light,liquid,medical,motor,other,pressure,relay,rfid,serial,servos,sound,temp,time,touch,video,wifi Manditory
• Manufacturer: One or more of: Sensor manufacturer. Can be 'generic'. Mandatory
• Link: Links to vendors or data-sheets. Optional
• Connection: One or more of: analog,gpio,i2c,pwm,spi,uart Manditory
• Kit: One of: gsk, hak, eak, tsk, robok Optional

Then add a much more detailed description here. Include items such as board-specifics, testing, etc...

    // Create an instance of SensorTemplate
    upm::SensorTemplate sensor(0);

    while(true)
    {
        std::cout << "SensorTemplate says: "
            << sensor.helloWorld() << std::endl;

        // Repeat every 2 seconds
        usleep(2000000);
    }

Public Member Functions
	SensorTemplate (int i2c_bus)
	Default constructor for SensorTemplate. More...
virtual	~SensorTemplate ()
std::string	helloWorld ()
	Hello world method. More...

Constructor & Destructor Documentation

SensorTemplate

(

int

i2c_bus

)

This creates an instance of SensorTemplate given an I2C bus number.

Parameters

i2c_bus

Target I2C bus

Returns

sensor context pointer

Exceptions

std::runtime_error

on failure to initialize I2C

virtual ~SensorTemplate ( )

inlinevirtual

SensorTemplate destructor

Member Function Documentation

std::string helloWorld

(

)

Provides an example method which returns 'Hello world'

---

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

• src/sensortemplate/sensortemplate.hpp
• src/sensortemplate/sensortemplate.cxx