XPoint.h

Go to the documentation of this file.

// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (c) 2026 Douglas Quigg (dstroy0) <dquigg123@gmail.com>
// https://github.com/dstroy0/XPoint
 
#ifndef XPOINT_H
#define XPOINT_H
 
#include "drivers/BitPool.h"
#include "drivers/XPointDriver.h"
#include <stdint.h>
 
enum RelayType
{
    RE_NON_LATCHING = 0,  
    RE_LATCHING_DUAL_COIL 
};
 
struct XPOINT_PACKED PulseEvent
{
    uint8_t r;   
    uint8_t c;   
    uint32_t t0; 
    bool on;     
};
 
class XPoint
{
  public:
    XPoint(uint8_t rows, uint8_t cols, RelayType type = RE_NON_LATCHING, uint16_t pdur = 0);
 
    XPoint(uint8_t rows, uint8_t cols, uint32_t *pool, RelayType type = RE_NON_LATCHING, uint16_t pdur = 0);
 
    ~XPoint();
 
    XPoint(const XPoint &) = delete;
    XPoint &operator=(const XPoint &) = delete;
 
    static uint16_t poolWords(uint8_t rows, uint8_t cols)
    {
        return BitPool::wordsFor((uint32_t)rows * cols + (uint32_t)rows * rows + cols);
    }
 
    void setDriver(XPointDriver *drv);
 
    void begin();
 
    bool connect(uint8_t row, uint8_t col);
 
    bool disconnect(uint8_t row, uint8_t col);
 
    bool setLevel(uint8_t row, uint8_t col, uint16_t level);
 
    void clearAll();
 
    void lockRows(uint8_t rowA, uint8_t rowB);
 
    void exclusiveInput(uint8_t col);
 
    void update();
 
  private:
    uint8_t _rows;
    uint8_t _cols;
    RelayType _type;
    uint16_t _pdur;
    XPointDriver *_drv;
    BitPool _pool; 
 
    static const uint8_t MAX_PULSES = 8;
    PulseEvent _pulses[MAX_PULSES];
 
    /* Section offsets — computed from _rows/_cols, never stored. */
    uint32_t _ilockOff() const
    {
        return (uint32_t)_rows * _cols;
    }
    uint32_t _exclOff() const
    {
        return (uint32_t)_rows * _cols + (uint32_t)_rows * _rows;
    }
 
    void _init();
    bool _pulsePending(uint8_t row, uint8_t col) const;
};
 
template <uint8_t ROWS, uint8_t COLS> class XPointStatic : public XPoint
{
    static const uint16_t WORDS = (uint16_t)(((uint32_t)ROWS * COLS + (uint32_t)ROWS * ROWS + COLS + 31u) / 32u);
 
    uint32_t _buf[WORDS > 0u ? WORDS : 1u];
 
  public:
    XPointStatic(RelayType type = RE_NON_LATCHING, uint16_t pdur = 0) : XPoint(ROWS, COLS, _buf, type, pdur)
    {
    }
};
 
#endif // XPOINT_H