Added: some minute details that can go wrong

Witty-Wizard · Witty-Wizard · commit 517f40896d25 · 2025-04-18T19:04:07.000+05:30
diff --git a/Docs/source/fport.rst b/Docs/source/fport.rst
diff --git a/Docs/source/index.rst b/Docs/source/index.rst
@@ -2,18 +2,6 @@
    sphinx-quickstart on Sat Mar 29 19:38:49 2025.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-   :hidden:
-
-   installation
-   tutorial
-   example
-   contributing
-   sbus
-   fport
-   apidocumentation 
 
 SerialIO
 ======================
@@ -22,20 +10,16 @@ SerialIO
 
 SerialIO is a common library designed to simplify the implementation of RC protocol decoding in Arduino projects. It provides a modular and extensible architecture that allows for easy integration of various RC protocols.
 
-Supported Protocols
---------------------
-
-- `Futaba SBus protocol <sbus.html>`_
-- `Crossfire RC protocol <https://github.com/crsf-wg/crsf/wiki>`_
-- `Flysky IBus protocol <https://basejunction.wordpress.com/2015/08/23/en-flysky-i6-14-channels-part1/>`_
-- `FrSky F.Port <fport.html>`_
-
-Getting Started
-----------------
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
 
-- `Installation <installation.html>`_
-- `Tutorial <tutorial.html>`_
-- `Examples <example.html>`_
+   supportedprotocols
+   installation
+   tutorial
+   example
+   contributing
+   apidocumentation 
 
 License
 -------
diff --git a/Docs/source/installation.rst b/Docs/source/installation.rst
@@ -5,8 +5,9 @@ Installation
 
 Arduino Installation
 --------------------
+SerialIO is available on the Arduino library manager or,
 
-To use the SerialIO library in your Arduino projects, follow these installation steps:
+you can install it manually by downloading the library from the GitHub repository:
 
 1. Download the SerialIO library from the `GitHub repository <https://github.com/Witty-Wizard/SerialIO>`_.
 2. Extract the downloaded ZIP file.
@@ -17,7 +18,7 @@ To use the SerialIO library in your Arduino projects, follow these installation
 PlatformIO Installation
 -----------------------
 
-If you are using PlatformIO, you can install the SerialIO library directly from the PlatformIO Library Manager. Add the following line to your `platformio.ini` file:
+If you are using PlatformIO, you can install the SerialIO library directly from the PlatformIO Library Manager. Add the following line to your ``platformio.ini`` file:
 
 .. code-block:: ini
 
diff --git a/Docs/source/supportedprotocols.rst b/Docs/source/supportedprotocols.rst
@@ -1,3 +1,11 @@
+Supported Protocols
+####################
+
+- `Futaba SBus protocol <#futabasbus>`_
+- `Crossfire RC protocol <https://github.com/crsf-wg/crsf/wiki>`_
+- `Flysky IBus protocol <https://basejunction.wordpress.com/2015/08/23/en-flysky-i6-14-channels-part1/>`_
+- `FrSky F.Port <#frskyfport>`_
+
 .. _futabasbus:
 
 Futaba SBus
@@ -8,12 +16,6 @@ The Futaba S.Bus protocol was introduced around 2009. It was developed by Futaba
 .. image:: _static/sbus.png
    :width: 700cm
 
-Specifications
---------------
-
-- `Physical Layer`_
-- `Message Format`_
-
 .. _physical_sbus:
 
 Physical Layer
@@ -31,7 +33,7 @@ The configuration of the UART communication for SBus uses the following format:
 - **2 stop bits**: Following the data bits and the parity bit, there are 2 stop bits. Stop bits indicate the end of a data frame and provide timing for the receiving device to process the data.
 
 Inversion
-^^^^^^^^^
+^^^^^^^^^^^^^^^^^^
 
 For using SBus with a microcontroller, an inverter is typically required for the inverted UART logic level. This inversion is necessary because traditional UART operates with an active high level, while SBus uses inverted UART with an active low level.
 
@@ -60,4 +62,37 @@ The SBus protocol uses a specific message format for transmitting control data f
 
   These bits provide information about the status of channels 17 and 18, as well as indications of frame loss and failsafe activation.
 
