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/XPointDriver.h"
#include <stdint.h>
#include <string.h>
 
enum RelayType
{
    RE_NON_LATCHING = 0,  
    RE_LATCHING_DUAL_COIL 
};
 
struct PulseEvent
{
    uint8_t r;        
    uint8_t c;        
    unsigned long 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, bool *state, bool *ilock, bool *excl, RelayType type = RE_NON_LATCHING,
           uint16_t pdur = 0);
 
    ~XPoint();
 
    XPoint(const XPoint &) = delete;
    XPoint &operator=(const XPoint &) = delete;
 
    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; 
    bool _owns;         
 
    bool *_state; 
    bool *_ilock; 
    bool *_excl;  
 
    static const uint8_t MAX_PULSES = 8; 
    PulseEvent _pulses[MAX_PULSES];      
 
    void _init();
};
 
template <uint8_t ROWS, uint8_t COLS> class XPointStatic : public XPoint
{
    bool _stateBuf[ROWS * COLS]; 
    bool _ilockBuf[ROWS * ROWS]; 
    bool _exclBuf[COLS];         
 
  public:
    XPointStatic(RelayType type = RE_NON_LATCHING, uint16_t pdur = 0)
        : XPoint(ROWS, COLS, _stateBuf, _ilockBuf, _exclBuf, type, pdur)
    {
    }
};
 
#endif // XPOINT_H