ErriezTM1638.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2018-2020 Erriez
 *
 * 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.
 */

#ifndef ERRIEZ_TM1638_H_
#define ERRIEZ_TM1638_H_

#include <Arduino.h>

// Commands
#define TM1638_CMD_DATA                 0x40 
#define TM1638_CMD_CTRL                 0x80 
#define TM1638_CMD_ADDR                 0xc0 

// Data command bits
#define TM1638_DATA_WRITE               0x00 
#define TM1638_DATA_READ_KEYS           0x02 
#define TM1638_DATA_AUTO_INC_ADDR       0x00 
#define TM1638_DATA_FIXED_ADDR          0x04 

// Control command bits
#define TM1638_CTRL_PULSE_1_16          0x00 
#define TM1638_CTRL_PULSE_2_16          0x01 
#define TM1638_CTRL_PULSE_4_16          0x02 
#define TM1638_CTRL_PULSE_10_16         0x03 
#define TM1638_CTRL_PULSE_11_16         0x04 
#define TM1638_CTRL_PULSE_12_16         0x05 
#define TM1638_CTRL_PULSE_13_16         0x06 
#define TM1638_CTRL_PULSE_14_16         0x07 
#define TM1638_CTRL_DISPLAY_OFF         0x00 
#define TM1638_CTRL_DISPLAY_ON          0x08 

#define TM1638_NUM_GRIDS                16   

#ifdef __AVR
#define TM1638_CLK_LOW()        { *portOutputRegister(_clkPort) &= ~_clkBit; }  
#define TM1638_CLK_HIGH()       { *portOutputRegister(_clkPort) |= _clkBit; }   
#define TM1638_CLK_INPUT()      { *portModeRegister(_clkPort) &= ~_clkBit; }    
#define TM1638_CLK_OUTPUT()     { *portModeRegister(_clkPort) |= _clkBit; }     

#define TM1638_DIO_LOW()        { *portOutputRegister(_dioPort) &= ~_dioBit; }  
#define TM1638_DIO_HIGH()       { *portOutputRegister(_dioPort) |= _dioBit; }   
#define TM1638_DIO_INPUT()      { *portModeRegister(_dioPort) &= ~_dioBit; }    
#define TM1638_DIO_OUTPUT()     { *portModeRegister(_dioPort) |= _dioBit; }     
#define TM1638_DIO_READ()       ( *portInputRegister(_dioPort) & _dioBit )      

#define TM1638_STB_LOW()        { *portOutputRegister(_stbPort) &= ~_stbBit; }  
#define TM1638_STB_HIGH()       { *portOutputRegister(_stbPort) |= _stbBit; }   
#define TM1638_STB_INPUT()      { *portModeRegister(_stbPort) &= ~_stbBit; }    
#define TM1638_STB_OUTPUT()     { *portModeRegister(_stbPort) |= _stbBit; }     
#else
#define TM1638_CLK_LOW()        { digitalWrite(_clkPin, LOW); }     
#define TM1638_CLK_HIGH()       { digitalWrite(_clkPin, HIGH); }    
#define TM1638_CLK_INPUT()      { pinMode(_clkPin, INPUT); }        
#define TM1638_CLK_OUTPUT()     { pinMode(_clkPin, OUTPUT); }       

#define TM1638_DIO_LOW()        { digitalWrite(_dioPin, LOW); }     
#define TM1638_DIO_HIGH()       { digitalWrite(_dioPin, HIGH); }    
#define TM1638_DIO_INPUT()      { pinMode(_dioPin, INPUT); }        
#define TM1638_DIO_OUTPUT()     { pinMode(_dioPin, OUTPUT); }       
#define TM1638_DIO_READ()       ( digitalRead(_dioPin) )            

#define TM1638_STB_LOW()        { digitalWrite(_stbPin, LOW); }     
#define TM1638_STB_HIGH()       { digitalWrite(_stbPin, HIGH); }    
#define TM1638_STB_INPUT()      { pinMode(_stbPin, INPUT); }        
#define TM1638_STB_OUTPUT()     { pinMode(_stbPin, OUTPUT); }       
#endif

// Delay defines
#if F_CPU >= 20000000UL
#define TM1638_PIN_DELAY()      { delayMicroseconds(1); }           
#else
#define TM1638_PIN_DELAY()                                          
#endif

class TM1638
{
public:
    TM1638(uint8_t clkPin, uint8_t dioPin, uint8_t stbPin,
           bool displayOn=true, uint8_t brightness=5);

    virtual void begin();
    virtual void end();
    virtual void displayOn();
    virtual void displayOff();
    virtual void setBrightness(uint8_t brightness);
    virtual void clear();
    virtual void writeData(uint8_t address, uint8_t data);
    virtual void writeData(uint8_t address, const uint8_t *buf, uint8_t len);
    virtual uint32_t getKeys();

protected:
#ifdef __AVR
    uint8_t _clkPort;   
    uint8_t _dioPort;   
    uint8_t _stbPort;   

    uint8_t _clkBit;    
    uint8_t _dioBit;    
    uint8_t _stbBit;    
#else
    uint8_t _clkPin;    
    uint8_t _dioPin;    
    uint8_t _stbPin;    
#endif

    bool    _displayOn;  
    uint8_t _brightness; 

    virtual void writeDisplayControl();
    virtual void writeCommand(uint8_t cmd);
    virtual void writeByte(uint8_t data);
    virtual uint8_t readByte();
};

#endif // ERRIEZ_TM1638_H_