SerialWombatHSCounter.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2023-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 SerialWombatHSCounter : public SerialWombatPin, public SerialWombatAbstractProcessedInput
{
public:
    enum publicDataOutput {
        PULSE_COUNT = 2, 
        FREQUENCY_ON_LTH_TRANSITION = 5, 
    };

    SerialWombatHSCounter(SerialWombatChip& serialWombat):SerialWombatPin(serialWombat), SerialWombatAbstractProcessedInput(serialWombat){}

    int16_t begin(uint8_t pin, SerialWombatHSCounter::publicDataOutput publicDataOutput = publicDataOutput::FREQUENCY_ON_LTH_TRANSITION ,uint16_t framesBetweenUpdates = 100, uint16_t publicOutputDivisor = 1)
    {
        _pin = pin;
        _pinMode = PIN_MODE_HS_COUNTER;
        return initPacketNoResponse(0,framesBetweenUpdates, publicOutputDivisor, (uint8_t)publicDataOutput );
    }
 
    uint32_t readCounts(bool resetCounts = false)
    {
        uint8_t tx[8] =
        {
        (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE1,
        _pin,
        _pinMode,
        (uint8_t)(resetCounts?1:0),
        0x55,
        0x55,
        0x55,
        0x55};
        uint8_t rx[8];
        int16_t result = _sw.sendPacket(tx, rx);
        if (result < 0)
        {
            return 0;
        }
        uint32_t returnval = (((uint32_t)rx[6]) << 24) + (((uint32_t)rx[5]) << 16) + (((uint16_t)rx[4]) << 8) + rx[3];
        return(returnval);
    }
 
    int32_t readFrequency()
    {
        uint8_t tx[8] =
        {
        (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE2,
        _pin,
        _pinMode,
        0x55,
        0x55,
        0x55,
        0x55,
        0x55 };
        uint8_t rx[8];
        int16_t result = _sw.sendPacket(tx, rx);
        if (result < 0)
        {
            return result;
        }
        uint32_t returnval = (((uint32_t)rx[6]) << 24) + (((uint32_t)rx[5]) << 16) + (((uint16_t)rx[4]) << 8) + rx[3];
        return(returnval);
    }

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