SerialWombatIRRx.h

Go to the documentation of this file.

#pragma once
 
/*
Copyright 2025-26 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 "Stream.h"
#include "SerialWombat.h"
 
class SerialWombatIRRx :
    public Stream, public SerialWombatPin
{
    public:
        enum publicDataOutput {
            COMMAND = 0, 
            ADDRESS = 1, 
            DATACOUNT = 2, 
        };
 

        SerialWombatIRRx(SerialWombatChip &serialWombatChip ):SerialWombatPin(serialWombatChip)
    {
    }

        int16_t begin(
                uint8_t pin, SerialWombatIRRx::publicDataOutput dataOutput = SerialWombatIRRx::publicDataOutput::DATACOUNT , uint8_t irMode = 0, bool useRepeat = true, 
                 SerialWombatPinState_t activeState=SW_LOW, uint16_t publicDataTimeoutPeriod_mS = 1000, uint16_t publicDataTimeoutValue = 0xFFFF, bool useAddressFilter = false, uint16_t addressFilterValue = 0x1234)
        {
            _pinMode = (uint8_t)PIN_MODE_IRRX;
            _pin = pin;
            int16_t returnValue = 0;
 
            {
                uint8_t tx[] = { 200, _pin, _pinMode, irMode,
                    useRepeat ? (uint8_t)1 : (uint8_t)0,
                    (uint8_t)activeState, 
                    (uint8_t)(addressFilterValue & 0xFF), (uint8_t)((addressFilterValue >> 8) & 0xFF), };
                returnValue = _sw.sendPacket(tx);
                if (returnValue < 0)
                {
                    return returnValue;
                }
            }
            {
                uint8_t tx[] { 201, _pin, _pinMode, (uint8_t)(publicDataTimeoutPeriod_mS & 0xFF), (uint8_t)((publicDataTimeoutPeriod_mS >> 8) & 0xFF),
                    (uint8_t)(publicDataTimeoutValue & 0xFF), (uint8_t)((publicDataTimeoutValue >> 8) & 0xFF),  useAddressFilter ? (uint8_t)1 : (uint8_t)0
                };
 
                returnValue = _sw.sendPacket(tx);
                if (returnValue < 0)
                {
                    return returnValue;
                }
            }
            {
                uint8_t tx[] { 205, _pin, _pinMode, (uint8_t)dataOutput,
                    0x55,0x55,0x55,0x55};
 
                returnValue = _sw.sendPacket(tx);
                //if (returnValue < 0)
                {
                    return returnValue;
                }
            }
 
        }

        int available()
        {
            uint8_t tx[8] = { 201, _pin, _pinMode, 0,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            _sw.sendPacket(tx, rx);
            return (rx[4]);
        }

        int read()
        {
            uint8_t tx[8] = { 202, _pin,_pinMode, 1,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            if (_sw.sendPacket(tx, rx) < 0)
            {
                return -1;
            }
 
            if (rx[3] != 0)
            {
                return (rx[4]);
            }
            else
            {
                return (-1);
            }
        }

        void flush()
        {
            //TODO  
        }

        int peek()
        {
            uint8_t tx[8] = { 203, _pin,_pinMode,0x55,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            _sw.sendPacket(tx, rx);
            if (rx[4] > 0)
            {
                return (rx[5]);
            }
            else
            {
                return (-1);
            }
        }

        size_t write(uint8_t data)
        {
            (void)data; // Avoid compiler warning about unused parameter
 
            return (1);
        }

        size_t write(const uint8_t* buffer, size_t size)
        {
            (void)buffer; // Avoid compiler warning about unused parameter
            return(size);
        }

        int availableForWrite()
        {
            return(0);
        }

        size_t readBytes(char* buffer, size_t length)
        {
            int index = 0;
            int bytesAvailable = 0;
            uint32_t timeoutMillis = millis() + timeout;
            while (length > 0 && timeoutMillis > millis())
            {
                int bytecount = 4;
                if (length < 4)
                {
                    bytecount = length;
                }
                {
 
                    uint8_t tx[8] = { 202, _pin,_pinMode, (uint8_t)bytecount,0x55,0x55,0x55,0x55 };
                    uint8_t rx[8];
                    _sw.sendPacket(tx, rx);
                    bytesAvailable = rx[3];
 
                    if (bytesAvailable == 0)
                    {
                        continue;
                    }
                    else
                    {
                        timeoutMillis = millis() + timeout;
                    }
                    uint8_t bytesReturned = bytecount;
                    if (rx[3] < bytecount)
                    {
                        bytesReturned = rx[3];
                    }
                    for (int i = 0; i < bytesReturned; ++i)
                    {
                        buffer[index] = rx[i + 4];
                        ++index;
                        --bytesAvailable;
                        --length;
 
                    }
                }
 
            }
            return (index);
        }

        void setTimeout(long timeout_mS)
        {
            if (timeout_mS == 0)
            {
                timeout = 0x80000000;
            }
            else
            {
                timeout = timeout_mS;
            }
        }
 

        SerialWombatIRRx& operator=(SerialWombatIRRx& irrx)
        {
            return irrx;
        }

        uint16_t readAddress()
        {
            uint8_t tx[8] = { 204, _pin,_pinMode, 0x55,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            _sw.sendPacket(tx, rx);
            uint16_t returnVal = rx[4];
            returnVal <<= 8;
            returnVal|= rx[3];
            return returnVal;
        }

        uint16_t readDataCount()
        {
            uint8_t tx[8] = { 204, _pin,_pinMode, 0x55,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            _sw.sendPacket(tx, rx);
            uint16_t returnVal = rx[6];
            returnVal <<= 8;
            returnVal|= rx[5];
            return returnVal;
        }
    protected:
        uint32_t timeout = 1;
};