localhorst/ESP32-Mesh-OTA
1
0
Fork 0
Code Issues Pull Requests Releases Activity

added all doxygen comments

Browse Source
This commit is contained in:
Hendrik Schutter
2021-01-21 11:11:37 +01:00
parent f3749b9985
commit 7fe1f18985
11 changed files with 406 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
components/mesh_ota/include/Mesh_Network.h
View File

@ -1,3 +1,12 @@
/**
* @file Mesh_Network.h
* @brief Mesh network layer used by OTA and APP
* @author Hendrik Schutter, init based in ESP32-IDE code
* @date 20.01.2021
*
* Additional Infos: Start network and send and receive data.
*/
#ifndef H_MESH_NETWORK
#define H_MESH_NETWORK

7
components/mesh_ota/include/Mesh_OTA.h
View File

@ -1,3 +1,10 @@
/**
* @file Mesh_OTA.h
* @brief Start and implement OTA updates via HTTPS from server and other mesh nodes (bidirectional)
* @author Hendrik Schutter
* @date 21.01.2021
*/
#ifndef H_MESH_OTA
#define H_MESH_OTA

8
components/mesh_ota/include/Mesh_OTA_Globals.h
View File

@ -1,3 +1,11 @@
/**
* @file Mesh_OTA_Globals.h
* @brief global variables unsed in Mesh_OTA
* @author Hendrik Schutter
* @date 21.01.2021
*
*/
#ifndef H_MESH_OTA_GLOBALS
#define H_MESH_OTA_GLOBALS

10
components/mesh_ota/include/Mesh_OTA_Partition_Access.h
View File

@ -1,3 +1,13 @@
/**
* @file Mesh_OTA_Partition_Access.h
* @brief Write and read partition if requested from Mesh_OTA
* @author Hendrik Schutter
* @date 21.01.2021
*
* Additional Infos: Write image via HTTPS
* Receive or transmit via Mesh
*/
#ifndef H_MESH_OTA_PARTITION_ACCESS
#define H_MESH_OTA_PARTITION_ACCESS

7
components/mesh_ota/include/Mesh_OTA_Util.h
View File

@ -1,3 +1,10 @@
/**
* @file Mesh_OTA_Util.h
* @brief Utility and helper functions to perfrom mesh OTA updates
* @author Hendrik Schutter
* @date 21.01.2021
*/
#ifndef H_MESH_OTA_UTIL
#define H_MESH_OTA_UTIL