diff --git a/docs/source/api.rst b/docs/source/api.rst index 3c6aced3..110cb783 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -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 @@ -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.