SerialWombatPulseTimer.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2020-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;

typedef enum
{
    SW_PULSETIMER_uS = 0,
    SW_PULSETIMER_mS = 1
} SerialWombatPulseTimerUnits;

 
class SerialWombatPulseTimer : public SerialWombatPin
{
public:
    SerialWombatPulseTimer(SerialWombatChip& serialWombat):SerialWombatPin(serialWombat)
    {
    }

    int16_t begin(uint8_t pin, SerialWombatPulseTimerUnits units = SW_PULSETIMER_uS, bool pullUpEnabled = false)
    {
        _pin = pin;
        _pinMode = PIN_MODE_PULSETIMER;
        return initPacketNoResponse(0,(uint8_t)pullUpEnabled,(uint8_t)units);
    }

    void refresh()
    {
        refreshHighCountsLowCounts();
        {
            uint8_t tx[] = { 202,_pin,_pinMode,0x55,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            _sw.sendPacket(tx, rx);
            Pulses = rx[5] + 256 * rx[6];
            MeasurementOverflowOccurred = rx[7];
        }
    }

    void refreshHighCountsLowCounts()
    {
        uint8_t tx[] = { 201,_pin,_pinMode,0x55,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        _sw.sendPacket(tx, rx);
        HighCounts = rx[3] + 256 * rx[4];
        LowCounts = rx[5] + 256 * rx[6];
    }
 
    /*
    \brief Retreive the High counts and number of pulses Serial Wombat chip in a single transaction
    
    This command will retreive consecutive high and low periods from the Serial Wombat chip.
    It it not guaranteed which is the most recent.
    */
    void refreshHighCountsPulses()
    {
        uint8_t tx[] = { 202,_pin,_pinMode,0x55,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        _sw.sendPacket(tx, rx);
        HighCounts = rx[3] + 256 * rx[4];
        Pulses = rx[5] + 256 * rx[6];
        MeasurementOverflowOccurred = rx[7];
    }
 
    /*
    \brief Retreives the most recent Counts in the configured units for the most recent high pulse
    
    \return Counts in mS or uS depending on configuration.
    */
    uint16_t readHighCounts()
    {
        refreshHighCountsLowCounts();
        return (HighCounts);
    }
 
 
    /*
    \brief Retreives the most recent Counts in the configured units for the most recent low pulse
    
    \return Counts in mS or uS depending on configuration.
    */
    uint16_t readLowCounts()
    {
        refreshHighCountsLowCounts();
        return (LowCounts);
    }
 
    /*
    \brief Retreives the number of pulses
    
    This value overflows at 65535.  Reading this value does not clear it.
    This function has a side effect of reading MeasurementOverflowOccured from the Serial Wombat chip,
    which clears it for future readings.
    \return Number of pulses counted (1 count per high/low cycle).  Rolls over at 65535 to 0
    */
    uint16_t readPulses()
    {
        refreshHighCountsPulses();
        return(Pulses);
    }
 
    /*
    \brief Count in selected units of last retreived high pulse
     
    This value is updated by refresh, refreshHighCountsLowCounts, refreshHighCountsPulses, readHighCounts, readLowCounts
    */
    uint16_t HighCounts = 0;
    /*
    \brief Count in selected units of last retreived low pulse
     
    This value is updated by refresh, refreshHighCountsLowCounts, readHighCounts, readLowCounts
    */
    uint16_t LowCounts = 0;
 
    /*
    \brief Count of last retreived pulses
    
    This value is updated by refresh, and refreshHighCountsPulses
    */
    uint16_t Pulses = 0;
    bool MeasurementOverflowOccurred = false;
 
private:
 
};

This class adds functionality that is specific to the SW18AB firmware in addition
to generic SerialWombatPulseTimer functionality avaialble on all Serial Wombat chips
*/
 
class SerialWombatPulseTimer_18AB : public SerialWombatPulseTimer, public SerialWombatAbstractProcessedInput
{
public:
    enum publicDataOutput {
        HIGH_TIME = 0, 
        LOW_TIME = 1, 
        PULSE_COUNT = 2, 
        PERIOD_ON_LTH_TRANSITION = 3,  
        PERIOD_ON_HTL_TRANSITION = 4,  
        FREQUENCY_ON_LTH_TRANSITION = 5, 
        FREQUENCY_ON_HTL_TRANSITION = 6, 
        DUTYCYCLE_ON_LTH_TRANSITION = 7, 
        DUTYCYCLE_ON_HTL_TRANSITION = 8, 
    };

    SerialWombatPulseTimer_18AB(SerialWombatChip& serialWombat):SerialWombatPulseTimer(serialWombat), SerialWombatAbstractProcessedInput(serialWombat)
    {
    }
 
    /*
    \brief configures which measurement is the Public Data Output of this pin mode
     
     This function sets what data is avaialble through the public data 
     This function is only avaialble on the Serial Wombat 18AB chip
    
    \param publicDataOutput An enumerated type indicating what data to output
    \return returns 0 or higher for success or a negative error code.
    */
    int16_t configurePublicDataOutput(SerialWombatPulseTimer_18AB::publicDataOutput publicDataOutput)
    {
        
    uint8_t tx[] = { 203,_pin,_pinMode,(uint8_t) publicDataOutput};
        return _sw.sendPacket(tx);   
//      return initPacketNoResponse(3,(uint8_t)publicDataOutput);
    }
    
    uint8_t pin() { return _pin; }
    uint8_t swPinModeNumber() { return _pinMode; }
};