Skip to content

Commit

Permalink
docs(ReadTheDocs): Add full CRSF for Arduino API to api.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ZZ-Cat committed Aug 13, 2023
1 parent 38182b8 commit 4db10ec
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ API

This page is a work in progress.

Information regarding the API of CRSF for Arduino is coming soon.
Class Declaration
-----------------

.. class:: CRSFforArduino

Expand All @@ -20,3 +21,28 @@ Information regarding the API of CRSF for Arduino is coming soon.
| Constructor with pin numbers.
| :var:`RxPin` is the UART Rx pin that the Tx pin of your receiver is connected to.
| :var:`TxPin` is the UART Tx pin that the Rx pin of your receiver is connected to.
.. function:: CRSFforArduino::~CRSFforArduino()

Destructor.

Functions
---------

.. function:: bool CRSFforArduino::begin()

.. function:: void CRSFforArduino::end()

.. function:: void CRSFforArduino::update()

.. function:: uint16_t getChannel(uint8_t channel)

.. function:: telemetryWriteGPS(float latitude, float longitude, float altitude, float speed, float groundCourse, uint8_t satellites)

====================
Application Examples
====================

.. note::

Application Examples are coming soon.

0 comments on commit 4db10ec

Please sign in to comment.