SerialWombatRandomBlink.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2026 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 SerialWombatRandomBlink : public SerialWombatPin, public SerialWombatAbstractScaledOutput
{
public:
    SerialWombatRandomBlink(SerialWombatChip& serialWombat) :SerialWombatPin(serialWombat), SerialWombatAbstractScaledOutput(serialWombat)
    {}
 
    

    int16_t begin(uint8_t pin,
         uint16_t onTimeMax,
        uint16_t offTimeMax,
        uint16_t onTimeMin = 0,
        uint16_t offTimeMin = 0, 
        uint16_t onPWMMin = 0xFFFF, 
        uint16_t onPWMMax = 0xFFFF,
        uint16_t offPWMMin = 0, uint16_t offPWMMax = 0)
    {
         _pin = pin;
        _pinMode = (uint8_t)PIN_MODE_RANDOMBLINK;
       int16_t result = initPacketNoResponse(0, SW_LE16(onTimeMax), SW_LE16(offTimeMax));
        if (result < 0)
        {
            return result;
        }
 
       
    if (onPWMMin != 0xFFFF || onPWMMax != 0xFFFF)
    {
        result = initPacketNoResponse(1, SW_LE16(onPWMMin), SW_LE16(onPWMMax));
        if (result < 0)
        {
            return result;
        }
    }
    if (offPWMMin != 0 || offTimeMax != 0)
    {
        result =  initPacketNoResponse(2, SW_LE16(offPWMMin), SW_LE16(offPWMMax));
 
        if (result < 0)
        {
            return result;
        }
    }
    if (onTimeMin != 0 || offTimeMin  != 0)
    {
          result =  initPacketNoResponse(3, SW_LE16(onTimeMin), SW_LE16(offTimeMin));;
    }
    return result;
    }
 
   
 
    
    uint8_t pin()
    {
        return SerialWombatPin::_pin;
    }

    uint8_t swPinModeNumber()
    {
        return SerialWombatPin::_pinMode;
    }
};