SerialWombatThroughputConsumer.h

Go to the documentation of this file.

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

class SerialWombatThroughputConsumer: public SerialWombatPin
{
public:
    SerialWombatThroughputConsumer(SerialWombatChip& serialWombat):SerialWombatPin(serialWombat){}
 
    /*
    @brief Initialize an instance of the Throughput Conumer class.  All delays are set to 0.
    @return Returns a negative error code if initialization failed.
    */
    int16_t begin(uint8_t pin)
    {
        _pin = pin;
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE0,pin,
                        (uint8_t)PIN_MODE_THROUGHPUT_CONSUMER,
                        0x55,0x55,0x55,0x55,0x55 };
        return _sw.sendPacket(tx);
    }
 

    */
    int16_t writeAll(uint16_t delay)
    {
        for (int i = 0; i < 16; ++i)
        {
            uint8_t tx[] = {(uint8_t) SerialWombatCommands::CONFIGURE_PIN_MODE1,
                            _pin,
                            (uint8_t) PIN_MODE_THROUGHPUT_CONSUMER ,
                            (uint8_t)i,
                            SW_LE16(delay), 0x55,0x55 };
            int16_t result = _sw.sendPacket(tx);
            if (result < 0)
            {
                return (result);
            }
        }
        return 0;
    }

    int16_t write(uint8_t frame, uint16_t delay)
    {
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE1,
                            _pin,
                            (uint8_t)PIN_MODE_THROUGHPUT_CONSUMER ,
                            frame,
                            SW_LE16(delay), 0x55,0x55 };
        return( _sw.sendPacket(tx));
    }
 

    int16_t delayInCommProcessing(uint16_t delay)
    {
        uint8_t tx[] = { (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE2,
                            _pin,
                            (uint8_t)PIN_MODE_THROUGHPUT_CONSUMER ,
                            SW_LE16(delay), 0x55,0x55, 0x55 };
        return(_sw.sendPacket(tx));
    }
 
};