SBK_MAX72xxHard.h

Go to the documentation of this file.

 
/*
 *  Adapted from the original Ledcontrol.h library by Eberhard Fahle:
 *  <https://github.com/wayoda/LedControl>
 *
 *  Original library:
 *  LEdControl.h - A library for controlling LEDs with a MAX7219/MAX7221
 *  Copyright (c) 2007 Eberhard Fahle
 *
 *  All credit for the original library goes to Eberhard Fahle.
 */
 
#pragma once
 
#define SBK_MAX72xx_IS_DEFINED
 
#include <Arduino.h>
#include <SPI.h>

class SBK_MAX72xxHard
{
public:
    SBK_MAX72xxHard(uint8_t csPin, uint8_t devsNum = 1);

    void setSPIClock(uint32_t frequency);

    void end();
 
    ~SBK_MAX72xxHard(); // Destructor

    uint8_t maxRows(uint8_t devIdx = 0) const
    {
        (void)devIdx;
        return _defaultRowBufferSize;
    }

    uint8_t maxColumns() const { return _defaultColBufferSize; }

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

    void begin();

    void setShutdown(uint8_t devIdx, bool status);

    void setScanLimit(uint8_t devIdx, uint8_t limit);

    void setBrightness(uint8_t devIdx, uint8_t brightness);

    uint8_t devsNum() const { return _devsNum; }

    void clear(uint8_t devIdx);

    void clear();

    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 setCol(uint8_t devIdx, uint8_t colIdx, uint8_t value);

    void show();

    void show(uint8_t devIdx);
 
private:
    void _spiTransfer(uint8_t targetDevice, uint8_t opcode, uint8_t data);
    void _writeColToAllDevices(uint8_t targetDevice, uint8_t colIdx, uint8_t data);
    inline uint8_t _bitMaskRow(uint8_t devIdx, uint8_t rowIdx) const;
    inline uint8_t _colIndex(uint8_t devIdx, uint8_t colIdx) const;
 
    const uint8_t _dataPin;
    const uint8_t _clkPin;
    const uint8_t _csPin;
    const uint8_t _devsNum = 1;
 
    static constexpr uint8_t _defaultRowBufferSize = 8;
    static constexpr uint8_t _defaultColBufferSize = 8;
    uint8_t *_buffer; // Internal display buffer
    bool *_update;    // Array to track if data has changed per device
 
    uint32_t _spiClock = 1000000; // Default 1 MHz
};