upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
Public Member Functions

API for the Grove Slide Potentiometer. More...

Detailed Description

Deprecated:
This class is being replaced by the upm-slide library and the Slide class.

Basic UPM module for the Grove slide potentiometer on analog that returns either a raw value or a scaled voltage value.

slide.jpg
upm::GroveSlide slide(0);
cout << slide.name() << endl;
while (true) {
float adc_value = slide.raw_value(); // Read raw value
float volts = slide.voltage_value(); // Read voltage, board reference set at 5.0V
fprintf(stdout, "%4d = %.2f V\n", (uint16_t) adc_value, volts);
upm_delay_us(2500000); // Sleep for 2.5s
}

Public Member Functions

 GroveSlide (unsigned int pin, float ref_voltage=5.0)
 
 ~GroveSlide ()
 
float raw_value ()
 
float voltage_value ()
 
float ref_voltage ()
 
- Public Member Functions inherited from Grove
std::string name ()
 

Additional Inherited Members

- Protected Attributes inherited from Grove
std::string m_name
 

Constructor & Destructor Documentation

GroveSlide ( unsigned int  pin,
float  ref_voltage = 5.0 
)

Grove analog slide potentiometer constructor

Parameters
pinNumber of the analog pin to use
ref_voltageReference voltage the board is set to, as a floating-point value; default is 5.0V

Here is the call graph for this function:

~GroveSlide ( )

GroveSlide destructor

Member Function Documentation

float raw_value ( )

Gets the raw value from the AIO pin

Returns
Raw value from the ADC

Here is the caller graph for this function:

float voltage_value ( )

Gets the voltage value from the pin

Returns
Voltage reading based on the reference voltage

Here is the call graph for this function:

float ref_voltage ( )

Gets the board's reference voltage passed on object initialization

Returns
Reference voltage the class was set for

Here is the caller graph for this function:

Inheritance diagram for GroveSlide:
Inheritance graph
[legend]
Collaboration diagram for GroveSlide:
Collaboration graph
[legend]

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