LED Control Library

Revision 2:a270bdb62fc8, committed 2015-12-17

Comitter:

Davidroid

Date:

Thu Dec 17 18:13:13 2015 +0000

Parent:

1:eab47c592e8f

Child:

3:843080fc7f37

Commit message:

+ Implementation completed.

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Components/Common/component.h	Thu Dec 17 18:13:13 2015 +0000
@@ -0,0 +1,91 @@
+/**
+ ******************************************************************************
+ * @file    component.h
+ * @author  AST
+ * @version V1.0.0
+ * @date    1 April 2015
+ * @brief   Generic header file containing a generic component's definitions
+ *          and I/O functions.
+ ******************************************************************************
+ * @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.
+ *
+ ******************************************************************************
+ */
+
+
+/* Prevent recursive inclusion -----------------------------------------------*/
+
+#ifndef __COMPONENT_H__
+#define __COMPONENT_H__
+
+
+/* Types ---------------------------------------------------------------------*/
+
+/**
+ * @brief  Component's Context structure definition.
+ */
+typedef struct
+{  
+    /* Identity. */
+    uint8_t who_am_i;
+
+    /* ACTION ----------------------------------------------------------------*/
+    /* There should be only a unique identifier for each component, which     */
+    /* should be the "who_am_i" parameter, hence this parameter is optional.  */
+    /* -----------------------------------------------------------------------*/
+    /* Type. */
+    uint8_t type;
+
+    /* Configuration. */
+    uint8_t address;
+
+    /* Pointer to the Data. */
+    void *pData;
+
+    /* Pointer to the Virtual Table. */
+    void *pVTable;
+
+    /* ACTION ----------------------------------------------------------------*/
+    /* There should be only a unique virtual table for each component, which  */
+    /* should be the "pVTable" parameter, hence this parameter is optional.   */
+    /* -----------------------------------------------------------------------*/
+    /* Pointer to the Extended Virtual Table. */
+    void *pExtVTable;
+} DrvContextTypeDef;
+
+/**
+ * @brief  Component's Status enumerator definition.
+ */
+typedef enum
+{
+    COMPONENT_OK = 0,
+    COMPONENT_ERROR,
+    COMPONENT_TIMEOUT,
+    COMPONENT_NOT_IMPLEMENTED
+} DrvStatusTypeDef;
+
+#endif
\ No newline at end of file

--- a/Components/Common/led.h	Mon Dec 14 17:43:29 2015 +0000
+++ b/Components/Common/led.h	Thu Dec 17 18:13:13 2015 +0000
@@ -38,6 +38,7 @@
 
 
 /* Define to prevent recursive inclusion -------------------------------------*/
+
 #ifndef __LED_H
 #define __LED_H
 
@@ -45,8 +46,15 @@
 extern "C" {
 #endif
 
+
 /* Includes ------------------------------------------------------------------*/
+
 #include <stdint.h>
+#include "component.h"
+
+
+/* Types ---------------------------------------------------------------------*/
+
 
 /** @addtogroup BSP
   * @{
@@ -56,42 +64,27 @@
   * @{
   */
 
-/** @addtogroup LED_DRIVER
-  * @{
-  */
-
-/** @defgroup LED_Exported_Types
+/** @addtogroup LED
   * @{
   */
 
 /**
- * @brief  LED_DRIVER init structure definition
+ * @brief LED initialization structure definition.
  */
 typedef struct
 {
-  uint8_t PdimVal;
-  uint8_t AdimVal;  
+  int placeholder;
 } LED_InitTypeDef;
 
 /**
- * @brief  LED_DRIVER component id enumerator definition
- */
-typedef enum
-{
-  LED_NONE_COMPONENT = 0,
-  LED_LED6001_COMPONENT = 1,
-} LED_ComponentTypeDef;
-
-/**
- * @brief  LED_DRIVER driver structure definition
+ * @brief  LED driver structure definition.
  */
 typedef struct
 {
-  DrvStatusTypeDef (*Init)(LED_InitTypeDef *);
-  void (*DeInit)(void);
-  void (*SetPwmDim)(uint8_t);
-  void (*SetAnaDim)(uint8_t);
-  DrvStatusTypeDef (*FaultStatus)(void);
+  DrvStatusTypeDef (*Init)(void *handle, LED_InitTypeDef *init);
+  DrvStatusTypeDef (*ReadID)(void *handle, uint8_t *id);
+  void (*SetPWMDimming)(void *handle, uint8_t dimming);
+  void (*SetAnalogDimming)(void *handle, uint8_t dimming);
 } LED_DrvVTableTypeDef;
 
 #ifdef __cplusplus

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Components/Interfaces/Component_class.h	Thu Dec 17 18:13:13 2015 +0000
@@ -0,0 +1,75 @@
+/**
+ ******************************************************************************
+ * @file    Component_class.h
+ * @author  Davide Aliprandi, STMicrolectronics
+ * @version V1.0.0
+ * @date    April 13th, 2015
+ * @brief   This file contains the abstract class describing the interface of a
+ *          generic component.
+ ******************************************************************************
+ * @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.
+ *
+ ******************************************************************************
+ */
+
+
+/* Define to prevent from recursive inclusion --------------------------------*/
+
+#ifndef __COMPONENT_CLASS_H
+#define __COMPONENT_CLASS_H
+
+
+/* Includes ------------------------------------------------------------------*/
+
+#include <stdint.h>
+
+
+/* Classes  ------------------------------------------------------------------*/
+
+/** An abstract class for Generic components.
+ */
+class Component
+{
+public:
+    /**
+     * @brief  Initializing the component.
+     * @param  init Pointer to device specific initalization structure.
+     * @retval "0" in case of success, an error code otherwise.
+     */
+    virtual int Init(void *init) = 0;
+
+    /**
+     * @brief  Getting the ID of the component.
+     * @param  id Pointer to an allocated variable to store the ID into.
+     * @retval "0" in case of success, an error code otherwise.
+     */
+    virtual int ReadID(uint8_t *id) = 0;
+};
+
+#endif /* __COMPONENT_CLASS_H */
+
+/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 

--- a/Components/Interfaces/Led_class.h	Mon Dec 14 17:43:29 2015 +0000
+++ b/Components/Interfaces/Led_class.h	Thu Dec 17 18:13:13 2015 +0000
@@ -78,6 +78,27 @@
      * Example:                                                               *
      *    virtual int GetValue(float *pfData) = 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 GetCurrent(void) = 0;
+
+    /**
+     * @brief  Setting PWM dimming value.
+     * @param  dimming PWM dimming value.
+     * @retval None.
+     */
+    virtual void SetPWMDimming(float dimming) = 0;
+
+    /**
+     * @brief  Setting Analog dimming value.
+     * @param  dimming Analog dimming value.
+     * @retval None.
+     */
+    virtual void SetAnalogDimming(float dimming) = 0;
 };
 
 #endif /* __LED_CLASS_H */

