upm  1.3.0
Sensor/Actuator repository for libmraa (v1.7.0)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions
Led Class Reference

API for the LED. More...

Detailed Description

UPM module for the LED (or other similar light-emitting diodes). An LED is a p-n junction semiconductor which emits light in response to voltage. The longer wire of an LED connects to the positive seat (anode); the shorter wire connects to the negative seat (cathode). The flat side of the bulb corresponds to the cathode, while the rounded side corresponds to the anode.

// Create the Grove LED object using GPIO pin 2
upm::Led* led = new upm::Led(2);
// Print the name
std::cout << led->name() << std::endl;
// Turn the LED on and off 10 times, pausing one second
// between transitions
for (int i=0; i < 10; i++) {
// Delete the Grove LED object
delete led;

Public Member Functions

 Led (int pin)
 ~Led ()
mraa_result_t write (int value)
mraa_result_t off ()
mraa_result_t on ()
std::string name ()

Constructor & Destructor Documentation

Led ( int  pin)

LED constructor

pinPin to use
~Led ( )

LED destructor

Member Function Documentation

mraa_result_t write ( int  value)

Turns the LED on or off, depending on the value. If the value is positive (greater than or equal to 1), the LED is turned on. Otherwise, for 0 or negative values, the LED is turned off.

valueTells the LED to turn on (for values >=1) or off (for values <1)
0 if successful, non-zero otherwise
mraa_result_t off ( )

Turns the LED off

0 if successful, non-zero otherwise
mraa_result_t on ( )

Turns the LED on

0 if successful, non-zero otherwise

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