Merge branch 'doc'

docs/ciot_8h_source.html

@@ -184,7 +184,7 @@
 <div class="ttc" id="aciot__bridge_8h_html"><div class="ttname"><a href="ciot__bridge_8h.html">ciot_bridge.h</a></div><div class="ttdoc">Defines functions and types for CIOT Bridge module.</div></div>
 <div class="ttc" id="aciot__err_8h_html"><div class="ttname"><a href="ciot__err_8h.html">ciot_err.h</a></div><div class="ttdoc">Header file for CIOT error handling.</div></div>
 <div class="ttc" id="aciot__err_8h_html_ad6378d4036e8a842176b2db8efb349c8"><div class="ttname"><a href="ciot__err_8h.html#ad6378d4036e8a842176b2db8efb349c8">ciot_err_t</a></div><div class="ttdeci">ciot_err_t</div><div class="ttdoc">Enumeration of CIOT error codes.</div><div class="ttdef"><b>Definition</b> ciot_err.h:71</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="aciot__iface_8h_html_aa95e39f8029362c17172c4ab860b9b2c"><div class="ttname"><a href="ciot__iface_8h.html#aa95e39f8029362c17172c4ab860b9b2c">ciot_iface_event_handler_t</a></div><div class="ttdeci">ciot_err_t ciot_iface_event_handler_t(ciot_iface_t *sender, ciot_iface_event_t *event, void *args)</div><div class="ttdoc">Function pointer for handling interface events.</div><div class="ttdef"><b>Definition</b> ciot_iface.h:131</div></div>
 <div class="ttc" id="aciot__storage_8h_html"><div class="ttname"><a href="ciot__storage_8h.html">ciot_storage.h</a></div><div class="ttdoc">Header file for CIOT Storage module.</div></div>
 <div class="ttc" id="aciot__storage_8h_html_abd15a0b08206e1aee533659f5c760024"><div class="ttname"><a href="ciot__storage_8h.html#abd15a0b08206e1aee533659f5c760024">ciot_storage_t</a></div><div class="ttdeci">struct ciot_storage * ciot_storage_t</div><div class="ttdoc">CIOT Storage instance pointer.</div><div class="ttdef"><b>Definition</b> ciot_storage.h:25</div></div>

docs/ciot__ble__scn_8h_source.html

@@ -151,7 +151,7 @@
 <div class="ttc" id="aciot__ble__scn__types_8h_html"><div class="ttname"><a href="ciot__ble__scn__types_8h.html">ciot_ble_scn_types.h</a></div><div class="ttdoc">Defines data types and structures for CIOT BLE SCN.</div></div>
 <div class="ttc" id="aciot__err_8h_html"><div class="ttname"><a href="ciot__err_8h.html">ciot_err.h</a></div><div class="ttdoc">Header file for CIOT error handling.</div></div>
 <div class="ttc" id="aciot__err_8h_html_ad6378d4036e8a842176b2db8efb349c8"><div class="ttname"><a href="ciot__err_8h.html#ad6378d4036e8a842176b2db8efb349c8">ciot_err_t</a></div><div class="ttdeci">ciot_err_t</div><div class="ttdoc">Enumeration of CIOT error codes.</div><div class="ttdef"><b>Definition</b> ciot_err.h:71</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="astructciot__ble__scn__adv__info__t_html"><div class="ttname"><a href="structciot__ble__scn__adv__info__t.html">ciot_ble_scn_adv_info_t</a></div><div class="ttdoc">Structure for CIOT BLE SCN advertising information.</div><div class="ttdef"><b>Definition</b> ciot_ble_scn_types.h:55</div></div>
 <div class="ttc" id="astructciot__ble__scn__cfg__t_html"><div class="ttname"><a href="structciot__ble__scn__cfg__t.html">ciot_ble_scn_cfg_t</a></div><div class="ttdoc">Structure for CIOT BLE SCN configuration.</div><div class="ttdef"><b>Definition</b> ciot_ble_scn_types.h:42</div></div>
 <div class="ttc" id="astructciot__ble__scn__req__t_html"><div class="ttname"><a href="structciot__ble__scn__req__t.html">ciot_ble_scn_req_t</a></div><div class="ttdoc">Structure for CIOT BLE SCN request.</div><div class="ttdef"><b>Definition</b> ciot_ble_scn_types.h:81</div></div>

