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.

Diff: BSP/x_nucleo_led61a1_class.cpp

Revision:
1:eab47c592e8f
Parent:
0:4a3d02667d9f
Child:
2:a270bdb62fc8
--- a/BSP/x_nucleo_led61a1_class.cpp	Thu Dec 10 15:32:20 2015 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,206 +0,0 @@
-/**
- ******************************************************************************
- * @file    x_nucleo_led61a1_class.cpp
- * @author  AST / Software Platforms and Cloud
- * @version V1.0
- * @date    December 9rd, 2015
- * @brief   Implementation file for the X_NUCLEO_LED61A1 expansion board.
- ******************************************************************************
- * @attention
- *
- * <h2><center>&copy; 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 -----------------------------------------------*/
-
-
-/* Includes ------------------------------------------------------------------*/
-
-/* ACTION 1 ------------------------------------------------------------------*
- * Include here platform specific header files.                               *
- *----------------------------------------------------------------------------*/        
-#include "mbed.h"
-#include "DevI2C.h"
-/* ACTION 2 ------------------------------------------------------------------*
- * Include here expansion board specific header files.                        *
- *----------------------------------------------------------------------------*/        
-#include "x_nucleo_led61a1_class.h"
-
-
-/* Static variables ----------------------------------------------------------*/
-
-/* Singleton instance of X_NUCLEO_LED61A1 class. */
-X_NUCLEO_LED61A1 *X_NUCLEO_LED61A1::_instance;
-
-
-/* Methods -------------------------------------------------------------------*/
-
-/**
- * @brief Constructor.
- * @param i2c I2C device to be used for communication.
- */
-X_NUCLEO_LED61A1::X_NUCLEO_LED61A1(DevI2C *i2c) : dev_i2c(i2c)
-{
-    /* Instantiating the components. */
-    /* ACTION 3 --------------------------------------------------------------*
-     * Instantiate here the expansion board's components.                     *
-     *                                                                        *
-     * Example:                                                               *
-     *   component_1 = new COMPONENT_1(COMPONENT_1_I2C_ADDRESS, *dev_i2c);    *
-     *   component_2 = new COMPONENT_2(COMPONENT_2_I2C_ADDRESS, *dev_i2c);    *
-     *------------------------------------------------------------------------*/
-    led6001 = new LED6001(LED6001_I2C_ADDRESS, *dev_i2c);
-}
-
-/**
- * @brief Getting a singleton instance of X_NUCLEO_LED61A1 class.
- * @param i2c I2C device to be used for communication.
- * @retval a singleton instance of X_NUCLEO_LED61A1 class.
- */
-X_NUCLEO_LED61A1 *X_NUCLEO_LED61A1::Instance(DevI2C *i2c)
-{
-    if (_instance == NULL)
-    {
-        /* I2C communication. */
-        if (i2c == NULL)
-            i2c = new DevI2C(X_NUCLEO_LED61A1_PIN_I2C_SDA, X_NUCLEO_LED61A1_PIN_I2C_SCL);
-
-        /* Instantiating the board. */
-        _instance = new X_NUCLEO_LED61A1(i2c);
-
-        /* Initializing the components. */
-        if (!_instance->Init())
-            error("Initialization of the X_NUCLEO_LED61A1 expansion board failed.\n");
-    }
-
-    return _instance;
-}
-
-/**
- * @brief Getting a singleton instance of X_NUCLEO_LED61A1 class.
- * @param sda pin name of the SDA pin of the I2C device to be used for communication.
- * @param scl pin name of the SCL pin of the I2C device to be used for communication.
- * @retval a singleton instance of X_NUCLEO_LED61A1 class.
- */
-X_NUCLEO_LED61A1 *X_NUCLEO_LED61A1::Instance(PinName sda, PinName scl)
-{
-    if (_instance == NULL)
-    {
-        /* I2C communication. */
-        DevI2C *i2c = new DevI2C(sda, scl);
-
-        /* Instantiating the board. */
-        _instance = new X_NUCLEO_LED61A1(i2c);
-
-        /* Initializing the components. */
-        if (!_instance->Init())
-            error("Initialization of the X_NUCLEO_LED61A1 expansion board failed.\n");
-    }
-
-    return _instance;
-}
-
-/**
- * @brief Initializing the X_NUCLEO_LED61A1 board.
- * @retval true if initialization is successful, false otherwise.
- */
-bool X_NUCLEO_LED61A1::Init(void)
-{
-    /* Initializing the components. */
-    /* ACTION 4 --------------------------------------------------------------*
-     * Initialize here the expansion board's components.                      *
-     *                                                                        *
-     * Example:                                                               *
-     *   return (Init_COMPONENT_1() && Init_COMPONENT_2());                   *
-     *------------------------------------------------------------------------*/
-    return (Init_LED6001());
-}
-
-/* ACTION 5 ------------------------------------------------------------------*
- * Implement here an initialization method for each expansion board's         *
- * component.                                                                 *
- *                                                                            *
- * Example:                                                                   *
- *   bool EXPANSION_BOARD::Init_COMPONENT_1(void)                             *
- *   {                                                                        *
- *     // Verifying identity.                                                 *
- *     uint8_t id = 0;                                                        *
- *     int ret = component_1->ReadID(&id);                                    *
- *     if ((ret != COMPONENT_OK) || (id != I_AM_COMPONENT_1))                 *
- *     {                                                                      *
- *       delete component_1;                                                  *
- *       component_1 = NULL;                                                  *
- *       return true;                                                         *
- *     }                                                                      *
- *                                                                            *
- *     // Configuration.                                                      *
- *     INTERFACE_InitTypeDef InitStructure;                                   *
- *     InitStructure.Property_1 = COMPONENT_1_PROPERY_1_INIT;                 *
- *     InitStructure.Property_N = COMPONENT_1_PROPERY_N_INIT;                 *
- *                                                                            *
- *     // Initialization.                                                     *
- *     if (component_1->Init(&InitStructure) != COMPONENT_OK)                 *
- *       return false;                                                        *
- *                                                                            *
- *     return true;                                                           *
- *   }                                                                        *
- *----------------------------------------------------------------------------*/
-/**
- * @brief  Initialize the LED6001 component.
- * @retval true if initialization is successful, false otherwise.
- */
-bool X_NUCLEO_LED61A1::Init_LED6001(void)
-{
-    /* Verifying identity. */
-    uint8_t id = 0;
-    int ret = led6001->ReadID(&id);
-    if ((ret != COMPONENT_OK) || (id != I_AM_LED6001))
-    {
-        delete led6001;
-        led6001 = NULL;
-        return true;
-    }
-
-    /* Configuration. */
-    LED_InitTypeDef InitStructure;
-    /* ACTION ----------------------------------------------------------------*
-     * Configure here the component's initialization structure.               *
-     *                                                                        *
-     * Example:                                                               *
-     *   InitStructure.Property_1 = COMPONENT_PROPERY_1_INIT;                 *
-     *   InitStructure.Property_N = COMPONENT_PROPERY_N_INIT;                 *
-     *------------------------------------------------------------------------*/
-
-    /* Initialization. */
-    if (led6001->Init(&InitStructure) != COMPONENT_OK)
-        return false;
-
-    return true;
-}
-
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/