LedMatrixDualHc595.h

/*
MIT License
 
Copyright (c) 2018 Brian T. Park
 
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 ACE_SEGMENT_LED_MATRIX_DUAL_HC595_H
#define ACE_SEGMENT_LED_MATRIX_DUAL_HC595_H
 
#include "LedMatrixBase.h"
 
class LedMatrixDualHc595Test_draw;
class LedMatrixDualHc595Test_enableGroup;
class LedMatrixDualHc595Test_disableGroup;
 
namespace ace_segment {
 
const uint8_t kByteOrderGroupHighElementLow = 0;
 
const uint8_t kByteOrderElementHighGroupLow = 1;
 
template <typename T_SPII>
class LedMatrixDualHc595: public LedMatrixBase {
  public:
    LedMatrixDualHc595(
        const T_SPII& spiInterface,
        uint8_t elementOnPattern,
        uint8_t groupOnPattern,
        uint8_t byteOrder,
        const uint8_t* remapArrayInverted = nullptr
    ) :
        LedMatrixBase(elementOnPattern, groupOnPattern),
        mSpiInterface(spiInterface),
        mRemapArrayInverted(remapArrayInverted),
        mByteOrder(byteOrder)
    {}
 
    void begin() const {}
 
    void end() const {}
 
    void draw(uint8_t group, uint8_t elementPattern) const {
      // Find the logical address which will cause this pattern to appear in
      // the correct physical position.
      uint8_t logicalGroup = remapPhysicalToLogical(group);
      uint8_t groupPattern = 0x1 << logicalGroup;
 
      drawPatterns(groupPattern, elementPattern);
      mPrevElementPattern = elementPattern;
    }
 
    void enableGroup(uint8_t group) const {
      draw(group, mPrevElementPattern);
    }
 
    void disableGroup(uint8_t group) const {
      (void) group;
      drawPatterns(0x00, 0x00);
      // Don't update mPrevElementPattern.
    }
 
    void clear() const {
      drawPatterns(0x00, 0x00);
      mPrevElementPattern = 0x00;
    }
 
  private:
    void drawPatterns(uint8_t groupPattern, uint8_t elementPattern) const {
      uint8_t actualGroupPattern = (groupPattern ^ mGroupXorMask);
      uint8_t actualElementPattern = (elementPattern ^ mElementXorMask);
      uint16_t data = (mByteOrder == kByteOrderGroupHighElementLow)
          ? actualGroupPattern << 8 | actualElementPattern
          : actualElementPattern << 8 | actualGroupPattern;
      mSpiInterface.send16(data);
    }
 
    uint8_t remapPhysicalToLogical(uint8_t pos) const {
      return mRemapArrayInverted ? mRemapArrayInverted[pos] : pos;
    }
 
  private:
    friend class ::LedMatrixDualHc595Test_draw;
    friend class ::LedMatrixDualHc595Test_enableGroup;
    friend class ::LedMatrixDualHc595Test_disableGroup;
 
    const T_SPII mSpiInterface;
 
    const uint8_t* const mRemapArrayInverted;
 
    const uint8_t mByteOrder;
 
    mutable uint8_t mPrevElementPattern;
};
 
}
 
#endif