SerialWombatQueue.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 class SerialWombatQueueType {
    QUEUE_TYPE_RAM_BYTE = 0,  
    QUEUE_TYPE_RAM_BYTE_SHIFT = 1,  
};

 
 
class SerialWombatQueue : public Stream
{
public:
        */
    SerialWombatQueue(SerialWombatChip& serialWombat):_sw(serialWombat)
    {
        _sw = serialWombat;
    }

        */
    int16_t begin(uint16_t index, uint16_t length, SerialWombatQueueType qtype = SerialWombatQueueType::QUEUE_TYPE_RAM_BYTE)
{
    startIndex = index;
    length = length;
    uint8_t tx[] = {(uint8_t) SerialWombatCommands::COMMAND_BINARY_QUEUE_INITIALIZE ,SW_LE16(index),SW_LE16(length),(uint8_t)qtype, 0x55,0x55 };
    uint8_t rx[8];
    int16_t result =  _sw.sendPacket(tx,rx);
    if (result < 0)
    {
        return result;
    }
    else
    {
        return ((int16_t)(rx[3] + 256 * rx[4]));
    }
}

        */
    int available()
{
    uint8_t tx[] = {(uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_INFORMATION ,SW_LE16(startIndex),0x55,0x55,0x55,0x55,0x55 };
    uint8_t rx[8];
    int16_t sendResult =  _sw.sendPacket(tx,rx);
    if (sendResult >= 0)
    {
        return (rx[4] + 256 * rx[5]);
    }
    return (0);
}

    */
    int read()
{
    uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_READ_BYTES ,SW_LE16(startIndex),1,0x55,0x55,0x55,0x55 };
    uint8_t rx[8];
    int16_t sendResult = _sw.sendPacket(tx, rx);
    if (sendResult >= 0)
    {
        if (rx[1] == 1)
        return (rx[2]);
    }
    return (-1);
}

    */
    void flush()
{
    begin(startIndex, length);
}

