SerialWombatUART.h

Go to the documentation of this file.

#pragma once
#include "Stream.h"
#include "SerialWombat.h"
 
/*
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.
*/

 
class SerialWombatUART :
    public Stream, public SerialWombatPin
{
public:
    SerialWombatUART(SerialWombatChip& serialWombat):SerialWombatPin(serialWombat){}
   

    int16_t begin(uint32_t baudRate, uint8_t pin, uint8_t rxPin, uint8_t txPin,uint8_t HWinterface = 1 )
    {
        _rxPin = rxPin;
        _txPin = txPin;
        _pin = pin;
        if (HWinterface == 2)
        {
            _pinMode = PIN_MODE_UART1_RX_TX;
            _tx7Command = (uint8_t)SerialWombatCommands::COMMAND_UART1_TX_7BYTES;
            _rx7Command = (uint8_t)SerialWombatCommands::COMMAND_UART1_RX_7BYTES;
 
        }
        else if (HWinterface == 1)
        {
            _pinMode = PIN_MODE_UART_RX_TX;
            _tx7Command = (uint8_t)SerialWombatCommands::COMMAND_UART0_TX_7BYTES;
            _rx7Command = (uint8_t)SerialWombatCommands::COMMAND_UART0_RX_7BYTES;
        }
        else
        {
            return (-1);
        }
         switch (baudRate)
         {
         case 300:
             _baudMarker = 0;
             break;
         case 1200:
             _baudMarker = 1;
             break;
 
         case 2400:
             _baudMarker = 2;
             break;
 
         case 4800:
             _baudMarker = 3;
             break;
         case 9600:
             _baudMarker = 4;
             break;
         case 19200:
             _baudMarker = 5;
             break;
 
         case 38400:
             _baudMarker = 6;
             break;
            
         case 57600:
             _baudMarker = 7;
             break;
 
         default:
             case 115200:
             _baudMarker = 8;
             break;
         }
        uint8_t tx[8] = { 200, _pin,_pinMode, _baudMarker,_rxPin,_txPin,0x55, 0x55 };
        uint8_t rx[8];
        return _sw.sendPacket(tx, rx);
 
    }

    virtual 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]);
}

    virtual 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);
    }
}

    virtual void flush()
{
    uint8_t tx[8] = { 200, _pin,_pinMode, _baudMarker,_rxPin,_txPin,0x55 };
    uint8_t rx[8];
    _sw.sendPacket(tx, rx);
}

    virtual 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);
    }
}

    virtual size_t write(uint8_t data)
{
    uint8_t tx[8] = { 201, _pin,_pinMode,1,data,0x55,0x55,0x55 };
    _sw.sendPacket(tx);
    return (1);
}

    virtual size_t write(const uint8_t* buffer, size_t size)
{
    size_t bytesAvailable = 0;
    size_t bytesSent;
    uint32_t timeoutMillis = millis() + timeout;
    
    for (bytesSent = 0; bytesSent  < size ;)
    {
 
        while (bytesAvailable < 4)
        {
            uint8_t peektx[8] = { 203, _pin,_pinMode,0x55,0x55,0x55,0x55,0x55 };
            uint8_t peekrx[8];
            _sw.sendPacket(peektx, peekrx);
            bytesAvailable = peekrx[3];
            if (timeoutMillis < millis())
            {
//                 Serial.printf("UART TX TIMEOUT!\r\n");
                return (bytesSent);
            }
        }
        timeoutMillis = millis() + timeout;
 
        while (bytesSent < size && bytesAvailable > 0)
        {
            delay(0);//yield();
            if ((size - bytesSent) < 7 || bytesAvailable < 7)
            {
                uint8_t tx[8] = { 201, _pin,_pinMode,0,0x55,0x55,0x55,0x55 };
                uint8_t rx[8];
                size_t txLen;
                tx[3] = 0;
                for (txLen = 0; txLen < 4 && txLen < bytesAvailable && bytesSent < size; ++txLen)
                {
                    tx[4 + txLen] = buffer[bytesSent];
                    ++bytesSent;
                    ++tx[3];
                }
                _sw.sendPacket(tx, rx);
                bytesAvailable = rx[3];
            }
            else
            {
                uint8_t tx[8] = { _tx7Command, 0x55,0x55,0x55,0x55,0x55,0x55,0x55 };
                size_t txLen;
                
                for (txLen = 0; txLen < 7 ; ++txLen)
                {
                    tx[1 + txLen] = buffer[bytesSent];
                    ++bytesSent;
                    --bytesAvailable;
                }
                _sw.sendPacket(tx);
            }
        }
    }
    return (bytesSent);
}

    virtual int availableForWrite()
{
    uint8_t peektx[8] = { 203, _pin,_pinMode,0x55,0x55,0x55,0x55,0x55 };
    uint8_t peekrx[8];
    _sw.sendPacket(peektx, peekrx);
    return peekrx[3];
}

    virtual size_t readBytes(char* buffer, size_t length)
{
    int index = 0;
    int bytesAvailable = 0;
    uint32_t timeoutMillis = millis() + timeout;
    while (length > 0 && timeoutMillis > millis())
    {
        yield();
        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;
 
            }
        }
        while (bytesAvailable >= 7 && length >= 7)
        {
            uint8_t tx[8] = { _rx7Command, 0x55,0x55,0x55,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            _sw.sendPacket(tx, rx);
            for (int i = 0; i <7; ++i)
            {
                buffer[index] = rx[i + 1];
                ++index;
                --bytesAvailable;
                --length;
 
            }
            yield();
        }
 
    }
 
    return (index);
}
 
 
    virtual void setTimeout(long timeout_mS)
{
    if (timeout_mS == 0)
    {
        timeout = 0x80000000;
    }
    else
    {
        timeout = timeout_mS;
    }
}
protected:
     uint8_t _rxPin  = 255;
     uint8_t _txPin = 255;
     uint8_t _baudMarker = 0;
     uint32_t timeout = 5000;
     uint8_t _pinMode = PIN_MODE_UART_RX_TX;
     uint8_t _tx7Command = (uint8_t)SerialWombatCommands::COMMAND_UART0_TX_7BYTES;
     uint8_t _rx7Command = (uint8_t)SerialWombatCommands::COMMAND_UART0_RX_7BYTES;
};
 
 

