LED Control Library

Diff: Components/led6001/led6001_class.h

Revision:

2:a270bdb62fc8

Parent:

1:eab47c592e8f

Child:

3:843080fc7f37

--- 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  *