--- a/Components/led6001/led6001_class.cpp	Mon Dec 14 17:43:29 2015 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,118 +0,0 @@
-/**
- ******************************************************************************
- * @file    led6001_class.cpp
- * @author  CL
- * @version V1.0.0
- * @date    30-Sep-2015
- * @brief   This file contains implementation of the LED6001's firmware driver.
- ******************************************************************************
- * @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 -----------------------------------------------*/
-
-
-/* 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/led6001/led6001.c
-    Revision:         0
-*/
-
-
-/* Includes ------------------------------------------------------------------*/
-
-#include "led6001_class.h"
-#include "led6001.h"
-
-
-/* Methods -------------------------------------------------------------------*/
-
-/**
- * @brief  Initializing the component.
- * @param  init Configuration settings for the LED6001 component.
- * @retval COMPONENT_OK in case of success, an error code otherwise.
- */
-LED_StatusTypeDef LED6001::Init/*LED6001_Init*/(LED_InitTypeDef *init)
-{
-#if 0
-  /* Configure the low level interface */
-  if (LED6001_IO_Init() != COMPONENT_OK)
-  {
-    return COMPONENT_ERROR;
-  }
-  
-  LED6001_IO_ITConfig();
-#endif
-  return COMPONENT_OK;
-}
-#if 0
-/**
- * @brief  Deinitializing the component.
- * @param  None.
- * @retval None.
- */
-void LED6001::LED6001_DeInit(void)
-{
-  LED6001_IO_DeInit();
-}
-
-/**
- * @brief  Setting PWM dim value.
- * @param  value PWM dim value.
- * @retval None.
- */
-void LED6001::LED6001_SetPwmDim(uint8_t value)
-{
-  LED6001_SetPdimTimer(value);
-}
-
-/**
- * @brief  Setting analog dim value.
- * @param  value Analog dim value.
- * @retval None.
- */
-void LED6001::LED6001_SetAnaDim(uint8_t value)
-{
-  LED6001_SetAdimTimer(value);
-}
-
-/**
- * @brief  Returning fault status of the component.
- * @param  None.
- * @retval Fault status.
- */
-LED_StatusTypeDef LED6001::LED6001_FaultStatus(void)
-{
-  return COMPONENT_OK;
-}
-#endif
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/

--- a/Components/led6001/led6001_class.h	Mon Dec 14 17:43:29 2015 +0000
+++ b/Components/led6001/led6001_class.h	Thu Dec 17 18:13:13 2015 +0000
@@ -74,6 +74,19 @@
 #include "../Interfaces/Led_class.h"
 
 
+/* Definitions ---------------------------------------------------------------*/
+
+/* Period of PWM and Analog Dimming modes's PWM signal. */
+#define PWM_PERIOD_ms      10
+
+/* Duty Cycle of PWM and Analog Dimming modes's PWM signal to power the LED off. */
+#define PWM_DIMMING_OFF    0.001f
+
+/* Duty Cycle Range of Analog Dimming. */
+#define MAX_PWM_ANALOG_DIMMING (1.2f/3.3f)
+#define MIN_PWM_ANALOG_DIMMING (0.3f/3.3f)
+
+
 /* Classes -------------------------------------------------------------------*/
 
 /**
@@ -90,8 +103,10 @@
      * @param xfault_irq pin name of the XFAULT pin of the component.
      * @param current    pin name of the ADC pin of the component responsible
      *                   for sensing the current flowing through the LED.
+     * @param pwm        pin name of the PWM pin of the component.
+     * @param analog     pin name of the Analog pin of the component.
      */
