SerialWombatQuadEnc.h

Go to the documentation of this file.

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

 
typedef enum
{
    QE_ONLOW_INT = 0,  
    QE_ONHIGH_INT = 1, 
    QE_ONBOTH_INT = 2, 
    QE_ONLOW_POLL = 4,   
    QE_ONHIGH_POLL = 5,    
    QE_ONBOTH_POLL = 6     
} QE_READ_MODE_t;
 
 

 
class SerialWombatQuadEnc :public SerialWombatPin
{
public:

    SerialWombatQuadEnc(SerialWombatChip& serialWombatChip) :SerialWombatPin(serialWombatChip)
    {
        _secondPin = 255;
    }

    void begin(uint8_t pin, uint8_t secondPin, uint16_t debounce_mS = 10, bool pullUpsEnabled = true, QE_READ_MODE_t readState = QE_ONBOTH_POLL)
    {
        _pin = pin;
        _secondPin = secondPin;
        _pinMode = PIN_MODE_QUADRATUREENCODER;
        uint8_t tx[] = { 200,_pin,PIN_MODE_QUADRATUREENCODER,SW_LE16(debounce_mS), _secondPin,(uint8_t)readState,pullUpsEnabled };
        uint8_t rx[8];
        _sw.sendPacket(tx, rx);
    }

    uint16_t read()
    {
        return _sw.readPublicData(_pin);
    }

    uint16_t read(uint16_t replacementValue)
    {
        return _sw.writePublicData(_pin, replacementValue);
    }

    void write(uint16_t value)
    {
        _sw.writePublicData(_pin, value);
    }
private:
 
    uint8_t _secondPin;
};

class SerialWombatQuadEnc_18AB : public SerialWombatQuadEnc, public SerialWombatAbstractProcessedInput
{
public:
    SerialWombatQuadEnc_18AB(SerialWombatChip& serialWombat) :SerialWombatQuadEnc(serialWombat) , SerialWombatAbstractProcessedInput(serialWombat)
    {}
 
    int16_t writeMinMaxIncrementTargetPin(uint16_t min = 65535, uint16_t max = 0, uint16_t increment = 1, uint8_t targetPin = 255)
    {
        
        {
            uint8_t tx[] = { 201,_pin,PIN_MODE_QUADRATUREENCODER,SW_LE16(increment), 0x55,0x55,0x55 };
            int16_t result = _sw.sendPacket(tx);
            if (result < 0)
            {
                return(result);
            }
        }
        {
            uint8_t tx[] = { 202,_pin,PIN_MODE_QUADRATUREENCODER,SW_LE16(min), SW_LE16(max),0x55 };
            int16_t result = _sw.sendPacket(tx);
            if (result < 0)
            {
                return(result);
            }
        }
        {
            uint8_t tx[] = { 203,_pin,PIN_MODE_QUADRATUREENCODER,targetPin,0x55,0x55,0x55,0x55 };
            return _sw.sendPacket(tx);
 
        }
 
    }
 
    int16_t writeFrequencyPeriodmS(uint16_t period)
    {
        uint8_t tx[] = { 204,_pin,PIN_MODE_QUADRATUREENCODER,SW_LE16(period),0x55,0x55,0x55 };
         return _sw.sendPacket(tx);
        
    }
 
    uint16_t readFrequency()
    {
        uint8_t tx[] = { 205,_pin,PIN_MODE_QUADRATUREENCODER,0x55,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        int16_t result = _sw.sendPacket(tx,rx);
        if (result < 0) return 0;
 
        return ((uint16_t)(rx[3] + 256 * rx[4]));
    }
 

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

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