Library for TM1640 LED controller Initial version
See here for more information.
Diff: TM1640.cpp
- Revision:
- 0:7e120ffa56d3
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/TM1640.cpp Thu Jan 28 19:25:49 2016 +0000 @@ -0,0 +1,436 @@ +/* mbed TM1640 Library, for TM1640 LED controller + * Copyright (c) 2016, v01: WH, Initial version + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, inclumosig without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUmosiG BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +#include "mbed.h" +#include "TM1640.h" + +/** Constructor for class for driving TM1640 LED controller with Serial bus interface device. + * @brief Supports 16 digits @ 8 segments. + * + * @param PinName mosi Serial bus MOSI pin + * @param PinName sclk Serial bus SCLK pin +*/ +TM1640::TM1640(PinName mosi, PinName sclk) : _mosi(mosi), _sclk(sclk) { + + _init(); +} + +/** Init the SPI interface and the controller + * @param none + * @return none + */ +void TM1640::_init(){ + +//TM1640 uses Serial bus that looks like SPI, but uses Start and Stop conditions like I2C instead of CS +//init Serial bus + _mosi=1; + _sclk=1; + +//init controller + _display = TM1640_DSP_ON; + _bright = TM1640_BRT_DEF; + _writeCmd(TM1640_DSP_CTRL_CMD, _display | _bright ); // Display control cmd, display on/off, brightness + + _writeCmd(TM1640_DATA_SET_CMD, TM1640_DATA_WR | TM1640_ADDR_INC | TM1640_MODE_NORM); // Data set cmd, normal mode, auto incr, write data +} + + +/** Clear the screen and locate to 0 + */ +void TM1640::cls() { + + _start(); + + _write(TM1640_ADDR_SET_CMD | 0x00); // Address set cmd, 0 + for (int cnt=0; cnt<TM1640_DISPLAY_MEM; cnt++) { + _write(0x00); // data + } + + _stop(); +} + +/** Set Brightness + * + * @param char brightness (3 significant bits, valid range 0..7 (1/16 .. 14/14 dutycycle) + * @return none + */ +void TM1640::setBrightness(char brightness){ + + _bright = brightness & TM1640_BRT_MSK; // mask invalid bits + + _writeCmd(TM1640_DSP_CTRL_CMD, _display | _bright ); // Display control cmd, display on/off, brightness +} + +/** Set the Display mode On/off + * + * @param bool display mode + */ +void TM1640::setDisplay(bool on) { + + if (on) { + _display = TM1640_DSP_ON; + } + else { + _display = TM1640_DSP_OFF; + } + + _writeCmd(TM1640_DSP_CTRL_CMD, _display | _bright ); // Display control cmd, display on/off, brightness +} + +/** Write databyte to TM1640 + * @param int address display memory location to write byte + * @param char data byte written at given address + * @return none + */ +void TM1640::writeData(char data, int address) { + + _start(); + + _write(TM1640_ADDR_SET_CMD | (address & TM1640_ADDR_MSK)); // Set Address cmd + _write(data); // data + + _stop(); +} + +/** Write Display datablock to TM1640 + * @param DisplayData_t data Array of TM1640_DISPLAY_MEM (=16) bytes for displaydata + * @param length number bytes to write (valid range 0..(TM1640_MAX_NR_GRIDS * TM1640_BYTES_PER_GRID) (=16), when starting at address 0) + * @param int address display memory location to write bytes (default = 0) + * @return none + */ +void TM1640::writeData(DisplayData_t data, int length, int address) { + + _start(); + +// sanity check + address &= TM1640_ADDR_MSK; + if (length < 0) {length = 0;} + if ((length + address) > TM1640_DISPLAY_MEM) {length = (TM1640_DISPLAY_MEM - address);} + +// _write(TM1640_ADDR_SET_CMD | 0x00); // Set Address at 0 + _write(TM1640_ADDR_SET_CMD | address); // Set Address + + for (int idx=0; idx<length; idx++) { +// _write(data[idx]); // data + _write(data[address + idx]); // data + } + + _stop(); +} + + +/** Generate Start condition for TM1640 + * @param none + * @return none + */ +void TM1640::_start() { + + _mosi=0; + wait_us(1); + _sclk=0; + wait_us(1); +} + +/** Generate Stop condition for TM1640 + * @param none + * @return none + */ +void TM1640::_stop() { + + _mosi=0; + wait_us(1); + _sclk=1; + wait_us(1); + _mosi=1; + wait_us(1); +} + +/** Send byte to TM1640 + * @param int data + * @return none + */ +void TM1640::_write(int data) { + + for (int bit=0; bit<8; bit++) { + //The TM1640 expects LSB first, whereas SPI is MSB first + if (((data >> bit) & 0x01) == 0x01) { + _mosi=1; + } + else { + _mosi=0; + } + wait_us(1); + _sclk=1; + wait_us(1); + _sclk=0; + wait_us(1); + } +} + + +/** Write command and parameter to TM1640 + * @param int cmd Command byte + * &Param int data Parameters for command + * @return none + */ +void TM1640::_writeCmd(int cmd, int data){ + + _start(); + + _write((cmd & TM1640_CMD_MSK) | (data & ~TM1640_CMD_MSK)); + + _stop(); +} + + +#if (LM1640_TEST == 1) +// Derived class for TM1640 used in LED&KEY display unit +// + +/** Constructor for class for driving TM1640 LED controller as used in LM1640 + * + * @brief Supports 8 Digits of 7 Segments + DP. + * + * @param PinName mosi Serial bus MOSI pin + * @param PinName sclk Serial bus SCLK pin + */ +TM1640_LM1640::TM1640_LM1640(PinName mosi, PinName sclk) : TM1640(mosi, sclk) { + _column = 0; + _columns = LM1640_NR_DIGITS; +} + +#if(0) +#if DOXYGEN_ONLY + /** Write a character to the Display + * + * @param c The character to write to the display + */ + int putc(int c); + + /** Write a formatted string to the Display + * + * @param format A printf-style format string, followed by the + * variables to use in formatting the string. + */ + int printf(const char* format, ...); +#endif +#endif + +/** Locate cursor to a screen column + * + * @param column The horizontal position from the left, indexed from 0 + */ +void TM1640_LM1640::locate(int column) { + //sanity check + if (column < 0) {column = 0;} + if (column > (_columns - 1)) {column = _columns - 1;} + + _column = column; +} + + +/** Number of screen columns + * + * @param none + * @return columns + */ +int TM1640_LM1640::columns() { + return _columns; +} + + +/** Clear the screen and locate to 0 + * @param bool clrAll Clear Icons also (default = false) + */ +void TM1640_LM1640::cls(bool clrAll) { + + if (clrAll) { + //clear local buffer (inclumosig Icons) + for (int idx=0; idx < LM1640_NR_GRIDS; idx++) { + _displaybuffer[idx] = 0x00; + } + } + else { + //clear local buffer (preserving Icons) + for (int idx=0; idx < LM1640_NR_GRIDS; idx++) { + _displaybuffer[idx] = _displaybuffer[idx] & MASK_ICON_GRID[idx]; + } + } + + writeData(_displaybuffer, (LM1640_NR_GRIDS * TM1640_BYTES_PER_GRID)); + + _column = 0; +} + +/** Set Icon + * + * @param Icon icon Enums Icon has Grid position encoded in 8 MSBs, Icon pattern encoded in 16 LSBs + * @return none + */ +void TM1640_LM1640::setIcon(Icon icon) { + int addr, icn; + + icn = icon & 0xFFFF; + addr = (icon >> 24) & 0xFF; + addr = (addr - 1); + + //Save char...and set bits for icon to write + _displaybuffer[addr] = _displaybuffer[addr] | LO(icn); +// writeData(_displaybuffer, (LM1640_NR_GRIDS * TM1640_BYTES_PER_GRID)); + writeData(_displaybuffer, TM1640_BYTES_PER_GRID, addr); +} + +/** Clr Icon + * + * @param Icon icon Enums Icon has Grid position encoded in 8 MSBs, Icon pattern encoded in 16 LSBs + * @return none + */ +void TM1640_LM1640::clrIcon(Icon icon) { + int addr, icn; + + icn = icon & 0xFFFF; + addr = (icon >> 24) & 0xFF; + addr = (addr - 1); + + //Save char...and clr bits for icon to write + _displaybuffer[addr] = _displaybuffer[addr] & ~LO(icn); +// writeData(_displaybuffer, (LM1640_NR_GRIDS * TM1640_BYTES_PER_GRID)); + writeData(_displaybuffer, TM1640_BYTES_PER_GRID, addr); +} + + +/** Set User Defined Characters (UDC) + * + * @param unsigned char udc_idx The Index of the UDC (0..7) + * @param int udc_data The bitpattern for the UDC (8 bits) + */ +void TM1640_LM1640::setUDC(unsigned char udc_idx, int udc_data) { + + //Sanity check + if (udc_idx > (LM1640_NR_UDC-1)) { + return; + } + // Mask out Icon bits? + + _UDC_7S[udc_idx] = LO(udc_data); +} + + +/** Write a single character (Stream implementation) + */ +int TM1640_LM1640::_putc(int value) { + int addr; + bool validChar = false; + char pattern = 0x00; + + if ((value == '\n') || (value == '\r')) { + //No character to write + validChar = false; + + //Update Cursor + _column = 0; + } + else if ((value == '.') || (value == ',')) { + //No character to write + validChar = false; + pattern = S7_DP; // placeholder for all DPs + + // Check to see that DP can be shown for current column + if (_column > 0) { + //Translate between _column and displaybuffer entries + //Add DP to bitpattern of digit left of current column. + addr = (_column - 1); + + //Save icons...and set bits for decimal point to write + _displaybuffer[addr] = _displaybuffer[addr] | pattern; +// writeData(_displaybuffer, (LM1640_NR_GRIDS * TM1640_BYTES_PER_GRID)); + writeData(_displaybuffer, TM1640_BYTES_PER_GRID, addr); + + //No Cursor Update + } + } + else if ((value >= 0) && (value < LM1640_NR_UDC)) { + //Character to write + validChar = true; + pattern = _UDC_7S[value]; + } + +#if (SHOW_ASCII == 1) + //display all ASCII characters + else if ((value >= FONT_7S_START) && (value <= FONT_7S_END)) { + //Character to write + validChar = true; + pattern = FONT_7S[value - FONT_7S_START]; + } // else +#else + //display only digits and hex characters + else if (value == '-') { + //Character to write + validChar = true; + pattern = C7_MIN; + } + else if ((value >= (int)'0') && (value <= (int) '9')) { + //Character to write + validChar = true; + pattern = FONT_7S[value - (int) '0']; + } + else if ((value >= (int) 'A') && (value <= (int) 'F')) { + //Character to write + validChar = true; + pattern = FONT_7S[10 + value - (int) 'A']; + } + else if ((value >= (int) 'a') && (value <= (int) 'f')) { + //Character to write + validChar = true; + pattern = FONT_7S[10 + value - (int) 'a']; + } //else +#endif + + if (validChar) { + //Character to write + + //Translate between _column and displaybuffer entries + addr = _column; + + //Save icons...and set bits for character to write + _displaybuffer[addr] = (_displaybuffer[addr] & MASK_ICON_GRID[_column]) | pattern; + +// writeData(_displaybuffer, (LM1640_NR_GRIDS * TM1640_BYTES_PER_GRID)); + writeData(_displaybuffer, TM1640_BYTES_PER_GRID, addr); + + //Update Cursor + _column++; + if (_column > (LM1640_NR_DIGITS - 1)) { + _column = 0; + } + + } // if validChar + + return value; +} + + +// get a single character (Stream implementation) +int TM1640_LM1640::_getc() { + return -1; +} + +#endif