Multi-Hackers / NCP5623B

Class module for NCP5623B I2C LED driver

Dependents:   mDotEVBM2X MTDOT-EVB-LinkCheck-AL MTDOT-EVBDemo-DRH MTDOT_BOX_EVB_Blinky ... more

NCP5623B.cpp@1:f0efe8462d0e, 2015-10-27 (annotated)

Committer:
mfiore
Date:
Tue Oct 27 19:56:56 2015 +0000
Revision:
1:f0efe8462d0e
Parent:
0:b28a2dfe05fd
Child:
2:9c70b63e3b1e
<CTRL><SHIFT><f> to fix formatting

Who changed what in which revision?

UserRevisionLine numberNew 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
falingtrea 0:b28a2dfe05fd 40 _i2c->frequency(400000);
mfiore 1:f0efe8462d0e 41
falingtrea 0:b28a2dfe05fd 42 // Turn off all LEDs and initialize all registers
mfiore 1:f0efe8462d0e 43 result |= NCP5623B::writeRegister(NCP5623B::DIMDWNSET, 0x00);
falingtrea 0:b28a2dfe05fd 44 result |= NCP5623B::writeRegister(NCP5623B::DIMTIME, 0x01);
falingtrea 0:b28a2dfe05fd 45 osDelay (1000);
falingtrea 0:b28a2dfe05fd 46 result |= NCP5623B::writeRegister(NCP5623B::LEDCURR, 0x00);
mfiore 1:f0efe8462d0e 47 result |= NCP5623B::writeRegister(NCP5623B::PWMLED1, 0x00);
mfiore 1:f0efe8462d0e 48 result |= NCP5623B::writeRegister(NCP5623B::PWMLED2, 0x00);
mfiore 1:f0efe8462d0e 49 result |= NCP5623B::writeRegister(NCP5623B::PWMLED3, 0x00);
falingtrea 0:b28a2dfe05fd 50
mfiore 1:f0efe8462d0e 51 if(result != 0) {
falingtrea 0:b28a2dfe05fd 52 debug("ILS29011:init failed\n\r");
falingtrea 0:b28a2dfe05fd 53 }
mfiore 1:f0efe8462d0e 54
mfiore 1:f0efe8462d0e 55 return result;
falingtrea 0:b28a2dfe05fd 56 }
falingtrea 0:b28a2dfe05fd 57
mfiore 1:f0efe8462d0e 58 /** Shutdown LEDS
mfiore 1:f0efe8462d0e 59 * @return status of command
mfiore 1:f0efe8462d0e 60 */
falingtrea 0:b28a2dfe05fd 61 uint8_t NCP5623B::shutdown(void) const
falingtrea 0:b28a2dfe05fd 62 {
mfiore 1:f0efe8462d0e 63 uint8_t result = 0;
falingtrea 0:b28a2dfe05fd 64
falingtrea 0:b28a2dfe05fd 65 result |= NCP5623B::writeRegister(NCP5623B::SHUTDWN, 0x00);
falingtrea 0:b28a2dfe05fd 66 return result;
falingtrea 0:b28a2dfe05fd 67
falingtrea 0:b28a2dfe05fd 68 }
falingtrea 0:b28a2dfe05fd 69
falingtrea 0:b28a2dfe05fd 70 /** Set static LED Current
falingtrea 0:b28a2dfe05fd 71 * data - value of current draw for all LEDs range 0-31
falingtrea 0:b28a2dfe05fd 72 * @return status of command
falingtrea 0:b28a2dfe05fd 73 */
falingtrea 0:b28a2dfe05fd 74 uint8_t NCP5623B::setLEDCurrent(uint8_t data) const
falingtrea 0:b28a2dfe05fd 75 {
mfiore 1:f0efe8462d0e 76 uint8_t result = 0;
falingtrea 0:b28a2dfe05fd 77
falingtrea 0:b28a2dfe05fd 78 result |= NCP5623B::writeRegister(NCP5623B::LEDCURR, data);
falingtrea 0:b28a2dfe05fd 79 return result;
falingtrea 0:b28a2dfe05fd 80 }
falingtrea 0:b28a2dfe05fd 81
mfiore 1:f0efe8462d0e 82 /** Set PWM mode for specific LED
mfiore 1:f0efe8462d0e 83 * @lednum - selects LED
mfiore 1:f0efe8462d0e 84 * @data - PWM value to set range 0-31 0-100% Pulse width
mfiore 1:f0efe8462d0e 85 * @return status of command
mfiore 1:f0efe8462d0e 86 */
falingtrea 0:b28a2dfe05fd 87 uint8_t NCP5623B::setPWM(LEDNUM lednum, int8_t data ) const
falingtrea 0:b28a2dfe05fd 88 {
mfiore 1:f0efe8462d0e 89 uint8_t result = 0;
falingtrea 0:b28a2dfe05fd 90
mfiore 1:f0efe8462d0e 91 switch (lednum) {
mfiore 1:f0efe8462d0e 92 case NCP5623B::LED_1:
mfiore 1:f0efe8462d0e 93 result |= NCP5623B::writeRegister(NCP5623B::PWMLED1, data);
mfiore 1:f0efe8462d0e 94 break;
mfiore 1:f0efe8462d0e 95 case NCP5623B::LED_2:
mfiore 1:f0efe8462d0e 96 result |= NCP5623B::writeRegister(NCP5623B::PWMLED2, data);
mfiore 1:f0efe8462d0e 97 break;
mfiore 1:f0efe8462d0e 98 case NCP5623B::LED_3:
mfiore 1:f0efe8462d0e 99 result |= NCP5623B::writeRegister(NCP5623B::PWMLED3, data);
mfiore 1:f0efe8462d0e 100 break;
mfiore 1:f0efe8462d0e 101 }
falingtrea 0:b28a2dfe05fd 102 return result;
falingtrea 0:b28a2dfe05fd 103 }
falingtrea 0:b28a2dfe05fd 104
mfiore 1:f0efe8462d0e 105 /** Set Dimming mode for all LEDs
mfiore 1:f0efe8462d0e 106 * @dimdir - direction of dimming
mfiore 1:f0efe8462d0e 107 * @endstep - ending step of ramp up or ramp down range 0-31
mfiore 1:f0efe8462d0e 108 * @steptime - time per step range 0-31 in 8 msec multiples
mfiore 1:f0efe8462d0e 109 * @return status of command
mfiore 1:f0efe8462d0e 110 */
mfiore 1:f0efe8462d0e 111 uint8_t NCP5623B::setDimming(DIMDIRECTION dimdir, uint8_t endstep, uint8_t steptime) const
falingtrea 0:b28a2dfe05fd 112 {
mfiore 1:f0efe8462d0e 113 uint8_t result = 0;
falingtrea 0:b28a2dfe05fd 114
mfiore 1:f0efe8462d0e 115 if (dimdir == NCP5623B::DIMDWN)
mfiore 1:f0efe8462d0e 116 result |= NCP5623B::writeRegister(NCP5623B::DIMDWNSET, endstep);
mfiore 1:f0efe8462d0e 117 else
mfiore 1:f0efe8462d0e 118 result |= NCP5623B::writeRegister(NCP5623B::DIMUPSET, endstep);
falingtrea 0:b28a2dfe05fd 119
mfiore 1:f0efe8462d0e 120 result |= NCP5623B::writeRegister(NCP5623B::DIMTIME, steptime);
falingtrea 0:b28a2dfe05fd 121
mfiore 1:f0efe8462d0e 122 return result;
falingtrea 0:b28a2dfe05fd 123 }
mfiore 1:f0efe8462d0e 124 /** Write to a register (exposed for debugging reasons)
mfiore 1:f0efe8462d0e 125 * @param reg - The register to be written
mfiore 1:f0efe8462d0e 126 * @param data - The data to be written
mfiore 1:f0efe8462d0e 127 */
falingtrea 0:b28a2dfe05fd 128 uint8_t NCP5623B::writeRegister(NCP5623B::REGISTER const reg, uint8_t const data) const
falingtrea 0:b28a2dfe05fd 129 {
falingtrea 0:b28a2dfe05fd 130 char buf[1];
falingtrea 0:b28a2dfe05fd 131 uint8_t result = 0;
falingtrea 0:b28a2dfe05fd 132
falingtrea 0:b28a2dfe05fd 133 buf[0] = reg | (data & NCP5623B::DATAMASK);
mfiore 1:f0efe8462d0e 134
falingtrea 0:b28a2dfe05fd 135 // __disable_irq(); // // Tickers and other timebase events can jack up the I2C bus for some devices
falingtrea 0:b28a2dfe05fd 136 result |= _i2c->write(_i2c_addr, buf, 1);
falingtrea 0:b28a2dfe05fd 137 // __enable_irq(); // Just need to block during the transaction
falingtrea 0:b28a2dfe05fd 138
mfiore 1:f0efe8462d0e 139 if(result != 0) {
falingtrea 0:b28a2dfe05fd 140 debug("NCP5623B:writeRegister failed\n\r");
falingtrea 0:b28a2dfe05fd 141 }
mfiore 1:f0efe8462d0e 142
falingtrea 0:b28a2dfe05fd 143 return result;
falingtrea 0:b28a2dfe05fd 144 }