Abstract class for 'constant current (CC)' LED driver component. Including "LedPwmOutCC API" class.
CompLedDvrCC.h@1:877856770b37, 2015-03-19 (annotated)
- Committer:
- nxp_ip
- Date:
- Thu Mar 19 08:39:52 2015 +0000
- Revision:
- 1:877856770b37
- Parent:
- 0:6d2f6c0fcc40
API document update
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
nxp_ip | 0:6d2f6c0fcc40 | 1 | /** Abstract class for 'constant-current (CC)' LED driver component |
nxp_ip | 0:6d2f6c0fcc40 | 2 | * |
nxp_ip | 0:6d2f6c0fcc40 | 3 | * Abstract class for CC-LED driver family |
nxp_ip | 0:6d2f6c0fcc40 | 4 | * No instance can be made from this class |
nxp_ip | 0:6d2f6c0fcc40 | 5 | * |
nxp_ip | 0:6d2f6c0fcc40 | 6 | * @author Akifumi (Tedd) OKANO, NXP Semiconductors |
nxp_ip | 1:877856770b37 | 7 | * @version 0.6 |
nxp_ip | 1:877856770b37 | 8 | * @date 19-Mar-2015 |
nxp_ip | 0:6d2f6c0fcc40 | 9 | * |
nxp_ip | 0:6d2f6c0fcc40 | 10 | * Released under the Apache 2 license License |
nxp_ip | 0:6d2f6c0fcc40 | 11 | */ |
nxp_ip | 0:6d2f6c0fcc40 | 12 | |
nxp_ip | 0:6d2f6c0fcc40 | 13 | #ifndef MBED_CompLedDvrCC |
nxp_ip | 0:6d2f6c0fcc40 | 14 | #define MBED_CompLedDvrCC |
nxp_ip | 0:6d2f6c0fcc40 | 15 | |
nxp_ip | 0:6d2f6c0fcc40 | 16 | #include "mbed.h" |
nxp_ip | 0:6d2f6c0fcc40 | 17 | |
nxp_ip | 0:6d2f6c0fcc40 | 18 | typedef enum { |
nxp_ip | 0:6d2f6c0fcc40 | 19 | /** Pin names of LED driver. Those are L0 .. L3, not like "LED0" to avoid mbed board LED names */ |
nxp_ip | 1:877856770b37 | 20 | L0, /**< LED0 pin */ |
nxp_ip | 1:877856770b37 | 21 | L1, /**< LED1 pin */ |
nxp_ip | 1:877856770b37 | 22 | L2, /**< LED2 pin */ |
nxp_ip | 1:877856770b37 | 23 | L3, /**< LED3 pin */ |
nxp_ip | 1:877856770b37 | 24 | L4, /**< LED4 pin */ |
nxp_ip | 1:877856770b37 | 25 | L5, /**< LED5 pin */ |
nxp_ip | 1:877856770b37 | 26 | L6, /**< LED6 pin */ |
nxp_ip | 1:877856770b37 | 27 | L7, /**< LED7 pin */ |
nxp_ip | 1:877856770b37 | 28 | L8, /**< LED8 pin */ |
nxp_ip | 1:877856770b37 | 29 | L9, /**< LED9 pin */ |
nxp_ip | 1:877856770b37 | 30 | L10, /**< LED10 pin */ |
nxp_ip | 1:877856770b37 | 31 | L11, /**< LED11 pin */ |
nxp_ip | 1:877856770b37 | 32 | L12, /**< LED12 pin */ |
nxp_ip | 1:877856770b37 | 33 | L13, /**< LED13 pin */ |
nxp_ip | 1:877856770b37 | 34 | L14, /**< LED14 pin */ |
nxp_ip | 1:877856770b37 | 35 | L15, /**< LED15 pin */ |
nxp_ip | 1:877856770b37 | 36 | L16, /**< LED16 pin */ |
nxp_ip | 1:877856770b37 | 37 | L17, /**< LED17 pin */ |
nxp_ip | 1:877856770b37 | 38 | L18, /**< LED18 pin */ |
nxp_ip | 1:877856770b37 | 39 | L19, /**< LED19 pin */ |
nxp_ip | 1:877856770b37 | 40 | L20, /**< LED20 pin */ |
nxp_ip | 1:877856770b37 | 41 | L21, /**< LED21 pin */ |
nxp_ip | 1:877856770b37 | 42 | L22, /**< LED22 pin */ |
nxp_ip | 1:877856770b37 | 43 | L23, /**< LED23 pin */ |
nxp_ip | 0:6d2f6c0fcc40 | 44 | L_NC = ~0x0L /**< for when the pin is left no-connection */ |
nxp_ip | 0:6d2f6c0fcc40 | 45 | } LedPinName; |
nxp_ip | 0:6d2f6c0fcc40 | 46 | |
nxp_ip | 0:6d2f6c0fcc40 | 47 | |
nxp_ip | 0:6d2f6c0fcc40 | 48 | /** Abstract class for CC-LED driver component |
nxp_ip | 0:6d2f6c0fcc40 | 49 | * |
nxp_ip | 0:6d2f6c0fcc40 | 50 | * @class CompLedDvrCC |
nxp_ip | 0:6d2f6c0fcc40 | 51 | * |
nxp_ip | 0:6d2f6c0fcc40 | 52 | * Abstract class for LED driver family |
nxp_ip | 0:6d2f6c0fcc40 | 53 | * No instance can be made from this class |
nxp_ip | 0:6d2f6c0fcc40 | 54 | */ |
nxp_ip | 0:6d2f6c0fcc40 | 55 | class CompLedDvrCC |
nxp_ip | 0:6d2f6c0fcc40 | 56 | { |
nxp_ip | 0:6d2f6c0fcc40 | 57 | public: |
nxp_ip | 0:6d2f6c0fcc40 | 58 | /** Default constructor */ |
nxp_ip | 0:6d2f6c0fcc40 | 59 | CompLedDvrCC(); |
nxp_ip | 0:6d2f6c0fcc40 | 60 | |
nxp_ip | 0:6d2f6c0fcc40 | 61 | /** Destructor */ |
nxp_ip | 0:6d2f6c0fcc40 | 62 | virtual ~CompLedDvrCC(); |
nxp_ip | 0:6d2f6c0fcc40 | 63 | |
nxp_ip | 0:6d2f6c0fcc40 | 64 | /** Virtual function to define standard function of the component */ |
nxp_ip | 0:6d2f6c0fcc40 | 65 | virtual void pwm( int port, float v ) = 0; |
nxp_ip | 0:6d2f6c0fcc40 | 66 | |
nxp_ip | 0:6d2f6c0fcc40 | 67 | /** Virtual function to define standard function of the component */ |
nxp_ip | 0:6d2f6c0fcc40 | 68 | virtual void current( int port, float v ) = 0; |
nxp_ip | 0:6d2f6c0fcc40 | 69 | } |
nxp_ip | 0:6d2f6c0fcc40 | 70 | ; |
nxp_ip | 0:6d2f6c0fcc40 | 71 | |
nxp_ip | 0:6d2f6c0fcc40 | 72 | #endif // MBED_CompLedDvrCC |
nxp_ip | 0:6d2f6c0fcc40 | 73 | |
nxp_ip | 0:6d2f6c0fcc40 | 74 |