SerialWombatPin.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2023-2025 Broadwell Consulting Inc.
 
"Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
the United States.  See SerialWombat.com for usage guidance.
 
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.
*/

class SerialWombatPin
{
public:
    SerialWombatPin(SerialWombatChip& serialWombatChip): _sw(serialWombatChip)
    {
    }

    SerialWombatPin(SerialWombatChip& serialWombatChip, uint8_t pin): _sw(serialWombatChip)
    {
        _pin = pin;
    }

    uint16_t readPublicData() 
    {
        return _sw.readPublicData(_pin);
    };
 

    void pinMode(uint8_t mode, bool pullDown = false, bool openDrain = false)
    {
        _sw.pinMode(_pin, mode, pullDown, openDrain);
    }

    void digitalWrite(uint8_t val)
    {
        _sw.digitalWrite(_pin, val);
    }

    int digitalRead()
    {
        return (_sw.digitalRead(_pin));
    }
 

    uint16_t writePublicData(uint16_t value) 
    { return _sw.writePublicData(_pin, value); }

    uint8_t pin() {return _pin;}

    uint8_t swPinModeNumber() { return _pinMode; }
 
 
 
  int16_t initPacketNoResponse(uint8_t packetNumber,uint8_t param0 = 0x55, uint8_t param1 = 0x55, uint8_t param2 = 0x55, uint8_t param3 = 0x55, uint8_t param4 = 0x55)
        {
            uint8_t tx[] = { (uint8_t)(200 +packetNumber), _pin, _pinMode,param0,param1,param2,param3,param4} ;
            return (_sw.sendPacket(tx));
        }
 
  int16_t initPacketNoResponse(uint8_t packetNumber,uint16_t param0 = 0x55, uint8_t param1 = 0x55, uint8_t param2 = 0x55, uint8_t param3 = 0x55 )
        {
            uint8_t tx[] = { (uint8_t)(200 +packetNumber), _pin, _pinMode,SW_LE16(param0),param1,param2,param3} ;
            return (_sw.sendPacket(tx));
        }
  int16_t initPacketNoResponse(uint8_t packetNumber,uint16_t param0,uint16_t param1, uint8_t param2 = 0x55)
        {
            uint8_t tx[] = { (uint8_t)(200 +packetNumber), _pin, _pinMode, SW_LE16(param0),SW_LE16(param1),param2 };
            return (_sw.sendPacket(tx));
        }

    int16_t disable ()
    {
        uint8_t tx[] =
        {
        (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE_DISABLE,
        _pin,
        _pinMode,
        0x55,0x55,0x55,0x55,0x55
        };
       return _sw.sendPacket(tx);
    }

  int16_t enablePullup(bool enabled)
  {
      uint8_t tx[] = {(uint8_t)SerialWombatCommands::COMMAND_SET_PIN_HW,_pin,(uint8_t)(enabled?1:0),0x55,0x55,0x55,0x55,0x55};
            return (_sw.sendPacket(tx));
  }

  int16_t enablePulldown(bool enabled)
  {
      uint8_t tx[] = {(uint8_t)SerialWombatCommands::COMMAND_SET_PIN_HW,_pin,0x55,(uint8_t)(enabled?1:0),0x55,0x55,0x55,0x55};
            return (_sw.sendPacket(tx));
  }

  int16_t enableOpenDrain(bool enabled)
  {
      uint8_t tx[] = {(uint8_t)SerialWombatCommands::COMMAND_SET_PIN_HW,_pin,0x55,0x55,(uint8_t)(enabled?1:0),0x55,0x55,0x55};
            return (_sw.sendPacket(tx));
  }

  int16_t forceDMA(bool enabled)
  {
      uint8_t tx[] = {(uint8_t)SerialWombatCommands::COMMAND_SET_PIN_HW,_pin,0x55,0x55,(uint8_t)(enabled?1:0),0x55,0x55,0x55};
            return (_sw.sendPacket(tx));
  }

  void setPinNumberForTesting(uint8_t pin)
  {
      _pin = pin;
  }
 
protected:
    uint8_t _pin = 255;
    SerialWombatChip& _sw;
    uint8_t _pinMode = 0;
 
};