SerialWombatResistanceInput.h

Go to the documentation of this file.

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

 
 
enum ResistanceInputPublicDataOutput {
    ResistanceInputPublicDataOutput_Raw = 0,  
    ResistanceInputPublicDataOutput_Filtered = 1,   
    ResistanceInputPublicDataOutput_Averaged = 2,   
    ResistanceInputPublicDataOutput_Minimum = 3, 
    ResistanceInputPublicDataOutput_Maximum = 4, 
};

class SerialWombatResistanceInput : public SerialWombatPin, public SerialWombatAbstractProcessedInput
{
public:
    SerialWombatResistanceInput(SerialWombatChip& serialWombatChip):SerialWombatPin(serialWombatChip), SerialWombatAbstractProcessedInput(serialWombatChip){}

    int16_t begin(uint8_t pin)
    {
        _pin = pin;
        uint8_t tx[] = { 200,_pin,PIN_MODE_RESISTANCEINPUT,0,0,0,0,0 };
        uint8_t rx[8];
        _sw.sendPacket(tx, rx);
        uint8_t tx1[] = { 201,_pin,PIN_MODE_RESISTANCEINPUT,4,0,0xFF,0x80,0 };
        return _sw.sendPacket(tx1, rx);
    }

    int16_t begin(uint8_t pin, uint16_t averageSamples, uint16_t filterConstant)
    {
        begin(pin);
        uint8_t tx[] = { 201,_pin,PIN_MODE_RESISTANCEINPUT,SW_LE16(averageSamples) ,SW_LE16(filterConstant),0 };
        return _sw.sendPacket(tx);
    }

    int16_t begin(uint8_t pin, uint16_t averageSamples, uint16_t filterConstant, ResistanceInputPublicDataOutput output)
    {
        begin(pin);
        uint8_t tx[] = { 201,_pin,PIN_MODE_RESISTANCEINPUT,SW_LE16(averageSamples) ,SW_LE16(filterConstant),(uint8_t)output };
        return _sw.sendPacket(tx);
    }

    uint16_t readFilteredOhms()
    {
        uint8_t tx[] = { 204,_pin,PIN_MODE_RESISTANCEINPUT,0x55,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
 
        _sw.sendPacket(tx, rx);
 
        return(rx[5] + rx[6] * 256);
    }
 

    uint16_t readAveragedOhms()
    {
        uint8_t tx[] = { 204,_pin,PIN_MODE_RESISTANCEINPUT,0x55,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
 
        _sw.sendPacket(tx, rx);
 
        return(rx[3] + rx[4] * 256);
    }
 

    uint16_t readMaximumOhms(bool resetAfterRead)
    {
        uint8_t tx[] = { 203,_pin,PIN_MODE_RESISTANCEINPUT,0,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
 
        if (resetAfterRead)
        {
            tx[3] = 1;
        }
        _sw.sendPacket(tx, rx);
 
        return(rx[5] + rx[6] * 256);
    }

    uint16_t readMinimumOhms(bool resetAfterRead)
    {
        uint8_t tx[] = { 203,_pin,PIN_MODE_RESISTANCEINPUT,0,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
 
        if (resetAfterRead)
        {
            tx[3] = 1;
        }
        _sw.sendPacket(tx, rx);
 
        return(rx[3] + rx[4] * 256);
    }
 
    uint8_t pin() { return _pin; }
    uint8_t swPinModeNumber() { return _pinMode; }
 
private:
    
};