ST / X_NUCLEO_LED61A1

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 ST Expansion SW Team

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’s D6 pin;
    • to initialize the pwm PinName variable with D9 rather than D6.
  • NUCLEO-F302R8 board has been tested with the following patch:
    • to connect with a wire the NUCLEO’s D7 pin to the LED61A1’s D6 pin;
    • to initialize the pwm PinName variable with D7 rather than D6.
  • 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’s D4 pin;
    • to connect with a wire the LPCX’s D4 pin to the LED61A1’s D6 pin;
    • to initialize the xfault_irq PinName variable with D3 rather than D4;
    • to initialize the pwm PinName variable with D4 rather than D6;
    • to initialize the analog PinName variable with NC rather than D5;
    • to disable the use of the user button in any application example as it is not available.
  • 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/Common/led.h@0:4a3d02667d9f, 2015-12-10 (annotated)

Committer:
Davidroid
Date:
Thu Dec 10 15:32:20 2015 +0000
Revision:
0:4a3d02667d9f
Child:
2:a270bdb62fc8
Library to handle the X-NUCLEO-LED61A1 LED Control Expansion Board based on the LED6001 component.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Davidroid 0:4a3d02667d9f 1 /**
Davidroid 0:4a3d02667d9f 2 ******************************************************************************
Davidroid 0:4a3d02667d9f 3 * @file led.h
Davidroid 0:4a3d02667d9f 4 * @author CL
Davidroid 0:4a3d02667d9f 5 * @version V1.0.0
Davidroid 0:4a3d02667d9f 6 * @date 30-Sep-2015
Davidroid 0:4a3d02667d9f 7 * @brief This header file contains the functions prototypes for the
Davidroid 0:4a3d02667d9f 8 * led driver.
Davidroid 0:4a3d02667d9f 9 ******************************************************************************
Davidroid 0:4a3d02667d9f 10 * @attention
Davidroid 0:4a3d02667d9f 11 *
Davidroid 0:4a3d02667d9f 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Davidroid 0:4a3d02667d9f 13 *
Davidroid 0:4a3d02667d9f 14 * Redistribution and use in source and binary forms, with or without modification,
Davidroid 0:4a3d02667d9f 15 * are permitted provided that the following conditions are met:
Davidroid 0:4a3d02667d9f 16 * 1. Redistributions of source code must retain the above copyright notice,
Davidroid 0:4a3d02667d9f 17 * this list of conditions and the following disclaimer.
Davidroid 0:4a3d02667d9f 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Davidroid 0:4a3d02667d9f 19 * this list of conditions and the following disclaimer in the documentation
Davidroid 0:4a3d02667d9f 20 * and/or other materials provided with the distribution.
Davidroid 0:4a3d02667d9f 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Davidroid 0:4a3d02667d9f 22 * may be used to endorse or promote products derived from this software
Davidroid 0:4a3d02667d9f 23 * without specific prior written permission.
Davidroid 0:4a3d02667d9f 24 *
Davidroid 0:4a3d02667d9f 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Davidroid 0:4a3d02667d9f 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Davidroid 0:4a3d02667d9f 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Davidroid 0:4a3d02667d9f 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Davidroid 0:4a3d02667d9f 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Davidroid 0:4a3d02667d9f 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Davidroid 0:4a3d02667d9f 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Davidroid 0:4a3d02667d9f 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Davidroid 0:4a3d02667d9f 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Davidroid 0:4a3d02667d9f 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Davidroid 0:4a3d02667d9f 35 *
Davidroid 0:4a3d02667d9f 36 ******************************************************************************
Davidroid 0:4a3d02667d9f 37 */
Davidroid 0:4a3d02667d9f 38
Davidroid 0:4a3d02667d9f 39
Davidroid 0:4a3d02667d9f 40 /* Define to prevent recursive inclusion -------------------------------------*/
Davidroid 0:4a3d02667d9f 41 #ifndef __LED_H
Davidroid 0:4a3d02667d9f 42 #define __LED_H
Davidroid 0:4a3d02667d9f 43
Davidroid 0:4a3d02667d9f 44 #ifdef __cplusplus
Davidroid 0:4a3d02667d9f 45 extern "C" {
Davidroid 0:4a3d02667d9f 46 #endif
Davidroid 0:4a3d02667d9f 47
Davidroid 0:4a3d02667d9f 48 /* Includes ------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 49 #include <stdint.h>
Davidroid 0:4a3d02667d9f 50
Davidroid 0:4a3d02667d9f 51 /** @addtogroup BSP
Davidroid 0:4a3d02667d9f 52 * @{
Davidroid 0:4a3d02667d9f 53 */
Davidroid 0:4a3d02667d9f 54
Davidroid 0:4a3d02667d9f 55 /** @addtogroup Components
Davidroid 0:4a3d02667d9f 56 * @{
Davidroid 0:4a3d02667d9f 57 */
Davidroid 0:4a3d02667d9f 58
Davidroid 0:4a3d02667d9f 59 /** @addtogroup LED_DRIVER
Davidroid 0:4a3d02667d9f 60 * @{
Davidroid 0:4a3d02667d9f 61 */
Davidroid 0:4a3d02667d9f 62
Davidroid 0:4a3d02667d9f 63 /** @defgroup LED_Exported_Types
Davidroid 0:4a3d02667d9f 64 * @{
Davidroid 0:4a3d02667d9f 65 */
Davidroid 0:4a3d02667d9f 66
Davidroid 0:4a3d02667d9f 67 /**
Davidroid 0:4a3d02667d9f 68 * @brief LED_DRIVER init structure definition
Davidroid 0:4a3d02667d9f 69 */
Davidroid 0:4a3d02667d9f 70 typedef struct
Davidroid 0:4a3d02667d9f 71 {
Davidroid 0:4a3d02667d9f 72 uint8_t PdimVal;
Davidroid 0:4a3d02667d9f 73 uint8_t AdimVal;
Davidroid 0:4a3d02667d9f 74 } LED_InitTypeDef;
Davidroid 0:4a3d02667d9f 75
Davidroid 0:4a3d02667d9f 76 /**
Davidroid 0:4a3d02667d9f 77 * @brief LED_DRIVER component id enumerator definition
Davidroid 0:4a3d02667d9f 78 */
Davidroid 0:4a3d02667d9f 79 typedef enum
Davidroid 0:4a3d02667d9f 80 {
Davidroid 0:4a3d02667d9f 81 LED_NONE_COMPONENT = 0,
Davidroid 0:4a3d02667d9f 82 LED_LED6001_COMPONENT = 1,
Davidroid 0:4a3d02667d9f 83 } LED_ComponentTypeDef;
Davidroid 0:4a3d02667d9f 84
Davidroid 0:4a3d02667d9f 85 /**
Davidroid 0:4a3d02667d9f 86 * @brief LED_DRIVER driver structure definition
Davidroid 0:4a3d02667d9f 87 */
Davidroid 0:4a3d02667d9f 88 typedef struct
Davidroid 0:4a3d02667d9f 89 {
Davidroid 0:4a3d02667d9f 90 DrvStatusTypeDef (*Init)(LED_InitTypeDef *);
Davidroid 0:4a3d02667d9f 91 void (*DeInit)(void);
Davidroid 0:4a3d02667d9f 92 void (*SetPwmDim)(uint8_t);
Davidroid 0:4a3d02667d9f 93 void (*SetAnaDim)(uint8_t);
Davidroid 0:4a3d02667d9f 94 DrvStatusTypeDef (*FaultStatus)(void);
Davidroid 0:4a3d02667d9f 95 } LED_DrvVTableTypeDef;
Davidroid 0:4a3d02667d9f 96
Davidroid 0:4a3d02667d9f 97 #ifdef __cplusplus
Davidroid 0:4a3d02667d9f 98 }
Davidroid 0:4a3d02667d9f 99 #endif
Davidroid 0:4a3d02667d9f 100
Davidroid 0:4a3d02667d9f 101 #endif /* __LED_H */
Davidroid 0:4a3d02667d9f 102
Davidroid 0:4a3d02667d9f 103 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/