docs/ciot__bridge_8h_source.html

@@ -149,7 +149,7 @@
 <div class="ttc" id="aciot__bridge__types_8h_html"><div class="ttname"><a href="ciot__bridge__types_8h.html">ciot_bridge_types.h</a></div><div class="ttdoc">Defines data types and structures for CIOT bridge.</div></div>
 <div class="ttc" id="aciot__err_8h_html"><div class="ttname"><a href="ciot__err_8h.html">ciot_err.h</a></div><div class="ttdoc">Header file for CIOT error handling.</div></div>
 <div class="ttc" id="aciot__err_8h_html_ad6378d4036e8a842176b2db8efb349c8"><div class="ttname"><a href="ciot__err_8h.html#ad6378d4036e8a842176b2db8efb349c8">ciot_err_t</a></div><div class="ttdeci">ciot_err_t</div><div class="ttdoc">Enumeration of CIOT error codes.</div><div class="ttdef"><b>Definition</b> ciot_err.h:71</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="astructciot__bridge__cfg__t_html"><div class="ttname"><a href="structciot__bridge__cfg__t.html">ciot_bridge_cfg_t</a></div><div class="ttdoc">Structure for CIOT bridge configuration.</div><div class="ttdef"><b>Definition</b> ciot_bridge_types.h:42</div></div>
 <div class="ttc" id="astructciot__bridge__req__t_html"><div class="ttname"><a href="structciot__bridge__req__t.html">ciot_bridge_req_t</a></div><div class="ttdoc">Structure for CIOT bridge request.</div><div class="ttdef"><b>Definition</b> ciot_bridge_types.h:66</div></div>
 <div class="ttc" id="astructciot__bridge__status__msg__t_html"><div class="ttname"><a href="structciot__bridge__status__msg__t.html">ciot_bridge_status_msg_t</a></div><div class="ttdoc">Structure for CIOT Bridge status message.</div><div class="ttdef"><b>Definition</b> ciot_bridge.h:29</div></div>

docs/ciot__dfu_8h_source.html

@@ -156,7 +156,7 @@
 <div class="ttc" id="aciot__dfu__types_8h_html"><div class="ttname"><a href="ciot__dfu__types_8h.html">ciot_dfu_types.h</a></div><div class="ttdoc">Defines data types and structures for CIOT DFU (Device Firmware Update).</div></div>
 <div class="ttc" id="aciot__err_8h_html"><div class="ttname"><a href="ciot__err_8h.html">ciot_err.h</a></div><div class="ttdoc">Header file for CIOT error handling.</div></div>
 <div class="ttc" id="aciot__err_8h_html_ad6378d4036e8a842176b2db8efb349c8"><div class="ttname"><a href="ciot__err_8h.html#ad6378d4036e8a842176b2db8efb349c8">ciot_err_t</a></div><div class="ttdeci">ciot_err_t</div><div class="ttdoc">Enumeration of CIOT error codes.</div><div class="ttdef"><b>Definition</b> ciot_err.h:71</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="aciot__iface_8h_html_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f"><div class="ttname"><a href="ciot__iface_8h.html#aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f">CIOT_IFACE_EVENT_CUSTOM</a></div><div class="ttdeci">@ CIOT_IFACE_EVENT_CUSTOM</div><div class="ttdef"><b>Definition</b> ciot_iface.h:50</div></div>
 <div class="ttc" id="astructciot__dfu__cfg__t_html"><div class="ttname"><a href="structciot__dfu__cfg__t.html">ciot_dfu_cfg_t</a></div><div class="ttdoc">Structure for CIOT DFU configuration.</div><div class="ttdef"><b>Definition</b> ciot_dfu_types.h:55</div></div>
 <div class="ttc" id="astructciot__dfu__req__t_html"><div class="ttname"><a href="structciot__dfu__req__t.html">ciot_dfu_req_t</a></div><div class="ttdoc">Structure for CIOT DFU request.</div><div class="ttdef"><b>Definition</b> ciot_dfu_types.h:83</div></div>

