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__
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
100#include "ciot_serializer_pb.h
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
95#include "ciot_serializer_pb.h
+
+
Header file for the CIOT core instance.
Defines functions and types for CIOT Bluetooth Low Energy (BLE) module.
Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner.
@@ -176,7 +176,7 @@
Defines data types and structures for CIOT HTTP client.
Header file for CIOT HTTP server interface.
Defines data types and structures for CIOT HTTP server.
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
Header file for CIOT logging functionality.
Header file for CIOT MQTT client functionality.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_err_t ciot_mqttc_get_topics(ciot_mqttc_t self, ciot_mqttc_topics_cfg_t *topics)
Get the configured MQTT topics.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
ciot_err_t ciot_ntp_send_data(ciot_ntp_t self, uint8_t *data, int size)
Send data for CIOT NTP.
ciot_ntp_t ciot_ntp_new(void *handle)
Create a new CIOT NTP instance.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
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_err_t ciot_opcuas_process_req(ciot_opcuas_t self, ciot_opcuas_req_t *req)
Process OPCUAS request for CIOT OPCUAS.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_ota_t ciot_ota_new(void *handle)
Create a new CIOT OTA instance.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
ciot_err_t ciot_s_send(ciot_s_t self, uint8_t *data, int size)
Send data using CIOT_S.
enum ciot_s_status ciot_s_status_t
CIOT_S status.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
ciot_err_t ciot_storage_init(void)
Initialize the CIOT Storage module.
ciot_err_t ciot_storage_format(ciot_storage_t self)
Format the storage.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
struct ciot_sys * ciot_sys_t
CIOT System instance pointer.
Definition ciot_sys.h:30
ciot_err_t ciot_sys_process_req(ciot_sys_t self, ciot_sys_req_t *req)
Process a system request.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
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_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
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
Header file for CIOT_S module.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
enum ciot_usb_event_id ciot_usb_event_id_t
Event ID enumeration for CIOT USB module.
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 @@
Header file for CIOT error handling.
ciot_err_t
Enumeration of CIOT error codes.
Definition ciot_err.h:71
-
Header file for the CIOT interface.
+
Header file for the common CIoT interface abstraction.
@ CIOT_IFACE_EVENT_CUSTOM
Definition ciot_iface.h:50
ciot_wifi_t ciot_wifi_new(void *handle)
Create a new CIOT Wi-Fi instance.
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.h | Header file for CIOT GPIO interface |
ciot_httpc.h | Header file for CIOT HTTP client interface |
ciot_https.h | Header file for CIOT HTTP server interface |
-
ciot_iface.h | Header file for the CIOT interface |
+
ciot_iface.h | Header file for the common CIoT interface abstraction |
ciot_ifaces.h | Header file for CIOT interfaces |
ciot_lib.h | CioT library header file |
ciot_log.h | Header 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 @@
The core of CIoT library.
-
The CIoT core consists of three modules: