tiny_serial.h

Go to the documentation of this file.

/*
    Copyright 2017-2025 (C) Alexey Dynda

    This file is part of Tiny Protocol Library.

    GNU General Public License Usage

    Protocol Library is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Protocol Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Protocol Library.  If not, see <http://www.gnu.org/licenses/>.

    Commercial License Usage

    Licensees holding valid commercial Tiny Protocol licenses may use this file in
    accordance with the commercial license agreement provided in accordance with
    the terms contained in a written agreement between you and Alexey Dynda.
    For further information contact via email on github account.
*/

#pragma once

#ifdef __cplusplus

extern "C"
{
#endif

#include <stdint.h>
#if defined(ARDUINO) || defined(__AVR__)
#include "arduino/arduino_serial.h"
#elif defined(__linux__)
#include "linux/linux_serial.h"
#elif defined(__APPLE__) && defined(__MACH__)
#include "macos/macos_serial.h"
#elif defined(_WIN32)
#include "win32/win32_serial.h"
#elif defined(__XTENSA__)
#include "esp32/esp32_serial.h"
#else
#include "no_platform/noplatform_serial.h"
#endif

    extern tiny_serial_handle_t tiny_serial_open(const char *name, uint32_t baud);

    extern void tiny_serial_close(tiny_serial_handle_t port);

    extern int tiny_serial_send(tiny_serial_handle_t port, const void *buf, int len);

    extern int tiny_serial_send_timeout(tiny_serial_handle_t port, const void *buf, int len, uint32_t timeout_ms);

    extern int tiny_serial_read(tiny_serial_handle_t port, void *buf, int len);

    extern int tiny_serial_read_timeout(tiny_serial_handle_t port, void *buf, int len, uint32_t timeout_ms);

#ifdef __cplusplus
}
#endif