docs/ciot__eth_8h_source.html

@@ -158,7 +158,7 @@
 <div class="ttc" id="aciot__eth_8h_html_acba9cf62e11fb559248dff916f3ba556aeedce4004914b72cbf5464d1f8dc6620"><div class="ttname"><a href="ciot__eth_8h.html#acba9cf62e11fb559248dff916f3ba556aeedce4004914b72cbf5464d1f8dc6620">CIOT_ETH_EVENT_START</a></div><div class="ttdeci">@ CIOT_ETH_EVENT_START</div><div class="ttdef"><b>Definition</b> ciot_eth.h:31</div></div>
 <div class="ttc" id="aciot__eth_8h_html_acba9cf62e11fb559248dff916f3ba556af7a9e91956122dcb208686cf6f362f4a"><div class="ttname"><a href="ciot__eth_8h.html#acba9cf62e11fb559248dff916f3ba556af7a9e91956122dcb208686cf6f362f4a">CIOT_ETH_EVENT_STOP</a></div><div class="ttdeci">@ CIOT_ETH_EVENT_STOP</div><div class="ttdef"><b>Definition</b> ciot_eth.h:32</div></div>
 <div class="ttc" id="aciot__eth_8h_html_af2d6489aa9834dcaecce9c322fd1a96e"><div class="ttname"><a href="ciot__eth_8h.html#af2d6489aa9834dcaecce9c322fd1a96e">ciot_eth_stop</a></div><div class="ttdeci">ciot_err_t ciot_eth_stop(ciot_eth_t self)</div><div class="ttdoc">Stops the CIOT Ethernet interface.</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="aciot__iface_8h_html_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f"><div class="ttname"><a href="ciot__iface_8h.html#aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f">CIOT_IFACE_EVENT_CUSTOM</a></div><div class="ttdeci">@ CIOT_IFACE_EVENT_CUSTOM</div><div class="ttdef"><b>Definition</b> ciot_iface.h:50</div></div>
 <div class="ttc" id="aciot__tcp__types_8h_html"><div class="ttname"><a href="ciot__tcp__types_8h.html">ciot_tcp_types.h</a></div><div class="ttdoc">Defines data types and structures for CIOT TCP functionality.</div></div>
 <div class="ttc" id="astructciot__eth__status__msg__t_html"><div class="ttname"><a href="structciot__eth__status__msg__t.html">ciot_eth_status_msg_t</a></div><div class="ttdoc">Structure representing the CIOT Ethernet status message.</div><div class="ttdef"><b>Definition</b> ciot_eth.h:40</div></div>

docs/ciot__gpio_8h_source.html

