Library to handle the X-NUCLEO-LED61A1 LED Control Expansion Board based on the LED6001 component.
Dependents: LedDimming_LED61A1_mbedOS HelloWorld_LED61A1_mbedOS LedDimming_LED61A1 HelloWorld_LED61A1 ... more
Fork of X_NUCLEO_LED61A1 by
LED Control Library
Library to handle the X-NUCLEO-LED61A1 LED Control Expansion Board based on the LED6001 component.
Platform compatibility
- NUCLEO boards have been tested with the default configuration provided by the HelloWorld_LED61A1 example.
- NUCLEO-F070RB, NUCLEO-F072RB, NUCLEO-F091RC boards have been tested with the following patch:
- to connect with a wire the NUCLEO’s
D9
pin to the LED61A1’sD6
pin; - to initialize the pwm PinName variable with
D9
rather thanD6
.
- to connect with a wire the NUCLEO’s
- NUCLEO-F302R8 board has been tested with the following patch:
- to connect with a wire the NUCLEO’s
D7
pin to the LED61A1’sD6
pin; - to initialize the pwm PinName variable with
D7
rather thanD6
.
- to connect with a wire the NUCLEO’s
- LPCXpresso11U68 board has been tested with the limitation of using only the PWM Dimming, as it provides only one PWM channel, thus allowing just one between the PWM or Analog Dimming functionalities. It has been tested with the following patch:
- to connect with a wire the LPCX’s
D3
pin to the LED61A1’sD4
pin; - to connect with a wire the LPCX’s
D4
pin to the LED61A1’sD6
pin; - to initialize the xfault_irq PinName variable with
D3
rather thanD4
; - to initialize the pwm PinName variable with
D4
rather thanD6
; - to initialize the analog PinName variable with
NC
rather thanD5
; - to disable the use of the user button in any application example as it is not available.
- to connect with a wire the LPCX’s
- FRDM-K64F board has been tested with the following patch:
- to disable the use of the user button in any application example as it is not available.
Components/Interfaces/Led.h
- Committer:
- Davidroid
- Date:
- 2017-05-08
- Revision:
- 12:fc2d2d3a2499
File content as of revision 12:fc2d2d3a2499:
/** ****************************************************************************** * @file Led.h * @author AST * @version V1.0.0 * @date April 13th, 2015 * @brief This file contains the abstract class describing the interface of a * led component. ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Generated with STM32CubeTOO -----------------------------------------------*/ /* Revision ------------------------------------------------------------------*/ /* Repository: http://svn.x-nucleodev.codex.cro.st.com/svnroot/X-NucleoDev Branch/Trunk/Tag: trunk Based on: X-CUBE-LED1/trunk/Drivers/BSP/Components/Common/led.h Revision: 0 */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __LED_CLASS_H #define __LED_CLASS_H /* Includes ------------------------------------------------------------------*/ #include <Component.h> /* Classes ------------------------------------------------------------------*/ /** An abstract class for Led components. */ class Led : public Component { public: /* ACTION 1 --------------------------------------------------------------* * Declare here the interface's methods. * * They should be: * * + Methods with the same name of the C component's virtual table * * (and extended virtual table, if any)'s functions, provided that * * the component's driver implements them (i.e.: the corresponding * * pointer to function is not "0"). * * * * Example: * * virtual int get_value(float *f) = 0; * *------------------------------------------------------------------------*/ /** * @brief Getting the current flowing through the LED. * @param None. * @retval The current flowing through the LED, represented as a floating * point number in the range [0.0, 1.0]. */ virtual float get_current(void) = 0; /** * @brief Setting PWM dimming value. * @param dimming PWM dimming value. * @retval None. */ virtual void set_pwm_dimming(float dimming) = 0; /** * @brief Setting Analog dimming value. * @param dimming Analog dimming value. * @retval None. */ virtual void set_analog_dimming(float dimming) = 0; /** * @brief Destructor. */ virtual ~Led() {}; }; #endif /* __LED_CLASS_H */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/