class SerialWombatSWUART : public SerialWombatUART
{
 
public:
  
 
    SerialWombatSWUART(SerialWombatChip& serialWombatChip):SerialWombatUART(serialWombatChip){}
    int16_t begin(uint32_t baudRate, uint8_t pin, uint8_t rxPin, uint8_t txPin, uint16_t userMemoryOffset, uint16_t rxLength, uint16_t txLength)
{
    _rxPin = rxPin;
    _txPin = txPin;
    _pin = pin;
    
    _pinMode = PIN_MODE_SW_UART;
    
    switch (baudRate)
    {
    case 300:
        _baudMarker = 0;
        break;
    case 1200:
        _baudMarker = 1;
        break;
 
    case 2400:
        _baudMarker = 2;
        break;
 
    case 4800:
        _baudMarker = 3;
        break;
    case 9600:
        _baudMarker = 4;
        break;
    case 19200:
        _baudMarker = 5;
        break;
 
    case 38400:
        _baudMarker = 6;
        break;
 
    case 57600:
        _baudMarker = 7;
        break;
 
    default:
    case 115200:
        _baudMarker = 7;  // Limit to 57600
        break;
    }
    uint8_t tx[8] = { 200, _pin,_pinMode, _baudMarker,_rxPin,_txPin,0x55, 0x55 };
    uint8_t rx[8];
 
    int16_t result = _sw.sendPacket(tx, rx);
    if (result < 0)
    {
        return (result);
    }
    int16_t rxoffset = 0;
    //if (_rxPin != 255)
    {
        if (rxLength == 0)
        {
            rxLength = 2;
        }
        rxoffset = rxQueue.begin(userMemoryOffset, rxLength);
        if (rxoffset >= 0)
        {
            userMemoryOffset += rxoffset;
        }
        else
        {
            return (0);  // No memory should have been allocated.
        }
    }
 
    int16_t txoffset = 0;
    //if (_txPin != 255)
    {
        if (txLength == 0)
        {
            txLength = 2;
        }
        txoffset = txQueue.begin(userMemoryOffset, txLength);
        if (txoffset >= 0)
        {
            userMemoryOffset += txoffset;
        }
        else
        {
            return rxoffset;
        }
    }
 
    uint8_t tx5[] = { 205,_pin,_pinMode,SW_LE16(txQueue.startIndex) };
    result = _sw.sendPacket(tx5);
    if (result < 0) return (result);
 
 
    uint8_t tx6[] = { 206,_pin,_pinMode,SW_LE16(rxQueue.startIndex) };
    result = _sw.sendPacket(tx6);
    if (result < 0) return (result);
 
    return (txoffset + rxoffset);
}

