SerialWombatPulseOnChange.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2022-2024 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 <stdint.h>
#include "SerialWombat.h"
 
class SerialWombat;


 
class SerialWombatPulseOnChange : public SerialWombatPin
{
public:
    SerialWombatPulseOnChange(SerialWombatChip& serialWombat):SerialWombatPin(serialWombat)
    {
        _pinMode = PIN_MODE_PULSE_ON_CHANGE;
    }
 

    int16_t begin(uint8_t pin, SerialWombatPinState_t activeMode = SW_HIGH, SerialWombatPinState_t inactiveMode = SW_LOW, uint16_t pulseOnTime = 50, uint16_t pulseOffTime = 50, uint8_t orNotAnd = 1, uint16_t PWMperiod = 0, uint16_t PWMdutyCycle = 0x8000)
{
    int16_t result;
    _pin = pin;
 
    result = initPacketNoResponse(0,(uint8_t)activeMode,(uint8_t)inactiveMode, orNotAnd); if (result < 0) { return result; }
    result = initPacketNoResponse(1,pulseOnTime,pulseOffTime); if (result < 0) { return result; }
    return initPacketNoResponse(2,PWMperiod,PWMdutyCycle); 
}

    int16_t setEntryOnChange(uint8_t entryID, uint8_t sourcePin)
{
    return setEntryMode(entryID, sourcePin, 0);
}

    int16_t setEntryOnIncrease(uint8_t entryID, uint8_t sourcePin)
{
    return setEntryMode(entryID, sourcePin, 1);
}

    int16_t setEntryOnDecrease(uint8_t entryID, uint8_t sourcePin)
{
    return setEntryMode(entryID, sourcePin, 2);
}

    int16_t setEntryOnEqualValue(uint8_t entryID, uint8_t sourcePin, uint16_t value)
{
    int16_t result = setEntryParams(entryID, value, 0);  if (result < 0) return result;
    return setEntryMode(entryID, sourcePin, 3);
}

    int16_t setEntryOnLessThanValue(uint8_t entryID, uint8_t sourcePin, uint16_t value)
    {
        int16_t result = setEntryParams(entryID, value, 0);  if (result < 0) return result;
        return setEntryMode(entryID, sourcePin, 4);
    }

    int16_t setEntryOnGreaterThanValue(uint8_t entryID, uint8_t sourcePin, uint16_t value)
    {
        int16_t result = setEntryParams(entryID, value, 0);  if (result < 0) return result;
        return setEntryMode(entryID, sourcePin, 5);
    }
 

    int16_t setEntryOnNotEqualValue(uint8_t entryID, uint8_t sourcePin, uint16_t value)
    {
        int16_t result = setEntryParams(entryID, value, 0);  if (result < 0) return result;
        return setEntryMode(entryID, sourcePin, 6);
    }

    int16_t setEntryOnPinsEqual(uint8_t entryID, uint8_t sourcePin, uint8_t secondPin )
    {
        int16_t result = setEntryParams(entryID, secondPin, 0);  if (result < 0) return result;
        return setEntryMode(entryID, sourcePin, 7);
    }

    int16_t setEntryOnPinsNotEqual(uint8_t entryID, uint8_t sourcePin, uint8_t secondPin )
    {
        int16_t result = setEntryParams(entryID, secondPin, 0);  if (result < 0) return result;
        return setEntryMode(entryID, sourcePin, 10);
    }

    int16_t setEntryOnPinGTPin(uint8_t entryID, uint8_t sourcePin, uint8_t secondPin );

    int16_t setEntryOnPinLTPin(uint8_t entryID, uint8_t sourcePin, uint8_t secondPin );
    int16_t setEntryOnPinCrossValue(uint8_t entryID, uint8_t sourcePin, uint16_t value); 

    int16_t setEntryOnPinCrossAscending(uint8_t entryID, uint8_t sourcePin, uint16_t value); 

    int16_t setEntryOnPinCrossDescending(uint8_t entryID, uint8_t sourcePin, uint16_t value);

    int16_t setEntryOnPinWithinRange(uint8_t entryID, uint8_t sourcePin, uint16_t lowValue, uint16_t highValue); 

    int16_t setEntryOnPinOutsideRange(uint8_t entryID, uint8_t sourcePin, uint16_t lowValue, uint16_t highValue);
private:
    int16_t setEntryParams(uint8_t entryID, uint16_t firstParam, uint16_t secondParam)
    {
        return initPacketNoResponse(3, entryID, SW_LE16(firstParam), SW_LE16(secondParam));
    }
    int16_t setEntryMode(uint8_t entryID, uint8_t pin, uint8_t mode)
    {
        return initPacketNoResponse(4, entryID, mode,pin);
    }
};