TinyLightProtocol.h

Go to the documentation of this file.

/*
    Copyright 2017-2019,2022 (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.
*/

#ifndef _TINY_LIGHT_PROTOCOL_H_
#define _TINY_LIGHT_PROTOCOL_H_

#include "TinyPacket.h"
#include "proto/light/tiny_light.h"

#ifdef ARDUINO
#include <HardwareSerial.h>
#else
#include <string.h>
#endif

namespace tinyproto
{

class Light
{
public:
    inline Light()
        : m_data{}
    {
    }

    void begin(write_block_cb_t writecb, read_block_cb_t readcb);

#ifdef ARDUINO

    void beginToSerial();

#ifdef HAVE_HWSERIAL1

    inline void beginToSerial1()
    {
        begin([](void *p, const void *b, int s) -> int { return Serial1.write((const uint8_t *)b, s); },
              [](void *p, void *b, int s) -> int { return Serial1.readBytes((uint8_t *)b, s); });
    }
#endif

#ifdef HAVE_HWSERIAL2

    inline void beginToSerial2()
    {
        begin([](void *p, const void *b, int s) -> int { return Serial2.write((const uint8_t *)b, s); },
              [](void *p, void *b, int s) -> int { return Serial2.readBytes((uint8_t *)b, s); });
    }
#endif

#ifdef HAVE_SERIALUSB

    inline void beginToSerialUSB()
    {
        begin([](void *p, const void *b, int s) -> int { return SerialUSB.write((const char *)b, s); },
              [](void *p, void *b, int s) -> int { return SerialUSB.readBytes((char *)b, s); });
    }
#endif

#endif

    void end();

    int write(char *buf, int size);

    int read(char *buf, int size);

    int write(const IPacket &pkt);

    int read(IPacket &pkt);

    void disableCrc();

    void enableCrc(hdlc_crc_t crc);

    bool enableCheckSum();

    bool enableCrc16();

    bool enableCrc32();

private:
    STinyLightData m_data{};

    hdlc_crc_t m_crc = HDLC_CRC_DEFAULT;
};

} // namespace tinyproto

#endif