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.

BSP/x_nucleo_led61a1_class.h@0:4a3d02667d9f, 2015-12-10 (annotated)

Committer:
Davidroid
Date:
Thu Dec 10 15:32:20 2015 +0000
Revision:
0:4a3d02667d9f
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 x_nucleo_led61a1_class.h
Davidroid 0:4a3d02667d9f 4 * @author AST / Software Platforms and Cloud
Davidroid 0:4a3d02667d9f 5 * @version V1.0
Davidroid 0:4a3d02667d9f 6 * @date December 9rd, 2015
Davidroid 0:4a3d02667d9f 7 * @brief Class header file for the X_NUCLEO_LED61A1 expansion board.
Davidroid 0:4a3d02667d9f 8 ******************************************************************************
Davidroid 0:4a3d02667d9f 9 * @attention
Davidroid 0:4a3d02667d9f 10 *
Davidroid 0:4a3d02667d9f 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Davidroid 0:4a3d02667d9f 12 *
Davidroid 0:4a3d02667d9f 13 * Redistribution and use in source and binary forms, with or without modification,
Davidroid 0:4a3d02667d9f 14 * are permitted provided that the following conditions are met:
Davidroid 0:4a3d02667d9f 15 * 1. Redistributions of source code must retain the above copyright notice,
Davidroid 0:4a3d02667d9f 16 * this list of conditions and the following disclaimer.
Davidroid 0:4a3d02667d9f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Davidroid 0:4a3d02667d9f 18 * this list of conditions and the following disclaimer in the documentation
Davidroid 0:4a3d02667d9f 19 * and/or other materials provided with the distribution.
Davidroid 0:4a3d02667d9f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Davidroid 0:4a3d02667d9f 21 * may be used to endorse or promote products derived from this software
Davidroid 0:4a3d02667d9f 22 * without specific prior written permission.
Davidroid 0:4a3d02667d9f 23 *
Davidroid 0:4a3d02667d9f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Davidroid 0:4a3d02667d9f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Davidroid 0:4a3d02667d9f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Davidroid 0:4a3d02667d9f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Davidroid 0:4a3d02667d9f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Davidroid 0:4a3d02667d9f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Davidroid 0:4a3d02667d9f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Davidroid 0:4a3d02667d9f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Davidroid 0:4a3d02667d9f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Davidroid 0:4a3d02667d9f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Davidroid 0:4a3d02667d9f 34 *
Davidroid 0:4a3d02667d9f 35 ******************************************************************************
Davidroid 0:4a3d02667d9f 36 */
Davidroid 0:4a3d02667d9f 37
Davidroid 0:4a3d02667d9f 38
Davidroid 0:4a3d02667d9f 39 /* Generated with Stm32CubeTOO -----------------------------------------------*/
Davidroid 0:4a3d02667d9f 40
Davidroid 0:4a3d02667d9f 41
Davidroid 0:4a3d02667d9f 42 /* Define to prevent recursive inclusion -------------------------------------*/
Davidroid 0:4a3d02667d9f 43
Davidroid 0:4a3d02667d9f 44 #ifndef __X_NUCLEO_LED61A1_CLASS_H
Davidroid 0:4a3d02667d9f 45 #define __X_NUCLEO_LED61A1_CLASS_H
Davidroid 0:4a3d02667d9f 46
Davidroid 0:4a3d02667d9f 47
Davidroid 0:4a3d02667d9f 48 /* Includes ------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 49
Davidroid 0:4a3d02667d9f 50 /* ACTION 1 ------------------------------------------------------------------*
Davidroid 0:4a3d02667d9f 51 * Include here platform specific header files. *
Davidroid 0:4a3d02667d9f 52 *----------------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 53 #include "mbed.h"
Davidroid 0:4a3d02667d9f 54 #include "DevI2C.h"
Davidroid 0:4a3d02667d9f 55 /* ACTION 2 ------------------------------------------------------------------*
Davidroid 0:4a3d02667d9f 56 * Include here expansion board configuration's header files. *
Davidroid 0:4a3d02667d9f 57 *----------------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 58 #include "x_nucleo_led61a1_config.h"
Davidroid 0:4a3d02667d9f 59 /* ACTION 3 ------------------------------------------------------------------*
Davidroid 0:4a3d02667d9f 60 * Include here expansion board's components' header files. *
Davidroid 0:4a3d02667d9f 61 * *
Davidroid 0:4a3d02667d9f 62 * Example: *
Davidroid 0:4a3d02667d9f 63 * #include "component_1_class.h" *
Davidroid 0:4a3d02667d9f 64 * #include "component_2_class.h" *
Davidroid 0:4a3d02667d9f 65 *----------------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 66 #include "led6001_class.h"
Davidroid 0:4a3d02667d9f 67
Davidroid 0:4a3d02667d9f 68
Davidroid 0:4a3d02667d9f 69 /* Classes -------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 70
Davidroid 0:4a3d02667d9f 71 /** Class representing a X_NUCLEO_LED61A1 board.
Davidroid 0:4a3d02667d9f 72 */
Davidroid 0:4a3d02667d9f 73 class X_NUCLEO_LED61A1
Davidroid 0:4a3d02667d9f 74 {
Davidroid 0:4a3d02667d9f 75 public:
Davidroid 0:4a3d02667d9f 76
Davidroid 0:4a3d02667d9f 77 /*** Instance, Initialization and Destructor Methods ***/
Davidroid 0:4a3d02667d9f 78
Davidroid 0:4a3d02667d9f 79 /**
Davidroid 0:4a3d02667d9f 80 * @brief Getting a singleton instance of X_NUCLEO_LED61A1 class.
Davidroid 0:4a3d02667d9f 81 * @param i2c I2C device to be used for communication.
Davidroid 0:4a3d02667d9f 82 * @retval a singleton instance of X_NUCLEO_LED61A1 class.
Davidroid 0:4a3d02667d9f 83 */
Davidroid 0:4a3d02667d9f 84 static X_NUCLEO_LED61A1 *Instance(DevI2C *i2c = NULL);
Davidroid 0:4a3d02667d9f 85
Davidroid 0:4a3d02667d9f 86 /**
Davidroid 0:4a3d02667d9f 87 * @brief Getting a singleton instance of X_NUCLEO_LED61A1 class.
Davidroid 0:4a3d02667d9f 88 * @param sda pin name of the SDA pin of the I2C device to be used for communication.
Davidroid 0:4a3d02667d9f 89 * @param scl pin name of the SCL pin of the I2C device to be used for communication.
Davidroid 0:4a3d02667d9f 90 * @retval a singleton instance of X_NUCLEO_LED61A1 class.
Davidroid 0:4a3d02667d9f 91 */
Davidroid 0:4a3d02667d9f 92 static X_NUCLEO_LED61A1 *Instance(PinName sda, PinName scl);
Davidroid 0:4a3d02667d9f 93
Davidroid 0:4a3d02667d9f 94 /**
Davidroid 0:4a3d02667d9f 95 * @brief Initializing the X_NUCLEO_LED61A1 board.
Davidroid 0:4a3d02667d9f 96 * @retval true if initialization is successful, false otherwise.
Davidroid 0:4a3d02667d9f 97 */
Davidroid 0:4a3d02667d9f 98 bool Init(void);
Davidroid 0:4a3d02667d9f 99
Davidroid 0:4a3d02667d9f 100 /**
Davidroid 0:4a3d02667d9f 101 * @brief Destructor.
Davidroid 0:4a3d02667d9f 102 */
Davidroid 0:4a3d02667d9f 103 ~X_NUCLEO_LED61A1(void) {}
Davidroid 0:4a3d02667d9f 104
Davidroid 0:4a3d02667d9f 105
Davidroid 0:4a3d02667d9f 106 /*** Public Expansion Board Related Attributes ***/
Davidroid 0:4a3d02667d9f 107
Davidroid 0:4a3d02667d9f 108 /* ACTION 4 --------------------------------------------------------------*
Davidroid 0:4a3d02667d9f 109 * Declare here a public attribute for each expansion board's component. *
Davidroid 0:4a3d02667d9f 110 * You will have to call these attributes' public methods within your *
Davidroid 0:4a3d02667d9f 111 * main program. *
Davidroid 0:4a3d02667d9f 112 * *
Davidroid 0:4a3d02667d9f 113 * Example: *
Davidroid 0:4a3d02667d9f 114 * COMPONENT_1 *component_1; *
Davidroid 0:4a3d02667d9f 115 * COMPONENT_2 *component_2; *
Davidroid 0:4a3d02667d9f 116 *------------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 117 LED6001 *led6001;
Davidroid 0:4a3d02667d9f 118
Davidroid 0:4a3d02667d9f 119
Davidroid 0:4a3d02667d9f 120 protected:
Davidroid 0:4a3d02667d9f 121
Davidroid 0:4a3d02667d9f 122 /*** Protected Constructor Method ***/
Davidroid 0:4a3d02667d9f 123
Davidroid 0:4a3d02667d9f 124 /**
Davidroid 0:4a3d02667d9f 125 * @brief Constructor.
Davidroid 0:4a3d02667d9f 126 * @param i2c I2C device to be used for communication.
Davidroid 0:4a3d02667d9f 127 */
Davidroid 0:4a3d02667d9f 128 X_NUCLEO_LED61A1(DevI2C *i2c);
Davidroid 0:4a3d02667d9f 129
Davidroid 0:4a3d02667d9f 130
Davidroid 0:4a3d02667d9f 131 /*** Protected Expansion Board Related Initialization Methods ***/
Davidroid 0:4a3d02667d9f 132
Davidroid 0:4a3d02667d9f 133 /* ACTION 5 --------------------------------------------------------------*
Davidroid 0:4a3d02667d9f 134 * Declare here a protected initialization method for each expansion *
Davidroid 0:4a3d02667d9f 135 * board's component. *
Davidroid 0:4a3d02667d9f 136 * *
Davidroid 0:4a3d02667d9f 137 * Example: *
Davidroid 0:4a3d02667d9f 138 * bool Init_COMPONENT_1(void); *
Davidroid 0:4a3d02667d9f 139 * bool Init_COMPONENT_2(void); *
Davidroid 0:4a3d02667d9f 140 *------------------------------------------------------------------------*/
Davidroid 0:4a3d02667d9f 141 bool Init_LED6001(void);
Davidroid 0:4a3d02667d9f 142
Davidroid 0:4a3d02667d9f 143
Davidroid 0:4a3d02667d9f 144 /*** Component's Instance Variables ***/
Davidroid 0:4a3d02667d9f 145
Davidroid 0:4a3d02667d9f 146 /* Singleton instance of X_NUCLEO_LED61A1 class. */
Davidroid 0:4a3d02667d9f 147 static X_NUCLEO_LED61A1 *_instance;
Davidroid 0:4a3d02667d9f 148
Davidroid 0:4a3d02667d9f 149 /* IO Device. */
Davidroid 0:4a3d02667d9f 150 DevI2C *dev_i2c;
Davidroid 0:4a3d02667d9f 151 };
Davidroid 0:4a3d02667d9f 152
Davidroid 0:4a3d02667d9f 153 #endif // __X_NUCLEO_LED61A1_CLASS_H
Davidroid 0:4a3d02667d9f 154
Davidroid 0:4a3d02667d9f 155 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/