SerialWombatFrequencyOutput.h

Go to the documentation of this file.

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

    int16_t begin(uint8_t pin, uint16_t maxFrequency_Hz = 65535, bool lowFrequency = false,  uint16_t dutyCycle = 0x8000)
    {
        _pin = pin;
        _pinMode = (uint8_t)PIN_MODE_FREQUENCY_OUTPUT;
        return initPacketNoResponse(0, SW_LE16(dutyCycle), SW_LE16( maxFrequency_Hz),(uint8_t)lowFrequency);
    }
 
 
private:
};
 
 

class SerialWombatFrequencyOutput_18AB: public SerialWombatFrequencyOutput, public SerialWombatAbstractScaledOutput
{
public:
    SerialWombatFrequencyOutput_18AB(SerialWombatChip& serialWombat) :SerialWombatFrequencyOutput(serialWombat), SerialWombatAbstractScaledOutput(serialWombat)
    {}
 

    uint8_t pin()
{
    return SerialWombatPin::_pin;
}

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