-    LED6001(PinName xfault_irq, PinName current) : Led(), xfault_irq(xfault_irq), current(current)
+    LED6001(PinName xfault_irq, PinName current, PinName pwm, PinName analog) : Led(), xfault_irq(xfault_irq), current(current), pwm(pwm), analog(analog)
     {
         /* ACTION 4 ----------------------------------------------------------*
          * Initialize here the component's member variables, one variable per *
@@ -133,55 +148,72 @@
      *------------------------------------------------------------------------*/
     /**
      * @brief  Initializing the component.
-     * @param  init Configuration settings for the LED6001 component.
-     * @retval COMPONENT_OK in case of success, an error code otherwise.
+     * @param  init Pointer to device specific initalization structure.
+     * @retval "0" in case of success, an error code otherwise.
      */
-    virtual int Init(void *init) {}
-#if 0
+    virtual int Init(void *init = NULL)
     {
-        return (int) LED6001_Init((void *) init);
+        pwm.period_ms(PWM_PERIOD_ms);
+        analog.period_ms(PWM_PERIOD_ms);
+        return (int) COMPONENT_OK;
     }
 
     /**
-     * @brief  Deinitializing the component.
-     * @param  None.
-     * @retval None.
+     * @brief  Getting the ID of the component.
+     * @param  id Pointer to an allocated variable to store the ID into.
+     * @retval "0" in case of success, an error code otherwise.
      */
-    virtual void DeInit(void)
+    virtual int ReadID(uint8_t *id)
     {
-        LED6001_DeInit();
+        return (int) COMPONENT_OK;
+    }
+
+    /**
+     * @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 GetCurrent(void)
+    {
+        return current.read();
     }
 
     /**
-     * @brief  Setting PWM dim value.
-     * @param  value PWM dim value.
+     * @brief  Setting PWM dimming value.
+     * @param  dimming PWM dimming value, represented as a floating
+     *         point number in the range [0.0, 1.0].
      * @retval None.
      */
-    virtual void SetPwmDim(uint8_t)
+    virtual void SetPWMDimming(float dimming)
     {
-        LED6001_SetPwmDim(() uint8_t);
+        if (dimming >= 0.0f && dimming <= 1.0f)
+            pwm.write(dimming);
     }
 
     /**
-     * @brief  Setting analog dim value.
-     * @param  value Analog dim value.
+     * @brief  Setting Analog dimming value.
+     * @param  dimming Analog dimming value, represented as a floating
+     *         point number in the range [0.0, 1.0].
      * @retval None.
      */
-    virtual void SetAnaDim(uint8_t)
+    virtual void SetAnalogDimming(float dimming)
     {
-        LED6001_SetAnaDim(() uint8_t);
+        if (dimming >= 0.0f && dimming <= 1.0f)
+            analog.write(dimming * (MAX_PWM_ANALOG_DIMMING - MIN_PWM_ANALOG_DIMMING) + MIN_PWM_ANALOG_DIMMING);
     }
 
     /**
-     * @brief  Returning fault status of the component.
+     * @brief  Powering OFF.
      * @param  None.
-     * @retval Fault status.
+     * @retval None.
      */
-    virtual int FaultStatus(void)
+    virtual void PowerOFF(void)
     {
-        return (int) LED6001_FaultStatus();
+        SetPWMDimming(PWM_DIMMING_OFF);
+        SetAnalogDimming(PWM_DIMMING_OFF);
     }
-#endif
+
 
     /*** Public Interrupt Related Methods ***/
 
@@ -285,7 +317,8 @@
      *   + mbed:                                                              *
      *     InterruptIn feature_irq;                                           *
      *------------------------------------------------------------------------*/
-     InterruptIn xfault_irq;
+    /* XFault Interrupt. */
+    InterruptIn xfault_irq;
 
     /* ACTION 10 -------------------------------------------------------------*
      * Declare here other pin related variables, if needed.                   *
@@ -294,7 +327,14 @@
      *   + mbed:                                                              *
      *     DigitalOut standby_reset;                                          *
      *------------------------------------------------------------------------*/
-     AnalogIn current;
+    /* Pin to sense the current flowing through the LED. */
+    AnalogIn current;
+
+    /* Pulse Width Modulation dimming pin. */
+    PwmOut pwm;
+
+    /* Analog dimming pin. */
+    PwmOut analog;
 
     /* ACTION 11 -------------------------------------------------------------*
      * Declare here communication related variables, if needed.               *
@@ -310,8 +350,6 @@
      * Note that there should be only a unique identifier for each component, *
      * which should be the "who_am_i" parameter.                              *
      *------------------------------------------------------------------------*/
-    /* Identity */
-    uint8_t who_am_i;
 
     /* ACTION 13 -------------------------------------------------------------*
      * Declare here the component's static and non-static data, one variable  *