@@ -152,7 +152,7 @@
 <div class="ttc" id="aciot__gpio_8h_html_aea01096d6b6bfbd522e8657a845f80c3"><div class="ttname"><a href="ciot__gpio_8h.html#aea01096d6b6bfbd522e8657a845f80c3">ciot_gpio_new</a></div><div class="ttdeci">ciot_gpio_t ciot_gpio_new(void *handle)</div><div class="ttdoc">Creates a new CIOT GPIO interface instance.</div></div>
 <div class="ttc" id="aciot__gpio__types_8h_html"><div class="ttname"><a href="ciot__gpio__types_8h.html">ciot_gpio_types.h</a></div><div class="ttdoc">Defines data types and structures for CIOT GPIO (General Purpose Input/Output).</div></div>
 <div class="ttc" id="aciot__gpio__types_8h_html_ac566dcf32b51c83a8f37164f23fc2cd9"><div class="ttname"><a href="ciot__gpio__types_8h.html#ac566dcf32b51c83a8f37164f23fc2cd9">ciot_gpio_state_t</a></div><div class="ttdeci">ciot_gpio_state_t</div><div class="ttdoc">Enumeration for CIOT GPIO states.</div><div class="ttdef"><b>Definition</b> ciot_gpio_types.h:24</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="astructciot__gpio__cfg__t_html"><div class="ttname"><a href="structciot__gpio__cfg__t.html">ciot_gpio_cfg_t</a></div><div class="ttdoc">Structure for CIOT GPIO configuration.</div><div class="ttdef"><b>Definition</b> ciot_gpio_types.h:65</div></div>
 <div class="ttc" id="astructciot__gpio__req__t_html"><div class="ttname"><a href="structciot__gpio__req__t.html">ciot_gpio_req_t</a></div><div class="ttdoc">Structure for CIOT GPIO request.</div><div class="ttdef"><b>Definition</b> ciot_gpio_types.h:110</div></div>
 <div class="ttc" id="astructciot__gpio__status__msg__t_html"><div class="ttname"><a href="structciot__gpio__status__msg__t.html">ciot_gpio_status_msg_t</a></div><div class="ttdoc">Structure representing the CIOT GPIO status message.</div><div class="ttdef"><b>Definition</b> ciot_gpio.h:30</div></div>

docs/ciot__httpc_8h_source.html

@@ -156,7 +156,7 @@
 <div class="ttc" id="aciot__httpc_8h_html_aa56416d08a9bcfbc90b3732204f02e4c"><div class="ttname"><a href="ciot__httpc_8h.html#aa56416d08a9bcfbc90b3732204f02e4c">ciot_httpc_new</a></div><div class="ttdeci">ciot_httpc_t ciot_httpc_new(void *handle)</div><div class="ttdoc">Creates a new CIOT HTTP client interface instance.</div></div>
 <div class="ttc" id="aciot__httpc_8h_html_aeb4ac97854627dc732459e7c0b60a900"><div class="ttname"><a href="ciot__httpc_8h.html#aeb4ac97854627dc732459e7c0b60a900">ciot_httpc_process_req</a></div><div class="ttdeci">ciot_err_t ciot_httpc_process_req(ciot_httpc_t self, ciot_httpc_req_t *req)</div><div class="ttdoc">Processes a request for the CIOT HTTP client interface.</div></div>
 <div class="ttc" id="aciot__httpc__types_8h_html"><div class="ttname"><a href="ciot__httpc__types_8h.html">ciot_httpc_types.h</a></div><div class="ttdoc">Defines data types and structures for CIOT HTTP client.</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="aciot__iface_8h_html_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f"><div class="ttname"><a href="ciot__iface_8h.html#aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f">CIOT_IFACE_EVENT_CUSTOM</a></div><div class="ttdeci">@ CIOT_IFACE_EVENT_CUSTOM</div><div class="ttdef"><b>Definition</b> ciot_iface.h:50</div></div>
 <div class="ttc" id="astructciot__httpc__cfg__t_html"><div class="ttname"><a href="structciot__httpc__cfg__t.html">ciot_httpc_cfg_t</a></div><div class="ttdoc">Structure for CIOT HTTP client configuration.</div><div class="ttdef"><b>Definition</b> ciot_httpc_types.h:97</div></div>
 <div class="ttc" id="astructciot__httpc__req__t_html"><div class="ttname"><a href="structciot__httpc__req__t.html">ciot_httpc_req_t</a></div><div class="ttdoc">Structure for CIOT HTTP client request.</div><div class="ttdef"><b>Definition</b> ciot_httpc_types.h:145</div></div>

docs/ciot__https_8h_source.html