    */
    int peek()
{
    uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_INFORMATION ,SW_LE16(startIndex),0x55,0x55,0x55,0x55,0x55 };
    uint8_t rx[8];
    int16_t sendResult = _sw.sendPacket(tx, rx);
    if (sendResult >= 0)
    {
        if ((rx[4] + 256 * rx[5]) > 0)
        {
            return(rx[3]);
        }
    }
    return (-1);
}

    */
   
    size_t write(uint8_t data)
{
    uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_ADD_BYTES ,SW_LE16(startIndex),1,data,0x55,0x55,0x55 };
    uint8_t rx[8];
    int16_t sendResult = _sw.sendPacket(tx, rx);
    if (sendResult >= 0)
    {
        
            return(rx[3]);
    }
    return (0);
}

    */
 
    size_t write(uint16_t data)
    {
        if (availableForWrite() < 2) return 0;
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_ADD_BYTES ,SW_LE16(startIndex),2,SW_LE16(data),0x55,0x55};
        uint8_t rx[8];
        int16_t sendResult = _sw.sendPacket(tx, rx);
        if (sendResult >= 0)
        {
 
            return(rx[3]);
        }
        return (0);
    }

    */
 
    size_t write(uint16_t buffer[], size_t size)
    {
        return (write((const uint8_t*)buffer, size * 2));
    }

    */
 
    size_t write(const uint16_t* buffer, size_t size)
    {
        return (write((const uint8_t*)buffer,size*2));
    }

    */
    size_t write(const uint8_t* buffer, size_t size)
{
    uint8_t nextWriteSize;
    uint16_t bytesWritten = 0;
    uint32_t startTime = millis();
 
    //Write up to the first 4 bytes
    if (size >= 4)
    {
        nextWriteSize = 4;
    }
    else
    {
        nextWriteSize = (uint8_t)size;
    }
    {
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_ADD_BYTES ,SW_LE16(startIndex),0,0x55,0x55,0x55,0x55 };
        uint8_t i;
        for (i = 0; i < nextWriteSize; ++i)
        {
            tx[4 + i] = buffer[i];
        }
        tx[3] = nextWriteSize;
        uint8_t rx[8];
        int16_t sendResult = _sw.sendPacket(tx, rx);
        if (sendResult < 0)
        {
            return(bytesWritten);
        }
        bytesWritten += rx[3];
    }
    while ((size - bytesWritten) >= 7)
    {
        yield();
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_ADD_7BYTES ,
            buffer[bytesWritten],
            buffer[bytesWritten + 1],
            buffer[bytesWritten + 2],
            buffer[bytesWritten + 3],
            buffer[bytesWritten + 4],
            buffer[bytesWritten + 5],
            buffer[bytesWritten + 6] };
 
        uint8_t rx[8];
        int16_t sendResult = _sw.sendPacket(tx, rx);
        if (sendResult < 0)
        {
            return(bytesWritten);
        }
        bytesWritten += rx[3];
        delay(0);
        if ((rx[3] == 0) && millis() >= startTime + _timeout) // Time out if couldn't write bytes and over timeout
        {
            return(bytesWritten);
        }
    }
 
    while (size - bytesWritten > 0)
    {
        yield();
        if (size - bytesWritten >= 4)
        {
            nextWriteSize = 4;
        }
        else
        {
            nextWriteSize = (uint8_t)(size - bytesWritten);
        }
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_ADD_BYTES ,SW_LE16(startIndex),0,0x55,0x55,0x55,0x55 };
        uint8_t i;
        for (i = 0; i < nextWriteSize; ++i)
        {
            tx[4 + i] = buffer[i + bytesWritten];
        }
        tx[3] = nextWriteSize;
        uint8_t rx[8];
        int16_t sendResult = _sw.sendPacket(tx, rx);
        if (sendResult < 0)
        {
            return(bytesWritten);
        }
        bytesWritten += rx[3];
        if ( (rx[3] == 0) && millis() >= startTime + _timeout)
        {
            return(bytesWritten);
        }
    }
    return (bytesWritten);
}

    */
    int availableForWrite()
{
    uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_INFORMATION ,SW_LE16(startIndex),0x55,0x55,0x55,0x55,0x55 };
    uint8_t rx[8];
    int16_t sendResult = _sw.sendPacket(tx, rx);
    if (sendResult >= 0)
    {
        return (rx[6] + 256 * rx[7]);
    }
    return (0);
}

    */
    size_t readBytes(char* buffer, size_t length)
{
    uint16_t bytesAvailable = 0;
    uint32_t startTime = millis();
 
    {
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_INFORMATION ,SW_LE16(startIndex),0x55,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        int16_t sendResult = _sw.sendPacket(tx, rx);
        if (sendResult >= 0)
        {
            bytesAvailable = (rx[4] + 256 * rx[5]);
        }
 
        if (bytesAvailable < length)
        {
            length = bytesAvailable;
        }
    }
    uint16_t bytesRead = 0;
    while (bytesRead < length)
    {
        yield();
        uint8_t bytesToRead =(uint8_t)( length - bytesRead);
        if (bytesToRead > 6)
        {
            bytesToRead = 6;
        }
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_READ_BYTES ,SW_LE16(startIndex),bytesToRead,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        int16_t sendResult = _sw.sendPacket(tx, rx);
        if (sendResult >= 0)
        {
            uint8_t i;
                for (i = 0; i < rx[1] && bytesRead < length; ++i)
                {
                    buffer[bytesRead] = rx[2 + i];
                    ++bytesRead;
                }
            
        }
        else
        {
            return (bytesRead);
        }
        if (millis() >= startTime + _timeout)
        {
            return(bytesRead);
        }
 
    }
    return bytesRead;
}
 
 
    uint16_t startIndex = 0xFFFF;
    uint16_t length = 0;
 
    void setTimeout(long timeout_mS)
{
    _timeout = timeout_mS;
}

   */
    size_t readUInt16(uint16_t* buffer, size_t length)
    {
        uint16_t bytesAvailable = 0;
    
            uint8_t tx[] = { (uint8_t)SerialWombatCommands::COMMAND_BINARY_QUEUE_INFORMATION ,SW_LE16(startIndex),0x55,0x55,0x55,0x55,0x55 };
            uint8_t rx[8];
            int16_t sendResult = _sw.sendPacket(tx, rx);
            if (sendResult >= 0)
            {
                bytesAvailable = (rx[4] + 256 * rx[5]);
            }
            uint16_t wordsAvailable = bytesAvailable /2;
            if (wordsAvailable < length)
            {
                length = wordsAvailable ;
            }
            return readBytes((char*)buffer, length * 2) / 2;
    }
 
    //TODO add copy interface
private:
    SerialWombatChip& _sw;
 
    
    uint32_t _timeout = 500;
};