From 65ec1d635dbb597ee32bbfa806b1b773a6c943f6 Mon Sep 17 00:00:00 2001 From: wesley-santos Date: Thu, 16 May 2024 16:44:36 -0300 Subject: [PATCH] doc: generate updated doxygen documentation --- docs/ciot_8h_source.html | 2 +- docs/ciot__ble__scn_8h_source.html | 2 +- docs/ciot__bridge_8h_source.html | 2 +- docs/ciot__dfu_8h_source.html | 2 +- docs/ciot__eth_8h_source.html | 2 +- docs/ciot__gpio_8h_source.html | 2 +- docs/ciot__httpc_8h_source.html | 2 +- docs/ciot__https_8h_source.html | 2 +- docs/ciot__iface_8h.html | 4 +- docs/ciot__lib_8h_source.html | 112 +++++++++--------- docs/ciot__mqttc_8h_source.html | 2 +- docs/ciot__ntp_8h_source.html | 2 +- docs/ciot__opcuas_8h_source.html | 2 +- docs/ciot__ota_8h_source.html | 2 +- docs/ciot__s_8h_source.html | 2 +- docs/ciot__storage_8h_source.html | 2 +- docs/ciot__sys_8h_source.html | 2 +- docs/ciot__tcp_8h_source.html | 2 +- docs/ciot__uart_8h_source.html | 2 +- docs/ciot__usb_8h_source.html | 2 +- docs/ciot__wifi_8h_source.html | 2 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 2 +- docs/files.html | 2 +- docs/group__core.html | 8 +- 24 files changed, 80 insertions(+), 86 deletions(-) diff --git a/docs/ciot_8h_source.html b/docs/ciot_8h_source.html index 64ea172..0ab2378 100644 --- a/docs/ciot_8h_source.html +++ b/docs/ciot_8h_source.html @@ -184,7 +184,7 @@
ciot_bridge.h
Defines functions and types for CIOT Bridge module.
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_iface_event_handler_t
ciot_err_t ciot_iface_event_handler_t(ciot_iface_t *sender, ciot_iface_event_t *event, void *args)
Function pointer for handling interface events.
Definition ciot_iface.h:131
ciot_storage.h
Header file for CIOT Storage module.
ciot_storage_t
struct ciot_storage * ciot_storage_t
CIOT Storage instance pointer.
Definition ciot_storage.h:25
diff --git a/docs/ciot__ble__scn_8h_source.html b/docs/ciot__ble__scn_8h_source.html index b6758a2..8063d44 100644 --- a/docs/ciot__ble__scn_8h_source.html +++ b/docs/ciot__ble__scn_8h_source.html @@ -151,7 +151,7 @@
ciot_ble_scn_types.h
Defines data types and structures for CIOT BLE SCN.
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_ble_scn_adv_info_t
Structure for CIOT BLE SCN advertising information.
Definition ciot_ble_scn_types.h:55
ciot_ble_scn_cfg_t
Structure for CIOT BLE SCN configuration.
Definition ciot_ble_scn_types.h:42
ciot_ble_scn_req_t
Structure for CIOT BLE SCN request.
Definition ciot_ble_scn_types.h:81
diff --git a/docs/ciot__bridge_8h_source.html b/docs/ciot__bridge_8h_source.html index 6576462..54c639b 100644 --- a/docs/ciot__bridge_8h_source.html +++ b/docs/ciot__bridge_8h_source.html @@ -149,7 +149,7 @@
ciot_bridge_types.h
Defines data types and structures for CIOT bridge.
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_bridge_cfg_t
Structure for CIOT bridge configuration.
Definition ciot_bridge_types.h:42
ciot_bridge_req_t
Structure for CIOT bridge request.
Definition ciot_bridge_types.h:66
ciot_bridge_status_msg_t
Structure for CIOT Bridge status message.
Definition ciot_bridge.h:29
diff --git a/docs/ciot__dfu_8h_source.html b/docs/ciot__dfu_8h_source.html index 9121434..1e179e2 100644 --- a/docs/ciot__dfu_8h_source.html +++ b/docs/ciot__dfu_8h_source.html @@ -156,7 +156,7 @@
ciot_dfu_types.h
Defines data types and structures for CIOT DFU (Device Firmware Update).
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_dfu_cfg_t
Structure for CIOT DFU configuration.
Definition ciot_dfu_types.h:55
ciot_dfu_req_t
Structure for CIOT DFU request.
Definition ciot_dfu_types.h:83
diff --git a/docs/ciot__eth_8h_source.html b/docs/ciot__eth_8h_source.html index eb0699e..5268324 100644 --- a/docs/ciot__eth_8h_source.html +++ b/docs/ciot__eth_8h_source.html @@ -158,7 +158,7 @@
CIOT_ETH_EVENT_START
@ CIOT_ETH_EVENT_START
Definition ciot_eth.h:31
CIOT_ETH_EVENT_STOP
@ CIOT_ETH_EVENT_STOP
Definition ciot_eth.h:32
ciot_eth_stop
ciot_err_t ciot_eth_stop(ciot_eth_t self)
Stops the CIOT Ethernet interface.
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_tcp_types.h
Defines data types and structures for CIOT TCP functionality.
ciot_eth_status_msg_t
Structure representing the CIOT Ethernet status message.
Definition ciot_eth.h:40
diff --git a/docs/ciot__gpio_8h_source.html b/docs/ciot__gpio_8h_source.html index b83da5e..9c00cd8 100644 --- a/docs/ciot__gpio_8h_source.html +++ b/docs/ciot__gpio_8h_source.html @@ -152,7 +152,7 @@
ciot_gpio_new
ciot_gpio_t ciot_gpio_new(void *handle)
Creates a new CIOT GPIO interface instance.
ciot_gpio_types.h
Defines data types and structures for CIOT GPIO (General Purpose Input/Output).
ciot_gpio_state_t
ciot_gpio_state_t
Enumeration for CIOT GPIO states.
Definition ciot_gpio_types.h:24
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_gpio_cfg_t
Structure for CIOT GPIO configuration.
Definition ciot_gpio_types.h:65
ciot_gpio_req_t
Structure for CIOT GPIO request.
Definition ciot_gpio_types.h:110
ciot_gpio_status_msg_t
Structure representing the CIOT GPIO status message.
Definition ciot_gpio.h:30
diff --git a/docs/ciot__httpc_8h_source.html b/docs/ciot__httpc_8h_source.html index 6f8ede9..0f4d7f2 100644 --- a/docs/ciot__httpc_8h_source.html +++ b/docs/ciot__httpc_8h_source.html @@ -156,7 +156,7 @@
ciot_httpc_new
ciot_httpc_t ciot_httpc_new(void *handle)
Creates a new CIOT HTTP client interface instance.
ciot_httpc_process_req
ciot_err_t ciot_httpc_process_req(ciot_httpc_t self, ciot_httpc_req_t *req)
Processes a request for the CIOT HTTP client interface.
ciot_httpc_types.h
Defines data types and structures for CIOT HTTP client.
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_httpc_cfg_t
Structure for CIOT HTTP client configuration.
Definition ciot_httpc_types.h:97
ciot_httpc_req_t
Structure for CIOT HTTP client request.
Definition ciot_httpc_types.h:145
diff --git a/docs/ciot__https_8h_source.html b/docs/ciot__https_8h_source.html index ed59a50..3a81f77 100644 --- a/docs/ciot__https_8h_source.html +++ b/docs/ciot__https_8h_source.html @@ -154,7 +154,7 @@
ciot_https_send_data
ciot_err_t ciot_https_send_data(ciot_https_t self, uint8_t *data, int size)
Sends data over the CIOT HTTP server interface.
ciot_https_t
struct ciot_https * ciot_https_t
Structure representing the CIOT HTTP server interface.
Definition ciot_https.h:25
ciot_https_types.h
Defines data types and structures for CIOT HTTP server.
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_https_cfg_t
Structure for CIOT HTTP server configuration.
Definition ciot_https_types.h:51
ciot_https_req_t
Structure for CIOT HTTP server request.
Definition ciot_https_types.h:78
diff --git a/docs/ciot__iface_8h.html b/docs/ciot__iface_8h.html index 1e38a4c..f720d36 100644 --- a/docs/ciot__iface_8h.html +++ b/docs/ciot__iface_8h.html @@ -101,7 +101,7 @@
-