@@ -154,7 +154,7 @@
 <div class="ttc" id="aciot__https_8h_html_ab9abc9d142e7332b9606568193d1ede0"><div class="ttname"><a href="ciot__https_8h.html#ab9abc9d142e7332b9606568193d1ede0">ciot_https_send_data</a></div><div class="ttdeci">ciot_err_t ciot_https_send_data(ciot_https_t self, uint8_t *data, int size)</div><div class="ttdoc">Sends data over the CIOT HTTP server interface.</div></div>
 <div class="ttc" id="aciot__https_8h_html_acfd2fcf5803562e750dea3815e1cbd49"><div class="ttname"><a href="ciot__https_8h.html#acfd2fcf5803562e750dea3815e1cbd49">ciot_https_t</a></div><div class="ttdeci">struct ciot_https * ciot_https_t</div><div class="ttdoc">Structure representing the CIOT HTTP server interface.</div><div class="ttdef"><b>Definition</b> ciot_https.h:25</div></div>
 <div class="ttc" id="aciot__https__types_8h_html"><div class="ttname"><a href="ciot__https__types_8h.html">ciot_https_types.h</a></div><div class="ttdoc">Defines data types and structures for CIOT HTTP server.</div></div>
-<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the CIOT interface.</div></div>
+<div class="ttc" id="aciot__iface_8h_html"><div class="ttname"><a href="ciot__iface_8h.html">ciot_iface.h</a></div><div class="ttdoc">Header file for the common CIoT interface abstraction.</div></div>
 <div class="ttc" id="aciot__iface_8h_html_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f"><div class="ttname"><a href="ciot__iface_8h.html#aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f">CIOT_IFACE_EVENT_CUSTOM</a></div><div class="ttdeci">@ CIOT_IFACE_EVENT_CUSTOM</div><div class="ttdef"><b>Definition</b> ciot_iface.h:50</div></div>
 <div class="ttc" id="astructciot__https__cfg__t_html"><div class="ttname"><a href="structciot__https__cfg__t.html">ciot_https_cfg_t</a></div><div class="ttdoc">Structure for CIOT HTTP server configuration.</div><div class="ttdef"><b>Definition</b> ciot_https_types.h:51</div></div>
 <div class="ttc" id="astructciot__https__req__t_html"><div class="ttname"><a href="structciot__https__req__t.html">ciot_https_req_t</a></div><div class="ttdoc">Structure for CIOT HTTP server request.</div><div class="ttdef"><b>Definition</b> ciot_https_types.h:78</div></div>

docs/ciot__iface_8h.html

@@ -101,7 +101,7 @@
 </div><!--header-->
 <div class="contents">
 
-<p>Header file for the CIOT interface.  
+<p>Header file for the common CIoT interface abstraction.  
 <a href="#details">More...</a></p>
 <div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br />
 <code>#include &quot;<a class="el" href="ciot__err_8h_source.html">ciot_err.h</a>&quot;</code><br />
@@ -253,7 +253,7 @@
 <tr class="separator:aa3ff9b2090848d0920e0a69de86f6250"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Header file for the CIOT interface. </p>
+<div class="textblock"><p>Header file for the common CIoT interface abstraction. </p>
 <p>An CIoT interface is an common abstraction that must be implemented by any resource which is desired to be managed by CIoT core. To create an new CIoT interface implementation, an ciot_iface_t instance type must be initialized. So the CIoT core can use the instance to automate the interface behavior like start/stop or process an external request. When an new interface is implemented, some rules must be follwed to warrant that the CIoT core will work properly. All standard CIoT interfaces follow these rules, and each of them can be used as an model or an example able to guide how to create an new interface implementation. </p><dl class="section version"><dt>Version</dt><dd>0.1 </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2023-10-09 </dd></dl>
 <dl class="section author"><dt>Author</dt><dd>Wesley Santos (<a href="#" onclick="location.href='mai'+'lto:'+'wes'+'le'+'ypr'+'o3'+'7@g'+'ma'+'il.'+'co'+'m'; return false;">wesle<span class="obfuscator">.nosp@m.</span>ypro<span class="obfuscator">.nosp@m.</span>37@gm<span class="obfuscator">.nosp@m.</span>ail.<span class="obfuscator">.nosp@m.</span>com</a>) </dd></dl>