-- **Byte[24]**: SBUS footer (0x00): The message concludes with a footer byte, marking the end of the S.Bus frame.
+- **Byte[24]**: SBUS footer (0x00): The message concludes with a footer byte, marking the end of the S.Bus frame.
+
+.. _frskyfport:
+
+FrSky F.Port
+============
+
+FrSky F.Port is a protocol developed by FrSky Electronic Co., Ltd., designed for communication between receivers and connected devices like servos or sensors. It is a one-line bus system that supports both control and data transmission, operating at a higher speed (115200 baud per second) compared to its predecessor, S.Port.
+
+.. _physical_fport:
+
+Physical Layer
+--------------
+
+The physical layer of the FrSky F.Port protocol utilizes UART (Universal Asynchronous Receiver-Transmitter) communication at a baud rate of 115200.
+
+UART Configuration
+^^^^^^^^^^^^^^^^^^
+
+The configuration of the UART communication for F.Port uses the following format:
+
+- **8 bits of data**: Each data frame consists of 8 bits, representing the information being transmitted.
+- **No parity**: It does not use a parity bit. Instead, it uses a checksum at the end of the whole packet for error detection.
+- **1 stop bit**: Following the data bits, there is 1 stop bit. Stop bits indicate the end of a data frame and provide timing for the receiving device to process the data.
+
+.. _format_fport:
+
+Message Format
+--------------
+
+For the data format and more details, refer to the official documentation at the following link:
+
+- `F.Port Protocol Specification (BetaFlight V2.1, 2017.11.21) <https://github.com/betaflight/betaflight/files/1491056/F.Port.protocol.betaFlight.V2.1.2017.11.21.pdf>`_
+
diff --git a/Docs/source/tutorial.rst b/Docs/source/tutorial.rst
@@ -1,7 +1,10 @@
 .. _tutorial:
 
 Tutorial
-========
+##########
+
+General usage
+==========================
 
 To use the library for decoding RC protocols in your Arduino project, follow these steps:
 
@@ -49,6 +52,61 @@ To instantiate a SerialIO object for receiving data only:
 
     receiver->getChannel(&channelData);
 
+Using software serial
+==========================
+If you are using a board that does not have hardware serial ports, you can use the SoftwareSerial library to create a software serial port.
+The SerialIO class can accept a SoftwareSerial object, but the begin method does not support software serial, so after creating the object, you need to 
+manually initiate the software serial port.
+
+.. note::
+
+    On AVR boards, only ibus, and fport protocols are supported (fport required an external inverter circuit), this is because sbus and crsf use unusual baudrate that are not supported by the hardware serial.
+    sbus can be used, by using a software serial library, but it is not recommended.
+
+Sbus
+^^^^^^
+
+.. code-block:: cpp
+
+    #include <SoftwareSerial.h>
+    #include <SerialIO.h>
+
+    #define pinRX 2
+    #define pinTX 3
+    #define SBUS_BAUDRATE 100000
+
+    /** SoftwareSerial(pinRX, pinTX, true);
+     *                               ^^^^
+     *                               set to true because sbus uses inverted uart
+     */
+
+    SoftwareSerial *mySerial = new SoftwareSerial(pinRX, pinTX, true); 
+    mySerial.begin(SBUS_BAUDRATE);
+    SerialIO *receiver = new sbus(mySerial); 
+
+Crossfire
+^^^^^^^^^
+
+.. note::
+
+    Crossfire uses a rather high baudrate of `420000`, which is not supported by hardware serial and for software serial, 
+    it is not recommended to use it, because the software serial library is not optimized for high baudrate. The following code
+    is not tested. Best alternative would be to use a better microcontroller or if you are using ELRS receivers, then reduce the 
+    baudrate to `115200`, which is supported by hardware and software serial.
+
+.. code-block:: cpp
+
+    #include <SoftwareSerial.h>
+    #include <SerialIO.h>
+
+    #define pinRX 2
+    #define pinTX 3
+    #define CRSF_BAUDRATE 100000
+
+    SoftwareSerial *mySerial = new SoftwareSerial(pinRX, pinTX); 
+    mySerial.begin(CRSF_BAUDRATE);
+    SerialIO *receiver = new crsf(mySerial); 
+
 See Also
 ^^^^^^^^
 - :cpp:class:`SerialIO`
diff --git a/README.md b/README.md
@@ -5,10 +5,18 @@
     <a href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img src="https://img.shields.io/github/license/Witty-Wizard/SerialIO" alt="GitHub License"></a>
 </p>
 
-# SerialIO Library
+# SerialIO
 
-A versatile Arduino library that provides support for decoding multiple RC protocols such as SBUS and CRSF.
+An arduino library for parsing almost any RC protocol.
 
-# Overview
+## Overview
 
 SerialIO is a common library designed to simplify the implementation of RC protocol decoding in Arduino projects. It provides a modular and extensible architecture that allows for easy integration of various RC protocols.
+
+## How to use?
+
+The examples and the tutorial are available on [this link](https://serialio.wittywizard.in)
+
+## Contributing to the library
+
+You see a bug or any feature that you require, please feel free to open an issue or if you have fixed the issue then please create a PR on github.
