Repository files navigation

• Introduction
• Key Features
• Supported platforms
• Easy to use
  • Cpp
  • Python
• Setting up
• How to buid
• Using tiny_loopback tool
• License

Tiny Protocol isLAYER 2 protocol. It is intended to be used for the systems with low resources.It is also can be compiled for desktop Linux system, and it can be built for Windows.Using this library you can easy implement data transfer between 2 microcontrollers or between microcontroller and pc via UART, SPI,I2C or any other communication channels.You don't need to think about data synchronization between points. The library use no dynamic allocation of memory.

TinyProto is based on RFC 1662. Tiny Protocol supports 2 HDLC modes: ABM (for peer to peer connections) and NRM (formulti-drop connections).

Tiny Protocol is NOT an application layer protocol, although, for example, it can be used with Protocol Buffers. The protocol supports ABM and NRM modes.

Main features:

• Hot plug/unplug support for ABM (peer to peer).
• Connection autorecover for Full duplex (both for ABM and NRM modes) and Light protocols (with enabled crc)
• Error detection: Simple 8-bit checksum (sum of bytes), FCS16 (CCITT-16), FCS32 (CCITT-32)
• Platform independent hdlc framing implementation (hdlc low level API: hdlc_ll_xxxx)
• Easy to use Light protcol - analogue of a SLIP protcol (tiny_light_xxxx API, see examples)
• Full-duplex protocol (tiny_fd_xxxx true RFC 1662 implementation, supports confirmation, frames retransmissions: ABM and NRM modes )
• one to one and one to many modes
• Frames of maximum 32K or 2G size (payload limit depends on platfrom).
• Low SRAM consumption (starts at 60 bytes).
• Low Flash consumption (starts at 1.2KiB, features can be disabled and enabled at compilation time)
• No dynamic memory allocation!
• Special serial loopback tool for debug purposes and performance testing (ABM mode only)

• Any platform, where C/C++ compiler is available (C99, C++11)

That's not a problem. Just implement abstraction layer for your platform (timing and mutex functions). Pleasego through the steps below:

• add TINY_CUSTOM_PLATFORM define to your compilation flags.
• Implement HAL functions and calltiny_hal_init() to pass your platform functions to the library
• add CONFIG_TINYHAL_THREAD_SUPPORT define to your compilation flags if your platform supports standard c++ thread library

Refer totiny_hal_init() function. To understand HAL implementation refer toLinux andESP32 examples inHAL abstraction layer.You may use template codeplatform_hal.c

Usage of light Tiny Protocol in C++ can look like this:

#include"tinyproto.h"tinyproto::Light  proto;tinyproto::Packet<256> packet;voidsetup() {    ...    proto.beginToSerial();}voidloop() {if (Serial.available()) {int len = proto.read( packet );if (len >0) {/* Send message back*/            proto.write( packet );        }    }}

Example of using full duplex Tiny Protocol in C++ is a little bit bigger, but it is still simple:

#include"tinyproto.h"tinyproto::Fd<FD_MIN_BUF_SIZE(64,4)>  proto;voidonReceive(void *udata, tinyproto::IPacket &pkt) {// Process message here, you can do with the message, what you need// Let's send it back to the sender ;)if ( proto.write(pkt) == TINY_ERR_TIMEOUT ) {// Do what you need to do if looping back failed on timeout.// But never use blocking operations inside callback    }}voidsetup() {    ...// Here we say FD protocol object, which callback to call once new msg is received    proto.setReceiveCallback( onReceive );    proto.begin();}voidloop() {if (Serial.available()) {uint8_t byte = Serial.read();        proto.run_rx( &byte,1 );// run FD protocol parser to process data received from the channel    }uint8_t byte;if ( proto.run_tx( &byte,1 ) ==1 )// FD protocol fills buffer with data, we need to send to the channel    {while ( Serial.write( byte ) ==0 );// Just send the data    }}

importtinyprotop=tinyproto.Hdlc()defon_read(a):print("Received bytes: "+','.join( ["{:#x}".format(x)forxina ] ) )# setup protocolp.on_read=on_readp.begin()# provide rx bytes to the protocol, obtained from hardware rx channelp.rx(bytearray([0x7E,0xFF,0x3F,0xF3,0x39,0x7E  ]) )

make# === OR ===mkdir buildcd buildcmake -DEXAMPLES=ON ..make

mkdir buildcd buildcmake -G "Visual Studio 16 2019" -DEXAMPLES=ON ..

Just place the library to your project components folder.

• Arduino Option 1 (with docs and tools)

  • Download source fromhttps://github.com/lexus2k/tinyproto
  • Put the downloaded library content to Arduino/libraries/tinyproto folder
  • Restart the Arduino IDE
  • You will find the examples in the Arduino IDE under File->Examples->tinyproto

• Arduino Option 2 (only library without docs)

  • Go to Arduino Library manager
  • Find and install tinyproto library
  • Restart the Arduino IDE
  • You will find the examples in the Arduino IDE under File->Examples->tinyproto

• ESP32 IDF

  • Download sources fromhttps://github.com/lexus2k/tinyproto and put to componentsfolder of your project
  • Runmake for your project

• Linux

  • Download sources fromhttps://github.com/lexus2k/tinyproto
  • Runmake command from tinyproto folder, and it will build library and tools for you

• Plain AVR

  • Download sources fromhttps://github.com/lexus2k/tinyproto
  • Install avr gcc compilers
  • Runmake ARCH=avr

• Python

  • Download sources fromhttps://github.com/lexus2k/tinyproto
  • Runpython setup.py install

• Connect your Arduino board to PC

• Run your sketch or tinylight_loopback

• Compile tiny_loopback tool

• Run tiny_loopback tool:./bld/tiny_loopback -p /dev/ttyUSB0 -t light -g -c 8 -a -r

• Connect your Arduino board to PC

• Run your sketch or tinyfd_loopback

• Compile tiny_loopback tool

• Run tiny_loopback tool:./bld/tiny_loopback -p /dev/ttyUSB0 -t fd -c 8 -w 3 -g -a -r

For more information about this library, please, visithttps://github.com/lexus2k/tinyproto.Doxygen documentation can be found atCodedocs xyz site.If you found any problem or have any idea, please, report to Issues section.If you find the library useful and want tosupport future development, you may contact me.

Paypal	Bitcoin	Etherium
Not available	3CtUY6Ag2zsvm1JyqeeKeK8kjdG7Tnjr5W	0x20608A71470Bc84a3232621819f578Fb9C02A460

The project is released under dual license: GPLv3, or Commercial license.

Copyright 2016-2024 (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 modifyit under the terms of the GNU Lesser General Public License as published bythe 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 ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public Licensealong with Protocol Library. If not, seehttp://www.gnu.org/licenses/.

Commercial License Usage

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