Class module for NCP5623B I2C LED driver
Dependents: mDotEVBM2X MTDOT-EVB-LinkCheck-AL MTDOT-EVBDemo-DRH MTDOT_BOX_EVB_Blinky ... more
NCP5623B.cpp@3:d8a72ac9972b, 2015-12-21 (annotated)
- Committer:
- Mike Fiore
- Date:
- Mon Dec 21 10:50:05 2015 -0600
- Revision:
- 3:d8a72ac9972b
- Parent:
- 2:9c70b63e3b1e
- Child:
- 4:ae3ff403404a
protect serial transactions by disabling interrupts
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
falingtrea | 0:b28a2dfe05fd | 1 | /** |
falingtrea | 0:b28a2dfe05fd | 2 | * @file NCP5623B.cpp |
falingtrea | 0:b28a2dfe05fd | 3 | * @brief Device driver - NCP5623B Triple LED Driver IC w/RTOS support |
falingtrea | 0:b28a2dfe05fd | 4 | * @author Tim Barr |
falingtrea | 0:b28a2dfe05fd | 5 | * @version 1.0 |
falingtrea | 0:b28a2dfe05fd | 6 | * @see http://www.onsemi.com/pub/Collateral/NCP5623B-D.PDF |
falingtrea | 0:b28a2dfe05fd | 7 | * |
falingtrea | 0:b28a2dfe05fd | 8 | * Copyright (c) 2015 |
falingtrea | 0:b28a2dfe05fd | 9 | * |
falingtrea | 0:b28a2dfe05fd | 10 | * Licensed under the Apache License, Version 2.0 (the "License"); |
falingtrea | 0:b28a2dfe05fd | 11 | * you may not use this file except in compliance with the License. |
falingtrea | 0:b28a2dfe05fd | 12 | * You may obtain a copy of the License at |
falingtrea | 0:b28a2dfe05fd | 13 | * |
falingtrea | 0:b28a2dfe05fd | 14 | * http://www.apache.org/licenses/LICENSE-2.0 |
falingtrea | 0:b28a2dfe05fd | 15 | * |
falingtrea | 0:b28a2dfe05fd | 16 | * Unless required by applicable law or agreed to in writing, software |
falingtrea | 0:b28a2dfe05fd | 17 | * distributed under the License is distributed on an "AS IS" BASIS, |
falingtrea | 0:b28a2dfe05fd | 18 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
falingtrea | 0:b28a2dfe05fd | 19 | * See the License for the specific language governing permissions and |
falingtrea | 0:b28a2dfe05fd | 20 | * limitations under the License. |
falingtrea | 0:b28a2dfe05fd | 21 | */ |
mfiore | 1:f0efe8462d0e | 22 | |
falingtrea | 0:b28a2dfe05fd | 23 | #include "NCP5623B.h" |
falingtrea | 0:b28a2dfe05fd | 24 | #include "mbed_debug.h" |
falingtrea | 0:b28a2dfe05fd | 25 | #include "rtos.h" |
mfiore | 1:f0efe8462d0e | 26 | |
falingtrea | 0:b28a2dfe05fd | 27 | NCP5623B::NCP5623B(I2C &i2c) |
falingtrea | 0:b28a2dfe05fd | 28 | { |
falingtrea | 0:b28a2dfe05fd | 29 | _i2c = &i2c; |
falingtrea | 0:b28a2dfe05fd | 30 | |
falingtrea | 0:b28a2dfe05fd | 31 | NCP5623B::init(); |
mfiore | 1:f0efe8462d0e | 32 | |
falingtrea | 0:b28a2dfe05fd | 33 | return; |
falingtrea | 0:b28a2dfe05fd | 34 | } |
falingtrea | 0:b28a2dfe05fd | 35 | |
falingtrea | 0:b28a2dfe05fd | 36 | uint8_t NCP5623B::init(void) |
falingtrea | 0:b28a2dfe05fd | 37 | { |
falingtrea | 0:b28a2dfe05fd | 38 | uint8_t result = 0; |
mfiore | 1:f0efe8462d0e | 39 | |
Mike Fiore |
3:d8a72ac9972b | 40 | __disable_irq(); |
falingtrea | 0:b28a2dfe05fd | 41 | _i2c->frequency(400000); |
Mike Fiore |
3:d8a72ac9972b | 42 | __enable_irq(); |
mfiore | 1:f0efe8462d0e | 43 | |
falingtrea | 0:b28a2dfe05fd | 44 | // Turn off all LEDs and initialize all registers |
mfiore | 1:f0efe8462d0e | 45 | result |= NCP5623B::writeRegister(NCP5623B::DIMDWNSET, 0x00); |
falingtrea | 0:b28a2dfe05fd | 46 | result |= NCP5623B::writeRegister(NCP5623B::DIMTIME, 0x01); |
falingtrea | 0:b28a2dfe05fd | 47 | osDelay (1000); |
falingtrea | 0:b28a2dfe05fd | 48 | result |= NCP5623B::writeRegister(NCP5623B::LEDCURR, 0x00); |
mfiore | 1:f0efe8462d0e | 49 | result |= NCP5623B::writeRegister(NCP5623B::PWMLED1, 0x00); |
mfiore | 1:f0efe8462d0e | 50 | result |= NCP5623B::writeRegister(NCP5623B::PWMLED2, 0x00); |
mfiore | 1:f0efe8462d0e | 51 | result |= NCP5623B::writeRegister(NCP5623B::PWMLED3, 0x00); |
falingtrea | 0:b28a2dfe05fd | 52 | |
mfiore | 1:f0efe8462d0e | 53 | return result; |
falingtrea | 0:b28a2dfe05fd | 54 | } |
falingtrea | 0:b28a2dfe05fd | 55 | |
mfiore | 1:f0efe8462d0e | 56 | /** Shutdown LEDS |
mfiore | 1:f0efe8462d0e | 57 | * @return status of command |
mfiore | 1:f0efe8462d0e | 58 | */ |
falingtrea | 0:b28a2dfe05fd | 59 | uint8_t NCP5623B::shutdown(void) const |
falingtrea | 0:b28a2dfe05fd | 60 | { |
mfiore | 1:f0efe8462d0e | 61 | uint8_t result = 0; |
falingtrea | 0:b28a2dfe05fd | 62 | |
falingtrea | 0:b28a2dfe05fd | 63 | result |= NCP5623B::writeRegister(NCP5623B::SHUTDWN, 0x00); |
falingtrea | 0:b28a2dfe05fd | 64 | return result; |
falingtrea | 0:b28a2dfe05fd | 65 | |
falingtrea | 0:b28a2dfe05fd | 66 | } |
falingtrea | 0:b28a2dfe05fd | 67 | |
falingtrea | 0:b28a2dfe05fd | 68 | /** Set static LED Current |
falingtrea | 0:b28a2dfe05fd | 69 | * data - value of current draw for all LEDs range 0-31 |
falingtrea | 0:b28a2dfe05fd | 70 | * @return status of command |
falingtrea | 0:b28a2dfe05fd | 71 | */ |
falingtrea | 0:b28a2dfe05fd | 72 | uint8_t NCP5623B::setLEDCurrent(uint8_t data) const |
falingtrea | 0:b28a2dfe05fd | 73 | { |
mfiore | 1:f0efe8462d0e | 74 | uint8_t result = 0; |
falingtrea | 0:b28a2dfe05fd | 75 | |
falingtrea | 0:b28a2dfe05fd | 76 | result |= NCP5623B::writeRegister(NCP5623B::LEDCURR, data); |
falingtrea | 0:b28a2dfe05fd | 77 | return result; |
falingtrea | 0:b28a2dfe05fd | 78 | } |
falingtrea | 0:b28a2dfe05fd | 79 | |
mfiore | 1:f0efe8462d0e | 80 | /** Set PWM mode for specific LED |
mfiore | 1:f0efe8462d0e | 81 | * @lednum - selects LED |
mfiore | 1:f0efe8462d0e | 82 | * @data - PWM value to set range 0-31 0-100% Pulse width |
mfiore | 1:f0efe8462d0e | 83 | * @return status of command |
mfiore | 1:f0efe8462d0e | 84 | */ |
falingtrea | 0:b28a2dfe05fd | 85 | uint8_t NCP5623B::setPWM(LEDNUM lednum, int8_t data ) const |
falingtrea | 0:b28a2dfe05fd | 86 | { |
mfiore | 1:f0efe8462d0e | 87 | uint8_t result = 0; |
falingtrea | 0:b28a2dfe05fd | 88 | |
mfiore | 1:f0efe8462d0e | 89 | switch (lednum) { |
mfiore | 1:f0efe8462d0e | 90 | case NCP5623B::LED_1: |
mfiore | 1:f0efe8462d0e | 91 | result |= NCP5623B::writeRegister(NCP5623B::PWMLED1, data); |
mfiore | 1:f0efe8462d0e | 92 | break; |
mfiore | 1:f0efe8462d0e | 93 | case NCP5623B::LED_2: |
mfiore | 1:f0efe8462d0e | 94 | result |= NCP5623B::writeRegister(NCP5623B::PWMLED2, data); |
mfiore | 1:f0efe8462d0e | 95 | break; |
mfiore | 1:f0efe8462d0e | 96 | case NCP5623B::LED_3: |
mfiore | 1:f0efe8462d0e | 97 | result |= NCP5623B::writeRegister(NCP5623B::PWMLED3, data); |
mfiore | 1:f0efe8462d0e | 98 | break; |
mfiore | 1:f0efe8462d0e | 99 | } |
falingtrea | 0:b28a2dfe05fd | 100 | return result; |
falingtrea | 0:b28a2dfe05fd | 101 | } |
falingtrea | 0:b28a2dfe05fd | 102 | |
mfiore | 1:f0efe8462d0e | 103 | /** Set Dimming mode for all LEDs |
mfiore | 1:f0efe8462d0e | 104 | * @dimdir - direction of dimming |
mfiore | 1:f0efe8462d0e | 105 | * @endstep - ending step of ramp up or ramp down range 0-31 |
mfiore | 1:f0efe8462d0e | 106 | * @steptime - time per step range 0-31 in 8 msec multiples |
mfiore | 1:f0efe8462d0e | 107 | * @return status of command |
mfiore | 1:f0efe8462d0e | 108 | */ |
mfiore | 1:f0efe8462d0e | 109 | uint8_t NCP5623B::setDimming(DIMDIRECTION dimdir, uint8_t endstep, uint8_t steptime) const |
falingtrea | 0:b28a2dfe05fd | 110 | { |
mfiore | 1:f0efe8462d0e | 111 | uint8_t result = 0; |
falingtrea | 0:b28a2dfe05fd | 112 | |
mfiore | 1:f0efe8462d0e | 113 | if (dimdir == NCP5623B::DIMDWN) |
mfiore | 1:f0efe8462d0e | 114 | result |= NCP5623B::writeRegister(NCP5623B::DIMDWNSET, endstep); |
mfiore | 1:f0efe8462d0e | 115 | else |
mfiore | 1:f0efe8462d0e | 116 | result |= NCP5623B::writeRegister(NCP5623B::DIMUPSET, endstep); |
falingtrea | 0:b28a2dfe05fd | 117 | |
mfiore | 1:f0efe8462d0e | 118 | result |= NCP5623B::writeRegister(NCP5623B::DIMTIME, steptime); |
falingtrea | 0:b28a2dfe05fd | 119 | |
mfiore | 1:f0efe8462d0e | 120 | return result; |
falingtrea | 0:b28a2dfe05fd | 121 | } |
mfiore | 1:f0efe8462d0e | 122 | /** Write to a register (exposed for debugging reasons) |
mfiore | 1:f0efe8462d0e | 123 | * @param reg - The register to be written |
mfiore | 1:f0efe8462d0e | 124 | * @param data - The data to be written |
mfiore | 1:f0efe8462d0e | 125 | */ |
falingtrea | 0:b28a2dfe05fd | 126 | uint8_t NCP5623B::writeRegister(NCP5623B::REGISTER const reg, uint8_t const data) const |
falingtrea | 0:b28a2dfe05fd | 127 | { |
falingtrea | 0:b28a2dfe05fd | 128 | char buf[1]; |
falingtrea | 0:b28a2dfe05fd | 129 | uint8_t result = 0; |
falingtrea | 0:b28a2dfe05fd | 130 | |
falingtrea | 0:b28a2dfe05fd | 131 | buf[0] = reg | (data & NCP5623B::DATAMASK); |
mfiore | 1:f0efe8462d0e | 132 | |
Mike Fiore |
3:d8a72ac9972b | 133 | __disable_irq(); |
falingtrea | 0:b28a2dfe05fd | 134 | result |= _i2c->write(_i2c_addr, buf, 1); |
Mike Fiore |
3:d8a72ac9972b | 135 | __enable_irq(); |
mfiore | 1:f0efe8462d0e | 136 | |
falingtrea | 0:b28a2dfe05fd | 137 | return result; |
falingtrea | 0:b28a2dfe05fd | 138 | } |