    int16_t begin(uint32_t baudRate, uint8_t pin, uint8_t rxPin, uint8_t txPin, uint8_t HWinterface = 1) 
{
    _rxPin = rxPin;
    _txPin = txPin;
    _pin = pin;
    rxQueue.startIndex = 0xFFFF;
    txQueue.startIndex = 0xFFFF;
    
    (void)HWinterface; // unused
    _pinMode = PIN_MODE_SW_UART;
    
    switch (baudRate)
    {
    case 300:
        _baudMarker = 0;
        break;
    case 1200:
        _baudMarker = 1;
        break;
 
    case 2400:
        _baudMarker = 2;
        break;
 
    case 4800:
        _baudMarker = 3;
        break;
    case 9600:
        _baudMarker = 4;
        break;
    case 19200:
        _baudMarker = 5;
        break;
 
    case 38400:
        _baudMarker = 6;
        break;
 
    case 57600:
        _baudMarker = 7;
        break;
 
    default:
    case 115200:
        _baudMarker = 7;  // Limit to 57600
        break;
    }
    uint8_t tx[8] = { 200, _pin,_pinMode, _baudMarker,_rxPin,_txPin,0x55, 0x55 };
    uint8_t rx[8];
 
    int16_t result = _sw.sendPacket(tx, rx);
    return (result);
}

    size_t write(const uint8_t* buffer, size_t size)
{
        if (txQueue.startIndex != 0xFFFF)
{
    return (txQueue.write(buffer, size));
}
        else
    {
        size_t sent = 0;
          while (sent < size)
          {
                uint8_t bytesToSend = 4;
                if ((size - sent) < bytesToSend)
                {
                     bytesToSend = size - sent;
        }
        uint8_t tx[8] = { 201, _pin,_pinMode, bytesToSend, 0x55,0x55,0x55,0x55};
        uint8_t rx[8];
                for (int i = 0; i < bytesToSend; ++i)
                {
                       tx[4 + i] = buffer[sent + i];
                }
        _sw.sendPacket(tx, rx);
                sent += bytesToSend;
                if (rx[3] < 4) // almost full
                {
                     return (sent);
                }
            delay(0);
          }
        return (sent);
    }
}
 
/*
    @brief Reads a specified number of bytes from the SerialWombatUART RX queue
    @param buffer  An array into which to put received bytes
    @param length  The maximum number of bytes to be received
    @return the number of bytes written to buffer
    
    This function will read bytes from the SerialWombatUART RX queue into buffer.
    If 'length' characters are not available to read then the value returned
    will be less than length.
    */
    size_t readBytes(char* buffer, size_t length)
{
    if (rxQueue.startIndex != 0xFFFF)
    {
        return (rxQueue.readBytes(buffer, length));
    }
    else
    {
        size_t bytesAvailable  = 1;
        size_t bytesReceived = 0;
        while (bytesAvailable && (bytesReceived < length))
        {
            uint8_t bytesRequested = 4;
            if (length - bytesReceived < 4)
            {
                bytesRequested = length - bytesReceived;
            }
            uint8_t tx[8] = { 202, _pin,_pinMode, bytesRequested, 0x55,0x55,0x55,0x55};
            uint8_t rx[8];
            _sw.sendPacket(tx, rx);
            if (rx[3] > 4)
            {
                rx[3] = 4;
            }
            for (int i = 0; i < rx[3]; ++i)
            {
                buffer[bytesReceived] = rx[4 + i];
                ++ bytesReceived;
            }
            bytesAvailable = rx[3];
            delay(0);
        }
        return (bytesReceived);
 
    }
 
}

    SerialWombatQueue rxQueue{ _sw };
    SerialWombatQueue txQueue{ _sw };
 
    uint8_t bytesToTransmit()
    {
        uint8_t tx[8] = { 203, _pin,_pinMode, 0x55, 0x55,0x55,0x55,0x55};
            uint8_t rx[8];
        if( _sw.sendPacket(tx, rx) >= 0)
{
        return(rx[6]);
}
return 0;
    }
private:
    using SerialWombatUART::begin;    //make parent class begin unavaialble
 
};