ISerial.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * 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.
 */

#ifndef ISERIAL_H_
#define ISERIAL_H_

#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

namespace ClearCore {
class ISerial {
public:

    typedef enum _Parities {
        PARITY_E = 0,
        PARITY_O,
        PARITY_N,
    } Parities;

    virtual void Flush() = 0;
    virtual void FlushInput() = 0;

    virtual void PortOpen() = 0;

    virtual void PortClose() = 0;

    virtual bool Speed(uint32_t bitsPerSecond) = 0;

    virtual uint32_t Speed() = 0;

    virtual int16_t CharGet() = 0;

    virtual int16_t CharPeek() = 0;

    virtual bool SendChar(uint8_t charToSend) = 0;

    bool SendLine() {
        return SendChar('\r') && SendChar('\n');
    }

    bool Send(const char *buffer, size_t bufferSize) {
        for (size_t iChar = 0; iChar < bufferSize; iChar++) {
            if (!SendChar(buffer[iChar])) {
                return false;
            }
        }
        return true;
    }

    bool SendLine(const char *buffer, size_t bufferSize) {
        return Send(buffer, bufferSize) && SendLine();
    }

    bool Send(const char *nullTermStr) {
        return Send(nullTermStr, strlen(nullTermStr));
    }

    bool SendLine(const char *nullTermStr) {
        return Send(nullTermStr) && SendLine();
    }

    bool Send(char theChar) {
        return SendChar(theChar);
    }

    bool SendLine(char theChar) {
        return Send(theChar) && SendLine();
    }

    bool Send(double number, uint8_t precision = 2) {
        char buffer[20];
        snprintf(buffer, sizeof(buffer), "%.*f", precision, number);
        return Send(buffer);
    }

    bool SendLine(double number, uint8_t precision = 2) {
        return Send(number, precision) && SendLine();
    }

    bool Send(int8_t number, uint8_t radix = 10) {
        return Send(static_cast<int32_t>(number), radix);
    }

    bool SendLine(int8_t number, uint8_t radix = 10) {
        return SendLine(static_cast<int32_t>(number), radix);
    }

    bool Send(uint8_t number, uint8_t radix = 10) {
        return Send(static_cast<uint32_t>(number), radix);
    }

    bool SendLine(uint8_t number, uint8_t radix = 10) {
        return SendLine(static_cast<uint32_t>(number), radix);
    }

    bool Send(int16_t number, uint8_t radix = 10) {
        return Send(static_cast<int32_t>(number), radix);
    }

    bool SendLine(int16_t number, uint8_t radix = 10) {
        return SendLine(static_cast<int32_t>(number), radix);
    }

    bool Send(uint16_t number, uint8_t radix = 10) {
        return Send(static_cast<uint32_t>(number), radix);
    }

    bool SendLine(uint16_t number, uint8_t radix = 10) {
        return SendLine(static_cast<uint32_t>(number), radix);
    }

    bool Send(int32_t number, uint8_t radix = 10) {
        if (radix < 2 || radix > 16) {
            // Only support bases 2 through 16.
            return false;
        }
        char strRep[2 + 8 * sizeof(number)];
        itoa(number, strRep, radix);
        Send((const char *)strRep);
        return true;
    }

    bool SendLine(int32_t number, uint8_t radix = 10) {
        return Send(number, radix) && SendLine();
    }

    bool Send(uint32_t number, uint8_t radix = 10) {
        if (radix < 2 || radix > 16) {
            // Only support bases 2 through 16.
            return false;
        }
        char strRep[1 + 8 * sizeof(number)];
        utoa(number, strRep, radix);
        Send((const char *)strRep);
        return true;
    }

    bool SendLine(uint32_t number, uint8_t radix = 10) {
        return Send(number, radix) && SendLine();
    }

    bool Send(int number, uint8_t radix = 10) {
        return Send(static_cast<int32_t>(number), radix);
    }

    bool SendLine(int number, uint8_t radix = 10) {
        return SendLine(static_cast<int32_t>(number), radix);
    }

    virtual int32_t AvailableForRead() = 0;

    virtual int32_t AvailableForWrite() = 0;

    virtual void WaitForTransmitIdle() = 0;

    virtual bool PortIsOpen() = 0;

    virtual operator bool() = 0;

    virtual bool Parity(Parities newParity) = 0;

    virtual Parities Parity() = 0;

    virtual bool StopBits(uint8_t bits) = 0;

    virtual bool CharSize(uint8_t size) = 0;

};

} // ClearCore namespace

#endif /* ISERIAL_H_ */