SerialWombatQueuedPulseOutput.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2024 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 SerialWombatQueuedPulseOutput :  public SerialWombatPin 
{ 
    public: 
        SerialWombatQueuedPulseOutput(SerialWombatChip &serialWombatChip):SerialWombatPin(serialWombatChip){}

         */
        int16_t begin(uint8_t pin, bool initialState = 0, bool idleState = 0, bool unitsMs = 0,  uint16_t QueueIndex = 0xFFFF) 
        {
            _pin = pin;
            _pinMode = PIN_MODE_QUEUED_PULSE_OUTPUT;
            return (initPacketNoResponse(0,(uint8_t) initialState, idleState,unitsMs,SW_LE16(QueueIndex)));
        }

         */
        int16_t queuePulses(uint16_t firstPulse, uint16_t secondPulse = 0, bool emptyQueueFirst = false)
        {
            uint8_t tx[] =
            {
                (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE1,
                _pin,
                _pinMode,
                SW_LE16(firstPulse),
                SW_LE16(secondPulse),
                0x55
            };
            if (emptyQueueFirst)
            {
                tx[7] = 0x01;
            }
            uint8_t rx[8];
            int16_t result = _sw.sendPacket(tx, rx);
            if (result < 0)
            {
                return (result);
            }
            else
            {
                return (rx[3]);
            }
        }

         */
        int16_t pause(bool paused)
        {
            return (initPacketNoResponse(2,(uint8_t) paused));
        }
        
        int16_t queueEntriesFilled()
        {
            uint8_t tx[] =
            {
                (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE1,
                _pin,
                _pinMode,
                SW_LE16(0),
                SW_LE16(0),
                0x55
            };
            uint8_t rx[8];
            int16_t result = _sw.sendPacket(tx, rx);
            if (result < 0)
            {
                return (result);
            }
            else
            {
                return (rx[4]);
            }
        }
 
        int16_t queueEntriesFree()
        {
            uint8_t tx[] =
            {
                (uint8_t)SerialWombatCommands::CONFIGURE_PIN_MODE1,
                _pin,
                _pinMode,
                SW_LE16(0),
                SW_LE16(0),
                0x55
            };
            uint8_t rx[8];
            int16_t result = _sw.sendPacket(tx, rx);
            if (result < 0)
            {
                return (result);
            }
            else
            {
                return (rx[5]);
            }
        }
        
};