Header file for the CIOT interface. +

Header file for the common CIoT interface abstraction. More...

#include <stdbool.h>
#include "ciot_err.h"
@@ -253,7 +253,7 @@  

Detailed Description

-

Header file for the CIOT interface.

+

Header file for the common CIoT interface abstraction.

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.

Version
0.1
Date
2023-10-09
Author
Wesley Santos (wesle.nosp@m.ypro.nosp@m.37@gm.nosp@m.ail..nosp@m.com)
diff --git a/docs/ciot__lib_8h_source.html b/docs/ciot__lib_8h_source.html index 2c1afbf..81671f2 100644 --- a/docs/ciot__lib_8h_source.html +++ b/docs/ciot__lib_8h_source.html @@ -104,61 +104,61 @@
12#ifndef __CIOT_LIB__H__
13#define __CIOT_LIB__H__
14
-
24#include "ciot.h"
-
25#include "ciot_iface.h"
-
26#include "ciot_err.h"
-
27#include "ciot_log.h"
-
28
-
33#include "types/ciot_ble_types.h"
-
34#include "types/ciot_ble_scn_types.h"
-
35#include "types/ciot_tcp_types.h"
-
36#include "types/ciot_gpio_types.h"
-
37#include "types/ciot_tcp_types.h"
-
38#include "types/ciot_wifi_types.h"
-
39#include "types/ciot_storage_types.h"
-
40#include "types/ciot_uart_types.h"
-
41#include "types/ciot_usb_types.h"
-
42
-
47#include "ciot_ble.h"
-
48#include "ciot_ble_scn.h"
-
49#include "ciot_eth.h"
-
50#include "ciot_gpio.h"
-
51#include "ciot_tcp.h"
-
52#include "ciot_wifi.h"
-
53#include "ciot_storage.h"
-
54#include "ciot_uart.h"
-
55#include "ciot_usb.h"
-
56
-
61#include "types/ciot_bridge_types.h"
-
62#include "types/ciot_dfu_types.h"
-
63#include "types/ciot_httpc_types.h"
-
64#include "types/ciot_https_types.h"
-
65#include "types/ciot_mqttc_types.h"
-
66#include "types/ciot_ntp_types.h"
-
67#include "types/ciot_opcuas_types.h"
-
68#include "types/ciot_ota_types.h"
-
69#include "types/ciot_sys_types.h"
-
70
-
75#include "ciot_bridge.h"
-
76#include "ciot_dfu.h"
-
77#include "ciot_httpc.h"
-
78#include "ciot_https.h"
-
79#include "ciot_mqttc.h"
-
80#include "ciot_nrf_dfu.h"
-
81#include "ciot_ntp.h"
-
82#include "ciot_opcuas.h"
-
83#include "ciot_opcuas.h"
-
84#include "ciot_ota.h"
-
85#include "ciot_sys.h"
-
86
-
91#include "ciot_s.h"
-
92#include "ciot_serializer.h"
-
93#include "ciot_timer.h"
-
94#include "ciot_utils.h"
-
95
-
100#include "ciot_serializer_pb.h
-
101
-
102#endif
+
19#include "ciot.h"
+
20#include "ciot_iface.h"
+
21#include "ciot_err.h"
+
22#include "ciot_log.h"
+
23
+
28#include "types/ciot_ble_types.h"
+
29#include "types/ciot_ble_scn_types.h"
+
30#include "types/ciot_tcp_types.h"
+
31#include "types/ciot_gpio_types.h"
+
32#include "types/ciot_tcp_types.h"
+
33#include "types/ciot_wifi_types.h"
+
34#include "types/ciot_storage_types.h"
+
35#include "types/ciot_uart_types.h"
+
36#include "types/ciot_usb_types.h"
+
37
+
42#include "ciot_ble.h"
+
43#include "ciot_ble_scn.h"
+
44#include "ciot_eth.h"
+
45#include "ciot_gpio.h"
+
46#include "ciot_tcp.h"
+
47#include "ciot_wifi.h"
+
48#include "ciot_storage.h"
+
49#include "ciot_uart.h"
+
50#include "ciot_usb.h"
+
51
+
56#include "types/ciot_bridge_types.h"
+
57#include "types/ciot_dfu_types.h"
+
58#include "types/ciot_httpc_types.h"
+
59#include "types/ciot_https_types.h"
+
60#include "types/ciot_mqttc_types.h"
+
61#include "types/ciot_ntp_types.h"
+
62#include "types/ciot_opcuas_types.h"
+
63#include "types/ciot_ota_types.h"
+
64#include "types/ciot_sys_types.h"
+
65
+
70#include "ciot_bridge.h"
+
71#include "ciot_dfu.h"
+
72#include "ciot_httpc.h"
+
73#include "ciot_https.h"
+
74#include "ciot_mqttc.h"
+
75#include "ciot_nrf_dfu.h"
+
76#include "ciot_ntp.h"
+
77#include "ciot_opcuas.h"
+
78#include "ciot_opcuas.h"
+
79#include "ciot_ota.h"
+
80#include "ciot_sys.h"
+
81
+
86#include "ciot_s.h"
+
87#include "ciot_serializer.h"
+
88#include "ciot_timer.h"
+
89#include "ciot_utils.h"
+
90
+
95#include "ciot_serializer_pb.h
+
96
+
97#endif
ciot.h
Header file for the CIOT core instance.
ciot_ble.h
Defines functions and types for CIOT Bluetooth Low Energy (BLE) module.
ciot_ble_scn.h
Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner.
@@ -176,7 +176,7 @@
ciot_httpc_types.h
Defines data types and structures for CIOT HTTP client.
ciot_https.h
Header file for CIOT HTTP server interface.
ciot_https_types.h
Defines data types and structures for CIOT HTTP server.
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_log.h
Header file for CIOT logging functionality.
ciot_mqttc.h
Header file for CIOT MQTT client functionality.
ciot_mqttc_types.h
Defines data types and structures for CIOT MQTT client.
diff --git a/docs/ciot__mqttc_8h_source.html b/docs/ciot__mqttc_8h_source.html index 9ce9507..09ddebb 100644 --- a/docs/ciot__mqttc_8h_source.html +++ b/docs/ciot__mqttc_8h_source.html @@ -162,7 +162,7 @@
152#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_mqttc_get_topics
ciot_err_t ciot_mqttc_get_topics(ciot_mqttc_t self, ciot_mqttc_topics_cfg_t *topics)
Get the configured MQTT topics.
ciot_mqttc_t
struct ciot_mqttc * ciot_mqttc_t
Structure representing a CIOT MQTT client instance.
Definition ciot_mqttc.h:25
diff --git a/docs/ciot__ntp_8h_source.html b/docs/ciot__ntp_8h_source.html index 2b94e1a..4ee912c 100644 --- a/docs/ciot__ntp_8h_source.html +++ b/docs/ciot__ntp_8h_source.html @@ -141,7 +141,7 @@
92#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_ntp_send_data
ciot_err_t ciot_ntp_send_data(ciot_ntp_t self, uint8_t *data, int size)
Send data for CIOT NTP.
ciot_ntp_new
ciot_ntp_t ciot_ntp_new(void *handle)
Create a new CIOT NTP instance.
ciot_ntp_stop
ciot_err_t ciot_ntp_stop(ciot_ntp_t self)
Stop CIOT NTP.
diff --git a/docs/ciot__opcuas_8h_source.html b/docs/ciot__opcuas_8h_source.html index efc6980..880e2ac 100644 --- a/docs/ciot__opcuas_8h_source.html +++ b/docs/ciot__opcuas_8h_source.html @@ -141,7 +141,7 @@
96#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_opcuas_add_node
ciot_err_t ciot_opcuas_add_node(ciot_opcuas_t self, uint16_t type, char *localization, char *display_name, char *node_id)
Add a node to CIOT OPCUAS.
ciot_opcuas_process_req
ciot_err_t ciot_opcuas_process_req(ciot_opcuas_t self, ciot_opcuas_req_t *req)
Process OPCUAS request for CIOT OPCUAS.
ciot_opcuas_new
ciot_opcuas_t ciot_opcuas_new(void *handle)
Create a new CIOT OPCUAS instance.
diff --git a/docs/ciot__ota_8h_source.html b/docs/ciot__ota_8h_source.html index 5b92b54..68d854e 100644 --- a/docs/ciot__ota_8h_source.html +++ b/docs/ciot__ota_8h_source.html @@ -165,7 +165,7 @@
117#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_ota_new
ciot_ota_t ciot_ota_new(void *handle)
Create a new CIOT OTA instance.
ciot_ota_event_id
ciot_ota_event_id
Enumeration of CIOT OTA event IDs.
Definition ciot_ota.h:44
diff --git a/docs/ciot__s_8h_source.html b/docs/ciot__s_8h_source.html index 995e4f7..02f5780 100644 --- a/docs/ciot__s_8h_source.html +++ b/docs/ciot__s_8h_source.html @@ -166,7 +166,7 @@
118#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_s_send
ciot_err_t ciot_s_send(ciot_s_t self, uint8_t *data, int size)
Send data using CIOT_S.
ciot_s_status_t
enum ciot_s_status ciot_s_status_t
CIOT_S status.
ciot_s_set_bridge_mode
ciot_err_t ciot_s_set_bridge_mode(ciot_s_t self, bool mode)
Set bridge mode for CIOT_S.
diff --git a/docs/ciot__storage_8h_source.html b/docs/ciot__storage_8h_source.html index 77fc255..398396c 100644 --- a/docs/ciot__storage_8h_source.html +++ b/docs/ciot__storage_8h_source.html @@ -149,7 +149,7 @@
130#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_storage_init
ciot_err_t ciot_storage_init(void)
Initialize the CIOT Storage module.
ciot_storage_format
ciot_err_t ciot_storage_format(ciot_storage_t self)
Format the storage.
ciot_storage_delete
ciot_err_t ciot_storage_delete(ciot_storage_t self, char *path)
Delete data from storage.
diff --git a/docs/ciot__sys_8h_source.html b/docs/ciot__sys_8h_source.html index 8c1bf15..515e4b7 100644 --- a/docs/ciot__sys_8h_source.html +++ b/docs/ciot__sys_8h_source.html @@ -153,7 +153,7 @@
136#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_sys_t
struct ciot_sys * ciot_sys_t
CIOT System instance pointer.
Definition ciot_sys.h:30
ciot_sys_process_req
ciot_err_t ciot_sys_process_req(ciot_sys_t self, ciot_sys_req_t *req)
Process a system request.
ciot_sys_stop
ciot_err_t ciot_sys_stop(ciot_sys_t self)
Stop the CIOT System module.
diff --git a/docs/ciot__tcp_8h_source.html b/docs/ciot__tcp_8h_source.html index 0e1bbb5..7bddcfa 100644 --- a/docs/ciot__tcp_8h_source.html +++ b/docs/ciot__tcp_8h_source.html @@ -164,7 +164,7 @@
131#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
ciot_iface_event_handler_t
ciot_err_t ciot_iface_event_handler_t(ciot_iface_t *sender, ciot_iface_event_t *event, void *args)
Function pointer for handling interface events.
Definition ciot_iface.h:131
ciot_tcp_send_data
ciot_err_t ciot_tcp_send_data(ciot_tcp_t self, uint8_t *data, int size)
Send data using the CIOT TCP module.
ciot_tcp_type
ciot_tcp_type
Enumeration of CIOT TCP connection types.
Definition ciot_tcp.h:26
diff --git a/docs/ciot__uart_8h_source.html b/docs/ciot__uart_8h_source.html index c168b42..a2bde26 100644 --- a/docs/ciot__uart_8h_source.html +++ b/docs/ciot__uart_8h_source.html @@ -182,7 +182,7 @@
153#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_s.h
Header file for CIOT_S module.
ciot_s_t
struct ciot_s * ciot_s_t
CIOT_S private struct typedef.
Definition ciot_s.h:39
diff --git a/docs/ciot__usb_8h_source.html b/docs/ciot__usb_8h_source.html index 012c585..6a0a73a 100644 --- a/docs/ciot__usb_8h_source.html +++ b/docs/ciot__usb_8h_source.html @@ -178,7 +178,7 @@
145#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_usb_event_id_t
enum ciot_usb_event_id ciot_usb_event_id_t
Event ID enumeration for CIOT USB module.
ciot_usb_event_id
ciot_usb_event_id
Event ID enumeration for CIOT USB module.
Definition ciot_usb.h:33
diff --git a/docs/ciot__wifi_8h_source.html b/docs/ciot__wifi_8h_source.html index d4f4187..6110e22 100644 --- a/docs/ciot__wifi_8h_source.html +++ b/docs/ciot__wifi_8h_source.html @@ -164,7 +164,7 @@
130#endif
ciot_err.h
Header file for CIOT error handling.
ciot_err_t
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
ciot_iface.h
Header file for the CIOT interface.
+
ciot_iface.h
Header file for the common CIoT interface abstraction.
CIOT_IFACE_EVENT_CUSTOM
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_wifi_new
ciot_wifi_t ciot_wifi_new(void *handle)
Create a new CIOT Wi-Fi instance.
ciot_wifi_send_data
ciot_err_t ciot_wifi_send_data(ciot_wifi_t self, uint8_t *data, int size)
Send data over Wi-Fi.
diff --git a/docs/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html index 87d9111..7aba594 100644 --- a/docs/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/docs/dir_d44c64559bbebec7f509842c48db8b23.html @@ -145,7 +145,7 @@  Header file for CIOT HTTP server interface.
   ciot_iface.h - Header file for the CIOT interface.
