dzd
TM1638.cpp
- Committer:
- wim
- Date:
- 2015-12-21
- Revision:
- 0:201dfacbe0e5
- Child:
- 1:1f2453ed85d7
File content as of revision 0:201dfacbe0e5:
/* mbed TM1638 Library, for TM1638 LED controller * Copyright (c) 2015, 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, including 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, INCLUDING 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 "TM1638.h" /** Constructor for class for driving TM1638 LED controller with SPI bus interface device. * @brief Supports 8 digits @ 10 segments. * Also supports a scanned keyboard of upto 24 keys. * * @param PinName mosi, miso, sclk, cs SPI bus pins */ TM1638::TM1638(PinName mosi, PinName miso, PinName sclk, PinName cs) : _spi(mosi,miso,sclk), _cs(cs) { _init(); } /** Init the SPI interface and the controller * @param none * @return none */ void TM1638::_init(){ //init SPI _cs=1; _spi.format(8,3); //TM1638 uses mode 3 (Clock High on Idle, Data latched on second (=rising) edge) _spi.frequency(500000); //init controller _display = TM1638_DSP_ON; _bright = TM1638_BRT_DEF; _writeCmd(TM1638_DSP_CTRL_CMD, _display | _bright ); // Display control cmd, display on/off, brightness _writeCmd(TM1638_DATA_SET_CMD, TM1638_DATA_WR | TM1638_ADDR_INC | TM1638_MODE_NORM); // Data set cmd, normal mode, auto incr, write data } /** Clear the screen and locate to 0 */ void TM1638::cls() { _cs=0; wait_us(1); _spi.write(_flip(TM1638_ADDR_SET_CMD | 0x00)); // Address set cmd, 0 for (int cnt=0; cnt<TM1638_DISPLAY_MEM; cnt++) { _spi.write(0x00); // data } wait_us(1); _cs=1; } /** Set Brightness * * @param char brightness (3 significant bits, valid range 0..7 (1/16 .. 14/14 dutycycle) * @return none */ void TM1638::setBrightness(char brightness){ _bright = brightness & TM1638_BRT_MSK; // mask invalid bits _writeCmd(TM1638_DSP_CTRL_CMD, _display | _bright ); // Display control cmd, display on/off, brightness } /** Set the Display mode On/off * * @param bool display mode */ void TM1638::setDisplay(bool on) { if (on) { _display = TM1638_DSP_ON; } else { _display = TM1638_DSP_OFF; } _writeCmd(TM1638_DSP_CTRL_CMD, _display | _bright ); // Display control cmd, display on/off, brightness } /** Write databyte to TM1638 * @param int address display memory location to write byte * @param char data byte written at given address * @return none */ void TM1638::writeData(int address, char data) { _cs=0; wait_us(1); _spi.write(_flip(TM1638_ADDR_SET_CMD | (address & TM1638_ADDR_MSK))); // Set Address cmd _spi.write(_flip(data)); // data wait_us(1); _cs=1; } /** Write Display datablock to TM1638 * @param DisplayData_t data Array of TM1638_DISPLAY_MEM (=16) bytes for displaydata (starting at address 0) * @param length number bytes to write (valide range 0..TM1638_DISPLAY_MEM (=16), starting at address 0) * @return none */ void TM1638::writeData(DisplayData_t data, int length) { _cs=0; wait_us(1); _spi.write(_flip(TM1638_ADDR_SET_CMD | 0x00)); // Set Address at 0 // sanity check if (length < 0) {length = 0;} if (length > TM1638_DISPLAY_MEM) {length = TM1638_DISPLAY_MEM;} // for (int idx=0; idx<TM1638_DISPLAY_MEM; idx++) { for (int idx=0; idx<length; idx++) { _spi.write(_flip(data[idx])); // data } wait_us(1); _cs=1; } /** Read keydata block from TM1638 * @param *keydata Ptr to Array of TM1638_KEY_MEM (=4) bytes for keydata * @return bool keypress True when at least one key was pressed * * Note: Due to the hardware configuration the TM1638 key matrix scanner will detect multiple keys pressed at same time, * but this may also result in some spurious keys being set in keypress data array. * It may be best to ignore all keys in those situations. That option is implemented in this method depending on #define setting. */ bool TM1638::getKeys(KeyData_t *keydata) { int keypress = 0; char data; // Read keys _cs=0; wait_us(1); // Enable Key Read mode _spi.write(_flip(TM1638_DATA_SET_CMD | TM1638_KEY_RD | TM1638_ADDR_INC | TM1638_MODE_NORM)); // Data set cmd, normal mode, auto incr, read data for (int idx=0; idx < TM1638_KEY_MEM; idx++) { data = _flip(_spi.write(0xFF)); // read keys and correct bitorder if (data != 0) { // Check for any pressed key for (int bit=0; bit < TM1638_KEY_BITS; bit++) { if (data & (1 << bit)) {keypress++;} // Test all significant bits } } (*keydata)[idx] = data; // Store keydata after correcting bitorder } wait_us(1); _cs=1; // Restore Data Write mode _writeCmd(TM1638_DATA_SET_CMD, TM1638_DATA_WR | TM1638_ADDR_INC | TM1638_MODE_NORM); // Data set cmd, normal mode, auto incr, write data #if(1) // Dismiss multiple keypresses at same time return (keypress == 1); #else // Allow multiple keypress and accept possible spurious keys return (keypress > 0); #endif } /** Helper to reverse all command or databits. The TM1638 expects LSB first, whereas SPI is MSB first * @param char data * @return bitreversed data */ char TM1638::_flip(char data) { char value=0; if (data & 0x01) {value |= 0x80;} ; if (data & 0x02) {value |= 0x40;} ; if (data & 0x04) {value |= 0x20;} ; if (data & 0x08) {value |= 0x10;} ; if (data & 0x10) {value |= 0x08;} ; if (data & 0x20) {value |= 0x04;} ; if (data & 0x40) {value |= 0x02;} ; if (data & 0x80) {value |= 0x01;} ; return value; } /** Write command and parameter to TM1638 * @param int cmd Command byte * &Param int data Parameters for command * @return none */ void TM1638::_writeCmd(int cmd, int data){ _cs=0; wait_us(1); // _spi.write(_flip( (cmd & 0xF0) | (data & 0x0F))); _spi.write(_flip( (cmd & TM1638_CMD_MSK) | (data & ~TM1638_CMD_MSK))); wait_us(1); _cs=1; } #if (LEDKEY8_TEST == 1) // Derived class for TM1638 used in LED&KEY display unit // /** Constructor for class for driving TM1638 LED controller as used in LEDKEY8 * * @brief Supports 8 Digits of 7 Segments + DP + LED Icons. Also supports a scanned keyboard of 8. * * @param PinName mosi, miso, sclk, cs SPI bus pins */ TM1638_LEDKEY8::TM1638_LEDKEY8(PinName mosi, PinName miso, PinName sclk, PinName cs) : TM1638(mosi, miso, sclk, cs) { _column = 0; _columns = LEDKEY8_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 TM1638_LEDKEY8::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 TM1638_LEDKEY8::columns() { return _columns; } /** Clear the screen and locate to 0 * @param bool clrAll Clear Icons also (default = false) */ void TM1638_LEDKEY8::cls(bool clrAll) { if (clrAll) { //clear local buffer (including Icons) for (int idx=0; idx < (LEDKEY8_NR_GRIDS << 1); idx++) { _displaybuffer[idx] = 0x00; } } else { //clear local buffer (preserving Icons) for (int idx=0; idx < LEDKEY8_NR_GRIDS; idx++) { _displaybuffer[(idx<<1)] = _displaybuffer[(idx<<1)] & MASK_ICON_GRID[idx][0]; _displaybuffer[(idx<<1) + 1] = _displaybuffer[(idx<<1) + 1] & MASK_ICON_GRID[idx][1]; } } writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); _column = 0; } /** Set Icon * * @param Icon icon Enums Icon has Grid position encoded in 8 MSBs, Icon pattern encoded in 24 LSBs * @return none */ void TM1638_LEDKEY8::setIcon(Icon icon) { int addr, icn; icn = icon & 0xFFFFFF; addr = (icon >> 24) & 0xFF; addr = (addr - 1) << 1; //Save char...and set bits for icon to write _displaybuffer[addr] = _displaybuffer[addr] | LO(icn); _displaybuffer[addr+1] = _displaybuffer[addr+1] | HI(icn); writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); } /** Clr Icon * * @param Icon icon Enums Icon has Grid position encoded in 8 MSBs, Icon pattern encoded in 24 LSBs * @return none */ void TM1638_LEDKEY8::clrIcon(Icon icon) { int addr, icn; icn = icon & 0xFFFFFF; addr = (icon >> 24) & 0xFF; addr = (addr - 1) << 1; //Save char...and clr bits for icon to write _displaybuffer[addr] = _displaybuffer[addr] & ~LO(icn); _displaybuffer[addr+1] = _displaybuffer[addr+1] & ~HI(icn); writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); } /** 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 TM1638_LEDKEY8::setUDC(unsigned char udc_idx, int udc_data) { //Sanity check if (udc_idx > (LEDKEY8_NR_UDC-1)) { return; } // Mask out Icon bits? _UDC_7S[udc_idx] = LO(udc_data); } #if(1) /** Write a single character (Stream implementation) */ int TM1638_LEDKEY8::_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 >= 0) && (value < LEDKEY8_NR_UDC)) { //Character to write validChar = true; pattern = _UDC_7S[value]; } 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 if (validChar) { //Character to write //Translate between _column and displaybuffer entries addr = _column << 1; //Save icons...and set bits for character to write _displaybuffer[addr] = (_displaybuffer[addr] & MASK_ICON_GRID[_column][0]) | pattern; // _displaybuffer[addr+1] = (_displaybuffer[addr+1] & MASK_ICON_GRID[_column][0]) | pattern; writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); //Update Cursor _column++; if (_column > (LEDKEY8_NR_DIGITS - 1)) { _column = 0; } } // if validChar return value; } #else /** Write a single character (Stream implementation) */ int TM1638_LEDKEY8::_putc(int value) { int addr; if ((value == '\n') || (value == '\r')) { //No character to write //Update Cursor _column = 0; } else if ((value >= 0) && (value < LEDKEY8_NR_UDC)) { //Character to write addr = (LEDKEY8_DIG1_IDX + ((LEDKEY8_NR_DIGITS - 1) - _column)) << 1; //Save icons...and set bits for character to write // _displaybuffer[addr] = (_displaybuffer[addr] & LO(S_ICON_MSK)) | _UDC_16S[value][0]; // _displaybuffer[addr+1] = (_displaybuffer[addr+1] & HI(S_ICON_MSK)) | _UDC_16S[value][1]; writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); //Update Cursor _column++; if (_column > (LEDKEY8_NR_DIGITS - 1)) { _column = 0; } } else if ((value >= (int)'0') && (value <= (int) '9')) { //Character to write value = value - (int) '0'; addr = (LEDKEY8_DIG1_IDX + ((LEDKEY8_NR_DIGITS - 1) - _column)) << 1; //Save icons...and set bits for character to write // _displaybuffer[addr] = (_displaybuffer[addr] & LO(S_ICON_MSK)) | FONT_7S[value][0]; // _displaybuffer[addr+1] = (_displaybuffer[addr+1] & HI(S_ICON_MSK)) | FONT_7S[value][1]; writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); //Update Cursor _column++; if (_column > (LEDKEY8_NR_DIGITS - 1)) { _column = 0; } } else if ((value >= (int) 'A') && (value <= (int) 'F')) { //Character to write value = 10 + value - (int) 'A'; addr = (LEDKEY8_DIG1_IDX + ((LEDKEY8_NR_DIGITS - 1) - _column)) << 1; //Save icons...and set bits for character to write // _displaybuffer[addr] = (_displaybuffer[addr] & LO(S_ICON_MSK)) | FONT_7S[value][0]; // _displaybuffer[addr+1] = (_displaybuffer[addr+1] & HI(S_ICON_MSK)) | FONT_7S[value][1]; writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); //Update Cursor _column++; if (_column > (LEDKEY8_NR_DIGITS - 1)) { _column = 0; } } else if ((value >= (int) 'a') && (value <= (int) 'f')) { //Character to write value = 10 + value - (int) 'a'; addr = (LEDKEY8_DIG1_IDX + ((LEDKEY8_NR_DIGITS - 1) - _column)) << 1; //Save icons...and set bits for character to write // _displaybuffer[addr] = (_displaybuffer[addr] & LO(S_ICON_MSK)) | FONT_7S[value][0]; // _displaybuffer[addr+1] = (_displaybuffer[addr+1] & HI(S_ICON_MSK)) | FONT_7S[value][1]; writeData(_displaybuffer, (LEDKEY8_NR_GRIDS*2)); //Update Cursor _column++; if (_column > (LEDKEY8_NR_DIGITS - 1)) { _column = 0; } } //else return value; } #endif // get a single character (Stream implementation) int TM1638_LEDKEY8::_getc() { return -1; } #endif