SerialPort.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
 
#include "../Common/CompilerMacrosExport.h"
#ifndef SC_EXPORT_LIBRARY_SERIAL_PORT
#define SC_EXPORT_LIBRARY_SERIAL_PORT 0
#endif
#define SC_SERIAL_PORT_EXPORT SC_COMPILER_LIBRARY_EXPORT(SC_EXPORT_LIBRARY_SERIAL_PORT)
 
#include "../File/File.h"
#include "SerialPortError.h"
 
namespace SC
{
 
 
 
struct SC_SERIAL_PORT_EXPORT SerialSettings
{
    enum class DataBits : uint8_t
    {
        Bits5 = 5,
        Bits6 = 6,
        Bits7 = 7,
        Bits8 = 8,
    };
 
    enum class Parity : uint8_t
    {
        None = 0,
        Odd,
        Even,
    };
 
    enum class StopBits : uint8_t
    {
        One = 1,
        Two = 2,
    };
 
    enum class FlowControl : uint8_t
    {
        None = 0,
        Software,
        Hardware,
    };
 
    uint32_t    baudRate    = 9600;
    DataBits    dataBits    = DataBits::Bits8;
    Parity      parity      = Parity::None;
    StopBits    stopBits    = StopBits::One;
    FlowControl flowControl = FlowControl::None;
};
 
struct SC_SERIAL_PORT_EXPORT SerialOpenOptions
{
    bool blocking    = true;
    bool inheritable = false;
    bool exclusive   = false;
 
    SerialSettings settings;
};
 
struct SC_SERIAL_PORT_EXPORT SerialDescriptor : public FileDescriptor
{
    ResultSerialPort open(StringSpan path, const SerialOpenOptions& options = SerialOpenOptions());
 
    ResultSerialPort setSettings(const SerialSettings& settings);
 
    ResultSerialPort getSettings(SerialSettings& settings) const;
};
 
} // namespace SC