SBK_HT16K33.h

Go to the documentation of this file.

 
/**********************************************************************
 * This library is a modified version of the original HT16K33 Arduino driver
 * from MikeS11's ProtonPack repository:
 * https://github.com/MikeS11/ProtonPack/tree/master/Source/Libraries/ht16k33-arduino-master
 *
 * Modifications were made specifically to drive vertical bar meters for use in
 * SBK projects such as the Wrist Blaster.
 *
 * All credit for the original implementation goes to Mike S11.
 **********************************************************************/
 
#pragma once
 
#define SBK_HT16K33_IS_DEFINED
 
#include <Arduino.h>
#include <Wire.h>
 
// HT16K33 Command Definitions
#define HT16K33_CMD_RAM 0x00
#define HT16K33_CMD_KEYS 0x40
#define HT16K33_CMD_SETUP 0x80
#define HT16K33_CMD_ROWINT 0xA0
#define HT16K33_CMD_DIMMING 0xE0
 
#define HT16K33_DISPLAY_OFF 0x00
#define HT16K33_DISPLAY_ON 0x01
#define HT16K33_BLINK_OFF 0x00
#define HT16K33_BLINK_1HZ 0x02
#define HT16K33_BLINK_2HZ 0x04
#define HT16K33_BLINK_0HZ5 0x06

class SBK_HT16K33
{
public:
  SBK_HT16K33(uint8_t devsNum = 1);

  ~SBK_HT16K33();

  void setDriverRows(uint8_t devIdx, uint8_t rowsCount = 8)
  {
    if (devIdx >= 8 || (rowsCount != 8 && rowsCount != 12 && rowsCount != 16))
      return;
 
    _maxRows[devIdx] = rowsCount;
  }

  uint8_t maxRows(uint8_t devIdx) const { return _maxRows[devIdx]; }

  uint8_t maxColumns() const { return _defaultColBufferSize; }

  uint8_t maxSegments(uint8_t devIdx) const { return maxRows(devIdx) * maxColumns(); }

  uint8_t setAddress(uint8_t devIdx, uint8_t addr);

  void begin();

  void clear(uint8_t devIdx);

  void clear();

  void setBrightness(uint8_t devIdx, uint8_t brightness);

  void setBrightness(uint8_t brightness);

  uint8_t devsNum() const { return _devsNum; }

  void setLed(uint8_t devIdx, uint8_t rowIdx, uint8_t colIdx, bool state); 

  bool getLed(uint8_t devIdx, uint8_t rowIdx, uint8_t colIdx) const; 

  void show(uint8_t devIdx); 

  void show();
 
private:
  uint8_t _devsNum = 1;
  uint8_t _i2c_addr[8];
  uint8_t _maxRows[8];
  uint16_t *_buffer;                                  
  static constexpr uint8_t _defaultRowBufferSize = 8; // HT16K33 comes in 3 versions 20SOP, 24SOP and 28SOP: 8, 12 or 16 rows (anodes)
  static constexpr uint8_t _defaultColBufferSize = 8;
 
  void _write(uint8_t devIdx); 
  inline uint8_t _colIndex(uint8_t devIdx, uint8_t colIdx) const;
};