ShiftRegGPIOXpander_ESP32.h

Go to the documentation of this file.

#ifndef _SHIFTREGGPIOXPANDER_ESP32_H_
#define _SHIFTREGGPIOXPANDER_ESP32_H_
 
#include <Arduino.h>
#include <stdint.h>
 
class SRGXVPort;

class ShiftRegGPIOXpander{
 
private:
   uint8_t _ds{};
   uint8_t _sh_cp{};
   uint8_t _st_cp{};

   bool _copyMainToAux(const bool &overWriteIfExists = true);
   void _discardAux();
   bool _moveAuxToMain();
   bool _sendAllSRCntnt();
   bool _sendSnglSRCntnt(const uint8_t &data); 
 
protected:
   SemaphoreHandle_t _SRGXAuxBffrMtx; // Mutex to protect the Auxiliary Buffer from concurrent access
   SemaphoreHandle_t _SRGXMnBffrMtx; // Mutex to protect the Main Buffer from concurrent access
 
   uint8_t* _mainBuffrArryPtr{};
   uint8_t* _auxBuffrArryPtr{nullptr};
   uint8_t _maxSRGXPin{};
   uint8_t _srQty{};
 
public:
   ShiftRegGPIOXpander();
   ShiftRegGPIOXpander(uint8_t ds, uint8_t sh_cp, uint8_t st_cp, uint8_t srQty = 1);
   ~ShiftRegGPIOXpander();
   bool begin(uint8_t* initCntnt = nullptr);   
   bool copyMainToAux(const bool &overWriteIfExists = true);
   SRGXVPort createSRGXVPort(const uint8_t &strtPin, const uint8_t &pinsQty);
   bool digitalReadSgmntSr(const uint8_t &strtPin, const uint8_t &pinsQty, uint16_t &bffrSgmnt);   
   uint8_t digitalReadSr(const uint8_t &srPin);   
   bool digitalToggleSr(const uint8_t &srPin);
   bool digitalToggleSrAll();
   bool digitalToggleSrMask(uint8_t* toggleMask);
   bool digitalToggleSrToAux(const uint8_t &srPin); 
   bool digitalWriteSr(const uint8_t &srPin, const uint8_t &value);
   bool digitalWriteSrAllReset();
   bool digitalWriteSrAllSet();
   bool digitalWriteSrMaskReset(uint8_t* resetMask);
   bool digitalWriteSrMaskSet(uint8_t* setMask);  
   bool digitalWriteSrToAux(const uint8_t srPin, const uint8_t value);
   bool discardAux();
   void end();
   bool flipBit(const uint8_t &srPin);
   uint8_t* getMainBuffPtr();
   uint8_t getMaxSRGXPin();
   uint8_t getSrQty();
   bool isValid(SRGXVPort &VPort);
   bool moveAuxToMain();
   bool resetBit(const uint8_t &srPin);
   bool setBit(const uint8_t &srPin);
   bool stampMaskOverMain(uint8_t* maskPtr, uint8_t* valsPtr);
   bool stampOverMain(uint8_t* newCntntPtr);
   bool stampSgmntOverMain(uint8_t* newSgmntPtr, const uint8_t &strtPin, const uint8_t &pinsQty);
};
 
//==========================================================>>

class SRGXVPort: public ShiftRegGPIOXpander{
   /*Allows the ShiftRegGPIOXpander class to access the private members of the SRGXVPort
   class. In this case the ShiftRegGPIOXpander class will be able instantiate SRGXVPort
   objects, as the SRGXVPort class constructor is protected to avoid instantiation by 
   the user but through the use the ShiftRegGPIOXpander::createSRGXVPort 
   (uint8_t&, uint8_t&) method to create a SRGXVPort object.*/
   friend class ShiftRegGPIOXpander;
   /*_maxPortPinsQty: Maximum number of pins that can be used in a virtual port, the 
   maximum number of pins that can be used in a virtual port is defined as 16, library
   developers choice.*/
   const static uint8_t _maxPortPinsQty{16}; 
 
private:
   ShiftRegGPIOXpander* _SRGXPtr{nullptr};   
   uint8_t _strtPin{0};
   uint8_t _pinsQty{0};
 
   uint8_t* _srgxStampMskPtr{nullptr}; // Pointer to the mask used to stamp the virtual port over the Main Buffer of the ShiftRegGPIOXpander object.
   uint16_t _vportBuffer{0};
   /*_vportMaxVal: Maximum value that can be set in the virtual port, calculated as 
   (2^pinsQty) - 1, where pinsQty is the number of pins that compose the virtual port. 
   The value is used to enforce the range of valid values. */
   uint16_t _vportMaxVal{0};
   bool _begun{false}; // Flag to indicate if the virtual port has been begun, i.e. if the begin() method has been called and the initial state of the virtual port has been set.
   bool _buildSRGXVPortMsk(uint8_t* &maskPtr);
 
protected:
   SemaphoreHandle_t _SRGXVPortMskMtx; // Mutex to protect the Auxiliary Buffer from concurrent access

   SRGXVPort();   
   SRGXVPort(ShiftRegGPIOXpander* SRGXPtr, uint8_t strtPin, uint8_t pinsQty);
 
public:
   ~SRGXVPort();
   bool begin(uint16_t initCntnt);
   uint8_t digitalReadSr(const uint8_t &srPin);
   bool digitalWriteSr(const uint8_t &srPin, const uint8_t &value);
   bool flipBit(const uint8_t &srPin);
   ShiftRegGPIOXpander* getSRGXPtr();
   uint8_t* getStampMask();
   uint16_t getVPortMaxVal();
   uint16_t readPort();   
   bool resetBit(const uint8_t &srPin);
   bool setBit(const uint8_t &srPin);
   bool writePort(uint16_t newPortVal);
};
 
//==========================================================>>
 
#endif //ShiftRegGPIOXpander_ESP32_H_