ErriezLKM1638Board.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 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_LKM1638_BOARD_H_
#define ERRIEZ_LKM1638_BOARD_H_

#include <Arduino.h>

#include <ErriezTM1638.h>

#define NUM_COLOR_LEDS    8 
#define NUM_DIGITS        8 

#define SEGMENTS_OFF      0b00000000 
#define SEGMENTS_MINUS    0b01000000 
#define SEGMENTS_DEGREE   0b01100011 
#define SEGMENTS_C        0b00111001 

#if (NUM_COLOR_LEDS > 8)
#error "Too many LED's. This won't fit in a 8-bit variable"
#endif

typedef enum {
    LedOff = 0,
    LedRed = 1,
    LedGreen = 2
} LedColor;


class LKM1638Board : public TM1638
{
public:
    // Constructor with 3 pins
    LKM1638Board(uint8_t clkPin, uint8_t dioPin, uint8_t stbPin);

    // Get buttons
    uint8_t getButtons();

    // Turn all LED's off
    void clear();

    // Set dual color LED's
    void setColorLED(uint8_t led, LedColor color);
    void colorLEDsOn(uint8_t leds, LedColor color);
    void colorLEDsOff(uint8_t leds);

    // Refresh 7-segment display
    void refresh();

    // Control 7-segment dots
    void dotOn(uint8_t pos);
    void dotOff(uint8_t pos);
    void setDots(uint8_t dots);

    // Set/get position for print functions
    void setPrintPos(uint8_t pos);
    uint8_t getPrintPos();

    // Write
    void setSegmentsDigit(uint8_t pos, uint8_t leds);
    void setDigit(uint8_t pos, uint8_t digit);

    // Notes:  Overloaded functions with default arguments are not allowed, so
    // create multiple functions with different number of arguments.

    // Display unsigned value 8, 16 or 32-bit with optional padding
    void print(uint8_t value);
    void print(uint8_t value, uint8_t radius);
    void print(uint8_t value, uint8_t radius, uint8_t maxDigits);
    void print(uint8_t value, uint8_t radius, uint8_t maxDigits, uint8_t pad);

    void print(uint16_t value);
    void print(uint16_t value, uint8_t radius);
    void print(uint16_t value, uint8_t radius, uint8_t maxDigits);
    void print(uint16_t value, uint8_t radius, uint8_t maxDigits, uint8_t pad);

    void print(unsigned long value);
    void print(unsigned long value, uint8_t radius);
    void print(unsigned long value, uint8_t radius, uint8_t maxDigits);
    void print(unsigned long value, uint8_t radius, uint8_t maxDigits, uint8_t pad);

    // Display signed value 8, 16 or 32-bit
    void print(int8_t value);
    void print(int8_t value, uint8_t radius);
    void print(int8_t value, uint8_t radius, uint8_t maxDigits);

    void print(int16_t value);
    void print(int16_t value, uint8_t radius);
    void print(int16_t value, uint8_t radius, uint8_t maxDigits);

    void print(long value);
    void print(long value, uint8_t radius);
    void print(long value, uint8_t radius, uint8_t maxDigits);

protected:
    uint8_t _leds[NUM_DIGITS];  
    uint8_t _pos;               
    uint8_t _dots;              

    void writeDigit(uint8_t pos);
    void writeUnsignedValue(uint32_t value, uint8_t radius, uint8_t maxDigits,
                                    uint8_t pad);
    void writeSignedValue(int32_t value, uint8_t radius, uint8_t maxDigits);
    uint8_t getNumDigits(uint32_t value, uint8_t radius);
    void displayOverflow(uint8_t numDigits);

    // Swap bits and bytes
    uint8_t swapBits(uint8_t data);
    uint8_t swapPos(uint8_t pos);
    uint8_t swapLeds(uint8_t led);
};

#endif // ERRIEZ_LKM1638_BOARD_H_