alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
src/rgbringcoder/rgbringcoder.h
View File

@ -33,7 +33,7 @@
namespace upm {
/**
* @brief Sparkfun RGB RingCoder
* @brief SparkFun RGB RingCoder
* @defgroup rgbringcoder libupm-rgbringcoder
* @ingroup seeed gpio led
*/
@ -41,19 +41,19 @@ namespace upm {
/**
* @library rgbringcoder
* @sensor rgbringcoder
* @comname Sparkfun RGB Ringcoder
* @comname SparkFun RGB Ringcoder
* @type led
* @web https://www.sparkfun.com/products/11040
* @man sparkfun
* @con pwm gpio
*
* @brief API for the Sparkfun RGB Ringcoder
* @brief API for the SparkFun* RGB RingCoder
*
* The RGB RingCoder is a breakout board, a circular LED containing
* 16 LEDs arranged in a ring, and a rotary encoder. The encoder
* RGB RingCoder is a breakout board, a circular LED containing
* 16 LEDs arranged in a ring, and a rotary encoder. The encoder
* contains an RGB LED as well as a push button function.
*
* The device will require 11 pins, 3 of which must be PWM capable
* The device requires 11 pins, 3 of which must be PWM-capable
* (for the RGB LEDs).
*
* @image html rgbringcoder.jpg
@ -66,62 +66,62 @@ namespace upm {
/**
* RGBRingCoder constructor
*
* @param en enable gpio
* @param latch latch gpio
* @param clear clear gpio
* @param clk clock gpio
* @param dat data out gpio
* @param sw push button switch gpio
* @param encA encoder A gpio
* @param encB encoder B gpio
* @param red RGB red led pwm
* @param green RGB green led pwm
* @param blue RGB blue led pwm
* @param en Enables GPIO
* @param latch Latch GPIO
* @param clear Clears GPIO
* @param clk Clock GPIO
* @param dat Data out GPIO
* @param sw Push button switch GPIO
* @param encA Encoder A GPIO
* @param encB Encoder B GPIO
* @param red RGB red LED PWM
* @param green RGB green LED PWM
* @param blue RGB blue LED PWM
*/
RGBRingCoder(int en, int latch, int clear, int clk, int dat, int sw,
int encA, int encB, int red, int green, int blue);
/**
* RGBRingCoder Destructor
* RGBRingCoder destructor
*/
~RGBRingCoder();
/*
* set the state of the ring LEDs. This is a 16 bit value, where
* each bit corresponds to one of the ring LEDs. A 1 bit means
* that specific LED is on, and 0 bit means that specific LED is
* Sets the state of the ring LEDs. This is a 16-bit value, where
* each bit corresponds to one of the ring LEDs. A 1 bit means
* that a specific LED is on, and a 0 bit means that a specific LED is
* off.
*
* @param bits the bits representing the state of each LED
* @param bits Bits representing the state of each LED
*/
void setRingLEDS(uint16_t bits);
/*
* return the state of the button
* Returns the state of the button
*
* @return true if the button is pressed, false otherwise
* @return True if the button is pressed, false otherwise
*/
bool getButtonState();
/*
* get the current rotary encoder counter value
* Gets the current rotary encoder counter value
*
* @return the current counter value
* @return Current counter value
*/
int getEncoderPosition() { return m_counter; };
/*
* set the encoder counter to 0
* Sets the encoder counter to 0
*/
void clearEncoderPosition() { m_counter = 0; };
/*
* set the intensity of the red, grenn, and blue LEDs. Values can
* be between 0.0 and 1.0. Lower is brighter, higher is dimmer.
* Sets the intensity of the red, green, and blue LEDs. Values can
* be between 0.0 and 1.0. Lower is brighter, higher is dimmer.
*
* @param r the red value, valid values are between 0.0 and 1.0
* @param g the green value, valid values are between 0.0 and 1.0
* @param b the blue value, valid values are between 0.0 and 1.0
* @param r Red value; valid values are 0.0-1.0
* @param g Green value; valid values are 0.0-1.0
* @param b Blue value; valid values are 0.0-1.0
*/
void setRGBLED(float r, float g, float b);