SerialWombatProtectedOutput.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2020-2023 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.
*/
 
#include "SerialWombat.h"
 
 
typedef enum
{
    PO_FAULT_IF_NOT_EQUAL = 0,
    PO_FAULT_IF_FEEDBACK_LESS_THAN_EXPECTED= 1,
    PO_FAULT_IF_FEEDBACK_GREATER_THAN_EXPECTED = 2,
} PO_COMPARE_t;
 

class SerialWombatProtectedOutput : public SerialWombatPin
{
public:
    SerialWombatProtectedOutput(SerialWombatChip& serialWombat):SerialWombatPin(serialWombat){}
    void begin(uint8_t pin, uint8_t monitoredPin)
    {
        _pin = pin;
        _monitoredPin = monitoredPin;
    }

    void configure(PO_COMPARE_t compareMode, uint16_t compareValue, uint8_t debounceTime, SerialWombatPinState_t activeState, SerialWombatPinState_t safeState)
    {
    _debounceTime = debounceTime;
    _safeState = safeState;
    _compareMode = compareMode;
    _activeState = activeState;
    {
        uint8_t tx[] = { 200,_pin,PIN_MODE_PROTECTED_OUTPUT,SW_LE16(compareValue), _debounceTime,_monitoredPin,(uint8_t)_safeState };
        _sw.sendPacket(tx);
    }
    {
        uint8_t tx1[] = { 201,_pin,PIN_MODE_PROTECTED_OUTPUT,(uint8_t) _compareMode,(uint8_t)_activeState,0x55,0x55,0x55 };
        _sw.sendPacket(tx1);
    }
 
    }

    bool isInSafeState()
    {
 
        return (_sw.readPublicData(_pin) >= _debounceTime);
    }

    void makeInput()
    {
        configure(PO_FAULT_IF_FEEDBACK_LESS_THAN_EXPECTED, 0, 100, SW_INPUT, SW_INPUT);
    }

    void digitalWrite(uint8_t state)
    {
        if (state == HIGH)
        {
            configure(PO_FAULT_IF_FEEDBACK_LESS_THAN_EXPECTED, 0, 100, SW_HIGH, SW_HIGH);
        }
        else if (state == LOW)
        {
            
                configure(PO_FAULT_IF_FEEDBACK_LESS_THAN_EXPECTED, 0, 100, SW_LOW, SW_LOW);
        }
    }
 
private:
 
    uint8_t _monitoredPin = 255;
    PO_COMPARE_t _compareMode = PO_FAULT_IF_NOT_EQUAL;
    uint8_t _debounceTime = 0;
    SerialWombatPinState_t _safeState = SW_INPUT;
    SerialWombatPinState_t _activeState = SW_INPUT;
    uint16_t _compareValue;
};