Skip to content

Update OTA API #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions source/amebapro2/API_Documents/OTA/Class OTA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Class OTA
==========

.. contents::
:local:
:depth: 2

**OTA Class**
-------------

**Description**
~~~~~~~~~~~~~~~

A class used for updating firmware Over the Air (OTA) in local area network.

**Syntax**
~~~~~~~~~~

.. code-block:: c++

class OTA

**Members**
~~~~~~~~~~~

+----------------------------------------------+--------------------------------------------+
| **Public Constructors** |
+==============================================+============================================+
| A public constructor should not be used as this class is intended to be a singleton class.|
| Access member functions using the object instance named OTA. |
+----------------------------------------------+--------------------------------------------+
| **Public Methods** |
+----------------------------------------------+--------------------------------------------+
| OTA::start_OTA_threads | To begin threading tasks for OTA |
| | firmware update. |
+----------------------------------------------+--------------------------------------------+

**OTA::start_OTA_threads**
--------------------------

**Description**
~~~~~~~~~~~~~~~

To begin threading tasks for OTA firmware update.

**Syntax**
~~~~~~~~~~

.. code-block:: c++

void start_OTA_threads(int port, char* server);

**Parameters**
~~~~~~~~~~~~~~

port: port number for the OTA HTTP server IP address

\*server: pointer for OTA HTTP server IP address

**Returns**
~~~~~~~~~~~

NA

**Example Code**
~~~~~~~~~~~~~~~~

Example: `OTA <https://github.com/Ameba-AIoT/ameba-arduino-pro2/blob/dev/Arduino_package/hardware/libraries/OTA/examples/OTA/OTA.ino>`_

.. note :: “OTA.h” must be included to use the function.
65 changes: 0 additions & 65 deletions source/amebapro2/API_Documents/OTA/Header OTA.rst

This file was deleted.

2 changes: 1 addition & 1 deletion source/amebapro2/API_Documents/OTA/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ OTA
.. toctree::
:maxdepth: 1

Header OTA
Class OTA
Loading