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@5:c8b00cf49c70, 2018-01-31 (annotated)

Committer:
Evan Hosseini
Date:
Wed Jan 31 10:15:23 2018 -0600
Revision:
5:c8b00cf49c70
Parent:
4:ae3ff403404a 
Remove explicit i2c frequency configuration, should be done by object owner

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