+ Header file for the common CIoT interface abstraction.
   ciot_ifaces.h  Header file for CIOT interfaces.
diff --git a/docs/files.html b/docs/files.html index f7f660d..836ad18 100644 --- a/docs/files.html +++ b/docs/files.html @@ -133,7 +133,7 @@  ciot_gpio.hHeader file for CIOT GPIO interface  ciot_httpc.hHeader file for CIOT HTTP client interface  ciot_https.hHeader file for CIOT HTTP server interface - ciot_iface.hHeader file for the CIOT interface + ciot_iface.hHeader file for the common CIoT interface abstraction  ciot_ifaces.hHeader file for CIOT interfaces  ciot_lib.hCioT library header file  ciot_log.hHeader file for CIOT logging functionality diff --git a/docs/group__core.html b/docs/group__core.html index 4c03550..f35a109 100644 --- a/docs/group__core.html +++ b/docs/group__core.html @@ -110,7 +110,7 @@  Header file for CIOT error handling.
  file  ciot_iface.h - Header file for the CIOT interface.
+ Header file for the common CIoT interface abstraction.
  file  ciot_log.h  Header file for CIOT logging functionality.
@@ -118,12 +118,6 @@

Detailed Description

The core of CIoT library.

-

The CIoT core consists of three modules: