diff --git a/docs/html/annotated.html b/docs/annotated.html similarity index 100% rename from docs/html/annotated.html rename to docs/annotated.html diff --git a/docs/html/annotated_dup.js b/docs/annotated_dup.js similarity index 100% rename from docs/html/annotated_dup.js rename to docs/annotated_dup.js diff --git a/docs/html/bc_s.png b/docs/bc_s.png similarity index 100% rename from docs/html/bc_s.png rename to docs/bc_s.png diff --git a/docs/html/bc_sd.png b/docs/bc_sd.png similarity index 100% rename from docs/html/bc_sd.png rename to docs/bc_sd.png diff --git a/docs/html/ciot_8h.html b/docs/ciot_8h.html similarity index 100% rename from docs/html/ciot_8h.html rename to docs/ciot_8h.html diff --git a/docs/html/ciot_8h.js b/docs/ciot_8h.js similarity index 100% rename from docs/html/ciot_8h.js rename to docs/ciot_8h.js diff --git a/docs/html/ciot_8h_source.html b/docs/ciot_8h_source.html similarity index 100% rename from docs/html/ciot_8h_source.html rename to docs/ciot_8h_source.html diff --git a/docs/html/ciot__ble_8h.html b/docs/ciot__ble_8h.html similarity index 100% rename from docs/html/ciot__ble_8h.html rename to docs/ciot__ble_8h.html diff --git a/docs/html/ciot__ble_8h.js b/docs/ciot__ble_8h.js similarity index 100% rename from docs/html/ciot__ble_8h.js rename to docs/ciot__ble_8h.js diff --git a/docs/html/ciot__ble_8h_source.html b/docs/ciot__ble_8h_source.html similarity index 100% rename from docs/html/ciot__ble_8h_source.html rename to docs/ciot__ble_8h_source.html diff --git a/docs/html/ciot__ble__scn_8h.html b/docs/ciot__ble__scn_8h.html similarity index 100% rename from docs/html/ciot__ble__scn_8h.html rename to docs/ciot__ble__scn_8h.html diff --git a/docs/html/ciot__ble__scn_8h.js b/docs/ciot__ble__scn_8h.js similarity index 100% rename from docs/html/ciot__ble__scn_8h.js rename to docs/ciot__ble__scn_8h.js diff --git a/docs/html/ciot__ble__scn_8h_source.html b/docs/ciot__ble__scn_8h_source.html similarity index 100% rename from docs/html/ciot__ble__scn_8h_source.html rename to docs/ciot__ble__scn_8h_source.html diff --git a/docs/html/ciot__ble__scn__types_8h.html b/docs/ciot__ble__scn__types_8h.html similarity index 100% rename from docs/html/ciot__ble__scn__types_8h.html rename to docs/ciot__ble__scn__types_8h.html diff --git a/docs/html/ciot__ble__scn__types_8h.js b/docs/ciot__ble__scn__types_8h.js similarity index 100% rename from docs/html/ciot__ble__scn__types_8h.js rename to docs/ciot__ble__scn__types_8h.js diff --git a/docs/html/ciot__ble__scn__types_8h_source.html b/docs/ciot__ble__scn__types_8h_source.html similarity index 100% rename from docs/html/ciot__ble__scn__types_8h_source.html rename to docs/ciot__ble__scn__types_8h_source.html diff --git a/docs/html/ciot__ble__types_8h.html b/docs/ciot__ble__types_8h.html similarity index 100% rename from docs/html/ciot__ble__types_8h.html rename to docs/ciot__ble__types_8h.html diff --git a/docs/html/ciot__ble__types_8h.js b/docs/ciot__ble__types_8h.js similarity index 100% rename from docs/html/ciot__ble__types_8h.js rename to docs/ciot__ble__types_8h.js diff --git a/docs/html/ciot__ble__types_8h_source.html b/docs/ciot__ble__types_8h_source.html similarity index 100% rename from docs/html/ciot__ble__types_8h_source.html rename to docs/ciot__ble__types_8h_source.html diff --git a/docs/html/ciot__bridge_8h.html b/docs/ciot__bridge_8h.html similarity index 100% rename from docs/html/ciot__bridge_8h.html rename to docs/ciot__bridge_8h.html diff --git a/docs/html/ciot__bridge_8h.js b/docs/ciot__bridge_8h.js similarity index 100% rename from docs/html/ciot__bridge_8h.js rename to docs/ciot__bridge_8h.js diff --git a/docs/html/ciot__bridge_8h_source.html b/docs/ciot__bridge_8h_source.html similarity index 100% rename from docs/html/ciot__bridge_8h_source.html rename to docs/ciot__bridge_8h_source.html diff --git a/docs/html/ciot__bridge__types_8h.html b/docs/ciot__bridge__types_8h.html similarity index 100% rename from docs/html/ciot__bridge__types_8h.html rename to docs/ciot__bridge__types_8h.html diff --git a/docs/html/ciot__bridge__types_8h.js b/docs/ciot__bridge__types_8h.js similarity index 100% rename from docs/html/ciot__bridge__types_8h.js rename to docs/ciot__bridge__types_8h.js diff --git a/docs/html/ciot__bridge__types_8h_source.html b/docs/ciot__bridge__types_8h_source.html similarity index 100% rename from docs/html/ciot__bridge__types_8h_source.html rename to docs/ciot__bridge__types_8h_source.html diff --git a/docs/html/ciot__common__types_8h.html b/docs/ciot__common__types_8h.html similarity index 100% rename from docs/html/ciot__common__types_8h.html rename to docs/ciot__common__types_8h.html diff --git a/docs/html/ciot__common__types_8h.js b/docs/ciot__common__types_8h.js similarity index 100% rename from docs/html/ciot__common__types_8h.js rename to docs/ciot__common__types_8h.js diff --git a/docs/html/ciot__common__types_8h_source.html b/docs/ciot__common__types_8h_source.html similarity index 100% rename from docs/html/ciot__common__types_8h_source.html rename to docs/ciot__common__types_8h_source.html diff --git a/docs/html/ciot__config_8h.html b/docs/ciot__config_8h.html similarity index 100% rename from docs/html/ciot__config_8h.html rename to docs/ciot__config_8h.html diff --git a/docs/html/ciot__config_8h.js b/docs/ciot__config_8h.js similarity index 100% rename from docs/html/ciot__config_8h.js rename to docs/ciot__config_8h.js diff --git a/docs/html/ciot__config_8h_source.html b/docs/ciot__config_8h_source.html similarity index 100% rename from docs/html/ciot__config_8h_source.html rename to docs/ciot__config_8h_source.html diff --git a/docs/html/ciot__crc_8h.html b/docs/ciot__crc_8h.html similarity index 100% rename from docs/html/ciot__crc_8h.html rename to docs/ciot__crc_8h.html diff --git a/docs/html/ciot__crc_8h.js b/docs/ciot__crc_8h.js similarity index 100% rename from docs/html/ciot__crc_8h.js rename to docs/ciot__crc_8h.js diff --git a/docs/html/ciot__crc_8h_source.html b/docs/ciot__crc_8h_source.html similarity index 100% rename from docs/html/ciot__crc_8h_source.html rename to docs/ciot__crc_8h_source.html diff --git a/docs/html/ciot__data__model__types_8h.html b/docs/ciot__data__model__types_8h.html similarity index 100% rename from docs/html/ciot__data__model__types_8h.html rename to docs/ciot__data__model__types_8h.html diff --git a/docs/html/ciot__data__model__types_8h.js b/docs/ciot__data__model__types_8h.js similarity index 100% rename from docs/html/ciot__data__model__types_8h.js rename to docs/ciot__data__model__types_8h.js diff --git a/docs/html/ciot__data__model__types_8h_source.html b/docs/ciot__data__model__types_8h_source.html similarity index 100% rename from docs/html/ciot__data__model__types_8h_source.html rename to docs/ciot__data__model__types_8h_source.html diff --git a/docs/html/ciot__default_8h.html b/docs/ciot__default_8h.html similarity index 100% rename from docs/html/ciot__default_8h.html rename to docs/ciot__default_8h.html diff --git a/docs/html/ciot__default_8h.js b/docs/ciot__default_8h.js similarity index 100% rename from docs/html/ciot__default_8h.js rename to docs/ciot__default_8h.js diff --git a/docs/html/ciot__default_8h_source.html b/docs/ciot__default_8h_source.html similarity index 100% rename from docs/html/ciot__default_8h_source.html rename to docs/ciot__default_8h_source.html diff --git a/docs/html/ciot__dfu_8h.html b/docs/ciot__dfu_8h.html similarity index 100% rename from docs/html/ciot__dfu_8h.html rename to docs/ciot__dfu_8h.html diff --git a/docs/html/ciot__dfu_8h.js b/docs/ciot__dfu_8h.js similarity index 100% rename from docs/html/ciot__dfu_8h.js rename to docs/ciot__dfu_8h.js diff --git a/docs/html/ciot__dfu_8h_source.html b/docs/ciot__dfu_8h_source.html similarity index 100% rename from docs/html/ciot__dfu_8h_source.html rename to docs/ciot__dfu_8h_source.html diff --git a/docs/html/ciot__dfu__types_8h.html b/docs/ciot__dfu__types_8h.html similarity index 100% rename from docs/html/ciot__dfu__types_8h.html rename to docs/ciot__dfu__types_8h.html diff --git a/docs/html/ciot__dfu__types_8h.js b/docs/ciot__dfu__types_8h.js similarity index 100% rename from docs/html/ciot__dfu__types_8h.js rename to docs/ciot__dfu__types_8h.js diff --git a/docs/html/ciot__dfu__types_8h_source.html b/docs/ciot__dfu__types_8h_source.html similarity index 100% rename from docs/html/ciot__dfu__types_8h_source.html rename to docs/ciot__dfu__types_8h_source.html diff --git a/docs/html/ciot__err_8h.html b/docs/ciot__err_8h.html similarity index 100% rename from docs/html/ciot__err_8h.html rename to docs/ciot__err_8h.html diff --git a/docs/html/ciot__err_8h.js b/docs/ciot__err_8h.js similarity index 100% rename from docs/html/ciot__err_8h.js rename to docs/ciot__err_8h.js diff --git a/docs/html/ciot__err_8h_source.html b/docs/ciot__err_8h_source.html similarity index 100% rename from docs/html/ciot__err_8h_source.html rename to docs/ciot__err_8h_source.html diff --git a/docs/html/ciot__eth_8h.html b/docs/ciot__eth_8h.html similarity index 100% rename from docs/html/ciot__eth_8h.html rename to docs/ciot__eth_8h.html diff --git a/docs/html/ciot__eth_8h.js b/docs/ciot__eth_8h.js similarity index 100% rename from docs/html/ciot__eth_8h.js rename to docs/ciot__eth_8h.js diff --git a/docs/html/ciot__eth_8h_source.html b/docs/ciot__eth_8h_source.html similarity index 100% rename from docs/html/ciot__eth_8h_source.html rename to docs/ciot__eth_8h_source.html diff --git a/docs/html/ciot__gpio_8h.html b/docs/ciot__gpio_8h.html similarity index 100% rename from docs/html/ciot__gpio_8h.html rename to docs/ciot__gpio_8h.html diff --git a/docs/html/ciot__gpio_8h.js b/docs/ciot__gpio_8h.js similarity index 100% rename from docs/html/ciot__gpio_8h.js rename to docs/ciot__gpio_8h.js diff --git a/docs/html/ciot__gpio_8h_source.html b/docs/ciot__gpio_8h_source.html similarity index 100% rename from docs/html/ciot__gpio_8h_source.html rename to docs/ciot__gpio_8h_source.html diff --git a/docs/html/ciot__gpio__types_8h.html b/docs/ciot__gpio__types_8h.html similarity index 100% rename from docs/html/ciot__gpio__types_8h.html rename to docs/ciot__gpio__types_8h.html diff --git a/docs/html/ciot__gpio__types_8h.js b/docs/ciot__gpio__types_8h.js similarity index 100% rename from docs/html/ciot__gpio__types_8h.js rename to docs/ciot__gpio__types_8h.js diff --git a/docs/html/ciot__gpio__types_8h_source.html b/docs/ciot__gpio__types_8h_source.html similarity index 100% rename from docs/html/ciot__gpio__types_8h_source.html rename to docs/ciot__gpio__types_8h_source.html diff --git a/docs/html/ciot__httpc_8h.html b/docs/ciot__httpc_8h.html similarity index 100% rename from docs/html/ciot__httpc_8h.html rename to docs/ciot__httpc_8h.html diff --git a/docs/html/ciot__httpc_8h.js b/docs/ciot__httpc_8h.js similarity index 100% rename from docs/html/ciot__httpc_8h.js rename to docs/ciot__httpc_8h.js diff --git a/docs/html/ciot__httpc_8h_source.html b/docs/ciot__httpc_8h_source.html similarity index 100% rename from docs/html/ciot__httpc_8h_source.html rename to docs/ciot__httpc_8h_source.html diff --git a/docs/html/ciot__httpc__types_8h.html b/docs/ciot__httpc__types_8h.html similarity index 100% rename from docs/html/ciot__httpc__types_8h.html rename to docs/ciot__httpc__types_8h.html diff --git a/docs/html/ciot__httpc__types_8h.js b/docs/ciot__httpc__types_8h.js similarity index 100% rename from docs/html/ciot__httpc__types_8h.js rename to docs/ciot__httpc__types_8h.js diff --git a/docs/html/ciot__httpc__types_8h_source.html b/docs/ciot__httpc__types_8h_source.html similarity index 100% rename from docs/html/ciot__httpc__types_8h_source.html rename to docs/ciot__httpc__types_8h_source.html diff --git a/docs/html/ciot__https_8h.html b/docs/ciot__https_8h.html similarity index 100% rename from docs/html/ciot__https_8h.html rename to docs/ciot__https_8h.html diff --git a/docs/html/ciot__https_8h.js b/docs/ciot__https_8h.js similarity index 100% rename from docs/html/ciot__https_8h.js rename to docs/ciot__https_8h.js diff --git a/docs/html/ciot__https_8h_source.html b/docs/ciot__https_8h_source.html similarity index 100% rename from docs/html/ciot__https_8h_source.html rename to docs/ciot__https_8h_source.html diff --git a/docs/html/ciot__https__types_8h.html b/docs/ciot__https__types_8h.html similarity index 100% rename from docs/html/ciot__https__types_8h.html rename to docs/ciot__https__types_8h.html diff --git a/docs/html/ciot__https__types_8h.js b/docs/ciot__https__types_8h.js similarity index 100% rename from docs/html/ciot__https__types_8h.js rename to docs/ciot__https__types_8h.js diff --git a/docs/html/ciot__https__types_8h_source.html b/docs/ciot__https__types_8h_source.html similarity index 100% rename from docs/html/ciot__https__types_8h_source.html rename to docs/ciot__https__types_8h_source.html diff --git a/docs/html/ciot__iface_8h.html b/docs/ciot__iface_8h.html similarity index 100% rename from docs/html/ciot__iface_8h.html rename to docs/ciot__iface_8h.html diff --git a/docs/html/ciot__iface_8h.js b/docs/ciot__iface_8h.js similarity index 100% rename from docs/html/ciot__iface_8h.js rename to docs/ciot__iface_8h.js diff --git a/docs/html/ciot__iface_8h_source.html b/docs/ciot__iface_8h_source.html similarity index 100% rename from docs/html/ciot__iface_8h_source.html rename to docs/ciot__iface_8h_source.html diff --git a/docs/html/ciot__ifaces_8h.html b/docs/ciot__ifaces_8h.html similarity index 100% rename from docs/html/ciot__ifaces_8h.html rename to docs/ciot__ifaces_8h.html diff --git a/docs/html/ciot__ifaces_8h.js b/docs/ciot__ifaces_8h.js similarity index 100% rename from docs/html/ciot__ifaces_8h.js rename to docs/ciot__ifaces_8h.js diff --git a/docs/html/ciot__ifaces_8h_source.html b/docs/ciot__ifaces_8h_source.html similarity index 100% rename from docs/html/ciot__ifaces_8h_source.html rename to docs/ciot__ifaces_8h_source.html diff --git a/docs/html/ciot__lib_8h.html b/docs/ciot__lib_8h.html similarity index 100% rename from docs/html/ciot__lib_8h.html rename to docs/ciot__lib_8h.html diff --git a/docs/html/ciot__lib_8h_source.html b/docs/ciot__lib_8h_source.html similarity index 100% rename from docs/html/ciot__lib_8h_source.html rename to docs/ciot__lib_8h_source.html diff --git a/docs/html/ciot__log_8h.html b/docs/ciot__log_8h.html similarity index 100% rename from docs/html/ciot__log_8h.html rename to docs/ciot__log_8h.html diff --git a/docs/html/ciot__log_8h.js b/docs/ciot__log_8h.js similarity index 100% rename from docs/html/ciot__log_8h.js rename to docs/ciot__log_8h.js diff --git a/docs/html/ciot__log_8h_source.html b/docs/ciot__log_8h_source.html similarity index 100% rename from docs/html/ciot__log_8h_source.html rename to docs/ciot__log_8h_source.html diff --git a/docs/html/ciot__mqttc_8h.html b/docs/ciot__mqttc_8h.html similarity index 100% rename from docs/html/ciot__mqttc_8h.html rename to docs/ciot__mqttc_8h.html diff --git a/docs/html/ciot__mqttc_8h.js b/docs/ciot__mqttc_8h.js similarity index 100% rename from docs/html/ciot__mqttc_8h.js rename to docs/ciot__mqttc_8h.js diff --git a/docs/html/ciot__mqttc_8h_source.html b/docs/ciot__mqttc_8h_source.html similarity index 100% rename from docs/html/ciot__mqttc_8h_source.html rename to docs/ciot__mqttc_8h_source.html diff --git a/docs/html/ciot__mqttc__types_8h.html b/docs/ciot__mqttc__types_8h.html similarity index 100% rename from docs/html/ciot__mqttc__types_8h.html rename to docs/ciot__mqttc__types_8h.html diff --git a/docs/html/ciot__mqttc__types_8h.js b/docs/ciot__mqttc__types_8h.js similarity index 100% rename from docs/html/ciot__mqttc__types_8h.js rename to docs/ciot__mqttc__types_8h.js diff --git a/docs/html/ciot__mqttc__types_8h_source.html b/docs/ciot__mqttc__types_8h_source.html similarity index 100% rename from docs/html/ciot__mqttc__types_8h_source.html rename to docs/ciot__mqttc__types_8h_source.html diff --git a/docs/html/ciot__msg__types_8h.html b/docs/ciot__msg__types_8h.html similarity index 100% rename from docs/html/ciot__msg__types_8h.html rename to docs/ciot__msg__types_8h.html diff --git a/docs/html/ciot__msg__types_8h.js b/docs/ciot__msg__types_8h.js similarity index 100% rename from docs/html/ciot__msg__types_8h.js rename to docs/ciot__msg__types_8h.js diff --git a/docs/html/ciot__msg__types_8h_source.html b/docs/ciot__msg__types_8h_source.html similarity index 100% rename from docs/html/ciot__msg__types_8h_source.html rename to docs/ciot__msg__types_8h_source.html diff --git a/docs/html/ciot__nrf__dfu_8h.html b/docs/ciot__nrf__dfu_8h.html similarity index 100% rename from docs/html/ciot__nrf__dfu_8h.html rename to docs/ciot__nrf__dfu_8h.html diff --git a/docs/html/ciot__nrf__dfu_8h.js b/docs/ciot__nrf__dfu_8h.js similarity index 100% rename from docs/html/ciot__nrf__dfu_8h.js rename to docs/ciot__nrf__dfu_8h.js diff --git a/docs/html/ciot__nrf__dfu_8h_source.html b/docs/ciot__nrf__dfu_8h_source.html similarity index 100% rename from docs/html/ciot__nrf__dfu_8h_source.html rename to docs/ciot__nrf__dfu_8h_source.html diff --git a/docs/html/ciot__ntp_8h.html b/docs/ciot__ntp_8h.html similarity index 100% rename from docs/html/ciot__ntp_8h.html rename to docs/ciot__ntp_8h.html diff --git a/docs/html/ciot__ntp_8h.js b/docs/ciot__ntp_8h.js similarity index 100% rename from docs/html/ciot__ntp_8h.js rename to docs/ciot__ntp_8h.js diff --git a/docs/html/ciot__ntp_8h_source.html b/docs/ciot__ntp_8h_source.html similarity index 100% rename from docs/html/ciot__ntp_8h_source.html rename to docs/ciot__ntp_8h_source.html diff --git a/docs/html/ciot__ntp__types_8h.html b/docs/ciot__ntp__types_8h.html similarity index 100% rename from docs/html/ciot__ntp__types_8h.html rename to docs/ciot__ntp__types_8h.html diff --git a/docs/html/ciot__ntp__types_8h.js b/docs/ciot__ntp__types_8h.js similarity index 100% rename from docs/html/ciot__ntp__types_8h.js rename to docs/ciot__ntp__types_8h.js diff --git a/docs/html/ciot__ntp__types_8h_source.html b/docs/ciot__ntp__types_8h_source.html similarity index 100% rename from docs/html/ciot__ntp__types_8h_source.html rename to docs/ciot__ntp__types_8h_source.html diff --git a/docs/html/ciot__opcuas_8h.html b/docs/ciot__opcuas_8h.html similarity index 100% rename from docs/html/ciot__opcuas_8h.html rename to docs/ciot__opcuas_8h.html diff --git a/docs/html/ciot__opcuas_8h.js b/docs/ciot__opcuas_8h.js similarity index 100% rename from docs/html/ciot__opcuas_8h.js rename to docs/ciot__opcuas_8h.js diff --git a/docs/html/ciot__opcuas_8h_source.html b/docs/ciot__opcuas_8h_source.html similarity index 100% rename from docs/html/ciot__opcuas_8h_source.html rename to docs/ciot__opcuas_8h_source.html diff --git a/docs/html/ciot__opcuas__types_8h.html b/docs/ciot__opcuas__types_8h.html similarity index 100% rename from docs/html/ciot__opcuas__types_8h.html rename to docs/ciot__opcuas__types_8h.html diff --git a/docs/html/ciot__opcuas__types_8h.js b/docs/ciot__opcuas__types_8h.js similarity index 100% rename from docs/html/ciot__opcuas__types_8h.js rename to docs/ciot__opcuas__types_8h.js diff --git a/docs/html/ciot__opcuas__types_8h_source.html b/docs/ciot__opcuas__types_8h_source.html similarity index 100% rename from docs/html/ciot__opcuas__types_8h_source.html rename to docs/ciot__opcuas__types_8h_source.html diff --git a/docs/html/ciot__ota_8h.html b/docs/ciot__ota_8h.html similarity index 100% rename from docs/html/ciot__ota_8h.html rename to docs/ciot__ota_8h.html diff --git a/docs/html/ciot__ota_8h.js b/docs/ciot__ota_8h.js similarity index 100% rename from docs/html/ciot__ota_8h.js rename to docs/ciot__ota_8h.js diff --git a/docs/html/ciot__ota_8h_source.html b/docs/ciot__ota_8h_source.html similarity index 100% rename from docs/html/ciot__ota_8h_source.html rename to docs/ciot__ota_8h_source.html diff --git a/docs/html/ciot__ota__types_8h.html b/docs/ciot__ota__types_8h.html similarity index 100% rename from docs/html/ciot__ota__types_8h.html rename to docs/ciot__ota__types_8h.html diff --git a/docs/html/ciot__ota__types_8h.js b/docs/ciot__ota__types_8h.js similarity index 100% rename from docs/html/ciot__ota__types_8h.js rename to docs/ciot__ota__types_8h.js diff --git a/docs/html/ciot__ota__types_8h_source.html b/docs/ciot__ota__types_8h_source.html similarity index 100% rename from docs/html/ciot__ota__types_8h_source.html rename to docs/ciot__ota__types_8h_source.html diff --git a/docs/html/ciot__s_8h.html b/docs/ciot__s_8h.html similarity index 100% rename from docs/html/ciot__s_8h.html rename to docs/ciot__s_8h.html diff --git a/docs/html/ciot__s_8h.js b/docs/ciot__s_8h.js similarity index 100% rename from docs/html/ciot__s_8h.js rename to docs/ciot__s_8h.js diff --git a/docs/html/ciot__s_8h_source.html b/docs/ciot__s_8h_source.html similarity index 100% rename from docs/html/ciot__s_8h_source.html rename to docs/ciot__s_8h_source.html diff --git a/docs/html/ciot__serializer_8h.html b/docs/ciot__serializer_8h.html similarity index 100% rename from docs/html/ciot__serializer_8h.html rename to docs/ciot__serializer_8h.html diff --git a/docs/html/ciot__serializer_8h.js b/docs/ciot__serializer_8h.js similarity index 100% rename from docs/html/ciot__serializer_8h.js rename to docs/ciot__serializer_8h.js diff --git a/docs/html/ciot__serializer_8h_source.html b/docs/ciot__serializer_8h_source.html similarity index 100% rename from docs/html/ciot__serializer_8h_source.html rename to docs/ciot__serializer_8h_source.html diff --git a/docs/html/ciot__slip_8h.html b/docs/ciot__slip_8h.html similarity index 100% rename from docs/html/ciot__slip_8h.html rename to docs/ciot__slip_8h.html diff --git a/docs/html/ciot__slip_8h.js b/docs/ciot__slip_8h.js similarity index 100% rename from docs/html/ciot__slip_8h.js rename to docs/ciot__slip_8h.js diff --git a/docs/html/ciot__slip_8h_source.html b/docs/ciot__slip_8h_source.html similarity index 100% rename from docs/html/ciot__slip_8h_source.html rename to docs/ciot__slip_8h_source.html diff --git a/docs/html/ciot__storage_8h.html b/docs/ciot__storage_8h.html similarity index 100% rename from docs/html/ciot__storage_8h.html rename to docs/ciot__storage_8h.html diff --git a/docs/html/ciot__storage_8h.js b/docs/ciot__storage_8h.js similarity index 100% rename from docs/html/ciot__storage_8h.js rename to docs/ciot__storage_8h.js diff --git a/docs/html/ciot__storage_8h_source.html b/docs/ciot__storage_8h_source.html similarity index 100% rename from docs/html/ciot__storage_8h_source.html rename to docs/ciot__storage_8h_source.html diff --git a/docs/html/ciot__storage__types_8h.html b/docs/ciot__storage__types_8h.html similarity index 100% rename from docs/html/ciot__storage__types_8h.html rename to docs/ciot__storage__types_8h.html diff --git a/docs/html/ciot__storage__types_8h.js b/docs/ciot__storage__types_8h.js similarity index 100% rename from docs/html/ciot__storage__types_8h.js rename to docs/ciot__storage__types_8h.js diff --git a/docs/html/ciot__storage__types_8h_source.html b/docs/ciot__storage__types_8h_source.html similarity index 100% rename from docs/html/ciot__storage__types_8h_source.html rename to docs/ciot__storage__types_8h_source.html diff --git a/docs/html/ciot__sys_8h.html b/docs/ciot__sys_8h.html similarity index 100% rename from docs/html/ciot__sys_8h.html rename to docs/ciot__sys_8h.html diff --git a/docs/html/ciot__sys_8h.js b/docs/ciot__sys_8h.js similarity index 100% rename from docs/html/ciot__sys_8h.js rename to docs/ciot__sys_8h.js diff --git a/docs/html/ciot__sys_8h_source.html b/docs/ciot__sys_8h_source.html similarity index 100% rename from docs/html/ciot__sys_8h_source.html rename to docs/ciot__sys_8h_source.html diff --git a/docs/html/ciot__sys__types_8h.html b/docs/ciot__sys__types_8h.html similarity index 100% rename from docs/html/ciot__sys__types_8h.html rename to docs/ciot__sys__types_8h.html diff --git a/docs/html/ciot__sys__types_8h.js b/docs/ciot__sys__types_8h.js similarity index 100% rename from docs/html/ciot__sys__types_8h.js rename to docs/ciot__sys__types_8h.js diff --git a/docs/html/ciot__sys__types_8h_source.html b/docs/ciot__sys__types_8h_source.html similarity index 100% rename from docs/html/ciot__sys__types_8h_source.html rename to docs/ciot__sys__types_8h_source.html diff --git a/docs/html/ciot__tcp_8h.html b/docs/ciot__tcp_8h.html similarity index 100% rename from docs/html/ciot__tcp_8h.html rename to docs/ciot__tcp_8h.html diff --git a/docs/html/ciot__tcp_8h.js b/docs/ciot__tcp_8h.js similarity index 100% rename from docs/html/ciot__tcp_8h.js rename to docs/ciot__tcp_8h.js diff --git a/docs/html/ciot__tcp_8h_source.html b/docs/ciot__tcp_8h_source.html similarity index 100% rename from docs/html/ciot__tcp_8h_source.html rename to docs/ciot__tcp_8h_source.html diff --git a/docs/html/ciot__tcp__types_8h.html b/docs/ciot__tcp__types_8h.html similarity index 100% rename from docs/html/ciot__tcp__types_8h.html rename to docs/ciot__tcp__types_8h.html diff --git a/docs/html/ciot__tcp__types_8h.js b/docs/ciot__tcp__types_8h.js similarity index 100% rename from docs/html/ciot__tcp__types_8h.js rename to docs/ciot__tcp__types_8h.js diff --git a/docs/html/ciot__tcp__types_8h_source.html b/docs/ciot__tcp__types_8h_source.html similarity index 100% rename from docs/html/ciot__tcp__types_8h_source.html rename to docs/ciot__tcp__types_8h_source.html diff --git a/docs/html/ciot__timer_8h.html b/docs/ciot__timer_8h.html similarity index 100% rename from docs/html/ciot__timer_8h.html rename to docs/ciot__timer_8h.html diff --git a/docs/html/ciot__timer_8h.js b/docs/ciot__timer_8h.js similarity index 100% rename from docs/html/ciot__timer_8h.js rename to docs/ciot__timer_8h.js diff --git a/docs/html/ciot__timer_8h_source.html b/docs/ciot__timer_8h_source.html similarity index 100% rename from docs/html/ciot__timer_8h_source.html rename to docs/ciot__timer_8h_source.html diff --git a/docs/html/ciot__types_8h.html b/docs/ciot__types_8h.html similarity index 100% rename from docs/html/ciot__types_8h.html rename to docs/ciot__types_8h.html diff --git a/docs/html/ciot__types_8h.js b/docs/ciot__types_8h.js similarity index 100% rename from docs/html/ciot__types_8h.js rename to docs/ciot__types_8h.js diff --git a/docs/html/ciot__types_8h_source.html b/docs/ciot__types_8h_source.html similarity index 100% rename from docs/html/ciot__types_8h_source.html rename to docs/ciot__types_8h_source.html diff --git a/docs/html/ciot__uart_8h.html b/docs/ciot__uart_8h.html similarity index 100% rename from docs/html/ciot__uart_8h.html rename to docs/ciot__uart_8h.html diff --git a/docs/html/ciot__uart_8h.js b/docs/ciot__uart_8h.js similarity index 100% rename from docs/html/ciot__uart_8h.js rename to docs/ciot__uart_8h.js diff --git a/docs/html/ciot__uart_8h_source.html b/docs/ciot__uart_8h_source.html similarity index 100% rename from docs/html/ciot__uart_8h_source.html rename to docs/ciot__uart_8h_source.html diff --git a/docs/html/ciot__uart__types_8h.html b/docs/ciot__uart__types_8h.html similarity index 100% rename from docs/html/ciot__uart__types_8h.html rename to docs/ciot__uart__types_8h.html diff --git a/docs/html/ciot__uart__types_8h.js b/docs/ciot__uart__types_8h.js similarity index 100% rename from docs/html/ciot__uart__types_8h.js rename to docs/ciot__uart__types_8h.js diff --git a/docs/html/ciot__uart__types_8h_source.html b/docs/ciot__uart__types_8h_source.html similarity index 100% rename from docs/html/ciot__uart__types_8h_source.html rename to docs/ciot__uart__types_8h_source.html diff --git a/docs/html/ciot__usb_8h.html b/docs/ciot__usb_8h.html similarity index 100% rename from docs/html/ciot__usb_8h.html rename to docs/ciot__usb_8h.html diff --git a/docs/html/ciot__usb_8h.js b/docs/ciot__usb_8h.js similarity index 100% rename from docs/html/ciot__usb_8h.js rename to docs/ciot__usb_8h.js diff --git a/docs/html/ciot__usb_8h_source.html b/docs/ciot__usb_8h_source.html similarity index 100% rename from docs/html/ciot__usb_8h_source.html rename to docs/ciot__usb_8h_source.html diff --git a/docs/html/ciot__usb__types_8h.html b/docs/ciot__usb__types_8h.html similarity index 100% rename from docs/html/ciot__usb__types_8h.html rename to docs/ciot__usb__types_8h.html diff --git a/docs/html/ciot__usb__types_8h.js b/docs/ciot__usb__types_8h.js similarity index 100% rename from docs/html/ciot__usb__types_8h.js rename to docs/ciot__usb__types_8h.js diff --git a/docs/html/ciot__usb__types_8h_source.html b/docs/ciot__usb__types_8h_source.html similarity index 100% rename from docs/html/ciot__usb__types_8h_source.html rename to docs/ciot__usb__types_8h_source.html diff --git a/docs/html/ciot__utils_8h.html b/docs/ciot__utils_8h.html similarity index 100% rename from docs/html/ciot__utils_8h.html rename to docs/ciot__utils_8h.html diff --git a/docs/html/ciot__utils_8h.js b/docs/ciot__utils_8h.js similarity index 100% rename from docs/html/ciot__utils_8h.js rename to docs/ciot__utils_8h.js diff --git a/docs/html/ciot__utils_8h_source.html b/docs/ciot__utils_8h_source.html similarity index 100% rename from docs/html/ciot__utils_8h_source.html rename to docs/ciot__utils_8h_source.html diff --git a/docs/html/ciot__wifi_8h.html b/docs/ciot__wifi_8h.html similarity index 100% rename from docs/html/ciot__wifi_8h.html rename to docs/ciot__wifi_8h.html diff --git a/docs/html/ciot__wifi_8h.js b/docs/ciot__wifi_8h.js similarity index 100% rename from docs/html/ciot__wifi_8h.js rename to docs/ciot__wifi_8h.js diff --git a/docs/html/ciot__wifi_8h_source.html b/docs/ciot__wifi_8h_source.html similarity index 100% rename from docs/html/ciot__wifi_8h_source.html rename to docs/ciot__wifi_8h_source.html diff --git a/docs/html/ciot__wifi__types_8h.html b/docs/ciot__wifi__types_8h.html similarity index 100% rename from docs/html/ciot__wifi__types_8h.html rename to docs/ciot__wifi__types_8h.html diff --git a/docs/html/ciot__wifi__types_8h.js b/docs/ciot__wifi__types_8h.js similarity index 100% rename from docs/html/ciot__wifi__types_8h.js rename to docs/ciot__wifi__types_8h.js diff --git a/docs/html/ciot__wifi__types_8h_source.html b/docs/ciot__wifi__types_8h_source.html similarity index 100% rename from docs/html/ciot__wifi__types_8h_source.html rename to docs/ciot__wifi__types_8h_source.html diff --git a/docs/html/classes.html b/docs/classes.html similarity index 100% rename from docs/html/classes.html rename to docs/classes.html diff --git a/docs/html/clipboard.js b/docs/clipboard.js similarity index 100% rename from docs/html/clipboard.js rename to docs/clipboard.js diff --git a/docs/html/closed.png b/docs/closed.png similarity index 100% rename from docs/html/closed.png rename to docs/closed.png diff --git a/docs/html/cookie.js b/docs/cookie.js similarity index 100% rename from docs/html/cookie.js rename to docs/cookie.js diff --git a/docs/html/dir_0ad255a918b7fba820a1ddafed6fa637.html b/docs/dir_0ad255a918b7fba820a1ddafed6fa637.html similarity index 100% rename from docs/html/dir_0ad255a918b7fba820a1ddafed6fa637.html rename to docs/dir_0ad255a918b7fba820a1ddafed6fa637.html diff --git a/docs/html/dir_0ad255a918b7fba820a1ddafed6fa637.js b/docs/dir_0ad255a918b7fba820a1ddafed6fa637.js similarity index 100% rename from docs/html/dir_0ad255a918b7fba820a1ddafed6fa637.js rename to docs/dir_0ad255a918b7fba820a1ddafed6fa637.js diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html similarity index 100% rename from docs/html/dir_d44c64559bbebec7f509842c48db8b23.html rename to docs/dir_d44c64559bbebec7f509842c48db8b23.html diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.js b/docs/dir_d44c64559bbebec7f509842c48db8b23.js similarity index 100% rename from docs/html/dir_d44c64559bbebec7f509842c48db8b23.js rename to docs/dir_d44c64559bbebec7f509842c48db8b23.js diff --git a/docs/html/doc.svg b/docs/doc.svg similarity index 100% rename from docs/html/doc.svg rename to docs/doc.svg diff --git a/docs/html/docd.svg b/docs/docd.svg similarity index 100% rename from docs/html/docd.svg rename to docs/docd.svg diff --git a/docs/html/doxygen.css b/docs/doxygen.css similarity index 100% rename from docs/html/doxygen.css rename to docs/doxygen.css diff --git a/docs/html/doxygen.svg b/docs/doxygen.svg similarity index 100% rename from docs/html/doxygen.svg rename to docs/doxygen.svg diff --git a/docs/html/doxygen_crawl.html b/docs/doxygen_crawl.html similarity index 100% rename from docs/html/doxygen_crawl.html rename to docs/doxygen_crawl.html diff --git a/docs/html/dynsections.js b/docs/dynsections.js similarity index 100% rename from docs/html/dynsections.js rename to docs/dynsections.js diff --git a/docs/html/files.html b/docs/files.html similarity index 100% rename from docs/html/files.html rename to docs/files.html diff --git a/docs/html/files_dup.js b/docs/files_dup.js similarity index 100% rename from docs/html/files_dup.js rename to docs/files_dup.js diff --git a/docs/html/folderclosed.svg b/docs/folderclosed.svg similarity index 100% rename from docs/html/folderclosed.svg rename to docs/folderclosed.svg diff --git a/docs/html/folderclosedd.svg b/docs/folderclosedd.svg similarity index 100% rename from docs/html/folderclosedd.svg rename to docs/folderclosedd.svg diff --git a/docs/html/folderopen.svg b/docs/folderopen.svg similarity index 100% rename from docs/html/folderopen.svg rename to docs/folderopen.svg diff --git a/docs/html/folderopend.svg b/docs/folderopend.svg similarity index 100% rename from docs/html/folderopend.svg rename to docs/folderopend.svg diff --git a/docs/html/functions.html b/docs/functions.html similarity index 100% rename from docs/html/functions.html rename to docs/functions.html diff --git a/docs/html/functions_b.html b/docs/functions_b.html similarity index 100% rename from docs/html/functions_b.html rename to docs/functions_b.html diff --git a/docs/html/functions_c.html b/docs/functions_c.html similarity index 100% rename from docs/html/functions_c.html rename to docs/functions_c.html diff --git a/docs/html/functions_d.html b/docs/functions_d.html similarity index 100% rename from docs/html/functions_d.html rename to docs/functions_d.html diff --git a/docs/html/functions_dup.js b/docs/functions_dup.js similarity index 100% rename from docs/html/functions_dup.js rename to docs/functions_dup.js diff --git a/docs/html/functions_e.html b/docs/functions_e.html similarity index 100% rename from docs/html/functions_e.html rename to docs/functions_e.html diff --git a/docs/html/functions_f.html b/docs/functions_f.html similarity index 100% rename from docs/html/functions_f.html rename to docs/functions_f.html diff --git a/docs/html/functions_g.html b/docs/functions_g.html similarity index 100% rename from docs/html/functions_g.html rename to docs/functions_g.html diff --git a/docs/html/functions_h.html b/docs/functions_h.html similarity index 100% rename from docs/html/functions_h.html rename to docs/functions_h.html diff --git a/docs/html/functions_i.html b/docs/functions_i.html similarity index 100% rename from docs/html/functions_i.html rename to docs/functions_i.html diff --git a/docs/html/functions_l.html b/docs/functions_l.html similarity index 100% rename from docs/html/functions_l.html rename to docs/functions_l.html diff --git a/docs/html/functions_m.html b/docs/functions_m.html similarity index 100% rename from docs/html/functions_m.html rename to docs/functions_m.html diff --git a/docs/html/functions_n.html b/docs/functions_n.html similarity index 100% rename from docs/html/functions_n.html rename to docs/functions_n.html diff --git a/docs/html/functions_o.html b/docs/functions_o.html similarity index 100% rename from docs/html/functions_o.html rename to docs/functions_o.html diff --git a/docs/html/functions_p.html b/docs/functions_p.html similarity index 100% rename from docs/html/functions_p.html rename to docs/functions_p.html diff --git a/docs/html/functions_q.html b/docs/functions_q.html similarity index 100% rename from docs/html/functions_q.html rename to docs/functions_q.html diff --git a/docs/html/functions_r.html b/docs/functions_r.html similarity index 100% rename from docs/html/functions_r.html rename to docs/functions_r.html diff --git a/docs/html/functions_s.html b/docs/functions_s.html similarity index 100% rename from docs/html/functions_s.html rename to docs/functions_s.html diff --git a/docs/html/functions_t.html b/docs/functions_t.html similarity index 100% rename from docs/html/functions_t.html rename to docs/functions_t.html diff --git a/docs/html/functions_u.html b/docs/functions_u.html similarity index 100% rename from docs/html/functions_u.html rename to docs/functions_u.html diff --git a/docs/html/functions_v.html b/docs/functions_v.html similarity index 100% rename from docs/html/functions_v.html rename to docs/functions_v.html diff --git a/docs/html/functions_vars.html b/docs/functions_vars.html similarity index 100% rename from docs/html/functions_vars.html rename to docs/functions_vars.html diff --git a/docs/html/functions_vars.js b/docs/functions_vars.js similarity index 100% rename from docs/html/functions_vars.js rename to docs/functions_vars.js diff --git a/docs/html/functions_vars_b.html b/docs/functions_vars_b.html similarity index 100% rename from docs/html/functions_vars_b.html rename to docs/functions_vars_b.html diff --git a/docs/html/functions_vars_c.html b/docs/functions_vars_c.html similarity index 100% rename from docs/html/functions_vars_c.html rename to docs/functions_vars_c.html diff --git a/docs/html/functions_vars_d.html b/docs/functions_vars_d.html similarity index 100% rename from docs/html/functions_vars_d.html rename to docs/functions_vars_d.html diff --git a/docs/html/functions_vars_e.html b/docs/functions_vars_e.html similarity index 100% rename from docs/html/functions_vars_e.html rename to docs/functions_vars_e.html diff --git a/docs/html/functions_vars_f.html b/docs/functions_vars_f.html similarity index 100% rename from docs/html/functions_vars_f.html rename to docs/functions_vars_f.html diff --git a/docs/html/functions_vars_g.html b/docs/functions_vars_g.html similarity index 100% rename from docs/html/functions_vars_g.html rename to docs/functions_vars_g.html diff --git a/docs/html/functions_vars_h.html b/docs/functions_vars_h.html similarity index 100% rename from docs/html/functions_vars_h.html rename to docs/functions_vars_h.html diff --git a/docs/html/functions_vars_i.html b/docs/functions_vars_i.html similarity index 100% rename from docs/html/functions_vars_i.html rename to docs/functions_vars_i.html diff --git a/docs/html/functions_vars_l.html b/docs/functions_vars_l.html similarity index 100% rename from docs/html/functions_vars_l.html rename to docs/functions_vars_l.html diff --git a/docs/html/functions_vars_m.html b/docs/functions_vars_m.html similarity index 100% rename from docs/html/functions_vars_m.html rename to docs/functions_vars_m.html diff --git a/docs/html/functions_vars_n.html b/docs/functions_vars_n.html similarity index 100% rename from docs/html/functions_vars_n.html rename to docs/functions_vars_n.html diff --git a/docs/html/functions_vars_o.html b/docs/functions_vars_o.html similarity index 100% rename from docs/html/functions_vars_o.html rename to docs/functions_vars_o.html diff --git a/docs/html/functions_vars_p.html b/docs/functions_vars_p.html similarity index 100% rename from docs/html/functions_vars_p.html rename to docs/functions_vars_p.html diff --git a/docs/html/functions_vars_q.html b/docs/functions_vars_q.html similarity index 100% rename from docs/html/functions_vars_q.html rename to docs/functions_vars_q.html diff --git a/docs/html/functions_vars_r.html b/docs/functions_vars_r.html similarity index 100% rename from docs/html/functions_vars_r.html rename to docs/functions_vars_r.html diff --git a/docs/html/functions_vars_s.html b/docs/functions_vars_s.html similarity index 100% rename from docs/html/functions_vars_s.html rename to docs/functions_vars_s.html diff --git a/docs/html/functions_vars_t.html b/docs/functions_vars_t.html similarity index 100% rename from docs/html/functions_vars_t.html rename to docs/functions_vars_t.html diff --git a/docs/html/functions_vars_u.html b/docs/functions_vars_u.html similarity index 100% rename from docs/html/functions_vars_u.html rename to docs/functions_vars_u.html diff --git a/docs/html/functions_vars_v.html b/docs/functions_vars_v.html similarity index 100% rename from docs/html/functions_vars_v.html rename to docs/functions_vars_v.html diff --git a/docs/html/functions_vars_w.html b/docs/functions_vars_w.html similarity index 100% rename from docs/html/functions_vars_w.html rename to docs/functions_vars_w.html diff --git a/docs/html/functions_w.html b/docs/functions_w.html similarity index 100% rename from docs/html/functions_w.html rename to docs/functions_w.html diff --git a/docs/html/globals.html b/docs/globals.html similarity index 100% rename from docs/html/globals.html rename to docs/globals.html diff --git a/docs/html/globals_c.html b/docs/globals_c.html similarity index 100% rename from docs/html/globals_c.html rename to docs/globals_c.html diff --git a/docs/html/globals_defs.html b/docs/globals_defs.html similarity index 100% rename from docs/html/globals_defs.html rename to docs/globals_defs.html diff --git a/docs/html/globals_dup.js b/docs/globals_dup.js similarity index 100% rename from docs/html/globals_dup.js rename to docs/globals_dup.js diff --git a/docs/html/globals_enum.html b/docs/globals_enum.html similarity index 100% rename from docs/html/globals_enum.html rename to docs/globals_enum.html diff --git a/docs/html/globals_eval.html b/docs/globals_eval.html similarity index 100% rename from docs/html/globals_eval.html rename to docs/globals_eval.html diff --git a/docs/html/globals_eval.js b/docs/globals_eval.js similarity index 100% rename from docs/html/globals_eval.js rename to docs/globals_eval.js diff --git a/docs/html/globals_eval_h.html b/docs/globals_eval_h.html similarity index 100% rename from docs/html/globals_eval_h.html rename to docs/globals_eval_h.html diff --git a/docs/html/globals_eval_n.html b/docs/globals_eval_n.html similarity index 100% rename from docs/html/globals_eval_n.html rename to docs/globals_eval_n.html diff --git a/docs/html/globals_func.html b/docs/globals_func.html similarity index 100% rename from docs/html/globals_func.html rename to docs/globals_func.html diff --git a/docs/html/globals_h.html b/docs/globals_h.html similarity index 100% rename from docs/html/globals_h.html rename to docs/globals_h.html diff --git a/docs/html/globals_n.html b/docs/globals_n.html similarity index 100% rename from docs/html/globals_n.html rename to docs/globals_n.html diff --git a/docs/html/globals_type.html b/docs/globals_type.html similarity index 100% rename from docs/html/globals_type.html rename to docs/globals_type.html diff --git a/docs/html/group__hardware__interfaces.html b/docs/group__hardware__interfaces.html similarity index 100% rename from docs/html/group__hardware__interfaces.html rename to docs/group__hardware__interfaces.html diff --git a/docs/html/group__hardware__interfaces.js b/docs/group__hardware__interfaces.js similarity index 100% rename from docs/html/group__hardware__interfaces.js rename to docs/group__hardware__interfaces.js diff --git a/docs/html/group__hardware__types.html b/docs/group__hardware__types.html similarity index 100% rename from docs/html/group__hardware__types.html rename to docs/group__hardware__types.html diff --git a/docs/html/group__hardware__types.js b/docs/group__hardware__types.js similarity index 100% rename from docs/html/group__hardware__types.js rename to docs/group__hardware__types.js diff --git a/docs/html/group__software__interfaces.html b/docs/group__software__interfaces.html similarity index 100% rename from docs/html/group__software__interfaces.html rename to docs/group__software__interfaces.html diff --git a/docs/html/group__software__interfaces.js b/docs/group__software__interfaces.js similarity index 100% rename from docs/html/group__software__interfaces.js rename to docs/group__software__interfaces.js diff --git a/docs/html/group__software__types.html b/docs/group__software__types.html similarity index 100% rename from docs/html/group__software__types.html rename to docs/group__software__types.html diff --git a/docs/html/group__software__types.js b/docs/group__software__types.js similarity index 100% rename from docs/html/group__software__types.js rename to docs/group__software__types.js diff --git a/docs/html/globals_b.html b/docs/html/globals_b.html deleted file mode 100644 index d048f99..0000000 --- a/docs/html/globals_b.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - -CioT: Globals - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:
- -

- b -

-
-
- - - - diff --git a/docs/html/globals_func.js b/docs/html/globals_func.js deleted file mode 100644 index 9c754a4..0000000 --- a/docs/html/globals_func.js +++ /dev/null @@ -1,6 +0,0 @@ -var globals_func = -[ - [ "_", "globals_func.html", null ], - [ "b", "globals_func_b.html", null ], - [ "c", "globals_func_c.html", null ] -]; \ No newline at end of file diff --git a/docs/html/globals_func_b.html b/docs/html/globals_func_b.html deleted file mode 100644 index c0635b1..0000000 --- a/docs/html/globals_func_b.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - -CioT: Globals - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
Here is a list of all functions with links to the files they belong to:
- -

- b -

-
-
- - - - diff --git a/docs/html/globals_func_c.html b/docs/html/globals_func_c.html deleted file mode 100644 index d98875a..0000000 --- a/docs/html/globals_func_c.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - -CioT: Globals - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
Here is a list of all functions with links to the files they belong to:
- -

- c -

-
-
- - - - diff --git a/docs/html/globals_p.html b/docs/html/globals_p.html deleted file mode 100644 index 73a9ba8..0000000 --- a/docs/html/globals_p.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - -CioT: Globals - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:
- -

- p -

-
-
- - - - diff --git a/docs/html/globals_type.js b/docs/html/globals_type.js deleted file mode 100644 index bb02666..0000000 --- a/docs/html/globals_type.js +++ /dev/null @@ -1,4 +0,0 @@ -var globals_type = -[ - [ "c", "globals_type.html", null ] -]; \ No newline at end of file diff --git a/docs/html/globals_vars.html b/docs/html/globals_vars.html deleted file mode 100644 index 589089f..0000000 --- a/docs/html/globals_vars.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - - -CioT: Globals - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
Here is a list of all variables with links to the files they belong to:
- -

- c -

-
-
- - - - diff --git a/docs/html/group___common.html b/docs/html/group___common.html deleted file mode 100644 index aedee84..0000000 --- a/docs/html/group___common.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - -CioT: constants - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
constants
-
-
- -

Header file for CIOT error handling. -

-

Header file for CIOT error handling.

-
Version
0.1
-
Date
2023-10-09
-
Author
Wesley Santos (wesle.nosp@m.ypro.nosp@m.37@gm.nosp@m.ail..nosp@m.com)
-
Copyright
Copyright (c) 2023
-
-
- - - - diff --git a/docs/html/group___hardware.html b/docs/html/group___hardware.html deleted file mode 100644 index 7811540..0000000 --- a/docs/html/group___hardware.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - -CioT: interfaces - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
interfaces
-
-
- -

Header file for CIOT Ethernet interface. -

-

Header file for CIOT Ethernet interface.

-
Version
0.1
-
Date
2023-10-17
-
Author
Wesley Santos (wesle.nosp@m.ypro.nosp@m.37@gm.nosp@m.ail..nosp@m.com)
-
Copyright
Copyright (c) 2023
-
-
- - - - diff --git a/docs/html/group___software.html b/docs/html/group___software.html deleted file mode 100644 index 18d6411..0000000 --- a/docs/html/group___software.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - -CioT: interfaces - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
interfaces
-
-
- -

Defines functions and types for CIOT Bridge module. -

-

Defines functions and types for CIOT Bridge module.

-

Header file for Device Firmware Update (DFU) functionality in CIOT library.

-
Version
0.1
-
Date
2023-11-13
-
Author
Wesley Santos (wesle.nosp@m.ypro.nosp@m.37@gm.nosp@m.ail..nosp@m.com)
-
Copyright
Copyright (c) 2023
-
Version
0.1
-
Date
2024-03-20
-
Author
Wesley Santos (wesle.nosp@m.ypro.nosp@m.37@gm.nosp@m.ail..nosp@m.com)
-
Copyright
Copyright (c) 2024
-
-
- - - - diff --git a/docs/html/group___utils.html b/docs/html/group___utils.html deleted file mode 100644 index 0d8ee64..0000000 --- a/docs/html/group___utils.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - -CioT: Utils - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
Utils
-
-
-
Author
Wesley Santos (wesle.nosp@m.ypro.nosp@m.37@gm.nosp@m.ail..nosp@m.com)
-
Version
0.1
-
Date
2024-04-19
-
Copyright
Copyright (c) 2024
-
-
- - - - diff --git a/docs/html/group___utils.js b/docs/html/group___utils.js deleted file mode 100644 index 1a4fd37..0000000 --- a/docs/html/group___utils.js +++ /dev/null @@ -1,16 +0,0 @@ -var group___utils = -[ - [ "ciot_slip_t", "structciot__slip__t.html", [ - [ "buffer_len", "structciot__slip__t.html#a899cec1e08bcfa497396baa3584d18e1", null ], - [ "current_index", "structciot__slip__t.html#ad1e3bc5a59e7ed48387fb95383fae12f", null ], - [ "p_buffer", "structciot__slip__t.html#a247b6cc8b5cd8bd49b0c4c62ed59f7b8", null ], - [ "state", "structciot__slip__t.html#accaf0db15b7c2817f00fed318f13fe5b", null ] - ] ], - [ "ciot_slip_read_state_t", "group___utils.html#ga290de618dbd8ce83c3c43ec2e9c393a1", [ - [ "CIOT_SLIP_STATE_DECODING", "group___utils.html#gga290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e", null ], - [ "CIOT_SLIP_STATE_ESC_RECEIVED", "group___utils.html#gga290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834", null ], - [ "CIOT_SLIP_STATE_CLEARING_INVALID_PACKET", "group___utils.html#gga290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06", null ] - ] ], - [ "ciot_slip_decode_add_byte", "group___utils.html#ga13b065e0e7ef6b2b98aa59e136929654", null ], - [ "ciot_slip_encode", "group___utils.html#ga31ccb83d79170663a4a74c3a073b6d45", null ] -]; \ No newline at end of file diff --git a/docs/html/group__slip.html b/docs/html/group__slip.html deleted file mode 100644 index ad25c17..0000000 --- a/docs/html/group__slip.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - - - -CioT: SLIP encoding and decoding - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
-Data Structures | -Enumerations | -Functions
-
SLIP encoding and decoding
-
-
- -

This module encodes and decodes SLIP packages. -More...

- - - - - -

-Data Structures

struct  ciot_slip_t
 Representation of a SLIP packet. More...
 
- - - - -

-Enumerations

enum  ciot_slip_read_state_t { CIOT_SLIP_STATE_DECODING -, CIOT_SLIP_STATE_ESC_RECEIVED -, CIOT_SLIP_STATE_CLEARING_INVALID_PACKET - }
 Status information that is used while receiving and decoding a packet. More...
 
- - - - - - - -

-Functions

int ciot_slip_encode (uint8_t *p_output, uint8_t *p_input, uint32_t input_length, uint32_t *p_output_buffer_length)
 Function for encoding a SLIP packet.
 
int ciot_slip_decode_add_byte (ciot_slip_t *p_slip, uint8_t c)
 Function for decoding a SLIP packet.
 
-

Detailed Description

-

This module encodes and decodes SLIP packages.

-

The SLIP protocol is described in @linkSLIP.

-

Enumeration Type Documentation

- -

◆ ciot_slip_read_state_t

- -
-
- - - - -
enum ciot_slip_read_state_t
-
- -

Status information that is used while receiving and decoding a packet.

- - - - -
Enumerator
CIOT_SLIP_STATE_DECODING 

Ready to receive the next byte.

-
CIOT_SLIP_STATE_ESC_RECEIVED 

An ESC byte has been received and the next byte must be decoded differently.

-
CIOT_SLIP_STATE_CLEARING_INVALID_PACKET 

The received data is invalid and transfer must be restarted.

-
- -
-
-

Function Documentation

- -

◆ ciot_slip_decode_add_byte()

- -
-
- - - - - - - - - - - -
int ciot_slip_decode_add_byte (ciot_slip_t * p_slip,
uint8_t c )
-
- -

Function for decoding a SLIP packet.

-

The decoded packet is put into p_slip::p_buffer. The index and buffer state is updated.

-

Ensure that p_slip is properly initialized. The initial state must be set to CIOT_SLIP_STATE_DECODING.

-
Parameters
- - - -
[in,out]p_slipState of the decoding process.
[in]cByte to decode.
-
-
-
Return values
- - - - - - -
NRF_SUCCESSIf a packet has been parsed. The received packet can be retrieved from p_slip.
NRF_ERROR_NULLIf p_slip is NULL.
NRF_ERROR_NO_MEMIf there is no more room in the buffer provided by p_slip.
NRF_ERROR_BUSYIf the packet has not been parsed completely yet.
NRF_ERROR_INVALID_DATAIf the packet is encoded wrong. In this case, p_slip::state is set to CIOT_SLIP_STATE_CLEARING_INVALID_PACKET, and decoding will stay in this state until the END byte is received.
-
-
- -
-
- -

◆ ciot_slip_encode()

- -
-
- - - - - - - - - - - - - - - - - - - - - -
int ciot_slip_encode (uint8_t * p_output,
uint8_t * p_input,
uint32_t input_length,
uint32_t * p_output_buffer_length )
-
- -

Function for encoding a SLIP packet.

-

The maximum size of the output data is (2*input size + 1) bytes. Ensure that the provided buffer is large enough.

-
Parameters
- - - - - -
[in,out]p_outputThe buffer where the encoded SLIP packet is stored. Ensure that it is large enough.
[in,out]p_inputThe buffer to be encoded.
[in,out]input_lengthThe length of the input buffer.
[out]p_output_buffer_lengthThe length of the output buffer after the input has been encoded.
-
-
-
Return values
- - - -
NRF_SUCCESSIf the input was successfully encoded into output.
NRF_ERROR_NULLIf one of the provided parameters is NULL.
-
-
- -
-
-
-
- - - - diff --git a/docs/html/group__slip.js b/docs/html/group__slip.js deleted file mode 100644 index 79de8c6..0000000 --- a/docs/html/group__slip.js +++ /dev/null @@ -1,16 +0,0 @@ -var group__slip = -[ - [ "ciot_slip_t", "structciot__slip__t.html", [ - [ "buffer_len", "structciot__slip__t.html#a899cec1e08bcfa497396baa3584d18e1", null ], - [ "current_index", "structciot__slip__t.html#ad1e3bc5a59e7ed48387fb95383fae12f", null ], - [ "p_buffer", "structciot__slip__t.html#a247b6cc8b5cd8bd49b0c4c62ed59f7b8", null ], - [ "state", "structciot__slip__t.html#accaf0db15b7c2817f00fed318f13fe5b", null ] - ] ], - [ "ciot_slip_read_state_t", "group__slip.html#ga290de618dbd8ce83c3c43ec2e9c393a1", [ - [ "CIOT_SLIP_STATE_DECODING", "group__slip.html#gga290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e", null ], - [ "CIOT_SLIP_STATE_ESC_RECEIVED", "group__slip.html#gga290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834", null ], - [ "CIOT_SLIP_STATE_CLEARING_INVALID_PACKET", "group__slip.html#gga290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06", null ] - ] ], - [ "ciot_slip_decode_add_byte", "group__slip.html#ga13b065e0e7ef6b2b98aa59e136929654", null ], - [ "ciot_slip_encode", "group__slip.html#ga31ccb83d79170663a4a74c3a073b6d45", null ] -]; \ No newline at end of file diff --git a/docs/html/group__uart__apis.html b/docs/html/group__uart__apis.html deleted file mode 100644 index 5493f5a..0000000 --- a/docs/html/group__uart__apis.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - -CioT: , uart configuration and communication related apis - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
-Functions
-
, uart configuration and communication related apis
-
-
- -

uart apis -More...

- - - - - - - - - - - - - - - - - - - - -

-Functions

uint32_t ciot_crc32_le (uint32_t crc, uint8_t const *buf, uint32_t len)
 CRC32 value that is in little endian.
 
uint32_t ciot_crc32_be (uint32_t crc, uint8_t const *buf, uint32_t len)
 CRC32 value that is in big endian.
 
uint16_t ciot_crc16_le (uint16_t crc, uint8_t const *buf, uint32_t len)
 CRC16 value that is in little endian.
 
uint16_t ciot_crc16_be (uint16_t crc, uint8_t const *buf, uint32_t len)
 CRC16 value that is in big endian.
 
uint8_t ciot_crc8_le (uint8_t crc, uint8_t const *buf, uint32_t len)
 CRC8 value that is in little endian.
 
uint8_t ciot_crc8_be (uint8_t crc, uint8_t const *buf, uint32_t len)
 CRC8 value that is in big endian.
 
-

Detailed Description

-

uart apis

-

Function Documentation

- -

◆ ciot_crc16_be()

- -
-
- - - - - - - - - - - - - - - - -
uint16_t ciot_crc16_be (uint16_t crc,
uint8_t const * buf,
uint32_t len )
-
- -

CRC16 value that is in big endian.

-
Parameters
- - - - -
uint16_tcrc : init crc value, use 0 at the first use.
uint8_tconst *buf : buffer to start calculate crc.
uint32_tlen : buffer length in byte.
-
-
-
Returns
None
- -
-
- -

◆ ciot_crc16_le()

- -
-
- - - - - - - - - - - - - - - - -
uint16_t ciot_crc16_le (uint16_t crc,
uint8_t const * buf,
uint32_t len )
-
- -

CRC16 value that is in little endian.

-
Parameters
- - - - -
uint16_tcrc : init crc value, use 0 at the first use.
uint8_tconst *buf : buffer to start calculate crc.
uint32_tlen : buffer length in byte.
-
-
-
Returns
None
- -
-
- -

◆ ciot_crc32_be()

- -
-
- - - - - - - - - - - - - - - - -
uint32_t ciot_crc32_be (uint32_t crc,
uint8_t const * buf,
uint32_t len )
-
- -

CRC32 value that is in big endian.

-
Parameters
- - - - -
uint32_tcrc : init crc value, use 0 at the first use.
uint8_tconst *buf : buffer to start calculate crc.
uint32_tlen : buffer length in byte.
-
-
-
Returns
None
- -
-
- -

◆ ciot_crc32_le()

- -
-
- - - - - - - - - - - - - - - - -
uint32_t ciot_crc32_le (uint32_t crc,
uint8_t const * buf,
uint32_t len )
-
- -

CRC32 value that is in little endian.

-
Parameters
- - - - -
uint32_tcrc : init crc value, use 0 at the first use.
uint8_tconst *buf : buffer to start calculate crc.
uint32_tlen : buffer length in byte.
-
-
-
Returns
None
- -
-
- -

◆ ciot_crc8_be()

- -
-
- - - - - - - - - - - - - - - - -
uint8_t ciot_crc8_be (uint8_t crc,
uint8_t const * buf,
uint32_t len )
-
- -

CRC8 value that is in big endian.

-
Parameters
- - - - -
uint32_tcrc : init crc value, use 0 at the first use.
uint8_tconst *buf : buffer to start calculate crc.
uint32_tlen : buffer length in byte.
-
-
-
Returns
None
- -
-
- -

◆ ciot_crc8_le()

- -
-
- - - - - - - - - - - - - - - - -
uint8_t ciot_crc8_le (uint8_t crc,
uint8_t const * buf,
uint32_t len )
-
- -

CRC8 value that is in little endian.

-
Parameters
- - - - -
uint8_tcrc : init crc value, use 0 at the first use.
uint8_tconst *buf : buffer to start calculate crc.
uint32_tlen : buffer length in byte.
-
-
-
Returns
None
- -
-
-
-
- - - - diff --git a/docs/html/group__uart__apis.js b/docs/html/group__uart__apis.js deleted file mode 100644 index 7af1d1b..0000000 --- a/docs/html/group__uart__apis.js +++ /dev/null @@ -1,9 +0,0 @@ -var group__uart__apis = -[ - [ "ciot_crc16_be", "group__uart__apis.html#ga5d59ce0d0ffe65eaf7944d695bde59e3", null ], - [ "ciot_crc16_le", "group__uart__apis.html#ga73a6ce791d6f000bad7ee2eedd0d8350", null ], - [ "ciot_crc32_be", "group__uart__apis.html#gaeed9b1c0c84b16c8e4e4b65be0787ae4", null ], - [ "ciot_crc32_le", "group__uart__apis.html#gad020e1771e2ff7a25a068ccc1b3d1331", null ], - [ "ciot_crc8_be", "group__uart__apis.html#gae831c4d3ed93d649df5ed07e5b9d1c46", null ], - [ "ciot_crc8_le", "group__uart__apis.html#ga39da2d632baf462933f90f3fbe7a63e7", null ] -]; \ No newline at end of file diff --git a/docs/html/search/classes_1.js b/docs/html/search/classes_1.js deleted file mode 100644 index a994209..0000000 --- a/docs/html/search/classes_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['packed_0',['packed',['../structpacked.html',1,'']]] -]; diff --git a/docs/html/search/enums_1.js b/docs/html/search/enums_1.js deleted file mode 100644 index 15552cc..0000000 --- a/docs/html/search/enums_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['packed_0',['packed',['../ciot__ble__scn__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ble_scn_types.h'],['../ciot__ble__scn__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ble_scn_types.h'],['../ciot__ble__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ble_types.h'],['../ciot__ble__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ble_types.h'],['../ciot__bridge__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_bridge_types.h'],['../ciot__bridge__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_bridge_types.h'],['../ciot__data__model__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_data_model_types.h'],['../ciot__data__model__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_data_model_types.h'],['../ciot__dfu__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_dfu_types.h'],['../ciot__dfu__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_dfu_types.h'],['../ciot__dfu__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_dfu_types.h'],['../ciot__gpio__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_gpio_types.h'],['../ciot__gpio__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_gpio_types.h'],['../ciot__gpio__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_gpio_types.h'],['../ciot__gpio__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_gpio_types.h'],['../ciot__httpc__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_httpc_types.h'],['../ciot__httpc__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_httpc_types.h'],['../ciot__httpc__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_httpc_types.h'],['../ciot__httpc__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_httpc_types.h'],['../ciot__https__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_https_types.h'],['../ciot__https__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_https_types.h'],['../ciot__mqttc__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_mqttc_types.h'],['../ciot__mqttc__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_mqttc_types.h'],['../ciot__mqttc__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_mqttc_types.h'],['../ciot__msg__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_msg_types.h'],['../ciot__msg__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_msg_types.h'],['../ciot__ntp__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ntp_types.h'],['../ciot__ntp__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ntp_types.h'],['../ciot__opcuas__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_opcuas_types.h'],['../ciot__opcuas__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_opcuas_types.h'],['../ciot__ota__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ota_types.h'],['../ciot__ota__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_ota_types.h'],['../ciot__storage__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_storage_types.h'],['../ciot__storage__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_storage_types.h'],['../ciot__storage__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_storage_types.h'],['../ciot__sys__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_sys_types.h'],['../ciot__sys__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_sys_types.h'],['../ciot__tcp__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_tcp_types.h'],['../ciot__tcp__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_tcp_types.h'],['../ciot__tcp__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_tcp_types.h'],['../ciot__tcp__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_tcp_types.h'],['../ciot__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_types.h'],['../ciot__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_types.h'],['../ciot__uart__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_uart_types.h'],['../ciot__uart__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_uart_types.h'],['../ciot__uart__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_uart_types.h'],['../ciot__usb__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_usb_types.h'],['../ciot__usb__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_usb_types.h'],['../ciot__wifi__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_wifi_types.h'],['../ciot__wifi__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_wifi_types.h'],['../ciot__wifi__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_wifi_types.h'],['../ciot__wifi__types_8h.html#a534fb037cf1b018ce77d60538ce0d7f4',1,'packed: ciot_wifi_types.h']]] -]; diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js deleted file mode 100644 index 71c24df..0000000 --- a/docs/html/search/functions_2.js +++ /dev/null @@ -1,191 +0,0 @@ -var searchData= -[ - ['ciot_5fble_5fget_5fmac_0',['ciot_ble_get_mac',['../ciot__ble_8h.html#ada2bfd0d1620ed6addb4768df6e04a1a',1,'ciot_ble.h']]], - ['ciot_5fble_5fmac_5fis_5fvalid_1',['ciot_ble_mac_is_valid',['../ciot__ble_8h.html#afb9a5b45554f53c423a114f63e2b67fd',1,'ciot_ble.h']]], - ['ciot_5fble_5fnew_2',['ciot_ble_new',['../ciot__ble_8h.html#ab9cc93352ac370bae80dc47d28a18f55',1,'ciot_ble.h']]], - ['ciot_5fble_5fprocess_5freq_3',['ciot_ble_process_req',['../ciot__ble_8h.html#aa0249bac01c064dddf3e9327224789d8',1,'ciot_ble.h']]], - ['ciot_5fble_5fscn_5fget_5fadv_5finfo_4',['ciot_ble_scn_get_adv_info',['../ciot__ble__scn_8h.html#af3c5072d04dee93723266acd2ae40bda',1,'ciot_ble_scn.h']]], - ['ciot_5fble_5fscn_5fhandle_5fevent_5',['ciot_ble_scn_handle_event',['../ciot__ble__scn_8h.html#ac868bbc26c4ba11695e5c3dcaa80b201',1,'ciot_ble_scn.h']]], - ['ciot_5fble_5fscn_5fnew_6',['ciot_ble_scn_new',['../ciot__ble__scn_8h.html#a412a0a86f5b189b653efb2f334d5613f',1,'ciot_ble_scn.h']]], - ['ciot_5fble_5fscn_5fprocess_5freq_7',['ciot_ble_scn_process_req',['../ciot__ble__scn_8h.html#a22b3f45a7f6909bc350f1e7dbee0c599',1,'ciot_ble_scn.h']]], - ['ciot_5fble_5fscn_5fsend_5fdata_8',['ciot_ble_scn_send_data',['../ciot__ble__scn_8h.html#a2768bcd961a130564cf03a0d21123d91',1,'ciot_ble_scn.h']]], - ['ciot_5fble_5fscn_5fstart_9',['ciot_ble_scn_start',['../ciot__ble__scn_8h.html#a9c8db4404daa80df68b678a3b41aa9b4',1,'ciot_ble_scn.h']]], - ['ciot_5fble_5fscn_5fstop_10',['ciot_ble_scn_stop',['../ciot__ble__scn_8h.html#acb4c25e68c3ad8a3b3ca67dbcb6e89f2',1,'ciot_ble_scn.h']]], - ['ciot_5fble_5fsend_5fdata_11',['ciot_ble_send_data',['../ciot__ble_8h.html#a4a6fad82ac94edb3e85476136784ae92',1,'ciot_ble.h']]], - ['ciot_5fble_5fset_5fifaces_12',['ciot_ble_set_ifaces',['../ciot__ble_8h.html#aa7915a6de7995a7b3ddb3fad62594ec4',1,'ciot_ble.h']]], - ['ciot_5fble_5fset_5fmac_13',['ciot_ble_set_mac',['../ciot__ble_8h.html#a7d43433b80be91b2ee1be13c7c26ea78',1,'ciot_ble.h']]], - ['ciot_5fble_5fstart_14',['ciot_ble_start',['../ciot__ble_8h.html#a03de82cf82dab2814fa4315b82fdb62c',1,'ciot_ble.h']]], - ['ciot_5fble_5fstop_15',['ciot_ble_stop',['../ciot__ble_8h.html#a89c4a8b8eac676407cebe70daa7bbdee',1,'ciot_ble.h']]], - ['ciot_5fble_5ftask_16',['ciot_ble_task',['../ciot__ble_8h.html#a3c3fffa1a77cc81312c4c81de699ef6b',1,'ciot_ble.h']]], - ['ciot_5fbridge_5fget_5ftarget_5fid_17',['ciot_bridge_get_target_id',['../ciot__bridge_8h.html#a3f22ac2c01ff5139c3d5206033259559',1,'ciot_bridge.h']]], - ['ciot_5fbridge_5fnew_18',['ciot_bridge_new',['../ciot__bridge_8h.html#a0dc495dc95e68b21d471d2f4d2c85a23',1,'ciot_bridge.h']]], - ['ciot_5fbridge_5fprocess_5freq_19',['ciot_bridge_process_req',['../ciot__bridge_8h.html#af52f86ee9e077ab344d6d4e67657a4ec',1,'ciot_bridge.h']]], - ['ciot_5fbridge_5fsend_5fdata_20',['ciot_bridge_send_data',['../ciot__bridge_8h.html#ab3d916e4bbdd0b6a4b5c8504eaa4a4c6',1,'ciot_bridge.h']]], - ['ciot_5fbridge_5fstart_21',['ciot_bridge_start',['../ciot__bridge_8h.html#a2ab34c59e732cf95f9f618d74a7fda9c',1,'ciot_bridge.h']]], - ['ciot_5fbridge_5fstop_22',['ciot_bridge_stop',['../ciot__bridge_8h.html#a445c0d9d20d8ebd685a1285b548d7b39',1,'ciot_bridge.h']]], - ['ciot_5fcrc16_5fbe_23',['ciot_crc16_be',['../ciot__crc_8h.html#a5d59ce0d0ffe65eaf7944d695bde59e3',1,'ciot_crc.h']]], - ['ciot_5fcrc16_5fle_24',['ciot_crc16_le',['../ciot__crc_8h.html#a73a6ce791d6f000bad7ee2eedd0d8350',1,'ciot_crc.h']]], - ['ciot_5fcrc32_5fbe_25',['ciot_crc32_be',['../ciot__crc_8h.html#aeed9b1c0c84b16c8e4e4b65be0787ae4',1,'ciot_crc.h']]], - ['ciot_5fcrc32_5fle_26',['ciot_crc32_le',['../ciot__crc_8h.html#ad020e1771e2ff7a25a068ccc1b3d1331',1,'ciot_crc.h']]], - ['ciot_5fcrc8_5fbe_27',['ciot_crc8_be',['../ciot__crc_8h.html#ae831c4d3ed93d649df5ed07e5b9d1c46',1,'ciot_crc.h']]], - ['ciot_5fcrc8_5fle_28',['ciot_crc8_le',['../ciot__crc_8h.html#a39da2d632baf462933f90f3fbe7a63e7',1,'ciot_crc.h']]], - ['ciot_5fdelete_5fiface_5fcfg_29',['ciot_delete_iface_cfg',['../ciot_8h.html#a2de16f3df26c78b69f64cf6e20050d4e',1,'ciot.h']]], - ['ciot_5fdfu_5fnew_30',['ciot_dfu_new',['../ciot__dfu_8h.html#a6552eb94e759a22b9fd3e3da8ed1d755',1,'ciot_dfu.h']]], - ['ciot_5fdfu_5fprocess_5freq_31',['ciot_dfu_process_req',['../ciot__dfu_8h.html#ad40861d034c57576a1bf3aaa3fbc2d9b',1,'ciot_dfu.h']]], - ['ciot_5fdfu_5fsend_5fdata_32',['ciot_dfu_send_data',['../ciot__dfu_8h.html#a586e31131b7ab4e0acb3df32122a4564',1,'ciot_dfu.h']]], - ['ciot_5fdfu_5fstart_33',['ciot_dfu_start',['../ciot__dfu_8h.html#ab157cc81dbd5e4045ac42b087f200b56',1,'ciot_dfu.h']]], - ['ciot_5fdfu_5fstop_34',['ciot_dfu_stop',['../ciot__dfu_8h.html#af686f43068829e48ff6ca2455a8b1f05',1,'ciot_dfu.h']]], - ['ciot_5fdfu_5ftask_35',['ciot_dfu_task',['../ciot__dfu_8h.html#a519f6db211ff754385aba2d45cfb3a28',1,'ciot_dfu.h']]], - ['ciot_5ferr_5fto_5fmessage_36',['ciot_err_to_message',['../ciot__err_8h.html#a1d1753e50e3d86f2a58cf488442b5f4c',1,'ciot_err.h']]], - ['ciot_5feth_5fnew_37',['ciot_eth_new',['../ciot__eth_8h.html#a2c82abdd259489cac5b0fa093497d90c',1,'ciot_eth.h']]], - ['ciot_5feth_5fprocess_5freq_38',['ciot_eth_process_req',['../ciot__eth_8h.html#a661b7975f64b8017ec7cd6c4f68a4395',1,'ciot_eth.h']]], - ['ciot_5feth_5fsend_5fdata_39',['ciot_eth_send_data',['../ciot__eth_8h.html#a3952717d31db12a55731412a370ceda5',1,'ciot_eth.h']]], - ['ciot_5feth_5fstart_40',['ciot_eth_start',['../ciot__eth_8h.html#abed434192140a1fae6f358608f3407a8',1,'ciot_eth.h']]], - ['ciot_5feth_5fstop_41',['ciot_eth_stop',['../ciot__eth_8h.html#af2d6489aa9834dcaecce9c322fd1a96e',1,'ciot_eth.h']]], - ['ciot_5fgpio_5fget_5fstate_42',['ciot_gpio_get_state',['../ciot__gpio_8h.html#a5b2cfc4c7dff3ca2d06f5ec2b8026d79',1,'ciot_gpio.h']]], - ['ciot_5fgpio_5fnew_43',['ciot_gpio_new',['../ciot__gpio_8h.html#aea01096d6b6bfbd522e8657a845f80c3',1,'ciot_gpio.h']]], - ['ciot_5fgpio_5fprocess_5freq_44',['ciot_gpio_process_req',['../ciot__gpio_8h.html#a442851a180a98c165e9f9492c4563737',1,'ciot_gpio.h']]], - ['ciot_5fgpio_5fsend_5fdata_45',['ciot_gpio_send_data',['../ciot__gpio_8h.html#a9c3f8ee56e12174192c444c6be0c1a5c',1,'ciot_gpio.h']]], - ['ciot_5fgpio_5fset_5fstate_46',['ciot_gpio_set_state',['../ciot__gpio_8h.html#a4a869a0c86a5b6cb73c1789a5bbd612b',1,'ciot_gpio.h']]], - ['ciot_5fgpio_5fstart_47',['ciot_gpio_start',['../ciot__gpio_8h.html#adb7495ded0ad7759f8957513c2865799',1,'ciot_gpio.h']]], - ['ciot_5fgpio_5fstop_48',['ciot_gpio_stop',['../ciot__gpio_8h.html#adcb7cc03019350645bc5cc0898d9606d',1,'ciot_gpio.h']]], - ['ciot_5fhttpc_5fnew_49',['ciot_httpc_new',['../ciot__httpc_8h.html#aa56416d08a9bcfbc90b3732204f02e4c',1,'ciot_httpc.h']]], - ['ciot_5fhttpc_5fprocess_5freq_50',['ciot_httpc_process_req',['../ciot__httpc_8h.html#aeb4ac97854627dc732459e7c0b60a900',1,'ciot_httpc.h']]], - ['ciot_5fhttpc_5fsend_5fdata_51',['ciot_httpc_send_data',['../ciot__httpc_8h.html#a8b0903c7bdf6e8928d3753c06f13c564',1,'ciot_httpc.h']]], - ['ciot_5fhttpc_5fstart_52',['ciot_httpc_start',['../ciot__httpc_8h.html#a46df5188166f70dba4fdff5393db031e',1,'ciot_httpc.h']]], - ['ciot_5fhttpc_5fstop_53',['ciot_httpc_stop',['../ciot__httpc_8h.html#a34deca8f36a9ebbb7b47663a026efc71',1,'ciot_httpc.h']]], - ['ciot_5fhttps_5fnew_54',['ciot_https_new',['../ciot__https_8h.html#a50f38073c89e88e99b5bf95abbe0b18b',1,'ciot_https.h']]], - ['ciot_5fhttps_5fprocess_5freq_55',['ciot_https_process_req',['../ciot__https_8h.html#a585618f81c962cef6251ffecc942a333',1,'ciot_https.h']]], - ['ciot_5fhttps_5fsend_5fdata_56',['ciot_https_send_data',['../ciot__https_8h.html#ab9abc9d142e7332b9606568193d1ede0',1,'ciot_https.h']]], - ['ciot_5fhttps_5fstart_57',['ciot_https_start',['../ciot__https_8h.html#a3a7dd3627113a6a829c764500112d752',1,'ciot_https.h']]], - ['ciot_5fhttps_5fstop_58',['ciot_https_stop',['../ciot__https_8h.html#a04b4527bce08440e2643a71679575174',1,'ciot_https.h']]], - ['ciot_5fiface_5fevent_5fto_5fstr_59',['ciot_iface_event_to_str',['../ciot__iface_8h.html#aa3ff9b2090848d0920e0a69de86f6250',1,'ciot_iface.h']]], - ['ciot_5fiface_5fget_5fcfg_60',['ciot_iface_get_cfg',['../ciot__iface_8h.html#aef1dd87e5c3111ca65fa4e63ca2c9213',1,'ciot_iface.h']]], - ['ciot_5fiface_5fget_5finfo_61',['ciot_iface_get_info',['../ciot__iface_8h.html#a6b87395146fdad575079c47979fe1cc5',1,'ciot_iface.h']]], - ['ciot_5fiface_5fget_5fmsg_5fid_62',['ciot_iface_get_msg_id',['../ciot__iface_8h.html#aa0070d90be5933f14530c81fca52fcfd',1,'ciot_iface.h']]], - ['ciot_5fiface_5fget_5fstatus_63',['ciot_iface_get_status',['../ciot__iface_8h.html#a7c59fa4a32c0662de361fd89847ab62b',1,'ciot_iface.h']]], - ['ciot_5fiface_5fprocess_5fmsg_64',['ciot_iface_process_msg',['../ciot__iface_8h.html#a1838217e75528a5d17f7e3b640c58321',1,'ciot_iface.h']]], - ['ciot_5fiface_5fprocess_5freq_65',['ciot_iface_process_req',['../ciot__iface_8h.html#abc404557e0571e7e5ea0c5db63fa8c23',1,'ciot_iface.h']]], - ['ciot_5fiface_5fregister_5fevent_66',['ciot_iface_register_event',['../ciot__iface_8h.html#abded5657da5e3c7e38c1185b4b14a4a8',1,'ciot_iface.h']]], - ['ciot_5fiface_5fregister_5frequest_67',['ciot_iface_register_request',['../ciot__iface_8h.html#acfdf034f3291c65ee6798ffc860b6f1a',1,'ciot_iface.h']]], - ['ciot_5fiface_5freset_5frequest_68',['ciot_iface_reset_request',['../ciot__iface_8h.html#aefceafcf049557b64450785501b2470a',1,'ciot_iface.h']]], - ['ciot_5fiface_5fsend_5fdata_69',['ciot_iface_send_data',['../ciot__iface_8h.html#ac30f4e1e8fcb5a66822b04c384890c58',1,'ciot_iface.h']]], - ['ciot_5fiface_5fsend_5fmsg_70',['ciot_iface_send_msg',['../ciot__iface_8h.html#a5e15dc97b9b45855f868dee02c69c166',1,'ciot_iface.h']]], - ['ciot_5fiface_5fsend_5freq_71',['ciot_iface_send_req',['../ciot__iface_8h.html#a5f8b92fd30cad0f550ef9976e037b93e',1,'ciot_iface.h']]], - ['ciot_5fiface_5fsend_5frsp_72',['ciot_iface_send_rsp',['../ciot__iface_8h.html#ae6a255f29e6adcc8a7325c29abba6844',1,'ciot_iface.h']]], - ['ciot_5fiface_5fset_5fserializer_73',['ciot_iface_set_serializer',['../ciot__iface_8h.html#ac6198bf9f283fff84839fcba7aaa0682',1,'ciot_iface.h']]], - ['ciot_5fiface_5fstart_74',['ciot_iface_start',['../ciot__iface_8h.html#a15efdb74520f75fe9f0a695a349f07e0',1,'ciot_iface.h']]], - ['ciot_5fiface_5fstop_75',['ciot_iface_stop',['../ciot__iface_8h.html#a7ad3131a637f86ed8d9a4655f060deca',1,'ciot_iface.h']]], - ['ciot_5fiface_5fto_5fstr_76',['ciot_iface_to_str',['../ciot__iface_8h.html#ad4bea4982fb363829998c5fa64f76ccb',1,'ciot_iface.h']]], - ['ciot_5fiface_5ftype_5fto_5fstr_77',['ciot_iface_type_to_str',['../ciot__iface_8h.html#a6411ae488746c99b42a7970dcbe6b042',1,'ciot_iface.h']]], - ['ciot_5fmqttc_5fnew_78',['ciot_mqttc_new',['../ciot__mqttc_8h.html#aa6ac15e5f6cfb3346cff3247dd25c279',1,'ciot_mqttc.h']]], - ['ciot_5fmqttc_5fprocess_5freq_79',['ciot_mqttc_process_req',['../ciot__mqttc_8h.html#aba9394c6a08cb0c2087ffdc537f75125',1,'ciot_mqttc.h']]], - ['ciot_5fmqttc_5fpublish_80',['ciot_mqttc_publish',['../ciot__mqttc_8h.html#a55aab38479c4242b37397c51e15dad37',1,'ciot_mqttc.h']]], - ['ciot_5fmqttc_5freset_5fdata_5frate_81',['ciot_mqttc_reset_data_rate',['../ciot__mqttc_8h.html#ad7bcb714dbb489d3b8508cb7acf72b27',1,'ciot_mqttc.h']]], - ['ciot_5fmqttc_5fsend_5fdata_82',['ciot_mqttc_send_data',['../ciot__mqttc_8h.html#aa04b6f015e9bbc8ab614027c460f899d',1,'ciot_mqttc.h']]], - ['ciot_5fmqttc_5fstart_83',['ciot_mqttc_start',['../ciot__mqttc_8h.html#a19c183447b4f862cb53f6ae127a80db0',1,'ciot_mqttc.h']]], - ['ciot_5fmqttc_5fstop_84',['ciot_mqttc_stop',['../ciot__mqttc_8h.html#af81da24c4d251706f5f901e810752597',1,'ciot_mqttc.h']]], - ['ciot_5fmqttc_5fsubscribe_85',['ciot_mqttc_subscribe',['../ciot__mqttc_8h.html#aee005c5cae5b325548b381df58613742',1,'ciot_mqttc.h']]], - ['ciot_5fmsg_5ftype_5fto_5fstr_86',['ciot_msg_type_to_str',['../ciot__msg__types_8h.html#ad74fa5c942e63dc4c806fbfd6414db45',1,'ciot_msg_types.h']]], - ['ciot_5fnew_87',['ciot_new',['../ciot_8h.html#af5987ba03fd375f7441ab9bf2c53f5f0',1,'ciot.h']]], - ['ciot_5fnrf_5fdfu_5fnew_88',['ciot_nrf_dfu_new',['../ciot__nrf__dfu_8h.html#aad325ff49e9a727535ba2245af2896f3',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fprocess_5freq_89',['ciot_nrf_dfu_process_req',['../ciot__nrf__dfu_8h.html#a470062374eb38631c7bf20f148011ede',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fread_5ffile_90',['ciot_nrf_dfu_read_file',['../ciot__nrf__dfu_8h.html#af751feb3c4ee63d05fe6dc1b2c591d4e',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fsend_5fdata_91',['ciot_nrf_dfu_send_data',['../ciot__nrf__dfu_8h.html#afcbdb54986436cb9fdf421ba8f50f077',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fsend_5ffirmware_92',['ciot_nrf_dfu_send_firmware',['../ciot__nrf__dfu_8h.html#af56db9aade46e176e0e286382ca04f7c',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fstart_93',['ciot_nrf_dfu_start',['../ciot__nrf__dfu_8h.html#ade8e82ea98fd5f89242d3a38effba293',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fstart_5fbootloader_94',['ciot_nrf_dfu_start_bootloader',['../ciot__nrf__dfu_8h.html#a818286457b301b0a341208839ade9a90',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fstate_95',['ciot_nrf_dfu_state',['../ciot__nrf__dfu_8h.html#aee5e7944d29dc3c5a75706fa4b45cc35',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5fstop_96',['ciot_nrf_dfu_stop',['../ciot__nrf__dfu_8h.html#a890127344062271c54ecddd1391c80c3',1,'ciot_nrf_dfu.h']]], - ['ciot_5fnrf_5fdfu_5ftask_97',['ciot_nrf_dfu_task',['../ciot__nrf__dfu_8h.html#aac67be0b79a25d514bb05ccf1622c07e',1,'ciot_nrf_dfu.h']]], - ['ciot_5fntp_5fnew_98',['ciot_ntp_new',['../ciot__ntp_8h.html#a21060aee75e3e21695cb1b47e9dbbea6',1,'ciot_ntp.h']]], - ['ciot_5fntp_5fprocess_5freq_99',['ciot_ntp_process_req',['../ciot__ntp_8h.html#aba2cd40d3a1923cc1c69ae0784bd6f79',1,'ciot_ntp.h']]], - ['ciot_5fntp_5fsend_5fdata_100',['ciot_ntp_send_data',['../ciot__ntp_8h.html#a1670e17032214d1a41e0381d2c5844ac',1,'ciot_ntp.h']]], - ['ciot_5fntp_5fset_101',['ciot_ntp_set',['../ciot__ntp_8h.html#abddacb943d084ba3d40cde58b1da45fc',1,'ciot_ntp.h']]], - ['ciot_5fntp_5fstart_102',['ciot_ntp_start',['../ciot__ntp_8h.html#ab2e49de0c8bc987fcbd6ff97912e9f21',1,'ciot_ntp.h']]], - ['ciot_5fntp_5fstop_103',['ciot_ntp_stop',['../ciot__ntp_8h.html#a4c928f5a646bc368a33351c0508e5986',1,'ciot_ntp.h']]], - ['ciot_5fopcuas_5fadd_5fnode_104',['ciot_opcuas_add_node',['../ciot__opcuas_8h.html#a0a3f5503c7a8cee3326a00a7b251b9b2',1,'ciot_opcuas.h']]], - ['ciot_5fopcuas_5fnew_105',['ciot_opcuas_new',['../ciot__opcuas_8h.html#a2a20908ad8a9104fa199239f790e72a8',1,'ciot_opcuas.h']]], - ['ciot_5fopcuas_5fprocess_5freq_106',['ciot_opcuas_process_req',['../ciot__opcuas_8h.html#a12d974a4c1fd3dfc906cef2a92d7decc',1,'ciot_opcuas.h']]], - ['ciot_5fopcuas_5fsend_5fdata_107',['ciot_opcuas_send_data',['../ciot__opcuas_8h.html#adce1d391f5b3a5aa5f638a8410d95cbc',1,'ciot_opcuas.h']]], - ['ciot_5fopcuas_5fstart_108',['ciot_opcuas_start',['../ciot__opcuas_8h.html#a86fd44bf128861a3cca1f57b680c137e',1,'ciot_opcuas.h']]], - ['ciot_5fopcuas_5fstop_109',['ciot_opcuas_stop',['../ciot__opcuas_8h.html#a7db26a1290536e33bcad744e00ecf954',1,'ciot_opcuas.h']]], - ['ciot_5fota_5fnew_110',['ciot_ota_new',['../ciot__ota_8h.html#a1919f2727400ca6493343a6400bcfec4',1,'ciot_ota.h']]], - ['ciot_5fota_5fprocess_5freq_111',['ciot_ota_process_req',['../ciot__ota_8h.html#a2ad1d252c2d48d024f67054bc7f71d87',1,'ciot_ota.h']]], - ['ciot_5fota_5frollback_112',['ciot_ota_rollback',['../ciot__ota_8h.html#ac316b7fc7ebed5e0aae3e23613d12945',1,'ciot_ota.h']]], - ['ciot_5fota_5fsend_5fdata_113',['ciot_ota_send_data',['../ciot__ota_8h.html#a450e80fb9f0810603d54bfd9a0919a38',1,'ciot_ota.h']]], - ['ciot_5fota_5fstart_114',['ciot_ota_start',['../ciot__ota_8h.html#a9a1c226a282e4d4ba2e0d9e0caffa91c',1,'ciot_ota.h']]], - ['ciot_5fota_5fstop_115',['ciot_ota_stop',['../ciot__ota_8h.html#a4fa33a4b506088b382a391192765dc42',1,'ciot_ota.h']]], - ['ciot_5fproxy_5fsend_5freq_116',['ciot_proxy_send_req',['../ciot_8h.html#af32f995ccbb96d62688e73df1f2998a9',1,'ciot.h']]], - ['ciot_5fregister_5fevent_117',['ciot_register_event',['../ciot_8h.html#a6d0892881a59cab0baba866d2dfdaa33',1,'ciot.h']]], - ['ciot_5fs_5fcheck_5ftimeout_118',['ciot_s_check_timeout',['../ciot__s_8h.html#a0c93c3938f1a7a0c0ec5789864d7a60e',1,'ciot_s.h']]], - ['ciot_5fs_5fnew_119',['ciot_s_new',['../ciot__s_8h.html#a47e024d9119662842e62f2b993b7511c',1,'ciot_s.h']]], - ['ciot_5fs_5fprocess_5fbyte_120',['ciot_s_process_byte',['../ciot__s_8h.html#a4d7f4cef42ccdb61d1ab7dd6adafc391',1,'ciot_s.h']]], - ['ciot_5fs_5fsend_121',['ciot_s_send',['../ciot__s_8h.html#a00fdcbb4aebbad8f80bf1bf1e732a9cb',1,'ciot_s.h']]], - ['ciot_5fs_5fset_5fbridge_5fmode_122',['ciot_s_set_bridge_mode',['../ciot__s_8h.html#a14867c1134859ec897f2ecf11af41793',1,'ciot_s.h']]], - ['ciot_5fsave_5fiface_5fcfg_123',['ciot_save_iface_cfg',['../ciot_8h.html#aa11d77071edcfb2ae57b26f92cda2e06',1,'ciot.h']]], - ['ciot_5fserializer_5ffrom_5fbytes_124',['ciot_serializer_from_bytes',['../ciot__serializer_8h.html#a2e6ad3f65b3277042564ae00d1ea9522',1,'ciot_serializer.h']]], - ['ciot_5fserializer_5fto_5fbytes_125',['ciot_serializer_to_bytes',['../ciot__serializer_8h.html#acce586f0c1adcf56d07b5c09e1df2c17',1,'ciot_serializer.h']]], - ['ciot_5fset_5fstorage_126',['ciot_set_storage',['../ciot_8h.html#ab1f4ff509841bbca90c9a29e870a23fd',1,'ciot.h']]], - ['ciot_5fslip_5fdecode_5fadd_5fbyte_127',['ciot_slip_decode_add_byte',['../ciot__slip_8h.html#a13b065e0e7ef6b2b98aa59e136929654',1,'ciot_slip.h']]], - ['ciot_5fslip_5fencode_128',['ciot_slip_encode',['../ciot__slip_8h.html#a31ccb83d79170663a4a74c3a073b6d45',1,'ciot_slip.h']]], - ['ciot_5fstart_129',['ciot_start',['../ciot_8h.html#a9ed835b9b7224f7757b9382061afc97c',1,'ciot.h']]], - ['ciot_5fstorage_5fdelete_130',['ciot_storage_delete',['../ciot__storage_8h.html#a3ef2b7405e84549b877fc3ff56573a70',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fformat_131',['ciot_storage_format',['../ciot__storage_8h.html#a2ba18ab68d78441277427d4d5d17d8e2',1,'ciot_storage.h']]], - ['ciot_5fstorage_5finit_132',['ciot_storage_init',['../ciot__storage_8h.html#a03cb31fbd7d15d42639eca3b35e681b7',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fload_133',['ciot_storage_load',['../ciot__storage_8h.html#a5dc173d4e3d285404c40f975c5ebff7d',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fnew_134',['ciot_storage_new',['../ciot__storage_8h.html#a4f5d3c6bb977f52bb50f491526710e1e',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fprocess_5freq_135',['ciot_storage_process_req',['../ciot__storage_8h.html#a7d7c52b2cee69e6b7c23be1ecc8ed0d7',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fsave_136',['ciot_storage_save',['../ciot__storage_8h.html#ae217d8018730853ce5e77e5c11b8ce4d',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fsend_5fdata_137',['ciot_storage_send_data',['../ciot__storage_8h.html#aa54c8242169de35f8bf2a6a074cc6945',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fstart_138',['ciot_storage_start',['../ciot__storage_8h.html#ade9c8a3a8b08bfbef4d4b7431ec5a740',1,'ciot_storage.h']]], - ['ciot_5fstorage_5fstop_139',['ciot_storage_stop',['../ciot__storage_8h.html#ac895b62ff9edf0c92bd9223e66c752ec',1,'ciot_storage.h']]], - ['ciot_5fsys_5fget_5fhw_140',['ciot_sys_get_hw',['../ciot__sys_8h.html#a7a01e9dc69f9e38add4b67f5d5353c65',1,'ciot_sys.h']]], - ['ciot_5fsys_5fnew_141',['ciot_sys_new',['../ciot__sys_8h.html#a22dbbf411c0235ce565adc505434a6c5',1,'ciot_sys.h']]], - ['ciot_5fsys_5fprocess_5freq_142',['ciot_sys_process_req',['../ciot__sys_8h.html#a06ce22313cfa75dd3862bf9125cd845c',1,'ciot_sys.h']]], - ['ciot_5fsys_5frst_143',['ciot_sys_rst',['../ciot__sys_8h.html#afcb34bf8efb97cfc6f0e87c417508147',1,'ciot_sys.h']]], - ['ciot_5fsys_5fsend_5fdata_144',['ciot_sys_send_data',['../ciot__sys_8h.html#a5fbca2415ce7a76809907b5d3217098b',1,'ciot_sys.h']]], - ['ciot_5fsys_5fset_5fevent_5fbits_145',['ciot_sys_set_event_bits',['../ciot__sys_8h.html#ae3972ff066bf63bde44841a4c6052a14',1,'ciot_sys.h']]], - ['ciot_5fsys_5fsleep_146',['ciot_sys_sleep',['../ciot__sys_8h.html#a642db3584c187d4bfa8b34dca84ea9f8',1,'ciot_sys.h']]], - ['ciot_5fsys_5fstart_147',['ciot_sys_start',['../ciot__sys_8h.html#a4e0bd89f65a81feced88a3b45bf7f541',1,'ciot_sys.h']]], - ['ciot_5fsys_5fstop_148',['ciot_sys_stop',['../ciot__sys_8h.html#a1e3d326166a820fc5716b2516bcca0c3',1,'ciot_sys.h']]], - ['ciot_5fsys_5ftask_149',['ciot_sys_task',['../ciot__sys_8h.html#a3a9c0875c8a82a6927c7bc27294092c4',1,'ciot_sys.h']]], - ['ciot_5fsys_5fupdate_5ffeatures_150',['ciot_sys_update_features',['../ciot__sys_8h.html#a5e7145c78ed2af300b57879b856478af',1,'ciot_sys.h']]], - ['ciot_5ftask_151',['ciot_task',['../ciot_8h.html#a27c376712b0d3594c545846834d24d25',1,'ciot.h']]], - ['ciot_5ftcp_5fget_5fip_152',['ciot_tcp_get_ip',['../ciot__tcp_8h.html#acf0f0475005d8a35010d7d3795a83709',1,'ciot_tcp.h']]], - ['ciot_5ftcp_5finit_153',['ciot_tcp_init',['../ciot__tcp_8h.html#aaf33d525b69a740035727775db744789',1,'ciot_tcp.h']]], - ['ciot_5ftcp_5fnew_154',['ciot_tcp_new',['../ciot__tcp_8h.html#aa7b4877b5e9386676e52472bc2b623fb',1,'ciot_tcp.h']]], - ['ciot_5ftcp_5fprocess_5freq_155',['ciot_tcp_process_req',['../ciot__tcp_8h.html#a8e470218e3e7bbfff2d416270c012a29',1,'ciot_tcp.h']]], - ['ciot_5ftcp_5fregister_5fevent_156',['ciot_tcp_register_event',['../ciot__tcp_8h.html#a6f7038a07ff7a89af6c8b228ebb99cae',1,'ciot_tcp.h']]], - ['ciot_5ftcp_5fsend_5fdata_157',['ciot_tcp_send_data',['../ciot__tcp_8h.html#a21f1441d7e5b4b9c43ae51509fc12fe7',1,'ciot_tcp.h']]], - ['ciot_5ftcp_5fstart_158',['ciot_tcp_start',['../ciot__tcp_8h.html#a4bc4953f648bd57ec2fd6a0607c8b3eb',1,'ciot_tcp.h']]], - ['ciot_5ftcp_5fstop_159',['ciot_tcp_stop',['../ciot__tcp_8h.html#a4873b02d0f4a5665258cd4ac47e83880',1,'ciot_tcp.h']]], - ['ciot_5ftimer_5fcompare_160',['ciot_timer_compare',['../ciot__timer_8h.html#aed2d654f1ff37f47c42c87a8de300b19',1,'ciot_timer.h']]], - ['ciot_5ftimer_5fget_161',['ciot_timer_get',['../ciot__timer_8h.html#ade8ee212546acd7193d5b55b803f64ac',1,'ciot_timer.h']]], - ['ciot_5ftimer_5fstart_162',['ciot_timer_start',['../ciot__timer_8h.html#a8d0e55ce9c38fa27cb6cbf0adf38ea85',1,'ciot_timer.h']]], - ['ciot_5fuart_5fnew_163',['ciot_uart_new',['../ciot__uart_8h.html#a2079bc11f1f437a1a3ce490a7db1d60a',1,'ciot_uart.h']]], - ['ciot_5fuart_5fprocess_5freq_164',['ciot_uart_process_req',['../ciot__uart_8h.html#a20f3b90cb598bec62e64a9fbd3bd399b',1,'ciot_uart.h']]], - ['ciot_5fuart_5fsend_5fbytes_165',['ciot_uart_send_bytes',['../ciot__uart_8h.html#af238f48d206919d750b36dd95a288903',1,'ciot_uart.h']]], - ['ciot_5fuart_5fsend_5fdata_166',['ciot_uart_send_data',['../ciot__uart_8h.html#a7702c9079dcd8a2e07381df4a54245d6',1,'ciot_uart.h']]], - ['ciot_5fuart_5fset_5fbridge_5fmode_167',['ciot_uart_set_bridge_mode',['../ciot__uart_8h.html#ab19c96e5abc4221723935e06a8035794',1,'ciot_uart.h']]], - ['ciot_5fuart_5fstart_168',['ciot_uart_start',['../ciot__uart_8h.html#a0f475e364cbc39bab4dbdb86cbdb347d',1,'ciot_uart.h']]], - ['ciot_5fuart_5fstop_169',['ciot_uart_stop',['../ciot__uart_8h.html#aa59a92031015d710116dd58847aa4207',1,'ciot_uart.h']]], - ['ciot_5fuart_5ftask_170',['ciot_uart_task',['../ciot__uart_8h.html#ac8590fc0ab4c129c57c14a442c922c2f',1,'ciot_uart.h']]], - ['ciot_5fusb_5fnew_171',['ciot_usb_new',['../ciot__usb_8h.html#abfc4f7cd5db3e2e5d94c4cd179d99799',1,'ciot_usb.h']]], - ['ciot_5fusb_5fprocess_5freq_172',['ciot_usb_process_req',['../ciot__usb_8h.html#aa7629e46c3c5f64fd1a03f449c9a62d9',1,'ciot_usb.h']]], - ['ciot_5fusb_5fsend_5fbytes_173',['ciot_usb_send_bytes',['../ciot__usb_8h.html#abae2505d8aed15ad739be049f4180e28',1,'ciot_usb.h']]], - ['ciot_5fusb_5fsend_5fdata_174',['ciot_usb_send_data',['../ciot__usb_8h.html#a1ca6b2b7d2fb270d03110baaafa69875',1,'ciot_usb.h']]], - ['ciot_5fusb_5fset_5fbridge_5fmode_175',['ciot_usb_set_bridge_mode',['../ciot__usb_8h.html#ad2167601e42b510a7c5c23092c4c1d67',1,'ciot_usb.h']]], - ['ciot_5fusb_5fstart_176',['ciot_usb_start',['../ciot__usb_8h.html#a6fc1bc4653f9484b79d7f6eec7b8a22e',1,'ciot_usb.h']]], - ['ciot_5fusb_5fstop_177',['ciot_usb_stop',['../ciot__usb_8h.html#adabdd1e2583c19abdaf9c618ac48744c',1,'ciot_usb.h']]], - ['ciot_5fusb_5ftask_178',['ciot_usb_task',['../ciot__usb_8h.html#a3182f3d52d2ed6b62d50f6b28f72e17e',1,'ciot_usb.h']]], - ['ciot_5fwifi_5fap_5fnew_179',['ciot_wifi_ap_new',['../ciot__wifi_8h.html#aff94df1a4c08ca1cbea37d8dcd3f8777',1,'ciot_wifi.h']]], - ['ciot_5fwifi_5fget_5fmac_180',['ciot_wifi_get_mac',['../ciot__wifi_8h.html#a5817f21b0b8d5b22430f3ecb3c3c37a5',1,'ciot_wifi.h']]], - ['ciot_5fwifi_5fnew_181',['ciot_wifi_new',['../ciot__wifi_8h.html#a07185c8551c5e40a05d113736a72e1d7',1,'ciot_wifi.h']]], - ['ciot_5fwifi_5fprocess_5freq_182',['ciot_wifi_process_req',['../ciot__wifi_8h.html#a37b38c412e4f11696f1e2c03852cc1b7',1,'ciot_wifi.h']]], - ['ciot_5fwifi_5fsend_5fdata_183',['ciot_wifi_send_data',['../ciot__wifi_8h.html#a1444b4045430489fbf88036fe898528a',1,'ciot_wifi.h']]], - ['ciot_5fwifi_5fsta_5fnew_184',['ciot_wifi_sta_new',['../ciot__wifi_8h.html#a57c540c883f21bdfa6d5d0a92584cc90',1,'ciot_wifi.h']]], - ['ciot_5fwifi_5fstart_185',['ciot_wifi_start',['../ciot__wifi_8h.html#af030ec8963d45c8374b58b10d3c83b9a',1,'ciot_wifi.h']]], - ['ciot_5fwifi_5fstop_186',['ciot_wifi_stop',['../ciot__wifi_8h.html#aed26866d40b64a5f80c4769481987cc0',1,'ciot_wifi.h']]], - ['crc32_5fcompute_187',['crc32_compute',['../ciot__utils_8h.html#a3c925cbabcbf9b62b099a9c5d5a054ad',1,'ciot_utils.h']]] -]; diff --git a/docs/html/search/groups_2.js b/docs/html/search/groups_2.js deleted file mode 100644 index f24ba66..0000000 --- a/docs/html/search/groups_2.js +++ /dev/null @@ -1,5 +0,0 @@ -var searchData= -[ - ['hardware_5finterfaces_0',['Hardware_interfaces',['../group__hardware__interfaces.html',1,'']]], - ['hardware_5ftypes_1',['Hardware_types',['../group__hardware__types.html',1,'']]] -]; diff --git a/docs/html/search/groups_3.js b/docs/html/search/groups_3.js deleted file mode 100644 index 017028c..0000000 --- a/docs/html/search/groups_3.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['related_20apis_0',[', uart configuration and communication related apis',['../group__uart__apis.html',1,'']]] -]; diff --git a/docs/html/search/groups_4.js b/docs/html/search/groups_4.js deleted file mode 100644 index b050bdd..0000000 --- a/docs/html/search/groups_4.js +++ /dev/null @@ -1,5 +0,0 @@ -var searchData= -[ - ['software_5finterfaces_0',['Software_interfaces',['../group__software__interfaces.html',1,'']]], - ['software_5ftypes_1',['Software_types',['../group__software__types.html',1,'']]] -]; diff --git a/docs/html/search/groups_5.js b/docs/html/search/groups_5.js deleted file mode 100644 index 5654282..0000000 --- a/docs/html/search/groups_5.js +++ /dev/null @@ -1,5 +0,0 @@ -var searchData= -[ - ['uart_20configuration_20and_20communication_20related_20apis_0',[', uart configuration and communication related apis',['../group__uart__apis.html',1,'']]], - ['utils_1',['Utils',['../group___utils.html',1,'']]] -]; diff --git a/docs/html/search/groups_6.js b/docs/html/search/groups_6.js deleted file mode 100644 index 5654282..0000000 --- a/docs/html/search/groups_6.js +++ /dev/null @@ -1,5 +0,0 @@ -var searchData= -[ - ['uart_20configuration_20and_20communication_20related_20apis_0',[', uart configuration and communication related apis',['../group__uart__apis.html',1,'']]], - ['utils_1',['Utils',['../group___utils.html',1,'']]] -]; diff --git a/docs/html/structpacked.html b/docs/html/structpacked.html deleted file mode 100644 index d203f42..0000000 --- a/docs/html/structpacked.html +++ /dev/null @@ -1,5438 +0,0 @@ - - - - - - - -CioT: packed Union Reference - - - - - - - - - - - - - - - -
-
- - - - - - -
-
CioT 0.1.0 -
-
Connected IoT
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
-Data Fields
-
packed Union Reference
-
-
- -

Structure for CIOT BLE status message. - More...

- -

#include <ciot_ble.h>

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Data Fields

ciot_msg_header_t header
 Message header.
 
ciot_ble_status_t status
 
ciot_ble_scn_status_t status
 
ciot_bridge_status_t status
 
ciot_dfu_status_t status
 
ciot_tcp_status_t status
 
ciot_gpio_status_t status
 
ciot_httpc_status_t status
 
ciot_https_status_t status
 
ciot_msg_t msg
 
uint8_t payload [sizeof(ciot_msg_t)]
 
ciot_iface_event_type_t type
 
ciot_iface_event_data_u * data
 
uint16_t size
 
ciot_mqttc_status_t status
 
ciot_ntp_status_t status
 
ciot_opcuas_status_t status
 
ciot_ota_status_t status
 
ciot_storage_status_t status
 
ciot_sys_status_t status
 
ciot_uart_status_t status
 
ciot_usb_status_t status
 
ciot_wifi_status_t status
 Wi-Fi status.
 
uint16_t interval
 
uint16_t window
 
uint16_t timeout
 
uint8_t active: 1
 
uint8_t brigde_mode: 1
 
uint8_t reserved: 6
 
uint8_t mac [6]
 
int8_t rssi
 
ciot_ble_scn_state_t state
 
ciot_ble_scn_adv_info_t adv_info
 
int err_code
 
ciot_ble_scn_req_type_t type
 
ciot_ble_scn_req_data_u data
 
ciot_ble_scn_cfg_t config
 
ciot_ble_scn_req_t request
 
uint8_t hw_mac [6]
 
uint8_t sw_mac [6]
 
ciot_ble_state_t state
 
ciot_ble_info_t info
 
uint8_t set_mac [6]
 
ciot_ble_req_type_t type
 
ciot_ble_req_data_u data
 
ciot_ble_cfg_t config
 
ciot_ble_req_t request
 
uint8_t ifaces_id [2]
 
ciot_bridge_state_t state
 
ciot_bridge_req_type_t type
 
ciot_bridge_req_data_u data
 
ciot_bridge_cfg_t config
 
ciot_bridge_req_t request
 
ciot_data_model_state_t state
 
ciot_data_model_req_type_t type
 
ciot_data_model_req_data_u data
 
ciot_data_model_cfg_t config
 
ciot_data_model_status_t status
 
ciot_data_model_req_t request
 
ciot_dfu_state_t state
 
int code
 
int error
 
uint32_t image_size
 
uint32_t image_read
 
ciot_dfu_req_type_t type
 
ciot_dfu_req_data_u data
 
ciot_dfu_cfg_t config
 
ciot_dfu_req_t request
 
uint64_t pin_mask
 
ciot_gpio_mode_t mode
 
ciot_gpio_pull_mode_t pull
 
uint64_t status_mask
 
uint32_t num
 
ciot_gpio_state_t state
 
ciot_gpio_cfg_t config
 
ciot_gpio_state_info_t set_state
 
ciot_gpio_req_get_state_t get_state
 
ciot_gpio_req_type_t type
 
ciot_gpio_req_data_u data
 
ciot_gpio_req_t request
 
char url [CIOT_HTTPC_URL_LEN]
 
ciot_httpc_method_t method
 
ciot_httpc_transport_type_t transport
 
ciot_httpc_state_t state
 
ciot_httpc_cfg_t cfg
 
uint8_t body [CIOT_HTTPC_BODY_LEN]
 
int content_length
 
char header [CIOT_HTTPC_HEADER_LEN]
 
char value [CIOT_HTTPC_HEADER_VAL]
 
ciot_httpc_req_type_t type
 
ciot_httpc_req_data_u data
 
ciot_httpc_cfg_t config
 
ciot_httpc_req_t request
 
ciot_httpc_event_u event
 
char address [CIOT_HTTPS_ADDRESS_LEN]
 
char route [CIOT_HTTPS_ROUTE_LEN]
 
int port
 
ciot_https_state_t state
 
ciot_https_req_type_t type
 
ciot_https_cfg_t config
 
ciot_https_req_t request
 
ciot_https_event_u event
 
int tls_last_err
 
int tls_stack_err
 
int tls_cert_verify_flags
 
int type
 
int transport_sock
 
char d2b [CIOT_CONFIG_MQTT_TOPIC_LEN]
 
char b2d [CIOT_CONFIG_MQTT_TOPIC_LEN]
 
char client_id [CIOT_CONFIG_MQTT_CLIENT_ID_LEN]
 
char user [CIOT_CONFIG_MQTT_USER_LEN]
 
char pass [CIOT_CONFIG_MQTT_PASS_LEN]
 
uint32_t port
 
uint8_t qos
 
ciot_mqttc_transport_t transport
 
ciot_mqttc_topics_cfg_t topics
 
ciot_mqttc_state_t state
 
uint8_t conn_count
 
uint16_t data_rate
 
time_t last_msg_time
 
ciot_mqttc_error_t error
 
char topic [CIOT_CONFIG_MQTT_TOPIC_LEN]
 
uint8_t msg [CIOT_CONFIG_MQTT_MSG_LEN]
 
int size
 
ciot_mqttc_req_publish_t publish
 
ciot_mqttc_req_subscribe_t subscribe
 
ciot_mqttc_req_type_t type
 
ciot_mqttc_req_data_u data
 
ciot_mqttc_cfg_t config
 
ciot_mqttc_req_t request
 
ciot_mqttc_event_u event
 
uint8_t id
 
ciot_msg_iface_type_t type
 
ciot_msg_type_t msg_type
 
uint32_t code
 
ciot_data_u ciot
 
ciot_storage_data_u storage
 
ciot_sys_data_u system
 
ciot_uart_data_u uart
 
ciot_usb_data_u usb
 
ciot_tcp_data_u tcp
 
ciot_wifi_data_u wifi
 
ciot_ble_data_u ble
 
ciot_ble_scn_data_u ble_scn
 
ciot_ntp_data_u ntp
 
ciot_ota_data_u ota
 
ciot_dfu_data_u dfu
 
ciot_https_data_u https
 
ciot_httpc_data_u httpc
 
ciot_mqttc_data_u mqtt
 
ciot_bridge_data_u bridge
 
ciot_msg_error_t error
 
ciot_msg_type_t type
 
ciot_msg_iface_info_t iface
 
ciot_msg_data_u data
 
uint8_t op_mode
 
uint8_t sync_mode
 
uint32_t sync_interval
 
char timezone [16]
 
char server [CIOT_CONFIG_NTP_SERVERS_COUNT][64]
 
ciot_ntp_state_t state
 
uint64_t last_sync
 
uint16_t sync_count
 
uint8_t init: 1
 
uint8_t sync: 1
 
uint8_t reserve: 6
 
ciot_ntp_req_type_t type
 
ciot_ntp_req_data_u data
 
ciot_ntp_cfg_t config
 
ciot_ntp_req_t request
 
ciot_opcuas_state_t state
 
uint16_t type
 
char localization [8]
 
char display_name [32]
 
char node_id [64]
 
ciot_opcuas_req_add_node_t add_node
 
ciot_opcuas_req_type_t type
 
ciot_opcuas_req_data_u data
 
ciot_opcuas_cfg_t config
 
ciot_opcuas_req_t request
 
uint8_t force:1
 
uint8_t encrypted:1
 
uint8_t restart:1
 
ciot_ota_state_t state
 
ciot_ota_req_type_t type
 
ciot_ota_req_data_u data
 
ciot_ota_cfg_t config
 
ciot_ota_req_t request
 
ciot_storage_type_t type
 
ciot_storage_state_t state
 
char path [16]
 
uint8_t size
 
uint8_t data [255]
 
ciot_storage_req_type_t type
 
ciot_storage_req_file_data_t data
 
ciot_storage_cfg_t config
 
ciot_storage_req_t request
 
uint16_t storage: 1
 
uint16_t system: 1
 
uint16_t uart: 1
 
uint16_t usb: 1
 
uint16_t ethernet: 1
 
uint16_t wifi: 1
 
uint16_t ble_scn: 1
 
uint16_t gpio: 1
 
uint16_t reserved: 8
 
uint16_t ntp: 1
 
uint16_t ota: 1
 
uint16_t dfu: 1
 
uint16_t http_client: 1
 
uint16_t http_server: 1
 
uint16_t mqtt_client: 1
 
uint16_t timer: 1
 
uint16_t serializer: 1
 
ciot_sys_hw_features_t hw
 
ciot_sys_sw_features_t sw
 
char hw_name [16]
 
uint8_t app_ver [3]
 
ciot_sys_hw_t hardware
 
ciot_sys_features_t features
 
uint8_t rst_reason
 
uint8_t rst_count
 
uint32_t free_memory
 
uint32_t lifetime
 
ciot_sys_info_t info
 
ciot_sys_req_type_t type
 
ciot_sys_req_data_u data
 
ciot_sys_cfg_t config
 
ciot_sys_req_t request
 
ciot_tcp_dhcp_cfg_t dhcp
 
uint8_t ip [4]
 
uint8_t gateway [4]
 
uint8_t mask [4]
 
uint8_t dns [4]
 
ciot_tcp_dhcp_state_t client
 
ciot_tcp_dhcp_state_t server
 
ciot_tcp_state_t state
 
ciot_tcp_dhcp_status_t dhcp
 
ciot_tcp_info_t info
 
ciot_tcp_req_type_t type
 
ciot_tcp_req_data_u data
 
ciot_tcp_cfg_t config
 
ciot_tcp_req_t request
 
uint8_t version [3]
 
ciot_state_t state
 
ciot_info_t info
 
uint8_t iface_id
 
uint32_t err
 
uint8_t iface
 
ciot_req_save_iface_cfg_t save_iface_cfg
 
ciot_req_delete_iface_cfg_t delete_iface_cfg
 
ciot_req_proxy_msg_t proxy_msg
 
ciot_req_result_t result
 
ciot_req_type_t type
 
ciot_req_data_u data
 
ciot_iface_cfg_t config
 
ciot_status_t status
 
ciot_req_t request
 
uint32_t baud_rate
 
uint8_t num
 
int8_t rx_pin
 
int8_t tx_pin
 
int8_t rts_pin
 
int8_t cts_pin
 
uint16_t parity
 
uint8_t flow_control: 1
 
uint8_t dtr: 1
 
uint8_t bridge_mode: 1
 
ciot_uart_state_t state
 
ciot_uart_error_t error
 
ciot_uart_req_send_data_t send_data
 
ciot_uart_req_type_t type
 
ciot_uart_req_data_u data
 
ciot_uart_cfg_t config
 
ciot_uart_req_t request
 
ciot_uart_event_u event
 
bool bridge_mode
 
ciot_usb_state_t state
 
ciot_usb_req_type_t type
 
ciot_usb_req_data_u data
 
ciot_usb_cfg_t config
 
ciot_usb_req_t request
 
ciot_usb_event_u event
 
uint8_t bssid [6]
 
char ssid [33]
 
uint8_t authmode
 
char password [64]
 
ciot_wifi_type_t type
 
ciot_tcp_cfg_t tcp
 
uint8_t disconnect_reason
 
ciot_wifi_ap_info_t info
 
ciot_tcp_status_t tcp
 
uint8_t count
 
ciot_wifi_ap_info_t ap_list [8]
 
ciot_wifi_scan_result_t scan_result
 
ciot_wifi_req_type_t type
 
ciot_wifi_req_data_u data
 
ciot_wifi_cfg_t config
 
ciot_wifi_req_t request
 
-

Detailed Description

-

Structure for CIOT BLE status message.

-

Union for CIOT WiFi data.

-

Structure for CIOT WiFi request.

-

Union for CIOT WiFi request data.

-

Structure for CIOT WiFi scan result.

-

Structure for CIOT WiFi status.

-

Structure for CIOT WiFi configuration.

-

Structure for CIOT WiFi access point information.

-

Union for CIOT USB data.

-

Structure for CIOT USB request.

-

Union for CIOT USB request data.

-

Structure for CIOT USB status.

-

Structure for CIOT USB configuration.

-

Union for CIOT UART data.

-

Structure for CIOT UART request.

-

Union for CIOT UART request data.

-

Structure for CIOT UART send data request.

-

Structure for CIOT UART status.

-

Structure for CIOT UART configuration.

-

Union for CIOT data.

-

Structure for CIOT request.

-

Union for CIOT request data.

-

Structure for CIOT proxy message request.

-

Structure for CIOT request result.

-

Structure for CIOT delete interface configuration request.

-

Structure for CIOT save interface configuration request.

-

Structure for CIOT status.

-

Structure for CIOT information.

-

Structure for CIOT interface configuration.

-

Union for CIOT TCP data.

-

Structure for CIOT TCP request.

-

Union for CIOT TCP request data.

-

Structure for CIOT TCP status.

-

Structure for CIOT TCP information.

-

Structure for CIOT TCP DHCP status.

-

Structure for CIOT TCP configuration.

-

Union for CIOT system data.

-

Structure for CIOT system request.

-

Union for CIOT system request data.

-

Structure for CIOT system configuration.

-

Structure for CIOT system status.

-

Structure for CIOT system information.

-

Structure for CIOT system features combining hardware and software features.

-

Structure for CIOT system software features.

-

Structure for CIOT system hardware features.

-

Union for CIOT storage data.

-

Structure for CIOT storage request.

-

Structure for CIOT storage file data in a request.

-

Structure for CIOT storage status.

-

Structure for CIOT storage configuration.

-

Union for CIOT OTA data.

-

Structure for CIOT OTA request.

-

Union for CIOT OTA request data.

-

Structure for CIOT OTA status.

-

Structure for CIOT OTA configuration.

-

Union for CIOT OPC UA Server data.

-

Structure for CIOT OPC UA Server request.

-

Union for CIOT OPC UA Server request data.

-

Structure for CIOT OPC UA Server add node request.

-

Structure for CIOT OPC UA Server status.

-

Structure for CIOT OPC UA Server configuration.

-

Union for CIOT NTP data.

-

Structure for CIOT NTP request.

-

Union for CIOT NTP request data.

-

Structure for CIOT NTP status.

-

Structure for CIOT NTP configuration.

-

Structure for CIOT message.

-

Structure for CIOT message header.

-

Union for CIOT message data.

-

Structure for CIOT message error information.

-

Structure for CIOT message interface information.

-

Union for CIOT MQTT client data.

-

Structure for CIOT MQTT client request.

-

Union for CIOT MQTT client request data.

-

Structure for CIOT MQTT client subscribe request.

-

Structure for CIOT MQTT client publish request.

-

Structure for CIOT MQTT client status.

-

Structure for CIOT MQTT client configuration.

-

Structure for CIOT MQTT client topics configuration.

-

Structure for CIOT MQTT client error information.

-

Union for CIOT HTTP server data.

-

Structure for CIOT HTTP server request.

-

Union for CIOT HTTP server request data.

-

Structure for CIOT HTTP server status.

-

Structure for CIOT HTTP server configuration.

-

Union for CIOT HTTP client data.

-

Structure for CIOT HTTP client request.

-

Structure for CIOT HTTP client set header request.

-

Structure for CIOT HTTP client send data request.

-

Structure for CIOT HTTP client status.

-

Structure for CIOT HTTP client configuration.

-

Union for CIOT GPIO data.

-

Structure for CIOT GPIO request.

-

Union for CIOT GPIO request data.

-

Structure for CIOT GPIO request to get state.

-

Structure for CIOT GPIO state information.

-

Structure for CIOT GPIO status.

-

Structure for CIOT GPIO configuration.

-

Union for CIOT DFU data.

-

Structure for CIOT DFU request.

-

Union for CIOT DFU request data.

-

Structure for CIOT DFU status.

-

Union for CIOT data model data.

-

Structure for CIOT data model request.

-

Union for CIOT data model request data.

-

Structure for CIOT data model status.

-

Structure for CIOT data model configuration.

-

Union for CIOT bridge data.

-

Structure for CIOT bridge request.

-

Union for CIOT bridge request data.

-

Structure for CIOT bridge status.

-

Structure for CIOT bridge configuration.

-

Union for CIOT BLE data.

-

Structure for CIOT BLE request.

-

Union for CIOT BLE request data.

-

Structure for CIOT BLE status.

-

Structure for CIOT BLE information.

-

Structure for CIOT BLE configuration.

-

Union for CIOT BLE SCN data.

-

Structure for CIOT BLE SCN request.

-

Union for CIOT BLE SCN request data.

-

Structure for CIOT BLE SCN status.

-

Structure for CIOT BLE SCN advertising information.

-

Structure for CIOT BLE SCN configuration.

-

Packed structure for Wi-Fi status message.

-

Status message structure for CIOT USB module.

-

Status message structure for CIOT UART module.

-

CIOT TCP status message structure.

-

CIOT System status message structure.

-

CIOT Storage status message structure.

-

Structure for CIOT OTA status message.

-

Structure for CIOT OPCUAS status message.

-

Structure for CIOT NTP status message.

-

Structure representing a CIOT MQTT client status message.

-

Structure representing an interface event.

-

Union for CIOT interface event data.

-

Structure representing the CIOT HTTP server status message.

-

Structure representing the CIOT HTTP client status message.

-

Structure representing the CIOT GPIO status message.

-

Structure representing the CIOT Ethernet status message.

-

Struct for DFU status message.

-

Structure for CIOT Bridge status message.

-

Structure for CIOT BLE scanner status message.

-

Field Documentation

- -

◆ active

- -
-
- - - - -
uint8_t active
-
-

Active flag

- -
-
- -

◆ add_node

- -
-
- - - - -
ciot_opcuas_req_add_node_t add_node
-
-

Add node request data

- -
-
- -

◆ address

- -
-
- - - - -
char address[CIOT_HTTPS_ADDRESS_LEN]
-
-

Address

- -
-
- -

◆ adv_info

- -
-
- - - - -
ciot_ble_scn_adv_info_t adv_info
-
-

Advertising information

- -
-
- -

◆ ap_list

- -
-
- - - - -
ciot_wifi_ap_info_t ap_list[8]
-
-

Access point list

- -
-
- -

◆ app_ver

- -
-
- - - - -
uint8_t app_ver[3]
-
-

Application version

- -
-
- -

◆ authmode

- -
-
- - - - -
uint8_t authmode
-
-

Authentication mode

- -
-
- -

◆ b2d

- -
-
- - - - -
char b2d[CIOT_CONFIG_MQTT_TOPIC_LEN]
-
-

Broker to device topic

- -
-
- -

◆ baud_rate

- -
-
- - - - -
uint32_t baud_rate
-
-

Baud rate

- -
-
- -

◆ ble

- -
-
- - - - -
ciot_ble_data_u ble
-
-

BLE data

- -
-
- -

◆ ble_scn [1/2]

- -
-
- - - - -
ciot_ble_scn_data_u ble_scn
-
-

BLE SCN data

- -
-
- -

◆ ble_scn [2/2]

- -
-
- - - - -
uint16_t ble_scn
-
-

BLE SCN (Serial Control) feature

- -
-
- -

◆ body

- -
-
- - - - -
uint8_t body[CIOT_HTTPC_BODY_LEN]
-
-

Body

- -
-
- -

◆ bridge

- -
-
- - - - -
ciot_bridge_data_u bridge
-
-

Bridge data

- -
-
- -

◆ bridge_mode [1/2]

- -
-
- - - - -
uint8_t bridge_mode
-
-

Bridge mode flag

- -
-
- -

◆ bridge_mode [2/2]

- -
-
- - - - -
bool bridge_mode
-
-

Bridge mode flag

- -
-
- -

◆ brigde_mode

- -
-
- - - - -
uint8_t brigde_mode
-
-

Bridge mode flag

- -
-
- -

◆ bssid

- -
-
- - - - -
uint8_t bssid[6]
-
-

BSSID

- -
-
- -

◆ cfg

- -
-
- - - - -
ciot_httpc_cfg_t cfg
-
-

Configuration

- -
-
- -

◆ ciot

- -
-
- - - - -
ciot_data_u ciot
-
-

CIOT data

- -
-
- -

◆ client

- -
-
- - - - -
ciot_tcp_dhcp_state_t client
-
-

DHCP client state

- -
-
- -

◆ client_id

- -
-
- - - - -
char client_id[CIOT_CONFIG_MQTT_CLIENT_ID_LEN]
-
-

Client ID

- -
-
- -

◆ code [1/2]

- -
-
- - - - -
int code
-
-

Code

-

Error code

- -
-
- -

◆ code [2/2]

- -
-
- - - - -
uint32_t code
-
-

Error code

- -
-
- -

◆ config [1/19]

- -
-
- - - - -
ciot_gpio_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [2/19]

- -
-
- - - - -
ciot_ble_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [3/19]

- -
-
- - - - -
ciot_bridge_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [4/19]

- -
-
- - - - -
ciot_data_model_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [5/19]

- -
-
- - - - -
ciot_dfu_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [6/19]

- -
-
- - - - -
ciot_gpio_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [7/19]

- -
-
- - - - -
ciot_httpc_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [8/19]

- -
-
- - - - -
ciot_https_cfg_t config
-
-

Configuration

- -
-
- -

◆ config [9/19]

- -
-
- - - - -
ciot_mqttc_cfg_t config
-
-

Configuration data

- -
-
- -

◆ config [10/19]

- -
-
- - - - -
ciot_ntp_cfg_t config
-
-

NTP configuration

- -
-
- -

◆ config [11/19]

- -
-
- - - - -
ciot_opcuas_cfg_t config
-
-

OPC UA Server configuration

- -
-
- -

◆ config [12/19]

- -
-
- - - - -
ciot_ota_cfg_t config
-
-

OTA configuration

- -
-
- -

◆ config [13/19]

- -
-
- - - - -
ciot_storage_cfg_t config
-
-

Storage configuration

- -
-
- -

◆ config [14/19]

- -
-
- - - - -
ciot_sys_cfg_t config
-
-

System configuration

- -
-
- -

◆ config [15/19]

- -
-
- - - - -
ciot_tcp_cfg_t config
-
-

TCP configuration

- -
-
- -

◆ config [16/19]

- -
-
- - - - -
ciot_iface_cfg_t config
-
-

Configuration data

- -
-
- -

◆ config [17/19]

- -
-
- - - - -
ciot_uart_cfg_t config
-
-

Configuration data

- -
-
- -

◆ config [18/19]

- -
-
- - - - -
ciot_usb_cfg_t config
-
-

Configuration data

- -
-
- -

◆ config [19/19]

- -
-
- - - - -
ciot_wifi_cfg_t config
-
-

Configuration data

- -
-
- -

◆ conn_count

- -
-
- - - - -
uint8_t conn_count
-
-

Connection count

- -
-
- -

◆ content_length

- -
-
- - - - -
int content_length
-
-

Content length

- -
-
- -

◆ count

- -
-
- - - - -
uint8_t count
-
-

Number of access points

- -
-
- -

◆ cts_pin

- -
-
- - - - -
int8_t cts_pin
-
-

CTS pin

- -
-
- -

◆ d2b

- -
-
- - - - -
char d2b[CIOT_CONFIG_MQTT_TOPIC_LEN]
-
-

Device to broker topic

- -
-
- -

◆ data [1/21]

- -
-
- - - - -
uint8_t data
-
-

Event data.

-

Message data

-

Data buffer

- -
-
- -

◆ data [2/21]

- -
-
- - - - -
ciot_ble_scn_req_data_u data
-
-

Request data

- -
-
- -

◆ data [3/21]

- -
-
- - - - -
ciot_ble_req_data_u data
-
-

Request data

- -
-
- -

◆ data [4/21]

- -
-
- - - - -
ciot_bridge_req_data_u data
-
-

Request data

- -
-
- -

◆ data [5/21]

- -
-
- - - - -
ciot_data_model_req_data_u data
-
-

Request data

- -
-
- -

◆ data [6/21]

- -
-
- - - - -
ciot_dfu_req_data_u data
-
-

Request data

- -
-
- -

◆ data [7/21]

- -
-
- - - - -
ciot_gpio_req_data_u data
-
-

Request data

- -
-
- -

◆ data [8/21]

- -
-
- - - - -
ciot_httpc_req_data_u data
-
-

Request data

- -
-
- -

◆ data [9/21]

- -
-
- - - - -
ciot_mqttc_req_data_u data
-
-

Request data

- -
-
- -

◆ data [10/21]

- -
-
- - - - -
ciot_msg_data_u data
-
-

Message data

- -
-
- -

◆ data [11/21]

- -
-
- - - - -
ciot_ntp_req_data_u data
-
-

Request data

- -
-
- -

◆ data [12/21]

- -
-
- - - - -
ciot_opcuas_req_data_u data
-
-

Request data

- -
-
- -

◆ data [13/21]

- -
-
- - - - -
ciot_ota_req_data_u data
-
-

Request data

- -
-
- -

◆ data [14/21]

- -
-
- - - - -
uint8_t data[255]
-
-

Data content

-

Message data

-

Data buffer

- -
-
- -

◆ data [15/21]

- -
-
- - - - -
ciot_storage_req_file_data_t data
-
-

Request data

- -
-
- -

◆ data [16/21]

- -
-
- - - - -
ciot_sys_req_data_u data
-
-

Request data

- -
-
- -

◆ data [17/21]

- -
-
- - - - -
ciot_tcp_req_data_u data
-
-

Request data

- -
-
- -

◆ data [18/21]

- -
-
- - - - -
ciot_req_data_u data
-
-

Request data

- -
-
- -

◆ data [19/21]

- -
-
- - - - -
ciot_uart_req_data_u data
-
-

Request data

- -
-
- -

◆ data [20/21]

- -
-
- - - - -
ciot_usb_req_data_u data
-
-

Request data

- -
-
- -

◆ data [21/21]

- -
-
- - - - -
ciot_wifi_req_data_u data
-
-

Request data

- -
-
- -

◆ data_rate

- -
-
- - - - -
uint16_t data_rate
-
-

Data rate

- -
-
- -

◆ delete_iface_cfg

- -
-
- - - - -
ciot_req_delete_iface_cfg_t delete_iface_cfg
-
-

Delete interface configuration request data

- -
-
- -

◆ dfu [1/2]

- -
-
- - - - -
ciot_dfu_data_u dfu
-
-

DFU data

- -
-
- -

◆ dfu [2/2]

- -
-
- - - - -
uint16_t dfu
-
-

DFU (Device Firmware Update) feature

- -
-
- -

◆ dhcp [1/2]

- -
-
- - - - -
ciot_tcp_dhcp_cfg_t dhcp
-
-

DHCP configuration

- -
-
- -

◆ dhcp [2/2]

- -
-
- - - - -
ciot_tcp_dhcp_status_t dhcp
-
-

DHCP status

- -
-
- -

◆ disconnect_reason

- -
-
- - - - -
uint8_t disconnect_reason
-
-

Disconnect reason

- -
-
- -

◆ display_name

- -
-
- - - - -
char display_name[32]
-
-

Display name

- -
-
- -

◆ dns

- -
-
- - - - -
uint8_t dns[4]
-
-

DNS address

- -
-
- -

◆ dtr

- -
-
- - - - -
uint8_t dtr
-
-

DTR flag

- -
-
- -

◆ encrypted

- -
-
- - - - -
uint8_t encrypted
-
-

Flag for encrypted update

- -
-
- -

◆ err

- -
-
- - - - -
uint32_t err
-
-

Error code

- -
-
- -

◆ err_code

- -
-
- - - - -
int err_code
-
-

Error code

- -
-
- -

◆ error [1/4]

- -
-
- - - - -
int error
-
-

Error

-

Error code

- -
-
- -

◆ error [2/4]

- -
-
- - - - -
ciot_mqttc_error_t error
-
-

Error information

- -
-
- -

◆ error [3/4]

- -
-
- - - - -
ciot_msg_error_t error
-
-

Error data

- -
-
- -

◆ error [4/4]

- -
-
- - - - -
ciot_uart_error_t error
-
-

UART error

- -
-
- -

◆ ethernet

- -
-
- - - - -
uint16_t ethernet
-
-

Ethernet feature

- -
-
- -

◆ event [1/5]

- -
-
- - - - -
ciot_httpc_event_u event
-
-

Event

- -
-
- -

◆ event [2/5]

- -
-
- - - - -
ciot_https_event_u event
-
-

Event

- -
-
- -

◆ event [3/5]

- -
-
- - - - -
ciot_mqttc_event_u event
-
-

Event data

- -
-
- -

◆ event [4/5]

- -
-
- - - - -
ciot_uart_event_u event
-
-

Event data

- -
-
- -

◆ event [5/5]

- -
-
- - - - -
ciot_usb_event_u event
-
-

Event data

- -
-
- -

◆ features

- -
-
- - - - -
ciot_sys_features_t features
-
-

System features

- -
-
- -

◆ flow_control

- -
-
- - - - -
uint8_t flow_control
-
-

Flow control flag

- -
-
- -

◆ force

- -
-
- - - - -
uint8_t force
-
-

Flag for forcing update

- -
-
- -

◆ free_memory

- -
-
- - - - -
uint32_t free_memory
-
-

Free memory

- -
-
- -

◆ gateway

- -
-
- - - - -
uint8_t gateway[4]
-
-

Gateway address

- -
-
- -

◆ get_state

- -
-
- - - - -
ciot_gpio_req_get_state_t get_state
-
-

Get state request

- -
-
- -

◆ gpio

- -
-
- - - - -
uint16_t gpio
-
-

GPIO feature

- -
-
- -

◆ hardware

- -
-
- - - - -
ciot_sys_hw_t hardware
-
-

Hardware type

- -
-
- -

◆ header [1/2]

- -
-
- - - - -
ciot_msg_header_t header
-
- -

Message header.

-

Message header

-

Header for the DFU status message.

-

Message header.

-

Header information.

- -
-
- -

◆ header [2/2]

- -
-
- - - - -
char header[CIOT_HTTPC_HEADER_LEN]
-
-

Header

- -
-
- -

◆ http_client

- -
-
- - - - -
uint16_t http_client
-
-

HTTP client feature

- -
-
- -

◆ http_server

- -
-
- - - - -
uint16_t http_server
-
-

HTTP server feature

- -
-
- -

◆ httpc

- -
-
- - - - -
ciot_httpc_data_u httpc
-
-

HTTP client data

- -
-
- -

◆ https

- -
-
- - - - -
ciot_https_data_u https
-
-

HTTP server data

- -
-
- -

◆ hw

- -
-
- - - - -
ciot_sys_hw_features_t hw
-
-

Hardware features

- -
-
- -

◆ hw_mac

- -
-
- - - - -
uint8_t hw_mac[6]
-
-

Hardware MAC address

- -
-
- -

◆ hw_name

- -
-
- - - - -
char hw_name[16]
-
-

Hardware name

- -
-
- -

◆ id

- -
-
- - - - -
uint8_t id
-
-

Interface ID

-

Message ID

- -
-
- -

◆ iface [1/2]

- -
-
- - - - -
ciot_msg_iface_info_t iface
-
-

Interface information

- -
-
- -

◆ iface [2/2]

- -
-
- - - - -
uint8_t iface
-
-

Interface

- -
-
- -

◆ iface_id

- -
-
- - - - -
uint8_t iface_id
-
-

Interface ID

- -
-
- -

◆ ifaces_id

- -
-
- - - - -
uint8_t ifaces_id[2]
-
-

Interface IDs

- -
-
- -

◆ image_read

- -
-
- - - - -
uint32_t image_read
-
-

Image read

-

Number of bytes read

- -
-
- -

◆ image_size

- -
-
- - - - -
uint32_t image_size
-
-

Image size

-

Size of the image

- -
-
- -

◆ info [1/5]

- -
-
- - - - -
ciot_ble_info_t info
-
-

Information

- -
-
- -

◆ info [2/5]

- -
-
- - - - -
ciot_sys_info_t info
-
-

System information

- -
-
- -

◆ info [3/5]

- -
-
- - - - -
ciot_tcp_info_t info
-
-

TCP information

- -
-
- -

◆ info [4/5]

- -
-
- - - - -
ciot_info_t info
-
-

CIOT information

- -
-
- -

◆ info [5/5]

- -
-
- - - - -
ciot_wifi_ap_info_t info
-
-

Access point information

- -
-
- -

◆ init

- -
-
- - - - -
uint8_t init
-
-

Initialization flag

- -
-
- -

◆ interval

- -
-
- - - - -
uint16_t interval
-
-

Interval value

- -
-
- -

◆ ip

- -
-
- - - - -
uint8_t ip
-
-

IP address

- -
-
- -

◆ last_msg_time

- -
-
- - - - -
time_t last_msg_time
-
-

Last message time

- -
-
- -

◆ last_sync

- -
-
- - - - -
uint64_t last_sync
-
-

Last synchronization timestamp

- -
-
- -

◆ lifetime

- -
-
- - - - -
uint32_t lifetime
-
-

System lifetime

- -
-
- -

◆ localization

- -
-
- - - - -
char localization[8]
-
-

Localization

- -
-
- -

◆ mac

- -
-
- - - - -
uint8_t mac
-
-

MAC address

- -
-
- -

◆ mask

- -
-
- - - - -
uint8_t mask[4]
-
-

Subnet mask

- -
-
- -

◆ method

- -
-
- - - - -
ciot_httpc_method_t method
-
-

HTTP method

- -
-
- -

◆ mode

- -
-
- - - - -
ciot_gpio_mode_t mode
-
-

Mode

- -
-
- -

◆ mqtt

- -
-
- - - - -
ciot_mqttc_data_u mqtt
-
-

MQTT client data

- -
-
- -

◆ mqtt_client

- -
-
- - - - -
uint16_t mqtt_client
-
-

MQTT client feature

- -
-
- -

◆ msg [1/2]

- -
-
- - - - -
ciot_msg_t msg
-
-

CIOT message.

- -
-
- -

◆ msg [2/2]

- -
-
- - - - -
uint8_t msg[CIOT_CONFIG_MQTT_MSG_LEN]
-
-

MQTT message

- -
-
- -

◆ msg_type

- -
-
- - - - -
ciot_msg_type_t msg_type
-
-

Message type

- -
-
- -

◆ node_id

- -
-
- - - - -
char node_id[64]
-
-

Node ID

- -
-
- -

◆ ntp [1/2]

- -
-
- - - - -
ciot_ntp_data_u ntp
-
-

NTP data

- -
-
- -

◆ ntp [2/2]

- -
-
- - - - -
uint16_t ntp
-
-

NTP (Network Time Protocol) feature

- -
-
- -

◆ num [1/2]

- -
-
- - - - -
uint32_t num
-
-

Number

- -
-
- -

◆ num [2/2]

- -
-
- - - - -
uint8_t num
-
-

UART number

- -
-
- -

◆ op_mode

- -
-
- - - - -
uint8_t op_mode
-
-

Operation mode

- -
-
- -

◆ ota [1/2]

- -
-
- - - - -
ciot_ota_data_u ota
-
-

OTA data

- -
-
- -

◆ ota [2/2]

- -
-
- - - - -
uint16_t ota
-
-

OTA (Over-The-Air) update feature

- -
-
- -

◆ parity

- -
-
- - - - -
uint16_t parity
-
-

Parity

- -
-
- -

◆ pass

- -
-
- - - - -
char pass[CIOT_CONFIG_MQTT_PASS_LEN]
-
-

MQTT password

- -
-
- -

◆ password

- -
-
- - - - -
char password[64]
-
-

Password

- -
-
- -

◆ path

- -
-
- - - - -
char path[16]
-
-

File path

- -
-
- -

◆ payload

- -
-
- - - - -
uint8_t payload
-
-

Payload data.

-

Payload data

- -
-
- -

◆ pin_mask

- -
-
- - - - -
uint64_t pin_mask
-
-

Pin mask

- -
-
- -

◆ port [1/2]

- -
-
- - - - -
uint32_t port
-
-

Port

-

Port number

- -
-
- -

◆ port [2/2]

- -
-
- - - - -
uint32_t port
-
-

MQTT port

-

Port number

- -
-
- -

◆ proxy_msg

- -
-
- - - - -
ciot_req_proxy_msg_t proxy_msg
-
-

Proxy message request data

- -
-
- -

◆ publish

- -
-
- - - - -
ciot_mqttc_req_publish_t publish
-
-

Publish request data

- -
-
- -

◆ pull

- -
-
- - - - -
ciot_gpio_pull_mode_t pull
-
-

Pull mode

- -
-
- -

◆ qos

- -
-
- - - - -
uint8_t qos
-
-

MQTT quality of service

-

Quality of service

- -
-
- -

◆ request [1/19]

- -
-
- - - - -
ciot_ble_scn_req_t request
-
-

Request

- -
-
- -

◆ request [2/19]

- -
-
- - - - -
ciot_ble_req_t request
-
-

Request

- -
-
- -

◆ request [3/19]

- -
-
- - - - -
ciot_bridge_req_t request
-
-

Request

- -
-
- -

◆ request [4/19]

- -
-
- - - - -
ciot_data_model_req_t request
-
-

Request

- -
-
- -

◆ request [5/19]

- -
-
- - - - -
ciot_dfu_req_t request
-
-

Request

- -
-
- -

◆ request [6/19]

- -
-
- - - - -
ciot_gpio_req_t request
-
-

Request

- -
-
- -

◆ request [7/19]

- -
-
- - - - -
ciot_httpc_req_t request
-
-

Request

- -
-
- -

◆ request [8/19]

- -
-
- - - - -
ciot_https_req_t request
-
-

Request

- -
-
- -

◆ request [9/19]

- -
-
- - - - -
ciot_mqttc_req_t request
-
-

Request data

- -
-
- -

◆ request [10/19]

- -
-
- - - - -
ciot_ntp_req_t request
-
-

NTP request

- -
-
- -

◆ request [11/19]

- -
-
- - - - -
ciot_opcuas_req_t request
-
-

OPC UA Server request

- -
-
- -

◆ request [12/19]

- -
-
- - - - -
ciot_ota_req_t request
-
-

OTA request

- -
-
- -

◆ request [13/19]

- -
-
- - - - -
ciot_storage_req_t request
-
-

Storage request

- -
-
- -

◆ request [14/19]

- -
-
- - - - -
ciot_sys_req_t request
-
-

System request

- -
-
- -

◆ request [15/19]

- -
-
- - - - -
ciot_tcp_req_t request
-
-

TCP request

- -
-
- -

◆ request [16/19]

- -
-
- - - - -
ciot_req_t request
-
-

Request data

- -
-
- -

◆ request [17/19]

- -
-
- - - - -
ciot_uart_req_t request
-
-

Request data

- -
-
- -

◆ request [18/19]

- -
-
- - - - -
ciot_usb_req_t request
-
-

Request data

- -
-
- -

◆ request [19/19]

- -
-
- - - - -
ciot_wifi_req_t request
-
-

Request data

- -
-
- -

◆ reserve

- -
-
- - - - -
uint8_t reserve
-
-

Reserved bits

- -
-
- -

◆ reserved [1/2]

- -
-
- - - - -
uint8_t reserved
-
-

Reserved bits

- -
-
- -

◆ reserved [2/2]

- -
-
- - - - -
uint16_t reserved
-
-

Reserved bits

- -
-
- -

◆ restart

- -
-
- - - - -
uint8_t restart
-
-

Flag for restarting after update

- -
-
- -

◆ result

- -
-
- - - - -
ciot_req_result_t result
-
-

Request result data

- -
-
- -

◆ route

- -
-
- - - - -
char route[CIOT_HTTPS_ROUTE_LEN]
-
-

Route

- -
-
- -

◆ rssi

- -
-
- - - - -
int8_t rssi
-
-

RSSI value

-

RSSI

- -
-
- -

◆ rst_count

- -
-
- - - - -
uint8_t rst_count
-
-

Restart count

- -
-
- -

◆ rst_reason

- -
-
- - - - -
uint8_t rst_reason
-
-

Restart reason

- -
-
- -

◆ rts_pin

- -
-
- - - - -
int8_t rts_pin
-
-

RTS pin

- -
-
- -

◆ rx_pin

- -
-
- - - - -
int8_t rx_pin
-
-

RX pin

- -
-
- -

◆ save_iface_cfg

- -
-
- - - - -
ciot_req_save_iface_cfg_t save_iface_cfg
-
-

Save interface configuration request data

- -
-
- -

◆ scan_result

- -
-
- - - - -
ciot_wifi_scan_result_t scan_result
-
-

WiFi scan result

- -
-
- -

◆ send_data

- -
-
- - - - -
ciot_uart_req_send_data_t send_data
-
-

Send data request data

- -
-
- -

◆ serializer

- -
-
- - - - -
uint16_t serializer
-
-

Serializer feature

- -
-
- -

◆ server [1/2]

- -
-
- - - - -
char server[CIOT_CONFIG_NTP_SERVERS_COUNT][64]
-
-

NTP servers

- -
-
- -

◆ server [2/2]

- -
-
- - - - -
ciot_tcp_dhcp_state_t server
-
-

DHCP server state

- -
-
- -

◆ set_mac

- -
-
- - - - -
uint8_t set_mac[6]
-
-

Set MAC data

- -
-
- -

◆ set_state

- -
-
- - - - -
ciot_gpio_state_info_t set_state
-
-

Set state information

- -
-
- -

◆ size [1/3]

- -
-
- - - - -
uint8_t size
-
-

Size of the event data.

-

Message size

-

Data size

- -
-
- -

◆ size [2/3]

- -
-
- - - - -
int size
-
-

Size of message

- -
-
- -

◆ size [3/3]

- -
-
- - - - -
uint8_t size
-
-

Data size

- -
-
- -

◆ ssid

- -
-
- - - - -
char ssid
-
-

SSID

- -
-
- -

◆ state [1/17]

- -
-
- - - - -
ciot_ble_scn_state_t state
-
-

State

- -
-
- -

◆ state [2/17]

- -
-
- - - - -
ciot_ble_state_t state
-
-

State

- -
-
- -

◆ state [3/17]

- -
-
- - - - -
ciot_bridge_state_t state
-
-

State

- -
-
- -

◆ state [4/17]

- -
-
- - - - -
ciot_data_model_state_t state
-
-

State

- -
-
- -

◆ state [5/17]

- -
-
- - - - -
ciot_dfu_state_t state
-
-

State

- -
-
- -

◆ state [6/17]

- -
-
- - - - -
ciot_gpio_state_t state
-
-

State

- -
-
- -

◆ state [7/17]

- -
-
- - - - -
ciot_httpc_state_t state
-
-

State

- -
-
- -

◆ state [8/17]

- -
-
- - - - -
ciot_https_state_t state
-
-

State

- -
-
- -

◆ state [9/17]

- -
-
- - - - -
ciot_mqttc_state_t state
-
-

MQTT client state

- -
-
- -

◆ state [10/17]

- -
-
- - - - -
ciot_ntp_state_t state
-
-

NTP state

- -
-
- -

◆ state [11/17]

- -
-
- - - - -
ciot_opcuas_state_t state
-
-

OPC UA Server state

- -
-
- -

◆ state [12/17]

- -
-
- - - - -
ciot_ota_state_t state
-
-

OTA state

- -
-
- -

◆ state [13/17]

- -
-
- - - - -
ciot_storage_state_t state
-
-

Storage state

- -
-
- -

◆ state [14/17]

- -
-
- - - - -
ciot_tcp_state_t state
-
-

TCP state

- -
-
- -

◆ state [15/17]

- -
-
- - - - -
ciot_state_t state
-
-

CIOT state

- -
-
- -

◆ state [16/17]

- -
-
- - - - -
ciot_uart_state_t state
-
-

UART state

- -
-
- -

◆ state [17/17]

- -
-
- - - - -
ciot_usb_state_t state
-
-

USB state

- -
-
- -

◆ status [1/19]

- -
-
- - - - -
ciot_wifi_status_t status
-
-

BLE status

-

Status

-

TCP status

-

Status data

-

NTP status

-

OPC UA Server status

-

OTA status

-

Storage status

-

System status

- -
-
- -

◆ status [2/19]

- -
-
- - - - -
ciot_ble_scn_status_t status
-
-

BLE scanner status

-

Status

- -
-
- -

◆ status [3/19]

- -
-
- - - - -
ciot_bridge_status_t status
-
-

Bridge status

-

Status

- -
-
- -

◆ status [4/19]

- -
-
- - - - -
ciot_dfu_status_t status
-
-

Status of the DFU operation.

-

Status

- -
-
- -

◆ status [5/19]

- -
-
- - - - -
ciot_tcp_status_t status
-
-

TCP status.

-

TCP status

- -
-
- -

◆ status [6/19]

- -
-
- - - - -
ciot_gpio_status_t status
-
-

GPIO status.

-

Status

- -
-
- -

◆ status [7/19]

- -
-
- - - - -
ciot_httpc_status_t status
-
-

HTTP client status.

-

Status

- -
-
- -

◆ status [8/19]

- -
-
- - - - -
ciot_https_status_t status
-
-

HTTP server status.

-

Status

- -
-
- -

◆ status [9/19]

- -
-
- - - - -
ciot_mqttc_status_t status
-
-

MQTT client status.

-

Status data

- -
-
- -

◆ status [10/19]

- -
-
- - - - -
ciot_ntp_status_t status
-
-

NTP status.

-

NTP status

- -
-
- -

◆ status [11/19]

- -
-
- - - - -
ciot_opcuas_status_t status
-
-

OPCUAS status.

-

OPC UA Server status

- -
-
- -

◆ status [12/19]

- -
-
- - - - -
ciot_ota_status_t status
-
-

OTA status.

-

OTA status

- -
-
- -

◆ status [13/19]

- -
-
- - - - -
ciot_storage_status_t status
-
-

Storage status

- -
-
- -

◆ status [14/19]

- -
-
- - - - -
ciot_sys_status_t status
-
-

System status

- -
-
- -

◆ status [15/19]

- -
-
- - - - -
ciot_uart_status_t status
-
-

Status information

-

Status data

- -
-
- -

◆ status [16/19]

- -
-
- - - - -
ciot_usb_status_t status
-
-

Status information

-

Status data

- -
-
- -

◆ status [17/19]

- -
-
- - - - -
ciot_wifi_status_t status
-
- -

Wi-Fi status.

-

Status data

- -
-
- -

◆ status [18/19]

- -
-
- - - - -
ciot_data_model_status_t status
-
-

Status

- -
-
- -

◆ status [19/19]

- -
-
- - - - -
ciot_status_t status
-
-

Status data

- -
-
- -

◆ status_mask

- -
-
- - - - -
uint64_t status_mask
-
-

Status mask

- -
-
- -

◆ storage [1/2]

- -
-
- - - - -
ciot_storage_data_u storage
-
-

Storage data

- -
-
- -

◆ storage [2/2]

- -
-
- - - - -
uint16_t storage
-
-

Storage feature

- -
-
- -

◆ subscribe

- -
-
- - - - -
ciot_mqttc_req_subscribe_t subscribe
-
-

Subscribe request data

- -
-
- -

◆ sw

- -
-
- - - - -
ciot_sys_sw_features_t sw
-
-

Software features

- -
-
- -

◆ sw_mac

- -
-
- - - - -
uint8_t sw_mac[6]
-
-

Software MAC address

- -
-
- -

◆ sync

- -
-
- - - - -
uint8_t sync
-
-

Sync flag

- -
-
- -

◆ sync_count

- -
-
- - - - -
uint16_t sync_count
-
-

Synchronization count

- -
-
- -

◆ sync_interval

- -
-
- - - - -
uint32_t sync_interval
-
-

Sync interval

- -
-
- -

◆ sync_mode

- -
-
- - - - -
uint8_t sync_mode
-
-

Sync mode

- -
-
- -

◆ system [1/2]

- -
-
- - - - -
ciot_sys_data_u system
-
-

System data

- -
-
- -

◆ system [2/2]

- -
-
- - - - -
uint16_t system
-
-

System feature

- -
-
- -

◆ tcp [1/3]

- -
-
- - - - -
ciot_tcp_data_u tcp
-
-

TCP data

- -
-
- -

◆ tcp [2/3]

- -
-
- - - - -
ciot_tcp_cfg_t tcp
-
-

TCP configuration

- -
-
- -

◆ tcp [3/3]

- -
-
- - - - -
ciot_tcp_status_t tcp
-
-

TCP status

- -
-
- -

◆ timeout

- -
-
- - - - -
uint16_t timeout
-
-

Timeout value

-

Timeout

- -
-
- -

◆ timer

- -
-
- - - - -
uint16_t timer
-
-

Timer feature

- -
-
- -

◆ timezone

- -
-
- - - - -
char timezone[16]
-
-

Timezone

- -
-
- -

◆ tls_cert_verify_flags

- -
-
- - - - -
int tls_cert_verify_flags
-
-

TLS certificate verification flags

- -
-
- -

◆ tls_last_err

- -
-
- - - - -
int tls_last_err
-
-

Last TLS error

- -
-
- -

◆ tls_stack_err

- -
-
- - - - -
int tls_stack_err
-
-

TLS stack error

- -
-
- -

◆ topic

- -
-
- - - - -
char topic
-
-

MQTT topic

- -
-
- -

◆ topics

- -
-
- - - - -
ciot_mqttc_topics_cfg_t topics
-
-

MQTT topics configuration

- -
-
- -

◆ transport [1/2]

- -
-
- - - - -
ciot_httpc_transport_type_t transport
-
-

Transport type

- -
-
- -

◆ transport [2/2]

- -
-
- - - - -
ciot_mqttc_transport_t transport
-
-

MQTT transport type

- -
-
- -

◆ transport_sock

- -
-
- - - - -
int transport_sock
-
-

Transport socket

- -
-
- -

◆ tx_pin

- -
-
- - - - -
int8_t tx_pin
-
-

TX pin

- -
-
- -

◆ type [1/26]

- -
-
- - - - -
ciot_msg_type_t type
-
-

Event type.

-

Message type

- -
-
- -

◆ type [2/26]

- -
-
- - - - -
ciot_ble_scn_req_type_t type
-
-

Request type

- -
-
- -

◆ type [3/26]

- -
-
- - - - -
ciot_ble_req_type_t type
-
-

Request type

- -
-
- -

◆ type [4/26]

- -
-
- - - - -
ciot_bridge_req_type_t type
-
-

Request type

- -
-
- -

◆ type [5/26]

- -
-
- - - - -
ciot_data_model_req_type_t type
-
-

Request type

- -
-
- -

◆ type [6/26]

- -
-
- - - - -
ciot_dfu_req_type_t type
-
-

Request type

- -
-
- -

◆ type [7/26]

- -
-
- - - - -
ciot_gpio_req_type_t type
-
-

Request type

- -
-
- -

◆ type [8/26]

- -
-
- - - - -
ciot_httpc_req_type_t type
-
-

Request type

- -
-
- -

◆ type [9/26]

- -
-
- - - - -
ciot_https_req_type_t type
-
-

Request type

- -
-
- -

◆ type [10/26]

- -
-
- - - - -
int type
-
-

Error type

- -
-
- -

◆ type [11/26]

- -
-
- - - - -
ciot_mqttc_req_type_t type
-
-

Request type

- -
-
- -

◆ type [12/26]

- -
-
- - - - -
ciot_msg_iface_type_t type
-
-

Interface type

- -
-
- -

◆ type [13/26]

- -
-
- - - - -
ciot_msg_type_t type
-
-

Message type

- -
-
- -

◆ type [14/26]

- -
-
- - - - -
ciot_ntp_req_type_t type
-
-

Request type

- -
-
- -

◆ type [15/26]

- -
-
- - - - -
uint16_t type
-
-

Node type

- -
-
- -

◆ type [16/26]

- -
-
- - - - -
ciot_opcuas_req_type_t type
-
-

Request type

- -
-
- -

◆ type [17/26]

- -
-
- - - - -
ciot_ota_req_type_t type
-
-

Request type

- -
-
- -

◆ type [18/26]

- -
-
- - - - -
ciot_storage_type_t type
-
-

Storage type

- -
-
- -

◆ type [19/26]

- -
-
- - - - -
ciot_storage_req_type_t type
-
-

Request type

- -
-
- -

◆ type [20/26]

- -
-
- - - - -
ciot_sys_req_type_t type
-
-

Request type

- -
-
- -

◆ type [21/26]

- -
-
- - - - -
ciot_tcp_req_type_t type
-
-

Request type

- -
-
- -

◆ type [22/26]

- -
-
- - - - -
ciot_req_type_t type
-
-

Request type

- -
-
- -

◆ type [23/26]

- -
-
- - - - -
ciot_uart_req_type_t type
-
-

Request type

- -
-
- -

◆ type [24/26]

- -
-
- - - - -
ciot_usb_req_type_t type
-
-

Request type

- -
-
- -

◆ type [25/26]

- -
-
- - - - -
ciot_wifi_type_t type
-
-

WiFi interface type

- -
-
- -

◆ type [26/26]

- -
-
- - - - -
ciot_wifi_req_type_t type
-
-

Request type

- -
-
- -

◆ uart [1/2]

- -
-
- - - - -
ciot_uart_data_u uart
-
-

UART data

- -
-
- -

◆ uart [2/2]

- -
-
- - - - -
uint16_t uart
-
-

UART feature

- -
-
- -

◆ url

- -
-
- - - - -
char url
-
-

URL

-

MQTT URL

-

URL for OTA update

- -
-
- -

◆ usb [1/2]

- -
-
- - - - -
ciot_usb_data_u usb
-
-

USB data

- -
-
- -

◆ usb [2/2]

- -
-
- - - - -
uint16_t usb
-
-

USB feature

- -
-
- -

◆ user

- -
-
- - - - -
char user[CIOT_CONFIG_MQTT_USER_LEN]
-
-

MQTT username

- -
-
- -

◆ value

- -
-
- - - - -
char value[CIOT_HTTPC_HEADER_VAL]
-
-

Value

- -
-
- -

◆ version

- -
-
- - - - -
uint8_t version[3]
-
-

Version information

- -
-
- -

◆ wifi [1/2]

- -
-
- - - - -
ciot_wifi_data_u wifi
-
-

WiFi data

- -
-
- -

◆ wifi [2/2]

- -
-
- - - - -
uint16_t wifi
-
-

WiFi feature

- -
-
- -

◆ window

- -
-
- - - - -
uint16_t window
-
-

Window value

- -
-
-
The documentation for this union was generated from the following files: -
-
- - - - diff --git a/docs/html/structpacked.js b/docs/html/structpacked.js deleted file mode 100644 index 451749e..0000000 --- a/docs/html/structpacked.js +++ /dev/null @@ -1,302 +0,0 @@ -var structpacked = -[ - [ "active", "structpacked.html#a05c940dbc220f5a723afd70071aebff8", null ], - [ "add_node", "structpacked.html#a79aa371ccd92a505f5c26dcd8218a131", null ], - [ "address", "structpacked.html#aaf2deef29cfe3fe5b18f00f49ff23d42", null ], - [ "adv_info", "structpacked.html#a9c267320c088f215b9649f93a8d955c1", null ], - [ "ap_list", "structpacked.html#a1f0703f0199d2ac8ec80081ea898e0cf", null ], - [ "app_ver", "structpacked.html#a33414ac5d16ad70f9ff7696f7922beec", null ], - [ "authmode", "structpacked.html#a62cb83d5528e0d152b4e179fea395cab", null ], - [ "b2d", "structpacked.html#a7e49cda0ef28302730e05911cb7a9d3c", null ], - [ "baud_rate", "structpacked.html#a148f33bbcda8087a77d8ba30f7e3c502", null ], - [ "ble", "structpacked.html#a8c90dd3961baa84d90870ce1f180006d", null ], - [ "ble_scn", "structpacked.html#a30ef17c042c5a942dc6491370179966c", null ], - [ "ble_scn", "structpacked.html#a3541968d9c0a8b544893692fb34cfdee", null ], - [ "body", "structpacked.html#afc1b0964d9fa89030c055cbc08315c58", null ], - [ "bridge", "structpacked.html#a2f12825330d395d82f01240cf84e6328", null ], - [ "bridge_mode", "structpacked.html#a7550d74d56b36307b64a75f5d4eb8dad", null ], - [ "bridge_mode", "structpacked.html#a4e8946f8a10777bc88814da1c657815c", null ], - [ "brigde_mode", "structpacked.html#ad44fdec90acd6e513033d8af6d0a7774", null ], - [ "bssid", "structpacked.html#a19c52baafe5797c359c5e0f5776499d7", null ], - [ "cfg", "structpacked.html#a301d9747f184171d8a1ee19d25d8e4ab", null ], - [ "ciot", "structpacked.html#afedab1afecebfb5eb8554e3b1b056502", null ], - [ "client", "structpacked.html#acb22641cf860e836e7394d14b9adae4b", null ], - [ "client_id", "structpacked.html#a71a2e48797aa4b94b9164ea22564c158", null ], - [ "code", "structpacked.html#a45a5b7c00a796a23f01673cef1dbe0a9", null ], - [ "code", "structpacked.html#afe73fa7a655419b386e0a10c7beaace3", null ], - [ "config", "structpacked.html#a15039efacca36cdba57c2ccf7b0a3d4f", null ], - [ "config", "structpacked.html#a3bb879297495825c0895764c1b7593b1", null ], - [ "config", "structpacked.html#a422a3539477ec835aea97b889564f22a", null ], - [ "config", "structpacked.html#a0a7b5df86de5bd60d09108b02de9d89d", null ], - [ "config", "structpacked.html#a8d4be68066e35bb11aecfff26e3cb30b", null ], - [ "config", "structpacked.html#a15039efacca36cdba57c2ccf7b0a3d4f", null ], - [ "config", "structpacked.html#a0ddab1f295ea5861939322623d313037", null ], - [ "config", "structpacked.html#a07d1ec38980b47dde9caaa52c42163cf", null ], - [ "config", "structpacked.html#a79c158a8d9a5ddac01d944ca9485764b", null ], - [ "config", "structpacked.html#a6c17383e9465f668d1e9dcb3cf8d4f4a", null ], - [ "config", "structpacked.html#aa976951e468c754fef849731243b0acb", null ], - [ "config", "structpacked.html#a62fb934187d712f56dc1289eda8f8cac", null ], - [ "config", "structpacked.html#aabe6a902449529e66a1bb460116af784", null ], - [ "config", "structpacked.html#a9d2eb5a0a1a2ed5d529672a8229a8fe8", null ], - [ "config", "structpacked.html#a71821427aa3817c68209a151bed81e56", null ], - [ "config", "structpacked.html#a82e7ef84cdd4eb20f2da20f0df751fd3", null ], - [ "config", "structpacked.html#a107556abf8506af23fc4f92aa4d20cea", null ], - [ "config", "structpacked.html#a5a3eefbe6f21d662a5e318bbf323a00e", null ], - [ "config", "structpacked.html#a711c5a971ab69b9cfa4850692e6bbaad", null ], - [ "conn_count", "structpacked.html#acaf4be12cb0cee4fbea5e8e121f6d2e4", null ], - [ "content_length", "structpacked.html#a675a47f46ecd9d8ec01c738e04c28cbe", null ], - [ "count", "structpacked.html#a20302e2c99a60d3f612dba57e3f6333b", null ], - [ "cts_pin", "structpacked.html#a73580a66f00a6a0ea4a56441d529797f", null ], - [ "d2b", "structpacked.html#a6b1fde5b6926d1fec0c3102bbf1ada9f", null ], - [ "data", "structpacked.html#a325819a8e492ac69542e8b31705af6e9", null ], - [ "data", "structpacked.html#ad255c0633c486a2ba3c6d2875d5a7fe5", null ], - [ "data", "structpacked.html#af05fffb7425971f74862815fe4169b7d", null ], - [ "data", "structpacked.html#a2f53bd6c51629c8cac0040526230998e", null ], - [ "data", "structpacked.html#adbf84251d29a448cb6b3f3b4b402ebd0", null ], - [ "data", "structpacked.html#a1d31b0b31c62cd6a2a3c3b5193efd5f9", null ], - [ "data", "structpacked.html#a8742485122a2b9e44392d5d51ddc2076", null ], - [ "data", "structpacked.html#a3623cfec7a7da849fd22ce7ec1c3e10f", null ], - [ "data", "structpacked.html#ad609e57ec1fe769dd7f41602cae320ca", null ], - [ "data", "structpacked.html#ac498d2909bc3de66ee0b1a597fa8e0b6", null ], - [ "data", "structpacked.html#a9401df5c514eae3e23f4468d8ca7795e", null ], - [ "data", "structpacked.html#a18e3465478724c7b699bb5077661ea35", null ], - [ "data", "structpacked.html#a77dc06e65f4b0aed4a3f44e1b6a32aa0", null ], - [ "data", "structpacked.html#afe23ad4b14c014e0c70c96d93e44005c", null ], - [ "data", "structpacked.html#a6b5e08e2800e812e2ee5294c83ac9fe6", null ], - [ "data", "structpacked.html#a3acb986a68044c354bb4e34cb18e4d3c", null ], - [ "data", "structpacked.html#ab9836dbdec18617a3ddefdeb64d68c5f", null ], - [ "data", "structpacked.html#aeecdef82363bc7b7d7ba9bf5f8f51908", null ], - [ "data", "structpacked.html#a8abbd25f85c295a54f54d2815908d273", null ], - [ "data", "structpacked.html#a91cc22753d20b8e288bae1944e5c5fce", null ], - [ "data", "structpacked.html#a01f8ce506c08d4070208e71aef019ff9", null ], - [ "data_rate", "structpacked.html#af7750329f3654d2f6fe5a20adeae49dd", null ], - [ "delete_iface_cfg", "structpacked.html#abaf229d7f984c35aa24c89632a544934", null ], - [ "dfu", "structpacked.html#a818d9af5834bb69bdafd6513ae494405", null ], - [ "dfu", "structpacked.html#a6adae5024e1ef3cf7e6209bf7f0c58a0", null ], - [ "dhcp", "structpacked.html#a689764758640d8f794e755c07c602667", null ], - [ "dhcp", "structpacked.html#acf265b9f6bf6e80f8d16a9aaade7e8cd", null ], - [ "disconnect_reason", "structpacked.html#ae5b995148e44c51fc076af577ec1acc8", null ], - [ "display_name", "structpacked.html#acfcef1819c1ec84a215884bb45ed99b6", null ], - [ "dns", "structpacked.html#a9bf249fa42db4caf84d05f92ed1f9718", null ], - [ "dtr", "structpacked.html#a5b495a42fbde79adb797b1e9f6a4e039", null ], - [ "encrypted", "structpacked.html#afe60ab2756fb1ea1c1de6f3ec6dbea98", null ], - [ "err", "structpacked.html#a2dd2df43c7a23b9fb91e6e462c592477", null ], - [ "err_code", "structpacked.html#a18c05079c393f6c94543830ac5360604", null ], - [ "error", "structpacked.html#a11614f44ef4d939bdd984953346a7572", null ], - [ "error", "structpacked.html#acee85046d884f9e69d341dafac56cd22", null ], - [ "error", "structpacked.html#a460f5e2f775eebdacec0950914ab87a9", null ], - [ "error", "structpacked.html#ad02fff01b7a3add4e201ad4fd60bb06d", null ], - [ "ethernet", "structpacked.html#a634aacbacba6e5a795fbebf904d6f827", null ], - [ "event", "structpacked.html#a28206abcb96418175c4998aaff04c99a", null ], - [ "event", "structpacked.html#ad463eb5d86dcaf2c866494686da9ce6e", null ], - [ "event", "structpacked.html#aea75f103343a18512b1024505e9766de", null ], - [ "event", "structpacked.html#af5207c84edf0697170da962f465640a0", null ], - [ "event", "structpacked.html#abe630baacf2cedc1090a81ef4e39a081", null ], - [ "features", "structpacked.html#a08bf5c347b3e2c3525c382eaab3d6f97", null ], - [ "flow_control", "structpacked.html#a9498b6790752dd532f6465f3efb59cbf", null ], - [ "force", "structpacked.html#a268d99c2d888dd67e8ea77d3be0a5021", null ], - [ "free_memory", "structpacked.html#aa455685612d3d0967fd32c32256a8bd3", null ], - [ "gateway", "structpacked.html#a0beca1eecd2529c061a6dc4cb8a412fd", null ], - [ "get_state", "structpacked.html#a93559a0f91d62042000a3276dc457506", null ], - [ "gpio", "structpacked.html#a633be9f96069e4c7cb47b431f80ca974", null ], - [ "hardware", "structpacked.html#a978e0f986a3de1feb66ebf37cd43b274", null ], - [ "header", "structpacked.html#ac82086f11a03c9e8ff189f5ca9c26f0f", null ], - [ "header", "structpacked.html#a376ba7d15e815aecda5b6276de7ff292", null ], - [ "http_client", "structpacked.html#ae536bd73f6eaace274e55d4779276e5e", null ], - [ "http_server", "structpacked.html#a8081e8e6e70c0ae11cc3996fe07f6dde", null ], - [ "httpc", "structpacked.html#a7d6cac53c9bf51f572908dc2a5b383f0", null ], - [ "https", "structpacked.html#a6a8bc746dffc95f0f7b3c468023e10ae", null ], - [ "hw", "structpacked.html#a68d421729d1895d3b9a6f4cc1dedbb42", null ], - [ "hw_mac", "structpacked.html#a42c07f83a6226da7e6271b3f070ac0d7", null ], - [ "hw_name", "structpacked.html#adc57848c0c5ba85f8662d618bcbd80a7", null ], - [ "id", "structpacked.html#a1e6927fa1486224044e568f9c370519b", null ], - [ "iface", "structpacked.html#a3501e3667f1031fb2f00b333b7b2269a", null ], - [ "iface", "structpacked.html#a82eb8e84b1ff534e368a647470a626c3", null ], - [ "iface_id", "structpacked.html#a5aca650808126ada7193361ab8921e7a", null ], - [ "ifaces_id", "structpacked.html#a56eef1c57392c0c3144874c536410da1", null ], - [ "image_read", "structpacked.html#a990d41db67b3605c9184428e72edcea1", null ], - [ "image_size", "structpacked.html#a42539ea8650b094f66be7a689243c5ef", null ], - [ "info", "structpacked.html#a7a8ead7f37f7534cd955cbefd78043ce", null ], - [ "info", "structpacked.html#a29734819b12e849f2f27b8663d023d8f", null ], - [ "info", "structpacked.html#a086ac86c52dfa147af9f5afed658c7cb", null ], - [ "info", "structpacked.html#a92c867a7e919ec76d2e58647718b633a", null ], - [ "info", "structpacked.html#ac1b76e51a84c5050063165be909dd70a", null ], - [ "init", "structpacked.html#a49f666045d24aa8becc5244bc2396aca", null ], - [ "interval", "structpacked.html#a6c52a3d605c056768b59164ce8df8334", null ], - [ "ip", "structpacked.html#a02f666cd85720a1af519b6a39c44b95a", null ], - [ "last_msg_time", "structpacked.html#a44794759868576e0404c9cf629863797", null ], - [ "last_sync", "structpacked.html#a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d", null ], - [ "lifetime", "structpacked.html#a569e06e92ec3d06c5ebf7f40d7f9a84e", null ], - [ "localization", "structpacked.html#aa5f4b442eedc591f6e6e03787e6343bc", null ], - [ "mac", "structpacked.html#a5084f88290d959c1f5469ad840b599b5", null ], - [ "mask", "structpacked.html#ada50f0e7b89816d02459e3e520b018bf", null ], - [ "method", "structpacked.html#ad10985b96579c7c2030050715bcad45d", null ], - [ "mode", "structpacked.html#a7d76e224ede8a4fa709cc3a505a81975", null ], - [ "mqtt", "structpacked.html#a57eed7a24887f5d1adba0df0ca8f29f5", null ], - [ "mqtt_client", "structpacked.html#a1f1d5466bff3ee92c8a67e4b067159a2", null ], - [ "msg", "structpacked.html#abd6b36b1e2c07eaa53b376fdbf0e9345", null ], - [ "msg", "structpacked.html#a2a544a28a9461b0de1f303ca407c459f", null ], - [ "msg_type", "structpacked.html#a61e21da913274adbd45e28f694651b11", null ], - [ "node_id", "structpacked.html#a381f93ba5743e8813f554bda3c272257", null ], - [ "ntp", "structpacked.html#a562d7a6cdd9053ec0bf7431017972903", null ], - [ "ntp", "structpacked.html#a34018b7bbca3d89088500ca3a47a66fd", null ], - [ "num", "structpacked.html#a7beea8f6745c478347f244cadef771c2", null ], - [ "num", "structpacked.html#abea371f9030e15a5d2a4c181576833d8", null ], - [ "op_mode", "structpacked.html#aec948fb30e99b1eda7e3d9ff741d417a", null ], - [ "ota", "structpacked.html#a466cfd56b729d0efcfa70cff1a8b7b85", null ], - [ "ota", "structpacked.html#aa20473f3745555bec85f491e13188f4e", null ], - [ "parity", "structpacked.html#ae5290e95682932917ab6a7fd7897abb4", null ], - [ "pass", "structpacked.html#a0559811c61c36a1df8aa9ac0c4d56d53", null ], - [ "password", "structpacked.html#ae3a23efe266762659e03567d6afc26dd", null ], - [ "path", "structpacked.html#ace45f567511d3f9ff978c679ae38b5b0", null ], - [ "payload", "structpacked.html#ab4f3fec57a517448f7d55021dbdbeba2", null ], - [ "pin_mask", "structpacked.html#a3feeb7044549691a36c39cc7c9b2ed2c", null ], - [ "port", "structpacked.html#a83a04ad582de2b7d36b96f9db429c2c6", null ], - [ "port", "structpacked.html#a83a04ad582de2b7d36b96f9db429c2c6", null ], - [ "proxy_msg", "structpacked.html#a778eb3ed59eb3397b9efad8d48d34b62", null ], - [ "publish", "structpacked.html#ae7b5bde19c99952b5a737b600f3c21e6", null ], - [ "pull", "structpacked.html#a5ee68c0e31fa06f342fad371023bdc4e", null ], - [ "qos", "structpacked.html#a65ee2b4b16f25052c441ff9959dcc7e7", null ], - [ "request", "structpacked.html#a4fff0375f4b234a60fcd5e6723d9c8a9", null ], - [ "request", "structpacked.html#a6aeefeee1b018d7d77c41f66f6015cf9", null ], - [ "request", "structpacked.html#a21b1ec52268024ae8c4b0eca1dc2a491", null ], - [ "request", "structpacked.html#a8342e156b9596a1154ff4ce550adb30f", null ], - [ "request", "structpacked.html#aeec32200114264e8556110d5c2ffc44c", null ], - [ "request", "structpacked.html#ac3fb50fe28f5e2ea50c6f662aa19beca", null ], - [ "request", "structpacked.html#a57c784a27da9399f6d1a7bd2122a3c65", null ], - [ "request", "structpacked.html#af4b02bc60804013ff8623f078ec43efe", null ], - [ "request", "structpacked.html#af4d809ae5adfaf23b4229995212f0ded", null ], - [ "request", "structpacked.html#a0a55111acf65b88d386268c615a69499", null ], - [ "request", "structpacked.html#a66e033d989ec031368788f08deba7feb", null ], - [ "request", "structpacked.html#a4e22c6ea4c9d8fad6bbd0d3894c82627", null ], - [ "request", "structpacked.html#ae35bc5d21998e1401aa886359cafd044", null ], - [ "request", "structpacked.html#a7146ff86f43fac1f87c45f31c3a3bd20", null ], - [ "request", "structpacked.html#aaf3b24e7b5d38ca3f76ca38e5e43ad7e", null ], - [ "request", "structpacked.html#a8975b1b5a295a8ee8669dfcce942dcd5", null ], - [ "request", "structpacked.html#aeac55f9a4429aa466599b8875763ff38", null ], - [ "request", "structpacked.html#aebb2adef59fcdc91db3d185996066c6a", null ], - [ "request", "structpacked.html#a95d1196af9ebc0b64f6f7e2842812448", null ], - [ "reserve", "structpacked.html#ac6c17ab632a9c78bc9fa846e9baeea7b", null ], - [ "reserved", "structpacked.html#acb7bc06bed6f6408d719334fc41698c7", null ], - [ "reserved", "structpacked.html#a5a6ed8c04a3db86066924b1a1bf4dad3", null ], - [ "restart", "structpacked.html#a63de528fa8d98b79adfe7f9f68880c17", null ], - [ "result", "structpacked.html#a90808ce2b0f0710bbe9799c64e8df0db", null ], - [ "route", "structpacked.html#a98bcbc9e1ebf74ba486f246d76f5bac1", null ], - [ "rssi", "structpacked.html#a3b962e67ba74725bd60ca3c29f785abe", null ], - [ "rst_count", "structpacked.html#acc644e0c68521fc2c21bdf5acb5f5812", null ], - [ "rst_reason", "structpacked.html#aa4f71758f86d92d3ae60a541335f579d", null ], - [ "rts_pin", "structpacked.html#a3c82534f71c473adbf7fa380db7badc2", null ], - [ "rx_pin", "structpacked.html#ab461fda70a78750930429bcc68db5a98", null ], - [ "save_iface_cfg", "structpacked.html#af24d10404fe7693abc12d43b4edea249", null ], - [ "scan_result", "structpacked.html#a23723a81650d6544d7da572eb4bf33b9", null ], - [ "send_data", "structpacked.html#a64001c4b28083877216a64df74dff823", null ], - [ "serializer", "structpacked.html#a720e2a2aba3a8aa7ec09162d3a522d60", null ], - [ "server", "structpacked.html#ab80672fab5b8d7864411603053aaffa4", null ], - [ "server", "structpacked.html#afdb30da7a1b29e70c8b5051adcaf649b", null ], - [ "set_mac", "structpacked.html#a62a0efca13351bcf8980bde96c09854e", null ], - [ "set_state", "structpacked.html#a5cc92c2a01be84c116055f80d77e5140", null ], - [ "size", "structpacked.html#ae5dc6ffcd9b7605c7787791e40cc6bb0", null ], - [ "size", "structpacked.html#a439227feff9d7f55384e8780cfc2eb82", null ], - [ "size", "structpacked.html#ae5dc6ffcd9b7605c7787791e40cc6bb0", null ], - [ "ssid", "structpacked.html#a431ea94992ad903ffe97cf85b3763ab0", null ], - [ "state", "structpacked.html#a9b3c50f82a67373296513704001266bb", null ], - [ "state", "structpacked.html#aa5d08015bd3ed92217c40487bd42e433", null ], - [ "state", "structpacked.html#a75d538f4bd5c29ec545f1e37dae43f0e", null ], - [ "state", "structpacked.html#a350c6a3720c9b7d1b3300e38430117e7", null ], - [ "state", "structpacked.html#a587d059d905fdf8cceb8643720812de4", null ], - [ "state", "structpacked.html#a939fe9a85b37a0ce4a0701b655c799ea", null ], - [ "state", "structpacked.html#a37c663f5a0040d827e450c52efe59882", null ], - [ "state", "structpacked.html#a28c09b101362530d97e51b712b741f63", null ], - [ "state", "structpacked.html#a28daf783134e0bed0e611de3ea451e4a", null ], - [ "state", "structpacked.html#a28ce8249c3bcacad6a7698b7697739b8", null ], - [ "state", "structpacked.html#a584e26c042d8a98bf6161b7aa27ba4cf", null ], - [ "state", "structpacked.html#a796f1aeb4c800b653ee018b20c818804", null ], - [ "state", "structpacked.html#aabc97b8fe1b1624b67ee7bc472d5b0b0", null ], - [ "state", "structpacked.html#a771cb8893000d5d94fc8bc2d21347412", null ], - [ "state", "structpacked.html#ab3a7653fc8a3bfebedb322cceec24c38", null ], - [ "state", "structpacked.html#a00c2e8ab24db2cabd968dcd6aa86a7c3", null ], - [ "state", "structpacked.html#a3442f594ec1fc76781d93b1a28b55cba", null ], - [ "status", "structpacked.html#a09cb5a4aa60e39d810f1c21089103503", null ], - [ "status", "structpacked.html#aa7ad441170fdff42b419665a6652a09f", null ], - [ "status", "structpacked.html#ab50a6b7e2887ecb6625b540edae99138", null ], - [ "status", "structpacked.html#a9fb48f785812375d586c71a02b453e64", null ], - [ "status", "structpacked.html#a290455b77155aab0d086fb8c69f76364", null ], - [ "status", "structpacked.html#af7b93aeb68c1648ccb2617ff8217e7b0", null ], - [ "status", "structpacked.html#ac5c1eb82650b9d0161a399175c459ad3", null ], - [ "status", "structpacked.html#ae71d44b4ec9b04f2b3eb183ae791f6ca", null ], - [ "status", "structpacked.html#a0bd4162002c890f2775878d4da138c03", null ], - [ "status", "structpacked.html#a95d5fa474c00a79ee883e78048ea7c4c", null ], - [ "status", "structpacked.html#ac3be6c0c62c2999a9dd9fa0099945876", null ], - [ "status", "structpacked.html#a86de670b32fc6ad5c7a44fefb41e6e3a", null ], - [ "status", "structpacked.html#ac1a66aa256f203858bb2477b812e36fb", null ], - [ "status", "structpacked.html#ad3dbfc73fddab4d58bde12f27edab41b", null ], - [ "status", "structpacked.html#aa311cb42bbd477c3bfd5371dd0b8bedd", null ], - [ "status", "structpacked.html#ab26791741e383cec2107fa1540a14342", null ], - [ "status", "structpacked.html#a09cb5a4aa60e39d810f1c21089103503", null ], - [ "status", "structpacked.html#a3f4172ed60af91f49f998cde97dd28cb", null ], - [ "status", "structpacked.html#ac4db33ce66ac8ec09d4b5b088eb88ead", null ], - [ "status_mask", "structpacked.html#af557caa253a733e218e1e71c2a91eef4", null ], - [ "storage", "structpacked.html#a4c64bed640d14af56502dd8dceb9ab20", null ], - [ "storage", "structpacked.html#ab8549384ff6a90d5fedec40cd3535ebf", null ], - [ "subscribe", "structpacked.html#a061e16f43670bc7f5d29c3971b4088c3", null ], - [ "sw", "structpacked.html#aeb930ea2d960351877d7ef0a126173ff", null ], - [ "sw_mac", "structpacked.html#a21008d923a4d8cacdc7622aae81197aa", null ], - [ "sync", "structpacked.html#adb4b09387463cd61bf8f7217366310ef", null ], - [ "sync_count", "structpacked.html#a69671f26529c8f6076d53b96a1e1627f", null ], - [ "sync_interval", "structpacked.html#a5150de065f0b170644b21514c7530542", null ], - [ "sync_mode", "structpacked.html#ac752937b32320cf191fe3abd0e8daed6", null ], - [ "system", "structpacked.html#a04c7e159105631b657e5b65f977a2c4a", null ], - [ "system", "structpacked.html#a2e90afcc174ac8d99edf7229774986db", null ], - [ "tcp", "structpacked.html#a2744efd5cf43b6d40d61ea66f7f620d3", null ], - [ "tcp", "structpacked.html#afa68a8b5194df4f630408f99085e4ab8", null ], - [ "tcp", "structpacked.html#ac4061ebe19bc469e9a7569aa132010a8", null ], - [ "timeout", "structpacked.html#a7f1ad43d3bf79b40bc39dbb5a6c3a5ae", null ], - [ "timer", "structpacked.html#aea00c2c1dec6e8f58532f25c65210d9e", null ], - [ "timezone", "structpacked.html#a4dc1e4fba8f7fec6b1579961829b34f7", null ], - [ "tls_cert_verify_flags", "structpacked.html#abde2f3e27511cfb7307766339fed98e9", null ], - [ "tls_last_err", "structpacked.html#af8b9db3223039d525df4371413d3c2f3", null ], - [ "tls_stack_err", "structpacked.html#a9006960d969e505489e2a46434d60ebb", null ], - [ "topic", "structpacked.html#ae14de85dbf4b99a847daee53083331cb", null ], - [ "topics", "structpacked.html#a2a5888184d23c617efb05a871a705673", null ], - [ "transport", "structpacked.html#a7e007ade3b5b7cfcc2ee06d35d52d4e1", null ], - [ "transport", "structpacked.html#addf4bba19daf5bd5b49b033e239931da", null ], - [ "transport_sock", "structpacked.html#a2d16d2a81fde684b4c79c0d71f8090b5", null ], - [ "tx_pin", "structpacked.html#abc8367b5354c54835c1d74192f355c1c", null ], - [ "type", "structpacked.html#ac3305f4a165c4d898ce7988191102e46", null ], - [ "type", "structpacked.html#abc70ef515ab30b52d6a58e0c72ee3688", null ], - [ "type", "structpacked.html#a1387b7c38bc20d7cf6308e7cbecff167", null ], - [ "type", "structpacked.html#a2ef6bd06414538f347bd722b6c4e064c", null ], - [ "type", "structpacked.html#a1cc8da72a2d329be4f8ff647f04884a0", null ], - [ "type", "structpacked.html#adb76936a18a28e534879c6f9d6f07868", null ], - [ "type", "structpacked.html#ab949dccfc732240972d8a27cf46f3e76", null ], - [ "type", "structpacked.html#ac4330d2b9fc6473e00966f8dd66a477c", null ], - [ "type", "structpacked.html#adf00e5263d183b9b74cd9dd06dd98856", null ], - [ "type", "structpacked.html#ac765329451135abec74c45e1897abf26", null ], - [ "type", "structpacked.html#a8e287bd3b319b246d8346f46ed6c4580", null ], - [ "type", "structpacked.html#ab9b24d9114ce832a5b9cbc962c9cea28", null ], - [ "type", "structpacked.html#ac3305f4a165c4d898ce7988191102e46", null ], - [ "type", "structpacked.html#a54590843a59febd0e8055f9249974adc", null ], - [ "type", "structpacked.html#acb5cfd209ba75c853d03f701e7f91679", null ], - [ "type", "structpacked.html#a6a535362b7c81b40f3ed9f6cb292a469", null ], - [ "type", "structpacked.html#a19605616d62f4ee24f6aefb6c34480e2", null ], - [ "type", "structpacked.html#aa03a710482f738f9fe6095f1d4c6774a", null ], - [ "type", "structpacked.html#a7b3cbcb3aea8c25ecc00d1316d1a79d6", null ], - [ "type", "structpacked.html#a4341eac7e0a50f29b2101e5b7584db32", null ], - [ "type", "structpacked.html#acd8fb37e86ba410b191b31dc8cf154c3", null ], - [ "type", "structpacked.html#a55a6010bd818c4c1b94eca45963f09a9", null ], - [ "type", "structpacked.html#a21d88bf4d17b9837d25893a4000044db", null ], - [ "type", "structpacked.html#aa027ba4e6f58da1f5204e16dd15d5136", null ], - [ "type", "structpacked.html#a35cbcdf247b4952f8c35e071bed5a1d8", null ], - [ "type", "structpacked.html#a6f6c1937c79d949cdf73c68cf9ad3493", null ], - [ "uart", "structpacked.html#aeaf49cc638f1cc4fac1c69fa12502d32", null ], - [ "uart", "structpacked.html#ab56ae378dca42f3463d9dab3f4462045", null ], - [ "url", "structpacked.html#ac4d7124a13340adca15d6f760640b66f", null ], - [ "usb", "structpacked.html#acd0961872f365a2b54fef650ac190f50", null ], - [ "usb", "structpacked.html#a71f3331b8fa338b8bb771e9c60142df8", null ], - [ "user", "structpacked.html#a40c9809e1d381340b5d342ef3a838715", null ], - [ "value", "structpacked.html#a82c2b14036a5b80ae9b5a4a6e2812a44", null ], - [ "version", "structpacked.html#a857436941aa8d7df5abfa34bcd054d35", null ], - [ "wifi", "structpacked.html#ac06a3086376da2d8a84120762824336c", null ], - [ "wifi", "structpacked.html#abf7485e5a2b2214d69dd780eddc62f39", null ], - [ "window", "structpacked.html#a6b307b5083cf92aca29549d780b44bd5", null ] -]; \ No newline at end of file diff --git a/docs/html/index.html b/docs/index.html similarity index 100% rename from docs/html/index.html rename to docs/index.html diff --git a/docs/html/jquery.js b/docs/jquery.js similarity index 100% rename from docs/html/jquery.js rename to docs/jquery.js diff --git a/docs/latex/Makefile b/docs/latex/Makefile deleted file mode 100644 index 7f82972..0000000 --- a/docs/latex/Makefile +++ /dev/null @@ -1,27 +0,0 @@ -LATEX_CMD?=pdflatex -MKIDX_CMD?=makeindex -BIBTEX_CMD?=bibtex -LATEX_COUNT?=8 -MANUAL_FILE?=refman - -all: $(MANUAL_FILE).pdf - -pdf: $(MANUAL_FILE).pdf - -$(MANUAL_FILE).pdf: clean $(MANUAL_FILE).tex - $(LATEX_CMD) $(MANUAL_FILE) - $(MKIDX_CMD) $(MANUAL_FILE).idx - $(LATEX_CMD) $(MANUAL_FILE) - latex_count=$(LATEX_COUNT) ; \ - while grep -E -s 'Rerun (LaTeX|to get cross-references right|to get bibliographical references right)' $(MANUAL_FILE).log && [ $$latex_count -gt 0 ] ;\ - do \ - echo "Rerunning latex...." ;\ - $(LATEX_CMD) $(MANUAL_FILE) ;\ - latex_count=`expr $$latex_count - 1` ;\ - done - $(MKIDX_CMD) $(MANUAL_FILE).idx - $(LATEX_CMD) $(MANUAL_FILE) - - -clean: - rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl $(MANUAL_FILE).pdf diff --git a/docs/latex/annotated.tex b/docs/latex/annotated.tex deleted file mode 100644 index a739809..0000000 --- a/docs/latex/annotated.tex +++ /dev/null @@ -1,172 +0,0 @@ -\doxysection{Data Structures} -Here are the data structures with brief descriptions\+:\begin{DoxyCompactList} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__cfg__t}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} \\*Structure for CIOT BLE configuration }{\pageref{structciot__ble__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ble__data__u}{ciot\+\_\+ble\+\_\+data\+\_\+u}} \\*Union for CIOT BLE data }{\pageref{unionciot__ble__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__ifaces}{ciot\+\_\+ble\+\_\+ifaces}} \\*Structure for CIOT BLE interface configuration }{\pageref{structciot__ble__ifaces}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__info__t}{ciot\+\_\+ble\+\_\+info\+\_\+t}} \\*Structure for CIOT BLE information }{\pageref{structciot__ble__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ble__req__data__u}{ciot\+\_\+ble\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT BLE request data }{\pageref{unionciot__ble__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__req__t}{ciot\+\_\+ble\+\_\+req\+\_\+t}} \\*Structure for CIOT BLE request }{\pageref{structciot__ble__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} \\*Structure for CIOT BLE SCN advertising information }{\pageref{structciot__ble__scn__adv__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t}} \\*Structure for CIOT BLE SCN configuration }{\pageref{structciot__ble__scn__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ble__scn__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+data\+\_\+u}} \\*Union for CIOT BLE SCN data }{\pageref{unionciot__ble__scn__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ble__scn__req__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT BLE SCN request data }{\pageref{unionciot__ble__scn__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} \\*Structure for CIOT BLE SCN request }{\pageref{structciot__ble__scn__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__scn__status__msg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure for CIOT BLE scanner status message }{\pageref{structciot__ble__scn__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} \\*Structure for CIOT BLE SCN status }{\pageref{structciot__ble__scn__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__status__msg__t}{ciot\+\_\+ble\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure for CIOT BLE status message }{\pageref{structciot__ble__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ble__status__t}{ciot\+\_\+ble\+\_\+status\+\_\+t}} \\*Structure for CIOT BLE status }{\pageref{structciot__ble__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} \\*Structure for CIOT bridge configuration }{\pageref{structciot__bridge__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__bridge__data__u}{ciot\+\_\+bridge\+\_\+data\+\_\+u}} \\*Union for CIOT bridge data }{\pageref{unionciot__bridge__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__bridge__req__data__u}{ciot\+\_\+bridge\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT bridge request data }{\pageref{unionciot__bridge__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__bridge__req__t}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} \\*Structure for CIOT bridge request }{\pageref{structciot__bridge__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__bridge__status__msg__t}{ciot\+\_\+bridge\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure for CIOT Bridge status message }{\pageref{structciot__bridge__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__bridge__status__t}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} \\*Structure for CIOT bridge status }{\pageref{structciot__bridge__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__cfg}{ciot\+\_\+cfg}} \\*CIOT configuration structure }{\pageref{structciot__cfg}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__data__model__cfg__t}{ciot\+\_\+data\+\_\+model\+\_\+cfg\+\_\+t}} \\*Structure for CIOT data model configuration }{\pageref{structciot__data__model__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__data__model__data__u}{ciot\+\_\+data\+\_\+model\+\_\+data\+\_\+u}} \\*Union for CIOT data model data }{\pageref{unionciot__data__model__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__data__model__req__data__u}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT data model request data }{\pageref{unionciot__data__model__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__data__model__req__t}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+t}} \\*Structure for CIOT data model request }{\pageref{structciot__data__model__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__data__model__status__t}{ciot\+\_\+data\+\_\+model\+\_\+status\+\_\+t}} \\*Structure for CIOT data model status }{\pageref{structciot__data__model__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__data__u}{ciot\+\_\+data\+\_\+u}} \\*Union for CIOT data }{\pageref{unionciot__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \\*Structure for CIOT DFU configuration }{\pageref{structciot__dfu__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__dfu__data__u}{ciot\+\_\+dfu\+\_\+data\+\_\+u}} \\*Union for CIOT DFU data }{\pageref{unionciot__dfu__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__dfu__req__data__u}{ciot\+\_\+dfu\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT DFU request data }{\pageref{unionciot__dfu__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} \\*Structure for CIOT DFU request }{\pageref{structciot__dfu__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__dfu__status__msg__t}{ciot\+\_\+dfu\+\_\+status\+\_\+msg\+\_\+t}} \\*Struct for DFU status message }{\pageref{structciot__dfu__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__dfu__status__t}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} \\*Structure for CIOT DFU status }{\pageref{structciot__dfu__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__eth__status__msg__t}{ciot\+\_\+eth\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure representing the CIOT Ethernet status message }{\pageref{structciot__eth__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__event__data}{ciot\+\_\+event\+\_\+data}} \\*Structure for event data in CIOT modules }{\pageref{structciot__event__data}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} \\*Structure for CIOT GPIO configuration }{\pageref{structciot__gpio__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__gpio__data__u}{ciot\+\_\+gpio\+\_\+data\+\_\+u}} \\*Union for CIOT GPIO data }{\pageref{unionciot__gpio__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__gpio__req__data__u}{ciot\+\_\+gpio\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT GPIO request data }{\pageref{unionciot__gpio__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__gpio__req__get__state__t}{ciot\+\_\+gpio\+\_\+req\+\_\+get\+\_\+state\+\_\+t}} \\*Structure for CIOT GPIO request to get state }{\pageref{structciot__gpio__req__get__state__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__gpio__req__t}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} \\*Structure for CIOT GPIO request }{\pageref{structciot__gpio__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__gpio__state__info__t}{ciot\+\_\+gpio\+\_\+state\+\_\+info\+\_\+t}} \\*Structure for CIOT GPIO state information }{\pageref{structciot__gpio__state__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__gpio__status__msg__t}{ciot\+\_\+gpio\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure representing the CIOT GPIO status message }{\pageref{structciot__gpio__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__gpio__status__t}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} \\*Structure for CIOT GPIO status }{\pageref{structciot__gpio__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} \\*Structure for CIOT HTTP client configuration }{\pageref{structciot__httpc__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__httpc__data__u}{ciot\+\_\+httpc\+\_\+data\+\_\+u}} \\*Union for CIOT HTTP client data }{\pageref{unionciot__httpc__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__httpc__event}{ciot\+\_\+httpc\+\_\+event}} \\*Union for CIOT HTTP client event }{\pageref{unionciot__httpc__event}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__httpc__event__data}{ciot\+\_\+httpc\+\_\+event\+\_\+data}} \\*Structure for CIOT HTTP client event data }{\pageref{structciot__httpc__event__data}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__httpc__req__data}{ciot\+\_\+httpc\+\_\+req\+\_\+data}} \\*Union for CIOT HTTP client request data }{\pageref{unionciot__httpc__req__data}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__httpc__req__send__t}{ciot\+\_\+httpc\+\_\+req\+\_\+send\+\_\+t}} \\*Structure for CIOT HTTP client send data request }{\pageref{structciot__httpc__req__send__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__httpc__req__set__header__t}{ciot\+\_\+httpc\+\_\+req\+\_\+set\+\_\+header\+\_\+t}} \\*Structure for CIOT HTTP client set header request }{\pageref{structciot__httpc__req__set__header__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__httpc__req__t}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} \\*Structure for CIOT HTTP client request }{\pageref{structciot__httpc__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__httpc__status__msg__t}{ciot\+\_\+httpc\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure representing the CIOT HTTP client status message }{\pageref{structciot__httpc__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__httpc__status__t}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} \\*Structure for CIOT HTTP client status }{\pageref{structciot__httpc__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__https__cfg__t}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} \\*Structure for CIOT HTTP server configuration }{\pageref{structciot__https__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__https__data__u}{ciot\+\_\+https\+\_\+data\+\_\+u}} \\*Union for CIOT HTTP server data }{\pageref{unionciot__https__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__https__event}{ciot\+\_\+https\+\_\+event}} \\*Union for CIOT HTTP server event }{\pageref{structciot__https__event}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__https__event__data}{ciot\+\_\+https\+\_\+event\+\_\+data}} \\*Structure for CIOT HTTP server event data }{\pageref{structciot__https__event__data}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__https__req__data__u}{ciot\+\_\+https\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT HTTP server request data }{\pageref{unionciot__https__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__https__req__t}{ciot\+\_\+https\+\_\+req\+\_\+t}} \\*Structure for CIOT HTTP server request }{\pageref{structciot__https__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__https__status__msg__t}{ciot\+\_\+https\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure representing the CIOT HTTP server status message }{\pageref{structciot__https__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__https__status__t}{ciot\+\_\+https\+\_\+status\+\_\+t}} \\*Structure for CIOT HTTP server status }{\pageref{structciot__https__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__iface}{ciot\+\_\+iface}} \\*Structure representing a CIOT interface }{\pageref{structciot__iface}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__iface__base}{ciot\+\_\+iface\+\_\+base}} \\*Structure representing the base of an interface }{\pageref{structciot__iface__base}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__iface__base__data}{ciot\+\_\+iface\+\_\+base\+\_\+data}} \\*Structure representing base data for an interface }{\pageref{structciot__iface__base__data}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__iface__cfg__t}{ciot\+\_\+iface\+\_\+cfg\+\_\+t}} \\*Structure for CIOT interface configuration }{\pageref{structciot__iface__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__iface__event__data__u}{ciot\+\_\+iface\+\_\+event\+\_\+data\+\_\+u}} \\*Union for CIOT interface event data }{\pageref{unionciot__iface__event__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__iface__event__t}{ciot\+\_\+iface\+\_\+event\+\_\+t}} \\*Structure representing an interface event }{\pageref{structciot__iface__event__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__iface__req__info}{ciot\+\_\+iface\+\_\+req\+\_\+info}} \\*Structure representing request information for an interface }{\pageref{structciot__iface__req__info}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ifaces}{ciot\+\_\+ifaces}} \\*Structure representing CIOT interfaces }{\pageref{structciot__ifaces}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__info__t}{ciot\+\_\+info\+\_\+t}} \\*Structure for CIOT information }{\pageref{structciot__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} \\*Structure for CIOT MQTT client configuration }{\pageref{structciot__mqttc__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__mqttc__data__u}{ciot\+\_\+mqttc\+\_\+data\+\_\+u}} \\*Union for CIOT MQTT client data }{\pageref{unionciot__mqttc__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__error__t}{ciot\+\_\+mqttc\+\_\+error\+\_\+t}} \\*Structure for CIOT MQTT client error information }{\pageref{structciot__mqttc__error__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__event}{ciot\+\_\+mqttc\+\_\+event}} \\*Union for CIOT MQTT client event }{\pageref{structciot__mqttc__event}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__event__data}{ciot\+\_\+mqttc\+\_\+event\+\_\+data}} \\*Structure for CIOT MQTT client event data }{\pageref{structciot__mqttc__event__data}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__mqttc__req__data__u}{ciot\+\_\+mqttc\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT MQTT client request data }{\pageref{unionciot__mqttc__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__req__publish__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+publish\+\_\+t}} \\*Structure for CIOT MQTT client publish request }{\pageref{structciot__mqttc__req__publish__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__req__subscribe__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+subscribe\+\_\+t}} \\*Structure for CIOT MQTT client subscribe request }{\pageref{structciot__mqttc__req__subscribe__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__req__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} \\*Structure for CIOT MQTT client request }{\pageref{structciot__mqttc__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__status__msg__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure representing a CIOT MQTT client status message }{\pageref{structciot__mqttc__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__status__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} \\*Structure for CIOT MQTT client status }{\pageref{structciot__mqttc__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__mqttc__topics__cfg__t}{ciot\+\_\+mqttc\+\_\+topics\+\_\+cfg\+\_\+t}} \\*Structure for CIOT MQTT client topics configuration }{\pageref{structciot__mqttc__topics__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \\*Union for CIOT message data }{\pageref{unionciot__msg__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__msg__error__t}{ciot\+\_\+msg\+\_\+error\+\_\+t}} \\*Structure for CIOT message error information }{\pageref{structciot__msg__error__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \\*Structure for CIOT message header }{\pageref{structciot__msg__header__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \\*Structure for CIOT message interface information }{\pageref{structciot__msg__iface__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \\*Structure for CIOT message }{\pageref{structciot__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__nrf__dfu__cfg}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg}} \\*Structure for CIOT Nordic DFU configuration }{\pageref{structciot__nrf__dfu__cfg}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet}} \\*Structure for CIOT Nordic DFU packet }{\pageref{structciot__nrf__dfu__packet}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} \\*Structure for CIOT NTP configuration }{\pageref{structciot__ntp__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ntp__data__u}{ciot\+\_\+ntp\+\_\+data\+\_\+u}} \\*Union for CIOT NTP data }{\pageref{unionciot__ntp__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ntp__req__data__u}{ciot\+\_\+ntp\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT NTP request data }{\pageref{unionciot__ntp__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ntp__req__t}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} \\*Structure for CIOT NTP request }{\pageref{structciot__ntp__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ntp__status__msg__t}{ciot\+\_\+ntp\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure for CIOT NTP status message }{\pageref{structciot__ntp__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ntp__status__t}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} \\*Structure for CIOT NTP status }{\pageref{structciot__ntp__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} \\*Structure for CIOT OPC UA Server configuration }{\pageref{structciot__opcuas__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__opcuas__data__u}{ciot\+\_\+opcuas\+\_\+data\+\_\+u}} \\*Union for CIOT OPC UA Server data }{\pageref{unionciot__opcuas__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__opcuas__req__add__node__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+add\+\_\+node\+\_\+t}} \\*Structure for CIOT OPC UA Server add node request }{\pageref{structciot__opcuas__req__add__node__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__opcuas__req__data__u}{ciot\+\_\+opcuas\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT OPC UA Server request data }{\pageref{unionciot__opcuas__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__opcuas__req__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} \\*Structure for CIOT OPC UA Server request }{\pageref{structciot__opcuas__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__opcuas__status__msg__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure for CIOT OPCUAS status message }{\pageref{structciot__opcuas__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__opcuas__status__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} \\*Structure for CIOT OPC UA Server status }{\pageref{structciot__opcuas__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ota__cfg__t}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} \\*Structure for CIOT OTA configuration }{\pageref{structciot__ota__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ota__data__u}{ciot\+\_\+ota\+\_\+data\+\_\+u}} \\*Union for CIOT OTA data }{\pageref{unionciot__ota__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__ota__req__data__u}{ciot\+\_\+ota\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT OTA request data }{\pageref{unionciot__ota__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ota__req__t}{ciot\+\_\+ota\+\_\+req\+\_\+t}} \\*Structure for CIOT OTA request }{\pageref{structciot__ota__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ota__status__msg__t}{ciot\+\_\+ota\+\_\+status\+\_\+msg\+\_\+t}} \\*Structure for CIOT OTA status message }{\pageref{structciot__ota__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__ota__status__t}{ciot\+\_\+ota\+\_\+status\+\_\+t}} \\*Structure for CIOT OTA status }{\pageref{structciot__ota__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__req__data__u}{ciot\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT request data }{\pageref{unionciot__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__req__delete__iface__cfg__t}{ciot\+\_\+req\+\_\+delete\+\_\+iface\+\_\+cfg\+\_\+t}} \\*Structure for CIOT delete interface configuration request }{\pageref{structciot__req__delete__iface__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__req__proxy__msg__t}{ciot\+\_\+req\+\_\+proxy\+\_\+msg\+\_\+t}} \\*Structure for CIOT proxy message request }{\pageref{structciot__req__proxy__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__req__result__t}{ciot\+\_\+req\+\_\+result\+\_\+t}} \\*Structure for CIOT request result }{\pageref{structciot__req__result__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__req__save__iface__cfg__t}{ciot\+\_\+req\+\_\+save\+\_\+iface\+\_\+cfg\+\_\+t}} \\*Structure for CIOT save interface configuration request }{\pageref{structciot__req__save__iface__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__req__t}{ciot\+\_\+req\+\_\+t}} \\*Structure for CIOT request }{\pageref{structciot__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__s__cfg}{ciot\+\_\+s\+\_\+cfg}} \\*CIOT\+\_\+S config struct }{\pageref{structciot__s__cfg}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__serializer}{ciot\+\_\+serializer}} \\*CIOT Serializer structure }{\pageref{structciot__serializer}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__slip__t}{ciot\+\_\+slip\+\_\+t}} \\*Representation of a SLIP packet }{\pageref{structciot__slip__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__status__t}{ciot\+\_\+status\+\_\+t}} \\*Structure for CIOT status }{\pageref{structciot__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__storage__cfg__t}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} \\*Structure for CIOT storage configuration }{\pageref{structciot__storage__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__storage__data__u}{ciot\+\_\+storage\+\_\+data\+\_\+u}} \\*Union for CIOT storage data }{\pageref{unionciot__storage__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__storage__req__file__data__t}{ciot\+\_\+storage\+\_\+req\+\_\+file\+\_\+data\+\_\+t}} \\*Structure for CIOT storage file data in a request }{\pageref{structciot__storage__req__file__data__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__storage__req__t}{ciot\+\_\+storage\+\_\+req\+\_\+t}} \\*Structure for CIOT storage request }{\pageref{structciot__storage__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__storage__status__msg__t}{ciot\+\_\+storage\+\_\+status\+\_\+msg\+\_\+t}} \\*CIOT Storage status message structure }{\pageref{structciot__storage__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__storage__status__t}{ciot\+\_\+storage\+\_\+status\+\_\+t}} \\*Structure for CIOT storage status }{\pageref{structciot__storage__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__cfg__t}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} \\*Structure for CIOT system configuration }{\pageref{structciot__sys__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__sys__data__u}{ciot\+\_\+sys\+\_\+data\+\_\+u}} \\*Union for CIOT system data }{\pageref{unionciot__sys__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__features__t}{ciot\+\_\+sys\+\_\+features\+\_\+t}} \\*Structure for CIOT system features combining hardware and software features }{\pageref{structciot__sys__features__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__hw__features__t}{ciot\+\_\+sys\+\_\+hw\+\_\+features\+\_\+t}} \\*Structure for CIOT system hardware features }{\pageref{structciot__sys__hw__features__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__info__t}{ciot\+\_\+sys\+\_\+info\+\_\+t}} \\*Structure for CIOT system information }{\pageref{structciot__sys__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__sys__req__data__u}{ciot\+\_\+sys\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT system request data }{\pageref{unionciot__sys__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__req__t}{ciot\+\_\+sys\+\_\+req\+\_\+t}} \\*Structure for CIOT system request }{\pageref{structciot__sys__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__status__msg__t}{ciot\+\_\+sys\+\_\+status\+\_\+msg\+\_\+t}} \\*CIOT System status message structure }{\pageref{structciot__sys__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__status__t}{ciot\+\_\+sys\+\_\+status\+\_\+t}} \\*Structure for CIOT system status }{\pageref{structciot__sys__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__sys__sw__features__t}{ciot\+\_\+sys\+\_\+sw\+\_\+features\+\_\+t}} \\*Structure for CIOT system software features }{\pageref{structciot__sys__sw__features__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \\*Structure for CIOT TCP configuration }{\pageref{structciot__tcp__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__tcp__data__u}{ciot\+\_\+tcp\+\_\+data\+\_\+u}} \\*Union for CIOT TCP data }{\pageref{unionciot__tcp__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__tcp__dhcp__status__t}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+status\+\_\+t}} \\*Structure for CIOT TCP DHCP status }{\pageref{structciot__tcp__dhcp__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__tcp__handle}{ciot\+\_\+tcp\+\_\+handle}} \\*Handle structure for CIOT TCP }{\pageref{structciot__tcp__handle}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__tcp__info__t}{ciot\+\_\+tcp\+\_\+info\+\_\+t}} \\*Structure for CIOT TCP information }{\pageref{structciot__tcp__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__tcp__req__data__u}{ciot\+\_\+tcp\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT TCP request data }{\pageref{unionciot__tcp__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} \\*Structure for CIOT TCP request }{\pageref{structciot__tcp__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__tcp__status__msg__t}{ciot\+\_\+tcp\+\_\+status\+\_\+msg\+\_\+t}} \\*CIOT TCP status message structure }{\pageref{structciot__tcp__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \\*Structure for CIOT TCP status }{\pageref{structciot__tcp__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__timer__cfg}{ciot\+\_\+timer\+\_\+cfg}} \\*Configuration structure for CIOT timer }{\pageref{structciot__timer__cfg}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__uart__base}{ciot\+\_\+uart\+\_\+base}} \\*Base structure for CIOT UART module }{\pageref{structciot__uart__base}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} \\*Structure for CIOT UART configuration }{\pageref{structciot__uart__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__uart__data__u}{ciot\+\_\+uart\+\_\+data\+\_\+u}} \\*Union for CIOT UART data }{\pageref{unionciot__uart__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__uart__event}{ciot\+\_\+uart\+\_\+event}} \\*Union for CIOT UART event }{\pageref{unionciot__uart__event}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__uart__req__data__u}{ciot\+\_\+uart\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT UART request data }{\pageref{unionciot__uart__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__uart__req__send__data__t}{ciot\+\_\+uart\+\_\+req\+\_\+send\+\_\+data\+\_\+t}} \\*Structure for CIOT UART send data request }{\pageref{structciot__uart__req__send__data__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__uart__req__t}{ciot\+\_\+uart\+\_\+req\+\_\+t}} \\*Structure for CIOT UART request }{\pageref{structciot__uart__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__uart__status__msg__t}{ciot\+\_\+uart\+\_\+status\+\_\+msg\+\_\+t}} \\*Status message structure for CIOT UART module }{\pageref{structciot__uart__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} \\*Structure for CIOT UART status }{\pageref{structciot__uart__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__usb__cfg__t}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} \\*Structure for CIOT USB configuration }{\pageref{structciot__usb__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__usb__data__u}{ciot\+\_\+usb\+\_\+data\+\_\+u}} \\*Union for CIOT USB data }{\pageref{unionciot__usb__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__usb__event}{ciot\+\_\+usb\+\_\+event}} \\*Union for CIOT USB event }{\pageref{unionciot__usb__event}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__usb__req__data__u}{ciot\+\_\+usb\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT USB request data }{\pageref{unionciot__usb__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__usb__req__t}{ciot\+\_\+usb\+\_\+req\+\_\+t}} \\*Structure for CIOT USB request }{\pageref{structciot__usb__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__usb__status__msg__t}{ciot\+\_\+usb\+\_\+status\+\_\+msg\+\_\+t}} \\*Status message structure for CIOT USB module }{\pageref{structciot__usb__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__usb__status__t}{ciot\+\_\+usb\+\_\+status\+\_\+t}} \\*Structure for CIOT USB status }{\pageref{structciot__usb__status__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} \\*Structure for CIOT Wi\+Fi access point information }{\pageref{structciot__wifi__ap__info__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} \\*Structure for CIOT Wi\+Fi configuration }{\pageref{structciot__wifi__cfg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__wifi__data__u}{ciot\+\_\+wifi\+\_\+data\+\_\+u}} \\*Union for CIOT Wi\+Fi data }{\pageref{unionciot__wifi__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{unionciot__wifi__req__data__u}{ciot\+\_\+wifi\+\_\+req\+\_\+data\+\_\+u}} \\*Union for CIOT Wi\+Fi request data }{\pageref{unionciot__wifi__req__data__u}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__wifi__req__t}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} \\*Structure for CIOT Wi\+Fi request }{\pageref{structciot__wifi__req__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__wifi__scan__result__t}{ciot\+\_\+wifi\+\_\+scan\+\_\+result\+\_\+t}} \\*Structure for CIOT Wi\+Fi scan result }{\pageref{structciot__wifi__scan__result__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__wifi__status__msg__t}{ciot\+\_\+wifi\+\_\+status\+\_\+msg\+\_\+t}} \\*Packed structure for Wi-\/\+Fi status message }{\pageref{structciot__wifi__status__msg__t}}{} -\item\contentsline{section}{\mbox{\hyperlink{structciot__wifi__status__t}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} \\*Structure for CIOT Wi\+Fi status }{\pageref{structciot__wifi__status__t}}{} -\end{DoxyCompactList} diff --git a/docs/latex/ciot_8h.tex b/docs/latex/ciot_8h.tex deleted file mode 100644 index 921e2de..0000000 --- a/docs/latex/ciot_8h.tex +++ /dev/null @@ -1,244 +0,0 @@ -\doxysection{include/ciot.h File Reference} -\hypertarget{ciot_8h}{}\label{ciot_8h}\index{include/ciot.h@{include/ciot.h}} -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+storage.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+bridge.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__cfg}{ciot\+\_\+cfg}} -\begin{DoxyCompactList}\small\item\em CIOT configuration structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot_8h_a69a23dd0ffa7b32ceaa106938030c108}{CIOT\+\_\+\+IFACE\+\_\+\+CFG\+\_\+\+FILENAME}}~"{}cfg\%d.\+dat"{} -\item -\#define \mbox{\hyperlink{ciot_8h_a06001434900c2b315cf793e5356f2836}{CIOT\+\_\+\+HANDLE}}~NULL -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT network handle. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__cfg}{ciot\+\_\+cfg}} \mbox{\hyperlink{ciot_8h_ad09537300f192bf4861b07202f6ed5fe}{ciot\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT configuration structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} \mbox{\hyperlink{ciot_8h_af5987ba03fd375f7441ab9bf2c53f5f0}{ciot\+\_\+new}} (void) -\begin{DoxyCompactList}\small\item\em Create a new CIOT network instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot_8h_a9ed835b9b7224f7757b9382061afc97c}{ciot\+\_\+start}} (\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} self, \mbox{\hyperlink{ciot_8h_ad09537300f192bf4861b07202f6ed5fe}{ciot\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT network module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot_8h_ab1f4ff509841bbca90c9a29e870a23fd}{ciot\+\_\+set\+\_\+storage}} (\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} self, \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} storage) -\begin{DoxyCompactList}\small\item\em Set the storage for CIOT network data. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot_8h_a6d0892881a59cab0baba866d2dfdaa33}{ciot\+\_\+register\+\_\+event}} (\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} self, \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}} event\+\_\+handler, void \texorpdfstring{$\ast$}{*}event\+\_\+args) -\begin{DoxyCompactList}\small\item\em Register an event handler for CIOT network events. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot_8h_af32f995ccbb96d62688e73df1f2998a9}{ciot\+\_\+proxy\+\_\+send\+\_\+req}} (\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} self, \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}iface, \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \texorpdfstring{$\ast$}{*}proxy\+\_\+iface, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}req, int size) -\begin{DoxyCompactList}\small\item\em Send a request via a proxy interface in CIOT network. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot_8h_aa11d77071edcfb2ae57b26f92cda2e06}{ciot\+\_\+save\+\_\+iface\+\_\+cfg}} (\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} self, uint8\+\_\+t iface\+\_\+id) -\begin{DoxyCompactList}\small\item\em Save the configuration of a specific interface in CIOT network. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot_8h_a2de16f3df26c78b69f64cf6e20050d4e}{ciot\+\_\+delete\+\_\+iface\+\_\+cfg}} (\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} self, uint8\+\_\+t iface\+\_\+id) -\begin{DoxyCompactList}\small\item\em Delete the configuration of a specific interface in CIOT network. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot_8h_a27c376712b0d3594c545846834d24d25}{ciot\+\_\+task}} (\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Perform the CIOT network task. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot_8h_a06001434900c2b315cf793e5356f2836}\label{ciot_8h_a06001434900c2b315cf793e5356f2836} -\index{ciot.h@{ciot.h}!CIOT\_HANDLE@{CIOT\_HANDLE}} -\index{CIOT\_HANDLE@{CIOT\_HANDLE}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HANDLE}{CIOT\_HANDLE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HANDLE~NULL} - -\Hypertarget{ciot_8h_a69a23dd0ffa7b32ceaa106938030c108}\label{ciot_8h_a69a23dd0ffa7b32ceaa106938030c108} -\index{ciot.h@{ciot.h}!CIOT\_IFACE\_CFG\_FILENAME@{CIOT\_IFACE\_CFG\_FILENAME}} -\index{CIOT\_IFACE\_CFG\_FILENAME@{CIOT\_IFACE\_CFG\_FILENAME}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_IFACE\_CFG\_FILENAME}{CIOT\_IFACE\_CFG\_FILENAME}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+IFACE\+\_\+\+CFG\+\_\+\+FILENAME~"{}cfg\%d.\+dat"{}} - - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot_8h_ad09537300f192bf4861b07202f6ed5fe}\label{ciot_8h_ad09537300f192bf4861b07202f6ed5fe} -\index{ciot.h@{ciot.h}!ciot\_cfg\_t@{ciot\_cfg\_t}} -\index{ciot\_cfg\_t@{ciot\_cfg\_t}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_cfg\_t}{ciot\_cfg\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__cfg}{ciot\+\_\+cfg}} \mbox{\hyperlink{ciot_8h_ad09537300f192bf4861b07202f6ed5fe}{ciot\+\_\+cfg\+\_\+t}}} - - - -CIOT configuration structure. - -\Hypertarget{ciot_8h_a8543fc73092a47512369c90b44059bb6}\label{ciot_8h_a8543fc73092a47512369c90b44059bb6} -\index{ciot.h@{ciot.h}!ciot\_t@{ciot\_t}} -\index{ciot\_t@{ciot\_t}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_t}{ciot\_t}} -{\footnotesize\ttfamily typedef struct ciot\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}} - - - -CIOT network handle. - - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot_8h_a2de16f3df26c78b69f64cf6e20050d4e}\label{ciot_8h_a2de16f3df26c78b69f64cf6e20050d4e} -\index{ciot.h@{ciot.h}!ciot\_delete\_iface\_cfg@{ciot\_delete\_iface\_cfg}} -\index{ciot\_delete\_iface\_cfg@{ciot\_delete\_iface\_cfg}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_delete\_iface\_cfg()}{ciot\_delete\_iface\_cfg()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+delete\+\_\+iface\+\_\+cfg (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}}]{self, }\item[{uint8\+\_\+t}]{iface\+\_\+id }\end{DoxyParamCaption})} - - - -Delete the configuration of a specific interface in CIOT network. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT network instance. \\ -\hline -{\em iface\+\_\+id} & ID of the interface to delete. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot_8h_af5987ba03fd375f7441ab9bf2c53f5f0}\label{ciot_8h_af5987ba03fd375f7441ab9bf2c53f5f0} -\index{ciot.h@{ciot.h}!ciot\_new@{ciot\_new}} -\index{ciot\_new@{ciot\_new}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_new()}{ciot\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} ciot\+\_\+new (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -Create a new CIOT network instance. - -\begin{DoxyReturn}{Returns} -Pointer to the created CIOT network instance. -\end{DoxyReturn} -\Hypertarget{ciot_8h_af32f995ccbb96d62688e73df1f2998a9}\label{ciot_8h_af32f995ccbb96d62688e73df1f2998a9} -\index{ciot.h@{ciot.h}!ciot\_proxy\_send\_req@{ciot\_proxy\_send\_req}} -\index{ciot\_proxy\_send\_req@{ciot\_proxy\_send\_req}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_proxy\_send\_req()}{ciot\_proxy\_send\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+proxy\+\_\+send\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{iface, }\item[{\mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{proxy\+\_\+iface, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send a request via a proxy interface in CIOT network. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT network instance. \\ -\hline -{\em iface} & Pointer to the network interface. \\ -\hline -{\em proxy\+\_\+iface} & Pointer to the proxy interface. \\ -\hline -{\em req} & Pointer to the request message. \\ -\hline -{\em size} & Size of the request message. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot_8h_a6d0892881a59cab0baba866d2dfdaa33}\label{ciot_8h_a6d0892881a59cab0baba866d2dfdaa33} -\index{ciot.h@{ciot.h}!ciot\_register\_event@{ciot\_register\_event}} -\index{ciot\_register\_event@{ciot\_register\_event}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_register\_event()}{ciot\_register\_event()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+register\+\_\+event (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}}}]{event\+\_\+handler, }\item[{void \texorpdfstring{$\ast$}{*}}]{event\+\_\+args }\end{DoxyParamCaption})} - - - -Register an event handler for CIOT network events. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT network instance. \\ -\hline -{\em event\+\_\+handler} & Event handler function. \\ -\hline -{\em event\+\_\+args} & Event handler arguments. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot_8h_aa11d77071edcfb2ae57b26f92cda2e06}\label{ciot_8h_aa11d77071edcfb2ae57b26f92cda2e06} -\index{ciot.h@{ciot.h}!ciot\_save\_iface\_cfg@{ciot\_save\_iface\_cfg}} -\index{ciot\_save\_iface\_cfg@{ciot\_save\_iface\_cfg}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_save\_iface\_cfg()}{ciot\_save\_iface\_cfg()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+save\+\_\+iface\+\_\+cfg (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}}]{self, }\item[{uint8\+\_\+t}]{iface\+\_\+id }\end{DoxyParamCaption})} - - - -Save the configuration of a specific interface in CIOT network. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT network instance. \\ -\hline -{\em iface\+\_\+id} & ID of the interface to save. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot_8h_ab1f4ff509841bbca90c9a29e870a23fd}\label{ciot_8h_ab1f4ff509841bbca90c9a29e870a23fd} -\index{ciot.h@{ciot.h}!ciot\_set\_storage@{ciot\_set\_storage}} -\index{ciot\_set\_storage@{ciot\_set\_storage}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_set\_storage()}{ciot\_set\_storage()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+set\+\_\+storage (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{storage }\end{DoxyParamCaption})} - - - -Set the storage for CIOT network data. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT network instance. \\ -\hline -{\em storage} & Pointer to the storage instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot_8h_a9ed835b9b7224f7757b9382061afc97c}\label{ciot_8h_a9ed835b9b7224f7757b9382061afc97c} -\index{ciot.h@{ciot.h}!ciot\_start@{ciot\_start}} -\index{ciot\_start@{ciot\_start}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_start()}{ciot\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot_8h_ad09537300f192bf4861b07202f6ed5fe}{ciot\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT network module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT network instance. \\ -\hline -{\em cfg} & Pointer to the network configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot_8h_a27c376712b0d3594c545846834d24d25}\label{ciot_8h_a27c376712b0d3594c545846834d24d25} -\index{ciot.h@{ciot.h}!ciot\_task@{ciot\_task}} -\index{ciot\_task@{ciot\_task}!ciot.h@{ciot.h}} -\doxysubsubsection{\texorpdfstring{ciot\_task()}{ciot\_task()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Perform the CIOT network task. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT network instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot_8h_source.tex b/docs/latex/ciot_8h_source.tex deleted file mode 100644 index 991cf7e..0000000 --- a/docs/latex/ciot_8h_source.tex +++ /dev/null @@ -1,75 +0,0 @@ -\doxysection{ciot.\+h} -\hypertarget{ciot_8h_source}{}\label{ciot_8h_source}\index{include/ciot.h@{include/ciot.h}} -\mbox{\hyperlink{ciot_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__storage_8h}{ciot\_storage.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__bridge_8h}{ciot\_bridge.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#define\ CIOT\_IFACE\_CFG\_FILENAME\ "{}cfg\%d.dat"{}}} -\DoxyCodeLine{00023\ } -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#ifdef\ CIOT\_TARGET\_MONGOOSE}} -\DoxyCodeLine{00025\ } -\DoxyCodeLine{00026\ \textcolor{keyword}{extern}\ \textcolor{keyword}{struct\ }mg\_mgr\ mg;\ } -\DoxyCodeLine{00027\ } -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#define\ CIOT\_HANDLE\ \&mg}} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#else}} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#define\ CIOT\_HANDLE\ NULL}} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00035\ } -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#ifdef\ CIOT\_TARGET\_NRF}} -\DoxyCodeLine{00037\ } -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#define\ app\_main\ main}} -\DoxyCodeLine{00039\ } -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#ifdef\ \ CIOT\_TARGET\_ARDUINO}} -\DoxyCodeLine{00043\ } -\DoxyCodeLine{00044\ \textcolor{preprocessor}{\#define\ app\_main\ setup}} -\DoxyCodeLine{00045\ } -\DoxyCodeLine{00046\ \textcolor{preprocessor}{\#endif\ \ }\textcolor{comment}{//CIOT\_TARGET\_ARDUINO}} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00048\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\ *\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}};\ } -\DoxyCodeLine{00049\ } -\DoxyCodeLine{00054\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__cfg}{ciot\_cfg}}} -\DoxyCodeLine{00055\ \{} -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ **\mbox{\hyperlink{structciot__cfg_abcdb687b2ecbb5e6f9125c1ea584bb68}{ifaces}};\ } -\DoxyCodeLine{00057\ \ \ \ \ \textcolor{keywordtype}{void}\ **\mbox{\hyperlink{structciot__cfg_a428c51338631d897b42d617f8db50410}{cfgs}};\ } -\DoxyCodeLine{00058\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__cfg_a20302e2c99a60d3f612dba57e3f6333b}{count}};\ } -\DoxyCodeLine{00059\ \}\ \mbox{\hyperlink{ciot_8h_ad09537300f192bf4861b07202f6ed5fe}{ciot\_cfg\_t}};} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00066\ \mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ \mbox{\hyperlink{ciot_8h_af5987ba03fd375f7441ab9bf2c53f5f0}{ciot\_new}}(\textcolor{keywordtype}{void});} -\DoxyCodeLine{00067\ } -\DoxyCodeLine{00075\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot_8h_a9ed835b9b7224f7757b9382061afc97c}{ciot\_start}}(\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ self,\ \mbox{\hyperlink{structciot__cfg}{ciot\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00076\ } -\DoxyCodeLine{00084\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot_8h_ab1f4ff509841bbca90c9a29e870a23fd}{ciot\_set\_storage}}(\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ self,\ \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ storage);} -\DoxyCodeLine{00085\ } -\DoxyCodeLine{00094\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot_8h_a6d0892881a59cab0baba866d2dfdaa33}{ciot\_register\_event}}(\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ self,\ \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\_iface\_event\_handler\_t}}\ event\_handler,\ \textcolor{keywordtype}{void}\ *event\_args);} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00106\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot_8h_af32f995ccbb96d62688e73df1f2998a9}{ciot\_proxy\_send\_req}}(\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ self,\ \mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *iface,\ \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\_msg\_iface\_info\_t}}\ *proxy\_iface,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *req,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00107\ } -\DoxyCodeLine{00115\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot_8h_aa11d77071edcfb2ae57b26f92cda2e06}{ciot\_save\_iface\_cfg}}(\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ self,\ uint8\_t\ iface\_id);} -\DoxyCodeLine{00116\ } -\DoxyCodeLine{00124\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot_8h_a2de16f3df26c78b69f64cf6e20050d4e}{ciot\_delete\_iface\_cfg}}(\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ self,\ uint8\_t\ iface\_id);} -\DoxyCodeLine{00125\ } -\DoxyCodeLine{00132\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot_8h_a27c376712b0d3594c545846834d24d25}{ciot\_task}}(\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ self);} -\DoxyCodeLine{00133\ } -\DoxyCodeLine{00134\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00135\ \}} -\DoxyCodeLine{00136\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00137\ } -\DoxyCodeLine{00138\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ble_8h.tex b/docs/latex/ciot__ble_8h.tex deleted file mode 100644 index 3445323..0000000 --- a/docs/latex/ciot__ble_8h.tex +++ /dev/null @@ -1,340 +0,0 @@ -\doxysection{include/ciot\+\_\+ble.h File Reference} -\hypertarget{ciot__ble_8h}{}\label{ciot__ble_8h}\index{include/ciot\_ble.h@{include/ciot\_ble.h}} - - -Defines functions and types for CIOT Bluetooth Low Energy (BLE) module. - - -{\ttfamily \#include "{}types/ciot\+\_\+ble\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ble\+\_\+scn.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ble__ifaces}{ciot\+\_\+ble\+\_\+ifaces}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE interface configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ble__status__msg__t}{ciot\+\_\+ble\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+ble \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Pointer to a CIOT BLE object. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bb}{ciot\+\_\+ble\+\_\+mac\+\_\+type}} \mbox{\hyperlink{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664}{ciot\+\_\+ble\+\_\+mac\+\_\+type\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT BLE MAC type. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__ble__ifaces}{ciot\+\_\+ble\+\_\+ifaces}} \mbox{\hyperlink{ciot__ble_8h_a7e2846e13398ef6ffd6def913495f5c2}{ciot\+\_\+ble\+\_\+ifaces\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE interface configuration. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bb}{ciot\+\_\+ble\+\_\+mac\+\_\+type}} \{ \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbae978837f99a7554a6ea2a13d470d3d33}{CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba9863cb9813d17d8384e6a4a1d1040099}{CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+HARDWARE}} -, \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbab0017c745f97c33b61ccf012a920f246}{CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+SOFTWARE}} -, \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba1620399b223e49561ca78b27fc34f548}{CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+REAL}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT BLE MAC type. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_ab9cc93352ac370bae80dc47d28a18f55}{ciot\+\_\+ble\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT BLE object. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_a03de82cf82dab2814fa4315b82fdb62c}{ciot\+\_\+ble\+\_\+start}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self, \mbox{\hyperlink{structciot__ble__cfg__t}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT BLE module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_a89c4a8b8eac676407cebe70daa7bbdee}{ciot\+\_\+ble\+\_\+stop}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT BLE module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_aa0249bac01c064dddf3e9327224789d8}{ciot\+\_\+ble\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self, \mbox{\hyperlink{structciot__ble__req__t}{ciot\+\_\+ble\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a BLE module request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_a4a6fad82ac94edb3e85476136784ae92}{ciot\+\_\+ble\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data using the CIOT BLE module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_a3c3fffa1a77cc81312c4c81de699ef6b}{ciot\+\_\+ble\+\_\+task}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Perform a task for the CIOT BLE module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_a7d43433b80be91b2ee1be13c7c26ea78}{ciot\+\_\+ble\+\_\+set\+\_\+mac}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self, uint8\+\_\+t mac\mbox{[}6\mbox{]}) -\begin{DoxyCompactList}\small\item\em Set the MAC address for the CIOT BLE module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_ada2bfd0d1620ed6addb4768df6e04a1a}{ciot\+\_\+ble\+\_\+get\+\_\+mac}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self, \mbox{\hyperlink{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664}{ciot\+\_\+ble\+\_\+mac\+\_\+type\+\_\+t}} type, uint8\+\_\+t mac\mbox{[}6\mbox{]}) -\begin{DoxyCompactList}\small\item\em Get the MAC address from the CIOT BLE module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble_8h_aa7915a6de7995a7b3ddb3fad62594ec4}{ciot\+\_\+ble\+\_\+set\+\_\+ifaces}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self, \mbox{\hyperlink{ciot__ble_8h_a7e2846e13398ef6ffd6def913495f5c2}{ciot\+\_\+ble\+\_\+ifaces\+\_\+t}} \texorpdfstring{$\ast$}{*}ifaces) -\begin{DoxyCompactList}\small\item\em Set the interfaces for the CIOT BLE module. \end{DoxyCompactList}\item -bool \mbox{\hyperlink{ciot__ble_8h_afb9a5b45554f53c423a114f63e2b67fd}{ciot\+\_\+ble\+\_\+mac\+\_\+is\+\_\+valid}} (\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} self, uint8\+\_\+t mac\mbox{[}6\mbox{]}) -\begin{DoxyCompactList}\small\item\em Check if a MAC address is valid for the CIOT BLE module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines functions and types for CIOT Bluetooth Low Energy (BLE) module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/20 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__ble_8h_a7e2846e13398ef6ffd6def913495f5c2}\label{ciot__ble_8h_a7e2846e13398ef6ffd6def913495f5c2} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_ifaces\_t@{ciot\_ble\_ifaces\_t}} -\index{ciot\_ble\_ifaces\_t@{ciot\_ble\_ifaces\_t}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_ifaces\_t}{ciot\_ble\_ifaces\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__ble__ifaces}{ciot\+\_\+ble\+\_\+ifaces}} \mbox{\hyperlink{ciot__ble_8h_a7e2846e13398ef6ffd6def913495f5c2}{ciot\+\_\+ble\+\_\+ifaces\+\_\+t}}} - - - -Structure for CIOT BLE interface configuration. - -\Hypertarget{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664}\label{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_mac\_type\_t@{ciot\_ble\_mac\_type\_t}} -\index{ciot\_ble\_mac\_type\_t@{ciot\_ble\_mac\_type\_t}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_mac\_type\_t}{ciot\_ble\_mac\_type\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bb}{ciot\+\_\+ble\+\_\+mac\+\_\+type}} \mbox{\hyperlink{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664}{ciot\+\_\+ble\+\_\+mac\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT BLE MAC type. - -\Hypertarget{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}\label{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_t@{ciot\_ble\_t}} -\index{ciot\_ble\_t@{ciot\_ble\_t}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_t}{ciot\_ble\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+ble\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}} - - - -Pointer to a CIOT BLE object. - -\texorpdfstring{$<$}{<} Include BLE types \texorpdfstring{$<$}{<} Include CIOT error handling \texorpdfstring{$<$}{<} Include CIOT BLE scanner - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bb}\label{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bb} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_mac\_type@{ciot\_ble\_mac\_type}} -\index{ciot\_ble\_mac\_type@{ciot\_ble\_mac\_type}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_mac\_type}{ciot\_ble\_mac\_type}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bb}{ciot\+\_\+ble\+\_\+mac\+\_\+type}}} - - - -Enumeration for CIOT BLE MAC type. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_MAC\_TYPE\_UNKNOWN@{CIOT\_BLE\_MAC\_TYPE\_UNKNOWN}!ciot\_ble.h@{ciot\_ble.h}}\index{ciot\_ble.h@{ciot\_ble.h}!CIOT\_BLE\_MAC\_TYPE\_UNKNOWN@{CIOT\_BLE\_MAC\_TYPE\_UNKNOWN}}}\Hypertarget{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbae978837f99a7554a6ea2a13d470d3d33}\label{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbae978837f99a7554a6ea2a13d470d3d33} -CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+UNKNOWN&Unknown MAC type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_MAC\_TYPE\_HARDWARE@{CIOT\_BLE\_MAC\_TYPE\_HARDWARE}!ciot\_ble.h@{ciot\_ble.h}}\index{ciot\_ble.h@{ciot\_ble.h}!CIOT\_BLE\_MAC\_TYPE\_HARDWARE@{CIOT\_BLE\_MAC\_TYPE\_HARDWARE}}}\Hypertarget{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba9863cb9813d17d8384e6a4a1d1040099}\label{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba9863cb9813d17d8384e6a4a1d1040099} -CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+HARDWARE&Hardware MAC type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_MAC\_TYPE\_SOFTWARE@{CIOT\_BLE\_MAC\_TYPE\_SOFTWARE}!ciot\_ble.h@{ciot\_ble.h}}\index{ciot\_ble.h@{ciot\_ble.h}!CIOT\_BLE\_MAC\_TYPE\_SOFTWARE@{CIOT\_BLE\_MAC\_TYPE\_SOFTWARE}}}\Hypertarget{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbab0017c745f97c33b61ccf012a920f246}\label{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbab0017c745f97c33b61ccf012a920f246} -CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+SOFTWARE&Software MAC type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_MAC\_TYPE\_REAL@{CIOT\_BLE\_MAC\_TYPE\_REAL}!ciot\_ble.h@{ciot\_ble.h}}\index{ciot\_ble.h@{ciot\_ble.h}!CIOT\_BLE\_MAC\_TYPE\_REAL@{CIOT\_BLE\_MAC\_TYPE\_REAL}}}\Hypertarget{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba1620399b223e49561ca78b27fc34f548}\label{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba1620399b223e49561ca78b27fc34f548} -CIOT\+\_\+\+BLE\+\_\+\+MAC\+\_\+\+TYPE\+\_\+\+REAL&Real MAC type \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__ble_8h_ada2bfd0d1620ed6addb4768df6e04a1a}\label{ciot__ble_8h_ada2bfd0d1620ed6addb4768df6e04a1a} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_get\_mac@{ciot\_ble\_get\_mac}} -\index{ciot\_ble\_get\_mac@{ciot\_ble\_get\_mac}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_get\_mac()}{ciot\_ble\_get\_mac()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+get\+\_\+mac (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664}{ciot\+\_\+ble\+\_\+mac\+\_\+type\+\_\+t}}}]{type, }\item[{uint8\+\_\+t}]{mac\mbox{[}6\mbox{]} }\end{DoxyParamCaption})} - - - -Get the MAC address from the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -{\em type} & Type of MAC address to retrieve \\ -\hline -{\em mac} & Pointer to store the retrieved MAC address \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_afb9a5b45554f53c423a114f63e2b67fd}\label{ciot__ble_8h_afb9a5b45554f53c423a114f63e2b67fd} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_mac\_is\_valid@{ciot\_ble\_mac\_is\_valid}} -\index{ciot\_ble\_mac\_is\_valid@{ciot\_ble\_mac\_is\_valid}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_mac\_is\_valid()}{ciot\_ble\_mac\_is\_valid()}} -{\footnotesize\ttfamily bool ciot\+\_\+ble\+\_\+mac\+\_\+is\+\_\+valid (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self, }\item[{uint8\+\_\+t}]{mac\mbox{[}6\mbox{]} }\end{DoxyParamCaption})} - - - -Check if a MAC address is valid for the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -{\em mac} & MAC address to check \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -true if the MAC address is valid, false otherwise -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_ab9cc93352ac370bae80dc47d28a18f55}\label{ciot__ble_8h_ab9cc93352ac370bae80dc47d28a18f55} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_new@{ciot\_ble\_new}} -\index{ciot\_ble\_new@{ciot\_ble\_new}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_new()}{ciot\_ble\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} ciot\+\_\+ble\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT BLE object. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the handle \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the created CIOT BLE object -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_aa0249bac01c064dddf3e9327224789d8}\label{ciot__ble_8h_aa0249bac01c064dddf3e9327224789d8} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_process\_req@{ciot\_ble\_process\_req}} -\index{ciot\_ble\_process\_req@{ciot\_ble\_process\_req}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_process\_req()}{ciot\_ble\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ble__req__t}{ciot\+\_\+ble\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a BLE module request. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -{\em req} & Pointer to the BLE request \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_a4a6fad82ac94edb3e85476136784ae92}\label{ciot__ble_8h_a4a6fad82ac94edb3e85476136784ae92} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_send\_data@{ciot\_ble\_send\_data}} -\index{ciot\_ble\_send\_data@{ciot\_ble\_send\_data}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_send\_data()}{ciot\_ble\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data using the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -{\em data} & Pointer to the data to be sent \\ -\hline -{\em size} & Size of the data in bytes \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_aa7915a6de7995a7b3ddb3fad62594ec4}\label{ciot__ble_8h_aa7915a6de7995a7b3ddb3fad62594ec4} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_set\_ifaces@{ciot\_ble\_set\_ifaces}} -\index{ciot\_ble\_set\_ifaces@{ciot\_ble\_set\_ifaces}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_set\_ifaces()}{ciot\_ble\_set\_ifaces()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+set\+\_\+ifaces (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot__ble_8h_a7e2846e13398ef6ffd6def913495f5c2}{ciot\+\_\+ble\+\_\+ifaces\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{ifaces }\end{DoxyParamCaption})} - - - -Set the interfaces for the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -{\em ifaces} & Pointer to the BLE interfaces configuration \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_a7d43433b80be91b2ee1be13c7c26ea78}\label{ciot__ble_8h_a7d43433b80be91b2ee1be13c7c26ea78} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_set\_mac@{ciot\_ble\_set\_mac}} -\index{ciot\_ble\_set\_mac@{ciot\_ble\_set\_mac}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_set\_mac()}{ciot\_ble\_set\_mac()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+set\+\_\+mac (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self, }\item[{uint8\+\_\+t}]{mac\mbox{[}6\mbox{]} }\end{DoxyParamCaption})} - - - -Set the MAC address for the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -{\em mac} & MAC address to set \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_a03de82cf82dab2814fa4315b82fdb62c}\label{ciot__ble_8h_a03de82cf82dab2814fa4315b82fdb62c} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_start@{ciot\_ble\_start}} -\index{ciot\_ble\_start@{ciot\_ble\_start}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_start()}{ciot\_ble\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ble__cfg__t}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -{\em cfg} & Pointer to the BLE configuration \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_a89c4a8b8eac676407cebe70daa7bbdee}\label{ciot__ble_8h_a89c4a8b8eac676407cebe70daa7bbdee} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_stop@{ciot\_ble\_stop}} -\index{ciot\_ble\_stop@{ciot\_ble\_stop}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_stop()}{ciot\_ble\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble_8h_a3c3fffa1a77cc81312c4c81de699ef6b}\label{ciot__ble_8h_a3c3fffa1a77cc81312c4c81de699ef6b} -\index{ciot\_ble.h@{ciot\_ble.h}!ciot\_ble\_task@{ciot\_ble\_task}} -\index{ciot\_ble\_task@{ciot\_ble\_task}!ciot\_ble.h@{ciot\_ble.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_task()}{ciot\_ble\_task()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Perform a task for the CIOT BLE module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE object \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} diff --git a/docs/latex/ciot__ble_8h_source.tex b/docs/latex/ciot__ble_8h_source.tex deleted file mode 100644 index 8dbf255..0000000 --- a/docs/latex/ciot__ble_8h_source.tex +++ /dev/null @@ -1,64 +0,0 @@ -\doxysection{ciot\+\_\+ble.\+h} -\hypertarget{ciot__ble_8h_source}{}\label{ciot__ble_8h_source}\index{include/ciot\_ble.h@{include/ciot\_ble.h}} -\mbox{\hyperlink{ciot__ble_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_BLE\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_BLE\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__types_8h}{types/ciot\_ble\_types.h}}"{}}\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}\ } -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__scn_8h}{ciot\_ble\_scn.h}}"{}}\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_ble\ *\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}};} -\DoxyCodeLine{00024\ } -\DoxyCodeLine{00026\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bb}{ciot\_ble\_mac\_type}}} -\DoxyCodeLine{00027\ \{} -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbae978837f99a7554a6ea2a13d470d3d33}{CIOT\_BLE\_MAC\_TYPE\_UNKNOWN}},\ } -\DoxyCodeLine{00029\ \ \ \ \ \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba9863cb9813d17d8384e6a4a1d1040099}{CIOT\_BLE\_MAC\_TYPE\_HARDWARE}},\ } -\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bbab0017c745f97c33b61ccf012a920f246}{CIOT\_BLE\_MAC\_TYPE\_SOFTWARE}},\ } -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{ciot__ble_8h_a8f93d371d8add01e842d3888601f65bba1620399b223e49561ca78b27fc34f548}{CIOT\_BLE\_MAC\_TYPE\_REAL}},\ } -\DoxyCodeLine{00032\ \}\ \mbox{\hyperlink{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664}{ciot\_ble\_mac\_type\_t}};} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00035\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__ble__ifaces}{ciot\_ble\_ifaces}}} -\DoxyCodeLine{00036\ \{} -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ \mbox{\hyperlink{structciot__ble__ifaces_a9ef3a8d93d750f948c6a3db1563132b4}{scanner}};\ } -\DoxyCodeLine{00038\ \ \ \ \ \textcolor{comment}{//\ ciot\_ble\_adv\_t\ adv;\ /**<\ BLE\ advertiser\ object\ */}} -\DoxyCodeLine{00039\ \}\ \mbox{\hyperlink{ciot__ble_8h_a7e2846e13398ef6ffd6def913495f5c2}{ciot\_ble\_ifaces\_t}};} -\DoxyCodeLine{00040\ } -\DoxyCodeLine{00042\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00043\ \{} -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__ble__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{structciot__ble__status__t}{ciot\_ble\_status\_t}}\ \mbox{\hyperlink{structciot__ble__status__msg__t_ae334becb4d9815b900b4cc43b5b9e49b}{status}};\ } -\DoxyCodeLine{00046\ \}\ \mbox{\hyperlink{structciot__ble__status__msg__t}{ciot\_ble\_status\_msg\_t}};} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00053\ \mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ \mbox{\hyperlink{ciot__ble_8h_ab9cc93352ac370bae80dc47d28a18f55}{ciot\_ble\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00054\ } -\DoxyCodeLine{00061\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_a03de82cf82dab2814fa4315b82fdb62c}{ciot\_ble\_start}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self,\ \mbox{\hyperlink{structciot__ble__cfg__t}{ciot\_ble\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00062\ } -\DoxyCodeLine{00068\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_a89c4a8b8eac676407cebe70daa7bbdee}{ciot\_ble\_stop}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self);} -\DoxyCodeLine{00069\ } -\DoxyCodeLine{00076\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_aa0249bac01c064dddf3e9327224789d8}{ciot\_ble\_process\_req}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self,\ \mbox{\hyperlink{structciot__ble__req__t}{ciot\_ble\_req\_t}}\ *req);} -\DoxyCodeLine{00077\ } -\DoxyCodeLine{00085\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_a4a6fad82ac94edb3e85476136784ae92}{ciot\_ble\_send\_data}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00086\ } -\DoxyCodeLine{00092\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_a3c3fffa1a77cc81312c4c81de699ef6b}{ciot\_ble\_task}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self);} -\DoxyCodeLine{00093\ } -\DoxyCodeLine{00100\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_a7d43433b80be91b2ee1be13c7c26ea78}{ciot\_ble\_set\_mac}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self,\ uint8\_t\ mac[6]);} -\DoxyCodeLine{00101\ } -\DoxyCodeLine{00109\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_ada2bfd0d1620ed6addb4768df6e04a1a}{ciot\_ble\_get\_mac}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self,\ \mbox{\hyperlink{ciot__ble_8h_a05089e2e5330e0767d0ac074a0d48664}{ciot\_ble\_mac\_type\_t}}\ type,\ uint8\_t\ mac[6]);} -\DoxyCodeLine{00110\ } -\DoxyCodeLine{00117\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble_8h_aa7915a6de7995a7b3ddb3fad62594ec4}{ciot\_ble\_set\_ifaces}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self,\ \mbox{\hyperlink{structciot__ble__ifaces}{ciot\_ble\_ifaces\_t}}\ *ifaces);} -\DoxyCodeLine{00118\ } -\DoxyCodeLine{00125\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{ciot__ble_8h_afb9a5b45554f53c423a114f63e2b67fd}{ciot\_ble\_mac\_is\_valid}}(\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ self,\ uint8\_t\ mac[6]);} -\DoxyCodeLine{00126\ } -\DoxyCodeLine{00127\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00128\ \}} -\DoxyCodeLine{00129\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00130\ } -\DoxyCodeLine{00131\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ble__scn_8h.tex b/docs/latex/ciot__ble__scn_8h.tex deleted file mode 100644 index 912759e..0000000 --- a/docs/latex/ciot__ble__scn_8h.tex +++ /dev/null @@ -1,210 +0,0 @@ -\doxysection{include/ciot\+\_\+ble\+\_\+scn.h File Reference} -\hypertarget{ciot__ble__scn_8h}{}\label{ciot__ble__scn_8h}\index{include/ciot\_ble\_scn.h@{include/ciot\_ble\_scn.h}} - - -Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner. - - -{\ttfamily \#include "{}types/ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ble__scn__status__msg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE scanner status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+ble\+\_\+scn \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Pointer to a CIOT BLE scanner object. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} \mbox{\hyperlink{ciot__ble__scn_8h_a412a0a86f5b189b653efb2f334d5613f}{ciot\+\_\+ble\+\_\+scn\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT BLE scanner object. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble__scn_8h_a9c8db4404daa80df68b678a3b41aa9b4}{ciot\+\_\+ble\+\_\+scn\+\_\+start}} (\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} self, \mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT BLE scanner. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble__scn_8h_acb4c25e68c3ad8a3b3ca67dbcb6e89f2}{ciot\+\_\+ble\+\_\+scn\+\_\+stop}} (\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT BLE scanner. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble__scn_8h_a22b3f45a7f6909bc350f1e7dbee0c599}{ciot\+\_\+ble\+\_\+scn\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} self, \mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a BLE scanner request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble__scn_8h_a2768bcd961a130564cf03a0d21123d91}{ciot\+\_\+ble\+\_\+scn\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data using the CIOT BLE scanner. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble__scn_8h_ac868bbc26c4ba11695e5c3dcaa80b201}{ciot\+\_\+ble\+\_\+scn\+\_\+handle\+\_\+event}} (\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} self, void \texorpdfstring{$\ast$}{*}event, void \texorpdfstring{$\ast$}{*}event\+\_\+args) -\begin{DoxyCompactList}\small\item\em Handle a BLE scanner event. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ble__scn_8h_af3c5072d04dee93723266acd2ae40bda}{ciot\+\_\+ble\+\_\+scn\+\_\+get\+\_\+adv\+\_\+info}} (\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} self, \mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} \texorpdfstring{$\ast$}{*}adv\+\_\+info) -\begin{DoxyCompactList}\small\item\em Get advertising information from the CIOT BLE scanner. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/18 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}\label{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_t@{ciot\_ble\_scn\_t}} -\index{ciot\_ble\_scn\_t@{ciot\_ble\_scn\_t}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_t}{ciot\_ble\_scn\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+ble\+\_\+scn\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}}} - - - -Pointer to a CIOT BLE scanner object. - -\texorpdfstring{$<$}{<} Include BLE scanner types \texorpdfstring{$<$}{<} Include CIOT interface \texorpdfstring{$<$}{<} Include CIOT error handling - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__ble__scn_8h_af3c5072d04dee93723266acd2ae40bda}\label{ciot__ble__scn_8h_af3c5072d04dee93723266acd2ae40bda} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_get\_adv\_info@{ciot\_ble\_scn\_get\_adv\_info}} -\index{ciot\_ble\_scn\_get\_adv\_info@{ciot\_ble\_scn\_get\_adv\_info}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_get\_adv\_info()}{ciot\_ble\_scn\_get\_adv\_info()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+scn\+\_\+get\+\_\+adv\+\_\+info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{adv\+\_\+info }\end{DoxyParamCaption})} - - - -Get advertising information from the CIOT BLE scanner. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE scanner object \\ -\hline -{\em adv\+\_\+info} & Pointer to the advertising information structure \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble__scn_8h_ac868bbc26c4ba11695e5c3dcaa80b201}\label{ciot__ble__scn_8h_ac868bbc26c4ba11695e5c3dcaa80b201} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_handle\_event@{ciot\_ble\_scn\_handle\_event}} -\index{ciot\_ble\_scn\_handle\_event@{ciot\_ble\_scn\_handle\_event}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_handle\_event()}{ciot\_ble\_scn\_handle\_event()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+scn\+\_\+handle\+\_\+event (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}}}]{self, }\item[{void \texorpdfstring{$\ast$}{*}}]{event, }\item[{void \texorpdfstring{$\ast$}{*}}]{event\+\_\+args }\end{DoxyParamCaption})} - - - -Handle a BLE scanner event. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE scanner object \\ -\hline -{\em event} & Pointer to the event \\ -\hline -{\em event\+\_\+args} & Pointer to the event arguments \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble__scn_8h_a412a0a86f5b189b653efb2f334d5613f}\label{ciot__ble__scn_8h_a412a0a86f5b189b653efb2f334d5613f} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_new@{ciot\_ble\_scn\_new}} -\index{ciot\_ble\_scn\_new@{ciot\_ble\_scn\_new}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_new()}{ciot\_ble\_scn\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} ciot\+\_\+ble\+\_\+scn\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT BLE scanner object. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the handle \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the created CIOT BLE scanner object -\end{DoxyReturn} -\Hypertarget{ciot__ble__scn_8h_a22b3f45a7f6909bc350f1e7dbee0c599}\label{ciot__ble__scn_8h_a22b3f45a7f6909bc350f1e7dbee0c599} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_process\_req@{ciot\_ble\_scn\_process\_req}} -\index{ciot\_ble\_scn\_process\_req@{ciot\_ble\_scn\_process\_req}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_process\_req()}{ciot\_ble\_scn\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+scn\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a BLE scanner request. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE scanner object \\ -\hline -{\em req} & Pointer to the BLE scanner request \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble__scn_8h_a2768bcd961a130564cf03a0d21123d91}\label{ciot__ble__scn_8h_a2768bcd961a130564cf03a0d21123d91} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_send\_data@{ciot\_ble\_scn\_send\_data}} -\index{ciot\_ble\_scn\_send\_data@{ciot\_ble\_scn\_send\_data}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_send\_data()}{ciot\_ble\_scn\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+scn\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data using the CIOT BLE scanner. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE scanner object \\ -\hline -{\em data} & Pointer to the data to be sent \\ -\hline -{\em size} & Size of the data in bytes \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble__scn_8h_a9c8db4404daa80df68b678a3b41aa9b4}\label{ciot__ble__scn_8h_a9c8db4404daa80df68b678a3b41aa9b4} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_start@{ciot\_ble\_scn\_start}} -\index{ciot\_ble\_scn\_start@{ciot\_ble\_scn\_start}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_start()}{ciot\_ble\_scn\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+scn\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT BLE scanner. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE scanner object \\ -\hline -{\em cfg} & Pointer to the BLE scanner configuration \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__ble__scn_8h_acb4c25e68c3ad8a3b3ca67dbcb6e89f2}\label{ciot__ble__scn_8h_acb4c25e68c3ad8a3b3ca67dbcb6e89f2} -\index{ciot\_ble\_scn.h@{ciot\_ble\_scn.h}!ciot\_ble\_scn\_stop@{ciot\_ble\_scn\_stop}} -\index{ciot\_ble\_scn\_stop@{ciot\_ble\_scn\_stop}!ciot\_ble\_scn.h@{ciot\_ble\_scn.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_stop()}{ciot\_ble\_scn\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ble\+\_\+scn\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT BLE scanner. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT BLE scanner object \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} diff --git a/docs/latex/ciot__ble__scn_8h_source.tex b/docs/latex/ciot__ble__scn_8h_source.tex deleted file mode 100644 index a238d5b..0000000 --- a/docs/latex/ciot__ble__scn_8h_source.tex +++ /dev/null @@ -1,44 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn.\+h} -\hypertarget{ciot__ble__scn_8h_source}{}\label{ciot__ble__scn_8h_source}\index{include/ciot\_ble\_scn.h@{include/ciot\_ble\_scn.h}} -\mbox{\hyperlink{ciot__ble__scn_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_BLE\_SCN\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_BLE\_SCN\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__scn__types_8h}{types/ciot\_ble\_scn\_types.h}}"{}}\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}\ } -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_ble\_scn\ *\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}};} -\DoxyCodeLine{00024\ } -\DoxyCodeLine{00026\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00027\ \{} -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__ble__scn__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00029\ \ \ \ \ \mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\_ble\_scn\_status\_t}}\ \mbox{\hyperlink{structciot__ble__scn__status__msg__t_aa7ad441170fdff42b419665a6652a09f}{status}};\ } -\DoxyCodeLine{00030\ \}\ \mbox{\hyperlink{structciot__ble__scn__status__msg__t}{ciot\_ble\_scn\_status\_msg\_t}};} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00037\ \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ \mbox{\hyperlink{ciot__ble__scn_8h_a412a0a86f5b189b653efb2f334d5613f}{ciot\_ble\_scn\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00038\ } -\DoxyCodeLine{00045\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble__scn_8h_a9c8db4404daa80df68b678a3b41aa9b4}{ciot\_ble\_scn\_start}}(\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ self,\ \mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\_ble\_scn\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00046\ } -\DoxyCodeLine{00052\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble__scn_8h_acb4c25e68c3ad8a3b3ca67dbcb6e89f2}{ciot\_ble\_scn\_stop}}(\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ self);} -\DoxyCodeLine{00053\ } -\DoxyCodeLine{00060\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble__scn_8h_a22b3f45a7f6909bc350f1e7dbee0c599}{ciot\_ble\_scn\_process\_req}}(\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ self,\ \mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\_ble\_scn\_req\_t}}\ *req);} -\DoxyCodeLine{00061\ } -\DoxyCodeLine{00069\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble__scn_8h_a2768bcd961a130564cf03a0d21123d91}{ciot\_ble\_scn\_send\_data}}(\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00070\ } -\DoxyCodeLine{00078\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble__scn_8h_ac868bbc26c4ba11695e5c3dcaa80b201}{ciot\_ble\_scn\_handle\_event}}(\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ self,\ \textcolor{keywordtype}{void}\ *event,\ \textcolor{keywordtype}{void}\ *event\_args);} -\DoxyCodeLine{00079\ } -\DoxyCodeLine{00086\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ble__scn_8h_af3c5072d04dee93723266acd2ae40bda}{ciot\_ble\_scn\_get\_adv\_info}}(\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ self,\ \mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\_ble\_scn\_adv\_info\_t}}\ *adv\_info);} -\DoxyCodeLine{00087\ } -\DoxyCodeLine{00088\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00089\ \}} -\DoxyCodeLine{00090\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00091\ } -\DoxyCodeLine{00092\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ble__scn__types_8h.tex b/docs/latex/ciot__ble__scn__types_8h.tex deleted file mode 100644 index 5c94a71..0000000 --- a/docs/latex/ciot__ble__scn__types_8h.tex +++ /dev/null @@ -1,94 +0,0 @@ -\doxysection{include/types/ciot\+\_\+ble\+\_\+scn\+\_\+types.h File Reference} -\hypertarget{ciot__ble__scn__types_8h}{}\label{ciot__ble__scn__types_8h}\index{include/types/ciot\_ble\_scn\_types.h@{include/types/ciot\_ble\_scn\_types.h}} - - -Defines data types and structures for CIOT BLE SCN. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE SCN configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE SCN advertising information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE SCN status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ble__scn__req__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT BLE SCN request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE SCN request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ble__scn__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT BLE SCN data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c}{ciot\+\_\+ble\+\_\+scn\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3cab5e38affddd56ac8693c35fe87d3bd43}{CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca5cc9b57b36fc4add0d1468183936a625}{CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+STATE\+\_\+\+PASSIVE}} -, \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca580d5606561bd5a7bf6ece413c1d7216}{CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+STATE\+\_\+\+ACTIVE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT BLE SCN states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaaa49cc27b8e221b0140c8440a39b7c4230}{CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+REQ\+\_\+\+UNKNOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT BLE SCN request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT BLE SCN. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/23 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa}\label{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa} -\index{ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}!ciot\_ble\_scn\_req\_type\_t@{ciot\_ble\_scn\_req\_type\_t}} -\index{ciot\_ble\_scn\_req\_type\_t@{ciot\_ble\_scn\_req\_type\_t}!ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_req\_type\_t}{ciot\_ble\_scn\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT BLE SCN request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_SCN\_REQ\_UNKNOWN@{CIOT\_BLE\_SCN\_REQ\_UNKNOWN}!ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}}\index{ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}!CIOT\_BLE\_SCN\_REQ\_UNKNOWN@{CIOT\_BLE\_SCN\_REQ\_UNKNOWN}}}\Hypertarget{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaaa49cc27b8e221b0140c8440a39b7c4230}\label{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaaa49cc27b8e221b0140c8440a39b7c4230} -CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c}\label{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c} -\index{ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}!ciot\_ble\_scn\_state\_t@{ciot\_ble\_scn\_state\_t}} -\index{ciot\_ble\_scn\_state\_t@{ciot\_ble\_scn\_state\_t}!ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_scn\_state\_t}{ciot\_ble\_scn\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c}{ciot\+\_\+ble\+\_\+scn\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT BLE SCN states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_SCN\_STATE\_IDLE@{CIOT\_BLE\_SCN\_STATE\_IDLE}!ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}}\index{ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}!CIOT\_BLE\_SCN\_STATE\_IDLE@{CIOT\_BLE\_SCN\_STATE\_IDLE}}}\Hypertarget{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3cab5e38affddd56ac8693c35fe87d3bd43}\label{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3cab5e38affddd56ac8693c35fe87d3bd43} -CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+STATE\+\_\+\+IDLE&Idle state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_SCN\_STATE\_PASSIVE@{CIOT\_BLE\_SCN\_STATE\_PASSIVE}!ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}}\index{ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}!CIOT\_BLE\_SCN\_STATE\_PASSIVE@{CIOT\_BLE\_SCN\_STATE\_PASSIVE}}}\Hypertarget{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca5cc9b57b36fc4add0d1468183936a625}\label{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca5cc9b57b36fc4add0d1468183936a625} -CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+STATE\+\_\+\+PASSIVE&Passive state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_SCN\_STATE\_ACTIVE@{CIOT\_BLE\_SCN\_STATE\_ACTIVE}!ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}}\index{ciot\_ble\_scn\_types.h@{ciot\_ble\_scn\_types.h}!CIOT\_BLE\_SCN\_STATE\_ACTIVE@{CIOT\_BLE\_SCN\_STATE\_ACTIVE}}}\Hypertarget{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca580d5606561bd5a7bf6ece413c1d7216}\label{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca580d5606561bd5a7bf6ece413c1d7216} -CIOT\+\_\+\+BLE\+\_\+\+SCN\+\_\+\+STATE\+\_\+\+ACTIVE&Active state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__ble__scn__types_8h_source.tex b/docs/latex/ciot__ble__scn__types_8h_source.tex deleted file mode 100644 index 278393f..0000000 --- a/docs/latex/ciot__ble__scn__types_8h_source.tex +++ /dev/null @@ -1,73 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h} -\hypertarget{ciot__ble__scn__types_8h_source}{}\label{ciot__ble__scn__types_8h_source}\index{include/types/ciot\_ble\_scn\_types.h@{include/types/ciot\_ble\_scn\_types.h}} -\mbox{\hyperlink{ciot__ble__scn__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_BLE\_SCN\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_BLE\_SCN\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3cab5e38affddd56ac8693c35fe87d3bd43}{CIOT\_BLE\_SCN\_STATE\_IDLE}},\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca5cc9b57b36fc4add0d1468183936a625}{CIOT\_BLE\_SCN\_STATE\_PASSIVE}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3ca580d5606561bd5a7bf6ece413c1d7216}{CIOT\_BLE\_SCN\_STATE\_ACTIVE}},\ } -\DoxyCodeLine{00028\ \}\ \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c}{ciot\_ble\_scn\_state\_t}};} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00033\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00034\ \{} -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaaa49cc27b8e221b0140c8440a39b7c4230}{CIOT\_BLE\_SCN\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00036\ \}\ \mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa}{ciot\_ble\_scn\_req\_type\_t}};} -\DoxyCodeLine{00037\ } -\DoxyCodeLine{00041\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00042\ \{} -\DoxyCodeLine{00043\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__ble__scn__cfg__t_a6c52a3d605c056768b59164ce8df8334}{interval}};\ } -\DoxyCodeLine{00044\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__ble__scn__cfg__t_a6b307b5083cf92aca29549d780b44bd5}{window}};\ } -\DoxyCodeLine{00045\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__ble__scn__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}{timeout}};\ } -\DoxyCodeLine{00046\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ble__scn__cfg__t_a05c940dbc220f5a723afd70071aebff8}{active}}\ :\ 1;\ } -\DoxyCodeLine{00047\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ble__scn__cfg__t_ad44fdec90acd6e513033d8af6d0a7774}{brigde\_mode}}\ :\ 1;\ } -\DoxyCodeLine{00048\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ble__scn__cfg__t_acb7bc06bed6f6408d719334fc41698c7}{reserved}}\ :\ 6;\ } -\DoxyCodeLine{00049\ \}\ \mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\_ble\_scn\_cfg\_t}};} -\DoxyCodeLine{00050\ } -\DoxyCodeLine{00054\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00055\ \{} -\DoxyCodeLine{00056\ \ \ \ \ uint8\_t\ mac[6];\ } -\DoxyCodeLine{00057\ \ \ \ \ int8\_t\ \mbox{\hyperlink{structciot__ble__scn__adv__info__t_a3b962e67ba74725bd60ca3c29f785abe}{rssi}};\ } -\DoxyCodeLine{00058\ \}\ \mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\_ble\_scn\_adv\_info\_t}};} -\DoxyCodeLine{00059\ } -\DoxyCodeLine{00063\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00064\ \{} -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c}{ciot\_ble\_scn\_state\_t}}\ \mbox{\hyperlink{structciot__ble__scn__status__t_a9b3c50f82a67373296513704001266bb}{state}};\ } -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\_ble\_scn\_adv\_info\_t}}\ \mbox{\hyperlink{structciot__ble__scn__status__t_a9c267320c088f215b9649f93a8d955c1}{adv\_info}};\ } -\DoxyCodeLine{00067\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__ble__scn__status__t_a18c05079c393f6c94543830ac5360604}{err\_code}};\ } -\DoxyCodeLine{00068\ \}\ \mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\_ble\_scn\_status\_t}};} -\DoxyCodeLine{00069\ } -\DoxyCodeLine{00073\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00074\ \{} -\DoxyCodeLine{00075\ \}\ \mbox{\hyperlink{unionciot__ble__scn__req__data__u}{ciot\_ble\_scn\_req\_data\_u}};} -\DoxyCodeLine{00076\ } -\DoxyCodeLine{00080\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00081\ \{} -\DoxyCodeLine{00082\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa}{ciot\_ble\_scn\_req\_type\_t}}\ \mbox{\hyperlink{structciot__ble__scn__req__t_abc70ef515ab30b52d6a58e0c72ee3688}{type}};\ } -\DoxyCodeLine{00083\ \ \ \ \ \mbox{\hyperlink{unionciot__ble__scn__req__data__u}{ciot\_ble\_scn\_req\_data\_u}}\ \mbox{\hyperlink{structciot__ble__scn__req__t_ad255c0633c486a2ba3c6d2875d5a7fe5}{data}};\ } -\DoxyCodeLine{00084\ \}\ \mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\_ble\_scn\_req\_t}};} -\DoxyCodeLine{00085\ } -\DoxyCodeLine{00089\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00090\ \{} -\DoxyCodeLine{00091\ \ \ \ \ \mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\_ble\_scn\_cfg\_t}}\ \mbox{\hyperlink{unionciot__ble__scn__data__u_a77ffb25407771dd73e21b56e0976b3b7}{config}};\ } -\DoxyCodeLine{00092\ \ \ \ \ \mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\_ble\_scn\_status\_t}}\ \mbox{\hyperlink{unionciot__ble__scn__data__u_aa7ad441170fdff42b419665a6652a09f}{status}};\ } -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\_ble\_scn\_req\_t}}\ \mbox{\hyperlink{unionciot__ble__scn__data__u_a4fff0375f4b234a60fcd5e6723d9c8a9}{request}};\ } -\DoxyCodeLine{00094\ \}\ \mbox{\hyperlink{unionciot__ble__scn__data__u}{ciot\_ble\_scn\_data\_u}};} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00096\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00097\ \}} -\DoxyCodeLine{00098\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00099\ } -\DoxyCodeLine{00100\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ble__types_8h.tex b/docs/latex/ciot__ble__types_8h.tex deleted file mode 100644 index 2b4a6dd..0000000 --- a/docs/latex/ciot__ble__types_8h.tex +++ /dev/null @@ -1,94 +0,0 @@ -\doxysection{include/types/ciot\+\_\+ble\+\_\+types.h File Reference} -\hypertarget{ciot__ble__types_8h}{}\label{ciot__ble__types_8h}\index{include/types/ciot\_ble\_types.h@{include/types/ciot\_ble\_types.h}} - - -Defines data types and structures for CIOT BLE. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ble__cfg__t}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ble__info__t}{ciot\+\_\+ble\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ble__status__t}{ciot\+\_\+ble\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ble__req__data__u}{ciot\+\_\+ble\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT BLE request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ble__req__t}{ciot\+\_\+ble\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT BLE request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ble__data__u}{ciot\+\_\+ble\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT BLE data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e}{ciot\+\_\+ble\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359ea2431d9b069b261be8bcf1856485b4c1c}{CIOT\+\_\+\+BLE\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359eae825183bbbe4671599dac35618a90d78}{CIOT\+\_\+\+BLE\+\_\+\+STATE\+\_\+\+STARTED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT BLE states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a}{ciot\+\_\+ble\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa3e891c72e54ad509017d098852f6ab7e}{CIOT\+\_\+\+BLE\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa955a66939faa9e3aeffe11ef0285e61c}{CIOT\+\_\+\+BLE\+\_\+\+REQ\+\_\+\+SET\+\_\+\+MAC}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT BLE request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT BLE. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/20 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a}\label{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a} -\index{ciot\_ble\_types.h@{ciot\_ble\_types.h}!ciot\_ble\_req\_type\_t@{ciot\_ble\_req\_type\_t}} -\index{ciot\_ble\_req\_type\_t@{ciot\_ble\_req\_type\_t}!ciot\_ble\_types.h@{ciot\_ble\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_req\_type\_t}{ciot\_ble\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a}{ciot\+\_\+ble\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT BLE request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_REQ\_UNKNOWN@{CIOT\_BLE\_REQ\_UNKNOWN}!ciot\_ble\_types.h@{ciot\_ble\_types.h}}\index{ciot\_ble\_types.h@{ciot\_ble\_types.h}!CIOT\_BLE\_REQ\_UNKNOWN@{CIOT\_BLE\_REQ\_UNKNOWN}}}\Hypertarget{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa3e891c72e54ad509017d098852f6ab7e}\label{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa3e891c72e54ad509017d098852f6ab7e} -CIOT\+\_\+\+BLE\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_REQ\_SET\_MAC@{CIOT\_BLE\_REQ\_SET\_MAC}!ciot\_ble\_types.h@{ciot\_ble\_types.h}}\index{ciot\_ble\_types.h@{ciot\_ble\_types.h}!CIOT\_BLE\_REQ\_SET\_MAC@{CIOT\_BLE\_REQ\_SET\_MAC}}}\Hypertarget{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa955a66939faa9e3aeffe11ef0285e61c}\label{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa955a66939faa9e3aeffe11ef0285e61c} -CIOT\+\_\+\+BLE\+\_\+\+REQ\+\_\+\+SET\+\_\+\+MAC&Set MAC request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e}\label{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e} -\index{ciot\_ble\_types.h@{ciot\_ble\_types.h}!ciot\_ble\_state\_t@{ciot\_ble\_state\_t}} -\index{ciot\_ble\_state\_t@{ciot\_ble\_state\_t}!ciot\_ble\_types.h@{ciot\_ble\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ble\_state\_t}{ciot\_ble\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e}{ciot\+\_\+ble\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT BLE states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_STATE\_IDLE@{CIOT\_BLE\_STATE\_IDLE}!ciot\_ble\_types.h@{ciot\_ble\_types.h}}\index{ciot\_ble\_types.h@{ciot\_ble\_types.h}!CIOT\_BLE\_STATE\_IDLE@{CIOT\_BLE\_STATE\_IDLE}}}\Hypertarget{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359ea2431d9b069b261be8bcf1856485b4c1c}\label{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359ea2431d9b069b261be8bcf1856485b4c1c} -CIOT\+\_\+\+BLE\+\_\+\+STATE\+\_\+\+IDLE&Idle state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BLE\_STATE\_STARTED@{CIOT\_BLE\_STATE\_STARTED}!ciot\_ble\_types.h@{ciot\_ble\_types.h}}\index{ciot\_ble\_types.h@{ciot\_ble\_types.h}!CIOT\_BLE\_STATE\_STARTED@{CIOT\_BLE\_STATE\_STARTED}}}\Hypertarget{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359eae825183bbbe4671599dac35618a90d78}\label{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359eae825183bbbe4671599dac35618a90d78} -CIOT\+\_\+\+BLE\+\_\+\+STATE\+\_\+\+STARTED&Started state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__ble__types_8h_source.tex b/docs/latex/ciot__ble__types_8h_source.tex deleted file mode 100644 index 43515c6..0000000 --- a/docs/latex/ciot__ble__types_8h_source.tex +++ /dev/null @@ -1,69 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+types.\+h} -\hypertarget{ciot__ble__types_8h_source}{}\label{ciot__ble__types_8h_source}\index{include/types/ciot\_ble\_types.h@{include/types/ciot\_ble\_types.h}} -\mbox{\hyperlink{ciot__ble__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_BLE\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_BLE\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359ea2431d9b069b261be8bcf1856485b4c1c}{CIOT\_BLE\_STATE\_IDLE}},\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359eae825183bbbe4671599dac35618a90d78}{CIOT\_BLE\_STATE\_STARTED}},\ } -\DoxyCodeLine{00027\ \}\ \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e}{ciot\_ble\_state\_t}};} -\DoxyCodeLine{00028\ } -\DoxyCodeLine{00032\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00033\ \{} -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa3e891c72e54ad509017d098852f6ab7e}{CIOT\_BLE\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0aa955a66939faa9e3aeffe11ef0285e61c}{CIOT\_BLE\_REQ\_SET\_MAC}},\ } -\DoxyCodeLine{00036\ \}\ \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a}{ciot\_ble\_req\_type\_t}};} -\DoxyCodeLine{00037\ } -\DoxyCodeLine{00041\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00042\ \{} -\DoxyCodeLine{00043\ \ \ \ \ uint8\_t\ mac[6];\ } -\DoxyCodeLine{00044\ \}\ \mbox{\hyperlink{structciot__ble__cfg__t}{ciot\_ble\_cfg\_t}};} -\DoxyCodeLine{00045\ } -\DoxyCodeLine{00049\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00050\ \{} -\DoxyCodeLine{00051\ \ \ \ \ uint8\_t\ hw\_mac[6];\ } -\DoxyCodeLine{00052\ \ \ \ \ uint8\_t\ sw\_mac[6];\ } -\DoxyCodeLine{00053\ \}\ \mbox{\hyperlink{structciot__ble__info__t}{ciot\_ble\_info\_t}};} -\DoxyCodeLine{00054\ } -\DoxyCodeLine{00058\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00059\ \{} -\DoxyCodeLine{00060\ \ \ \ \ \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e}{ciot\_ble\_state\_t}}\ \mbox{\hyperlink{structciot__ble__status__t_aa5d08015bd3ed92217c40487bd42e433}{state}};\ } -\DoxyCodeLine{00061\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__ble__status__t_a18c05079c393f6c94543830ac5360604}{err\_code}};\ } -\DoxyCodeLine{00062\ \ \ \ \ \mbox{\hyperlink{structciot__ble__info__t}{ciot\_ble\_info\_t}}\ \mbox{\hyperlink{structciot__ble__status__t_a7a8ead7f37f7534cd955cbefd78043ce}{info}};\ } -\DoxyCodeLine{00063\ \}\ \mbox{\hyperlink{structciot__ble__status__t}{ciot\_ble\_status\_t}};} -\DoxyCodeLine{00064\ } -\DoxyCodeLine{00068\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00069\ \{} -\DoxyCodeLine{00070\ \ \ \ \ uint8\_t\ set\_mac[6];\ } -\DoxyCodeLine{00071\ \}\ \mbox{\hyperlink{unionciot__ble__req__data__u}{ciot\_ble\_req\_data\_u}};} -\DoxyCodeLine{00072\ } -\DoxyCodeLine{00076\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00077\ \{} -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a}{ciot\_ble\_req\_type\_t}}\ \mbox{\hyperlink{structciot__ble__req__t_a1387b7c38bc20d7cf6308e7cbecff167}{type}};\ } -\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{unionciot__ble__req__data__u}{ciot\_ble\_req\_data\_u}}\ \mbox{\hyperlink{structciot__ble__req__t_af05fffb7425971f74862815fe4169b7d}{data}};\ } -\DoxyCodeLine{00080\ \}\ \mbox{\hyperlink{structciot__ble__req__t}{ciot\_ble\_req\_t}};} -\DoxyCodeLine{00081\ } -\DoxyCodeLine{00085\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00086\ \{} -\DoxyCodeLine{00087\ \ \ \ \ \mbox{\hyperlink{structciot__ble__cfg__t}{ciot\_ble\_cfg\_t}}\ \mbox{\hyperlink{unionciot__ble__data__u_a3bb879297495825c0895764c1b7593b1}{config}};\ } -\DoxyCodeLine{00088\ \ \ \ \ \mbox{\hyperlink{structciot__ble__status__t}{ciot\_ble\_status\_t}}\ \mbox{\hyperlink{unionciot__ble__data__u_ae334becb4d9815b900b4cc43b5b9e49b}{status}};\ } -\DoxyCodeLine{00089\ \ \ \ \ \mbox{\hyperlink{structciot__ble__req__t}{ciot\_ble\_req\_t}}\ \mbox{\hyperlink{unionciot__ble__data__u_a6aeefeee1b018d7d77c41f66f6015cf9}{request}};\ } -\DoxyCodeLine{00090\ \}\ \mbox{\hyperlink{unionciot__ble__data__u}{ciot\_ble\_data\_u}};} -\DoxyCodeLine{00091\ } -\DoxyCodeLine{00092\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00093\ \}} -\DoxyCodeLine{00094\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00096\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__bridge_8h.tex b/docs/latex/ciot__bridge_8h.tex deleted file mode 100644 index 8f85806..0000000 --- a/docs/latex/ciot__bridge_8h.tex +++ /dev/null @@ -1,200 +0,0 @@ -\doxysection{include/ciot\+\_\+bridge.h File Reference} -\hypertarget{ciot__bridge_8h}{}\label{ciot__bridge_8h}\index{include/ciot\_bridge.h@{include/ciot\_bridge.h}} - - -Defines functions and types for CIOT Bridge module. - - -{\ttfamily \#include "{}types/ciot\+\_\+bridge\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__bridge__status__msg__t}{ciot\+\_\+bridge\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Bridge status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__bridge_8h_a3224a430fb71dfab6696211645a53774}{CIOT\+\_\+\+BRIDGE\+\_\+\+NULL\+\_\+\+TARGET}}~-\/1 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+bridge \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Pointer to a CIOT Bridge object. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} \mbox{\hyperlink{ciot__bridge_8h_a0dc495dc95e68b21d471d2f4d2c85a23}{ciot\+\_\+bridge\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT Bridge object. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__bridge_8h_a2ab34c59e732cf95f9f618d74a7fda9c}{ciot\+\_\+bridge\+\_\+start}} (\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} self, \mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT Bridge module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__bridge_8h_a445c0d9d20d8ebd685a1285b548d7b39}{ciot\+\_\+bridge\+\_\+stop}} (\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT Bridge module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__bridge_8h_af52f86ee9e077ab344d6d4e67657a4ec}{ciot\+\_\+bridge\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} self, \mbox{\hyperlink{structciot__bridge__req__t}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a Bridge module request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__bridge_8h_ab3d916e4bbdd0b6a4b5c8504eaa4a4c6}{ciot\+\_\+bridge\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data using the CIOT Bridge module. \end{DoxyCompactList}\item -int \mbox{\hyperlink{ciot__bridge_8h_a3f22ac2c01ff5139c3d5206033259559}{ciot\+\_\+bridge\+\_\+get\+\_\+target\+\_\+id}} (\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} self, uint8\+\_\+t sender\+\_\+id) -\begin{DoxyCompactList}\small\item\em Get the target ID for a sender in the CIOT Bridge module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines functions and types for CIOT Bridge module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/13 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__bridge_8h_a3224a430fb71dfab6696211645a53774}\label{ciot__bridge_8h_a3224a430fb71dfab6696211645a53774} -\index{ciot\_bridge.h@{ciot\_bridge.h}!CIOT\_BRIDGE\_NULL\_TARGET@{CIOT\_BRIDGE\_NULL\_TARGET}} -\index{CIOT\_BRIDGE\_NULL\_TARGET@{CIOT\_BRIDGE\_NULL\_TARGET}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_BRIDGE\_NULL\_TARGET}{CIOT\_BRIDGE\_NULL\_TARGET}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+BRIDGE\+\_\+\+NULL\+\_\+\+TARGET~-\/1} - -\texorpdfstring{$<$}{<} Include CIOT Bridge types \texorpdfstring{$<$}{<} Include CIOT interface \texorpdfstring{$<$}{<} Include CIOT error handling Null target ID for CIOT Bridge - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}\label{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c} -\index{ciot\_bridge.h@{ciot\_bridge.h}!ciot\_bridge\_t@{ciot\_bridge\_t}} -\index{ciot\_bridge\_t@{ciot\_bridge\_t}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_t}{ciot\_bridge\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+bridge\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}}} - - - -Pointer to a CIOT Bridge object. - - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__bridge_8h_a3f22ac2c01ff5139c3d5206033259559}\label{ciot__bridge_8h_a3f22ac2c01ff5139c3d5206033259559} -\index{ciot\_bridge.h@{ciot\_bridge.h}!ciot\_bridge\_get\_target\_id@{ciot\_bridge\_get\_target\_id}} -\index{ciot\_bridge\_get\_target\_id@{ciot\_bridge\_get\_target\_id}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_get\_target\_id()}{ciot\_bridge\_get\_target\_id()}} -{\footnotesize\ttfamily int ciot\+\_\+bridge\+\_\+get\+\_\+target\+\_\+id (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}}}]{self, }\item[{uint8\+\_\+t}]{sender\+\_\+id }\end{DoxyParamCaption})} - - - -Get the target ID for a sender in the CIOT Bridge module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Bridge object \\ -\hline -{\em sender\+\_\+id} & Sender ID \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Target ID for the sender, or CIOT\+\_\+\+BRIDGE\+\_\+\+NULL\+\_\+\+TARGET if not found -\end{DoxyReturn} -\Hypertarget{ciot__bridge_8h_a0dc495dc95e68b21d471d2f4d2c85a23}\label{ciot__bridge_8h_a0dc495dc95e68b21d471d2f4d2c85a23} -\index{ciot\_bridge.h@{ciot\_bridge.h}!ciot\_bridge\_new@{ciot\_bridge\_new}} -\index{ciot\_bridge\_new@{ciot\_bridge\_new}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_new()}{ciot\_bridge\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} ciot\+\_\+bridge\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT Bridge object. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the handle \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the created CIOT Bridge object -\end{DoxyReturn} -\Hypertarget{ciot__bridge_8h_af52f86ee9e077ab344d6d4e67657a4ec}\label{ciot__bridge_8h_af52f86ee9e077ab344d6d4e67657a4ec} -\index{ciot\_bridge.h@{ciot\_bridge.h}!ciot\_bridge\_process\_req@{ciot\_bridge\_process\_req}} -\index{ciot\_bridge\_process\_req@{ciot\_bridge\_process\_req}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_process\_req()}{ciot\_bridge\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+bridge\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__bridge__req__t}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a Bridge module request. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Bridge object \\ -\hline -{\em req} & Pointer to the Bridge request \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__bridge_8h_ab3d916e4bbdd0b6a4b5c8504eaa4a4c6}\label{ciot__bridge_8h_ab3d916e4bbdd0b6a4b5c8504eaa4a4c6} -\index{ciot\_bridge.h@{ciot\_bridge.h}!ciot\_bridge\_send\_data@{ciot\_bridge\_send\_data}} -\index{ciot\_bridge\_send\_data@{ciot\_bridge\_send\_data}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_send\_data()}{ciot\_bridge\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+bridge\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data using the CIOT Bridge module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Bridge object \\ -\hline -{\em data} & Pointer to the data to be sent \\ -\hline -{\em size} & Size of the data in bytes \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__bridge_8h_a2ab34c59e732cf95f9f618d74a7fda9c}\label{ciot__bridge_8h_a2ab34c59e732cf95f9f618d74a7fda9c} -\index{ciot\_bridge.h@{ciot\_bridge.h}!ciot\_bridge\_start@{ciot\_bridge\_start}} -\index{ciot\_bridge\_start@{ciot\_bridge\_start}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_start()}{ciot\_bridge\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+bridge\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT Bridge module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Bridge object \\ -\hline -{\em cfg} & Pointer to the Bridge configuration \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} -\Hypertarget{ciot__bridge_8h_a445c0d9d20d8ebd685a1285b548d7b39}\label{ciot__bridge_8h_a445c0d9d20d8ebd685a1285b548d7b39} -\index{ciot\_bridge.h@{ciot\_bridge.h}!ciot\_bridge\_stop@{ciot\_bridge\_stop}} -\index{ciot\_bridge\_stop@{ciot\_bridge\_stop}!ciot\_bridge.h@{ciot\_bridge.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_stop()}{ciot\_bridge\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+bridge\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT Bridge module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Bridge object \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT error code indicating success or failure -\end{DoxyReturn} diff --git a/docs/latex/ciot__bridge_8h_source.tex b/docs/latex/ciot__bridge_8h_source.tex deleted file mode 100644 index 39c5b6d..0000000 --- a/docs/latex/ciot__bridge_8h_source.tex +++ /dev/null @@ -1,43 +0,0 @@ -\doxysection{ciot\+\_\+bridge.\+h} -\hypertarget{ciot__bridge_8h_source}{}\label{ciot__bridge_8h_source}\index{include/ciot\_bridge.h@{include/ciot\_bridge.h}} -\mbox{\hyperlink{ciot__bridge_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_BRIDGE\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_BRIDGE\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__bridge__types_8h}{types/ciot\_bridge\_types.h}}"{}}\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}\ } -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}\ } -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#define\ CIOT\_BRIDGE\_NULL\_TARGET\ -\/1\ }} -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_bridge\ *\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00028\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00029\ \{} -\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__bridge__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{structciot__bridge__status__t}{ciot\_bridge\_status\_t}}\ \mbox{\hyperlink{structciot__bridge__status__msg__t_ab50a6b7e2887ecb6625b540edae99138}{status}};\ } -\DoxyCodeLine{00032\ \}\ \mbox{\hyperlink{structciot__bridge__status__msg__t}{ciot\_bridge\_status\_msg\_t}};} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00039\ \mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}}\ \mbox{\hyperlink{ciot__bridge_8h_a0dc495dc95e68b21d471d2f4d2c85a23}{ciot\_bridge\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00040\ } -\DoxyCodeLine{00047\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__bridge_8h_a2ab34c59e732cf95f9f618d74a7fda9c}{ciot\_bridge\_start}}(\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}}\ self,\ \mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\_bridge\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00048\ } -\DoxyCodeLine{00054\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__bridge_8h_a445c0d9d20d8ebd685a1285b548d7b39}{ciot\_bridge\_stop}}(\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}}\ self);} -\DoxyCodeLine{00055\ } -\DoxyCodeLine{00062\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__bridge_8h_af52f86ee9e077ab344d6d4e67657a4ec}{ciot\_bridge\_process\_req}}(\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}}\ self,\ \mbox{\hyperlink{structciot__bridge__req__t}{ciot\_bridge\_req\_t}}\ *req);} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00071\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__bridge_8h_ab3d916e4bbdd0b6a4b5c8504eaa4a4c6}{ciot\_bridge\_send\_data}}(\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00072\ } -\DoxyCodeLine{00079\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{ciot__bridge_8h_a3f22ac2c01ff5139c3d5206033259559}{ciot\_bridge\_get\_target\_id}}(\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}}\ self,\ uint8\_t\ sender\_id);} -\DoxyCodeLine{00080\ } -\DoxyCodeLine{00081\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00082\ \}} -\DoxyCodeLine{00083\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__bridge__types_8h.tex b/docs/latex/ciot__bridge__types_8h.tex deleted file mode 100644 index 6c8f777..0000000 --- a/docs/latex/ciot__bridge__types_8h.tex +++ /dev/null @@ -1,92 +0,0 @@ -\doxysection{include/types/ciot\+\_\+bridge\+\_\+types.h File Reference} -\hypertarget{ciot__bridge__types_8h}{}\label{ciot__bridge__types_8h}\index{include/types/ciot\_bridge\_types.h@{include/types/ciot\_bridge\_types.h}} - - -Defines data types and structures for CIOT bridge. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT bridge configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__bridge__status__t}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT bridge status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__bridge__req__data__u}{ciot\+\_\+bridge\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT bridge request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__bridge__req__t}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT bridge request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__bridge__data__u}{ciot\+\_\+bridge\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT bridge data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d}{ciot\+\_\+bridge\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da7c87588279038f2adb2e81c7fa46c6cf}{CIOT\+\_\+\+BRIDGE\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da02411a74aaac3fd6dad4ec51736e160c}{CIOT\+\_\+\+BRIDGE\+\_\+\+STATE\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da23ccfff2dd7b803c7221b137c040959b}{CIOT\+\_\+\+BRIDGE\+\_\+\+STATE\+\_\+\+ERROR}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT bridge states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13}{ciot\+\_\+bridge\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13a91947281c4503d5af190b3c39478e32c}{CIOT\+\_\+\+BRIDGE\+\_\+\+REQ\+\_\+\+UNKNOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT bridge request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT bridge. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/13 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13}\label{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13} -\index{ciot\_bridge\_types.h@{ciot\_bridge\_types.h}!ciot\_bridge\_req\_type\_t@{ciot\_bridge\_req\_type\_t}} -\index{ciot\_bridge\_req\_type\_t@{ciot\_bridge\_req\_type\_t}!ciot\_bridge\_types.h@{ciot\_bridge\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_req\_type\_t}{ciot\_bridge\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13}{ciot\+\_\+bridge\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT bridge request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BRIDGE\_REQ\_UNKNOWN@{CIOT\_BRIDGE\_REQ\_UNKNOWN}!ciot\_bridge\_types.h@{ciot\_bridge\_types.h}}\index{ciot\_bridge\_types.h@{ciot\_bridge\_types.h}!CIOT\_BRIDGE\_REQ\_UNKNOWN@{CIOT\_BRIDGE\_REQ\_UNKNOWN}}}\Hypertarget{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13a91947281c4503d5af190b3c39478e32c}\label{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13a91947281c4503d5af190b3c39478e32c} -CIOT\+\_\+\+BRIDGE\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d}\label{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d} -\index{ciot\_bridge\_types.h@{ciot\_bridge\_types.h}!ciot\_bridge\_state\_t@{ciot\_bridge\_state\_t}} -\index{ciot\_bridge\_state\_t@{ciot\_bridge\_state\_t}!ciot\_bridge\_types.h@{ciot\_bridge\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_bridge\_state\_t}{ciot\_bridge\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d}{ciot\+\_\+bridge\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT bridge states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BRIDGE\_STATE\_IDLE@{CIOT\_BRIDGE\_STATE\_IDLE}!ciot\_bridge\_types.h@{ciot\_bridge\_types.h}}\index{ciot\_bridge\_types.h@{ciot\_bridge\_types.h}!CIOT\_BRIDGE\_STATE\_IDLE@{CIOT\_BRIDGE\_STATE\_IDLE}}}\Hypertarget{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da7c87588279038f2adb2e81c7fa46c6cf}\label{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da7c87588279038f2adb2e81c7fa46c6cf} -CIOT\+\_\+\+BRIDGE\+\_\+\+STATE\+\_\+\+IDLE&Idle state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BRIDGE\_STATE\_STARTED@{CIOT\_BRIDGE\_STATE\_STARTED}!ciot\_bridge\_types.h@{ciot\_bridge\_types.h}}\index{ciot\_bridge\_types.h@{ciot\_bridge\_types.h}!CIOT\_BRIDGE\_STATE\_STARTED@{CIOT\_BRIDGE\_STATE\_STARTED}}}\Hypertarget{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da02411a74aaac3fd6dad4ec51736e160c}\label{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da02411a74aaac3fd6dad4ec51736e160c} -CIOT\+\_\+\+BRIDGE\+\_\+\+STATE\+\_\+\+STARTED&Started state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_BRIDGE\_STATE\_ERROR@{CIOT\_BRIDGE\_STATE\_ERROR}!ciot\_bridge\_types.h@{ciot\_bridge\_types.h}}\index{ciot\_bridge\_types.h@{ciot\_bridge\_types.h}!CIOT\_BRIDGE\_STATE\_ERROR@{CIOT\_BRIDGE\_STATE\_ERROR}}}\Hypertarget{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da23ccfff2dd7b803c7221b137c040959b}\label{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da23ccfff2dd7b803c7221b137c040959b} -CIOT\+\_\+\+BRIDGE\+\_\+\+STATE\+\_\+\+ERROR&Error state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__bridge__types_8h_source.tex b/docs/latex/ciot__bridge__types_8h_source.tex deleted file mode 100644 index 4174afb..0000000 --- a/docs/latex/ciot__bridge__types_8h_source.tex +++ /dev/null @@ -1,61 +0,0 @@ -\doxysection{ciot\+\_\+bridge\+\_\+types.\+h} -\hypertarget{ciot__bridge__types_8h_source}{}\label{ciot__bridge__types_8h_source}\index{include/types/ciot\_bridge\_types.h@{include/types/ciot\_bridge\_types.h}} -\mbox{\hyperlink{ciot__bridge__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_BRIDGE\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_BRIDGE\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da7c87588279038f2adb2e81c7fa46c6cf}{CIOT\_BRIDGE\_STATE\_IDLE}},\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da02411a74aaac3fd6dad4ec51736e160c}{CIOT\_BRIDGE\_STATE\_STARTED}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55da23ccfff2dd7b803c7221b137c040959b}{CIOT\_BRIDGE\_STATE\_ERROR}},\ } -\DoxyCodeLine{00028\ \}\ \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d}{ciot\_bridge\_state\_t}};} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00033\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00034\ \{} -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13a91947281c4503d5af190b3c39478e32c}{CIOT\_BRIDGE\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00036\ \}\ \mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13}{ciot\_bridge\_req\_type\_t}};} -\DoxyCodeLine{00037\ } -\DoxyCodeLine{00041\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00042\ \{} -\DoxyCodeLine{00043\ \ \ \ \ uint8\_t\ ifaces\_id[2];\ } -\DoxyCodeLine{00044\ \}\ \mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\_bridge\_cfg\_t}};} -\DoxyCodeLine{00045\ } -\DoxyCodeLine{00049\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00050\ \{} -\DoxyCodeLine{00051\ \ \ \ \ \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d}{ciot\_bridge\_state\_t}}\ \mbox{\hyperlink{structciot__bridge__status__t_a75d538f4bd5c29ec545f1e37dae43f0e}{state}};\ } -\DoxyCodeLine{00052\ \}\ \mbox{\hyperlink{structciot__bridge__status__t}{ciot\_bridge\_status\_t}};} -\DoxyCodeLine{00053\ } -\DoxyCodeLine{00057\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00058\ \{} -\DoxyCodeLine{00059\ } -\DoxyCodeLine{00060\ \}\ \mbox{\hyperlink{unionciot__bridge__req__data__u}{ciot\_bridge\_req\_data\_u}};} -\DoxyCodeLine{00061\ } -\DoxyCodeLine{00065\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00066\ \{} -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13}{ciot\_bridge\_req\_type\_t}}\ \mbox{\hyperlink{structciot__bridge__req__t_a2ef6bd06414538f347bd722b6c4e064c}{type}};\ } -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{unionciot__bridge__req__data__u}{ciot\_bridge\_req\_data\_u}}\ \mbox{\hyperlink{structciot__bridge__req__t_a2f53bd6c51629c8cac0040526230998e}{data}};\ } -\DoxyCodeLine{00069\ \}\ \mbox{\hyperlink{structciot__bridge__req__t}{ciot\_bridge\_req\_t}};} -\DoxyCodeLine{00070\ } -\DoxyCodeLine{00074\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00075\ \{} -\DoxyCodeLine{00076\ \ \ \ \ \mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\_bridge\_cfg\_t}}\ \mbox{\hyperlink{unionciot__bridge__data__u_a422a3539477ec835aea97b889564f22a}{config}};\ } -\DoxyCodeLine{00077\ \ \ \ \ \mbox{\hyperlink{structciot__bridge__status__t}{ciot\_bridge\_status\_t}}\ \mbox{\hyperlink{unionciot__bridge__data__u_ab50a6b7e2887ecb6625b540edae99138}{status}};\ } -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{structciot__bridge__req__t}{ciot\_bridge\_req\_t}}\ \mbox{\hyperlink{unionciot__bridge__data__u_a21b1ec52268024ae8c4b0eca1dc2a491}{request}};\ } -\DoxyCodeLine{00079\ \}\ \mbox{\hyperlink{unionciot__bridge__data__u}{ciot\_bridge\_data\_u}};} -\DoxyCodeLine{00080\ } -\DoxyCodeLine{00081\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00082\ \}} -\DoxyCodeLine{00083\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__common__types_8h.tex b/docs/latex/ciot__common__types_8h.tex deleted file mode 100644 index 115ef13..0000000 --- a/docs/latex/ciot__common__types_8h.tex +++ /dev/null @@ -1,48 +0,0 @@ -\doxysection{include/ciot\+\_\+common\+\_\+types.h File Reference} -\hypertarget{ciot__common__types_8h}{}\label{ciot__common__types_8h}\index{include/ciot\_common\_types.h@{include/ciot\_common\_types.h}} - - -Defines common types used in CIOT modules. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__event__data}{ciot\+\_\+event\+\_\+data}} -\begin{DoxyCompactList}\small\item\em Structure for event data in CIOT modules. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct \mbox{\hyperlink{structciot__event__data}{ciot\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for event data in CIOT modules. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines common types used in CIOT modules. - -w \texorpdfstring{$\ast$}{*} \begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/14 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}\label{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e} -\index{ciot\_common\_types.h@{ciot\_common\_types.h}!ciot\_event\_data\_t@{ciot\_event\_data\_t}} -\index{ciot\_event\_data\_t@{ciot\_event\_data\_t}!ciot\_common\_types.h@{ciot\_common\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_event\_data\_t}{ciot\_event\_data\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__event__data}{ciot\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}}} - - - -Structure for event data in CIOT modules. - diff --git a/docs/latex/ciot__common__types_8h_source.tex b/docs/latex/ciot__common__types_8h_source.tex deleted file mode 100644 index 2b2f802..0000000 --- a/docs/latex/ciot__common__types_8h_source.tex +++ /dev/null @@ -1,27 +0,0 @@ -\doxysection{ciot\+\_\+common\+\_\+types.\+h} -\hypertarget{ciot__common__types_8h_source}{}\label{ciot__common__types_8h_source}\index{include/ciot\_common\_types.h@{include/ciot\_common\_types.h}} -\mbox{\hyperlink{ciot__common__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_COMMON\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_COMMON\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00018\ } -\DoxyCodeLine{00020\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__event__data}{ciot\_event\_data}}} -\DoxyCodeLine{00021\ \{} -\DoxyCodeLine{00022\ \ \ \ \ uint8\_t\ *\mbox{\hyperlink{structciot__event__data_aaa8222c604b0b520bc2205ddcc42d855}{ptr}};\ } -\DoxyCodeLine{00023\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__event__data_a439227feff9d7f55384e8780cfc2eb82}{size}};\ } -\DoxyCodeLine{00024\ \}\ \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\_event\_data\_t}};} -\DoxyCodeLine{00025\ } -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00027\ \}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__config_8h.tex b/docs/latex/ciot__config_8h.tex deleted file mode 100644 index b0f4218..0000000 --- a/docs/latex/ciot__config_8h.tex +++ /dev/null @@ -1,214 +0,0 @@ -\doxysection{include/ciot\+\_\+config.h File Reference} -\hypertarget{ciot__config_8h}{}\label{ciot__config_8h}\index{include/ciot\_config.h@{include/ciot\_config.h}} - - -Configuration options for the CIOT library. - - -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__config_8h_a9d4899595ff9cdd8c920802d34e4c4aa}{CIOT\+\_\+\+TARGET\+\_\+\+UNKNOWN}} -\item -\#define \mbox{\hyperlink{ciot__config_8h_a308e001caa7470a8d08a2e85a4d96b8b}{CIOT\+\_\+\+VER}}~0, 1, 0 -\item -\#define \mbox{\hyperlink{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}{CIOT\+\_\+\+CONFIG\+\_\+\+LOG\+\_\+\+LEVEL}}~\mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a5f57b5ccf4a45d424a48b7edfc305a6b}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+INFO}} -\item -\#define \mbox{\hyperlink{ciot__config_8h_a186bc96636ade48237ab070f06addc99}{CIOT\+\_\+\+CONFIG\+\_\+\+APP\+\_\+\+VER}}~0, 3, 0 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a246a5924c487a75e59a9e7a3d3dc971b}{CIOT\+\_\+\+CONFIG\+\_\+\+HARDWARE\+\_\+\+NAME}}~"{}CIOT BOARD"{} -\item -\#define \mbox{\hyperlink{ciot__config_8h_a0fcb171a0d3b1eac51cf9bfa90d906cc}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+STORAGE}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_ad140ac0bec42207439a532c0ad082366}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+SYSTEM}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a02f813de273571624eb6c96c1899f757}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+UART}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a4f43c64c17f3778334fd48cee3edf44b}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+USB}}~0 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a6dc948a124871514166a7af7e6183803}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+BLE\+\_\+\+SCN}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_aff28490be76958e49cbc2b2ef1e0eb20}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+ETHERNET}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_aa2894556fa44adea617f243356083f21}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+WIFI}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a4d3353714ceeeb9fb3c9194e3836f0fd}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+NTP}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a4c4a996f1746ebd2d7346e64a93f69f3}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+OTA}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a251d01d6a87722ff3112f7c3e19eb675}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+DFU}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a8df4e58b5652a4de40cd958e782df114}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+HTTPS}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_abd191e184bd878220a70d25c4ad08abf}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+HTTPC}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a595e79e3b6eb41743c2ca97fbd867929}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+MQTTC}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_afb001a0ca89034fb9080542d74d24680}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+TIMER}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a9c1d5b23b81041e39ec83946d85e565d}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+BRIDGE}}~1 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a9b9559cad470869eca1c6c6a8210d9cd}{CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+SERIALIZER}}~0 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a2a51fc859e13b6f8377f6675583c6dd1}{CIOT\+\_\+\+CONFIG\+\_\+\+MESSAGE\+\_\+\+LEN}}~330 -\item -\#define \mbox{\hyperlink{ciot__config_8h_a2363f926f2104cad3b5cd5f1b1699f44}{CIOT\+\_\+\+CONFIG\+\_\+\+MESSAGE\+\_\+\+PAYLOAD\+\_\+\+LEN}}~256 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Configuration options for the CIOT library. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__config_8h_a186bc96636ade48237ab070f06addc99}\label{ciot__config_8h_a186bc96636ade48237ab070f06addc99} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_APP\_VER@{CIOT\_CONFIG\_APP\_VER}} -\index{CIOT\_CONFIG\_APP\_VER@{CIOT\_CONFIG\_APP\_VER}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_APP\_VER}{CIOT\_CONFIG\_APP\_VER}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+APP\+\_\+\+VER~0, 3, 0} - -Default app version \Hypertarget{ciot__config_8h_a6dc948a124871514166a7af7e6183803}\label{ciot__config_8h_a6dc948a124871514166a7af7e6183803} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_BLE\_SCN@{CIOT\_CONFIG\_FEATURE\_BLE\_SCN}} -\index{CIOT\_CONFIG\_FEATURE\_BLE\_SCN@{CIOT\_CONFIG\_FEATURE\_BLE\_SCN}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_BLE\_SCN}{CIOT\_CONFIG\_FEATURE\_BLE\_SCN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+BLE\+\_\+\+SCN~1} - -Enable Bluetooth Low Energy Scanner \Hypertarget{ciot__config_8h_a9c1d5b23b81041e39ec83946d85e565d}\label{ciot__config_8h_a9c1d5b23b81041e39ec83946d85e565d} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_BRIDGE@{CIOT\_CONFIG\_FEATURE\_BRIDGE}} -\index{CIOT\_CONFIG\_FEATURE\_BRIDGE@{CIOT\_CONFIG\_FEATURE\_BRIDGE}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_BRIDGE}{CIOT\_CONFIG\_FEATURE\_BRIDGE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+BRIDGE~1} - -Enable Bridge Implementation \Hypertarget{ciot__config_8h_a251d01d6a87722ff3112f7c3e19eb675}\label{ciot__config_8h_a251d01d6a87722ff3112f7c3e19eb675} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_DFU@{CIOT\_CONFIG\_FEATURE\_DFU}} -\index{CIOT\_CONFIG\_FEATURE\_DFU@{CIOT\_CONFIG\_FEATURE\_DFU}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_DFU}{CIOT\_CONFIG\_FEATURE\_DFU}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+DFU~1} - -Enable DFU \Hypertarget{ciot__config_8h_aff28490be76958e49cbc2b2ef1e0eb20}\label{ciot__config_8h_aff28490be76958e49cbc2b2ef1e0eb20} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_ETHERNET@{CIOT\_CONFIG\_FEATURE\_ETHERNET}} -\index{CIOT\_CONFIG\_FEATURE\_ETHERNET@{CIOT\_CONFIG\_FEATURE\_ETHERNET}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_ETHERNET}{CIOT\_CONFIG\_FEATURE\_ETHERNET}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+ETHERNET~1} - -Enable Ethernet \Hypertarget{ciot__config_8h_abd191e184bd878220a70d25c4ad08abf}\label{ciot__config_8h_abd191e184bd878220a70d25c4ad08abf} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_HTTPC@{CIOT\_CONFIG\_FEATURE\_HTTPC}} -\index{CIOT\_CONFIG\_FEATURE\_HTTPC@{CIOT\_CONFIG\_FEATURE\_HTTPC}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_HTTPC}{CIOT\_CONFIG\_FEATURE\_HTTPC}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+HTTPC~1} - -Enable HTTP Client \Hypertarget{ciot__config_8h_a8df4e58b5652a4de40cd958e782df114}\label{ciot__config_8h_a8df4e58b5652a4de40cd958e782df114} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_HTTPS@{CIOT\_CONFIG\_FEATURE\_HTTPS}} -\index{CIOT\_CONFIG\_FEATURE\_HTTPS@{CIOT\_CONFIG\_FEATURE\_HTTPS}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_HTTPS}{CIOT\_CONFIG\_FEATURE\_HTTPS}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+HTTPS~1} - -Enable HTTP Server \Hypertarget{ciot__config_8h_a595e79e3b6eb41743c2ca97fbd867929}\label{ciot__config_8h_a595e79e3b6eb41743c2ca97fbd867929} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_MQTTC@{CIOT\_CONFIG\_FEATURE\_MQTTC}} -\index{CIOT\_CONFIG\_FEATURE\_MQTTC@{CIOT\_CONFIG\_FEATURE\_MQTTC}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_MQTTC}{CIOT\_CONFIG\_FEATURE\_MQTTC}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+MQTTC~1} - -Enable MQTT Client \Hypertarget{ciot__config_8h_a4d3353714ceeeb9fb3c9194e3836f0fd}\label{ciot__config_8h_a4d3353714ceeeb9fb3c9194e3836f0fd} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_NTP@{CIOT\_CONFIG\_FEATURE\_NTP}} -\index{CIOT\_CONFIG\_FEATURE\_NTP@{CIOT\_CONFIG\_FEATURE\_NTP}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_NTP}{CIOT\_CONFIG\_FEATURE\_NTP}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+NTP~1} - -Enable NTP \Hypertarget{ciot__config_8h_a4c4a996f1746ebd2d7346e64a93f69f3}\label{ciot__config_8h_a4c4a996f1746ebd2d7346e64a93f69f3} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_OTA@{CIOT\_CONFIG\_FEATURE\_OTA}} -\index{CIOT\_CONFIG\_FEATURE\_OTA@{CIOT\_CONFIG\_FEATURE\_OTA}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_OTA}{CIOT\_CONFIG\_FEATURE\_OTA}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+OTA~1} - -Enable OTA \Hypertarget{ciot__config_8h_a9b9559cad470869eca1c6c6a8210d9cd}\label{ciot__config_8h_a9b9559cad470869eca1c6c6a8210d9cd} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_SERIALIZER@{CIOT\_CONFIG\_FEATURE\_SERIALIZER}} -\index{CIOT\_CONFIG\_FEATURE\_SERIALIZER@{CIOT\_CONFIG\_FEATURE\_SERIALIZER}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_SERIALIZER}{CIOT\_CONFIG\_FEATURE\_SERIALIZER}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+SERIALIZER~0} - -Enable serializer \Hypertarget{ciot__config_8h_a0fcb171a0d3b1eac51cf9bfa90d906cc}\label{ciot__config_8h_a0fcb171a0d3b1eac51cf9bfa90d906cc} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_STORAGE@{CIOT\_CONFIG\_FEATURE\_STORAGE}} -\index{CIOT\_CONFIG\_FEATURE\_STORAGE@{CIOT\_CONFIG\_FEATURE\_STORAGE}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_STORAGE}{CIOT\_CONFIG\_FEATURE\_STORAGE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+STORAGE~1} - -Enable Storage \Hypertarget{ciot__config_8h_ad140ac0bec42207439a532c0ad082366}\label{ciot__config_8h_ad140ac0bec42207439a532c0ad082366} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_SYSTEM@{CIOT\_CONFIG\_FEATURE\_SYSTEM}} -\index{CIOT\_CONFIG\_FEATURE\_SYSTEM@{CIOT\_CONFIG\_FEATURE\_SYSTEM}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_SYSTEM}{CIOT\_CONFIG\_FEATURE\_SYSTEM}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+SYSTEM~1} - -Enable System \Hypertarget{ciot__config_8h_afb001a0ca89034fb9080542d74d24680}\label{ciot__config_8h_afb001a0ca89034fb9080542d74d24680} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_TIMER@{CIOT\_CONFIG\_FEATURE\_TIMER}} -\index{CIOT\_CONFIG\_FEATURE\_TIMER@{CIOT\_CONFIG\_FEATURE\_TIMER}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_TIMER}{CIOT\_CONFIG\_FEATURE\_TIMER}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+TIMER~1} - -Enable system timer \Hypertarget{ciot__config_8h_a02f813de273571624eb6c96c1899f757}\label{ciot__config_8h_a02f813de273571624eb6c96c1899f757} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_UART@{CIOT\_CONFIG\_FEATURE\_UART}} -\index{CIOT\_CONFIG\_FEATURE\_UART@{CIOT\_CONFIG\_FEATURE\_UART}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_UART}{CIOT\_CONFIG\_FEATURE\_UART}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+UART~1} - -Enable UART \Hypertarget{ciot__config_8h_a4f43c64c17f3778334fd48cee3edf44b}\label{ciot__config_8h_a4f43c64c17f3778334fd48cee3edf44b} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_USB@{CIOT\_CONFIG\_FEATURE\_USB}} -\index{CIOT\_CONFIG\_FEATURE\_USB@{CIOT\_CONFIG\_FEATURE\_USB}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_USB}{CIOT\_CONFIG\_FEATURE\_USB}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+USB~0} - -Enable USB \Hypertarget{ciot__config_8h_aa2894556fa44adea617f243356083f21}\label{ciot__config_8h_aa2894556fa44adea617f243356083f21} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_FEATURE\_WIFI@{CIOT\_CONFIG\_FEATURE\_WIFI}} -\index{CIOT\_CONFIG\_FEATURE\_WIFI@{CIOT\_CONFIG\_FEATURE\_WIFI}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_FEATURE\_WIFI}{CIOT\_CONFIG\_FEATURE\_WIFI}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+FEATURE\+\_\+\+WIFI~1} - -Enable Wi\+Fi \Hypertarget{ciot__config_8h_a246a5924c487a75e59a9e7a3d3dc971b}\label{ciot__config_8h_a246a5924c487a75e59a9e7a3d3dc971b} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_HARDWARE\_NAME@{CIOT\_CONFIG\_HARDWARE\_NAME}} -\index{CIOT\_CONFIG\_HARDWARE\_NAME@{CIOT\_CONFIG\_HARDWARE\_NAME}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HARDWARE\_NAME}{CIOT\_CONFIG\_HARDWARE\_NAME}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HARDWARE\+\_\+\+NAME~"{}CIOT BOARD"{}} - -Default hardware name \Hypertarget{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}\label{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_LOG\_LEVEL@{CIOT\_CONFIG\_LOG\_LEVEL}} -\index{CIOT\_CONFIG\_LOG\_LEVEL@{CIOT\_CONFIG\_LOG\_LEVEL}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_LOG\_LEVEL}{CIOT\_CONFIG\_LOG\_LEVEL}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+LOG\+\_\+\+LEVEL~\mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a5f57b5ccf4a45d424a48b7edfc305a6b}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+INFO}}} - -Default log level \Hypertarget{ciot__config_8h_a2a51fc859e13b6f8377f6675583c6dd1}\label{ciot__config_8h_a2a51fc859e13b6f8377f6675583c6dd1} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_MESSAGE\_LEN@{CIOT\_CONFIG\_MESSAGE\_LEN}} -\index{CIOT\_CONFIG\_MESSAGE\_LEN@{CIOT\_CONFIG\_MESSAGE\_LEN}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MESSAGE\_LEN}{CIOT\_CONFIG\_MESSAGE\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MESSAGE\+\_\+\+LEN~330} - -CIOT expected message size \Hypertarget{ciot__config_8h_a2363f926f2104cad3b5cd5f1b1699f44}\label{ciot__config_8h_a2363f926f2104cad3b5cd5f1b1699f44} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_CONFIG\_MESSAGE\_PAYLOAD\_LEN@{CIOT\_CONFIG\_MESSAGE\_PAYLOAD\_LEN}} -\index{CIOT\_CONFIG\_MESSAGE\_PAYLOAD\_LEN@{CIOT\_CONFIG\_MESSAGE\_PAYLOAD\_LEN}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MESSAGE\_PAYLOAD\_LEN}{CIOT\_CONFIG\_MESSAGE\_PAYLOAD\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MESSAGE\+\_\+\+PAYLOAD\+\_\+\+LEN~256} - -CIOT message payload size \Hypertarget{ciot__config_8h_a9d4899595ff9cdd8c920802d34e4c4aa}\label{ciot__config_8h_a9d4899595ff9cdd8c920802d34e4c4aa} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_TARGET\_UNKNOWN@{CIOT\_TARGET\_UNKNOWN}} -\index{CIOT\_TARGET\_UNKNOWN@{CIOT\_TARGET\_UNKNOWN}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_TARGET\_UNKNOWN}{CIOT\_TARGET\_UNKNOWN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+TARGET\+\_\+\+UNKNOWN} - -\Hypertarget{ciot__config_8h_a308e001caa7470a8d08a2e85a4d96b8b}\label{ciot__config_8h_a308e001caa7470a8d08a2e85a4d96b8b} -\index{ciot\_config.h@{ciot\_config.h}!CIOT\_VER@{CIOT\_VER}} -\index{CIOT\_VER@{CIOT\_VER}!ciot\_config.h@{ciot\_config.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_VER}{CIOT\_VER}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+VER~0, 1, 0} - diff --git a/docs/latex/ciot__config_8h_source.tex b/docs/latex/ciot__config_8h_source.tex deleted file mode 100644 index aa1dbca..0000000 --- a/docs/latex/ciot__config_8h_source.tex +++ /dev/null @@ -1,59 +0,0 @@ -\doxysection{ciot\+\_\+config.\+h} -\hypertarget{ciot__config_8h_source}{}\label{ciot__config_8h_source}\index{include/ciot\_config.h@{include/ciot\_config.h}} -\mbox{\hyperlink{ciot__config_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_CONFIG\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_CONFIG\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#if\ defined(ICACHE\_FLASH)\ ||\ defined(ICACHE\_RAM\_ATTR)}} -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#define\ CIOT\_TARGET\_ESP8266}} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#elif\ defined(\_WIN32)}} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#define\ CIOT\_TARGET\_WIN}} -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#elif\ defined(ARDUINO)}} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#define\ CIOT\_TARGET\_INO}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#elif\ defined(ESP\_PLATFORM)}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#define\ CIOT\_TARGET\_ESP32}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#elif\ defined(NRF51)\ ||\ defined(NRF52)\ ||\ defined(NRF52840\_XXAA)}} -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#define\ CIOT\_TARGET\_NRF}} -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#elif\ defined(\_\_LINUX\_\_)\ ||\ defined(\_\_gnu\_linux\_\_)\ ||\ defined(\_\_linux\_\_)}} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#define\ CIOT\_TARGET\_LINUX}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#else}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#define\ CIOT\_TARGET\_UNKNOWN}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#warning\ "{}Target\ undefined."{}}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#define\ CIOT\_VER\ 0,\ 1,\ 0}} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#if\ \_\_has\_include("{}ciot\_custom\_config.h"{})}} -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#include\ "{}ciot\_custom\_config.h"{}}} -\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#else}} -\DoxyCodeLine{00035\ } -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#warning\ "{}ciot\_custom\_config.h\ not\ found.\ Using\ default\ configuration.\ Create\ a\ ciot\_custom\_config.h\ file\ to\ customize\ the\ ciot\ lib\ configurations."{}}} -\DoxyCodeLine{00037\ } -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_LOG\_LEVEL\ CIOT\_LOG\_LEVEL\_INFO\ }} -\DoxyCodeLine{00039\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_APP\_VER\ 0,\ 3,\ 0\ }} -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HARDWARE\_NAME\ "{}CIOT\ BOARD"{}\ }} -\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_STORAGE\ 1\ \ \ \ }} -\DoxyCodeLine{00043\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_SYSTEM\ 1\ \ \ \ \ }} -\DoxyCodeLine{00044\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_UART\ 1\ \ \ \ \ \ \ }} -\DoxyCodeLine{00045\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_USB\ 0\ \ \ \ \ \ \ \ }} -\DoxyCodeLine{00046\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_BLE\_SCN\ 1\ \ \ \ }} -\DoxyCodeLine{00047\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_ETHERNET\ 1\ \ \ }} -\DoxyCodeLine{00048\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_WIFI\ 1\ \ \ \ \ \ \ }} -\DoxyCodeLine{00049\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_NTP\ 1\ \ \ \ \ \ \ \ }} -\DoxyCodeLine{00050\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_OTA\ 1\ \ \ \ \ \ \ \ }} -\DoxyCodeLine{00051\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_DFU\ 1\ \ \ \ \ \ \ \ }} -\DoxyCodeLine{00052\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_HTTPS\ 1\ \ \ \ \ \ }} -\DoxyCodeLine{00053\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_HTTPC\ 1\ \ \ \ \ \ }} -\DoxyCodeLine{00054\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_MQTTC\ 1\ \ \ \ \ \ }} -\DoxyCodeLine{00055\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_TIMER\ 1\ \ \ \ \ \ }} -\DoxyCodeLine{00056\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_BRIDGE\ 1\ \ \ \ \ }} -\DoxyCodeLine{00057\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_FEATURE\_SERIALIZER\ 0\ \ }} -\DoxyCodeLine{00059\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MESSAGE\_LEN\ 330\ \ \ \ \ \ \ \ \ \ \ \ \ \ }} -\DoxyCodeLine{00060\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MESSAGE\_PAYLOAD\_LEN\ 256\ \ \ \ \ \ }} -\DoxyCodeLine{00062\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{//\_\_has\_include("{}ciot\_custom\_config.h"{})}} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00064\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__crc_8h.tex b/docs/latex/ciot__crc_8h.tex deleted file mode 100644 index d6452d7..0000000 --- a/docs/latex/ciot__crc_8h.tex +++ /dev/null @@ -1,168 +0,0 @@ -\doxysection{include/ciot\+\_\+crc.h File Reference} -\hypertarget{ciot__crc_8h}{}\label{ciot__crc_8h}\index{include/ciot\_crc.h@{include/ciot\_crc.h}} -{\ttfamily \#include $<$stdint.\+h$>$}\newline -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -uint32\+\_\+t \mbox{\hyperlink{ciot__crc_8h_ad020e1771e2ff7a25a068ccc1b3d1331}{ciot\+\_\+crc32\+\_\+le}} (uint32\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC32 value that is in little endian. \end{DoxyCompactList}\item -uint32\+\_\+t \mbox{\hyperlink{ciot__crc_8h_aeed9b1c0c84b16c8e4e4b65be0787ae4}{ciot\+\_\+crc32\+\_\+be}} (uint32\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC32 value that is in big endian. \end{DoxyCompactList}\item -uint16\+\_\+t \mbox{\hyperlink{ciot__crc_8h_a73a6ce791d6f000bad7ee2eedd0d8350}{ciot\+\_\+crc16\+\_\+le}} (uint16\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC16 value that is in little endian. \end{DoxyCompactList}\item -uint16\+\_\+t \mbox{\hyperlink{ciot__crc_8h_a5d59ce0d0ffe65eaf7944d695bde59e3}{ciot\+\_\+crc16\+\_\+be}} (uint16\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC16 value that is in big endian. \end{DoxyCompactList}\item -uint8\+\_\+t \mbox{\hyperlink{ciot__crc_8h_a39da2d632baf462933f90f3fbe7a63e7}{ciot\+\_\+crc8\+\_\+le}} (uint8\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC8 value that is in little endian. \end{DoxyCompactList}\item -uint8\+\_\+t \mbox{\hyperlink{ciot__crc_8h_ae831c4d3ed93d649df5ed07e5b9d1c46}{ciot\+\_\+crc8\+\_\+be}} (uint8\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC8 value that is in big endian. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/19 -\end{DoxyDate} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__crc_8h_a5d59ce0d0ffe65eaf7944d695bde59e3}\label{ciot__crc_8h_a5d59ce0d0ffe65eaf7944d695bde59e3} -\index{ciot\_crc.h@{ciot\_crc.h}!ciot\_crc16\_be@{ciot\_crc16\_be}} -\index{ciot\_crc16\_be@{ciot\_crc16\_be}!ciot\_crc.h@{ciot\_crc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_crc16\_be()}{ciot\_crc16\_be()}} -{\footnotesize\ttfamily uint16\+\_\+t ciot\+\_\+crc16\+\_\+be (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC16 value that is in big endian. - - -\begin{DoxyParams}{Parameters} -{\em uint16\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{ciot__crc_8h_a73a6ce791d6f000bad7ee2eedd0d8350}\label{ciot__crc_8h_a73a6ce791d6f000bad7ee2eedd0d8350} -\index{ciot\_crc.h@{ciot\_crc.h}!ciot\_crc16\_le@{ciot\_crc16\_le}} -\index{ciot\_crc16\_le@{ciot\_crc16\_le}!ciot\_crc.h@{ciot\_crc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_crc16\_le()}{ciot\_crc16\_le()}} -{\footnotesize\ttfamily uint16\+\_\+t ciot\+\_\+crc16\+\_\+le (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC16 value that is in little endian. - - -\begin{DoxyParams}{Parameters} -{\em uint16\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{ciot__crc_8h_aeed9b1c0c84b16c8e4e4b65be0787ae4}\label{ciot__crc_8h_aeed9b1c0c84b16c8e4e4b65be0787ae4} -\index{ciot\_crc.h@{ciot\_crc.h}!ciot\_crc32\_be@{ciot\_crc32\_be}} -\index{ciot\_crc32\_be@{ciot\_crc32\_be}!ciot\_crc.h@{ciot\_crc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_crc32\_be()}{ciot\_crc32\_be()}} -{\footnotesize\ttfamily uint32\+\_\+t ciot\+\_\+crc32\+\_\+be (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC32 value that is in big endian. - - -\begin{DoxyParams}{Parameters} -{\em uint32\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{ciot__crc_8h_ad020e1771e2ff7a25a068ccc1b3d1331}\label{ciot__crc_8h_ad020e1771e2ff7a25a068ccc1b3d1331} -\index{ciot\_crc.h@{ciot\_crc.h}!ciot\_crc32\_le@{ciot\_crc32\_le}} -\index{ciot\_crc32\_le@{ciot\_crc32\_le}!ciot\_crc.h@{ciot\_crc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_crc32\_le()}{ciot\_crc32\_le()}} -{\footnotesize\ttfamily uint32\+\_\+t ciot\+\_\+crc32\+\_\+le (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC32 value that is in little endian. - - -\begin{DoxyParams}{Parameters} -{\em uint32\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{ciot__crc_8h_ae831c4d3ed93d649df5ed07e5b9d1c46}\label{ciot__crc_8h_ae831c4d3ed93d649df5ed07e5b9d1c46} -\index{ciot\_crc.h@{ciot\_crc.h}!ciot\_crc8\_be@{ciot\_crc8\_be}} -\index{ciot\_crc8\_be@{ciot\_crc8\_be}!ciot\_crc.h@{ciot\_crc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_crc8\_be()}{ciot\_crc8\_be()}} -{\footnotesize\ttfamily uint8\+\_\+t ciot\+\_\+crc8\+\_\+be (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC8 value that is in big endian. - - -\begin{DoxyParams}{Parameters} -{\em uint32\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{ciot__crc_8h_a39da2d632baf462933f90f3fbe7a63e7}\label{ciot__crc_8h_a39da2d632baf462933f90f3fbe7a63e7} -\index{ciot\_crc.h@{ciot\_crc.h}!ciot\_crc8\_le@{ciot\_crc8\_le}} -\index{ciot\_crc8\_le@{ciot\_crc8\_le}!ciot\_crc.h@{ciot\_crc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_crc8\_le()}{ciot\_crc8\_le()}} -{\footnotesize\ttfamily uint8\+\_\+t ciot\+\_\+crc8\+\_\+le (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC8 value that is in little endian. - - -\begin{DoxyParams}{Parameters} -{\em uint8\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} diff --git a/docs/latex/ciot__crc_8h_source.tex b/docs/latex/ciot__crc_8h_source.tex deleted file mode 100644 index 9c4946e..0000000 --- a/docs/latex/ciot__crc_8h_source.tex +++ /dev/null @@ -1,73 +0,0 @@ -\doxysection{ciot\+\_\+crc.\+h} -\hypertarget{ciot__crc_8h_source}{}\label{ciot__crc_8h_source}\index{include/ciot\_crc.h@{include/ciot\_crc.h}} -\mbox{\hyperlink{ciot__crc_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_CRC\_\_H\_\_}} -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_CRC\_\_H\_\_}} -\DoxyCodeLine{00014\ } -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00018\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00021\ \textcolor{comment}{/*\ \ \ \ \ \ \ \ \ \ \ Notes\ about\ CRC\ APIs\ usage}} -\DoxyCodeLine{00022\ \textcolor{comment}{\ *\ The\ ESP32\ ROM\ include\ some\ CRC\ tables\ and\ CRC\ APIs\ to\ speed\ up\ CRC\ calculation.}} -\DoxyCodeLine{00023\ \textcolor{comment}{\ *\ The\ CRC\ APIs\ include\ CRC8,\ CRC16,\ CRC32\ algorithms\ for\ both\ little\ endian\ and\ big\ endian\ modes.}} -\DoxyCodeLine{00024\ \textcolor{comment}{\ *\ Here\ are\ the\ polynomials\ for\ the\ algorithms:}} -\DoxyCodeLine{00025\ \textcolor{comment}{\ *\ CRC-\/8\ \ \ \ \ \ \ \ x8+x2+x1+1\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0x07}} -\DoxyCodeLine{00026\ \textcolor{comment}{\ *\ CRC16-\/CCITT\ \ x16+x12+x5+1\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0x1021}} -\DoxyCodeLine{00027\ \textcolor{comment}{\ *\ CRC32\ \ \ \ \ \ \ \ x32+x26+x23+x22+x16+x12+x11+x10+x8+x7+x5+x4+x2+x1+1\ \ \ \ \ 0x04c11db7}} -\DoxyCodeLine{00028\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00029\ \textcolor{comment}{\ *\ These\ group\ of\ CRC\ APIs\ are\ designed\ to\ calculate\ the\ data\ in\ buffers\ either\ continuous\ or\ not.}} -\DoxyCodeLine{00030\ \textcolor{comment}{\ *\ To\ make\ it\ easy,\ we\ had\ added\ a\ \`{}\string~`\ at\ the\ beginning\ and\ the\ end\ of\ the\ functions.}} -\DoxyCodeLine{00031\ \textcolor{comment}{\ *\ To\ calculate\ non-\/continuous\ buffers,\ we\ can\ write\ the\ code\ like\ this:}} -\DoxyCodeLine{00032\ \textcolor{comment}{\ *\ \ \ \ \ init\ =\ \string~init;}} -\DoxyCodeLine{00033\ \textcolor{comment}{\ *\ \ \ \ \ crc\ =\ crc32\_le(init,\ buf0,\ length0);}} -\DoxyCodeLine{00034\ \textcolor{comment}{\ *\ \ \ \ \ crc\ =\ crc32\_le(crc,\ buf1,\ length1);}} -\DoxyCodeLine{00035\ \textcolor{comment}{\ *\ \ \ \ \ crc\ =\ \string~crc;}} -\DoxyCodeLine{00036\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00037\ \textcolor{comment}{\ *\ However,\ it\ is\ not\ easy\ to\ select\ which\ API\ to\ use\ and\ give\ the\ correct\ parameters.}} -\DoxyCodeLine{00038\ \textcolor{comment}{\ *\ A\ specific\ CRC\ algorithm\ will\ include\ this\ parameters:\ width,\ polynomials,\ init,\ refin,\ refout,\ xorout}} -\DoxyCodeLine{00039\ \textcolor{comment}{\ *\ \ \ \ \ refin\ and\ refout\ show\ the\ endian\ of\ the\ algorithm:}} -\DoxyCodeLine{00040\ \textcolor{comment}{\ *\ \ \ \ \ \ \ \ \ if\ both\ of\ them\ are\ true,\ please\ use\ the\ little\ endian\ API.}} -\DoxyCodeLine{00041\ \textcolor{comment}{\ *\ \ \ \ \ \ \ \ \ if\ both\ of\ them\ are\ false,\ please\ use\ the\ big\ endian\ API.}} -\DoxyCodeLine{00042\ \textcolor{comment}{\ *\ \ \ \ \ xorout\ is\ the\ value\ which\ you\ need\ to\ be\ xored\ to\ the\ raw\ result.}} -\DoxyCodeLine{00043\ \textcolor{comment}{\ *\ However,\ these\ group\ of\ APIs\ need\ one\ '\string~'\ before\ and\ after\ the\ APIs.}} -\DoxyCodeLine{00044\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00045\ \textcolor{comment}{\ *\ Here\ are\ some\ examples\ for\ CRC16:}} -\DoxyCodeLine{00046\ \textcolor{comment}{\ *\ CRC-\/16/CCITT,\ poly\ =\ 0x1021,\ init\ =\ 0x0000,\ refin\ =\ true,\ refout\ =\ true,\ xorout\ =\ 0x0000}} -\DoxyCodeLine{00047\ \textcolor{comment}{\ *\ \ \ \ \ crc\ =\ \string~crc16\_le((uint16\_t)\string~0x0000,\ buf,\ length);}} -\DoxyCodeLine{00048\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00049\ \textcolor{comment}{\ *\ CRC-\/16/CCITT-\/FALSE,\ poly\ =\ 0x1021,\ init\ =\ 0xffff,\ refin\ =\ false,\ refout\ =\ false,\ xorout\ =\ 0x0000}} -\DoxyCodeLine{00050\ \textcolor{comment}{\ *\ \ \ \ \ crc\ =\ \string~crc16\_be((uint16\_t)\string~0xffff,\ buf,\ length);}} -\DoxyCodeLine{00051\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00052\ \textcolor{comment}{\ *\ CRC-\/16/X25,\ poly\ =\ 0x1021,\ init\ =\ 0xffff,\ refin\ =\ true,\ refout\ =\ true,\ xorout\ =\ 0xffff}} -\DoxyCodeLine{00053\ \textcolor{comment}{\ *\ \ \ \ \ crc\ =\ (\string~crc16\_le((uint16\_t)\string~(0xffff),\ buf,\ length))\string^0xffff;}} -\DoxyCodeLine{00054\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00055\ \textcolor{comment}{\ *\ CRC-\/16/XMODEM,\ poly=\ 0x1021,\ init\ =\ 0x0000,\ refin\ =\ false,\ refout\ =\ false,\ xorout\ =\ 0x0000}} -\DoxyCodeLine{00056\ \textcolor{comment}{\ *\ \ \ \ \ crc\ =\ \string~crc16\_be((uint16\_t)\string~0x0000,\ buf,\ length);}} -\DoxyCodeLine{00057\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00058\ \textcolor{comment}{\ *}} -\DoxyCodeLine{00059\ \textcolor{comment}{\ */}} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00072\ uint32\_t\ \mbox{\hyperlink{ciot__crc_8h_ad020e1771e2ff7a25a068ccc1b3d1331}{ciot\_crc32\_le}}(uint32\_t\ crc,\ uint8\_t\ \textcolor{keyword}{const}\ *buf,\ uint32\_t\ len);} -\DoxyCodeLine{00073\ } -\DoxyCodeLine{00085\ uint32\_t\ \mbox{\hyperlink{ciot__crc_8h_aeed9b1c0c84b16c8e4e4b65be0787ae4}{ciot\_crc32\_be}}(uint32\_t\ crc,\ uint8\_t\ \textcolor{keyword}{const}\ *buf,\ uint32\_t\ len);} -\DoxyCodeLine{00086\ } -\DoxyCodeLine{00098\ uint16\_t\ \mbox{\hyperlink{ciot__crc_8h_a73a6ce791d6f000bad7ee2eedd0d8350}{ciot\_crc16\_le}}(uint16\_t\ crc,\ uint8\_t\ \textcolor{keyword}{const}\ *buf,\ uint32\_t\ len);} -\DoxyCodeLine{00099\ } -\DoxyCodeLine{00111\ uint16\_t\ \mbox{\hyperlink{ciot__crc_8h_a5d59ce0d0ffe65eaf7944d695bde59e3}{ciot\_crc16\_be}}(uint16\_t\ crc,\ uint8\_t\ \textcolor{keyword}{const}\ *buf,\ uint32\_t\ len);} -\DoxyCodeLine{00112\ } -\DoxyCodeLine{00124\ uint8\_t\ \mbox{\hyperlink{ciot__crc_8h_a39da2d632baf462933f90f3fbe7a63e7}{ciot\_crc8\_le}}(uint8\_t\ crc,\ uint8\_t\ \textcolor{keyword}{const}\ *buf,\ uint32\_t\ len);} -\DoxyCodeLine{00125\ } -\DoxyCodeLine{00137\ uint8\_t\ \mbox{\hyperlink{ciot__crc_8h_ae831c4d3ed93d649df5ed07e5b9d1c46}{ciot\_crc8\_be}}(uint8\_t\ crc,\ uint8\_t\ \textcolor{keyword}{const}\ *buf,\ uint32\_t\ len);} -\DoxyCodeLine{00138\ } -\DoxyCodeLine{00139\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00140\ \}} -\DoxyCodeLine{00141\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00142\ } -\DoxyCodeLine{00143\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__data__model__types_8h.tex b/docs/latex/ciot__data__model__types_8h.tex deleted file mode 100644 index 374c62c..0000000 --- a/docs/latex/ciot__data__model__types_8h.tex +++ /dev/null @@ -1,60 +0,0 @@ -\doxysection{include/types/ciot\+\_\+data\+\_\+model\+\_\+types.h File Reference} -\hypertarget{ciot__data__model__types_8h}{}\label{ciot__data__model__types_8h}\index{include/types/ciot\_data\_model\_types.h@{include/types/ciot\_data\_model\_types.h}} -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__data__model__cfg__t}{ciot\+\_\+data\+\_\+model\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT data model configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__data__model__status__t}{ciot\+\_\+data\+\_\+model\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT data model status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__data__model__req__data__u}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT data model request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__data__model__req__t}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT data model request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__data__model__data__u}{ciot\+\_\+data\+\_\+model\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT data model data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a}{ciot\+\_\+data\+\_\+model\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05aa3d6e53393cdb43053723613fd71b0be5}{CIOT\+\_\+\+DATA\+\_\+\+MODEL\+\_\+\+STATE\+\_\+\+IDLE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT data model states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454ca7c15c82a2c513452266ef7531a5d1eda}{CIOT\+\_\+\+DATA\+\_\+\+MODEL\+\_\+\+REQ\+\_\+\+UNKNOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT data model request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c}\label{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c} -\index{ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}!ciot\_data\_model\_req\_type\_t@{ciot\_data\_model\_req\_type\_t}} -\index{ciot\_data\_model\_req\_type\_t@{ciot\_data\_model\_req\_type\_t}!ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_data\_model\_req\_type\_t}{ciot\_data\_model\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT data model request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DATA\_MODEL\_REQ\_UNKNOWN@{CIOT\_DATA\_MODEL\_REQ\_UNKNOWN}!ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}}\index{ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}!CIOT\_DATA\_MODEL\_REQ\_UNKNOWN@{CIOT\_DATA\_MODEL\_REQ\_UNKNOWN}}}\Hypertarget{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454ca7c15c82a2c513452266ef7531a5d1eda}\label{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454ca7c15c82a2c513452266ef7531a5d1eda} -CIOT\+\_\+\+DATA\+\_\+\+MODEL\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a}\label{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a} -\index{ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}!ciot\_data\_model\_state\_t@{ciot\_data\_model\_state\_t}} -\index{ciot\_data\_model\_state\_t@{ciot\_data\_model\_state\_t}!ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_data\_model\_state\_t}{ciot\_data\_model\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a}{ciot\+\_\+data\+\_\+model\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT data model states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DATA\_MODEL\_STATE\_IDLE@{CIOT\_DATA\_MODEL\_STATE\_IDLE}!ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}}\index{ciot\_data\_model\_types.h@{ciot\_data\_model\_types.h}!CIOT\_DATA\_MODEL\_STATE\_IDLE@{CIOT\_DATA\_MODEL\_STATE\_IDLE}}}\Hypertarget{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05aa3d6e53393cdb43053723613fd71b0be5}\label{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05aa3d6e53393cdb43053723613fd71b0be5} -CIOT\+\_\+\+DATA\+\_\+\+MODEL\+\_\+\+STATE\+\_\+\+IDLE&Idle state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__data__model__types_8h_source.tex b/docs/latex/ciot__data__model__types_8h_source.tex deleted file mode 100644 index 53726c5..0000000 --- a/docs/latex/ciot__data__model__types_8h_source.tex +++ /dev/null @@ -1,59 +0,0 @@ -\doxysection{ciot\+\_\+data\+\_\+model\+\_\+types.\+h} -\hypertarget{ciot__data__model__types_8h_source}{}\label{ciot__data__model__types_8h_source}\index{include/types/ciot\_data\_model\_types.h@{include/types/ciot\_data\_model\_types.h}} -\mbox{\hyperlink{ciot__data__model__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_DATA\_MODEL\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_DATA\_MODEL\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00018\ } -\DoxyCodeLine{00022\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00023\ \{} -\DoxyCodeLine{00024\ \ \ \ \ \mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05aa3d6e53393cdb43053723613fd71b0be5}{CIOT\_DATA\_MODEL\_STATE\_IDLE}},\ } -\DoxyCodeLine{00025\ \}\ \mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a}{ciot\_data\_model\_state\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00031\ \{} -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454ca7c15c82a2c513452266ef7531a5d1eda}{CIOT\_DATA\_MODEL\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00033\ \}\ \mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c}{ciot\_data\_model\_req\_type\_t}};} -\DoxyCodeLine{00034\ } -\DoxyCodeLine{00038\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00039\ \{} -\DoxyCodeLine{00040\ } -\DoxyCodeLine{00041\ \}\ \mbox{\hyperlink{structciot__data__model__cfg__t}{ciot\_data\_model\_cfg\_t}};} -\DoxyCodeLine{00042\ } -\DoxyCodeLine{00046\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00047\ \{} -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a}{ciot\_data\_model\_state\_t}}\ \mbox{\hyperlink{structciot__data__model__status__t_a350c6a3720c9b7d1b3300e38430117e7}{state}};\ } -\DoxyCodeLine{00049\ \}\ \mbox{\hyperlink{structciot__data__model__status__t}{ciot\_data\_model\_status\_t}};} -\DoxyCodeLine{00050\ } -\DoxyCodeLine{00054\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00055\ \{} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00057\ \}\ \mbox{\hyperlink{unionciot__data__model__req__data__u}{ciot\_data\_model\_req\_data\_u}};} -\DoxyCodeLine{00058\ } -\DoxyCodeLine{00062\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00063\ \{} -\DoxyCodeLine{00064\ \ \ \ \ \mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c}{ciot\_data\_model\_req\_type\_t}}\ \mbox{\hyperlink{structciot__data__model__req__t_a1cc8da72a2d329be4f8ff647f04884a0}{type}};\ } -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{unionciot__data__model__req__data__u}{ciot\_data\_model\_req\_data\_u}}\ \mbox{\hyperlink{structciot__data__model__req__t_adbf84251d29a448cb6b3f3b4b402ebd0}{data}};\ } -\DoxyCodeLine{00066\ \}\ \mbox{\hyperlink{structciot__data__model__req__t}{ciot\_data\_model\_req\_t}};} -\DoxyCodeLine{00067\ } -\DoxyCodeLine{00071\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00072\ \{} -\DoxyCodeLine{00073\ \ \ \ \ \mbox{\hyperlink{structciot__data__model__cfg__t}{ciot\_data\_model\_cfg\_t}}\ \mbox{\hyperlink{unionciot__data__model__data__u_a0a7b5df86de5bd60d09108b02de9d89d}{config}};\ } -\DoxyCodeLine{00074\ \ \ \ \ \mbox{\hyperlink{structciot__data__model__status__t}{ciot\_data\_model\_status\_t}}\ \mbox{\hyperlink{unionciot__data__model__data__u_a3f4172ed60af91f49f998cde97dd28cb}{status}};\ } -\DoxyCodeLine{00075\ \ \ \ \ \mbox{\hyperlink{structciot__data__model__req__t}{ciot\_data\_model\_req\_t}}\ \mbox{\hyperlink{unionciot__data__model__data__u_a8342e156b9596a1154ff4ce550adb30f}{request}};\ } -\DoxyCodeLine{00076\ \}\ \mbox{\hyperlink{unionciot__data__model__data__u}{ciot\_data\_model\_data\_u}};} -\DoxyCodeLine{00077\ } -\DoxyCodeLine{00078\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00079\ \}} -\DoxyCodeLine{00080\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00081\ } -\DoxyCodeLine{00082\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__default_8h.tex b/docs/latex/ciot__default_8h.tex deleted file mode 100644 index c0c1102..0000000 --- a/docs/latex/ciot__default_8h.tex +++ /dev/null @@ -1,568 +0,0 @@ -\doxysection{include/ciot\+\_\+default.h File Reference} -\hypertarget{ciot__default_8h}{}\label{ciot__default_8h}\index{include/ciot\_default.h@{include/ciot\_default.h}} - - -Default configuration options for CIOT library. - - -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ac9389de4857fca429528b43c0e70bc08}{CIOT\+\_\+\+CONFIG\+\_\+\+STORAGE\+\_\+\+TYPE}}~\mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a5888e89d9b87b625ea64913fdbf4b9ae}{CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+FS}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_aae6ed2cc1f62936138b7b12cb78eab19}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+BAUD\+\_\+\+RATE}}~115200 -\item -\#define \mbox{\hyperlink{ciot__default_8h_af9d6ddc888416ceda770bd6ba0666adf}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+NUM}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a47a6c4735b406987793ff61a3748c356}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+RX\+\_\+\+PIN}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_afe80a6e24ff36484761b8a0740e21cd3}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TX\+\_\+\+PIN}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_ac915c58485a09a470ab105dcd7fdb438}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+RTS\+\_\+\+PIN}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a39b5dff57834d4a9f00b09ff9d7e0586}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+CTS\+\_\+\+PIN}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a0b574bd3271269a00ef9a3364564a650}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+FLOW\+\_\+\+CONTROL}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_ad5a0b532b36ce2e64548273d4694de52}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+PARITY}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a5e191db9399c301be511e6024b2f402d}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+DTR}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_ac64f70fbc40557ffc7f0f6c9d4aed430}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+BRIDGE\+\_\+\+MODE}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_abe942f163ef66924c29e63adb6e91cc3}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+DHCP}}~\mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da612a799c9f8c26c1f3b9a503712bd711}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+NO\+\_\+\+CHANGE}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a26d8ac3e34dcb0faaf41977b7dc54607}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+IP}}~0, 0, 0, 0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_abc5eb2049e9aab488e1bb1846c71b481}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+GATEWAY}}~0, 0, 0, 0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_ab361b51c2b4bb8324a0767a6680cab25}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+MASK}}~0, 0, 0, 0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_aa196f69c014910ca0e0f37d44b83ad30}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+DNS}}~0, 0, 0, 0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a7f79abe5ea5f7e3260843192069bdcaa}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+SSID}}~"{}Ciot AP"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_afdccac291d2c1de6425402fec83189cf}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+PASSWORD}}~"{}administrator"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a82cca16f86e1276f9a325ebbd1ec5d68}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+TCP}}~\mbox{\hyperlink{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a69173d99aec57142ba91edc18300f781}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA\+\_\+\+SSID}}~"{}Ciot STA"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a89cc8bb6906a26e085cd6d79e881717f}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA\+\_\+\+PASSWORD}}~"{}administrator"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a195751f0292e7d1046fa7a4b08e5fc23}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA\+\_\+\+TCP}}~\mbox{\hyperlink{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a7a33c55b1ce3269738b939eeb19cb71b}{CIOT\+\_\+\+CONFIG\+\_\+\+ETH}}~\mbox{\hyperlink{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a33bf5b2e0676207bb01e529a4adcf59e}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+OP\+\_\+\+MODE}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a81124436ceaf4bdbf7fd16ec51729aa7}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SYNC\+\_\+\+MODE}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_ab4fbb783d249bcf33ad25052b6072474}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SYNC\+\_\+\+INTERVAL}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT}}~3 -\item -\#define \mbox{\hyperlink{ciot__default_8h_ad52d4acc5014fec93b596267a4267489}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVER1}}~"{}pool.\+ntp.\+org"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a7e2f6267fdbe83b93e2220a3733f9774}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVER2}}~"{}time.\+google.\+com"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ade7f6e32e02db936bfd97768500c7c74}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVER3}}~"{}gps.\+ntp.\+br"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ae5e243b358058e660e46de4d92ec23dd}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+URL}}~"{}http\+://127.\+0.\+0.\+1\+:8080/v1/ciot"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ae166c8150eec3860c86266fbafa30164}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+TRANSPORT}}~\mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2ac0b77b7cf582d3d2adb20f67dac8cea1}{CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+TCP}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_abf9505c4cab01e148100b048a372663f}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+METHOD}}~\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac0f3e0c43ca1d9895d911a61aa3a0a3d}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+POST}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ab26205cfa1af914695c961fe6a7c37f7}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+TIMEOUT}}~20000 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a1a18adba17f39adbcca041afd38dc988}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPS\+\_\+\+ADDRESS}}~"{}http\+://127.\+0.\+0.\+1"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ab7eacba51c8ae0c580dbe9fbf5996cc1}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPS\+\_\+\+ROUTE}}~"{}/v1/ciot"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a67e3c6ac14d049d86edac23aeae48833}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPS\+\_\+\+PORT}}~8080 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a3ae1f5c8551422aca407ba0e0d7d051a}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+URL}}~"{}mqtt\+://test.\+mosquitto.\+org"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a04e894147896f6ba01229a76c6c1f976}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+PORT}}~1883 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a66e76a6c3a0b20620bee393047c462e6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+QOS}}~0 -\item -\#define \mbox{\hyperlink{ciot__default_8h_a0bb103892cbaabdd15fb9f93ef6ebfb8}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+USER}}~"{}"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ac7f8eb636e1dfd5e75ca8a2ccf174981}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+PASS}}~"{}"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a9835f697325cb7920259cad52e13b0a1}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+TOPIC\+\_\+\+D2B}}~"{}v1/ciot/d2b"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a0dad743975d309bddcfe83e7db9f4c43}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+TOPIC\+\_\+\+B2D}}~"{}v1/ciot/b2d"{} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ad1c730d9022fce47870a8de547c63721}{CIOT\+\_\+\+CONFIG\+\_\+\+SYS}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_ab398686897078b551d637f058ec072f7}{CIOT\+\_\+\+CONFIG\+\_\+\+STORAGE}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a0aa6817a5c88e8290142061b6b933252}{CIOT\+\_\+\+CONFIG\+\_\+\+UART}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a27de0c03a642d79eb31e712994646733}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a7c09f75e4ebc749a5c225c760c2befde}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a030e60462692de23e6989b3b23d894eb}{HG\+\_\+\+TCP\+\_\+\+CONFIG\+\_\+\+NTP}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_aef3854df37260fcf01c87b0acabf03dd}{CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a86eea122295995d6664aae9037c34a1d}{HG\+\_\+\+TCP\+\_\+\+CONFIG\+\_\+\+HTTPS}} -\item -\#define \mbox{\hyperlink{ciot__default_8h_a132bac5d5f62fa38121a52690971284c}{HG\+\_\+\+TCP\+\_\+\+CONFIG\+\_\+\+MQTTC}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Default configuration options for CIOT library. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/14 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__default_8h_a7a33c55b1ce3269738b939eeb19cb71b}\label{ciot__default_8h_a7a33c55b1ce3269738b939eeb19cb71b} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_ETH@{CIOT\_CONFIG\_ETH}} -\index{CIOT\_CONFIG\_ETH@{CIOT\_CONFIG\_ETH}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_ETH}{CIOT\_CONFIG\_ETH}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+ETH~\mbox{\hyperlink{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP}}} - -\Hypertarget{ciot__default_8h_aef3854df37260fcf01c87b0acabf03dd}\label{ciot__default_8h_aef3854df37260fcf01c87b0acabf03dd} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPC@{CIOT\_CONFIG\_HTTPC}} -\index{CIOT\_CONFIG\_HTTPC@{CIOT\_CONFIG\_HTTPC}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPC}{CIOT\_CONFIG\_HTTPC}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .url\ =\ \mbox{\hyperlink{ciot__default_8h_ae5e243b358058e660e46de4d92ec23dd}{CIOT\_CONFIG\_HTTPC\_URL}},\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .method\ =\ \mbox{\hyperlink{ciot__default_8h_abf9505c4cab01e148100b048a372663f}{CIOT\_CONFIG\_HTTPC\_METHOD}},\ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .transport\ =\ \mbox{\hyperlink{ciot__default_8h_ae166c8150eec3860c86266fbafa30164}{CIOT\_CONFIG\_HTTPC\_TRANSPORT}},\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .timeout\ =\ \mbox{\hyperlink{ciot__default_8h_ab26205cfa1af914695c961fe6a7c37f7}{CIOT\_CONFIG\_HTTPC\_TIMEOUT}},\ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_abf9505c4cab01e148100b048a372663f}\label{ciot__default_8h_abf9505c4cab01e148100b048a372663f} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPC\_METHOD@{CIOT\_CONFIG\_HTTPC\_METHOD}} -\index{CIOT\_CONFIG\_HTTPC\_METHOD@{CIOT\_CONFIG\_HTTPC\_METHOD}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPC\_METHOD}{CIOT\_CONFIG\_HTTPC\_METHOD}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+METHOD~\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac0f3e0c43ca1d9895d911a61aa3a0a3d}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+POST}}} - -\Hypertarget{ciot__default_8h_ab26205cfa1af914695c961fe6a7c37f7}\label{ciot__default_8h_ab26205cfa1af914695c961fe6a7c37f7} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPC\_TIMEOUT@{CIOT\_CONFIG\_HTTPC\_TIMEOUT}} -\index{CIOT\_CONFIG\_HTTPC\_TIMEOUT@{CIOT\_CONFIG\_HTTPC\_TIMEOUT}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPC\_TIMEOUT}{CIOT\_CONFIG\_HTTPC\_TIMEOUT}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+TIMEOUT~20000} - -\Hypertarget{ciot__default_8h_ae166c8150eec3860c86266fbafa30164}\label{ciot__default_8h_ae166c8150eec3860c86266fbafa30164} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPC\_TRANSPORT@{CIOT\_CONFIG\_HTTPC\_TRANSPORT}} -\index{CIOT\_CONFIG\_HTTPC\_TRANSPORT@{CIOT\_CONFIG\_HTTPC\_TRANSPORT}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPC\_TRANSPORT}{CIOT\_CONFIG\_HTTPC\_TRANSPORT}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+TRANSPORT~\mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2ac0b77b7cf582d3d2adb20f67dac8cea1}{CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+TCP}}} - -\Hypertarget{ciot__default_8h_ae5e243b358058e660e46de4d92ec23dd}\label{ciot__default_8h_ae5e243b358058e660e46de4d92ec23dd} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPC\_URL@{CIOT\_CONFIG\_HTTPC\_URL}} -\index{CIOT\_CONFIG\_HTTPC\_URL@{CIOT\_CONFIG\_HTTPC\_URL}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPC\_URL}{CIOT\_CONFIG\_HTTPC\_URL}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPC\+\_\+\+URL~"{}http\+://127.\+0.\+0.\+1\+:8080/v1/ciot"{}} - -\Hypertarget{ciot__default_8h_a1a18adba17f39adbcca041afd38dc988}\label{ciot__default_8h_a1a18adba17f39adbcca041afd38dc988} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPS\_ADDRESS@{CIOT\_CONFIG\_HTTPS\_ADDRESS}} -\index{CIOT\_CONFIG\_HTTPS\_ADDRESS@{CIOT\_CONFIG\_HTTPS\_ADDRESS}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPS\_ADDRESS}{CIOT\_CONFIG\_HTTPS\_ADDRESS}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPS\+\_\+\+ADDRESS~"{}http\+://127.\+0.\+0.\+1"{}} - -\Hypertarget{ciot__default_8h_a67e3c6ac14d049d86edac23aeae48833}\label{ciot__default_8h_a67e3c6ac14d049d86edac23aeae48833} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPS\_PORT@{CIOT\_CONFIG\_HTTPS\_PORT}} -\index{CIOT\_CONFIG\_HTTPS\_PORT@{CIOT\_CONFIG\_HTTPS\_PORT}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPS\_PORT}{CIOT\_CONFIG\_HTTPS\_PORT}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPS\+\_\+\+PORT~8080} - -\Hypertarget{ciot__default_8h_ab7eacba51c8ae0c580dbe9fbf5996cc1}\label{ciot__default_8h_ab7eacba51c8ae0c580dbe9fbf5996cc1} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_HTTPS\_ROUTE@{CIOT\_CONFIG\_HTTPS\_ROUTE}} -\index{CIOT\_CONFIG\_HTTPS\_ROUTE@{CIOT\_CONFIG\_HTTPS\_ROUTE}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_HTTPS\_ROUTE}{CIOT\_CONFIG\_HTTPS\_ROUTE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+HTTPS\+\_\+\+ROUTE~"{}/v1/ciot"{}} - -\Hypertarget{ciot__default_8h_ac7f8eb636e1dfd5e75ca8a2ccf174981}\label{ciot__default_8h_ac7f8eb636e1dfd5e75ca8a2ccf174981} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_MQTTC\_PASS@{CIOT\_CONFIG\_MQTTC\_PASS}} -\index{CIOT\_CONFIG\_MQTTC\_PASS@{CIOT\_CONFIG\_MQTTC\_PASS}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTTC\_PASS}{CIOT\_CONFIG\_MQTTC\_PASS}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+PASS~"{}"{}} - -\Hypertarget{ciot__default_8h_a04e894147896f6ba01229a76c6c1f976}\label{ciot__default_8h_a04e894147896f6ba01229a76c6c1f976} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_MQTTC\_PORT@{CIOT\_CONFIG\_MQTTC\_PORT}} -\index{CIOT\_CONFIG\_MQTTC\_PORT@{CIOT\_CONFIG\_MQTTC\_PORT}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTTC\_PORT}{CIOT\_CONFIG\_MQTTC\_PORT}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+PORT~1883} - -\Hypertarget{ciot__default_8h_a66e76a6c3a0b20620bee393047c462e6}\label{ciot__default_8h_a66e76a6c3a0b20620bee393047c462e6} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_MQTTC\_QOS@{CIOT\_CONFIG\_MQTTC\_QOS}} -\index{CIOT\_CONFIG\_MQTTC\_QOS@{CIOT\_CONFIG\_MQTTC\_QOS}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTTC\_QOS}{CIOT\_CONFIG\_MQTTC\_QOS}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+QOS~0} - -\Hypertarget{ciot__default_8h_a0dad743975d309bddcfe83e7db9f4c43}\label{ciot__default_8h_a0dad743975d309bddcfe83e7db9f4c43} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D@{CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D}} -\index{CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D@{CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D}{CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+TOPIC\+\_\+\+B2D~"{}v1/ciot/b2d"{}} - -\Hypertarget{ciot__default_8h_a9835f697325cb7920259cad52e13b0a1}\label{ciot__default_8h_a9835f697325cb7920259cad52e13b0a1} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B@{CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B}} -\index{CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B@{CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B}{CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+TOPIC\+\_\+\+D2B~"{}v1/ciot/d2b"{}} - -\Hypertarget{ciot__default_8h_a3ae1f5c8551422aca407ba0e0d7d051a}\label{ciot__default_8h_a3ae1f5c8551422aca407ba0e0d7d051a} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_MQTTC\_URL@{CIOT\_CONFIG\_MQTTC\_URL}} -\index{CIOT\_CONFIG\_MQTTC\_URL@{CIOT\_CONFIG\_MQTTC\_URL}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTTC\_URL}{CIOT\_CONFIG\_MQTTC\_URL}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+URL~"{}mqtt\+://test.\+mosquitto.\+org"{}} - -\Hypertarget{ciot__default_8h_a0bb103892cbaabdd15fb9f93ef6ebfb8}\label{ciot__default_8h_a0bb103892cbaabdd15fb9f93ef6ebfb8} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_MQTTC\_USER@{CIOT\_CONFIG\_MQTTC\_USER}} -\index{CIOT\_CONFIG\_MQTTC\_USER@{CIOT\_CONFIG\_MQTTC\_USER}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTTC\_USER}{CIOT\_CONFIG\_MQTTC\_USER}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTTC\+\_\+\+USER~"{}"{}} - -\Hypertarget{ciot__default_8h_a33bf5b2e0676207bb01e529a4adcf59e}\label{ciot__default_8h_a33bf5b2e0676207bb01e529a4adcf59e} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_NTP\_OP\_MODE@{CIOT\_CONFIG\_NTP\_OP\_MODE}} -\index{CIOT\_CONFIG\_NTP\_OP\_MODE@{CIOT\_CONFIG\_NTP\_OP\_MODE}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_OP\_MODE}{CIOT\_CONFIG\_NTP\_OP\_MODE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+OP\+\_\+\+MODE~0} - -\Hypertarget{ciot__default_8h_ad52d4acc5014fec93b596267a4267489}\label{ciot__default_8h_ad52d4acc5014fec93b596267a4267489} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_NTP\_SERVER1@{CIOT\_CONFIG\_NTP\_SERVER1}} -\index{CIOT\_CONFIG\_NTP\_SERVER1@{CIOT\_CONFIG\_NTP\_SERVER1}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_SERVER1}{CIOT\_CONFIG\_NTP\_SERVER1}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVER1~"{}pool.\+ntp.\+org"{}} - -\Hypertarget{ciot__default_8h_a7e2f6267fdbe83b93e2220a3733f9774}\label{ciot__default_8h_a7e2f6267fdbe83b93e2220a3733f9774} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_NTP\_SERVER2@{CIOT\_CONFIG\_NTP\_SERVER2}} -\index{CIOT\_CONFIG\_NTP\_SERVER2@{CIOT\_CONFIG\_NTP\_SERVER2}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_SERVER2}{CIOT\_CONFIG\_NTP\_SERVER2}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVER2~"{}time.\+google.\+com"{}} - -\Hypertarget{ciot__default_8h_ade7f6e32e02db936bfd97768500c7c74}\label{ciot__default_8h_ade7f6e32e02db936bfd97768500c7c74} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_NTP\_SERVER3@{CIOT\_CONFIG\_NTP\_SERVER3}} -\index{CIOT\_CONFIG\_NTP\_SERVER3@{CIOT\_CONFIG\_NTP\_SERVER3}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_SERVER3}{CIOT\_CONFIG\_NTP\_SERVER3}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVER3~"{}gps.\+ntp.\+br"{}} - -\Hypertarget{ciot__default_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}\label{ciot__default_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_NTP\_SERVERS\_COUNT@{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}} -\index{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT@{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT~3} - -\Hypertarget{ciot__default_8h_ab4fbb783d249bcf33ad25052b6072474}\label{ciot__default_8h_ab4fbb783d249bcf33ad25052b6072474} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_NTP\_SYNC\_INTERVAL@{CIOT\_CONFIG\_NTP\_SYNC\_INTERVAL}} -\index{CIOT\_CONFIG\_NTP\_SYNC\_INTERVAL@{CIOT\_CONFIG\_NTP\_SYNC\_INTERVAL}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_SYNC\_INTERVAL}{CIOT\_CONFIG\_NTP\_SYNC\_INTERVAL}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SYNC\+\_\+\+INTERVAL~0} - -\Hypertarget{ciot__default_8h_a81124436ceaf4bdbf7fd16ec51729aa7}\label{ciot__default_8h_a81124436ceaf4bdbf7fd16ec51729aa7} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_NTP\_SYNC\_MODE@{CIOT\_CONFIG\_NTP\_SYNC\_MODE}} -\index{CIOT\_CONFIG\_NTP\_SYNC\_MODE@{CIOT\_CONFIG\_NTP\_SYNC\_MODE}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_SYNC\_MODE}{CIOT\_CONFIG\_NTP\_SYNC\_MODE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SYNC\+\_\+\+MODE~0} - -\Hypertarget{ciot__default_8h_ab398686897078b551d637f058ec072f7}\label{ciot__default_8h_ab398686897078b551d637f058ec072f7} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_STORAGE@{CIOT\_CONFIG\_STORAGE}} -\index{CIOT\_CONFIG\_STORAGE@{CIOT\_CONFIG\_STORAGE}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_STORAGE}{CIOT\_CONFIG\_STORAGE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+STORAGE} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .type\ =\ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a5888e89d9b87b625ea64913fdbf4b9ae}{CIOT\_STORAGE\_TYPE\_FS}}\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_ac9389de4857fca429528b43c0e70bc08}\label{ciot__default_8h_ac9389de4857fca429528b43c0e70bc08} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_STORAGE\_TYPE@{CIOT\_CONFIG\_STORAGE\_TYPE}} -\index{CIOT\_CONFIG\_STORAGE\_TYPE@{CIOT\_CONFIG\_STORAGE\_TYPE}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_STORAGE\_TYPE}{CIOT\_CONFIG\_STORAGE\_TYPE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+STORAGE\+\_\+\+TYPE~\mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a5888e89d9b87b625ea64913fdbf4b9ae}{CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+FS}}} - -\Hypertarget{ciot__default_8h_ad1c730d9022fce47870a8de547c63721}\label{ciot__default_8h_ad1c730d9022fce47870a8de547c63721} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_SYS@{CIOT\_CONFIG\_SYS}} -\index{CIOT\_CONFIG\_SYS@{CIOT\_CONFIG\_SYS}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_SYS}{CIOT\_CONFIG\_SYS}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+SYS} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}\label{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_TCP@{CIOT\_CONFIG\_TCP}} -\index{CIOT\_CONFIG\_TCP@{CIOT\_CONFIG\_TCP}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_TCP}{CIOT\_CONFIG\_TCP}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+TCP} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .dhcp\ =\ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da612a799c9f8c26c1f3b9a503712bd711}{CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE}},\ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .ip\ =\ \{\mbox{\hyperlink{ciot__default_8h_a26d8ac3e34dcb0faaf41977b7dc54607}{CIOT\_CONFIG\_TCP\_IP}}\},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .gateway\ =\ \{\mbox{\hyperlink{ciot__default_8h_abc5eb2049e9aab488e1bb1846c71b481}{CIOT\_CONFIG\_TCP\_GATEWAY}}\},\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .mask\ =\ \{\mbox{\hyperlink{ciot__default_8h_ab361b51c2b4bb8324a0767a6680cab25}{CIOT\_CONFIG\_TCP\_MASK}}\},\ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .dns\ =\ \{\mbox{\hyperlink{ciot__default_8h_aa196f69c014910ca0e0f37d44b83ad30}{CIOT\_CONFIG\_TCP\_DNS}}\},\ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_abe942f163ef66924c29e63adb6e91cc3}\label{ciot__default_8h_abe942f163ef66924c29e63adb6e91cc3} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_TCP\_DHCP@{CIOT\_CONFIG\_TCP\_DHCP}} -\index{CIOT\_CONFIG\_TCP\_DHCP@{CIOT\_CONFIG\_TCP\_DHCP}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_TCP\_DHCP}{CIOT\_CONFIG\_TCP\_DHCP}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+DHCP~\mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da612a799c9f8c26c1f3b9a503712bd711}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+NO\+\_\+\+CHANGE}}} - -\Hypertarget{ciot__default_8h_aa196f69c014910ca0e0f37d44b83ad30}\label{ciot__default_8h_aa196f69c014910ca0e0f37d44b83ad30} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_TCP\_DNS@{CIOT\_CONFIG\_TCP\_DNS}} -\index{CIOT\_CONFIG\_TCP\_DNS@{CIOT\_CONFIG\_TCP\_DNS}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_TCP\_DNS}{CIOT\_CONFIG\_TCP\_DNS}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+DNS~0, 0, 0, 0} - -\Hypertarget{ciot__default_8h_abc5eb2049e9aab488e1bb1846c71b481}\label{ciot__default_8h_abc5eb2049e9aab488e1bb1846c71b481} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_TCP\_GATEWAY@{CIOT\_CONFIG\_TCP\_GATEWAY}} -\index{CIOT\_CONFIG\_TCP\_GATEWAY@{CIOT\_CONFIG\_TCP\_GATEWAY}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_TCP\_GATEWAY}{CIOT\_CONFIG\_TCP\_GATEWAY}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+GATEWAY~0, 0, 0, 0} - -\Hypertarget{ciot__default_8h_a26d8ac3e34dcb0faaf41977b7dc54607}\label{ciot__default_8h_a26d8ac3e34dcb0faaf41977b7dc54607} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_TCP\_IP@{CIOT\_CONFIG\_TCP\_IP}} -\index{CIOT\_CONFIG\_TCP\_IP@{CIOT\_CONFIG\_TCP\_IP}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_TCP\_IP}{CIOT\_CONFIG\_TCP\_IP}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+IP~0, 0, 0, 0} - -\Hypertarget{ciot__default_8h_ab361b51c2b4bb8324a0767a6680cab25}\label{ciot__default_8h_ab361b51c2b4bb8324a0767a6680cab25} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_TCP\_MASK@{CIOT\_CONFIG\_TCP\_MASK}} -\index{CIOT\_CONFIG\_TCP\_MASK@{CIOT\_CONFIG\_TCP\_MASK}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_TCP\_MASK}{CIOT\_CONFIG\_TCP\_MASK}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+TCP\+\_\+\+MASK~0, 0, 0, 0} - -\Hypertarget{ciot__default_8h_a0aa6817a5c88e8290142061b6b933252}\label{ciot__default_8h_a0aa6817a5c88e8290142061b6b933252} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART@{CIOT\_CONFIG\_UART}} -\index{CIOT\_CONFIG\_UART@{CIOT\_CONFIG\_UART}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART}{CIOT\_CONFIG\_UART}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .baud\_rate\ =\ \mbox{\hyperlink{ciot__default_8h_aae6ed2cc1f62936138b7b12cb78eab19}{CIOT\_CONFIG\_UART\_BAUD\_RATE}},\ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .num\ =\ \mbox{\hyperlink{ciot__default_8h_af9d6ddc888416ceda770bd6ba0666adf}{CIOT\_CONFIG\_UART\_NUM}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .rx\_pin\ =\ \mbox{\hyperlink{ciot__default_8h_a47a6c4735b406987793ff61a3748c356}{CIOT\_CONFIG\_UART\_RX\_PIN}},\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .tx\_pin\ =\ \mbox{\hyperlink{ciot__default_8h_afe80a6e24ff36484761b8a0740e21cd3}{CIOT\_CONFIG\_UART\_TX\_PIN}},\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .rts\_pin\ =\ \mbox{\hyperlink{ciot__default_8h_ac915c58485a09a470ab105dcd7fdb438}{CIOT\_CONFIG\_UART\_RTS\_PIN}},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .cts\_pin\ =\ \mbox{\hyperlink{ciot__default_8h_a39b5dff57834d4a9f00b09ff9d7e0586}{CIOT\_CONFIG\_UART\_CTS\_PIN}},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .flow\_control\ =\ \mbox{\hyperlink{ciot__default_8h_a0b574bd3271269a00ef9a3364564a650}{CIOT\_CONFIG\_UART\_FLOW\_CONTROL}},\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .parity\ =\ \mbox{\hyperlink{ciot__default_8h_ad5a0b532b36ce2e64548273d4694de52}{CIOT\_CONFIG\_UART\_PARITY}},\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .dtr\ =\ \mbox{\hyperlink{ciot__default_8h_a5e191db9399c301be511e6024b2f402d}{CIOT\_CONFIG\_UART\_DTR}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .bridge\_mode\ =\ \mbox{\hyperlink{ciot__default_8h_ac64f70fbc40557ffc7f0f6c9d4aed430}{CIOT\_CONFIG\_UART\_BRIDGE\_MODE}},\ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_aae6ed2cc1f62936138b7b12cb78eab19}\label{ciot__default_8h_aae6ed2cc1f62936138b7b12cb78eab19} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_BAUD\_RATE@{CIOT\_CONFIG\_UART\_BAUD\_RATE}} -\index{CIOT\_CONFIG\_UART\_BAUD\_RATE@{CIOT\_CONFIG\_UART\_BAUD\_RATE}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_BAUD\_RATE}{CIOT\_CONFIG\_UART\_BAUD\_RATE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+BAUD\+\_\+\+RATE~115200} - -\Hypertarget{ciot__default_8h_ac64f70fbc40557ffc7f0f6c9d4aed430}\label{ciot__default_8h_ac64f70fbc40557ffc7f0f6c9d4aed430} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_BRIDGE\_MODE@{CIOT\_CONFIG\_UART\_BRIDGE\_MODE}} -\index{CIOT\_CONFIG\_UART\_BRIDGE\_MODE@{CIOT\_CONFIG\_UART\_BRIDGE\_MODE}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_BRIDGE\_MODE}{CIOT\_CONFIG\_UART\_BRIDGE\_MODE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+BRIDGE\+\_\+\+MODE~0} - -\Hypertarget{ciot__default_8h_a39b5dff57834d4a9f00b09ff9d7e0586}\label{ciot__default_8h_a39b5dff57834d4a9f00b09ff9d7e0586} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_CTS\_PIN@{CIOT\_CONFIG\_UART\_CTS\_PIN}} -\index{CIOT\_CONFIG\_UART\_CTS\_PIN@{CIOT\_CONFIG\_UART\_CTS\_PIN}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_CTS\_PIN}{CIOT\_CONFIG\_UART\_CTS\_PIN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+CTS\+\_\+\+PIN~0} - -\Hypertarget{ciot__default_8h_a5e191db9399c301be511e6024b2f402d}\label{ciot__default_8h_a5e191db9399c301be511e6024b2f402d} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_DTR@{CIOT\_CONFIG\_UART\_DTR}} -\index{CIOT\_CONFIG\_UART\_DTR@{CIOT\_CONFIG\_UART\_DTR}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_DTR}{CIOT\_CONFIG\_UART\_DTR}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+DTR~0} - -\Hypertarget{ciot__default_8h_a0b574bd3271269a00ef9a3364564a650}\label{ciot__default_8h_a0b574bd3271269a00ef9a3364564a650} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_FLOW\_CONTROL@{CIOT\_CONFIG\_UART\_FLOW\_CONTROL}} -\index{CIOT\_CONFIG\_UART\_FLOW\_CONTROL@{CIOT\_CONFIG\_UART\_FLOW\_CONTROL}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_FLOW\_CONTROL}{CIOT\_CONFIG\_UART\_FLOW\_CONTROL}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+FLOW\+\_\+\+CONTROL~0} - -\Hypertarget{ciot__default_8h_af9d6ddc888416ceda770bd6ba0666adf}\label{ciot__default_8h_af9d6ddc888416ceda770bd6ba0666adf} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_NUM@{CIOT\_CONFIG\_UART\_NUM}} -\index{CIOT\_CONFIG\_UART\_NUM@{CIOT\_CONFIG\_UART\_NUM}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_NUM}{CIOT\_CONFIG\_UART\_NUM}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+NUM~0} - -\Hypertarget{ciot__default_8h_ad5a0b532b36ce2e64548273d4694de52}\label{ciot__default_8h_ad5a0b532b36ce2e64548273d4694de52} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_PARITY@{CIOT\_CONFIG\_UART\_PARITY}} -\index{CIOT\_CONFIG\_UART\_PARITY@{CIOT\_CONFIG\_UART\_PARITY}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_PARITY}{CIOT\_CONFIG\_UART\_PARITY}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+PARITY~0} - -\Hypertarget{ciot__default_8h_ac915c58485a09a470ab105dcd7fdb438}\label{ciot__default_8h_ac915c58485a09a470ab105dcd7fdb438} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_RTS\_PIN@{CIOT\_CONFIG\_UART\_RTS\_PIN}} -\index{CIOT\_CONFIG\_UART\_RTS\_PIN@{CIOT\_CONFIG\_UART\_RTS\_PIN}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_RTS\_PIN}{CIOT\_CONFIG\_UART\_RTS\_PIN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+RTS\+\_\+\+PIN~0} - -\Hypertarget{ciot__default_8h_a47a6c4735b406987793ff61a3748c356}\label{ciot__default_8h_a47a6c4735b406987793ff61a3748c356} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_RX\_PIN@{CIOT\_CONFIG\_UART\_RX\_PIN}} -\index{CIOT\_CONFIG\_UART\_RX\_PIN@{CIOT\_CONFIG\_UART\_RX\_PIN}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_RX\_PIN}{CIOT\_CONFIG\_UART\_RX\_PIN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+RX\+\_\+\+PIN~0} - -\Hypertarget{ciot__default_8h_afe80a6e24ff36484761b8a0740e21cd3}\label{ciot__default_8h_afe80a6e24ff36484761b8a0740e21cd3} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_UART\_TX\_PIN@{CIOT\_CONFIG\_UART\_TX\_PIN}} -\index{CIOT\_CONFIG\_UART\_TX\_PIN@{CIOT\_CONFIG\_UART\_TX\_PIN}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_TX\_PIN}{CIOT\_CONFIG\_UART\_TX\_PIN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TX\+\_\+\+PIN~0} - -\Hypertarget{ciot__default_8h_a27de0c03a642d79eb31e712994646733}\label{ciot__default_8h_a27de0c03a642d79eb31e712994646733} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_AP@{CIOT\_CONFIG\_WIFI\_AP}} -\index{CIOT\_CONFIG\_WIFI\_AP@{CIOT\_CONFIG\_WIFI\_AP}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_AP}{CIOT\_CONFIG\_WIFI\_AP}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .ssid\ =\ \mbox{\hyperlink{ciot__default_8h_a7f79abe5ea5f7e3260843192069bdcaa}{CIOT\_CONFIG\_WIFI\_AP\_SSID}},\ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .password\ =\ \mbox{\hyperlink{ciot__default_8h_afdccac291d2c1de6425402fec83189cf}{CIOT\_CONFIG\_WIFI\_AP\_PASSWORD}},\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .tcp\ =\ \mbox{\hyperlink{ciot__default_8h_a82cca16f86e1276f9a325ebbd1ec5d68}{CIOT\_CONFIG\_WIFI\_AP\_TCP}},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .type\ =\ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa7bfdef61a443d4e6f7e5b96acfade2fa}{CIOT\_WIFI\_IF\_AP}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_afdccac291d2c1de6425402fec83189cf}\label{ciot__default_8h_afdccac291d2c1de6425402fec83189cf} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_AP\_PASSWORD@{CIOT\_CONFIG\_WIFI\_AP\_PASSWORD}} -\index{CIOT\_CONFIG\_WIFI\_AP\_PASSWORD@{CIOT\_CONFIG\_WIFI\_AP\_PASSWORD}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_AP\_PASSWORD}{CIOT\_CONFIG\_WIFI\_AP\_PASSWORD}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+PASSWORD~"{}administrator"{}} - -\Hypertarget{ciot__default_8h_a7f79abe5ea5f7e3260843192069bdcaa}\label{ciot__default_8h_a7f79abe5ea5f7e3260843192069bdcaa} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_AP\_SSID@{CIOT\_CONFIG\_WIFI\_AP\_SSID}} -\index{CIOT\_CONFIG\_WIFI\_AP\_SSID@{CIOT\_CONFIG\_WIFI\_AP\_SSID}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_AP\_SSID}{CIOT\_CONFIG\_WIFI\_AP\_SSID}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+SSID~"{}Ciot AP"{}} - -\Hypertarget{ciot__default_8h_a82cca16f86e1276f9a325ebbd1ec5d68}\label{ciot__default_8h_a82cca16f86e1276f9a325ebbd1ec5d68} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_AP\_TCP@{CIOT\_CONFIG\_WIFI\_AP\_TCP}} -\index{CIOT\_CONFIG\_WIFI\_AP\_TCP@{CIOT\_CONFIG\_WIFI\_AP\_TCP}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_AP\_TCP}{CIOT\_CONFIG\_WIFI\_AP\_TCP}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+TCP~\mbox{\hyperlink{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP}}} - -\Hypertarget{ciot__default_8h_a7c09f75e4ebc749a5c225c760c2befde}\label{ciot__default_8h_a7c09f75e4ebc749a5c225c760c2befde} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_STA@{CIOT\_CONFIG\_WIFI\_STA}} -\index{CIOT\_CONFIG\_WIFI\_STA@{CIOT\_CONFIG\_WIFI\_STA}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_STA}{CIOT\_CONFIG\_WIFI\_STA}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .ssid\ =\ \mbox{\hyperlink{ciot__default_8h_a69173d99aec57142ba91edc18300f781}{CIOT\_CONFIG\_WIFI\_STA\_SSID}},\ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .password\ =\ \mbox{\hyperlink{ciot__default_8h_a89cc8bb6906a26e085cd6d79e881717f}{CIOT\_CONFIG\_WIFI\_STA\_PASSWORD}},\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .tcp\ =\ \mbox{\hyperlink{ciot__default_8h_a195751f0292e7d1046fa7a4b08e5fc23}{CIOT\_CONFIG\_WIFI\_STA\_TCP}},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .type\ =\ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa22577cd2b8c579f221be06f275674e60}{CIOT\_WIFI\_IF\_STA}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_a89cc8bb6906a26e085cd6d79e881717f}\label{ciot__default_8h_a89cc8bb6906a26e085cd6d79e881717f} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_STA\_PASSWORD@{CIOT\_CONFIG\_WIFI\_STA\_PASSWORD}} -\index{CIOT\_CONFIG\_WIFI\_STA\_PASSWORD@{CIOT\_CONFIG\_WIFI\_STA\_PASSWORD}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_STA\_PASSWORD}{CIOT\_CONFIG\_WIFI\_STA\_PASSWORD}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA\+\_\+\+PASSWORD~"{}administrator"{}} - -\Hypertarget{ciot__default_8h_a69173d99aec57142ba91edc18300f781}\label{ciot__default_8h_a69173d99aec57142ba91edc18300f781} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_STA\_SSID@{CIOT\_CONFIG\_WIFI\_STA\_SSID}} -\index{CIOT\_CONFIG\_WIFI\_STA\_SSID@{CIOT\_CONFIG\_WIFI\_STA\_SSID}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_STA\_SSID}{CIOT\_CONFIG\_WIFI\_STA\_SSID}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA\+\_\+\+SSID~"{}Ciot STA"{}} - -\Hypertarget{ciot__default_8h_a195751f0292e7d1046fa7a4b08e5fc23}\label{ciot__default_8h_a195751f0292e7d1046fa7a4b08e5fc23} -\index{ciot\_default.h@{ciot\_default.h}!CIOT\_CONFIG\_WIFI\_STA\_TCP@{CIOT\_CONFIG\_WIFI\_STA\_TCP}} -\index{CIOT\_CONFIG\_WIFI\_STA\_TCP@{CIOT\_CONFIG\_WIFI\_STA\_TCP}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_STA\_TCP}{CIOT\_CONFIG\_WIFI\_STA\_TCP}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+STA\+\_\+\+TCP~\mbox{\hyperlink{ciot__default_8h_a59fb15004027f7b6a0be6bda1b0568b1}{CIOT\+\_\+\+CONFIG\+\_\+\+TCP}}} - -\Hypertarget{ciot__default_8h_a86eea122295995d6664aae9037c34a1d}\label{ciot__default_8h_a86eea122295995d6664aae9037c34a1d} -\index{ciot\_default.h@{ciot\_default.h}!HG\_TCP\_CONFIG\_HTTPS@{HG\_TCP\_CONFIG\_HTTPS}} -\index{HG\_TCP\_CONFIG\_HTTPS@{HG\_TCP\_CONFIG\_HTTPS}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{HG\_TCP\_CONFIG\_HTTPS}{HG\_TCP\_CONFIG\_HTTPS}} -{\footnotesize\ttfamily \#define HG\+\_\+\+TCP\+\_\+\+CONFIG\+\_\+\+HTTPS} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .address\ =\ HG\_TCP\_CONFIG\_HTTPS\_ADDRESS,\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .route\ =\ HG\_TCP\_CONFIG\_HTTPS\_ROUTE,\ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .port\ =\ HG\_TCP\_CONFIG\_HTTPS\_PORT,\ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_a132bac5d5f62fa38121a52690971284c}\label{ciot__default_8h_a132bac5d5f62fa38121a52690971284c} -\index{ciot\_default.h@{ciot\_default.h}!HG\_TCP\_CONFIG\_MQTTC@{HG\_TCP\_CONFIG\_MQTTC}} -\index{HG\_TCP\_CONFIG\_MQTTC@{HG\_TCP\_CONFIG\_MQTTC}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{HG\_TCP\_CONFIG\_MQTTC}{HG\_TCP\_CONFIG\_MQTTC}} -{\footnotesize\ttfamily \#define HG\+\_\+\+TCP\+\_\+\+CONFIG\+\_\+\+MQTTC} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .url\ =\ \mbox{\hyperlink{ciot__default_8h_a3ae1f5c8551422aca407ba0e0d7d051a}{CIOT\_CONFIG\_MQTTC\_URL}},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .port\ =\ \mbox{\hyperlink{ciot__default_8h_a04e894147896f6ba01229a76c6c1f976}{CIOT\_CONFIG\_MQTTC\_PORT}},\ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .qos\ =\ \mbox{\hyperlink{ciot__default_8h_a66e76a6c3a0b20620bee393047c462e6}{CIOT\_CONFIG\_MQTTC\_QOS}},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .topics\ =\ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ .b2d\ =\ \mbox{\hyperlink{ciot__default_8h_a0dad743975d309bddcfe83e7db9f4c43}{CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D}},\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ .d2b\ =\ \mbox{\hyperlink{ciot__default_8h_a9835f697325cb7920259cad52e13b0a1}{CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B}},\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} -\Hypertarget{ciot__default_8h_a030e60462692de23e6989b3b23d894eb}\label{ciot__default_8h_a030e60462692de23e6989b3b23d894eb} -\index{ciot\_default.h@{ciot\_default.h}!HG\_TCP\_CONFIG\_NTP@{HG\_TCP\_CONFIG\_NTP}} -\index{HG\_TCP\_CONFIG\_NTP@{HG\_TCP\_CONFIG\_NTP}!ciot\_default.h@{ciot\_default.h}} -\doxysubsubsection{\texorpdfstring{HG\_TCP\_CONFIG\_NTP}{HG\_TCP\_CONFIG\_NTP}} -{\footnotesize\ttfamily \#define HG\+\_\+\+TCP\+\_\+\+CONFIG\+\_\+\+NTP} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .op\_mode\ =\ HG\_TCP\_CONFIG\_NTP\_OP\_MODE,\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .sync\_mode\ =\ HG\_TCP\_CONFIG\_NTP\_SYNC\_MODE,\ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .sync\_interval\ =\ HG\_TCP\_CONFIG\_NTP\_SYNC\_INTERVAL,\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ .server\ =\ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \{\mbox{\hyperlink{ciot__default_8h_ad52d4acc5014fec93b596267a4267489}{CIOT\_CONFIG\_NTP\_SERVER1}}\},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \{\mbox{\hyperlink{ciot__default_8h_a7e2f6267fdbe83b93e2220a3733f9774}{CIOT\_CONFIG\_NTP\_SERVER2}}\},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \{\mbox{\hyperlink{ciot__default_8h_ade7f6e32e02db936bfd97768500c7c74}{CIOT\_CONFIG\_NTP\_SERVER3}}\}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}} - -\end{DoxyCode} diff --git a/docs/latex/ciot__default_8h_source.tex b/docs/latex/ciot__default_8h_source.tex deleted file mode 100644 index c03eb05..0000000 --- a/docs/latex/ciot__default_8h_source.tex +++ /dev/null @@ -1,151 +0,0 @@ -\doxysection{ciot\+\_\+default.\+h} -\hypertarget{ciot__default_8h_source}{}\label{ciot__default_8h_source}\index{include/ciot\_default.h@{include/ciot\_default.h}} -\mbox{\hyperlink{ciot__default_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_DEFAULT\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_DEFAULT\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_STORAGE\_TYPE\ CIOT\_STORAGE\_TYPE\_FS}} -\DoxyCodeLine{00014\ } -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_BAUD\_RATE\ 115200}} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_NUM\ 0}} -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_RX\_PIN\ 0}} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_TX\_PIN\ 0}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_RTS\_PIN\ 0}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_CTS\_PIN\ 0}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_FLOW\_CONTROL\ 0}} -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_PARITY\ 0}} -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_DTR\ 0}} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_BRIDGE\_MODE\ 0}} -\DoxyCodeLine{00025\ } -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_TCP\_DHCP\ CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_TCP\_IP\ 0,\ 0,\ 0,\ 0}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_TCP\_GATEWAY\ 0,\ 0,\ 0,\ 0}} -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_TCP\_MASK\ 0,\ 0,\ 0,\ 0}} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_TCP\_DNS\ 0,\ 0,\ 0,\ 0}} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_AP\_SSID\ "{}Ciot\ AP"{}}} -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_AP\_PASSWORD\ "{}administrator"{}}} -\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_AP\_TCP\ CIOT\_CONFIG\_TCP}} -\DoxyCodeLine{00035\ } -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_STA\_SSID\ "{}Ciot\ STA"{}}} -\DoxyCodeLine{00037\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_STA\_PASSWORD\ "{}administrator"{}}} -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_STA\_TCP\ CIOT\_CONFIG\_TCP}} -\DoxyCodeLine{00039\ } -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_ETH\ CIOT\_CONFIG\_TCP}} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_OP\_MODE\ 0}} -\DoxyCodeLine{00043\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_SYNC\_MODE\ 0}} -\DoxyCodeLine{00044\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_SYNC\_INTERVAL\ 0}} -\DoxyCodeLine{00045\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_SERVERS\_COUNT\ 3}} -\DoxyCodeLine{00046\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_SERVER1\ "{}pool.ntp.org"{}}} -\DoxyCodeLine{00047\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_SERVER2\ "{}time.google.com"{}}} -\DoxyCodeLine{00048\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_SERVER3\ "{}gps.ntp.br"{}}} -\DoxyCodeLine{00049\ } -\DoxyCodeLine{00050\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPC\_URL\ "{}http://127.0.0.1:8080/v1/ciot"{}}} -\DoxyCodeLine{00051\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPC\_TRANSPORT\ CIOT\_HTTPC\_TRANSPORT\_TCP}} -\DoxyCodeLine{00052\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPC\_METHOD\ CIOT\_HTTPC\_METHOD\_POST}} -\DoxyCodeLine{00053\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPC\_TIMEOUT\ 20000}} -\DoxyCodeLine{00054\ } -\DoxyCodeLine{00055\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPS\_ADDRESS\ "{}http://127.0.0.1"{}}} -\DoxyCodeLine{00056\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPS\_ROUTE\ "{}/v1/ciot"{}}} -\DoxyCodeLine{00057\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPS\_PORT\ 8080}} -\DoxyCodeLine{00058\ } -\DoxyCodeLine{00059\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTTC\_URL\ "{}mqtt://test.mosquitto.org"{}}} -\DoxyCodeLine{00060\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTTC\_PORT\ 1883}} -\DoxyCodeLine{00061\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTTC\_QOS\ 0}} -\DoxyCodeLine{00062\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTTC\_USER\ "{}"{}}} -\DoxyCodeLine{00063\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTTC\_PASS\ "{}"{}}} -\DoxyCodeLine{00064\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B\ "{}v1/ciot/d2b"{}}} -\DoxyCodeLine{00065\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D\ "{}v1/ciot/b2d"{}}} -\DoxyCodeLine{00066\ } -\DoxyCodeLine{00067\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_SYS\ \(\backslash\)}} -\DoxyCodeLine{00068\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00069\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00070\ } -\DoxyCodeLine{00071\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_STORAGE\ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00072\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00073\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .type\ =\ CIOT\_STORAGE\_TYPE\_FS\ \(\backslash\)}} -\DoxyCodeLine{00074\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00075\ } -\DoxyCodeLine{00076\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00077\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00078\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .baud\_rate\ =\ CIOT\_CONFIG\_UART\_BAUD\_RATE,\ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00079\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .num\ =\ CIOT\_CONFIG\_UART\_NUM,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00080\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .rx\_pin\ =\ CIOT\_CONFIG\_UART\_RX\_PIN,\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00081\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .tx\_pin\ =\ CIOT\_CONFIG\_UART\_TX\_PIN,\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00082\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .rts\_pin\ =\ CIOT\_CONFIG\_UART\_RTS\_PIN,\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00083\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .cts\_pin\ =\ CIOT\_CONFIG\_UART\_CTS\_PIN,\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00084\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .flow\_control\ =\ CIOT\_CONFIG\_UART\_FLOW\_CONTROL,\ \(\backslash\)}} -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .parity\ =\ CIOT\_CONFIG\_UART\_PARITY,\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00086\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .dtr\ =\ CIOT\_CONFIG\_UART\_DTR,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00087\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .bridge\_mode\ =\ CIOT\_CONFIG\_UART\_BRIDGE\_MODE,\ \ \ \(\backslash\)}} -\DoxyCodeLine{00088\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00089\ } -\DoxyCodeLine{00090\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_TCP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00091\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00092\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .dhcp\ =\ CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE,\ \ \(\backslash\)}} -\DoxyCodeLine{00093\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .ip\ =\ \{CIOT\_CONFIG\_TCP\_IP\},\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00094\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .gateway\ =\ \{CIOT\_CONFIG\_TCP\_GATEWAY\},\ \(\backslash\)}} -\DoxyCodeLine{00095\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .mask\ =\ \{CIOT\_CONFIG\_TCP\_MASK\},\ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00096\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .dns\ =\ \{CIOT\_CONFIG\_TCP\_DNS\},\ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00097\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00098\ } -\DoxyCodeLine{00099\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_AP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00100\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00101\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .ssid\ =\ CIOT\_CONFIG\_WIFI\_AP\_SSID,\ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00102\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .password\ =\ CIOT\_CONFIG\_WIFI\_AP\_PASSWORD,\ \(\backslash\)}} -\DoxyCodeLine{00103\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .tcp\ =\ CIOT\_CONFIG\_WIFI\_AP\_TCP,\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00104\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .type\ =\ CIOT\_WIFI\_IF\_AP,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00105\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00106\ } -\DoxyCodeLine{00107\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_STA\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00108\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00109\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .ssid\ =\ CIOT\_CONFIG\_WIFI\_STA\_SSID,\ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00110\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .password\ =\ CIOT\_CONFIG\_WIFI\_STA\_PASSWORD,\ \(\backslash\)}} -\DoxyCodeLine{00111\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .tcp\ =\ CIOT\_CONFIG\_WIFI\_STA\_TCP,\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00112\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .type\ =\ CIOT\_WIFI\_IF\_STA,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00113\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00114\ } -\DoxyCodeLine{00115\ \textcolor{preprocessor}{\#define\ HG\_TCP\_CONFIG\_NTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00116\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00117\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .op\_mode\ =\ HG\_TCP\_CONFIG\_NTP\_OP\_MODE,\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00118\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .sync\_mode\ =\ HG\_TCP\_CONFIG\_NTP\_SYNC\_MODE,\ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00119\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .sync\_interval\ =\ HG\_TCP\_CONFIG\_NTP\_SYNC\_INTERVAL,\ \(\backslash\)}} -\DoxyCodeLine{00120\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .server\ =\ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00121\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \{CIOT\_CONFIG\_NTP\_SERVER1\},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00122\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \{CIOT\_CONFIG\_NTP\_SERVER2\},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00123\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \{CIOT\_CONFIG\_NTP\_SERVER3\}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00124\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00125\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00126\ } -\DoxyCodeLine{00127\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_HTTPC\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00128\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00129\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .url\ =\ CIOT\_CONFIG\_HTTPC\_URL,\ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00130\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .method\ =\ CIOT\_CONFIG\_HTTPC\_METHOD,\ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00131\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .transport\ =\ CIOT\_CONFIG\_HTTPC\_TRANSPORT,\ \(\backslash\)}} -\DoxyCodeLine{00132\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .timeout\ =\ CIOT\_CONFIG\_HTTPC\_TIMEOUT,\ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00133\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00134\ } -\DoxyCodeLine{00135\ \textcolor{preprocessor}{\#define\ HG\_TCP\_CONFIG\_HTTPS\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00136\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00137\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .address\ =\ HG\_TCP\_CONFIG\_HTTPS\_ADDRESS,\ \(\backslash\)}} -\DoxyCodeLine{00138\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .route\ =\ HG\_TCP\_CONFIG\_HTTPS\_ROUTE,\ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00139\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .port\ =\ HG\_TCP\_CONFIG\_HTTPS\_PORT,\ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00140\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00141\ } -\DoxyCodeLine{00142\ \textcolor{preprocessor}{\#define\ HG\_TCP\_CONFIG\_MQTTC\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00143\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00144\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .url\ =\ CIOT\_CONFIG\_MQTTC\_URL,\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00145\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .port\ =\ CIOT\_CONFIG\_MQTTC\_PORT,\ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00146\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .qos\ =\ CIOT\_CONFIG\_MQTTC\_QOS,\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00147\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ .topics\ =\ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00148\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ .b2d\ =\ CIOT\_CONFIG\_MQTTC\_TOPIC\_B2D,\ \(\backslash\)}} -\DoxyCodeLine{00149\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ .d2b\ =\ CIOT\_CONFIG\_MQTTC\_TOPIC\_D2B,\ \(\backslash\)}} -\DoxyCodeLine{00150\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00151\ \textcolor{preprocessor}{\ \ \ \ \}}} -\DoxyCodeLine{00152\ } -\DoxyCodeLine{00153\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__dfu_8h.tex b/docs/latex/ciot__dfu_8h.tex deleted file mode 100644 index a0e7baf..0000000 --- a/docs/latex/ciot__dfu_8h.tex +++ /dev/null @@ -1,217 +0,0 @@ -\doxysection{include/ciot\+\_\+dfu.h File Reference} -\hypertarget{ciot__dfu_8h}{}\label{ciot__dfu_8h}\index{include/ciot\_dfu.h@{include/ciot\_dfu.h}} - - -Header file for Device Firmware Update (DFU) functionality in CIOT library. - - -{\ttfamily \#include "{}types/ciot\+\_\+dfu\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__dfu__status__msg__t}{ciot\+\_\+dfu\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Struct for DFU status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+dfu \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} -\item -typedef enum \mbox{\hyperlink{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379fa}{ciot\+\_\+dfu\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__dfu_8h_a05b6b5e8d94559756412865daf115077}{ciot\+\_\+dfu\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumerates DFU event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379fa}{ciot\+\_\+dfu\+\_\+event\+\_\+id}} \{ \mbox{\hyperlink{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379faa120fde02407033deee0ab692a65a7902}{CIOT\+\_\+\+DFU\+\_\+\+EVENT\+\_\+\+STATE\+\_\+\+CHANGED}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM - \} -\begin{DoxyCompactList}\small\item\em Enumerates DFU event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} \mbox{\hyperlink{ciot__dfu_8h_a6552eb94e759a22b9fd3e3da8ed1d755}{ciot\+\_\+dfu\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Creates a new CIOT DFU object. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__dfu_8h_ab157cc81dbd5e4045ac42b087f200b56}{ciot\+\_\+dfu\+\_\+start}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self, \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Starts the DFU process. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__dfu_8h_af686f43068829e48ff6ca2455a8b1f05}{ciot\+\_\+dfu\+\_\+stop}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stops the DFU process. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__dfu_8h_ad40861d034c57576a1bf3aaa3fbc2d9b}{ciot\+\_\+dfu\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self, \mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Processes a DFU request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__dfu_8h_a586e31131b7ab4e0acb3df32122a4564}{ciot\+\_\+dfu\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Sends data during the DFU process. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__dfu_8h_a519f6db211ff754385aba2d45cfb3a28}{ciot\+\_\+dfu\+\_\+task}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Performs the DFU task. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for Device Firmware Update (DFU) functionality in CIOT library. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/03-\/20 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__dfu_8h_a05b6b5e8d94559756412865daf115077}\label{ciot__dfu_8h_a05b6b5e8d94559756412865daf115077} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_event\_id\_t@{ciot\_dfu\_event\_id\_t}} -\index{ciot\_dfu\_event\_id\_t@{ciot\_dfu\_event\_id\_t}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_event\_id\_t}{ciot\_dfu\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379fa}{ciot\+\_\+dfu\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__dfu_8h_a05b6b5e8d94559756412865daf115077}{ciot\+\_\+dfu\+\_\+event\+\_\+id\+\_\+t}}} - - - -Enumerates DFU event IDs. - -\Hypertarget{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}\label{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_t@{ciot\_dfu\_t}} -\index{ciot\_dfu\_t@{ciot\_dfu\_t}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_t}{ciot\_dfu\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+dfu\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}} - -Opaque pointer to a CIOT DFU object. - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379fa}\label{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379fa} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_event\_id@{ciot\_dfu\_event\_id}} -\index{ciot\_dfu\_event\_id@{ciot\_dfu\_event\_id}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_event\_id}{ciot\_dfu\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379fa}{ciot\+\_\+dfu\+\_\+event\+\_\+id}}} - - - -Enumerates DFU event IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_EVENT\_STATE\_CHANGED@{CIOT\_DFU\_EVENT\_STATE\_CHANGED}!ciot\_dfu.h@{ciot\_dfu.h}}\index{ciot\_dfu.h@{ciot\_dfu.h}!CIOT\_DFU\_EVENT\_STATE\_CHANGED@{CIOT\_DFU\_EVENT\_STATE\_CHANGED}}}\Hypertarget{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379faa120fde02407033deee0ab692a65a7902}\label{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379faa120fde02407033deee0ab692a65a7902} -CIOT\+\_\+\+DFU\+\_\+\+EVENT\+\_\+\+STATE\+\_\+\+CHANGED&DFU state changed event. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__dfu_8h_a6552eb94e759a22b9fd3e3da8ed1d755}\label{ciot__dfu_8h_a6552eb94e759a22b9fd3e3da8ed1d755} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_new@{ciot\_dfu\_new}} -\index{ciot\_dfu\_new@{ciot\_dfu\_new}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_new()}{ciot\_dfu\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} ciot\+\_\+dfu\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Creates a new CIOT DFU object. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the created DFU object. -\end{DoxyReturn} -\Hypertarget{ciot__dfu_8h_ad40861d034c57576a1bf3aaa3fbc2d9b}\label{ciot__dfu_8h_ad40861d034c57576a1bf3aaa3fbc2d9b} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_process\_req@{ciot\_dfu\_process\_req}} -\index{ciot\_dfu\_process\_req@{ciot\_dfu\_process\_req}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_process\_req()}{ciot\_dfu\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+dfu\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Processes a DFU request. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the DFU object. \\ -\hline -{\em req} & Pointer to the DFU request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__dfu_8h_a586e31131b7ab4e0acb3df32122a4564}\label{ciot__dfu_8h_a586e31131b7ab4e0acb3df32122a4564} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_send\_data@{ciot\_dfu\_send\_data}} -\index{ciot\_dfu\_send\_data@{ciot\_dfu\_send\_data}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_send\_data()}{ciot\_dfu\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+dfu\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends data during the DFU process. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the DFU object. \\ -\hline -{\em data} & Pointer to the data to be sent. \\ -\hline -{\em size} & Size of the data to be sent. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__dfu_8h_ab157cc81dbd5e4045ac42b087f200b56}\label{ciot__dfu_8h_ab157cc81dbd5e4045ac42b087f200b56} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_start@{ciot\_dfu\_start}} -\index{ciot\_dfu\_start@{ciot\_dfu\_start}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_start()}{ciot\_dfu\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+dfu\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Starts the DFU process. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the DFU object. \\ -\hline -{\em cfg} & Pointer to the DFU configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__dfu_8h_af686f43068829e48ff6ca2455a8b1f05}\label{ciot__dfu_8h_af686f43068829e48ff6ca2455a8b1f05} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_stop@{ciot\_dfu\_stop}} -\index{ciot\_dfu\_stop@{ciot\_dfu\_stop}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_stop()}{ciot\_dfu\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+dfu\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stops the DFU process. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the DFU object. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__dfu_8h_a519f6db211ff754385aba2d45cfb3a28}\label{ciot__dfu_8h_a519f6db211ff754385aba2d45cfb3a28} -\index{ciot\_dfu.h@{ciot\_dfu.h}!ciot\_dfu\_task@{ciot\_dfu\_task}} -\index{ciot\_dfu\_task@{ciot\_dfu\_task}!ciot\_dfu.h@{ciot\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_task()}{ciot\_dfu\_task()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+dfu\+\_\+task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Performs the DFU task. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the DFU object. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating the status of the operation. -\end{DoxyReturn} diff --git a/docs/latex/ciot__dfu_8h_source.tex b/docs/latex/ciot__dfu_8h_source.tex deleted file mode 100644 index a0ffb02..0000000 --- a/docs/latex/ciot__dfu_8h_source.tex +++ /dev/null @@ -1,45 +0,0 @@ -\doxysection{ciot\+\_\+dfu.\+h} -\hypertarget{ciot__dfu_8h_source}{}\label{ciot__dfu_8h_source}\index{include/ciot\_dfu.h@{include/ciot\_dfu.h}} -\mbox{\hyperlink{ciot__dfu_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_DFU\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_DFU\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__dfu__types_8h}{types/ciot\_dfu\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00022\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_dfu\ *\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}};\ } -\DoxyCodeLine{00027\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379fa}{ciot\_dfu\_event\_id}}\ \{} -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__dfu_8h_a20fffb74034c28e3c7f56b2466d379faa120fde02407033deee0ab692a65a7902}{CIOT\_DFU\_EVENT\_STATE\_CHANGED}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00029\ \}\ \mbox{\hyperlink{ciot__dfu_8h_a05b6b5e8d94559756412865daf115077}{ciot\_dfu\_event\_id\_t}};} -\DoxyCodeLine{00030\ } -\DoxyCodeLine{00034\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__dfu__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{structciot__dfu__status__t}{ciot\_dfu\_status\_t}}\ \mbox{\hyperlink{structciot__dfu__status__msg__t_a9fb48f785812375d586c71a02b453e64}{status}};\ } -\DoxyCodeLine{00037\ \}\ \mbox{\hyperlink{structciot__dfu__status__msg__t}{ciot\_dfu\_status\_msg\_t}};} -\DoxyCodeLine{00038\ } -\DoxyCodeLine{00044\ \mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ \mbox{\hyperlink{ciot__dfu_8h_a6552eb94e759a22b9fd3e3da8ed1d755}{ciot\_dfu\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00045\ } -\DoxyCodeLine{00052\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__dfu_8h_ab157cc81dbd5e4045ac42b087f200b56}{ciot\_dfu\_start}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self,\ \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\_dfu\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00053\ } -\DoxyCodeLine{00059\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__dfu_8h_af686f43068829e48ff6ca2455a8b1f05}{ciot\_dfu\_stop}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self);} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00067\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__dfu_8h_ad40861d034c57576a1bf3aaa3fbc2d9b}{ciot\_dfu\_process\_req}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self,\ \mbox{\hyperlink{structciot__dfu__req__t}{ciot\_dfu\_req\_t}}\ *req);} -\DoxyCodeLine{00068\ } -\DoxyCodeLine{00076\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__dfu_8h_a586e31131b7ab4e0acb3df32122a4564}{ciot\_dfu\_send\_data}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00077\ } -\DoxyCodeLine{00083\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__dfu_8h_a519f6db211ff754385aba2d45cfb3a28}{ciot\_dfu\_task}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self);} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00086\ \}} -\DoxyCodeLine{00087\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00088\ } -\DoxyCodeLine{00089\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__dfu__types_8h.tex b/docs/latex/ciot__dfu__types_8h.tex deleted file mode 100644 index 5a7549d..0000000 --- a/docs/latex/ciot__dfu__types_8h.tex +++ /dev/null @@ -1,136 +0,0 @@ -\doxysection{include/types/ciot\+\_\+dfu\+\_\+types.h File Reference} -\hypertarget{ciot__dfu__types_8h}{}\label{ciot__dfu__types_8h}\index{include/types/ciot\_dfu\_types.h@{include/types/ciot\_dfu\_types.h}} - - -Defines data types and structures for CIOT DFU (Device Firmware Update). - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT DFU configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__dfu__status__t}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT DFU status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__dfu__req__data__u}{ciot\+\_\+dfu\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT DFU request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT DFU request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__dfu__data__u}{ciot\+\_\+dfu\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT DFU data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365}{ciot\+\_\+dfu\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2d35a9f74e70953aa9f9da44bb47aa16}{CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a19824e532f98744f29b7242935287903}{CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2db1f86f2ada419de201e3e4962cab1b}{CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+IN\+\_\+\+PROGRESS}} -, \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a393d8a9161cf6ac9b5c6f20a31a46ed9}{CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+COMPLETED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT DFU states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572}{ciot\+\_\+dfu\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a5f70da81c47429d85820f89a4c161485}{CIOT\+\_\+\+DFU\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a36e2397f2b518b59d8ee9b8d5dada729}{CIOT\+\_\+\+DFU\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+FIRMWARE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT DFU request types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a}{ciot\+\_\+dfu\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaf4c3b89af87b4b26c1de07a3c4e2107a}{CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa7ce5cb795ab9be3288e458a5d3afa7fe}{CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+UART}} -, \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa6444ac136a4260d6e2c009d4ca5324be}{CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+USB}} -, \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaa0b6b28f6e7d624adbf2a93286ff2892}{CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+BLE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT DFU types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT DFU (Device Firmware Update). - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572}\label{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572} -\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!ciot\_dfu\_req\_type\_t@{ciot\_dfu\_req\_type\_t}} -\index{ciot\_dfu\_req\_type\_t@{ciot\_dfu\_req\_type\_t}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_req\_type\_t}{ciot\_dfu\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572}{ciot\+\_\+dfu\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT DFU request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_REQ\_UNKNOWN@{CIOT\_DFU\_REQ\_UNKNOWN}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_REQ\_UNKNOWN@{CIOT\_DFU\_REQ\_UNKNOWN}}}\Hypertarget{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a5f70da81c47429d85820f89a4c161485}\label{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a5f70da81c47429d85820f89a4c161485} -CIOT\+\_\+\+DFU\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_REQ\_SEND\_FIRMWARE@{CIOT\_DFU\_REQ\_SEND\_FIRMWARE}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_REQ\_SEND\_FIRMWARE@{CIOT\_DFU\_REQ\_SEND\_FIRMWARE}}}\Hypertarget{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a36e2397f2b518b59d8ee9b8d5dada729}\label{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a36e2397f2b518b59d8ee9b8d5dada729} -CIOT\+\_\+\+DFU\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+FIRMWARE&Send firmware request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365}\label{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365} -\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!ciot\_dfu\_state\_t@{ciot\_dfu\_state\_t}} -\index{ciot\_dfu\_state\_t@{ciot\_dfu\_state\_t}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_state\_t}{ciot\_dfu\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365}{ciot\+\_\+dfu\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT DFU states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_STATE\_ERROR@{CIOT\_DFU\_STATE\_ERROR}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_STATE\_ERROR@{CIOT\_DFU\_STATE\_ERROR}}}\Hypertarget{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2d35a9f74e70953aa9f9da44bb47aa16}\label{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2d35a9f74e70953aa9f9da44bb47aa16} -CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+ERROR&Error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_STATE\_IDLE@{CIOT\_DFU\_STATE\_IDLE}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_STATE\_IDLE@{CIOT\_DFU\_STATE\_IDLE}}}\Hypertarget{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a19824e532f98744f29b7242935287903}\label{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a19824e532f98744f29b7242935287903} -CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+IDLE&Idle state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_STATE\_IN\_PROGRESS@{CIOT\_DFU\_STATE\_IN\_PROGRESS}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_STATE\_IN\_PROGRESS@{CIOT\_DFU\_STATE\_IN\_PROGRESS}}}\Hypertarget{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2db1f86f2ada419de201e3e4962cab1b}\label{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2db1f86f2ada419de201e3e4962cab1b} -CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+IN\+\_\+\+PROGRESS&In progress state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_STATE\_COMPLETED@{CIOT\_DFU\_STATE\_COMPLETED}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_STATE\_COMPLETED@{CIOT\_DFU\_STATE\_COMPLETED}}}\Hypertarget{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a393d8a9161cf6ac9b5c6f20a31a46ed9}\label{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a393d8a9161cf6ac9b5c6f20a31a46ed9} -CIOT\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+COMPLETED&Completed state \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a}\label{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a} -\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!ciot\_dfu\_type\_t@{ciot\_dfu\_type\_t}} -\index{ciot\_dfu\_type\_t@{ciot\_dfu\_type\_t}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_dfu\_type\_t}{ciot\_dfu\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a}{ciot\+\_\+dfu\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT DFU types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_TYPE\_UNKNOWN@{CIOT\_DFU\_TYPE\_UNKNOWN}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_TYPE\_UNKNOWN@{CIOT\_DFU\_TYPE\_UNKNOWN}}}\Hypertarget{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaf4c3b89af87b4b26c1de07a3c4e2107a}\label{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaf4c3b89af87b4b26c1de07a3c4e2107a} -CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+UNKNOWN&Unknown DFU type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_TYPE\_UART@{CIOT\_DFU\_TYPE\_UART}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_TYPE\_UART@{CIOT\_DFU\_TYPE\_UART}}}\Hypertarget{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa7ce5cb795ab9be3288e458a5d3afa7fe}\label{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa7ce5cb795ab9be3288e458a5d3afa7fe} -CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+UART&UART DFU type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_TYPE\_USB@{CIOT\_DFU\_TYPE\_USB}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_TYPE\_USB@{CIOT\_DFU\_TYPE\_USB}}}\Hypertarget{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa6444ac136a4260d6e2c009d4ca5324be}\label{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa6444ac136a4260d6e2c009d4ca5324be} -CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+USB&USB DFU type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_DFU\_TYPE\_BLE@{CIOT\_DFU\_TYPE\_BLE}!ciot\_dfu\_types.h@{ciot\_dfu\_types.h}}\index{ciot\_dfu\_types.h@{ciot\_dfu\_types.h}!CIOT\_DFU\_TYPE\_BLE@{CIOT\_DFU\_TYPE\_BLE}}}\Hypertarget{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaa0b6b28f6e7d624adbf2a93286ff2892}\label{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaa0b6b28f6e7d624adbf2a93286ff2892} -CIOT\+\_\+\+DFU\+\_\+\+TYPE\+\_\+\+BLE&BLE DFU type \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__dfu__types_8h_source.tex b/docs/latex/ciot__dfu__types_8h_source.tex deleted file mode 100644 index 88fef4d..0000000 --- a/docs/latex/ciot__dfu__types_8h_source.tex +++ /dev/null @@ -1,75 +0,0 @@ -\doxysection{ciot\+\_\+dfu\+\_\+types.\+h} -\hypertarget{ciot__dfu__types_8h_source}{}\label{ciot__dfu__types_8h_source}\index{include/types/ciot\_dfu\_types.h@{include/types/ciot\_dfu\_types.h}} -\mbox{\hyperlink{ciot__dfu__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_DFU\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_DFU\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2d35a9f74e70953aa9f9da44bb47aa16}{CIOT\_DFU\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a19824e532f98744f29b7242935287903}{CIOT\_DFU\_STATE\_IDLE}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a2db1f86f2ada419de201e3e4962cab1b}{CIOT\_DFU\_STATE\_IN\_PROGRESS}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365a393d8a9161cf6ac9b5c6f20a31a46ed9}{CIOT\_DFU\_STATE\_COMPLETED}},\ } -\DoxyCodeLine{00029\ \}\ \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365}{ciot\_dfu\_state\_t}};} -\DoxyCodeLine{00030\ } -\DoxyCodeLine{00034\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00035\ \{} -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a5f70da81c47429d85820f89a4c161485}{CIOT\_DFU\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572a36e2397f2b518b59d8ee9b8d5dada729}{CIOT\_DFU\_REQ\_SEND\_FIRMWARE}},\ } -\DoxyCodeLine{00038\ \}\ \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572}{ciot\_dfu\_req\_type\_t}};} -\DoxyCodeLine{00039\ } -\DoxyCodeLine{00043\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00044\ \{} -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaf4c3b89af87b4b26c1de07a3c4e2107a}{CIOT\_DFU\_TYPE\_UNKNOWN}},\ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa7ce5cb795ab9be3288e458a5d3afa7fe}{CIOT\_DFU\_TYPE\_UART}},\ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aa6444ac136a4260d6e2c009d4ca5324be}{CIOT\_DFU\_TYPE\_USB}},\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963aaa0b6b28f6e7d624adbf2a93286ff2892}{CIOT\_DFU\_TYPE\_BLE}},\ } -\DoxyCodeLine{00049\ \}\ \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a}{ciot\_dfu\_type\_t}};} -\DoxyCodeLine{00050\ } -\DoxyCodeLine{00054\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct}} -\DoxyCodeLine{00055\ \{} -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a}{ciot\_dfu\_type\_t}}\ \mbox{\hyperlink{structciot__dfu__cfg__t_afa34dcfb78399ee2321831a93d8bce73}{type}};\ } -\DoxyCodeLine{00057\ \}\ \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\_dfu\_cfg\_t}};} -\DoxyCodeLine{00058\ } -\DoxyCodeLine{00062\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00063\ \{} -\DoxyCodeLine{00064\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365}{ciot\_dfu\_state\_t}}\ \mbox{\hyperlink{structciot__dfu__status__t_a587d059d905fdf8cceb8643720812de4}{state}};\ } -\DoxyCodeLine{00065\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__dfu__status__t_a45a5b7c00a796a23f01673cef1dbe0a9}{code}};\ } -\DoxyCodeLine{00066\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__dfu__status__t_a11614f44ef4d939bdd984953346a7572}{error}};\ } -\DoxyCodeLine{00067\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__dfu__status__t_a42539ea8650b094f66be7a689243c5ef}{image\_size}};\ } -\DoxyCodeLine{00068\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__dfu__status__t_a990d41db67b3605c9184428e72edcea1}{image\_read}};\ } -\DoxyCodeLine{00069\ \}\ \mbox{\hyperlink{structciot__dfu__status__t}{ciot\_dfu\_status\_t}};} -\DoxyCodeLine{00070\ } -\DoxyCodeLine{00074\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00075\ \{} -\DoxyCodeLine{00076\ \ \ \ \ } -\DoxyCodeLine{00077\ \}\ \mbox{\hyperlink{unionciot__dfu__req__data__u}{ciot\_dfu\_req\_data\_u}};} -\DoxyCodeLine{00078\ } -\DoxyCodeLine{00082\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00083\ \{} -\DoxyCodeLine{00084\ \ \ \ \ \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572}{ciot\_dfu\_req\_type\_t}}\ \mbox{\hyperlink{structciot__dfu__req__t_adb76936a18a28e534879c6f9d6f07868}{type}};\ } -\DoxyCodeLine{00085\ \ \ \ \ \mbox{\hyperlink{unionciot__dfu__req__data__u}{ciot\_dfu\_req\_data\_u}}\ \mbox{\hyperlink{structciot__dfu__req__t_a1d31b0b31c62cd6a2a3c3b5193efd5f9}{data}};\ } -\DoxyCodeLine{00086\ \}\ \mbox{\hyperlink{structciot__dfu__req__t}{ciot\_dfu\_req\_t}};} -\DoxyCodeLine{00087\ } -\DoxyCodeLine{00091\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00092\ \{} -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\_dfu\_cfg\_t}}\ \mbox{\hyperlink{unionciot__dfu__data__u_a8d4be68066e35bb11aecfff26e3cb30b}{config}};\ } -\DoxyCodeLine{00094\ \ \ \ \ \mbox{\hyperlink{structciot__dfu__status__t}{ciot\_dfu\_status\_t}}\ \mbox{\hyperlink{unionciot__dfu__data__u_a9fb48f785812375d586c71a02b453e64}{status}};\ } -\DoxyCodeLine{00095\ \ \ \ \ \mbox{\hyperlink{structciot__dfu__req__t}{ciot\_dfu\_req\_t}}\ \mbox{\hyperlink{unionciot__dfu__data__u_aeec32200114264e8556110d5c2ffc44c}{request}};\ } -\DoxyCodeLine{00096\ \}\ \mbox{\hyperlink{unionciot__dfu__data__u}{ciot\_dfu\_data\_u}};} -\DoxyCodeLine{00097\ } -\DoxyCodeLine{00098\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00099\ \}} -\DoxyCodeLine{00100\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00101\ } -\DoxyCodeLine{00102\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__err_8h.tex b/docs/latex/ciot__err_8h.tex deleted file mode 100644 index 8196ea2..0000000 --- a/docs/latex/ciot__err_8h.tex +++ /dev/null @@ -1,335 +0,0 @@ -\doxysection{include/ciot\+\_\+err.h File Reference} -\hypertarget{ciot__err_8h}{}\label{ciot__err_8h}\index{include/ciot\_err.h@{include/ciot\_err.h}} - - -Header file for CIOT error handling. - - -{\ttfamily \#include "{}ciot\+\_\+log.\+h"{}}\newline -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__err_8h_a5c83da3390515076963e6de67984fff5}{CIOT\+\_\+\+ERR\+\_\+\+BASE}}~0x0 -\begin{DoxyCompactList}\small\item\em Base error code for CIOT library. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__err_8h_ad14d33778f6214b2efd5d62bf6c6e3f2}{CIOT\+\_\+\+ERROR\+\_\+\+LOG}}(x)~\mbox{\hyperlink{ciot__log_8h_a2707adc47298b0e7b3a09627ff04a020}{CIOT\+\_\+\+LOGE}}(TAG, "{}\%s\+:\%d \%s"{}, \+\_\+\+\_\+\+FILE\+\_\+\+\_\+, \+\_\+\+\_\+\+LINE\+\_\+\+\_\+, \mbox{\hyperlink{ciot__err_8h_a1d1753e50e3d86f2a58cf488442b5f4c}{ciot\+\_\+err\+\_\+to\+\_\+message}}(ciot\+\_\+err)) -\begin{DoxyCompactList}\small\item\em Macro to log an error. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__err_8h_aa26e80d640e682764d732b12782cc7a3}{CIOT\+\_\+\+NULL\+\_\+\+CHECK}}(x) -\begin{DoxyCompactList}\small\item\em Macro to check for a null pointer and return an error if found. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__err_8h_a2d5c5535c945cd775e34e309019df360}{CIOT\+\_\+\+ERROR\+\_\+\+PRINT}}(x) -\begin{DoxyCompactList}\small\item\em Macro to print an error message if an operation fails. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__err_8h_a1806dc8280a05018951cee099f371d2d}{CIOT\+\_\+\+ERROR\+\_\+\+RETURN}}(x) -\begin{DoxyCompactList}\small\item\em Macro to return an error if an operation fails. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a71470ad3a7d23f316a2c6de561694646}{CIOT\+\_\+\+FAIL}} = -\/1 -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a608f016995435f4c5f758dc42f5c28dc}{CIOT\+\_\+\+OK}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9e389c8626c35577967cf7e312b3a45a}{CIOT\+\_\+\+ERR\+\_\+\+NULL\+\_\+\+ARG}} = CIOT\+\_\+\+ERR\+\_\+\+BASE + 1 -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a37a385918af7cb9c2a488bd82addef9a}{CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+ID}} -, \newline -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a92a85995ffcf6be5cd10ed9677827304}{CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+TYPE}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9b5fa45b99fba67d690588956d52f7b0}{CIOT\+\_\+\+ERR\+\_\+\+OVERFLOW}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8af592c215972533cd90b05e02f8e8d6cd}{CIOT\+\_\+\+ERR\+\_\+\+NOT\+\_\+\+IMPLEMENTED}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab80d9a08671e6164cae2d7ecf66af1cf}{CIOT\+\_\+\+ERR\+\_\+\+NOT\+\_\+\+SUPPORTED}} -, \newline -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a8a64d46b6f851cbea6f4be9827fa5719}{CIOT\+\_\+\+ERR\+\_\+\+BUSY}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a87486b88023e82004f4cc7bd8c91a587}{CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+STATE}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ae9b9cea99e0d51f7e70b70f11d2d8025}{CIOT\+\_\+\+ERR\+\_\+\+SERIALIZATION}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8aedd08488ef3c685bb1e2c47c14a80cb9}{CIOT\+\_\+\+ERR\+\_\+\+DESERIALIZATION}} -, \newline -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a4c98aa1cfd3dd9cdce9d0a9f6f5b5a74}{CIOT\+\_\+\+ERR\+\_\+\+SEND\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a26c7b6aac6b34bf51f17571df94876bc}{CIOT\+\_\+\+ERR\+\_\+\+RECV\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8add84c2b5f1832e3842e6639686ca342e}{CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+SIZE}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a671951c11518830a673c4e01f89059bd}{CIOT\+\_\+\+ERR\+\_\+\+CLOSED}} -, \newline -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2e6c77a112c02b82bf99b3c0ec247b6b}{CIOT\+\_\+\+ERR\+\_\+\+NOT\+\_\+\+FOUND}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab36d19cffa587308a172dc9d67e9ebf0}{CIOT\+\_\+\+ERR\+\_\+\+VALIDATION\+\_\+\+FAILED}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2c1218c0f210769b6a92052cb87aef3e}{CIOT\+\_\+\+ERR\+\_\+\+CONNECTION}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a699674cfe223dd193c22bd43b040e6ee}{CIOT\+\_\+\+ERR\+\_\+\+DISCONNECTION}} -, \newline -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a54bf87c72caefdedb6407028ba041fcf}{CIOT\+\_\+\+ERR\+\_\+\+EXCEPTION}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6a5c8b52d640c541101f6669f412dc3b}{CIOT\+\_\+\+ERR\+\_\+\+TERMINATOR\+\_\+\+MISSING}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a7b81bbef8df280eaf950be25a97d6b0f}{CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+ARG}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a134ff0d5fe0ca3d4d834e797cbf94bde}{CIOT\+\_\+\+ERR\+\_\+\+NO\+\_\+\+MEMORY}} -, \newline -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8abe6f4938ab424fc41b067a153ac1105c}{CIOT\+\_\+\+ERR\+\_\+\+TIMEOUT}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a811422a99ed9205e5c17a426012b2914}{CIOT\+\_\+\+ERR\+\_\+\+MONGOOSE}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6d5e8817f2b08fcf3e7a18678b397fba}{CIOT\+\_\+\+ERR\+\_\+\+IMPOSSIBLE\+\_\+\+OP}} -, \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ad5d03221253b6f9e2e632dea64791478}{CIOT\+\_\+\+ERR\+\_\+\+CHECKSUM}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration of CIOT error codes. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__err_8h_a1d1753e50e3d86f2a58cf488442b5f4c}{ciot\+\_\+err\+\_\+to\+\_\+message}} (\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} err) -\begin{DoxyCompactList}\small\item\em Converts a CIOT error code to a human-\/readable message. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT error handling. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__err_8h_a5c83da3390515076963e6de67984fff5}\label{ciot__err_8h_a5c83da3390515076963e6de67984fff5} -\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_BASE@{CIOT\_ERR\_BASE}} -\index{CIOT\_ERR\_BASE@{CIOT\_ERR\_BASE}!ciot\_err.h@{ciot\_err.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_ERR\_BASE}{CIOT\_ERR\_BASE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+ERR\+\_\+\+BASE~0x0} - - - -Base error code for CIOT library. - -\Hypertarget{ciot__err_8h_ad14d33778f6214b2efd5d62bf6c6e3f2}\label{ciot__err_8h_ad14d33778f6214b2efd5d62bf6c6e3f2} -\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERROR\_LOG@{CIOT\_ERROR\_LOG}} -\index{CIOT\_ERROR\_LOG@{CIOT\_ERROR\_LOG}!ciot\_err.h@{ciot\_err.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_ERROR\_LOG}{CIOT\_ERROR\_LOG}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+ERROR\+\_\+\+LOG(\begin{DoxyParamCaption}\item[{}]{x }\end{DoxyParamCaption})~\mbox{\hyperlink{ciot__log_8h_a2707adc47298b0e7b3a09627ff04a020}{CIOT\+\_\+\+LOGE}}(TAG, "{}\%s\+:\%d \%s"{}, \+\_\+\+\_\+\+FILE\+\_\+\+\_\+, \+\_\+\+\_\+\+LINE\+\_\+\+\_\+, \mbox{\hyperlink{ciot__err_8h_a1d1753e50e3d86f2a58cf488442b5f4c}{ciot\+\_\+err\+\_\+to\+\_\+message}}(ciot\+\_\+err))} - - - -Macro to log an error. - - -\begin{DoxyParams}{Parameters} -{\em x} & The error code. \\ -\hline -\end{DoxyParams} -\Hypertarget{ciot__err_8h_a2d5c5535c945cd775e34e309019df360}\label{ciot__err_8h_a2d5c5535c945cd775e34e309019df360} -\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERROR\_PRINT@{CIOT\_ERROR\_PRINT}} -\index{CIOT\_ERROR\_PRINT@{CIOT\_ERROR\_PRINT}!ciot\_err.h@{ciot\_err.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_ERROR\_PRINT}{CIOT\_ERROR\_PRINT}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+ERROR\+\_\+\+PRINT(\begin{DoxyParamCaption}\item[{}]{x }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ ciot\_err\ =\ x;\ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (ciot\_err\ !=\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a608f016995435f4c5f758dc42f5c28dc}{CIOT\_OK}})\ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ CIOT\_ERROR\_LOG(ciot\_err);\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to print an error message if an operation fails. - - -\begin{DoxyParams}{Parameters} -{\em x} & The operation to check for errors. \\ -\hline -\end{DoxyParams} -\Hypertarget{ciot__err_8h_a1806dc8280a05018951cee099f371d2d}\label{ciot__err_8h_a1806dc8280a05018951cee099f371d2d} -\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERROR\_RETURN@{CIOT\_ERROR\_RETURN}} -\index{CIOT\_ERROR\_RETURN@{CIOT\_ERROR\_RETURN}!ciot\_err.h@{ciot\_err.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_ERROR\_RETURN}{CIOT\_ERROR\_RETURN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+ERROR\+\_\+\+RETURN(\begin{DoxyParamCaption}\item[{}]{x }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ ciot\_err\ =\ x;\ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (ciot\_err\ !=\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a608f016995435f4c5f758dc42f5c28dc}{CIOT\_OK}})\ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ CIOT\_ERROR\_LOG(ciot\_err);\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ ciot\_err;\ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to return an error if an operation fails. - - -\begin{DoxyParams}{Parameters} -{\em x} & The operation to check for errors. \\ -\hline -\end{DoxyParams} -\Hypertarget{ciot__err_8h_aa26e80d640e682764d732b12782cc7a3}\label{ciot__err_8h_aa26e80d640e682764d732b12782cc7a3} -\index{ciot\_err.h@{ciot\_err.h}!CIOT\_NULL\_CHECK@{CIOT\_NULL\_CHECK}} -\index{CIOT\_NULL\_CHECK@{CIOT\_NULL\_CHECK}!ciot\_err.h@{ciot\_err.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_NULL\_CHECK}{CIOT\_NULL\_CHECK}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+NULL\+\_\+\+CHECK(\begin{DoxyParamCaption}\item[{}]{x }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{if}\ (x\ ==\ NULL)\ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9e389c8626c35577967cf7e312b3a45a}{CIOT\_ERR\_NULL\_ARG}}} - -\end{DoxyCode} - - -Macro to check for a null pointer and return an error if found. - - -\begin{DoxyParams}{Parameters} -{\em x} & The pointer to check. \\ -\hline -\end{DoxyParams} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8} -\index{ciot\_err.h@{ciot\_err.h}!ciot\_err\_t@{ciot\_err\_t}} -\index{ciot\_err\_t@{ciot\_err\_t}!ciot\_err.h@{ciot\_err.h}} -\doxysubsubsection{\texorpdfstring{ciot\_err\_t}{ciot\_err\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}}} - - - -Enumeration of CIOT error codes. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_FAIL@{CIOT\_FAIL}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_FAIL@{CIOT\_FAIL}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a71470ad3a7d23f316a2c6de561694646}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a71470ad3a7d23f316a2c6de561694646} -CIOT\+\_\+\+FAIL&General failure. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OK@{CIOT\_OK}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_OK@{CIOT\_OK}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a608f016995435f4c5f758dc42f5c28dc}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a608f016995435f4c5f758dc42f5c28dc} -CIOT\+\_\+\+OK&Operation successful. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_NULL\_ARG@{CIOT\_ERR\_NULL\_ARG}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_NULL\_ARG@{CIOT\_ERR\_NULL\_ARG}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9e389c8626c35577967cf7e312b3a45a}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9e389c8626c35577967cf7e312b3a45a} -CIOT\+\_\+\+ERR\+\_\+\+NULL\+\_\+\+ARG&Null argument error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_INVALID\_ID@{CIOT\_ERR\_INVALID\_ID}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_INVALID\_ID@{CIOT\_ERR\_INVALID\_ID}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a37a385918af7cb9c2a488bd82addef9a}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a37a385918af7cb9c2a488bd82addef9a} -CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+ID&Invalid ID error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_INVALID\_TYPE@{CIOT\_ERR\_INVALID\_TYPE}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_INVALID\_TYPE@{CIOT\_ERR\_INVALID\_TYPE}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a92a85995ffcf6be5cd10ed9677827304}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a92a85995ffcf6be5cd10ed9677827304} -CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+TYPE&Invalid type error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_OVERFLOW@{CIOT\_ERR\_OVERFLOW}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_OVERFLOW@{CIOT\_ERR\_OVERFLOW}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9b5fa45b99fba67d690588956d52f7b0}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9b5fa45b99fba67d690588956d52f7b0} -CIOT\+\_\+\+ERR\+\_\+\+OVERFLOW&Overflow error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_NOT\_IMPLEMENTED@{CIOT\_ERR\_NOT\_IMPLEMENTED}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_NOT\_IMPLEMENTED@{CIOT\_ERR\_NOT\_IMPLEMENTED}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8af592c215972533cd90b05e02f8e8d6cd}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8af592c215972533cd90b05e02f8e8d6cd} -CIOT\+\_\+\+ERR\+\_\+\+NOT\+\_\+\+IMPLEMENTED&Not implemented error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_NOT\_SUPPORTED@{CIOT\_ERR\_NOT\_SUPPORTED}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_NOT\_SUPPORTED@{CIOT\_ERR\_NOT\_SUPPORTED}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab80d9a08671e6164cae2d7ecf66af1cf}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab80d9a08671e6164cae2d7ecf66af1cf} -CIOT\+\_\+\+ERR\+\_\+\+NOT\+\_\+\+SUPPORTED&Operation not supported error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_BUSY@{CIOT\_ERR\_BUSY}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_BUSY@{CIOT\_ERR\_BUSY}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a8a64d46b6f851cbea6f4be9827fa5719}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a8a64d46b6f851cbea6f4be9827fa5719} -CIOT\+\_\+\+ERR\+\_\+\+BUSY&Busy error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_INVALID\_STATE@{CIOT\_ERR\_INVALID\_STATE}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_INVALID\_STATE@{CIOT\_ERR\_INVALID\_STATE}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a87486b88023e82004f4cc7bd8c91a587}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a87486b88023e82004f4cc7bd8c91a587} -CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+STATE&Invalid state error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_SERIALIZATION@{CIOT\_ERR\_SERIALIZATION}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_SERIALIZATION@{CIOT\_ERR\_SERIALIZATION}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ae9b9cea99e0d51f7e70b70f11d2d8025}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ae9b9cea99e0d51f7e70b70f11d2d8025} -CIOT\+\_\+\+ERR\+\_\+\+SERIALIZATION&Serialization error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_DESERIALIZATION@{CIOT\_ERR\_DESERIALIZATION}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_DESERIALIZATION@{CIOT\_ERR\_DESERIALIZATION}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8aedd08488ef3c685bb1e2c47c14a80cb9}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8aedd08488ef3c685bb1e2c47c14a80cb9} -CIOT\+\_\+\+ERR\+\_\+\+DESERIALIZATION&Deserialization error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_SEND\_DATA@{CIOT\_ERR\_SEND\_DATA}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_SEND\_DATA@{CIOT\_ERR\_SEND\_DATA}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a4c98aa1cfd3dd9cdce9d0a9f6f5b5a74}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a4c98aa1cfd3dd9cdce9d0a9f6f5b5a74} -CIOT\+\_\+\+ERR\+\_\+\+SEND\+\_\+\+DATA&Error sending data. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_RECV\_DATA@{CIOT\_ERR\_RECV\_DATA}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_RECV\_DATA@{CIOT\_ERR\_RECV\_DATA}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a26c7b6aac6b34bf51f17571df94876bc}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a26c7b6aac6b34bf51f17571df94876bc} -CIOT\+\_\+\+ERR\+\_\+\+RECV\+\_\+\+DATA&Error receiving data. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_INVALID\_SIZE@{CIOT\_ERR\_INVALID\_SIZE}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_INVALID\_SIZE@{CIOT\_ERR\_INVALID\_SIZE}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8add84c2b5f1832e3842e6639686ca342e}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8add84c2b5f1832e3842e6639686ca342e} -CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+SIZE&Invalid size error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_CLOSED@{CIOT\_ERR\_CLOSED}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_CLOSED@{CIOT\_ERR\_CLOSED}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a671951c11518830a673c4e01f89059bd}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a671951c11518830a673c4e01f89059bd} -CIOT\+\_\+\+ERR\+\_\+\+CLOSED&Closed error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_NOT\_FOUND@{CIOT\_ERR\_NOT\_FOUND}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_NOT\_FOUND@{CIOT\_ERR\_NOT\_FOUND}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2e6c77a112c02b82bf99b3c0ec247b6b}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2e6c77a112c02b82bf99b3c0ec247b6b} -CIOT\+\_\+\+ERR\+\_\+\+NOT\+\_\+\+FOUND&Not found error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_VALIDATION\_FAILED@{CIOT\_ERR\_VALIDATION\_FAILED}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_VALIDATION\_FAILED@{CIOT\_ERR\_VALIDATION\_FAILED}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab36d19cffa587308a172dc9d67e9ebf0}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab36d19cffa587308a172dc9d67e9ebf0} -CIOT\+\_\+\+ERR\+\_\+\+VALIDATION\+\_\+\+FAILED&Validation failed error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_CONNECTION@{CIOT\_ERR\_CONNECTION}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_CONNECTION@{CIOT\_ERR\_CONNECTION}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2c1218c0f210769b6a92052cb87aef3e}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2c1218c0f210769b6a92052cb87aef3e} -CIOT\+\_\+\+ERR\+\_\+\+CONNECTION&Connection error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_DISCONNECTION@{CIOT\_ERR\_DISCONNECTION}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_DISCONNECTION@{CIOT\_ERR\_DISCONNECTION}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a699674cfe223dd193c22bd43b040e6ee}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a699674cfe223dd193c22bd43b040e6ee} -CIOT\+\_\+\+ERR\+\_\+\+DISCONNECTION&Disconnection error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_EXCEPTION@{CIOT\_ERR\_EXCEPTION}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_EXCEPTION@{CIOT\_ERR\_EXCEPTION}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a54bf87c72caefdedb6407028ba041fcf}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a54bf87c72caefdedb6407028ba041fcf} -CIOT\+\_\+\+ERR\+\_\+\+EXCEPTION&Exception error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_TERMINATOR\_MISSING@{CIOT\_ERR\_TERMINATOR\_MISSING}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_TERMINATOR\_MISSING@{CIOT\_ERR\_TERMINATOR\_MISSING}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6a5c8b52d640c541101f6669f412dc3b}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6a5c8b52d640c541101f6669f412dc3b} -CIOT\+\_\+\+ERR\+\_\+\+TERMINATOR\+\_\+\+MISSING&Terminator missing error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_INVALID\_ARG@{CIOT\_ERR\_INVALID\_ARG}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_INVALID\_ARG@{CIOT\_ERR\_INVALID\_ARG}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a7b81bbef8df280eaf950be25a97d6b0f}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a7b81bbef8df280eaf950be25a97d6b0f} -CIOT\+\_\+\+ERR\+\_\+\+INVALID\+\_\+\+ARG&Invalid argument error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_NO\_MEMORY@{CIOT\_ERR\_NO\_MEMORY}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_NO\_MEMORY@{CIOT\_ERR\_NO\_MEMORY}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a134ff0d5fe0ca3d4d834e797cbf94bde}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a134ff0d5fe0ca3d4d834e797cbf94bde} -CIOT\+\_\+\+ERR\+\_\+\+NO\+\_\+\+MEMORY&Out of memory error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_TIMEOUT@{CIOT\_ERR\_TIMEOUT}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_TIMEOUT@{CIOT\_ERR\_TIMEOUT}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8abe6f4938ab424fc41b067a153ac1105c}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8abe6f4938ab424fc41b067a153ac1105c} -CIOT\+\_\+\+ERR\+\_\+\+TIMEOUT&Timeout error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_MONGOOSE@{CIOT\_ERR\_MONGOOSE}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_MONGOOSE@{CIOT\_ERR\_MONGOOSE}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a811422a99ed9205e5c17a426012b2914}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a811422a99ed9205e5c17a426012b2914} -CIOT\+\_\+\+ERR\+\_\+\+MONGOOSE&Mongoose error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_IMPOSSIBLE\_OP@{CIOT\_ERR\_IMPOSSIBLE\_OP}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_IMPOSSIBLE\_OP@{CIOT\_ERR\_IMPOSSIBLE\_OP}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6d5e8817f2b08fcf3e7a18678b397fba}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6d5e8817f2b08fcf3e7a18678b397fba} -CIOT\+\_\+\+ERR\+\_\+\+IMPOSSIBLE\+\_\+\+OP&Impossible operation error. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ERR\_CHECKSUM@{CIOT\_ERR\_CHECKSUM}!ciot\_err.h@{ciot\_err.h}}\index{ciot\_err.h@{ciot\_err.h}!CIOT\_ERR\_CHECKSUM@{CIOT\_ERR\_CHECKSUM}}}\Hypertarget{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ad5d03221253b6f9e2e632dea64791478}\label{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ad5d03221253b6f9e2e632dea64791478} -CIOT\+\_\+\+ERR\+\_\+\+CHECKSUM&Checksum error. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__err_8h_a1d1753e50e3d86f2a58cf488442b5f4c}\label{ciot__err_8h_a1d1753e50e3d86f2a58cf488442b5f4c} -\index{ciot\_err.h@{ciot\_err.h}!ciot\_err\_to\_message@{ciot\_err\_to\_message}} -\index{ciot\_err\_to\_message@{ciot\_err\_to\_message}!ciot\_err.h@{ciot\_err.h}} -\doxysubsubsection{\texorpdfstring{ciot\_err\_to\_message()}{ciot\_err\_to\_message()}} -{\footnotesize\ttfamily const char \texorpdfstring{$\ast$}{*} ciot\+\_\+err\+\_\+to\+\_\+message (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}}}]{err }\end{DoxyParamCaption})} - - - -Converts a CIOT error code to a human-\/readable message. - - -\begin{DoxyParams}{Parameters} -{\em err} & The error code. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the error message. -\end{DoxyReturn} diff --git a/docs/latex/ciot__err_8h_source.tex b/docs/latex/ciot__err_8h_source.tex deleted file mode 100644 index 837c29b..0000000 --- a/docs/latex/ciot__err_8h_source.tex +++ /dev/null @@ -1,83 +0,0 @@ -\doxysection{ciot\+\_\+err.\+h} -\hypertarget{ciot__err_8h_source}{}\label{ciot__err_8h_source}\index{include/ciot\_err.h@{include/ciot\_err.h}} -\mbox{\hyperlink{ciot__err_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_ERR\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_ERR\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__log_8h}{ciot\_log.h}}"{}}} -\DoxyCodeLine{00018\ } -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#define\ CIOT\_ERR\_BASE\ 0x0}} -\DoxyCodeLine{00023\ } -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#define\ CIOT\_ERROR\_LOG(x)\ CIOT\_LOGE(TAG,\ "{}\%s:\%d\ \%s"{},\ \_\_FILE\_\_,\ \_\_LINE\_\_,\ ciot\_err\_to\_message(ciot\_err))}} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#define\ CIOT\_NULL\_CHECK(x)\ \(\backslash\)}} -\DoxyCodeLine{00035\ \textcolor{preprocessor}{\ \ \ \ if\ (x\ ==\ NULL)\ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\ \ \ \ return\ CIOT\_ERR\_NULL\_ARG}} -\DoxyCodeLine{00037\ } -\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#define\ CIOT\_ERROR\_PRINT(x)\ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00043\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00044\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00045\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ ciot\_err\_t\ ciot\_err\ =\ x;\ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00046\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (ciot\_err\ !=\ CIOT\_OK)\ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00047\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00048\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ CIOT\_ERROR\_LOG(ciot\_err);\ \(\backslash\)}} -\DoxyCodeLine{00049\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00050\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00051\ } -\DoxyCodeLine{00056\ \textcolor{preprocessor}{\#define\ CIOT\_ERROR\_RETURN(x)\ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00057\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00058\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00059\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ ciot\_err\_t\ ciot\_err\ =\ x;\ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00060\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (ciot\_err\ !=\ CIOT\_OK)\ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00061\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00062\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ CIOT\_ERROR\_LOG(ciot\_err);\ \(\backslash\)}} -\DoxyCodeLine{00063\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ return\ ciot\_err;\ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00064\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00065\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00066\ } -\DoxyCodeLine{00070\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \{} -\DoxyCodeLine{00071\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a71470ad3a7d23f316a2c6de561694646}{CIOT\_FAIL}}\ =\ -\/1,\ } -\DoxyCodeLine{00072\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a608f016995435f4c5f758dc42f5c28dc}{CIOT\_OK}},\ } -\DoxyCodeLine{00073\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9e389c8626c35577967cf7e312b3a45a}{CIOT\_ERR\_NULL\_ARG}}\ =\ \mbox{\hyperlink{ciot__err_8h_a5c83da3390515076963e6de67984fff5}{CIOT\_ERR\_BASE}}\ +\ 1,\ } -\DoxyCodeLine{00074\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a37a385918af7cb9c2a488bd82addef9a}{CIOT\_ERR\_INVALID\_ID}},\ } -\DoxyCodeLine{00075\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a92a85995ffcf6be5cd10ed9677827304}{CIOT\_ERR\_INVALID\_TYPE}},\ } -\DoxyCodeLine{00076\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a9b5fa45b99fba67d690588956d52f7b0}{CIOT\_ERR\_OVERFLOW}},\ } -\DoxyCodeLine{00077\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8af592c215972533cd90b05e02f8e8d6cd}{CIOT\_ERR\_NOT\_IMPLEMENTED}},\ } -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab80d9a08671e6164cae2d7ecf66af1cf}{CIOT\_ERR\_NOT\_SUPPORTED}},\ } -\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a8a64d46b6f851cbea6f4be9827fa5719}{CIOT\_ERR\_BUSY}},\ } -\DoxyCodeLine{00080\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a87486b88023e82004f4cc7bd8c91a587}{CIOT\_ERR\_INVALID\_STATE}},\ } -\DoxyCodeLine{00081\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ae9b9cea99e0d51f7e70b70f11d2d8025}{CIOT\_ERR\_SERIALIZATION}},\ } -\DoxyCodeLine{00082\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8aedd08488ef3c685bb1e2c47c14a80cb9}{CIOT\_ERR\_DESERIALIZATION}},\ } -\DoxyCodeLine{00083\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a4c98aa1cfd3dd9cdce9d0a9f6f5b5a74}{CIOT\_ERR\_SEND\_DATA}},\ } -\DoxyCodeLine{00084\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a26c7b6aac6b34bf51f17571df94876bc}{CIOT\_ERR\_RECV\_DATA}},\ } -\DoxyCodeLine{00085\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8add84c2b5f1832e3842e6639686ca342e}{CIOT\_ERR\_INVALID\_SIZE}},\ } -\DoxyCodeLine{00086\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a671951c11518830a673c4e01f89059bd}{CIOT\_ERR\_CLOSED}},\ } -\DoxyCodeLine{00087\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2e6c77a112c02b82bf99b3c0ec247b6b}{CIOT\_ERR\_NOT\_FOUND}},\ } -\DoxyCodeLine{00088\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ab36d19cffa587308a172dc9d67e9ebf0}{CIOT\_ERR\_VALIDATION\_FAILED}},\ } -\DoxyCodeLine{00089\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a2c1218c0f210769b6a92052cb87aef3e}{CIOT\_ERR\_CONNECTION}},\ } -\DoxyCodeLine{00090\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a699674cfe223dd193c22bd43b040e6ee}{CIOT\_ERR\_DISCONNECTION}},\ } -\DoxyCodeLine{00091\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a54bf87c72caefdedb6407028ba041fcf}{CIOT\_ERR\_EXCEPTION}},\ } -\DoxyCodeLine{00092\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6a5c8b52d640c541101f6669f412dc3b}{CIOT\_ERR\_TERMINATOR\_MISSING}},\ } -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a7b81bbef8df280eaf950be25a97d6b0f}{CIOT\_ERR\_INVALID\_ARG}},\ } -\DoxyCodeLine{00094\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a134ff0d5fe0ca3d4d834e797cbf94bde}{CIOT\_ERR\_NO\_MEMORY}},\ } -\DoxyCodeLine{00095\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8abe6f4938ab424fc41b067a153ac1105c}{CIOT\_ERR\_TIMEOUT}},\ } -\DoxyCodeLine{00096\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a811422a99ed9205e5c17a426012b2914}{CIOT\_ERR\_MONGOOSE}},\ } -\DoxyCodeLine{00097\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8a6d5e8817f2b08fcf3e7a18678b397fba}{CIOT\_ERR\_IMPOSSIBLE\_OP}},\ } -\DoxyCodeLine{00098\ \ \ \ \ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8ad5d03221253b6f9e2e632dea64791478}{CIOT\_ERR\_CHECKSUM}},\ } -\DoxyCodeLine{00099\ \}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}};} -\DoxyCodeLine{00100\ } -\DoxyCodeLine{00106\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\mbox{\hyperlink{ciot__err_8h_a1d1753e50e3d86f2a58cf488442b5f4c}{ciot\_err\_to\_message}}(\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ err);} -\DoxyCodeLine{00107\ } -\DoxyCodeLine{00108\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00109\ \}} -\DoxyCodeLine{00110\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00111\ } -\DoxyCodeLine{00112\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__eth_8h.tex b/docs/latex/ciot__eth_8h.tex deleted file mode 100644 index f69d52b..0000000 --- a/docs/latex/ciot__eth_8h.tex +++ /dev/null @@ -1,204 +0,0 @@ -\doxysection{include/ciot\+\_\+eth.h File Reference} -\hypertarget{ciot__eth_8h}{}\label{ciot__eth_8h}\index{include/ciot\_eth.h@{include/ciot\_eth.h}} - - -Header file for CIOT Ethernet interface. - - -{\ttfamily \#include "{}types/ciot\+\_\+tcp\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__eth__status__msg__t}{ciot\+\_\+eth\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT Ethernet status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+eth \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT Ethernet interface. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556}{ciot\+\_\+eth\+\_\+event\+\_\+id\+\_\+t}} \{ \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aeedce4004914b72cbf5464d1f8dc6620}{CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+START}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM -, \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556af7a9e91956122dcb208686cf6f362f4a}{CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+STOP}} -, \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aa06cce1cad097460e007b222417aaf7a}{CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+CONNECTED}} -, \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556a7a0a49fd6006a25ba1cf375e28fe05fe}{CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+DISCONNECTED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration of CIOT Ethernet event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}} \mbox{\hyperlink{ciot__eth_8h_a2c82abdd259489cac5b0fa093497d90c}{ciot\+\_\+eth\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Creates a new CIOT Ethernet interface instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__eth_8h_abed434192140a1fae6f358608f3407a8}{ciot\+\_\+eth\+\_\+start}} (\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}} self, \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Starts the CIOT Ethernet interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__eth_8h_af2d6489aa9834dcaecce9c322fd1a96e}{ciot\+\_\+eth\+\_\+stop}} (\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stops the CIOT Ethernet interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__eth_8h_a661b7975f64b8017ec7cd6c4f68a4395}{ciot\+\_\+eth\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}} self, \mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Processes a request for the CIOT Ethernet interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__eth_8h_a3952717d31db12a55731412a370ceda5}{ciot\+\_\+eth\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Sends data over the CIOT Ethernet interface. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT Ethernet interface. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}\label{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7} -\index{ciot\_eth.h@{ciot\_eth.h}!ciot\_eth\_t@{ciot\_eth\_t}} -\index{ciot\_eth\_t@{ciot\_eth\_t}!ciot\_eth.h@{ciot\_eth.h}} -\doxysubsubsection{\texorpdfstring{ciot\_eth\_t}{ciot\_eth\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+eth\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}}} - - - -Structure representing the CIOT Ethernet interface. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556}\label{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556} -\index{ciot\_eth.h@{ciot\_eth.h}!ciot\_eth\_event\_id\_t@{ciot\_eth\_event\_id\_t}} -\index{ciot\_eth\_event\_id\_t@{ciot\_eth\_event\_id\_t}!ciot\_eth.h@{ciot\_eth.h}} -\doxysubsubsection{\texorpdfstring{ciot\_eth\_event\_id\_t}{ciot\_eth\_event\_id\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556}{ciot\+\_\+eth\+\_\+event\+\_\+id\+\_\+t}}} - - - -Enumeration of CIOT Ethernet event IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ETH\_EVENT\_START@{CIOT\_ETH\_EVENT\_START}!ciot\_eth.h@{ciot\_eth.h}}\index{ciot\_eth.h@{ciot\_eth.h}!CIOT\_ETH\_EVENT\_START@{CIOT\_ETH\_EVENT\_START}}}\Hypertarget{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aeedce4004914b72cbf5464d1f8dc6620}\label{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aeedce4004914b72cbf5464d1f8dc6620} -CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+START&Ethernet start event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ETH\_EVENT\_STOP@{CIOT\_ETH\_EVENT\_STOP}!ciot\_eth.h@{ciot\_eth.h}}\index{ciot\_eth.h@{ciot\_eth.h}!CIOT\_ETH\_EVENT\_STOP@{CIOT\_ETH\_EVENT\_STOP}}}\Hypertarget{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556af7a9e91956122dcb208686cf6f362f4a}\label{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556af7a9e91956122dcb208686cf6f362f4a} -CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+STOP&Ethernet stop event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ETH\_EVENT\_CONNECTED@{CIOT\_ETH\_EVENT\_CONNECTED}!ciot\_eth.h@{ciot\_eth.h}}\index{ciot\_eth.h@{ciot\_eth.h}!CIOT\_ETH\_EVENT\_CONNECTED@{CIOT\_ETH\_EVENT\_CONNECTED}}}\Hypertarget{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aa06cce1cad097460e007b222417aaf7a}\label{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aa06cce1cad097460e007b222417aaf7a} -CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+CONNECTED&Ethernet connected event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_ETH\_EVENT\_DISCONNECTED@{CIOT\_ETH\_EVENT\_DISCONNECTED}!ciot\_eth.h@{ciot\_eth.h}}\index{ciot\_eth.h@{ciot\_eth.h}!CIOT\_ETH\_EVENT\_DISCONNECTED@{CIOT\_ETH\_EVENT\_DISCONNECTED}}}\Hypertarget{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556a7a0a49fd6006a25ba1cf375e28fe05fe}\label{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556a7a0a49fd6006a25ba1cf375e28fe05fe} -CIOT\+\_\+\+ETH\+\_\+\+EVENT\+\_\+\+DISCONNECTED&Ethernet disconnected event. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__eth_8h_a2c82abdd259489cac5b0fa093497d90c}\label{ciot__eth_8h_a2c82abdd259489cac5b0fa093497d90c} -\index{ciot\_eth.h@{ciot\_eth.h}!ciot\_eth\_new@{ciot\_eth\_new}} -\index{ciot\_eth\_new@{ciot\_eth\_new}!ciot\_eth.h@{ciot\_eth.h}} -\doxysubsubsection{\texorpdfstring{ciot\_eth\_new()}{ciot\_eth\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}} ciot\+\_\+eth\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Creates a new CIOT Ethernet interface instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & The handle for the Ethernet interface. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the new CIOT Ethernet instance. -\end{DoxyReturn} -\Hypertarget{ciot__eth_8h_a661b7975f64b8017ec7cd6c4f68a4395}\label{ciot__eth_8h_a661b7975f64b8017ec7cd6c4f68a4395} -\index{ciot\_eth.h@{ciot\_eth.h}!ciot\_eth\_process\_req@{ciot\_eth\_process\_req}} -\index{ciot\_eth\_process\_req@{ciot\_eth\_process\_req}!ciot\_eth.h@{ciot\_eth.h}} -\doxysubsubsection{\texorpdfstring{ciot\_eth\_process\_req()}{ciot\_eth\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+eth\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Processes a request for the CIOT Ethernet interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT Ethernet instance. \\ -\hline -{\em req} & The TCP request to be processed. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__eth_8h_a3952717d31db12a55731412a370ceda5}\label{ciot__eth_8h_a3952717d31db12a55731412a370ceda5} -\index{ciot\_eth.h@{ciot\_eth.h}!ciot\_eth\_send\_data@{ciot\_eth\_send\_data}} -\index{ciot\_eth\_send\_data@{ciot\_eth\_send\_data}!ciot\_eth.h@{ciot\_eth.h}} -\doxysubsubsection{\texorpdfstring{ciot\_eth\_send\_data()}{ciot\_eth\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+eth\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends data over the CIOT Ethernet interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT Ethernet instance. \\ -\hline -{\em data} & The data to be sent. \\ -\hline -{\em size} & The size of the data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__eth_8h_abed434192140a1fae6f358608f3407a8}\label{ciot__eth_8h_abed434192140a1fae6f358608f3407a8} -\index{ciot\_eth.h@{ciot\_eth.h}!ciot\_eth\_start@{ciot\_eth\_start}} -\index{ciot\_eth\_start@{ciot\_eth\_start}!ciot\_eth.h@{ciot\_eth.h}} -\doxysubsubsection{\texorpdfstring{ciot\_eth\_start()}{ciot\_eth\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+eth\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Starts the CIOT Ethernet interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT Ethernet instance. \\ -\hline -{\em cfg} & The TCP configuration for Ethernet. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__eth_8h_af2d6489aa9834dcaecce9c322fd1a96e}\label{ciot__eth_8h_af2d6489aa9834dcaecce9c322fd1a96e} -\index{ciot\_eth.h@{ciot\_eth.h}!ciot\_eth\_stop@{ciot\_eth\_stop}} -\index{ciot\_eth\_stop@{ciot\_eth\_stop}!ciot\_eth.h@{ciot\_eth.h}} -\doxysubsubsection{\texorpdfstring{ciot\_eth\_stop()}{ciot\_eth\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+eth\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\+\_\+eth\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stops the CIOT Ethernet interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT Ethernet instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} diff --git a/docs/latex/ciot__eth_8h_source.tex b/docs/latex/ciot__eth_8h_source.tex deleted file mode 100644 index c2e2a03..0000000 --- a/docs/latex/ciot__eth_8h_source.tex +++ /dev/null @@ -1,47 +0,0 @@ -\doxysection{ciot\+\_\+eth.\+h} -\hypertarget{ciot__eth_8h_source}{}\label{ciot__eth_8h_source}\index{include/ciot\_eth.h@{include/ciot\_eth.h}} -\mbox{\hyperlink{ciot__eth_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_ETH\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_ETH\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp__types_8h}{types/ciot\_tcp\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_eth\ *\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\_eth\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \{} -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aeedce4004914b72cbf5464d1f8dc6620}{CIOT\_ETH\_EVENT\_START}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556af7a9e91956122dcb208686cf6f362f4a}{CIOT\_ETH\_EVENT\_STOP}},\ } -\DoxyCodeLine{00033\ \ \ \ \ \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556aa06cce1cad097460e007b222417aaf7a}{CIOT\_ETH\_EVENT\_CONNECTED}},\ } -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556a7a0a49fd6006a25ba1cf375e28fe05fe}{CIOT\_ETH\_EVENT\_DISCONNECTED}},\ } -\DoxyCodeLine{00035\ \}\ \mbox{\hyperlink{ciot__eth_8h_acba9cf62e11fb559248dff916f3ba556}{ciot\_eth\_event\_id\_t}};} -\DoxyCodeLine{00036\ } -\DoxyCodeLine{00040\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__eth__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__status__t}{ciot\_tcp\_status\_t}}\ \mbox{\hyperlink{structciot__eth__status__msg__t_a290455b77155aab0d086fb8c69f76364}{status}};\ } -\DoxyCodeLine{00043\ \}\ \mbox{\hyperlink{structciot__eth__status__msg__t}{ciot\_eth\_status\_msg\_t}};} -\DoxyCodeLine{00044\ } -\DoxyCodeLine{00050\ \mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\_eth\_t}}\ \mbox{\hyperlink{ciot__eth_8h_a2c82abdd259489cac5b0fa093497d90c}{ciot\_eth\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00051\ } -\DoxyCodeLine{00058\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__eth_8h_abed434192140a1fae6f358608f3407a8}{ciot\_eth\_start}}(\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\_eth\_t}}\ self,\ \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\_tcp\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00059\ } -\DoxyCodeLine{00065\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__eth_8h_af2d6489aa9834dcaecce9c322fd1a96e}{ciot\_eth\_stop}}(\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\_eth\_t}}\ self);} -\DoxyCodeLine{00066\ } -\DoxyCodeLine{00073\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__eth_8h_a661b7975f64b8017ec7cd6c4f68a4395}{ciot\_eth\_process\_req}}(\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\_eth\_t}}\ self,\ \mbox{\hyperlink{structciot__tcp__req__t}{ciot\_tcp\_req\_t}}\ *req);} -\DoxyCodeLine{00074\ } -\DoxyCodeLine{00082\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__eth_8h_a3952717d31db12a55731412a370ceda5}{ciot\_eth\_send\_data}}(\mbox{\hyperlink{ciot__eth_8h_a3f3b88cf1c074f50fd03c724c41d9da7}{ciot\_eth\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00083\ } -\DoxyCodeLine{00084\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00085\ \}} -\DoxyCodeLine{00086\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00087\ } -\DoxyCodeLine{00088\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__gpio_8h.tex b/docs/latex/ciot__gpio_8h.tex deleted file mode 100644 index 22660a6..0000000 --- a/docs/latex/ciot__gpio_8h.tex +++ /dev/null @@ -1,210 +0,0 @@ -\doxysection{include/ciot\+\_\+gpio.h File Reference} -\hypertarget{ciot__gpio_8h}{}\label{ciot__gpio_8h}\index{include/ciot\_gpio.h@{include/ciot\_gpio.h}} - - -Header file for CIOT GPIO interface. - - -{\ttfamily \#include "{}types/ciot\+\_\+gpio\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__gpio__status__msg__t}{ciot\+\_\+gpio\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT GPIO status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+gpio \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT GPIO interface. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} \mbox{\hyperlink{ciot__gpio_8h_aea01096d6b6bfbd522e8657a845f80c3}{ciot\+\_\+gpio\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Creates a new CIOT GPIO interface instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__gpio_8h_adb7495ded0ad7759f8957513c2865799}{ciot\+\_\+gpio\+\_\+start}} (\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} self, \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Starts the CIOT GPIO interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__gpio_8h_adcb7cc03019350645bc5cc0898d9606d}{ciot\+\_\+gpio\+\_\+stop}} (\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stops the CIOT GPIO interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__gpio_8h_a442851a180a98c165e9f9492c4563737}{ciot\+\_\+gpio\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} self, \mbox{\hyperlink{structciot__gpio__req__t}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Processes a request for the CIOT GPIO interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__gpio_8h_a9c3f8ee56e12174192c444c6be0c1a5c}{ciot\+\_\+gpio\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Sends data over the CIOT GPIO interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__gpio_8h_a4a869a0c86a5b6cb73c1789a5bbd612b}{ciot\+\_\+gpio\+\_\+set\+\_\+state}} (\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} self, int gpio, \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} state) -\begin{DoxyCompactList}\small\item\em Sets the state of a GPIO pin. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} \mbox{\hyperlink{ciot__gpio_8h_a5b2cfc4c7dff3ca2d06f5ec2b8026d79}{ciot\+\_\+gpio\+\_\+get\+\_\+state}} (\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} self, int gpio) -\begin{DoxyCompactList}\small\item\em Gets the state of a GPIO pin. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT GPIO interface. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}\label{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_t@{ciot\_gpio\_t}} -\index{ciot\_gpio\_t@{ciot\_gpio\_t}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_t}{ciot\_gpio\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+gpio\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}}} - - - -Structure representing the CIOT GPIO interface. - - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__gpio_8h_a5b2cfc4c7dff3ca2d06f5ec2b8026d79}\label{ciot__gpio_8h_a5b2cfc4c7dff3ca2d06f5ec2b8026d79} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_get\_state@{ciot\_gpio\_get\_state}} -\index{ciot\_gpio\_get\_state@{ciot\_gpio\_get\_state}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_get\_state()}{ciot\_gpio\_get\_state()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} ciot\+\_\+gpio\+\_\+get\+\_\+state (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}}}]{self, }\item[{int}]{gpio }\end{DoxyParamCaption})} - - - -Gets the state of a GPIO pin. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT GPIO instance. \\ -\hline -{\em gpio} & The GPIO pin number. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -The state of the GPIO pin (CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+HIGH or CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+LOW). -\end{DoxyReturn} -\Hypertarget{ciot__gpio_8h_aea01096d6b6bfbd522e8657a845f80c3}\label{ciot__gpio_8h_aea01096d6b6bfbd522e8657a845f80c3} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_new@{ciot\_gpio\_new}} -\index{ciot\_gpio\_new@{ciot\_gpio\_new}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_new()}{ciot\_gpio\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}} ciot\+\_\+gpio\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Creates a new CIOT GPIO interface instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & The handle for the GPIO interface. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the new CIOT GPIO instance. -\end{DoxyReturn} -\Hypertarget{ciot__gpio_8h_a442851a180a98c165e9f9492c4563737}\label{ciot__gpio_8h_a442851a180a98c165e9f9492c4563737} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_process\_req@{ciot\_gpio\_process\_req}} -\index{ciot\_gpio\_process\_req@{ciot\_gpio\_process\_req}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_process\_req()}{ciot\_gpio\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+gpio\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__gpio__req__t}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Processes a request for the CIOT GPIO interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT GPIO instance. \\ -\hline -{\em req} & The GPIO request to be processed. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__gpio_8h_a9c3f8ee56e12174192c444c6be0c1a5c}\label{ciot__gpio_8h_a9c3f8ee56e12174192c444c6be0c1a5c} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_send\_data@{ciot\_gpio\_send\_data}} -\index{ciot\_gpio\_send\_data@{ciot\_gpio\_send\_data}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_send\_data()}{ciot\_gpio\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+gpio\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends data over the CIOT GPIO interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT GPIO instance. \\ -\hline -{\em data} & The data to be sent. \\ -\hline -{\em size} & The size of the data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__gpio_8h_a4a869a0c86a5b6cb73c1789a5bbd612b}\label{ciot__gpio_8h_a4a869a0c86a5b6cb73c1789a5bbd612b} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_set\_state@{ciot\_gpio\_set\_state}} -\index{ciot\_gpio\_set\_state@{ciot\_gpio\_set\_state}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_set\_state()}{ciot\_gpio\_set\_state()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+gpio\+\_\+set\+\_\+state (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}}}]{self, }\item[{int}]{gpio, }\item[{\mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}}}]{state }\end{DoxyParamCaption})} - - - -Sets the state of a GPIO pin. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT GPIO instance. \\ -\hline -{\em gpio} & The GPIO pin number. \\ -\hline -{\em state} & The state to set (CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+HIGH or CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+LOW). \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__gpio_8h_adb7495ded0ad7759f8957513c2865799}\label{ciot__gpio_8h_adb7495ded0ad7759f8957513c2865799} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_start@{ciot\_gpio\_start}} -\index{ciot\_gpio\_start@{ciot\_gpio\_start}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_start()}{ciot\_gpio\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+gpio\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Starts the CIOT GPIO interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT GPIO instance. \\ -\hline -{\em cfg} & The GPIO configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__gpio_8h_adcb7cc03019350645bc5cc0898d9606d}\label{ciot__gpio_8h_adcb7cc03019350645bc5cc0898d9606d} -\index{ciot\_gpio.h@{ciot\_gpio.h}!ciot\_gpio\_stop@{ciot\_gpio\_stop}} -\index{ciot\_gpio\_stop@{ciot\_gpio\_stop}!ciot\_gpio.h@{ciot\_gpio.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_stop()}{ciot\_gpio\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+gpio\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\+\_\+gpio\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stops the CIOT GPIO interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT GPIO instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} diff --git a/docs/latex/ciot__gpio_8h_source.tex b/docs/latex/ciot__gpio_8h_source.tex deleted file mode 100644 index 552633e..0000000 --- a/docs/latex/ciot__gpio_8h_source.tex +++ /dev/null @@ -1,44 +0,0 @@ -\doxysection{ciot\+\_\+gpio.\+h} -\hypertarget{ciot__gpio_8h_source}{}\label{ciot__gpio_8h_source}\index{include/ciot\_gpio.h@{include/ciot\_gpio.h}} -\mbox{\hyperlink{ciot__gpio_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_GPIO\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_GPIO\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__gpio__types_8h}{types/ciot\_gpio\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_gpio\ *\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__gpio__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{structciot__gpio__status__t}{ciot\_gpio\_status\_t}}\ \mbox{\hyperlink{structciot__gpio__status__msg__t_af7b93aeb68c1648ccb2617ff8217e7b0}{status}};\ } -\DoxyCodeLine{00033\ \}\ \mbox{\hyperlink{structciot__gpio__status__msg__t}{ciot\_gpio\_status\_msg\_t}};} -\DoxyCodeLine{00034\ } -\DoxyCodeLine{00040\ \mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}}\ \mbox{\hyperlink{ciot__gpio_8h_aea01096d6b6bfbd522e8657a845f80c3}{ciot\_gpio\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00048\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__gpio_8h_adb7495ded0ad7759f8957513c2865799}{ciot\_gpio\_start}}(\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}}\ self,\ \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\_gpio\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00049\ } -\DoxyCodeLine{00055\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__gpio_8h_adcb7cc03019350645bc5cc0898d9606d}{ciot\_gpio\_stop}}(\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}}\ self);} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00063\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__gpio_8h_a442851a180a98c165e9f9492c4563737}{ciot\_gpio\_process\_req}}(\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}}\ self,\ \mbox{\hyperlink{structciot__gpio__req__t}{ciot\_gpio\_req\_t}}\ *req);} -\DoxyCodeLine{00064\ } -\DoxyCodeLine{00072\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__gpio_8h_a9c3f8ee56e12174192c444c6be0c1a5c}{ciot\_gpio\_send\_data}}(\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00073\ } -\DoxyCodeLine{00081\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__gpio_8h_a4a869a0c86a5b6cb73c1789a5bbd612b}{ciot\_gpio\_set\_state}}(\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}}\ self,\ \textcolor{keywordtype}{int}\ gpio,\ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\_gpio\_state\_t}}\ state);} -\DoxyCodeLine{00082\ } -\DoxyCodeLine{00089\ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\_gpio\_state\_t}}\ \mbox{\hyperlink{ciot__gpio_8h_a5b2cfc4c7dff3ca2d06f5ec2b8026d79}{ciot\_gpio\_get\_state}}(\mbox{\hyperlink{ciot__gpio_8h_ae9e94463a96ddb2055cd747a6ac5b8dc}{ciot\_gpio\_t}}\ self,\ \textcolor{keywordtype}{int}\ gpio);} -\DoxyCodeLine{00090\ } -\DoxyCodeLine{00091\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00092\ \}} -\DoxyCodeLine{00093\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00094\ } -\DoxyCodeLine{00095\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__gpio__types_8h.tex b/docs/latex/ciot__gpio__types_8h.tex deleted file mode 100644 index b069847..0000000 --- a/docs/latex/ciot__gpio__types_8h.tex +++ /dev/null @@ -1,169 +0,0 @@ -\doxysection{include/types/ciot\+\_\+gpio\+\_\+types.h File Reference} -\hypertarget{ciot__gpio__types_8h}{}\label{ciot__gpio__types_8h}\index{include/types/ciot\_gpio\_types.h@{include/types/ciot\_gpio\_types.h}} - - -Defines data types and structures for CIOT GPIO (General Purpose Input/\+Output). - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT GPIO configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__gpio__status__t}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT GPIO status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__gpio__state__info__t}{ciot\+\_\+gpio\+\_\+state\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT GPIO state information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__gpio__req__get__state__t}{ciot\+\_\+gpio\+\_\+req\+\_\+get\+\_\+state\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT GPIO request to get state. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__gpio__req__data__u}{ciot\+\_\+gpio\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT GPIO request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__gpio__req__t}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT GPIO request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__gpio__data__u}{ciot\+\_\+gpio\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT GPIO data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9af69cfd9cebab632443f7ec571b22b8f1}{CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+ERR}} = -\/1 -, \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a5af664ade1079acf3371a80d83b16e9a}{CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+LOW}} -, \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a3b10aa4077009f19e3a75077246f1df5}{CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+HIGH}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT GPIO states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d}{ciot\+\_\+gpio\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2daf32a90c97d64c9ec2a75ebdf92bfc629}{CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da591932f3178bc6c970e89e7e3d07dfff}{CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+CONFIG}} -, \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da3717eef4db07663dddac4d766597e985}{CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+SET\+\_\+\+STATE}} -, \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2dabf5ffe4d1ff61a6e18e024b7000933ca}{CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+GET\+\_\+\+STATE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT GPIO request types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71}{ciot\+\_\+gpio\+\_\+mode\+\_\+t}} \{ \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a0201638f1798ffea9b8f9b091c443768}{CIOT\+\_\+\+GPIO\+\_\+\+MODE\+\_\+\+DIABLED}} -, \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a5dc50aace0aa33de279a2f1ac471a630}{CIOT\+\_\+\+GPIO\+\_\+\+MODE\+\_\+\+INPUT}} -, \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a4bbdd6e15ba0de21024a2db0c9330b32}{CIOT\+\_\+\+GPIO\+\_\+\+MODE\+\_\+\+OUTPUT}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT GPIO modes. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe}{ciot\+\_\+gpio\+\_\+pull\+\_\+mode\+\_\+t}} \{ \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaa6266ad862e3d90fcc7467f103417b95}{CIOT\+\_\+\+GPIO\+\_\+\+PULL\+\_\+\+DISABLED}} -, \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaf9207baa17fdde6ffa3b6bd58a1ec754}{CIOT\+\_\+\+GPIO\+\_\+\+PULLUP}} -, \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeab6c8129e2821fea62d640964f7266c43}{CIOT\+\_\+\+GPIO\+\_\+\+PULLDOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT GPIO pull modes. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT GPIO (General Purpose Input/\+Output). - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71}\label{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71} -\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!ciot\_gpio\_mode\_t@{ciot\_gpio\_mode\_t}} -\index{ciot\_gpio\_mode\_t@{ciot\_gpio\_mode\_t}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_mode\_t}{ciot\_gpio\_mode\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71}{ciot\+\_\+gpio\+\_\+mode\+\_\+t}}} - - - -Enumeration for CIOT GPIO modes. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_MODE\_DIABLED@{CIOT\_GPIO\_MODE\_DIABLED}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_MODE\_DIABLED@{CIOT\_GPIO\_MODE\_DIABLED}}}\Hypertarget{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a0201638f1798ffea9b8f9b091c443768}\label{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a0201638f1798ffea9b8f9b091c443768} -CIOT\+\_\+\+GPIO\+\_\+\+MODE\+\_\+\+DIABLED&Disabled mode \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_MODE\_INPUT@{CIOT\_GPIO\_MODE\_INPUT}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_MODE\_INPUT@{CIOT\_GPIO\_MODE\_INPUT}}}\Hypertarget{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a5dc50aace0aa33de279a2f1ac471a630}\label{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a5dc50aace0aa33de279a2f1ac471a630} -CIOT\+\_\+\+GPIO\+\_\+\+MODE\+\_\+\+INPUT&Input mode \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_MODE\_OUTPUT@{CIOT\_GPIO\_MODE\_OUTPUT}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_MODE\_OUTPUT@{CIOT\_GPIO\_MODE\_OUTPUT}}}\Hypertarget{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a4bbdd6e15ba0de21024a2db0c9330b32}\label{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a4bbdd6e15ba0de21024a2db0c9330b32} -CIOT\+\_\+\+GPIO\+\_\+\+MODE\+\_\+\+OUTPUT&Output mode \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe}\label{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe} -\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!ciot\_gpio\_pull\_mode\_t@{ciot\_gpio\_pull\_mode\_t}} -\index{ciot\_gpio\_pull\_mode\_t@{ciot\_gpio\_pull\_mode\_t}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_pull\_mode\_t}{ciot\_gpio\_pull\_mode\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe}{ciot\+\_\+gpio\+\_\+pull\+\_\+mode\+\_\+t}}} - - - -Enumeration for CIOT GPIO pull modes. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_PULL\_DISABLED@{CIOT\_GPIO\_PULL\_DISABLED}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_PULL\_DISABLED@{CIOT\_GPIO\_PULL\_DISABLED}}}\Hypertarget{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaa6266ad862e3d90fcc7467f103417b95}\label{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaa6266ad862e3d90fcc7467f103417b95} -CIOT\+\_\+\+GPIO\+\_\+\+PULL\+\_\+\+DISABLED&Pull disabled mode \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_PULLUP@{CIOT\_GPIO\_PULLUP}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_PULLUP@{CIOT\_GPIO\_PULLUP}}}\Hypertarget{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaf9207baa17fdde6ffa3b6bd58a1ec754}\label{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaf9207baa17fdde6ffa3b6bd58a1ec754} -CIOT\+\_\+\+GPIO\+\_\+\+PULLUP&Pull-\/up mode \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_PULLDOWN@{CIOT\_GPIO\_PULLDOWN}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_PULLDOWN@{CIOT\_GPIO\_PULLDOWN}}}\Hypertarget{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeab6c8129e2821fea62d640964f7266c43}\label{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeab6c8129e2821fea62d640964f7266c43} -CIOT\+\_\+\+GPIO\+\_\+\+PULLDOWN&Pull-\/down mode \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d}\label{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d} -\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!ciot\_gpio\_req\_type\_t@{ciot\_gpio\_req\_type\_t}} -\index{ciot\_gpio\_req\_type\_t@{ciot\_gpio\_req\_type\_t}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_req\_type\_t}{ciot\_gpio\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d}{ciot\+\_\+gpio\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT GPIO request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_REQ\_UNKNOWN@{CIOT\_GPIO\_REQ\_UNKNOWN}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_REQ\_UNKNOWN@{CIOT\_GPIO\_REQ\_UNKNOWN}}}\Hypertarget{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2daf32a90c97d64c9ec2a75ebdf92bfc629}\label{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2daf32a90c97d64c9ec2a75ebdf92bfc629} -CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_REQ\_CONFIG@{CIOT\_GPIO\_REQ\_CONFIG}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_REQ\_CONFIG@{CIOT\_GPIO\_REQ\_CONFIG}}}\Hypertarget{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da591932f3178bc6c970e89e7e3d07dfff}\label{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da591932f3178bc6c970e89e7e3d07dfff} -CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+CONFIG&Configure GPIO request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_REQ\_SET\_STATE@{CIOT\_GPIO\_REQ\_SET\_STATE}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_REQ\_SET\_STATE@{CIOT\_GPIO\_REQ\_SET\_STATE}}}\Hypertarget{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da3717eef4db07663dddac4d766597e985}\label{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da3717eef4db07663dddac4d766597e985} -CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+SET\+\_\+\+STATE&Set GPIO state request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_REQ\_GET\_STATE@{CIOT\_GPIO\_REQ\_GET\_STATE}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_REQ\_GET\_STATE@{CIOT\_GPIO\_REQ\_GET\_STATE}}}\Hypertarget{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2dabf5ffe4d1ff61a6e18e024b7000933ca}\label{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2dabf5ffe4d1ff61a6e18e024b7000933ca} -CIOT\+\_\+\+GPIO\+\_\+\+REQ\+\_\+\+GET\+\_\+\+STATE&Get GPIO state request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}\label{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9} -\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!ciot\_gpio\_state\_t@{ciot\_gpio\_state\_t}} -\index{ciot\_gpio\_state\_t@{ciot\_gpio\_state\_t}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_gpio\_state\_t}{ciot\_gpio\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT GPIO states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_STATE\_ERR@{CIOT\_GPIO\_STATE\_ERR}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_STATE\_ERR@{CIOT\_GPIO\_STATE\_ERR}}}\Hypertarget{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9af69cfd9cebab632443f7ec571b22b8f1}\label{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9af69cfd9cebab632443f7ec571b22b8f1} -CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+ERR&Error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_STATE\_LOW@{CIOT\_GPIO\_STATE\_LOW}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_STATE\_LOW@{CIOT\_GPIO\_STATE\_LOW}}}\Hypertarget{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a5af664ade1079acf3371a80d83b16e9a}\label{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a5af664ade1079acf3371a80d83b16e9a} -CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+LOW&Low state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_GPIO\_STATE\_HIGH@{CIOT\_GPIO\_STATE\_HIGH}!ciot\_gpio\_types.h@{ciot\_gpio\_types.h}}\index{ciot\_gpio\_types.h@{ciot\_gpio\_types.h}!CIOT\_GPIO\_STATE\_HIGH@{CIOT\_GPIO\_STATE\_HIGH}}}\Hypertarget{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a3b10aa4077009f19e3a75077246f1df5}\label{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a3b10aa4077009f19e3a75077246f1df5} -CIOT\+\_\+\+GPIO\+\_\+\+STATE\+\_\+\+HIGH&High state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__gpio__types_8h_source.tex b/docs/latex/ciot__gpio__types_8h_source.tex deleted file mode 100644 index 9dc6d73..0000000 --- a/docs/latex/ciot__gpio__types_8h_source.tex +++ /dev/null @@ -1,93 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+types.\+h} -\hypertarget{ciot__gpio__types_8h_source}{}\label{ciot__gpio__types_8h_source}\index{include/types/ciot\_gpio\_types.h@{include/types/ciot\_gpio\_types.h}} -\mbox{\hyperlink{ciot__gpio__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_GPIO\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_GPIO\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9af69cfd9cebab632443f7ec571b22b8f1}{CIOT\_GPIO\_STATE\_ERR}}\ =\ -\/1,\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a5af664ade1079acf3371a80d83b16e9a}{CIOT\_GPIO\_STATE\_LOW}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9a3b10aa4077009f19e3a75077246f1df5}{CIOT\_GPIO\_STATE\_HIGH}}\ } -\DoxyCodeLine{00028\ \}\ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\_gpio\_state\_t}};} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00033\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00034\ \{} -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2daf32a90c97d64c9ec2a75ebdf92bfc629}{CIOT\_GPIO\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da591932f3178bc6c970e89e7e3d07dfff}{CIOT\_GPIO\_REQ\_CONFIG}},\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2da3717eef4db07663dddac4d766597e985}{CIOT\_GPIO\_REQ\_SET\_STATE}},\ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2dabf5ffe4d1ff61a6e18e024b7000933ca}{CIOT\_GPIO\_REQ\_GET\_STATE}}\ } -\DoxyCodeLine{00039\ \}\ \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d}{ciot\_gpio\_req\_type\_t}};} -\DoxyCodeLine{00040\ } -\DoxyCodeLine{00044\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00045\ \{} -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a0201638f1798ffea9b8f9b091c443768}{CIOT\_GPIO\_MODE\_DIABLED}},\ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a5dc50aace0aa33de279a2f1ac471a630}{CIOT\_GPIO\_MODE\_INPUT}},\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71a4bbdd6e15ba0de21024a2db0c9330b32}{CIOT\_GPIO\_MODE\_OUTPUT}}\ } -\DoxyCodeLine{00049\ \}\ \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71}{ciot\_gpio\_mode\_t}};} -\DoxyCodeLine{00050\ } -\DoxyCodeLine{00054\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00055\ \{} -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaa6266ad862e3d90fcc7467f103417b95}{CIOT\_GPIO\_PULL\_DISABLED}},\ } -\DoxyCodeLine{00057\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeaf9207baa17fdde6ffa3b6bd58a1ec754}{CIOT\_GPIO\_PULLUP}},\ } -\DoxyCodeLine{00058\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfeab6c8129e2821fea62d640964f7266c43}{CIOT\_GPIO\_PULLDOWN}}\ } -\DoxyCodeLine{00059\ \}\ \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe}{ciot\_gpio\_pull\_mode\_t}};} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00064\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00065\ \{} -\DoxyCodeLine{00066\ \ \ \ \ uint64\_t\ \mbox{\hyperlink{structciot__gpio__cfg__t_a3feeb7044549691a36c39cc7c9b2ed2c}{pin\_mask}};\ } -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71}{ciot\_gpio\_mode\_t}}\ \mbox{\hyperlink{structciot__gpio__cfg__t_a7d76e224ede8a4fa709cc3a505a81975}{mode}};\ } -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe}{ciot\_gpio\_pull\_mode\_t}}\ \mbox{\hyperlink{structciot__gpio__cfg__t_a5ee68c0e31fa06f342fad371023bdc4e}{pull}};\ } -\DoxyCodeLine{00069\ \}\ \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\_gpio\_cfg\_t}};} -\DoxyCodeLine{00070\ } -\DoxyCodeLine{00074\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00075\ \{} -\DoxyCodeLine{00076\ \ \ \ \ uint64\_t\ \mbox{\hyperlink{structciot__gpio__status__t_af557caa253a733e218e1e71c2a91eef4}{status\_mask}};\ } -\DoxyCodeLine{00077\ \}\ \mbox{\hyperlink{structciot__gpio__status__t}{ciot\_gpio\_status\_t}};} -\DoxyCodeLine{00078\ } -\DoxyCodeLine{00082\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00083\ \{} -\DoxyCodeLine{00084\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__gpio__state__info__t_a7beea8f6745c478347f244cadef771c2}{num}};\ } -\DoxyCodeLine{00085\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\_gpio\_state\_t}}\ \mbox{\hyperlink{structciot__gpio__state__info__t_a939fe9a85b37a0ce4a0701b655c799ea}{state}};\ } -\DoxyCodeLine{00086\ \}\ \mbox{\hyperlink{structciot__gpio__state__info__t}{ciot\_gpio\_state\_info\_t}};} -\DoxyCodeLine{00087\ } -\DoxyCodeLine{00091\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00092\ \{} -\DoxyCodeLine{00093\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__gpio__req__get__state__t_a7beea8f6745c478347f244cadef771c2}{num}};\ } -\DoxyCodeLine{00094\ \}\ \mbox{\hyperlink{structciot__gpio__req__get__state__t}{ciot\_gpio\_req\_get\_state\_t}};} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00099\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00100\ \{} -\DoxyCodeLine{00101\ \ \ \ \ \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\_gpio\_cfg\_t}}\ \mbox{\hyperlink{unionciot__gpio__req__data__u_a15039efacca36cdba57c2ccf7b0a3d4f}{config}};\ } -\DoxyCodeLine{00102\ \ \ \ \ \mbox{\hyperlink{structciot__gpio__state__info__t}{ciot\_gpio\_state\_info\_t}}\ \mbox{\hyperlink{unionciot__gpio__req__data__u_a5cc92c2a01be84c116055f80d77e5140}{set\_state}};\ } -\DoxyCodeLine{00103\ \ \ \ \ \mbox{\hyperlink{structciot__gpio__req__get__state__t}{ciot\_gpio\_req\_get\_state\_t}}\ \mbox{\hyperlink{unionciot__gpio__req__data__u_a93559a0f91d62042000a3276dc457506}{get\_state}};\ } -\DoxyCodeLine{00104\ \}\ \mbox{\hyperlink{unionciot__gpio__req__data__u}{ciot\_gpio\_req\_data\_u}};} -\DoxyCodeLine{00105\ } -\DoxyCodeLine{00109\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00110\ \{} -\DoxyCodeLine{00111\ \ \ \ \ \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d}{ciot\_gpio\_req\_type\_t}}\ \mbox{\hyperlink{structciot__gpio__req__t_ab949dccfc732240972d8a27cf46f3e76}{type}};\ } -\DoxyCodeLine{00112\ \ \ \ \ \mbox{\hyperlink{unionciot__gpio__req__data__u}{ciot\_gpio\_req\_data\_u}}\ \mbox{\hyperlink{structciot__gpio__req__t_a8742485122a2b9e44392d5d51ddc2076}{data}};\ } -\DoxyCodeLine{00113\ \}\ \mbox{\hyperlink{structciot__gpio__req__t}{ciot\_gpio\_req\_t}};} -\DoxyCodeLine{00114\ } -\DoxyCodeLine{00118\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00119\ \{} -\DoxyCodeLine{00120\ \ \ \ \ \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\_gpio\_cfg\_t}}\ \mbox{\hyperlink{unionciot__gpio__data__u_a15039efacca36cdba57c2ccf7b0a3d4f}{config}};\ } -\DoxyCodeLine{00121\ \ \ \ \ \mbox{\hyperlink{structciot__gpio__status__t}{ciot\_gpio\_status\_t}}\ \mbox{\hyperlink{unionciot__gpio__data__u_af7b93aeb68c1648ccb2617ff8217e7b0}{status}};\ } -\DoxyCodeLine{00122\ \ \ \ \ \mbox{\hyperlink{structciot__gpio__req__t}{ciot\_gpio\_req\_t}}\ \mbox{\hyperlink{unionciot__gpio__data__u_ac3fb50fe28f5e2ea50c6f662aa19beca}{request}};\ } -\DoxyCodeLine{00123\ \}\ \mbox{\hyperlink{unionciot__gpio__data__u}{ciot\_gpio\_data\_u}};} -\DoxyCodeLine{00124\ } -\DoxyCodeLine{00125\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00126\ \}} -\DoxyCodeLine{00127\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00128\ } -\DoxyCodeLine{00129\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__httpc_8h.tex b/docs/latex/ciot__httpc_8h.tex deleted file mode 100644 index 8b6b78a..0000000 --- a/docs/latex/ciot__httpc_8h.tex +++ /dev/null @@ -1,206 +0,0 @@ -\doxysection{include/ciot\+\_\+httpc.h File Reference} -\hypertarget{ciot__httpc_8h}{}\label{ciot__httpc_8h}\index{include/ciot\_httpc.h@{include/ciot\_httpc.h}} - - -Header file for CIOT HTTP client interface. - - -{\ttfamily \#include "{}types/ciot\+\_\+httpc\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__httpc__status__msg__t}{ciot\+\_\+httpc\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT HTTP client status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+httpc \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT HTTP client interface. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8}{ciot\+\_\+httpc\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__httpc_8h_a8992ff730daa4b1341950e1fcc062095}{ciot\+\_\+httpc\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration of HTTP client event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8}{ciot\+\_\+httpc\+\_\+event\+\_\+id}} \{ \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8afb97828385b4f79444b7ebfc7640bde9}{CIOT\+\_\+\+HTTPC\+\_\+\+EVENT\+\_\+\+CONNECTING}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM -, \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8a3f5ae57e03d9b825c8fb4733c15359db}{CIOT\+\_\+\+HTTPC\+\_\+\+EVENT\+\_\+\+CONNECTED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration of HTTP client event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} \mbox{\hyperlink{ciot__httpc_8h_aa56416d08a9bcfbc90b3732204f02e4c}{ciot\+\_\+httpc\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Creates a new CIOT HTTP client interface instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__httpc_8h_a46df5188166f70dba4fdff5393db031e}{ciot\+\_\+httpc\+\_\+start}} (\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} self, \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Starts the CIOT HTTP client interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__httpc_8h_a34deca8f36a9ebbb7b47663a026efc71}{ciot\+\_\+httpc\+\_\+stop}} (\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stops the CIOT HTTP client interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__httpc_8h_aeb4ac97854627dc732459e7c0b60a900}{ciot\+\_\+httpc\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} self, \mbox{\hyperlink{structciot__httpc__req__t}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Processes a request for the CIOT HTTP client interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__httpc_8h_a8b0903c7bdf6e8928d3753c06f13c564}{ciot\+\_\+httpc\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Sends data over the CIOT HTTP client interface. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT HTTP client interface. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__httpc_8h_a8992ff730daa4b1341950e1fcc062095}\label{ciot__httpc_8h_a8992ff730daa4b1341950e1fcc062095} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_event\_id\_t@{ciot\_httpc\_event\_id\_t}} -\index{ciot\_httpc\_event\_id\_t@{ciot\_httpc\_event\_id\_t}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_event\_id\_t}{ciot\_httpc\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8}{ciot\+\_\+httpc\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__httpc_8h_a8992ff730daa4b1341950e1fcc062095}{ciot\+\_\+httpc\+\_\+event\+\_\+id\+\_\+t}}} - - - -Enumeration of HTTP client event IDs. - -\Hypertarget{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}\label{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_t@{ciot\_httpc\_t}} -\index{ciot\_httpc\_t@{ciot\_httpc\_t}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_t}{ciot\_httpc\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+httpc\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}}} - - - -Structure representing the CIOT HTTP client interface. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8}\label{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_event\_id@{ciot\_httpc\_event\_id}} -\index{ciot\_httpc\_event\_id@{ciot\_httpc\_event\_id}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_event\_id}{ciot\_httpc\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8}{ciot\+\_\+httpc\+\_\+event\+\_\+id}}} - - - -Enumeration of HTTP client event IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_EVENT\_CONNECTING@{CIOT\_HTTPC\_EVENT\_CONNECTING}!ciot\_httpc.h@{ciot\_httpc.h}}\index{ciot\_httpc.h@{ciot\_httpc.h}!CIOT\_HTTPC\_EVENT\_CONNECTING@{CIOT\_HTTPC\_EVENT\_CONNECTING}}}\Hypertarget{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8afb97828385b4f79444b7ebfc7640bde9}\label{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8afb97828385b4f79444b7ebfc7640bde9} -CIOT\+\_\+\+HTTPC\+\_\+\+EVENT\+\_\+\+CONNECTING&Event ID for connecting. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_EVENT\_CONNECTED@{CIOT\_HTTPC\_EVENT\_CONNECTED}!ciot\_httpc.h@{ciot\_httpc.h}}\index{ciot\_httpc.h@{ciot\_httpc.h}!CIOT\_HTTPC\_EVENT\_CONNECTED@{CIOT\_HTTPC\_EVENT\_CONNECTED}}}\Hypertarget{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8a3f5ae57e03d9b825c8fb4733c15359db}\label{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8a3f5ae57e03d9b825c8fb4733c15359db} -CIOT\+\_\+\+HTTPC\+\_\+\+EVENT\+\_\+\+CONNECTED&Event ID for connected. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__httpc_8h_aa56416d08a9bcfbc90b3732204f02e4c}\label{ciot__httpc_8h_aa56416d08a9bcfbc90b3732204f02e4c} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_new@{ciot\_httpc\_new}} -\index{ciot\_httpc\_new@{ciot\_httpc\_new}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_new()}{ciot\_httpc\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} ciot\+\_\+httpc\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Creates a new CIOT HTTP client interface instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & The handle for the HTTP client interface. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the new CIOT HTTP client instance. -\end{DoxyReturn} -\Hypertarget{ciot__httpc_8h_aeb4ac97854627dc732459e7c0b60a900}\label{ciot__httpc_8h_aeb4ac97854627dc732459e7c0b60a900} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_process\_req@{ciot\_httpc\_process\_req}} -\index{ciot\_httpc\_process\_req@{ciot\_httpc\_process\_req}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_process\_req()}{ciot\_httpc\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+httpc\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__httpc__req__t}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Processes a request for the CIOT HTTP client interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP client instance. \\ -\hline -{\em req} & The HTTP client request to be processed. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__httpc_8h_a8b0903c7bdf6e8928d3753c06f13c564}\label{ciot__httpc_8h_a8b0903c7bdf6e8928d3753c06f13c564} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_send\_data@{ciot\_httpc\_send\_data}} -\index{ciot\_httpc\_send\_data@{ciot\_httpc\_send\_data}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_send\_data()}{ciot\_httpc\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+httpc\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends data over the CIOT HTTP client interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP client instance. \\ -\hline -{\em data} & The data to be sent. \\ -\hline -{\em size} & The size of the data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__httpc_8h_a46df5188166f70dba4fdff5393db031e}\label{ciot__httpc_8h_a46df5188166f70dba4fdff5393db031e} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_start@{ciot\_httpc\_start}} -\index{ciot\_httpc\_start@{ciot\_httpc\_start}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_start()}{ciot\_httpc\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+httpc\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Starts the CIOT HTTP client interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP client instance. \\ -\hline -{\em cfg} & The HTTP client configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__httpc_8h_a34deca8f36a9ebbb7b47663a026efc71}\label{ciot__httpc_8h_a34deca8f36a9ebbb7b47663a026efc71} -\index{ciot\_httpc.h@{ciot\_httpc.h}!ciot\_httpc\_stop@{ciot\_httpc\_stop}} -\index{ciot\_httpc\_stop@{ciot\_httpc\_stop}!ciot\_httpc.h@{ciot\_httpc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_stop()}{ciot\_httpc\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+httpc\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stops the CIOT HTTP client interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP client instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} diff --git a/docs/latex/ciot__httpc_8h_source.tex b/docs/latex/ciot__httpc_8h_source.tex deleted file mode 100644 index 604bd21..0000000 --- a/docs/latex/ciot__httpc_8h_source.tex +++ /dev/null @@ -1,45 +0,0 @@ -\doxysection{ciot\+\_\+httpc.\+h} -\hypertarget{ciot__httpc_8h_source}{}\label{ciot__httpc_8h_source}\index{include/ciot\_httpc.h@{include/ciot\_httpc.h}} -\mbox{\hyperlink{ciot__httpc_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_HTTPC\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_HTTPC\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__httpc__types_8h}{types/ciot\_httpc\_types.h}}"{}}} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00024\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_httpc\ *\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\_httpc\_t}};} -\DoxyCodeLine{00025\ } -\DoxyCodeLine{00029\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8}{ciot\_httpc\_event\_id}}\ \{} -\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8afb97828385b4f79444b7ebfc7640bde9}{CIOT\_HTTPC\_EVENT\_CONNECTING}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{ciot__httpc_8h_a7867b22f4a59e270cd0aadf3165804a8a3f5ae57e03d9b825c8fb4733c15359db}{CIOT\_HTTPC\_EVENT\_CONNECTED}},\ } -\DoxyCodeLine{00032\ \}\ \mbox{\hyperlink{ciot__httpc_8h_a8992ff730daa4b1341950e1fcc062095}{ciot\_httpc\_event\_id\_t}};} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00037\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__httpc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__status__t}{ciot\_httpc\_status\_t}}\ \mbox{\hyperlink{structciot__httpc__status__msg__t_ac5c1eb82650b9d0161a399175c459ad3}{status}};\ } -\DoxyCodeLine{00040\ \}\ \mbox{\hyperlink{structciot__httpc__status__msg__t}{ciot\_httpc\_status\_msg\_t}};} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00047\ \mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\_httpc\_t}}\ \mbox{\hyperlink{ciot__httpc_8h_aa56416d08a9bcfbc90b3732204f02e4c}{ciot\_httpc\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00048\ } -\DoxyCodeLine{00055\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__httpc_8h_a46df5188166f70dba4fdff5393db031e}{ciot\_httpc\_start}}(\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\_httpc\_t}}\ self,\ \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\_httpc\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00062\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__httpc_8h_a34deca8f36a9ebbb7b47663a026efc71}{ciot\_httpc\_stop}}(\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\_httpc\_t}}\ self);} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00070\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__httpc_8h_aeb4ac97854627dc732459e7c0b60a900}{ciot\_httpc\_process\_req}}(\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\_httpc\_t}}\ self,\ \mbox{\hyperlink{structciot__httpc__req__t}{ciot\_httpc\_req\_t}}\ *req);} -\DoxyCodeLine{00071\ } -\DoxyCodeLine{00079\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__httpc_8h_a8b0903c7bdf6e8928d3753c06f13c564}{ciot\_httpc\_send\_data}}(\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\_httpc\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00080\ } -\DoxyCodeLine{00081\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00082\ \}} -\DoxyCodeLine{00083\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__httpc__types_8h.tex b/docs/latex/ciot__httpc__types_8h.tex deleted file mode 100644 index 16254a3..0000000 --- a/docs/latex/ciot__httpc__types_8h.tex +++ /dev/null @@ -1,359 +0,0 @@ -\doxysection{include/types/ciot\+\_\+httpc\+\_\+types.h File Reference} -\hypertarget{ciot__httpc__types_8h}{}\label{ciot__httpc__types_8h}\index{include/types/ciot\_httpc\_types.h@{include/types/ciot\_httpc\_types.h}} - - -Defines data types and structures for CIOT HTTP client. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+common\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP client configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__httpc__status__t}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP client status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__httpc__req__send__t}{ciot\+\_\+httpc\+\_\+req\+\_\+send\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP client send data request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__httpc__req__set__header__t}{ciot\+\_\+httpc\+\_\+req\+\_\+set\+\_\+header\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP client set header request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__httpc__req__data}{ciot\+\_\+httpc\+\_\+req\+\_\+data}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP client request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__httpc__req__t}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP client request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__httpc__event__data}{ciot\+\_\+httpc\+\_\+event\+\_\+data}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP client event data. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__httpc__event}{ciot\+\_\+httpc\+\_\+event}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP client event. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__httpc__data__u}{ciot\+\_\+httpc\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP client data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__httpc__types_8h_ab32b0446ee870bfb7a79c056a81e6683}{CIOT\+\_\+\+HTTPC\+\_\+\+URL\+\_\+\+LEN}}~64 -\item -\#define \mbox{\hyperlink{ciot__httpc__types_8h_af6ec592d3f9ba347d3534361538fb04b}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+LEN}}~8 -\item -\#define \mbox{\hyperlink{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd}{CIOT\+\_\+\+HTTPC\+\_\+\+BODY\+\_\+\+LEN}}~256 -\item -\#define \mbox{\hyperlink{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+LEN}}~48 -\item -\#define \mbox{\hyperlink{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+VAL}}~48 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef union \mbox{\hyperlink{unionciot__httpc__req__data}{ciot\+\_\+httpc\+\_\+req\+\_\+data}} \mbox{\hyperlink{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}{ciot\+\_\+httpc\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP client request data. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__httpc__event__data}{ciot\+\_\+httpc\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__httpc__types_8h_a491fa8406af26b99bd40ebb9ab2329da}{ciot\+\_\+httpc\+\_\+event\+\_\+data\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP client event data. \end{DoxyCompactList}\item -typedef union \mbox{\hyperlink{unionciot__httpc__event}{ciot\+\_\+httpc\+\_\+event}} \mbox{\hyperlink{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}{ciot\+\_\+httpc\+\_\+event\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP client event. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5}{ciot\+\_\+httpc\+\_\+state\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5ab4a3e67dcc1afbfba00d0df61b40b8da}{CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a76b62150d0e55c88c843115abdd10071}{CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5aeb32c53e0ba4ee494743e1931be6eeec}{CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0bd77b70defc26341e91f9b6922252f9}{CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+CONNECTING}} -, \newline -\mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0df909f7e832643e2cf49aa050d023dd}{CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+CONNECTED}} -, \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a2f5ce6951d2b9d638c13c4938b0c01c7}{CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+DATA\+\_\+\+RECEIVED}} -, \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a41421c36fcf36da91a51f06855224157}{CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+TIMEOUT}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT HTTP client states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb}{ciot\+\_\+httpc\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba2c25436ee320558e3b39e0278af195e1}{CIOT\+\_\+\+HTTPC\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cbad7ea3f3d9a71d83af66217bb6887312a}{CIOT\+\_\+\+HTTPC\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba572be88b8d0c24041a432f1dc4a4ae16}{CIOT\+\_\+\+HTTPC\+\_\+\+REQ\+\_\+\+SET\+\_\+\+HEADER}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT HTTP client request types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7}{ciot\+\_\+httpc\+\_\+method\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a650e5214875a4cdd3e347425901c5577}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+GET}} = 0 -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac0f3e0c43ca1d9895d911a61aa3a0a3d}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+POST}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3fecc1706149db9a7031a9726564e50e}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PUT}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3907ae9dfab102ca11b9f52c35831aa3}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PATCH}} -, \newline -\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a0f4269d141ab0dc5832a06a1e918f882}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+DELETE}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7af157cd0398674ba1012f6768e47ea8bf}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+HEAD}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a26c3f63b94bcfab576aee93a1ebe6e58}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+NOTIFY}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a4995d14b4b9469afee820440e999d031}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+SUBSCRIBE}} -, \newline -\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a8a9fbce8b6f60e6d17568fc73d2ae9fa}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+UNSUBSCRIBE}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aad83faf84362fa782451b9b7813cb903}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+OPTIONS}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aa8be300f4466d5d8e37ad27c4fb48b67}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+COPY}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a554691606720719d5c7d18aec331d819}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+MOVE}} -, \newline -\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a9ba67439f21bc5a14f885acb4702e7a6}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+LOCK}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a5227db99bf72a1289368d5542cfcafa2}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+UNLOCK}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a517da021c623763eb791f30ff5a21d8c}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PROPFIND}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac96588e2a31fb4cab864cafdb28fd6a2}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PROPPATCH}} -, \newline -\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a615ae69783de68e87fe6b10d15fcf241}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+MKCOL}} -, \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a717d104c5930fd4723ccab14fa590955}{CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+MAX}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for HTTP methods. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2}{ciot\+\_\+httpc\+\_\+transport\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a22a12a1f89b04f673e7c6da6120118fb}{CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2ac0b77b7cf582d3d2adb20f67dac8cea1}{CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+TCP}} -, \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a2b14353c34ecb4525e768f4ba62da6b8}{CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+SSL}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for HTTP client transport types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT HTTP client. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/11 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd}\label{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_BODY\_LEN@{CIOT\_HTTPC\_BODY\_LEN}} -\index{CIOT\_HTTPC\_BODY\_LEN@{CIOT\_HTTPC\_BODY\_LEN}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPC\_BODY\_LEN}{CIOT\_HTTPC\_BODY\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPC\+\_\+\+BODY\+\_\+\+LEN~256} - -Maximum length of HTTP request body \Hypertarget{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9}\label{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_HEADER\_LEN@{CIOT\_HTTPC\_HEADER\_LEN}} -\index{CIOT\_HTTPC\_HEADER\_LEN@{CIOT\_HTTPC\_HEADER\_LEN}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPC\_HEADER\_LEN}{CIOT\_HTTPC\_HEADER\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+LEN~48} - -Maximum length of HTTP header \Hypertarget{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6}\label{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_HEADER\_VAL@{CIOT\_HTTPC\_HEADER\_VAL}} -\index{CIOT\_HTTPC\_HEADER\_VAL@{CIOT\_HTTPC\_HEADER\_VAL}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPC\_HEADER\_VAL}{CIOT\_HTTPC\_HEADER\_VAL}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+VAL~48} - -Maximum length of HTTP header value \Hypertarget{ciot__httpc__types_8h_af6ec592d3f9ba347d3534361538fb04b}\label{ciot__httpc__types_8h_af6ec592d3f9ba347d3534361538fb04b} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_LEN@{CIOT\_HTTPC\_METHOD\_LEN}} -\index{CIOT\_HTTPC\_METHOD\_LEN@{CIOT\_HTTPC\_METHOD\_LEN}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPC\_METHOD\_LEN}{CIOT\_HTTPC\_METHOD\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+LEN~8} - -Maximum length of HTTP method \Hypertarget{ciot__httpc__types_8h_ab32b0446ee870bfb7a79c056a81e6683}\label{ciot__httpc__types_8h_ab32b0446ee870bfb7a79c056a81e6683} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_URL\_LEN@{CIOT\_HTTPC\_URL\_LEN}} -\index{CIOT\_HTTPC\_URL\_LEN@{CIOT\_HTTPC\_URL\_LEN}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPC\_URL\_LEN}{CIOT\_HTTPC\_URL\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPC\+\_\+\+URL\+\_\+\+LEN~64} - -Maximum length of URL - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__httpc__types_8h_a491fa8406af26b99bd40ebb9ab2329da}\label{ciot__httpc__types_8h_a491fa8406af26b99bd40ebb9ab2329da} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!ciot\_httpc\_event\_data\_t@{ciot\_httpc\_event\_data\_t}} -\index{ciot\_httpc\_event\_data\_t@{ciot\_httpc\_event\_data\_t}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_event\_data\_t}{ciot\_httpc\_event\_data\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__httpc__event__data}{ciot\+\_\+httpc\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__httpc__types_8h_a491fa8406af26b99bd40ebb9ab2329da}{ciot\+\_\+httpc\+\_\+event\+\_\+data\+\_\+t}}} - - - -Structure for CIOT HTTP client event data. - -\Hypertarget{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}\label{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!ciot\_httpc\_event\_u@{ciot\_httpc\_event\_u}} -\index{ciot\_httpc\_event\_u@{ciot\_httpc\_event\_u}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_event\_u}{ciot\_httpc\_event\_u}} -{\footnotesize\ttfamily typedef union \mbox{\hyperlink{unionciot__httpc__event}{ciot\+\_\+httpc\+\_\+event}} \mbox{\hyperlink{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}{ciot\+\_\+httpc\+\_\+event\+\_\+u}}} - - - -Union for CIOT HTTP client event. - -\Hypertarget{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}\label{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!ciot\_httpc\_req\_data\_u@{ciot\_httpc\_req\_data\_u}} -\index{ciot\_httpc\_req\_data\_u@{ciot\_httpc\_req\_data\_u}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_req\_data\_u}{ciot\_httpc\_req\_data\_u}} -{\footnotesize\ttfamily typedef union \mbox{\hyperlink{unionciot__httpc__req__data}{ciot\+\_\+httpc\+\_\+req\+\_\+data}} \mbox{\hyperlink{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}{ciot\+\_\+httpc\+\_\+req\+\_\+data\+\_\+u}}} - - - -Union for CIOT HTTP client request data. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!ciot\_httpc\_method\_t@{ciot\_httpc\_method\_t}} -\index{ciot\_httpc\_method\_t@{ciot\_httpc\_method\_t}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_method\_t}{ciot\_httpc\_method\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7}{ciot\+\_\+httpc\+\_\+method\+\_\+t}}} - - - -Enumeration for HTTP methods. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_GET@{CIOT\_HTTPC\_METHOD\_GET}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_GET@{CIOT\_HTTPC\_METHOD\_GET}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a650e5214875a4cdd3e347425901c5577}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a650e5214875a4cdd3e347425901c5577} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+GET&GET method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_POST@{CIOT\_HTTPC\_METHOD\_POST}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_POST@{CIOT\_HTTPC\_METHOD\_POST}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac0f3e0c43ca1d9895d911a61aa3a0a3d}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac0f3e0c43ca1d9895d911a61aa3a0a3d} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+POST&POST method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_PUT@{CIOT\_HTTPC\_METHOD\_PUT}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_PUT@{CIOT\_HTTPC\_METHOD\_PUT}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3fecc1706149db9a7031a9726564e50e}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3fecc1706149db9a7031a9726564e50e} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PUT&PUT method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_PATCH@{CIOT\_HTTPC\_METHOD\_PATCH}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_PATCH@{CIOT\_HTTPC\_METHOD\_PATCH}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3907ae9dfab102ca11b9f52c35831aa3}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3907ae9dfab102ca11b9f52c35831aa3} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PATCH&PATCH method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_DELETE@{CIOT\_HTTPC\_METHOD\_DELETE}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_DELETE@{CIOT\_HTTPC\_METHOD\_DELETE}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a0f4269d141ab0dc5832a06a1e918f882}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a0f4269d141ab0dc5832a06a1e918f882} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+DELETE&DELETE method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_HEAD@{CIOT\_HTTPC\_METHOD\_HEAD}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_HEAD@{CIOT\_HTTPC\_METHOD\_HEAD}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7af157cd0398674ba1012f6768e47ea8bf}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7af157cd0398674ba1012f6768e47ea8bf} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+HEAD&HEAD method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_NOTIFY@{CIOT\_HTTPC\_METHOD\_NOTIFY}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_NOTIFY@{CIOT\_HTTPC\_METHOD\_NOTIFY}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a26c3f63b94bcfab576aee93a1ebe6e58}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a26c3f63b94bcfab576aee93a1ebe6e58} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+NOTIFY&NOTIFY method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_SUBSCRIBE@{CIOT\_HTTPC\_METHOD\_SUBSCRIBE}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_SUBSCRIBE@{CIOT\_HTTPC\_METHOD\_SUBSCRIBE}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a4995d14b4b9469afee820440e999d031}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a4995d14b4b9469afee820440e999d031} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+SUBSCRIBE&SUBSCRIBE method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_UNSUBSCRIBE@{CIOT\_HTTPC\_METHOD\_UNSUBSCRIBE}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_UNSUBSCRIBE@{CIOT\_HTTPC\_METHOD\_UNSUBSCRIBE}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a8a9fbce8b6f60e6d17568fc73d2ae9fa}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a8a9fbce8b6f60e6d17568fc73d2ae9fa} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+UNSUBSCRIBE&UNSUBSCRIBE method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_OPTIONS@{CIOT\_HTTPC\_METHOD\_OPTIONS}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_OPTIONS@{CIOT\_HTTPC\_METHOD\_OPTIONS}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aad83faf84362fa782451b9b7813cb903}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aad83faf84362fa782451b9b7813cb903} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+OPTIONS&OPTIONS method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_COPY@{CIOT\_HTTPC\_METHOD\_COPY}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_COPY@{CIOT\_HTTPC\_METHOD\_COPY}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aa8be300f4466d5d8e37ad27c4fb48b67}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aa8be300f4466d5d8e37ad27c4fb48b67} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+COPY© method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_MOVE@{CIOT\_HTTPC\_METHOD\_MOVE}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_MOVE@{CIOT\_HTTPC\_METHOD\_MOVE}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a554691606720719d5c7d18aec331d819}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a554691606720719d5c7d18aec331d819} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+MOVE&MOVE method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_LOCK@{CIOT\_HTTPC\_METHOD\_LOCK}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_LOCK@{CIOT\_HTTPC\_METHOD\_LOCK}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a9ba67439f21bc5a14f885acb4702e7a6}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a9ba67439f21bc5a14f885acb4702e7a6} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+LOCK&LOCK method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_UNLOCK@{CIOT\_HTTPC\_METHOD\_UNLOCK}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_UNLOCK@{CIOT\_HTTPC\_METHOD\_UNLOCK}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a5227db99bf72a1289368d5542cfcafa2}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a5227db99bf72a1289368d5542cfcafa2} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+UNLOCK&UNLOCK method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_PROPFIND@{CIOT\_HTTPC\_METHOD\_PROPFIND}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_PROPFIND@{CIOT\_HTTPC\_METHOD\_PROPFIND}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a517da021c623763eb791f30ff5a21d8c}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a517da021c623763eb791f30ff5a21d8c} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PROPFIND&PROPFIND method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_PROPPATCH@{CIOT\_HTTPC\_METHOD\_PROPPATCH}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_PROPPATCH@{CIOT\_HTTPC\_METHOD\_PROPPATCH}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac96588e2a31fb4cab864cafdb28fd6a2}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac96588e2a31fb4cab864cafdb28fd6a2} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+PROPPATCH&PROPPATCH method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_MKCOL@{CIOT\_HTTPC\_METHOD\_MKCOL}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_MKCOL@{CIOT\_HTTPC\_METHOD\_MKCOL}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a615ae69783de68e87fe6b10d15fcf241}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a615ae69783de68e87fe6b10d15fcf241} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+MKCOL&MKCOL method \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_METHOD\_MAX@{CIOT\_HTTPC\_METHOD\_MAX}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_METHOD\_MAX@{CIOT\_HTTPC\_METHOD\_MAX}}}\Hypertarget{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a717d104c5930fd4723ccab14fa590955}\label{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a717d104c5930fd4723ccab14fa590955} -CIOT\+\_\+\+HTTPC\+\_\+\+METHOD\+\_\+\+MAX&Max method \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb}\label{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!ciot\_httpc\_req\_type\_t@{ciot\_httpc\_req\_type\_t}} -\index{ciot\_httpc\_req\_type\_t@{ciot\_httpc\_req\_type\_t}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_req\_type\_t}{ciot\_httpc\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb}{ciot\+\_\+httpc\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT HTTP client request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_REQ\_UNKNOWN@{CIOT\_HTTPC\_REQ\_UNKNOWN}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_REQ\_UNKNOWN@{CIOT\_HTTPC\_REQ\_UNKNOWN}}}\Hypertarget{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba2c25436ee320558e3b39e0278af195e1}\label{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba2c25436ee320558e3b39e0278af195e1} -CIOT\+\_\+\+HTTPC\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_REQ\_SEND\_DATA@{CIOT\_HTTPC\_REQ\_SEND\_DATA}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_REQ\_SEND\_DATA@{CIOT\_HTTPC\_REQ\_SEND\_DATA}}}\Hypertarget{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cbad7ea3f3d9a71d83af66217bb6887312a}\label{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cbad7ea3f3d9a71d83af66217bb6887312a} -CIOT\+\_\+\+HTTPC\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+DATA&Send data request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_REQ\_SET\_HEADER@{CIOT\_HTTPC\_REQ\_SET\_HEADER}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_REQ\_SET\_HEADER@{CIOT\_HTTPC\_REQ\_SET\_HEADER}}}\Hypertarget{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba572be88b8d0c24041a432f1dc4a4ae16}\label{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba572be88b8d0c24041a432f1dc4a4ae16} -CIOT\+\_\+\+HTTPC\+\_\+\+REQ\+\_\+\+SET\+\_\+\+HEADER&Set header request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!ciot\_httpc\_state\_t@{ciot\_httpc\_state\_t}} -\index{ciot\_httpc\_state\_t@{ciot\_httpc\_state\_t}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_state\_t}{ciot\_httpc\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5}{ciot\+\_\+httpc\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT HTTP client states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_STATE\_ERROR@{CIOT\_HTTPC\_STATE\_ERROR}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_STATE\_ERROR@{CIOT\_HTTPC\_STATE\_ERROR}}}\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5ab4a3e67dcc1afbfba00d0df61b40b8da}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5ab4a3e67dcc1afbfba00d0df61b40b8da} -CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+ERROR&Error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_STATE\_IDLE@{CIOT\_HTTPC\_STATE\_IDLE}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_STATE\_IDLE@{CIOT\_HTTPC\_STATE\_IDLE}}}\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a76b62150d0e55c88c843115abdd10071}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a76b62150d0e55c88c843115abdd10071} -CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+IDLE&Idle state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_STATE\_STARTED@{CIOT\_HTTPC\_STATE\_STARTED}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_STATE\_STARTED@{CIOT\_HTTPC\_STATE\_STARTED}}}\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5aeb32c53e0ba4ee494743e1931be6eeec}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5aeb32c53e0ba4ee494743e1931be6eeec} -CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+STARTED&Started state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_STATE\_CONNECTING@{CIOT\_HTTPC\_STATE\_CONNECTING}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_STATE\_CONNECTING@{CIOT\_HTTPC\_STATE\_CONNECTING}}}\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0bd77b70defc26341e91f9b6922252f9}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0bd77b70defc26341e91f9b6922252f9} -CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+CONNECTING&Connecting state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_STATE\_CONNECTED@{CIOT\_HTTPC\_STATE\_CONNECTED}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_STATE\_CONNECTED@{CIOT\_HTTPC\_STATE\_CONNECTED}}}\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0df909f7e832643e2cf49aa050d023dd}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0df909f7e832643e2cf49aa050d023dd} -CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+CONNECTED&Connected state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_STATE\_DATA\_RECEIVED@{CIOT\_HTTPC\_STATE\_DATA\_RECEIVED}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_STATE\_DATA\_RECEIVED@{CIOT\_HTTPC\_STATE\_DATA\_RECEIVED}}}\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a2f5ce6951d2b9d638c13c4938b0c01c7}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a2f5ce6951d2b9d638c13c4938b0c01c7} -CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+DATA\+\_\+\+RECEIVED&Data received state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_STATE\_TIMEOUT@{CIOT\_HTTPC\_STATE\_TIMEOUT}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_STATE\_TIMEOUT@{CIOT\_HTTPC\_STATE\_TIMEOUT}}}\Hypertarget{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a41421c36fcf36da91a51f06855224157}\label{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a41421c36fcf36da91a51f06855224157} -CIOT\+\_\+\+HTTPC\+\_\+\+STATE\+\_\+\+TIMEOUT&Timeout state \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2}\label{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2} -\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!ciot\_httpc\_transport\_type\_t@{ciot\_httpc\_transport\_type\_t}} -\index{ciot\_httpc\_transport\_type\_t@{ciot\_httpc\_transport\_type\_t}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_httpc\_transport\_type\_t}{ciot\_httpc\_transport\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2}{ciot\+\_\+httpc\+\_\+transport\+\_\+type\+\_\+t}}} - - - -Enumeration for HTTP client transport types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_TRANSPORT\_UNKNOWN@{CIOT\_HTTPC\_TRANSPORT\_UNKNOWN}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_TRANSPORT\_UNKNOWN@{CIOT\_HTTPC\_TRANSPORT\_UNKNOWN}}}\Hypertarget{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a22a12a1f89b04f673e7c6da6120118fb}\label{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a22a12a1f89b04f673e7c6da6120118fb} -CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+UNKNOWN&Unknown transport type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_TRANSPORT\_TCP@{CIOT\_HTTPC\_TRANSPORT\_TCP}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_TRANSPORT\_TCP@{CIOT\_HTTPC\_TRANSPORT\_TCP}}}\Hypertarget{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2ac0b77b7cf582d3d2adb20f67dac8cea1}\label{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2ac0b77b7cf582d3d2adb20f67dac8cea1} -CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+TCP&TCP transport type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPC\_TRANSPORT\_SSL@{CIOT\_HTTPC\_TRANSPORT\_SSL}!ciot\_httpc\_types.h@{ciot\_httpc\_types.h}}\index{ciot\_httpc\_types.h@{ciot\_httpc\_types.h}!CIOT\_HTTPC\_TRANSPORT\_SSL@{CIOT\_HTTPC\_TRANSPORT\_SSL}}}\Hypertarget{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a2b14353c34ecb4525e768f4ba62da6b8}\label{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a2b14353c34ecb4525e768f4ba62da6b8} -CIOT\+\_\+\+HTTPC\+\_\+\+TRANSPORT\+\_\+\+SSL&SSL transport type \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__httpc__types_8h_source.tex b/docs/latex/ciot__httpc__types_8h_source.tex deleted file mode 100644 index 1770271..0000000 --- a/docs/latex/ciot__httpc__types_8h_source.tex +++ /dev/null @@ -1,135 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+types.\+h} -\hypertarget{ciot__httpc__types_8h_source}{}\label{ciot__httpc__types_8h_source}\index{include/types/ciot\_httpc\_types.h@{include/types/ciot\_httpc\_types.h}} -\mbox{\hyperlink{ciot__httpc__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_HTTPC\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_HTTPC\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}} -\DoxyCodeLine{00016\ \{} -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00018\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__common__types_8h}{ciot\_common\_types.h}}"{}}} -\DoxyCodeLine{00022\ } -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPC\_URL\_LEN\ 64}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPC\_METHOD\_LEN\ 8}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPC\_BODY\_LEN\ 256}} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPC\_HEADER\_LEN\ 48}} -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPC\_HEADER\_VAL\ 48}} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00037\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00038\ \{} -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5ab4a3e67dcc1afbfba00d0df61b40b8da}{CIOT\_HTTPC\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a76b62150d0e55c88c843115abdd10071}{CIOT\_HTTPC\_STATE\_IDLE}},\ } -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5aeb32c53e0ba4ee494743e1931be6eeec}{CIOT\_HTTPC\_STATE\_STARTED}},\ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0bd77b70defc26341e91f9b6922252f9}{CIOT\_HTTPC\_STATE\_CONNECTING}},\ } -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a0df909f7e832643e2cf49aa050d023dd}{CIOT\_HTTPC\_STATE\_CONNECTED}},\ } -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a2f5ce6951d2b9d638c13c4938b0c01c7}{CIOT\_HTTPC\_STATE\_DATA\_RECEIVED}},\ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5a41421c36fcf36da91a51f06855224157}{CIOT\_HTTPC\_STATE\_TIMEOUT}},\ } -\DoxyCodeLine{00046\ \}\ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5}{ciot\_httpc\_state\_t}};} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00051\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00052\ \{} -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba2c25436ee320558e3b39e0278af195e1}{CIOT\_HTTPC\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00054\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cbad7ea3f3d9a71d83af66217bb6887312a}{CIOT\_HTTPC\_REQ\_SEND\_DATA}},\ } -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cba572be88b8d0c24041a432f1dc4a4ae16}{CIOT\_HTTPC\_REQ\_SET\_HEADER}},\ } -\DoxyCodeLine{00056\ \}\ \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb}{ciot\_httpc\_req\_type\_t}};} -\DoxyCodeLine{00057\ } -\DoxyCodeLine{00061\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00062\ \{} -\DoxyCodeLine{00063\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a650e5214875a4cdd3e347425901c5577}{CIOT\_HTTPC\_METHOD\_GET}}\ =\ 0,\ } -\DoxyCodeLine{00064\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac0f3e0c43ca1d9895d911a61aa3a0a3d}{CIOT\_HTTPC\_METHOD\_POST}},\ } -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3fecc1706149db9a7031a9726564e50e}{CIOT\_HTTPC\_METHOD\_PUT}},\ } -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a3907ae9dfab102ca11b9f52c35831aa3}{CIOT\_HTTPC\_METHOD\_PATCH}},\ } -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a0f4269d141ab0dc5832a06a1e918f882}{CIOT\_HTTPC\_METHOD\_DELETE}},\ } -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7af157cd0398674ba1012f6768e47ea8bf}{CIOT\_HTTPC\_METHOD\_HEAD}},\ } -\DoxyCodeLine{00069\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a26c3f63b94bcfab576aee93a1ebe6e58}{CIOT\_HTTPC\_METHOD\_NOTIFY}},\ } -\DoxyCodeLine{00070\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a4995d14b4b9469afee820440e999d031}{CIOT\_HTTPC\_METHOD\_SUBSCRIBE}},\ } -\DoxyCodeLine{00071\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a8a9fbce8b6f60e6d17568fc73d2ae9fa}{CIOT\_HTTPC\_METHOD\_UNSUBSCRIBE}},\ } -\DoxyCodeLine{00072\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aad83faf84362fa782451b9b7813cb903}{CIOT\_HTTPC\_METHOD\_OPTIONS}},\ } -\DoxyCodeLine{00073\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7aa8be300f4466d5d8e37ad27c4fb48b67}{CIOT\_HTTPC\_METHOD\_COPY}},\ } -\DoxyCodeLine{00074\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a554691606720719d5c7d18aec331d819}{CIOT\_HTTPC\_METHOD\_MOVE}},\ } -\DoxyCodeLine{00075\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a9ba67439f21bc5a14f885acb4702e7a6}{CIOT\_HTTPC\_METHOD\_LOCK}},\ } -\DoxyCodeLine{00076\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a5227db99bf72a1289368d5542cfcafa2}{CIOT\_HTTPC\_METHOD\_UNLOCK}},\ } -\DoxyCodeLine{00077\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a517da021c623763eb791f30ff5a21d8c}{CIOT\_HTTPC\_METHOD\_PROPFIND}},\ } -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7ac96588e2a31fb4cab864cafdb28fd6a2}{CIOT\_HTTPC\_METHOD\_PROPPATCH}},\ } -\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a615ae69783de68e87fe6b10d15fcf241}{CIOT\_HTTPC\_METHOD\_MKCOL}},\ } -\DoxyCodeLine{00080\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7a717d104c5930fd4723ccab14fa590955}{CIOT\_HTTPC\_METHOD\_MAX}},\ } -\DoxyCodeLine{00081\ \}\ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7}{ciot\_httpc\_method\_t}};} -\DoxyCodeLine{00082\ } -\DoxyCodeLine{00086\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00087\ \{} -\DoxyCodeLine{00088\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a22a12a1f89b04f673e7c6da6120118fb}{CIOT\_HTTPC\_TRANSPORT\_UNKNOWN}},\ } -\DoxyCodeLine{00089\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2ac0b77b7cf582d3d2adb20f67dac8cea1}{CIOT\_HTTPC\_TRANSPORT\_TCP}},\ } -\DoxyCodeLine{00090\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2a2b14353c34ecb4525e768f4ba62da6b8}{CIOT\_HTTPC\_TRANSPORT\_SSL}},\ } -\DoxyCodeLine{00091\ \}\ \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2}{ciot\_httpc\_transport\_type\_t}};} -\DoxyCodeLine{00092\ } -\DoxyCodeLine{00096\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00097\ \{} -\DoxyCodeLine{00098\ \ \ \ \ \textcolor{keywordtype}{char}\ url[\mbox{\hyperlink{ciot__httpc__types_8h_ab32b0446ee870bfb7a79c056a81e6683}{CIOT\_HTTPC\_URL\_LEN}}];\ } -\DoxyCodeLine{00099\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7}{ciot\_httpc\_method\_t}}\ \mbox{\hyperlink{structciot__httpc__cfg__t_ad10985b96579c7c2030050715bcad45d}{method}};\ } -\DoxyCodeLine{00100\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2}{ciot\_httpc\_transport\_type\_t}}\ \mbox{\hyperlink{structciot__httpc__cfg__t_a7e007ade3b5b7cfcc2ee06d35d52d4e1}{transport}};\ } -\DoxyCodeLine{00101\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__httpc__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}{timeout}};\ } -\DoxyCodeLine{00102\ \}\ \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\_httpc\_cfg\_t}};} -\DoxyCodeLine{00103\ } -\DoxyCodeLine{00107\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00108\ \{} -\DoxyCodeLine{00109\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5}{ciot\_httpc\_state\_t}}\ \mbox{\hyperlink{structciot__httpc__status__t_a37c663f5a0040d827e450c52efe59882}{state}};\ } -\DoxyCodeLine{00110\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__httpc__status__t_a11614f44ef4d939bdd984953346a7572}{error}};\ } -\DoxyCodeLine{00111\ \}\ \mbox{\hyperlink{structciot__httpc__status__t}{ciot\_httpc\_status\_t}};} -\DoxyCodeLine{00112\ } -\DoxyCodeLine{00116\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00117\ \{} -\DoxyCodeLine{00118\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\_httpc\_cfg\_t}}\ \mbox{\hyperlink{structciot__httpc__req__send__t_a301d9747f184171d8a1ee19d25d8e4ab}{cfg}};\ } -\DoxyCodeLine{00119\ \ \ \ \ uint8\_t\ body[\mbox{\hyperlink{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd}{CIOT\_HTTPC\_BODY\_LEN}}];\ } -\DoxyCodeLine{00120\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__httpc__req__send__t_a675a47f46ecd9d8ec01c738e04c28cbe}{content\_length}};\ } -\DoxyCodeLine{00121\ \}\ \mbox{\hyperlink{structciot__httpc__req__send__t}{ciot\_httpc\_req\_send\_t}};} -\DoxyCodeLine{00122\ } -\DoxyCodeLine{00126\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00127\ \{} -\DoxyCodeLine{00128\ \ \ \ \ \textcolor{keywordtype}{char}\ header[\mbox{\hyperlink{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9}{CIOT\_HTTPC\_HEADER\_LEN}}];\ } -\DoxyCodeLine{00129\ \ \ \ \ \textcolor{keywordtype}{char}\ value[\mbox{\hyperlink{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6}{CIOT\_HTTPC\_HEADER\_VAL}}];\ } -\DoxyCodeLine{00130\ \}\ \mbox{\hyperlink{structciot__httpc__req__set__header__t}{ciot\_httpc\_req\_set\_header\_t}};} -\DoxyCodeLine{00131\ } -\DoxyCodeLine{00135\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\mbox{\hyperlink{unionciot__httpc__req__data}{ciot\_httpc\_req\_data}}} -\DoxyCodeLine{00136\ \{} -\DoxyCodeLine{00137\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__req__send__t}{ciot\_httpc\_req\_send\_t}}\ \mbox{\hyperlink{unionciot__httpc__req__data_ad6a0d166be37b6649d30122842622328}{send}};\ } -\DoxyCodeLine{00138\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__req__set__header__t}{ciot\_httpc\_req\_set\_header\_t}}\ \mbox{\hyperlink{unionciot__httpc__req__data_aa49303f9ec122aab28d291d44dcd0da5}{set\_header}};\ } -\DoxyCodeLine{00139\ \}\ \mbox{\hyperlink{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}{ciot\_httpc\_req\_data\_u}};} -\DoxyCodeLine{00140\ } -\DoxyCodeLine{00144\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00145\ \{} -\DoxyCodeLine{00146\ \ \ \ \ \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb}{ciot\_httpc\_req\_type\_t}}\ \mbox{\hyperlink{structciot__httpc__req__t_ac4330d2b9fc6473e00966f8dd66a477c}{type}};\ } -\DoxyCodeLine{00147\ \ \ \ \ \mbox{\hyperlink{unionciot__httpc__req__data}{ciot\_httpc\_req\_data\_u}}\ \mbox{\hyperlink{structciot__httpc__req__t_a3623cfec7a7da849fd22ce7ec1c3e10f}{data}};\ } -\DoxyCodeLine{00148\ \}\ \mbox{\hyperlink{structciot__httpc__req__t}{ciot\_httpc\_req\_t}};} -\DoxyCodeLine{00149\ } -\DoxyCodeLine{00153\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__httpc__event__data}{ciot\_httpc\_event\_data}}} -\DoxyCodeLine{00154\ \{} -\DoxyCodeLine{00155\ \ \ \ \ \mbox{\hyperlink{structciot__event__data}{ciot\_event\_data\_t}}\ \mbox{\hyperlink{structciot__httpc__event__data_ac824ce50cc96c6354577281b657d14b6}{body}};\ } -\DoxyCodeLine{00156\ \ \ \ \ \textcolor{keywordtype}{char}\ *\mbox{\hyperlink{structciot__httpc__event__data_ab135e5154c1828bef226a3df98ee3333}{url}};\ } -\DoxyCodeLine{00157\ \}\ \mbox{\hyperlink{ciot__httpc__types_8h_a491fa8406af26b99bd40ebb9ab2329da}{ciot\_httpc\_event\_data\_t}};} -\DoxyCodeLine{00158\ } -\DoxyCodeLine{00162\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\mbox{\hyperlink{unionciot__httpc__event}{ciot\_httpc\_event}}} -\DoxyCodeLine{00163\ \{} -\DoxyCodeLine{00164\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__event__data}{ciot\_httpc\_event\_data\_t}}\ \mbox{\hyperlink{unionciot__httpc__event_a6ec8e644d05e4d629a77959492eee5d3}{data}};\ } -\DoxyCodeLine{00165\ \}\ \mbox{\hyperlink{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}{ciot\_httpc\_event\_u}};} -\DoxyCodeLine{00166\ } -\DoxyCodeLine{00170\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00171\ \{} -\DoxyCodeLine{00172\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\_httpc\_cfg\_t}}\ \mbox{\hyperlink{unionciot__httpc__data__u_a0ddab1f295ea5861939322623d313037}{config}};\ } -\DoxyCodeLine{00173\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__status__t}{ciot\_httpc\_status\_t}}\ \mbox{\hyperlink{unionciot__httpc__data__u_ac5c1eb82650b9d0161a399175c459ad3}{status}};\ } -\DoxyCodeLine{00174\ \ \ \ \ \mbox{\hyperlink{structciot__httpc__req__t}{ciot\_httpc\_req\_t}}\ \mbox{\hyperlink{unionciot__httpc__data__u_a57c784a27da9399f6d1a7bd2122a3c65}{request}};\ } -\DoxyCodeLine{00175\ \ \ \ \ \mbox{\hyperlink{unionciot__httpc__event}{ciot\_httpc\_event\_u}}\ \mbox{\hyperlink{unionciot__httpc__data__u_a28206abcb96418175c4998aaff04c99a}{event}};\ } -\DoxyCodeLine{00176\ \}\ \mbox{\hyperlink{unionciot__httpc__data__u}{ciot\_httpc\_data\_u}};} -\DoxyCodeLine{00177\ } -\DoxyCodeLine{00178\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00179\ \}} -\DoxyCodeLine{00180\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00181\ } -\DoxyCodeLine{00182\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__https_8h.tex b/docs/latex/ciot__https_8h.tex deleted file mode 100644 index 54bff53..0000000 --- a/docs/latex/ciot__https_8h.tex +++ /dev/null @@ -1,201 +0,0 @@ -\doxysection{include/ciot\+\_\+https.h File Reference} -\hypertarget{ciot__https_8h}{}\label{ciot__https_8h}\index{include/ciot\_https.h@{include/ciot\_https.h}} - - -Header file for CIOT HTTP server interface. - - -{\ttfamily \#include "{}types/ciot\+\_\+https\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__https__status__msg__t}{ciot\+\_\+https\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT HTTP server status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+https \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the CIOT HTTP server interface. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12}{ciot\+\_\+https\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__https_8h_a26069470806c3c576f68c2c7108c07a0}{ciot\+\_\+https\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration of HTTP server event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12}{ciot\+\_\+https\+\_\+event\+\_\+id}} \{ \mbox{\hyperlink{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12abda42e477b51af9bdec887127fbe6d27}{CIOT\+\_\+\+HTTPS\+\_\+\+EVENT\+\_\+\+DATA}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM - \} -\begin{DoxyCompactList}\small\item\em Enumeration of HTTP server event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} \mbox{\hyperlink{ciot__https_8h_a50f38073c89e88e99b5bf95abbe0b18b}{ciot\+\_\+https\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Creates a new CIOT HTTP server interface instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__https_8h_a3a7dd3627113a6a829c764500112d752}{ciot\+\_\+https\+\_\+start}} (\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} self, \mbox{\hyperlink{structciot__https__cfg__t}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Starts the CIOT HTTP server interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__https_8h_a04b4527bce08440e2643a71679575174}{ciot\+\_\+https\+\_\+stop}} (\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stops the CIOT HTTP server interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__https_8h_a585618f81c962cef6251ffecc942a333}{ciot\+\_\+https\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} self, \mbox{\hyperlink{structciot__https__req__t}{ciot\+\_\+https\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Processes a request for the CIOT HTTP server interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__https_8h_ab9abc9d142e7332b9606568193d1ede0}{ciot\+\_\+https\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Sends data over the CIOT HTTP server interface. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT HTTP server interface. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__https_8h_a26069470806c3c576f68c2c7108c07a0}\label{ciot__https_8h_a26069470806c3c576f68c2c7108c07a0} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_event\_id\_t@{ciot\_https\_event\_id\_t}} -\index{ciot\_https\_event\_id\_t@{ciot\_https\_event\_id\_t}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_event\_id\_t}{ciot\_https\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12}{ciot\+\_\+https\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__https_8h_a26069470806c3c576f68c2c7108c07a0}{ciot\+\_\+https\+\_\+event\+\_\+id\+\_\+t}}} - - - -Enumeration of HTTP server event IDs. - -\Hypertarget{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}\label{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_t@{ciot\_https\_t}} -\index{ciot\_https\_t@{ciot\_https\_t}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_t}{ciot\_https\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+https\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}}} - - - -Structure representing the CIOT HTTP server interface. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12}\label{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_event\_id@{ciot\_https\_event\_id}} -\index{ciot\_https\_event\_id@{ciot\_https\_event\_id}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_event\_id}{ciot\_https\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12}{ciot\+\_\+https\+\_\+event\+\_\+id}}} - - - -Enumeration of HTTP server event IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPS\_EVENT\_DATA@{CIOT\_HTTPS\_EVENT\_DATA}!ciot\_https.h@{ciot\_https.h}}\index{ciot\_https.h@{ciot\_https.h}!CIOT\_HTTPS\_EVENT\_DATA@{CIOT\_HTTPS\_EVENT\_DATA}}}\Hypertarget{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12abda42e477b51af9bdec887127fbe6d27}\label{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12abda42e477b51af9bdec887127fbe6d27} -CIOT\+\_\+\+HTTPS\+\_\+\+EVENT\+\_\+\+DATA&Event ID for data received. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__https_8h_a50f38073c89e88e99b5bf95abbe0b18b}\label{ciot__https_8h_a50f38073c89e88e99b5bf95abbe0b18b} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_new@{ciot\_https\_new}} -\index{ciot\_https\_new@{ciot\_https\_new}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_new()}{ciot\_https\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} ciot\+\_\+https\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Creates a new CIOT HTTP server interface instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & The handle for the HTTP server interface. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the new CIOT HTTP server instance. -\end{DoxyReturn} -\Hypertarget{ciot__https_8h_a585618f81c962cef6251ffecc942a333}\label{ciot__https_8h_a585618f81c962cef6251ffecc942a333} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_process\_req@{ciot\_https\_process\_req}} -\index{ciot\_https\_process\_req@{ciot\_https\_process\_req}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_process\_req()}{ciot\_https\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+https\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__https__req__t}{ciot\+\_\+https\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Processes a request for the CIOT HTTP server interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP server instance. \\ -\hline -{\em req} & The HTTP server request to be processed. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__https_8h_ab9abc9d142e7332b9606568193d1ede0}\label{ciot__https_8h_ab9abc9d142e7332b9606568193d1ede0} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_send\_data@{ciot\_https\_send\_data}} -\index{ciot\_https\_send\_data@{ciot\_https\_send\_data}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_send\_data()}{ciot\_https\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+https\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends data over the CIOT HTTP server interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP server instance. \\ -\hline -{\em data} & The data to be sent. \\ -\hline -{\em size} & The size of the data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__https_8h_a3a7dd3627113a6a829c764500112d752}\label{ciot__https_8h_a3a7dd3627113a6a829c764500112d752} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_start@{ciot\_https\_start}} -\index{ciot\_https\_start@{ciot\_https\_start}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_start()}{ciot\_https\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+https\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__https__cfg__t}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Starts the CIOT HTTP server interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP server instance. \\ -\hline -{\em cfg} & The HTTP server configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__https_8h_a04b4527bce08440e2643a71679575174}\label{ciot__https_8h_a04b4527bce08440e2643a71679575174} -\index{ciot\_https.h@{ciot\_https.h}!ciot\_https\_stop@{ciot\_https\_stop}} -\index{ciot\_https\_stop@{ciot\_https\_stop}!ciot\_https.h@{ciot\_https.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_stop()}{ciot\_https\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+https\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stops the CIOT HTTP server interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT HTTP server instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} diff --git a/docs/latex/ciot__https_8h_source.tex b/docs/latex/ciot__https_8h_source.tex deleted file mode 100644 index d7a121b..0000000 --- a/docs/latex/ciot__https_8h_source.tex +++ /dev/null @@ -1,44 +0,0 @@ -\doxysection{ciot\+\_\+https.\+h} -\hypertarget{ciot__https_8h_source}{}\label{ciot__https_8h_source}\index{include/ciot\_https.h@{include/ciot\_https.h}} -\mbox{\hyperlink{ciot__https_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_HTTPS\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_HTTPS\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__https__types_8h}{types/ciot\_https\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_https\ *\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\_https\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12}{ciot\_https\_event\_id}}\ \{} -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{ciot__https_8h_a3bfe51b8fc1185d9f555a28985455f12abda42e477b51af9bdec887127fbe6d27}{CIOT\_HTTPS\_EVENT\_DATA}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00032\ \}\ \mbox{\hyperlink{ciot__https_8h_a26069470806c3c576f68c2c7108c07a0}{ciot\_https\_event\_id\_t}};} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00037\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__https__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{structciot__https__status__t}{ciot\_https\_status\_t}}\ \mbox{\hyperlink{structciot__https__status__msg__t_ae71d44b4ec9b04f2b3eb183ae791f6ca}{status}};\ } -\DoxyCodeLine{00040\ \}\ \mbox{\hyperlink{structciot__https__status__msg__t}{ciot\_https\_status\_msg\_t}};} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00047\ \mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\_https\_t}}\ \mbox{\hyperlink{ciot__https_8h_a50f38073c89e88e99b5bf95abbe0b18b}{ciot\_https\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00048\ } -\DoxyCodeLine{00055\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__https_8h_a3a7dd3627113a6a829c764500112d752}{ciot\_https\_start}}(\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\_https\_t}}\ self,\ \mbox{\hyperlink{structciot__https__cfg__t}{ciot\_https\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00062\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__https_8h_a04b4527bce08440e2643a71679575174}{ciot\_https\_stop}}(\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\_https\_t}}\ self);} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00070\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__https_8h_a585618f81c962cef6251ffecc942a333}{ciot\_https\_process\_req}}(\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\_https\_t}}\ self,\ \mbox{\hyperlink{structciot__https__req__t}{ciot\_https\_req\_t}}\ *req);} -\DoxyCodeLine{00071\ } -\DoxyCodeLine{00079\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__https_8h_ab9abc9d142e7332b9606568193d1ede0}{ciot\_https\_send\_data}}(\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\_https\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00080\ } -\DoxyCodeLine{00081\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00082\ \}} -\DoxyCodeLine{00083\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__https__types_8h.tex b/docs/latex/ciot__https__types_8h.tex deleted file mode 100644 index 2bf8a5d..0000000 --- a/docs/latex/ciot__https__types_8h.tex +++ /dev/null @@ -1,157 +0,0 @@ -\doxysection{include/types/ciot\+\_\+https\+\_\+types.h File Reference} -\hypertarget{ciot__https__types_8h}{}\label{ciot__https__types_8h}\index{include/types/ciot\_https\_types.h@{include/types/ciot\_https\_types.h}} - - -Defines data types and structures for CIOT HTTP server. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+common\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__https__cfg__t}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP server configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__https__status__t}{ciot\+\_\+https\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP server status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__https__req__data__u}{ciot\+\_\+https\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP server request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__https__req__t}{ciot\+\_\+https\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP server request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__https__event__data}{ciot\+\_\+https\+\_\+event\+\_\+data}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP server event data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__https__event}{ciot\+\_\+https\+\_\+event}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP server event. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__https__data__u}{ciot\+\_\+https\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP server data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623}{CIOT\+\_\+\+HTTPS\+\_\+\+ADDRESS\+\_\+\+LEN}}~64 -\item -\#define \mbox{\hyperlink{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749}{CIOT\+\_\+\+HTTPS\+\_\+\+ROUTE\+\_\+\+LEN}}~32 -\item -\#define \mbox{\hyperlink{ciot__https__types_8h_aa7678310edbfc6790c69ab81cd7ccf52}{CIOT\+\_\+\+HTTPS\+\_\+\+METHOD\+\_\+\+LEN}}~8 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct \mbox{\hyperlink{structciot__https__event__data}{ciot\+\_\+https\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__https__types_8h_a2c6c4aa32536b02785ca49d2716498b3}{ciot\+\_\+https\+\_\+event\+\_\+data\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT HTTP server event data. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__https__event}{ciot\+\_\+https\+\_\+event}} \mbox{\hyperlink{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}{ciot\+\_\+https\+\_\+event\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT HTTP server event. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd}{ciot\+\_\+https\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdacd46841a989b783e5bc6221a735f8e1d}{CIOT\+\_\+\+HTTPS\+\_\+\+STATE\+\_\+\+STOPPED}} -, \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdaa775c25c0d8b7eeb99d8d53b11bed6c7}{CIOT\+\_\+\+HTTPS\+\_\+\+STATE\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fda5c3019e26199226925ec1ed6790a9207}{CIOT\+\_\+\+HTTPS\+\_\+\+STATE\+\_\+\+ERROR}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT HTTP server states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3}{ciot\+\_\+https\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3aefeacc094012affef1849ed248027c31}{CIOT\+\_\+\+HTTPS\+\_\+\+REQ\+\_\+\+UNKNOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT HTTP server request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT HTTP server. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623}\label{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623} -\index{ciot\_https\_types.h@{ciot\_https\_types.h}!CIOT\_HTTPS\_ADDRESS\_LEN@{CIOT\_HTTPS\_ADDRESS\_LEN}} -\index{CIOT\_HTTPS\_ADDRESS\_LEN@{CIOT\_HTTPS\_ADDRESS\_LEN}!ciot\_https\_types.h@{ciot\_https\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPS\_ADDRESS\_LEN}{CIOT\_HTTPS\_ADDRESS\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPS\+\_\+\+ADDRESS\+\_\+\+LEN~64} - -Maximum length of HTTPS address \Hypertarget{ciot__https__types_8h_aa7678310edbfc6790c69ab81cd7ccf52}\label{ciot__https__types_8h_aa7678310edbfc6790c69ab81cd7ccf52} -\index{ciot\_https\_types.h@{ciot\_https\_types.h}!CIOT\_HTTPS\_METHOD\_LEN@{CIOT\_HTTPS\_METHOD\_LEN}} -\index{CIOT\_HTTPS\_METHOD\_LEN@{CIOT\_HTTPS\_METHOD\_LEN}!ciot\_https\_types.h@{ciot\_https\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPS\_METHOD\_LEN}{CIOT\_HTTPS\_METHOD\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPS\+\_\+\+METHOD\+\_\+\+LEN~8} - -Maximum length of HTTPS method \Hypertarget{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749}\label{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749} -\index{ciot\_https\_types.h@{ciot\_https\_types.h}!CIOT\_HTTPS\_ROUTE\_LEN@{CIOT\_HTTPS\_ROUTE\_LEN}} -\index{CIOT\_HTTPS\_ROUTE\_LEN@{CIOT\_HTTPS\_ROUTE\_LEN}!ciot\_https\_types.h@{ciot\_https\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_HTTPS\_ROUTE\_LEN}{CIOT\_HTTPS\_ROUTE\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+HTTPS\+\_\+\+ROUTE\+\_\+\+LEN~32} - -Maximum length of HTTPS route - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__https__types_8h_a2c6c4aa32536b02785ca49d2716498b3}\label{ciot__https__types_8h_a2c6c4aa32536b02785ca49d2716498b3} -\index{ciot\_https\_types.h@{ciot\_https\_types.h}!ciot\_https\_event\_data\_t@{ciot\_https\_event\_data\_t}} -\index{ciot\_https\_event\_data\_t@{ciot\_https\_event\_data\_t}!ciot\_https\_types.h@{ciot\_https\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_event\_data\_t}{ciot\_https\_event\_data\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__https__event__data}{ciot\+\_\+https\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__https__types_8h_a2c6c4aa32536b02785ca49d2716498b3}{ciot\+\_\+https\+\_\+event\+\_\+data\+\_\+t}}} - - - -Structure for CIOT HTTP server event data. - -\Hypertarget{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}\label{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704} -\index{ciot\_https\_types.h@{ciot\_https\_types.h}!ciot\_https\_event\_u@{ciot\_https\_event\_u}} -\index{ciot\_https\_event\_u@{ciot\_https\_event\_u}!ciot\_https\_types.h@{ciot\_https\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_event\_u}{ciot\_https\_event\_u}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__https__event}{ciot\+\_\+https\+\_\+event}} \mbox{\hyperlink{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}{ciot\+\_\+https\+\_\+event\+\_\+u}}} - - - -Union for CIOT HTTP server event. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3}\label{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3} -\index{ciot\_https\_types.h@{ciot\_https\_types.h}!ciot\_https\_req\_type\_t@{ciot\_https\_req\_type\_t}} -\index{ciot\_https\_req\_type\_t@{ciot\_https\_req\_type\_t}!ciot\_https\_types.h@{ciot\_https\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_req\_type\_t}{ciot\_https\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3}{ciot\+\_\+https\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT HTTP server request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPS\_REQ\_UNKNOWN@{CIOT\_HTTPS\_REQ\_UNKNOWN}!ciot\_https\_types.h@{ciot\_https\_types.h}}\index{ciot\_https\_types.h@{ciot\_https\_types.h}!CIOT\_HTTPS\_REQ\_UNKNOWN@{CIOT\_HTTPS\_REQ\_UNKNOWN}}}\Hypertarget{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3aefeacc094012affef1849ed248027c31}\label{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3aefeacc094012affef1849ed248027c31} -CIOT\+\_\+\+HTTPS\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd}\label{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd} -\index{ciot\_https\_types.h@{ciot\_https\_types.h}!ciot\_https\_state\_t@{ciot\_https\_state\_t}} -\index{ciot\_https\_state\_t@{ciot\_https\_state\_t}!ciot\_https\_types.h@{ciot\_https\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_https\_state\_t}{ciot\_https\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd}{ciot\+\_\+https\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT HTTP server states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPS\_STATE\_STOPPED@{CIOT\_HTTPS\_STATE\_STOPPED}!ciot\_https\_types.h@{ciot\_https\_types.h}}\index{ciot\_https\_types.h@{ciot\_https\_types.h}!CIOT\_HTTPS\_STATE\_STOPPED@{CIOT\_HTTPS\_STATE\_STOPPED}}}\Hypertarget{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdacd46841a989b783e5bc6221a735f8e1d}\label{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdacd46841a989b783e5bc6221a735f8e1d} -CIOT\+\_\+\+HTTPS\+\_\+\+STATE\+\_\+\+STOPPED&Stopped state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPS\_STATE\_STARTED@{CIOT\_HTTPS\_STATE\_STARTED}!ciot\_https\_types.h@{ciot\_https\_types.h}}\index{ciot\_https\_types.h@{ciot\_https\_types.h}!CIOT\_HTTPS\_STATE\_STARTED@{CIOT\_HTTPS\_STATE\_STARTED}}}\Hypertarget{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdaa775c25c0d8b7eeb99d8d53b11bed6c7}\label{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdaa775c25c0d8b7eeb99d8d53b11bed6c7} -CIOT\+\_\+\+HTTPS\+\_\+\+STATE\+\_\+\+STARTED&Started state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_HTTPS\_STATE\_ERROR@{CIOT\_HTTPS\_STATE\_ERROR}!ciot\_https\_types.h@{ciot\_https\_types.h}}\index{ciot\_https\_types.h@{ciot\_https\_types.h}!CIOT\_HTTPS\_STATE\_ERROR@{CIOT\_HTTPS\_STATE\_ERROR}}}\Hypertarget{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fda5c3019e26199226925ec1ed6790a9207}\label{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fda5c3019e26199226925ec1ed6790a9207} -CIOT\+\_\+\+HTTPS\+\_\+\+STATE\+\_\+\+ERROR&Error state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__https__types_8h_source.tex b/docs/latex/ciot__https__types_8h_source.tex deleted file mode 100644 index 47563f5..0000000 --- a/docs/latex/ciot__https__types_8h_source.tex +++ /dev/null @@ -1,82 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+types.\+h} -\hypertarget{ciot__https__types_8h_source}{}\label{ciot__https__types_8h_source}\index{include/types/ciot\_https\_types.h@{include/types/ciot\_https\_types.h}} -\mbox{\hyperlink{ciot__https__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_HTTPS\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_HTTPS\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__common__types_8h}{ciot\_common\_types.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPS\_ADDRESS\_LEN\ 64}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPS\_ROUTE\_LEN\ 32}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#define\ CIOT\_HTTPS\_METHOD\_LEN\ 8}} -\DoxyCodeLine{00028\ } -\DoxyCodeLine{00032\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00033\ \{} -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdacd46841a989b783e5bc6221a735f8e1d}{CIOT\_HTTPS\_STATE\_STOPPED}},\ } -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fdaa775c25c0d8b7eeb99d8d53b11bed6c7}{CIOT\_HTTPS\_STATE\_STARTED}},\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fda5c3019e26199226925ec1ed6790a9207}{CIOT\_HTTPS\_STATE\_ERROR}},\ } -\DoxyCodeLine{00037\ \}\ \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd}{ciot\_https\_state\_t}};} -\DoxyCodeLine{00038\ } -\DoxyCodeLine{00042\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00043\ \{} -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3aefeacc094012affef1849ed248027c31}{CIOT\_HTTPS\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00045\ \}\ \mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3}{ciot\_https\_req\_type\_t}};} -\DoxyCodeLine{00046\ } -\DoxyCodeLine{00050\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00051\ \{} -\DoxyCodeLine{00052\ \ \ \ \ \textcolor{keywordtype}{char}\ address[\mbox{\hyperlink{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623}{CIOT\_HTTPS\_ADDRESS\_LEN}}];\ } -\DoxyCodeLine{00053\ \ \ \ \ \textcolor{keywordtype}{char}\ route[\mbox{\hyperlink{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749}{CIOT\_HTTPS\_ROUTE\_LEN}}];\ } -\DoxyCodeLine{00054\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__https__cfg__t_a63c89c04d1feae07ca35558055155ffb}{port}};\ } -\DoxyCodeLine{00055\ \}\ \mbox{\hyperlink{structciot__https__cfg__t}{ciot\_https\_cfg\_t}};} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00060\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00061\ \{} -\DoxyCodeLine{00062\ \ \ \ \ \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd}{ciot\_https\_state\_t}}\ \mbox{\hyperlink{structciot__https__status__t_a28c09b101362530d97e51b712b741f63}{state}};\ } -\DoxyCodeLine{00063\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__https__status__t_a11614f44ef4d939bdd984953346a7572}{error}};\ } -\DoxyCodeLine{00064\ \}\ \mbox{\hyperlink{structciot__https__status__t}{ciot\_https\_status\_t}};} -\DoxyCodeLine{00065\ } -\DoxyCodeLine{00069\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00070\ \{} -\DoxyCodeLine{00071\ } -\DoxyCodeLine{00072\ \}\ \mbox{\hyperlink{unionciot__https__req__data__u}{ciot\_https\_req\_data\_u}};} -\DoxyCodeLine{00073\ } -\DoxyCodeLine{00077\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00078\ \{} -\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3}{ciot\_https\_req\_type\_t}}\ \mbox{\hyperlink{structciot__https__req__t_adf00e5263d183b9b74cd9dd06dd98856}{type}};\ } -\DoxyCodeLine{00080\ \}\ \mbox{\hyperlink{structciot__https__req__t}{ciot\_https\_req\_t}};} -\DoxyCodeLine{00081\ } -\DoxyCodeLine{00085\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__https__event__data}{ciot\_https\_event\_data}}} -\DoxyCodeLine{00086\ \{} -\DoxyCodeLine{00087\ \ \ \ \ \mbox{\hyperlink{structciot__event__data}{ciot\_event\_data\_t}}\ \mbox{\hyperlink{structciot__https__event__data_ac824ce50cc96c6354577281b657d14b6}{body}};\ } -\DoxyCodeLine{00088\ \ \ \ \ \mbox{\hyperlink{structciot__event__data}{ciot\_event\_data\_t}}\ \mbox{\hyperlink{structciot__https__event__data_ad31b04303ebf9721f2537ea359199783}{url}};\ } -\DoxyCodeLine{00089\ \ \ \ \ \mbox{\hyperlink{structciot__event__data}{ciot\_event\_data\_t}}\ \mbox{\hyperlink{structciot__https__event__data_af63c670f07c4a0a799e8581e95d4810e}{method}};\ } -\DoxyCodeLine{00090\ \}\ \mbox{\hyperlink{ciot__https__types_8h_a2c6c4aa32536b02785ca49d2716498b3}{ciot\_https\_event\_data\_t}};} -\DoxyCodeLine{00091\ } -\DoxyCodeLine{00095\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__https__event}{ciot\_https\_event}}} -\DoxyCodeLine{00096\ \{} -\DoxyCodeLine{00097\ \ \ \ \ \mbox{\hyperlink{structciot__https__event__data}{ciot\_https\_event\_data\_t}}\ \mbox{\hyperlink{structciot__https__event_af26174e3b6aead3c5f7d4deea8ea6fc0}{data}};\ } -\DoxyCodeLine{00098\ \}\ \mbox{\hyperlink{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}{ciot\_https\_event\_u}};} -\DoxyCodeLine{00099\ } -\DoxyCodeLine{00103\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00104\ \{} -\DoxyCodeLine{00105\ \ \ \ \ \mbox{\hyperlink{structciot__https__cfg__t}{ciot\_https\_cfg\_t}}\ \mbox{\hyperlink{unionciot__https__data__u_a07d1ec38980b47dde9caaa52c42163cf}{config}};\ } -\DoxyCodeLine{00106\ \ \ \ \ \mbox{\hyperlink{structciot__https__status__t}{ciot\_https\_status\_t}}\ \mbox{\hyperlink{unionciot__https__data__u_ae71d44b4ec9b04f2b3eb183ae791f6ca}{status}};\ } -\DoxyCodeLine{00107\ \ \ \ \ \mbox{\hyperlink{structciot__https__req__t}{ciot\_https\_req\_t}}\ \mbox{\hyperlink{unionciot__https__data__u_af4b02bc60804013ff8623f078ec43efe}{request}};\ } -\DoxyCodeLine{00108\ \ \ \ \ \mbox{\hyperlink{structciot__https__event}{ciot\_https\_event\_u}}\ \mbox{\hyperlink{unionciot__https__data__u_ad463eb5d86dcaf2c866494686da9ce6e}{event}};\ } -\DoxyCodeLine{00109\ \}\ \mbox{\hyperlink{unionciot__https__data__u}{ciot\_https\_data\_u}};} -\DoxyCodeLine{00110\ } -\DoxyCodeLine{00111\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00112\ \}} -\DoxyCodeLine{00113\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00114\ } -\DoxyCodeLine{00115\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__iface_8h.tex b/docs/latex/ciot__iface_8h.tex deleted file mode 100644 index 387bbf5..0000000 --- a/docs/latex/ciot__iface_8h.tex +++ /dev/null @@ -1,705 +0,0 @@ -\doxysection{include/ciot\+\_\+iface.h File Reference} -\hypertarget{ciot__iface_8h}{}\label{ciot__iface_8h}\index{include/ciot\_iface.h@{include/ciot\_iface.h}} - - -Header file for the CIOT interface. - - -{\ttfamily \#include $<$stdbool.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+msg\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+serializer.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -union \mbox{\hyperlink{unionciot__iface__event__data__u}{ciot\+\_\+iface\+\_\+event\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT interface event data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__iface__event__t}{ciot\+\_\+iface\+\_\+event\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing an interface event. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__iface__base__data}{ciot\+\_\+iface\+\_\+base\+\_\+data}} -\begin{DoxyCompactList}\small\item\em Structure representing base data for an interface. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__iface__req__info}{ciot\+\_\+iface\+\_\+req\+\_\+info}} -\begin{DoxyCompactList}\small\item\em Structure representing request information for an interface. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__iface__base}{ciot\+\_\+iface\+\_\+base}} -\begin{DoxyCompactList}\small\item\em Structure representing the base of an interface. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__iface}{ciot\+\_\+iface}} -\begin{DoxyCompactList}\small\item\em Structure representing a CIOT interface. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef enum \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753ca}{ciot\+\_\+iface\+\_\+req\+\_\+status}} \mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\+\_\+iface\+\_\+req\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for the status of interface requests. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cb}{ciot\+\_\+iface\+\_\+event\+\_\+type}} \mbox{\hyperlink{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}{ciot\+\_\+iface\+\_\+event\+\_\+type\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT interface event types. \end{DoxyCompactList}\item -typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_afa768ec7c39932d18718c66358303d16}{ciot\+\_\+iface\+\_\+start\+\_\+fn}}(void \texorpdfstring{$\ast$}{*}iface, \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Function pointer for starting an interface. \end{DoxyCompactList}\item -typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_adbb3382dd13c68ed5090d0021bfd8f29}{ciot\+\_\+iface\+\_\+stop\+\_\+fn}}(void \texorpdfstring{$\ast$}{*}iface) -\begin{DoxyCompactList}\small\item\em Function pointer for stopping an interface. \end{DoxyCompactList}\item -typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_ae586597c42a97043136f6afe51e7ebe8}{ciot\+\_\+iface\+\_\+process\+\_\+req\+\_\+fn}}(void \texorpdfstring{$\ast$}{*}iface, \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Function pointer for processing a request on an interface. \end{DoxyCompactList}\item -typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_affffc532ae0b36b941fc0ed0376a0a5a}{ciot\+\_\+iface\+\_\+send\+\_\+data\+\_\+fn}}(void \texorpdfstring{$\ast$}{*}iface, void \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Function pointer for sending data on an interface. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__iface__base__data}{ciot\+\_\+iface\+\_\+base\+\_\+data}} \mbox{\hyperlink{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}{ciot\+\_\+iface\+\_\+base\+\_\+data\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing base data for an interface. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__iface__req__info}{ciot\+\_\+iface\+\_\+req\+\_\+info}} \mbox{\hyperlink{ciot__iface_8h_a3c7fbbc6d64e6ea8584c014743e20fb9}{ciot\+\_\+iface\+\_\+req\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing request information for an interface. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__iface__base}{ciot\+\_\+iface\+\_\+base}} \mbox{\hyperlink{ciot__iface_8h_abe9d78b6b8e29546fe52054115bea7a0}{ciot\+\_\+iface\+\_\+base\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing the base of an interface. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__iface}{ciot\+\_\+iface}} \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing a CIOT interface. \end{DoxyCompactList}\item -typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}}(\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}sender, \mbox{\hyperlink{structciot__iface__event__t}{ciot\+\_\+iface\+\_\+event\+\_\+t}} \texorpdfstring{$\ast$}{*}event, void \texorpdfstring{$\ast$}{*}args) -\begin{DoxyCompactList}\small\item\em Function pointer for handling interface events. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753ca}{ciot\+\_\+iface\+\_\+req\+\_\+status}} \{ \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa6fad5b037b43a54a8d8e8f70c6e30eb6}{CIOT\+\_\+\+IFACE\+\_\+\+REQ\+\_\+\+STATUS\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caac426693d5012b5aed25f77d2e8bedda5}{CIOT\+\_\+\+IFACE\+\_\+\+REQ\+\_\+\+STATUS\+\_\+\+SENDED}} -, \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa52b88fef2a02a82b04031ad4ba09d0ef}{CIOT\+\_\+\+IFACE\+\_\+\+REQ\+\_\+\+STATUS\+\_\+\+RECEIVED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for the status of interface requests. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cb}{ciot\+\_\+iface\+\_\+event\+\_\+type}} \{ \newline -\mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbad1b206ed7fad45c5e6630dc78d91844d}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+INTERNAL}} = -\/1 -, \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba783c8ee8ead4e6638b0454ffbe5fe009}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba2b18a98e307314d7257854b3f09700a6}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab52a8702f0eaf2aed031a3ca78468a71}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+STOPPED}} -, \newline -\mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba98063df9c53273544ed5b5424a05024e}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+ERROR}} -, \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba0f80ad7aed1ba3eecf1922446cbdde95}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+REQUEST}} -, \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba080fca556c9a023720751526ecad8ccc}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab9bcdc77d1e0c80fdca8b60528af9d81}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+DONE}} -, \newline -\mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT interface event types. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_a15efdb74520f75fe9f0a695a349f07e0}{ciot\+\_\+iface\+\_\+start}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Starts the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_a7ad3131a637f86ed8d9a4655f060deca}{ciot\+\_\+iface\+\_\+stop}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self) -\begin{DoxyCompactList}\small\item\em Stops the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_aef1dd87e5c3111ca65fa4e63ca2c9213}{ciot\+\_\+iface\+\_\+get\+\_\+cfg}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Gets the configuration of the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_a7c59fa4a32c0662de361fd89847ab62b}{ciot\+\_\+iface\+\_\+get\+\_\+status}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, void \texorpdfstring{$\ast$}{*}status) -\begin{DoxyCompactList}\small\item\em Gets the status of the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_a6b87395146fdad575079c47979fe1cc5}{ciot\+\_\+iface\+\_\+get\+\_\+info}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}iface, void \texorpdfstring{$\ast$}{*}info, int size) -\begin{DoxyCompactList}\small\item\em Gets the information of the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_abc404557e0571e7e5ea0c5db63fa8c23}{ciot\+\_\+iface\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}req, void \texorpdfstring{$\ast$}{*}sender) -\begin{DoxyCompactList}\small\item\em Processes a request on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_a1838217e75528a5d17f7e3b640c58321}{ciot\+\_\+iface\+\_\+process\+\_\+msg}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg, void \texorpdfstring{$\ast$}{*}sender) -\begin{DoxyCompactList}\small\item\em Processes a message on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_ac30f4e1e8fcb5a66822b04c384890c58}{ciot\+\_\+iface\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, void \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Sends data on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_a5e15dc97b9b45855f868dee02c69c166}{ciot\+\_\+iface\+\_\+send\+\_\+msg}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg, int size) -\begin{DoxyCompactList}\small\item\em Sends a message on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_a5f8b92fd30cad0f550ef9976e037b93e}{ciot\+\_\+iface\+\_\+send\+\_\+req}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}req, int size) -\begin{DoxyCompactList}\small\item\em Sends a request on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_ae6a255f29e6adcc8a7325c29abba6844}{ciot\+\_\+iface\+\_\+send\+\_\+rsp}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}rsp, int size) -\begin{DoxyCompactList}\small\item\em Sends a response on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_abded5657da5e3c7e38c1185b4b14a4a8}{ciot\+\_\+iface\+\_\+register\+\_\+event}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}} event\+\_\+handler, void \texorpdfstring{$\ast$}{*}event\+\_\+args) -\begin{DoxyCompactList}\small\item\em Registers an event handler for the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_aefceafcf049557b64450785501b2470a}{ciot\+\_\+iface\+\_\+reset\+\_\+request}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self) -\begin{DoxyCompactList}\small\item\em Resets a request on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_acfdf034f3291c65ee6798ffc860b6f1a}{ciot\+\_\+iface\+\_\+register\+\_\+request}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \texorpdfstring{$\ast$}{*}iface, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg, \mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\+\_\+iface\+\_\+req\+\_\+status\+\_\+t}} status) -\begin{DoxyCompactList}\small\item\em Registers a request on the CIOT interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__iface_8h_ac6198bf9f283fff84839fcba7aaa0682}{ciot\+\_\+iface\+\_\+set\+\_\+serializer}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, \mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}} serializer) -\begin{DoxyCompactList}\small\item\em Sets the serializer for the CIOT interface. \end{DoxyCompactList}\item -uint8\+\_\+t \mbox{\hyperlink{ciot__iface_8h_aa0070d90be5933f14530c81fca52fcfd}{ciot\+\_\+iface\+\_\+get\+\_\+msg\+\_\+id}} (void) -\begin{DoxyCompactList}\small\item\em Gets the message ID for the CIOT interface. \end{DoxyCompactList}\item -const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__iface_8h_ad4bea4982fb363829998c5fa64f76ccb}{ciot\+\_\+iface\+\_\+to\+\_\+str}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}iface) -\begin{DoxyCompactList}\small\item\em Converts a CIOT interface instance to a string representation. \end{DoxyCompactList}\item -const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__iface_8h_a6411ae488746c99b42a7970dcbe6b042}{ciot\+\_\+iface\+\_\+type\+\_\+to\+\_\+str}} (\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}} iface\+\_\+type) -\begin{DoxyCompactList}\small\item\em Converts a CIOT interface type to a string representation. \end{DoxyCompactList}\item -const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__iface_8h_aa3ff9b2090848d0920e0a69de86f6250}{ciot\+\_\+iface\+\_\+event\+\_\+to\+\_\+str}} (\mbox{\hyperlink{structciot__iface__event__t}{ciot\+\_\+iface\+\_\+event\+\_\+t}} \texorpdfstring{$\ast$}{*}event) -\begin{DoxyCompactList}\small\item\em Converts a CIOT interface event to a string representation. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for the CIOT interface. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}\label{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_base\_data\_t@{ciot\_iface\_base\_data\_t}} -\index{ciot\_iface\_base\_data\_t@{ciot\_iface\_base\_data\_t}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_base\_data\_t}{ciot\_iface\_base\_data\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__iface__base__data}{ciot\+\_\+iface\+\_\+base\+\_\+data}} \mbox{\hyperlink{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}{ciot\+\_\+iface\+\_\+base\+\_\+data\+\_\+t}}} - - - -Structure representing base data for an interface. - -\Hypertarget{ciot__iface_8h_abe9d78b6b8e29546fe52054115bea7a0}\label{ciot__iface_8h_abe9d78b6b8e29546fe52054115bea7a0} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_base\_t@{ciot\_iface\_base\_t}} -\index{ciot\_iface\_base\_t@{ciot\_iface\_base\_t}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_base\_t}{ciot\_iface\_base\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__iface__base}{ciot\+\_\+iface\+\_\+base}} \mbox{\hyperlink{ciot__iface_8h_abe9d78b6b8e29546fe52054115bea7a0}{ciot\+\_\+iface\+\_\+base\+\_\+t}}} - - - -Structure representing the base of an interface. - -\Hypertarget{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}\label{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_event\_handler\_t@{ciot\_iface\_event\_handler\_t}} -\index{ciot\_iface\_event\_handler\_t@{ciot\_iface\_event\_handler\_t}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_event\_handler\_t}{ciot\_iface\_event\_handler\_t}} -{\footnotesize\ttfamily typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t(\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}sender, \mbox{\hyperlink{structciot__iface__event__t}{ciot\+\_\+iface\+\_\+event\+\_\+t}} \texorpdfstring{$\ast$}{*}event, void \texorpdfstring{$\ast$}{*}args)} - - - -Function pointer for handling interface events. - -\Hypertarget{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}\label{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_event\_type\_t@{ciot\_iface\_event\_type\_t}} -\index{ciot\_iface\_event\_type\_t@{ciot\_iface\_event\_type\_t}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_event\_type\_t}{ciot\_iface\_event\_type\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cb}{ciot\+\_\+iface\+\_\+event\+\_\+type}} \mbox{\hyperlink{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}{ciot\+\_\+iface\+\_\+event\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT interface event types. - -\Hypertarget{ciot__iface_8h_ae586597c42a97043136f6afe51e7ebe8}\label{ciot__iface_8h_ae586597c42a97043136f6afe51e7ebe8} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_process\_req\_fn@{ciot\_iface\_process\_req\_fn}} -\index{ciot\_iface\_process\_req\_fn@{ciot\_iface\_process\_req\_fn}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_process\_req\_fn}{ciot\_iface\_process\_req\_fn}} -{\footnotesize\ttfamily typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+process\+\_\+req\+\_\+fn(void \texorpdfstring{$\ast$}{*}iface, \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}req)} - - - -Function pointer for processing a request on an interface. - -\Hypertarget{ciot__iface_8h_a3c7fbbc6d64e6ea8584c014743e20fb9}\label{ciot__iface_8h_a3c7fbbc6d64e6ea8584c014743e20fb9} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_req\_info\_t@{ciot\_iface\_req\_info\_t}} -\index{ciot\_iface\_req\_info\_t@{ciot\_iface\_req\_info\_t}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_req\_info\_t}{ciot\_iface\_req\_info\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__iface__req__info}{ciot\+\_\+iface\+\_\+req\+\_\+info}} \mbox{\hyperlink{ciot__iface_8h_a3c7fbbc6d64e6ea8584c014743e20fb9}{ciot\+\_\+iface\+\_\+req\+\_\+info\+\_\+t}}} - - - -Structure representing request information for an interface. - -\Hypertarget{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}\label{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_req\_status\_t@{ciot\_iface\_req\_status\_t}} -\index{ciot\_iface\_req\_status\_t@{ciot\_iface\_req\_status\_t}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_req\_status\_t}{ciot\_iface\_req\_status\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753ca}{ciot\+\_\+iface\+\_\+req\+\_\+status}} \mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\+\_\+iface\+\_\+req\+\_\+status\+\_\+t}}} - - - -Enumeration for the status of interface requests. - -\Hypertarget{ciot__iface_8h_affffc532ae0b36b941fc0ed0376a0a5a}\label{ciot__iface_8h_affffc532ae0b36b941fc0ed0376a0a5a} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_send\_data\_fn@{ciot\_iface\_send\_data\_fn}} -\index{ciot\_iface\_send\_data\_fn@{ciot\_iface\_send\_data\_fn}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_send\_data\_fn}{ciot\_iface\_send\_data\_fn}} -{\footnotesize\ttfamily typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+send\+\_\+data\+\_\+fn(void \texorpdfstring{$\ast$}{*}iface, void \texorpdfstring{$\ast$}{*}data, int size)} - - - -Function pointer for sending data on an interface. - -\Hypertarget{ciot__iface_8h_afa768ec7c39932d18718c66358303d16}\label{ciot__iface_8h_afa768ec7c39932d18718c66358303d16} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_start\_fn@{ciot\_iface\_start\_fn}} -\index{ciot\_iface\_start\_fn@{ciot\_iface\_start\_fn}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_start\_fn}{ciot\_iface\_start\_fn}} -{\footnotesize\ttfamily typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+start\+\_\+fn(void \texorpdfstring{$\ast$}{*}iface, \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}cfg)} - - - -Function pointer for starting an interface. - -\Hypertarget{ciot__iface_8h_adbb3382dd13c68ed5090d0021bfd8f29}\label{ciot__iface_8h_adbb3382dd13c68ed5090d0021bfd8f29} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_stop\_fn@{ciot\_iface\_stop\_fn}} -\index{ciot\_iface\_stop\_fn@{ciot\_iface\_stop\_fn}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_stop\_fn}{ciot\_iface\_stop\_fn}} -{\footnotesize\ttfamily typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+stop\+\_\+fn(void \texorpdfstring{$\ast$}{*}iface)} - - - -Function pointer for stopping an interface. - -\Hypertarget{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}\label{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_t@{ciot\_iface\_t}} -\index{ciot\_iface\_t@{ciot\_iface\_t}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_t}{ciot\_iface\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__iface}{ciot\+\_\+iface}} \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}}} - - - -Structure representing a CIOT interface. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cb}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cb} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_event\_type@{ciot\_iface\_event\_type}} -\index{ciot\_iface\_event\_type@{ciot\_iface\_event\_type}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_event\_type}{ciot\_iface\_event\_type}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cb}{ciot\+\_\+iface\+\_\+event\+\_\+type}}} - - - -Enumeration for CIOT interface event types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_INTERNAL@{CIOT\_IFACE\_EVENT\_INTERNAL}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_INTERNAL@{CIOT\_IFACE\_EVENT\_INTERNAL}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbad1b206ed7fad45c5e6630dc78d91844d}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbad1b206ed7fad45c5e6630dc78d91844d} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+INTERNAL&Internal event type. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_UNKNOWN@{CIOT\_IFACE\_EVENT\_UNKNOWN}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_UNKNOWN@{CIOT\_IFACE\_EVENT\_UNKNOWN}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba783c8ee8ead4e6638b0454ffbe5fe009}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba783c8ee8ead4e6638b0454ffbe5fe009} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+UNKNOWN&Unknown event type. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_STARTED@{CIOT\_IFACE\_EVENT\_STARTED}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_STARTED@{CIOT\_IFACE\_EVENT\_STARTED}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba2b18a98e307314d7257854b3f09700a6}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba2b18a98e307314d7257854b3f09700a6} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+STARTED&Interface started event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_STOPPED@{CIOT\_IFACE\_EVENT\_STOPPED}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_STOPPED@{CIOT\_IFACE\_EVENT\_STOPPED}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab52a8702f0eaf2aed031a3ca78468a71}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab52a8702f0eaf2aed031a3ca78468a71} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+STOPPED&Interface stopped event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_ERROR@{CIOT\_IFACE\_EVENT\_ERROR}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_ERROR@{CIOT\_IFACE\_EVENT\_ERROR}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba98063df9c53273544ed5b5424a05024e}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba98063df9c53273544ed5b5424a05024e} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+ERROR&Interface error event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_REQUEST@{CIOT\_IFACE\_EVENT\_REQUEST}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_REQUEST@{CIOT\_IFACE\_EVENT\_REQUEST}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba0f80ad7aed1ba3eecf1922446cbdde95}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba0f80ad7aed1ba3eecf1922446cbdde95} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+REQUEST&Interface request event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_DATA@{CIOT\_IFACE\_EVENT\_DATA}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_DATA@{CIOT\_IFACE\_EVENT\_DATA}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba080fca556c9a023720751526ecad8ccc}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba080fca556c9a023720751526ecad8ccc} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+DATA&Interface data event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_DONE@{CIOT\_IFACE\_EVENT\_DONE}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_DONE@{CIOT\_IFACE\_EVENT\_DONE}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab9bcdc77d1e0c80fdca8b60528af9d81}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab9bcdc77d1e0c80fdca8b60528af9d81} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+DONE&Interface done event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_EVENT\_CUSTOM@{CIOT\_IFACE\_EVENT\_CUSTOM}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_EVENT\_CUSTOM@{CIOT\_IFACE\_EVENT\_CUSTOM}}}\Hypertarget{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}\label{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f} -CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM&Custom interface event. \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753ca}\label{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753ca} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_req\_status@{ciot\_iface\_req\_status}} -\index{ciot\_iface\_req\_status@{ciot\_iface\_req\_status}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_req\_status}{ciot\_iface\_req\_status}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753ca}{ciot\+\_\+iface\+\_\+req\+\_\+status}}} - - - -Enumeration for the status of interface requests. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_REQ\_STATUS\_IDLE@{CIOT\_IFACE\_REQ\_STATUS\_IDLE}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_REQ\_STATUS\_IDLE@{CIOT\_IFACE\_REQ\_STATUS\_IDLE}}}\Hypertarget{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa6fad5b037b43a54a8d8e8f70c6e30eb6}\label{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa6fad5b037b43a54a8d8e8f70c6e30eb6} -CIOT\+\_\+\+IFACE\+\_\+\+REQ\+\_\+\+STATUS\+\_\+\+IDLE&Request status\+: Idle. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_REQ\_STATUS\_SENDED@{CIOT\_IFACE\_REQ\_STATUS\_SENDED}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_REQ\_STATUS\_SENDED@{CIOT\_IFACE\_REQ\_STATUS\_SENDED}}}\Hypertarget{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caac426693d5012b5aed25f77d2e8bedda5}\label{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caac426693d5012b5aed25f77d2e8bedda5} -CIOT\+\_\+\+IFACE\+\_\+\+REQ\+\_\+\+STATUS\+\_\+\+SENDED&Request status\+: Sent. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_REQ\_STATUS\_RECEIVED@{CIOT\_IFACE\_REQ\_STATUS\_RECEIVED}!ciot\_iface.h@{ciot\_iface.h}}\index{ciot\_iface.h@{ciot\_iface.h}!CIOT\_IFACE\_REQ\_STATUS\_RECEIVED@{CIOT\_IFACE\_REQ\_STATUS\_RECEIVED}}}\Hypertarget{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa52b88fef2a02a82b04031ad4ba09d0ef}\label{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa52b88fef2a02a82b04031ad4ba09d0ef} -CIOT\+\_\+\+IFACE\+\_\+\+REQ\+\_\+\+STATUS\+\_\+\+RECEIVED&Request status\+: Received. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__iface_8h_aa3ff9b2090848d0920e0a69de86f6250}\label{ciot__iface_8h_aa3ff9b2090848d0920e0a69de86f6250} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_event\_to\_str@{ciot\_iface\_event\_to\_str}} -\index{ciot\_iface\_event\_to\_str@{ciot\_iface\_event\_to\_str}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_event\_to\_str()}{ciot\_iface\_event\_to\_str()}} -{\footnotesize\ttfamily const char \texorpdfstring{$\ast$}{*} ciot\+\_\+iface\+\_\+event\+\_\+to\+\_\+str (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structciot__iface__event__t}{ciot\+\_\+iface\+\_\+event\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{event }\end{DoxyParamCaption})} - - - -Converts a CIOT interface event to a string representation. - - -\begin{DoxyParams}{Parameters} -{\em event} & The CIOT interface event. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A string representation of the CIOT interface event. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_aef1dd87e5c3111ca65fa4e63ca2c9213}\label{ciot__iface_8h_aef1dd87e5c3111ca65fa4e63ca2c9213} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_get\_cfg@{ciot\_iface\_get\_cfg}} -\index{ciot\_iface\_get\_cfg@{ciot\_iface\_get\_cfg}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_get\_cfg()}{ciot\_iface\_get\_cfg()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+get\+\_\+cfg (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Gets the configuration of the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em cfg} & The configuration data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a6b87395146fdad575079c47979fe1cc5}\label{ciot__iface_8h_a6b87395146fdad575079c47979fe1cc5} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_get\_info@{ciot\_iface\_get\_info}} -\index{ciot\_iface\_get\_info@{ciot\_iface\_get\_info}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_get\_info()}{ciot\_iface\_get\_info()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+get\+\_\+info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{iface, }\item[{void \texorpdfstring{$\ast$}{*}}]{info, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Gets the information of the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em iface} & The CIOT interface. \\ -\hline -{\em info} & The information data. \\ -\hline -{\em size} & The size of the information data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_aa0070d90be5933f14530c81fca52fcfd}\label{ciot__iface_8h_aa0070d90be5933f14530c81fca52fcfd} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_get\_msg\_id@{ciot\_iface\_get\_msg\_id}} -\index{ciot\_iface\_get\_msg\_id@{ciot\_iface\_get\_msg\_id}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_get\_msg\_id()}{ciot\_iface\_get\_msg\_id()}} -{\footnotesize\ttfamily uint8\+\_\+t ciot\+\_\+iface\+\_\+get\+\_\+msg\+\_\+id (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -Gets the message ID for the CIOT interface. - -\begin{DoxyReturn}{Returns} -The message ID. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a7c59fa4a32c0662de361fd89847ab62b}\label{ciot__iface_8h_a7c59fa4a32c0662de361fd89847ab62b} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_get\_status@{ciot\_iface\_get\_status}} -\index{ciot\_iface\_get\_status@{ciot\_iface\_get\_status}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_get\_status()}{ciot\_iface\_get\_status()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+get\+\_\+status (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{void \texorpdfstring{$\ast$}{*}}]{status }\end{DoxyParamCaption})} - - - -Gets the status of the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em status} & The status data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a1838217e75528a5d17f7e3b640c58321}\label{ciot__iface_8h_a1838217e75528a5d17f7e3b640c58321} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_process\_msg@{ciot\_iface\_process\_msg}} -\index{ciot\_iface\_process\_msg@{ciot\_iface\_process\_msg}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_process\_msg()}{ciot\_iface\_process\_msg()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+process\+\_\+msg (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{msg, }\item[{void \texorpdfstring{$\ast$}{*}}]{sender }\end{DoxyParamCaption})} - - - -Processes a message on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em msg} & The message data. \\ -\hline -{\em sender} & The sender of the message. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_abc404557e0571e7e5ea0c5db63fa8c23}\label{ciot__iface_8h_abc404557e0571e7e5ea0c5db63fa8c23} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_process\_req@{ciot\_iface\_process\_req}} -\index{ciot\_iface\_process\_req@{ciot\_iface\_process\_req}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_process\_req()}{ciot\_iface\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}}]{req, }\item[{void \texorpdfstring{$\ast$}{*}}]{sender }\end{DoxyParamCaption})} - - - -Processes a request on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em req} & The request data. \\ -\hline -{\em sender} & The sender of the request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_abded5657da5e3c7e38c1185b4b14a4a8}\label{ciot__iface_8h_abded5657da5e3c7e38c1185b4b14a4a8} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_register\_event@{ciot\_iface\_register\_event}} -\index{ciot\_iface\_register\_event@{ciot\_iface\_register\_event}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_register\_event()}{ciot\_iface\_register\_event()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+register\+\_\+event (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}}}]{event\+\_\+handler, }\item[{void \texorpdfstring{$\ast$}{*}}]{event\+\_\+args }\end{DoxyParamCaption})} - - - -Registers an event handler for the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em event\+\_\+handler} & The event handler function pointer. \\ -\hline -{\em event\+\_\+args} & The event arguments. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_acfdf034f3291c65ee6798ffc860b6f1a}\label{ciot__iface_8h_acfdf034f3291c65ee6798ffc860b6f1a} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_register\_request@{ciot\_iface\_register\_request}} -\index{ciot\_iface\_register\_request@{ciot\_iface\_register\_request}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_register\_request()}{ciot\_iface\_register\_request()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+register\+\_\+request (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{iface, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{msg, }\item[{\mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\+\_\+iface\+\_\+req\+\_\+status\+\_\+t}}}]{status }\end{DoxyParamCaption})} - - - -Registers a request on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em iface} & The interface information. \\ -\hline -{\em msg} & The request message. \\ -\hline -{\em status} & The request status. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_aefceafcf049557b64450785501b2470a}\label{ciot__iface_8h_aefceafcf049557b64450785501b2470a} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_reset\_request@{ciot\_iface\_reset\_request}} -\index{ciot\_iface\_reset\_request@{ciot\_iface\_reset\_request}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_reset\_request()}{ciot\_iface\_reset\_request()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+reset\+\_\+request (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self }\end{DoxyParamCaption})} - - - -Resets a request on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_ac30f4e1e8fcb5a66822b04c384890c58}\label{ciot__iface_8h_ac30f4e1e8fcb5a66822b04c384890c58} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_send\_data@{ciot\_iface\_send\_data}} -\index{ciot\_iface\_send\_data@{ciot\_iface\_send\_data}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_send\_data()}{ciot\_iface\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{void \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends data on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em data} & The data to be sent. \\ -\hline -{\em size} & The size of the data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a5e15dc97b9b45855f868dee02c69c166}\label{ciot__iface_8h_a5e15dc97b9b45855f868dee02c69c166} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_send\_msg@{ciot\_iface\_send\_msg}} -\index{ciot\_iface\_send\_msg@{ciot\_iface\_send\_msg}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_send\_msg()}{ciot\_iface\_send\_msg()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+send\+\_\+msg (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{msg, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends a message on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em msg} & The message to be sent. \\ -\hline -{\em size} & The size of the message. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a5f8b92fd30cad0f550ef9976e037b93e}\label{ciot__iface_8h_a5f8b92fd30cad0f550ef9976e037b93e} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_send\_req@{ciot\_iface\_send\_req}} -\index{ciot\_iface\_send\_req@{ciot\_iface\_send\_req}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_send\_req()}{ciot\_iface\_send\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+send\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends a request on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em req} & The request to be sent. \\ -\hline -{\em size} & The size of the request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_ae6a255f29e6adcc8a7325c29abba6844}\label{ciot__iface_8h_ae6a255f29e6adcc8a7325c29abba6844} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_send\_rsp@{ciot\_iface\_send\_rsp}} -\index{ciot\_iface\_send\_rsp@{ciot\_iface\_send\_rsp}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_send\_rsp()}{ciot\_iface\_send\_rsp()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+send\+\_\+rsp (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{rsp, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends a response on the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em rsp} & The response to be sent. \\ -\hline -{\em size} & The size of the response. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_ac6198bf9f283fff84839fcba7aaa0682}\label{ciot__iface_8h_ac6198bf9f283fff84839fcba7aaa0682} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_set\_serializer@{ciot\_iface\_set\_serializer}} -\index{ciot\_iface\_set\_serializer@{ciot\_iface\_set\_serializer}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_set\_serializer()}{ciot\_iface\_set\_serializer()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+set\+\_\+serializer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}}}]{serializer }\end{DoxyParamCaption})} - - - -Sets the serializer for the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em serializer} & The serializer to set. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a15efdb74520f75fe9f0a695a349f07e0}\label{ciot__iface_8h_a15efdb74520f75fe9f0a695a349f07e0} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_start@{ciot\_iface\_start}} -\index{ciot\_iface\_start@{ciot\_iface\_start}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_start()}{ciot\_iface\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{\mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Starts the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -{\em cfg} & The configuration data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a7ad3131a637f86ed8d9a4655f060deca}\label{ciot__iface_8h_a7ad3131a637f86ed8d9a4655f060deca} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_stop@{ciot\_iface\_stop}} -\index{ciot\_iface\_stop@{ciot\_iface\_stop}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_stop()}{ciot\_iface\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+iface\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self }\end{DoxyParamCaption})} - - - -Stops the CIOT interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & The CIOT interface instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the result of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_ad4bea4982fb363829998c5fa64f76ccb}\label{ciot__iface_8h_ad4bea4982fb363829998c5fa64f76ccb} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_to\_str@{ciot\_iface\_to\_str}} -\index{ciot\_iface\_to\_str@{ciot\_iface\_to\_str}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_to\_str()}{ciot\_iface\_to\_str()}} -{\footnotesize\ttfamily const char \texorpdfstring{$\ast$}{*} ciot\+\_\+iface\+\_\+to\+\_\+str (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{iface }\end{DoxyParamCaption})} - - - -Converts a CIOT interface instance to a string representation. - - -\begin{DoxyParams}{Parameters} -{\em iface} & The CIOT interface instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A string representation of the CIOT interface. -\end{DoxyReturn} -\Hypertarget{ciot__iface_8h_a6411ae488746c99b42a7970dcbe6b042}\label{ciot__iface_8h_a6411ae488746c99b42a7970dcbe6b042} -\index{ciot\_iface.h@{ciot\_iface.h}!ciot\_iface\_type\_to\_str@{ciot\_iface\_type\_to\_str}} -\index{ciot\_iface\_type\_to\_str@{ciot\_iface\_type\_to\_str}!ciot\_iface.h@{ciot\_iface.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_type\_to\_str()}{ciot\_iface\_type\_to\_str()}} -{\footnotesize\ttfamily const char \texorpdfstring{$\ast$}{*} ciot\+\_\+iface\+\_\+type\+\_\+to\+\_\+str (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}}}]{iface\+\_\+type }\end{DoxyParamCaption})} - - - -Converts a CIOT interface type to a string representation. - - -\begin{DoxyParams}{Parameters} -{\em iface\+\_\+type} & The CIOT interface type. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A string representation of the CIOT interface type. -\end{DoxyReturn} diff --git a/docs/latex/ciot__iface_8h_source.tex b/docs/latex/ciot__iface_8h_source.tex deleted file mode 100644 index 3a0bf40..0000000 --- a/docs/latex/ciot__iface_8h_source.tex +++ /dev/null @@ -1,136 +0,0 @@ -\doxysection{ciot\+\_\+iface.\+h} -\hypertarget{ciot__iface_8h_source}{}\label{ciot__iface_8h_source}\index{include/ciot\_iface.h@{include/ciot\_iface.h}} -\mbox{\hyperlink{ciot__iface_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_IFACE\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_IFACE\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00018\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__msg__types_8h}{types/ciot\_msg\_types.h}}"{}}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__serializer_8h}{ciot\_serializer.h}}"{}}} -\DoxyCodeLine{00022\ } -\DoxyCodeLine{00026\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753ca}{ciot\_iface\_req\_status}}\ \{} -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa6fad5b037b43a54a8d8e8f70c6e30eb6}{CIOT\_IFACE\_REQ\_STATUS\_IDLE}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caac426693d5012b5aed25f77d2e8bedda5}{CIOT\_IFACE\_REQ\_STATUS\_SENDED}},\ } -\DoxyCodeLine{00029\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aa73c62bfec675d5d722fab4532b753caa52b88fef2a02a82b04031ad4ba09d0ef}{CIOT\_IFACE\_REQ\_STATUS\_RECEIVED}},\ } -\DoxyCodeLine{00030\ \}\ \mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\_iface\_req\_status\_t}};} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00035\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cb}{ciot\_iface\_event\_type}}\ \{} -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbad1b206ed7fad45c5e6630dc78d91844d}{CIOT\_IFACE\_EVENT\_INTERNAL}}\ =\ -\/1,\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba783c8ee8ead4e6638b0454ffbe5fe009}{CIOT\_IFACE\_EVENT\_UNKNOWN}},\ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba2b18a98e307314d7257854b3f09700a6}{CIOT\_IFACE\_EVENT\_STARTED}},\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab52a8702f0eaf2aed031a3ca78468a71}{CIOT\_IFACE\_EVENT\_STOPPED}},\ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba98063df9c53273544ed5b5424a05024e}{CIOT\_IFACE\_EVENT\_ERROR}},\ } -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba0f80ad7aed1ba3eecf1922446cbdde95}{CIOT\_IFACE\_EVENT\_REQUEST}},\ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba080fca556c9a023720751526ecad8ccc}{CIOT\_IFACE\_EVENT\_DATA}},\ } -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cbab9bcdc77d1e0c80fdca8b60528af9d81}{CIOT\_IFACE\_EVENT\_DONE}},\ } -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00045\ \}\ \mbox{\hyperlink{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}{ciot\_iface\_event\_type\_t}};} -\DoxyCodeLine{00046\ } -\DoxyCodeLine{00050\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00051\ \ \ \ \ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ \mbox{\hyperlink{unionciot__iface__event__data__u_abd6b36b1e2c07eaa53b376fdbf0e9345}{msg}};\ } -\DoxyCodeLine{00052\ \ \ \ \ uint8\_t\ payload[\textcolor{keyword}{sizeof}(\mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}})];\ } -\DoxyCodeLine{00053\ \}\ \mbox{\hyperlink{unionciot__iface__event__data__u}{ciot\_iface\_event\_data\_u}};} -\DoxyCodeLine{00054\ } -\DoxyCodeLine{00058\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00059\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}{ciot\_iface\_event\_type\_t}}\ \mbox{\hyperlink{structciot__iface__event__t_a5cd16071ec4ec2b6bb4c625e53b07c5b}{type}};\ } -\DoxyCodeLine{00060\ \ \ \ \ \mbox{\hyperlink{unionciot__iface__event__data__u}{ciot\_iface\_event\_data\_u}}\ *\mbox{\hyperlink{structciot__iface__event__t_a6714610a8d6e593a48b14b3c5600fef0}{data}};\ } -\DoxyCodeLine{00061\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__iface__event__t_aaba88b24a21a6c70c895c0d55f4a69a0}{size}};\ } -\DoxyCodeLine{00062\ \}\ \mbox{\hyperlink{structciot__iface__event__t}{ciot\_iface\_event\_t}};} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00067\ \textcolor{keyword}{typedef}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ (\mbox{\hyperlink{ciot__iface_8h_afa768ec7c39932d18718c66358303d16}{ciot\_iface\_start\_fn}})(\textcolor{keywordtype}{void}\ *iface,\ \mbox{\hyperlink{unionciot__msg__data__u}{ciot\_msg\_data\_u}}\ *cfg);} -\DoxyCodeLine{00068\ } -\DoxyCodeLine{00072\ \textcolor{keyword}{typedef}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ (\mbox{\hyperlink{ciot__iface_8h_adbb3382dd13c68ed5090d0021bfd8f29}{ciot\_iface\_stop\_fn}})(\textcolor{keywordtype}{void}\ *iface);} -\DoxyCodeLine{00073\ } -\DoxyCodeLine{00077\ \textcolor{keyword}{typedef}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ (\mbox{\hyperlink{ciot__iface_8h_ae586597c42a97043136f6afe51e7ebe8}{ciot\_iface\_process\_req\_fn}})(\textcolor{keywordtype}{void}\ *iface,\ \mbox{\hyperlink{unionciot__msg__data__u}{ciot\_msg\_data\_u}}\ *req);} -\DoxyCodeLine{00078\ } -\DoxyCodeLine{00082\ \textcolor{keyword}{typedef}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ (\mbox{\hyperlink{ciot__iface_8h_affffc532ae0b36b941fc0ed0376a0a5a}{ciot\_iface\_send\_data\_fn}})(\textcolor{keywordtype}{void}\ *iface,\ \textcolor{keywordtype}{void}\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00083\ } -\DoxyCodeLine{00087\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__iface__base__data}{ciot\_iface\_base\_data}}\ \{} -\DoxyCodeLine{00088\ \ \ \ \ \textcolor{keywordtype}{void}\ *\mbox{\hyperlink{structciot__iface__base__data_add9af9569af79ec26dd741fb226b38ba}{ptr}};\ } -\DoxyCodeLine{00089\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__iface__base__data_aaba88b24a21a6c70c895c0d55f4a69a0}{size}};\ } -\DoxyCodeLine{00090\ \}\ \mbox{\hyperlink{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}{ciot\_iface\_base\_data\_t}};} -\DoxyCodeLine{00091\ } -\DoxyCodeLine{00095\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__iface__req__info}{ciot\_iface\_req\_info}}\ \{} -\DoxyCodeLine{00096\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\_iface\_req\_status\_t}}\ \mbox{\hyperlink{structciot__iface__req__info_a2a773bc681a41b29b21f8c106c0161ef}{status}};\ } -\DoxyCodeLine{00097\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__iface__req__info_a1e6927fa1486224044e568f9c370519b}{id}};\ } -\DoxyCodeLine{00098\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\_msg\_type\_t}}\ \mbox{\hyperlink{structciot__iface__req__info_ac3305f4a165c4d898ce7988191102e46}{type}};\ } -\DoxyCodeLine{00099\ \ \ \ \ \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\_msg\_iface\_info\_t}}\ \mbox{\hyperlink{structciot__iface__req__info_a3501e3667f1031fb2f00b333b7b2269a}{iface}};\ } -\DoxyCodeLine{00100\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__iface__req__info_a0b61a5ca677a324b62936d18d21ff362}{response\_size}};\ } -\DoxyCodeLine{00101\ \}\ \mbox{\hyperlink{ciot__iface_8h_a3c7fbbc6d64e6ea8584c014743e20fb9}{ciot\_iface\_req\_info\_t}};} -\DoxyCodeLine{00102\ } -\DoxyCodeLine{00106\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__iface__base}{ciot\_iface\_base}}\ \{} -\DoxyCodeLine{00107\ \ \ \ \ \textcolor{keywordtype}{void}\ *\mbox{\hyperlink{structciot__iface__base_add9af9569af79ec26dd741fb226b38ba}{ptr}};\ } -\DoxyCodeLine{00108\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_afa768ec7c39932d18718c66358303d16}{ciot\_iface\_start\_fn}}\ *\mbox{\hyperlink{structciot__iface__base_abd070cd5170ccae6d490974e511dd41b}{start}};\ } -\DoxyCodeLine{00109\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_adbb3382dd13c68ed5090d0021bfd8f29}{ciot\_iface\_stop\_fn}}\ *\mbox{\hyperlink{structciot__iface__base_ac99445311cef9672f346b7a3ab22d879}{stop}};\ } -\DoxyCodeLine{00110\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_ae586597c42a97043136f6afe51e7ebe8}{ciot\_iface\_process\_req\_fn}}\ *\mbox{\hyperlink{structciot__iface__base_ae2b271bbc55ea5a64e70f8566010f2cb}{process\_req}};\ } -\DoxyCodeLine{00111\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_affffc532ae0b36b941fc0ed0376a0a5a}{ciot\_iface\_send\_data\_fn}}\ *\mbox{\hyperlink{structciot__iface__base_ad0e5b143f45f5ccb026a527086ddb15f}{send\_data}};\ } -\DoxyCodeLine{00112\ \ \ \ \ \mbox{\hyperlink{structciot__iface__base__data}{ciot\_iface\_base\_data\_t}}\ \mbox{\hyperlink{structciot__iface__base_a6894fb208d021352bc4a53806a2a38dc}{cfg}};\ } -\DoxyCodeLine{00113\ \ \ \ \ \mbox{\hyperlink{structciot__iface__base__data}{ciot\_iface\_base\_data\_t}}\ \mbox{\hyperlink{structciot__iface__base_ac0223aea9839f62092995675d1e38339}{status}};\ } -\DoxyCodeLine{00114\ \ \ \ \ \mbox{\hyperlink{structciot__iface__req__info}{ciot\_iface\_req\_info\_t}}\ \mbox{\hyperlink{structciot__iface__base_aa04a90d2225ba674bcdc0c62f4a78c2c}{req}};\ } -\DoxyCodeLine{00115\ \}\ \mbox{\hyperlink{ciot__iface_8h_abe9d78b6b8e29546fe52054115bea7a0}{ciot\_iface\_base\_t}};} -\DoxyCodeLine{00116\ } -\DoxyCodeLine{00120\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__iface}{ciot\_iface}}\ \mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}};} -\DoxyCodeLine{00121\ } -\DoxyCodeLine{00125\ \textcolor{keyword}{typedef}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ (\mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\_iface\_event\_handler\_t}})(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *sender,\ \mbox{\hyperlink{structciot__iface__event__t}{ciot\_iface\_event\_t}}\ *event,\ \textcolor{keywordtype}{void}\ *args);} -\DoxyCodeLine{00126\ } -\DoxyCodeLine{00130\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__iface}{ciot\_iface}}\ \{} -\DoxyCodeLine{00131\ \ \ \ \ \mbox{\hyperlink{structciot__iface__base}{ciot\_iface\_base\_t}}\ \mbox{\hyperlink{structciot__iface_a853cb7e7d6095705dfa3c0cef66ec736}{base}};\ } -\DoxyCodeLine{00132\ \ \ \ \ \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\_msg\_iface\_info\_t}}\ \mbox{\hyperlink{structciot__iface_a3d19d97719cf13cda1f021cf5dbaabb6}{info}};\ } -\DoxyCodeLine{00133\ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\_iface\_event\_handler\_t}}\ *\mbox{\hyperlink{structciot__iface_a6c29272de72de0546f7cb703993eb1f5}{event\_handler}};\ } -\DoxyCodeLine{00134\ \ \ \ \ \mbox{\hyperlink{structciot__serializer}{ciot\_serializer\_t}}\ \mbox{\hyperlink{structciot__iface_ae1afa3b8277cc9c96f891782785c4b34}{serializer}};\ } -\DoxyCodeLine{00135\ \ \ \ \ \textcolor{keywordtype}{void}\ *\mbox{\hyperlink{structciot__iface_a702f51681c5c1dd8d6ad5aaa41d80f29}{event\_args}};\ } -\DoxyCodeLine{00136\ \};} -\DoxyCodeLine{00137\ } -\DoxyCodeLine{00144\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_a15efdb74520f75fe9f0a695a349f07e0}{ciot\_iface\_start}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{unionciot__msg__data__u}{ciot\_msg\_data\_u}}\ *cfg);} -\DoxyCodeLine{00145\ } -\DoxyCodeLine{00151\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_a7ad3131a637f86ed8d9a4655f060deca}{ciot\_iface\_stop}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self);} -\DoxyCodeLine{00152\ } -\DoxyCodeLine{00159\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_aef1dd87e5c3111ca65fa4e63ca2c9213}{ciot\_iface\_get\_cfg}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{unionciot__msg__data__u}{ciot\_msg\_data\_u}}\ *cfg);} -\DoxyCodeLine{00160\ } -\DoxyCodeLine{00167\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_a7c59fa4a32c0662de361fd89847ab62b}{ciot\_iface\_get\_status}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \textcolor{keywordtype}{void}\ *status);} -\DoxyCodeLine{00168\ } -\DoxyCodeLine{00176\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_a6b87395146fdad575079c47979fe1cc5}{ciot\_iface\_get\_info}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *iface,\ \textcolor{keywordtype}{void}\ *info,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00177\ } -\DoxyCodeLine{00185\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_abc404557e0571e7e5ea0c5db63fa8c23}{ciot\_iface\_process\_req}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{unionciot__msg__data__u}{ciot\_msg\_data\_u}}\ *req,\ \textcolor{keywordtype}{void}\ *sender);} -\DoxyCodeLine{00186\ } -\DoxyCodeLine{00194\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_a1838217e75528a5d17f7e3b640c58321}{ciot\_iface\_process\_msg}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg,\ \textcolor{keywordtype}{void}\ *sender);} -\DoxyCodeLine{00195\ } -\DoxyCodeLine{00203\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_ac30f4e1e8fcb5a66822b04c384890c58}{ciot\_iface\_send\_data}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \textcolor{keywordtype}{void}\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00204\ } -\DoxyCodeLine{00212\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_a5e15dc97b9b45855f868dee02c69c166}{ciot\_iface\_send\_msg}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00213\ } -\DoxyCodeLine{00221\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_a5f8b92fd30cad0f550ef9976e037b93e}{ciot\_iface\_send\_req}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *req,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00222\ } -\DoxyCodeLine{00230\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_ae6a255f29e6adcc8a7325c29abba6844}{ciot\_iface\_send\_rsp}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *rsp,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00231\ } -\DoxyCodeLine{00239\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_abded5657da5e3c7e38c1185b4b14a4a8}{ciot\_iface\_register\_event}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\_iface\_event\_handler\_t}}\ event\_handler,\ \textcolor{keywordtype}{void}\ *event\_args);} -\DoxyCodeLine{00240\ } -\DoxyCodeLine{00246\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_aefceafcf049557b64450785501b2470a}{ciot\_iface\_reset\_request}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self);} -\DoxyCodeLine{00247\ } -\DoxyCodeLine{00256\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_acfdf034f3291c65ee6798ffc860b6f1a}{ciot\_iface\_register\_request}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\_msg\_iface\_info\_t}}\ *iface,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg,\ \mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\_iface\_req\_status\_t}}\ status);} -\DoxyCodeLine{00257\ } -\DoxyCodeLine{00264\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__iface_8h_ac6198bf9f283fff84839fcba7aaa0682}{ciot\_iface\_set\_serializer}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ \mbox{\hyperlink{structciot__serializer}{ciot\_serializer\_t}}\ serializer);} -\DoxyCodeLine{00265\ } -\DoxyCodeLine{00270\ uint8\_t\ \mbox{\hyperlink{ciot__iface_8h_aa0070d90be5933f14530c81fca52fcfd}{ciot\_iface\_get\_msg\_id}}(\textcolor{keywordtype}{void});} -\DoxyCodeLine{00271\ } -\DoxyCodeLine{00277\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\mbox{\hyperlink{ciot__iface_8h_ad4bea4982fb363829998c5fa64f76ccb}{ciot\_iface\_to\_str}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *iface);} -\DoxyCodeLine{00278\ } -\DoxyCodeLine{00284\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\mbox{\hyperlink{ciot__iface_8h_a6411ae488746c99b42a7970dcbe6b042}{ciot\_iface\_type\_to\_str}}(\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\_msg\_iface\_type\_t}}\ iface\_type);} -\DoxyCodeLine{00285\ } -\DoxyCodeLine{00291\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\mbox{\hyperlink{ciot__iface_8h_aa3ff9b2090848d0920e0a69de86f6250}{ciot\_iface\_event\_to\_str}}(\mbox{\hyperlink{structciot__iface__event__t}{ciot\_iface\_event\_t}}\ *event);} -\DoxyCodeLine{00292\ } -\DoxyCodeLine{00293\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00294\ \}} -\DoxyCodeLine{00295\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00296\ } -\DoxyCodeLine{00297\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ifaces_8h.tex b/docs/latex/ciot__ifaces_8h.tex deleted file mode 100644 index 63ba423..0000000 --- a/docs/latex/ciot__ifaces_8h.tex +++ /dev/null @@ -1,194 +0,0 @@ -\doxysection{include/ciot\+\_\+ifaces.h File Reference} -\hypertarget{ciot__ifaces_8h}{}\label{ciot__ifaces_8h}\index{include/ciot\_ifaces.h@{include/ciot\_ifaces.h}} - - -Header file for CIOT interfaces. - - -{\ttfamily \#include "{}ciot.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+storage.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+sys.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+uart.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+usb.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+tcp.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+wifi.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ble.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ble\+\_\+scn.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ntp.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ota.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+https.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+httpc.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+mqttc.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+bridge.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ifaces}{ciot\+\_\+ifaces}} -\begin{DoxyCompactList}\small\item\em Structure representing CIOT interfaces. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef enum \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1e}{ciot\+\_\+iface\+\_\+id}} \mbox{\hyperlink{ciot__ifaces_8h_a81dae521394bdd3a9d8b848740f5433a}{ciot\+\_\+iface\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT interface IDs. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__ifaces}{ciot\+\_\+ifaces}} \mbox{\hyperlink{ciot__ifaces_8h_a689f38bac0aaf012140f11da651c8c0f}{ciot\+\_\+ifaces\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing CIOT interfaces. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1e}{ciot\+\_\+iface\+\_\+id}} \{ \newline -\mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eab83be87e2b46a1081b4213c560c25426}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea49cfed8646f3de92a34287bb413e85ef}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+CIOT}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eaf73e60bfa3d2bfe988000062e4a6fb5a}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+STORAGE}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea46a519b30f420e680495d99a0f013b02}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+SYSTEM}} -, \newline -\mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea70e4ffdab38e4c017b0e82199aceb028}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+UART}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ead428622f610ad7bf11f8c881108a2430}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+USB}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eace465d93bac433735d3cb4f4256743ea}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+TCP}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eae58f8ebc9e8233810e0507dcc8cf3de5}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+ETH}} -, \newline -\mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea6ff4fdc5bf330bfbde15f71646b3a14f}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+WIFI}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2a08ed7ae7a1cc621cb4708a6dd0e396}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+BLE}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea7f3c5f3d0ad4f1dfd3d783241d99db3f}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+BLE\+\_\+\+SCN}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea050d0909d9275b2785e13e92ee6db35d}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+GPIO}} -, \newline -\mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2c1db03e2628aba552b741a079c4f3b6}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+NTP}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea77a9be4a3d71157a99b3931ecb890760}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+OTA}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea663fe58cdc4d896f7729e953d709b9ea}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+DFU}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eadeaee2994eba2268fbf880938d75ce9e}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+HTTP\+\_\+\+CLIENT}} -, \newline -\mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea10242eda2c41ddb76f3d05a8d3507c14}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+HTTP\+\_\+\+SERVER}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eac8eeadb10c436b739b7bb180d65b053a}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+MQTT}} -, \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea38e855c72e72086bdc9b45543981b9d3}{CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+BRIDGE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT interface IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT interfaces. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/15 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__ifaces_8h_a81dae521394bdd3a9d8b848740f5433a}\label{ciot__ifaces_8h_a81dae521394bdd3a9d8b848740f5433a} -\index{ciot\_ifaces.h@{ciot\_ifaces.h}!ciot\_iface\_id\_t@{ciot\_iface\_id\_t}} -\index{ciot\_iface\_id\_t@{ciot\_iface\_id\_t}!ciot\_ifaces.h@{ciot\_ifaces.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_id\_t}{ciot\_iface\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1e}{ciot\+\_\+iface\+\_\+id}} \mbox{\hyperlink{ciot__ifaces_8h_a81dae521394bdd3a9d8b848740f5433a}{ciot\+\_\+iface\+\_\+id\+\_\+t}}} - - - -Enumeration for CIOT interface IDs. - -\Hypertarget{ciot__ifaces_8h_a689f38bac0aaf012140f11da651c8c0f}\label{ciot__ifaces_8h_a689f38bac0aaf012140f11da651c8c0f} -\index{ciot\_ifaces.h@{ciot\_ifaces.h}!ciot\_ifaces\_t@{ciot\_ifaces\_t}} -\index{ciot\_ifaces\_t@{ciot\_ifaces\_t}!ciot\_ifaces.h@{ciot\_ifaces.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ifaces\_t}{ciot\_ifaces\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__ifaces}{ciot\+\_\+ifaces}} \mbox{\hyperlink{ciot__ifaces_8h_a689f38bac0aaf012140f11da651c8c0f}{ciot\+\_\+ifaces\+\_\+t}}} - - - -Structure representing CIOT interfaces. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1e}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1e} -\index{ciot\_ifaces.h@{ciot\_ifaces.h}!ciot\_iface\_id@{ciot\_iface\_id}} -\index{ciot\_iface\_id@{ciot\_iface\_id}!ciot\_ifaces.h@{ciot\_ifaces.h}} -\doxysubsubsection{\texorpdfstring{ciot\_iface\_id}{ciot\_iface\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1e}{ciot\+\_\+iface\+\_\+id}}} - - - -Enumeration for CIOT interface IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_UNKNOWN@{CIOT\_IFACE\_ID\_UNKNOWN}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_UNKNOWN@{CIOT\_IFACE\_ID\_UNKNOWN}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eab83be87e2b46a1081b4213c560c25426}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eab83be87e2b46a1081b4213c560c25426} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+UNKNOWN&Unknown interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_CIOT@{CIOT\_IFACE\_ID\_CIOT}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_CIOT@{CIOT\_IFACE\_ID\_CIOT}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea49cfed8646f3de92a34287bb413e85ef}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea49cfed8646f3de92a34287bb413e85ef} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+CIOT&CIOT interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_STORAGE@{CIOT\_IFACE\_ID\_STORAGE}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_STORAGE@{CIOT\_IFACE\_ID\_STORAGE}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eaf73e60bfa3d2bfe988000062e4a6fb5a}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eaf73e60bfa3d2bfe988000062e4a6fb5a} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+STORAGE&Storage interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_SYSTEM@{CIOT\_IFACE\_ID\_SYSTEM}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_SYSTEM@{CIOT\_IFACE\_ID\_SYSTEM}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea46a519b30f420e680495d99a0f013b02}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea46a519b30f420e680495d99a0f013b02} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+SYSTEM&System interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_UART@{CIOT\_IFACE\_ID\_UART}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_UART@{CIOT\_IFACE\_ID\_UART}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea70e4ffdab38e4c017b0e82199aceb028}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea70e4ffdab38e4c017b0e82199aceb028} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+UART&UART interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_USB@{CIOT\_IFACE\_ID\_USB}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_USB@{CIOT\_IFACE\_ID\_USB}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ead428622f610ad7bf11f8c881108a2430}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ead428622f610ad7bf11f8c881108a2430} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+USB&USB interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_TCP@{CIOT\_IFACE\_ID\_TCP}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_TCP@{CIOT\_IFACE\_ID\_TCP}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eace465d93bac433735d3cb4f4256743ea}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eace465d93bac433735d3cb4f4256743ea} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+TCP&TCP interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_ETH@{CIOT\_IFACE\_ID\_ETH}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_ETH@{CIOT\_IFACE\_ID\_ETH}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eae58f8ebc9e8233810e0507dcc8cf3de5}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eae58f8ebc9e8233810e0507dcc8cf3de5} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+ETH&Ethernet interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_WIFI@{CIOT\_IFACE\_ID\_WIFI}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_WIFI@{CIOT\_IFACE\_ID\_WIFI}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea6ff4fdc5bf330bfbde15f71646b3a14f}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea6ff4fdc5bf330bfbde15f71646b3a14f} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+WIFI&Wi\+Fi interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_BLE@{CIOT\_IFACE\_ID\_BLE}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_BLE@{CIOT\_IFACE\_ID\_BLE}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2a08ed7ae7a1cc621cb4708a6dd0e396}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2a08ed7ae7a1cc621cb4708a6dd0e396} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+BLE&BLE interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_BLE\_SCN@{CIOT\_IFACE\_ID\_BLE\_SCN}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_BLE\_SCN@{CIOT\_IFACE\_ID\_BLE\_SCN}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea7f3c5f3d0ad4f1dfd3d783241d99db3f}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea7f3c5f3d0ad4f1dfd3d783241d99db3f} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+BLE\+\_\+\+SCN&BLE SCN interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_GPIO@{CIOT\_IFACE\_ID\_GPIO}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_GPIO@{CIOT\_IFACE\_ID\_GPIO}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea050d0909d9275b2785e13e92ee6db35d}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea050d0909d9275b2785e13e92ee6db35d} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+GPIO&GPIO interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_NTP@{CIOT\_IFACE\_ID\_NTP}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_NTP@{CIOT\_IFACE\_ID\_NTP}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2c1db03e2628aba552b741a079c4f3b6}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2c1db03e2628aba552b741a079c4f3b6} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+NTP&NTP interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_OTA@{CIOT\_IFACE\_ID\_OTA}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_OTA@{CIOT\_IFACE\_ID\_OTA}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea77a9be4a3d71157a99b3931ecb890760}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea77a9be4a3d71157a99b3931ecb890760} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+OTA&OTA interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_DFU@{CIOT\_IFACE\_ID\_DFU}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_DFU@{CIOT\_IFACE\_ID\_DFU}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea663fe58cdc4d896f7729e953d709b9ea}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea663fe58cdc4d896f7729e953d709b9ea} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+DFU&DFU interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_HTTP\_CLIENT@{CIOT\_IFACE\_ID\_HTTP\_CLIENT}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_HTTP\_CLIENT@{CIOT\_IFACE\_ID\_HTTP\_CLIENT}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eadeaee2994eba2268fbf880938d75ce9e}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eadeaee2994eba2268fbf880938d75ce9e} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+HTTP\+\_\+\+CLIENT&HTTP client interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_HTTP\_SERVER@{CIOT\_IFACE\_ID\_HTTP\_SERVER}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_HTTP\_SERVER@{CIOT\_IFACE\_ID\_HTTP\_SERVER}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea10242eda2c41ddb76f3d05a8d3507c14}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea10242eda2c41ddb76f3d05a8d3507c14} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+HTTP\+\_\+\+SERVER&HTTP server interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_MQTT@{CIOT\_IFACE\_ID\_MQTT}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_MQTT@{CIOT\_IFACE\_ID\_MQTT}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eac8eeadb10c436b739b7bb180d65b053a}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eac8eeadb10c436b739b7bb180d65b053a} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+MQTT&MQTT interface ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_ID\_BRIDGE@{CIOT\_IFACE\_ID\_BRIDGE}!ciot\_ifaces.h@{ciot\_ifaces.h}}\index{ciot\_ifaces.h@{ciot\_ifaces.h}!CIOT\_IFACE\_ID\_BRIDGE@{CIOT\_IFACE\_ID\_BRIDGE}}}\Hypertarget{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea38e855c72e72086bdc9b45543981b9d3}\label{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea38e855c72e72086bdc9b45543981b9d3} -CIOT\+\_\+\+IFACE\+\_\+\+ID\+\_\+\+BRIDGE&Bridge interface ID. \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__ifaces_8h_source.tex b/docs/latex/ciot__ifaces_8h_source.tex deleted file mode 100644 index 9543263..0000000 --- a/docs/latex/ciot__ifaces_8h_source.tex +++ /dev/null @@ -1,69 +0,0 @@ -\doxysection{ciot\+\_\+ifaces.\+h} -\hypertarget{ciot__ifaces_8h_source}{}\label{ciot__ifaces_8h_source}\index{include/ciot\_ifaces.h@{include/ciot\_ifaces.h}} -\mbox{\hyperlink{ciot__ifaces_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_IFACES\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_IFACES\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot_8h}{ciot.h}}"{}}} -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__storage_8h}{ciot\_storage.h}}"{}}} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__sys_8h}{ciot\_sys.h}}"{}}} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__uart_8h}{ciot\_uart.h}}"{}}} -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__usb_8h}{ciot\_usb.h}}"{}}} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp_8h}{ciot\_tcp.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp_8h}{ciot\_tcp.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__wifi_8h}{ciot\_wifi.h}}"{}}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble_8h}{ciot\_ble.h}}"{}}} -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__scn_8h}{ciot\_ble\_scn.h}}"{}}} -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ntp_8h}{ciot\_ntp.h}}"{}}} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ota_8h}{ciot\_ota.h}}"{}}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__https_8h}{ciot\_https.h}}"{}}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__httpc_8h}{ciot\_httpc.h}}"{}}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__mqttc_8h}{ciot\_mqttc.h}}"{}}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__bridge_8h}{ciot\_bridge.h}}"{}}} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00033\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1e}{ciot\_iface\_id}}\ \{} -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eab83be87e2b46a1081b4213c560c25426}{CIOT\_IFACE\_ID\_UNKNOWN}},\ } -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea49cfed8646f3de92a34287bb413e85ef}{CIOT\_IFACE\_ID\_CIOT}},\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eaf73e60bfa3d2bfe988000062e4a6fb5a}{CIOT\_IFACE\_ID\_STORAGE}},\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea46a519b30f420e680495d99a0f013b02}{CIOT\_IFACE\_ID\_SYSTEM}},\ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea70e4ffdab38e4c017b0e82199aceb028}{CIOT\_IFACE\_ID\_UART}},\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ead428622f610ad7bf11f8c881108a2430}{CIOT\_IFACE\_ID\_USB}},\ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eace465d93bac433735d3cb4f4256743ea}{CIOT\_IFACE\_ID\_TCP}},\ } -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eae58f8ebc9e8233810e0507dcc8cf3de5}{CIOT\_IFACE\_ID\_ETH}},\ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea6ff4fdc5bf330bfbde15f71646b3a14f}{CIOT\_IFACE\_ID\_WIFI}},\ } -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2a08ed7ae7a1cc621cb4708a6dd0e396}{CIOT\_IFACE\_ID\_BLE}},\ } -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea7f3c5f3d0ad4f1dfd3d783241d99db3f}{CIOT\_IFACE\_ID\_BLE\_SCN}},\ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea050d0909d9275b2785e13e92ee6db35d}{CIOT\_IFACE\_ID\_GPIO}},\ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea2c1db03e2628aba552b741a079c4f3b6}{CIOT\_IFACE\_ID\_NTP}},\ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea77a9be4a3d71157a99b3931ecb890760}{CIOT\_IFACE\_ID\_OTA}},\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea663fe58cdc4d896f7729e953d709b9ea}{CIOT\_IFACE\_ID\_DFU}},\ } -\DoxyCodeLine{00049\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eadeaee2994eba2268fbf880938d75ce9e}{CIOT\_IFACE\_ID\_HTTP\_CLIENT}},\ } -\DoxyCodeLine{00050\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea10242eda2c41ddb76f3d05a8d3507c14}{CIOT\_IFACE\_ID\_HTTP\_SERVER}},\ } -\DoxyCodeLine{00051\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1eac8eeadb10c436b739b7bb180d65b053a}{CIOT\_IFACE\_ID\_MQTT}},\ } -\DoxyCodeLine{00052\ \ \ \ \ \mbox{\hyperlink{ciot__ifaces_8h_a9d5cb59b2cf79db4358c80d28c99dd1ea38e855c72e72086bdc9b45543981b9d3}{CIOT\_IFACE\_ID\_BRIDGE}},\ } -\DoxyCodeLine{00053\ \}\ \mbox{\hyperlink{ciot__ifaces_8h_a81dae521394bdd3a9d8b848740f5433a}{ciot\_iface\_id\_t}};} -\DoxyCodeLine{00054\ } -\DoxyCodeLine{00058\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__ifaces}{ciot\_ifaces}}\ \{} -\DoxyCodeLine{00059\ \ \ \ \ \mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\_t}}\ \mbox{\hyperlink{structciot__ifaces_a56416f6eac2692c41c82d053ba002af2}{ciot}};\ } -\DoxyCodeLine{00060\ \ \ \ \ \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ \mbox{\hyperlink{structciot__ifaces_aaed783b786fd40c5690a32bebe9f0326}{storage}};\ } -\DoxyCodeLine{00061\ \ \ \ \ \mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ \mbox{\hyperlink{structciot__ifaces_a5cd7a867e5e008c3dd064684a180a470}{system}};\ } -\DoxyCodeLine{00062\ \ \ \ \ \mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ \mbox{\hyperlink{structciot__ifaces_a114aac4c4bd60245dda949be0febdcd2}{uart}};\ } -\DoxyCodeLine{00063\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ \mbox{\hyperlink{structciot__ifaces_a5d16ffd7a66e7e0e0c5fd07876f5a964}{usb}};\ } -\DoxyCodeLine{00064\ \ \ \ \ \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ \mbox{\hyperlink{structciot__ifaces_ac80889c5f3c6d9ed2cd6bba3616bdf4f}{tcp}};\ } -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ \mbox{\hyperlink{structciot__ifaces_ab20831600cb6d38f235145fee948813b}{eth}};\ } -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ \mbox{\hyperlink{structciot__ifaces_a688b2e35a1af524849eab17acfc86317}{wifi}};\ } -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\_ble\_t}}\ \mbox{\hyperlink{structciot__ifaces_ae23a932dbacce6377227a4654618111e}{ble}};\ } -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\_ble\_scn\_t}}\ \mbox{\hyperlink{structciot__ifaces_abac8466359f1900dd232e80aaa8f8069}{ble\_scn}};\ } -\DoxyCodeLine{00069\ \ \ \ \ \mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}}\ \mbox{\hyperlink{structciot__ifaces_a3ee37815964e9fd49d2dfee631dacedf}{ntp}};\ } -\DoxyCodeLine{00070\ \ \ \ \ \mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}}\ \mbox{\hyperlink{structciot__ifaces_a72c8d347d1c888290c5c6c8ecd4c58c5}{ota}};\ } -\DoxyCodeLine{00071\ \ \ \ \ \mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\_https\_t}}\ \mbox{\hyperlink{structciot__ifaces_a1ed8d43c3f1f21fa7c17cc87a6fe7797}{https}};\ } -\DoxyCodeLine{00072\ \ \ \ \ \mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\_httpc\_t}}\ \mbox{\hyperlink{structciot__ifaces_a54c2caecbbbf05be0157f3ab02cc7d24}{httpc}};\ } -\DoxyCodeLine{00073\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ \mbox{\hyperlink{structciot__ifaces_afda8467a92fbc5a6bb84aa0703cf6605}{mqtt}};\ } -\DoxyCodeLine{00074\ \ \ \ \ \mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\_bridge\_t}}\ \mbox{\hyperlink{structciot__ifaces_ab80591df7743604e3f3961fc9c52b0e3}{bridge}};\ } -\DoxyCodeLine{00075\ \}\ \mbox{\hyperlink{ciot__ifaces_8h_a689f38bac0aaf012140f11da651c8c0f}{ciot\_ifaces\_t}};} -\DoxyCodeLine{00076\ } -\DoxyCodeLine{00077\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__lib_8h.tex b/docs/latex/ciot__lib_8h.tex deleted file mode 100644 index aca9acb..0000000 --- a/docs/latex/ciot__lib_8h.tex +++ /dev/null @@ -1,60 +0,0 @@ -\doxysection{include/ciot\+\_\+lib.h File Reference} -\hypertarget{ciot__lib_8h}{}\label{ciot__lib_8h}\index{include/ciot\_lib.h@{include/ciot\_lib.h}} - - -CioT library header file. - - -{\ttfamily \#include "{}types/ciot\+\_\+ble\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+tcp\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+gpio\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+wifi\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+storage\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+uart\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+usb\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ble.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ble\+\_\+scn.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+eth.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+gpio.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+tcp.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+wifi.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+storage.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+uart.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+usb.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+bridge\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+dfu\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+httpc\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+https\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+mqttc\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+ntp\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+opcuas\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+ota\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+sys\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+bridge.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+dfu.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+httpc.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+https.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+mqttc.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+nrf\+\_\+dfu.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ntp.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+opcuas.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+ota.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+sys.\+h"{}}\newline - - -\doxysubsection{Detailed Description} -CioT library header file. - -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/05-\/14 -\end{DoxyDate} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} diff --git a/docs/latex/ciot__lib_8h_source.tex b/docs/latex/ciot__lib_8h_source.tex deleted file mode 100644 index de35e8e..0000000 --- a/docs/latex/ciot__lib_8h_source.tex +++ /dev/null @@ -1,53 +0,0 @@ -\doxysection{ciot\+\_\+lib.\+h} -\hypertarget{ciot__lib_8h_source}{}\label{ciot__lib_8h_source}\index{include/ciot\_lib.h@{include/ciot\_lib.h}} -\mbox{\hyperlink{ciot__lib_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_LIB\_\_H\_\_}} -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_LIB\_\_H\_\_}} -\DoxyCodeLine{00014\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__types_8h}{types/ciot\_ble\_types.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__scn__types_8h}{types/ciot\_ble\_scn\_types.h}}"{}}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp__types_8h}{types/ciot\_tcp\_types.h}}"{}}} -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__gpio__types_8h}{types/ciot\_gpio\_types.h}}"{}}} -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp__types_8h}{types/ciot\_tcp\_types.h}}"{}}} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__wifi__types_8h}{types/ciot\_wifi\_types.h}}"{}}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__storage__types_8h}{types/ciot\_storage\_types.h}}"{}}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__uart__types_8h}{types/ciot\_uart\_types.h}}"{}}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__usb__types_8h}{types/ciot\_usb\_types.h}}"{}}} -\DoxyCodeLine{00028\ } -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble_8h}{ciot\_ble.h}}"{}}} -\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__scn_8h}{ciot\_ble\_scn.h}}"{}}} -\DoxyCodeLine{00035\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__eth_8h}{ciot\_eth.h}}"{}}} -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__gpio_8h}{ciot\_gpio.h}}"{}}} -\DoxyCodeLine{00037\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp_8h}{ciot\_tcp.h}}"{}}} -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__wifi_8h}{ciot\_wifi.h}}"{}}} -\DoxyCodeLine{00039\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__storage_8h}{ciot\_storage.h}}"{}}} -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__uart_8h}{ciot\_uart.h}}"{}}} -\DoxyCodeLine{00041\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__usb_8h}{ciot\_usb.h}}"{}}} -\DoxyCodeLine{00042\ } -\DoxyCodeLine{00047\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__bridge__types_8h}{types/ciot\_bridge\_types.h}}"{}}} -\DoxyCodeLine{00048\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__dfu__types_8h}{types/ciot\_dfu\_types.h}}"{}}} -\DoxyCodeLine{00049\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__httpc__types_8h}{types/ciot\_httpc\_types.h}}"{}}} -\DoxyCodeLine{00050\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__https__types_8h}{types/ciot\_https\_types.h}}"{}}} -\DoxyCodeLine{00051\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__mqttc__types_8h}{types/ciot\_mqttc\_types.h}}"{}}} -\DoxyCodeLine{00052\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ntp__types_8h}{types/ciot\_ntp\_types.h}}"{}}} -\DoxyCodeLine{00053\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__opcuas__types_8h}{types/ciot\_opcuas\_types.h}}"{}}} -\DoxyCodeLine{00054\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ota__types_8h}{types/ciot\_ota\_types.h}}"{}}} -\DoxyCodeLine{00055\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__sys__types_8h}{types/ciot\_sys\_types.h}}"{}}} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00061\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__bridge_8h}{ciot\_bridge.h}}"{}}} -\DoxyCodeLine{00062\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__dfu_8h}{ciot\_dfu.h}}"{}}} -\DoxyCodeLine{00063\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__httpc_8h}{ciot\_httpc.h}}"{}}} -\DoxyCodeLine{00064\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__https_8h}{ciot\_https.h}}"{}}} -\DoxyCodeLine{00065\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__mqttc_8h}{ciot\_mqttc.h}}"{}}} -\DoxyCodeLine{00066\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__nrf__dfu_8h}{ciot\_nrf\_dfu.h}}"{}}} -\DoxyCodeLine{00067\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ntp_8h}{ciot\_ntp.h}}"{}}} -\DoxyCodeLine{00068\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__opcuas_8h}{ciot\_opcuas.h}}"{}}} -\DoxyCodeLine{00069\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__opcuas_8h}{ciot\_opcuas.h}}"{}}} -\DoxyCodeLine{00070\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ota_8h}{ciot\_ota.h}}"{}}} -\DoxyCodeLine{00071\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__sys_8h}{ciot\_sys.h}}"{}}} -\DoxyCodeLine{00072\ } -\DoxyCodeLine{00073\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__log_8h.tex b/docs/latex/ciot__log_8h.tex deleted file mode 100644 index f0b7637..0000000 --- a/docs/latex/ciot__log_8h.tex +++ /dev/null @@ -1,315 +0,0 @@ -\doxysection{include/ciot\+\_\+log.h File Reference} -\hypertarget{ciot__log_8h}{}\label{ciot__log_8h}\index{include/ciot\_log.h@{include/ciot\_log.h}} - - -Header file for CIOT logging functionality. - - -{\ttfamily \#include "{}ciot\+\_\+config.\+h"{}}\newline -{\ttfamily \#include $<$stdio.\+h$>$}\newline -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__log_8h_a017fce4c69c3715ce3301383a4b34510}{CIOT\+\_\+\+LOG\+\_\+\+BUFFER\+\_\+\+HEX}}(TAG, data, size)~\mbox{\hyperlink{ciot__log_8h_af003b1fbcac6bc1f6fb1c90d3e89f1ac}{CIOT\+\_\+\+LOG\+\_\+\+HEX}}(TAG, data, size) -\begin{DoxyCompactList}\small\item\em Macro to log hexadecimal data. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_a1576040bae89b4db49ec4fa591cc058f}{CIOT\+\_\+\+LOGD}}(TAG, MASK, ...) -\begin{DoxyCompactList}\small\item\em Macro to log debug level messages. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_a1e7ff68dc9676c1a06338c170fd52dbc}{CIOT\+\_\+\+LOGV}}(TAG, MASK, ...) -\begin{DoxyCompactList}\small\item\em Macro to log verbose level messages. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_a9e6947da6e5c522adbadd7dea5242e5f}{CIOT\+\_\+\+LOGI}}(TAG, MASK, ...) -\begin{DoxyCompactList}\small\item\em Macro to log info level messages. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_a95d4dba62da56d115efe881b38c73da6}{CIOT\+\_\+\+LOGW}}(TAG, MASK, ...) -\begin{DoxyCompactList}\small\item\em Macro to log warning level messages. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_a2707adc47298b0e7b3a09627ff04a020}{CIOT\+\_\+\+LOGE}}(TAG, MASK, ...) -\begin{DoxyCompactList}\small\item\em Macro to log error level messages. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_a2f7e6eb84773996a18fc43ccada98dc4}{CIOT\+\_\+\+LOG\+\_\+\+MSG}}(TAG, LOG\+\_\+\+MACRO, header, sender, msg) -\begin{DoxyCompactList}\small\item\em Macro to log a message with additional information. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_a2907f8630cc580826a1ec21930c511d3}{CIOT\+\_\+\+LOG\+\_\+\+MSG\+\_\+P}}(TAG, LOG\+\_\+\+MACRO, header, sender, msg) -\begin{DoxyCompactList}\small\item\em Macro to log a message pointer with additional information. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__log_8h_af003b1fbcac6bc1f6fb1c90d3e89f1ac}{CIOT\+\_\+\+LOG\+\_\+\+HEX}}(TAG, data, size) -\begin{DoxyCompactList}\small\item\em Macro to log hexadecimal data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef enum \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432}{ciot\+\_\+log\+\_\+level}} \mbox{\hyperlink{ciot__log_8h_af095bb48295769c5ebc399890c12cb93}{ciot\+\_\+log\+\_\+level\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT log levels. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432}{ciot\+\_\+log\+\_\+level}} \{ \newline -\mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a77fe66f0cf4772e333512b1f009c460d}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+NONE}} -, \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a05dd8f3fe5ca95cc5e1da78333e58356}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+ERROR}} -, \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432af9392e21b089c518e0a9dc1be3d4a799}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+WARNING}} -, \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a5f57b5ccf4a45d424a48b7edfc305a6b}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+INFO}} -, \newline -\mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a2acc86c1f4f9cc2ff727d0d59f235162}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+VERBOSE}} -, \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a1c854b20829665b670feca84ed8f0260}{CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+DEBUG}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT log levels. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT logging functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/18 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__log_8h_a017fce4c69c3715ce3301383a4b34510}\label{ciot__log_8h_a017fce4c69c3715ce3301383a4b34510} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_BUFFER\_HEX@{CIOT\_LOG\_BUFFER\_HEX}} -\index{CIOT\_LOG\_BUFFER\_HEX@{CIOT\_LOG\_BUFFER\_HEX}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOG\_BUFFER\_HEX}{CIOT\_LOG\_BUFFER\_HEX}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOG\+\_\+\+BUFFER\+\_\+\+HEX(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{data, }\item[{}]{size }\end{DoxyParamCaption})~\mbox{\hyperlink{ciot__log_8h_af003b1fbcac6bc1f6fb1c90d3e89f1ac}{CIOT\+\_\+\+LOG\+\_\+\+HEX}}(TAG, data, size)} - - - -Macro to log hexadecimal data. - -\Hypertarget{ciot__log_8h_af003b1fbcac6bc1f6fb1c90d3e89f1ac}\label{ciot__log_8h_af003b1fbcac6bc1f6fb1c90d3e89f1ac} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_HEX@{CIOT\_LOG\_HEX}} -\index{CIOT\_LOG\_HEX@{CIOT\_LOG\_HEX}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOG\_HEX}{CIOT\_LOG\_HEX}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOG\+\_\+\+HEX(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{data, }\item[{}]{size }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (\mbox{\hyperlink{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}{CIOT\_CONFIG\_LOG\_LEVEL}}\ >=\ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a1c854b20829665b670feca84ed8f0260}{CIOT\_LOG\_LEVEL\_DEBUG}})\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ uint8\_t\ *u8ptr\ =\ data;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ for\ (\textcolor{keywordtype}{size\_t}\ i\ =\ 0;\ i\ <\ size;\ i++)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}\%02X"{}},\ u8ptr[i]);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}\(\backslash\)n"{}});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to log hexadecimal data. - -\Hypertarget{ciot__log_8h_a2f7e6eb84773996a18fc43ccada98dc4}\label{ciot__log_8h_a2f7e6eb84773996a18fc43ccada98dc4} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_MSG@{CIOT\_LOG\_MSG}} -\index{CIOT\_LOG\_MSG@{CIOT\_LOG\_MSG}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOG\_MSG}{CIOT\_LOG\_MSG}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOG\+\_\+\+MSG(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{LOG\+\_\+\+MACRO, }\item[{}]{header, }\item[{}]{sender, }\item[{}]{msg }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ LOG\_MACRO(TAG,\ header\ \textcolor{stringliteral}{"{}id:\%d\ \%d:\%s\ \%d:\%s\ \%d:\%s"{}},\ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ sender-\/>info.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_ad4bea4982fb363829998c5fa64f76ccb}{ciot\_iface\_to\_str}}(sender),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg.type,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ad74fa5c942e63dc4c806fbfd6414db45}{ciot\_msg\_type\_to\_str}}(\&msg),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg.iface.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_a6411ae488746c99b42a7970dcbe6b042}{ciot\_iface\_type\_to\_str}}(msg.iface.type))} - -\end{DoxyCode} - - -Macro to log a message with additional information. - -\Hypertarget{ciot__log_8h_a2907f8630cc580826a1ec21930c511d3}\label{ciot__log_8h_a2907f8630cc580826a1ec21930c511d3} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_MSG\_P@{CIOT\_LOG\_MSG\_P}} -\index{CIOT\_LOG\_MSG\_P@{CIOT\_LOG\_MSG\_P}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOG\_MSG\_P}{CIOT\_LOG\_MSG\_P}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOG\+\_\+\+MSG\+\_\+P(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{LOG\+\_\+\+MACRO, }\item[{}]{header, }\item[{}]{sender, }\item[{}]{msg }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ LOG\_MACRO(TAG,\ header\ \textcolor{stringliteral}{"{}id:\%d\ \%d:\%s\ \%d:\%s\ \%d:\%s"{}},\ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg-\/>id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ sender-\/>info.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_ad4bea4982fb363829998c5fa64f76ccb}{ciot\_iface\_to\_str}}(sender),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg-\/>type,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ad74fa5c942e63dc4c806fbfd6414db45}{ciot\_msg\_type\_to\_str}}(msg),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg-\/>iface.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__iface_8h_a6411ae488746c99b42a7970dcbe6b042}{ciot\_iface\_type\_to\_str}}(msg-\/>iface.type))} - -\end{DoxyCode} - - -Macro to log a message pointer with additional information. - -\Hypertarget{ciot__log_8h_a1576040bae89b4db49ec4fa591cc058f}\label{ciot__log_8h_a1576040bae89b4db49ec4fa591cc058f} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOGD@{CIOT\_LOGD}} -\index{CIOT\_LOGD@{CIOT\_LOGD}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOGD}{CIOT\_LOGD}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOGD(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{MASK, }\item[{}]{... }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (\mbox{\hyperlink{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}{CIOT\_CONFIG\_LOG\_LEVEL}}\ >=\ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a1c854b20829665b670feca84ed8f0260}{CIOT\_LOG\_LEVEL\_DEBUG}})\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}[\%s]\ :\ "{}},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}\(\backslash\)n"{}});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to log debug level messages. - -\Hypertarget{ciot__log_8h_a2707adc47298b0e7b3a09627ff04a020}\label{ciot__log_8h_a2707adc47298b0e7b3a09627ff04a020} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOGE@{CIOT\_LOGE}} -\index{CIOT\_LOGE@{CIOT\_LOGE}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOGE}{CIOT\_LOGE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOGE(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{MASK, }\item[{}]{... }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (\mbox{\hyperlink{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}{CIOT\_CONFIG\_LOG\_LEVEL}}\ >=\ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a05dd8f3fe5ca95cc5e1da78333e58356}{CIOT\_LOG\_LEVEL\_ERROR}})\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}[\%s]\ :\ "{}},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}\(\backslash\)n"{}});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to log error level messages. - -\Hypertarget{ciot__log_8h_a9e6947da6e5c522adbadd7dea5242e5f}\label{ciot__log_8h_a9e6947da6e5c522adbadd7dea5242e5f} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOGI@{CIOT\_LOGI}} -\index{CIOT\_LOGI@{CIOT\_LOGI}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOGI}{CIOT\_LOGI}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOGI(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{MASK, }\item[{}]{... }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (\mbox{\hyperlink{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}{CIOT\_CONFIG\_LOG\_LEVEL}}\ >=\ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a5f57b5ccf4a45d424a48b7edfc305a6b}{CIOT\_LOG\_LEVEL\_INFO}})\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}[\%s]\ :\ "{}},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}\(\backslash\)n"{}});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to log info level messages. - -\Hypertarget{ciot__log_8h_a1e7ff68dc9676c1a06338c170fd52dbc}\label{ciot__log_8h_a1e7ff68dc9676c1a06338c170fd52dbc} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOGV@{CIOT\_LOGV}} -\index{CIOT\_LOGV@{CIOT\_LOGV}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOGV}{CIOT\_LOGV}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOGV(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{MASK, }\item[{}]{... }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (\mbox{\hyperlink{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}{CIOT\_CONFIG\_LOG\_LEVEL}}\ >=\ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a2acc86c1f4f9cc2ff727d0d59f235162}{CIOT\_LOG\_LEVEL\_VERBOSE}})\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}[\%s]\ :\ "{}},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}\(\backslash\)n"{}});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to log verbose level messages. - -\Hypertarget{ciot__log_8h_a95d4dba62da56d115efe881b38c73da6}\label{ciot__log_8h_a95d4dba62da56d115efe881b38c73da6} -\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOGW@{CIOT\_LOGW}} -\index{CIOT\_LOGW@{CIOT\_LOGW}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_LOGW}{CIOT\_LOGW}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+LOGW(\begin{DoxyParamCaption}\item[{}]{TAG, }\item[{}]{MASK, }\item[{}]{... }\end{DoxyParamCaption})} - -{\bfseries Value\+:} -\begin{DoxyCode}{0} -\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{do}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ if\ (\mbox{\hyperlink{ciot__config_8h_aedfdd865ecfa805d726fb9eca008c4b7}{CIOT\_CONFIG\_LOG\_LEVEL}}\ >=\ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432af9392e21b089c518e0a9dc1be3d4a799}{CIOT\_LOG\_LEVEL\_WARNING}})\ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}[\%s]\ :\ "{}},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ printf(\textcolor{stringliteral}{"{}\(\backslash\)n"{}});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)} -\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{while}\ (0)} - -\end{DoxyCode} - - -Macro to log warning level messages. - - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__log_8h_af095bb48295769c5ebc399890c12cb93}\label{ciot__log_8h_af095bb48295769c5ebc399890c12cb93} -\index{ciot\_log.h@{ciot\_log.h}!ciot\_log\_level\_t@{ciot\_log\_level\_t}} -\index{ciot\_log\_level\_t@{ciot\_log\_level\_t}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{ciot\_log\_level\_t}{ciot\_log\_level\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432}{ciot\+\_\+log\+\_\+level}} \mbox{\hyperlink{ciot__log_8h_af095bb48295769c5ebc399890c12cb93}{ciot\+\_\+log\+\_\+level\+\_\+t}}} - - - -Enumeration for CIOT log levels. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432}\label{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432} -\index{ciot\_log.h@{ciot\_log.h}!ciot\_log\_level@{ciot\_log\_level}} -\index{ciot\_log\_level@{ciot\_log\_level}!ciot\_log.h@{ciot\_log.h}} -\doxysubsubsection{\texorpdfstring{ciot\_log\_level}{ciot\_log\_level}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432}{ciot\+\_\+log\+\_\+level}}} - - - -Enumeration for CIOT log levels. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_LOG\_LEVEL\_NONE@{CIOT\_LOG\_LEVEL\_NONE}!ciot\_log.h@{ciot\_log.h}}\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_LEVEL\_NONE@{CIOT\_LOG\_LEVEL\_NONE}}}\Hypertarget{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a77fe66f0cf4772e333512b1f009c460d}\label{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a77fe66f0cf4772e333512b1f009c460d} -CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+NONE&No logging. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_LOG\_LEVEL\_ERROR@{CIOT\_LOG\_LEVEL\_ERROR}!ciot\_log.h@{ciot\_log.h}}\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_LEVEL\_ERROR@{CIOT\_LOG\_LEVEL\_ERROR}}}\Hypertarget{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a05dd8f3fe5ca95cc5e1da78333e58356}\label{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a05dd8f3fe5ca95cc5e1da78333e58356} -CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+ERROR&Error level logging. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_LOG\_LEVEL\_WARNING@{CIOT\_LOG\_LEVEL\_WARNING}!ciot\_log.h@{ciot\_log.h}}\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_LEVEL\_WARNING@{CIOT\_LOG\_LEVEL\_WARNING}}}\Hypertarget{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432af9392e21b089c518e0a9dc1be3d4a799}\label{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432af9392e21b089c518e0a9dc1be3d4a799} -CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+WARNING&Warning level logging. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_LOG\_LEVEL\_INFO@{CIOT\_LOG\_LEVEL\_INFO}!ciot\_log.h@{ciot\_log.h}}\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_LEVEL\_INFO@{CIOT\_LOG\_LEVEL\_INFO}}}\Hypertarget{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a5f57b5ccf4a45d424a48b7edfc305a6b}\label{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a5f57b5ccf4a45d424a48b7edfc305a6b} -CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+INFO&Info level logging. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_LOG\_LEVEL\_VERBOSE@{CIOT\_LOG\_LEVEL\_VERBOSE}!ciot\_log.h@{ciot\_log.h}}\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_LEVEL\_VERBOSE@{CIOT\_LOG\_LEVEL\_VERBOSE}}}\Hypertarget{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a2acc86c1f4f9cc2ff727d0d59f235162}\label{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a2acc86c1f4f9cc2ff727d0d59f235162} -CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+VERBOSE&Verbose level logging. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_LOG\_LEVEL\_DEBUG@{CIOT\_LOG\_LEVEL\_DEBUG}!ciot\_log.h@{ciot\_log.h}}\index{ciot\_log.h@{ciot\_log.h}!CIOT\_LOG\_LEVEL\_DEBUG@{CIOT\_LOG\_LEVEL\_DEBUG}}}\Hypertarget{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a1c854b20829665b670feca84ed8f0260}\label{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a1c854b20829665b670feca84ed8f0260} -CIOT\+\_\+\+LOG\+\_\+\+LEVEL\+\_\+\+DEBUG&Debug level logging. \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__log_8h_source.tex b/docs/latex/ciot__log_8h_source.tex deleted file mode 100644 index 2bb4b1a..0000000 --- a/docs/latex/ciot__log_8h_source.tex +++ /dev/null @@ -1,141 +0,0 @@ -\doxysection{ciot\+\_\+log.\+h} -\hypertarget{ciot__log_8h_source}{}\label{ciot__log_8h_source}\index{include/ciot\_log.h@{include/ciot\_log.h}} -\mbox{\hyperlink{ciot__log_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_LOG\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_LOG\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__config_8h}{ciot\_config.h}}"{}}} -\DoxyCodeLine{00014\ } -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00016\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}} -\DoxyCodeLine{00017\ \{} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \ \ \ \ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432}{ciot\_log\_level}}} -\DoxyCodeLine{00024\ \ \ \ \ \{} -\DoxyCodeLine{00025\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a77fe66f0cf4772e333512b1f009c460d}{CIOT\_LOG\_LEVEL\_NONE}},\ } -\DoxyCodeLine{00026\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a05dd8f3fe5ca95cc5e1da78333e58356}{CIOT\_LOG\_LEVEL\_ERROR}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432af9392e21b089c518e0a9dc1be3d4a799}{CIOT\_LOG\_LEVEL\_WARNING}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a5f57b5ccf4a45d424a48b7edfc305a6b}{CIOT\_LOG\_LEVEL\_INFO}},\ } -\DoxyCodeLine{00029\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a2acc86c1f4f9cc2ff727d0d59f235162}{CIOT\_LOG\_LEVEL\_VERBOSE}},\ } -\DoxyCodeLine{00030\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{ciot__log_8h_a399d3388116ce0479b91f0fdb5b56432a1c854b20829665b670feca84ed8f0260}{CIOT\_LOG\_LEVEL\_DEBUG}},\ } -\DoxyCodeLine{00031\ \ \ \ \ \}\ \mbox{\hyperlink{ciot__log_8h_af095bb48295769c5ebc399890c12cb93}{ciot\_log\_level\_t}};} -\DoxyCodeLine{00032\ } -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#ifdef\ IDF\_VER}} -\DoxyCodeLine{00034\ } -\DoxyCodeLine{00035\ \textcolor{preprocessor}{\#include\ "{}esp\_log.h"{}}} -\DoxyCodeLine{00036\ } -\DoxyCodeLine{00037\ \textcolor{comment}{//\ Forwarding\ logging\ macros\ to\ ESP-\/IDF\ logging\ macros}} -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#define\ CIOT\_LOGD\ ESP\_LOGD}} -\DoxyCodeLine{00039\ \textcolor{preprocessor}{\#define\ CIOT\_LOGV\ ESP\_LOGV}} -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#define\ CIOT\_LOGI\ ESP\_LOGI}} -\DoxyCodeLine{00041\ \textcolor{preprocessor}{\#define\ CIOT\_LOGW\ ESP\_LOGW}} -\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#define\ CIOT\_LOGE\ ESP\_LOGE}} -\DoxyCodeLine{00043\ \textcolor{preprocessor}{\#define\ CIOT\_LOG\_BUFFER\_HEX(tag,\ data,\ size)\ ESP\_LOG\_BUFFER\_HEX\_LEVEL(tag,\ data,\ size,\ ESP\_LOG\_DEBUG)}} -\DoxyCodeLine{00044\ } -\DoxyCodeLine{00045\ \textcolor{preprocessor}{\#else}} -\DoxyCodeLine{00046\ } -\DoxyCodeLine{00047\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00048\ } -\DoxyCodeLine{00052\ \textcolor{preprocessor}{\#define\ CIOT\_LOG\_BUFFER\_HEX(TAG,\ data,\ size)\ CIOT\_LOG\_HEX(TAG,\ data,\ size)}} -\DoxyCodeLine{00053\ } -\DoxyCodeLine{00057\ \textcolor{preprocessor}{\#define\ CIOT\_LOGD(TAG,\ MASK,\ ...)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00058\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00059\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00060\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (CIOT\_CONFIG\_LOG\_LEVEL\ >=\ CIOT\_LOG\_LEVEL\_DEBUG)\ \(\backslash\)}} -\DoxyCodeLine{00061\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00062\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}[\%s]\ :\ "{},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00063\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00064\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}\(\backslash\)n"{});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00065\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00066\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00067\ } -\DoxyCodeLine{00071\ \textcolor{preprocessor}{\#define\ CIOT\_LOGV(TAG,\ MASK,\ ...)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00072\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00073\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00074\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (CIOT\_CONFIG\_LOG\_LEVEL\ >=\ CIOT\_LOG\_LEVEL\_VERBOSE)\ \(\backslash\)}} -\DoxyCodeLine{00075\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00076\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}[\%s]\ :\ "{},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00077\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00078\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}\(\backslash\)n"{});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00079\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00080\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00081\ } -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\#define\ CIOT\_LOGI(TAG,\ MASK,\ ...)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00086\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00087\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00088\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (CIOT\_CONFIG\_LOG\_LEVEL\ >=\ CIOT\_LOG\_LEVEL\_INFO)\ \(\backslash\)}} -\DoxyCodeLine{00089\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00090\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}[\%s]\ :\ "{},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00091\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00092\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}\(\backslash\)n"{});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00093\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00094\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00099\ \textcolor{preprocessor}{\#define\ CIOT\_LOGW(TAG,\ MASK,\ ...)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00100\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00101\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00102\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (CIOT\_CONFIG\_LOG\_LEVEL\ >=\ CIOT\_LOG\_LEVEL\_WARNING)\ \(\backslash\)}} -\DoxyCodeLine{00103\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00104\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}[\%s]\ :\ "{},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00105\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00106\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}\(\backslash\)n"{});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00107\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00108\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00109\ } -\DoxyCodeLine{00113\ \textcolor{preprocessor}{\#define\ CIOT\_LOGE(TAG,\ MASK,\ ...)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00114\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00115\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00116\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (CIOT\_CONFIG\_LOG\_LEVEL\ >=\ CIOT\_LOG\_LEVEL\_ERROR)\ \(\backslash\)}} -\DoxyCodeLine{00117\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00118\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}[\%s]\ :\ "{},\ TAG);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00119\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf(MASK,\ \#\#\_\_VA\_ARGS\_\_);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00120\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}\(\backslash\)n"{});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00121\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00122\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00123\ } -\DoxyCodeLine{00124\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{//\ IDF\_VER}} -\DoxyCodeLine{00125\ } -\DoxyCodeLine{00129\ \textcolor{preprocessor}{\#define\ CIOT\_LOG\_MSG(TAG,\ LOG\_MACRO,\ header,\ sender,\ msg)\ \(\backslash\)}} -\DoxyCodeLine{00130\ \textcolor{preprocessor}{\ \ \ \ LOG\_MACRO(TAG,\ header\ "{}id:\%d\ \%d:\%s\ \%d:\%s\ \%d:\%s"{},\ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00131\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00132\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ sender-\/>info.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00133\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ ciot\_iface\_to\_str(sender),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00134\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg.type,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00135\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ ciot\_msg\_type\_to\_str(\&msg),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00136\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg.iface.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00137\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ ciot\_iface\_type\_to\_str(msg.iface.type))}} -\DoxyCodeLine{00138\ } -\DoxyCodeLine{00142\ \textcolor{preprocessor}{\#define\ CIOT\_LOG\_MSG\_P(TAG,\ LOG\_MACRO,\ header,\ sender,\ msg)\ \(\backslash\)}} -\DoxyCodeLine{00143\ \textcolor{preprocessor}{\ \ \ \ LOG\_MACRO(TAG,\ header\ "{}id:\%d\ \%d:\%s\ \%d:\%s\ \%d:\%s"{},\ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00144\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg-\/>id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00145\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ sender-\/>info.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00146\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ ciot\_iface\_to\_str(sender),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00147\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg-\/>type,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00148\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ ciot\_msg\_type\_to\_str(msg),\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00149\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ msg-\/>iface.id,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00150\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ ciot\_iface\_type\_to\_str(msg-\/>iface.type))}} -\DoxyCodeLine{00151\ } -\DoxyCodeLine{00155\ \textcolor{preprocessor}{\#define\ CIOT\_LOG\_HEX(TAG,\ data,\ size)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00156\ \textcolor{preprocessor}{\ \ \ \ do\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00157\ \textcolor{preprocessor}{\ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00158\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ if\ (CIOT\_CONFIG\_LOG\_LEVEL\ >=\ CIOT\_LOG\_LEVEL\_DEBUG)\ \(\backslash\)}} -\DoxyCodeLine{00159\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00160\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ uint8\_t\ *u8ptr\ =\ data;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00161\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ for\ (size\_t\ i\ =\ 0;\ i\ <\ size;\ i++)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00162\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00163\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ printf("{}\%02X"{},\ u8ptr[i]);\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00164\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00165\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \ \ \ \ printf("{}\(\backslash\)n"{});\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00166\ \textcolor{preprocessor}{\ \ \ \ \ \ \ \ \}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \(\backslash\)}} -\DoxyCodeLine{00167\ \textcolor{preprocessor}{\ \ \ \ \}\ while\ (0)}} -\DoxyCodeLine{00168\ } -\DoxyCodeLine{00169\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00170\ \}} -\DoxyCodeLine{00171\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00172\ } -\DoxyCodeLine{00173\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__mqttc_8h.tex b/docs/latex/ciot__mqttc_8h.tex deleted file mode 100644 index 11b244b..0000000 --- a/docs/latex/ciot__mqttc_8h.tex +++ /dev/null @@ -1,261 +0,0 @@ -\doxysection{include/ciot\+\_\+mqttc.h File Reference} -\hypertarget{ciot__mqttc_8h}{}\label{ciot__mqttc_8h}\index{include/ciot\_mqttc.h@{include/ciot\_mqttc.h}} -{\ttfamily \#include "{}types/ciot\+\_\+mqttc\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__mqttc__status__msg__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing a CIOT MQTT client status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+mqttc \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure representing a CIOT MQTT client instance. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898}{ciot\+\_\+mqttc\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__mqttc_8h_a366b460dc8e7ec1e3f89c9247882842a}{ciot\+\_\+mqttc\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT MQTT client event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898}{ciot\+\_\+mqttc\+\_\+event\+\_\+id}} \{ \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a7fdb135e2a3ea11cafe0449a29a16d0d}{CIOT\+\_\+\+MQTT\+\_\+\+EVENT\+\_\+\+CONNECTING}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM -, \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898aa028c2dfe1e1b2a3a3efb1cc698a6b68}{CIOT\+\_\+\+MQTT\+\_\+\+EVENT\+\_\+\+SUBSCRIBED}} -, \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a6cefc05e924cb723d9f72f2e674e5ef7}{CIOT\+\_\+\+MQTT\+\_\+\+EVENT\+\_\+\+UNSUBSCRIBED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT MQTT client event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_aa6ac15e5f6cfb3346cff3247dd25c279}{ciot\+\_\+mqttc\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Creates a new CIOT MQTT client instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_a19c183447b4f862cb53f6ae127a80db0}{ciot\+\_\+mqttc\+\_\+start}} (\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} self, \mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Starts the CIOT MQTT client. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_af81da24c4d251706f5f901e810752597}{ciot\+\_\+mqttc\+\_\+stop}} (\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stops the CIOT MQTT client. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_aba9394c6a08cb0c2087ffdc537f75125}{ciot\+\_\+mqttc\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} self, \mbox{\hyperlink{structciot__mqttc__req__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Processes MQTT client requests. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_aa04b6f015e9bbc8ab614027c460f899d}{ciot\+\_\+mqttc\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Sends data using the MQTT client. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_a55aab38479c4242b37397c51e15dad37}{ciot\+\_\+mqttc\+\_\+publish}} (\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} self, char \texorpdfstring{$\ast$}{*}topic, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size, uint8\+\_\+t qos) -\begin{DoxyCompactList}\small\item\em Publishes a message using the MQTT client. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_aee005c5cae5b325548b381df58613742}{ciot\+\_\+mqttc\+\_\+subscribe}} (\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} self, char \texorpdfstring{$\ast$}{*}topic, uint8\+\_\+t qos) -\begin{DoxyCompactList}\small\item\em Subscribes to an MQTT topic using the MQTT client. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__mqttc_8h_ad7bcb714dbb489d3b8508cb7acf72b27}{ciot\+\_\+mqttc\+\_\+reset\+\_\+data\+\_\+rate}} (\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Resets the data rate for the MQTT client. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__mqttc_8h_a366b460dc8e7ec1e3f89c9247882842a}\label{ciot__mqttc_8h_a366b460dc8e7ec1e3f89c9247882842a} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_event\_id\_t@{ciot\_mqttc\_event\_id\_t}} -\index{ciot\_mqttc\_event\_id\_t@{ciot\_mqttc\_event\_id\_t}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_event\_id\_t}{ciot\_mqttc\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898}{ciot\+\_\+mqttc\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__mqttc_8h_a366b460dc8e7ec1e3f89c9247882842a}{ciot\+\_\+mqttc\+\_\+event\+\_\+id\+\_\+t}}} - - - -Enumeration for CIOT MQTT client event IDs. - -\Hypertarget{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}\label{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_t@{ciot\_mqttc\_t}} -\index{ciot\_mqttc\_t@{ciot\_mqttc\_t}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_t}{ciot\_mqttc\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+mqttc\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}} - - - -Structure representing a CIOT MQTT client instance. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898}\label{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_event\_id@{ciot\_mqttc\_event\_id}} -\index{ciot\_mqttc\_event\_id@{ciot\_mqttc\_event\_id}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_event\_id}{ciot\_mqttc\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898}{ciot\+\_\+mqttc\+\_\+event\+\_\+id}}} - - - -Enumeration for CIOT MQTT client event IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_EVENT\_CONNECTING@{CIOT\_MQTT\_EVENT\_CONNECTING}!ciot\_mqttc.h@{ciot\_mqttc.h}}\index{ciot\_mqttc.h@{ciot\_mqttc.h}!CIOT\_MQTT\_EVENT\_CONNECTING@{CIOT\_MQTT\_EVENT\_CONNECTING}}}\Hypertarget{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a7fdb135e2a3ea11cafe0449a29a16d0d}\label{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a7fdb135e2a3ea11cafe0449a29a16d0d} -CIOT\+\_\+\+MQTT\+\_\+\+EVENT\+\_\+\+CONNECTING&MQTT client connecting event ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_EVENT\_SUBSCRIBED@{CIOT\_MQTT\_EVENT\_SUBSCRIBED}!ciot\_mqttc.h@{ciot\_mqttc.h}}\index{ciot\_mqttc.h@{ciot\_mqttc.h}!CIOT\_MQTT\_EVENT\_SUBSCRIBED@{CIOT\_MQTT\_EVENT\_SUBSCRIBED}}}\Hypertarget{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898aa028c2dfe1e1b2a3a3efb1cc698a6b68}\label{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898aa028c2dfe1e1b2a3a3efb1cc698a6b68} -CIOT\+\_\+\+MQTT\+\_\+\+EVENT\+\_\+\+SUBSCRIBED&MQTT client subscribed event ID. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_EVENT\_UNSUBSCRIBED@{CIOT\_MQTT\_EVENT\_UNSUBSCRIBED}!ciot\_mqttc.h@{ciot\_mqttc.h}}\index{ciot\_mqttc.h@{ciot\_mqttc.h}!CIOT\_MQTT\_EVENT\_UNSUBSCRIBED@{CIOT\_MQTT\_EVENT\_UNSUBSCRIBED}}}\Hypertarget{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a6cefc05e924cb723d9f72f2e674e5ef7}\label{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a6cefc05e924cb723d9f72f2e674e5ef7} -CIOT\+\_\+\+MQTT\+\_\+\+EVENT\+\_\+\+UNSUBSCRIBED&MQTT client unsubscribed event ID. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__mqttc_8h_aa6ac15e5f6cfb3346cff3247dd25c279}\label{ciot__mqttc_8h_aa6ac15e5f6cfb3346cff3247dd25c279} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_new@{ciot\_mqttc\_new}} -\index{ciot\_mqttc\_new@{ciot\_mqttc\_new}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_new()}{ciot\_mqttc\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} ciot\+\_\+mqttc\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Creates a new CIOT MQTT client instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & A handle for the MQTT client. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the new MQTT client instance. -\end{DoxyReturn} -\Hypertarget{ciot__mqttc_8h_aba9394c6a08cb0c2087ffdc537f75125}\label{ciot__mqttc_8h_aba9394c6a08cb0c2087ffdc537f75125} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_process\_req@{ciot\_mqttc\_process\_req}} -\index{ciot\_mqttc\_process\_req@{ciot\_mqttc\_process\_req}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_process\_req()}{ciot\_mqttc\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+mqttc\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__mqttc__req__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Processes MQTT client requests. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the MQTT client instance. \\ -\hline -{\em req} & Pointer to the MQTT client request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__mqttc_8h_a55aab38479c4242b37397c51e15dad37}\label{ciot__mqttc_8h_a55aab38479c4242b37397c51e15dad37} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_publish@{ciot\_mqttc\_publish}} -\index{ciot\_mqttc\_publish@{ciot\_mqttc\_publish}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_publish()}{ciot\_mqttc\_publish()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+mqttc\+\_\+publish (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}}]{self, }\item[{char \texorpdfstring{$\ast$}{*}}]{topic, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size, }\item[{uint8\+\_\+t}]{qos }\end{DoxyParamCaption})} - - - -Publishes a message using the MQTT client. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the MQTT client instance. \\ -\hline -{\em topic} & MQTT topic to publish to. \\ -\hline -{\em data} & Pointer to the data to be published. \\ -\hline -{\em size} & Size of the data to be published. \\ -\hline -{\em qos} & Quality of Service level for the message. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__mqttc_8h_ad7bcb714dbb489d3b8508cb7acf72b27}\label{ciot__mqttc_8h_ad7bcb714dbb489d3b8508cb7acf72b27} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_reset\_data\_rate@{ciot\_mqttc\_reset\_data\_rate}} -\index{ciot\_mqttc\_reset\_data\_rate@{ciot\_mqttc\_reset\_data\_rate}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_reset\_data\_rate()}{ciot\_mqttc\_reset\_data\_rate()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+mqttc\+\_\+reset\+\_\+data\+\_\+rate (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Resets the data rate for the MQTT client. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the MQTT client instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__mqttc_8h_aa04b6f015e9bbc8ab614027c460f899d}\label{ciot__mqttc_8h_aa04b6f015e9bbc8ab614027c460f899d} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_send\_data@{ciot\_mqttc\_send\_data}} -\index{ciot\_mqttc\_send\_data@{ciot\_mqttc\_send\_data}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_send\_data()}{ciot\_mqttc\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+mqttc\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Sends data using the MQTT client. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the MQTT client instance. \\ -\hline -{\em data} & Pointer to the data to be sent. \\ -\hline -{\em size} & Size of the data to be sent. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__mqttc_8h_a19c183447b4f862cb53f6ae127a80db0}\label{ciot__mqttc_8h_a19c183447b4f862cb53f6ae127a80db0} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_start@{ciot\_mqttc\_start}} -\index{ciot\_mqttc\_start@{ciot\_mqttc\_start}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_start()}{ciot\_mqttc\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+mqttc\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Starts the CIOT MQTT client. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the MQTT client instance. \\ -\hline -{\em cfg} & Pointer to the MQTT client configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__mqttc_8h_af81da24c4d251706f5f901e810752597}\label{ciot__mqttc_8h_af81da24c4d251706f5f901e810752597} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_stop@{ciot\_mqttc\_stop}} -\index{ciot\_mqttc\_stop@{ciot\_mqttc\_stop}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_stop()}{ciot\_mqttc\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+mqttc\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stops the CIOT MQTT client. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the MQTT client instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the status of the operation. -\end{DoxyReturn} -\Hypertarget{ciot__mqttc_8h_aee005c5cae5b325548b381df58613742}\label{ciot__mqttc_8h_aee005c5cae5b325548b381df58613742} -\index{ciot\_mqttc.h@{ciot\_mqttc.h}!ciot\_mqttc\_subscribe@{ciot\_mqttc\_subscribe}} -\index{ciot\_mqttc\_subscribe@{ciot\_mqttc\_subscribe}!ciot\_mqttc.h@{ciot\_mqttc.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_subscribe()}{ciot\_mqttc\_subscribe()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+mqttc\+\_\+subscribe (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}}}]{self, }\item[{char \texorpdfstring{$\ast$}{*}}]{topic, }\item[{uint8\+\_\+t}]{qos }\end{DoxyParamCaption})} - - - -Subscribes to an MQTT topic using the MQTT client. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the MQTT client instance. \\ -\hline -{\em topic} & MQTT topic to subscribe to. \\ -\hline -{\em qos} & Quality of Service level for the subscription. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -An error code indicating the status of the operation. -\end{DoxyReturn} diff --git a/docs/latex/ciot__mqttc_8h_source.tex b/docs/latex/ciot__mqttc_8h_source.tex deleted file mode 100644 index 9f8684a..0000000 --- a/docs/latex/ciot__mqttc_8h_source.tex +++ /dev/null @@ -1,54 +0,0 @@ -\doxysection{ciot\+\_\+mqttc.\+h} -\hypertarget{ciot__mqttc_8h_source}{}\label{ciot__mqttc_8h_source}\index{include/ciot\_mqttc.h@{include/ciot\_mqttc.h}} -\mbox{\hyperlink{ciot__mqttc_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_MQTT\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_MQTT\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__mqttc__types_8h}{types/ciot\_mqttc\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_mqttc\ *\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898}{ciot\_mqttc\_event\_id}}} -\DoxyCodeLine{00031\ \{} -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a7fdb135e2a3ea11cafe0449a29a16d0d}{CIOT\_MQTT\_EVENT\_CONNECTING}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00033\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898aa028c2dfe1e1b2a3a3efb1cc698a6b68}{CIOT\_MQTT\_EVENT\_SUBSCRIBED}},\ } -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc_8h_afc1eb0a89e9bcff163827db2fb32b898a6cefc05e924cb723d9f72f2e674e5ef7}{CIOT\_MQTT\_EVENT\_UNSUBSCRIBED}},\ } -\DoxyCodeLine{00035\ \}\ \mbox{\hyperlink{ciot__mqttc_8h_a366b460dc8e7ec1e3f89c9247882842a}{ciot\_mqttc\_event\_id\_t}};} -\DoxyCodeLine{00036\ } -\DoxyCodeLine{00040\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00041\ \{} -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__mqttc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__status__t}{ciot\_mqttc\_status\_t}}\ \mbox{\hyperlink{structciot__mqttc__status__msg__t_a0bd4162002c890f2775878d4da138c03}{status}};\ } -\DoxyCodeLine{00044\ \}\ \mbox{\hyperlink{structciot__mqttc__status__msg__t}{ciot\_mqttc\_status\_msg\_t}};} -\DoxyCodeLine{00045\ } -\DoxyCodeLine{00051\ \mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_aa6ac15e5f6cfb3346cff3247dd25c279}{ciot\_mqttc\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00052\ } -\DoxyCodeLine{00059\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_a19c183447b4f862cb53f6ae127a80db0}{ciot\_mqttc\_start}}(\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ self,\ \mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\_mqttc\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00066\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_af81da24c4d251706f5f901e810752597}{ciot\_mqttc\_stop}}(\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ self);} -\DoxyCodeLine{00067\ } -\DoxyCodeLine{00074\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_aba9394c6a08cb0c2087ffdc537f75125}{ciot\_mqttc\_process\_req}}(\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ self,\ \mbox{\hyperlink{structciot__mqttc__req__t}{ciot\_mqttc\_req\_t}}\ *req);} -\DoxyCodeLine{00075\ } -\DoxyCodeLine{00083\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_aa04b6f015e9bbc8ab614027c460f899d}{ciot\_mqttc\_send\_data}}(\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00094\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_a55aab38479c4242b37397c51e15dad37}{ciot\_mqttc\_publish}}(\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ self,\ \textcolor{keywordtype}{char}\ *topic,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size,\ uint8\_t\ qos);} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00103\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_aee005c5cae5b325548b381df58613742}{ciot\_mqttc\_subscribe}}(\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ self,\ \textcolor{keywordtype}{char}\ *topic,\ uint8\_t\ qos);} -\DoxyCodeLine{00104\ } -\DoxyCodeLine{00110\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__mqttc_8h_ad7bcb714dbb489d3b8508cb7acf72b27}{ciot\_mqttc\_reset\_data\_rate}}(\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\_mqttc\_t}}\ self);} -\DoxyCodeLine{00111\ } -\DoxyCodeLine{00112\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00113\ \}} -\DoxyCodeLine{00114\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00115\ } -\DoxyCodeLine{00116\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__mqttc__types_8h.tex b/docs/latex/ciot__mqttc__types_8h.tex deleted file mode 100644 index e5fa543..0000000 --- a/docs/latex/ciot__mqttc__types_8h.tex +++ /dev/null @@ -1,253 +0,0 @@ -\doxysection{include/types/ciot\+\_\+mqttc\+\_\+types.h File Reference} -\hypertarget{ciot__mqttc__types_8h}{}\label{ciot__mqttc__types_8h}\index{include/types/ciot\_mqttc\_types.h@{include/types/ciot\_mqttc\_types.h}} - - -Defines data types and structures for CIOT MQTT client. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include $<$time.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+common\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__mqttc__error__t}{ciot\+\_\+mqttc\+\_\+error\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client error information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__topics__cfg__t}{ciot\+\_\+mqttc\+\_\+topics\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client topics configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__status__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__req__publish__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+publish\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client publish request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__req__subscribe__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+subscribe\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client subscribe request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__mqttc__req__data__u}{ciot\+\_\+mqttc\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT MQTT client request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__req__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__event__data}{ciot\+\_\+mqttc\+\_\+event\+\_\+data}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client event data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__mqttc__event}{ciot\+\_\+mqttc\+\_\+event}} -\begin{DoxyCompactList}\small\item\em Union for CIOT MQTT client event. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__mqttc__data__u}{ciot\+\_\+mqttc\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT MQTT client data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+CLIENT\+\_\+\+ID\+\_\+\+LEN}}~32 -\item -\#define \mbox{\hyperlink{ciot__mqttc__types_8h_aeb924d17fcd585c2612e41f7f4ad9a1f}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+URL\+\_\+\+LEN}}~64 -\item -\#define \mbox{\hyperlink{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+USER\+\_\+\+LEN}}~32 -\item -\#define \mbox{\hyperlink{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+PASS\+\_\+\+LEN}}~32 -\item -\#define \mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}~48 -\item -\#define \mbox{\hyperlink{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+MSG\+\_\+\+LEN}}~256 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct \mbox{\hyperlink{structciot__mqttc__event__data}{ciot\+\_\+mqttc\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__mqttc__types_8h_ac871b56a938626c38c705618405ee350}{ciot\+\_\+mqttc\+\_\+event\+\_\+data\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT MQTT client event data. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__mqttc__event}{ciot\+\_\+mqttc\+\_\+event}} \mbox{\hyperlink{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}{ciot\+\_\+mqttc\+\_\+event\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT MQTT client event. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce}{ciot\+\_\+mqttc\+\_\+state\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea3cd3678d8b777367f05ebeb64fa5d6e1}{CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea004bb3b5e1c7526ac86d715808871aab}{CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+DISCONNECTED}} -, \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ceaead9e930ad102c9ab546ca112841a1a8}{CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+CONNECTING}} -, \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea556288d80c5f236a85b349084936ad24}{CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+DISCONNECTING}} -, \newline -\mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea79b34e4a21856bfabc772c8491525476}{CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+CONNECTED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT MQTT client states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684}{ciot\+\_\+mqttc\+\_\+transport\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a2f26568f96a771a6de885dcdecc7e83c}{CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a525b4c85b24d94e497cb786ba050b7f9}{CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+TCP}} -, \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5d3cd88c4c3238306de35766ebd4c119}{CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+SSL}} -, \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5ce16156ba60d3c867acb7d960d574fd}{CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+WS}} -, \newline -\mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684adf27ceb8c08b58be48c97e2057e51fe4}{CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+WSS}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT MQTT client transport types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43}{ciot\+\_\+mqttc\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a1832343a674951b5cc6e0b1281ac8872}{CIOT\+\_\+\+MQTT\+\_\+\+REQ\+\_\+\+UNKNONW}} -, \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a5b0bc93e48a1c931162fc99240863279}{CIOT\+\_\+\+MQTT\+\_\+\+REQ\+\_\+\+PUBLISH}} -, \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43ab1ca6f635ae3eb1dc067fd0058846f55}{CIOT\+\_\+\+MQTT\+\_\+\+REQ\+\_\+\+SUBSCRIBE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT MQTT client request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT MQTT client. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e}\label{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN@{CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN}} -\index{CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN@{CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN}{CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+CLIENT\+\_\+\+ID\+\_\+\+LEN~32} - -Default length of MQTT client ID \Hypertarget{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086}\label{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_CONFIG\_MQTT\_MSG\_LEN@{CIOT\_CONFIG\_MQTT\_MSG\_LEN}} -\index{CIOT\_CONFIG\_MQTT\_MSG\_LEN@{CIOT\_CONFIG\_MQTT\_MSG\_LEN}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTT\_MSG\_LEN}{CIOT\_CONFIG\_MQTT\_MSG\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+MSG\+\_\+\+LEN~256} - -Default length of MQTT message \Hypertarget{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50}\label{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_CONFIG\_MQTT\_PASS\_LEN@{CIOT\_CONFIG\_MQTT\_PASS\_LEN}} -\index{CIOT\_CONFIG\_MQTT\_PASS\_LEN@{CIOT\_CONFIG\_MQTT\_PASS\_LEN}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTT\_PASS\_LEN}{CIOT\_CONFIG\_MQTT\_PASS\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+PASS\+\_\+\+LEN~32} - -Default length of MQTT password \Hypertarget{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}\label{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_CONFIG\_MQTT\_TOPIC\_LEN@{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}} -\index{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN@{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN~48} - -Default length of MQTT topic \Hypertarget{ciot__mqttc__types_8h_aeb924d17fcd585c2612e41f7f4ad9a1f}\label{ciot__mqttc__types_8h_aeb924d17fcd585c2612e41f7f4ad9a1f} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_CONFIG\_MQTT\_URL\_LEN@{CIOT\_CONFIG\_MQTT\_URL\_LEN}} -\index{CIOT\_CONFIG\_MQTT\_URL\_LEN@{CIOT\_CONFIG\_MQTT\_URL\_LEN}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTT\_URL\_LEN}{CIOT\_CONFIG\_MQTT\_URL\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+URL\+\_\+\+LEN~64} - -Default length of MQTT URL \Hypertarget{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e}\label{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_CONFIG\_MQTT\_USER\_LEN@{CIOT\_CONFIG\_MQTT\_USER\_LEN}} -\index{CIOT\_CONFIG\_MQTT\_USER\_LEN@{CIOT\_CONFIG\_MQTT\_USER\_LEN}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_MQTT\_USER\_LEN}{CIOT\_CONFIG\_MQTT\_USER\_LEN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+USER\+\_\+\+LEN~32} - -Default length of MQTT username - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__mqttc__types_8h_ac871b56a938626c38c705618405ee350}\label{ciot__mqttc__types_8h_ac871b56a938626c38c705618405ee350} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!ciot\_mqttc\_event\_data\_t@{ciot\_mqttc\_event\_data\_t}} -\index{ciot\_mqttc\_event\_data\_t@{ciot\_mqttc\_event\_data\_t}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_event\_data\_t}{ciot\_mqttc\_event\_data\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__mqttc__event__data}{ciot\+\_\+mqttc\+\_\+event\+\_\+data}} \mbox{\hyperlink{ciot__mqttc__types_8h_ac871b56a938626c38c705618405ee350}{ciot\+\_\+mqttc\+\_\+event\+\_\+data\+\_\+t}}} - - - -Structure for CIOT MQTT client event data. - -\Hypertarget{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}\label{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!ciot\_mqttc\_event\_u@{ciot\_mqttc\_event\_u}} -\index{ciot\_mqttc\_event\_u@{ciot\_mqttc\_event\_u}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_event\_u}{ciot\_mqttc\_event\_u}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__mqttc__event}{ciot\+\_\+mqttc\+\_\+event}} \mbox{\hyperlink{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}{ciot\+\_\+mqttc\+\_\+event\+\_\+u}}} - - - -Union for CIOT MQTT client event. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43}\label{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!ciot\_mqttc\_req\_type\_t@{ciot\_mqttc\_req\_type\_t}} -\index{ciot\_mqttc\_req\_type\_t@{ciot\_mqttc\_req\_type\_t}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_req\_type\_t}{ciot\_mqttc\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43}{ciot\+\_\+mqttc\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT MQTT client request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_REQ\_UNKNONW@{CIOT\_MQTT\_REQ\_UNKNONW}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_REQ\_UNKNONW@{CIOT\_MQTT\_REQ\_UNKNONW}}}\Hypertarget{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a1832343a674951b5cc6e0b1281ac8872}\label{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a1832343a674951b5cc6e0b1281ac8872} -CIOT\+\_\+\+MQTT\+\_\+\+REQ\+\_\+\+UNKNONW&Unknown request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_REQ\_PUBLISH@{CIOT\_MQTT\_REQ\_PUBLISH}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_REQ\_PUBLISH@{CIOT\_MQTT\_REQ\_PUBLISH}}}\Hypertarget{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a5b0bc93e48a1c931162fc99240863279}\label{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a5b0bc93e48a1c931162fc99240863279} -CIOT\+\_\+\+MQTT\+\_\+\+REQ\+\_\+\+PUBLISH&Publish request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_REQ\_SUBSCRIBE@{CIOT\_MQTT\_REQ\_SUBSCRIBE}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_REQ\_SUBSCRIBE@{CIOT\_MQTT\_REQ\_SUBSCRIBE}}}\Hypertarget{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43ab1ca6f635ae3eb1dc067fd0058846f55}\label{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43ab1ca6f635ae3eb1dc067fd0058846f55} -CIOT\+\_\+\+MQTT\+\_\+\+REQ\+\_\+\+SUBSCRIBE&Subscribe request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce}\label{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!ciot\_mqttc\_state\_t@{ciot\_mqttc\_state\_t}} -\index{ciot\_mqttc\_state\_t@{ciot\_mqttc\_state\_t}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_state\_t}{ciot\_mqttc\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce}{ciot\+\_\+mqttc\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT MQTT client states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_STATE\_ERROR@{CIOT\_MQTT\_STATE\_ERROR}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_STATE\_ERROR@{CIOT\_MQTT\_STATE\_ERROR}}}\Hypertarget{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea3cd3678d8b777367f05ebeb64fa5d6e1}\label{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea3cd3678d8b777367f05ebeb64fa5d6e1} -CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+ERROR&Error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_STATE\_DISCONNECTED@{CIOT\_MQTT\_STATE\_DISCONNECTED}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_STATE\_DISCONNECTED@{CIOT\_MQTT\_STATE\_DISCONNECTED}}}\Hypertarget{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea004bb3b5e1c7526ac86d715808871aab}\label{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea004bb3b5e1c7526ac86d715808871aab} -CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+DISCONNECTED&Disconnected state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_STATE\_CONNECTING@{CIOT\_MQTT\_STATE\_CONNECTING}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_STATE\_CONNECTING@{CIOT\_MQTT\_STATE\_CONNECTING}}}\Hypertarget{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ceaead9e930ad102c9ab546ca112841a1a8}\label{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ceaead9e930ad102c9ab546ca112841a1a8} -CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+CONNECTING&Connecting state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_STATE\_DISCONNECTING@{CIOT\_MQTT\_STATE\_DISCONNECTING}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_STATE\_DISCONNECTING@{CIOT\_MQTT\_STATE\_DISCONNECTING}}}\Hypertarget{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea556288d80c5f236a85b349084936ad24}\label{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea556288d80c5f236a85b349084936ad24} -CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+DISCONNECTING&Disconnecting state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_STATE\_CONNECTED@{CIOT\_MQTT\_STATE\_CONNECTED}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_STATE\_CONNECTED@{CIOT\_MQTT\_STATE\_CONNECTED}}}\Hypertarget{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea79b34e4a21856bfabc772c8491525476}\label{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea79b34e4a21856bfabc772c8491525476} -CIOT\+\_\+\+MQTT\+\_\+\+STATE\+\_\+\+CONNECTED&Connected state \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684}\label{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684} -\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!ciot\_mqttc\_transport\_t@{ciot\_mqttc\_transport\_t}} -\index{ciot\_mqttc\_transport\_t@{ciot\_mqttc\_transport\_t}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_mqttc\_transport\_t}{ciot\_mqttc\_transport\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684}{ciot\+\_\+mqttc\+\_\+transport\+\_\+t}}} - - - -Enumeration for CIOT MQTT client transport types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_TRANSPORT\_UNKNOWN@{CIOT\_MQTT\_TRANSPORT\_UNKNOWN}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_TRANSPORT\_UNKNOWN@{CIOT\_MQTT\_TRANSPORT\_UNKNOWN}}}\Hypertarget{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a2f26568f96a771a6de885dcdecc7e83c}\label{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a2f26568f96a771a6de885dcdecc7e83c} -CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+UNKNOWN&Unknown transport type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_TRANSPORT\_OVER\_TCP@{CIOT\_MQTT\_TRANSPORT\_OVER\_TCP}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_TRANSPORT\_OVER\_TCP@{CIOT\_MQTT\_TRANSPORT\_OVER\_TCP}}}\Hypertarget{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a525b4c85b24d94e497cb786ba050b7f9}\label{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a525b4c85b24d94e497cb786ba050b7f9} -CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+TCP&TCP transport type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_TRANSPORT\_OVER\_SSL@{CIOT\_MQTT\_TRANSPORT\_OVER\_SSL}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_TRANSPORT\_OVER\_SSL@{CIOT\_MQTT\_TRANSPORT\_OVER\_SSL}}}\Hypertarget{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5d3cd88c4c3238306de35766ebd4c119}\label{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5d3cd88c4c3238306de35766ebd4c119} -CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+SSL&SSL transport type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_TRANSPORT\_OVER\_WS@{CIOT\_MQTT\_TRANSPORT\_OVER\_WS}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_TRANSPORT\_OVER\_WS@{CIOT\_MQTT\_TRANSPORT\_OVER\_WS}}}\Hypertarget{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5ce16156ba60d3c867acb7d960d574fd}\label{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5ce16156ba60d3c867acb7d960d574fd} -CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+WS&Web\+Socket transport type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MQTT\_TRANSPORT\_OVER\_WSS@{CIOT\_MQTT\_TRANSPORT\_OVER\_WSS}!ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}}\index{ciot\_mqttc\_types.h@{ciot\_mqttc\_types.h}!CIOT\_MQTT\_TRANSPORT\_OVER\_WSS@{CIOT\_MQTT\_TRANSPORT\_OVER\_WSS}}}\Hypertarget{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684adf27ceb8c08b58be48c97e2057e51fe4}\label{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684adf27ceb8c08b58be48c97e2057e51fe4} -CIOT\+\_\+\+MQTT\+\_\+\+TRANSPORT\+\_\+\+OVER\+\_\+\+WSS&Secure Web\+Socket transport type \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__mqttc__types_8h_source.tex b/docs/latex/ciot__mqttc__types_8h_source.tex deleted file mode 100644 index 0965367..0000000 --- a/docs/latex/ciot__mqttc__types_8h_source.tex +++ /dev/null @@ -1,150 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+types.\+h} -\hypertarget{ciot__mqttc__types_8h_source}{}\label{ciot__mqttc__types_8h_source}\index{include/types/ciot\_mqttc\_types.h@{include/types/ciot\_mqttc\_types.h}} -\mbox{\hyperlink{ciot__mqttc__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_MQTT\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_MQTT\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__common__types_8h}{ciot\_common\_types.h}}"{}}} -\DoxyCodeLine{00022\ } -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN\ 32}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_MQTT\_URL\_LEN}} -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTT\_URL\_LEN\ 64}} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_MQTT\_USER\_LEN}} -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTT\_USER\_LEN\ 32}} -\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_MQTT\_PASS\_LEN}} -\DoxyCodeLine{00037\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTT\_PASS\_LEN\ 32}} -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}} -\DoxyCodeLine{00041\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTT\_TOPIC\_LEN\ 48}} -\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00044\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_MQTT\_MSG\_LEN}} -\DoxyCodeLine{00045\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_MQTT\_MSG\_LEN\ 256}} -\DoxyCodeLine{00046\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00051\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00052\ \{} -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea3cd3678d8b777367f05ebeb64fa5d6e1}{CIOT\_MQTT\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00054\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea004bb3b5e1c7526ac86d715808871aab}{CIOT\_MQTT\_STATE\_DISCONNECTED}},\ } -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ceaead9e930ad102c9ab546ca112841a1a8}{CIOT\_MQTT\_STATE\_CONNECTING}},\ } -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea556288d80c5f236a85b349084936ad24}{CIOT\_MQTT\_STATE\_DISCONNECTING}},\ } -\DoxyCodeLine{00057\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2cea79b34e4a21856bfabc772c8491525476}{CIOT\_MQTT\_STATE\_CONNECTED}},\ } -\DoxyCodeLine{00058\ \}\ \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce}{ciot\_mqttc\_state\_t}};} -\DoxyCodeLine{00059\ } -\DoxyCodeLine{00063\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00064\ \{} -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a2f26568f96a771a6de885dcdecc7e83c}{CIOT\_MQTT\_TRANSPORT\_UNKNOWN}},\ } -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a525b4c85b24d94e497cb786ba050b7f9}{CIOT\_MQTT\_TRANSPORT\_OVER\_TCP}},\ } -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5d3cd88c4c3238306de35766ebd4c119}{CIOT\_MQTT\_TRANSPORT\_OVER\_SSL}},\ } -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684a5ce16156ba60d3c867acb7d960d574fd}{CIOT\_MQTT\_TRANSPORT\_OVER\_WS}},\ } -\DoxyCodeLine{00069\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684adf27ceb8c08b58be48c97e2057e51fe4}{CIOT\_MQTT\_TRANSPORT\_OVER\_WSS}},\ } -\DoxyCodeLine{00070\ \}\ \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684}{ciot\_mqttc\_transport\_t}};} -\DoxyCodeLine{00071\ } -\DoxyCodeLine{00075\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00076\ \{} -\DoxyCodeLine{00077\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a1832343a674951b5cc6e0b1281ac8872}{CIOT\_MQTT\_REQ\_UNKNONW}},\ } -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43a5b0bc93e48a1c931162fc99240863279}{CIOT\_MQTT\_REQ\_PUBLISH}},\ } -\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43ab1ca6f635ae3eb1dc067fd0058846f55}{CIOT\_MQTT\_REQ\_SUBSCRIBE}},\ } -\DoxyCodeLine{00080\ \}\ \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43}{ciot\_mqttc\_req\_type\_t}};} -\DoxyCodeLine{00081\ } -\DoxyCodeLine{00085\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00086\ \{} -\DoxyCodeLine{00087\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__mqttc__error__t_af8b9db3223039d525df4371413d3c2f3}{tls\_last\_err}};\ } -\DoxyCodeLine{00088\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__mqttc__error__t_a9006960d969e505489e2a46434d60ebb}{tls\_stack\_err}};\ } -\DoxyCodeLine{00089\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__mqttc__error__t_abde2f3e27511cfb7307766339fed98e9}{tls\_cert\_verify\_flags}};\ } -\DoxyCodeLine{00090\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__mqttc__error__t_ac765329451135abec74c45e1897abf26}{type}};\ } -\DoxyCodeLine{00091\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__mqttc__error__t_a45a5b7c00a796a23f01673cef1dbe0a9}{code}};\ } -\DoxyCodeLine{00092\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__mqttc__error__t_a2d16d2a81fde684b4c79c0d71f8090b5}{transport\_sock}};\ } -\DoxyCodeLine{00093\ \}\ \mbox{\hyperlink{structciot__mqttc__error__t}{ciot\_mqttc\_error\_t}};} -\DoxyCodeLine{00094\ } -\DoxyCodeLine{00098\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00099\ \{} -\DoxyCodeLine{00100\ \ \ \ \ \textcolor{keywordtype}{char}\ d2b[\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}}];\ } -\DoxyCodeLine{00101\ \ \ \ \ \textcolor{keywordtype}{char}\ b2d[\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}}];\ } -\DoxyCodeLine{00102\ \}\ \mbox{\hyperlink{structciot__mqttc__topics__cfg__t}{ciot\_mqttc\_topics\_cfg\_t}};} -\DoxyCodeLine{00103\ } -\DoxyCodeLine{00107\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00108\ \{} -\DoxyCodeLine{00109\ \ \ \ \ \textcolor{keywordtype}{char}\ client\_id[\mbox{\hyperlink{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e}{CIOT\_CONFIG\_MQTT\_CLIENT\_ID\_LEN}}];\ } -\DoxyCodeLine{00110\ \ \ \ \ \textcolor{keywordtype}{char}\ url[\mbox{\hyperlink{ciot__mqttc__types_8h_aeb924d17fcd585c2612e41f7f4ad9a1f}{CIOT\_CONFIG\_MQTT\_URL\_LEN}}];\ } -\DoxyCodeLine{00111\ \ \ \ \ \textcolor{keywordtype}{char}\ user[\mbox{\hyperlink{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e}{CIOT\_CONFIG\_MQTT\_USER\_LEN}}];\ } -\DoxyCodeLine{00112\ \ \ \ \ \textcolor{keywordtype}{char}\ pass[\mbox{\hyperlink{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50}{CIOT\_CONFIG\_MQTT\_PASS\_LEN}}];\ } -\DoxyCodeLine{00113\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__mqttc__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6}{port}};\ } -\DoxyCodeLine{00114\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__mqttc__cfg__t_a65ee2b4b16f25052c441ff9959dcc7e7}{qos}};\ } -\DoxyCodeLine{00115\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684}{ciot\_mqttc\_transport\_t}}\ \mbox{\hyperlink{structciot__mqttc__cfg__t_addf4bba19daf5bd5b49b033e239931da}{transport}};\ } -\DoxyCodeLine{00116\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__topics__cfg__t}{ciot\_mqttc\_topics\_cfg\_t}}\ \mbox{\hyperlink{structciot__mqttc__cfg__t_a2a5888184d23c617efb05a871a705673}{topics}};\ } -\DoxyCodeLine{00117\ \}\ \mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\_mqttc\_cfg\_t}};} -\DoxyCodeLine{00118\ } -\DoxyCodeLine{00122\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00123\ \{} -\DoxyCodeLine{00124\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce}{ciot\_mqttc\_state\_t}}\ \mbox{\hyperlink{structciot__mqttc__status__t_a28daf783134e0bed0e611de3ea451e4a}{state}};\ } -\DoxyCodeLine{00125\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__mqttc__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4}{conn\_count}};\ } -\DoxyCodeLine{00126\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__mqttc__status__t_af7750329f3654d2f6fe5a20adeae49dd}{data\_rate}};\ } -\DoxyCodeLine{00127\ \ \ \ \ time\_t\ \mbox{\hyperlink{structciot__mqttc__status__t_a44794759868576e0404c9cf629863797}{last\_msg\_time}};\ } -\DoxyCodeLine{00128\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__error__t}{ciot\_mqttc\_error\_t}}\ \mbox{\hyperlink{structciot__mqttc__status__t_acee85046d884f9e69d341dafac56cd22}{error}};\ } -\DoxyCodeLine{00129\ \}\ \mbox{\hyperlink{structciot__mqttc__status__t}{ciot\_mqttc\_status\_t}};} -\DoxyCodeLine{00130\ } -\DoxyCodeLine{00134\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00135\ \{} -\DoxyCodeLine{00136\ \ \ \ \ \textcolor{keywordtype}{char}\ topic[\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}}];\ } -\DoxyCodeLine{00137\ \ \ \ \ uint8\_t\ msg[\mbox{\hyperlink{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086}{CIOT\_CONFIG\_MQTT\_MSG\_LEN}}];\ } -\DoxyCodeLine{00138\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__mqttc__req__publish__t_a439227feff9d7f55384e8780cfc2eb82}{size}};\ } -\DoxyCodeLine{00139\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__mqttc__req__publish__t_a65ee2b4b16f25052c441ff9959dcc7e7}{qos}};\ } -\DoxyCodeLine{00140\ \}\ \mbox{\hyperlink{structciot__mqttc__req__publish__t}{ciot\_mqttc\_req\_publish\_t}};} -\DoxyCodeLine{00141\ } -\DoxyCodeLine{00145\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00146\ \{} -\DoxyCodeLine{00147\ \ \ \ \ \textcolor{keywordtype}{char}\ topic[\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\_CONFIG\_MQTT\_TOPIC\_LEN}}];\ } -\DoxyCodeLine{00148\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__mqttc__req__subscribe__t_a65ee2b4b16f25052c441ff9959dcc7e7}{qos}};\ } -\DoxyCodeLine{00149\ \}\ \mbox{\hyperlink{structciot__mqttc__req__subscribe__t}{ciot\_mqttc\_req\_subscribe\_t}};} -\DoxyCodeLine{00150\ } -\DoxyCodeLine{00154\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00155\ \{} -\DoxyCodeLine{00156\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__req__publish__t}{ciot\_mqttc\_req\_publish\_t}}\ \mbox{\hyperlink{unionciot__mqttc__req__data__u_ae7b5bde19c99952b5a737b600f3c21e6}{publish}};\ } -\DoxyCodeLine{00157\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__req__subscribe__t}{ciot\_mqttc\_req\_subscribe\_t}}\ \mbox{\hyperlink{unionciot__mqttc__req__data__u_a061e16f43670bc7f5d29c3971b4088c3}{subscribe}};\ } -\DoxyCodeLine{00158\ \}\ \mbox{\hyperlink{unionciot__mqttc__req__data__u}{ciot\_mqttc\_req\_data\_u}};} -\DoxyCodeLine{00159\ } -\DoxyCodeLine{00163\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00164\ \{} -\DoxyCodeLine{00165\ \ \ \ \ \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43}{ciot\_mqttc\_req\_type\_t}}\ \mbox{\hyperlink{structciot__mqttc__req__t_a8e287bd3b319b246d8346f46ed6c4580}{type}};\ } -\DoxyCodeLine{00166\ \ \ \ \ \mbox{\hyperlink{unionciot__mqttc__req__data__u}{ciot\_mqttc\_req\_data\_u}}\ \mbox{\hyperlink{structciot__mqttc__req__t_ad609e57ec1fe769dd7f41602cae320ca}{data}};\ } -\DoxyCodeLine{00167\ \}\ \mbox{\hyperlink{structciot__mqttc__req__t}{ciot\_mqttc\_req\_t}};} -\DoxyCodeLine{00168\ } -\DoxyCodeLine{00172\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__mqttc__event__data}{ciot\_mqttc\_event\_data}}} -\DoxyCodeLine{00173\ \{} -\DoxyCodeLine{00174\ \ \ \ \ \mbox{\hyperlink{structciot__event__data}{ciot\_event\_data\_t}}\ \mbox{\hyperlink{structciot__mqttc__event__data_a2dbb61af8fd36dccbf3662d0c7a64839}{payload}};\ } -\DoxyCodeLine{00175\ \ \ \ \ \textcolor{keywordtype}{char}\ *\mbox{\hyperlink{structciot__mqttc__event__data_affecb48e716753e10b44feac31f12529}{topic}};\ } -\DoxyCodeLine{00176\ \}\ \mbox{\hyperlink{ciot__mqttc__types_8h_ac871b56a938626c38c705618405ee350}{ciot\_mqttc\_event\_data\_t}};} -\DoxyCodeLine{00177\ } -\DoxyCodeLine{00181\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__mqttc__event}{ciot\_mqttc\_event}}} -\DoxyCodeLine{00182\ \{} -\DoxyCodeLine{00183\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__event__data}{ciot\_mqttc\_event\_data\_t}}\ \mbox{\hyperlink{structciot__mqttc__event_acd187e9c28c27f14c5eb518411a273cb}{data}};\ } -\DoxyCodeLine{00184\ \}\ \mbox{\hyperlink{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}{ciot\_mqttc\_event\_u}};} -\DoxyCodeLine{00185\ } -\DoxyCodeLine{00189\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00190\ \{} -\DoxyCodeLine{00191\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\_mqttc\_cfg\_t}}\ \mbox{\hyperlink{unionciot__mqttc__data__u_a79c158a8d9a5ddac01d944ca9485764b}{config}};\ } -\DoxyCodeLine{00192\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__status__t}{ciot\_mqttc\_status\_t}}\ \mbox{\hyperlink{unionciot__mqttc__data__u_a0bd4162002c890f2775878d4da138c03}{status}};\ } -\DoxyCodeLine{00193\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__req__t}{ciot\_mqttc\_req\_t}}\ \mbox{\hyperlink{unionciot__mqttc__data__u_af4d809ae5adfaf23b4229995212f0ded}{request}};\ } -\DoxyCodeLine{00194\ \ \ \ \ \mbox{\hyperlink{structciot__mqttc__event}{ciot\_mqttc\_event\_u}}\ \mbox{\hyperlink{unionciot__mqttc__data__u_aea75f103343a18512b1024505e9766de}{event}};\ } -\DoxyCodeLine{00195\ \}\ \mbox{\hyperlink{unionciot__mqttc__data__u}{ciot\_mqttc\_data\_u}};} -\DoxyCodeLine{00196\ } -\DoxyCodeLine{00197\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00198\ \}} -\DoxyCodeLine{00199\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00200\ } -\DoxyCodeLine{00201\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__msg__types_8h.tex b/docs/latex/ciot__msg__types_8h.tex deleted file mode 100644 index 2912982..0000000 --- a/docs/latex/ciot__msg__types_8h.tex +++ /dev/null @@ -1,297 +0,0 @@ -\doxysection{include/types/ciot\+\_\+msg\+\_\+types.h File Reference} -\hypertarget{ciot__msg__types_8h}{}\label{ciot__msg__types_8h}\index{include/types/ciot\_msg\_types.h@{include/types/ciot\_msg\_types.h}} - - -Defines data types and structures for CIOT messaging. - - -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+storage\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+sys\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+uart\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+usb\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+tcp\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+wifi\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+ble\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+ntp\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+dfu\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+ota\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+https\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+httpc\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+mqttc\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}types/ciot\+\_\+bridge\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT message interface information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__msg__error__t}{ciot\+\_\+msg\+\_\+error\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT message error information. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT message data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT message header. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__msg__types_8h_aa577da47450d2b604f58ee6e957c7b1a}{CIOT\+\_\+\+MSG\+\_\+\+HEADER\+\_\+\+SIZE}}~(sizeof(\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}})) -\item -\#define \mbox{\hyperlink{ciot__msg__types_8h_a9ba863166c0f0c740fef8994c7f21598}{CIOT\+\_\+\+MSG\+\_\+\+GET\+\_\+\+SIZE}}(data)~(\mbox{\hyperlink{ciot__msg__types_8h_aa577da47450d2b604f58ee6e957c7b1a}{CIOT\+\_\+\+MSG\+\_\+\+HEADER\+\_\+\+SIZE}} + sizeof(data)) -\item -\#define \mbox{\hyperlink{ciot__msg__types_8h_a3c8f8294a63f46a7a7ed043ba8dacc93}{CIOT\+\_\+\+MSG\+\_\+\+MAX\+\_\+\+SIZE}}~sizeof(\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}}); -\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba65c33be2457e343493460c29d3b03e0e}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbacada4954ca221fdc25c2c478625d6a9e}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+START}} -, \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbae01a23d279f8674eb8e7fbc4c8b30a28}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+STOP}} -, \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba9ca32ac07611a36e17181e4e2dee5ba7}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+GET\+\_\+\+CONFIG}} -, \newline -\mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba8ebce537fc418c0a5dc2231de2660d5e}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+GET\+\_\+\+STATUS}} -, \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba168673ee4b498d56024c3c46d5d6d53a}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+REQUEST}} -, \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba5ca3e5de0b2ddc69c53654a0d13d713a}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+ERROR}} -, \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba07a7987e3b4a2f82eb41213b25068458}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+EVENT}} -, \newline -\mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba2161a50e60627d09f6278819d93cb4f8}{CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+CUSTOM}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT message types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a75837371354fe9353d77acc9fc49ee6d}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad57b9f27f19fb7d16c08c4857ae7291d}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+CIOT}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a613cf065591c3e8300a4fe009a044aec}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+STORAGE}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a327aeede0ef7fba282b1911dfa988d28}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+SYSTEM}} -, \newline -\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab3a691e3ca526bb17bd62366d83bbcd7}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+UART}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a2c76f658f22fa29ed49d56c697215918}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+USB}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab013ddfd461842f9031bed420c5720bc}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+TCP}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aa3dce94aa5a8e8a6c1a0592f59cdb747}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+ETH}} -, \newline -\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a53e8d8ba26c3663e0a7f9d8a70aa2770}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+WIFI}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a7ca4cc3f201a9ce47e80e5e6685e6fd5}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+BLE}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a9d8b8db1db47ef5baf0a7894264e364c}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+BLE\+\_\+\+SCN}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a22891d22cf46370531f6eb833b037235}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+GPIO}} -, \newline -\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a08b41fe63e5a4b8ea4710adaac89f8b8}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+NTP}} = 127 -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ae07a8e59d7924852ed66075eefcd1c3d}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+OTA}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608acf86ce5e05bba2ba30d275ce78438806}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+DFU}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad89e327f418602211b2202c414291750}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+HTTP\+\_\+\+CLIENT}} -, \newline -\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab91f2d2aa5ecf13c79d0028a487584ca}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+HTTP\+\_\+\+SERVER}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a3065d35cd0a10d31382d9c5b38249ca5}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+MQTT}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aff200c36869c4d69a1cb8edf4d45202a}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+CUSTOM}} -, \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a67c77e20c41ae475451f4f01a3b2fdb4}{CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+BRIDGE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT message interface types. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__msg__types_8h_ad74fa5c942e63dc4c806fbfd6414db45}{ciot\+\_\+msg\+\_\+type\+\_\+to\+\_\+str}} (\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg) -\begin{DoxyCompactList}\small\item\em Convert CIOT message type to string. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT messaging. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__msg__types_8h_a9ba863166c0f0c740fef8994c7f21598}\label{ciot__msg__types_8h_a9ba863166c0f0c740fef8994c7f21598} -\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_GET\_SIZE@{CIOT\_MSG\_GET\_SIZE}} -\index{CIOT\_MSG\_GET\_SIZE@{CIOT\_MSG\_GET\_SIZE}!ciot\_msg\_types.h@{ciot\_msg\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_MSG\_GET\_SIZE}{CIOT\_MSG\_GET\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+MSG\+\_\+\+GET\+\_\+\+SIZE(\begin{DoxyParamCaption}\item[{}]{data }\end{DoxyParamCaption})~(\mbox{\hyperlink{ciot__msg__types_8h_aa577da47450d2b604f58ee6e957c7b1a}{CIOT\+\_\+\+MSG\+\_\+\+HEADER\+\_\+\+SIZE}} + sizeof(data))} - -Calculate message size \Hypertarget{ciot__msg__types_8h_aa577da47450d2b604f58ee6e957c7b1a}\label{ciot__msg__types_8h_aa577da47450d2b604f58ee6e957c7b1a} -\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_HEADER\_SIZE@{CIOT\_MSG\_HEADER\_SIZE}} -\index{CIOT\_MSG\_HEADER\_SIZE@{CIOT\_MSG\_HEADER\_SIZE}!ciot\_msg\_types.h@{ciot\_msg\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_MSG\_HEADER\_SIZE}{CIOT\_MSG\_HEADER\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+MSG\+\_\+\+HEADER\+\_\+\+SIZE~(sizeof(\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}}))} - -Size of the message header \Hypertarget{ciot__msg__types_8h_a3c8f8294a63f46a7a7ed043ba8dacc93}\label{ciot__msg__types_8h_a3c8f8294a63f46a7a7ed043ba8dacc93} -\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_MAX\_SIZE@{CIOT\_MSG\_MAX\_SIZE}} -\index{CIOT\_MSG\_MAX\_SIZE@{CIOT\_MSG\_MAX\_SIZE}!ciot\_msg\_types.h@{ciot\_msg\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_MSG\_MAX\_SIZE}{CIOT\_MSG\_MAX\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+MSG\+\_\+\+MAX\+\_\+\+SIZE~sizeof(\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}});} - -Maximum message size - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608} -\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!ciot\_msg\_iface\_type\_t@{ciot\_msg\_iface\_type\_t}} -\index{ciot\_msg\_iface\_type\_t@{ciot\_msg\_iface\_type\_t}!ciot\_msg\_types.h@{ciot\_msg\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_msg\_iface\_type\_t}{ciot\_msg\_iface\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT message interface types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_UNKNOWN@{CIOT\_IFACE\_TYPE\_UNKNOWN}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_UNKNOWN@{CIOT\_IFACE\_TYPE\_UNKNOWN}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a75837371354fe9353d77acc9fc49ee6d}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a75837371354fe9353d77acc9fc49ee6d} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+UNKNOWN&Unknown interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_CIOT@{CIOT\_IFACE\_TYPE\_CIOT}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_CIOT@{CIOT\_IFACE\_TYPE\_CIOT}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad57b9f27f19fb7d16c08c4857ae7291d}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad57b9f27f19fb7d16c08c4857ae7291d} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+CIOT&CIOT interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_STORAGE@{CIOT\_IFACE\_TYPE\_STORAGE}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_STORAGE@{CIOT\_IFACE\_TYPE\_STORAGE}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a613cf065591c3e8300a4fe009a044aec}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a613cf065591c3e8300a4fe009a044aec} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+STORAGE&Storage interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_SYSTEM@{CIOT\_IFACE\_TYPE\_SYSTEM}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_SYSTEM@{CIOT\_IFACE\_TYPE\_SYSTEM}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a327aeede0ef7fba282b1911dfa988d28}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a327aeede0ef7fba282b1911dfa988d28} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+SYSTEM&System interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_UART@{CIOT\_IFACE\_TYPE\_UART}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_UART@{CIOT\_IFACE\_TYPE\_UART}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab3a691e3ca526bb17bd62366d83bbcd7}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab3a691e3ca526bb17bd62366d83bbcd7} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+UART&UART interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_USB@{CIOT\_IFACE\_TYPE\_USB}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_USB@{CIOT\_IFACE\_TYPE\_USB}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a2c76f658f22fa29ed49d56c697215918}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a2c76f658f22fa29ed49d56c697215918} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+USB&USB interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_TCP@{CIOT\_IFACE\_TYPE\_TCP}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_TCP@{CIOT\_IFACE\_TYPE\_TCP}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab013ddfd461842f9031bed420c5720bc}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab013ddfd461842f9031bed420c5720bc} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+TCP&TCP interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_ETH@{CIOT\_IFACE\_TYPE\_ETH}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_ETH@{CIOT\_IFACE\_TYPE\_ETH}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aa3dce94aa5a8e8a6c1a0592f59cdb747}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aa3dce94aa5a8e8a6c1a0592f59cdb747} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+ETH&Ethernet interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_WIFI@{CIOT\_IFACE\_TYPE\_WIFI}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_WIFI@{CIOT\_IFACE\_TYPE\_WIFI}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a53e8d8ba26c3663e0a7f9d8a70aa2770}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a53e8d8ba26c3663e0a7f9d8a70aa2770} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+WIFI&Wi\+Fi interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_BLE@{CIOT\_IFACE\_TYPE\_BLE}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_BLE@{CIOT\_IFACE\_TYPE\_BLE}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a7ca4cc3f201a9ce47e80e5e6685e6fd5}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a7ca4cc3f201a9ce47e80e5e6685e6fd5} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+BLE&BLE interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_BLE\_SCN@{CIOT\_IFACE\_TYPE\_BLE\_SCN}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_BLE\_SCN@{CIOT\_IFACE\_TYPE\_BLE\_SCN}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a9d8b8db1db47ef5baf0a7894264e364c}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a9d8b8db1db47ef5baf0a7894264e364c} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+BLE\+\_\+\+SCN&BLE SCN interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_GPIO@{CIOT\_IFACE\_TYPE\_GPIO}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_GPIO@{CIOT\_IFACE\_TYPE\_GPIO}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a22891d22cf46370531f6eb833b037235}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a22891d22cf46370531f6eb833b037235} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+GPIO&GPIO interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_NTP@{CIOT\_IFACE\_TYPE\_NTP}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_NTP@{CIOT\_IFACE\_TYPE\_NTP}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a08b41fe63e5a4b8ea4710adaac89f8b8}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a08b41fe63e5a4b8ea4710adaac89f8b8} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+NTP&NTP interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_OTA@{CIOT\_IFACE\_TYPE\_OTA}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_OTA@{CIOT\_IFACE\_TYPE\_OTA}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ae07a8e59d7924852ed66075eefcd1c3d}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ae07a8e59d7924852ed66075eefcd1c3d} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+OTA&OTA interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_DFU@{CIOT\_IFACE\_TYPE\_DFU}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_DFU@{CIOT\_IFACE\_TYPE\_DFU}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608acf86ce5e05bba2ba30d275ce78438806}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608acf86ce5e05bba2ba30d275ce78438806} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+DFU&DFU interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_HTTP\_CLIENT@{CIOT\_IFACE\_TYPE\_HTTP\_CLIENT}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_HTTP\_CLIENT@{CIOT\_IFACE\_TYPE\_HTTP\_CLIENT}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad89e327f418602211b2202c414291750}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad89e327f418602211b2202c414291750} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+HTTP\+\_\+\+CLIENT&HTTP client interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_HTTP\_SERVER@{CIOT\_IFACE\_TYPE\_HTTP\_SERVER}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_HTTP\_SERVER@{CIOT\_IFACE\_TYPE\_HTTP\_SERVER}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab91f2d2aa5ecf13c79d0028a487584ca}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab91f2d2aa5ecf13c79d0028a487584ca} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+HTTP\+\_\+\+SERVER&HTTP server interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_MQTT@{CIOT\_IFACE\_TYPE\_MQTT}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_MQTT@{CIOT\_IFACE\_TYPE\_MQTT}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a3065d35cd0a10d31382d9c5b38249ca5}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a3065d35cd0a10d31382d9c5b38249ca5} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+MQTT&MQTT interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_CUSTOM@{CIOT\_IFACE\_TYPE\_CUSTOM}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_CUSTOM@{CIOT\_IFACE\_TYPE\_CUSTOM}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aff200c36869c4d69a1cb8edf4d45202a}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aff200c36869c4d69a1cb8edf4d45202a} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+CUSTOM&Custom interface type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_IFACE\_TYPE\_BRIDGE@{CIOT\_IFACE\_TYPE\_BRIDGE}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_IFACE\_TYPE\_BRIDGE@{CIOT\_IFACE\_TYPE\_BRIDGE}}}\Hypertarget{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a67c77e20c41ae475451f4f01a3b2fdb4}\label{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a67c77e20c41ae475451f4f01a3b2fdb4} -CIOT\+\_\+\+IFACE\+\_\+\+TYPE\+\_\+\+BRIDGE&Bridge interface type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb} -\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!ciot\_msg\_type\_t@{ciot\_msg\_type\_t}} -\index{ciot\_msg\_type\_t@{ciot\_msg\_type\_t}!ciot\_msg\_types.h@{ciot\_msg\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_msg\_type\_t}{ciot\_msg\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT message types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_UNKNOWN@{CIOT\_MSG\_TYPE\_UNKNOWN}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_UNKNOWN@{CIOT\_MSG\_TYPE\_UNKNOWN}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba65c33be2457e343493460c29d3b03e0e}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba65c33be2457e343493460c29d3b03e0e} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+UNKNOWN&Unknown message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_START@{CIOT\_MSG\_TYPE\_START}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_START@{CIOT\_MSG\_TYPE\_START}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbacada4954ca221fdc25c2c478625d6a9e}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbacada4954ca221fdc25c2c478625d6a9e} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+START&Start message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_STOP@{CIOT\_MSG\_TYPE\_STOP}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_STOP@{CIOT\_MSG\_TYPE\_STOP}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbae01a23d279f8674eb8e7fbc4c8b30a28}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbae01a23d279f8674eb8e7fbc4c8b30a28} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+STOP&Stop message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_GET\_CONFIG@{CIOT\_MSG\_TYPE\_GET\_CONFIG}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_GET\_CONFIG@{CIOT\_MSG\_TYPE\_GET\_CONFIG}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba9ca32ac07611a36e17181e4e2dee5ba7}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba9ca32ac07611a36e17181e4e2dee5ba7} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+GET\+\_\+\+CONFIG&Get configuration message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_GET\_STATUS@{CIOT\_MSG\_TYPE\_GET\_STATUS}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_GET\_STATUS@{CIOT\_MSG\_TYPE\_GET\_STATUS}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba8ebce537fc418c0a5dc2231de2660d5e}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba8ebce537fc418c0a5dc2231de2660d5e} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+GET\+\_\+\+STATUS&Get status message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_REQUEST@{CIOT\_MSG\_TYPE\_REQUEST}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_REQUEST@{CIOT\_MSG\_TYPE\_REQUEST}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba168673ee4b498d56024c3c46d5d6d53a}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba168673ee4b498d56024c3c46d5d6d53a} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+REQUEST&Request message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_ERROR@{CIOT\_MSG\_TYPE\_ERROR}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_ERROR@{CIOT\_MSG\_TYPE\_ERROR}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba5ca3e5de0b2ddc69c53654a0d13d713a}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba5ca3e5de0b2ddc69c53654a0d13d713a} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+ERROR&Error message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_EVENT@{CIOT\_MSG\_TYPE\_EVENT}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_EVENT@{CIOT\_MSG\_TYPE\_EVENT}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba07a7987e3b4a2f82eb41213b25068458}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba07a7987e3b4a2f82eb41213b25068458} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+EVENT&Event message type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_MSG\_TYPE\_CUSTOM@{CIOT\_MSG\_TYPE\_CUSTOM}!ciot\_msg\_types.h@{ciot\_msg\_types.h}}\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!CIOT\_MSG\_TYPE\_CUSTOM@{CIOT\_MSG\_TYPE\_CUSTOM}}}\Hypertarget{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba2161a50e60627d09f6278819d93cb4f8}\label{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba2161a50e60627d09f6278819d93cb4f8} -CIOT\+\_\+\+MSG\+\_\+\+TYPE\+\_\+\+CUSTOM&Custom message type \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__msg__types_8h_ad74fa5c942e63dc4c806fbfd6414db45}\label{ciot__msg__types_8h_ad74fa5c942e63dc4c806fbfd6414db45} -\index{ciot\_msg\_types.h@{ciot\_msg\_types.h}!ciot\_msg\_type\_to\_str@{ciot\_msg\_type\_to\_str}} -\index{ciot\_msg\_type\_to\_str@{ciot\_msg\_type\_to\_str}!ciot\_msg\_types.h@{ciot\_msg\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_msg\_type\_to\_str()}{ciot\_msg\_type\_to\_str()}} -{\footnotesize\ttfamily const char \texorpdfstring{$\ast$}{*} ciot\+\_\+msg\+\_\+type\+\_\+to\+\_\+str (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{msg }\end{DoxyParamCaption})} - - - -Convert CIOT message type to string. - - -\begin{DoxyParams}{Parameters} -{\em msg} & The CIOT message. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -The string representation of the message type. -\end{DoxyReturn} diff --git a/docs/latex/ciot__msg__types_8h_source.tex b/docs/latex/ciot__msg__types_8h_source.tex deleted file mode 100644 index 088f921..0000000 --- a/docs/latex/ciot__msg__types_8h_source.tex +++ /dev/null @@ -1,129 +0,0 @@ -\doxysection{ciot\+\_\+msg\+\_\+types.\+h} -\hypertarget{ciot__msg__types_8h_source}{}\label{ciot__msg__types_8h_source}\index{include/types/ciot\_msg\_types.h@{include/types/ciot\_msg\_types.h}} -\mbox{\hyperlink{ciot__msg__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_MSG\_DATA\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_MSG\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__types_8h}{types/ciot\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__storage__types_8h}{types/ciot\_storage\_types.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__sys__types_8h}{types/ciot\_sys\_types.h}}"{}}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__uart__types_8h}{types/ciot\_uart\_types.h}}"{}}} -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__usb__types_8h}{types/ciot\_usb\_types.h}}"{}}} -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp__types_8h}{types/ciot\_tcp\_types.h}}"{}}} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__wifi__types_8h}{types/ciot\_wifi\_types.h}}"{}}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__types_8h}{types/ciot\_ble\_types.h}}"{}}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ble__scn__types_8h}{types/ciot\_ble\_scn\_types.h}}"{}}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ntp__types_8h}{types/ciot\_ntp\_types.h}}"{}}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__dfu__types_8h}{types/ciot\_dfu\_types.h}}"{}}} -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ota__types_8h}{types/ciot\_ota\_types.h}}"{}}} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__https__types_8h}{types/ciot\_https\_types.h}}"{}}} -\DoxyCodeLine{00031\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__httpc__types_8h}{types/ciot\_httpc\_types.h}}"{}}} -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__mqttc__types_8h}{types/ciot\_mqttc\_types.h}}"{}}} -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__bridge__types_8h}{types/ciot\_bridge\_types.h}}"{}}} -\DoxyCodeLine{00034\ } -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#define\ CIOT\_MSG\_HEADER\_SIZE\ (sizeof(ciot\_msg\_header\_t))}} -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#define\ CIOT\_MSG\_GET\_SIZE(data)\ (CIOT\_MSG\_HEADER\_SIZE\ +\ sizeof(data))}} -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#define\ CIOT\_MSG\_MAX\_SIZE\ sizeof(ciot\_msg\_t);}} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00045\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00046\ \{} -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba65c33be2457e343493460c29d3b03e0e}{CIOT\_MSG\_TYPE\_UNKNOWN}},\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbacada4954ca221fdc25c2c478625d6a9e}{CIOT\_MSG\_TYPE\_START}},\ } -\DoxyCodeLine{00049\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cbae01a23d279f8674eb8e7fbc4c8b30a28}{CIOT\_MSG\_TYPE\_STOP}},\ } -\DoxyCodeLine{00050\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba9ca32ac07611a36e17181e4e2dee5ba7}{CIOT\_MSG\_TYPE\_GET\_CONFIG}},\ } -\DoxyCodeLine{00051\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba8ebce537fc418c0a5dc2231de2660d5e}{CIOT\_MSG\_TYPE\_GET\_STATUS}},\ } -\DoxyCodeLine{00052\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba168673ee4b498d56024c3c46d5d6d53a}{CIOT\_MSG\_TYPE\_REQUEST}},\ } -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba5ca3e5de0b2ddc69c53654a0d13d713a}{CIOT\_MSG\_TYPE\_ERROR}},\ } -\DoxyCodeLine{00054\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba07a7987e3b4a2f82eb41213b25068458}{CIOT\_MSG\_TYPE\_EVENT}},\ } -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cba2161a50e60627d09f6278819d93cb4f8}{CIOT\_MSG\_TYPE\_CUSTOM}},\ } -\DoxyCodeLine{00056\ \}\ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\_msg\_type\_t}};} -\DoxyCodeLine{00057\ } -\DoxyCodeLine{00061\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00062\ \{} -\DoxyCodeLine{00063\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a75837371354fe9353d77acc9fc49ee6d}{CIOT\_IFACE\_TYPE\_UNKNOWN}},\ } -\DoxyCodeLine{00064\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad57b9f27f19fb7d16c08c4857ae7291d}{CIOT\_IFACE\_TYPE\_CIOT}},\ } -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a613cf065591c3e8300a4fe009a044aec}{CIOT\_IFACE\_TYPE\_STORAGE}},\ } -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a327aeede0ef7fba282b1911dfa988d28}{CIOT\_IFACE\_TYPE\_SYSTEM}},\ } -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab3a691e3ca526bb17bd62366d83bbcd7}{CIOT\_IFACE\_TYPE\_UART}},\ } -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a2c76f658f22fa29ed49d56c697215918}{CIOT\_IFACE\_TYPE\_USB}},\ } -\DoxyCodeLine{00069\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab013ddfd461842f9031bed420c5720bc}{CIOT\_IFACE\_TYPE\_TCP}},\ } -\DoxyCodeLine{00070\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aa3dce94aa5a8e8a6c1a0592f59cdb747}{CIOT\_IFACE\_TYPE\_ETH}},\ } -\DoxyCodeLine{00071\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a53e8d8ba26c3663e0a7f9d8a70aa2770}{CIOT\_IFACE\_TYPE\_WIFI}},\ } -\DoxyCodeLine{00072\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a7ca4cc3f201a9ce47e80e5e6685e6fd5}{CIOT\_IFACE\_TYPE\_BLE}},\ } -\DoxyCodeLine{00073\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a9d8b8db1db47ef5baf0a7894264e364c}{CIOT\_IFACE\_TYPE\_BLE\_SCN}},\ } -\DoxyCodeLine{00074\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a22891d22cf46370531f6eb833b037235}{CIOT\_IFACE\_TYPE\_GPIO}},\ } -\DoxyCodeLine{00075\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a08b41fe63e5a4b8ea4710adaac89f8b8}{CIOT\_IFACE\_TYPE\_NTP}}\ =\ 127,\ } -\DoxyCodeLine{00076\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ae07a8e59d7924852ed66075eefcd1c3d}{CIOT\_IFACE\_TYPE\_OTA}},\ } -\DoxyCodeLine{00077\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608acf86ce5e05bba2ba30d275ce78438806}{CIOT\_IFACE\_TYPE\_DFU}},\ } -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ad89e327f418602211b2202c414291750}{CIOT\_IFACE\_TYPE\_HTTP\_CLIENT}},\ } -\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608ab91f2d2aa5ecf13c79d0028a487584ca}{CIOT\_IFACE\_TYPE\_HTTP\_SERVER}},\ } -\DoxyCodeLine{00080\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a3065d35cd0a10d31382d9c5b38249ca5}{CIOT\_IFACE\_TYPE\_MQTT}},\ } -\DoxyCodeLine{00081\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608aff200c36869c4d69a1cb8edf4d45202a}{CIOT\_IFACE\_TYPE\_CUSTOM}},\ } -\DoxyCodeLine{00082\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608a67c77e20c41ae475451f4f01a3b2fdb4}{CIOT\_IFACE\_TYPE\_BRIDGE}},\ } -\DoxyCodeLine{00083\ \}\ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\_msg\_iface\_type\_t}};} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00088\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00089\ \{} -\DoxyCodeLine{00090\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__msg__iface__info__t_a1e6927fa1486224044e568f9c370519b}{id}};\ } -\DoxyCodeLine{00091\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\_msg\_iface\_type\_t}}\ \mbox{\hyperlink{structciot__msg__iface__info__t_ab9b24d9114ce832a5b9cbc962c9cea28}{type}};\ } -\DoxyCodeLine{00092\ \}\ \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\_msg\_iface\_info\_t}};} -\DoxyCodeLine{00093\ } -\DoxyCodeLine{00097\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00098\ \{} -\DoxyCodeLine{00099\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\_msg\_type\_t}}\ \mbox{\hyperlink{structciot__msg__error__t_a61e21da913274adbd45e28f694651b11}{msg\_type}};\ } -\DoxyCodeLine{00100\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__msg__error__t_afe73fa7a655419b386e0a10c7beaace3}{code}};\ } -\DoxyCodeLine{00101\ \}\ \mbox{\hyperlink{structciot__msg__error__t}{ciot\_msg\_error\_t}};} -\DoxyCodeLine{00102\ } -\DoxyCodeLine{00106\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00107\ \{} -\DoxyCodeLine{00108\ \ \ \ \ \mbox{\hyperlink{unionciot__data__u}{ciot\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_afedab1afecebfb5eb8554e3b1b056502}{ciot}};\ } -\DoxyCodeLine{00109\ \ \ \ \ \mbox{\hyperlink{unionciot__storage__data__u}{ciot\_storage\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a4c64bed640d14af56502dd8dceb9ab20}{storage}};\ } -\DoxyCodeLine{00110\ \ \ \ \ \mbox{\hyperlink{unionciot__sys__data__u}{ciot\_sys\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a04c7e159105631b657e5b65f977a2c4a}{system}};\ } -\DoxyCodeLine{00111\ \ \ \ \ \mbox{\hyperlink{unionciot__uart__data__u}{ciot\_uart\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_aeaf49cc638f1cc4fac1c69fa12502d32}{uart}};\ } -\DoxyCodeLine{00112\ \ \ \ \ \mbox{\hyperlink{unionciot__usb__data__u}{ciot\_usb\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_acd0961872f365a2b54fef650ac190f50}{usb}};\ } -\DoxyCodeLine{00113\ \ \ \ \ \mbox{\hyperlink{unionciot__tcp__data__u}{ciot\_tcp\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a2744efd5cf43b6d40d61ea66f7f620d3}{tcp}};\ } -\DoxyCodeLine{00114\ \ \ \ \ \mbox{\hyperlink{unionciot__wifi__data__u}{ciot\_wifi\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_ac06a3086376da2d8a84120762824336c}{wifi}};\ } -\DoxyCodeLine{00115\ \ \ \ \ \mbox{\hyperlink{unionciot__ble__data__u}{ciot\_ble\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a8c90dd3961baa84d90870ce1f180006d}{ble}};\ } -\DoxyCodeLine{00116\ \ \ \ \ \mbox{\hyperlink{unionciot__ble__scn__data__u}{ciot\_ble\_scn\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a30ef17c042c5a942dc6491370179966c}{ble\_scn}};\ } -\DoxyCodeLine{00117\ \ \ \ \ \mbox{\hyperlink{unionciot__ntp__data__u}{ciot\_ntp\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a562d7a6cdd9053ec0bf7431017972903}{ntp}};\ } -\DoxyCodeLine{00118\ \ \ \ \ \mbox{\hyperlink{unionciot__ota__data__u}{ciot\_ota\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a466cfd56b729d0efcfa70cff1a8b7b85}{ota}};\ } -\DoxyCodeLine{00119\ \ \ \ \ \mbox{\hyperlink{unionciot__dfu__data__u}{ciot\_dfu\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a818d9af5834bb69bdafd6513ae494405}{dfu}};\ } -\DoxyCodeLine{00120\ \ \ \ \ \mbox{\hyperlink{unionciot__https__data__u}{ciot\_https\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a6a8bc746dffc95f0f7b3c468023e10ae}{https}};\ } -\DoxyCodeLine{00121\ \ \ \ \ \mbox{\hyperlink{unionciot__httpc__data__u}{ciot\_httpc\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a7d6cac53c9bf51f572908dc2a5b383f0}{httpc}};\ } -\DoxyCodeLine{00122\ \ \ \ \ \mbox{\hyperlink{unionciot__mqttc__data__u}{ciot\_mqttc\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a57eed7a24887f5d1adba0df0ca8f29f5}{mqtt}};\ } -\DoxyCodeLine{00123\ \ \ \ \ \mbox{\hyperlink{unionciot__bridge__data__u}{ciot\_bridge\_data\_u}}\ \mbox{\hyperlink{unionciot__msg__data__u_a2f12825330d395d82f01240cf84e6328}{bridge}};\ } -\DoxyCodeLine{00124\ \ \ \ \ \mbox{\hyperlink{structciot__msg__error__t}{ciot\_msg\_error\_t}}\ \mbox{\hyperlink{unionciot__msg__data__u_a460f5e2f775eebdacec0950914ab87a9}{error}};\ } -\DoxyCodeLine{00125\ \ \ \ \ uint8\_t\ payload[256];\ } -\DoxyCodeLine{00126\ \}\ \mbox{\hyperlink{unionciot__msg__data__u}{ciot\_msg\_data\_u}};} -\DoxyCodeLine{00127\ } -\DoxyCodeLine{00131\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00132\ \{} -\DoxyCodeLine{00133\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__msg__header__t_a1e6927fa1486224044e568f9c370519b}{id}};\ } -\DoxyCodeLine{00134\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\_msg\_type\_t}}\ \mbox{\hyperlink{structciot__msg__header__t_ac3305f4a165c4d898ce7988191102e46}{type}};\ } -\DoxyCodeLine{00135\ \ \ \ \ \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\_msg\_iface\_info\_t}}\ \mbox{\hyperlink{structciot__msg__header__t_a3501e3667f1031fb2f00b333b7b2269a}{iface}};\ } -\DoxyCodeLine{00136\ \}\ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}};} -\DoxyCodeLine{00137\ } -\DoxyCodeLine{00141\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00142\ \{} -\DoxyCodeLine{00143\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__msg__t_a1e6927fa1486224044e568f9c370519b}{id}};\ } -\DoxyCodeLine{00144\ \ \ \ \ \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\_msg\_type\_t}}\ \mbox{\hyperlink{structciot__msg__t_ac3305f4a165c4d898ce7988191102e46}{type}};\ } -\DoxyCodeLine{00145\ \ \ \ \ \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\_msg\_iface\_info\_t}}\ \mbox{\hyperlink{structciot__msg__t_a3501e3667f1031fb2f00b333b7b2269a}{iface}};\ } -\DoxyCodeLine{00146\ \ \ \ \ \mbox{\hyperlink{unionciot__msg__data__u}{ciot\_msg\_data\_u}}\ \mbox{\hyperlink{structciot__msg__t_ac498d2909bc3de66ee0b1a597fa8e0b6}{data}};\ } -\DoxyCodeLine{00147\ \}\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}};} -\DoxyCodeLine{00148\ } -\DoxyCodeLine{00154\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\mbox{\hyperlink{ciot__msg__types_8h_ad74fa5c942e63dc4c806fbfd6414db45}{ciot\_msg\_type\_to\_str}}(\mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg);} -\DoxyCodeLine{00155\ } -\DoxyCodeLine{00156\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00157\ \}} -\DoxyCodeLine{00158\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00159\ } -\DoxyCodeLine{00160\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__nrf__dfu_8h.tex b/docs/latex/ciot__nrf__dfu_8h.tex deleted file mode 100644 index 7c3cb78..0000000 --- a/docs/latex/ciot__nrf__dfu_8h.tex +++ /dev/null @@ -1,739 +0,0 @@ -\doxysection{include/ciot\+\_\+nrf\+\_\+dfu.h File Reference} -\hypertarget{ciot__nrf__dfu_8h}{}\label{ciot__nrf__dfu_8h}\index{include/ciot\_nrf\_dfu.h@{include/ciot\_nrf\_dfu.h}} - - -Header file for CIOT Nordic DFU functionality. - - -{\ttfamily \#include "{}ciot\+\_\+dfu.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Nordic DFU packet. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__nrf__dfu__cfg}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Nordic DFU configuration. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__nrf__dfu_8h_a907d5c29f7ee7e98e90243fa4f9b6caf}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+TIMEOUT\+\_\+\+SEC}}~2 -\begin{DoxyCompactList}\small\item\em Timeout value in seconds for CIOT Nordic DFU. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__nrf__dfu_8h_a47e67583a19bb09b121e5f710d019c65}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+MAX\+\_\+\+DFU\+\_\+\+PKT\+\_\+\+LEN\+\_\+\+UART}}~64 -\begin{DoxyCompactList}\small\item\em Maximum packet length for DFU over UART. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__nrf__dfu_8h_a7f9149227c077569702eec2a6bf10eb0}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+MAX\+\_\+\+DFU\+\_\+\+PKT\+\_\+\+LEN\+\_\+\+BLE}}~20 -\begin{DoxyCompactList}\small\item\em Maximum packet length for DFU over BLE. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type}} \mbox{\hyperlink{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU packet types. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22f}{ciot\+\_\+nrf\+\_\+dfu\+\_\+op}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a76d2a2022825679c72f023ccc3419ec0}{ciot\+\_\+nrf\+\_\+dfu\+\_\+op\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU operations. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbb}{ciot\+\_\+nrf\+\_\+dfu\+\_\+result}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a0ef11c38f41f3f2cdcafe8fb6b87f862}{ciot\+\_\+nrf\+\_\+dfu\+\_\+result\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU results. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876}{ciot\+\_\+nrf\+\_\+dfu\+\_\+ext\+\_\+error\+\_\+code}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a15b30f8e9e3796c5d5ada153348a36ab}{ciot\+\_\+nrf\+\_\+dfu\+\_\+ext\+\_\+error\+\_\+code\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU extended error codes. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU states. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Nordic DFU packet. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__nrf__dfu__cfg}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg}} \mbox{\hyperlink{ciot__nrf__dfu_8h_af6665b1af9b889771ac694b094584274}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Nordic DFU configuration. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type}} \{ \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a58dd6cb15eff5a9634ae0673debae2ab}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+PACKET\+\_\+\+TYPE\+\_\+\+INIT}} = 0x01 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a5ecc108cbe6e0d67b52aa89d30e6536a}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+PACKET\+\_\+\+TYPE\+\_\+\+APP\+\_\+\+IMAGE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU packet types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22f}{ciot\+\_\+nrf\+\_\+dfu\+\_\+op}} \{ \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa66b58d6f2457c551911bf581b0b597f5}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+PROTOCOL\+\_\+\+VERSION}} = 0x00 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa949711c2a53bb4f5a0e95ede57961de5}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+CREATE}} = 0x01 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa441ab25d1d04a7731c0f5e4ce4aa4c3d}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+RECEIPT\+\_\+\+NOTIF\+\_\+\+SET}} = 0x02 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa0be8dfd4a9a263aaff04bf4286adf485}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+CRC\+\_\+\+GET}} = 0x03 -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22facefebfaa540776ef026faf8ffd1d6f2c}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+EXECUTE}} = 0x04 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa34e5ddf70ff4473417abfaf2fcca9b37}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+SELECT}} = 0x06 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa7ebc56e7820cd05d85a8be13ded4be67}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+MTU\+\_\+\+GET}} = 0x07 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa8d93489a0a27db77cbb426eec1575e43}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+WRITE}} = 0x08 -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa306c499e291f73d904669d4f5b452484}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+PING}} = 0x09 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa59921b1894fcdfe66347bea3b54e4e04}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+HARDWARE\+\_\+\+VERSION}} = 0x0A -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa6b6934d66b625e1c35b38924626024c6}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+FIRMWARE\+\_\+\+VERSION}} = 0x0B -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa11aec25a50a4001a3a7d1f5e2eea38b2}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+ABORT}} = 0x0C -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa384c95064568d91872ccdff4a60ed61a}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+RESPONSE}} = 0x60 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fac60c573eb055a584d3a2d6a9d81409b3}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+SLIP\+\_\+\+PACKET\+\_\+\+END}} = 0x\+C0 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22faa86c9874390b6aed30bfb676c780361a}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+INVALID}} = 0x\+FF - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU operations. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbb}{ciot\+\_\+nrf\+\_\+dfu\+\_\+result}} \{ \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba5363aba557b0d617d6b8c3d3ca2284ca}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INVALID}} = 0x00 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba535936d5b4b584ad7bb8a7af9e5552bc}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+SUCCESS}} = 0x01 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaba90277ffa964d5019755f287e8df8e4}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+OP\+\_\+\+CODE\+\_\+\+NOT\+\_\+\+SUPPORTED}} = 0x02 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbab2a095ee2dfb1a01af69266390eab21c}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INVALID\+\_\+\+PARAMETER}} = 0x03 -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba06f56145d9f3ef38be063e323c4bc33c}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INSUFFICIENT\+\_\+\+RESOURCES}} = 0x04 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba799c1d5ee8dd5574537b167e98499f16}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INVALID\+\_\+\+OBJECT}} = 0x05 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba916e351ddf13637d5dfe6c79cd2982bd}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+UNSUPPORTED\+\_\+\+TYPE}} = 0x07 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba8ae66ea17e57737330c6dbb4e4d28b69}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+OPERATION\+\_\+\+NOT\+\_\+\+PERMITTED}} = 0x08 -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbae028cd46f32cc471013710a10b1748eb}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+OPERATION\+\_\+\+FAILED}} = 0x0A -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaf20b2768859408e961a888aae72e4f83}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+EXT\+\_\+\+ERROR}} = 0x0B - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU results. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876}{ciot\+\_\+nrf\+\_\+dfu\+\_\+ext\+\_\+error\+\_\+code}} \{ \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876acd7fa6a508c1e3839856c82ebdfc617d}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+NO\+\_\+\+ERROR}} = 0x00 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ae9642fdf6a86410f790f975077d92f8f}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+INVALID\+\_\+\+ERROR\+\_\+\+CODE}} = 0x01 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a2189d8a473d22eed4eeb95cab818dbfc}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+WRONG\+\_\+\+COMMAND\+\_\+\+FORMAT}} = 0x02 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a889fcdbcd2b35b8363e5b4fcb3c68135}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+UNKNOWN\+\_\+\+COMMAND}} = 0x03 -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876aa1444e9416d8c46a6bee2f8af10a847e}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+INIT\+\_\+\+COMMAND\+\_\+\+INVALID}} = 0x04 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a6c02c9ae073844a47747ce63fa3d7130}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+FW\+\_\+\+VERSION\+\_\+\+FAILURE}} = 0x05 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a8774f8de1e6fe337794f1dd01c1372f2}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+HW\+\_\+\+VERSION\+\_\+\+FAILURE}} = 0x06 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a9d52a14d24c2c26773961819baac956d}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+SD\+\_\+\+VERSION\+\_\+\+FAILURE}} = 0x07 -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a44ad275bc794402797d4b8149eadaaa9}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+SIGNATURE\+\_\+\+MISSING}} = 0x08 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ad03f610f0b797c20379f644792d86c08}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+WRONG\+\_\+\+HASH\+\_\+\+TYPE}} = 0x09 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a7bf63807b9f68dd5b74e6ec16c4e92ee}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+HASH\+\_\+\+FAILED}} = 0x0A -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a94fbaa466d441666a84115b95711d334}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+WRONG\+\_\+\+SIGNATURE\+\_\+\+TYPE}} = 0x0B -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a4511b180056f03eb9a6d793540fc7950}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+VERIFICATION\+\_\+\+FAILED}} = 0x0C -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a1b058729e996daf5b636d9e1466196b7}{NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+INSUFFICIENT\+\_\+\+SPACE}} = 0x0D - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU extended error codes. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state}} \{ \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a60afa6e95e03b21559f0579ee7b69b04}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6455d3c1186b42c96b1f97827e71342f}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a21b7dbe1f859ebdefdbbac5b77930071}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+SEND\+\_\+\+PING}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3af5045df1247bf3563ed125171405b002}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+PING\+\_\+\+RESP}} -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6b0e0c732f0b02958aa9d9d3055ecd16}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+CREATE\+\_\+\+OBJECT}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3ad8fa89ee49d7550f5f3a49e62e86aa1c}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+CREATE\+\_\+\+OBJ}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aea9a7ecc2182f03fa6bf8ac79eb770b3}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WRITE\+\_\+\+DFU\+\_\+\+PACKAGE}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aa1b1df86ff85c29f399dc91451405784}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+REQUEST\+\_\+\+CRC}} -, \newline -\mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3abe14f277137dda905fcd4e5c798c132f}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+CRC}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a0b97b26322ad79bd6d3a725b8eef32b4}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+REQUEST\+\_\+\+EXECUTE}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3acac843800e7d29923bdc6189822bbb29}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+EXECUTE}} -, \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a445a16b5b89db0c852dc48bc92096b58}{CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+COMPLETED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Nordic DFU states. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_aad325ff49e9a727535ba2245af2896f3}{ciot\+\_\+nrf\+\_\+dfu\+\_\+new}} (\mbox{\hyperlink{ciot__nrf__dfu_8h_af6665b1af9b889771ac694b094584274}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Create a new CIOT Nordic DFU instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_ade8e82ea98fd5f89242d3a38effba293}{ciot\+\_\+nrf\+\_\+dfu\+\_\+start}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self, \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start CIOT Nordic DFU. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a890127344062271c54ecddd1391c80c3}{ciot\+\_\+nrf\+\_\+dfu\+\_\+stop}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop CIOT Nordic DFU. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a470062374eb38631c7bf20f148011ede}{ciot\+\_\+nrf\+\_\+dfu\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self, \mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process DFU request for CIOT Nordic DFU. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_afcbdb54986436cb9fdf421ba8f50f077}{ciot\+\_\+nrf\+\_\+dfu\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data for CIOT Nordic DFU. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_aac67be0b79a25d514bb05ccf1622c07e}{ciot\+\_\+nrf\+\_\+dfu\+\_\+task}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Perform CIOT Nordic DFU task. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_af56db9aade46e176e0e286382ca04f7c}{ciot\+\_\+nrf\+\_\+dfu\+\_\+send\+\_\+firmware}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Send firmware for CIOT Nordic DFU. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_af751feb3c4ee63d05fe6dc1b2c591d4e}{ciot\+\_\+nrf\+\_\+dfu\+\_\+read\+\_\+file}} (\mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}} \texorpdfstring{$\ast$}{*}object, const char \texorpdfstring{$\ast$}{*}name) -\begin{DoxyCompactList}\small\item\em Read file for CIOT Nordic DFU. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a818286457b301b0a341208839ade9a90}{ciot\+\_\+nrf\+\_\+dfu\+\_\+start\+\_\+bootloader}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self, \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}iface, int sys\+\_\+id) -\begin{DoxyCompactList}\small\item\em Start bootloader for CIOT Nordic DFU. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_aee5e7944d29dc3c5a75706fa4b45cc35}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state}} (\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Get the state of CIOT Nordic DFU. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT Nordic DFU functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/18 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__nrf__dfu_8h_a7f9149227c077569702eec2a6bf10eb0}\label{ciot__nrf__dfu_8h_a7f9149227c077569702eec2a6bf10eb0} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_BLE@{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_BLE}} -\index{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_BLE@{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_BLE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_BLE}{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_BLE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+MAX\+\_\+\+DFU\+\_\+\+PKT\+\_\+\+LEN\+\_\+\+BLE~20} - - - -Maximum packet length for DFU over BLE. - -\Hypertarget{ciot__nrf__dfu_8h_a47e67583a19bb09b121e5f710d019c65}\label{ciot__nrf__dfu_8h_a47e67583a19bb09b121e5f710d019c65} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_UART@{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_UART}} -\index{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_UART@{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_UART}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_UART}{CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_UART}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+MAX\+\_\+\+DFU\+\_\+\+PKT\+\_\+\+LEN\+\_\+\+UART~64} - - - -Maximum packet length for DFU over UART. - -\Hypertarget{ciot__nrf__dfu_8h_a907d5c29f7ee7e98e90243fa4f9b6caf}\label{ciot__nrf__dfu_8h_a907d5c29f7ee7e98e90243fa4f9b6caf} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_TIMEOUT\_SEC@{CIOT\_NRF\_DFU\_TIMEOUT\_SEC}} -\index{CIOT\_NRF\_DFU\_TIMEOUT\_SEC@{CIOT\_NRF\_DFU\_TIMEOUT\_SEC}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_NRF\_DFU\_TIMEOUT\_SEC}{CIOT\_NRF\_DFU\_TIMEOUT\_SEC}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+TIMEOUT\+\_\+\+SEC~2} - - - -Timeout value in seconds for CIOT Nordic DFU. - - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__nrf__dfu_8h_af6665b1af9b889771ac694b094584274}\label{ciot__nrf__dfu_8h_af6665b1af9b889771ac694b094584274} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_cfg\_t@{ciot\_nrf\_dfu\_cfg\_t}} -\index{ciot\_nrf\_dfu\_cfg\_t@{ciot\_nrf\_dfu\_cfg\_t}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_cfg\_t}{ciot\_nrf\_dfu\_cfg\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__nrf__dfu__cfg}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg}} \mbox{\hyperlink{ciot__nrf__dfu_8h_af6665b1af9b889771ac694b094584274}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg\+\_\+t}}} - - - -Structure for CIOT Nordic DFU configuration. - -\Hypertarget{ciot__nrf__dfu_8h_a15b30f8e9e3796c5d5ada153348a36ab}\label{ciot__nrf__dfu_8h_a15b30f8e9e3796c5d5ada153348a36ab} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_ext\_error\_code\_t@{ciot\_nrf\_dfu\_ext\_error\_code\_t}} -\index{ciot\_nrf\_dfu\_ext\_error\_code\_t@{ciot\_nrf\_dfu\_ext\_error\_code\_t}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_ext\_error\_code\_t}{ciot\_nrf\_dfu\_ext\_error\_code\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876}{ciot\+\_\+nrf\+\_\+dfu\+\_\+ext\+\_\+error\+\_\+code}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a15b30f8e9e3796c5d5ada153348a36ab}{ciot\+\_\+nrf\+\_\+dfu\+\_\+ext\+\_\+error\+\_\+code\+\_\+t}}} - - - -Enumeration for CIOT Nordic DFU extended error codes. - -\Hypertarget{ciot__nrf__dfu_8h_a76d2a2022825679c72f023ccc3419ec0}\label{ciot__nrf__dfu_8h_a76d2a2022825679c72f023ccc3419ec0} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_op\_t@{ciot\_nrf\_dfu\_op\_t}} -\index{ciot\_nrf\_dfu\_op\_t@{ciot\_nrf\_dfu\_op\_t}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_op\_t}{ciot\_nrf\_dfu\_op\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22f}{ciot\+\_\+nrf\+\_\+dfu\+\_\+op}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a76d2a2022825679c72f023ccc3419ec0}{ciot\+\_\+nrf\+\_\+dfu\+\_\+op\+\_\+t}}} - - - -Enumeration for CIOT Nordic DFU operations. - -\Hypertarget{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}\label{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_packet\_t@{ciot\_nrf\_dfu\_packet\_t}} -\index{ciot\_nrf\_dfu\_packet\_t@{ciot\_nrf\_dfu\_packet\_t}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_packet\_t}{ciot\_nrf\_dfu\_packet\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}}} - - - -Structure for CIOT Nordic DFU packet. - -\Hypertarget{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0}\label{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_packet\_type\_t@{ciot\_nrf\_dfu\_packet\_type\_t}} -\index{ciot\_nrf\_dfu\_packet\_type\_t@{ciot\_nrf\_dfu\_packet\_type\_t}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_packet\_type\_t}{ciot\_nrf\_dfu\_packet\_type\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type}} \mbox{\hyperlink{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT Nordic DFU packet types. - -\Hypertarget{ciot__nrf__dfu_8h_a0ef11c38f41f3f2cdcafe8fb6b87f862}\label{ciot__nrf__dfu_8h_a0ef11c38f41f3f2cdcafe8fb6b87f862} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_result\_t@{ciot\_nrf\_dfu\_result\_t}} -\index{ciot\_nrf\_dfu\_result\_t@{ciot\_nrf\_dfu\_result\_t}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_result\_t}{ciot\_nrf\_dfu\_result\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbb}{ciot\+\_\+nrf\+\_\+dfu\+\_\+result}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a0ef11c38f41f3f2cdcafe8fb6b87f862}{ciot\+\_\+nrf\+\_\+dfu\+\_\+result\+\_\+t}}} - - - -Enumeration for CIOT Nordic DFU results. - -\Hypertarget{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9}\label{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_state\_t@{ciot\_nrf\_dfu\_state\_t}} -\index{ciot\_nrf\_dfu\_state\_t@{ciot\_nrf\_dfu\_state\_t}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_state\_t}{ciot\_nrf\_dfu\_state\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT Nordic DFU states. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_ext\_error\_code@{ciot\_nrf\_dfu\_ext\_error\_code}} -\index{ciot\_nrf\_dfu\_ext\_error\_code@{ciot\_nrf\_dfu\_ext\_error\_code}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_ext\_error\_code}{ciot\_nrf\_dfu\_ext\_error\_code}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876}{ciot\+\_\+nrf\+\_\+dfu\+\_\+ext\+\_\+error\+\_\+code}}} - - - -Enumeration for CIOT Nordic DFU extended error codes. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_NO\_ERROR@{NRF\_DFU\_EXT\_ERROR\_NO\_ERROR}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_NO\_ERROR@{NRF\_DFU\_EXT\_ERROR\_NO\_ERROR}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876acd7fa6a508c1e3839856c82ebdfc617d}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876acd7fa6a508c1e3839856c82ebdfc617d} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+NO\+\_\+\+ERROR&No extended error code set. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_INVALID\_ERROR\_CODE@{NRF\_DFU\_EXT\_ERROR\_INVALID\_ERROR\_CODE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_INVALID\_ERROR\_CODE@{NRF\_DFU\_EXT\_ERROR\_INVALID\_ERROR\_CODE}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ae9642fdf6a86410f790f975077d92f8f}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ae9642fdf6a86410f790f975077d92f8f} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+INVALID\+\_\+\+ERROR\+\_\+\+CODE&Invalid error code. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_WRONG\_COMMAND\_FORMAT@{NRF\_DFU\_EXT\_ERROR\_WRONG\_COMMAND\_FORMAT}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_WRONG\_COMMAND\_FORMAT@{NRF\_DFU\_EXT\_ERROR\_WRONG\_COMMAND\_FORMAT}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a2189d8a473d22eed4eeb95cab818dbfc}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a2189d8a473d22eed4eeb95cab818dbfc} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+WRONG\+\_\+\+COMMAND\+\_\+\+FORMAT&Incorrect command format. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_UNKNOWN\_COMMAND@{NRF\_DFU\_EXT\_ERROR\_UNKNOWN\_COMMAND}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_UNKNOWN\_COMMAND@{NRF\_DFU\_EXT\_ERROR\_UNKNOWN\_COMMAND}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a889fcdbcd2b35b8363e5b4fcb3c68135}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a889fcdbcd2b35b8363e5b4fcb3c68135} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+UNKNOWN\+\_\+\+COMMAND&Unknown or unsupported command. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_INIT\_COMMAND\_INVALID@{NRF\_DFU\_EXT\_ERROR\_INIT\_COMMAND\_INVALID}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_INIT\_COMMAND\_INVALID@{NRF\_DFU\_EXT\_ERROR\_INIT\_COMMAND\_INVALID}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876aa1444e9416d8c46a6bee2f8af10a847e}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876aa1444e9416d8c46a6bee2f8af10a847e} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+INIT\+\_\+\+COMMAND\+\_\+\+INVALID&Invalid init command or missing fields. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_FW\_VERSION\_FAILURE@{NRF\_DFU\_EXT\_ERROR\_FW\_VERSION\_FAILURE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_FW\_VERSION\_FAILURE@{NRF\_DFU\_EXT\_ERROR\_FW\_VERSION\_FAILURE}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a6c02c9ae073844a47747ce63fa3d7130}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a6c02c9ae073844a47747ce63fa3d7130} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+FW\+\_\+\+VERSION\+\_\+\+FAILURE&Firmware version too low. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_HW\_VERSION\_FAILURE@{NRF\_DFU\_EXT\_ERROR\_HW\_VERSION\_FAILURE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_HW\_VERSION\_FAILURE@{NRF\_DFU\_EXT\_ERROR\_HW\_VERSION\_FAILURE}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a8774f8de1e6fe337794f1dd01c1372f2}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a8774f8de1e6fe337794f1dd01c1372f2} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+HW\+\_\+\+VERSION\+\_\+\+FAILURE&Hardware version mismatch. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_SD\_VERSION\_FAILURE@{NRF\_DFU\_EXT\_ERROR\_SD\_VERSION\_FAILURE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_SD\_VERSION\_FAILURE@{NRF\_DFU\_EXT\_ERROR\_SD\_VERSION\_FAILURE}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a9d52a14d24c2c26773961819baac956d}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a9d52a14d24c2c26773961819baac956d} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+SD\+\_\+\+VERSION\+\_\+\+FAILURE&Soft\+Device version mismatch. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_SIGNATURE\_MISSING@{NRF\_DFU\_EXT\_ERROR\_SIGNATURE\_MISSING}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_SIGNATURE\_MISSING@{NRF\_DFU\_EXT\_ERROR\_SIGNATURE\_MISSING}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a44ad275bc794402797d4b8149eadaaa9}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a44ad275bc794402797d4b8149eadaaa9} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+SIGNATURE\+\_\+\+MISSING&Signature missing in init packet. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_WRONG\_HASH\_TYPE@{NRF\_DFU\_EXT\_ERROR\_WRONG\_HASH\_TYPE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_WRONG\_HASH\_TYPE@{NRF\_DFU\_EXT\_ERROR\_WRONG\_HASH\_TYPE}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ad03f610f0b797c20379f644792d86c08}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ad03f610f0b797c20379f644792d86c08} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+WRONG\+\_\+\+HASH\+\_\+\+TYPE&Unsupported hash type. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_HASH\_FAILED@{NRF\_DFU\_EXT\_ERROR\_HASH\_FAILED}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_HASH\_FAILED@{NRF\_DFU\_EXT\_ERROR\_HASH\_FAILED}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a7bf63807b9f68dd5b74e6ec16c4e92ee}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a7bf63807b9f68dd5b74e6ec16c4e92ee} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+HASH\+\_\+\+FAILED&Hash calculation failed. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_WRONG\_SIGNATURE\_TYPE@{NRF\_DFU\_EXT\_ERROR\_WRONG\_SIGNATURE\_TYPE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_WRONG\_SIGNATURE\_TYPE@{NRF\_DFU\_EXT\_ERROR\_WRONG\_SIGNATURE\_TYPE}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a94fbaa466d441666a84115b95711d334}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a94fbaa466d441666a84115b95711d334} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+WRONG\+\_\+\+SIGNATURE\+\_\+\+TYPE&Unknown or unsupported signature type. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_VERIFICATION\_FAILED@{NRF\_DFU\_EXT\_ERROR\_VERIFICATION\_FAILED}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_VERIFICATION\_FAILED@{NRF\_DFU\_EXT\_ERROR\_VERIFICATION\_FAILED}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a4511b180056f03eb9a6d793540fc7950}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a4511b180056f03eb9a6d793540fc7950} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+VERIFICATION\+\_\+\+FAILED&Hash verification failed. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{NRF\_DFU\_EXT\_ERROR\_INSUFFICIENT\_SPACE@{NRF\_DFU\_EXT\_ERROR\_INSUFFICIENT\_SPACE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!NRF\_DFU\_EXT\_ERROR\_INSUFFICIENT\_SPACE@{NRF\_DFU\_EXT\_ERROR\_INSUFFICIENT\_SPACE}}}\Hypertarget{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a1b058729e996daf5b636d9e1466196b7}\label{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a1b058729e996daf5b636d9e1466196b7} -NRF\+\_\+\+DFU\+\_\+\+EXT\+\_\+\+ERROR\+\_\+\+INSUFFICIENT\+\_\+\+SPACE&Insufficient space for firmware. \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22f}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22f} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_op@{ciot\_nrf\_dfu\_op}} -\index{ciot\_nrf\_dfu\_op@{ciot\_nrf\_dfu\_op}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_op}{ciot\_nrf\_dfu\_op}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22f}{ciot\+\_\+nrf\+\_\+dfu\+\_\+op}}} - - - -Enumeration for CIOT Nordic DFU operations. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_PROTOCOL\_VERSION@{CIOT\_NRF\_DFU\_OP\_PROTOCOL\_VERSION}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_PROTOCOL\_VERSION@{CIOT\_NRF\_DFU\_OP\_PROTOCOL\_VERSION}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa66b58d6f2457c551911bf581b0b597f5}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa66b58d6f2457c551911bf581b0b597f5} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+PROTOCOL\+\_\+\+VERSION&Retrieve protocol version. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_OBJECT\_CREATE@{CIOT\_NRF\_DFU\_OP\_OBJECT\_CREATE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_OBJECT\_CREATE@{CIOT\_NRF\_DFU\_OP\_OBJECT\_CREATE}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa949711c2a53bb4f5a0e95ede57961de5}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa949711c2a53bb4f5a0e95ede57961de5} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+CREATE&Create selected object. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_RECEIPT\_NOTIF\_SET@{CIOT\_NRF\_DFU\_OP\_RECEIPT\_NOTIF\_SET}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_RECEIPT\_NOTIF\_SET@{CIOT\_NRF\_DFU\_OP\_RECEIPT\_NOTIF\_SET}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa441ab25d1d04a7731c0f5e4ce4aa4c3d}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa441ab25d1d04a7731c0f5e4ce4aa4c3d} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+RECEIPT\+\_\+\+NOTIF\+\_\+\+SET&Set receipt notification. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_CRC\_GET@{CIOT\_NRF\_DFU\_OP\_CRC\_GET}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_CRC\_GET@{CIOT\_NRF\_DFU\_OP\_CRC\_GET}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa0be8dfd4a9a263aaff04bf4286adf485}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa0be8dfd4a9a263aaff04bf4286adf485} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+CRC\+\_\+\+GET&Request CRC of selected object. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_OBJECT\_EXECUTE@{CIOT\_NRF\_DFU\_OP\_OBJECT\_EXECUTE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_OBJECT\_EXECUTE@{CIOT\_NRF\_DFU\_OP\_OBJECT\_EXECUTE}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22facefebfaa540776ef026faf8ffd1d6f2c}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22facefebfaa540776ef026faf8ffd1d6f2c} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+EXECUTE&Execute selected object. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_OBJECT\_SELECT@{CIOT\_NRF\_DFU\_OP\_OBJECT\_SELECT}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_OBJECT\_SELECT@{CIOT\_NRF\_DFU\_OP\_OBJECT\_SELECT}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa34e5ddf70ff4473417abfaf2fcca9b37}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa34e5ddf70ff4473417abfaf2fcca9b37} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+SELECT&Select object. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_MTU\_GET@{CIOT\_NRF\_DFU\_OP\_MTU\_GET}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_MTU\_GET@{CIOT\_NRF\_DFU\_OP\_MTU\_GET}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa7ebc56e7820cd05d85a8be13ded4be67}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa7ebc56e7820cd05d85a8be13ded4be67} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+MTU\+\_\+\+GET&Retrieve MTU size. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_OBJECT\_WRITE@{CIOT\_NRF\_DFU\_OP\_OBJECT\_WRITE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_OBJECT\_WRITE@{CIOT\_NRF\_DFU\_OP\_OBJECT\_WRITE}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa8d93489a0a27db77cbb426eec1575e43}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa8d93489a0a27db77cbb426eec1575e43} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+OBJECT\+\_\+\+WRITE&Write selected object. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_PING@{CIOT\_NRF\_DFU\_OP\_PING}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_PING@{CIOT\_NRF\_DFU\_OP\_PING}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa306c499e291f73d904669d4f5b452484}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa306c499e291f73d904669d4f5b452484} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+PING&Ping. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_HARDWARE\_VERSION@{CIOT\_NRF\_DFU\_OP\_HARDWARE\_VERSION}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_HARDWARE\_VERSION@{CIOT\_NRF\_DFU\_OP\_HARDWARE\_VERSION}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa59921b1894fcdfe66347bea3b54e4e04}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa59921b1894fcdfe66347bea3b54e4e04} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+HARDWARE\+\_\+\+VERSION&Retrieve hardware version. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_FIRMWARE\_VERSION@{CIOT\_NRF\_DFU\_OP\_FIRMWARE\_VERSION}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_FIRMWARE\_VERSION@{CIOT\_NRF\_DFU\_OP\_FIRMWARE\_VERSION}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa6b6934d66b625e1c35b38924626024c6}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa6b6934d66b625e1c35b38924626024c6} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+FIRMWARE\+\_\+\+VERSION&Retrieve firmware version. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_ABORT@{CIOT\_NRF\_DFU\_OP\_ABORT}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_ABORT@{CIOT\_NRF\_DFU\_OP\_ABORT}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa11aec25a50a4001a3a7d1f5e2eea38b2}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa11aec25a50a4001a3a7d1f5e2eea38b2} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+ABORT&Abort the DFU procedure. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_RESPONSE@{CIOT\_NRF\_DFU\_OP\_RESPONSE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_RESPONSE@{CIOT\_NRF\_DFU\_OP\_RESPONSE}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa384c95064568d91872ccdff4a60ed61a}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa384c95064568d91872ccdff4a60ed61a} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+RESPONSE&Response. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_SLIP\_PACKET\_END@{CIOT\_NRF\_DFU\_OP\_SLIP\_PACKET\_END}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_SLIP\_PACKET\_END@{CIOT\_NRF\_DFU\_OP\_SLIP\_PACKET\_END}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fac60c573eb055a584d3a2d6a9d81409b3}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fac60c573eb055a584d3a2d6a9d81409b3} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+SLIP\+\_\+\+PACKET\+\_\+\+END&Slip end of packet. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_OP\_INVALID@{CIOT\_NRF\_DFU\_OP\_INVALID}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_OP\_INVALID@{CIOT\_NRF\_DFU\_OP\_INVALID}}}\Hypertarget{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22faa86c9874390b6aed30bfb676c780361a}\label{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22faa86c9874390b6aed30bfb676c780361a} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+OP\+\_\+\+INVALID&Invalid request. \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06}\label{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_packet\_type@{ciot\_nrf\_dfu\_packet\_type}} -\index{ciot\_nrf\_dfu\_packet\_type@{ciot\_nrf\_dfu\_packet\_type}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_packet\_type}{ciot\_nrf\_dfu\_packet\_type}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type}}} - - - -Enumeration for CIOT Nordic DFU packet types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_PACKET\_TYPE\_INIT@{CIOT\_NRF\_DFU\_PACKET\_TYPE\_INIT}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_PACKET\_TYPE\_INIT@{CIOT\_NRF\_DFU\_PACKET\_TYPE\_INIT}}}\Hypertarget{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a58dd6cb15eff5a9634ae0673debae2ab}\label{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a58dd6cb15eff5a9634ae0673debae2ab} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+PACKET\+\_\+\+TYPE\+\_\+\+INIT&DFU initialization packet type. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_PACKET\_TYPE\_APP\_IMAGE@{CIOT\_NRF\_DFU\_PACKET\_TYPE\_APP\_IMAGE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_PACKET\_TYPE\_APP\_IMAGE@{CIOT\_NRF\_DFU\_PACKET\_TYPE\_APP\_IMAGE}}}\Hypertarget{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a5ecc108cbe6e0d67b52aa89d30e6536a}\label{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a5ecc108cbe6e0d67b52aa89d30e6536a} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+PACKET\+\_\+\+TYPE\+\_\+\+APP\+\_\+\+IMAGE&DFU application image packet type. \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbb}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbb} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_result@{ciot\_nrf\_dfu\_result}} -\index{ciot\_nrf\_dfu\_result@{ciot\_nrf\_dfu\_result}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_result}{ciot\_nrf\_dfu\_result}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbb}{ciot\+\_\+nrf\+\_\+dfu\+\_\+result}}} - - - -Enumeration for CIOT Nordic DFU results. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID@{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_INVALID@{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba5363aba557b0d617d6b8c3d3ca2284ca}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba5363aba557b0d617d6b8c3d3ca2284ca} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INVALID&Invalid opcode. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_SUCCESS@{CIOT\_NRF\_DFU\_RES\_CODE\_SUCCESS}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_SUCCESS@{CIOT\_NRF\_DFU\_RES\_CODE\_SUCCESS}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba535936d5b4b584ad7bb8a7af9e5552bc}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba535936d5b4b584ad7bb8a7af9e5552bc} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+SUCCESS&Operation successful. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_OP\_CODE\_NOT\_SUPPORTED@{CIOT\_NRF\_DFU\_RES\_CODE\_OP\_CODE\_NOT\_SUPPORTED}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_OP\_CODE\_NOT\_SUPPORTED@{CIOT\_NRF\_DFU\_RES\_CODE\_OP\_CODE\_NOT\_SUPPORTED}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaba90277ffa964d5019755f287e8df8e4}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaba90277ffa964d5019755f287e8df8e4} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+OP\+\_\+\+CODE\+\_\+\+NOT\+\_\+\+SUPPORTED&Opcode not supported. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_PARAMETER@{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_PARAMETER}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_PARAMETER@{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_PARAMETER}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbab2a095ee2dfb1a01af69266390eab21c}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbab2a095ee2dfb1a01af69266390eab21c} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INVALID\+\_\+\+PARAMETER&Missing or invalid parameter value. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_INSUFFICIENT\_RESOURCES@{CIOT\_NRF\_DFU\_RES\_CODE\_INSUFFICIENT\_RESOURCES}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_INSUFFICIENT\_RESOURCES@{CIOT\_NRF\_DFU\_RES\_CODE\_INSUFFICIENT\_RESOURCES}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba06f56145d9f3ef38be063e323c4bc33c}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba06f56145d9f3ef38be063e323c4bc33c} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INSUFFICIENT\+\_\+\+RESOURCES&Not enough memory for the data object. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_OBJECT@{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_OBJECT}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_OBJECT@{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_OBJECT}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba799c1d5ee8dd5574537b167e98499f16}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba799c1d5ee8dd5574537b167e98499f16} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+INVALID\+\_\+\+OBJECT&Data object does not match firmware and hardware requirements, wrong signature, or parsing failure. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_UNSUPPORTED\_TYPE@{CIOT\_NRF\_DFU\_RES\_CODE\_UNSUPPORTED\_TYPE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_UNSUPPORTED\_TYPE@{CIOT\_NRF\_DFU\_RES\_CODE\_UNSUPPORTED\_TYPE}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba916e351ddf13637d5dfe6c79cd2982bd}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba916e351ddf13637d5dfe6c79cd2982bd} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+UNSUPPORTED\+\_\+\+TYPE&Not a valid object type for Create request. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_NOT\_PERMITTED@{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_NOT\_PERMITTED}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_NOT\_PERMITTED@{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_NOT\_PERMITTED}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba8ae66ea17e57737330c6dbb4e4d28b69}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba8ae66ea17e57737330c6dbb4e4d28b69} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+OPERATION\+\_\+\+NOT\+\_\+\+PERMITTED&DFU process state does not allow this operation. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_FAILED@{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_FAILED}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_FAILED@{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_FAILED}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbae028cd46f32cc471013710a10b1748eb}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbae028cd46f32cc471013710a10b1748eb} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+OPERATION\+\_\+\+FAILED&Operation failed. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_RES\_CODE\_EXT\_ERROR@{CIOT\_NRF\_DFU\_RES\_CODE\_EXT\_ERROR}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_RES\_CODE\_EXT\_ERROR@{CIOT\_NRF\_DFU\_RES\_CODE\_EXT\_ERROR}}}\Hypertarget{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaf20b2768859408e961a888aae72e4f83}\label{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaf20b2768859408e961a888aae72e4f83} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+RES\+\_\+\+CODE\+\_\+\+EXT\+\_\+\+ERROR&Extended error. See nrf\+\_\+dfu\+\_\+ext\+\_\+error\+\_\+code\+\_\+t. \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_state@{ciot\_nrf\_dfu\_state}} -\index{ciot\_nrf\_dfu\_state@{ciot\_nrf\_dfu\_state}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_state}{ciot\_nrf\_dfu\_state}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state}}} - - - -Enumeration for CIOT Nordic DFU states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_ERROR@{CIOT\_NRF\_DFU\_STATE\_ERROR}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_ERROR@{CIOT\_NRF\_DFU\_STATE\_ERROR}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a60afa6e95e03b21559f0579ee7b69b04}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a60afa6e95e03b21559f0579ee7b69b04} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+ERROR&Error state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_IDLE@{CIOT\_NRF\_DFU\_STATE\_IDLE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_IDLE@{CIOT\_NRF\_DFU\_STATE\_IDLE}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6455d3c1186b42c96b1f97827e71342f}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6455d3c1186b42c96b1f97827e71342f} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+IDLE&Idle state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_SEND\_PING@{CIOT\_NRF\_DFU\_STATE\_SEND\_PING}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_SEND\_PING@{CIOT\_NRF\_DFU\_STATE\_SEND\_PING}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a21b7dbe1f859ebdefdbbac5b77930071}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a21b7dbe1f859ebdefdbbac5b77930071} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+SEND\+\_\+\+PING&Sending ping state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_WAITING\_PING\_RESP@{CIOT\_NRF\_DFU\_STATE\_WAITING\_PING\_RESP}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_WAITING\_PING\_RESP@{CIOT\_NRF\_DFU\_STATE\_WAITING\_PING\_RESP}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3af5045df1247bf3563ed125171405b002}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3af5045df1247bf3563ed125171405b002} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+PING\+\_\+\+RESP&Waiting for ping response state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_CREATE\_OBJECT@{CIOT\_NRF\_DFU\_STATE\_CREATE\_OBJECT}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_CREATE\_OBJECT@{CIOT\_NRF\_DFU\_STATE\_CREATE\_OBJECT}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6b0e0c732f0b02958aa9d9d3055ecd16}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6b0e0c732f0b02958aa9d9d3055ecd16} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+CREATE\+\_\+\+OBJECT&Creating object state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_WAITING\_CREATE\_OBJ@{CIOT\_NRF\_DFU\_STATE\_WAITING\_CREATE\_OBJ}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_WAITING\_CREATE\_OBJ@{CIOT\_NRF\_DFU\_STATE\_WAITING\_CREATE\_OBJ}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3ad8fa89ee49d7550f5f3a49e62e86aa1c}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3ad8fa89ee49d7550f5f3a49e62e86aa1c} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+CREATE\+\_\+\+OBJ&Waiting for object creation state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_WRITE\_DFU\_PACKAGE@{CIOT\_NRF\_DFU\_STATE\_WRITE\_DFU\_PACKAGE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_WRITE\_DFU\_PACKAGE@{CIOT\_NRF\_DFU\_STATE\_WRITE\_DFU\_PACKAGE}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aea9a7ecc2182f03fa6bf8ac79eb770b3}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aea9a7ecc2182f03fa6bf8ac79eb770b3} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WRITE\+\_\+\+DFU\+\_\+\+PACKAGE&Writing DFU package state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_REQUEST\_CRC@{CIOT\_NRF\_DFU\_STATE\_REQUEST\_CRC}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_REQUEST\_CRC@{CIOT\_NRF\_DFU\_STATE\_REQUEST\_CRC}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aa1b1df86ff85c29f399dc91451405784}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aa1b1df86ff85c29f399dc91451405784} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+REQUEST\+\_\+\+CRC&Requesting CRC state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_WAITING\_CRC@{CIOT\_NRF\_DFU\_STATE\_WAITING\_CRC}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_WAITING\_CRC@{CIOT\_NRF\_DFU\_STATE\_WAITING\_CRC}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3abe14f277137dda905fcd4e5c798c132f}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3abe14f277137dda905fcd4e5c798c132f} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+CRC&Waiting for CRC state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_REQUEST\_EXECUTE@{CIOT\_NRF\_DFU\_STATE\_REQUEST\_EXECUTE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_REQUEST\_EXECUTE@{CIOT\_NRF\_DFU\_STATE\_REQUEST\_EXECUTE}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a0b97b26322ad79bd6d3a725b8eef32b4}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a0b97b26322ad79bd6d3a725b8eef32b4} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+REQUEST\+\_\+\+EXECUTE&Requesting execute state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_WAITING\_EXECUTE@{CIOT\_NRF\_DFU\_STATE\_WAITING\_EXECUTE}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_WAITING\_EXECUTE@{CIOT\_NRF\_DFU\_STATE\_WAITING\_EXECUTE}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3acac843800e7d29923bdc6189822bbb29}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3acac843800e7d29923bdc6189822bbb29} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+WAITING\+\_\+\+EXECUTE&Waiting for execute state. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NRF\_DFU\_STATE\_COMPLETED@{CIOT\_NRF\_DFU\_STATE\_COMPLETED}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}}\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!CIOT\_NRF\_DFU\_STATE\_COMPLETED@{CIOT\_NRF\_DFU\_STATE\_COMPLETED}}}\Hypertarget{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a445a16b5b89db0c852dc48bc92096b58}\label{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a445a16b5b89db0c852dc48bc92096b58} -CIOT\+\_\+\+NRF\+\_\+\+DFU\+\_\+\+STATE\+\_\+\+COMPLETED&Completed state. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__nrf__dfu_8h_aad325ff49e9a727535ba2245af2896f3}\label{ciot__nrf__dfu_8h_aad325ff49e9a727535ba2245af2896f3} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_new@{ciot\_nrf\_dfu\_new}} -\index{ciot\_nrf\_dfu\_new@{ciot\_nrf\_dfu\_new}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_new()}{ciot\_nrf\_dfu\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+new (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__nrf__dfu_8h_af6665b1af9b889771ac694b094584274}{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Create a new CIOT Nordic DFU instance. - - -\begin{DoxyParams}{Parameters} -{\em cfg} & Pointer to the configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Instance of CIOT DFU. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_a470062374eb38631c7bf20f148011ede}\label{ciot__nrf__dfu_8h_a470062374eb38631c7bf20f148011ede} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_process\_req@{ciot\_nrf\_dfu\_process\_req}} -\index{ciot\_nrf\_dfu\_process\_req@{ciot\_nrf\_dfu\_process\_req}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_process\_req()}{ciot\_nrf\_dfu\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process DFU request for CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -{\em req} & DFU request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_af751feb3c4ee63d05fe6dc1b2c591d4e}\label{ciot__nrf__dfu_8h_af751feb3c4ee63d05fe6dc1b2c591d4e} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_read\_file@{ciot\_nrf\_dfu\_read\_file}} -\index{ciot\_nrf\_dfu\_read\_file@{ciot\_nrf\_dfu\_read\_file}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_read\_file()}{ciot\_nrf\_dfu\_read\_file()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+read\+\_\+file (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{object, }\item[{const char \texorpdfstring{$\ast$}{*}}]{name }\end{DoxyParamCaption})} - - - -Read file for CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em object} & Object to read into. \\ -\hline -{\em name} & Name of the file. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_afcbdb54986436cb9fdf421ba8f50f077}\label{ciot__nrf__dfu_8h_afcbdb54986436cb9fdf421ba8f50f077} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_send\_data@{ciot\_nrf\_dfu\_send\_data}} -\index{ciot\_nrf\_dfu\_send\_data@{ciot\_nrf\_dfu\_send\_data}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_send\_data()}{ciot\_nrf\_dfu\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data for CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -{\em data} & Data to send. \\ -\hline -{\em size} & Size of data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_af56db9aade46e176e0e286382ca04f7c}\label{ciot__nrf__dfu_8h_af56db9aade46e176e0e286382ca04f7c} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_send\_firmware@{ciot\_nrf\_dfu\_send\_firmware}} -\index{ciot\_nrf\_dfu\_send\_firmware@{ciot\_nrf\_dfu\_send\_firmware}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_send\_firmware()}{ciot\_nrf\_dfu\_send\_firmware()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+send\+\_\+firmware (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Send firmware for CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_ade8e82ea98fd5f89242d3a38effba293}\label{ciot__nrf__dfu_8h_ade8e82ea98fd5f89242d3a38effba293} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_start@{ciot\_nrf\_dfu\_start}} -\index{ciot\_nrf\_dfu\_start@{ciot\_nrf\_dfu\_start}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_start()}{ciot\_nrf\_dfu\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -{\em cfg} & Configuration for DFU. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_a818286457b301b0a341208839ade9a90}\label{ciot__nrf__dfu_8h_a818286457b301b0a341208839ade9a90} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_start\_bootloader@{ciot\_nrf\_dfu\_start\_bootloader}} -\index{ciot\_nrf\_dfu\_start\_bootloader@{ciot\_nrf\_dfu\_start\_bootloader}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_start\_bootloader()}{ciot\_nrf\_dfu\_start\_bootloader()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+start\+\_\+bootloader (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{iface, }\item[{int}]{sys\+\_\+id }\end{DoxyParamCaption})} - - - -Start bootloader for CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -{\em iface} & Interface pointer. \\ -\hline -{\em sys\+\_\+id} & System ID. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_aee5e7944d29dc3c5a75706fa4b45cc35}\label{ciot__nrf__dfu_8h_aee5e7944d29dc3c5a75706fa4b45cc35} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_state@{ciot\_nrf\_dfu\_state}} -\index{ciot\_nrf\_dfu\_state@{ciot\_nrf\_dfu\_state}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_state()}{ciot\_nrf\_dfu\_state()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state\+\_\+t}} \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}{ciot\+\_\+nrf\+\_\+dfu\+\_\+state}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Get the state of CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -State of DFU. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_a890127344062271c54ecddd1391c80c3}\label{ciot__nrf__dfu_8h_a890127344062271c54ecddd1391c80c3} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_stop@{ciot\_nrf\_dfu\_stop}} -\index{ciot\_nrf\_dfu\_stop@{ciot\_nrf\_dfu\_stop}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_stop()}{ciot\_nrf\_dfu\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop CIOT Nordic DFU. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__nrf__dfu_8h_aac67be0b79a25d514bb05ccf1622c07e}\label{ciot__nrf__dfu_8h_aac67be0b79a25d514bb05ccf1622c07e} -\index{ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}!ciot\_nrf\_dfu\_task@{ciot\_nrf\_dfu\_task}} -\index{ciot\_nrf\_dfu\_task@{ciot\_nrf\_dfu\_task}!ciot\_nrf\_dfu.h@{ciot\_nrf\_dfu.h}} -\doxysubsubsection{\texorpdfstring{ciot\_nrf\_dfu\_task()}{ciot\_nrf\_dfu\_task()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+nrf\+\_\+dfu\+\_\+task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\+\_\+dfu\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Perform CIOT Nordic DFU task. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT DFU. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} diff --git a/docs/latex/ciot__nrf__dfu_8h_source.tex b/docs/latex/ciot__nrf__dfu_8h_source.tex deleted file mode 100644 index 2c52f27..0000000 --- a/docs/latex/ciot__nrf__dfu_8h_source.tex +++ /dev/null @@ -1,129 +0,0 @@ -\doxysection{ciot\+\_\+nrf\+\_\+dfu.\+h} -\hypertarget{ciot__nrf__dfu_8h_source}{}\label{ciot__nrf__dfu_8h_source}\index{include/ciot\_nrf\_dfu.h@{include/ciot\_nrf\_dfu.h}} -\mbox{\hyperlink{ciot__nrf__dfu_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_NRF\_DFU\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_NRF\_DFU\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__dfu_8h}{ciot\_dfu.h}}"{}}} -\DoxyCodeLine{00015\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#define\ CIOT\_NRF\_DFU\_TIMEOUT\_SEC\ 2}} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#define\ CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_UART\ 64}} -\DoxyCodeLine{00025\ } -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#define\ CIOT\_NRF\_DFU\_MAX\_DFU\_PKT\_LEN\_BLE\ 20}} -\DoxyCodeLine{00030\ } -\DoxyCodeLine{00034\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06}{ciot\_nrf\_dfu\_packet\_type}}} -\DoxyCodeLine{00035\ \{} -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a58dd6cb15eff5a9634ae0673debae2ab}{CIOT\_NRF\_DFU\_PACKET\_TYPE\_INIT}}\ =\ 0x01,\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_ab974f696095f5fdfd9a2bf98983ddc06a5ecc108cbe6e0d67b52aa89d30e6536a}{CIOT\_NRF\_DFU\_PACKET\_TYPE\_APP\_IMAGE}},\ } -\DoxyCodeLine{00038\ \}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0}{ciot\_nrf\_dfu\_packet\_type\_t}};} -\DoxyCodeLine{00039\ } -\DoxyCodeLine{00043\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22f}{ciot\_nrf\_dfu\_op}}} -\DoxyCodeLine{00044\ \{} -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa66b58d6f2457c551911bf581b0b597f5}{CIOT\_NRF\_DFU\_OP\_PROTOCOL\_VERSION}}\ =\ 0x00,\ \ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa949711c2a53bb4f5a0e95ede57961de5}{CIOT\_NRF\_DFU\_OP\_OBJECT\_CREATE}}\ =\ 0x01,\ \ \ \ \ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa441ab25d1d04a7731c0f5e4ce4aa4c3d}{CIOT\_NRF\_DFU\_OP\_RECEIPT\_NOTIF\_SET}}\ =\ 0x02,\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa0be8dfd4a9a263aaff04bf4286adf485}{CIOT\_NRF\_DFU\_OP\_CRC\_GET}}\ =\ 0x03,\ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00049\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22facefebfaa540776ef026faf8ffd1d6f2c}{CIOT\_NRF\_DFU\_OP\_OBJECT\_EXECUTE}}\ =\ 0x04,\ \ \ \ } -\DoxyCodeLine{00050\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa34e5ddf70ff4473417abfaf2fcca9b37}{CIOT\_NRF\_DFU\_OP\_OBJECT\_SELECT}}\ =\ 0x06,\ \ \ \ \ } -\DoxyCodeLine{00051\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa7ebc56e7820cd05d85a8be13ded4be67}{CIOT\_NRF\_DFU\_OP\_MTU\_GET}}\ =\ 0x07,\ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00052\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa8d93489a0a27db77cbb426eec1575e43}{CIOT\_NRF\_DFU\_OP\_OBJECT\_WRITE}}\ =\ 0x08,\ \ \ \ \ \ } -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa306c499e291f73d904669d4f5b452484}{CIOT\_NRF\_DFU\_OP\_PING}}\ =\ 0x09,\ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00054\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa59921b1894fcdfe66347bea3b54e4e04}{CIOT\_NRF\_DFU\_OP\_HARDWARE\_VERSION}}\ =\ 0x0A,\ \ } -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa6b6934d66b625e1c35b38924626024c6}{CIOT\_NRF\_DFU\_OP\_FIRMWARE\_VERSION}}\ =\ 0x0B,\ \ } -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa11aec25a50a4001a3a7d1f5e2eea38b2}{CIOT\_NRF\_DFU\_OP\_ABORT}}\ =\ 0x0C,\ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00057\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fa384c95064568d91872ccdff4a60ed61a}{CIOT\_NRF\_DFU\_OP\_RESPONSE}}\ =\ 0x60,\ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00058\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22fac60c573eb055a584d3a2d6a9d81409b3}{CIOT\_NRF\_DFU\_OP\_SLIP\_PACKET\_END}}\ =\ 0xC0,\ \ \ } -\DoxyCodeLine{00059\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a2abe0b961d351c9d48e8ccd6b703c22faa86c9874390b6aed30bfb676c780361a}{CIOT\_NRF\_DFU\_OP\_INVALID}}\ =\ 0xFF,\ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00060\ \}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a76d2a2022825679c72f023ccc3419ec0}{ciot\_nrf\_dfu\_op\_t}};} -\DoxyCodeLine{00061\ } -\DoxyCodeLine{00065\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbb}{ciot\_nrf\_dfu\_result}}} -\DoxyCodeLine{00066\ \{} -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba5363aba557b0d617d6b8c3d3ca2284ca}{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID}}\ =\ 0x00,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba535936d5b4b584ad7bb8a7af9e5552bc}{CIOT\_NRF\_DFU\_RES\_CODE\_SUCCESS}}\ =\ 0x01,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00069\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaba90277ffa964d5019755f287e8df8e4}{CIOT\_NRF\_DFU\_RES\_CODE\_OP\_CODE\_NOT\_SUPPORTED}}\ =\ 0x02,\ \ \ } -\DoxyCodeLine{00070\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbab2a095ee2dfb1a01af69266390eab21c}{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_PARAMETER}}\ =\ 0x03,\ \ \ \ \ \ \ } -\DoxyCodeLine{00071\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba06f56145d9f3ef38be063e323c4bc33c}{CIOT\_NRF\_DFU\_RES\_CODE\_INSUFFICIENT\_RESOURCES}}\ =\ 0x04,\ \ } -\DoxyCodeLine{00072\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba799c1d5ee8dd5574537b167e98499f16}{CIOT\_NRF\_DFU\_RES\_CODE\_INVALID\_OBJECT}}\ =\ 0x05,\ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00073\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba916e351ddf13637d5dfe6c79cd2982bd}{CIOT\_NRF\_DFU\_RES\_CODE\_UNSUPPORTED\_TYPE}}\ =\ 0x07,\ \ \ \ \ \ \ \ } -\DoxyCodeLine{00074\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbba8ae66ea17e57737330c6dbb4e4d28b69}{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_NOT\_PERMITTED}}\ =\ 0x08,\ } -\DoxyCodeLine{00075\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbae028cd46f32cc471013710a10b1748eb}{CIOT\_NRF\_DFU\_RES\_CODE\_OPERATION\_FAILED}}\ =\ 0x0A,\ \ \ \ \ \ \ \ } -\DoxyCodeLine{00076\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a1fe3f84c3a3765c0c4138d0423e09dbbaf20b2768859408e961a888aae72e4f83}{CIOT\_NRF\_DFU\_RES\_CODE\_EXT\_ERROR}}\ =\ 0x0B,\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00077\ \}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a0ef11c38f41f3f2cdcafe8fb6b87f862}{ciot\_nrf\_dfu\_result\_t}};} -\DoxyCodeLine{00078\ } -\DoxyCodeLine{00082\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876}{ciot\_nrf\_dfu\_ext\_error\_code}}} -\DoxyCodeLine{00083\ \{} -\DoxyCodeLine{00084\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876acd7fa6a508c1e3839856c82ebdfc617d}{NRF\_DFU\_EXT\_ERROR\_NO\_ERROR}}\ =\ 0x00,\ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00085\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ae9642fdf6a86410f790f975077d92f8f}{NRF\_DFU\_EXT\_ERROR\_INVALID\_ERROR\_CODE}}\ =\ 0x01,\ \ \ } -\DoxyCodeLine{00086\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a2189d8a473d22eed4eeb95cab818dbfc}{NRF\_DFU\_EXT\_ERROR\_WRONG\_COMMAND\_FORMAT}}\ =\ 0x02,\ } -\DoxyCodeLine{00087\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a889fcdbcd2b35b8363e5b4fcb3c68135}{NRF\_DFU\_EXT\_ERROR\_UNKNOWN\_COMMAND}}\ =\ 0x03,\ \ \ \ \ \ } -\DoxyCodeLine{00088\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876aa1444e9416d8c46a6bee2f8af10a847e}{NRF\_DFU\_EXT\_ERROR\_INIT\_COMMAND\_INVALID}}\ =\ 0x04,\ } -\DoxyCodeLine{00089\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a6c02c9ae073844a47747ce63fa3d7130}{NRF\_DFU\_EXT\_ERROR\_FW\_VERSION\_FAILURE}}\ =\ 0x05,\ \ \ } -\DoxyCodeLine{00090\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a8774f8de1e6fe337794f1dd01c1372f2}{NRF\_DFU\_EXT\_ERROR\_HW\_VERSION\_FAILURE}}\ =\ 0x06,\ \ \ } -\DoxyCodeLine{00091\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a9d52a14d24c2c26773961819baac956d}{NRF\_DFU\_EXT\_ERROR\_SD\_VERSION\_FAILURE}}\ =\ 0x07,\ \ \ } -\DoxyCodeLine{00092\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a44ad275bc794402797d4b8149eadaaa9}{NRF\_DFU\_EXT\_ERROR\_SIGNATURE\_MISSING}}\ =\ 0x08,\ \ \ \ } -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876ad03f610f0b797c20379f644792d86c08}{NRF\_DFU\_EXT\_ERROR\_WRONG\_HASH\_TYPE}}\ =\ 0x09,\ \ \ \ \ \ } -\DoxyCodeLine{00094\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a7bf63807b9f68dd5b74e6ec16c4e92ee}{NRF\_DFU\_EXT\_ERROR\_HASH\_FAILED}}\ =\ 0x0A,\ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00095\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a94fbaa466d441666a84115b95711d334}{NRF\_DFU\_EXT\_ERROR\_WRONG\_SIGNATURE\_TYPE}}\ =\ 0x0B,\ } -\DoxyCodeLine{00096\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a4511b180056f03eb9a6d793540fc7950}{NRF\_DFU\_EXT\_ERROR\_VERIFICATION\_FAILED}}\ =\ 0x0C,\ \ } -\DoxyCodeLine{00097\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a9b1886dcffda4260c62de821ec13d876a1b058729e996daf5b636d9e1466196b7}{NRF\_DFU\_EXT\_ERROR\_INSUFFICIENT\_SPACE}}\ =\ 0x0D,\ \ \ } -\DoxyCodeLine{00098\ \}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a15b30f8e9e3796c5d5ada153348a36ab}{ciot\_nrf\_dfu\_ext\_error\_code\_t}};} -\DoxyCodeLine{00099\ } -\DoxyCodeLine{00103\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}{ciot\_nrf\_dfu\_state}}} -\DoxyCodeLine{00104\ \{} -\DoxyCodeLine{00105\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a60afa6e95e03b21559f0579ee7b69b04}{CIOT\_NRF\_DFU\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00106\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6455d3c1186b42c96b1f97827e71342f}{CIOT\_NRF\_DFU\_STATE\_IDLE}},\ } -\DoxyCodeLine{00107\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a21b7dbe1f859ebdefdbbac5b77930071}{CIOT\_NRF\_DFU\_STATE\_SEND\_PING}},\ } -\DoxyCodeLine{00108\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3af5045df1247bf3563ed125171405b002}{CIOT\_NRF\_DFU\_STATE\_WAITING\_PING\_RESP}},\ } -\DoxyCodeLine{00109\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a6b0e0c732f0b02958aa9d9d3055ecd16}{CIOT\_NRF\_DFU\_STATE\_CREATE\_OBJECT}},\ } -\DoxyCodeLine{00110\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3ad8fa89ee49d7550f5f3a49e62e86aa1c}{CIOT\_NRF\_DFU\_STATE\_WAITING\_CREATE\_OBJ}},\ } -\DoxyCodeLine{00111\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aea9a7ecc2182f03fa6bf8ac79eb770b3}{CIOT\_NRF\_DFU\_STATE\_WRITE\_DFU\_PACKAGE}},\ } -\DoxyCodeLine{00112\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3aa1b1df86ff85c29f399dc91451405784}{CIOT\_NRF\_DFU\_STATE\_REQUEST\_CRC}},\ } -\DoxyCodeLine{00113\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3abe14f277137dda905fcd4e5c798c132f}{CIOT\_NRF\_DFU\_STATE\_WAITING\_CRC}},\ } -\DoxyCodeLine{00114\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a0b97b26322ad79bd6d3a725b8eef32b4}{CIOT\_NRF\_DFU\_STATE\_REQUEST\_EXECUTE}},\ } -\DoxyCodeLine{00115\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3acac843800e7d29923bdc6189822bbb29}{CIOT\_NRF\_DFU\_STATE\_WAITING\_EXECUTE}},\ } -\DoxyCodeLine{00116\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3a445a16b5b89db0c852dc48bc92096b58}{CIOT\_NRF\_DFU\_STATE\_COMPLETED}},\ } -\DoxyCodeLine{00117\ \}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9}{ciot\_nrf\_dfu\_state\_t}};} -\DoxyCodeLine{00118\ } -\DoxyCodeLine{00122\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\_nrf\_dfu\_packet}}} -\DoxyCodeLine{00123\ \{} -\DoxyCodeLine{00124\ \ \ \ \ \mbox{\hyperlink{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0}{ciot\_nrf\_dfu\_packet\_type\_t}}\ \mbox{\hyperlink{structciot__nrf__dfu__packet_a50c8cebed3105b196315a23d0634f1a5}{type}};\ } -\DoxyCodeLine{00125\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__nrf__dfu__packet_ab2c6b258f02add8fdf4cfc7c371dd772}{size}};\ } -\DoxyCodeLine{00126\ \ \ \ \ uint8\_t\ *\mbox{\hyperlink{structciot__nrf__dfu__packet_abe222f6d3581e7920dcad5306cc906a8}{data}};\ } -\DoxyCodeLine{00127\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structciot__nrf__dfu__packet_a3e7bef03191254ebdc38d44d1c2dad91}{transferred}};\ } -\DoxyCodeLine{00128\ \}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\_nrf\_dfu\_packet\_t}};} -\DoxyCodeLine{00129\ } -\DoxyCodeLine{00133\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__nrf__dfu__cfg}{ciot\_nrf\_dfu\_cfg}}} -\DoxyCodeLine{00134\ \{} -\DoxyCodeLine{00135\ \ \ \ \ \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\_dfu\_cfg\_t}}\ \mbox{\hyperlink{structciot__nrf__dfu__cfg_a6c2ee01676a3fac944277ac66f411267}{dfu}};\ } -\DoxyCodeLine{00136\ \ \ \ \ \mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\_nrf\_dfu\_packet\_t}}\ \mbox{\hyperlink{structciot__nrf__dfu__cfg_a795b5a3aa5d9214e635ad47549f52f15}{init\_packet}};\ } -\DoxyCodeLine{00137\ \ \ \ \ \mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\_nrf\_dfu\_packet\_t}}\ \mbox{\hyperlink{structciot__nrf__dfu__cfg_a22016a576f391282c8806fc79a64b1f2}{app\_image}};\ } -\DoxyCodeLine{00138\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__nrf__dfu__cfg_a9e30754c48462959a3efdef7ac582744}{max\_package\_len}};\ } -\DoxyCodeLine{00139\ \ \ \ \ \mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *\mbox{\hyperlink{structciot__nrf__dfu__cfg_add0d24e0065c33f7e1da60ac94e6988b}{iface}};\ } -\DoxyCodeLine{00140\ \}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_af6665b1af9b889771ac694b094584274}{ciot\_nrf\_dfu\_cfg\_t}};} -\DoxyCodeLine{00141\ } -\DoxyCodeLine{00148\ \mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_aad325ff49e9a727535ba2245af2896f3}{ciot\_nrf\_dfu\_new}}(\mbox{\hyperlink{structciot__nrf__dfu__cfg}{ciot\_nrf\_dfu\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00149\ } -\DoxyCodeLine{00157\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_ade8e82ea98fd5f89242d3a38effba293}{ciot\_nrf\_dfu\_start}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self,\ \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\_dfu\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00158\ } -\DoxyCodeLine{00165\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a890127344062271c54ecddd1391c80c3}{ciot\_nrf\_dfu\_stop}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self);} -\DoxyCodeLine{00166\ } -\DoxyCodeLine{00174\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a470062374eb38631c7bf20f148011ede}{ciot\_nrf\_dfu\_process\_req}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self,\ \mbox{\hyperlink{structciot__dfu__req__t}{ciot\_dfu\_req\_t}}\ *req);} -\DoxyCodeLine{00175\ } -\DoxyCodeLine{00184\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_afcbdb54986436cb9fdf421ba8f50f077}{ciot\_nrf\_dfu\_send\_data}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00185\ } -\DoxyCodeLine{00192\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_aac67be0b79a25d514bb05ccf1622c07e}{ciot\_nrf\_dfu\_task}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self);} -\DoxyCodeLine{00193\ } -\DoxyCodeLine{00200\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_af56db9aade46e176e0e286382ca04f7c}{ciot\_nrf\_dfu\_send\_firmware}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self);} -\DoxyCodeLine{00201\ } -\DoxyCodeLine{00209\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_af751feb3c4ee63d05fe6dc1b2c591d4e}{ciot\_nrf\_dfu\_read\_file}}(\mbox{\hyperlink{structciot__nrf__dfu__packet}{ciot\_nrf\_dfu\_packet\_t}}\ *\textcolor{keywordtype}{object},\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *name);} -\DoxyCodeLine{00210\ } -\DoxyCodeLine{00219\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a818286457b301b0a341208839ade9a90}{ciot\_nrf\_dfu\_start\_bootloader}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self,\ \mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *iface,\ \textcolor{keywordtype}{int}\ sys\_id);} -\DoxyCodeLine{00220\ } -\DoxyCodeLine{00227\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a4ef7cf2448bcedc88f7c278ddb30c9a9}{ciot\_nrf\_dfu\_state\_t}}\ \mbox{\hyperlink{ciot__nrf__dfu_8h_a548699ff1d8ff4bef907d5387fc33af3}{ciot\_nrf\_dfu\_state}}(\mbox{\hyperlink{ciot__dfu_8h_a185c613ee5be1f09245c6f2dcf92d340}{ciot\_dfu\_t}}\ self);} -\DoxyCodeLine{00228\ } -\DoxyCodeLine{00229\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ntp_8h.tex b/docs/latex/ciot__ntp_8h.tex deleted file mode 100644 index d12c682..0000000 --- a/docs/latex/ciot__ntp_8h.tex +++ /dev/null @@ -1,184 +0,0 @@ -\doxysection{include/ciot\+\_\+ntp.h File Reference} -\hypertarget{ciot__ntp_8h}{}\label{ciot__ntp_8h}\index{include/ciot\_ntp.h@{include/ciot\_ntp.h}} - - -Header file for CIOT NTP (Network Time Protocol) functionality. - - -{\ttfamily \#include "{}types/ciot\+\_\+ntp\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ntp__status__msg__t}{ciot\+\_\+ntp\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT NTP status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+ntp \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Opaque pointer to CIOT NTP structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} \mbox{\hyperlink{ciot__ntp_8h_a21060aee75e3e21695cb1b47e9dbbea6}{ciot\+\_\+ntp\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT NTP instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ntp_8h_ab2e49de0c8bc987fcbd6ff97912e9f21}{ciot\+\_\+ntp\+\_\+start}} (\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} self, \mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start CIOT NTP. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ntp_8h_a4c928f5a646bc368a33351c0508e5986}{ciot\+\_\+ntp\+\_\+stop}} (\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop CIOT NTP. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ntp_8h_aba2cd40d3a1923cc1c69ae0784bd6f79}{ciot\+\_\+ntp\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} self, \mbox{\hyperlink{structciot__ntp__req__t}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process NTP request for CIOT NTP. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ntp_8h_a1670e17032214d1a41e0381d2c5844ac}{ciot\+\_\+ntp\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data for CIOT NTP. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ntp_8h_abddacb943d084ba3d40cde58b1da45fc}{ciot\+\_\+ntp\+\_\+set}} (\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} ntp) -\begin{DoxyCompactList}\small\item\em Set CIOT NTP configuration. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT NTP (Network Time Protocol) functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}\label{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e} -\index{ciot\_ntp.h@{ciot\_ntp.h}!ciot\_ntp\_t@{ciot\_ntp\_t}} -\index{ciot\_ntp\_t@{ciot\_ntp\_t}!ciot\_ntp.h@{ciot\_ntp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_t}{ciot\_ntp\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+ntp\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}}} - - - -Opaque pointer to CIOT NTP structure. - - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__ntp_8h_a21060aee75e3e21695cb1b47e9dbbea6}\label{ciot__ntp_8h_a21060aee75e3e21695cb1b47e9dbbea6} -\index{ciot\_ntp.h@{ciot\_ntp.h}!ciot\_ntp\_new@{ciot\_ntp\_new}} -\index{ciot\_ntp\_new@{ciot\_ntp\_new}!ciot\_ntp.h@{ciot\_ntp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_new()}{ciot\_ntp\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} ciot\+\_\+ntp\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT NTP instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Instance of CIOT NTP. -\end{DoxyReturn} -\Hypertarget{ciot__ntp_8h_aba2cd40d3a1923cc1c69ae0784bd6f79}\label{ciot__ntp_8h_aba2cd40d3a1923cc1c69ae0784bd6f79} -\index{ciot\_ntp.h@{ciot\_ntp.h}!ciot\_ntp\_process\_req@{ciot\_ntp\_process\_req}} -\index{ciot\_ntp\_process\_req@{ciot\_ntp\_process\_req}!ciot\_ntp.h@{ciot\_ntp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_process\_req()}{ciot\_ntp\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ntp\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ntp__req__t}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process NTP request for CIOT NTP. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT NTP. \\ -\hline -{\em req} & NTP request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ntp_8h_a1670e17032214d1a41e0381d2c5844ac}\label{ciot__ntp_8h_a1670e17032214d1a41e0381d2c5844ac} -\index{ciot\_ntp.h@{ciot\_ntp.h}!ciot\_ntp\_send\_data@{ciot\_ntp\_send\_data}} -\index{ciot\_ntp\_send\_data@{ciot\_ntp\_send\_data}!ciot\_ntp.h@{ciot\_ntp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_send\_data()}{ciot\_ntp\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ntp\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data for CIOT NTP. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT NTP. \\ -\hline -{\em data} & Data to send. \\ -\hline -{\em size} & Size of data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ntp_8h_abddacb943d084ba3d40cde58b1da45fc}\label{ciot__ntp_8h_abddacb943d084ba3d40cde58b1da45fc} -\index{ciot\_ntp.h@{ciot\_ntp.h}!ciot\_ntp\_set@{ciot\_ntp\_set}} -\index{ciot\_ntp\_set@{ciot\_ntp\_set}!ciot\_ntp.h@{ciot\_ntp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_set()}{ciot\_ntp\_set()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ntp\+\_\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}}}]{ntp }\end{DoxyParamCaption})} - - - -Set CIOT NTP configuration. - - -\begin{DoxyParams}{Parameters} -{\em ntp} & Instance of CIOT NTP. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ntp_8h_ab2e49de0c8bc987fcbd6ff97912e9f21}\label{ciot__ntp_8h_ab2e49de0c8bc987fcbd6ff97912e9f21} -\index{ciot\_ntp.h@{ciot\_ntp.h}!ciot\_ntp\_start@{ciot\_ntp\_start}} -\index{ciot\_ntp\_start@{ciot\_ntp\_start}!ciot\_ntp.h@{ciot\_ntp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_start()}{ciot\_ntp\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ntp\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start CIOT NTP. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT NTP. \\ -\hline -{\em cfg} & Configuration for NTP. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ntp_8h_a4c928f5a646bc368a33351c0508e5986}\label{ciot__ntp_8h_a4c928f5a646bc368a33351c0508e5986} -\index{ciot\_ntp.h@{ciot\_ntp.h}!ciot\_ntp\_stop@{ciot\_ntp\_stop}} -\index{ciot\_ntp\_stop@{ciot\_ntp\_stop}!ciot\_ntp.h@{ciot\_ntp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_stop()}{ciot\_ntp\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ntp\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop CIOT NTP. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT NTP. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} diff --git a/docs/latex/ciot__ntp_8h_source.tex b/docs/latex/ciot__ntp_8h_source.tex deleted file mode 100644 index c9d69dd..0000000 --- a/docs/latex/ciot__ntp_8h_source.tex +++ /dev/null @@ -1,43 +0,0 @@ -\doxysection{ciot\+\_\+ntp.\+h} -\hypertarget{ciot__ntp_8h_source}{}\label{ciot__ntp_8h_source}\index{include/ciot\_ntp.h@{include/ciot\_ntp.h}} -\mbox{\hyperlink{ciot__ntp_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_NTP\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_NTP\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ntp__types_8h}{types/ciot\_ntp\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_ntp\ *\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00031\ \{} -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__ntp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00033\ \ \ \ \ \mbox{\hyperlink{structciot__ntp__status__t}{ciot\_ntp\_status\_t}}\ \mbox{\hyperlink{structciot__ntp__status__msg__t_a95d5fa474c00a79ee883e78048ea7c4c}{status}};\ } -\DoxyCodeLine{00034\ \}\ \mbox{\hyperlink{structciot__ntp__status__msg__t}{ciot\_ntp\_status\_msg\_t}};} -\DoxyCodeLine{00035\ } -\DoxyCodeLine{00042\ \mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}}\ \mbox{\hyperlink{ciot__ntp_8h_a21060aee75e3e21695cb1b47e9dbbea6}{ciot\_ntp\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00043\ } -\DoxyCodeLine{00051\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ntp_8h_ab2e49de0c8bc987fcbd6ff97912e9f21}{ciot\_ntp\_start}}(\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}}\ self,\ \mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\_ntp\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00052\ } -\DoxyCodeLine{00059\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ntp_8h_a4c928f5a646bc368a33351c0508e5986}{ciot\_ntp\_stop}}(\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}}\ self);} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00068\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ntp_8h_aba2cd40d3a1923cc1c69ae0784bd6f79}{ciot\_ntp\_process\_req}}(\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}}\ self,\ \mbox{\hyperlink{structciot__ntp__req__t}{ciot\_ntp\_req\_t}}\ *req);} -\DoxyCodeLine{00069\ } -\DoxyCodeLine{00078\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ntp_8h_a1670e17032214d1a41e0381d2c5844ac}{ciot\_ntp\_send\_data}}(\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00079\ } -\DoxyCodeLine{00086\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ntp_8h_abddacb943d084ba3d40cde58b1da45fc}{ciot\_ntp\_set}}(\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\_ntp\_t}}\ ntp);} -\DoxyCodeLine{00087\ } -\DoxyCodeLine{00088\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00089\ \}} -\DoxyCodeLine{00090\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00091\ } -\DoxyCodeLine{00092\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ntp__types_8h.tex b/docs/latex/ciot__ntp__types_8h.tex deleted file mode 100644 index cc75cd0..0000000 --- a/docs/latex/ciot__ntp__types_8h.tex +++ /dev/null @@ -1,108 +0,0 @@ -\doxysection{include/types/ciot\+\_\+ntp\+\_\+types.h File Reference} -\hypertarget{ciot__ntp__types_8h}{}\label{ciot__ntp__types_8h}\index{include/types/ciot\_ntp\_types.h@{include/types/ciot\_ntp\_types.h}} - - -Defines data types and structures for CIOT NTP functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include $<$time.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+config.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT NTP configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ntp__status__t}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT NTP status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ntp__req__data__u}{ciot\+\_\+ntp\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT NTP request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ntp__req__t}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT NTP request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ntp__data__u}{ciot\+\_\+ntp\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT NTP data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__ntp__types_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT}}~0 -\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8}{ciot\+\_\+ntp\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a4c64b5cfa4f3a03f7292079ecef99611}{HG\+\_\+\+NTP\+\_\+\+STATE\+\_\+\+RESET}} -, \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a6c5c848eb0bd58b8638046ab9a655fc2}{HG\+\_\+\+NTP\+\_\+\+STATE\+\_\+\+COMPLETED}} -, \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8aab0cb2237b349602daf7dc3a5bba18ca}{HG\+\_\+\+NTP\+\_\+\+STATE\+\_\+\+IN\+\_\+\+PROGRESS}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT NTP state. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa}{ciot\+\_\+ntp\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861faa4ef58072669af9e608f808ad52143129}{CIOT\+\_\+\+NTP\+\_\+\+REQ\+\_\+\+UNKNOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT NTP request type. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT NTP functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/18 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__ntp__types_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}\label{ciot__ntp__types_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf} -\index{ciot\_ntp\_types.h@{ciot\_ntp\_types.h}!CIOT\_CONFIG\_NTP\_SERVERS\_COUNT@{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}} -\index{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT@{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}!ciot\_ntp\_types.h@{ciot\_ntp\_types.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT~0} - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa}\label{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa} -\index{ciot\_ntp\_types.h@{ciot\_ntp\_types.h}!ciot\_ntp\_req\_type\_t@{ciot\_ntp\_req\_type\_t}} -\index{ciot\_ntp\_req\_type\_t@{ciot\_ntp\_req\_type\_t}!ciot\_ntp\_types.h@{ciot\_ntp\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_req\_type\_t}{ciot\_ntp\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa}{ciot\+\_\+ntp\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT NTP request type. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_NTP\_REQ\_UNKNOWN@{CIOT\_NTP\_REQ\_UNKNOWN}!ciot\_ntp\_types.h@{ciot\_ntp\_types.h}}\index{ciot\_ntp\_types.h@{ciot\_ntp\_types.h}!CIOT\_NTP\_REQ\_UNKNOWN@{CIOT\_NTP\_REQ\_UNKNOWN}}}\Hypertarget{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861faa4ef58072669af9e608f808ad52143129}\label{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861faa4ef58072669af9e608f808ad52143129} -CIOT\+\_\+\+NTP\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown NTP request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8}\label{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8} -\index{ciot\_ntp\_types.h@{ciot\_ntp\_types.h}!ciot\_ntp\_state\_t@{ciot\_ntp\_state\_t}} -\index{ciot\_ntp\_state\_t@{ciot\_ntp\_state\_t}!ciot\_ntp\_types.h@{ciot\_ntp\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ntp\_state\_t}{ciot\_ntp\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8}{ciot\+\_\+ntp\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT NTP state. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{HG\_NTP\_STATE\_RESET@{HG\_NTP\_STATE\_RESET}!ciot\_ntp\_types.h@{ciot\_ntp\_types.h}}\index{ciot\_ntp\_types.h@{ciot\_ntp\_types.h}!HG\_NTP\_STATE\_RESET@{HG\_NTP\_STATE\_RESET}}}\Hypertarget{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a4c64b5cfa4f3a03f7292079ecef99611}\label{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a4c64b5cfa4f3a03f7292079ecef99611} -HG\+\_\+\+NTP\+\_\+\+STATE\+\_\+\+RESET&NTP state\+: reset \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{HG\_NTP\_STATE\_COMPLETED@{HG\_NTP\_STATE\_COMPLETED}!ciot\_ntp\_types.h@{ciot\_ntp\_types.h}}\index{ciot\_ntp\_types.h@{ciot\_ntp\_types.h}!HG\_NTP\_STATE\_COMPLETED@{HG\_NTP\_STATE\_COMPLETED}}}\Hypertarget{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a6c5c848eb0bd58b8638046ab9a655fc2}\label{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a6c5c848eb0bd58b8638046ab9a655fc2} -HG\+\_\+\+NTP\+\_\+\+STATE\+\_\+\+COMPLETED&NTP state\+: completed \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{HG\_NTP\_STATE\_IN\_PROGRESS@{HG\_NTP\_STATE\_IN\_PROGRESS}!ciot\_ntp\_types.h@{ciot\_ntp\_types.h}}\index{ciot\_ntp\_types.h@{ciot\_ntp\_types.h}!HG\_NTP\_STATE\_IN\_PROGRESS@{HG\_NTP\_STATE\_IN\_PROGRESS}}}\Hypertarget{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8aab0cb2237b349602daf7dc3a5bba18ca}\label{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8aab0cb2237b349602daf7dc3a5bba18ca} -HG\+\_\+\+NTP\+\_\+\+STATE\+\_\+\+IN\+\_\+\+PROGRESS&NTP state\+: in progress \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__ntp__types_8h_source.tex b/docs/latex/ciot__ntp__types_8h_source.tex deleted file mode 100644 index b4a45f5..0000000 --- a/docs/latex/ciot__ntp__types_8h_source.tex +++ /dev/null @@ -1,77 +0,0 @@ -\doxysection{ciot\+\_\+ntp\+\_\+types.\+h} -\hypertarget{ciot__ntp__types_8h_source}{}\label{ciot__ntp__types_8h_source}\index{include/types/ciot\_ntp\_types.h@{include/types/ciot\_ntp\_types.h}} -\mbox{\hyperlink{ciot__ntp__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_NTP\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_NTP\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__config_8h}{ciot\_config.h}}"{}}} -\DoxyCodeLine{00022\ } -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_NTP\_SERVERS\_COUNT\ 0}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00031\ \{} -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a4c64b5cfa4f3a03f7292079ecef99611}{HG\_NTP\_STATE\_RESET}},\ } -\DoxyCodeLine{00033\ \ \ \ \ \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8a6c5c848eb0bd58b8638046ab9a655fc2}{HG\_NTP\_STATE\_COMPLETED}},\ } -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8aab0cb2237b349602daf7dc3a5bba18ca}{HG\_NTP\_STATE\_IN\_PROGRESS}},\ } -\DoxyCodeLine{00035\ \}\ \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8}{ciot\_ntp\_state\_t}};} -\DoxyCodeLine{00036\ } -\DoxyCodeLine{00040\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00041\ \{} -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861faa4ef58072669af9e608f808ad52143129}{CIOT\_NTP\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00043\ \}\ \mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa}{ciot\_ntp\_req\_type\_t}};} -\DoxyCodeLine{00044\ } -\DoxyCodeLine{00048\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00049\ \{} -\DoxyCodeLine{00050\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ntp__cfg__t_aec948fb30e99b1eda7e3d9ff741d417a}{op\_mode}};\ } -\DoxyCodeLine{00051\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ntp__cfg__t_ac752937b32320cf191fe3abd0e8daed6}{sync\_mode}};\ } -\DoxyCodeLine{00052\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__ntp__cfg__t_a5150de065f0b170644b21514c7530542}{sync\_interval}};\ } -\DoxyCodeLine{00053\ \ \ \ \ \textcolor{keywordtype}{char}\ timezone[16];\ } -\DoxyCodeLine{00054\ \ \ \ \ \textcolor{keywordtype}{char}\ server[\mbox{\hyperlink{ciot__default_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}{CIOT\_CONFIG\_NTP\_SERVERS\_COUNT}}][64];\ } -\DoxyCodeLine{00055\ \}\ \mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\_ntp\_cfg\_t}};} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00060\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00061\ \{} -\DoxyCodeLine{00062\ \ \ \ \ \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8}{ciot\_ntp\_state\_t}}\ \mbox{\hyperlink{structciot__ntp__status__t_a28ce8249c3bcacad6a7698b7697739b8}{state}};\ } -\DoxyCodeLine{00063\ \ \ \ \ uint64\_t\ \mbox{\hyperlink{structciot__ntp__status__t_a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d}{last\_sync}};\ } -\DoxyCodeLine{00064\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__ntp__status__t_a69671f26529c8f6076d53b96a1e1627f}{sync\_count}};\ } -\DoxyCodeLine{00065\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ntp__status__t_a49f666045d24aa8becc5244bc2396aca}{init}}\ :\ 1;\ } -\DoxyCodeLine{00066\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ntp__status__t_adb4b09387463cd61bf8f7217366310ef}{sync}}\ :\ 1;\ } -\DoxyCodeLine{00067\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ntp__status__t_ac6c17ab632a9c78bc9fa846e9baeea7b}{reserve}}\ :\ 6;\ } -\DoxyCodeLine{00068\ \}\ \mbox{\hyperlink{structciot__ntp__status__t}{ciot\_ntp\_status\_t}};} -\DoxyCodeLine{00069\ } -\DoxyCodeLine{00073\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00074\ \{} -\DoxyCodeLine{00075\ \ \ \ \ \textcolor{comment}{/*\ No\ specific\ request\ data\ defined\ */}} -\DoxyCodeLine{00076\ \}\ \mbox{\hyperlink{unionciot__ntp__req__data__u}{ciot\_ntp\_req\_data\_u}};} -\DoxyCodeLine{00077\ } -\DoxyCodeLine{00081\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00082\ \{} -\DoxyCodeLine{00083\ \ \ \ \ \mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa}{ciot\_ntp\_req\_type\_t}}\ \mbox{\hyperlink{structciot__ntp__req__t_a54590843a59febd0e8055f9249974adc}{type}};\ } -\DoxyCodeLine{00084\ \ \ \ \ \mbox{\hyperlink{unionciot__ntp__req__data__u}{ciot\_ntp\_req\_data\_u}}\ \mbox{\hyperlink{structciot__ntp__req__t_a9401df5c514eae3e23f4468d8ca7795e}{data}};\ } -\DoxyCodeLine{00085\ \}\ \mbox{\hyperlink{structciot__ntp__req__t}{ciot\_ntp\_req\_t}};} -\DoxyCodeLine{00086\ } -\DoxyCodeLine{00090\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00091\ \{} -\DoxyCodeLine{00092\ \ \ \ \ \mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\_ntp\_cfg\_t}}\ \mbox{\hyperlink{unionciot__ntp__data__u_a6c17383e9465f668d1e9dcb3cf8d4f4a}{config}};\ } -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{structciot__ntp__status__t}{ciot\_ntp\_status\_t}}\ \mbox{\hyperlink{unionciot__ntp__data__u_a95d5fa474c00a79ee883e78048ea7c4c}{status}};\ } -\DoxyCodeLine{00094\ \ \ \ \ \mbox{\hyperlink{structciot__ntp__req__t}{ciot\_ntp\_req\_t}}\ \mbox{\hyperlink{unionciot__ntp__data__u_a0a55111acf65b88d386268c615a69499}{request}};\ } -\DoxyCodeLine{00095\ \}\ \mbox{\hyperlink{unionciot__ntp__data__u}{ciot\_ntp\_data\_u}};} -\DoxyCodeLine{00096\ } -\DoxyCodeLine{00097\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00098\ \}} -\DoxyCodeLine{00099\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00100\ } -\DoxyCodeLine{00101\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__opcuas_8h.tex b/docs/latex/ciot__opcuas_8h.tex deleted file mode 100644 index 6d86e64..0000000 --- a/docs/latex/ciot__opcuas_8h.tex +++ /dev/null @@ -1,192 +0,0 @@ -\doxysection{include/ciot\+\_\+opcuas.h File Reference} -\hypertarget{ciot__opcuas_8h}{}\label{ciot__opcuas_8h}\index{include/ciot\_opcuas.h@{include/ciot\_opcuas.h}} - - -Header file for CIOT OPC UA Server (OPCUAS) functionality. - - -{\ttfamily \#include "{}types/ciot\+\_\+opcuas\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__opcuas__status__msg__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OPCUAS status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+opcuas \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Opaque pointer to CIOT OPCUAS structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} \mbox{\hyperlink{ciot__opcuas_8h_a2a20908ad8a9104fa199239f790e72a8}{ciot\+\_\+opcuas\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT OPCUAS instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__opcuas_8h_a86fd44bf128861a3cca1f57b680c137e}{ciot\+\_\+opcuas\+\_\+start}} (\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} self, \mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start CIOT OPCUAS. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__opcuas_8h_a7db26a1290536e33bcad744e00ecf954}{ciot\+\_\+opcuas\+\_\+stop}} (\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop CIOT OPCUAS. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__opcuas_8h_a12d974a4c1fd3dfc906cef2a92d7decc}{ciot\+\_\+opcuas\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} self, \mbox{\hyperlink{structciot__opcuas__req__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process OPCUAS request for CIOT OPCUAS. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__opcuas_8h_adce1d391f5b3a5aa5f638a8410d95cbc}{ciot\+\_\+opcuas\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data for CIOT OPCUAS. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__opcuas_8h_a0a3f5503c7a8cee3326a00a7b251b9b2}{ciot\+\_\+opcuas\+\_\+add\+\_\+node}} (\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} self, uint16\+\_\+t type, char \texorpdfstring{$\ast$}{*}localization, char \texorpdfstring{$\ast$}{*}display\+\_\+name, char \texorpdfstring{$\ast$}{*}node\+\_\+id) -\begin{DoxyCompactList}\small\item\em Add a node to CIOT OPCUAS. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT OPC UA Server (OPCUAS) functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/21 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}\label{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf} -\index{ciot\_opcuas.h@{ciot\_opcuas.h}!ciot\_opcuas\_t@{ciot\_opcuas\_t}} -\index{ciot\_opcuas\_t@{ciot\_opcuas\_t}!ciot\_opcuas.h@{ciot\_opcuas.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_t}{ciot\_opcuas\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+opcuas\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}}} - - - -Opaque pointer to CIOT OPCUAS structure. - - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__opcuas_8h_a0a3f5503c7a8cee3326a00a7b251b9b2}\label{ciot__opcuas_8h_a0a3f5503c7a8cee3326a00a7b251b9b2} -\index{ciot\_opcuas.h@{ciot\_opcuas.h}!ciot\_opcuas\_add\_node@{ciot\_opcuas\_add\_node}} -\index{ciot\_opcuas\_add\_node@{ciot\_opcuas\_add\_node}!ciot\_opcuas.h@{ciot\_opcuas.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_add\_node()}{ciot\_opcuas\_add\_node()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+opcuas\+\_\+add\+\_\+node (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}}}]{self, }\item[{uint16\+\_\+t}]{type, }\item[{char \texorpdfstring{$\ast$}{*}}]{localization, }\item[{char \texorpdfstring{$\ast$}{*}}]{display\+\_\+name, }\item[{char \texorpdfstring{$\ast$}{*}}]{node\+\_\+id }\end{DoxyParamCaption})} - - - -Add a node to CIOT OPCUAS. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OPCUAS. \\ -\hline -{\em type} & Type of the node. \\ -\hline -{\em localization} & Localization of the node. \\ -\hline -{\em display\+\_\+name} & Display name of the node. \\ -\hline -{\em node\+\_\+id} & Node ID of the node. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__opcuas_8h_a2a20908ad8a9104fa199239f790e72a8}\label{ciot__opcuas_8h_a2a20908ad8a9104fa199239f790e72a8} -\index{ciot\_opcuas.h@{ciot\_opcuas.h}!ciot\_opcuas\_new@{ciot\_opcuas\_new}} -\index{ciot\_opcuas\_new@{ciot\_opcuas\_new}!ciot\_opcuas.h@{ciot\_opcuas.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_new()}{ciot\_opcuas\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}} ciot\+\_\+opcuas\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT OPCUAS instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Instance of CIOT OPCUAS. -\end{DoxyReturn} -\Hypertarget{ciot__opcuas_8h_a12d974a4c1fd3dfc906cef2a92d7decc}\label{ciot__opcuas_8h_a12d974a4c1fd3dfc906cef2a92d7decc} -\index{ciot\_opcuas.h@{ciot\_opcuas.h}!ciot\_opcuas\_process\_req@{ciot\_opcuas\_process\_req}} -\index{ciot\_opcuas\_process\_req@{ciot\_opcuas\_process\_req}!ciot\_opcuas.h@{ciot\_opcuas.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_process\_req()}{ciot\_opcuas\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+opcuas\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__opcuas__req__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process OPCUAS request for CIOT OPCUAS. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OPCUAS. \\ -\hline -{\em req} & OPCUAS request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__opcuas_8h_adce1d391f5b3a5aa5f638a8410d95cbc}\label{ciot__opcuas_8h_adce1d391f5b3a5aa5f638a8410d95cbc} -\index{ciot\_opcuas.h@{ciot\_opcuas.h}!ciot\_opcuas\_send\_data@{ciot\_opcuas\_send\_data}} -\index{ciot\_opcuas\_send\_data@{ciot\_opcuas\_send\_data}!ciot\_opcuas.h@{ciot\_opcuas.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_send\_data()}{ciot\_opcuas\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+opcuas\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data for CIOT OPCUAS. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OPCUAS. \\ -\hline -{\em data} & Data to send. \\ -\hline -{\em size} & Size of data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__opcuas_8h_a86fd44bf128861a3cca1f57b680c137e}\label{ciot__opcuas_8h_a86fd44bf128861a3cca1f57b680c137e} -\index{ciot\_opcuas.h@{ciot\_opcuas.h}!ciot\_opcuas\_start@{ciot\_opcuas\_start}} -\index{ciot\_opcuas\_start@{ciot\_opcuas\_start}!ciot\_opcuas.h@{ciot\_opcuas.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_start()}{ciot\_opcuas\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+opcuas\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start CIOT OPCUAS. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OPCUAS. \\ -\hline -{\em cfg} & Configuration for OPCUAS. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__opcuas_8h_a7db26a1290536e33bcad744e00ecf954}\label{ciot__opcuas_8h_a7db26a1290536e33bcad744e00ecf954} -\index{ciot\_opcuas.h@{ciot\_opcuas.h}!ciot\_opcuas\_stop@{ciot\_opcuas\_stop}} -\index{ciot\_opcuas\_stop@{ciot\_opcuas\_stop}!ciot\_opcuas.h@{ciot\_opcuas.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_stop()}{ciot\_opcuas\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+opcuas\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\+\_\+opcuas\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop CIOT OPCUAS. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OPCUAS. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} diff --git a/docs/latex/ciot__opcuas_8h_source.tex b/docs/latex/ciot__opcuas_8h_source.tex deleted file mode 100644 index 4f6013a..0000000 --- a/docs/latex/ciot__opcuas_8h_source.tex +++ /dev/null @@ -1,43 +0,0 @@ -\doxysection{ciot\+\_\+opcuas.\+h} -\hypertarget{ciot__opcuas_8h_source}{}\label{ciot__opcuas_8h_source}\index{include/ciot\_opcuas.h@{include/ciot\_opcuas.h}} -\mbox{\hyperlink{ciot__opcuas_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_OPCUAS\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_OPCUAS\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__opcuas__types_8h}{types/ciot\_opcuas\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_opcuas\ *\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\_opcuas\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00031\ \{} -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__opcuas__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00033\ \ \ \ \ \mbox{\hyperlink{structciot__opcuas__status__t}{ciot\_opcuas\_status\_t}}\ \mbox{\hyperlink{structciot__opcuas__status__msg__t_ac3be6c0c62c2999a9dd9fa0099945876}{status}};\ } -\DoxyCodeLine{00034\ \}\ \mbox{\hyperlink{structciot__opcuas__status__msg__t}{ciot\_opcuas\_status\_msg\_t}};} -\DoxyCodeLine{00035\ } -\DoxyCodeLine{00042\ \mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\_opcuas\_t}}\ \mbox{\hyperlink{ciot__opcuas_8h_a2a20908ad8a9104fa199239f790e72a8}{ciot\_opcuas\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00043\ } -\DoxyCodeLine{00051\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__opcuas_8h_a86fd44bf128861a3cca1f57b680c137e}{ciot\_opcuas\_start}}(\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\_opcuas\_t}}\ self,\ \mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\_opcuas\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00052\ } -\DoxyCodeLine{00059\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__opcuas_8h_a7db26a1290536e33bcad744e00ecf954}{ciot\_opcuas\_stop}}(\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\_opcuas\_t}}\ self);} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00068\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__opcuas_8h_a12d974a4c1fd3dfc906cef2a92d7decc}{ciot\_opcuas\_process\_req}}(\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\_opcuas\_t}}\ self,\ \mbox{\hyperlink{structciot__opcuas__req__t}{ciot\_opcuas\_req\_t}}\ *req);} -\DoxyCodeLine{00069\ } -\DoxyCodeLine{00078\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__opcuas_8h_adce1d391f5b3a5aa5f638a8410d95cbc}{ciot\_opcuas\_send\_data}}(\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\_opcuas\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00079\ } -\DoxyCodeLine{00090\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__opcuas_8h_a0a3f5503c7a8cee3326a00a7b251b9b2}{ciot\_opcuas\_add\_node}}(\mbox{\hyperlink{ciot__opcuas_8h_a2a6f8d1050e1c57937371e12b3c850bf}{ciot\_opcuas\_t}}\ self,\ uint16\_t\ type,\ \textcolor{keywordtype}{char}\ *localization,\ \textcolor{keywordtype}{char}\ *display\_name,\ \textcolor{keywordtype}{char}\ *node\_id);} -\DoxyCodeLine{00091\ } -\DoxyCodeLine{00092\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00093\ \}} -\DoxyCodeLine{00094\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00096\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__opcuas__types_8h.tex b/docs/latex/ciot__opcuas__types_8h.tex deleted file mode 100644 index 099766b..0000000 --- a/docs/latex/ciot__opcuas__types_8h.tex +++ /dev/null @@ -1,104 +0,0 @@ -\doxysection{include/types/ciot\+\_\+opcuas\+\_\+types.h File Reference} -\hypertarget{ciot__opcuas__types_8h}{}\label{ciot__opcuas__types_8h}\index{include/types/ciot\_opcuas\_types.h@{include/types/ciot\_opcuas\_types.h}} - - -Defines data types and structures for CIOT OPC UA Server functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OPC UA Server configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__opcuas__status__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OPC UA Server status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__opcuas__req__add__node__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+add\+\_\+node\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OPC UA Server add node request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__opcuas__req__data__u}{ciot\+\_\+opcuas\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT OPC UA Server request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__opcuas__req__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OPC UA Server request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__opcuas__data__u}{ciot\+\_\+opcuas\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT OPC UA Server data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1}{ciot\+\_\+opcuas\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a67398559dfbdef65155d1fc16ea24d96}{CIOT\+\_\+\+OPCUAS\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a2712146499e42ecf7da21142d2228d84}{CIOT\+\_\+\+OPCUAS\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a4658fd4a9b75cead2da6dcc4e22b73fd}{CIOT\+\_\+\+OPCUAS\+\_\+\+STATE\+\_\+\+RUNNING}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT OPC UA Server state. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c}{ciot\+\_\+opcuas\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca3e4c72d9a9fec403c2b7bfa0f0bb0543}{CIOT\+\_\+\+OPCUAS\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658cafc37181f45b08e2fcefb25123744dab2}{CIOT\+\_\+\+OPCUAS\+\_\+\+REQ\+\_\+\+ADD\+\_\+\+NODE}} -, \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca07fc86e18d23ceab74564968a2d9a895}{CIOT\+\_\+\+OPCUAS\+\_\+\+REQ\+\_\+\+RUN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT OPC UA Server request type. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT OPC UA Server functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/21 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c}\label{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c} -\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!ciot\_opcuas\_req\_type\_t@{ciot\_opcuas\_req\_type\_t}} -\index{ciot\_opcuas\_req\_type\_t@{ciot\_opcuas\_req\_type\_t}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_req\_type\_t}{ciot\_opcuas\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c}{ciot\+\_\+opcuas\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT OPC UA Server request type. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OPCUAS\_REQ\_UNKNOWN@{CIOT\_OPCUAS\_REQ\_UNKNOWN}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}}\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!CIOT\_OPCUAS\_REQ\_UNKNOWN@{CIOT\_OPCUAS\_REQ\_UNKNOWN}}}\Hypertarget{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca3e4c72d9a9fec403c2b7bfa0f0bb0543}\label{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca3e4c72d9a9fec403c2b7bfa0f0bb0543} -CIOT\+\_\+\+OPCUAS\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown OPC UA Server request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OPCUAS\_REQ\_ADD\_NODE@{CIOT\_OPCUAS\_REQ\_ADD\_NODE}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}}\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!CIOT\_OPCUAS\_REQ\_ADD\_NODE@{CIOT\_OPCUAS\_REQ\_ADD\_NODE}}}\Hypertarget{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658cafc37181f45b08e2fcefb25123744dab2}\label{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658cafc37181f45b08e2fcefb25123744dab2} -CIOT\+\_\+\+OPCUAS\+\_\+\+REQ\+\_\+\+ADD\+\_\+\+NODE&Add node request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OPCUAS\_REQ\_RUN@{CIOT\_OPCUAS\_REQ\_RUN}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}}\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!CIOT\_OPCUAS\_REQ\_RUN@{CIOT\_OPCUAS\_REQ\_RUN}}}\Hypertarget{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca07fc86e18d23ceab74564968a2d9a895}\label{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca07fc86e18d23ceab74564968a2d9a895} -CIOT\+\_\+\+OPCUAS\+\_\+\+REQ\+\_\+\+RUN&Run request \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1}\label{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1} -\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!ciot\_opcuas\_state\_t@{ciot\_opcuas\_state\_t}} -\index{ciot\_opcuas\_state\_t@{ciot\_opcuas\_state\_t}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_opcuas\_state\_t}{ciot\_opcuas\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1}{ciot\+\_\+opcuas\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT OPC UA Server state. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OPCUAS\_STATE\_ERROR@{CIOT\_OPCUAS\_STATE\_ERROR}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}}\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!CIOT\_OPCUAS\_STATE\_ERROR@{CIOT\_OPCUAS\_STATE\_ERROR}}}\Hypertarget{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a67398559dfbdef65155d1fc16ea24d96}\label{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a67398559dfbdef65155d1fc16ea24d96} -CIOT\+\_\+\+OPCUAS\+\_\+\+STATE\+\_\+\+ERROR&OPC UA Server state\+: error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OPCUAS\_STATE\_IDLE@{CIOT\_OPCUAS\_STATE\_IDLE}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}}\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!CIOT\_OPCUAS\_STATE\_IDLE@{CIOT\_OPCUAS\_STATE\_IDLE}}}\Hypertarget{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a2712146499e42ecf7da21142d2228d84}\label{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a2712146499e42ecf7da21142d2228d84} -CIOT\+\_\+\+OPCUAS\+\_\+\+STATE\+\_\+\+IDLE&OPC UA Server state\+: idle \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OPCUAS\_STATE\_RUNNING@{CIOT\_OPCUAS\_STATE\_RUNNING}!ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}}\index{ciot\_opcuas\_types.h@{ciot\_opcuas\_types.h}!CIOT\_OPCUAS\_STATE\_RUNNING@{CIOT\_OPCUAS\_STATE\_RUNNING}}}\Hypertarget{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a4658fd4a9b75cead2da6dcc4e22b73fd}\label{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a4658fd4a9b75cead2da6dcc4e22b73fd} -CIOT\+\_\+\+OPCUAS\+\_\+\+STATE\+\_\+\+RUNNING&OPC UA Server state\+: running \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__opcuas__types_8h_source.tex b/docs/latex/ciot__opcuas__types_8h_source.tex deleted file mode 100644 index 7f6354b..0000000 --- a/docs/latex/ciot__opcuas__types_8h_source.tex +++ /dev/null @@ -1,71 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+types.\+h} -\hypertarget{ciot__opcuas__types_8h_source}{}\label{ciot__opcuas__types_8h_source}\index{include/types/ciot\_opcuas\_types.h@{include/types/ciot\_opcuas\_types.h}} -\mbox{\hyperlink{ciot__opcuas__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_OPCUAS\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_OPCUAS\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a67398559dfbdef65155d1fc16ea24d96}{CIOT\_OPCUAS\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a2712146499e42ecf7da21142d2228d84}{CIOT\_OPCUAS\_STATE\_IDLE}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1a4658fd4a9b75cead2da6dcc4e22b73fd}{CIOT\_OPCUAS\_STATE\_RUNNING}},\ } -\DoxyCodeLine{00028\ \}\ \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1}{ciot\_opcuas\_state\_t}};} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00033\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00034\ \{} -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca3e4c72d9a9fec403c2b7bfa0f0bb0543}{CIOT\_OPCUAS\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658cafc37181f45b08e2fcefb25123744dab2}{CIOT\_OPCUAS\_REQ\_ADD\_NODE}},\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658ca07fc86e18d23ceab74564968a2d9a895}{CIOT\_OPCUAS\_REQ\_RUN}},\ } -\DoxyCodeLine{00038\ \}\ \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c}{ciot\_opcuas\_req\_type\_t}};} -\DoxyCodeLine{00039\ } -\DoxyCodeLine{00043\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00044\ \{} -\DoxyCodeLine{00045\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__opcuas__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6}{port}};\ } -\DoxyCodeLine{00046\ \}\ \mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\_opcuas\_cfg\_t}};} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00051\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00052\ \{} -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1}{ciot\_opcuas\_state\_t}}\ \mbox{\hyperlink{structciot__opcuas__status__t_a584e26c042d8a98bf6161b7aa27ba4cf}{state}};\ } -\DoxyCodeLine{00054\ \}\ \mbox{\hyperlink{structciot__opcuas__status__t}{ciot\_opcuas\_status\_t}};} -\DoxyCodeLine{00055\ } -\DoxyCodeLine{00059\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00060\ \{} -\DoxyCodeLine{00061\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__opcuas__req__add__node__t_acb5cfd209ba75c853d03f701e7f91679}{type}};\ } -\DoxyCodeLine{00062\ \ \ \ \ \textcolor{keywordtype}{char}\ localization[8];\ } -\DoxyCodeLine{00063\ \ \ \ \ \textcolor{keywordtype}{char}\ display\_name[32];\ } -\DoxyCodeLine{00064\ \ \ \ \ \textcolor{keywordtype}{char}\ node\_id[64];\ } -\DoxyCodeLine{00065\ \}\ \mbox{\hyperlink{structciot__opcuas__req__add__node__t}{ciot\_opcuas\_req\_add\_node\_t}};} -\DoxyCodeLine{00066\ } -\DoxyCodeLine{00070\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00071\ \{} -\DoxyCodeLine{00072\ \ \ \ \ \mbox{\hyperlink{structciot__opcuas__req__add__node__t}{ciot\_opcuas\_req\_add\_node\_t}}\ \mbox{\hyperlink{unionciot__opcuas__req__data__u_a79aa371ccd92a505f5c26dcd8218a131}{add\_node}};\ } -\DoxyCodeLine{00073\ \}\ \mbox{\hyperlink{unionciot__opcuas__req__data__u}{ciot\_opcuas\_req\_data\_u}};} -\DoxyCodeLine{00074\ } -\DoxyCodeLine{00078\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00079\ \{} -\DoxyCodeLine{00080\ \ \ \ \ \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c}{ciot\_opcuas\_req\_type\_t}}\ \mbox{\hyperlink{structciot__opcuas__req__t_a6a535362b7c81b40f3ed9f6cb292a469}{type}};\ } -\DoxyCodeLine{00081\ \ \ \ \ \mbox{\hyperlink{unionciot__opcuas__req__data__u}{ciot\_opcuas\_req\_data\_u}}\ \mbox{\hyperlink{structciot__opcuas__req__t_a18e3465478724c7b699bb5077661ea35}{data}};\ } -\DoxyCodeLine{00082\ \}\ \mbox{\hyperlink{structciot__opcuas__req__t}{ciot\_opcuas\_req\_t}};} -\DoxyCodeLine{00083\ } -\DoxyCodeLine{00087\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00088\ \{} -\DoxyCodeLine{00089\ \ \ \ \ \mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\_opcuas\_cfg\_t}}\ \mbox{\hyperlink{unionciot__opcuas__data__u_aa976951e468c754fef849731243b0acb}{config}};\ } -\DoxyCodeLine{00090\ \ \ \ \ \mbox{\hyperlink{structciot__opcuas__status__t}{ciot\_opcuas\_status\_t}}\ \mbox{\hyperlink{unionciot__opcuas__data__u_ac3be6c0c62c2999a9dd9fa0099945876}{status}};\ } -\DoxyCodeLine{00091\ \ \ \ \ \mbox{\hyperlink{structciot__opcuas__req__t}{ciot\_opcuas\_req\_t}}\ \mbox{\hyperlink{unionciot__opcuas__data__u_a66e033d989ec031368788f08deba7feb}{request}};\ } -\DoxyCodeLine{00092\ \}\ \mbox{\hyperlink{unionciot__opcuas__data__u}{ciot\_opcuas\_data\_u}};} -\DoxyCodeLine{00093\ } -\DoxyCodeLine{00094\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00095\ \}} -\DoxyCodeLine{00096\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00097\ } -\DoxyCodeLine{00098\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ota_8h.tex b/docs/latex/ciot__ota_8h.tex deleted file mode 100644 index 7e656d4..0000000 --- a/docs/latex/ciot__ota_8h.tex +++ /dev/null @@ -1,281 +0,0 @@ -\doxysection{include/ciot\+\_\+ota.h File Reference} -\hypertarget{ciot__ota_8h}{}\label{ciot__ota_8h}\index{include/ciot\_ota.h@{include/ciot\_ota.h}} - - -Header file for CIOT OTA (Over-\/the-\/\+Air) functionality. - - -{\ttfamily \#include "{}types/ciot\+\_\+ota\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ota__status__msg__t}{ciot\+\_\+ota\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OTA status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__ota_8h_a58196a71cb679cde4bd1e5eea4532721}{CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+TASK\+\_\+\+STACK\+\_\+\+SIZE}}~8192 -\item -\#define \mbox{\hyperlink{ciot__ota_8h_adb91c2dbebfce89f1528cf9be880599e}{CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+TASK\+\_\+\+PRIORITY}}~(tsk\+IDLE\+\_\+\+PRIORITY + 4) -\item -\#define \mbox{\hyperlink{ciot__ota_8h_a3b57f51588da0ff44484f11d1f27a161}{CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+TASK\+\_\+\+CORE\+\_\+\+ID}}~1 -\item -\#define \mbox{\hyperlink{ciot__ota_8h_af99d5bbe46413966124b473f86fb852d}{CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+BUF\+\_\+\+SIZE}}~1024 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+ota \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Opaque pointer to CIOT OTA structure. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64}{ciot\+\_\+ota\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__ota_8h_af4e5ec481586fbb21bebf38d0c3cb0be}{ciot\+\_\+ota\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration of CIOT OTA event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64}{ciot\+\_\+ota\+\_\+event\+\_\+id}} \{ \newline -\mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a9cd3ef2729d29203a80fc481d75a57aa}{CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+CONNECTED}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM -, \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64abddb7e6bac08de2de9f7e05ad8c8a419}{CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+READING\+\_\+\+INFO}} -, \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a36badbcf5c707f55ad68bacc5d54478a}{CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+DECRYPTING}} -, \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64ac31b8578c4d21a016f5a7893554710ab}{CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+WRITING}} -, \newline -\mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a56891046fa6c9434c52e7b2f77e764ab}{CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+UPDATING\+\_\+\+APP}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration of CIOT OTA event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} \mbox{\hyperlink{ciot__ota_8h_a1919f2727400ca6493343a6400bcfec4}{ciot\+\_\+ota\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT OTA instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ota_8h_a9a1c226a282e4d4ba2e0d9e0caffa91c}{ciot\+\_\+ota\+\_\+start}} (\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} self, \mbox{\hyperlink{structciot__ota__cfg__t}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start CIOT OTA. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ota_8h_a4fa33a4b506088b382a391192765dc42}{ciot\+\_\+ota\+\_\+stop}} (\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop CIOT OTA. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ota_8h_a2ad1d252c2d48d024f67054bc7f71d87}{ciot\+\_\+ota\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} self, \mbox{\hyperlink{structciot__ota__req__t}{ciot\+\_\+ota\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process OTA request for CIOT OTA. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ota_8h_a450e80fb9f0810603d54bfd9a0919a38}{ciot\+\_\+ota\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data for CIOT OTA. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__ota_8h_ac316b7fc7ebed5e0aae3e23613d12945}{ciot\+\_\+ota\+\_\+rollback}} (\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Rollback CIOT OTA. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT OTA (Over-\/the-\/\+Air) functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__ota_8h_af99d5bbe46413966124b473f86fb852d}\label{ciot__ota_8h_af99d5bbe46413966124b473f86fb852d} -\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_CONFIG\_OTA\_BUF\_SIZE@{CIOT\_CONFIG\_OTA\_BUF\_SIZE}} -\index{CIOT\_CONFIG\_OTA\_BUF\_SIZE@{CIOT\_CONFIG\_OTA\_BUF\_SIZE}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_OTA\_BUF\_SIZE}{CIOT\_CONFIG\_OTA\_BUF\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+BUF\+\_\+\+SIZE~1024} - -Default buffer size for OTA. \Hypertarget{ciot__ota_8h_a3b57f51588da0ff44484f11d1f27a161}\label{ciot__ota_8h_a3b57f51588da0ff44484f11d1f27a161} -\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID@{CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID}} -\index{CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID@{CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID}{CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+TASK\+\_\+\+CORE\+\_\+\+ID~1} - -Default core ID for OTA task. \Hypertarget{ciot__ota_8h_adb91c2dbebfce89f1528cf9be880599e}\label{ciot__ota_8h_adb91c2dbebfce89f1528cf9be880599e} -\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_CONFIG\_OTA\_TASK\_PRIORITY@{CIOT\_CONFIG\_OTA\_TASK\_PRIORITY}} -\index{CIOT\_CONFIG\_OTA\_TASK\_PRIORITY@{CIOT\_CONFIG\_OTA\_TASK\_PRIORITY}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_OTA\_TASK\_PRIORITY}{CIOT\_CONFIG\_OTA\_TASK\_PRIORITY}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+TASK\+\_\+\+PRIORITY~(tsk\+IDLE\+\_\+\+PRIORITY + 4)} - -Default priority for OTA task. \Hypertarget{ciot__ota_8h_a58196a71cb679cde4bd1e5eea4532721}\label{ciot__ota_8h_a58196a71cb679cde4bd1e5eea4532721} -\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE@{CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE}} -\index{CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE@{CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE}{CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+OTA\+\_\+\+TASK\+\_\+\+STACK\+\_\+\+SIZE~8192} - -Default stack size for OTA task. - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__ota_8h_af4e5ec481586fbb21bebf38d0c3cb0be}\label{ciot__ota_8h_af4e5ec481586fbb21bebf38d0c3cb0be} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_event\_id\_t@{ciot\_ota\_event\_id\_t}} -\index{ciot\_ota\_event\_id\_t@{ciot\_ota\_event\_id\_t}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_event\_id\_t}{ciot\_ota\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64}{ciot\+\_\+ota\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__ota_8h_af4e5ec481586fbb21bebf38d0c3cb0be}{ciot\+\_\+ota\+\_\+event\+\_\+id\+\_\+t}}} - - - -Enumeration of CIOT OTA event IDs. - -\Hypertarget{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}\label{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_t@{ciot\_ota\_t}} -\index{ciot\_ota\_t@{ciot\_ota\_t}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_t}{ciot\_ota\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+ota\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}}} - - - -Opaque pointer to CIOT OTA structure. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64}\label{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_event\_id@{ciot\_ota\_event\_id}} -\index{ciot\_ota\_event\_id@{ciot\_ota\_event\_id}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_event\_id}{ciot\_ota\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64}{ciot\+\_\+ota\+\_\+event\+\_\+id}}} - - - -Enumeration of CIOT OTA event IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_EVENT\_CONNECTED@{CIOT\_OTA\_EVENT\_CONNECTED}!ciot\_ota.h@{ciot\_ota.h}}\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_OTA\_EVENT\_CONNECTED@{CIOT\_OTA\_EVENT\_CONNECTED}}}\Hypertarget{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a9cd3ef2729d29203a80fc481d75a57aa}\label{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a9cd3ef2729d29203a80fc481d75a57aa} -CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+CONNECTED&Connected event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_EVENT\_READING\_INFO@{CIOT\_OTA\_EVENT\_READING\_INFO}!ciot\_ota.h@{ciot\_ota.h}}\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_OTA\_EVENT\_READING\_INFO@{CIOT\_OTA\_EVENT\_READING\_INFO}}}\Hypertarget{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64abddb7e6bac08de2de9f7e05ad8c8a419}\label{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64abddb7e6bac08de2de9f7e05ad8c8a419} -CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+READING\+\_\+\+INFO&Reading information event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_EVENT\_DECRYPTING@{CIOT\_OTA\_EVENT\_DECRYPTING}!ciot\_ota.h@{ciot\_ota.h}}\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_OTA\_EVENT\_DECRYPTING@{CIOT\_OTA\_EVENT\_DECRYPTING}}}\Hypertarget{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a36badbcf5c707f55ad68bacc5d54478a}\label{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a36badbcf5c707f55ad68bacc5d54478a} -CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+DECRYPTING&Decrypting event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_EVENT\_WRITING@{CIOT\_OTA\_EVENT\_WRITING}!ciot\_ota.h@{ciot\_ota.h}}\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_OTA\_EVENT\_WRITING@{CIOT\_OTA\_EVENT\_WRITING}}}\Hypertarget{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64ac31b8578c4d21a016f5a7893554710ab}\label{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64ac31b8578c4d21a016f5a7893554710ab} -CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+WRITING&Writing event. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_EVENT\_UPDATING\_APP@{CIOT\_OTA\_EVENT\_UPDATING\_APP}!ciot\_ota.h@{ciot\_ota.h}}\index{ciot\_ota.h@{ciot\_ota.h}!CIOT\_OTA\_EVENT\_UPDATING\_APP@{CIOT\_OTA\_EVENT\_UPDATING\_APP}}}\Hypertarget{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a56891046fa6c9434c52e7b2f77e764ab}\label{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a56891046fa6c9434c52e7b2f77e764ab} -CIOT\+\_\+\+OTA\+\_\+\+EVENT\+\_\+\+UPDATING\+\_\+\+APP&Updating application event. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__ota_8h_a1919f2727400ca6493343a6400bcfec4}\label{ciot__ota_8h_a1919f2727400ca6493343a6400bcfec4} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_new@{ciot\_ota\_new}} -\index{ciot\_ota\_new@{ciot\_ota\_new}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_new()}{ciot\_ota\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} ciot\+\_\+ota\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT OTA instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Instance of CIOT OTA. -\end{DoxyReturn} -\Hypertarget{ciot__ota_8h_a2ad1d252c2d48d024f67054bc7f71d87}\label{ciot__ota_8h_a2ad1d252c2d48d024f67054bc7f71d87} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_process\_req@{ciot\_ota\_process\_req}} -\index{ciot\_ota\_process\_req@{ciot\_ota\_process\_req}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_process\_req()}{ciot\_ota\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ota\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ota__req__t}{ciot\+\_\+ota\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process OTA request for CIOT OTA. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OTA. \\ -\hline -{\em req} & OTA request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ota_8h_ac316b7fc7ebed5e0aae3e23613d12945}\label{ciot__ota_8h_ac316b7fc7ebed5e0aae3e23613d12945} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_rollback@{ciot\_ota\_rollback}} -\index{ciot\_ota\_rollback@{ciot\_ota\_rollback}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_rollback()}{ciot\_ota\_rollback()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ota\+\_\+rollback (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Rollback CIOT OTA. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OTA. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ota_8h_a450e80fb9f0810603d54bfd9a0919a38}\label{ciot__ota_8h_a450e80fb9f0810603d54bfd9a0919a38} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_send\_data@{ciot\_ota\_send\_data}} -\index{ciot\_ota\_send\_data@{ciot\_ota\_send\_data}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_send\_data()}{ciot\_ota\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ota\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data for CIOT OTA. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OTA. \\ -\hline -{\em data} & Data to send. \\ -\hline -{\em size} & Size of data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ota_8h_a9a1c226a282e4d4ba2e0d9e0caffa91c}\label{ciot__ota_8h_a9a1c226a282e4d4ba2e0d9e0caffa91c} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_start@{ciot\_ota\_start}} -\index{ciot\_ota\_start@{ciot\_ota\_start}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_start()}{ciot\_ota\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ota\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__ota__cfg__t}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start CIOT OTA. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OTA. \\ -\hline -{\em cfg} & Configuration for OTA. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__ota_8h_a4fa33a4b506088b382a391192765dc42}\label{ciot__ota_8h_a4fa33a4b506088b382a391192765dc42} -\index{ciot\_ota.h@{ciot\_ota.h}!ciot\_ota\_stop@{ciot\_ota\_stop}} -\index{ciot\_ota\_stop@{ciot\_ota\_stop}!ciot\_ota.h@{ciot\_ota.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_stop()}{ciot\_ota\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+ota\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop CIOT OTA. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT OTA. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} diff --git a/docs/latex/ciot__ota_8h_source.tex b/docs/latex/ciot__ota_8h_source.tex deleted file mode 100644 index 3e1d3fb..0000000 --- a/docs/latex/ciot__ota_8h_source.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+ota.\+h} -\hypertarget{ciot__ota_8h_source}{}\label{ciot__ota_8h_source}\index{include/ciot\_ota.h@{include/ciot\_ota.h}} -\mbox{\hyperlink{ciot__ota_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_OTA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_OTA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__ota__types_8h}{types/ciot\_ota\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE}} -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_OTA\_TASK\_STACK\_SIZE\ 8192\ }} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_OTA\_TASK\_PRIORITY}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_OTA\_TASK\_PRIORITY\ (tskIDLE\_PRIORITY\ +\ 4)\ }} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID}} -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_OTA\_TASK\_CORE\_ID\ 1\ }} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00031\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_OTA\_BUF\_SIZE}} -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_OTA\_BUF\_SIZE\ 1024\ }} -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00034\ } -\DoxyCodeLine{00038\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_ota\ *\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}};} -\DoxyCodeLine{00039\ } -\DoxyCodeLine{00043\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64}{ciot\_ota\_event\_id}}} -\DoxyCodeLine{00044\ \{} -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a9cd3ef2729d29203a80fc481d75a57aa}{CIOT\_OTA\_EVENT\_CONNECTED}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64abddb7e6bac08de2de9f7e05ad8c8a419}{CIOT\_OTA\_EVENT\_READING\_INFO}},\ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a36badbcf5c707f55ad68bacc5d54478a}{CIOT\_OTA\_EVENT\_DECRYPTING}},\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64ac31b8578c4d21a016f5a7893554710ab}{CIOT\_OTA\_EVENT\_WRITING}},\ } -\DoxyCodeLine{00049\ \ \ \ \ \mbox{\hyperlink{ciot__ota_8h_a2a2372b3836fb8585417c8b2717f4d64a56891046fa6c9434c52e7b2f77e764ab}{CIOT\_OTA\_EVENT\_UPDATING\_APP}},\ } -\DoxyCodeLine{00050\ \}\ \mbox{\hyperlink{ciot__ota_8h_af4e5ec481586fbb21bebf38d0c3cb0be}{ciot\_ota\_event\_id\_t}};} -\DoxyCodeLine{00051\ } -\DoxyCodeLine{00055\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00056\ \{} -\DoxyCodeLine{00057\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__ota__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00058\ \ \ \ \ \mbox{\hyperlink{structciot__ota__status__t}{ciot\_ota\_status\_t}}\ \mbox{\hyperlink{structciot__ota__status__msg__t_a86de670b32fc6ad5c7a44fefb41e6e3a}{status}};\ } -\DoxyCodeLine{00059\ \}\ \mbox{\hyperlink{structciot__ota__status__msg__t}{ciot\_ota\_status\_msg\_t}};} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00067\ \mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}}\ \mbox{\hyperlink{ciot__ota_8h_a1919f2727400ca6493343a6400bcfec4}{ciot\_ota\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00068\ } -\DoxyCodeLine{00076\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ota_8h_a9a1c226a282e4d4ba2e0d9e0caffa91c}{ciot\_ota\_start}}(\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}}\ self,\ \mbox{\hyperlink{structciot__ota__cfg__t}{ciot\_ota\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00077\ } -\DoxyCodeLine{00084\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ota_8h_a4fa33a4b506088b382a391192765dc42}{ciot\_ota\_stop}}(\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}}\ self);} -\DoxyCodeLine{00085\ } -\DoxyCodeLine{00093\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ota_8h_a2ad1d252c2d48d024f67054bc7f71d87}{ciot\_ota\_process\_req}}(\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}}\ self,\ \mbox{\hyperlink{structciot__ota__req__t}{ciot\_ota\_req\_t}}\ *req);} -\DoxyCodeLine{00094\ } -\DoxyCodeLine{00103\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ota_8h_a450e80fb9f0810603d54bfd9a0919a38}{ciot\_ota\_send\_data}}(\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00104\ } -\DoxyCodeLine{00111\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__ota_8h_ac316b7fc7ebed5e0aae3e23613d12945}{ciot\_ota\_rollback}}(\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\_ota\_t}}\ self);} -\DoxyCodeLine{00112\ } -\DoxyCodeLine{00113\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00114\ \}} -\DoxyCodeLine{00115\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00116\ } -\DoxyCodeLine{00117\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__ota__types_8h.tex b/docs/latex/ciot__ota__types_8h.tex deleted file mode 100644 index 815628b..0000000 --- a/docs/latex/ciot__ota__types_8h.tex +++ /dev/null @@ -1,141 +0,0 @@ -\doxysection{include/types/ciot\+\_\+ota\+\_\+types.h File Reference} -\hypertarget{ciot__ota__types_8h}{}\label{ciot__ota__types_8h}\index{include/types/ciot\_ota\_types.h@{include/types/ciot\_ota\_types.h}} - - -Defines data types and structures for CIOT Over-\/\+The-\/\+Air (OTA) functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include $<$stddef.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__ota__cfg__t}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OTA configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ota__status__t}{ciot\+\_\+ota\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OTA status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ota__req__data__u}{ciot\+\_\+ota\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT OTA request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__ota__req__t}{ciot\+\_\+ota\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT OTA request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__ota__data__u}{ciot\+\_\+ota\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT OTA data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15}{ciot\+\_\+ota\+\_\+state\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a153fe0b4a80fd5556f1f7b6bd2bacfa9}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ad7642fe395ae6f6881ba24403ff160d6}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0080d95556253115e20c3731a15be120}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+INIT}} -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ac82f16265153f90a54472489c2bb3558}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+IN\+\_\+\+PROGRESS}} -, \newline -\mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a8d449f644ab603947f86e4307102565e}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+START}} -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0a9339130c6c470f7c4fd9a608b4400c}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+CONNECTED}} -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a89eb2a71799c2f2f6285eb22c373df0a}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+CHECKING\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a328e1c668f670a807f03d1c8fab8476d}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+DECRYPTING}} -, \newline -\mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a444e12a3d7b6bd961907a3012640918b}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+FLASHING}} -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a073d84c91e1a42ee2ef9de54b1016ea7}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+UPDATE\+\_\+\+BOOT\+\_\+\+PARTITION}} -, \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a1a1a9c966f7c58260168ad25244adfc9}{CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+DONE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT OTA state. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20}{ciot\+\_\+ota\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aefbe0949eb768e9bd3e9038282b3c896}{CIOT\+\_\+\+OTA\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aded6cefc8280f134660da5d38911c916}{CIOT\+\_\+\+OTA\+\_\+\+REQ\+\_\+\+ROLLBACK}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT OTA request type. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT Over-\/\+The-\/\+Air (OTA) functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/18 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20}\label{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20} -\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!ciot\_ota\_req\_type\_t@{ciot\_ota\_req\_type\_t}} -\index{ciot\_ota\_req\_type\_t@{ciot\_ota\_req\_type\_t}!ciot\_ota\_types.h@{ciot\_ota\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_req\_type\_t}{ciot\_ota\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20}{ciot\+\_\+ota\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT OTA request type. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_REQ\_UNKNOWN@{CIOT\_OTA\_REQ\_UNKNOWN}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_REQ\_UNKNOWN@{CIOT\_OTA\_REQ\_UNKNOWN}}}\Hypertarget{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aefbe0949eb768e9bd3e9038282b3c896}\label{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aefbe0949eb768e9bd3e9038282b3c896} -CIOT\+\_\+\+OTA\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown OTA request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_REQ\_ROLLBACK@{CIOT\_OTA\_REQ\_ROLLBACK}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_REQ\_ROLLBACK@{CIOT\_OTA\_REQ\_ROLLBACK}}}\Hypertarget{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aded6cefc8280f134660da5d38911c916}\label{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aded6cefc8280f134660da5d38911c916} -CIOT\+\_\+\+OTA\+\_\+\+REQ\+\_\+\+ROLLBACK&Rollback request \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15} -\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!ciot\_ota\_state\_t@{ciot\_ota\_state\_t}} -\index{ciot\_ota\_state\_t@{ciot\_ota\_state\_t}!ciot\_ota\_types.h@{ciot\_ota\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_ota\_state\_t}{ciot\_ota\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15}{ciot\+\_\+ota\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT OTA state. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_ERROR@{CIOT\_OTA\_STATE\_ERROR}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_ERROR@{CIOT\_OTA\_STATE\_ERROR}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a153fe0b4a80fd5556f1f7b6bd2bacfa9}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a153fe0b4a80fd5556f1f7b6bd2bacfa9} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+ERROR&OTA state\+: error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_IDLE@{CIOT\_OTA\_STATE\_IDLE}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_IDLE@{CIOT\_OTA\_STATE\_IDLE}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ad7642fe395ae6f6881ba24403ff160d6}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ad7642fe395ae6f6881ba24403ff160d6} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+IDLE&OTA state\+: idle \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_INIT@{CIOT\_OTA\_STATE\_INIT}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_INIT@{CIOT\_OTA\_STATE\_INIT}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0080d95556253115e20c3731a15be120}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0080d95556253115e20c3731a15be120} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+INIT&OTA state\+: initialization \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_IN\_PROGRESS@{CIOT\_OTA\_STATE\_IN\_PROGRESS}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_IN\_PROGRESS@{CIOT\_OTA\_STATE\_IN\_PROGRESS}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ac82f16265153f90a54472489c2bb3558}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ac82f16265153f90a54472489c2bb3558} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+IN\+\_\+\+PROGRESS&OTA state\+: in progress \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_START@{CIOT\_OTA\_STATE\_START}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_START@{CIOT\_OTA\_STATE\_START}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a8d449f644ab603947f86e4307102565e}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a8d449f644ab603947f86e4307102565e} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+START&OTA state\+: start \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_CONNECTED@{CIOT\_OTA\_STATE\_CONNECTED}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_CONNECTED@{CIOT\_OTA\_STATE\_CONNECTED}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0a9339130c6c470f7c4fd9a608b4400c}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0a9339130c6c470f7c4fd9a608b4400c} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+CONNECTED&OTA state\+: connected \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_CHECKING\_DATA@{CIOT\_OTA\_STATE\_CHECKING\_DATA}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_CHECKING\_DATA@{CIOT\_OTA\_STATE\_CHECKING\_DATA}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a89eb2a71799c2f2f6285eb22c373df0a}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a89eb2a71799c2f2f6285eb22c373df0a} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+CHECKING\+\_\+\+DATA&OTA state\+: checking data \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_DECRYPTING@{CIOT\_OTA\_STATE\_DECRYPTING}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_DECRYPTING@{CIOT\_OTA\_STATE\_DECRYPTING}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a328e1c668f670a807f03d1c8fab8476d}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a328e1c668f670a807f03d1c8fab8476d} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+DECRYPTING&OTA state\+: decrypting \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_FLASHING@{CIOT\_OTA\_STATE\_FLASHING}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_FLASHING@{CIOT\_OTA\_STATE\_FLASHING}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a444e12a3d7b6bd961907a3012640918b}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a444e12a3d7b6bd961907a3012640918b} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+FLASHING&OTA state\+: flashing \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_UPDATE\_BOOT\_PARTITION@{CIOT\_OTA\_STATE\_UPDATE\_BOOT\_PARTITION}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_UPDATE\_BOOT\_PARTITION@{CIOT\_OTA\_STATE\_UPDATE\_BOOT\_PARTITION}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a073d84c91e1a42ee2ef9de54b1016ea7}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a073d84c91e1a42ee2ef9de54b1016ea7} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+UPDATE\+\_\+\+BOOT\+\_\+\+PARTITION&OTA state\+: updating boot partition \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_OTA\_STATE\_DONE@{CIOT\_OTA\_STATE\_DONE}!ciot\_ota\_types.h@{ciot\_ota\_types.h}}\index{ciot\_ota\_types.h@{ciot\_ota\_types.h}!CIOT\_OTA\_STATE\_DONE@{CIOT\_OTA\_STATE\_DONE}}}\Hypertarget{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a1a1a9c966f7c58260168ad25244adfc9}\label{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a1a1a9c966f7c58260168ad25244adfc9} -CIOT\+\_\+\+OTA\+\_\+\+STATE\+\_\+\+DONE&OTA state\+: done \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__ota__types_8h_source.tex b/docs/latex/ciot__ota__types_8h_source.tex deleted file mode 100644 index 21766b1..0000000 --- a/docs/latex/ciot__ota__types_8h_source.tex +++ /dev/null @@ -1,78 +0,0 @@ -\doxysection{ciot\+\_\+ota\+\_\+types.\+h} -\hypertarget{ciot__ota__types_8h_source}{}\label{ciot__ota__types_8h_source}\index{include/types/ciot\_ota\_types.h@{include/types/ciot\_ota\_types.h}} -\mbox{\hyperlink{ciot__ota__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_OTA\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_OTA\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00024\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00025\ \{} -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a153fe0b4a80fd5556f1f7b6bd2bacfa9}{CIOT\_OTA\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ad7642fe395ae6f6881ba24403ff160d6}{CIOT\_OTA\_STATE\_IDLE}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0080d95556253115e20c3731a15be120}{CIOT\_OTA\_STATE\_INIT}},\ } -\DoxyCodeLine{00029\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15ac82f16265153f90a54472489c2bb3558}{CIOT\_OTA\_STATE\_IN\_PROGRESS}},\ } -\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a8d449f644ab603947f86e4307102565e}{CIOT\_OTA\_STATE\_START}},\ } -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a0a9339130c6c470f7c4fd9a608b4400c}{CIOT\_OTA\_STATE\_CONNECTED}},\ } -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a89eb2a71799c2f2f6285eb22c373df0a}{CIOT\_OTA\_STATE\_CHECKING\_DATA}},\ } -\DoxyCodeLine{00033\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a328e1c668f670a807f03d1c8fab8476d}{CIOT\_OTA\_STATE\_DECRYPTING}},\ } -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a444e12a3d7b6bd961907a3012640918b}{CIOT\_OTA\_STATE\_FLASHING}},\ } -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a073d84c91e1a42ee2ef9de54b1016ea7}{CIOT\_OTA\_STATE\_UPDATE\_BOOT\_PARTITION}},\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15a1a1a9c966f7c58260168ad25244adfc9}{CIOT\_OTA\_STATE\_DONE}},\ } -\DoxyCodeLine{00037\ \}\ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15}{ciot\_ota\_state\_t}};} -\DoxyCodeLine{00038\ } -\DoxyCodeLine{00042\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00043\ \{} -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aefbe0949eb768e9bd3e9038282b3c896}{CIOT\_OTA\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20aded6cefc8280f134660da5d38911c916}{CIOT\_OTA\_REQ\_ROLLBACK}},\ } -\DoxyCodeLine{00046\ \}\ \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20}{ciot\_ota\_req\_type\_t}};} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00051\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00052\ \{} -\DoxyCodeLine{00053\ \ \ \ \ \textcolor{keywordtype}{char}\ url[128];\ } -\DoxyCodeLine{00054\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ota__cfg__t_a268d99c2d888dd67e8ea77d3be0a5021}{force}}\ :1;\ } -\DoxyCodeLine{00055\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ota__cfg__t_afe60ab2756fb1ea1c1de6f3ec6dbea98}{encrypted}}\ :1;\ } -\DoxyCodeLine{00056\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ota__cfg__t_a63de528fa8d98b79adfe7f9f68880c17}{restart}}\ :1;\ } -\DoxyCodeLine{00057\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__ota__cfg__t_acb7bc06bed6f6408d719334fc41698c7}{reserved}}\ :5;\ } -\DoxyCodeLine{00058\ \}\ \mbox{\hyperlink{structciot__ota__cfg__t}{ciot\_ota\_cfg\_t}};} -\DoxyCodeLine{00059\ } -\DoxyCodeLine{00063\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00064\ \{} -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15}{ciot\_ota\_state\_t}}\ \mbox{\hyperlink{structciot__ota__status__t_a796f1aeb4c800b653ee018b20c818804}{state}};\ } -\DoxyCodeLine{00066\ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structciot__ota__status__t_a11614f44ef4d939bdd984953346a7572}{error}};\ } -\DoxyCodeLine{00067\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__ota__status__t_a42539ea8650b094f66be7a689243c5ef}{image\_size}};\ } -\DoxyCodeLine{00068\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__ota__status__t_a990d41db67b3605c9184428e72edcea1}{image\_read}};\ } -\DoxyCodeLine{00069\ \}\ \mbox{\hyperlink{structciot__ota__status__t}{ciot\_ota\_status\_t}};} -\DoxyCodeLine{00070\ } -\DoxyCodeLine{00074\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00075\ \{} -\DoxyCodeLine{00076\ \ \ \ \ \textcolor{comment}{/*\ No\ specific\ request\ data\ defined\ */}} -\DoxyCodeLine{00077\ \}\ \mbox{\hyperlink{unionciot__ota__req__data__u}{ciot\_ota\_req\_data\_u}};} -\DoxyCodeLine{00078\ } -\DoxyCodeLine{00082\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00083\ \{} -\DoxyCodeLine{00084\ \ \ \ \ \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20}{ciot\_ota\_req\_type\_t}}\ \mbox{\hyperlink{structciot__ota__req__t_a19605616d62f4ee24f6aefb6c34480e2}{type}};\ } -\DoxyCodeLine{00085\ \ \ \ \ \mbox{\hyperlink{unionciot__ota__req__data__u}{ciot\_ota\_req\_data\_u}}\ \mbox{\hyperlink{structciot__ota__req__t_a77dc06e65f4b0aed4a3f44e1b6a32aa0}{data}};\ } -\DoxyCodeLine{00086\ \}\ \mbox{\hyperlink{structciot__ota__req__t}{ciot\_ota\_req\_t}};} -\DoxyCodeLine{00087\ } -\DoxyCodeLine{00091\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00092\ \{} -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{structciot__ota__cfg__t}{ciot\_ota\_cfg\_t}}\ \mbox{\hyperlink{unionciot__ota__data__u_a62fb934187d712f56dc1289eda8f8cac}{config}};\ } -\DoxyCodeLine{00094\ \ \ \ \ \mbox{\hyperlink{structciot__ota__status__t}{ciot\_ota\_status\_t}}\ \mbox{\hyperlink{unionciot__ota__data__u_a86de670b32fc6ad5c7a44fefb41e6e3a}{status}};\ } -\DoxyCodeLine{00095\ \ \ \ \ \mbox{\hyperlink{structciot__ota__req__t}{ciot\_ota\_req\_t}}\ \mbox{\hyperlink{unionciot__ota__data__u_a4e22c6ea4c9d8fad6bbd0d3894c82627}{request}};\ } -\DoxyCodeLine{00096\ \}\ \mbox{\hyperlink{unionciot__ota__data__u}{ciot\_ota\_data\_u}};} -\DoxyCodeLine{00097\ } -\DoxyCodeLine{00098\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00099\ \}} -\DoxyCodeLine{00100\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00101\ } -\DoxyCodeLine{00102\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__s_8h.tex b/docs/latex/ciot__s_8h.tex deleted file mode 100644 index da3c786..0000000 --- a/docs/latex/ciot__s_8h.tex +++ /dev/null @@ -1,274 +0,0 @@ -\doxysection{include/ciot\+\_\+s.h File Reference} -\hypertarget{ciot__s_8h}{}\label{ciot__s_8h}\index{include/ciot\_s.h@{include/ciot\_s.h}} - - -Header file for CIOT\+\_\+S (Communication Interface Over Transport) module. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__s__cfg}{ciot\+\_\+s\+\_\+cfg}} -\begin{DoxyCompactList}\small\item\em CIOT\+\_\+S config struct. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__s_8h_a2f0fd14f043350f0bb586e527d72d4ca}{CIOT\+\_\+\+S\+\_\+\+BASE\+\_\+\+ERR}}~0x0 -\item -\#define \mbox{\hyperlink{ciot__s_8h_a0c8d7eee4ad76474e1a795d539af7489}{CIOT\+\_\+\+S\+\_\+\+START\+\_\+\+CH}}~\textquotesingle{}\{\textquotesingle{} -\item -\#define \mbox{\hyperlink{ciot__s_8h_a454cbf8a51c076e297148719f8ad4f03}{CIOT\+\_\+\+S\+\_\+\+LENGHT\+\_\+\+SIZE}}~2 -\item -\#define \mbox{\hyperlink{ciot__s_8h_a958b5b763c873fb977a8cf2dc15dd69f}{CIOT\+\_\+\+S\+\_\+\+END\+\_\+\+CH}}~\textquotesingle{}\}\textquotesingle{} -\item -\#define \mbox{\hyperlink{ciot__s_8h_a08b8e7174adadc6c5d23fd15348fa0f3}{CIOT\+\_\+\+S\+\_\+\+BUF\+\_\+\+SIZE}}~512 -\item -\#define \mbox{\hyperlink{ciot__s_8h_a451d99c99313941fbfef451a7a830341}{CIOT\+\_\+\+S\+\_\+\+HEADER\+\_\+\+SIZE}}~3 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+s \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT\+\_\+S private struct typedef. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2}{ciot\+\_\+s\+\_\+status}} \mbox{\hyperlink{ciot__s_8h_a061479d073e577bea43e5f500abb7fa3}{ciot\+\_\+s\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT\+\_\+S status. \end{DoxyCompactList}\item -typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\+\_\+s\+\_\+msg\+\_\+handler\+\_\+t}}(\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}iface, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Message handler function type definition. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__s__cfg}{ciot\+\_\+s\+\_\+cfg}} \mbox{\hyperlink{ciot__s_8h_a9e2f0df6038e3db27a8f0fa1724cfa74}{ciot\+\_\+s\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT\+\_\+S config struct. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2}{ciot\+\_\+s\+\_\+status}} \{ \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a7aadbf38530370cb4ba0d27b44a54306}{CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+WAIT\+\_\+\+START\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2ae053def601f16100aeb60fb82b3c65f8}{CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+WAIT\+\_\+\+SIZE}} -, \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a51cd1ce663428588f8aaa47f17822b12}{CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+READ\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a2221c4f133239b0c83c498778a24aada}{CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+TIMEOUT}} - \} -\begin{DoxyCompactList}\small\item\em CIOT\+\_\+S status. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} \mbox{\hyperlink{ciot__s_8h_a47e024d9119662842e62f2b993b7511c}{ciot\+\_\+s\+\_\+new}} (\mbox{\hyperlink{ciot__s_8h_a9e2f0df6038e3db27a8f0fa1724cfa74}{ciot\+\_\+s\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Create a new CIOT\+\_\+S instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__s_8h_a00fdcbb4aebbad8f80bf1bf1e732a9cb}{ciot\+\_\+s\+\_\+send}} (\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data using CIOT\+\_\+S. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__s_8h_a4d7f4cef42ccdb61d1ab7dd6adafc391}{ciot\+\_\+s\+\_\+process\+\_\+byte}} (\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} self, uint8\+\_\+t byte) -\begin{DoxyCompactList}\small\item\em Process a byte received by CIOT\+\_\+S. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__s_8h_a14867c1134859ec897f2ecf11af41793}{ciot\+\_\+s\+\_\+set\+\_\+bridge\+\_\+mode}} (\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} self, bool mode) -\begin{DoxyCompactList}\small\item\em Set bridge mode for CIOT\+\_\+S. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT\+\_\+S (Communication Interface Over Transport) module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__s_8h_a2f0fd14f043350f0bb586e527d72d4ca}\label{ciot__s_8h_a2f0fd14f043350f0bb586e527d72d4ca} -\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_BASE\_ERR@{CIOT\_S\_BASE\_ERR}} -\index{CIOT\_S\_BASE\_ERR@{CIOT\_S\_BASE\_ERR}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_S\_BASE\_ERR}{CIOT\_S\_BASE\_ERR}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+S\+\_\+\+BASE\+\_\+\+ERR~0x0} - -Starting number of CIOT\+\_\+S error codes \Hypertarget{ciot__s_8h_a08b8e7174adadc6c5d23fd15348fa0f3}\label{ciot__s_8h_a08b8e7174adadc6c5d23fd15348fa0f3} -\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_BUF\_SIZE@{CIOT\_S\_BUF\_SIZE}} -\index{CIOT\_S\_BUF\_SIZE@{CIOT\_S\_BUF\_SIZE}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_S\_BUF\_SIZE}{CIOT\_S\_BUF\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+S\+\_\+\+BUF\+\_\+\+SIZE~512} - -Buffer size \Hypertarget{ciot__s_8h_a958b5b763c873fb977a8cf2dc15dd69f}\label{ciot__s_8h_a958b5b763c873fb977a8cf2dc15dd69f} -\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_END\_CH@{CIOT\_S\_END\_CH}} -\index{CIOT\_S\_END\_CH@{CIOT\_S\_END\_CH}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_S\_END\_CH}{CIOT\_S\_END\_CH}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+S\+\_\+\+END\+\_\+\+CH~\textquotesingle{}\}\textquotesingle{}} - -Message end character \Hypertarget{ciot__s_8h_a451d99c99313941fbfef451a7a830341}\label{ciot__s_8h_a451d99c99313941fbfef451a7a830341} -\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_HEADER\_SIZE@{CIOT\_S\_HEADER\_SIZE}} -\index{CIOT\_S\_HEADER\_SIZE@{CIOT\_S\_HEADER\_SIZE}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_S\_HEADER\_SIZE}{CIOT\_S\_HEADER\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+S\+\_\+\+HEADER\+\_\+\+SIZE~3} - -Header size \Hypertarget{ciot__s_8h_a454cbf8a51c076e297148719f8ad4f03}\label{ciot__s_8h_a454cbf8a51c076e297148719f8ad4f03} -\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_LENGHT\_SIZE@{CIOT\_S\_LENGHT\_SIZE}} -\index{CIOT\_S\_LENGHT\_SIZE@{CIOT\_S\_LENGHT\_SIZE}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_S\_LENGHT\_SIZE}{CIOT\_S\_LENGHT\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+S\+\_\+\+LENGHT\+\_\+\+SIZE~2} - -Number of bytes used to receive message length \Hypertarget{ciot__s_8h_a0c8d7eee4ad76474e1a795d539af7489}\label{ciot__s_8h_a0c8d7eee4ad76474e1a795d539af7489} -\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_START\_CH@{CIOT\_S\_START\_CH}} -\index{CIOT\_S\_START\_CH@{CIOT\_S\_START\_CH}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_S\_START\_CH}{CIOT\_S\_START\_CH}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+S\+\_\+\+START\+\_\+\+CH~\textquotesingle{}\{\textquotesingle{}} - -Message start character - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__s_8h_a9e2f0df6038e3db27a8f0fa1724cfa74}\label{ciot__s_8h_a9e2f0df6038e3db27a8f0fa1724cfa74} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_cfg\_t@{ciot\_s\_cfg\_t}} -\index{ciot\_s\_cfg\_t@{ciot\_s\_cfg\_t}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_cfg\_t}{ciot\_s\_cfg\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__s__cfg}{ciot\+\_\+s\+\_\+cfg}} \mbox{\hyperlink{ciot__s_8h_a9e2f0df6038e3db27a8f0fa1724cfa74}{ciot\+\_\+s\+\_\+cfg\+\_\+t}}} - - - -CIOT\+\_\+S config struct. - -\Hypertarget{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}\label{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_msg\_handler\_t@{ciot\_s\_msg\_handler\_t}} -\index{ciot\_s\_msg\_handler\_t@{ciot\_s\_msg\_handler\_t}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_msg\_handler\_t}{ciot\_s\_msg\_handler\_t}} -{\footnotesize\ttfamily typedef \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+s\+\_\+msg\+\_\+handler\+\_\+t(\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}iface, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size)} - - - -Message handler function type definition. - -\Hypertarget{ciot__s_8h_a061479d073e577bea43e5f500abb7fa3}\label{ciot__s_8h_a061479d073e577bea43e5f500abb7fa3} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_status\_t@{ciot\_s\_status\_t}} -\index{ciot\_s\_status\_t@{ciot\_s\_status\_t}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_status\_t}{ciot\_s\_status\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2}{ciot\+\_\+s\+\_\+status}} \mbox{\hyperlink{ciot__s_8h_a061479d073e577bea43e5f500abb7fa3}{ciot\+\_\+s\+\_\+status\+\_\+t}}} - - - -CIOT\+\_\+S status. - -\Hypertarget{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}\label{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_t@{ciot\_s\_t}} -\index{ciot\_s\_t@{ciot\_s\_t}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_t}{ciot\_s\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+s\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}}} - - - -CIOT\+\_\+S private struct typedef. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2}\label{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_status@{ciot\_s\_status}} -\index{ciot\_s\_status@{ciot\_s\_status}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_status}{ciot\_s\_status}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2}{ciot\+\_\+s\+\_\+status}}} - - - -CIOT\+\_\+S status. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_S\_STATUS\_WAIT\_START\_DATA@{CIOT\_S\_STATUS\_WAIT\_START\_DATA}!ciot\_s.h@{ciot\_s.h}}\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_STATUS\_WAIT\_START\_DATA@{CIOT\_S\_STATUS\_WAIT\_START\_DATA}}}\Hypertarget{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a7aadbf38530370cb4ba0d27b44a54306}\label{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a7aadbf38530370cb4ba0d27b44a54306} -CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+WAIT\+\_\+\+START\+\_\+\+DATA&Waiting start data character \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_S\_STATUS\_WAIT\_SIZE@{CIOT\_S\_STATUS\_WAIT\_SIZE}!ciot\_s.h@{ciot\_s.h}}\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_STATUS\_WAIT\_SIZE@{CIOT\_S\_STATUS\_WAIT\_SIZE}}}\Hypertarget{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2ae053def601f16100aeb60fb82b3c65f8}\label{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2ae053def601f16100aeb60fb82b3c65f8} -CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+WAIT\+\_\+\+SIZE&Waiting size \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_S\_STATUS\_READ\_DATA@{CIOT\_S\_STATUS\_READ\_DATA}!ciot\_s.h@{ciot\_s.h}}\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_STATUS\_READ\_DATA@{CIOT\_S\_STATUS\_READ\_DATA}}}\Hypertarget{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a51cd1ce663428588f8aaa47f17822b12}\label{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a51cd1ce663428588f8aaa47f17822b12} -CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+READ\+\_\+\+DATA&Waiting read data \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_S\_STATUS\_TIMEOUT@{CIOT\_S\_STATUS\_TIMEOUT}!ciot\_s.h@{ciot\_s.h}}\index{ciot\_s.h@{ciot\_s.h}!CIOT\_S\_STATUS\_TIMEOUT@{CIOT\_S\_STATUS\_TIMEOUT}}}\Hypertarget{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a2221c4f133239b0c83c498778a24aada}\label{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a2221c4f133239b0c83c498778a24aada} -CIOT\+\_\+\+S\+\_\+\+STATUS\+\_\+\+TIMEOUT&Data timeout \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__s_8h_a47e024d9119662842e62f2b993b7511c}\label{ciot__s_8h_a47e024d9119662842e62f2b993b7511c} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_new@{ciot\_s\_new}} -\index{ciot\_s\_new@{ciot\_s\_new}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_new()}{ciot\_s\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} ciot\+\_\+s\+\_\+new (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__s_8h_a9e2f0df6038e3db27a8f0fa1724cfa74}{ciot\+\_\+s\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Create a new CIOT\+\_\+S instance. - - -\begin{DoxyParams}{Parameters} -{\em cfg} & Configuration for CIOT\+\_\+S. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Instance of CIOT\+\_\+S. -\end{DoxyReturn} -\Hypertarget{ciot__s_8h_a4d7f4cef42ccdb61d1ab7dd6adafc391}\label{ciot__s_8h_a4d7f4cef42ccdb61d1ab7dd6adafc391} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_process\_byte@{ciot\_s\_process\_byte}} -\index{ciot\_s\_process\_byte@{ciot\_s\_process\_byte}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_process\_byte()}{ciot\_s\_process\_byte()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+s\+\_\+process\+\_\+byte (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}}}]{self, }\item[{uint8\+\_\+t}]{byte }\end{DoxyParamCaption})} - - - -Process a byte received by CIOT\+\_\+S. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT\+\_\+S. \\ -\hline -{\em byte} & Byte to process. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__s_8h_a00fdcbb4aebbad8f80bf1bf1e732a9cb}\label{ciot__s_8h_a00fdcbb4aebbad8f80bf1bf1e732a9cb} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_send@{ciot\_s\_send}} -\index{ciot\_s\_send@{ciot\_s\_send}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_send()}{ciot\_s\_send()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+s\+\_\+send (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data using CIOT\+\_\+S. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT\+\_\+S. \\ -\hline -{\em data} & Data to send. \\ -\hline -{\em size} & Size of data. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} -\Hypertarget{ciot__s_8h_a14867c1134859ec897f2ecf11af41793}\label{ciot__s_8h_a14867c1134859ec897f2ecf11af41793} -\index{ciot\_s.h@{ciot\_s.h}!ciot\_s\_set\_bridge\_mode@{ciot\_s\_set\_bridge\_mode}} -\index{ciot\_s\_set\_bridge\_mode@{ciot\_s\_set\_bridge\_mode}!ciot\_s.h@{ciot\_s.h}} -\doxysubsubsection{\texorpdfstring{ciot\_s\_set\_bridge\_mode()}{ciot\_s\_set\_bridge\_mode()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+s\+\_\+set\+\_\+bridge\+\_\+mode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}}}]{self, }\item[{bool}]{mode }\end{DoxyParamCaption})} - - - -Set bridge mode for CIOT\+\_\+S. - - -\begin{DoxyParams}{Parameters} -{\em self} & Instance of CIOT\+\_\+S. \\ -\hline -{\em mode} & Bridge mode flag. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code. -\end{DoxyReturn} diff --git a/docs/latex/ciot__s_8h_source.tex b/docs/latex/ciot__s_8h_source.tex deleted file mode 100644 index ddca290..0000000 --- a/docs/latex/ciot__s_8h_source.tex +++ /dev/null @@ -1,66 +0,0 @@ -\doxysection{ciot\+\_\+s.\+h} -\hypertarget{ciot__s_8h_source}{}\label{ciot__s_8h_source}\index{include/ciot\_s.h@{include/ciot\_s.h}} -\mbox{\hyperlink{ciot__s_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_S\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_S\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00018\ } -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#if\ CIOT\_CONFIG\_FEATURE\_TIMER}} -\DoxyCodeLine{00023\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__timer_8h}{ciot\_timer.h}}"{}}} -\DoxyCodeLine{00024\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00025\ } -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#define\ CIOT\_S\_BASE\_ERR\ 0x0\ \ \ \ \ }} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#define\ CIOT\_S\_START\_CH\ '\{'\ \ \ \ \ }} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#define\ CIOT\_S\_LENGHT\_SIZE\ 2\ \ \ \ }} -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#define\ CIOT\_S\_END\_CH\ '\}'\ \ \ \ \ \ \ }} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#define\ CIOT\_S\_BUF\_SIZE\ 512\ \ \ \ \ }} -\DoxyCodeLine{00031\ \textcolor{preprocessor}{\#define\ CIOT\_S\_HEADER\_SIZE\ 3\ \ \ \ }} -\DoxyCodeLine{00036\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_s\ *\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\_s\_t}};} -\DoxyCodeLine{00037\ } -\DoxyCodeLine{00041\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2}{ciot\_s\_status}}} -\DoxyCodeLine{00042\ \{} -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a7aadbf38530370cb4ba0d27b44a54306}{CIOT\_S\_STATUS\_WAIT\_START\_DATA}},\ \ } -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2ae053def601f16100aeb60fb82b3c65f8}{CIOT\_S\_STATUS\_WAIT\_SIZE}},\ \ \ \ \ \ \ \ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a51cd1ce663428588f8aaa47f17822b12}{CIOT\_S\_STATUS\_READ\_DATA}},\ \ \ \ \ \ \ \ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__s_8h_abf179a683c9ec625bcd80eeffc5225f2a2221c4f133239b0c83c498778a24aada}{CIOT\_S\_STATUS\_TIMEOUT}},\ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00047\ \}\ \mbox{\hyperlink{ciot__s_8h_a061479d073e577bea43e5f500abb7fa3}{ciot\_s\_status\_t}};} -\DoxyCodeLine{00048\ } -\DoxyCodeLine{00052\ \textcolor{keyword}{typedef}\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}(\mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\_s\_msg\_handler\_t}})(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *iface,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00053\ } -\DoxyCodeLine{00057\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__s__cfg}{ciot\_s\_cfg}}} -\DoxyCodeLine{00058\ \{} -\DoxyCodeLine{00059\ \ \ \ \ \mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\_s\_msg\_handler\_t}}\ *\mbox{\hyperlink{structciot__s__cfg_a8a3b67e9e535387d32be766122edf704}{send\_bytes}};\ \ \ \ \ \ \ } -\DoxyCodeLine{00060\ \ \ \ \ \mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\_s\_msg\_handler\_t}}\ *\mbox{\hyperlink{structciot__s__cfg_a104dd7ebfd24bb8b26a683a795e169d2}{on\_message\_cb}};\ \ \ \ } -\DoxyCodeLine{00061\ \ \ \ \ \mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *\mbox{\hyperlink{structciot__s__cfg_add0d24e0065c33f7e1da60ac94e6988b}{iface}};\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00062\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structciot__s__cfg_a4e8946f8a10777bc88814da1c657815c}{bridge\_mode}};\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00063\ \}\ \mbox{\hyperlink{ciot__s_8h_a9e2f0df6038e3db27a8f0fa1724cfa74}{ciot\_s\_cfg\_t}};} -\DoxyCodeLine{00064\ } -\DoxyCodeLine{00071\ \mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\_s\_t}}\ \mbox{\hyperlink{ciot__s_8h_a47e024d9119662842e62f2b993b7511c}{ciot\_s\_new}}(\mbox{\hyperlink{structciot__s__cfg}{ciot\_s\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00072\ } -\DoxyCodeLine{00081\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__s_8h_a00fdcbb4aebbad8f80bf1bf1e732a9cb}{ciot\_s\_send}}(\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\_s\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00082\ } -\DoxyCodeLine{00090\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__s_8h_a4d7f4cef42ccdb61d1ab7dd6adafc391}{ciot\_s\_process\_byte}}(\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\_s\_t}}\ self,\ uint8\_t\ \textcolor{keywordtype}{byte});} -\DoxyCodeLine{00091\ } -\DoxyCodeLine{00099\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__s_8h_a14867c1134859ec897f2ecf11af41793}{ciot\_s\_set\_bridge\_mode}}(\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\_s\_t}}\ self,\ \textcolor{keywordtype}{bool}\ mode);} -\DoxyCodeLine{00100\ } -\DoxyCodeLine{00101\ \textcolor{preprocessor}{\#if\ CIOT\_CONFIG\_FEATURE\_TIMER}} -\DoxyCodeLine{00108\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ ciot\_s\_check\_timeout(\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\_s\_t}}\ self);} -\DoxyCodeLine{00109\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00110\ } -\DoxyCodeLine{00111\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00112\ \}} -\DoxyCodeLine{00113\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00114\ } -\DoxyCodeLine{00115\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__serializer_8h.tex b/docs/latex/ciot__serializer_8h.tex deleted file mode 100644 index b99c717..0000000 --- a/docs/latex/ciot__serializer_8h.tex +++ /dev/null @@ -1,198 +0,0 @@ -\doxysection{include/ciot\+\_\+serializer.h File Reference} -\hypertarget{ciot__serializer_8h}{}\label{ciot__serializer_8h}\index{include/ciot\_serializer.h@{include/ciot\_serializer.h}} - - -Header file for CIOT Serializer module. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include "{}types/ciot\+\_\+msg\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__serializer}{ciot\+\_\+serializer}} -\begin{DoxyCompactList}\small\item\em CIOT Serializer structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct \mbox{\hyperlink{structciot__serializer}{ciot\+\_\+serializer}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT Serializer instance pointer. \end{DoxyCompactList}\item -typedef int \mbox{\hyperlink{ciot__serializer_8h_ad5f4d77f37d8f97c45e7ac3684c6240d}{ciot\+\_\+serializer\+\_\+to\+\_\+bytes\+\_\+fn}}(uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg) -\begin{DoxyCompactList}\small\item\em Function pointer type for serializing to bytes. \end{DoxyCompactList}\item -typedef int \mbox{\hyperlink{ciot__serializer_8h_ad4e6ec6f4f6b2794af860108e701a284}{ciot\+\_\+serializer\+\_\+from\+\_\+bytes\+\_\+fn}}(\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg, uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, int size) -\begin{DoxyCompactList}\small\item\em Function pointer type for deserializing from bytes. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702b}{ciot\+\_\+serializer\+\_\+type}} \mbox{\hyperlink{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7}{ciot\+\_\+serializer\+\_\+type\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enum representing CIOT Serializer types. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702b}{ciot\+\_\+serializer\+\_\+type}} \{ \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba1628b71e70eb2dcf89b24e63d9d86289}{CIOT\+\_\+\+SERIALIZER\+\_\+\+TYPE\+\_\+\+NONE}} -, \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba0f0db27db7f111da963526dfface091e}{CIOT\+\_\+\+SERIALIZER\+\_\+\+TYPE\+\_\+\+PROTOBUF}} -, \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba6d5cb551c26a7529e01e27c64dbc2a7a}{CIOT\+\_\+\+SERIALIZER\+\_\+\+TYPE\+\_\+\+CUSTOM}} - \} -\begin{DoxyCompactList}\small\item\em Enum representing CIOT Serializer types. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -int \mbox{\hyperlink{ciot__serializer_8h_acce586f0c1adcf56d07b5c09e1df2c17}{ciot\+\_\+serializer\+\_\+to\+\_\+bytes}} (\mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg) -\begin{DoxyCompactList}\small\item\em Serialize a CIOT message to bytes using the specified serializer. \end{DoxyCompactList}\item -int \mbox{\hyperlink{ciot__serializer_8h_a2e6ad3f65b3277042564ae00d1ea9522}{ciot\+\_\+serializer\+\_\+from\+\_\+bytes}} (\mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}} self, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg, uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, int size) -\begin{DoxyCompactList}\small\item\em Deserialize bytes to a CIOT message using the specified serializer. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT Serializer module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/13 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__serializer_8h_ad4e6ec6f4f6b2794af860108e701a284}\label{ciot__serializer_8h_ad4e6ec6f4f6b2794af860108e701a284} -\index{ciot\_serializer.h@{ciot\_serializer.h}!ciot\_serializer\_from\_bytes\_fn@{ciot\_serializer\_from\_bytes\_fn}} -\index{ciot\_serializer\_from\_bytes\_fn@{ciot\_serializer\_from\_bytes\_fn}!ciot\_serializer.h@{ciot\_serializer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_serializer\_from\_bytes\_fn}{ciot\_serializer\_from\_bytes\_fn}} -{\footnotesize\ttfamily typedef int ciot\+\_\+serializer\+\_\+from\+\_\+bytes\+\_\+fn(\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg, uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, int size)} - - - -Function pointer type for deserializing from bytes. - - -\begin{DoxyParams}{Parameters} -{\em msg} & CIOT message to fill with deserialized data. \\ -\hline -{\em bytes} & Source buffer containing serialized data. \\ -\hline -{\em size} & Size of the serialized data in bytes. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Number of bytes consumed during deserialization. -\end{DoxyReturn} -\Hypertarget{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}\label{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac} -\index{ciot\_serializer.h@{ciot\_serializer.h}!ciot\_serializer\_t@{ciot\_serializer\_t}} -\index{ciot\_serializer\_t@{ciot\_serializer\_t}!ciot\_serializer.h@{ciot\_serializer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_serializer\_t}{ciot\_serializer\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__serializer}{ciot\+\_\+serializer}}\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}}} - - - -CIOT Serializer instance pointer. - -\Hypertarget{ciot__serializer_8h_ad5f4d77f37d8f97c45e7ac3684c6240d}\label{ciot__serializer_8h_ad5f4d77f37d8f97c45e7ac3684c6240d} -\index{ciot\_serializer.h@{ciot\_serializer.h}!ciot\_serializer\_to\_bytes\_fn@{ciot\_serializer\_to\_bytes\_fn}} -\index{ciot\_serializer\_to\_bytes\_fn@{ciot\_serializer\_to\_bytes\_fn}!ciot\_serializer.h@{ciot\_serializer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_serializer\_to\_bytes\_fn}{ciot\_serializer\_to\_bytes\_fn}} -{\footnotesize\ttfamily typedef int ciot\+\_\+serializer\+\_\+to\+\_\+bytes\+\_\+fn(uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}msg)} - - - -Function pointer type for serializing to bytes. - - -\begin{DoxyParams}{Parameters} -{\em bytes} & Destination buffer for serialized data. \\ -\hline -{\em msg} & CIOT message to serialize. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Number of bytes serialized. -\end{DoxyReturn} -\Hypertarget{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7}\label{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7} -\index{ciot\_serializer.h@{ciot\_serializer.h}!ciot\_serializer\_type\_t@{ciot\_serializer\_type\_t}} -\index{ciot\_serializer\_type\_t@{ciot\_serializer\_type\_t}!ciot\_serializer.h@{ciot\_serializer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_serializer\_type\_t}{ciot\_serializer\_type\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702b}{ciot\+\_\+serializer\+\_\+type}} \mbox{\hyperlink{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7}{ciot\+\_\+serializer\+\_\+type\+\_\+t}}} - - - -Enum representing CIOT Serializer types. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702b}\label{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702b} -\index{ciot\_serializer.h@{ciot\_serializer.h}!ciot\_serializer\_type@{ciot\_serializer\_type}} -\index{ciot\_serializer\_type@{ciot\_serializer\_type}!ciot\_serializer.h@{ciot\_serializer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_serializer\_type}{ciot\_serializer\_type}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702b}{ciot\+\_\+serializer\+\_\+type}}} - - - -Enum representing CIOT Serializer types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SERIALIZER\_TYPE\_NONE@{CIOT\_SERIALIZER\_TYPE\_NONE}!ciot\_serializer.h@{ciot\_serializer.h}}\index{ciot\_serializer.h@{ciot\_serializer.h}!CIOT\_SERIALIZER\_TYPE\_NONE@{CIOT\_SERIALIZER\_TYPE\_NONE}}}\Hypertarget{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba1628b71e70eb2dcf89b24e63d9d86289}\label{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba1628b71e70eb2dcf89b24e63d9d86289} -CIOT\+\_\+\+SERIALIZER\+\_\+\+TYPE\+\_\+\+NONE&No serializer type specified \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SERIALIZER\_TYPE\_PROTOBUF@{CIOT\_SERIALIZER\_TYPE\_PROTOBUF}!ciot\_serializer.h@{ciot\_serializer.h}}\index{ciot\_serializer.h@{ciot\_serializer.h}!CIOT\_SERIALIZER\_TYPE\_PROTOBUF@{CIOT\_SERIALIZER\_TYPE\_PROTOBUF}}}\Hypertarget{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba0f0db27db7f111da963526dfface091e}\label{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba0f0db27db7f111da963526dfface091e} -CIOT\+\_\+\+SERIALIZER\+\_\+\+TYPE\+\_\+\+PROTOBUF&Protocol Buffers serializer \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SERIALIZER\_TYPE\_CUSTOM@{CIOT\_SERIALIZER\_TYPE\_CUSTOM}!ciot\_serializer.h@{ciot\_serializer.h}}\index{ciot\_serializer.h@{ciot\_serializer.h}!CIOT\_SERIALIZER\_TYPE\_CUSTOM@{CIOT\_SERIALIZER\_TYPE\_CUSTOM}}}\Hypertarget{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba6d5cb551c26a7529e01e27c64dbc2a7a}\label{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba6d5cb551c26a7529e01e27c64dbc2a7a} -CIOT\+\_\+\+SERIALIZER\+\_\+\+TYPE\+\_\+\+CUSTOM&Custom serializer \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__serializer_8h_a2e6ad3f65b3277042564ae00d1ea9522}\label{ciot__serializer_8h_a2e6ad3f65b3277042564ae00d1ea9522} -\index{ciot\_serializer.h@{ciot\_serializer.h}!ciot\_serializer\_from\_bytes@{ciot\_serializer\_from\_bytes}} -\index{ciot\_serializer\_from\_bytes@{ciot\_serializer\_from\_bytes}!ciot\_serializer.h@{ciot\_serializer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_serializer\_from\_bytes()}{ciot\_serializer\_from\_bytes()}} -{\footnotesize\ttfamily int ciot\+\_\+serializer\+\_\+from\+\_\+bytes (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{msg, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{bytes, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Deserialize bytes to a CIOT message using the specified serializer. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Serializer instance. \\ -\hline -{\em msg} & CIOT message to fill with deserialized data. \\ -\hline -{\em bytes} & Source buffer containing serialized data. \\ -\hline -{\em size} & Size of the serialized data in bytes. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Number of bytes consumed during deserialization. -\end{DoxyReturn} -\Hypertarget{ciot__serializer_8h_acce586f0c1adcf56d07b5c09e1df2c17}\label{ciot__serializer_8h_acce586f0c1adcf56d07b5c09e1df2c17} -\index{ciot\_serializer.h@{ciot\_serializer.h}!ciot\_serializer\_to\_bytes@{ciot\_serializer\_to\_bytes}} -\index{ciot\_serializer\_to\_bytes@{ciot\_serializer\_to\_bytes}!ciot\_serializer.h@{ciot\_serializer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_serializer\_to\_bytes()}{ciot\_serializer\_to\_bytes()}} -{\footnotesize\ttfamily int ciot\+\_\+serializer\+\_\+to\+\_\+bytes (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{bytes, }\item[{\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{msg }\end{DoxyParamCaption})} - - - -Serialize a CIOT message to bytes using the specified serializer. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Serializer instance. \\ -\hline -{\em bytes} & Destination buffer for serialized data. \\ -\hline -{\em msg} & CIOT message to serialize. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Number of bytes serialized. -\end{DoxyReturn} diff --git a/docs/latex/ciot__serializer_8h_source.tex b/docs/latex/ciot__serializer_8h_source.tex deleted file mode 100644 index 18a0edc..0000000 --- a/docs/latex/ciot__serializer_8h_source.tex +++ /dev/null @@ -1,46 +0,0 @@ -\doxysection{ciot\+\_\+serializer.\+h} -\hypertarget{ciot__serializer_8h_source}{}\label{ciot__serializer_8h_source}\index{include/ciot\_serializer.h@{include/ciot\_serializer.h}} -\mbox{\hyperlink{ciot__serializer_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_SERIALIZER\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_SERIALIZER\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__msg__types_8h}{types/ciot\_msg\_types.h}}"{}}} -\DoxyCodeLine{00015\ } -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00017\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__serializer}{ciot\_serializer}}\ *\mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\_serializer\_t}};} -\DoxyCodeLine{00024\ } -\DoxyCodeLine{00032\ \textcolor{keyword}{typedef}\ int\ (\mbox{\hyperlink{ciot__serializer_8h_ad5f4d77f37d8f97c45e7ac3684c6240d}{ciot\_serializer\_to\_bytes\_fn}})(uint8\_t\ *bytes,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg);} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00042\ \textcolor{keyword}{typedef}\ int\ (\mbox{\hyperlink{ciot__serializer_8h_ad4e6ec6f4f6b2794af860108e701a284}{ciot\_serializer\_from\_bytes\_fn}})(\mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg,\ uint8\_t\ *bytes,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00043\ } -\DoxyCodeLine{00047\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702b}{ciot\_serializer\_type}}} -\DoxyCodeLine{00048\ \{} -\DoxyCodeLine{00049\ \ \ \ \ \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba1628b71e70eb2dcf89b24e63d9d86289}{CIOT\_SERIALIZER\_TYPE\_NONE}},\ \ \ } -\DoxyCodeLine{00050\ \ \ \ \ \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba0f0db27db7f111da963526dfface091e}{CIOT\_SERIALIZER\_TYPE\_PROTOBUF}},\ } -\DoxyCodeLine{00051\ \ \ \ \ \mbox{\hyperlink{ciot__serializer_8h_ae62dc58498158eda5c753d6c3397702ba6d5cb551c26a7529e01e27c64dbc2a7a}{CIOT\_SERIALIZER\_TYPE\_CUSTOM}},\ \ } -\DoxyCodeLine{00052\ \}\ \mbox{\hyperlink{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7}{ciot\_serializer\_type\_t}};} -\DoxyCodeLine{00053\ } -\DoxyCodeLine{00057\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__serializer}{ciot\_serializer}}} -\DoxyCodeLine{00058\ \{} -\DoxyCodeLine{00059\ \ \ \ \ \mbox{\hyperlink{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7}{ciot\_serializer\_type\_t}}\ \mbox{\hyperlink{structciot__serializer_a592dc1023ebe4d8247de4f601b4c20f5}{type}};\ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00060\ \ \ \ \ \mbox{\hyperlink{ciot__serializer_8h_ad5f4d77f37d8f97c45e7ac3684c6240d}{ciot\_serializer\_to\_bytes\_fn}}\ *\mbox{\hyperlink{structciot__serializer_a5134e67f23ff9c0bf8efd1e393d8d2c1}{to\_bytes}};\ \ } -\DoxyCodeLine{00061\ \ \ \ \ \mbox{\hyperlink{ciot__serializer_8h_ad4e6ec6f4f6b2794af860108e701a284}{ciot\_serializer\_from\_bytes\_fn}}\ *\mbox{\hyperlink{structciot__serializer_a54d8784095e9490e44f8ddc37679ef81}{from\_bytes}};\ } -\DoxyCodeLine{00062\ \};} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00072\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{ciot__serializer_8h_acce586f0c1adcf56d07b5c09e1df2c17}{ciot\_serializer\_to\_bytes}}(\mbox{\hyperlink{structciot__serializer}{ciot\_serializer\_t}}\ self,\ uint8\_t\ *bytes,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg);} -\DoxyCodeLine{00073\ } -\DoxyCodeLine{00083\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{ciot__serializer_8h_a2e6ad3f65b3277042564ae00d1ea9522}{ciot\_serializer\_from\_bytes}}(\mbox{\hyperlink{structciot__serializer}{ciot\_serializer\_t}}\ self,\ \mbox{\hyperlink{structciot__msg__t}{ciot\_msg\_t}}\ *msg,\ uint8\_t\ *bytes,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00085\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00086\ \}} -\DoxyCodeLine{00087\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00088\ } -\DoxyCodeLine{00089\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__slip_8h.tex b/docs/latex/ciot__slip_8h.tex deleted file mode 100644 index ae13f30..0000000 --- a/docs/latex/ciot__slip_8h.tex +++ /dev/null @@ -1,145 +0,0 @@ -\doxysection{include/ciot\+\_\+slip.h File Reference} -\hypertarget{ciot__slip_8h}{}\label{ciot__slip_8h}\index{include/ciot\_slip.h@{include/ciot\_slip.h}} - - -This module encodes and decodes SLIP packages. - - -{\ttfamily \#include $<$stdint.\+h$>$}\newline -{\ttfamily \#include $<$string.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__slip__t}{ciot\+\_\+slip\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Representation of a SLIP packet. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+DECODING}} -, \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+ESC\+\_\+\+RECEIVED}} -, \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+CLEARING\+\_\+\+INVALID\+\_\+\+PACKET}} - \} -\begin{DoxyCompactList}\small\item\em Status information that is used while receiving and decoding a packet. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -int \mbox{\hyperlink{ciot__slip_8h_a31ccb83d79170663a4a74c3a073b6d45}{ciot\+\_\+slip\+\_\+encode}} (uint8\+\_\+t \texorpdfstring{$\ast$}{*}p\+\_\+output, uint8\+\_\+t \texorpdfstring{$\ast$}{*}p\+\_\+input, uint32\+\_\+t input\+\_\+length, uint32\+\_\+t \texorpdfstring{$\ast$}{*}p\+\_\+output\+\_\+buffer\+\_\+length) -\begin{DoxyCompactList}\small\item\em Function for encoding a SLIP packet. \end{DoxyCompactList}\item -int \mbox{\hyperlink{ciot__slip_8h_a13b065e0e7ef6b2b98aa59e136929654}{ciot\+\_\+slip\+\_\+decode\+\_\+add\+\_\+byte}} (\mbox{\hyperlink{structciot__slip__t}{ciot\+\_\+slip\+\_\+t}} \texorpdfstring{$\ast$}{*}p\+\_\+slip, uint8\+\_\+t c) -\begin{DoxyCompactList}\small\item\em Function for decoding a SLIP packet. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -This module encodes and decodes SLIP packages. - -Copyright (c) 2015 -\/ 2017, Nordic Semiconductor ASA - -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met\+: - - -\begin{DoxyEnumerate} -\item Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -\item Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA integrated circuit in a product or a software update for such product, must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -\item Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. -\item This software, with or without modification, must only be used with a Nordic Semiconductor ASA integrated circuit. -\item Any software provided in binary form under this license must not be reverse engineered, decompiled, modified and/or disassembled. -\end{DoxyEnumerate} - -THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "{}\+AS IS"{} AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -The SLIP protocol is described in @link\+SLIP. - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}\label{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1} -\index{ciot\_slip.h@{ciot\_slip.h}!ciot\_slip\_read\_state\_t@{ciot\_slip\_read\_state\_t}} -\index{ciot\_slip\_read\_state\_t@{ciot\_slip\_read\_state\_t}!ciot\_slip.h@{ciot\_slip.h}} -\doxysubsubsection{\texorpdfstring{ciot\_slip\_read\_state\_t}{ciot\_slip\_read\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}}} - - - -Status information that is used while receiving and decoding a packet. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SLIP\_STATE\_DECODING@{CIOT\_SLIP\_STATE\_DECODING}!ciot\_slip.h@{ciot\_slip.h}}\index{ciot\_slip.h@{ciot\_slip.h}!CIOT\_SLIP\_STATE\_DECODING@{CIOT\_SLIP\_STATE\_DECODING}}}\Hypertarget{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e}\label{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e} -CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+DECODING&Ready to receive the next byte. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SLIP\_STATE\_ESC\_RECEIVED@{CIOT\_SLIP\_STATE\_ESC\_RECEIVED}!ciot\_slip.h@{ciot\_slip.h}}\index{ciot\_slip.h@{ciot\_slip.h}!CIOT\_SLIP\_STATE\_ESC\_RECEIVED@{CIOT\_SLIP\_STATE\_ESC\_RECEIVED}}}\Hypertarget{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834}\label{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834} -CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+ESC\+\_\+\+RECEIVED&An ESC byte has been received and the next byte must be decoded differently. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET@{CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET}!ciot\_slip.h@{ciot\_slip.h}}\index{ciot\_slip.h@{ciot\_slip.h}!CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET@{CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET}}}\Hypertarget{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06}\label{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06} -CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+CLEARING\+\_\+\+INVALID\+\_\+\+PACKET&The received data is invalid and transfer must be restarted. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__slip_8h_a13b065e0e7ef6b2b98aa59e136929654}\label{ciot__slip_8h_a13b065e0e7ef6b2b98aa59e136929654} -\index{ciot\_slip.h@{ciot\_slip.h}!ciot\_slip\_decode\_add\_byte@{ciot\_slip\_decode\_add\_byte}} -\index{ciot\_slip\_decode\_add\_byte@{ciot\_slip\_decode\_add\_byte}!ciot\_slip.h@{ciot\_slip.h}} -\doxysubsubsection{\texorpdfstring{ciot\_slip\_decode\_add\_byte()}{ciot\_slip\_decode\_add\_byte()}} -{\footnotesize\ttfamily int ciot\+\_\+slip\+\_\+decode\+\_\+add\+\_\+byte (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structciot__slip__t}{ciot\+\_\+slip\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{p\+\_\+slip, }\item[{uint8\+\_\+t}]{c }\end{DoxyParamCaption})} - - - -Function for decoding a SLIP packet. - -The decoded packet is put into {\ttfamily p\+\_\+slip\+::p\+\_\+buffer}. The index and buffer state is updated. - -Ensure that {\ttfamily p\+\_\+slip} is properly initialized. The initial state must be set to \doxylink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+DECODING}. - - -\begin{DoxyParams}[1]{Parameters} -\mbox{\texttt{ in,out}} & {\em p\+\_\+slip} & State of the decoding process. \\ -\hline -\mbox{\texttt{ in}} & {\em c} & Byte to decode.\\ -\hline -\end{DoxyParams} - -\begin{DoxyRetVals}{Return values} -{\em NRF\+\_\+\+SUCCESS} & If a packet has been parsed. The received packet can be retrieved from {\ttfamily p\+\_\+slip}. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+NULL} & If {\ttfamily p\+\_\+slip} is NULL. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+NO\+\_\+\+MEM} & If there is no more room in the buffer provided by {\ttfamily p\+\_\+slip}. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+BUSY} & If the packet has not been parsed completely yet. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+INVALID\+\_\+\+DATA} & If the packet is encoded wrong. In this case, {\ttfamily p\+\_\+slip\+::state} is set to \doxylink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+CLEARING\+\_\+\+INVALID\+\_\+\+PACKET}, and decoding will stay in this state until the END byte is received. \\ -\hline -\end{DoxyRetVals} -\Hypertarget{ciot__slip_8h_a31ccb83d79170663a4a74c3a073b6d45}\label{ciot__slip_8h_a31ccb83d79170663a4a74c3a073b6d45} -\index{ciot\_slip.h@{ciot\_slip.h}!ciot\_slip\_encode@{ciot\_slip\_encode}} -\index{ciot\_slip\_encode@{ciot\_slip\_encode}!ciot\_slip.h@{ciot\_slip.h}} -\doxysubsubsection{\texorpdfstring{ciot\_slip\_encode()}{ciot\_slip\_encode()}} -{\footnotesize\ttfamily int ciot\+\_\+slip\+\_\+encode (\begin{DoxyParamCaption}\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{p\+\_\+output, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{p\+\_\+input, }\item[{uint32\+\_\+t}]{input\+\_\+length, }\item[{uint32\+\_\+t \texorpdfstring{$\ast$}{*}}]{p\+\_\+output\+\_\+buffer\+\_\+length }\end{DoxyParamCaption})} - - - -Function for encoding a SLIP packet. - -The maximum size of the output data is (2\texorpdfstring{$\ast$}{*}input size + 1) bytes. Ensure that the provided buffer is large enough. - - -\begin{DoxyParams}[1]{Parameters} -\mbox{\texttt{ in,out}} & {\em p\+\_\+output} & The buffer where the encoded SLIP packet is stored. Ensure that it is large enough. \\ -\hline -\mbox{\texttt{ in,out}} & {\em p\+\_\+input} & The buffer to be encoded. \\ -\hline -\mbox{\texttt{ in,out}} & {\em input\+\_\+length} & The length of the input buffer. \\ -\hline -\mbox{\texttt{ out}} & {\em p\+\_\+output\+\_\+buffer\+\_\+length} & The length of the output buffer after the input has been encoded.\\ -\hline -\end{DoxyParams} - -\begin{DoxyRetVals}{Return values} -{\em NRF\+\_\+\+SUCCESS} & If the input was successfully encoded into output. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+NULL} & If one of the provided parameters is NULL. \\ -\hline -\end{DoxyRetVals} diff --git a/docs/latex/ciot__slip_8h_source.tex b/docs/latex/ciot__slip_8h_source.tex deleted file mode 100644 index ac79b81..0000000 --- a/docs/latex/ciot__slip_8h_source.tex +++ /dev/null @@ -1,43 +0,0 @@ -\doxysection{ciot\+\_\+slip.\+h} -\hypertarget{ciot__slip_8h_source}{}\label{ciot__slip_8h_source}\index{include/ciot\_slip.h@{include/ciot\_slip.h}} -\mbox{\hyperlink{ciot__slip_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#ifndef\ CIOT\_SLIP\_H\_\_}} -\DoxyCodeLine{00041\ \textcolor{preprocessor}{\#define\ CIOT\_SLIP\_H\_\_}} -\DoxyCodeLine{00042\ } -\DoxyCodeLine{00043\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00044\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00045\ } -\DoxyCodeLine{00046\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00047\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}} -\DoxyCodeLine{00048\ \{} -\DoxyCodeLine{00049\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00050\ } -\DoxyCodeLine{00059\ \ \ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}} -\DoxyCodeLine{00060\ \ \ \{} -\DoxyCodeLine{00061\ \ \ \ \ \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e}{CIOT\_SLIP\_STATE\_DECODING}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00062\ \ \ \ \ \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834}{CIOT\_SLIP\_STATE\_ESC\_RECEIVED}},\ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00063\ \ \ \ \ \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06}{CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET}}\ } -\DoxyCodeLine{00064\ \ \ \}\ \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\_slip\_read\_state\_t}};} -\DoxyCodeLine{00065\ } -\DoxyCodeLine{00067\ \ \ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct}} -\DoxyCodeLine{00068\ \ \ \{} -\DoxyCodeLine{00069\ \ \ \ \ \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\_slip\_read\_state\_t}}\ \mbox{\hyperlink{structciot__slip__t_accaf0db15b7c2817f00fed318f13fe5b}{state}};\ } -\DoxyCodeLine{00070\ } -\DoxyCodeLine{00071\ \ \ \ \ uint8\_t\ *\mbox{\hyperlink{structciot__slip__t_a247b6cc8b5cd8bd49b0c4c62ed59f7b8}{p\_buffer}};\ \ \ \ \ \ } -\DoxyCodeLine{00072\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__slip__t_ad1e3bc5a59e7ed48387fb95383fae12f}{current\_index}};\ } -\DoxyCodeLine{00073\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__slip__t_a899cec1e08bcfa497396baa3584d18e1}{buffer\_len}};\ \ \ \ } -\DoxyCodeLine{00074\ \ \ \}\ \mbox{\hyperlink{structciot__slip__t}{ciot\_slip\_t}};} -\DoxyCodeLine{00075\ } -\DoxyCodeLine{00088\ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{ciot__slip_8h_a31ccb83d79170663a4a74c3a073b6d45}{ciot\_slip\_encode}}(uint8\_t\ *p\_output,\ uint8\_t\ *p\_input,\ uint32\_t\ input\_length,\ uint32\_t\ *p\_output\_buffer\_length);} -\DoxyCodeLine{00089\ } -\DoxyCodeLine{00106\ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{ciot__slip_8h_a13b065e0e7ef6b2b98aa59e136929654}{ciot\_slip\_decode\_add\_byte}}(\mbox{\hyperlink{structciot__slip__t}{ciot\_slip\_t}}\ *p\_slip,\ uint8\_t\ c);} -\DoxyCodeLine{00107\ } -\DoxyCodeLine{00108\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00109\ \}} -\DoxyCodeLine{00110\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00111\ } -\DoxyCodeLine{00112\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{//\ CIOT\_SLIP\_H\_\_}} - -\end{DoxyCode} diff --git a/docs/latex/ciot__storage_8h.tex b/docs/latex/ciot__storage_8h.tex deleted file mode 100644 index f0299a9..0000000 --- a/docs/latex/ciot__storage_8h.tex +++ /dev/null @@ -1,273 +0,0 @@ -\doxysection{include/ciot\+\_\+storage.h File Reference} -\hypertarget{ciot__storage_8h}{}\label{ciot__storage_8h}\index{include/ciot\_storage.h@{include/ciot\_storage.h}} - - -Header file for CIOT Storage module. - - -{\ttfamily \#include "{}types/ciot\+\_\+storage\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__storage__status__msg__t}{ciot\+\_\+storage\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT Storage status message structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+storage \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT Storage instance pointer. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_a4f5d3c6bb977f52bb50f491526710e1e}{ciot\+\_\+storage\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT Storage instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_a03cb31fbd7d15d42639eca3b35e681b7}{ciot\+\_\+storage\+\_\+init}} (void) -\begin{DoxyCompactList}\small\item\em Initialize the CIOT Storage module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_ade9c8a3a8b08bfbef4d4b7431ec5a740}{ciot\+\_\+storage\+\_\+start}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self, \mbox{\hyperlink{structciot__storage__cfg__t}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT Storage module with the given configuration. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_ac895b62ff9edf0c92bd9223e66c752ec}{ciot\+\_\+storage\+\_\+stop}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT Storage module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_a7d7c52b2cee69e6b7c23be1ecc8ed0d7}{ciot\+\_\+storage\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self, \mbox{\hyperlink{structciot__storage__req__t}{ciot\+\_\+storage\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a storage request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_aa54c8242169de35f8bf2a6a074cc6945}{ciot\+\_\+storage\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data using the CIOT Storage module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_ae217d8018730853ce5e77e5c11b8ce4d}{ciot\+\_\+storage\+\_\+save}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self, char \texorpdfstring{$\ast$}{*}path, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Save data to storage. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_a5dc173d4e3d285404c40f975c5ebff7d}{ciot\+\_\+storage\+\_\+load}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self, char \texorpdfstring{$\ast$}{*}path, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Load data from storage. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_a3ef2b7405e84549b877fc3ff56573a70}{ciot\+\_\+storage\+\_\+delete}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self, char \texorpdfstring{$\ast$}{*}path) -\begin{DoxyCompactList}\small\item\em Delete data from storage. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__storage_8h_a2ba18ab68d78441277427d4d5d17d8e2}{ciot\+\_\+storage\+\_\+format}} (\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Format the storage. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT Storage module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/04 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}\label{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_t@{ciot\_storage\_t}} -\index{ciot\_storage\_t@{ciot\_storage\_t}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_t}{ciot\_storage\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+storage\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}} - - - -CIOT Storage instance pointer. - - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__storage_8h_a3ef2b7405e84549b877fc3ff56573a70}\label{ciot__storage_8h_a3ef2b7405e84549b877fc3ff56573a70} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_delete@{ciot\_storage\_delete}} -\index{ciot\_storage\_delete@{ciot\_storage\_delete}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_delete()}{ciot\_storage\_delete()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+delete (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self, }\item[{char \texorpdfstring{$\ast$}{*}}]{path }\end{DoxyParamCaption})} - - - -Delete data from storage. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -{\em path} & Path of the data to delete. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_a2ba18ab68d78441277427d4d5d17d8e2}\label{ciot__storage_8h_a2ba18ab68d78441277427d4d5d17d8e2} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_format@{ciot\_storage\_format}} -\index{ciot\_storage\_format@{ciot\_storage\_format}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_format()}{ciot\_storage\_format()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+format (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Format the storage. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_a03cb31fbd7d15d42639eca3b35e681b7}\label{ciot__storage_8h_a03cb31fbd7d15d42639eca3b35e681b7} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_init@{ciot\_storage\_init}} -\index{ciot\_storage\_init@{ciot\_storage\_init}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_init()}{ciot\_storage\_init()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+init (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -Initialize the CIOT Storage module. - -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_a5dc173d4e3d285404c40f975c5ebff7d}\label{ciot__storage_8h_a5dc173d4e3d285404c40f975c5ebff7d} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_load@{ciot\_storage\_load}} -\index{ciot\_storage\_load@{ciot\_storage\_load}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_load()}{ciot\_storage\_load()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+load (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self, }\item[{char \texorpdfstring{$\ast$}{*}}]{path, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Load data from storage. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -{\em path} & Path from where data will be loaded. \\ -\hline -{\em data} & Pointer to store the loaded data. \\ -\hline -{\em size} & Size of the data buffer in bytes. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_a4f5d3c6bb977f52bb50f491526710e1e}\label{ciot__storage_8h_a4f5d3c6bb977f52bb50f491526710e1e} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_new@{ciot\_storage\_new}} -\index{ciot\_storage\_new@{ciot\_storage\_new}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_new()}{ciot\_storage\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} ciot\+\_\+storage\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT Storage instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the storage handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT Storage instance pointer. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_a7d7c52b2cee69e6b7c23be1ecc8ed0d7}\label{ciot__storage_8h_a7d7c52b2cee69e6b7c23be1ecc8ed0d7} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_process\_req@{ciot\_storage\_process\_req}} -\index{ciot\_storage\_process\_req@{ciot\_storage\_process\_req}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_process\_req()}{ciot\_storage\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__storage__req__t}{ciot\+\_\+storage\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a storage request. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -{\em req} & Storage request to process. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_ae217d8018730853ce5e77e5c11b8ce4d}\label{ciot__storage_8h_ae217d8018730853ce5e77e5c11b8ce4d} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_save@{ciot\_storage\_save}} -\index{ciot\_storage\_save@{ciot\_storage\_save}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_save()}{ciot\_storage\_save()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+save (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self, }\item[{char \texorpdfstring{$\ast$}{*}}]{path, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Save data to storage. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -{\em path} & Path where data will be saved. \\ -\hline -{\em data} & Pointer to the data to save. \\ -\hline -{\em size} & Size of the data in bytes. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_aa54c8242169de35f8bf2a6a074cc6945}\label{ciot__storage_8h_aa54c8242169de35f8bf2a6a074cc6945} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_send\_data@{ciot\_storage\_send\_data}} -\index{ciot\_storage\_send\_data@{ciot\_storage\_send\_data}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_send\_data()}{ciot\_storage\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data using the CIOT Storage module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -{\em data} & Pointer to the data to be sent. \\ -\hline -{\em size} & Size of the data in bytes. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_ade9c8a3a8b08bfbef4d4b7431ec5a740}\label{ciot__storage_8h_ade9c8a3a8b08bfbef4d4b7431ec5a740} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_start@{ciot\_storage\_start}} -\index{ciot\_storage\_start@{ciot\_storage\_start}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_start()}{ciot\_storage\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__storage__cfg__t}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT Storage module with the given configuration. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -{\em cfg} & Configuration for the storage module. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__storage_8h_ac895b62ff9edf0c92bd9223e66c752ec}\label{ciot__storage_8h_ac895b62ff9edf0c92bd9223e66c752ec} -\index{ciot\_storage.h@{ciot\_storage.h}!ciot\_storage\_stop@{ciot\_storage\_stop}} -\index{ciot\_storage\_stop@{ciot\_storage\_stop}!ciot\_storage.h@{ciot\_storage.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_stop()}{ciot\_storage\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+storage\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT Storage module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT Storage instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot__storage_8h_source.tex b/docs/latex/ciot__storage_8h_source.tex deleted file mode 100644 index b956345..0000000 --- a/docs/latex/ciot__storage_8h_source.tex +++ /dev/null @@ -1,51 +0,0 @@ -\doxysection{ciot\+\_\+storage.\+h} -\hypertarget{ciot__storage_8h_source}{}\label{ciot__storage_8h_source}\index{include/ciot\_storage.h@{include/ciot\_storage.h}} -\mbox{\hyperlink{ciot__storage_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_STORAGE\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_STORAGE\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__storage__types_8h}{types/ciot\_storage\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_storage\ *\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}};} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00031\ \{} -\DoxyCodeLine{00032\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__storage__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ \ \ \ \ \ } -\DoxyCodeLine{00033\ \ \ \ \ \mbox{\hyperlink{structciot__storage__status__t}{ciot\_storage\_status\_t}}\ \mbox{\hyperlink{structciot__storage__status__msg__t_ac1a66aa256f203858bb2477b812e36fb}{status}};\ \ } -\DoxyCodeLine{00034\ \}\ \mbox{\hyperlink{structciot__storage__status__msg__t}{ciot\_storage\_status\_msg\_t}};} -\DoxyCodeLine{00035\ } -\DoxyCodeLine{00042\ \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ \mbox{\hyperlink{ciot__storage_8h_a4f5d3c6bb977f52bb50f491526710e1e}{ciot\_storage\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00043\ } -\DoxyCodeLine{00049\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_a03cb31fbd7d15d42639eca3b35e681b7}{ciot\_storage\_init}}(\textcolor{keywordtype}{void});} -\DoxyCodeLine{00050\ } -\DoxyCodeLine{00058\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_ade9c8a3a8b08bfbef4d4b7431ec5a740}{ciot\_storage\_start}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self,\ \mbox{\hyperlink{structciot__storage__cfg__t}{ciot\_storage\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00059\ } -\DoxyCodeLine{00066\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_ac895b62ff9edf0c92bd9223e66c752ec}{ciot\_storage\_stop}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self);} -\DoxyCodeLine{00067\ } -\DoxyCodeLine{00075\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_a7d7c52b2cee69e6b7c23be1ecc8ed0d7}{ciot\_storage\_process\_req}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self,\ \mbox{\hyperlink{structciot__storage__req__t}{ciot\_storage\_req\_t}}\ *req);} -\DoxyCodeLine{00076\ } -\DoxyCodeLine{00085\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_aa54c8242169de35f8bf2a6a074cc6945}{ciot\_storage\_send\_data}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00086\ } -\DoxyCodeLine{00096\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_ae217d8018730853ce5e77e5c11b8ce4d}{ciot\_storage\_save}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self,\ \textcolor{keywordtype}{char}\ *path,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00097\ } -\DoxyCodeLine{00107\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_a5dc173d4e3d285404c40f975c5ebff7d}{ciot\_storage\_load}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self,\ \textcolor{keywordtype}{char}\ *path,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00108\ } -\DoxyCodeLine{00116\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_a3ef2b7405e84549b877fc3ff56573a70}{ciot\_storage\_delete}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self,\ \textcolor{keywordtype}{char}\ *path);} -\DoxyCodeLine{00117\ } -\DoxyCodeLine{00124\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__storage_8h_a2ba18ab68d78441277427d4d5d17d8e2}{ciot\_storage\_format}}(\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\_storage\_t}}\ self);} -\DoxyCodeLine{00125\ } -\DoxyCodeLine{00126\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00127\ \}} -\DoxyCodeLine{00128\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00129\ } -\DoxyCodeLine{00130\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__storage__types_8h.tex b/docs/latex/ciot__storage__types_8h.tex deleted file mode 100644 index 51e79f2..0000000 --- a/docs/latex/ciot__storage__types_8h.tex +++ /dev/null @@ -1,138 +0,0 @@ -\doxysection{include/types/ciot\+\_\+storage\+\_\+types.h File Reference} -\hypertarget{ciot__storage__types_8h}{}\label{ciot__storage__types_8h}\index{include/types/ciot\_storage\_types.h@{include/types/ciot\_storage\_types.h}} - - -Defines data types and structures for CIOT storage functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__storage__cfg__t}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT storage configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__storage__status__t}{ciot\+\_\+storage\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT storage status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__storage__req__file__data__t}{ciot\+\_\+storage\+\_\+req\+\_\+file\+\_\+data\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT storage file data in a request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__storage__req__t}{ciot\+\_\+storage\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT storage request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__storage__data__u}{ciot\+\_\+storage\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT storage data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239}{ciot\+\_\+storage\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a83d3bc245d343102f7a7ac18b036aceb}{CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239afc4a37eba78791073c18a5f63c03aeb4}{CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+EEPROM}} -, \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239adb7bbd45322a2e288bd6915ce487bbf0}{CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+FLASH}} -, \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a5888e89d9b87b625ea64913fdbf4b9ae}{CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+FS}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT storage types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86}{ciot\+\_\+storage\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86ac1049db8c3ea10d4f1e581674021e625}{CIOT\+\_\+\+STORAGE\+\_\+\+STATE\+\_\+\+IDLE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT storage state. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541}{ciot\+\_\+storage\+\_\+req\+\_\+type\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a4689fd1c078349f1583ecdbeaf7da85b}{CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a6218cd2bd3e86d2c74b59c95e3466a8e}{CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+SAVE}} -, \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541aba02c3e6c860284b2f06654a8977bf23}{CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+LOAD}} -, \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541af284b0fcdf84425bbd7ea1fedc16ae89}{CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+DELETE}} -, \newline -\mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a3dadf7c4810cb89e7bf75d0e1624db9a}{CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+FORMAT}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT storage request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT storage functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541}\label{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541} -\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!ciot\_storage\_req\_type\_t@{ciot\_storage\_req\_type\_t}} -\index{ciot\_storage\_req\_type\_t@{ciot\_storage\_req\_type\_t}!ciot\_storage\_types.h@{ciot\_storage\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_req\_type\_t}{ciot\_storage\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541}{ciot\+\_\+storage\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT storage request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_REQ\_UNKNOWN@{CIOT\_STORAGE\_REQ\_UNKNOWN}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_REQ\_UNKNOWN@{CIOT\_STORAGE\_REQ\_UNKNOWN}}}\Hypertarget{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a4689fd1c078349f1583ecdbeaf7da85b}\label{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a4689fd1c078349f1583ecdbeaf7da85b} -CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown storage request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_REQ\_SAVE@{CIOT\_STORAGE\_REQ\_SAVE}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_REQ\_SAVE@{CIOT\_STORAGE\_REQ\_SAVE}}}\Hypertarget{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a6218cd2bd3e86d2c74b59c95e3466a8e}\label{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a6218cd2bd3e86d2c74b59c95e3466a8e} -CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+SAVE&Save data request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_REQ\_LOAD@{CIOT\_STORAGE\_REQ\_LOAD}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_REQ\_LOAD@{CIOT\_STORAGE\_REQ\_LOAD}}}\Hypertarget{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541aba02c3e6c860284b2f06654a8977bf23}\label{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541aba02c3e6c860284b2f06654a8977bf23} -CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+LOAD&Load data request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_REQ\_DELETE@{CIOT\_STORAGE\_REQ\_DELETE}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_REQ\_DELETE@{CIOT\_STORAGE\_REQ\_DELETE}}}\Hypertarget{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541af284b0fcdf84425bbd7ea1fedc16ae89}\label{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541af284b0fcdf84425bbd7ea1fedc16ae89} -CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+DELETE&Delete data request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_REQ\_FORMAT@{CIOT\_STORAGE\_REQ\_FORMAT}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_REQ\_FORMAT@{CIOT\_STORAGE\_REQ\_FORMAT}}}\Hypertarget{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a3dadf7c4810cb89e7bf75d0e1624db9a}\label{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a3dadf7c4810cb89e7bf75d0e1624db9a} -CIOT\+\_\+\+STORAGE\+\_\+\+REQ\+\_\+\+FORMAT&Format storage request \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86}\label{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86} -\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!ciot\_storage\_state\_t@{ciot\_storage\_state\_t}} -\index{ciot\_storage\_state\_t@{ciot\_storage\_state\_t}!ciot\_storage\_types.h@{ciot\_storage\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_state\_t}{ciot\_storage\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86}{ciot\+\_\+storage\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT storage state. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_STATE\_IDLE@{CIOT\_STORAGE\_STATE\_IDLE}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_STATE\_IDLE@{CIOT\_STORAGE\_STATE\_IDLE}}}\Hypertarget{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86ac1049db8c3ea10d4f1e581674021e625}\label{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86ac1049db8c3ea10d4f1e581674021e625} -CIOT\+\_\+\+STORAGE\+\_\+\+STATE\+\_\+\+IDLE&Storage state\+: idle \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239}\label{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239} -\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!ciot\_storage\_type\_t@{ciot\_storage\_type\_t}} -\index{ciot\_storage\_type\_t@{ciot\_storage\_type\_t}!ciot\_storage\_types.h@{ciot\_storage\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_storage\_type\_t}{ciot\_storage\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239}{ciot\+\_\+storage\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT storage types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_TYPE\_UNKNOWN@{CIOT\_STORAGE\_TYPE\_UNKNOWN}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_TYPE\_UNKNOWN@{CIOT\_STORAGE\_TYPE\_UNKNOWN}}}\Hypertarget{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a83d3bc245d343102f7a7ac18b036aceb}\label{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a83d3bc245d343102f7a7ac18b036aceb} -CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+UNKNOWN&Unknown storage type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_TYPE\_EEPROM@{CIOT\_STORAGE\_TYPE\_EEPROM}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_TYPE\_EEPROM@{CIOT\_STORAGE\_TYPE\_EEPROM}}}\Hypertarget{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239afc4a37eba78791073c18a5f63c03aeb4}\label{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239afc4a37eba78791073c18a5f63c03aeb4} -CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+EEPROM&EEPROM storage type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_TYPE\_FLASH@{CIOT\_STORAGE\_TYPE\_FLASH}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_TYPE\_FLASH@{CIOT\_STORAGE\_TYPE\_FLASH}}}\Hypertarget{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239adb7bbd45322a2e288bd6915ce487bbf0}\label{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239adb7bbd45322a2e288bd6915ce487bbf0} -CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+FLASH&Flash storage type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STORAGE\_TYPE\_FS@{CIOT\_STORAGE\_TYPE\_FS}!ciot\_storage\_types.h@{ciot\_storage\_types.h}}\index{ciot\_storage\_types.h@{ciot\_storage\_types.h}!CIOT\_STORAGE\_TYPE\_FS@{CIOT\_STORAGE\_TYPE\_FS}}}\Hypertarget{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a5888e89d9b87b625ea64913fdbf4b9ae}\label{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a5888e89d9b87b625ea64913fdbf4b9ae} -CIOT\+\_\+\+STORAGE\+\_\+\+TYPE\+\_\+\+FS&Filesystem storage type \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__storage__types_8h_source.tex b/docs/latex/ciot__storage__types_8h_source.tex deleted file mode 100644 index ef4a96a..0000000 --- a/docs/latex/ciot__storage__types_8h_source.tex +++ /dev/null @@ -1,73 +0,0 @@ -\doxysection{ciot\+\_\+storage\+\_\+types.\+h} -\hypertarget{ciot__storage__types_8h_source}{}\label{ciot__storage__types_8h_source}\index{include/types/ciot\_storage\_types.h@{include/types/ciot\_storage\_types.h}} -\mbox{\hyperlink{ciot__storage__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_STORAGE\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_STORAGE\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a83d3bc245d343102f7a7ac18b036aceb}{CIOT\_STORAGE\_TYPE\_UNKNOWN}},\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239afc4a37eba78791073c18a5f63c03aeb4}{CIOT\_STORAGE\_TYPE\_EEPROM}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239adb7bbd45322a2e288bd6915ce487bbf0}{CIOT\_STORAGE\_TYPE\_FLASH}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239a5888e89d9b87b625ea64913fdbf4b9ae}{CIOT\_STORAGE\_TYPE\_FS}},\ } -\DoxyCodeLine{00029\ \}\ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239}{ciot\_storage\_type\_t}};} -\DoxyCodeLine{00030\ } -\DoxyCodeLine{00034\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00035\ \{} -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86ac1049db8c3ea10d4f1e581674021e625}{CIOT\_STORAGE\_STATE\_IDLE}},\ } -\DoxyCodeLine{00037\ \}\ \mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86}{ciot\_storage\_state\_t}};} -\DoxyCodeLine{00038\ } -\DoxyCodeLine{00042\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00043\ \{} -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a4689fd1c078349f1583ecdbeaf7da85b}{CIOT\_STORAGE\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a6218cd2bd3e86d2c74b59c95e3466a8e}{CIOT\_STORAGE\_REQ\_SAVE}},\ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541aba02c3e6c860284b2f06654a8977bf23}{CIOT\_STORAGE\_REQ\_LOAD}},\ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541af284b0fcdf84425bbd7ea1fedc16ae89}{CIOT\_STORAGE\_REQ\_DELETE}},\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541a3dadf7c4810cb89e7bf75d0e1624db9a}{CIOT\_STORAGE\_REQ\_FORMAT}},\ } -\DoxyCodeLine{00049\ \}\ \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541}{ciot\_storage\_req\_type\_t}};} -\DoxyCodeLine{00050\ } -\DoxyCodeLine{00054\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00055\ \{} -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239}{ciot\_storage\_type\_t}}\ \mbox{\hyperlink{structciot__storage__cfg__t_aa03a710482f738f9fe6095f1d4c6774a}{type}};\ } -\DoxyCodeLine{00057\ \}\ \mbox{\hyperlink{structciot__storage__cfg__t}{ciot\_storage\_cfg\_t}};} -\DoxyCodeLine{00058\ } -\DoxyCodeLine{00062\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00063\ \{} -\DoxyCodeLine{00064\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86}{ciot\_storage\_state\_t}}\ \mbox{\hyperlink{structciot__storage__status__t_aabc97b8fe1b1624b67ee7bc472d5b0b0}{state}};\ } -\DoxyCodeLine{00065\ \}\ \mbox{\hyperlink{structciot__storage__status__t}{ciot\_storage\_status\_t}};} -\DoxyCodeLine{00066\ } -\DoxyCodeLine{00070\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00071\ \{} -\DoxyCodeLine{00072\ \ \ \ \ \textcolor{keywordtype}{char}\ path[16];\ } -\DoxyCodeLine{00073\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__storage__req__file__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0}{size}};\ } -\DoxyCodeLine{00074\ \ \ \ \ uint8\_t\ data[255];\ } -\DoxyCodeLine{00075\ \}\ \mbox{\hyperlink{structciot__storage__req__file__data__t}{ciot\_storage\_req\_file\_data\_t}};} -\DoxyCodeLine{00076\ } -\DoxyCodeLine{00080\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00081\ \{} -\DoxyCodeLine{00082\ \ \ \ \ \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541}{ciot\_storage\_req\_type\_t}}\ \mbox{\hyperlink{structciot__storage__req__t_a7b3cbcb3aea8c25ecc00d1316d1a79d6}{type}};\ } -\DoxyCodeLine{00083\ \ \ \ \ \mbox{\hyperlink{structciot__storage__req__file__data__t}{ciot\_storage\_req\_file\_data\_t}}\ \mbox{\hyperlink{structciot__storage__req__t_a6b5e08e2800e812e2ee5294c83ac9fe6}{data}};\ } -\DoxyCodeLine{00084\ \}\ \mbox{\hyperlink{structciot__storage__req__t}{ciot\_storage\_req\_t}};} -\DoxyCodeLine{00085\ } -\DoxyCodeLine{00089\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00090\ \{} -\DoxyCodeLine{00091\ \ \ \ \ \mbox{\hyperlink{structciot__storage__cfg__t}{ciot\_storage\_cfg\_t}}\ \mbox{\hyperlink{unionciot__storage__data__u_aabe6a902449529e66a1bb460116af784}{config}};\ } -\DoxyCodeLine{00092\ \ \ \ \ \mbox{\hyperlink{structciot__storage__status__t}{ciot\_storage\_status\_t}}\ \mbox{\hyperlink{unionciot__storage__data__u_ac1a66aa256f203858bb2477b812e36fb}{status}};\ } -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{structciot__storage__req__t}{ciot\_storage\_req\_t}}\ \mbox{\hyperlink{unionciot__storage__data__u_ae35bc5d21998e1401aa886359cafd044}{request}};\ } -\DoxyCodeLine{00094\ \}\ \mbox{\hyperlink{unionciot__storage__data__u}{ciot\_storage\_data\_u}};} -\DoxyCodeLine{00095\ } -\DoxyCodeLine{00096\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00097\ \}} -\DoxyCodeLine{00098\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00099\ } -\DoxyCodeLine{00100\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__sys_8h.tex b/docs/latex/ciot__sys_8h.tex deleted file mode 100644 index fe77a9a..0000000 --- a/docs/latex/ciot__sys_8h.tex +++ /dev/null @@ -1,296 +0,0 @@ -\doxysection{include/ciot\+\_\+sys.h File Reference} -\hypertarget{ciot__sys_8h}{}\label{ciot__sys_8h}\index{include/ciot\_sys.h@{include/ciot\_sys.h}} - - -Header file for CIOT System module. - - -{\ttfamily \#include "{}types/ciot\+\_\+sys\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__sys__status__msg__t}{ciot\+\_\+sys\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT System status message structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__sys_8h_a3a3e986404de91f1c9943996fd1b7c2b}{CIOT\+\_\+\+SYS\+\_\+\+EVT\+\_\+\+BIT\+\_\+\+POOLING}}~0x00000001 -\begin{DoxyCompactList}\small\item\em Event bit for CIOT System module. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+sys \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT System instance pointer. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a22dbbf411c0235ce565adc505434a6c5}{ciot\+\_\+sys\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT System instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a4e0bd89f65a81feced88a3b45bf7f541}{ciot\+\_\+sys\+\_\+start}} (\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} self, \mbox{\hyperlink{structciot__sys__cfg__t}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT System module with the given configuration. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a1e3d326166a820fc5716b2516bcca0c3}{ciot\+\_\+sys\+\_\+stop}} (\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT System module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a06ce22313cfa75dd3862bf9125cd845c}{ciot\+\_\+sys\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} self, \mbox{\hyperlink{structciot__sys__req__t}{ciot\+\_\+sys\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a system request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a5fbca2415ce7a76809907b5d3217098b}{ciot\+\_\+sys\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data using the CIOT System module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_afcb34bf8efb97cfc6f0e87c417508147}{ciot\+\_\+sys\+\_\+rst}} (\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Reset the CIOT System module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a3a9c0875c8a82a6927c7bc27294092c4}{ciot\+\_\+sys\+\_\+task}} (\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Perform system task operations. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_ae3972ff066bf63bde44841a4c6052a14}{ciot\+\_\+sys\+\_\+set\+\_\+event\+\_\+bits}} (\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} self, int event\+\_\+bits) -\begin{DoxyCompactList}\small\item\em Set event bits for the CIOT System module. \end{DoxyCompactList}\item -void \mbox{\hyperlink{ciot__sys_8h_a642db3584c187d4bfa8b34dca84ea9f8}{ciot\+\_\+sys\+\_\+sleep}} (long ms) -\begin{DoxyCompactList}\small\item\em Put the system to sleep for the specified duration. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a5e7145c78ed2af300b57879b856478af}{ciot\+\_\+sys\+\_\+update\+\_\+features}} (\mbox{\hyperlink{structciot__sys__features__t}{ciot\+\_\+sys\+\_\+features\+\_\+t}} \texorpdfstring{$\ast$}{*}features) -\begin{DoxyCompactList}\small\item\em Update system features with the given features configuration. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\+\_\+sys\+\_\+hw\+\_\+t}} \mbox{\hyperlink{ciot__sys_8h_a7a01e9dc69f9e38add4b67f5d5353c65}{ciot\+\_\+sys\+\_\+get\+\_\+hw}} (void) -\begin{DoxyCompactList}\small\item\em Get the hardware information of the system. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT System module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__sys_8h_a3a3e986404de91f1c9943996fd1b7c2b}\label{ciot__sys_8h_a3a3e986404de91f1c9943996fd1b7c2b} -\index{ciot\_sys.h@{ciot\_sys.h}!CIOT\_SYS\_EVT\_BIT\_POOLING@{CIOT\_SYS\_EVT\_BIT\_POOLING}} -\index{CIOT\_SYS\_EVT\_BIT\_POOLING@{CIOT\_SYS\_EVT\_BIT\_POOLING}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_SYS\_EVT\_BIT\_POOLING}{CIOT\_SYS\_EVT\_BIT\_POOLING}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+SYS\+\_\+\+EVT\+\_\+\+BIT\+\_\+\+POOLING~0x00000001} - - - -Event bit for CIOT System module. - - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}\label{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_t@{ciot\_sys\_t}} -\index{ciot\_sys\_t@{ciot\_sys\_t}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_t}{ciot\_sys\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+sys\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}} - - - -CIOT System instance pointer. - - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__sys_8h_a7a01e9dc69f9e38add4b67f5d5353c65}\label{ciot__sys_8h_a7a01e9dc69f9e38add4b67f5d5353c65} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_get\_hw@{ciot\_sys\_get\_hw}} -\index{ciot\_sys\_get\_hw@{ciot\_sys\_get\_hw}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_get\_hw()}{ciot\_sys\_get\_hw()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\+\_\+sys\+\_\+hw\+\_\+t}} ciot\+\_\+sys\+\_\+get\+\_\+hw (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -Get the hardware information of the system. - -\begin{DoxyReturn}{Returns} -Hardware information of the system. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_a22dbbf411c0235ce565adc505434a6c5}\label{ciot__sys_8h_a22dbbf411c0235ce565adc505434a6c5} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_new@{ciot\_sys\_new}} -\index{ciot\_sys\_new@{ciot\_sys\_new}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_new()}{ciot\_sys\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} ciot\+\_\+sys\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT System instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the system handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT System instance pointer. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_a06ce22313cfa75dd3862bf9125cd845c}\label{ciot__sys_8h_a06ce22313cfa75dd3862bf9125cd845c} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_process\_req@{ciot\_sys\_process\_req}} -\index{ciot\_sys\_process\_req@{ciot\_sys\_process\_req}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_process\_req()}{ciot\_sys\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__sys__req__t}{ciot\+\_\+sys\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a system request. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT System instance. \\ -\hline -{\em req} & System request to process. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_afcb34bf8efb97cfc6f0e87c417508147}\label{ciot__sys_8h_afcb34bf8efb97cfc6f0e87c417508147} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_rst@{ciot\_sys\_rst}} -\index{ciot\_sys\_rst@{ciot\_sys\_rst}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_rst()}{ciot\_sys\_rst()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+rst (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Reset the CIOT System module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT System instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_a5fbca2415ce7a76809907b5d3217098b}\label{ciot__sys_8h_a5fbca2415ce7a76809907b5d3217098b} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_send\_data@{ciot\_sys\_send\_data}} -\index{ciot\_sys\_send\_data@{ciot\_sys\_send\_data}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_send\_data()}{ciot\_sys\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data using the CIOT System module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT System instance. \\ -\hline -{\em data} & Pointer to the data to be sent. \\ -\hline -{\em size} & Size of the data in bytes. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_ae3972ff066bf63bde44841a4c6052a14}\label{ciot__sys_8h_ae3972ff066bf63bde44841a4c6052a14} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_set\_event\_bits@{ciot\_sys\_set\_event\_bits}} -\index{ciot\_sys\_set\_event\_bits@{ciot\_sys\_set\_event\_bits}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_set\_event\_bits()}{ciot\_sys\_set\_event\_bits()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+set\+\_\+event\+\_\+bits (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}}]{self, }\item[{int}]{event\+\_\+bits }\end{DoxyParamCaption})} - - - -Set event bits for the CIOT System module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT System instance. \\ -\hline -{\em event\+\_\+bits} & Event bits to set. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_a642db3584c187d4bfa8b34dca84ea9f8}\label{ciot__sys_8h_a642db3584c187d4bfa8b34dca84ea9f8} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_sleep@{ciot\_sys\_sleep}} -\index{ciot\_sys\_sleep@{ciot\_sys\_sleep}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_sleep()}{ciot\_sys\_sleep()}} -{\footnotesize\ttfamily void ciot\+\_\+sys\+\_\+sleep (\begin{DoxyParamCaption}\item[{long}]{ms }\end{DoxyParamCaption})} - - - -Put the system to sleep for the specified duration. - - -\begin{DoxyParams}{Parameters} -{\em ms} & Duration in milliseconds. \\ -\hline -\end{DoxyParams} -\Hypertarget{ciot__sys_8h_a4e0bd89f65a81feced88a3b45bf7f541}\label{ciot__sys_8h_a4e0bd89f65a81feced88a3b45bf7f541} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_start@{ciot\_sys\_start}} -\index{ciot\_sys\_start@{ciot\_sys\_start}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_start()}{ciot\_sys\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__sys__cfg__t}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT System module with the given configuration. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT System instance. \\ -\hline -{\em cfg} & Configuration for the system module. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_a1e3d326166a820fc5716b2516bcca0c3}\label{ciot__sys_8h_a1e3d326166a820fc5716b2516bcca0c3} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_stop@{ciot\_sys\_stop}} -\index{ciot\_sys\_stop@{ciot\_sys\_stop}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_stop()}{ciot\_sys\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT System module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT System instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_a3a9c0875c8a82a6927c7bc27294092c4}\label{ciot__sys_8h_a3a9c0875c8a82a6927c7bc27294092c4} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_task@{ciot\_sys\_task}} -\index{ciot\_sys\_task@{ciot\_sys\_task}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_task()}{ciot\_sys\_task()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Perform system task operations. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT System instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__sys_8h_a5e7145c78ed2af300b57879b856478af}\label{ciot__sys_8h_a5e7145c78ed2af300b57879b856478af} -\index{ciot\_sys.h@{ciot\_sys.h}!ciot\_sys\_update\_features@{ciot\_sys\_update\_features}} -\index{ciot\_sys\_update\_features@{ciot\_sys\_update\_features}!ciot\_sys.h@{ciot\_sys.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_update\_features()}{ciot\_sys\_update\_features()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+sys\+\_\+update\+\_\+features (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structciot__sys__features__t}{ciot\+\_\+sys\+\_\+features\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{features }\end{DoxyParamCaption})} - - - -Update system features with the given features configuration. - - -\begin{DoxyParams}{Parameters} -{\em features} & Pointer to the system features configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot__sys_8h_source.tex b/docs/latex/ciot__sys_8h_source.tex deleted file mode 100644 index ddb7da1..0000000 --- a/docs/latex/ciot__sys_8h_source.tex +++ /dev/null @@ -1,55 +0,0 @@ -\doxysection{ciot\+\_\+sys.\+h} -\hypertarget{ciot__sys_8h_source}{}\label{ciot__sys_8h_source}\index{include/ciot\_sys.h@{include/ciot\_sys.h}} -\mbox{\hyperlink{ciot__sys_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_SYS\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_SYS\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__sys__types_8h}{types/ciot\_sys\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#define\ CIOT\_SYS\_EVT\_BIT\_POOLING\ 0x00000001}} -\DoxyCodeLine{00026\ } -\DoxyCodeLine{00030\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_sys\ *\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}};} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00035\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00036\ \{} -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__sys__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ \ \ \ \ \ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{structciot__sys__status__t}{ciot\_sys\_status\_t}}\ \mbox{\hyperlink{structciot__sys__status__msg__t_ad3dbfc73fddab4d58bde12f27edab41b}{status}};\ \ \ \ \ \ } -\DoxyCodeLine{00039\ \}\ \mbox{\hyperlink{structciot__sys__status__msg__t}{ciot\_sys\_status\_msg\_t}};} -\DoxyCodeLine{00040\ } -\DoxyCodeLine{00047\ \mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a22dbbf411c0235ce565adc505434a6c5}{ciot\_sys\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00048\ } -\DoxyCodeLine{00056\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a4e0bd89f65a81feced88a3b45bf7f541}{ciot\_sys\_start}}(\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ self,\ \mbox{\hyperlink{structciot__sys__cfg__t}{ciot\_sys\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00057\ } -\DoxyCodeLine{00064\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a1e3d326166a820fc5716b2516bcca0c3}{ciot\_sys\_stop}}(\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ self);} -\DoxyCodeLine{00065\ } -\DoxyCodeLine{00073\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a06ce22313cfa75dd3862bf9125cd845c}{ciot\_sys\_process\_req}}(\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ self,\ \mbox{\hyperlink{structciot__sys__req__t}{ciot\_sys\_req\_t}}\ *req);} -\DoxyCodeLine{00074\ } -\DoxyCodeLine{00083\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a5fbca2415ce7a76809907b5d3217098b}{ciot\_sys\_send\_data}}(\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00084\ } -\DoxyCodeLine{00091\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_afcb34bf8efb97cfc6f0e87c417508147}{ciot\_sys\_rst}}(\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ self);} -\DoxyCodeLine{00092\ } -\DoxyCodeLine{00099\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a3a9c0875c8a82a6927c7bc27294092c4}{ciot\_sys\_task}}(\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ self);} -\DoxyCodeLine{00100\ } -\DoxyCodeLine{00108\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_ae3972ff066bf63bde44841a4c6052a14}{ciot\_sys\_set\_event\_bits}}(\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\_sys\_t}}\ self,\ \textcolor{keywordtype}{int}\ event\_bits);} -\DoxyCodeLine{00109\ } -\DoxyCodeLine{00115\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{ciot__sys_8h_a642db3584c187d4bfa8b34dca84ea9f8}{ciot\_sys\_sleep}}(\textcolor{keywordtype}{long}\ ms);} -\DoxyCodeLine{00116\ } -\DoxyCodeLine{00123\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a5e7145c78ed2af300b57879b856478af}{ciot\_sys\_update\_features}}(\mbox{\hyperlink{structciot__sys__features__t}{ciot\_sys\_features\_t}}\ *features);} -\DoxyCodeLine{00124\ } -\DoxyCodeLine{00130\ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\_sys\_hw\_t}}\ \mbox{\hyperlink{ciot__sys_8h_a7a01e9dc69f9e38add4b67f5d5353c65}{ciot\_sys\_get\_hw}}(\textcolor{keywordtype}{void});} -\DoxyCodeLine{00131\ } -\DoxyCodeLine{00132\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00133\ \}} -\DoxyCodeLine{00134\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00135\ } -\DoxyCodeLine{00136\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__sys__types_8h.tex b/docs/latex/ciot__sys__types_8h.tex deleted file mode 100644 index af5f538..0000000 --- a/docs/latex/ciot__sys__types_8h.tex +++ /dev/null @@ -1,137 +0,0 @@ -\doxysection{include/types/ciot\+\_\+sys\+\_\+types.h File Reference} -\hypertarget{ciot__sys__types_8h}{}\label{ciot__sys__types_8h}\index{include/types/ciot\_sys\_types.h@{include/types/ciot\_sys\_types.h}} - - -Defines data types and structures for CIOT system functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__sys__hw__features__t}{ciot\+\_\+sys\+\_\+hw\+\_\+features\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT system hardware features. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__sys__sw__features__t}{ciot\+\_\+sys\+\_\+sw\+\_\+features\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT system software features. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__sys__features__t}{ciot\+\_\+sys\+\_\+features\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT system features combining hardware and software features. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__sys__info__t}{ciot\+\_\+sys\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT system information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__sys__status__t}{ciot\+\_\+sys\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT system status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__sys__cfg__t}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT system configuration. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__sys__req__data__u}{ciot\+\_\+sys\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT system request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__sys__req__t}{ciot\+\_\+sys\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT system request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__sys__data__u}{ciot\+\_\+sys\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT system data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7}{ciot\+\_\+sys\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7ac7043876735504a548f88a6f78591c97}{CIOT\+\_\+\+SYS\+\_\+\+REQ\+\_\+\+UNKNONW}} -, \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7afaec21fbf72d7431b0e1060c30bad2b4}{CIOT\+\_\+\+SYS\+\_\+\+REQ\+\_\+\+RESTART}} -, \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7a051ef1036102b4fb06143109a949073c}{CIOT\+\_\+\+SYS\+\_\+\+REQ\+\_\+\+INIT\+\_\+\+DFU}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT system request types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\+\_\+sys\+\_\+hw\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efaff188acdae36c3f846e46c0fcac0f51f}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efadcbf5b47597d8916e929fcb8a41f51eb}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+ESP8266}} -, \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efabe1261ec53dded1b8ab49ea4f72f436c}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+ARDUINO}} -, \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad421d4334f8a1f0d9d9bfbcb86f3a8b0}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+ESP32}} -, \newline -\mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa864748032796d5bc1f9f1d8ca757377f}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+NRF51}} -, \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa1d69a7e4e65f5feab317dca37a76c8c7}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+NRF52}} -, \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa50ce4141c796252e0dd6618bbab7f9e6}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+LINUX}} -, \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad7c83e675bfd1a4bbc5966f3977896df}{CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+WIN32}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT system hardware types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT system functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef} -\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!ciot\_sys\_hw\_t@{ciot\_sys\_hw\_t}} -\index{ciot\_sys\_hw\_t@{ciot\_sys\_hw\_t}!ciot\_sys\_types.h@{ciot\_sys\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_hw\_t}{ciot\_sys\_hw\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\+\_\+sys\+\_\+hw\+\_\+t}}} - - - -Enumeration for CIOT system hardware types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_UNKNOWN@{CIOT\_SYS\_HW\_UNKNOWN}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_UNKNOWN@{CIOT\_SYS\_HW\_UNKNOWN}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efaff188acdae36c3f846e46c0fcac0f51f}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efaff188acdae36c3f846e46c0fcac0f51f} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+UNKNOWN&Unknown hardware type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_ESP8266@{CIOT\_SYS\_HW\_ESP8266}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_ESP8266@{CIOT\_SYS\_HW\_ESP8266}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efadcbf5b47597d8916e929fcb8a41f51eb}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efadcbf5b47597d8916e929fcb8a41f51eb} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+ESP8266&ESP8266 hardware type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_ARDUINO@{CIOT\_SYS\_HW\_ARDUINO}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_ARDUINO@{CIOT\_SYS\_HW\_ARDUINO}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efabe1261ec53dded1b8ab49ea4f72f436c}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efabe1261ec53dded1b8ab49ea4f72f436c} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+ARDUINO&Arduino hardware type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_ESP32@{CIOT\_SYS\_HW\_ESP32}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_ESP32@{CIOT\_SYS\_HW\_ESP32}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad421d4334f8a1f0d9d9bfbcb86f3a8b0}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad421d4334f8a1f0d9d9bfbcb86f3a8b0} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+ESP32&ESP32 hardware type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_NRF51@{CIOT\_SYS\_HW\_NRF51}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_NRF51@{CIOT\_SYS\_HW\_NRF51}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa864748032796d5bc1f9f1d8ca757377f}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa864748032796d5bc1f9f1d8ca757377f} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+NRF51&NRF51 hardware type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_NRF52@{CIOT\_SYS\_HW\_NRF52}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_NRF52@{CIOT\_SYS\_HW\_NRF52}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa1d69a7e4e65f5feab317dca37a76c8c7}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa1d69a7e4e65f5feab317dca37a76c8c7} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+NRF52&NRF52 hardware type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_LINUX@{CIOT\_SYS\_HW\_LINUX}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_LINUX@{CIOT\_SYS\_HW\_LINUX}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa50ce4141c796252e0dd6618bbab7f9e6}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa50ce4141c796252e0dd6618bbab7f9e6} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+LINUX&Linux hardware type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_HW\_WIN32@{CIOT\_SYS\_HW\_WIN32}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_HW\_WIN32@{CIOT\_SYS\_HW\_WIN32}}}\Hypertarget{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad7c83e675bfd1a4bbc5966f3977896df}\label{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad7c83e675bfd1a4bbc5966f3977896df} -CIOT\+\_\+\+SYS\+\_\+\+HW\+\_\+\+WIN32&Windows 32-\/bit hardware type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7}\label{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7} -\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!ciot\_sys\_req\_type\_t@{ciot\_sys\_req\_type\_t}} -\index{ciot\_sys\_req\_type\_t@{ciot\_sys\_req\_type\_t}!ciot\_sys\_types.h@{ciot\_sys\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_sys\_req\_type\_t}{ciot\_sys\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7}{ciot\+\_\+sys\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT system request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_REQ\_UNKNONW@{CIOT\_SYS\_REQ\_UNKNONW}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_REQ\_UNKNONW@{CIOT\_SYS\_REQ\_UNKNONW}}}\Hypertarget{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7ac7043876735504a548f88a6f78591c97}\label{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7ac7043876735504a548f88a6f78591c97} -CIOT\+\_\+\+SYS\+\_\+\+REQ\+\_\+\+UNKNONW&Unknown system request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_REQ\_RESTART@{CIOT\_SYS\_REQ\_RESTART}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_REQ\_RESTART@{CIOT\_SYS\_REQ\_RESTART}}}\Hypertarget{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7afaec21fbf72d7431b0e1060c30bad2b4}\label{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7afaec21fbf72d7431b0e1060c30bad2b4} -CIOT\+\_\+\+SYS\+\_\+\+REQ\+\_\+\+RESTART&System restart request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SYS\_REQ\_INIT\_DFU@{CIOT\_SYS\_REQ\_INIT\_DFU}!ciot\_sys\_types.h@{ciot\_sys\_types.h}}\index{ciot\_sys\_types.h@{ciot\_sys\_types.h}!CIOT\_SYS\_REQ\_INIT\_DFU@{CIOT\_SYS\_REQ\_INIT\_DFU}}}\Hypertarget{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7a051ef1036102b4fb06143109a949073c}\label{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7a051ef1036102b4fb06143109a949073c} -CIOT\+\_\+\+SYS\+\_\+\+REQ\+\_\+\+INIT\+\_\+\+DFU&Initialize DFU (Device Firmware Update) request \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__sys__types_8h_source.tex b/docs/latex/ciot__sys__types_8h_source.tex deleted file mode 100644 index 6eb671d..0000000 --- a/docs/latex/ciot__sys__types_8h_source.tex +++ /dev/null @@ -1,112 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+types.\+h} -\hypertarget{ciot__sys__types_8h_source}{}\label{ciot__sys__types_8h_source}\index{include/types/ciot\_sys\_types.h@{include/types/ciot\_sys\_types.h}} -\mbox{\hyperlink{ciot__sys__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_SYS\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_SYS\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7ac7043876735504a548f88a6f78591c97}{CIOT\_SYS\_REQ\_UNKNONW}},\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7afaec21fbf72d7431b0e1060c30bad2b4}{CIOT\_SYS\_REQ\_RESTART}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7a051ef1036102b4fb06143109a949073c}{CIOT\_SYS\_REQ\_INIT\_DFU}},\ } -\DoxyCodeLine{00028\ \}\ \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7}{ciot\_sys\_req\_type\_t}};} -\DoxyCodeLine{00029\ } -\DoxyCodeLine{00033\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00034\ \{} -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efaff188acdae36c3f846e46c0fcac0f51f}{CIOT\_SYS\_HW\_UNKNOWN}},\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efadcbf5b47597d8916e929fcb8a41f51eb}{CIOT\_SYS\_HW\_ESP8266}},\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efabe1261ec53dded1b8ab49ea4f72f436c}{CIOT\_SYS\_HW\_ARDUINO}},\ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad421d4334f8a1f0d9d9bfbcb86f3a8b0}{CIOT\_SYS\_HW\_ESP32}},\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa864748032796d5bc1f9f1d8ca757377f}{CIOT\_SYS\_HW\_NRF51}},\ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa1d69a7e4e65f5feab317dca37a76c8c7}{CIOT\_SYS\_HW\_NRF52}},\ } -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efa50ce4141c796252e0dd6618bbab7f9e6}{CIOT\_SYS\_HW\_LINUX}},\ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5efad7c83e675bfd1a4bbc5966f3977896df}{CIOT\_SYS\_HW\_WIN32}},\ } -\DoxyCodeLine{00043\ \}\ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\_sys\_hw\_t}};} -\DoxyCodeLine{00044\ } -\DoxyCodeLine{00048\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00049\ \{} -\DoxyCodeLine{00050\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_ab8549384ff6a90d5fedec40cd3535ebf}{storage}}\ :\ 1;\ } -\DoxyCodeLine{00051\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_a2e90afcc174ac8d99edf7229774986db}{system}}\ :\ 1;\ } -\DoxyCodeLine{00052\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_ab56ae378dca42f3463d9dab3f4462045}{uart}}\ :\ 1;\ } -\DoxyCodeLine{00053\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_a71f3331b8fa338b8bb771e9c60142df8}{usb}}\ :\ 1;\ } -\DoxyCodeLine{00054\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_a634aacbacba6e5a795fbebf904d6f827}{ethernet}}\ :\ 1;\ } -\DoxyCodeLine{00055\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_abf7485e5a2b2214d69dd780eddc62f39}{wifi}}\ :\ 1;\ } -\DoxyCodeLine{00056\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_a3541968d9c0a8b544893692fb34cfdee}{ble\_scn}}\ :\ 1;\ } -\DoxyCodeLine{00057\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_a633be9f96069e4c7cb47b431f80ca974}{gpio}}\ :\ 1;\ } -\DoxyCodeLine{00058\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__hw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3}{reserved}}\ :\ 8;\ } -\DoxyCodeLine{00059\ \}\ \mbox{\hyperlink{structciot__sys__hw__features__t}{ciot\_sys\_hw\_features\_t}};} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00064\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00065\ \{} -\DoxyCodeLine{00066\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_a34018b7bbca3d89088500ca3a47a66fd}{ntp}}\ :\ 1;\ } -\DoxyCodeLine{00067\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_aa20473f3745555bec85f491e13188f4e}{ota}}\ :\ 1;\ } -\DoxyCodeLine{00068\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_a6adae5024e1ef3cf7e6209bf7f0c58a0}{dfu}}\ :\ 1;\ } -\DoxyCodeLine{00069\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_ae536bd73f6eaace274e55d4779276e5e}{http\_client}}\ :\ 1;\ } -\DoxyCodeLine{00070\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_a8081e8e6e70c0ae11cc3996fe07f6dde}{http\_server}}\ :\ 1;\ } -\DoxyCodeLine{00071\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_a1f1d5466bff3ee92c8a67e4b067159a2}{mqtt\_client}}\ :\ 1;\ } -\DoxyCodeLine{00072\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_aea00c2c1dec6e8f58532f25c65210d9e}{timer}}\ :\ 1;\ } -\DoxyCodeLine{00073\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_a720e2a2aba3a8aa7ec09162d3a522d60}{serializer}}\ :\ 1;\ } -\DoxyCodeLine{00074\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__sys__sw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3}{reserved}}\ :\ 8;\ } -\DoxyCodeLine{00075\ \}\ \mbox{\hyperlink{structciot__sys__sw__features__t}{ciot\_sys\_sw\_features\_t}};} -\DoxyCodeLine{00076\ } -\DoxyCodeLine{00080\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00081\ \{} -\DoxyCodeLine{00082\ \ \ \ \ \mbox{\hyperlink{structciot__sys__hw__features__t}{ciot\_sys\_hw\_features\_t}}\ \mbox{\hyperlink{structciot__sys__features__t_a68d421729d1895d3b9a6f4cc1dedbb42}{hw}};\ } -\DoxyCodeLine{00083\ \ \ \ \ \mbox{\hyperlink{structciot__sys__sw__features__t}{ciot\_sys\_sw\_features\_t}}\ \mbox{\hyperlink{structciot__sys__features__t_aeb930ea2d960351877d7ef0a126173ff}{sw}};\ } -\DoxyCodeLine{00084\ \}\ \mbox{\hyperlink{structciot__sys__features__t}{ciot\_sys\_features\_t}};} -\DoxyCodeLine{00085\ } -\DoxyCodeLine{00089\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00090\ \{} -\DoxyCodeLine{00091\ \ \ \ \ \textcolor{keywordtype}{char}\ hw\_name[16];\ } -\DoxyCodeLine{00092\ \ \ \ \ uint8\_t\ app\_ver[3];\ } -\DoxyCodeLine{00093\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\_sys\_hw\_t}}\ \mbox{\hyperlink{structciot__sys__info__t_a978e0f986a3de1feb66ebf37cd43b274}{hardware}};\ } -\DoxyCodeLine{00094\ \ \ \ \ \mbox{\hyperlink{structciot__sys__features__t}{ciot\_sys\_features\_t}}\ \mbox{\hyperlink{structciot__sys__info__t_a08bf5c347b3e2c3525c382eaab3d6f97}{features}};\ } -\DoxyCodeLine{00095\ \}\ \mbox{\hyperlink{structciot__sys__info__t}{ciot\_sys\_info\_t}};} -\DoxyCodeLine{00096\ } -\DoxyCodeLine{00100\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00101\ \{} -\DoxyCodeLine{00102\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__sys__status__t_aa4f71758f86d92d3ae60a541335f579d}{rst\_reason}};\ } -\DoxyCodeLine{00103\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__sys__status__t_acc644e0c68521fc2c21bdf5acb5f5812}{rst\_count}};\ } -\DoxyCodeLine{00104\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__sys__status__t_aa455685612d3d0967fd32c32256a8bd3}{free\_memory}};\ } -\DoxyCodeLine{00105\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__sys__status__t_a569e06e92ec3d06c5ebf7f40d7f9a84e}{lifetime}};\ } -\DoxyCodeLine{00106\ \ \ \ \ \mbox{\hyperlink{structciot__sys__info__t}{ciot\_sys\_info\_t}}\ \mbox{\hyperlink{structciot__sys__status__t_a29734819b12e849f2f27b8663d023d8f}{info}};\ } -\DoxyCodeLine{00107\ \}\ \mbox{\hyperlink{structciot__sys__status__t}{ciot\_sys\_status\_t}};} -\DoxyCodeLine{00108\ } -\DoxyCodeLine{00112\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00113\ \{} -\DoxyCodeLine{00114\ } -\DoxyCodeLine{00115\ \}\ \mbox{\hyperlink{structciot__sys__cfg__t}{ciot\_sys\_cfg\_t}};} -\DoxyCodeLine{00116\ } -\DoxyCodeLine{00120\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00121\ \{} -\DoxyCodeLine{00122\ } -\DoxyCodeLine{00123\ \}\ \mbox{\hyperlink{unionciot__sys__req__data__u}{ciot\_sys\_req\_data\_u}};} -\DoxyCodeLine{00124\ } -\DoxyCodeLine{00128\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00129\ \{} -\DoxyCodeLine{00130\ \ \ \ \ \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7}{ciot\_sys\_req\_type\_t}}\ \mbox{\hyperlink{structciot__sys__req__t_a4341eac7e0a50f29b2101e5b7584db32}{type}};\ } -\DoxyCodeLine{00131\ \ \ \ \ \mbox{\hyperlink{unionciot__sys__req__data__u}{ciot\_sys\_req\_data\_u}}\ \mbox{\hyperlink{structciot__sys__req__t_a3acb986a68044c354bb4e34cb18e4d3c}{data}};\ } -\DoxyCodeLine{00132\ \}\ \mbox{\hyperlink{structciot__sys__req__t}{ciot\_sys\_req\_t}};} -\DoxyCodeLine{00133\ } -\DoxyCodeLine{00137\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00138\ \{} -\DoxyCodeLine{00139\ \ \ \ \ \mbox{\hyperlink{structciot__sys__cfg__t}{ciot\_sys\_cfg\_t}}\ \mbox{\hyperlink{unionciot__sys__data__u_a9d2eb5a0a1a2ed5d529672a8229a8fe8}{config}};\ } -\DoxyCodeLine{00140\ \ \ \ \ \mbox{\hyperlink{structciot__sys__status__t}{ciot\_sys\_status\_t}}\ \mbox{\hyperlink{unionciot__sys__data__u_ad3dbfc73fddab4d58bde12f27edab41b}{status}};\ } -\DoxyCodeLine{00141\ \ \ \ \ \mbox{\hyperlink{structciot__sys__req__t}{ciot\_sys\_req\_t}}\ \mbox{\hyperlink{unionciot__sys__data__u_a7146ff86f43fac1f87c45f31c3a3bd20}{request}};\ } -\DoxyCodeLine{00142\ \}\ \mbox{\hyperlink{unionciot__sys__data__u}{ciot\_sys\_data\_u}};} -\DoxyCodeLine{00143\ } -\DoxyCodeLine{00144\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00145\ \}} -\DoxyCodeLine{00146\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00147\ } -\DoxyCodeLine{00148\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__tcp_8h.tex b/docs/latex/ciot__tcp_8h.tex deleted file mode 100644 index 2670242..0000000 --- a/docs/latex/ciot__tcp_8h.tex +++ /dev/null @@ -1,291 +0,0 @@ -\doxysection{include/ciot\+\_\+tcp.h File Reference} -\hypertarget{ciot__tcp_8h}{}\label{ciot__tcp_8h}\index{include/ciot\_tcp.h@{include/ciot\_tcp.h}} - - -Header file for CIOT TCP module. - - -{\ttfamily \#include "{}types/ciot\+\_\+tcp\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__tcp__handle}{ciot\+\_\+tcp\+\_\+handle}} -\begin{DoxyCompactList}\small\item\em Handle structure for CIOT TCP. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__tcp__status__msg__t}{ciot\+\_\+tcp\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT TCP status message structure. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef enum \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4}{ciot\+\_\+tcp\+\_\+type}} \mbox{\hyperlink{ciot__tcp_8h_a8206ed69c94c5a1a4c934d3fc89a10db}{ciot\+\_\+tcp\+\_\+type\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration of CIOT TCP connection types. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__tcp__handle}{ciot\+\_\+tcp\+\_\+handle}} \mbox{\hyperlink{ciot__tcp_8h_af40757b42f3a862bda187c4480db9fdd}{ciot\+\_\+tcp\+\_\+handle\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Handle structure for CIOT TCP. \end{DoxyCompactList}\item -typedef struct ciot\+\_\+tcp \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} -\begin{DoxyCompactList}\small\item\em CIOT TCP instance pointer. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4}{ciot\+\_\+tcp\+\_\+type}} \{ \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4aaa42761772eedb190594f60334e7f9b6}{CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a0653aba615cacd4d37ca017b39cac2c3}{CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+WIFI\+\_\+\+STA}} -, \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a14d1cd4b6a8ecd2b169de66540675046}{CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+WIFI\+\_\+\+AP}} -, \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a567e4dfbd0835d25cf6648942b584639}{CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+ETHERNET}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration of CIOT TCP connection types. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_aaf33d525b69a740035727775db744789}{ciot\+\_\+tcp\+\_\+init}} (void) -\begin{DoxyCompactList}\small\item\em Initialize the CIOT TCP module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_aa7b4877b5e9386676e52472bc2b623fb}{ciot\+\_\+tcp\+\_\+new}} (\mbox{\hyperlink{ciot__tcp_8h_af40757b42f3a862bda187c4480db9fdd}{ciot\+\_\+tcp\+\_\+handle\+\_\+t}} \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT TCP instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_a4bc4953f648bd57ec2fd6a0607c8b3eb}{ciot\+\_\+tcp\+\_\+start}} (\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} self, \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT TCP module with the given configuration. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_a4873b02d0f4a5665258cd4ac47e83880}{ciot\+\_\+tcp\+\_\+stop}} (\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT TCP module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_a8e470218e3e7bbfff2d416270c012a29}{ciot\+\_\+tcp\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} self, \mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a TCP request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_a21f1441d7e5b4b9c43ae51509fc12fe7}{ciot\+\_\+tcp\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data using the CIOT TCP module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_a6f7038a07ff7a89af6c8b228ebb99cae}{ciot\+\_\+tcp\+\_\+register\+\_\+event}} (\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} tcp, \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}} event\+\_\+handler, void \texorpdfstring{$\ast$}{*}event\+\_\+args) -\begin{DoxyCompactList}\small\item\em Register an event handler for the CIOT TCP module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__tcp_8h_acf0f0475005d8a35010d7d3795a83709}{ciot\+\_\+tcp\+\_\+get\+\_\+ip}} (\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} self, uint8\+\_\+t ip\mbox{[}4\mbox{]}) -\begin{DoxyCompactList}\small\item\em Get the IP address of the CIOT TCP module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT TCP module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__tcp_8h_af40757b42f3a862bda187c4480db9fdd}\label{ciot__tcp_8h_af40757b42f3a862bda187c4480db9fdd} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_handle\_t@{ciot\_tcp\_handle\_t}} -\index{ciot\_tcp\_handle\_t@{ciot\_tcp\_handle\_t}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_handle\_t}{ciot\_tcp\_handle\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__tcp__handle}{ciot\+\_\+tcp\+\_\+handle}} \mbox{\hyperlink{ciot__tcp_8h_af40757b42f3a862bda187c4480db9fdd}{ciot\+\_\+tcp\+\_\+handle\+\_\+t}}} - - - -Handle structure for CIOT TCP. - -\Hypertarget{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}\label{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_t@{ciot\_tcp\_t}} -\index{ciot\_tcp\_t@{ciot\_tcp\_t}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_t}{ciot\_tcp\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+tcp\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}}} - - - -CIOT TCP instance pointer. - -\Hypertarget{ciot__tcp_8h_a8206ed69c94c5a1a4c934d3fc89a10db}\label{ciot__tcp_8h_a8206ed69c94c5a1a4c934d3fc89a10db} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_type\_t@{ciot\_tcp\_type\_t}} -\index{ciot\_tcp\_type\_t@{ciot\_tcp\_type\_t}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_type\_t}{ciot\_tcp\_type\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4}{ciot\+\_\+tcp\+\_\+type}} \mbox{\hyperlink{ciot__tcp_8h_a8206ed69c94c5a1a4c934d3fc89a10db}{ciot\+\_\+tcp\+\_\+type\+\_\+t}}} - - - -Enumeration of CIOT TCP connection types. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4}\label{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_type@{ciot\_tcp\_type}} -\index{ciot\_tcp\_type@{ciot\_tcp\_type}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_type}{ciot\_tcp\_type}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4}{ciot\+\_\+tcp\+\_\+type}}} - - - -Enumeration of CIOT TCP connection types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_TYPE\_UNKNOWN@{CIOT\_TCP\_TYPE\_UNKNOWN}!ciot\_tcp.h@{ciot\_tcp.h}}\index{ciot\_tcp.h@{ciot\_tcp.h}!CIOT\_TCP\_TYPE\_UNKNOWN@{CIOT\_TCP\_TYPE\_UNKNOWN}}}\Hypertarget{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4aaa42761772eedb190594f60334e7f9b6}\label{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4aaa42761772eedb190594f60334e7f9b6} -CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+UNKNOWN&Unknown TCP type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_TYPE\_WIFI\_STA@{CIOT\_TCP\_TYPE\_WIFI\_STA}!ciot\_tcp.h@{ciot\_tcp.h}}\index{ciot\_tcp.h@{ciot\_tcp.h}!CIOT\_TCP\_TYPE\_WIFI\_STA@{CIOT\_TCP\_TYPE\_WIFI\_STA}}}\Hypertarget{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a0653aba615cacd4d37ca017b39cac2c3}\label{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a0653aba615cacd4d37ca017b39cac2c3} -CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+WIFI\+\_\+\+STA&Wi\+Fi station TCP type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_TYPE\_WIFI\_AP@{CIOT\_TCP\_TYPE\_WIFI\_AP}!ciot\_tcp.h@{ciot\_tcp.h}}\index{ciot\_tcp.h@{ciot\_tcp.h}!CIOT\_TCP\_TYPE\_WIFI\_AP@{CIOT\_TCP\_TYPE\_WIFI\_AP}}}\Hypertarget{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a14d1cd4b6a8ecd2b169de66540675046}\label{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a14d1cd4b6a8ecd2b169de66540675046} -CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+WIFI\+\_\+\+AP&Wi\+Fi access point TCP type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_TYPE\_ETHERNET@{CIOT\_TCP\_TYPE\_ETHERNET}!ciot\_tcp.h@{ciot\_tcp.h}}\index{ciot\_tcp.h@{ciot\_tcp.h}!CIOT\_TCP\_TYPE\_ETHERNET@{CIOT\_TCP\_TYPE\_ETHERNET}}}\Hypertarget{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a567e4dfbd0835d25cf6648942b584639}\label{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a567e4dfbd0835d25cf6648942b584639} -CIOT\+\_\+\+TCP\+\_\+\+TYPE\+\_\+\+ETHERNET&Ethernet TCP type \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__tcp_8h_acf0f0475005d8a35010d7d3795a83709}\label{ciot__tcp_8h_acf0f0475005d8a35010d7d3795a83709} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_get\_ip@{ciot\_tcp\_get\_ip}} -\index{ciot\_tcp\_get\_ip@{ciot\_tcp\_get\_ip}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_get\_ip()}{ciot\_tcp\_get\_ip()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+tcp\+\_\+get\+\_\+ip (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}}}]{self, }\item[{uint8\+\_\+t}]{ip\mbox{[}4\mbox{]} }\end{DoxyParamCaption})} - - - -Get the IP address of the CIOT TCP module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT TCP instance. \\ -\hline -{\em ip} & Array to store the IP address (4 bytes). \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__tcp_8h_aaf33d525b69a740035727775db744789}\label{ciot__tcp_8h_aaf33d525b69a740035727775db744789} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_init@{ciot\_tcp\_init}} -\index{ciot\_tcp\_init@{ciot\_tcp\_init}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_init()}{ciot\_tcp\_init()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+tcp\+\_\+init (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -Initialize the CIOT TCP module. - -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__tcp_8h_aa7b4877b5e9386676e52472bc2b623fb}\label{ciot__tcp_8h_aa7b4877b5e9386676e52472bc2b623fb} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_new@{ciot\_tcp\_new}} -\index{ciot\_tcp\_new@{ciot\_tcp\_new}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_new()}{ciot\_tcp\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} ciot\+\_\+tcp\+\_\+new (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__tcp_8h_af40757b42f3a862bda187c4480db9fdd}{ciot\+\_\+tcp\+\_\+handle\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT TCP instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Handle for the TCP instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -CIOT TCP instance pointer. -\end{DoxyReturn} -\Hypertarget{ciot__tcp_8h_a8e470218e3e7bbfff2d416270c012a29}\label{ciot__tcp_8h_a8e470218e3e7bbfff2d416270c012a29} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_process\_req@{ciot\_tcp\_process\_req}} -\index{ciot\_tcp\_process\_req@{ciot\_tcp\_process\_req}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_process\_req()}{ciot\_tcp\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+tcp\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a TCP request. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT TCP instance. \\ -\hline -{\em req} & TCP request to process. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__tcp_8h_a6f7038a07ff7a89af6c8b228ebb99cae}\label{ciot__tcp_8h_a6f7038a07ff7a89af6c8b228ebb99cae} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_register\_event@{ciot\_tcp\_register\_event}} -\index{ciot\_tcp\_register\_event@{ciot\_tcp\_register\_event}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_register\_event()}{ciot\_tcp\_register\_event()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+tcp\+\_\+register\+\_\+event (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}}}]{tcp, }\item[{\mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}}}]{event\+\_\+handler, }\item[{void \texorpdfstring{$\ast$}{*}}]{event\+\_\+args }\end{DoxyParamCaption})} - - - -Register an event handler for the CIOT TCP module. - - -\begin{DoxyParams}{Parameters} -{\em tcp} & CIOT TCP instance. \\ -\hline -{\em event\+\_\+handler} & Event handler function pointer. \\ -\hline -{\em event\+\_\+args} & Event handler arguments. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__tcp_8h_a21f1441d7e5b4b9c43ae51509fc12fe7}\label{ciot__tcp_8h_a21f1441d7e5b4b9c43ae51509fc12fe7} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_send\_data@{ciot\_tcp\_send\_data}} -\index{ciot\_tcp\_send\_data@{ciot\_tcp\_send\_data}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_send\_data()}{ciot\_tcp\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+tcp\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data using the CIOT TCP module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT TCP instance. \\ -\hline -{\em data} & Pointer to the data to be sent. \\ -\hline -{\em size} & Size of the data in bytes. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__tcp_8h_a4bc4953f648bd57ec2fd6a0607c8b3eb}\label{ciot__tcp_8h_a4bc4953f648bd57ec2fd6a0607c8b3eb} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_start@{ciot\_tcp\_start}} -\index{ciot\_tcp\_start@{ciot\_tcp\_start}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_start()}{ciot\_tcp\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+tcp\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT TCP module with the given configuration. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT TCP instance. \\ -\hline -{\em cfg} & Configuration for the TCP module. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__tcp_8h_a4873b02d0f4a5665258cd4ac47e83880}\label{ciot__tcp_8h_a4873b02d0f4a5665258cd4ac47e83880} -\index{ciot\_tcp.h@{ciot\_tcp.h}!ciot\_tcp\_stop@{ciot\_tcp\_stop}} -\index{ciot\_tcp\_stop@{ciot\_tcp\_stop}!ciot\_tcp.h@{ciot\_tcp.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_stop()}{ciot\_tcp\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+tcp\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT TCP module. - - -\begin{DoxyParams}{Parameters} -{\em self} & CIOT TCP instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot__tcp_8h_source.tex b/docs/latex/ciot__tcp_8h_source.tex deleted file mode 100644 index 2a71098..0000000 --- a/docs/latex/ciot__tcp_8h_source.tex +++ /dev/null @@ -1,62 +0,0 @@ -\doxysection{ciot\+\_\+tcp.\+h} -\hypertarget{ciot__tcp_8h_source}{}\label{ciot__tcp_8h_source}\index{include/ciot\_tcp.h@{include/ciot\_tcp.h}} -\mbox{\hyperlink{ciot__tcp_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_TCP\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_TCP\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp__types_8h}{types/ciot\_tcp\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4}{ciot\_tcp\_type}}} -\DoxyCodeLine{00026\ \{} -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4aaa42761772eedb190594f60334e7f9b6}{CIOT\_TCP\_TYPE\_UNKNOWN}},\ \ \ \ \ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a0653aba615cacd4d37ca017b39cac2c3}{CIOT\_TCP\_TYPE\_WIFI\_STA}},\ \ \ \ } -\DoxyCodeLine{00029\ \ \ \ \ \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a14d1cd4b6a8ecd2b169de66540675046}{CIOT\_TCP\_TYPE\_WIFI\_AP}},\ \ \ \ \ } -\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{ciot__tcp_8h_a420540e389b2d5f21d7bfbd640f44bd4a567e4dfbd0835d25cf6648942b584639}{CIOT\_TCP\_TYPE\_ETHERNET}},\ \ \ \ } -\DoxyCodeLine{00031\ \}\ \mbox{\hyperlink{ciot__tcp_8h_a8206ed69c94c5a1a4c934d3fc89a10db}{ciot\_tcp\_type\_t}};} -\DoxyCodeLine{00032\ } -\DoxyCodeLine{00036\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__tcp__handle}{ciot\_tcp\_handle}}} -\DoxyCodeLine{00037\ \{} -\DoxyCodeLine{00038\ \ \ \ \ \textcolor{keywordtype}{void}\ *\mbox{\hyperlink{structciot__tcp__handle_af47c5ec8385375f1765e2728e856714a}{netif}};\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\_tcp\_cfg\_t}}\ *\mbox{\hyperlink{structciot__tcp__handle_a34be4afa8e4bf3487bbf19439633a0f8}{cfg}};\ \ \ \ \ \ \ \ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__status__t}{ciot\_tcp\_status\_t}}\ *\mbox{\hyperlink{structciot__tcp__handle_a1f53b649c735819db1618409eec01b05}{status}};\ \ } -\DoxyCodeLine{00041\ \}\ \mbox{\hyperlink{ciot__tcp_8h_af40757b42f3a862bda187c4480db9fdd}{ciot\_tcp\_handle\_t}};} -\DoxyCodeLine{00042\ } -\DoxyCodeLine{00046\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_tcp\ *\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}};} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00051\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00052\ \{} -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__tcp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ \ \ \ \ \ \ } -\DoxyCodeLine{00054\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__status__t}{ciot\_tcp\_status\_t}}\ \mbox{\hyperlink{structciot__tcp__status__msg__t_a290455b77155aab0d086fb8c69f76364}{status}};\ \ \ \ \ \ \ } -\DoxyCodeLine{00055\ \}\ \mbox{\hyperlink{structciot__tcp__status__msg__t}{ciot\_tcp\_status\_msg\_t}};} -\DoxyCodeLine{00056\ } -\DoxyCodeLine{00062\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_aaf33d525b69a740035727775db744789}{ciot\_tcp\_init}}(\textcolor{keywordtype}{void});} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00070\ \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_aa7b4877b5e9386676e52472bc2b623fb}{ciot\_tcp\_new}}(\mbox{\hyperlink{structciot__tcp__handle}{ciot\_tcp\_handle\_t}}\ *handle);} -\DoxyCodeLine{00071\ } -\DoxyCodeLine{00079\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_a4bc4953f648bd57ec2fd6a0607c8b3eb}{ciot\_tcp\_start}}(\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ self,\ \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\_tcp\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00080\ } -\DoxyCodeLine{00087\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_a4873b02d0f4a5665258cd4ac47e83880}{ciot\_tcp\_stop}}(\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ self);} -\DoxyCodeLine{00088\ } -\DoxyCodeLine{00096\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_a8e470218e3e7bbfff2d416270c012a29}{ciot\_tcp\_process\_req}}(\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ self,\ \mbox{\hyperlink{structciot__tcp__req__t}{ciot\_tcp\_req\_t}}\ *req);} -\DoxyCodeLine{00097\ } -\DoxyCodeLine{00106\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_a21f1441d7e5b4b9c43ae51509fc12fe7}{ciot\_tcp\_send\_data}}(\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00107\ } -\DoxyCodeLine{00116\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_a6f7038a07ff7a89af6c8b228ebb99cae}{ciot\_tcp\_register\_event}}(\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ tcp,\ \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\_iface\_event\_handler\_t}}\ event\_handler,\ \textcolor{keywordtype}{void}\ *event\_args);} -\DoxyCodeLine{00117\ } -\DoxyCodeLine{00125\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__tcp_8h_acf0f0475005d8a35010d7d3795a83709}{ciot\_tcp\_get\_ip}}(\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\_tcp\_t}}\ self,\ uint8\_t\ ip[4]);} -\DoxyCodeLine{00126\ } -\DoxyCodeLine{00127\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00128\ \}} -\DoxyCodeLine{00129\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00130\ } -\DoxyCodeLine{00131\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__tcp__types_8h.tex b/docs/latex/ciot__tcp__types_8h.tex deleted file mode 100644 index a18d42f..0000000 --- a/docs/latex/ciot__tcp__types_8h.tex +++ /dev/null @@ -1,171 +0,0 @@ -\doxysection{include/types/ciot\+\_\+tcp\+\_\+types.h File Reference} -\hypertarget{ciot__tcp__types_8h}{}\label{ciot__tcp__types_8h}\index{include/types/ciot\_tcp\_types.h@{include/types/ciot\_tcp\_types.h}} - - -Defines data types and structures for CIOT TCP functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT TCP configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__tcp__dhcp__status__t}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT TCP DHCP status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__tcp__info__t}{ciot\+\_\+tcp\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT TCP information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT TCP status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__tcp__req__data__u}{ciot\+\_\+tcp\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT TCP request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT TCP request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__tcp__data__u}{ciot\+\_\+tcp\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT TCP data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4}{ciot\+\_\+tcp\+\_\+state\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4ad830cbd0026ab149b983ca446d00da93}{CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a1133752fa7b40a274d3cdc1b1f606380}{CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+STOPPED}} -, \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a7c1ef5f54de6485e51c38d35823ef474}{CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a8c0ce6cdcfc832aaa59eeb008720264d}{CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+CONNECTING}} -, \newline -\mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a3266288819ae51df6e46bf607f97cc18}{CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+CONNECTED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT TCP connection states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823ab0167afbae61b85190d4a3ce6f8e1bb6}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a498ff82ecd47e1cc74eb97e647f9af41}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+STATE\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a4bd1f94974adc3039a15f24009f07725}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+STATE\+\_\+\+STOPPED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT TCP DHCP (Dynamic Host Configuration Protocol) states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+cfg\+\_\+t}} \{ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da612a799c9f8c26c1f3b9a503712bd711}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+NO\+\_\+\+CHANGE}} -, \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da256c65576b0fdb5d6cde2ec00741053d}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+CLIENT}} -, \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da687fde87cf827b9e89f391a724332b64}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+SERVER}} -, \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32daf1cef0fee46226a83db77ffb5adb78aa}{CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+DISABLED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT TCP DHCP configuration types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210}{ciot\+\_\+tcp\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210ad747f2cdac489da51cbb5d9dd8a44331}{CIOT\+\_\+\+TCP\+\_\+\+REQ\+\_\+\+UNKNOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT TCP request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data types and structures for CIOT TCP functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d}\label{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d} -\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!ciot\_tcp\_dhcp\_cfg\_t@{ciot\_tcp\_dhcp\_cfg\_t}} -\index{ciot\_tcp\_dhcp\_cfg\_t@{ciot\_tcp\_dhcp\_cfg\_t}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_dhcp\_cfg\_t}{ciot\_tcp\_dhcp\_cfg\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+cfg\+\_\+t}}} - - - -Enumeration for CIOT TCP DHCP configuration types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE@{CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE@{CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE}}}\Hypertarget{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da612a799c9f8c26c1f3b9a503712bd711}\label{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da612a799c9f8c26c1f3b9a503712bd711} -CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+NO\+\_\+\+CHANGE&No change in DHCP configuration \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_DHCP\_CFG\_CLIENT@{CIOT\_TCP\_DHCP\_CFG\_CLIENT}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_DHCP\_CFG\_CLIENT@{CIOT\_TCP\_DHCP\_CFG\_CLIENT}}}\Hypertarget{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da256c65576b0fdb5d6cde2ec00741053d}\label{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da256c65576b0fdb5d6cde2ec00741053d} -CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+CLIENT&DHCP client configuration \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_DHCP\_CFG\_SERVER@{CIOT\_TCP\_DHCP\_CFG\_SERVER}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_DHCP\_CFG\_SERVER@{CIOT\_TCP\_DHCP\_CFG\_SERVER}}}\Hypertarget{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da687fde87cf827b9e89f391a724332b64}\label{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da687fde87cf827b9e89f391a724332b64} -CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+SERVER&DHCP server configuration \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_DHCP\_CFG\_DISABLED@{CIOT\_TCP\_DHCP\_CFG\_DISABLED}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_DHCP\_CFG\_DISABLED@{CIOT\_TCP\_DHCP\_CFG\_DISABLED}}}\Hypertarget{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32daf1cef0fee46226a83db77ffb5adb78aa}\label{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32daf1cef0fee46226a83db77ffb5adb78aa} -CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+CFG\+\_\+\+DISABLED&DHCP disabled configuration \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}\label{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823} -\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!ciot\_tcp\_dhcp\_state\_t@{ciot\_tcp\_dhcp\_state\_t}} -\index{ciot\_tcp\_dhcp\_state\_t@{ciot\_tcp\_dhcp\_state\_t}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_dhcp\_state\_t}{ciot\_tcp\_dhcp\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT TCP DHCP (Dynamic Host Configuration Protocol) states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_DHCP\_STATE\_IDLE@{CIOT\_TCP\_DHCP\_STATE\_IDLE}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_DHCP\_STATE\_IDLE@{CIOT\_TCP\_DHCP\_STATE\_IDLE}}}\Hypertarget{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823ab0167afbae61b85190d4a3ce6f8e1bb6}\label{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823ab0167afbae61b85190d4a3ce6f8e1bb6} -CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+STATE\+\_\+\+IDLE&Idle DHCP state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_DHCP\_STATE\_STARTED@{CIOT\_TCP\_DHCP\_STATE\_STARTED}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_DHCP\_STATE\_STARTED@{CIOT\_TCP\_DHCP\_STATE\_STARTED}}}\Hypertarget{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a498ff82ecd47e1cc74eb97e647f9af41}\label{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a498ff82ecd47e1cc74eb97e647f9af41} -CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+STATE\+\_\+\+STARTED&Started DHCP state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_DHCP\_STATE\_STOPPED@{CIOT\_TCP\_DHCP\_STATE\_STOPPED}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_DHCP\_STATE\_STOPPED@{CIOT\_TCP\_DHCP\_STATE\_STOPPED}}}\Hypertarget{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a4bd1f94974adc3039a15f24009f07725}\label{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a4bd1f94974adc3039a15f24009f07725} -CIOT\+\_\+\+TCP\+\_\+\+DHCP\+\_\+\+STATE\+\_\+\+STOPPED&Stopped DHCP state \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210}\label{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210} -\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!ciot\_tcp\_req\_type\_t@{ciot\_tcp\_req\_type\_t}} -\index{ciot\_tcp\_req\_type\_t@{ciot\_tcp\_req\_type\_t}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_req\_type\_t}{ciot\_tcp\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210}{ciot\+\_\+tcp\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT TCP request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_REQ\_UNKNOWN@{CIOT\_TCP\_REQ\_UNKNOWN}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_REQ\_UNKNOWN@{CIOT\_TCP\_REQ\_UNKNOWN}}}\Hypertarget{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210ad747f2cdac489da51cbb5d9dd8a44331}\label{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210ad747f2cdac489da51cbb5d9dd8a44331} -CIOT\+\_\+\+TCP\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown TCP request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4}\label{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4} -\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!ciot\_tcp\_state\_t@{ciot\_tcp\_state\_t}} -\index{ciot\_tcp\_state\_t@{ciot\_tcp\_state\_t}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_tcp\_state\_t}{ciot\_tcp\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4}{ciot\+\_\+tcp\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT TCP connection states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_STATE\_ERROR@{CIOT\_TCP\_STATE\_ERROR}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_STATE\_ERROR@{CIOT\_TCP\_STATE\_ERROR}}}\Hypertarget{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4ad830cbd0026ab149b983ca446d00da93}\label{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4ad830cbd0026ab149b983ca446d00da93} -CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+ERROR&Error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_STATE\_STOPPED@{CIOT\_TCP\_STATE\_STOPPED}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_STATE\_STOPPED@{CIOT\_TCP\_STATE\_STOPPED}}}\Hypertarget{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a1133752fa7b40a274d3cdc1b1f606380}\label{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a1133752fa7b40a274d3cdc1b1f606380} -CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+STOPPED&Stopped state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_STATE\_STARTED@{CIOT\_TCP\_STATE\_STARTED}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_STATE\_STARTED@{CIOT\_TCP\_STATE\_STARTED}}}\Hypertarget{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a7c1ef5f54de6485e51c38d35823ef474}\label{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a7c1ef5f54de6485e51c38d35823ef474} -CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+STARTED&Started state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_STATE\_CONNECTING@{CIOT\_TCP\_STATE\_CONNECTING}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_STATE\_CONNECTING@{CIOT\_TCP\_STATE\_CONNECTING}}}\Hypertarget{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a8c0ce6cdcfc832aaa59eeb008720264d}\label{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a8c0ce6cdcfc832aaa59eeb008720264d} -CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+CONNECTING&Connecting state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_TCP\_STATE\_CONNECTED@{CIOT\_TCP\_STATE\_CONNECTED}!ciot\_tcp\_types.h@{ciot\_tcp\_types.h}}\index{ciot\_tcp\_types.h@{ciot\_tcp\_types.h}!CIOT\_TCP\_STATE\_CONNECTED@{CIOT\_TCP\_STATE\_CONNECTED}}}\Hypertarget{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a3266288819ae51df6e46bf607f97cc18}\label{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a3266288819ae51df6e46bf607f97cc18} -CIOT\+\_\+\+TCP\+\_\+\+STATE\+\_\+\+CONNECTED&Connected state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__tcp__types_8h_source.tex b/docs/latex/ciot__tcp__types_8h_source.tex deleted file mode 100644 index c55b54f..0000000 --- a/docs/latex/ciot__tcp__types_8h_source.tex +++ /dev/null @@ -1,97 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+types.\+h} -\hypertarget{ciot__tcp__types_8h_source}{}\label{ciot__tcp__types_8h_source}\index{include/types/ciot\_tcp\_types.h@{include/types/ciot\_tcp\_types.h}} -\mbox{\hyperlink{ciot__tcp__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_TCP\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_TCP\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00024\ \{} -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4ad830cbd0026ab149b983ca446d00da93}{CIOT\_TCP\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a1133752fa7b40a274d3cdc1b1f606380}{CIOT\_TCP\_STATE\_STOPPED}},\ } -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a7c1ef5f54de6485e51c38d35823ef474}{CIOT\_TCP\_STATE\_STARTED}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a8c0ce6cdcfc832aaa59eeb008720264d}{CIOT\_TCP\_STATE\_CONNECTING}},\ } -\DoxyCodeLine{00029\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4a3266288819ae51df6e46bf607f97cc18}{CIOT\_TCP\_STATE\_CONNECTED}},\ } -\DoxyCodeLine{00030\ \}\ \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4}{ciot\_tcp\_state\_t}};} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00035\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00036\ \{} -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823ab0167afbae61b85190d4a3ce6f8e1bb6}{CIOT\_TCP\_DHCP\_STATE\_IDLE}},\ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a498ff82ecd47e1cc74eb97e647f9af41}{CIOT\_TCP\_DHCP\_STATE\_STARTED}},\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823a4bd1f94974adc3039a15f24009f07725}{CIOT\_TCP\_DHCP\_STATE\_STOPPED}},\ } -\DoxyCodeLine{00040\ \}\ \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\_tcp\_dhcp\_state\_t}};} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00045\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00046\ \{} -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da612a799c9f8c26c1f3b9a503712bd711}{CIOT\_TCP\_DHCP\_CFG\_NO\_CHANGE}},\ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da256c65576b0fdb5d6cde2ec00741053d}{CIOT\_TCP\_DHCP\_CFG\_CLIENT}},\ } -\DoxyCodeLine{00049\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32da687fde87cf827b9e89f391a724332b64}{CIOT\_TCP\_DHCP\_CFG\_SERVER}},\ } -\DoxyCodeLine{00050\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32daf1cef0fee46226a83db77ffb5adb78aa}{CIOT\_TCP\_DHCP\_CFG\_DISABLED}},\ } -\DoxyCodeLine{00051\ \}\ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d}{ciot\_tcp\_dhcp\_cfg\_t}};} -\DoxyCodeLine{00052\ } -\DoxyCodeLine{00056\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00057\ \{} -\DoxyCodeLine{00058\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210ad747f2cdac489da51cbb5d9dd8a44331}{CIOT\_TCP\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00059\ \}\ \mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210}{ciot\_tcp\_req\_type\_t}};} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00064\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00065\ \{} -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d}{ciot\_tcp\_dhcp\_cfg\_t}}\ \mbox{\hyperlink{structciot__tcp__cfg__t_a689764758640d8f794e755c07c602667}{dhcp}};\ } -\DoxyCodeLine{00067\ \ \ \ \ uint8\_t\ ip[4];\ } -\DoxyCodeLine{00068\ \ \ \ \ uint8\_t\ gateway[4];\ } -\DoxyCodeLine{00069\ \ \ \ \ uint8\_t\ mask[4];\ } -\DoxyCodeLine{00070\ \ \ \ \ uint8\_t\ dns[4];\ } -\DoxyCodeLine{00071\ \}\ \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\_tcp\_cfg\_t}};} -\DoxyCodeLine{00072\ } -\DoxyCodeLine{00076\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00077\ \{} -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\_tcp\_dhcp\_state\_t}}\ \mbox{\hyperlink{structciot__tcp__dhcp__status__t_acb22641cf860e836e7394d14b9adae4b}{client}};\ } -\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\_tcp\_dhcp\_state\_t}}\ \mbox{\hyperlink{structciot__tcp__dhcp__status__t_afdb30da7a1b29e70c8b5051adcaf649b}{server}};\ } -\DoxyCodeLine{00080\ \}\ \mbox{\hyperlink{structciot__tcp__dhcp__status__t}{ciot\_tcp\_dhcp\_status\_t}};} -\DoxyCodeLine{00081\ } -\DoxyCodeLine{00085\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00086\ \{} -\DoxyCodeLine{00087\ \ \ \ \ uint8\_t\ mac[6];\ } -\DoxyCodeLine{00088\ \ \ \ \ uint8\_t\ ip[4];\ } -\DoxyCodeLine{00089\ \}\ \mbox{\hyperlink{structciot__tcp__info__t}{ciot\_tcp\_info\_t}};} -\DoxyCodeLine{00090\ } -\DoxyCodeLine{00094\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00095\ \{} -\DoxyCodeLine{00096\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4}{ciot\_tcp\_state\_t}}\ \mbox{\hyperlink{structciot__tcp__status__t_a771cb8893000d5d94fc8bc2d21347412}{state}};\ } -\DoxyCodeLine{00097\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__tcp__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4}{conn\_count}};\ } -\DoxyCodeLine{00098\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__dhcp__status__t}{ciot\_tcp\_dhcp\_status\_t}}\ \mbox{\hyperlink{structciot__tcp__status__t_acf265b9f6bf6e80f8d16a9aaade7e8cd}{dhcp}};\ } -\DoxyCodeLine{00099\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__info__t}{ciot\_tcp\_info\_t}}\ \mbox{\hyperlink{structciot__tcp__status__t_a086ac86c52dfa147af9f5afed658c7cb}{info}};\ } -\DoxyCodeLine{00100\ \}\ \mbox{\hyperlink{structciot__tcp__status__t}{ciot\_tcp\_status\_t}};} -\DoxyCodeLine{00101\ } -\DoxyCodeLine{00105\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00106\ \{} -\DoxyCodeLine{00107\ } -\DoxyCodeLine{00108\ \}\ \mbox{\hyperlink{unionciot__tcp__req__data__u}{ciot\_tcp\_req\_data\_u}};} -\DoxyCodeLine{00109\ } -\DoxyCodeLine{00113\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00114\ \{} -\DoxyCodeLine{00115\ \ \ \ \ \mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210}{ciot\_tcp\_req\_type\_t}}\ \mbox{\hyperlink{structciot__tcp__req__t_acd8fb37e86ba410b191b31dc8cf154c3}{type}};\ } -\DoxyCodeLine{00116\ \ \ \ \ \mbox{\hyperlink{unionciot__tcp__req__data__u}{ciot\_tcp\_req\_data\_u}}\ \mbox{\hyperlink{structciot__tcp__req__t_ab9836dbdec18617a3ddefdeb64d68c5f}{data}};\ } -\DoxyCodeLine{00117\ \}\ \mbox{\hyperlink{structciot__tcp__req__t}{ciot\_tcp\_req\_t}};} -\DoxyCodeLine{00118\ } -\DoxyCodeLine{00122\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00123\ \{} -\DoxyCodeLine{00124\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\_tcp\_cfg\_t}}\ \mbox{\hyperlink{unionciot__tcp__data__u_a71821427aa3817c68209a151bed81e56}{config}};\ } -\DoxyCodeLine{00125\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__status__t}{ciot\_tcp\_status\_t}}\ \mbox{\hyperlink{unionciot__tcp__data__u_a290455b77155aab0d086fb8c69f76364}{status}};\ } -\DoxyCodeLine{00126\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__req__t}{ciot\_tcp\_req\_t}}\ \mbox{\hyperlink{unionciot__tcp__data__u_aaf3b24e7b5d38ca3f76ca38e5e43ad7e}{request}};\ } -\DoxyCodeLine{00127\ \}\ \mbox{\hyperlink{unionciot__tcp__data__u}{ciot\_tcp\_data\_u}};} -\DoxyCodeLine{00128\ } -\DoxyCodeLine{00129\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00130\ \}} -\DoxyCodeLine{00131\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00132\ } -\DoxyCodeLine{00133\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__timer_8h.tex b/docs/latex/ciot__timer_8h.tex deleted file mode 100644 index ef99299..0000000 --- a/docs/latex/ciot__timer_8h.tex +++ /dev/null @@ -1,130 +0,0 @@ -\doxysection{include/ciot\+\_\+timer.h File Reference} -\hypertarget{ciot__timer_8h}{}\label{ciot__timer_8h}\index{include/ciot\_timer.h@{include/ciot\_timer.h}} - - -Header file for CIOT timer module. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include $<$stdbool.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__timer__cfg}{ciot\+\_\+timer\+\_\+cfg}} -\begin{DoxyCompactList}\small\item\em Configuration structure for CIOT timer. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef void(\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__timer_8h_ae11839d456d62e3e384c7122812fcefc}{ciot\+\_\+timer\+\_\+event\+\_\+handler\+\_\+t}}) (void \texorpdfstring{$\ast$}{*}args) -\begin{DoxyCompactList}\small\item\em Event handler function type definition for CIOT timer module. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__timer__cfg}{ciot\+\_\+timer\+\_\+cfg}} \mbox{\hyperlink{ciot__timer_8h_ae019e659b7b831fe1d18d0cc25a2947a}{ciot\+\_\+timer\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Configuration structure for CIOT timer. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__timer_8h_a8d0e55ce9c38fa27cb6cbf0adf38ea85}{ciot\+\_\+timer\+\_\+start}} (\mbox{\hyperlink{ciot__timer_8h_ae019e659b7b831fe1d18d0cc25a2947a}{ciot\+\_\+timer\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT timer module with the given configuration. \end{DoxyCompactList}\item -uint64\+\_\+t \mbox{\hyperlink{ciot__timer_8h_ade8ee212546acd7193d5b55b803f64ac}{ciot\+\_\+timer\+\_\+get}} (void) -\begin{DoxyCompactList}\small\item\em Get the current timestamp from the CIOT timer. \end{DoxyCompactList}\item -bool \mbox{\hyperlink{ciot__timer_8h_aed2d654f1ff37f47c42c87a8de300b19}{ciot\+\_\+timer\+\_\+compare}} (uint64\+\_\+t \texorpdfstring{$\ast$}{*}timer, uint16\+\_\+t interval) -\begin{DoxyCompactList}\small\item\em Compare the current timer value with an interval. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT timer module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/01-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__timer_8h_ae019e659b7b831fe1d18d0cc25a2947a}\label{ciot__timer_8h_ae019e659b7b831fe1d18d0cc25a2947a} -\index{ciot\_timer.h@{ciot\_timer.h}!ciot\_timer\_cfg\_t@{ciot\_timer\_cfg\_t}} -\index{ciot\_timer\_cfg\_t@{ciot\_timer\_cfg\_t}!ciot\_timer.h@{ciot\_timer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_timer\_cfg\_t}{ciot\_timer\_cfg\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__timer__cfg}{ciot\+\_\+timer\+\_\+cfg}} \mbox{\hyperlink{ciot__timer_8h_ae019e659b7b831fe1d18d0cc25a2947a}{ciot\+\_\+timer\+\_\+cfg\+\_\+t}}} - - - -Configuration structure for CIOT timer. - -\Hypertarget{ciot__timer_8h_ae11839d456d62e3e384c7122812fcefc}\label{ciot__timer_8h_ae11839d456d62e3e384c7122812fcefc} -\index{ciot\_timer.h@{ciot\_timer.h}!ciot\_timer\_event\_handler\_t@{ciot\_timer\_event\_handler\_t}} -\index{ciot\_timer\_event\_handler\_t@{ciot\_timer\_event\_handler\_t}!ciot\_timer.h@{ciot\_timer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_timer\_event\_handler\_t}{ciot\_timer\_event\_handler\_t}} -{\footnotesize\ttfamily typedef void(\texorpdfstring{$\ast$}{*} ciot\+\_\+timer\+\_\+event\+\_\+handler\+\_\+t) (void \texorpdfstring{$\ast$}{*}args)} - - - -Event handler function type definition for CIOT timer module. - - -\begin{DoxyParams}{Parameters} -{\em args} & Event arguments. \\ -\hline -\end{DoxyParams} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__timer_8h_aed2d654f1ff37f47c42c87a8de300b19}\label{ciot__timer_8h_aed2d654f1ff37f47c42c87a8de300b19} -\index{ciot\_timer.h@{ciot\_timer.h}!ciot\_timer\_compare@{ciot\_timer\_compare}} -\index{ciot\_timer\_compare@{ciot\_timer\_compare}!ciot\_timer.h@{ciot\_timer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_timer\_compare()}{ciot\_timer\_compare()}} -{\footnotesize\ttfamily bool ciot\+\_\+timer\+\_\+compare (\begin{DoxyParamCaption}\item[{uint64\+\_\+t \texorpdfstring{$\ast$}{*}}]{timer, }\item[{uint16\+\_\+t}]{interval }\end{DoxyParamCaption})} - - - -Compare the current timer value with an interval. - - -\begin{DoxyParams}{Parameters} -{\em timer} & Pointer to the timer value to compare. \\ -\hline -{\em interval} & Interval value to compare against. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -True if the timer value is greater than or equal to the interval, false otherwise. -\end{DoxyReturn} -\Hypertarget{ciot__timer_8h_ade8ee212546acd7193d5b55b803f64ac}\label{ciot__timer_8h_ade8ee212546acd7193d5b55b803f64ac} -\index{ciot\_timer.h@{ciot\_timer.h}!ciot\_timer\_get@{ciot\_timer\_get}} -\index{ciot\_timer\_get@{ciot\_timer\_get}!ciot\_timer.h@{ciot\_timer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_timer\_get()}{ciot\_timer\_get()}} -{\footnotesize\ttfamily uint64\+\_\+t ciot\+\_\+timer\+\_\+get (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -Get the current timestamp from the CIOT timer. - -\begin{DoxyReturn}{Returns} -Current timestamp in milliseconds. -\end{DoxyReturn} -\Hypertarget{ciot__timer_8h_a8d0e55ce9c38fa27cb6cbf0adf38ea85}\label{ciot__timer_8h_a8d0e55ce9c38fa27cb6cbf0adf38ea85} -\index{ciot\_timer.h@{ciot\_timer.h}!ciot\_timer\_start@{ciot\_timer\_start}} -\index{ciot\_timer\_start@{ciot\_timer\_start}!ciot\_timer.h@{ciot\_timer.h}} -\doxysubsubsection{\texorpdfstring{ciot\_timer\_start()}{ciot\_timer\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+timer\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__timer_8h_ae019e659b7b831fe1d18d0cc25a2947a}{ciot\+\_\+timer\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT timer module with the given configuration. - - -\begin{DoxyParams}{Parameters} -{\em cfg} & Configuration for the timer module. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot__timer_8h_source.tex b/docs/latex/ciot__timer_8h_source.tex deleted file mode 100644 index dd4fcea..0000000 --- a/docs/latex/ciot__timer_8h_source.tex +++ /dev/null @@ -1,30 +0,0 @@ -\doxysection{ciot\+\_\+timer.\+h} -\hypertarget{ciot__timer_8h_source}{}\label{ciot__timer_8h_source}\index{include/ciot\_timer.h@{include/ciot\_timer.h}} -\mbox{\hyperlink{ciot__timer_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_TIMER\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_TIMER\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00015\ } -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00023\ \textcolor{keyword}{typedef}\ void\ (*\mbox{\hyperlink{ciot__timer_8h_ae11839d456d62e3e384c7122812fcefc}{ciot\_timer\_event\_handler\_t}})(\textcolor{keywordtype}{void}\ *args);} -\DoxyCodeLine{00024\ } -\DoxyCodeLine{00028\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__timer__cfg}{ciot\_timer\_cfg}}} -\DoxyCodeLine{00029\ \{} -\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{ciot__timer_8h_ae11839d456d62e3e384c7122812fcefc}{ciot\_timer\_event\_handler\_t}}\ \mbox{\hyperlink{structciot__timer__cfg_ac792c2b1c6a52954e47c8a9ed5ac8582}{event\_handler}};\ \ } -\DoxyCodeLine{00031\ \ \ \ \ \textcolor{keywordtype}{void}\ *\mbox{\hyperlink{structciot__timer__cfg_a702f51681c5c1dd8d6ad5aaa41d80f29}{event\_args}};\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00032\ \}\ \mbox{\hyperlink{ciot__timer_8h_ae019e659b7b831fe1d18d0cc25a2947a}{ciot\_timer\_cfg\_t}};} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00040\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__timer_8h_a8d0e55ce9c38fa27cb6cbf0adf38ea85}{ciot\_timer\_start}}(\mbox{\hyperlink{structciot__timer__cfg}{ciot\_timer\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00047\ uint64\_t\ \mbox{\hyperlink{ciot__timer_8h_ade8ee212546acd7193d5b55b803f64ac}{ciot\_timer\_get}}(\textcolor{keywordtype}{void});} -\DoxyCodeLine{00048\ } -\DoxyCodeLine{00056\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{ciot__timer_8h_aed2d654f1ff37f47c42c87a8de300b19}{ciot\_timer\_compare}}(uint64\_t\ *timer,\ uint16\_t\ interval);} -\DoxyCodeLine{00057\ } -\DoxyCodeLine{00058\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__types_8h.tex b/docs/latex/ciot__types_8h.tex deleted file mode 100644 index 9605125..0000000 --- a/docs/latex/ciot__types_8h.tex +++ /dev/null @@ -1,117 +0,0 @@ -\doxysection{include/types/ciot\+\_\+types.h File Reference} -\hypertarget{ciot__types_8h}{}\label{ciot__types_8h}\index{include/types/ciot\_types.h@{include/types/ciot\_types.h}} - - -Defines types and structures for CIOT functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__iface__cfg__t}{ciot\+\_\+iface\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT interface configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__info__t}{ciot\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__status__t}{ciot\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__req__save__iface__cfg__t}{ciot\+\_\+req\+\_\+save\+\_\+iface\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT save interface configuration request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__req__delete__iface__cfg__t}{ciot\+\_\+req\+\_\+delete\+\_\+iface\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT delete interface configuration request. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__req__result__t}{ciot\+\_\+req\+\_\+result\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT request result. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__req__proxy__msg__t}{ciot\+\_\+req\+\_\+proxy\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT proxy message request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__req__data__u}{ciot\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__req__t}{ciot\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__data__u}{ciot\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2}{ciot\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a7b1b50cf522d03e22820f35c9b615dbc}{CIOT\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a39d9db01f73111913fe49087fc809be9}{CIOT\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a073c800d62d834a591038d5894ad81a1}{CIOT\+\_\+\+STATE\+\_\+\+BUSY}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3}{ciot\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3a5bfc3b86697b77d7813e8f762e92b4ea}{CIOT\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3aede746db7e9dbee372ee79789d83fbc0}{CIOT\+\_\+\+REQ\+\_\+\+SAVE\+\_\+\+IFACE\+\_\+\+CFG}} -, \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3ad5565cc1fd1218de2af439243c69aad9}{CIOT\+\_\+\+REQ\+\_\+\+DELETE\+\_\+\+IFACE\+\_\+\+CFG}} -, \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3aab488cccdc1e9e5009926c15766ebf2c}{CIOT\+\_\+\+REQ\+\_\+\+PROXY\+\_\+\+MSG}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines types and structures for CIOT functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/12-\/07 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__types_8h_a03b3036727499342240dda078a6c69a3}\label{ciot__types_8h_a03b3036727499342240dda078a6c69a3} -\index{ciot\_types.h@{ciot\_types.h}!ciot\_req\_type\_t@{ciot\_req\_type\_t}} -\index{ciot\_req\_type\_t@{ciot\_req\_type\_t}!ciot\_types.h@{ciot\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_req\_type\_t}{ciot\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3}{ciot\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_REQ\_UNKNOWN@{CIOT\_REQ\_UNKNOWN}!ciot\_types.h@{ciot\_types.h}}\index{ciot\_types.h@{ciot\_types.h}!CIOT\_REQ\_UNKNOWN@{CIOT\_REQ\_UNKNOWN}}}\Hypertarget{ciot__types_8h_a03b3036727499342240dda078a6c69a3a5bfc3b86697b77d7813e8f762e92b4ea}\label{ciot__types_8h_a03b3036727499342240dda078a6c69a3a5bfc3b86697b77d7813e8f762e92b4ea} -CIOT\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_REQ\_SAVE\_IFACE\_CFG@{CIOT\_REQ\_SAVE\_IFACE\_CFG}!ciot\_types.h@{ciot\_types.h}}\index{ciot\_types.h@{ciot\_types.h}!CIOT\_REQ\_SAVE\_IFACE\_CFG@{CIOT\_REQ\_SAVE\_IFACE\_CFG}}}\Hypertarget{ciot__types_8h_a03b3036727499342240dda078a6c69a3aede746db7e9dbee372ee79789d83fbc0}\label{ciot__types_8h_a03b3036727499342240dda078a6c69a3aede746db7e9dbee372ee79789d83fbc0} -CIOT\+\_\+\+REQ\+\_\+\+SAVE\+\_\+\+IFACE\+\_\+\+CFG&Save interface configuration request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_REQ\_DELETE\_IFACE\_CFG@{CIOT\_REQ\_DELETE\_IFACE\_CFG}!ciot\_types.h@{ciot\_types.h}}\index{ciot\_types.h@{ciot\_types.h}!CIOT\_REQ\_DELETE\_IFACE\_CFG@{CIOT\_REQ\_DELETE\_IFACE\_CFG}}}\Hypertarget{ciot__types_8h_a03b3036727499342240dda078a6c69a3ad5565cc1fd1218de2af439243c69aad9}\label{ciot__types_8h_a03b3036727499342240dda078a6c69a3ad5565cc1fd1218de2af439243c69aad9} -CIOT\+\_\+\+REQ\+\_\+\+DELETE\+\_\+\+IFACE\+\_\+\+CFG&Delete interface configuration request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_REQ\_PROXY\_MSG@{CIOT\_REQ\_PROXY\_MSG}!ciot\_types.h@{ciot\_types.h}}\index{ciot\_types.h@{ciot\_types.h}!CIOT\_REQ\_PROXY\_MSG@{CIOT\_REQ\_PROXY\_MSG}}}\Hypertarget{ciot__types_8h_a03b3036727499342240dda078a6c69a3aab488cccdc1e9e5009926c15766ebf2c}\label{ciot__types_8h_a03b3036727499342240dda078a6c69a3aab488cccdc1e9e5009926c15766ebf2c} -CIOT\+\_\+\+REQ\+\_\+\+PROXY\+\_\+\+MSG&Proxy message request \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__types_8h_a95856e0042526f191649883a3a46dfe2}\label{ciot__types_8h_a95856e0042526f191649883a3a46dfe2} -\index{ciot\_types.h@{ciot\_types.h}!ciot\_state\_t@{ciot\_state\_t}} -\index{ciot\_state\_t@{ciot\_state\_t}!ciot\_types.h@{ciot\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_state\_t}{ciot\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2}{ciot\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STATE\_ERROR@{CIOT\_STATE\_ERROR}!ciot\_types.h@{ciot\_types.h}}\index{ciot\_types.h@{ciot\_types.h}!CIOT\_STATE\_ERROR@{CIOT\_STATE\_ERROR}}}\Hypertarget{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a7b1b50cf522d03e22820f35c9b615dbc}\label{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a7b1b50cf522d03e22820f35c9b615dbc} -CIOT\+\_\+\+STATE\+\_\+\+ERROR&Error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STATE\_IDLE@{CIOT\_STATE\_IDLE}!ciot\_types.h@{ciot\_types.h}}\index{ciot\_types.h@{ciot\_types.h}!CIOT\_STATE\_IDLE@{CIOT\_STATE\_IDLE}}}\Hypertarget{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a39d9db01f73111913fe49087fc809be9}\label{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a39d9db01f73111913fe49087fc809be9} -CIOT\+\_\+\+STATE\+\_\+\+IDLE&Idle state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_STATE\_BUSY@{CIOT\_STATE\_BUSY}!ciot\_types.h@{ciot\_types.h}}\index{ciot\_types.h@{ciot\_types.h}!CIOT\_STATE\_BUSY@{CIOT\_STATE\_BUSY}}}\Hypertarget{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a073c800d62d834a591038d5894ad81a1}\label{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a073c800d62d834a591038d5894ad81a1} -CIOT\+\_\+\+STATE\+\_\+\+BUSY&Busy state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__types_8h_source.tex b/docs/latex/ciot__types_8h_source.tex deleted file mode 100644 index db9446f..0000000 --- a/docs/latex/ciot__types_8h_source.tex +++ /dev/null @@ -1,96 +0,0 @@ -\doxysection{ciot\+\_\+types.\+h} -\hypertarget{ciot__types_8h_source}{}\label{ciot__types_8h_source}\index{include/types/ciot\_types.h@{include/types/ciot\_types.h}} -\mbox{\hyperlink{ciot__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_TYPES\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00018\ } -\DoxyCodeLine{00022\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00023\ \{} -\DoxyCodeLine{00024\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a7b1b50cf522d03e22820f35c9b615dbc}{CIOT\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00025\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a39d9db01f73111913fe49087fc809be9}{CIOT\_STATE\_IDLE}},\ } -\DoxyCodeLine{00026\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2a073c800d62d834a591038d5894ad81a1}{CIOT\_STATE\_BUSY}},\ } -\DoxyCodeLine{00027\ \}\ \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2}{ciot\_state\_t}};} -\DoxyCodeLine{00028\ } -\DoxyCodeLine{00032\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00033\ \{} -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3a5bfc3b86697b77d7813e8f762e92b4ea}{CIOT\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3aede746db7e9dbee372ee79789d83fbc0}{CIOT\_REQ\_SAVE\_IFACE\_CFG}},\ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3ad5565cc1fd1218de2af439243c69aad9}{CIOT\_REQ\_DELETE\_IFACE\_CFG}},\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3aab488cccdc1e9e5009926c15766ebf2c}{CIOT\_REQ\_PROXY\_MSG}},\ } -\DoxyCodeLine{00038\ \}\ \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3}{ciot\_req\_type\_t}};} -\DoxyCodeLine{00039\ } -\DoxyCodeLine{00043\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00044\ \{} -\DoxyCodeLine{00045\ } -\DoxyCodeLine{00046\ \}\ \mbox{\hyperlink{structciot__iface__cfg__t}{ciot\_iface\_cfg\_t}};} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00051\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00052\ \{} -\DoxyCodeLine{00053\ \ \ \ \ uint8\_t\ version[3];\ } -\DoxyCodeLine{00054\ \}\ \mbox{\hyperlink{structciot__info__t}{ciot\_info\_t}};} -\DoxyCodeLine{00055\ } -\DoxyCodeLine{00059\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00060\ \{} -\DoxyCodeLine{00061\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2}{ciot\_state\_t}}\ \mbox{\hyperlink{structciot__status__t_ab3a7653fc8a3bfebedb322cceec24c38}{state}};\ } -\DoxyCodeLine{00062\ \ \ \ \ \mbox{\hyperlink{structciot__info__t}{ciot\_info\_t}}\ \mbox{\hyperlink{structciot__status__t_a92c867a7e919ec76d2e58647718b633a}{info}};\ } -\DoxyCodeLine{00063\ \}\ \mbox{\hyperlink{structciot__status__t}{ciot\_status\_t}};} -\DoxyCodeLine{00064\ } -\DoxyCodeLine{00068\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00069\ \{} -\DoxyCodeLine{00070\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__req__save__iface__cfg__t_a5aca650808126ada7193361ab8921e7a}{iface\_id}};\ } -\DoxyCodeLine{00071\ \}\ \mbox{\hyperlink{structciot__req__save__iface__cfg__t}{ciot\_req\_save\_iface\_cfg\_t}};} -\DoxyCodeLine{00072\ } -\DoxyCodeLine{00076\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00077\ \{} -\DoxyCodeLine{00078\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__req__delete__iface__cfg__t_a5aca650808126ada7193361ab8921e7a}{iface\_id}};\ } -\DoxyCodeLine{00079\ \}\ \mbox{\hyperlink{structciot__req__delete__iface__cfg__t}{ciot\_req\_delete\_iface\_cfg\_t}};} -\DoxyCodeLine{00080\ } -\DoxyCodeLine{00084\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00085\ \{} -\DoxyCodeLine{00086\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__req__result__t_a5aca650808126ada7193361ab8921e7a}{iface\_id}};\ } -\DoxyCodeLine{00087\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__req__result__t_a2dd2df43c7a23b9fb91e6e462c592477}{err}};\ } -\DoxyCodeLine{00088\ \}\ \mbox{\hyperlink{structciot__req__result__t}{ciot\_req\_result\_t}};} -\DoxyCodeLine{00089\ } -\DoxyCodeLine{00093\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00094\ \{} -\DoxyCodeLine{00095\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__req__proxy__msg__t_a82eb8e84b1ff534e368a647470a626c3}{iface}};\ } -\DoxyCodeLine{00096\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__req__proxy__msg__t_aaba88b24a21a6c70c895c0d55f4a69a0}{size}};\ } -\DoxyCodeLine{00097\ \ \ \ \ uint8\_t\ data[256];\ } -\DoxyCodeLine{00098\ \}\ \mbox{\hyperlink{structciot__req__proxy__msg__t}{ciot\_req\_proxy\_msg\_t}};} -\DoxyCodeLine{00099\ } -\DoxyCodeLine{00103\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00104\ \{} -\DoxyCodeLine{00105\ \ \ \ \ \mbox{\hyperlink{structciot__req__save__iface__cfg__t}{ciot\_req\_save\_iface\_cfg\_t}}\ \mbox{\hyperlink{unionciot__req__data__u_af24d10404fe7693abc12d43b4edea249}{save\_iface\_cfg}};\ } -\DoxyCodeLine{00106\ \ \ \ \ \mbox{\hyperlink{structciot__req__delete__iface__cfg__t}{ciot\_req\_delete\_iface\_cfg\_t}}\ \mbox{\hyperlink{unionciot__req__data__u_abaf229d7f984c35aa24c89632a544934}{delete\_iface\_cfg}};\ } -\DoxyCodeLine{00107\ \ \ \ \ \mbox{\hyperlink{structciot__req__proxy__msg__t}{ciot\_req\_proxy\_msg\_t}}\ \mbox{\hyperlink{unionciot__req__data__u_a778eb3ed59eb3397b9efad8d48d34b62}{proxy\_msg}};\ } -\DoxyCodeLine{00108\ \ \ \ \ \mbox{\hyperlink{structciot__req__result__t}{ciot\_req\_result\_t}}\ \mbox{\hyperlink{unionciot__req__data__u_a90808ce2b0f0710bbe9799c64e8df0db}{result}};\ } -\DoxyCodeLine{00109\ \}\ \mbox{\hyperlink{unionciot__req__data__u}{ciot\_req\_data\_u}};} -\DoxyCodeLine{00110\ } -\DoxyCodeLine{00114\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00115\ \{} -\DoxyCodeLine{00116\ \ \ \ \ \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3}{ciot\_req\_type\_t}}\ \mbox{\hyperlink{structciot__req__t_a55a6010bd818c4c1b94eca45963f09a9}{type}};\ } -\DoxyCodeLine{00117\ \ \ \ \ \mbox{\hyperlink{unionciot__req__data__u}{ciot\_req\_data\_u}}\ \mbox{\hyperlink{structciot__req__t_aeecdef82363bc7b7d7ba9bf5f8f51908}{data}};\ } -\DoxyCodeLine{00118\ \}\ \mbox{\hyperlink{structciot__req__t}{ciot\_req\_t}};} -\DoxyCodeLine{00119\ } -\DoxyCodeLine{00123\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00124\ \{} -\DoxyCodeLine{00125\ \ \ \ \ \mbox{\hyperlink{structciot__iface__cfg__t}{ciot\_iface\_cfg\_t}}\ \mbox{\hyperlink{unionciot__data__u_a82e7ef84cdd4eb20f2da20f0df751fd3}{config}};\ } -\DoxyCodeLine{00126\ \ \ \ \ \mbox{\hyperlink{structciot__status__t}{ciot\_status\_t}}\ \mbox{\hyperlink{unionciot__data__u_ac4db33ce66ac8ec09d4b5b088eb88ead}{status}};\ } -\DoxyCodeLine{00127\ \ \ \ \ \mbox{\hyperlink{structciot__req__t}{ciot\_req\_t}}\ \mbox{\hyperlink{unionciot__data__u_a8975b1b5a295a8ee8669dfcce942dcd5}{request}};\ } -\DoxyCodeLine{00128\ \}\ \mbox{\hyperlink{unionciot__data__u}{ciot\_data\_u}};} -\DoxyCodeLine{00129\ } -\DoxyCodeLine{00130\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00131\ \}} -\DoxyCodeLine{00132\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00133\ } -\DoxyCodeLine{00134\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__uart_8h.tex b/docs/latex/ciot__uart_8h.tex deleted file mode 100644 index c3823ce..0000000 --- a/docs/latex/ciot__uart_8h.tex +++ /dev/null @@ -1,340 +0,0 @@ -\doxysection{include/ciot\+\_\+uart.h File Reference} -\hypertarget{ciot__uart_8h}{}\label{ciot__uart_8h}\index{include/ciot\_uart.h@{include/ciot\_uart.h}} - - -Header file for CIOT UART module. - - -{\ttfamily \#include "{}types/ciot\+\_\+uart\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+s.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__uart__base}{ciot\+\_\+uart\+\_\+base}} -\begin{DoxyCompactList}\small\item\em Base structure for CIOT UART module. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__uart__status__msg__t}{ciot\+\_\+uart\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Status message structure for CIOT UART module. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__uart_8h_ab3755cf621fe54476a2505e7da26fc01}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+RX\+\_\+\+BUF\+\_\+\+SIZE}}~256 -\begin{DoxyCompactList}\small\item\em Default configuration values for CIOT UART module. \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__uart_8h_af725b689143a19b64eac902151957d69}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TX\+\_\+\+BUF\+\_\+\+SIZE}}~256 -\item -\#define \mbox{\hyperlink{ciot__uart_8h_a68ff35a9890306827119c13486c00137}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+QUEUE\+\_\+\+SIZE}}~20 -\item -\#define \mbox{\hyperlink{ciot__uart_8h_ad58f30c8c839283b62501b16212adcc7}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TASK\+\_\+\+SIZE}}~4096 -\item -\#define \mbox{\hyperlink{ciot__uart_8h_a2fa421cf8f26edbbb9c809761788e3f6}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TASK\+\_\+\+PRIO}}~(tsk\+IDLE\+\_\+\+PRIORITY + 1) -\item -\#define \mbox{\hyperlink{ciot__uart_8h_a797dec8616d7fdc049d273a4d1eb967b}{CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TASK\+\_\+\+CORE}}~1 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+uart \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Handle type for CIOT UART module. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0e}{ciot\+\_\+uart\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__uart_8h_a95cd10e869cbb1e43fcae25dadd5bdfb}{ciot\+\_\+uart\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Event ID enumeration for CIOT UART module. \end{DoxyCompactList}\item -typedef struct \mbox{\hyperlink{structciot__uart__base}{ciot\+\_\+uart\+\_\+base}} \mbox{\hyperlink{ciot__uart_8h_a78b44a6ece241c7fbc110ddba2e3d4db}{ciot\+\_\+uart\+\_\+base\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Base structure for CIOT UART module. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0e}{ciot\+\_\+uart\+\_\+event\+\_\+id}} \{ \mbox{\hyperlink{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0ea195c22e4ee22b16b675cc44f64cfdfff}{CIOT\+\_\+\+UART\+\_\+\+EVENT\+\_\+\+DATA}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM - \} -\begin{DoxyCompactList}\small\item\em Event ID enumeration for CIOT UART module. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_a2079bc11f1f437a1a3ce490a7db1d60a}{ciot\+\_\+uart\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new instance of CIOT UART module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_a0f475e364cbc39bab4dbdb86cbdb347d}{ciot\+\_\+uart\+\_\+start}} (\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} self, \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT UART module with the given configuration. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_aa59a92031015d710116dd58847aa4207}{ciot\+\_\+uart\+\_\+stop}} (\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT UART module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_a20f3b90cb598bec62e64a9fbd3bd399b}{ciot\+\_\+uart\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} self, \mbox{\hyperlink{structciot__uart__req__t}{ciot\+\_\+uart\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a request in the CIOT UART module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_a7702c9079dcd8a2e07381df4a54245d6}{ciot\+\_\+uart\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data through the CIOT UART module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_af238f48d206919d750b36dd95a288903}{ciot\+\_\+uart\+\_\+send\+\_\+bytes}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, int size) -\begin{DoxyCompactList}\small\item\em Send bytes through the CIOT UART interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_ab19c96e5abc4221723935e06a8035794}{ciot\+\_\+uart\+\_\+set\+\_\+bridge\+\_\+mode}} (\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} self, bool mode) -\begin{DoxyCompactList}\small\item\em Set bridge mode for the CIOT UART module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__uart_8h_ac8590fc0ab4c129c57c14a442c922c2f}{ciot\+\_\+uart\+\_\+task}} (\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Task function for the CIOT UART module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT UART module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__uart_8h_a68ff35a9890306827119c13486c00137}\label{ciot__uart_8h_a68ff35a9890306827119c13486c00137} -\index{ciot\_uart.h@{ciot\_uart.h}!CIOT\_CONFIG\_UART\_QUEUE\_SIZE@{CIOT\_CONFIG\_UART\_QUEUE\_SIZE}} -\index{CIOT\_CONFIG\_UART\_QUEUE\_SIZE@{CIOT\_CONFIG\_UART\_QUEUE\_SIZE}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_QUEUE\_SIZE}{CIOT\_CONFIG\_UART\_QUEUE\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+QUEUE\+\_\+\+SIZE~20} - -\Hypertarget{ciot__uart_8h_ab3755cf621fe54476a2505e7da26fc01}\label{ciot__uart_8h_ab3755cf621fe54476a2505e7da26fc01} -\index{ciot\_uart.h@{ciot\_uart.h}!CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE@{CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE}} -\index{CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE@{CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE}{CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+RX\+\_\+\+BUF\+\_\+\+SIZE~256} - - - -Default configuration values for CIOT UART module. - -\Hypertarget{ciot__uart_8h_a797dec8616d7fdc049d273a4d1eb967b}\label{ciot__uart_8h_a797dec8616d7fdc049d273a4d1eb967b} -\index{ciot\_uart.h@{ciot\_uart.h}!CIOT\_CONFIG\_UART\_TASK\_CORE@{CIOT\_CONFIG\_UART\_TASK\_CORE}} -\index{CIOT\_CONFIG\_UART\_TASK\_CORE@{CIOT\_CONFIG\_UART\_TASK\_CORE}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_TASK\_CORE}{CIOT\_CONFIG\_UART\_TASK\_CORE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TASK\+\_\+\+CORE~1} - -\Hypertarget{ciot__uart_8h_a2fa421cf8f26edbbb9c809761788e3f6}\label{ciot__uart_8h_a2fa421cf8f26edbbb9c809761788e3f6} -\index{ciot\_uart.h@{ciot\_uart.h}!CIOT\_CONFIG\_UART\_TASK\_PRIO@{CIOT\_CONFIG\_UART\_TASK\_PRIO}} -\index{CIOT\_CONFIG\_UART\_TASK\_PRIO@{CIOT\_CONFIG\_UART\_TASK\_PRIO}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_TASK\_PRIO}{CIOT\_CONFIG\_UART\_TASK\_PRIO}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TASK\+\_\+\+PRIO~(tsk\+IDLE\+\_\+\+PRIORITY + 1)} - -\Hypertarget{ciot__uart_8h_ad58f30c8c839283b62501b16212adcc7}\label{ciot__uart_8h_ad58f30c8c839283b62501b16212adcc7} -\index{ciot\_uart.h@{ciot\_uart.h}!CIOT\_CONFIG\_UART\_TASK\_SIZE@{CIOT\_CONFIG\_UART\_TASK\_SIZE}} -\index{CIOT\_CONFIG\_UART\_TASK\_SIZE@{CIOT\_CONFIG\_UART\_TASK\_SIZE}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_TASK\_SIZE}{CIOT\_CONFIG\_UART\_TASK\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TASK\+\_\+\+SIZE~4096} - -\Hypertarget{ciot__uart_8h_af725b689143a19b64eac902151957d69}\label{ciot__uart_8h_af725b689143a19b64eac902151957d69} -\index{ciot\_uart.h@{ciot\_uart.h}!CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE@{CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE}} -\index{CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE@{CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE}{CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+UART\+\_\+\+TX\+\_\+\+BUF\+\_\+\+SIZE~256} - - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__uart_8h_a78b44a6ece241c7fbc110ddba2e3d4db}\label{ciot__uart_8h_a78b44a6ece241c7fbc110ddba2e3d4db} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_base\_t@{ciot\_uart\_base\_t}} -\index{ciot\_uart\_base\_t@{ciot\_uart\_base\_t}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_base\_t}{ciot\_uart\_base\_t}} -{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structciot__uart__base}{ciot\+\_\+uart\+\_\+base}} \mbox{\hyperlink{ciot__uart_8h_a78b44a6ece241c7fbc110ddba2e3d4db}{ciot\+\_\+uart\+\_\+base\+\_\+t}}} - - - -Base structure for CIOT UART module. - -\Hypertarget{ciot__uart_8h_a95cd10e869cbb1e43fcae25dadd5bdfb}\label{ciot__uart_8h_a95cd10e869cbb1e43fcae25dadd5bdfb} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_event\_id\_t@{ciot\_uart\_event\_id\_t}} -\index{ciot\_uart\_event\_id\_t@{ciot\_uart\_event\_id\_t}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_event\_id\_t}{ciot\_uart\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0e}{ciot\+\_\+uart\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__uart_8h_a95cd10e869cbb1e43fcae25dadd5bdfb}{ciot\+\_\+uart\+\_\+event\+\_\+id\+\_\+t}}} - - - -Event ID enumeration for CIOT UART module. - -\Hypertarget{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}\label{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_t@{ciot\_uart\_t}} -\index{ciot\_uart\_t@{ciot\_uart\_t}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_t}{ciot\_uart\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+uart\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}}} - - - -Handle type for CIOT UART module. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0e}\label{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0e} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_event\_id@{ciot\_uart\_event\_id}} -\index{ciot\_uart\_event\_id@{ciot\_uart\_event\_id}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_event\_id}{ciot\_uart\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0e}{ciot\+\_\+uart\+\_\+event\+\_\+id}}} - - - -Event ID enumeration for CIOT UART module. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_EVENT\_DATA@{CIOT\_UART\_EVENT\_DATA}!ciot\_uart.h@{ciot\_uart.h}}\index{ciot\_uart.h@{ciot\_uart.h}!CIOT\_UART\_EVENT\_DATA@{CIOT\_UART\_EVENT\_DATA}}}\Hypertarget{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0ea195c22e4ee22b16b675cc44f64cfdfff}\label{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0ea195c22e4ee22b16b675cc44f64cfdfff} -CIOT\+\_\+\+UART\+\_\+\+EVENT\+\_\+\+DATA&Custom event for UART data \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__uart_8h_a2079bc11f1f437a1a3ce490a7db1d60a}\label{ciot__uart_8h_a2079bc11f1f437a1a3ce490a7db1d60a} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_new@{ciot\_uart\_new}} -\index{ciot\_uart\_new@{ciot\_uart\_new}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_new()}{ciot\_uart\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} ciot\+\_\+uart\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new instance of CIOT UART module. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Unused parameter (can be NULL). \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the new CIOT UART instance. -\end{DoxyReturn} -\Hypertarget{ciot__uart_8h_a20f3b90cb598bec62e64a9fbd3bd399b}\label{ciot__uart_8h_a20f3b90cb598bec62e64a9fbd3bd399b} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_process\_req@{ciot\_uart\_process\_req}} -\index{ciot\_uart\_process\_req@{ciot\_uart\_process\_req}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_process\_req()}{ciot\_uart\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+uart\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__uart__req__t}{ciot\+\_\+uart\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a request in the CIOT UART module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT UART instance. \\ -\hline -{\em req} & Pointer to the UART request structure. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__uart_8h_af238f48d206919d750b36dd95a288903}\label{ciot__uart_8h_af238f48d206919d750b36dd95a288903} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_send\_bytes@{ciot\_uart\_send\_bytes}} -\index{ciot\_uart\_send\_bytes@{ciot\_uart\_send\_bytes}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_send\_bytes()}{ciot\_uart\_send\_bytes()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+uart\+\_\+send\+\_\+bytes (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{bytes, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send bytes through the CIOT UART interface. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT interface instance. \\ -\hline -{\em bytes} & Pointer to the byte buffer to send. \\ -\hline -{\em size} & Size of the byte buffer. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__uart_8h_a7702c9079dcd8a2e07381df4a54245d6}\label{ciot__uart_8h_a7702c9079dcd8a2e07381df4a54245d6} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_send\_data@{ciot\_uart\_send\_data}} -\index{ciot\_uart\_send\_data@{ciot\_uart\_send\_data}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_send\_data()}{ciot\_uart\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+uart\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data through the CIOT UART module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT UART instance. \\ -\hline -{\em data} & Pointer to the data buffer. \\ -\hline -{\em size} & Size of the data buffer. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__uart_8h_ab19c96e5abc4221723935e06a8035794}\label{ciot__uart_8h_ab19c96e5abc4221723935e06a8035794} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_set\_bridge\_mode@{ciot\_uart\_set\_bridge\_mode}} -\index{ciot\_uart\_set\_bridge\_mode@{ciot\_uart\_set\_bridge\_mode}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_set\_bridge\_mode()}{ciot\_uart\_set\_bridge\_mode()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+uart\+\_\+set\+\_\+bridge\+\_\+mode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}}}]{self, }\item[{bool}]{mode }\end{DoxyParamCaption})} - - - -Set bridge mode for the CIOT UART module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT UART instance. \\ -\hline -{\em mode} & Bridge mode flag (true for enabled, false for disabled). \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__uart_8h_a0f475e364cbc39bab4dbdb86cbdb347d}\label{ciot__uart_8h_a0f475e364cbc39bab4dbdb86cbdb347d} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_start@{ciot\_uart\_start}} -\index{ciot\_uart\_start@{ciot\_uart\_start}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_start()}{ciot\_uart\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+uart\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT UART module with the given configuration. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT UART instance. \\ -\hline -{\em cfg} & Configuration for the UART module. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__uart_8h_aa59a92031015d710116dd58847aa4207}\label{ciot__uart_8h_aa59a92031015d710116dd58847aa4207} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_stop@{ciot\_uart\_stop}} -\index{ciot\_uart\_stop@{ciot\_uart\_stop}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_stop()}{ciot\_uart\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+uart\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT UART module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT UART instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__uart_8h_ac8590fc0ab4c129c57c14a442c922c2f}\label{ciot__uart_8h_ac8590fc0ab4c129c57c14a442c922c2f} -\index{ciot\_uart.h@{ciot\_uart.h}!ciot\_uart\_task@{ciot\_uart\_task}} -\index{ciot\_uart\_task@{ciot\_uart\_task}!ciot\_uart.h@{ciot\_uart.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_task()}{ciot\_uart\_task()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+uart\+\_\+task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Task function for the CIOT UART module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT UART instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot__uart_8h_source.tex b/docs/latex/ciot__uart_8h_source.tex deleted file mode 100644 index 8ae20f0..0000000 --- a/docs/latex/ciot__uart_8h_source.tex +++ /dev/null @@ -1,80 +0,0 @@ -\doxysection{ciot\+\_\+uart.\+h} -\hypertarget{ciot__uart_8h_source}{}\label{ciot__uart_8h_source}\index{include/ciot\_uart.h@{include/ciot\_uart.h}} -\mbox{\hyperlink{ciot__uart_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_UART\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_UART\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__uart__types_8h}{types/ciot\_uart\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__s_8h}{ciot\_s.h}}"{}}} -\DoxyCodeLine{00022\ } -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_RX\_BUF\_SIZE\ 256}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE}} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_TX\_BUF\_SIZE\ 256}} -\DoxyCodeLine{00031\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00032\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_UART\_QUEUE\_SIZE}} -\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_QUEUE\_SIZE\ 20}} -\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00035\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_UART\_TASK\_SIZE}} -\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_TASK\_SIZE\ 4096}} -\DoxyCodeLine{00037\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_UART\_TASK\_PRIO}} -\DoxyCodeLine{00039\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_TASK\_PRIO\ (tskIDLE\_PRIORITY\ +\ 1)}} -\DoxyCodeLine{00040\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00041\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_UART\_TASK\_CORE}} -\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_UART\_TASK\_CORE\ 1}} -\DoxyCodeLine{00043\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00044\ } -\DoxyCodeLine{00048\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_uart\ *\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}};} -\DoxyCodeLine{00049\ } -\DoxyCodeLine{00053\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0e}{ciot\_uart\_event\_id}}} -\DoxyCodeLine{00054\ \{} -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__uart_8h_a03b2c325917b0578e226cad351ffba0ea195c22e4ee22b16b675cc44f64cfdfff}{CIOT\_UART\_EVENT\_DATA}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00056\ \}\ \mbox{\hyperlink{ciot__uart_8h_a95cd10e869cbb1e43fcae25dadd5bdfb}{ciot\_uart\_event\_id\_t}};} -\DoxyCodeLine{00057\ } -\DoxyCodeLine{00061\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structciot__uart__base}{ciot\_uart\_base}}} -\DoxyCodeLine{00062\ \{} -\DoxyCodeLine{00063\ \ \ \ \ \mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ \mbox{\hyperlink{structciot__uart__base_a05aee9079d36e8f1c1f55a4803c9048f}{iface}};\ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00064\ \ \ \ \ \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\_uart\_cfg\_t}}\ \mbox{\hyperlink{structciot__uart__base_a3f98eeddc8b251dcbfd39459c99f9c72}{cfg}};\ \ \ \ \ \ \ \ } -\DoxyCodeLine{00065\ \ \ \ \ \mbox{\hyperlink{structciot__uart__status__t}{ciot\_uart\_status\_t}}\ \mbox{\hyperlink{structciot__uart__base_aa311cb42bbd477c3bfd5371dd0b8bedd}{status}};\ \ } -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\_s\_t}}\ \mbox{\hyperlink{structciot__uart__base_a233ade82acc15e44b91d5b225bb2ba98}{s}};\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00067\ \}\ \mbox{\hyperlink{ciot__uart_8h_a78b44a6ece241c7fbc110ddba2e3d4db}{ciot\_uart\_base\_t}};} -\DoxyCodeLine{00068\ } -\DoxyCodeLine{00072\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00073\ \{} -\DoxyCodeLine{00074\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__uart__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ \ \ } -\DoxyCodeLine{00075\ \ \ \ \ \mbox{\hyperlink{structciot__uart__status__t}{ciot\_uart\_status\_t}}\ \mbox{\hyperlink{structciot__uart__status__msg__t_aa311cb42bbd477c3bfd5371dd0b8bedd}{status}};\ \ } -\DoxyCodeLine{00076\ \}\ \mbox{\hyperlink{structciot__uart__status__msg__t}{ciot\_uart\_status\_msg\_t}};} -\DoxyCodeLine{00077\ } -\DoxyCodeLine{00084\ \mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ \mbox{\hyperlink{ciot__uart_8h_a2079bc11f1f437a1a3ce490a7db1d60a}{ciot\_uart\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00085\ } -\DoxyCodeLine{00093\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__uart_8h_a0f475e364cbc39bab4dbdb86cbdb347d}{ciot\_uart\_start}}(\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ self,\ \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\_uart\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00094\ } -\DoxyCodeLine{00101\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__uart_8h_aa59a92031015d710116dd58847aa4207}{ciot\_uart\_stop}}(\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ self);} -\DoxyCodeLine{00102\ } -\DoxyCodeLine{00110\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__uart_8h_a20f3b90cb598bec62e64a9fbd3bd399b}{ciot\_uart\_process\_req}}(\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ self,\ \mbox{\hyperlink{structciot__uart__req__t}{ciot\_uart\_req\_t}}\ *req);} -\DoxyCodeLine{00111\ } -\DoxyCodeLine{00120\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__uart_8h_a7702c9079dcd8a2e07381df4a54245d6}{ciot\_uart\_send\_data}}(\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00121\ } -\DoxyCodeLine{00130\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__uart_8h_af238f48d206919d750b36dd95a288903}{ciot\_uart\_send\_bytes}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *self,\ uint8\_t\ *bytes,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00131\ } -\DoxyCodeLine{00139\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__uart_8h_ab19c96e5abc4221723935e06a8035794}{ciot\_uart\_set\_bridge\_mode}}(\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ self,\ \textcolor{keywordtype}{bool}\ mode);} -\DoxyCodeLine{00140\ } -\DoxyCodeLine{00147\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__uart_8h_ac8590fc0ab4c129c57c14a442c922c2f}{ciot\_uart\_task}}(\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\_uart\_t}}\ self);} -\DoxyCodeLine{00148\ } -\DoxyCodeLine{00149\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00150\ \}} -\DoxyCodeLine{00151\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00152\ } -\DoxyCodeLine{00153\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__uart__types_8h.tex b/docs/latex/ciot__uart__types_8h.tex deleted file mode 100644 index 4f7acd4..0000000 --- a/docs/latex/ciot__uart__types_8h.tex +++ /dev/null @@ -1,198 +0,0 @@ -\doxysection{include/types/ciot\+\_\+uart\+\_\+types.h File Reference} -\hypertarget{ciot__uart__types_8h}{}\label{ciot__uart__types_8h}\index{include/types/ciot\_uart\_types.h@{include/types/ciot\_uart\_types.h}} - - -Defines data structures and types for CIOT UART functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include $<$stdbool.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+common\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT UART configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT UART status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__uart__req__send__data__t}{ciot\+\_\+uart\+\_\+req\+\_\+send\+\_\+data\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT UART send data request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__uart__req__data__u}{ciot\+\_\+uart\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT UART request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__uart__req__t}{ciot\+\_\+uart\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT UART request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__uart__event}{ciot\+\_\+uart\+\_\+event}} -\begin{DoxyCompactList}\small\item\em Union for CIOT UART event. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__uart__data__u}{ciot\+\_\+uart\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT UART data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef union \mbox{\hyperlink{unionciot__uart__event}{ciot\+\_\+uart\+\_\+event}} \mbox{\hyperlink{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}{ciot\+\_\+uart\+\_\+event\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT UART event. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec}{ciot\+\_\+uart\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca68e791de6f32826bfeadcc76ca60bc2e}{CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+CLOSED}} -, \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca199a994bef9447f18c393c779a0892c1}{CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca9a25df08d25fcbbeed4211d968806f23}{CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+INTERNAL\+\_\+\+ERROR}} -, \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ecab6941d4ad015b3618bb4389a6fd81b38}{CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+CIOT\+\_\+\+S\+\_\+\+ERROR}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT UART states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a}{ciot\+\_\+uart\+\_\+error\+\_\+t}} \{ \newline -\mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa247559c3b774b184eefcddff921c7e7f}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+NONE}} -, \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aaad6937afc4eaec25982854d59b88c44e}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+BREAK}} -, \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4980792413629568f394143146dfd34e}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+BUFFER\+\_\+\+FULL}} -, \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4471ad6db30324129d09ef452d3f21ef}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+FIFO\+\_\+\+OVERFLOW}} -, \newline -\mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa378a518c8cbc1750b42c1ba8dc74ac53}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+FRAME}} -, \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa673b4c65f8766835eb2acaad965ced62}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+PARITY}} -, \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa29325d36ddc3f3283eb395420109f403}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+DATA\+\_\+\+BREAK}} -, \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa156f45510839d0ea276118f836a2a60f}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+UNKNOWN\+\_\+\+EVENT}} -, \newline -\mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa00bbe17b442ed0e94d1f3695b32bda2a}{CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+OPEN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT UART errors. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c}{ciot\+\_\+uart\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca94d082e7fecb8305a0acb0cc05384352}{CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca9a3b4577451009d87249a3afa3f5d1a7}{CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+DATA}} -, \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca553ca846abf1dd6c736512c293f62134}{CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+BYTES}} -, \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca7db606c5c2e1124419279dae212d92b6}{CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+ENABLE\+\_\+\+BRIDGE\+\_\+\+MODE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT UART request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data structures and types for CIOT UART functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}\label{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca} -\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!ciot\_uart\_event\_u@{ciot\_uart\_event\_u}} -\index{ciot\_uart\_event\_u@{ciot\_uart\_event\_u}!ciot\_uart\_types.h@{ciot\_uart\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_event\_u}{ciot\_uart\_event\_u}} -{\footnotesize\ttfamily typedef union \mbox{\hyperlink{unionciot__uart__event}{ciot\+\_\+uart\+\_\+event}} \mbox{\hyperlink{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}{ciot\+\_\+uart\+\_\+event\+\_\+u}}} - - - -Union for CIOT UART event. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a} -\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!ciot\_uart\_error\_t@{ciot\_uart\_error\_t}} -\index{ciot\_uart\_error\_t@{ciot\_uart\_error\_t}!ciot\_uart\_types.h@{ciot\_uart\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_error\_t}{ciot\_uart\_error\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a}{ciot\+\_\+uart\+\_\+error\+\_\+t}}} - - - -Enumeration for CIOT UART errors. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_NONE@{CIOT\_UART\_ERR\_NONE}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_NONE@{CIOT\_UART\_ERR\_NONE}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa247559c3b774b184eefcddff921c7e7f}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa247559c3b774b184eefcddff921c7e7f} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+NONE&No error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_BREAK@{CIOT\_UART\_ERR\_BREAK}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_BREAK@{CIOT\_UART\_ERR\_BREAK}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aaad6937afc4eaec25982854d59b88c44e}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aaad6937afc4eaec25982854d59b88c44e} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+BREAK&Break error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_BUFFER\_FULL@{CIOT\_UART\_ERR\_BUFFER\_FULL}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_BUFFER\_FULL@{CIOT\_UART\_ERR\_BUFFER\_FULL}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4980792413629568f394143146dfd34e}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4980792413629568f394143146dfd34e} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+BUFFER\+\_\+\+FULL&Buffer full error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_FIFO\_OVERFLOW@{CIOT\_UART\_ERR\_FIFO\_OVERFLOW}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_FIFO\_OVERFLOW@{CIOT\_UART\_ERR\_FIFO\_OVERFLOW}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4471ad6db30324129d09ef452d3f21ef}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4471ad6db30324129d09ef452d3f21ef} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+FIFO\+\_\+\+OVERFLOW&FIFO overflow error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_FRAME@{CIOT\_UART\_ERR\_FRAME}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_FRAME@{CIOT\_UART\_ERR\_FRAME}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa378a518c8cbc1750b42c1ba8dc74ac53}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa378a518c8cbc1750b42c1ba8dc74ac53} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+FRAME&Frame error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_PARITY@{CIOT\_UART\_ERR\_PARITY}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_PARITY@{CIOT\_UART\_ERR\_PARITY}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa673b4c65f8766835eb2acaad965ced62}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa673b4c65f8766835eb2acaad965ced62} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+PARITY&Parity error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_DATA\_BREAK@{CIOT\_UART\_ERR\_DATA\_BREAK}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_DATA\_BREAK@{CIOT\_UART\_ERR\_DATA\_BREAK}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa29325d36ddc3f3283eb395420109f403}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa29325d36ddc3f3283eb395420109f403} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+DATA\+\_\+\+BREAK&Data break error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_UNKNOWN\_EVENT@{CIOT\_UART\_ERR\_UNKNOWN\_EVENT}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_UNKNOWN\_EVENT@{CIOT\_UART\_ERR\_UNKNOWN\_EVENT}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa156f45510839d0ea276118f836a2a60f}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa156f45510839d0ea276118f836a2a60f} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+UNKNOWN\+\_\+\+EVENT&Unknown event error \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_ERR\_OPEN@{CIOT\_UART\_ERR\_OPEN}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_ERR\_OPEN@{CIOT\_UART\_ERR\_OPEN}}}\Hypertarget{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa00bbe17b442ed0e94d1f3695b32bda2a}\label{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa00bbe17b442ed0e94d1f3695b32bda2a} -CIOT\+\_\+\+UART\+\_\+\+ERR\+\_\+\+OPEN&Open error \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c}\label{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c} -\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!ciot\_uart\_req\_type\_t@{ciot\_uart\_req\_type\_t}} -\index{ciot\_uart\_req\_type\_t@{ciot\_uart\_req\_type\_t}!ciot\_uart\_types.h@{ciot\_uart\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_req\_type\_t}{ciot\_uart\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c}{ciot\+\_\+uart\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT UART request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_REQ\_UNKNOWN@{CIOT\_UART\_REQ\_UNKNOWN}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_REQ\_UNKNOWN@{CIOT\_UART\_REQ\_UNKNOWN}}}\Hypertarget{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca94d082e7fecb8305a0acb0cc05384352}\label{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca94d082e7fecb8305a0acb0cc05384352} -CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_REQ\_SEND\_DATA@{CIOT\_UART\_REQ\_SEND\_DATA}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_REQ\_SEND\_DATA@{CIOT\_UART\_REQ\_SEND\_DATA}}}\Hypertarget{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca9a3b4577451009d87249a3afa3f5d1a7}\label{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca9a3b4577451009d87249a3afa3f5d1a7} -CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+DATA&Send data request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_REQ\_SEND\_BYTES@{CIOT\_UART\_REQ\_SEND\_BYTES}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_REQ\_SEND\_BYTES@{CIOT\_UART\_REQ\_SEND\_BYTES}}}\Hypertarget{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca553ca846abf1dd6c736512c293f62134}\label{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca553ca846abf1dd6c736512c293f62134} -CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+SEND\+\_\+\+BYTES&Send bytes request \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_REQ\_ENABLE\_BRIDGE\_MODE@{CIOT\_UART\_REQ\_ENABLE\_BRIDGE\_MODE}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_REQ\_ENABLE\_BRIDGE\_MODE@{CIOT\_UART\_REQ\_ENABLE\_BRIDGE\_MODE}}}\Hypertarget{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca7db606c5c2e1124419279dae212d92b6}\label{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca7db606c5c2e1124419279dae212d92b6} -CIOT\+\_\+\+UART\+\_\+\+REQ\+\_\+\+ENABLE\+\_\+\+BRIDGE\+\_\+\+MODE&Enable bridge mode request \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec}\label{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec} -\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!ciot\_uart\_state\_t@{ciot\_uart\_state\_t}} -\index{ciot\_uart\_state\_t@{ciot\_uart\_state\_t}!ciot\_uart\_types.h@{ciot\_uart\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_uart\_state\_t}{ciot\_uart\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec}{ciot\+\_\+uart\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT UART states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_STATE\_CLOSED@{CIOT\_UART\_STATE\_CLOSED}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_STATE\_CLOSED@{CIOT\_UART\_STATE\_CLOSED}}}\Hypertarget{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca68e791de6f32826bfeadcc76ca60bc2e}\label{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca68e791de6f32826bfeadcc76ca60bc2e} -CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+CLOSED&UART closed state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_STATE\_STARTED@{CIOT\_UART\_STATE\_STARTED}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_STATE\_STARTED@{CIOT\_UART\_STATE\_STARTED}}}\Hypertarget{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca199a994bef9447f18c393c779a0892c1}\label{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca199a994bef9447f18c393c779a0892c1} -CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+STARTED&UART started state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_STATE\_INTERNAL\_ERROR@{CIOT\_UART\_STATE\_INTERNAL\_ERROR}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_STATE\_INTERNAL\_ERROR@{CIOT\_UART\_STATE\_INTERNAL\_ERROR}}}\Hypertarget{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca9a25df08d25fcbbeed4211d968806f23}\label{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca9a25df08d25fcbbeed4211d968806f23} -CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+INTERNAL\+\_\+\+ERROR&Internal UART error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_UART\_STATE\_CIOT\_S\_ERROR@{CIOT\_UART\_STATE\_CIOT\_S\_ERROR}!ciot\_uart\_types.h@{ciot\_uart\_types.h}}\index{ciot\_uart\_types.h@{ciot\_uart\_types.h}!CIOT\_UART\_STATE\_CIOT\_S\_ERROR@{CIOT\_UART\_STATE\_CIOT\_S\_ERROR}}}\Hypertarget{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ecab6941d4ad015b3618bb4389a6fd81b38}\label{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ecab6941d4ad015b3618bb4389a6fd81b38} -CIOT\+\_\+\+UART\+\_\+\+STATE\+\_\+\+CIOT\+\_\+\+S\+\_\+\+ERROR&CIOT-\/specific UART error state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__uart__types_8h_source.tex b/docs/latex/ciot__uart__types_8h_source.tex deleted file mode 100644 index ed875ca..0000000 --- a/docs/latex/ciot__uart__types_8h_source.tex +++ /dev/null @@ -1,104 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+types.\+h} -\hypertarget{ciot__uart__types_8h_source}{}\label{ciot__uart__types_8h_source}\index{include/types/ciot\_uart\_types.h@{include/types/ciot\_uart\_types.h}} -\mbox{\hyperlink{ciot__uart__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_UART\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_UART\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__common__types_8h}{ciot\_common\_types.h}}"{}}} -\DoxyCodeLine{00022\ } -\DoxyCodeLine{00026\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00027\ \{} -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca68e791de6f32826bfeadcc76ca60bc2e}{CIOT\_UART\_STATE\_CLOSED}},\ } -\DoxyCodeLine{00029\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca199a994bef9447f18c393c779a0892c1}{CIOT\_UART\_STATE\_STARTED}},\ } -\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48eca9a25df08d25fcbbeed4211d968806f23}{CIOT\_UART\_STATE\_INTERNAL\_ERROR}},\ } -\DoxyCodeLine{00031\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ecab6941d4ad015b3618bb4389a6fd81b38}{CIOT\_UART\_STATE\_CIOT\_S\_ERROR}},\ } -\DoxyCodeLine{00032\ \}\ \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec}{ciot\_uart\_state\_t}};} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00037\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00038\ \{} -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa247559c3b774b184eefcddff921c7e7f}{CIOT\_UART\_ERR\_NONE}},\ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aaad6937afc4eaec25982854d59b88c44e}{CIOT\_UART\_ERR\_BREAK}},\ } -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4980792413629568f394143146dfd34e}{CIOT\_UART\_ERR\_BUFFER\_FULL}},\ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa4471ad6db30324129d09ef452d3f21ef}{CIOT\_UART\_ERR\_FIFO\_OVERFLOW}},\ } -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa378a518c8cbc1750b42c1ba8dc74ac53}{CIOT\_UART\_ERR\_FRAME}},\ } -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa673b4c65f8766835eb2acaad965ced62}{CIOT\_UART\_ERR\_PARITY}},\ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa29325d36ddc3f3283eb395420109f403}{CIOT\_UART\_ERR\_DATA\_BREAK}},\ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa156f45510839d0ea276118f836a2a60f}{CIOT\_UART\_ERR\_UNKNOWN\_EVENT}},\ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494aa00bbe17b442ed0e94d1f3695b32bda2a}{CIOT\_UART\_ERR\_OPEN}},\ } -\DoxyCodeLine{00048\ \}\ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a}{ciot\_uart\_error\_t}};} -\DoxyCodeLine{00049\ } -\DoxyCodeLine{00053\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00054\ \{} -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca94d082e7fecb8305a0acb0cc05384352}{CIOT\_UART\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca9a3b4577451009d87249a3afa3f5d1a7}{CIOT\_UART\_REQ\_SEND\_DATA}},\ } -\DoxyCodeLine{00057\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca553ca846abf1dd6c736512c293f62134}{CIOT\_UART\_REQ\_SEND\_BYTES}},\ } -\DoxyCodeLine{00058\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751ca7db606c5c2e1124419279dae212d92b6}{CIOT\_UART\_REQ\_ENABLE\_BRIDGE\_MODE}},\ } -\DoxyCodeLine{00059\ \}\ \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c}{ciot\_uart\_req\_type\_t}};} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00064\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00065\ \{} -\DoxyCodeLine{00066\ \ \ \ \ uint32\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_a148f33bbcda8087a77d8ba30f7e3c502}{baud\_rate}};\ } -\DoxyCodeLine{00067\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_abea371f9030e15a5d2a4c181576833d8}{num}};\ } -\DoxyCodeLine{00068\ \ \ \ \ int8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_ab461fda70a78750930429bcc68db5a98}{rx\_pin}};\ } -\DoxyCodeLine{00069\ \ \ \ \ int8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_abc8367b5354c54835c1d74192f355c1c}{tx\_pin}};\ } -\DoxyCodeLine{00070\ \ \ \ \ int8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_a3c82534f71c473adbf7fa380db7badc2}{rts\_pin}};\ } -\DoxyCodeLine{00071\ \ \ \ \ int8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_a73580a66f00a6a0ea4a56441d529797f}{cts\_pin}};\ } -\DoxyCodeLine{00072\ \ \ \ \ uint16\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_ae5290e95682932917ab6a7fd7897abb4}{parity}};\ } -\DoxyCodeLine{00073\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_a9498b6790752dd532f6465f3efb59cbf}{flow\_control}}\ :\ 1;\ } -\DoxyCodeLine{00074\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_a5b495a42fbde79adb797b1e9f6a4e039}{dtr}}\ :\ 1;\ } -\DoxyCodeLine{00075\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_a7550d74d56b36307b64a75f5d4eb8dad}{bridge\_mode}}\ :\ 1;\ } -\DoxyCodeLine{00076\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__uart__cfg__t_acb7bc06bed6f6408d719334fc41698c7}{reserved}}\ :\ 5;\ } -\DoxyCodeLine{00077\ \}\ \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\_uart\_cfg\_t}};} -\DoxyCodeLine{00078\ } -\DoxyCodeLine{00082\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00083\ \{} -\DoxyCodeLine{00084\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec}{ciot\_uart\_state\_t}}\ \mbox{\hyperlink{structciot__uart__status__t_a00c2e8ab24db2cabd968dcd6aa86a7c3}{state}};\ } -\DoxyCodeLine{00085\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a}{ciot\_uart\_error\_t}}\ \mbox{\hyperlink{structciot__uart__status__t_ad02fff01b7a3add4e201ad4fd60bb06d}{error}};\ } -\DoxyCodeLine{00086\ \}\ \mbox{\hyperlink{structciot__uart__status__t}{ciot\_uart\_status\_t}};} -\DoxyCodeLine{00087\ } -\DoxyCodeLine{00091\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00092\ \{} -\DoxyCodeLine{00093\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__uart__req__send__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0}{size}};\ } -\DoxyCodeLine{00094\ \ \ \ \ uint8\_t\ data[255];\ } -\DoxyCodeLine{00095\ \}\ \mbox{\hyperlink{structciot__uart__req__send__data__t}{ciot\_uart\_req\_send\_data\_t}};} -\DoxyCodeLine{00096\ } -\DoxyCodeLine{00100\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00101\ \{} -\DoxyCodeLine{00102\ \ \ \ \ \mbox{\hyperlink{structciot__uart__req__send__data__t}{ciot\_uart\_req\_send\_data\_t}}\ \mbox{\hyperlink{unionciot__uart__req__data__u_a64001c4b28083877216a64df74dff823}{send\_data}};\ } -\DoxyCodeLine{00103\ \}\ \mbox{\hyperlink{unionciot__uart__req__data__u}{ciot\_uart\_req\_data\_u}};} -\DoxyCodeLine{00104\ } -\DoxyCodeLine{00108\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00109\ \{} -\DoxyCodeLine{00110\ \ \ \ \ \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c}{ciot\_uart\_req\_type\_t}}\ \mbox{\hyperlink{structciot__uart__req__t_a21d88bf4d17b9837d25893a4000044db}{type}};\ } -\DoxyCodeLine{00111\ \ \ \ \ \mbox{\hyperlink{unionciot__uart__req__data__u}{ciot\_uart\_req\_data\_u}}\ \mbox{\hyperlink{structciot__uart__req__t_a8abbd25f85c295a54f54d2815908d273}{data}};\ } -\DoxyCodeLine{00112\ \}\ \mbox{\hyperlink{structciot__uart__req__t}{ciot\_uart\_req\_t}};} -\DoxyCodeLine{00113\ } -\DoxyCodeLine{00117\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\mbox{\hyperlink{unionciot__uart__event}{ciot\_uart\_event}}} -\DoxyCodeLine{00118\ \{} -\DoxyCodeLine{00119\ \ \ \ \ \mbox{\hyperlink{structciot__event__data}{ciot\_event\_data\_t}}\ \mbox{\hyperlink{unionciot__uart__event_a998bffd5567753ef3f6b652a400de36b}{data}};\ } -\DoxyCodeLine{00120\ \}\ \mbox{\hyperlink{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}{ciot\_uart\_event\_u}};} -\DoxyCodeLine{00121\ } -\DoxyCodeLine{00125\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00126\ \{} -\DoxyCodeLine{00127\ \ \ \ \ \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\_uart\_cfg\_t}}\ \mbox{\hyperlink{unionciot__uart__data__u_a107556abf8506af23fc4f92aa4d20cea}{config}};\ } -\DoxyCodeLine{00128\ \ \ \ \ \mbox{\hyperlink{structciot__uart__status__t}{ciot\_uart\_status\_t}}\ \mbox{\hyperlink{unionciot__uart__data__u_aa311cb42bbd477c3bfd5371dd0b8bedd}{status}};\ } -\DoxyCodeLine{00129\ \ \ \ \ \mbox{\hyperlink{structciot__uart__req__t}{ciot\_uart\_req\_t}}\ \mbox{\hyperlink{unionciot__uart__data__u_aeac55f9a4429aa466599b8875763ff38}{request}};\ } -\DoxyCodeLine{00130\ \ \ \ \ \mbox{\hyperlink{unionciot__uart__event}{ciot\_uart\_event\_u}}\ \mbox{\hyperlink{unionciot__uart__data__u_af5207c84edf0697170da962f465640a0}{event}};\ } -\DoxyCodeLine{00131\ \}\ \mbox{\hyperlink{unionciot__uart__data__u}{ciot\_uart\_data\_u}};} -\DoxyCodeLine{00132\ } -\DoxyCodeLine{00133\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00134\ \}} -\DoxyCodeLine{00135\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00136\ } -\DoxyCodeLine{00137\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__usb_8h.tex b/docs/latex/ciot__usb_8h.tex deleted file mode 100644 index a0bb946..0000000 --- a/docs/latex/ciot__usb_8h.tex +++ /dev/null @@ -1,395 +0,0 @@ -\doxysection{include/ciot\+\_\+usb.h File Reference} -\hypertarget{ciot__usb_8h}{}\label{ciot__usb_8h}\index{include/ciot\_usb.h@{include/ciot\_usb.h}} - - -Header file for CIOT USB module. - - -{\ttfamily \#include $<$stdbool.\+h$>$}\newline -{\ttfamily \#include "{}types/ciot\+\_\+usb\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__usb__status__msg__t}{ciot\+\_\+usb\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Status message structure for CIOT USB module. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+usb \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Handle type for CIOT USB module. \end{DoxyCompactList}\item -typedef enum \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5}{ciot\+\_\+usb\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__usb_8h_a014429fc850b705c643a7ec24bd55e1e}{ciot\+\_\+usb\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Event ID enumeration for CIOT USB module. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5}{ciot\+\_\+usb\+\_\+event\+\_\+id}} \{ \newline -\mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a276f27a10f2d1d8f2b9669e73f741453}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+SOF}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4e25ddb62bf2e37c550da599ba49baa}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+RESET}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a491b16a86bf780ddadb881ba97be218a}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+SUSPEND}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a10a07726018e6efe25f3d1e5dca2e895}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+RESUME}} -, \newline -\mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a696943e19333fb49af7bae6c62beb19b}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+WUREQ}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9c35023883831b5dc9a630f9121f0c68}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+SETUP}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4003dcdc297ffa8fc4cbd2f9207daa8}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+EPTRANSFER}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a6d8d7a8948f67370c8d7180f4e35d357}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+FIRST\+\_\+\+POWER}} -, \newline -\mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5adb38ca4f63e6efb7f66e814211e9a3ad}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+POWER\+\_\+\+DETECTED}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a8a1cc8b9386234f3133dc7c78eb0bef6}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+POWER\+\_\+\+REMOVED}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ad179606eaf7b0171f649090a3aa447c6}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+POWER\+\_\+\+READY}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a51f79a53cfc322086e3efd9e48c5ea6f}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+FIRST\+\_\+\+APP}} -, \newline -\mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaf2b626cb9e5b1be9d2eaa819fd3d386}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+INST\+\_\+\+APPEND}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a70d9c2054d28e7851d2ab32fc21b7e64}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+INST\+\_\+\+REMOVE}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac5ce262971db46bd319f96d936f97e51}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STARTED}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a2876fe138403454c4c0c4bdec005b795}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STOPPED}} -, \newline -\mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaa1ee6bcea019eed94daab3193bd589b}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STATE\+\_\+\+CHANGED}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac3c161231a97b52f7b5eafdae193ef58}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+FIRST\+\_\+\+INTERNAL}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5abefb094f2be1ef915bf5e9a20cf34add}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+HFCLK\+\_\+\+READY}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a4026d37d3f5e925bc054770b9ebe9526}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+START\+\_\+\+REQ}} -, \newline -\mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a62de26da02a6e09bcd443684af656843}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STOP\+\_\+\+REQ}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a727280bd1dbf820baf7166b64bd9cf4e}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+SUSPEND\+\_\+\+REQ}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9911a33a214c0b913128cf4c120bf737}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+WAKEUP\+\_\+\+REQ}} -, \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a1ea491afe0afdeef5390fb08ccf65cf8}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+SETUP\+\_\+\+SETADDRESS}} -, \newline -\mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a0f83b5f8ff28920ceaaad901510476c6}{CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DATA}} - \} -\begin{DoxyCompactList}\small\item\em Event ID enumeration for CIOT USB module. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_abfc4f7cd5db3e2e5d94c4cd179d99799}{ciot\+\_\+usb\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new instance of CIOT USB module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_a6fc1bc4653f9484b79d7f6eec7b8a22e}{ciot\+\_\+usb\+\_\+start}} (\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} self, \mbox{\hyperlink{structciot__usb__cfg__t}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT USB module with the given configuration. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_adabdd1e2583c19abdaf9c618ac48744c}{ciot\+\_\+usb\+\_\+stop}} (\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT USB module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_aa7629e46c3c5f64fd1a03f449c9a62d9}{ciot\+\_\+usb\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} self, \mbox{\hyperlink{structciot__usb__req__t}{ciot\+\_\+usb\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a request in the CIOT USB module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_a1ca6b2b7d2fb270d03110baaafa69875}{ciot\+\_\+usb\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data through the CIOT USB module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_abae2505d8aed15ad739be049f4180e28}{ciot\+\_\+usb\+\_\+send\+\_\+bytes}} (\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}iface, uint8\+\_\+t \texorpdfstring{$\ast$}{*}bytes, int size) -\begin{DoxyCompactList}\small\item\em Send bytes through the CIOT USB interface. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_ad2167601e42b510a7c5c23092c4c1d67}{ciot\+\_\+usb\+\_\+set\+\_\+bridge\+\_\+mode}} (\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} self, bool mode) -\begin{DoxyCompactList}\small\item\em Set bridge mode for the CIOT USB module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__usb_8h_a3182f3d52d2ed6b62d50f6b28f72e17e}{ciot\+\_\+usb\+\_\+task}} (\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Task function for the CIOT USB module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT USB module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__usb_8h_a014429fc850b705c643a7ec24bd55e1e}\label{ciot__usb_8h_a014429fc850b705c643a7ec24bd55e1e} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_event\_id\_t@{ciot\_usb\_event\_id\_t}} -\index{ciot\_usb\_event\_id\_t@{ciot\_usb\_event\_id\_t}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_event\_id\_t}{ciot\_usb\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5}{ciot\+\_\+usb\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__usb_8h_a014429fc850b705c643a7ec24bd55e1e}{ciot\+\_\+usb\+\_\+event\+\_\+id\+\_\+t}}} - - - -Event ID enumeration for CIOT USB module. - -\Hypertarget{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}\label{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_t@{ciot\_usb\_t}} -\index{ciot\_usb\_t@{ciot\_usb\_t}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_t}{ciot\_usb\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+usb\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}}} - - - -Handle type for CIOT USB module. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_event\_id@{ciot\_usb\_event\_id}} -\index{ciot\_usb\_event\_id@{ciot\_usb\_event\_id}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_event\_id}{ciot\_usb\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5}{ciot\+\_\+usb\+\_\+event\+\_\+id}}} - - - -Event ID enumeration for CIOT USB module. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DRV\_SOF@{CIOT\_USB\_EVENT\_DRV\_SOF}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DRV\_SOF@{CIOT\_USB\_EVENT\_DRV\_SOF}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a276f27a10f2d1d8f2b9669e73f741453}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a276f27a10f2d1d8f2b9669e73f741453} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+SOF&USB driver start of frame event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DRV\_RESET@{CIOT\_USB\_EVENT\_DRV\_RESET}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DRV\_RESET@{CIOT\_USB\_EVENT\_DRV\_RESET}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4e25ddb62bf2e37c550da599ba49baa}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4e25ddb62bf2e37c550da599ba49baa} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+RESET&USB driver reset event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DRV\_SUSPEND@{CIOT\_USB\_EVENT\_DRV\_SUSPEND}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DRV\_SUSPEND@{CIOT\_USB\_EVENT\_DRV\_SUSPEND}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a491b16a86bf780ddadb881ba97be218a}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a491b16a86bf780ddadb881ba97be218a} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+SUSPEND&USB driver suspend event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DRV\_RESUME@{CIOT\_USB\_EVENT\_DRV\_RESUME}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DRV\_RESUME@{CIOT\_USB\_EVENT\_DRV\_RESUME}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a10a07726018e6efe25f3d1e5dca2e895}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a10a07726018e6efe25f3d1e5dca2e895} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+RESUME&USB driver resume event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DRV\_WUREQ@{CIOT\_USB\_EVENT\_DRV\_WUREQ}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DRV\_WUREQ@{CIOT\_USB\_EVENT\_DRV\_WUREQ}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a696943e19333fb49af7bae6c62beb19b}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a696943e19333fb49af7bae6c62beb19b} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+WUREQ&USB driver wake-\/up request event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DRV\_SETUP@{CIOT\_USB\_EVENT\_DRV\_SETUP}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DRV\_SETUP@{CIOT\_USB\_EVENT\_DRV\_SETUP}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9c35023883831b5dc9a630f9121f0c68}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9c35023883831b5dc9a630f9121f0c68} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+SETUP&USB driver setup event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DRV\_EPTRANSFER@{CIOT\_USB\_EVENT\_DRV\_EPTRANSFER}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DRV\_EPTRANSFER@{CIOT\_USB\_EVENT\_DRV\_EPTRANSFER}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4003dcdc297ffa8fc4cbd2f9207daa8}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4003dcdc297ffa8fc4cbd2f9207daa8} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DRV\+\_\+\+EPTRANSFER&USB driver endpoint transfer event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_FIRST\_POWER@{CIOT\_USB\_EVENT\_FIRST\_POWER}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_FIRST\_POWER@{CIOT\_USB\_EVENT\_FIRST\_POWER}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a6d8d7a8948f67370c8d7180f4e35d357}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a6d8d7a8948f67370c8d7180f4e35d357} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+FIRST\+\_\+\+POWER&First power event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_POWER\_DETECTED@{CIOT\_USB\_EVENT\_POWER\_DETECTED}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_POWER\_DETECTED@{CIOT\_USB\_EVENT\_POWER\_DETECTED}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5adb38ca4f63e6efb7f66e814211e9a3ad}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5adb38ca4f63e6efb7f66e814211e9a3ad} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+POWER\+\_\+\+DETECTED&Power detected event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_POWER\_REMOVED@{CIOT\_USB\_EVENT\_POWER\_REMOVED}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_POWER\_REMOVED@{CIOT\_USB\_EVENT\_POWER\_REMOVED}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a8a1cc8b9386234f3133dc7c78eb0bef6}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a8a1cc8b9386234f3133dc7c78eb0bef6} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+POWER\+\_\+\+REMOVED&Power removed event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_POWER\_READY@{CIOT\_USB\_EVENT\_POWER\_READY}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_POWER\_READY@{CIOT\_USB\_EVENT\_POWER\_READY}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ad179606eaf7b0171f649090a3aa447c6}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ad179606eaf7b0171f649090a3aa447c6} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+POWER\+\_\+\+READY&Power ready event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_FIRST\_APP@{CIOT\_USB\_EVENT\_FIRST\_APP}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_FIRST\_APP@{CIOT\_USB\_EVENT\_FIRST\_APP}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a51f79a53cfc322086e3efd9e48c5ea6f}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a51f79a53cfc322086e3efd9e48c5ea6f} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+FIRST\+\_\+\+APP&First application event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_INST\_APPEND@{CIOT\_USB\_EVENT\_INST\_APPEND}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_INST\_APPEND@{CIOT\_USB\_EVENT\_INST\_APPEND}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaf2b626cb9e5b1be9d2eaa819fd3d386}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaf2b626cb9e5b1be9d2eaa819fd3d386} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+INST\+\_\+\+APPEND&Instance append event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_INST\_REMOVE@{CIOT\_USB\_EVENT\_INST\_REMOVE}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_INST\_REMOVE@{CIOT\_USB\_EVENT\_INST\_REMOVE}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a70d9c2054d28e7851d2ab32fc21b7e64}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a70d9c2054d28e7851d2ab32fc21b7e64} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+INST\+\_\+\+REMOVE&Instance remove event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_STARTED@{CIOT\_USB\_EVENT\_STARTED}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_STARTED@{CIOT\_USB\_EVENT\_STARTED}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac5ce262971db46bd319f96d936f97e51}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac5ce262971db46bd319f96d936f97e51} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STARTED&USB started event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_STOPPED@{CIOT\_USB\_EVENT\_STOPPED}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_STOPPED@{CIOT\_USB\_EVENT\_STOPPED}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a2876fe138403454c4c0c4bdec005b795}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a2876fe138403454c4c0c4bdec005b795} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STOPPED&USB stopped event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_STATE\_CHANGED@{CIOT\_USB\_EVENT\_STATE\_CHANGED}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_STATE\_CHANGED@{CIOT\_USB\_EVENT\_STATE\_CHANGED}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaa1ee6bcea019eed94daab3193bd589b}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaa1ee6bcea019eed94daab3193bd589b} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STATE\+\_\+\+CHANGED&State changed event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_FIRST\_INTERNAL@{CIOT\_USB\_EVENT\_FIRST\_INTERNAL}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_FIRST\_INTERNAL@{CIOT\_USB\_EVENT\_FIRST\_INTERNAL}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac3c161231a97b52f7b5eafdae193ef58}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac3c161231a97b52f7b5eafdae193ef58} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+FIRST\+\_\+\+INTERNAL&First internal event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_HFCLK\_READY@{CIOT\_USB\_EVENT\_HFCLK\_READY}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_HFCLK\_READY@{CIOT\_USB\_EVENT\_HFCLK\_READY}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5abefb094f2be1ef915bf5e9a20cf34add}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5abefb094f2be1ef915bf5e9a20cf34add} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+HFCLK\+\_\+\+READY&High frequency clock ready event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_START\_REQ@{CIOT\_USB\_EVENT\_START\_REQ}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_START\_REQ@{CIOT\_USB\_EVENT\_START\_REQ}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a4026d37d3f5e925bc054770b9ebe9526}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a4026d37d3f5e925bc054770b9ebe9526} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+START\+\_\+\+REQ&Start request event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_STOP\_REQ@{CIOT\_USB\_EVENT\_STOP\_REQ}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_STOP\_REQ@{CIOT\_USB\_EVENT\_STOP\_REQ}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a62de26da02a6e09bcd443684af656843}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a62de26da02a6e09bcd443684af656843} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+STOP\+\_\+\+REQ&Stop request event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_SUSPEND\_REQ@{CIOT\_USB\_EVENT\_SUSPEND\_REQ}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_SUSPEND\_REQ@{CIOT\_USB\_EVENT\_SUSPEND\_REQ}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a727280bd1dbf820baf7166b64bd9cf4e}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a727280bd1dbf820baf7166b64bd9cf4e} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+SUSPEND\+\_\+\+REQ&Suspend request event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_WAKEUP\_REQ@{CIOT\_USB\_EVENT\_WAKEUP\_REQ}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_WAKEUP\_REQ@{CIOT\_USB\_EVENT\_WAKEUP\_REQ}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9911a33a214c0b913128cf4c120bf737}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9911a33a214c0b913128cf4c120bf737} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+WAKEUP\+\_\+\+REQ&Wake-\/up request event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_SETUP\_SETADDRESS@{CIOT\_USB\_EVENT\_SETUP\_SETADDRESS}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_SETUP\_SETADDRESS@{CIOT\_USB\_EVENT\_SETUP\_SETADDRESS}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a1ea491afe0afdeef5390fb08ccf65cf8}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a1ea491afe0afdeef5390fb08ccf65cf8} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+SETUP\+\_\+\+SETADDRESS&Setup set address event \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_EVENT\_DATA@{CIOT\_USB\_EVENT\_DATA}!ciot\_usb.h@{ciot\_usb.h}}\index{ciot\_usb.h@{ciot\_usb.h}!CIOT\_USB\_EVENT\_DATA@{CIOT\_USB\_EVENT\_DATA}}}\Hypertarget{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a0f83b5f8ff28920ceaaad901510476c6}\label{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a0f83b5f8ff28920ceaaad901510476c6} -CIOT\+\_\+\+USB\+\_\+\+EVENT\+\_\+\+DATA&USB data event \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__usb_8h_abfc4f7cd5db3e2e5d94c4cd179d99799}\label{ciot__usb_8h_abfc4f7cd5db3e2e5d94c4cd179d99799} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_new@{ciot\_usb\_new}} -\index{ciot\_usb\_new@{ciot\_usb\_new}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_new()}{ciot\_usb\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} ciot\+\_\+usb\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new instance of CIOT USB module. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Unused parameter (can be NULL). \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the new CIOT USB instance. -\end{DoxyReturn} -\Hypertarget{ciot__usb_8h_aa7629e46c3c5f64fd1a03f449c9a62d9}\label{ciot__usb_8h_aa7629e46c3c5f64fd1a03f449c9a62d9} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_process\_req@{ciot\_usb\_process\_req}} -\index{ciot\_usb\_process\_req@{ciot\_usb\_process\_req}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_process\_req()}{ciot\_usb\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+usb\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__usb__req__t}{ciot\+\_\+usb\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a request in the CIOT USB module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT USB instance. \\ -\hline -{\em req} & Pointer to the USB request structure. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__usb_8h_abae2505d8aed15ad739be049f4180e28}\label{ciot__usb_8h_abae2505d8aed15ad739be049f4180e28} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_send\_bytes@{ciot\_usb\_send\_bytes}} -\index{ciot\_usb\_send\_bytes@{ciot\_usb\_send\_bytes}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_send\_bytes()}{ciot\_usb\_send\_bytes()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+usb\+\_\+send\+\_\+bytes (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{iface, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{bytes, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send bytes through the CIOT USB interface. - - -\begin{DoxyParams}{Parameters} -{\em iface} & Pointer to the CIOT interface instance. \\ -\hline -{\em bytes} & Pointer to the byte buffer to send. \\ -\hline -{\em size} & Size of the byte buffer. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__usb_8h_a1ca6b2b7d2fb270d03110baaafa69875}\label{ciot__usb_8h_a1ca6b2b7d2fb270d03110baaafa69875} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_send\_data@{ciot\_usb\_send\_data}} -\index{ciot\_usb\_send\_data@{ciot\_usb\_send\_data}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_send\_data()}{ciot\_usb\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+usb\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data through the CIOT USB module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT USB instance. \\ -\hline -{\em data} & Pointer to the data buffer. \\ -\hline -{\em size} & Size of the data buffer. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__usb_8h_ad2167601e42b510a7c5c23092c4c1d67}\label{ciot__usb_8h_ad2167601e42b510a7c5c23092c4c1d67} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_set\_bridge\_mode@{ciot\_usb\_set\_bridge\_mode}} -\index{ciot\_usb\_set\_bridge\_mode@{ciot\_usb\_set\_bridge\_mode}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_set\_bridge\_mode()}{ciot\_usb\_set\_bridge\_mode()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+usb\+\_\+set\+\_\+bridge\+\_\+mode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}}}]{self, }\item[{bool}]{mode }\end{DoxyParamCaption})} - - - -Set bridge mode for the CIOT USB module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT USB instance. \\ -\hline -{\em mode} & Bridge mode flag (true for enabled, false for disabled). \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__usb_8h_a6fc1bc4653f9484b79d7f6eec7b8a22e}\label{ciot__usb_8h_a6fc1bc4653f9484b79d7f6eec7b8a22e} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_start@{ciot\_usb\_start}} -\index{ciot\_usb\_start@{ciot\_usb\_start}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_start()}{ciot\_usb\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+usb\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__usb__cfg__t}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT USB module with the given configuration. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT USB instance. \\ -\hline -{\em cfg} & Configuration for the USB module. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__usb_8h_adabdd1e2583c19abdaf9c618ac48744c}\label{ciot__usb_8h_adabdd1e2583c19abdaf9c618ac48744c} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_stop@{ciot\_usb\_stop}} -\index{ciot\_usb\_stop@{ciot\_usb\_stop}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_stop()}{ciot\_usb\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+usb\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT USB module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT USB instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__usb_8h_a3182f3d52d2ed6b62d50f6b28f72e17e}\label{ciot__usb_8h_a3182f3d52d2ed6b62d50f6b28f72e17e} -\index{ciot\_usb.h@{ciot\_usb.h}!ciot\_usb\_task@{ciot\_usb\_task}} -\index{ciot\_usb\_task@{ciot\_usb\_task}!ciot\_usb.h@{ciot\_usb.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_task()}{ciot\_usb\_task()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+usb\+\_\+task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Task function for the CIOT USB module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT USB instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot__usb_8h_source.tex b/docs/latex/ciot__usb_8h_source.tex deleted file mode 100644 index 1568ba5..0000000 --- a/docs/latex/ciot__usb_8h_source.tex +++ /dev/null @@ -1,78 +0,0 @@ -\doxysection{ciot\+\_\+usb.\+h} -\hypertarget{ciot__usb_8h_source}{}\label{ciot__usb_8h_source}\index{include/ciot\_usb.h@{include/ciot\_usb.h}} -\mbox{\hyperlink{ciot__usb_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_USB\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_USB\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__usb__types_8h}{types/ciot\_usb\_types.h}}"{}}} -\DoxyCodeLine{00021\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00022\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00023\ } -\DoxyCodeLine{00027\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_usb\ *\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}};} -\DoxyCodeLine{00028\ } -\DoxyCodeLine{00032\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5}{ciot\_usb\_event\_id}}} -\DoxyCodeLine{00033\ \{} -\DoxyCodeLine{00034\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a276f27a10f2d1d8f2b9669e73f741453}{CIOT\_USB\_EVENT\_DRV\_SOF}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ \ \ \ \ } -\DoxyCodeLine{00035\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4e25ddb62bf2e37c550da599ba49baa}{CIOT\_USB\_EVENT\_DRV\_RESET}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a491b16a86bf780ddadb881ba97be218a}{CIOT\_USB\_EVENT\_DRV\_SUSPEND}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a10a07726018e6efe25f3d1e5dca2e895}{CIOT\_USB\_EVENT\_DRV\_RESUME}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a696943e19333fb49af7bae6c62beb19b}{CIOT\_USB\_EVENT\_DRV\_WUREQ}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9c35023883831b5dc9a630f9121f0c68}{CIOT\_USB\_EVENT\_DRV\_SETUP}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ae4003dcdc297ffa8fc4cbd2f9207daa8}{CIOT\_USB\_EVENT\_DRV\_EPTRANSFER}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a6d8d7a8948f67370c8d7180f4e35d357}{CIOT\_USB\_EVENT\_FIRST\_POWER}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5adb38ca4f63e6efb7f66e814211e9a3ad}{CIOT\_USB\_EVENT\_POWER\_DETECTED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a8a1cc8b9386234f3133dc7c78eb0bef6}{CIOT\_USB\_EVENT\_POWER\_REMOVED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ad179606eaf7b0171f649090a3aa447c6}{CIOT\_USB\_EVENT\_POWER\_READY}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a51f79a53cfc322086e3efd9e48c5ea6f}{CIOT\_USB\_EVENT\_FIRST\_APP}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaf2b626cb9e5b1be9d2eaa819fd3d386}{CIOT\_USB\_EVENT\_INST\_APPEND}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a70d9c2054d28e7851d2ab32fc21b7e64}{CIOT\_USB\_EVENT\_INST\_REMOVE}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00048\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac5ce262971db46bd319f96d936f97e51}{CIOT\_USB\_EVENT\_STARTED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00049\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a2876fe138403454c4c0c4bdec005b795}{CIOT\_USB\_EVENT\_STOPPED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00050\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5aaa1ee6bcea019eed94daab3193bd589b}{CIOT\_USB\_EVENT\_STATE\_CHANGED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00051\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5ac3c161231a97b52f7b5eafdae193ef58}{CIOT\_USB\_EVENT\_FIRST\_INTERNAL}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00052\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5abefb094f2be1ef915bf5e9a20cf34add}{CIOT\_USB\_EVENT\_HFCLK\_READY}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a4026d37d3f5e925bc054770b9ebe9526}{CIOT\_USB\_EVENT\_START\_REQ}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00054\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a62de26da02a6e09bcd443684af656843}{CIOT\_USB\_EVENT\_STOP\_REQ}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a727280bd1dbf820baf7166b64bd9cf4e}{CIOT\_USB\_EVENT\_SUSPEND\_REQ}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a9911a33a214c0b913128cf4c120bf737}{CIOT\_USB\_EVENT\_WAKEUP\_REQ}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00057\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a1ea491afe0afdeef5390fb08ccf65cf8}{CIOT\_USB\_EVENT\_SETUP\_SETADDRESS}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00058\ \ \ \ \ \mbox{\hyperlink{ciot__usb_8h_a0dca39c70c3854cb378c750cf03a92a5a0f83b5f8ff28920ceaaad901510476c6}{CIOT\_USB\_EVENT\_DATA}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00059\ \}\ \mbox{\hyperlink{ciot__usb_8h_a014429fc850b705c643a7ec24bd55e1e}{ciot\_usb\_event\_id\_t}};} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00064\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00065\ \{} -\DoxyCodeLine{00066\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__usb__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ \ \ } -\DoxyCodeLine{00067\ \ \ \ \ \mbox{\hyperlink{structciot__usb__status__t}{ciot\_usb\_status\_t}}\ \mbox{\hyperlink{structciot__usb__status__msg__t_ab26791741e383cec2107fa1540a14342}{status}};\ \ \ } -\DoxyCodeLine{00068\ \}\ \mbox{\hyperlink{structciot__usb__status__msg__t}{ciot\_usb\_status\_msg\_t}};} -\DoxyCodeLine{00069\ } -\DoxyCodeLine{00076\ \mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ \mbox{\hyperlink{ciot__usb_8h_abfc4f7cd5db3e2e5d94c4cd179d99799}{ciot\_usb\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00077\ } -\DoxyCodeLine{00085\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__usb_8h_a6fc1bc4653f9484b79d7f6eec7b8a22e}{ciot\_usb\_start}}(\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ self,\ \mbox{\hyperlink{structciot__usb__cfg__t}{ciot\_usb\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00086\ } -\DoxyCodeLine{00093\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__usb_8h_adabdd1e2583c19abdaf9c618ac48744c}{ciot\_usb\_stop}}(\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ self);} -\DoxyCodeLine{00094\ } -\DoxyCodeLine{00102\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__usb_8h_aa7629e46c3c5f64fd1a03f449c9a62d9}{ciot\_usb\_process\_req}}(\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ self,\ \mbox{\hyperlink{structciot__usb__req__t}{ciot\_usb\_req\_t}}\ *req);} -\DoxyCodeLine{00103\ } -\DoxyCodeLine{00112\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__usb_8h_a1ca6b2b7d2fb270d03110baaafa69875}{ciot\_usb\_send\_data}}(\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00113\ } -\DoxyCodeLine{00122\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__usb_8h_abae2505d8aed15ad739be049f4180e28}{ciot\_usb\_send\_bytes}}(\mbox{\hyperlink{structciot__iface}{ciot\_iface\_t}}\ *iface,\ uint8\_t\ *bytes,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00123\ } -\DoxyCodeLine{00131\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__usb_8h_ad2167601e42b510a7c5c23092c4c1d67}{ciot\_usb\_set\_bridge\_mode}}(\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ self,\ \textcolor{keywordtype}{bool}\ mode);} -\DoxyCodeLine{00132\ } -\DoxyCodeLine{00139\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__usb_8h_a3182f3d52d2ed6b62d50f6b28f72e17e}{ciot\_usb\_task}}(\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\_usb\_t}}\ self);} -\DoxyCodeLine{00140\ } -\DoxyCodeLine{00141\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00142\ \}} -\DoxyCodeLine{00143\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00144\ } -\DoxyCodeLine{00145\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__usb__types_8h.tex b/docs/latex/ciot__usb__types_8h.tex deleted file mode 100644 index a775a9d..0000000 --- a/docs/latex/ciot__usb__types_8h.tex +++ /dev/null @@ -1,108 +0,0 @@ -\doxysection{include/types/ciot\+\_\+usb\+\_\+types.h File Reference} -\hypertarget{ciot__usb__types_8h}{}\label{ciot__usb__types_8h}\index{include/types/ciot\_usb\_types.h@{include/types/ciot\_usb\_types.h}} - - -Defines data structures and types for CIOT USB functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+common\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__usb__cfg__t}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT USB configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__usb__status__t}{ciot\+\_\+usb\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT USB status. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__usb__req__data__u}{ciot\+\_\+usb\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT USB request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__usb__req__t}{ciot\+\_\+usb\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT USB request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__usb__event}{ciot\+\_\+usb\+\_\+event}} -\begin{DoxyCompactList}\small\item\em Union for CIOT USB event. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__usb__data__u}{ciot\+\_\+usb\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT USB data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef union \mbox{\hyperlink{unionciot__usb__event}{ciot\+\_\+usb\+\_\+event}} \mbox{\hyperlink{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}{ciot\+\_\+usb\+\_\+event\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT USB event. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4}{ciot\+\_\+usb\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a481dcefd205d22bd32f4fed57ca1c1a7}{CIOT\+\_\+\+USB\+\_\+\+STATE\+\_\+\+STOPPED}} -, \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a6e05597b6f5e366cd8b0f7c053faa55b}{CIOT\+\_\+\+USB\+\_\+\+STATE\+\_\+\+STARTED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT USB states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef}{ciot\+\_\+usb\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41efa131069815baa028e3106e0f74227b5d7}{CIOT\+\_\+\+USB\+\_\+\+REQ\+\_\+\+UNKNOWN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT USB request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data structures and types for CIOT USB functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/10 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}\label{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948} -\index{ciot\_usb\_types.h@{ciot\_usb\_types.h}!ciot\_usb\_event\_u@{ciot\_usb\_event\_u}} -\index{ciot\_usb\_event\_u@{ciot\_usb\_event\_u}!ciot\_usb\_types.h@{ciot\_usb\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_event\_u}{ciot\_usb\_event\_u}} -{\footnotesize\ttfamily typedef union \mbox{\hyperlink{unionciot__usb__event}{ciot\+\_\+usb\+\_\+event}} \mbox{\hyperlink{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}{ciot\+\_\+usb\+\_\+event\+\_\+u}}} - - - -Union for CIOT USB event. - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef}\label{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef} -\index{ciot\_usb\_types.h@{ciot\_usb\_types.h}!ciot\_usb\_req\_type\_t@{ciot\_usb\_req\_type\_t}} -\index{ciot\_usb\_req\_type\_t@{ciot\_usb\_req\_type\_t}!ciot\_usb\_types.h@{ciot\_usb\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_req\_type\_t}{ciot\_usb\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef}{ciot\+\_\+usb\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT USB request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_REQ\_UNKNOWN@{CIOT\_USB\_REQ\_UNKNOWN}!ciot\_usb\_types.h@{ciot\_usb\_types.h}}\index{ciot\_usb\_types.h@{ciot\_usb\_types.h}!CIOT\_USB\_REQ\_UNKNOWN@{CIOT\_USB\_REQ\_UNKNOWN}}}\Hypertarget{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41efa131069815baa028e3106e0f74227b5d7}\label{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41efa131069815baa028e3106e0f74227b5d7} -CIOT\+\_\+\+USB\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown request type \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4}\label{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4} -\index{ciot\_usb\_types.h@{ciot\_usb\_types.h}!ciot\_usb\_state\_t@{ciot\_usb\_state\_t}} -\index{ciot\_usb\_state\_t@{ciot\_usb\_state\_t}!ciot\_usb\_types.h@{ciot\_usb\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_usb\_state\_t}{ciot\_usb\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4}{ciot\+\_\+usb\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT USB states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_STATE\_STOPPED@{CIOT\_USB\_STATE\_STOPPED}!ciot\_usb\_types.h@{ciot\_usb\_types.h}}\index{ciot\_usb\_types.h@{ciot\_usb\_types.h}!CIOT\_USB\_STATE\_STOPPED@{CIOT\_USB\_STATE\_STOPPED}}}\Hypertarget{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a481dcefd205d22bd32f4fed57ca1c1a7}\label{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a481dcefd205d22bd32f4fed57ca1c1a7} -CIOT\+\_\+\+USB\+\_\+\+STATE\+\_\+\+STOPPED&USB stopped state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_USB\_STATE\_STARTED@{CIOT\_USB\_STATE\_STARTED}!ciot\_usb\_types.h@{ciot\_usb\_types.h}}\index{ciot\_usb\_types.h@{ciot\_usb\_types.h}!CIOT\_USB\_STATE\_STARTED@{CIOT\_USB\_STATE\_STARTED}}}\Hypertarget{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a6e05597b6f5e366cd8b0f7c053faa55b}\label{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a6e05597b6f5e366cd8b0f7c053faa55b} -CIOT\+\_\+\+USB\+\_\+\+STATE\+\_\+\+STARTED&USB started state \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__usb__types_8h_source.tex b/docs/latex/ciot__usb__types_8h_source.tex deleted file mode 100644 index 4e1d455..0000000 --- a/docs/latex/ciot__usb__types_8h_source.tex +++ /dev/null @@ -1,68 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+types.\+h} -\hypertarget{ciot__usb__types_8h_source}{}\label{ciot__usb__types_8h_source}\index{include/types/ciot\_usb\_types.h@{include/types/ciot\_usb\_types.h}} -\mbox{\hyperlink{ciot__usb__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_USB\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_USB\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__common__types_8h}{ciot\_common\_types.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00026\ \{} -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a481dcefd205d22bd32f4fed57ca1c1a7}{CIOT\_USB\_STATE\_STOPPED}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4a6e05597b6f5e366cd8b0f7c053faa55b}{CIOT\_USB\_STATE\_STARTED}},\ } -\DoxyCodeLine{00029\ \}\ \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4}{ciot\_usb\_state\_t}};} -\DoxyCodeLine{00030\ } -\DoxyCodeLine{00034\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00035\ \{} -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41efa131069815baa028e3106e0f74227b5d7}{CIOT\_USB\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00037\ \}\ \mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef}{ciot\_usb\_req\_type\_t}};} -\DoxyCodeLine{00038\ } -\DoxyCodeLine{00042\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00043\ \{} -\DoxyCodeLine{00044\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structciot__usb__cfg__t_a4e8946f8a10777bc88814da1c657815c}{bridge\_mode}};\ } -\DoxyCodeLine{00045\ \}\ \mbox{\hyperlink{structciot__usb__cfg__t}{ciot\_usb\_cfg\_t}};} -\DoxyCodeLine{00046\ } -\DoxyCodeLine{00050\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00051\ \{} -\DoxyCodeLine{00052\ \ \ \ \ \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4}{ciot\_usb\_state\_t}}\ \mbox{\hyperlink{structciot__usb__status__t_a3442f594ec1fc76781d93b1a28b55cba}{state}};\ } -\DoxyCodeLine{00053\ \}\ \mbox{\hyperlink{structciot__usb__status__t}{ciot\_usb\_status\_t}};} -\DoxyCodeLine{00054\ } -\DoxyCodeLine{00058\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00059\ \{} -\DoxyCodeLine{00060\ } -\DoxyCodeLine{00061\ \}\ \mbox{\hyperlink{unionciot__usb__req__data__u}{ciot\_usb\_req\_data\_u}};} -\DoxyCodeLine{00062\ } -\DoxyCodeLine{00066\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00067\ \{} -\DoxyCodeLine{00068\ \ \ \ \ \mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef}{ciot\_usb\_req\_type\_t}}\ \mbox{\hyperlink{structciot__usb__req__t_aa027ba4e6f58da1f5204e16dd15d5136}{type}};\ } -\DoxyCodeLine{00069\ \ \ \ \ \mbox{\hyperlink{unionciot__usb__req__data__u}{ciot\_usb\_req\_data\_u}}\ \mbox{\hyperlink{structciot__usb__req__t_a91cc22753d20b8e288bae1944e5c5fce}{data}};\ } -\DoxyCodeLine{00070\ \}\ \mbox{\hyperlink{structciot__usb__req__t}{ciot\_usb\_req\_t}};} -\DoxyCodeLine{00071\ } -\DoxyCodeLine{00075\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\mbox{\hyperlink{unionciot__usb__event}{ciot\_usb\_event}}} -\DoxyCodeLine{00076\ \{} -\DoxyCodeLine{00077\ \ \ \ \ \mbox{\hyperlink{structciot__event__data}{ciot\_event\_data\_t}}\ \mbox{\hyperlink{unionciot__usb__event_a998bffd5567753ef3f6b652a400de36b}{data}};\ } -\DoxyCodeLine{00078\ \}\ \mbox{\hyperlink{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}{ciot\_usb\_event\_u}};} -\DoxyCodeLine{00079\ } -\DoxyCodeLine{00083\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00084\ \{} -\DoxyCodeLine{00085\ \ \ \ \ \mbox{\hyperlink{structciot__usb__cfg__t}{ciot\_usb\_cfg\_t}}\ \mbox{\hyperlink{unionciot__usb__data__u_a5a3eefbe6f21d662a5e318bbf323a00e}{config}};\ } -\DoxyCodeLine{00086\ \ \ \ \ \mbox{\hyperlink{structciot__usb__status__t}{ciot\_usb\_status\_t}}\ \mbox{\hyperlink{unionciot__usb__data__u_ab26791741e383cec2107fa1540a14342}{status}};\ } -\DoxyCodeLine{00087\ \ \ \ \ \mbox{\hyperlink{structciot__usb__req__t}{ciot\_usb\_req\_t}}\ \mbox{\hyperlink{unionciot__usb__data__u_aebb2adef59fcdc91db3d185996066c6a}{request}};\ } -\DoxyCodeLine{00088\ \ \ \ \ \mbox{\hyperlink{unionciot__usb__event}{ciot\_usb\_event\_u}}\ \mbox{\hyperlink{unionciot__usb__data__u_abe630baacf2cedc1090a81ef4e39a081}{event}};\ } -\DoxyCodeLine{00089\ \}\ \mbox{\hyperlink{unionciot__usb__data__u}{ciot\_usb\_data\_u}};} -\DoxyCodeLine{00090\ } -\DoxyCodeLine{00091\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00092\ \}} -\DoxyCodeLine{00093\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00094\ } -\DoxyCodeLine{00095\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__utils_8h.tex b/docs/latex/ciot__utils_8h.tex deleted file mode 100644 index 6ef8c12..0000000 --- a/docs/latex/ciot__utils_8h.tex +++ /dev/null @@ -1,58 +0,0 @@ -\doxysection{include/ciot\+\_\+utils.h File Reference} -\hypertarget{ciot__utils_8h}{}\label{ciot__utils_8h}\index{include/ciot\_utils.h@{include/ciot\_utils.h}} -{\ttfamily \#include $<$stdlib.\+h$>$}\newline -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include $<$stdbool.\+h$>$}\newline -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -void \mbox{\hyperlink{ciot__utils_8h_aa302b5f9f162b83148b624c132ff56a6}{bytes\+\_\+to\+\_\+hex}} (char \texorpdfstring{$\ast$}{*}dst, uint8\+\_\+t \texorpdfstring{$\ast$}{*}src, size\+\_\+t size, bool reverse) -\begin{DoxyCompactList}\small\item\em Convert bytes to hexadecimal representation. \end{DoxyCompactList}\item -uint32\+\_\+t \mbox{\hyperlink{ciot__utils_8h_a3c925cbabcbf9b62b099a9c5d5a054ad}{crc32\+\_\+compute}} (uint8\+\_\+t const \texorpdfstring{$\ast$}{*}p\+\_\+data, uint32\+\_\+t size, uint32\+\_\+t const \texorpdfstring{$\ast$}{*}p\+\_\+crc) -\begin{DoxyCompactList}\small\item\em Compute CRC32 checksum for the given data. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__utils_8h_aa302b5f9f162b83148b624c132ff56a6}\label{ciot__utils_8h_aa302b5f9f162b83148b624c132ff56a6} -\index{ciot\_utils.h@{ciot\_utils.h}!bytes\_to\_hex@{bytes\_to\_hex}} -\index{bytes\_to\_hex@{bytes\_to\_hex}!ciot\_utils.h@{ciot\_utils.h}} -\doxysubsubsection{\texorpdfstring{bytes\_to\_hex()}{bytes\_to\_hex()}} -{\footnotesize\ttfamily void bytes\+\_\+to\+\_\+hex (\begin{DoxyParamCaption}\item[{char \texorpdfstring{$\ast$}{*}}]{dst, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{src, }\item[{size\+\_\+t}]{size, }\item[{bool}]{reverse }\end{DoxyParamCaption})} - - - -Convert bytes to hexadecimal representation. - - -\begin{DoxyParams}{Parameters} -{\em dst} & Destination buffer for the hexadecimal string. \\ -\hline -{\em src} & Source buffer containing bytes to convert. \\ -\hline -{\em size} & Size of the source buffer. \\ -\hline -{\em reverse} & Flag indicating whether to reverse byte order (little-\/endian). \\ -\hline -\end{DoxyParams} -\Hypertarget{ciot__utils_8h_a3c925cbabcbf9b62b099a9c5d5a054ad}\label{ciot__utils_8h_a3c925cbabcbf9b62b099a9c5d5a054ad} -\index{ciot\_utils.h@{ciot\_utils.h}!crc32\_compute@{crc32\_compute}} -\index{crc32\_compute@{crc32\_compute}!ciot\_utils.h@{ciot\_utils.h}} -\doxysubsubsection{\texorpdfstring{crc32\_compute()}{crc32\_compute()}} -{\footnotesize\ttfamily uint32\+\_\+t crc32\+\_\+compute (\begin{DoxyParamCaption}\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{p\+\_\+data, }\item[{uint32\+\_\+t}]{size, }\item[{uint32\+\_\+t const \texorpdfstring{$\ast$}{*}}]{p\+\_\+crc }\end{DoxyParamCaption})} - - - -Compute CRC32 checksum for the given data. - - -\begin{DoxyParams}{Parameters} -{\em p\+\_\+data} & Pointer to the data buffer. \\ -\hline -{\em size} & Size of the data buffer. \\ -\hline -{\em p\+\_\+crc} & Pointer to the initial CRC32 value (optional, can be NULL). \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Computed CRC32 checksum. -\end{DoxyReturn} diff --git a/docs/latex/ciot__utils_8h_source.tex b/docs/latex/ciot__utils_8h_source.tex deleted file mode 100644 index 66ec7ba..0000000 --- a/docs/latex/ciot__utils_8h_source.tex +++ /dev/null @@ -1,27 +0,0 @@ -\doxysection{ciot\+\_\+utils.\+h} -\hypertarget{ciot__utils_8h_source}{}\label{ciot__utils_8h_source}\index{include/ciot\_utils.h@{include/ciot\_utils.h}} -\mbox{\hyperlink{ciot__utils_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_UTILS\_\_H\_\_}} -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_UTILS\_\_H\_\_}} -\DoxyCodeLine{00012\ } -\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00014\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00015\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00016\ } -\DoxyCodeLine{00017\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00020\ } -\DoxyCodeLine{00029\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{ciot__utils_8h_aa302b5f9f162b83148b624c132ff56a6}{bytes\_to\_hex}}(\textcolor{keywordtype}{char}\ *dst,\ uint8\_t\ *src,\ \textcolor{keywordtype}{size\_t}\ size,\ \textcolor{keywordtype}{bool}\ reverse);} -\DoxyCodeLine{00030\ } -\DoxyCodeLine{00039\ uint32\_t\ \mbox{\hyperlink{ciot__utils_8h_a3c925cbabcbf9b62b099a9c5d5a054ad}{crc32\_compute}}(uint8\_t\ \textcolor{keyword}{const}\ *p\_data,\ uint32\_t\ size,\ uint32\_t\ \textcolor{keyword}{const}\ *p\_crc);} -\DoxyCodeLine{00040\ } -\DoxyCodeLine{00041\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00042\ \}} -\DoxyCodeLine{00043\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00044\ } -\DoxyCodeLine{00045\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__wifi_8h.tex b/docs/latex/ciot__wifi_8h.tex deleted file mode 100644 index 63e0389..0000000 --- a/docs/latex/ciot__wifi_8h.tex +++ /dev/null @@ -1,324 +0,0 @@ -\doxysection{include/ciot\+\_\+wifi.h File Reference} -\hypertarget{ciot__wifi_8h}{}\label{ciot__wifi_8h}\index{include/ciot\_wifi.h@{include/ciot\_wifi.h}} - - -Header file for CIOT Wi-\/\+Fi module. - - -{\ttfamily \#include "{}types/ciot\+\_\+wifi\+\_\+types.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+iface.\+h"{}}\newline -{\ttfamily \#include "{}ciot\+\_\+err.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__wifi__status__msg__t}{ciot\+\_\+wifi\+\_\+status\+\_\+msg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Packed structure for Wi-\/\+Fi status message. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \mbox{\hyperlink{ciot__wifi_8h_a42b035be0aacdd70d63a87058414db71}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+AUTH}}~0 -\begin{DoxyCompactList}\small\item\em Default configuration values for Wi-\/\+Fi Access Point (AP). \end{DoxyCompactList}\item -\#define \mbox{\hyperlink{ciot__wifi_8h_a28cc7b020ea752969183284f9e2f4ddb}{CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+MAX\+\_\+\+CONN}}~1 -\end{DoxyCompactItemize} -\doxysubsubsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef struct ciot\+\_\+wifi \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} -\item -typedef enum \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1c}{ciot\+\_\+wifi\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__wifi_8h_aef3e522ed9507f7dbe6304d5ad31fbf9}{ciot\+\_\+wifi\+\_\+event\+\_\+id\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Enumeration of Wi-\/\+Fi event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1c}{ciot\+\_\+wifi\+\_\+event\+\_\+id}} \{ \newline -\mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca6b713b4b3920bb34f47260c7643ca2b8}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+START}} = CIOT\+\_\+\+IFACE\+\_\+\+EVENT\+\_\+\+CUSTOM -, \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca257ec9d7ea2e07aace2c8a179405e807}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+STOP}} -, \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca1b98996941b31dea8da9c83eb62fea37}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+CONNECTED}} -, \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca7076a750c510b561b1f0884ddd7e50db}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+DISCONNECTED}} -, \newline -\mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1cac7a40b44a69f4c9761043bf78a5cded3}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+START}} -, \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca52710095670909e218c917ec10e77363}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+STOP}} -, \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caa23c4adec62d9312d64a71f82f6efd03}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+STACONNECTED}} -, \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caf42578350701e71889e933df00f62043}{CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+STADISCONNECTED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration of Wi-\/\+Fi event IDs. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_a07185c8551c5e40a05d113736a72e1d7}{ciot\+\_\+wifi\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT Wi-\/\+Fi instance. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_aff94df1a4c08ca1cbea37d8dcd3f8777}{ciot\+\_\+wifi\+\_\+ap\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT Wi-\/\+Fi instance for Access Point (AP) mode. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_a57c540c883f21bdfa6d5d0a92584cc90}{ciot\+\_\+wifi\+\_\+sta\+\_\+new}} (void \texorpdfstring{$\ast$}{*}handle) -\begin{DoxyCompactList}\small\item\em Create a new CIOT Wi-\/\+Fi instance for Station (STA) mode. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_af030ec8963d45c8374b58b10d3c83b9a}{ciot\+\_\+wifi\+\_\+start}} (\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} self, \mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}cfg) -\begin{DoxyCompactList}\small\item\em Start the CIOT Wi-\/\+Fi module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_aed26866d40b64a5f80c4769481987cc0}{ciot\+\_\+wifi\+\_\+stop}} (\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} self) -\begin{DoxyCompactList}\small\item\em Stop the CIOT Wi-\/\+Fi module. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_a37b38c412e4f11696f1e2c03852cc1b7}{ciot\+\_\+wifi\+\_\+process\+\_\+req}} (\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} self, \mbox{\hyperlink{structciot__wifi__req__t}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}req) -\begin{DoxyCompactList}\small\item\em Process a Wi-\/\+Fi request. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_a1444b4045430489fbf88036fe898528a}{ciot\+\_\+wifi\+\_\+send\+\_\+data}} (\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} self, uint8\+\_\+t \texorpdfstring{$\ast$}{*}data, int size) -\begin{DoxyCompactList}\small\item\em Send data over Wi-\/\+Fi. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} \mbox{\hyperlink{ciot__wifi_8h_a5817f21b0b8d5b22430f3ecb3c3c37a5}{ciot\+\_\+wifi\+\_\+get\+\_\+mac}} (\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} self, \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\+\_\+wifi\+\_\+type\+\_\+t}} type, uint8\+\_\+t mac\mbox{[}6\mbox{]}) -\begin{DoxyCompactList}\small\item\em Get the MAC address of the Wi-\/\+Fi module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Header file for CIOT Wi-\/\+Fi module. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/18 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Macro Definition Documentation} -\Hypertarget{ciot__wifi_8h_a42b035be0aacdd70d63a87058414db71}\label{ciot__wifi_8h_a42b035be0aacdd70d63a87058414db71} -\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_CONFIG\_WIFI\_AP\_AUTH@{CIOT\_CONFIG\_WIFI\_AP\_AUTH}} -\index{CIOT\_CONFIG\_WIFI\_AP\_AUTH@{CIOT\_CONFIG\_WIFI\_AP\_AUTH}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_AP\_AUTH}{CIOT\_CONFIG\_WIFI\_AP\_AUTH}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+AUTH~0} - - - -Default configuration values for Wi-\/\+Fi Access Point (AP). - -\Hypertarget{ciot__wifi_8h_a28cc7b020ea752969183284f9e2f4ddb}\label{ciot__wifi_8h_a28cc7b020ea752969183284f9e2f4ddb} -\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN@{CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN}} -\index{CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN@{CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN}{CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN}} -{\footnotesize\ttfamily \#define CIOT\+\_\+\+CONFIG\+\_\+\+WIFI\+\_\+\+AP\+\_\+\+MAX\+\_\+\+CONN~1} - - - -\doxysubsection{Typedef Documentation} -\Hypertarget{ciot__wifi_8h_aef3e522ed9507f7dbe6304d5ad31fbf9}\label{ciot__wifi_8h_aef3e522ed9507f7dbe6304d5ad31fbf9} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_event\_id\_t@{ciot\_wifi\_event\_id\_t}} -\index{ciot\_wifi\_event\_id\_t@{ciot\_wifi\_event\_id\_t}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_event\_id\_t}{ciot\_wifi\_event\_id\_t}} -{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1c}{ciot\+\_\+wifi\+\_\+event\+\_\+id}} \mbox{\hyperlink{ciot__wifi_8h_aef3e522ed9507f7dbe6304d5ad31fbf9}{ciot\+\_\+wifi\+\_\+event\+\_\+id\+\_\+t}}} - - - -Enumeration of Wi-\/\+Fi event IDs. - -\Hypertarget{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}\label{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_t@{ciot\_wifi\_t}} -\index{ciot\_wifi\_t@{ciot\_wifi\_t}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_t}{ciot\_wifi\_t}} -{\footnotesize\ttfamily typedef struct ciot\+\_\+wifi\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}}} - - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1c}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1c} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_event\_id@{ciot\_wifi\_event\_id}} -\index{ciot\_wifi\_event\_id@{ciot\_wifi\_event\_id}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_event\_id}{ciot\_wifi\_event\_id}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1c}{ciot\+\_\+wifi\+\_\+event\+\_\+id}}} - - - -Enumeration of Wi-\/\+Fi event IDs. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_STA\_START@{CIOT\_WIFI\_EVENT\_STA\_START}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_STA\_START@{CIOT\_WIFI\_EVENT\_STA\_START}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca6b713b4b3920bb34f47260c7643ca2b8}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca6b713b4b3920bb34f47260c7643ca2b8} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+START&Event for Wi-\/\+Fi STA start. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_STA\_STOP@{CIOT\_WIFI\_EVENT\_STA\_STOP}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_STA\_STOP@{CIOT\_WIFI\_EVENT\_STA\_STOP}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca257ec9d7ea2e07aace2c8a179405e807}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca257ec9d7ea2e07aace2c8a179405e807} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+STOP&Event for Wi-\/\+Fi STA stop. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_STA\_CONNECTED@{CIOT\_WIFI\_EVENT\_STA\_CONNECTED}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_STA\_CONNECTED@{CIOT\_WIFI\_EVENT\_STA\_CONNECTED}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca1b98996941b31dea8da9c83eb62fea37}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca1b98996941b31dea8da9c83eb62fea37} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+CONNECTED&Event for Wi-\/\+Fi STA connected. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_STA\_DISCONNECTED@{CIOT\_WIFI\_EVENT\_STA\_DISCONNECTED}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_STA\_DISCONNECTED@{CIOT\_WIFI\_EVENT\_STA\_DISCONNECTED}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca7076a750c510b561b1f0884ddd7e50db}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca7076a750c510b561b1f0884ddd7e50db} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+STA\+\_\+\+DISCONNECTED&Event for Wi-\/\+Fi STA disconnected. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_AP\_START@{CIOT\_WIFI\_EVENT\_AP\_START}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_AP\_START@{CIOT\_WIFI\_EVENT\_AP\_START}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1cac7a40b44a69f4c9761043bf78a5cded3}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1cac7a40b44a69f4c9761043bf78a5cded3} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+START&Event for Wi-\/\+Fi AP start. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_AP\_STOP@{CIOT\_WIFI\_EVENT\_AP\_STOP}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_AP\_STOP@{CIOT\_WIFI\_EVENT\_AP\_STOP}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca52710095670909e218c917ec10e77363}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca52710095670909e218c917ec10e77363} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+STOP&Event for Wi-\/\+Fi AP stop. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_AP\_STACONNECTED@{CIOT\_WIFI\_EVENT\_AP\_STACONNECTED}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_AP\_STACONNECTED@{CIOT\_WIFI\_EVENT\_AP\_STACONNECTED}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caa23c4adec62d9312d64a71f82f6efd03}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caa23c4adec62d9312d64a71f82f6efd03} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+STACONNECTED&Event for Wi-\/\+Fi AP STA connected. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_EVENT\_AP\_STADISCONNECTED@{CIOT\_WIFI\_EVENT\_AP\_STADISCONNECTED}!ciot\_wifi.h@{ciot\_wifi.h}}\index{ciot\_wifi.h@{ciot\_wifi.h}!CIOT\_WIFI\_EVENT\_AP\_STADISCONNECTED@{CIOT\_WIFI\_EVENT\_AP\_STADISCONNECTED}}}\Hypertarget{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caf42578350701e71889e933df00f62043}\label{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caf42578350701e71889e933df00f62043} -CIOT\+\_\+\+WIFI\+\_\+\+EVENT\+\_\+\+AP\+\_\+\+STADISCONNECTED&Event for Wi-\/\+Fi AP STA disconnected. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{ciot__wifi_8h_aff94df1a4c08ca1cbea37d8dcd3f8777}\label{ciot__wifi_8h_aff94df1a4c08ca1cbea37d8dcd3f8777} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_ap\_new@{ciot\_wifi\_ap\_new}} -\index{ciot\_wifi\_ap\_new@{ciot\_wifi\_ap\_new}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_ap\_new()}{ciot\_wifi\_ap\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} ciot\+\_\+wifi\+\_\+ap\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT Wi-\/\+Fi instance for Access Point (AP) mode. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the Wi-\/\+Fi handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the created CIOT Wi-\/\+Fi instance for AP mode. -\end{DoxyReturn} -\Hypertarget{ciot__wifi_8h_a5817f21b0b8d5b22430f3ecb3c3c37a5}\label{ciot__wifi_8h_a5817f21b0b8d5b22430f3ecb3c3c37a5} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_get\_mac@{ciot\_wifi\_get\_mac}} -\index{ciot\_wifi\_get\_mac@{ciot\_wifi\_get\_mac}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_get\_mac()}{ciot\_wifi\_get\_mac()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+wifi\+\_\+get\+\_\+mac (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\+\_\+wifi\+\_\+type\+\_\+t}}}]{type, }\item[{uint8\+\_\+t}]{mac\mbox{[}6\mbox{]} }\end{DoxyParamCaption})} - - - -Get the MAC address of the Wi-\/\+Fi module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Wi-\/\+Fi instance. \\ -\hline -{\em type} & Type of Wi-\/\+Fi (AP or STA). \\ -\hline -{\em mac} & Buffer to store the MAC address. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__wifi_8h_a07185c8551c5e40a05d113736a72e1d7}\label{ciot__wifi_8h_a07185c8551c5e40a05d113736a72e1d7} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_new@{ciot\_wifi\_new}} -\index{ciot\_wifi\_new@{ciot\_wifi\_new}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_new()}{ciot\_wifi\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} ciot\+\_\+wifi\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT Wi-\/\+Fi instance. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the Wi-\/\+Fi handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the created CIOT Wi-\/\+Fi instance. -\end{DoxyReturn} -\Hypertarget{ciot__wifi_8h_a37b38c412e4f11696f1e2c03852cc1b7}\label{ciot__wifi_8h_a37b38c412e4f11696f1e2c03852cc1b7} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_process\_req@{ciot\_wifi\_process\_req}} -\index{ciot\_wifi\_process\_req@{ciot\_wifi\_process\_req}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_process\_req()}{ciot\_wifi\_process\_req()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+wifi\+\_\+process\+\_\+req (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__wifi__req__t}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{req }\end{DoxyParamCaption})} - - - -Process a Wi-\/\+Fi request. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Wi-\/\+Fi instance. \\ -\hline -{\em req} & Pointer to the Wi-\/\+Fi request. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__wifi_8h_a1444b4045430489fbf88036fe898528a}\label{ciot__wifi_8h_a1444b4045430489fbf88036fe898528a} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_send\_data@{ciot\_wifi\_send\_data}} -\index{ciot\_wifi\_send\_data@{ciot\_wifi\_send\_data}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_send\_data()}{ciot\_wifi\_send\_data()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+wifi\+\_\+send\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}}}]{self, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{data, }\item[{int}]{size }\end{DoxyParamCaption})} - - - -Send data over Wi-\/\+Fi. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Wi-\/\+Fi instance. \\ -\hline -{\em data} & Pointer to the data buffer. \\ -\hline -{\em size} & Size of the data buffer. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__wifi_8h_a57c540c883f21bdfa6d5d0a92584cc90}\label{ciot__wifi_8h_a57c540c883f21bdfa6d5d0a92584cc90} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_sta\_new@{ciot\_wifi\_sta\_new}} -\index{ciot\_wifi\_sta\_new@{ciot\_wifi\_sta\_new}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_sta\_new()}{ciot\_wifi\_sta\_new()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} ciot\+\_\+wifi\+\_\+sta\+\_\+new (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{handle }\end{DoxyParamCaption})} - - - -Create a new CIOT Wi-\/\+Fi instance for Station (STA) mode. - - -\begin{DoxyParams}{Parameters} -{\em handle} & Pointer to the Wi-\/\+Fi handle. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the created CIOT Wi-\/\+Fi instance for STA mode. -\end{DoxyReturn} -\Hypertarget{ciot__wifi_8h_af030ec8963d45c8374b58b10d3c83b9a}\label{ciot__wifi_8h_af030ec8963d45c8374b58b10d3c83b9a} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_start@{ciot\_wifi\_start}} -\index{ciot\_wifi\_start@{ciot\_wifi\_start}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_start()}{ciot\_wifi\_start()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+wifi\+\_\+start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}}}]{self, }\item[{\mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{cfg }\end{DoxyParamCaption})} - - - -Start the CIOT Wi-\/\+Fi module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Wi-\/\+Fi instance. \\ -\hline -{\em cfg} & Pointer to the Wi-\/\+Fi configuration. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} -\Hypertarget{ciot__wifi_8h_aed26866d40b64a5f80c4769481987cc0}\label{ciot__wifi_8h_aed26866d40b64a5f80c4769481987cc0} -\index{ciot\_wifi.h@{ciot\_wifi.h}!ciot\_wifi\_stop@{ciot\_wifi\_stop}} -\index{ciot\_wifi\_stop@{ciot\_wifi\_stop}!ciot\_wifi.h@{ciot\_wifi.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_stop()}{ciot\_wifi\_stop()}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\+\_\+err\+\_\+t}} ciot\+\_\+wifi\+\_\+stop (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}}}]{self }\end{DoxyParamCaption})} - - - -Stop the CIOT Wi-\/\+Fi module. - - -\begin{DoxyParams}{Parameters} -{\em self} & Pointer to the CIOT Wi-\/\+Fi instance. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Error code indicating success or failure. -\end{DoxyReturn} diff --git a/docs/latex/ciot__wifi_8h_source.tex b/docs/latex/ciot__wifi_8h_source.tex deleted file mode 100644 index 686797a..0000000 --- a/docs/latex/ciot__wifi_8h_source.tex +++ /dev/null @@ -1,64 +0,0 @@ -\doxysection{ciot\+\_\+wifi.\+h} -\hypertarget{ciot__wifi_8h_source}{}\label{ciot__wifi_8h_source}\index{include/ciot\_wifi.h@{include/ciot\_wifi.h}} -\mbox{\hyperlink{ciot__wifi_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_WIFI\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_WIFI\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__wifi__types_8h}{types/ciot\_wifi\_types.h}}"{}}} -\DoxyCodeLine{00019\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__iface_8h}{ciot\_iface.h}}"{}}} -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__err_8h}{ciot\_err.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_WIFI\_AP\_AUTH}} -\DoxyCodeLine{00026\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_AP\_AUTH\ 0}} -\DoxyCodeLine{00027\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00028\ \textcolor{preprocessor}{\#ifndef\ CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN}} -\DoxyCodeLine{00029\ \textcolor{preprocessor}{\#define\ CIOT\_CONFIG\_WIFI\_AP\_MAX\_CONN\ 1}} -\DoxyCodeLine{00030\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00031\ } -\DoxyCodeLine{00032\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }ciot\_wifi\ *\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}};} -\DoxyCodeLine{00033\ } -\DoxyCodeLine{00037\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1c}{ciot\_wifi\_event\_id}}\ \{} -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca6b713b4b3920bb34f47260c7643ca2b8}{CIOT\_WIFI\_EVENT\_STA\_START}}\ =\ \mbox{\hyperlink{ciot__iface_8h_aab1a8c4944d96c57298e26e8bf3110cba7682c08bf60ddc6f695e62b7b2344a4f}{CIOT\_IFACE\_EVENT\_CUSTOM}},\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca257ec9d7ea2e07aace2c8a179405e807}{CIOT\_WIFI\_EVENT\_STA\_STOP}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00040\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca1b98996941b31dea8da9c83eb62fea37}{CIOT\_WIFI\_EVENT\_STA\_CONNECTED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00041\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca7076a750c510b561b1f0884ddd7e50db}{CIOT\_WIFI\_EVENT\_STA\_DISCONNECTED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00042\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1cac7a40b44a69f4c9761043bf78a5cded3}{CIOT\_WIFI\_EVENT\_AP\_START}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1ca52710095670909e218c917ec10e77363}{CIOT\_WIFI\_EVENT\_AP\_STOP}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00044\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caa23c4adec62d9312d64a71f82f6efd03}{CIOT\_WIFI\_EVENT\_AP\_STACONNECTED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00045\ \ \ \ \ \mbox{\hyperlink{ciot__wifi_8h_a19c22be5088c4eab517d5814d79e3d1caf42578350701e71889e933df00f62043}{CIOT\_WIFI\_EVENT\_AP\_STADISCONNECTED}},\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ } -\DoxyCodeLine{00046\ \}\ \mbox{\hyperlink{ciot__wifi_8h_aef3e522ed9507f7dbe6304d5ad31fbf9}{ciot\_wifi\_event\_id\_t}};} -\DoxyCodeLine{00047\ } -\DoxyCodeLine{00051\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))\ \{} -\DoxyCodeLine{00052\ \ \ \ \ \mbox{\hyperlink{structciot__msg__header__t}{ciot\_msg\_header\_t}}\ \mbox{\hyperlink{structciot__wifi__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}};\ } -\DoxyCodeLine{00053\ \ \ \ \ \mbox{\hyperlink{structciot__wifi__status__t}{ciot\_wifi\_status\_t}}\ \mbox{\hyperlink{structciot__wifi__status__msg__t_a09cb5a4aa60e39d810f1c21089103503}{status}};\ } -\DoxyCodeLine{00054\ \}\ \mbox{\hyperlink{structciot__wifi__status__msg__t}{ciot\_wifi\_status\_msg\_t}};} -\DoxyCodeLine{00055\ } -\DoxyCodeLine{00062\ \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_a07185c8551c5e40a05d113736a72e1d7}{ciot\_wifi\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00063\ } -\DoxyCodeLine{00070\ \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_aff94df1a4c08ca1cbea37d8dcd3f8777}{ciot\_wifi\_ap\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00071\ } -\DoxyCodeLine{00078\ \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_a57c540c883f21bdfa6d5d0a92584cc90}{ciot\_wifi\_sta\_new}}(\textcolor{keywordtype}{void}\ *handle);} -\DoxyCodeLine{00079\ } -\DoxyCodeLine{00087\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_af030ec8963d45c8374b58b10d3c83b9a}{ciot\_wifi\_start}}(\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ self,\ \mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\_wifi\_cfg\_t}}\ *cfg);} -\DoxyCodeLine{00088\ } -\DoxyCodeLine{00095\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_aed26866d40b64a5f80c4769481987cc0}{ciot\_wifi\_stop}}(\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ self);} -\DoxyCodeLine{00096\ } -\DoxyCodeLine{00104\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_a37b38c412e4f11696f1e2c03852cc1b7}{ciot\_wifi\_process\_req}}(\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ self,\ \mbox{\hyperlink{structciot__wifi__req__t}{ciot\_wifi\_req\_t}}\ *req);} -\DoxyCodeLine{00105\ } -\DoxyCodeLine{00114\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_a1444b4045430489fbf88036fe898528a}{ciot\_wifi\_send\_data}}(\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ self,\ uint8\_t\ *data,\ \textcolor{keywordtype}{int}\ size);} -\DoxyCodeLine{00115\ } -\DoxyCodeLine{00124\ \mbox{\hyperlink{ciot__err_8h_ad6378d4036e8a842176b2db8efb349c8}{ciot\_err\_t}}\ \mbox{\hyperlink{ciot__wifi_8h_a5817f21b0b8d5b22430f3ecb3c3c37a5}{ciot\_wifi\_get\_mac}}(\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\_wifi\_t}}\ self,\ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\_wifi\_type\_t}}\ type,\ uint8\_t\ mac[6]);} -\DoxyCodeLine{00125\ } -\DoxyCodeLine{00126\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00127\ \}} -\DoxyCodeLine{00128\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00129\ } -\DoxyCodeLine{00130\ \textcolor{preprocessor}{\#endif\ \ }} - -\end{DoxyCode} diff --git a/docs/latex/ciot__wifi__types_8h.tex b/docs/latex/ciot__wifi__types_8h.tex deleted file mode 100644 index 86397a1..0000000 --- a/docs/latex/ciot__wifi__types_8h.tex +++ /dev/null @@ -1,150 +0,0 @@ -\doxysection{include/types/ciot\+\_\+wifi\+\_\+types.h File Reference} -\hypertarget{ciot__wifi__types_8h}{}\label{ciot__wifi__types_8h}\index{include/types/ciot\_wifi\_types.h@{include/types/ciot\_wifi\_types.h}} - - -Defines data structures and types for CIOT Wi\+Fi functionality. - - -{\ttfamily \#include $<$inttypes.\+h$>$}\newline -{\ttfamily \#include "{}ciot\+\_\+tcp\+\_\+types.\+h"{}}\newline -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Wi\+Fi access point information. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Wi\+Fi configuration. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__wifi__status__t}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Wi\+Fi status. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__wifi__scan__result__t}{ciot\+\_\+wifi\+\_\+scan\+\_\+result\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Wi\+Fi scan result. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__wifi__req__data__u}{ciot\+\_\+wifi\+\_\+req\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT Wi\+Fi request data. \end{DoxyCompactList}\item -struct \mbox{\hyperlink{structciot__wifi__req__t}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Structure for CIOT Wi\+Fi request. \end{DoxyCompactList}\item -union \mbox{\hyperlink{unionciot__wifi__data__u}{ciot\+\_\+wifi\+\_\+data\+\_\+u}} -\begin{DoxyCompactList}\small\item\em Union for CIOT Wi\+Fi data. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\+\_\+wifi\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa22577cd2b8c579f221be06f275674e60}{CIOT\+\_\+\+WIFI\+\_\+\+IF\+\_\+\+STA}} -, \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa7bfdef61a443d4e6f7e5b96acfade2fa}{CIOT\+\_\+\+WIFI\+\_\+\+IF\+\_\+\+AP}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Wi\+Fi interface types. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036}{ciot\+\_\+wifi\+\_\+scan\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036aae17584d11aca31c75f644b1ec2b0af4}{CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+ERROR}} = -\/1 -, \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a4b64a2aa7491e1fc0baa7818e6b0a627}{CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+IDLE}} -, \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a7112209d7638abecd3bb12235439da52}{CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+SCANNING}} -, \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a81236e72b5b965ab3003fc7eefa172f8}{CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+SCANNED}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Wi\+Fi scan states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348}{ciot\+\_\+wifi\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348a8c2d80f4f370ad20291a732f50de55ef}{CIOT\+\_\+\+WIFI\+\_\+\+STATE\+\_\+\+IDLE}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Wi\+Fi states. \end{DoxyCompactList}\item -enum \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395}{ciot\+\_\+wifi\+\_\+req\+\_\+type\+\_\+t}} \{ \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395a1cefbec3b48a7dc0c4e8333da88d9c2c}{CIOT\+\_\+\+WIFI\+\_\+\+REQ\+\_\+\+UNKNOWN}} -, \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395af69b99260309c1d8ba4c8a36372fbc7f}{CIOT\+\_\+\+WIFI\+\_\+\+REQ\+\_\+\+SCAN}} - \} -\begin{DoxyCompactList}\small\item\em Enumeration for CIOT Wi\+Fi request types. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Defines data structures and types for CIOT Wi\+Fi functionality. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/18 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395}\label{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395} -\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!ciot\_wifi\_req\_type\_t@{ciot\_wifi\_req\_type\_t}} -\index{ciot\_wifi\_req\_type\_t@{ciot\_wifi\_req\_type\_t}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_req\_type\_t}{ciot\_wifi\_req\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395}{ciot\+\_\+wifi\+\_\+req\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT Wi\+Fi request types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_REQ\_UNKNOWN@{CIOT\_WIFI\_REQ\_UNKNOWN}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_REQ\_UNKNOWN@{CIOT\_WIFI\_REQ\_UNKNOWN}}}\Hypertarget{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395a1cefbec3b48a7dc0c4e8333da88d9c2c}\label{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395a1cefbec3b48a7dc0c4e8333da88d9c2c} -CIOT\+\_\+\+WIFI\+\_\+\+REQ\+\_\+\+UNKNOWN&Unknown Wi\+Fi request type \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_REQ\_SCAN@{CIOT\_WIFI\_REQ\_SCAN}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_REQ\_SCAN@{CIOT\_WIFI\_REQ\_SCAN}}}\Hypertarget{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395af69b99260309c1d8ba4c8a36372fbc7f}\label{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395af69b99260309c1d8ba4c8a36372fbc7f} -CIOT\+\_\+\+WIFI\+\_\+\+REQ\+\_\+\+SCAN&Wi\+Fi scan request \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036}\label{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036} -\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!ciot\_wifi\_scan\_state\_t@{ciot\_wifi\_scan\_state\_t}} -\index{ciot\_wifi\_scan\_state\_t@{ciot\_wifi\_scan\_state\_t}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_scan\_state\_t}{ciot\_wifi\_scan\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036}{ciot\+\_\+wifi\+\_\+scan\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT Wi\+Fi scan states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_SCAN\_STATE\_ERROR@{CIOT\_WIFI\_SCAN\_STATE\_ERROR}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_SCAN\_STATE\_ERROR@{CIOT\_WIFI\_SCAN\_STATE\_ERROR}}}\Hypertarget{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036aae17584d11aca31c75f644b1ec2b0af4}\label{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036aae17584d11aca31c75f644b1ec2b0af4} -CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+ERROR&Wi\+Fi scan error state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_SCAN\_STATE\_IDLE@{CIOT\_WIFI\_SCAN\_STATE\_IDLE}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_SCAN\_STATE\_IDLE@{CIOT\_WIFI\_SCAN\_STATE\_IDLE}}}\Hypertarget{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a4b64a2aa7491e1fc0baa7818e6b0a627}\label{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a4b64a2aa7491e1fc0baa7818e6b0a627} -CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+IDLE&Wi\+Fi scan idle state \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_SCAN\_STATE\_SCANNING@{CIOT\_WIFI\_SCAN\_STATE\_SCANNING}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_SCAN\_STATE\_SCANNING@{CIOT\_WIFI\_SCAN\_STATE\_SCANNING}}}\Hypertarget{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a7112209d7638abecd3bb12235439da52}\label{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a7112209d7638abecd3bb12235439da52} -CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+SCANNING&Wi\+Fi scan in progress \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_SCAN\_STATE\_SCANNED@{CIOT\_WIFI\_SCAN\_STATE\_SCANNED}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_SCAN\_STATE\_SCANNED@{CIOT\_WIFI\_SCAN\_STATE\_SCANNED}}}\Hypertarget{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a81236e72b5b965ab3003fc7eefa172f8}\label{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a81236e72b5b965ab3003fc7eefa172f8} -CIOT\+\_\+\+WIFI\+\_\+\+SCAN\+\_\+\+STATE\+\_\+\+SCANNED&Wi\+Fi scan completed \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348}\label{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348} -\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!ciot\_wifi\_state\_t@{ciot\_wifi\_state\_t}} -\index{ciot\_wifi\_state\_t@{ciot\_wifi\_state\_t}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_state\_t}{ciot\_wifi\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348}{ciot\+\_\+wifi\+\_\+state\+\_\+t}}} - - - -Enumeration for CIOT Wi\+Fi states. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_STATE\_IDLE@{CIOT\_WIFI\_STATE\_IDLE}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_STATE\_IDLE@{CIOT\_WIFI\_STATE\_IDLE}}}\Hypertarget{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348a8c2d80f4f370ad20291a732f50de55ef}\label{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348a8c2d80f4f370ad20291a732f50de55ef} -CIOT\+\_\+\+WIFI\+\_\+\+STATE\+\_\+\+IDLE&Wi\+Fi idle state \\ -\hline - -\end{DoxyEnumFields} -\Hypertarget{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}\label{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f} -\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!ciot\_wifi\_type\_t@{ciot\_wifi\_type\_t}} -\index{ciot\_wifi\_type\_t@{ciot\_wifi\_type\_t}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}} -\doxysubsubsection{\texorpdfstring{ciot\_wifi\_type\_t}{ciot\_wifi\_type\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\+\_\+wifi\+\_\+type\+\_\+t}}} - - - -Enumeration for CIOT Wi\+Fi interface types. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_IF\_STA@{CIOT\_WIFI\_IF\_STA}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_IF\_STA@{CIOT\_WIFI\_IF\_STA}}}\Hypertarget{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa22577cd2b8c579f221be06f275674e60}\label{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa22577cd2b8c579f221be06f275674e60} -CIOT\+\_\+\+WIFI\+\_\+\+IF\+\_\+\+STA&Wi\+Fi interface in station mode \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_WIFI\_IF\_AP@{CIOT\_WIFI\_IF\_AP}!ciot\_wifi\_types.h@{ciot\_wifi\_types.h}}\index{ciot\_wifi\_types.h@{ciot\_wifi\_types.h}!CIOT\_WIFI\_IF\_AP@{CIOT\_WIFI\_IF\_AP}}}\Hypertarget{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa7bfdef61a443d4e6f7e5b96acfade2fa}\label{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa7bfdef61a443d4e6f7e5b96acfade2fa} -CIOT\+\_\+\+WIFI\+\_\+\+IF\+\_\+\+AP&Wi\+Fi interface in access point mode \\ -\hline - -\end{DoxyEnumFields} diff --git a/docs/latex/ciot__wifi__types_8h_source.tex b/docs/latex/ciot__wifi__types_8h_source.tex deleted file mode 100644 index f870bce..0000000 --- a/docs/latex/ciot__wifi__types_8h_source.tex +++ /dev/null @@ -1,95 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+types.\+h} -\hypertarget{ciot__wifi__types_8h_source}{}\label{ciot__wifi__types_8h_source}\index{include/types/ciot\_wifi\_types.h@{include/types/ciot\_wifi\_types.h}} -\mbox{\hyperlink{ciot__wifi__types_8h}{Go to the documentation of this file.}} -\begin{DoxyCode}{0} -\DoxyCodeLine{00001\ } -\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#ifndef\ \_\_CIOT\_WIFI\_DATA\_\_H\_\_}} -\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#define\ \_\_CIOT\_WIFI\_DATA\_\_H\_\_}} -\DoxyCodeLine{00013\ } -\DoxyCodeLine{00014\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00015\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{} -\DoxyCodeLine{00016\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00017\ } -\DoxyCodeLine{00018\ \textcolor{preprocessor}{\#include\ }} -\DoxyCodeLine{00019\ } -\DoxyCodeLine{00020\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\_tcp\_types.h}}"{}}} -\DoxyCodeLine{00021\ } -\DoxyCodeLine{00025\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00026\ \{} -\DoxyCodeLine{00027\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa22577cd2b8c579f221be06f275674e60}{CIOT\_WIFI\_IF\_STA}},\ } -\DoxyCodeLine{00028\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6fa7bfdef61a443d4e6f7e5b96acfade2fa}{CIOT\_WIFI\_IF\_AP}},\ } -\DoxyCodeLine{00029\ \}\ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\_wifi\_type\_t}};} -\DoxyCodeLine{00030\ } -\DoxyCodeLine{00034\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00035\ \{} -\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036aae17584d11aca31c75f644b1ec2b0af4}{CIOT\_WIFI\_SCAN\_STATE\_ERROR}}\ =\ -\/1,\ } -\DoxyCodeLine{00037\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a4b64a2aa7491e1fc0baa7818e6b0a627}{CIOT\_WIFI\_SCAN\_STATE\_IDLE}},\ } -\DoxyCodeLine{00038\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a7112209d7638abecd3bb12235439da52}{CIOT\_WIFI\_SCAN\_STATE\_SCANNING}},\ } -\DoxyCodeLine{00039\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036a81236e72b5b965ab3003fc7eefa172f8}{CIOT\_WIFI\_SCAN\_STATE\_SCANNED}},\ } -\DoxyCodeLine{00040\ \}\ \mbox{\hyperlink{ciot__wifi__types_8h_ad99bf8f02a2d7a54b3a9a73752e74036}{ciot\_wifi\_scan\_state\_t}};} -\DoxyCodeLine{00041\ } -\DoxyCodeLine{00045\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00046\ \{} -\DoxyCodeLine{00047\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348a8c2d80f4f370ad20291a732f50de55ef}{CIOT\_WIFI\_STATE\_IDLE}},\ } -\DoxyCodeLine{00048\ \}\ \mbox{\hyperlink{ciot__wifi__types_8h_ad1f8d811fc212531fc388a76b784f348}{ciot\_wifi\_state\_t}};} -\DoxyCodeLine{00049\ } -\DoxyCodeLine{00053\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{enum}\ \_\_attribute\_\_((packed))} -\DoxyCodeLine{00054\ \{} -\DoxyCodeLine{00055\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395a1cefbec3b48a7dc0c4e8333da88d9c2c}{CIOT\_WIFI\_REQ\_UNKNOWN}},\ } -\DoxyCodeLine{00056\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395af69b99260309c1d8ba4c8a36372fbc7f}{CIOT\_WIFI\_REQ\_SCAN}},\ } -\DoxyCodeLine{00057\ \}\ \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395}{ciot\_wifi\_req\_type\_t}};} -\DoxyCodeLine{00058\ } -\DoxyCodeLine{00062\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00063\ \{} -\DoxyCodeLine{00064\ \ \ \ \ uint8\_t\ bssid[6];\ } -\DoxyCodeLine{00065\ \ \ \ \ \textcolor{keywordtype}{char}\ ssid[33];\ } -\DoxyCodeLine{00066\ \ \ \ \ int8\_t\ \mbox{\hyperlink{structciot__wifi__ap__info__t_a3b962e67ba74725bd60ca3c29f785abe}{rssi}};\ } -\DoxyCodeLine{00067\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__wifi__ap__info__t_a62cb83d5528e0d152b4e179fea395cab}{authmode}};\ } -\DoxyCodeLine{00068\ \}\ \mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\_wifi\_ap\_info\_t}};} -\DoxyCodeLine{00069\ } -\DoxyCodeLine{00073\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00074\ \{} -\DoxyCodeLine{00075\ \ \ \ \ \textcolor{keywordtype}{char}\ ssid[32];\ } -\DoxyCodeLine{00076\ \ \ \ \ \textcolor{keywordtype}{char}\ password[64];\ } -\DoxyCodeLine{00077\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\_wifi\_type\_t}}\ \mbox{\hyperlink{structciot__wifi__cfg__t_a35cbcdf247b4952f8c35e071bed5a1d8}{type}};\ } -\DoxyCodeLine{00078\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\_tcp\_cfg\_t}}\ \mbox{\hyperlink{structciot__wifi__cfg__t_afa68a8b5194df4f630408f99085e4ab8}{tcp}};\ } -\DoxyCodeLine{00079\ \}\ \mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\_wifi\_cfg\_t}};} -\DoxyCodeLine{00080\ } -\DoxyCodeLine{00084\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00085\ \{} -\DoxyCodeLine{00086\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__wifi__status__t_ae5b995148e44c51fc076af577ec1acc8}{disconnect\_reason}};\ } -\DoxyCodeLine{00087\ \ \ \ \ \mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\_wifi\_ap\_info\_t}}\ \mbox{\hyperlink{structciot__wifi__status__t_ac1b76e51a84c5050063165be909dd70a}{info}};\ } -\DoxyCodeLine{00088\ \ \ \ \ \mbox{\hyperlink{structciot__tcp__status__t}{ciot\_tcp\_status\_t}}\ \mbox{\hyperlink{structciot__wifi__status__t_ac4061ebe19bc469e9a7569aa132010a8}{tcp}};\ } -\DoxyCodeLine{00089\ \}\ \mbox{\hyperlink{structciot__wifi__status__t}{ciot\_wifi\_status\_t}};} -\DoxyCodeLine{00090\ } -\DoxyCodeLine{00094\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00095\ \{} -\DoxyCodeLine{00096\ \ \ \ \ uint8\_t\ \mbox{\hyperlink{structciot__wifi__scan__result__t_a20302e2c99a60d3f612dba57e3f6333b}{count}};\ } -\DoxyCodeLine{00097\ \ \ \ \ \mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\_wifi\_ap\_info\_t}}\ ap\_list[8];\ } -\DoxyCodeLine{00098\ \}\ \mbox{\hyperlink{structciot__wifi__scan__result__t}{ciot\_wifi\_scan\_result\_t}};} -\DoxyCodeLine{00099\ } -\DoxyCodeLine{00103\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00104\ \{} -\DoxyCodeLine{00105\ \ \ \ \ \mbox{\hyperlink{structciot__wifi__scan__result__t}{ciot\_wifi\_scan\_result\_t}}\ \mbox{\hyperlink{unionciot__wifi__req__data__u_a23723a81650d6544d7da572eb4bf33b9}{scan\_result}};\ } -\DoxyCodeLine{00106\ \}\ \mbox{\hyperlink{unionciot__wifi__req__data__u}{ciot\_wifi\_req\_data\_u}};} -\DoxyCodeLine{00107\ } -\DoxyCodeLine{00111\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00112\ \{} -\DoxyCodeLine{00113\ \ \ \ \ \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395}{ciot\_wifi\_req\_type\_t}}\ \mbox{\hyperlink{structciot__wifi__req__t_a6f6c1937c79d949cdf73c68cf9ad3493}{type}};\ } -\DoxyCodeLine{00114\ \ \ \ \ \mbox{\hyperlink{unionciot__wifi__req__data__u}{ciot\_wifi\_req\_data\_u}}\ \mbox{\hyperlink{structciot__wifi__req__t_a01f8ce506c08d4070208e71aef019ff9}{data}};\ } -\DoxyCodeLine{00115\ \}\ \mbox{\hyperlink{structciot__wifi__req__t}{ciot\_wifi\_req\_t}};} -\DoxyCodeLine{00116\ } -\DoxyCodeLine{00120\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{union\ }\_\_attribute\_\_((packed))} -\DoxyCodeLine{00121\ \{} -\DoxyCodeLine{00122\ \ \ \ \ \mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\_wifi\_cfg\_t}}\ \mbox{\hyperlink{unionciot__wifi__data__u_a711c5a971ab69b9cfa4850692e6bbaad}{config}};\ } -\DoxyCodeLine{00123\ \ \ \ \ \mbox{\hyperlink{structciot__wifi__status__t}{ciot\_wifi\_status\_t}}\ \mbox{\hyperlink{unionciot__wifi__data__u_a09cb5a4aa60e39d810f1c21089103503}{status}};\ } -\DoxyCodeLine{00124\ \ \ \ \ \mbox{\hyperlink{structciot__wifi__req__t}{ciot\_wifi\_req\_t}}\ \mbox{\hyperlink{unionciot__wifi__data__u_a95d1196af9ebc0b64f6f7e2842812448}{request}};\ } -\DoxyCodeLine{00125\ \}\ \mbox{\hyperlink{unionciot__wifi__data__u}{ciot\_wifi\_data\_u}};} -\DoxyCodeLine{00126\ } -\DoxyCodeLine{00127\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}} -\DoxyCodeLine{00128\ \}} -\DoxyCodeLine{00129\ \textcolor{preprocessor}{\#endif}} -\DoxyCodeLine{00130\ } -\DoxyCodeLine{00131\ \textcolor{preprocessor}{\#endif\ }} - -\end{DoxyCode} diff --git a/docs/latex/dir_0ad255a918b7fba820a1ddafed6fa637.tex b/docs/latex/dir_0ad255a918b7fba820a1ddafed6fa637.tex deleted file mode 100644 index 7d9c627..0000000 --- a/docs/latex/dir_0ad255a918b7fba820a1ddafed6fa637.tex +++ /dev/null @@ -1,45 +0,0 @@ -\doxysection{include/types Directory Reference} -\hypertarget{dir_0ad255a918b7fba820a1ddafed6fa637}{}\label{dir_0ad255a918b7fba820a1ddafed6fa637}\index{include/types Directory Reference@{include/types Directory Reference}} -\doxysubsubsection*{Files} -\begin{DoxyCompactItemize} -\item -file \mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT BLE SCN. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT BLE. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT bridge. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}} -\item -file \mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT DFU (Device Firmware Update). \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT GPIO (General Purpose Input/\+Output). \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT HTTP client. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT HTTP server. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT MQTT client. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT messaging. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT NTP functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT OPC UA Server functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT Over-\/\+The-\/\+Air (OTA) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT storage functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT system functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT TCP functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines types and structures for CIOT functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data structures and types for CIOT UART functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data structures and types for CIOT USB functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data structures and types for CIOT Wi\+Fi functionality. \end{DoxyCompactList}\end{DoxyCompactItemize} diff --git a/docs/latex/dir_d44c64559bbebec7f509842c48db8b23.tex b/docs/latex/dir_d44c64559bbebec7f509842c48db8b23.tex deleted file mode 100644 index 472eab2..0000000 --- a/docs/latex/dir_d44c64559bbebec7f509842c48db8b23.tex +++ /dev/null @@ -1,78 +0,0 @@ -\doxysection{include Directory Reference} -\hypertarget{dir_d44c64559bbebec7f509842c48db8b23}{}\label{dir_d44c64559bbebec7f509842c48db8b23}\index{include Directory Reference@{include Directory Reference}} -\doxysubsubsection*{Directories} -\begin{DoxyCompactItemize} -\item -directory \mbox{\hyperlink{dir_0ad255a918b7fba820a1ddafed6fa637}{types}} -\end{DoxyCompactItemize} -\doxysubsubsection*{Files} -\begin{DoxyCompactItemize} -\item -file \mbox{\hyperlink{ciot_8h}{ciot.\+h}} -\item -file \mbox{\hyperlink{ciot__ble_8h}{ciot\+\_\+ble.\+h}} -\begin{DoxyCompactList}\small\item\em Defines functions and types for CIOT Bluetooth Low Energy (BLE) module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ble__scn_8h}{ciot\+\_\+ble\+\_\+scn.\+h}} -\begin{DoxyCompactList}\small\item\em Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__bridge_8h}{ciot\+\_\+bridge.\+h}} -\begin{DoxyCompactList}\small\item\em Defines functions and types for CIOT Bridge module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__common__types_8h}{ciot\+\_\+common\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines common types used in CIOT modules. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__config_8h}{ciot\+\_\+config.\+h}} -\begin{DoxyCompactList}\small\item\em Configuration options for the CIOT library. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__crc_8h}{ciot\+\_\+crc.\+h}} -\item -file \mbox{\hyperlink{ciot__default_8h}{ciot\+\_\+default.\+h}} -\begin{DoxyCompactList}\small\item\em Default configuration options for CIOT library. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__dfu_8h}{ciot\+\_\+dfu.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for Device Firmware Update (DFU) functionality in CIOT library. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__err_8h}{ciot\+\_\+err.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT error handling. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__eth_8h}{ciot\+\_\+eth.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Ethernet interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__gpio_8h}{ciot\+\_\+gpio.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT GPIO interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__httpc_8h}{ciot\+\_\+httpc.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT HTTP client interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__https_8h}{ciot\+\_\+https.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT HTTP server interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for the CIOT interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ifaces_8h}{ciot\+\_\+ifaces.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT interfaces. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__lib_8h}{ciot\+\_\+lib.\+h}} -\begin{DoxyCompactList}\small\item\em CioT library header file. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__log_8h}{ciot\+\_\+log.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT logging functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__mqttc_8h}{ciot\+\_\+mqttc.\+h}} -\item -file \mbox{\hyperlink{ciot__nrf__dfu_8h}{ciot\+\_\+nrf\+\_\+dfu.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Nordic DFU functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ntp_8h}{ciot\+\_\+ntp.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT NTP (Network Time Protocol) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__opcuas_8h}{ciot\+\_\+opcuas.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT OPC UA Server (OPCUAS) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ota_8h}{ciot\+\_\+ota.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT OTA (Over-\/the-\/\+Air) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__s_8h}{ciot\+\_\+s.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT\+\_\+S (Communication Interface Over Transport) module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__serializer_8h}{ciot\+\_\+serializer.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Serializer module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__slip_8h}{ciot\+\_\+slip.\+h}} -\begin{DoxyCompactList}\small\item\em This module encodes and decodes SLIP packages. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__storage_8h}{ciot\+\_\+storage.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Storage module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__sys_8h}{ciot\+\_\+sys.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT System module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__tcp_8h}{ciot\+\_\+tcp.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT TCP module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__timer_8h}{ciot\+\_\+timer.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT timer module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__uart_8h}{ciot\+\_\+uart.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT UART module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__usb_8h}{ciot\+\_\+usb.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT USB module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__utils_8h}{ciot\+\_\+utils.\+h}} -\item -file \mbox{\hyperlink{ciot__wifi_8h}{ciot\+\_\+wifi.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Wi-\/\+Fi module. \end{DoxyCompactList}\end{DoxyCompactItemize} diff --git a/docs/latex/doxygen.sty b/docs/latex/doxygen.sty deleted file mode 100644 index 4bfc17f..0000000 --- a/docs/latex/doxygen.sty +++ /dev/null @@ -1,694 +0,0 @@ -\NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{doxygen} - -% Packages used by this style file -\RequirePackage{alltt} -%%\RequirePackage{array} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package -\RequirePackage{calc} -\RequirePackage{float} -%%\RequirePackage{ifthen} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package -\RequirePackage{verbatim} -\RequirePackage[table]{xcolor} -\RequirePackage{longtable_doxygen} -\RequirePackage{tabu_doxygen} -\RequirePackage{fancyvrb} -\RequirePackage{tabularx} -\RequirePackage{multicol} -\RequirePackage{multirow} -\RequirePackage{hanging} -\RequirePackage{ifpdf} -\RequirePackage{adjustbox} -\RequirePackage{amssymb} -\RequirePackage{stackengine} -\RequirePackage{enumitem} -\RequirePackage{alphalph} -\RequirePackage[normalem]{ulem} % for strikeout, but don't modify emphasis - -%---------- Internal commands used in this style file ---------------- - -\newcommand{\ensurespace}[1]{% - \begingroup% - \setlength{\dimen@}{#1}% - \vskip\z@\@plus\dimen@% - \penalty -100\vskip\z@\@plus -\dimen@% - \vskip\dimen@% - \penalty 9999% - \vskip -\dimen@% - \vskip\z@skip% hide the previous |\vskip| from |\addvspace| - \endgroup% -} - -\newcommand{\DoxyHorRuler}[1]{% - \setlength{\parskip}{0ex plus 0ex minus 0ex}% - \ifthenelse{#1=0}% - {% - \hrule% - }% - {% - \hrulefilll% - }% -} -\newcommand{\DoxyLabelFont}{} -\newcommand{\entrylabel}[1]{% - {% - \parbox[b]{\labelwidth-4pt}{% - \makebox[0pt][l]{\DoxyLabelFont#1}% - \vspace{1.5\baselineskip}% - }% - }% -} - -\newenvironment{DoxyDesc}[1]{% - \ensurespace{4\baselineskip}% - \begin{list}{}{% - \settowidth{\labelwidth}{20pt}% - %\setlength{\parsep}{0pt}% - \setlength{\itemsep}{0pt}% - \setlength{\leftmargin}{\labelwidth+\labelsep}% - \renewcommand{\makelabel}{\entrylabel}% - }% - \item[#1]% -}{% - \end{list}% -} - -\newsavebox{\xrefbox} -\newlength{\xreflength} -\newcommand{\xreflabel}[1]{% - \sbox{\xrefbox}{#1}% - \setlength{\xreflength}{\wd\xrefbox}% - \ifthenelse{\xreflength>\labelwidth}{% - \begin{minipage}{\textwidth}% - \setlength{\parindent}{0pt}% - \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}% - \end{minipage}% - }{% - \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}% - }% -} - -%---------- Commands used by doxygen LaTeX output generator ---------- - -% Used by 
 ...
-\newenvironment{DoxyPre}{% - \small% - \begin{alltt}% -}{% - \end{alltt}% - \normalsize% -} -% Necessary for redefining not defined characters, i.e. "Replacement Character" in tex output. -\newlength{\CodeWidthChar} -\newlength{\CodeHeightChar} -\settowidth{\CodeWidthChar}{?} -\settoheight{\CodeHeightChar}{?} -% Necessary for hanging indent -\newlength{\DoxyCodeWidth} - -\newcommand\DoxyCodeLine[1]{ - \ifthenelse{\equal{\detokenize{#1}}{}} - { - \vspace*{\baselineskip} - } - { - \hangpara{\DoxyCodeWidth}{1}{#1}\par - } -} - -\newcommand\NiceSpace{% - \discretionary{}{\kern\fontdimen2\font}{\kern\fontdimen2\font}% -} - -% Used by @code ... @endcode -\newenvironment{DoxyCode}[1]{% - \par% - \scriptsize% - \normalfont\ttfamily% - \rightskip0pt plus 1fil% - \settowidth{\DoxyCodeWidth}{000000}% - \settowidth{\CodeWidthChar}{?}% - \settoheight{\CodeHeightChar}{?}% - \setlength{\parskip}{0ex plus 0ex minus 0ex}% - \ifthenelse{\equal{#1}{0}} - { - {\lccode`~32 \lowercase{\global\let~}\NiceSpace}\obeyspaces% - } - { - {\lccode`~32 \lowercase{\global\let~}}\obeyspaces% - } - -}{% - \normalfont% - \normalsize% - \settowidth{\CodeWidthChar}{?}% - \settoheight{\CodeHeightChar}{?}% -} - -% Redefining not defined characters, i.e. "Replacement Character" in tex output. -\def\ucr{\adjustbox{width=\CodeWidthChar,height=\CodeHeightChar}{\stackinset{c}{}{c}{-.2pt}{% - \textcolor{white}{\sffamily\bfseries\small ?}}{% - \rotatebox{45}{$\blacksquare$}}}} - -% Used by @example, @include, @includelineno and @dontinclude -\newenvironment{DoxyCodeInclude}[1]{% - \DoxyCode{#1}% -}{% - \endDoxyCode% -} - -% Used by @verbatim ... @endverbatim -\newenvironment{DoxyVerb}{% - \par% - \footnotesize% - \verbatim% -}{% - \endverbatim% - \normalsize% -} - -% Used by @verbinclude -\newenvironment{DoxyVerbInclude}{% - \DoxyVerb% -}{% - \endDoxyVerb% -} - -% Used by numbered lists (using '-#' or
    ...
) -\setlistdepth{12} -\newlist{DoxyEnumerate}{enumerate}{12} -\setlist[DoxyEnumerate,1]{label=\arabic*.} -\setlist[DoxyEnumerate,2]{label=(\enumalphalphcnt*)} -\setlist[DoxyEnumerate,3]{label=\roman*.} -\setlist[DoxyEnumerate,4]{label=\enumAlphAlphcnt*.} -\setlist[DoxyEnumerate,5]{label=\arabic*.} -\setlist[DoxyEnumerate,6]{label=(\enumalphalphcnt*)} -\setlist[DoxyEnumerate,7]{label=\roman*.} -\setlist[DoxyEnumerate,8]{label=\enumAlphAlphcnt*.} -\setlist[DoxyEnumerate,9]{label=\arabic*.} -\setlist[DoxyEnumerate,10]{label=(\enumalphalphcnt*)} -\setlist[DoxyEnumerate,11]{label=\roman*.} -\setlist[DoxyEnumerate,12]{label=\enumAlphAlphcnt*.} - -% Used by bullet lists (using '-', @li, @arg, or
    ...
) -\setlistdepth{12} -\newlist{DoxyItemize}{itemize}{12} -\setlist[DoxyItemize]{label=\textperiodcentered} - -\setlist[DoxyItemize,1]{label=\textbullet} -\setlist[DoxyItemize,2]{label=\normalfont\bfseries \textendash} -\setlist[DoxyItemize,3]{label=\textasteriskcentered} -\setlist[DoxyItemize,4]{label=\textperiodcentered} - -% Used by description lists (using
...
) -\newenvironment{DoxyDescription}{% - \description% -}{% - \enddescription% -} - -% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc -% (only if caption is specified) -\newenvironment{DoxyImage}{% - \begin{figure}[H]% - \centering% -}{% - \end{figure}% -} - -% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc -% (only if no caption is specified) -\newenvironment{DoxyImageNoCaption}{% - \begin{center}% -}{% - \end{center}% -} - -% Used by @image -% (only if inline is specified) -\newenvironment{DoxyInlineImage}{% -}{% -} - -% Used by @attention -\newenvironment{DoxyAttention}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @author and @authors -\newenvironment{DoxyAuthor}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @date -\newenvironment{DoxyDate}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @invariant -\newenvironment{DoxyInvariant}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @note -\newenvironment{DoxyNote}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @post -\newenvironment{DoxyPostcond}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @pre -\newenvironment{DoxyPrecond}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @copyright -\newenvironment{DoxyCopyright}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @remark -\newenvironment{DoxyRemark}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @return and @returns -\newenvironment{DoxyReturn}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @since -\newenvironment{DoxySince}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @see -\newenvironment{DoxySeeAlso}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @version -\newenvironment{DoxyVersion}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @warning -\newenvironment{DoxyWarning}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by @par and @paragraph -\newenvironment{DoxyParagraph}[1]{% - \begin{DoxyDesc}{#1}% -}{% - \end{DoxyDesc}% -} - -% Used by parameter lists -\newenvironment{DoxyParams}[2][]{% - \tabulinesep=1mm% - \par% - \ifthenelse{\equal{#1}{}}% - {\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|}}% name + description - {\ifthenelse{\equal{#1}{1}}% - {\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + name + desc - {\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + type + name + desc - } - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for fields of simple structs -\newenvironment{DoxyFields}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|X[-1,l]|}% - \multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for fields simple class style enums -\newenvironment{DoxyEnumFields}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for parameters within a detailed function description -\newenvironment{DoxyParamCaption}{% - \renewcommand{\item}[2][]{\\ \hspace*{2.0cm} ##1 {\em ##2}}% -}{% -} - -% Used by return value lists -\newenvironment{DoxyRetVals}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used by exception lists -\newenvironment{DoxyExceptions}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used by template parameter lists -\newenvironment{DoxyTemplParams}[1]{% - \tabulinesep=1mm% - \par% - \begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endfirsthead% - \multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]% - \hline% - \endhead% -}{% - \end{longtabu*}% - \vspace{6pt}% -} - -% Used for member lists -\newenvironment{DoxyCompactItemize}{% - \begin{itemize}% - \setlength{\itemsep}{-3pt}% - \setlength{\parsep}{0pt}% - \setlength{\topsep}{0pt}% - \setlength{\partopsep}{0pt}% -}{% - \end{itemize}% -} - -% Used for member descriptions -\newenvironment{DoxyCompactList}{% - \begin{list}{}{% - \setlength{\leftmargin}{0.5cm}% - \setlength{\itemsep}{0pt}% - \setlength{\parsep}{0pt}% - \setlength{\topsep}{0pt}% - \renewcommand{\makelabel}{\hfill}% - }% -}{% - \end{list}% -} - -% Used for reference lists (@bug, @deprecated, @todo, etc.) -\newenvironment{DoxyRefList}{% - \begin{list}{}{% - \setlength{\labelwidth}{10pt}% - \setlength{\leftmargin}{\labelwidth}% - \addtolength{\leftmargin}{\labelsep}% - \renewcommand{\makelabel}{\xreflabel}% - }% -}{% - \end{list}% -} - -% Used by @bug, @deprecated, @todo, etc. -\newenvironment{DoxyRefDesc}[1]{% - \begin{list}{}{% - \renewcommand\makelabel[1]{\textbf{##1}}% - \settowidth\labelwidth{\makelabel{#1}}% - \setlength\leftmargin{\labelwidth+\labelsep}% - }% -}{% - \end{list}% -} - -% Used by parameter lists and simple sections -\newenvironment{Desc} -{\begin{list}{}{% - \settowidth{\labelwidth}{20pt}% - \setlength{\parsep}{0pt}% - \setlength{\itemsep}{0pt}% - \setlength{\leftmargin}{\labelwidth+\labelsep}% - \renewcommand{\makelabel}{\entrylabel}% - } -}{% - \end{list}% -} - -% Used by tables -\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}% -\newenvironment{TabularC}[1]% -{\tabulinesep=1mm -\begin{longtabu*}spread 0pt [c]{*#1{|X[-1]}|}}% -{\end{longtabu*}\par}% - -\newenvironment{TabularNC}[1]% -{\begin{tabu}spread 0pt [l]{*#1{|X[-1]}|}}% -{\end{tabu}\par}% - -% Used for member group headers -\newenvironment{Indent}{% - \begin{list}{}{% - \setlength{\leftmargin}{0.5cm}% - }% - \item[]\ignorespaces% -}{% - \unskip% - \end{list}% -} - -% Used when hyperlinks are turned on -\newcommand{\doxylink}[2]{% - \mbox{\hyperlink{#1}{#2}}% -} - -% Used when hyperlinks are turned on -% Third argument is the SectionType, see the doxygen internal -% documentation for the values (relevant: Page ... Subsubsection). -\newcommand{\doxysectlink}[3]{% - \mbox{\hyperlink{#1}{#2}}% -} -% Used when hyperlinks are turned off -\newcommand{\doxyref}[3]{% - \textbf{#1} (\textnormal{#2}\,\pageref{#3})% -} - -% Used when hyperlinks are turned off -% Fourth argument is the SectionType, see the doxygen internal -% documentation for the values (relevant: Page ... Subsubsection). -\newcommand{\doxysectref}[4]{% - \textbf{#1} (\textnormal{#2}\,\pageref{#3})% -} - -% Used to link to a table when hyperlinks are turned on -\newcommand{\doxytablelink}[2]{% - \ref{#1}% -} - -% Used to link to a table when hyperlinks are turned off -\newcommand{\doxytableref}[3]{% - \ref{#3}% -} - -% Used by @addindex -\newcommand{\lcurly}{\{} -\newcommand{\rcurly}{\}} - -% Colors used for syntax highlighting -\definecolor{comment}{rgb}{0.5,0.0,0.0} -\definecolor{keyword}{rgb}{0.0,0.5,0.0} -\definecolor{keywordtype}{rgb}{0.38,0.25,0.125} -\definecolor{keywordflow}{rgb}{0.88,0.5,0.0} -\definecolor{preprocessor}{rgb}{0.5,0.38,0.125} -\definecolor{stringliteral}{rgb}{0.0,0.125,0.25} -\definecolor{charliteral}{rgb}{0.0,0.5,0.5} -\definecolor{xmlcdata}{rgb}{0.0,0.0,0.0} -\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0} -\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43} -\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0} -\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0} - -% Color used for table heading -\newcommand{\tableheadbgcolor}{lightgray}% - -% Version of hypertarget with correct landing location -\newcommand{\Hypertarget}[1]{\Hy@raisedlink{\hypertarget{#1}{}}} - -% possibility to have sections etc. be within the margins -% unfortunately had to copy part of book.cls and add \raggedright -\makeatletter -\newcounter{subsubsubsection}[subsubsection] -\newcounter{subsubsubsubsection}[subsubsubsection] -\newcounter{subsubsubsubsubsection}[subsubsubsubsection] -\newcounter{subsubsubsubsubsubsection}[subsubsubsubsubsection] -\renewcommand{\thesubsubsubsection}{\thesubsubsection.\arabic{subsubsubsection}} -\renewcommand{\thesubsubsubsubsection}{\thesubsubsubsection.\arabic{subsubsubsubsection}} -\renewcommand{\thesubsubsubsubsubsection}{\thesubsubsubsubsection.\arabic{subsubsubsubsubsection}} -\renewcommand{\thesubsubsubsubsubsubsection}{\thesubsubsubsubsubsection.\arabic{subsubsubsubsubsubsection}} -\newcommand{\subsubsubsectionmark}[1]{} -\newcommand{\subsubsubsubsectionmark}[1]{} -\newcommand{\subsubsubsubsubsectionmark}[1]{} -\newcommand{\subsubsubsubsubsubsectionmark}[1]{} -\def\toclevel@subsubsubsection{4} -\def\toclevel@subsubsubsubsection{5} -\def\toclevel@subsubsubsubsubsection{6} -\def\toclevel@subsubsubsubsubsubsection{7} -\def\toclevel@paragraph{8} -\def\toclevel@subparagraph{9} - -\newcommand\doxysection{\@startsection {section}{1}{\z@}% - {-3.5ex \@plus -1ex \@minus -.2ex}% - {2.3ex \@plus.2ex}% - {\raggedright\normalfont\Large\bfseries}} -\newcommand\doxysubsection{\@startsection{subsection}{2}{\z@}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\large\bfseries}} -\newcommand\doxysubsubsection{\@startsection{subsubsection}{3}{\z@}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\normalsize\bfseries}} -\newcommand\doxysubsubsubsection{\@startsection{subsubsubsection}{4}{\z@}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\normalsize\bfseries}} -\newcommand\doxysubsubsubsubsection{\@startsection{subsubsubsubsection}{5}{\z@}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\normalsize\bfseries}} -\newcommand\doxysubsubsubsubsubsection{\@startsection{subsubsubsubsubsection}{6}{\z@}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\normalsize\bfseries}} -\newcommand\doxysubsubsubsubsubsubsection{\@startsection{subsubsubsubsubsubsection}{7}{\z@}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\normalsize\bfseries}} -\newcommand\doxyparagraph{\@startsection{paragraph}{8}{\z@}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\normalsize\bfseries}} -\newcommand\doxysubparagraph{\@startsection{subparagraph}{9}{\parindent}% - {-3.25ex\@plus -1ex \@minus -.2ex}% - {1.5ex \@plus .2ex}% - {\raggedright\normalfont\normalsize\bfseries}} - -\newcommand\l@subsubsubsection{\@dottedtocline{4}{6.1em}{7.8em}} -\newcommand\l@subsubsubsubsection{\@dottedtocline{5}{6.1em}{9.4em}} -\newcommand\l@subsubsubsubsubsection{\@dottedtocline{6}{6.1em}{11em}} -\newcommand\l@subsubsubsubsubsubsection{\@dottedtocline{7}{6.1em}{12.6em}} -\renewcommand\l@paragraph{\@dottedtocline{8}{6.1em}{14.2em}} -\renewcommand\l@subparagraph{\@dottedtocline{9}{6.1em}{15.8em}} -\makeatother -% the sectsty doesn't look to be maintained but gives, in our case, some warning like: -% LaTeX Warning: Command \underline has changed. -% Check if current package is valid. -% unfortunately had to copy the relevant part -\newcommand*{\doxypartfont} [1] - {\gdef\SS@partnumberfont{\SS@sectid{0}\SS@nopart\SS@makeulinepartchap#1} - \gdef\SS@parttitlefont{\SS@sectid{0}\SS@titlepart\SS@makeulinepartchap#1}} -\newcommand*{\doxychapterfont} [1] - {\gdef\SS@chapnumfont{\SS@sectid{1}\SS@nopart\SS@makeulinepartchap#1} - \gdef\SS@chaptitlefont{\SS@sectid{1}\SS@titlepart\SS@makeulinepartchap#1}} -\newcommand*{\doxysectionfont} [1] - {\gdef\SS@sectfont{\SS@sectid{2}\SS@rr\SS@makeulinesect#1}} -\newcommand*{\doxysubsectionfont} [1] - {\gdef\SS@subsectfont{\SS@sectid{3}\SS@rr\SS@makeulinesect#1}} -\newcommand*{\doxysubsubsectionfont} [1] - {\gdef\SS@subsubsectfont{\SS@sectid{4}\SS@rr\SS@makeulinesect#1}} -\newcommand*{\doxyparagraphfont} [1] - {\gdef\SS@parafont{\SS@sectid{5}\SS@rr\SS@makeulinesect#1}} -\newcommand*{\doxysubparagraphfont} [1] - {\gdef\SS@subparafont{\SS@sectid{6}\SS@rr\SS@makeulinesect#1}} -\newcommand*{\doxyminisecfont} [1] - {\gdef\SS@minisecfont{\SS@sectid{7}\SS@rr\SS@makeulinepartchap#1}} -\newcommand*{\doxyallsectionsfont} [1] {\doxypartfont{#1}% - \doxychapterfont{#1}% - \doxysectionfont{#1}% - \doxysubsectionfont{#1}% - \doxysubsubsectionfont{#1}% - \doxyparagraphfont{#1}% - \doxysubparagraphfont{#1}% - \doxyminisecfont{#1}}% -% Define caption that is also suitable in a table -\makeatletter -\def\doxyfigcaption{% -\H@refstepcounter{figure}% -\@dblarg{\@caption{figure}}} -\makeatother - -% Define alpha enumarative names for counters > 26 -\makeatletter -\def\enumalphalphcnt#1{\expandafter\@enumalphalphcnt\csname c@#1\endcsname} -\def\@enumalphalphcnt#1{\alphalph{#1}} -\def\enumAlphAlphcnt#1{\expandafter\@enumAlphAlphcnt\csname c@#1\endcsname} -\def\@enumAlphAlphcnt#1{\AlphAlph{#1}} -\makeatother -\AddEnumerateCounter{\enumalphalphcnt}{\@enumalphalphcnt}{aa} -\AddEnumerateCounter{\enumAlphAlphcnt}{\@enumAlphAlphcnt}{AA} diff --git a/docs/latex/etoc_doxygen.sty b/docs/latex/etoc_doxygen.sty deleted file mode 100644 index 5f7e127..0000000 --- a/docs/latex/etoc_doxygen.sty +++ /dev/null @@ -1,2178 +0,0 @@ -%% -%% This is file etoc_doxygen.sty -%% -%% Apart from this header notice and the renaming from etoc to -%% etoc_doxygen (also in \ProvidesPackage) it is an identical -%% copy of -%% -%% etoc.sty -%% -%% at version 1.2b of 2023/07/01. -%% -%% This file has been provided to Doxygen team courtesy of the -%% author for benefit of users having a LaTeX installation not -%% yet providing version 1.2a or later of etoc, whose -%% deeplevels feature is required. -%% -%% The original source etoc.dtx (only of the latest version at -%% any given time) is available at -%% -%% https://ctan.org/pkg/etoc -%% -%% and contains the terms for copying and modification as well -%% as author contact information. -%% -%% In brief any modified versions of this file must be renamed -%% with new filenames distinct from etoc.sty. -%% -%% Package: etoc -%% Version: 1.2b -%% License: LPPL 1.3c -%% Copyright (C) 2012-2023 Jean-Francois B. -\NeedsTeXFormat{LaTeX2e}[2003/12/01] -\ProvidesPackage{etoc_doxygen}[2023/07/01 v1.2b Completely customisable TOCs (JFB)] -\newif\ifEtoc@oldLaTeX -\@ifl@t@r\fmtversion{2020/10/01} - {} - {\Etoc@oldLaTeXtrue - \PackageInfo{etoc}{Old LaTeX (\fmtversion) detected!\MessageBreak - Since 1.1a (2023/01/14), etoc prefers LaTeX at least\MessageBreak - as recent as 2020-10-01, for reasons of the .toc file,\MessageBreak - and used to require it (from 1.1a to 1.2).\MessageBreak - This etoc (1.2b) does not *require* it, but has not been\MessageBreak - tested thoroughly on old LaTeX (especially if document\MessageBreak - does not use hyperref) and retrofitting was done only\MessageBreak - on basis of author partial remembrances of old context.\MessageBreak - Reported}} -\RequirePackage{kvoptions} -\SetupKeyvalOptions{prefix=Etoc@} -\newif\ifEtoc@lof -\DeclareVoidOption{lof}{\Etoc@loftrue - \PackageInfo{etoc}{Experimental support for \string\locallistoffigures.\MessageBreak - Barely tested, use at own risk}% -} -\newif\ifEtoc@lot -\DeclareVoidOption{lot}{\Etoc@lottrue - \PackageInfo{etoc}{Experimental support for \string\locallistoftables.\MessageBreak - Barely tested, use at own risk}% -} -\@ifclassloaded{memoir}{ -\PackageInfo{etoc} - {As this is with memoir class, all `...totoc' options\MessageBreak - are set true by default. Reported} -\DeclareBoolOption[true]{maintoctotoc} -\DeclareBoolOption[true]{localtoctotoc} -\DeclareBoolOption[true]{localloftotoc} -\DeclareBoolOption[true]{locallottotoc} -}{ -\DeclareBoolOption[false]{maintoctotoc} -\DeclareBoolOption[false]{localtoctotoc} -\DeclareBoolOption[false]{localloftotoc} -\DeclareBoolOption[false]{locallottotoc} -} -\DeclareBoolOption[true]{ouroboros} -\DeclareBoolOption[false]{deeplevels} -\DeclareDefaultOption{\PackageWarning{etoc}{Option `\CurrentOption' is unknown.}} -\ProcessKeyvalOptions* -\DisableKeyvalOption[action=error,package=etoc]{etoc}{lof} -\DisableKeyvalOption[action=error,package=etoc]{etoc}{lot} -\DisableKeyvalOption[action=error,package=etoc]{etoc}{deeplevels} -\def\etocsetup#1{\setkeys{etoc}{#1}} -\def\etocifmaintoctotoc{\ifEtoc@maintoctotoc - \expandafter\@firstoftwo - \else - \expandafter\@secondoftwo - \fi} -\def\etociflocaltoctotoc{\ifEtoc@localtoctotoc - \expandafter\@firstoftwo - \else - \expandafter\@secondoftwo - \fi} -\def\etociflocalloftotoc{\ifEtoc@localloftotoc - \expandafter\@firstoftwo - \else - \expandafter\@secondoftwo - \fi} -\def\etociflocallottotoc{\ifEtoc@locallottotoc - \expandafter\@firstoftwo - \else - \expandafter\@secondoftwo - \fi} -\RequirePackage{multicol} -\def\etoc@{\etoc@} -\long\def\Etoc@gobtoetoc@ #1\etoc@{} -\newtoks\Etoc@toctoks -\def\Etoc@par{\par} -\def\etocinline{\def\Etoc@par{}} -\let\etocnopar\etocinline -\def\etocdisplay{\def\Etoc@par{\par}} -\let\Etoc@global\@empty -\def\etocglobaldefs{\let\Etoc@global\global\let\tof@global\global} -\def\etoclocaldefs {\let\Etoc@global\@empty\let\tof@global\@empty} -\newif\ifEtoc@numbered -\newif\ifEtoc@hyperref -\newif\ifEtoc@parskip -\newif\ifEtoc@tocwithid -\newif\ifEtoc@standardlines -\newif\ifEtoc@etocstyle -\newif\ifEtoc@classstyle -\newif\ifEtoc@keeporiginaltoc -\newif\ifEtoc@skipprefix -\newif\ifEtoc@isfirst -\newif\ifEtoc@localtoc -\newif\ifEtoc@skipthisone -\newif\ifEtoc@stoptoc -\newif\ifEtoc@notactive -\newif\ifEtoc@mustclosegroup -\newif\ifEtoc@isemptytoc -\newif\ifEtoc@checksemptiness -\def\etocchecksemptiness {\Etoc@checksemptinesstrue } -\def\etocdoesnotcheckemptiness {\Etoc@checksemptinessfalse } -\newif\ifEtoc@notocifnotoc -\def\etocnotocifnotoc {\Etoc@checksemptinesstrue\Etoc@notocifnotoctrue } -\newcounter{etoc@tocid} -\def\Etoc@tocext{toc} -\def\Etoc@lofext{lof} -\def\Etoc@lotext{lot} -\let\Etoc@currext\Etoc@tocext -\def\etocifislocal{\ifEtoc@localtoc\expandafter\@firstoftwo\else - \expandafter\@secondoftwo\fi - } -\def\etocifislocaltoc{\etocifislocal{\ifx\Etoc@currext\Etoc@tocext - \expandafter\@firstoftwo\else - \expandafter\@secondoftwo\fi}% - {\@secondoftwo}% - } -\def\etocifislocallof{\etocifislocal{\ifx\Etoc@currext\Etoc@lofext - \expandafter\@firstoftwo\else - \expandafter\@secondoftwo\fi}% - {\@secondoftwo}% - } -\def\etocifislocallot{\etocifislocal{\ifx\Etoc@currext\Etoc@lotext - \expandafter\@firstoftwo\else - \expandafter\@secondoftwo\fi}% - {\@secondoftwo}% - } -\expandafter\def\csname Etoc@-3@@\endcsname {-\thr@@} -\expandafter\def\csname Etoc@-2@@\endcsname {-\tw@} -\expandafter\let\csname Etoc@-1@@\endcsname \m@ne -\expandafter\let\csname Etoc@0@@\endcsname \z@ -\expandafter\let\csname Etoc@1@@\endcsname \@ne -\expandafter\let\csname Etoc@2@@\endcsname \tw@ -\expandafter\let\csname Etoc@3@@\endcsname \thr@@ -\expandafter\chardef\csname Etoc@4@@\endcsname 4 -\expandafter\chardef\csname Etoc@5@@\endcsname 5 -\expandafter\chardef\csname Etoc@6@@\endcsname 6 -\ifEtoc@deeplevels - \expandafter\chardef\csname Etoc@7@@\endcsname 7 - \expandafter\chardef\csname Etoc@8@@\endcsname 8 - \expandafter\chardef\csname Etoc@9@@\endcsname 9 - \expandafter\chardef\csname Etoc@10@@\endcsname 10 - \expandafter\chardef\csname Etoc@11@@\endcsname 11 - \expandafter\chardef\csname Etoc@12@@\endcsname 12 -\fi -\expandafter\let\expandafter\Etoc@maxlevel - \csname Etoc@\ifEtoc@deeplevels12\else6\fi @@\endcsname -\edef\etocthemaxlevel{\number\Etoc@maxlevel} -\@ifclassloaded{memoir}{\def\Etoc@minf{-\thr@@}}{\def\Etoc@minf{-\tw@}} -\let\Etoc@none@@ \Etoc@minf -\expandafter\let\expandafter\Etoc@all@@ - \csname Etoc@\ifEtoc@deeplevels11\else5\fi @@\endcsname -\let\Etoc@dolevels\@empty -\def\Etoc@newlevel #1{\expandafter\def\expandafter\Etoc@dolevels\expandafter - {\Etoc@dolevels\Etoc@do{#1}}} -\ifdefined\expanded - \def\etocsetlevel#1#2{\expanded{\noexpand\etoc@setlevel{#1}{#2}}}% -\else - \def\etocsetlevel#1#2{{\edef\Etoc@tmp{\noexpand\etoc@setlevel{#1}{#2}}\expandafter}\Etoc@tmp}% -\fi -\def\etoc@setlevel#1#2{% - \edef\Etoc@tmp{\the\numexpr#2}% - \if1\ifnum\Etoc@tmp>\Etoc@maxlevel0\fi\unless\ifnum\Etoc@minf<\Etoc@tmp;\fi1% - \ifEtoc@deeplevels - \in@{.#1,}{.none,.all,.figure,.table,.-3,.-2,.-1,.0,.1,.2,.3,.4,.5,.6,% - .7,.8,.9,.10,.11,.12,}% - \else - \in@{.#1,}{.none,.all,.figure,.table,.-3,.-2,.-1,.0,.1,.2,.3,.4,.5,.6,}% - \fi - \ifin@\else\if\@car#1\@nil @\in@true\fi\fi - \ifin@ - \PackageWarning{etoc} - {Sorry, but `#1' is forbidden as level name.\MessageBreak - \if\@car#1\@nil @% - (because of the @ as first character)\MessageBreak\fi - Reported}% - \else - \etocifunknownlevelTF{#1}{\Etoc@newlevel{#1}}{}% - \expandafter\let\csname Etoc@#1@@\expandafter\endcsname - \csname Etoc@\Etoc@tmp @@\endcsname - \expandafter\edef\csname Etoc@@#1@@\endcsname - {\expandafter\noexpand\csname Etoc@#1@@\endcsname}% - \expandafter\edef\csname toclevel@@#1\endcsname - {\expandafter\noexpand\csname toclevel@#1\endcsname}% - \fi - \else - \PackageWarning{etoc} - {Argument `\detokenize{#2}' of \string\etocsetlevel\space should - represent one of\MessageBreak - \ifnum\Etoc@minf=-\thr@@-2, \fi-1, 0, 1, 2, \ifEtoc@deeplevels ...\else3, 4\fi, - \the\numexpr\Etoc@maxlevel-1, or \number\Etoc@maxlevel\space - but evaluates to \Etoc@tmp.\MessageBreak - The level of `#1' will be set to \number\Etoc@maxlevel.\MessageBreak - Tables of contents will ignore `#1' as long\MessageBreak - as its level is \number\Etoc@maxlevel\space (=\string\etocthemaxlevel).% - \MessageBreak - Reported}% - \etocifunknownlevelTF{#1}{\Etoc@newlevel{#1}}{}% - \expandafter\let\csname Etoc@#1@@\endcsname\Etoc@maxlevel - \fi -} -\def\etoclevel#1{\csname Etoc@#1@@\endcsname} -\def\etocthelevel#1{\number\csname Etoc@#1@@\endcsname} -\def\etocifunknownlevelTF#1{\@ifundefined{Etoc@#1@@}} -\@ifclassloaded{memoir}{\etocsetlevel{book}{-2}}{} -\etocsetlevel{part}{-1} -\etocsetlevel{chapter}{0} -\etocsetlevel{section}{1} -\etocsetlevel{subsection}{2} -\etocsetlevel{subsubsection}{3} -\etocsetlevel{paragraph}{4} -\etocsetlevel{subparagraph}{5} -\ifdefined\c@chapter - \etocsetlevel{appendix}{0} -\else - \etocsetlevel{appendix}{1} -\fi -\def\Etoc@do#1{\@namedef{l@@#1}{\csname l@#1\endcsname}} -\Etoc@dolevels -\let\Etoc@figure@@\Etoc@maxlevel -\let\Etoc@table@@ \Etoc@maxlevel -\let\Etoc@gobblethreeorfour\@gobblefour -\ifdefined\@gobblethree - \let\Etoc@gobblethree\@gobblethree -\else - \long\def\Etoc@gobblethree#1#2#3{}% -\fi -\AtBeginDocument{% -\@ifpackageloaded{parskip}{\Etoc@parskiptrue}{}% -\@ifpackageloaded{hyperref} - {\Etoc@hyperreftrue} - {\ifEtoc@oldLaTeX - \let\Etoc@gobblethreeorfour\Etoc@gobblethree - \let\Etoc@etoccontentsline@fourargs\Etoc@etoccontentsline@ - \long\def\Etoc@etoccontentsline@#1#2#3{% - \Etoc@etoccontentsline@fourargs{#1}{#2}{#3}{}% - }% - \fi - }% -} -\def\etocskipfirstprefix {\global\Etoc@skipprefixtrue } -\def\Etoc@updatestackofends#1\etoc@{\gdef\Etoc@stackofends{#1}} -\def\Etoc@stackofends{{-3}{}} -\def\Etoc@doendsandbegin{% - \expandafter\Etoc@traversestackofends\Etoc@stackofends\etoc@ -} -\def\Etoc@traversestackofends#1{% - \ifnum#1>\Etoc@level - \csname Etoc@end@#1\endcsname - \expandafter\Etoc@traversestackofends - \else - \Etoc@traversestackofends@done{#1}% - \fi -} -\def\Etoc@traversestackofends@done#1#2{#2% - \ifnum#1<\Etoc@level - \csname Etoc@begin@\the\numexpr\Etoc@level\endcsname - \Etoc@global\Etoc@isfirsttrue - \edef\Etoc@tmp{{\the\numexpr\Etoc@level}}% - \else - \Etoc@global\Etoc@isfirstfalse - \let\Etoc@tmp\@empty - \fi - \expandafter\Etoc@updatestackofends\Etoc@tmp{#1}% -} -\def\Etoc@etoccontentsline #1{% - \let\Etoc@next\Etoc@gobblethreeorfour - \ifnum\csname Etoc@#1@@\endcsname=\Etoc@maxlevel - \else - \Etoc@skipthisonefalse - \global\expandafter\let\expandafter\Etoc@level\csname Etoc@#1@@\endcsname - \if @\@car#1\@nil\else\global\let\Etoc@virtualtop\Etoc@level\fi - \ifEtoc@localtoc - \ifEtoc@stoptoc - \Etoc@skipthisonetrue - \else - \ifEtoc@notactive - \Etoc@skipthisonetrue - \else - \unless\ifnum\Etoc@level>\etoclocaltop - \Etoc@skipthisonetrue - \global\Etoc@stoptoctrue - \fi - \fi - \fi - \fi - \ifEtoc@skipthisone - \else - \unless\ifnum\Etoc@level>\c@tocdepth - \ifEtoc@standardlines - \let\Etoc@next\Etoc@savedcontentsline - \else - \let\Etoc@next\Etoc@etoccontentsline@ - \fi - \fi - \fi - \fi - \Etoc@next{#1}% -} -\def\Etoc@etoccontentsline@ #1#2#3#4{% - \Etoc@doendsandbegin - \Etoc@global\edef\Etoc@prefix {\expandafter\noexpand - \csname Etoc@prefix@\the\numexpr\Etoc@level\endcsname }% - \Etoc@global\edef\Etoc@contents{\expandafter\noexpand - \csname Etoc@contents@\the\numexpr\Etoc@level\endcsname }% - \ifEtoc@skipprefix \Etoc@global\def\Etoc@prefix{\@empty}\fi - \global\Etoc@skipprefixfalse - \Etoc@lxyz{#2}{#3}{#4}% - \Etoc@prefix - \Etoc@contents -} -\def\Etoc@lxyz #1#2#3{% - \ifEtoc@hyperref - \Etoc@global\def\etocthelink##1{\hyperlink{#3}{##1}}% - \else - \Etoc@global\let\etocthelink\@firstofone - \fi - \Etoc@global\def\etocthepage {#2}% - \ifEtoc@hyperref - \ifx\etocthepage\@empty - \Etoc@global\let\etocthelinkedpage\@empty - \else - \Etoc@global\def\etocthelinkedpage{\hyperlink {#3}{#2}}% - \fi - \else - \Etoc@global\let\etocthelinkedpage\etocthepage - \fi - \Etoc@global\def\etocthename{#1}% - \futurelet\Etoc@getnb@token\Etoc@@getnb #1\hspace\etoc@ - \ifEtoc@hyperref - \def\Etoc@tmp##1##2{\Etoc@global\def##2{\hyperlink{#3}{##1}}}% - \expandafter\Etoc@tmp\expandafter{\etocthename}\etocthelinkedname - \ifEtoc@numbered - \expandafter\Etoc@tmp\expandafter{\etocthenumber}\etocthelinkednumber - \else - \Etoc@global\let\etocthelinkednumber\@empty - \fi - \else - \Etoc@global\let\etocthelinkedname \etocthename - \Etoc@global\let\etocthelinkednumber\etocthenumber - \fi - \Etoc@global\expandafter\let\csname etoclink \endcsname \etocthelink - \Etoc@global\expandafter\let\csname etocname \endcsname \etocthename - \Etoc@global\expandafter\let\csname etocnumber \endcsname\etocthenumber - \Etoc@global\expandafter\let\csname etocpage \endcsname \etocthepage - \ifEtoc@hyperref - \Etoc@lxyz@linktoc - \fi -} -\def\Etoc@lxyz@linktoc{% - \ifcase\Hy@linktoc - \or - \Etoc@global\expandafter\let\csname etocname \endcsname\etocthelinkedname - \Etoc@global\expandafter\let\csname etocnumber \endcsname\etocthelinkednumber - \or % page - \Etoc@global\expandafter\let\csname etocpage \endcsname\etocthelinkedpage - \else % all - \Etoc@global\expandafter\let\csname etocname \endcsname\etocthelinkedname - \Etoc@global\expandafter\let\csname etocnumber \endcsname\etocthelinkednumber - \Etoc@global\expandafter\let\csname etocpage \endcsname\etocthelinkedpage - \fi -} -\def\Etoc@@getnb {% - \let\Etoc@next\Etoc@getnb - \ifx\Etoc@getnb@token\@sptoken\let\Etoc@next\Etoc@getnb@nonbr\fi - \ifx\Etoc@getnb@token\bgroup \let\Etoc@next\Etoc@getnb@nonbr\fi - \Etoc@next -} -\def\Etoc@getnb #1{% - \in@{#1}{\numberline\chapternumberline\partnumberline\booknumberline}% - \ifin@ - \let\Etoc@next\Etoc@getnb@nmbrd - \else - \ifnum\Etoc@level=\m@ne - \let\Etoc@next\Etoc@@getit - \else - \let\Etoc@next\Etoc@getnb@nonbr - \fi - \in@{#1}{\nonumberline}% - \ifin@ - \let\Etoc@next\Etoc@getnb@nonumberline - \fi - \fi - \Etoc@next #1% -} -\def\Etoc@getnb@nmbrd #1#2{% - \Etoc@global\Etoc@numberedtrue - \Etoc@global\def\etocthenumber {#2}% - \Etoc@getnb@nmbrd@getname\@empty -}% -\def\Etoc@getnb@nmbrd@getname #1\hspace\etoc@ {% - \Etoc@global\expandafter\def\expandafter\etocthename\expandafter{#1}% -} -\def\Etoc@getnb@nonbr #1\etoc@ {% - \Etoc@global\Etoc@numberedfalse - \Etoc@global\let\etocthenumber \@empty -} -\def\Etoc@getnb@nonumberline #1\hspace\etoc@ {% - \Etoc@global\Etoc@numberedfalse - \Etoc@global\let\etocthenumber \@empty - \Etoc@global\expandafter\def\expandafter\etocthename\expandafter{\@gobble#1}% -} -\def\Etoc@@getit #1\hspace#2{% - \ifx\etoc@#2% - \Etoc@global\Etoc@numberedfalse - \Etoc@global\let\etocthenumber \@empty - \else - \Etoc@global\Etoc@numberedtrue - \Etoc@global\def\etocthenumber {#1}% - \expandafter\Etoc@getit@getname \expandafter\@empty - \fi -} -\def\Etoc@getit@getname #1\hspace\etoc@ {% - \Etoc@global\expandafter\def\expandafter\etocthename\expandafter{#1}% -} -\let\etocthename \@empty -\let\etocthenumber \@empty -\let\etocthepage \@empty -\let\etocthelinkedname \@empty -\let\etocthelinkednumber \@empty -\let\etocthelinkedpage \@empty -\let\etocthelink \@firstofone -\DeclareRobustCommand*{\etocname} {} -\DeclareRobustCommand*{\etocnumber}{} -\DeclareRobustCommand*{\etocpage} {} -\DeclareRobustCommand*{\etoclink} {\@firstofone} -\DeclareRobustCommand*{\etocifnumbered} - {\ifEtoc@numbered\expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi} -\expandafter\let\expandafter\etocxifnumbered\csname etocifnumbered \endcsname -\DeclareRobustCommand*{\etociffirst} - {\ifEtoc@isfirst\expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi} -\expandafter\let\expandafter\etocxiffirst\csname etociffirst \endcsname -\def\Etoc@readtoc {% - \ifeof \Etoc@tf - \else - \read \Etoc@tf to \Etoc@buffer - \Etoc@toctoks=\expandafter\expandafter\expandafter - {\expandafter\the\expandafter\Etoc@toctoks\Etoc@buffer}% - \expandafter\Etoc@readtoc - \fi -} -\Etoc@toctoks {}% (superfluous, but for clarity) -\AtBeginDocument{\IfFileExists{\jobname.toc} - {{\endlinechar=\m@ne - \makeatletter - \newread\Etoc@tf - \openin\Etoc@tf\@filef@und - \Etoc@readtoc - \global\Etoc@toctoks=\expandafter{\the\Etoc@toctoks}% - \closein\Etoc@tf}} - {\typeout{No file \jobname.toc.}}} -\def\Etoc@openouttoc{% - \ifEtoc@hyperref - \ifx\hyper@last\@undefined - \IfFileExists{\jobname .toc} - {\Hy@WarningNoLine - {old toc file detected; run LaTeX again (cheers from `etoc')}% - \global\Etoc@toctoks={}% - } - {}% - \fi - \fi - \if@filesw - \newwrite \tf@toc - \immediate \openout \tf@toc \jobname .toc\relax - \fi - \global\let\Etoc@openouttoc\empty -} -\def\Etoc@toctoc{% - \gdef\Etoc@stackofends{{-3}{}}% - \global\let\Etoc@level\Etoc@minf - \global\let\Etoc@virtualtop\Etoc@minf - \the\Etoc@toctoks - \ifEtoc@notactive - \else - \gdef\Etoc@level{-\thr@@}% - \Etoc@doendsandbegin - \fi -} -\def\Etoc@@startlocaltoc#1#2{% - \ifEtoc@localtoc - \ifnum #1=#2\relax - \global\let\etoclocaltop\Etoc@virtualtop - \Etoc@@startlocaltochook - \etoclocaltableofcontentshook - \ifEtoc@etocstyle - \etocetoclocaltocmaketitle - \fi - \ifx\Etoc@aftertitlehook\@empty - \else - \ifEtoc@localtoctotoc - \ifEtoc@ouroboros - \else - \let\Etoc@tmp\contentsline - \def\contentsline{\let\contentsline\Etoc@tmp\Etoc@gobblethreeorfour}% - \fi - \fi - \fi - \global\Etoc@notactivefalse - \fi - \fi -} -\let\etoc@startlocaltoc\@gobble -\let\Etoc@@startlocaltoc@toc\Etoc@@startlocaltoc -\let\Etoc@@startlocaltochook\@empty -\unless\ifEtoc@deeplevels - \def\etocdivisionnameatlevel#1{% - \ifcase\numexpr#1\relax - \ifdefined\c@chapter chapter\else section\fi% - \or section% - \or subsection% - \or subsubsection% - \or paragraph% - \or subparagraph% - \or empty% - \else\ifnum\numexpr#1<\m@ne - book% - \else - part% - \fi - \fi - } -\else - \def\etocdivisionnameatlevel#1{% - \ifcase\numexpr#1\relax - \ifdefined\c@chapter chapter\else section\fi% - \or section% - \or subsection% - \or subsubsection% - \or subsubsubsection% - \or subsubsubsubsection% - \or subsubsubsubsubsection% - \or subsubsubsubsubsubsection% - \or paragraph% - \or subparagraph% - \else\ifnum\numexpr#1>\z@ - empty% - \else\ifnum\numexpr#1=\m@ne - part% - \else - book% - \fi\fi - \fi - } -\fi -\def\etoclocalheadtotoc#1#2{\addcontentsline{toc}{@#1}{#2}} -\def\etocglobalheadtotoc{\addcontentsline{toc}} -\providecommand*\UseName{\@nameuse} -\def\etocetoclocaltocmaketitle{% - \UseName{\etocdivisionnameatlevel{\etoclocaltop+1}}*{\localcontentsname}% - \if@noskipsec\leavevmode\par\fi - \etociflocaltoctotoc - {\etocifisstarred - {}% star variant, do not add to toc - {\etoclocalheadtotoc - {\etocdivisionnameatlevel{\etoclocaltop+1}}% - {\localcontentsname}% - }% - }% - {}% -}% -\def\localcontentsname {\contentsname}% -\let\etoclocaltableofcontentshook\@empty -\if1\ifEtoc@lof0\fi\ifEtoc@lot0\fi1% -\else -\AtBeginDocument{% - \let\Etoc@originaladdcontentsline\addcontentsline - \def\addcontentsline{\Etoc@hackedaddcontentsline}% -}% -\fi -\ifEtoc@lof - \ifEtoc@lot - \def\Etoc@hackedaddcontentsline#1{% - \expanded{\noexpand\in@{.#1,}}{.lof,.lot,}% - \ifin@\expandafter\Etoc@hackedaddcontentsline@i - \else\expandafter\Etoc@originaladdcontentsline - \fi {#1}} - \else - \def\Etoc@hackedaddcontentsline#1{% - \expanded{\noexpand\in@{.#1,}}{.lof,}% - \ifin@\expandafter\Etoc@hackedaddcontentsline@i - \else\expandafter\Etoc@originaladdcontentsline - \fi {#1}} - \fi -\else - \def\Etoc@hackedaddcontentsline#1{% - \expanded{\noexpand\in@{.#1,}}{.lot,}% - \ifin@\expandafter\Etoc@hackedaddcontentsline@i - \else\expandafter\Etoc@originaladdcontentsline - \fi {#1}} -\fi -\def\Etoc@hackedaddcontentsline@i#1#2#3{% - \expanded{\noexpand\in@{.#1;#2,}}{.lof;figure,.lot;table,}% - \ifin@ - \addtocontents {toc}{% - \protect\contentsline{#2}{#3}{\thepage}{\ifEtoc@hyperref\@currentHref\fi}% - \ifdefined\protected@file@percent\protected@file@percent\fi - }% - \fi - \Etoc@originaladdcontentsline{#1}{#2}{#3}% -} -\unless\ifdefined\expanded - \def\Etoc@hackedaddcontentsline#1{% - {\edef\Etoc@tmp{\noexpand\in@{.#1,}{\ifEtoc@lof.lof,\fi\ifEtoc@lot.lot,\fi}}\expandafter}% - \Etoc@tmp - \ifin@\expandafter\Etoc@hackedaddcontentsline@i - \else\expandafter\Etoc@originaladdcontentsline - \fi {#1}% - } - \def\Etoc@hackedaddcontentsline@i#1#2#3{% - {\edef\Etoc@tmp{\noexpand\in@{.#1;#2,}}\expandafter}% - \Etoc@tmp{.lof;figure,.lot;table,}% - \ifin@ - \addtocontents {toc}{% - \protect\contentsline{#2}{#3}{\thepage}{\ifEtoc@hyperref\@currentHref\fi}% - \ifdefined\protected@file@percent\protected@file@percent\fi - }% - \fi - \Etoc@originaladdcontentsline{#1}{#2}{#3}% - } -\fi -\def\Etoc@@startlocallistof#1#2#3{% - \ifEtoc@localtoc - \ifnum #2=#3\relax - \global\let\etoclocaltop\Etoc@virtualtop - \global\Etoc@notactivefalse - \Etoc@@startlocaltochook - \csname etoclocallistof#1shook\endcsname - \ifEtoc@etocstyle - \csname etocetoclistof#1smaketitle\endcsname - \fi - \fi - \fi -} -\def\Etoc@@startlocallistof@setlevels#1{% - \ifnum\etoclocaltop<\z@ - \expandafter\let\csname Etoc@#1@@\endcsname\@ne - \else - \expandafter\let\csname Etoc@#1@@\expandafter\endcsname - \csname Etoc@\the\numexpr\etoclocaltop+\@ne @@\endcsname - \fi - \def\Etoc@do##1{% - \ifnum\etoclevel{##1}>\etoclocaltop - \expandafter\let\csname Etoc@##1@@\endcsname\Etoc@maxlevel - \fi}% - \Etoc@dolevels -} -\def\etoclocallistoffigureshook{\etocstandardlines} -\def\etoclocallistoftableshook {\etocstandardlines} -\def\locallistfigurename{\listfigurename} -\def\locallisttablename {\listtablename} -\def\etocetoclistoffiguresmaketitle{% - \UseName{\etocdivisionnameatlevel{\etoclocaltop+1}}*{\locallistfigurename}% - \ifnum\etoclocaltop>\tw@\mbox{}\par\fi - \etociflocalloftotoc - {\etocifisstarred - {}% star variant, do not add to toc - {\etoclocalheadtotoc - {\etocdivisionnameatlevel{\etoclocaltop+1}}% - {\locallistfigurename}% - }% - }% - {}% -}% -\def\etocetoclistoftablesmaketitle{% - \UseName{\etocdivisionnameatlevel{\etoclocaltop+1}}*{\locallisttablename}% - \ifnum\etoclocaltop>\tw@\mbox{}\par\fi - \etociflocallottotoc - {\etocifisstarred - {}% star variant, do not add to toc - {\etoclocalheadtotoc - {\etocdivisionnameatlevel{\etoclocaltop+1}}% - {\locallisttablename}% - }% - }% - {}% -}% -\let\Etoc@listofreset\@empty -\ifEtoc@lof - \def\locallistoffigures{% - \def\Etoc@listofreset{% - \let\Etoc@currext\Etoc@tocext - \let\Etoc@@startlocaltoc\Etoc@@startlocaltoc@toc - \let\Etoc@@startlocaltochook\@empty - \let\Etoc@listofreset\@empty - \let\Etoc@listofhook\@empty - }% - \let\Etoc@currext\Etoc@lofext - \def\Etoc@@startlocaltoc{\Etoc@@startlocallistof{figure}}% - \def\Etoc@@startlocaltochook{\Etoc@@startlocallistof@setlevels{figure}}% - \def\Etoc@listofhook{% - \def\Etoc@do####1{% - \expandafter\let\csname Etoc@@####1@@\endcsname\Etoc@maxlevel - }% - \Etoc@dolevels - }% - \localtableofcontents - } -\else - \def\locallistoffigures{% - \PackageError{etoc}{% - \string\locallistoffigures \on@line\space but\MessageBreak - package was loaded without `lof' option}% - {Try again with \string\usepackage[lof]{etoc}}% - } -\fi -\ifEtoc@lot - \def\locallistoftables{% - \def\Etoc@listofreset{% - \let\Etoc@currext\Etoc@tocext - \let\Etoc@@startlocaltoc\Etoc@@startlocaltoc@toc - \let\Etoc@@startlocaltochook\@empty - \let\Etoc@listofreset\@empty - \let\Etoc@listofhook\@empty - }% - \let\Etoc@currext\Etoc@lotext - \def\Etoc@@startlocaltoc{\Etoc@@startlocallistof{table}}% - \def\Etoc@@startlocaltochook{\Etoc@@startlocallistof@setlevels{table}}% - \def\Etoc@listofhook{% - \def\Etoc@do####1{% - \expandafter\let\csname Etoc@@####1@@\endcsname\Etoc@maxlevel - }% - \Etoc@dolevels - }% - \localtableofcontents - } -\else - \def\locallistoftables{% - \PackageError{etoc}{% - \string\locallistoftable \on@line\space but\MessageBreak - package was loaded without `lot' option}% - {Try again with \string\usepackage[lot]{etoc}}% - } -\fi -\def\Etoc@checkifempty {% - \global\Etoc@isemptytoctrue - \global\Etoc@stoptocfalse - \global\let\Etoc@level\Etoc@minf - \global\let\Etoc@virtualtop\Etoc@minf - \gdef\Etoc@stackofends{{-3}{}}% - \begingroup - \ifEtoc@localtoc - \def\etoc@startlocaltoc##1{% - \ifnum##1=\Etoc@tocid\relax - \global\let\etoclocaltop\Etoc@virtualtop - \Etoc@@startlocaltochook - \global\Etoc@notactivefalse - \fi - }% - \let\contentsline\Etoc@testingcontentslinelocal - \else - \let\contentsline\Etoc@testingcontentsline - \fi - \Etoc@storetocdepth - \let\Etoc@setlocaltop@doendsandbegin\@empty - \the\Etoc@toctoks - \Etoc@restoretocdepth - \endgroup -} -\DeclareRobustCommand*\etocifwasempty - {\ifEtoc@isemptytoc\expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi } -\expandafter\let\expandafter\etocxifwasempty\csname etocifwasempty \endcsname -\def\Etoc@testingcontentslinelocal #1{% - \ifEtoc@stoptoc - \else - \ifnum\csname Etoc@#1@@\endcsname=\Etoc@maxlevel - \else - \global\expandafter\let\expandafter\Etoc@level\csname Etoc@#1@@\endcsname - \if @\@car#1\@nil\else\global\let\Etoc@virtualtop\Etoc@level\fi - \ifEtoc@notactive - \else - \ifnum\Etoc@level>\etoclocaltop - \unless\ifnum\Etoc@level>\c@tocdepth - \global\Etoc@isemptytocfalse - \global\Etoc@stoptoctrue - \fi - \else - \global\Etoc@stoptoctrue - \fi - \fi - \fi - \fi - \Etoc@gobblethreeorfour{}% -} -\def\Etoc@testingcontentsline #1{% - \ifEtoc@stoptoc - \else - \ifnum\csname Etoc@#1@@\endcsname=\Etoc@maxlevel - \else - \unless\ifnum\csname Etoc@#1@@\endcsname>\c@tocdepth - \global\Etoc@isemptytocfalse - \global\Etoc@stoptoctrue - \fi - \fi - \fi - \Etoc@gobblethreeorfour{}% -} -\def\Etoc@localtableofcontents#1{% - \gdef\etoclocaltop{-\@m}% - \Etoc@localtoctrue - \global\Etoc@isemptytocfalse - \edef\Etoc@tocid{#1}% - \ifnum\Etoc@tocid<\@ne - \setbox0\hbox{\ref{Unknown toc ref \@secondoftwo#1. \space Rerun LaTeX}}% - \global\Etoc@stoptoctrue - \gdef\etoclocaltop{-\thr@@}% - \Etoc@tableofcontents - \expandafter\Etoc@gobtoetoc@ - \fi - \global\Etoc@notactivetrue - \ifEtoc@checksemptiness - \Etoc@checkifempty - \fi - \ifEtoc@isemptytoc - \ifEtoc@notactive - \setbox0\hbox{\ref{Unknown toc ID \number\Etoc@tocid. \space Rerun LaTeX}}% - \global\Etoc@isemptytocfalse - \global\Etoc@stoptoctrue - \gdef\etoclocaltop{-\thr@@}% - \Etoc@tableofcontents - \expandafter\expandafter\expandafter\Etoc@gobtoetoc@ - \fi - \else - \global\Etoc@stoptocfalse - \global\Etoc@notactivetrue - \edef\etoc@startlocaltoc##1% - {\noexpand\Etoc@@startlocaltoc{##1}{\Etoc@tocid}}% - \Etoc@tableofcontents - \fi - \@gobble\etoc@ - \endgroup\ifEtoc@mustclosegroup\endgroup\fi - \Etoc@tocdepthreset - \Etoc@listofreset - \etocaftertochook -}% \Etoc@localtableofcontents -\def\Etoc@getref #1{% - \@ifundefined{r@#1} - {0} - {\expandafter\Etoc@getref@i\romannumeral-`0% - \expandafter\expandafter\expandafter - \@car\csname r@#1\endcsname0\@nil\@etoc - }% -} -\def\Etoc@getref@i#1#2\@etoc{\ifnum9<1\string#1 #1#2\else 0\fi} -\def\Etoc@ref#1{\Etoc@localtableofcontents{\Etoc@getref{#1}}} -\def\Etoc@label#1{\label{#1}\futurelet\Etoc@nexttoken\Etoc@t@bleofcontents} -\@firstofone{\def\Etoc@again} {\futurelet\Etoc@nexttoken\Etoc@t@bleofcontents} -\def\Etoc@dothis #1#2\etoc@ {\fi #1} -\def\Etoc@t@bleofcontents{% - \gdef\etoclocaltop{-\@M}% - \ifx\Etoc@nexttoken\label\Etoc@dothis{\expandafter\Etoc@label\@gobble}\fi - \ifx\Etoc@nexttoken\@sptoken\Etoc@dothis{\Etoc@again}\fi - \ifx\Etoc@nexttoken\ref\Etoc@dothis{\expandafter\Etoc@ref\@gobble}\fi - \ifEtoc@tocwithid\Etoc@dothis{\Etoc@localtableofcontents{\c@etoc@tocid}}\fi - \global\Etoc@isemptytocfalse - \ifEtoc@checksemptiness\Etoc@checkifempty\fi - \ifEtoc@isemptytoc - \ifEtoc@notocifnotoc - \expandafter\expandafter\expandafter\@gobble - \fi - \fi - \Etoc@tableofcontents - \endgroup - \ifEtoc@mustclosegroup\endgroup\fi - \Etoc@tocdepthreset - \Etoc@listofreset - \etocaftertochook - \@gobble\etoc@ - }% \Etoc@t@bleofcontents -\def\Etoc@table@fcontents{% - \refstepcounter{etoc@tocid}% - \Etoc@tocwithidfalse - \futurelet\Etoc@nexttoken\Etoc@t@bleofcontents -} -\def\Etoc@localtable@fcontents{% - \refstepcounter{etoc@tocid}% - \addtocontents{toc}{\string\etoc@startlocaltoc{\the\c@etoc@tocid}}% - \Etoc@tocwithidtrue - \futurelet\Etoc@nexttoken\Etoc@t@bleofcontents -} -\def\etoctableofcontents{% - \Etoc@openouttoc - \Etoc@tocdepthset - \begingroup - \@ifstar - {\let\Etoc@aftertitlehook\@empty\Etoc@table@fcontents} - {\def\Etoc@aftertitlehook{\etocaftertitlehook}\Etoc@table@fcontents}% -}% \etoctableofcontents -\def\etocifisstarred{\ifx\Etoc@aftertitlehook\@empty - \expandafter\@firstoftwo\else - \expandafter\@secondoftwo - \fi} -\let\etocoriginaltableofcontents\tableofcontents -\let\tableofcontents\etoctableofcontents -\let\Etoc@listofhook\@empty -\newcommand*\localtableofcontents{% - \Etoc@openouttoc - \Etoc@tocdepthset - \begingroup - \Etoc@listofhook - \@ifstar - {\let\Etoc@aftertitlehook\@empty\Etoc@localtable@fcontents} - {\def\Etoc@aftertitlehook{\etocaftertitlehook}\Etoc@localtable@fcontents}% -}% \localtableofcontents -\newcommand*\localtableofcontentswithrelativedepth[1]{% - \def\Etoc@@startlocaltochook{% - \global\c@tocdepth\numexpr\etoclocaltop+#1\relax - }% - \def\Etoc@listofreset{\let\Etoc@@startlocaltochook\@empty - \let\Etoc@listofreset\@empty}% - \localtableofcontents -}% \localtableofcontentswithrelativedepth -\newcommand\etocsettocstyle[2]{% - \Etoc@etocstylefalse - \Etoc@classstylefalse - \def\Etoc@tableofcontents@user@before{#1}% - \def\Etoc@tableofcontents@user@after {#2}% -}% -\def\etocstoretocstyleinto#1{% -%% \@ifdefinable#1{% - \edef#1{\noexpand\Etoc@etocstylefalse\noexpand\Etoc@classstylefalse - \def\noexpand\Etoc@tableofcontents@user@before{% - \unexpanded\expandafter{\Etoc@tableofcontents@user@before}% - }% - \def\noexpand\Etoc@tableofcontents@user@after{% - \unexpanded\expandafter{\Etoc@tableofcontents@user@after}% - }% - }% -%% }% -}% -\def\Etoc@tableofcontents {% - \Etoc@tableofcontents@etoc@before - \ifEtoc@localtoc\ifEtoc@etocstyle\expandafter\expandafter\expandafter\@gobble\fi\fi - \Etoc@tableofcontents@user@before - \Etoc@tableofcontents@contents - \ifEtoc@localtoc\ifEtoc@etocstyle\expandafter\expandafter\expandafter\@gobble\fi\fi - \Etoc@tableofcontents@user@after - \Etoc@tableofcontents@etoc@after - \@gobble\etoc@ -} -\def\Etoc@tableofcontents@etoc@before{% - \ifnum\c@tocdepth>\Etoc@minf - \else - \expandafter\Etoc@gobtoetoc@ - \fi - \Etoc@par - \Etoc@beforetitlehook - \etocbeforetitlehook - \Etoc@storetocdepth - \let\Etoc@savedcontentsline\contentsline - \let\contentsline\Etoc@etoccontentsline - \ifEtoc@standardlines - \else - \def\Etoc@do##1{% - \expandafter\def\csname etocsaved##1tocline\endcsname - {\PackageError{etoc}{% - \expandafter\string\csname etocsaved##1tocline\endcsname\space - has been deprecated\MessageBreak - at 1.1a and is removed at 1.2.\MessageBreak - Use \expandafter\string\csname l@##1\endcsname\space directly.\MessageBreak - Reported \on@line}% - {I will use \expandafter\string - \csname l@##1\endcsname\space myself for this time.% - }% - \csname l@##1\endcsname - }% - }% - \Etoc@dolevels - \fi -}% -\def\Etoc@tableofcontents@contents{% - \Etoc@tocdepthset - \ifEtoc@parskip\parskip\z@skip\fi - \Etoc@aftertitlehook - \gdef\etoclocaltop{-\thr@@}% - \Etoc@toctoc - \etocaftercontentshook -}% -\def\Etoc@tableofcontents@etoc@after{% - \@nobreakfalse - \Etoc@restoretocdepth - \ifx\Etoc@global\global - \@ifundefined{tof@finish} - {} - {\ifx\tof@finish\@empty - \else - \global\let\contentsline\Etoc@savedcontentsline - \fi - }% - \fi -} -\def\etocsetstyle#1{\ifcsname Etoc@#1@@\endcsname - \expandafter\Etoc@setstyle@a - \else - \expandafter\Etoc@setstyle@error - \fi {#1}% -} -\def\Etoc@setstyle@error #1{% - \PackageWarning{etoc}{`#1' is unknown to etoc. \space Did you\MessageBreak - forget some \string\etocsetlevel{#1}{}?\MessageBreak - Reported}% - \@gobblefour -} -\def\Etoc@setstyle@a #1{% - \edef\Etoc@tmp{\the\numexpr\csname Etoc@#1@@\endcsname}% - \if1\unless\ifnum\Etoc@tmp<\Etoc@maxlevel 0\fi - \unless\ifnum\Etoc@tmp>\Etoc@minf 0\fi1% - \Etoc@standardlinesfalse - \expandafter\Etoc@setstyle@b\expandafter\Etoc@tmp - \else - \ifnum\Etoc@tmp=\Etoc@maxlevel - \in@{.#1,}{.figure,.table,}% - \ifin@ - \PackageWarning{etoc} - {You can not use \string\etocsetstyle\space with `#1'.\MessageBreak - Check the package documentation (in particular about\MessageBreak - \string\etoclocallistoffigureshook/\string\etoclocallistoftableshook)% - \MessageBreak on how to customize - figure and table entries in local\MessageBreak lists. Reported}% - \else - \PackageInfo{etoc} - {Attempt to set the style of `#1',\MessageBreak - whose level is currently the maximal one \etocthemaxlevel,\MessageBreak - which is never displayed. \space This will be ignored\MessageBreak - but note that we do quit compatibility mode.\MessageBreak - Reported}% - \Etoc@standardlinesfalse - \fi - \else - \PackageWarning{etoc}{This should not happen. Reported}% - \fi - \expandafter\@gobblefour - \fi -} -\long\def\Etoc@setstyle@b#1#2#3#4#5{% - \expandafter\def\csname Etoc@begin@#1\endcsname {#2}% - \expandafter\def\csname Etoc@prefix@#1\endcsname {#3}% - \expandafter\def\csname Etoc@contents@#1\endcsname {#4}% - \expandafter\def\csname Etoc@end@#1\endcsname {#5}% -} -\def\Etoc@setstyle@e#1{% - \expandafter\let\csname Etoc@begin@#1\endcsname \@empty - \expandafter\let\csname Etoc@prefix@#1\endcsname \@empty - \expandafter\let\csname Etoc@contents@#1\endcsname \@empty - \expandafter\let\csname Etoc@end@#1\endcsname \@empty -} -\def\Etoc@storelines@a#1{% - \noexpand\Etoc@setstyle@b{#1}% - {\expandafter\Etoc@expandonce\csname Etoc@begin@#1\endcsname}% - {\expandafter\Etoc@expandonce\csname Etoc@prefix@#1\endcsname}% - {\expandafter\Etoc@expandonce\csname Etoc@contents@#1\endcsname}% - {\expandafter\Etoc@expandonce\csname Etoc@end@#1\endcsname}% -} -\def\Etoc@expandonce#1{\unexpanded\expandafter{#1}} -\def\etocstorelinestylesinto#1{% - \edef#1{\Etoc@storelines@a{-2}\Etoc@storelines@a{-1}\Etoc@storelines@a{0}% - \Etoc@storelines@a {1}\Etoc@storelines@a {2}\Etoc@storelines@a{3}% - \Etoc@storelines@a {4}\Etoc@storelines@a {5}% - \ifEtoc@deeplevels - \Etoc@storelines@a{6}\Etoc@storelines@a{7}\Etoc@storelines@a{8}% - \Etoc@storelines@a{9}\Etoc@storelines@a{10}\Etoc@storelines@a{11}% - \fi - }% -} -\def\etocstorethislinestyleinto#1#2{% - \edef#2{\expandafter\Etoc@storelines@a\expandafter{\number\etoclevel{#1}}}% -}% -\def\etocfontminustwo {\normalfont \LARGE \bfseries} -\def\etocfontminusone {\normalfont \large \bfseries} -\def\etocfontzero {\normalfont \large \bfseries} -\def\etocfontone {\normalfont \normalsize \bfseries} -\def\etocfonttwo {\normalfont \normalsize} -\def\etocfontthree {\normalfont \footnotesize} -\def\etocsepminustwo {4ex \@plus .5ex \@minus .5ex} -\def\etocsepminusone {4ex \@plus .5ex \@minus .5ex} -\def\etocsepzero {2.5ex \@plus .4ex \@minus .4ex} -\def\etocsepone {1.5ex \@plus .3ex \@minus .3ex} -\def\etocseptwo {.5ex \@plus .1ex \@minus .1ex} -\def\etocsepthree {.25ex \@plus .05ex \@minus .05ex} -\def\etocbaselinespreadminustwo {1} -\def\etocbaselinespreadminusone {1} -\def\etocbaselinespreadzero {1} -\def\etocbaselinespreadone {1} -\def\etocbaselinespreadtwo {1} -\def\etocbaselinespreadthree {.9} -\def\etocminustwoleftmargin {1.5em plus 0.5fil} -\def\etocminustworightmargin {1.5em plus -0.5fil} -\def\etocminusoneleftmargin {1em} -\def\etocminusonerightmargin {1em} -\def\etoctoclineleaders - {\hbox{\normalfont\normalsize\hb@xt@2ex {\hss.\hss}}} -\def\etocabbrevpagename {p.~} -\def\etocpartname {Part} -\def\etocbookname {Book} -\def\etocdefaultlines{% - \Etoc@standardlinesfalse - \etocdefaultlines@setbook - \etocdefaultlines@setpart - \etocdefaultlines@setchapter - \etocdefaultlines@setsection - \etocdefaultlines@setsubsection - \etocdefaultlines@setsubsubsection - \etocdefaultlines@setdeeperones -} -\def\etocnoprotrusion{\leavevmode\kern-\p@\kern\p@} -\@ifclassloaded{memoir}{% - \def\etocdefaultlines@setbook{% - \Etoc@setstyle@b - {-2}% - {\addpenalty\@M\etocskipfirstprefix} - {\addpenalty\@secpenalty} - {\begingroup - \etocfontminustwo - \addvspace{\etocsepminustwo}% - \parindent \z@ - \leftskip \etocminustwoleftmargin - \rightskip \etocminustworightmargin - \parfillskip \@flushglue - \vbox{\etocifnumbered{\etoclink{\etocbookname\enspace\etocthenumber:\quad}}{}% - \etocname - \baselineskip\etocbaselinespreadminustwo\baselineskip - \par}% - \addpenalty\@M\addvspace{\etocsepminusone}% - \endgroup} - {}% - } - }{\let\etocdefaultlines@setbook\@empty} -\def\etocdefaultlines@setpart{% -\Etoc@setstyle@b - {-1}% - {\addpenalty\@M\etocskipfirstprefix} - {\addpenalty\@secpenalty} - {\begingroup - \etocfontminusone - \addvspace{\etocsepminusone}% - \parindent \z@ - \leftskip \etocminusoneleftmargin - \rightskip \etocminusonerightmargin - \parfillskip \@flushglue - \vbox{\etocifnumbered{\etoclink{\etocpartname\enspace\etocthenumber.\quad}}{}% - \etocname - \baselineskip\etocbaselinespreadminusone\baselineskip - \par}% - \addpenalty\@M\addvspace{\etocsepzero}% - \endgroup} - {}% -} -\def\etocdefaultlines@setchapter{% -\Etoc@setstyle@b - {0}% - {\addpenalty\@M\etocskipfirstprefix} - {\addpenalty\@itempenalty} - {\begingroup - \etocfontzero - \addvspace{\etocsepzero}% - \parindent \z@ \parfillskip \@flushglue - \vbox{\etocifnumbered{\etocnumber.\enspace}{}\etocname - \baselineskip\etocbaselinespreadzero\baselineskip - \par}% - \endgroup} - {\addpenalty{-\@highpenalty}\addvspace{\etocsepminusone}}% -} -\def\etocdefaultlines@setsection{% -\Etoc@setstyle@b - {1}% - {\addpenalty\@M\etocskipfirstprefix} - {\addpenalty\@itempenalty} - {\begingroup - \etocfontone - \addvspace{\etocsepone}% - \parindent \z@ \parfillskip \z@ - \setbox\z@\vbox{\parfillskip\@flushglue - \etocname\par - \setbox\tw@\lastbox - \global\setbox\@ne\hbox{\unhbox\tw@\ }}% - \dimen\z@=\wd\@ne - \setbox\z@=\etoctoclineleaders - \advance\dimen\z@\wd\z@ - \etocifnumbered - {\setbox\tw@\hbox{\etocnumber, \etocabbrevpagename\etocpage\etocnoprotrusion}} - {\setbox\tw@\hbox{\etocabbrevpagename\etocpage\etocnoprotrusion}}% - \advance\dimen\z@\wd\tw@ - \ifdim\dimen\z@ < \linewidth - \vbox{\etocname~% - \leaders\box\z@\hfil\box\tw@ - \baselineskip\etocbaselinespreadone\baselineskip - \par}% - \else - \vbox{\etocname~% - \leaders\copy\z@\hfil\break - \hbox{}\leaders\box\z@\hfil\box\tw@ - \baselineskip\etocbaselinespreadone\baselineskip - \par}% - \fi - \endgroup} - {\addpenalty\@secpenalty\addvspace{\etocsepzero}}% -} -\def\etocdefaultlines@setsubsection{% -\Etoc@setstyle@b - {2}% - {\addpenalty\@medpenalty\etocskipfirstprefix} - {\addpenalty\@itempenalty} - {\begingroup - \etocfonttwo - \addvspace{\etocseptwo}% - \parindent \z@ \parfillskip \z@ - \setbox\z@\vbox{\parfillskip\@flushglue - \etocname\par\setbox\tw@\lastbox - \global\setbox\@ne\hbox{\unhbox\tw@}}% - \dimen\z@=\wd\@ne - \setbox\z@=\etoctoclineleaders - \advance\dimen\z@\wd\z@ - \etocifnumbered - {\setbox\tw@\hbox{\etocnumber, \etocabbrevpagename\etocpage\etocnoprotrusion}} - {\setbox\tw@\hbox{\etocabbrevpagename\etocpage\etocnoprotrusion}}% - \advance\dimen\z@\wd\tw@ - \ifdim\dimen\z@ < \linewidth - \vbox{\etocname~% - \leaders\box\z@\hfil\box\tw@ - \baselineskip\etocbaselinespreadtwo\baselineskip - \par}% - \else - \vbox{\etocname~% - \leaders\copy\z@\hfil\break - \hbox{}\leaders\box\z@\hfil\box\tw@ - \baselineskip\etocbaselinespreadtwo\baselineskip - \par}% - \fi - \endgroup} - {\addpenalty\@secpenalty\addvspace{\etocsepone}}% -} -\def\etocdefaultlines@setsubsubsection{% -\Etoc@setstyle@b - {3}% - {\addpenalty\@M - \etocfontthree - \vspace{\etocsepthree}% - \noindent - \etocskipfirstprefix} - {\allowbreak\,--\,} - {\etocname} - {.\hfil - \begingroup - \baselineskip\etocbaselinespreadthree\baselineskip - \par - \endgroup - \addpenalty{-\@highpenalty}} -} -\def\etocdefaultlines@setdeeperones{% -\Etoc@setstyle@e{4}% -\Etoc@setstyle@e{5}% -\ifEtoc@deeplevels - \Etoc@setstyle@e{6}% - \Etoc@setstyle@e{7}% - \Etoc@setstyle@e{8}% - \Etoc@setstyle@e{9}% - \Etoc@setstyle@e{10}% - \Etoc@setstyle@e{11}% -\fi -} -\def\etocabovetocskip{3.5ex \@plus 1ex \@minus .2ex} -\def\etocbelowtocskip{3.5ex \@plus 1ex \@minus .2ex} -\def\etoccolumnsep{2em} -\def\etocmulticolsep{0ex} -\def\etocmulticolpretolerance{-1} -\def\etocmulticoltolerance{200} -\def\etocdefaultnbcol{2} -\def\etocinnertopsep{2ex} -\newcommand\etocmulticolstyle[2][\etocdefaultnbcol]{% -\etocsettocstyle - {\let\etocoldpar\par - \addvspace{\etocabovetocskip}% - \ifnum #1>\@ne - \expandafter\@firstoftwo - \else \expandafter\@secondoftwo - \fi - {\multicolpretolerance\etocmulticolpretolerance - \multicoltolerance\etocmulticoltolerance - \setlength{\columnsep}{\etoccolumnsep}% - \setlength{\multicolsep}{\etocmulticolsep}% - \begin{multicols}{#1}[#2\etocoldpar\addvspace{\etocinnertopsep}]} - {#2\ifvmode\else\begingroup\interlinepenalty\@M\parskip\z@skip - \@@par\endgroup - \fi - \nobreak\addvspace{\etocinnertopsep}% - \pretolerance\etocmulticolpretolerance - \tolerance\etocmulticoltolerance}% - }% - {\ifnum #1>\@ne - \expandafter\@firstofone - \else \expandafter\@gobble - \fi - {\end{multicols}}% - \addvspace{\etocbelowtocskip}}% -} -\def\etocinnerbottomsep{3.5ex} -\def\etocinnerleftsep{2em} -\def\etocinnerrightsep{2em} -\def\etoctoprule{\hrule} -\def\etocleftrule{\vrule} -\def\etocrightrule{\vrule} -\def\etocbottomrule{\hrule} -\def\etoctoprulecolorcmd{\relax} -\def\etocbottomrulecolorcmd{\relax} -\def\etocleftrulecolorcmd{\relax} -\def\etocrightrulecolorcmd{\relax} -\def\etoc@ruledheading #1{% - \hb@xt@\linewidth{\color@begingroup - \hss #1\hss\hskip-\linewidth - \etoctoprulecolorcmd\leaders\etoctoprule\hss - \phantom{#1}% - \leaders\etoctoprule\hss\color@endgroup}% - \nointerlineskip\nobreak\vskip\etocinnertopsep} -\newcommand*\etocruledstyle[2][\etocdefaultnbcol]{% -\etocsettocstyle - {\addvspace{\etocabovetocskip}% - \ifnum #1>\@ne - \expandafter\@firstoftwo - \else \expandafter\@secondoftwo - \fi - {\multicolpretolerance\etocmulticolpretolerance - \multicoltolerance\etocmulticoltolerance - \setlength{\columnsep}{\etoccolumnsep}% - \setlength{\multicolsep}{\etocmulticolsep}% - \begin{multicols}{#1}[\etoc@ruledheading{#2}]} - {\etoc@ruledheading{#2}% - \pretolerance\etocmulticolpretolerance - \tolerance\etocmulticoltolerance}} - {\ifnum #1>\@ne\expandafter\@firstofone - \else \expandafter\@gobble - \fi - {\end{multicols}}% - \addvspace{\etocbelowtocskip}}} -\def\etocframedmphook{\relax} -\long\def\etocbkgcolorcmd{\relax} -\long\def\Etoc@relax{\relax} -\newbox\etoc@framed@titlebox -\newbox\etoc@framed@contentsbox -\newcommand*\etocframedstyle[2][\etocdefaultnbcol]{% -\etocsettocstyle{% - \addvspace{\etocabovetocskip}% - \sbox\z@{#2}% - \dimen\z@\dp\z@ - \ifdim\wd\z@<\linewidth \dp\z@\z@ \else \dimen\z@\z@ \fi - \setbox\etoc@framed@titlebox=\hb@xt@\linewidth{\color@begingroup - \hss - \ifx\etocbkgcolorcmd\Etoc@relax - \else - \sbox\tw@{\color{white}% - \vrule\@width\wd\z@\@height\ht\z@\@depth\dimen\z@}% - \ifdim\wd\z@<\linewidth \dp\tw@\z@\fi - \box\tw@ - \hskip-\wd\z@ - \fi - \copy\z@ - \hss - \hskip-\linewidth - \etoctoprulecolorcmd\leaders\etoctoprule\hss - \hskip\wd\z@ - \etoctoprulecolorcmd\leaders\etoctoprule\hss\color@endgroup}% - \setbox\z@\hbox{\etocleftrule\etocrightrule}% - \dimen\tw@\linewidth\advance\dimen\tw@-\wd\z@ - \advance\dimen\tw@-\etocinnerleftsep - \advance\dimen\tw@-\etocinnerrightsep - \setbox\etoc@framed@contentsbox=\vbox\bgroup - \hsize\dimen\tw@ - \kern\dimen\z@ - \vskip\etocinnertopsep - \hbox\bgroup - \begin{minipage}{\hsize}% - \etocframedmphook - \ifnum #1>\@ne - \expandafter\@firstoftwo - \else \expandafter\@secondoftwo - \fi - {\multicolpretolerance\etocmulticolpretolerance - \multicoltolerance\etocmulticoltolerance - \setlength{\columnsep}{\etoccolumnsep}% - \setlength{\multicolsep}{\etocmulticolsep}% - \begin{multicols}{#1}} - {\pretolerance\etocmulticolpretolerance - \tolerance\etocmulticoltolerance}} - {\ifnum #1>\@ne\expandafter\@firstofone - \else \expandafter\@gobble - \fi - {\end{multicols}\unskip }% - \end{minipage}% - \egroup - \vskip\etocinnerbottomsep - \egroup - \vbox{\hsize\linewidth - \ifx\etocbkgcolorcmd\Etoc@relax - \else - \kern\ht\etoc@framed@titlebox - \kern\dp\etoc@framed@titlebox - \hb@xt@\linewidth{\color@begingroup - \etocleftrulecolorcmd\etocleftrule - \etocbkgcolorcmd - \leaders\vrule - \@height\ht\etoc@framed@contentsbox - \@depth\dp\etoc@framed@contentsbox - \hss - \etocrightrulecolorcmd\etocrightrule - \color@endgroup}\nointerlineskip - \vskip-\dp\etoc@framed@contentsbox - \vskip-\ht\etoc@framed@contentsbox - \vskip-\dp\etoc@framed@titlebox - \vskip-\ht\etoc@framed@titlebox - \fi - \box\etoc@framed@titlebox\nointerlineskip - \hb@xt@\linewidth{\color@begingroup - {\etocleftrulecolorcmd\etocleftrule}% - \hss\box\etoc@framed@contentsbox\hss - \etocrightrulecolorcmd\etocrightrule\color@endgroup} - \nointerlineskip - \vskip\ht\etoc@framed@contentsbox - \vskip\dp\etoc@framed@contentsbox - \hb@xt@\linewidth{\color@begingroup\etocbottomrulecolorcmd - \leaders\etocbottomrule\hss\color@endgroup}} - \addvspace{\etocbelowtocskip}}} -\newcommand\etoc@multicoltoc[2][\etocdefaultnbcol]{% - \etocmulticolstyle[#1]{#2}% - \tableofcontents} -\newcommand\etoc@multicoltoci[2][\etocdefaultnbcol]{% - \etocmulticolstyle[#1]{#2}% - \tableofcontents*} -\newcommand\etoc@local@multicoltoc[2][\etocdefaultnbcol]{% - \etocmulticolstyle[#1]{#2}% - \localtableofcontents} -\newcommand\etoc@local@multicoltoci[2][\etocdefaultnbcol]{% - \etocmulticolstyle[#1]{#2}% - \localtableofcontents*} -\newcommand*\etoc@ruledtoc[2][\etocdefaultnbcol]{% - \etocruledstyle[#1]{#2}% - \tableofcontents} -\newcommand*\etoc@ruledtoci[2][\etocdefaultnbcol]{% - \etocruledstyle[#1]{#2}% - \tableofcontents*} -\newcommand*\etoc@local@ruledtoc[2][\etocdefaultnbcol]{% - \etocruledstyle[#1]{#2}% - \localtableofcontents} -\newcommand*\etoc@local@ruledtoci[2][\etocdefaultnbcol]{% - \etocruledstyle[#1]{#2}% - \localtableofcontents*} -\newcommand*\etoc@framedtoc[2][\etocdefaultnbcol]{% - \etocframedstyle[#1]{#2}% - \tableofcontents} -\newcommand*\etoc@framedtoci[2][\etocdefaultnbcol]{% - \etocframedstyle[#1]{#2}% - \tableofcontents*} -\newcommand*\etoc@local@framedtoc[2][\etocdefaultnbcol]{% - \etocframedstyle[#1]{#2}% - \localtableofcontents} -\newcommand*\etoc@local@framedtoci[2][\etocdefaultnbcol]{% - \etocframedstyle[#1]{#2}% - \localtableofcontents*} -\def\etocmulticol{\begingroup - \Etoc@mustclosegrouptrue - \@ifstar - {\etoc@multicoltoci} - {\etoc@multicoltoc}} -\def\etocruled{\begingroup - \Etoc@mustclosegrouptrue - \@ifstar - {\etoc@ruledtoci} - {\etoc@ruledtoc}} -\def\etocframed{\begingroup - \Etoc@mustclosegrouptrue - \@ifstar - {\etoc@framedtoci} - {\etoc@framedtoc}} -\def\etoclocalmulticol{\begingroup - \Etoc@mustclosegrouptrue - \@ifstar - {\etoc@local@multicoltoci} - {\etoc@local@multicoltoc}} -\def\etoclocalruled{\begingroup - \Etoc@mustclosegrouptrue - \@ifstar - {\etoc@local@ruledtoci} - {\etoc@local@ruledtoc}} -\def\etoclocalframed{\begingroup - \Etoc@mustclosegrouptrue - \@ifstar - {\etoc@local@framedtoci} - {\etoc@local@framedtoc}} -\def\etocmemoirtoctotocfmt #1#2{% - \PackageWarning{etoc} - {\string\etocmemoirtoctotocfmt\space is deprecated.\MessageBreak - Use in its place \string\etocsettoclineforclasstoc,\MessageBreak - and \string\etocsettoclineforclasslistof{toc} (or {lof}, {lot}). - I will do this now.\MessageBreak - Reported}% - \etocsettoclineforclasstoc{#1}{#2}% - \etocsettoclineforclasslistof{toc}{#1}{#2}% -} -\def\etocsettoclineforclasstoc #1#2{% - \def\etocclassmaintocaddtotoc{\etocglobalheadtotoc{#1}{#2}}% -} -\def\etocsettoclineforclasslistof #1#2#3{% - \@namedef{etocclasslocal#1addtotoc}{\etoclocalheadtotoc{#2}{#3}}% -} -\let\etocclasslocaltocaddtotoc\@empty -\let\etocclasslocallofaddtotoc\@empty -\let\etocclasslocallotaddtotoc\@empty -\ifdefined\c@chapter - \def\etocclasslocaltocmaketitle{\section*{\localcontentsname}} - \def\etocclasslocallofmaketitle{\section*{\locallistfigurename}} - \def\etocclasslocallotmaketitle{\section*{\locallisttablename}} - \etocsettoclineforclasstoc {chapter}{\contentsname} - \etocsettoclineforclasslistof{toc}{section}{\localcontentsname} - \etocsettoclineforclasslistof{lof}{section}{\locallistfigurename} - \etocsettoclineforclasslistof{lot}{section}{\locallisttablename} -\else - \def\etocclasslocaltocmaketitle{\subsection*{\localcontentsname}}% - \def\etocclasslocallofmaketitle{\subsection*{\locallistfigurename}}% - \def\etocclasslocallotmaketitle{\subsection*{\locallisttablename}}% - \etocsettoclineforclasstoc {section}{\contentsname} - \etocsettoclineforclasslistof{toc}{subsection}{\localcontentsname} - \etocsettoclineforclasslistof{lof}{subsection}{\locallistfigurename} - \etocsettoclineforclasslistof{lot}{subsection}{\locallisttablename} -\fi -\def\etocclasslocalperhapsaddtotoc #1{% - \etocifisstarred - {} - {\csname ifEtoc@local#1totoc\endcsname - \csname etocclasslocal#1addtotoc\endcsname - \fi - }% -} -\def\etocarticlestyle{% - \etocsettocstyle - {\ifEtoc@localtoc - \@nameuse{etocclasslocal\Etoc@currext maketitle}% - \etocclasslocalperhapsaddtotoc\Etoc@currext - \else - \section *{\contentsname - \@mkboth {\MakeUppercase \contentsname} - {\MakeUppercase \contentsname}}% - \etocifisstarred{}{\etocifmaintoctotoc{\etocclassmaintocaddtotoc}{}}% - \fi - } - {}% -} -\def\etocarticlestylenomarks{% - \etocsettocstyle - {\ifEtoc@localtoc - \@nameuse{etocclasslocal\Etoc@currext maketitle}% - \etocclasslocalperhapsaddtotoc\Etoc@currext - \else - \section *{\contentsname}% - \etocifisstarred{}{\etocifmaintoctotoc{\etocclassmaintocaddtotoc}{}}% - \fi - } - {}% -} -\def\etocbookstyle{% - \etocsettocstyle - {\if@twocolumn \@restonecoltrue \onecolumn \else \@restonecolfalse \fi - \ifEtoc@localtoc - \@nameuse{etocclasslocal\Etoc@currext maketitle}% - \etocclasslocalperhapsaddtotoc\Etoc@currext - \else - \chapter *{\contentsname - \@mkboth {\MakeUppercase \contentsname} - {\MakeUppercase \contentsname}}% - \etocifisstarred{}{\etocifmaintoctotoc{\etocclassmaintocaddtotoc}{}}% - \fi - }% - {\if@restonecol \twocolumn \fi}% -} -\def\etocbookstylenomarks{% - \etocsettocstyle - {\if@twocolumn \@restonecoltrue \onecolumn \else \@restonecolfalse \fi - \ifEtoc@localtoc - \@nameuse{etocclasslocal\Etoc@currext maketitle}% - \etocclasslocalperhapsaddtotoc\Etoc@currext - \else - \chapter *{\contentsname}% - \etocifisstarred{}{\etocifmaintoctotoc{\etocclassmaintocaddtotoc}{}}% - \fi - }% - {\if@restonecol \twocolumn \fi}% -} -\let\etocreportstyle\etocbookstyle -\let\etocreportstylenomarks\etocbookstylenomarks -\def\etocmemoirstyle{% - \etocsettocstyle - {\ensureonecol \par \begingroup \phantomsection - \ifx\Etoc@aftertitlehook\@empty - \else - \ifmem@em@starred@listof - \else - \ifEtoc@localtoc - \etocclasslocalperhapsaddtotoc\Etoc@currext - \else - \ifEtoc@maintoctotoc - \etocclassmaintocaddtotoc - \fi - \fi - \fi - \fi - \ifEtoc@localtoc - \@namedef{@\Etoc@currext maketitle}{% - \@nameuse{etocclasslocal\Etoc@currext maketitle}% - }% - \fi - \@nameuse {@\Etoc@currext maketitle} %<< space token here from memoir code - \ifx\Etoc@aftertitlehook\@empty - \else - \Etoc@aftertitlehook \let \Etoc@aftertitlehook \relax - \fi - \parskip \cftparskip \@nameuse {cft\Etoc@currext beforelisthook}% - }% - {\@nameuse {cft\Etoc@currext afterlisthook}% - \endgroup\restorefromonecol - }% -} -\let\Etoc@beforetitlehook\@empty -\if1\@ifclassloaded{scrartcl}0{\@ifclassloaded{scrbook}0{\@ifclassloaded{scrreprt}01}}% -\expandafter\@gobble -\else - \ifdefined\setuptoc - \def\Etoc@beforetitlehook{% - \ifEtoc@localtoc - \etocclasslocalperhapsaddtotoc\Etoc@currext - \setuptoc{\Etoc@currext}{leveldown}% - \else - \etocifisstarred{}{\etocifmaintoctotoc{\setuptoc{toc}{totoc}}}% - \fi - }% - \fi -\expandafter\@firstofone -\fi -{\def\etocclasslocalperhapsaddtotoc #1{% - \etocifisstarred - {}% - {\csname ifEtoc@local#1totoc\endcsname - \setuptoc{\Etoc@currext}{totoc}% - \fi - }% - }% -} -\ifdefined\Iftocfeature - \def\etoc@Iftocfeature{\Iftocfeature}% -\else - \def\etoc@Iftocfeature{\iftocfeature}% -\fi -\def\etocscrartclstyle{% - \etocsettocstyle - {\ifx\Etoc@currext\Etoc@tocext - \expandafter\@firstofone - \else - \expandafter\@gobble - \fi - {\let\if@dynlist\if@tocleft}% - \edef\@currext{\Etoc@currext}% - \@ifundefined{listof\@currext name}% - {\def\list@fname{\listofname~\@currext}}% - {\expandafter\let\expandafter\list@fname - \csname listof\@currext name\endcsname}% - \etoc@Iftocfeature {\@currext}{onecolumn} - {\etoc@Iftocfeature {\@currext}{leveldown} - {} - {\if@twocolumn \aftergroup \twocolumn \onecolumn \fi }} - {}% - \etoc@Iftocfeature {\@currext}{numberline}% - {\def \nonumberline {\numberline {}}}{}% - \expandafter\tocbasic@listhead\expandafter {\list@fname}% - \begingroup \expandafter \expandafter \expandafter - \endgroup \expandafter - \ifx - \csname microtypesetup\endcsname \relax - \else - \etoc@Iftocfeature {\@currext}{noprotrusion}{} - {\microtypesetup {protrusion=false}% - \PackageInfo {tocbasic}% - {character protrusion at \@currext\space deactivated}}% - \fi - \etoc@Iftocfeature{\@currext}{noparskipfake}{}{% - \ifvmode \@tempskipa\lastskip \vskip-\lastskip - \addtolength{\@tempskipa}{\parskip}\vskip\@tempskipa\fi - }% - \setlength {\parskip }{\z@ }% - \setlength {\parindent }{\z@ }% - \setlength {\parfillskip }{\z@ \@plus 1fil}% - \csname tocbasic@@before@hook\endcsname - \csname tb@\@currext @before@hook\endcsname - }% end of before_toc - {% start of after_toc - \providecommand\tocbasic@end@toc@file{}\tocbasic@end@toc@file - \edef\@currext{\Etoc@currext}% - \csname tb@\@currext @after@hook\endcsname - \csname tocbasic@@after@hook\endcsname - }% end of after_toc -} -\let\etocscrbookstyle\etocscrartclstyle -\let\etocscrreprtstyle\etocscrartclstyle -\def\etocclasstocstyle{\etocarticlestyle} -\newcommand*\etocmarkboth[1]{% - \@mkboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}} -\newcommand*\etocmarkbothnouc[1]{\@mkboth{#1}{#1}} -\newcommand\etoctocstyle[3][section]{\etocmulticolstyle[#2]% - {\csname #1\endcsname *{#3}}} -\newcommand\etoctocstylewithmarks[4][section]{\etocmulticolstyle[#2]% - {\csname #1\endcsname *{#3\etocmarkboth{#4}}}} -\newcommand\etoctocstylewithmarksnouc[4][section]{\etocmulticolstyle[#2]% - {\csname #1\endcsname *{#3\etocmarkbothnouc{#4}}}} -\def\Etoc@redefetocstylesforchapters{% - \renewcommand\etoctocstylewithmarks[4][chapter]{% - \etocmulticolstyle[##2]{\csname ##1\endcsname *{##3\etocmarkboth{##4}}}% - } - \renewcommand\etoctocstylewithmarksnouc[4][chapter]{% - \etocmulticolstyle[##2]{\csname ##1\endcsname *{##3\etocmarkbothnouc{##4}}}% - } - \renewcommand\etoctocstyle[3][chapter]{% - \etocmulticolstyle[##2]{\csname ##1\endcsname *{##3}} - } -} -\@ifclassloaded{scrartcl} - {\renewcommand*\etocclasstocstyle{\etocscrartclstyle}}{} -\@ifclassloaded{book} - {\renewcommand*\etocfontone{\normalfont\normalsize} - \renewcommand*\etocclasstocstyle{\etocbookstyle} - \Etoc@redefetocstylesforchapters}{} -\@ifclassloaded{report} - {\renewcommand*\etocfontone{\normalfont\normalsize} - \renewcommand*\etocclasstocstyle{\etocreportstyle} - \Etoc@redefetocstylesforchapters}{} -\@ifclassloaded{scrbook} - {\renewcommand*\etocfontone{\normalfont\normalsize} - \renewcommand*\etocclasstocstyle{\etocscrbookstyle} - \Etoc@redefetocstylesforchapters}{} -\@ifclassloaded{scrreprt} - {\renewcommand*\etocfontone{\normalfont\normalsize} - \renewcommand*\etocclasstocstyle{\etocscrreprtstyle} - \Etoc@redefetocstylesforchapters}{} -\@ifclassloaded{memoir} - {\renewcommand*\etocfontone{\normalfont\normalsize} - \renewcommand*\etocclasstocstyle{\etocmemoirstyle} - \Etoc@redefetocstylesforchapters}{} -\def\etoctocloftstyle {% - \etocsettocstyle{% - \@cfttocstart - \par - \begingroup - \parindent\z@ \parskip\cftparskip - \@nameuse{@cftmake\Etoc@currext title}% - \ifEtoc@localtoc - \etoctocloftlocalperhapsaddtotoc\Etoc@currext - \else - \etocifisstarred {}{\ifEtoc@maintoctotoc\@cftdobibtoc\fi}% - \fi - }% - {% - \endgroup - \@cfttocfinish - }% -} -\def\etoctocloftlocalperhapsaddtotoc#1{% - \etocifisstarred - {}% - {\csname ifEtoc@local#1totoc\endcsname - \ifdefined\c@chapter\def\@tocextra{@section}\else\def\@tocextra{@subsection}\fi - \csname @cftdobib#1\endcsname - \fi - }% -} -\def\etoctocbibindstyle {% - \etocsettocstyle {% - \toc@start - \ifEtoc@localtoc - \@nameuse{etocclasslocal\Etoc@currext maketitle}% - \etocclasslocalperhapsaddtotoc\Etoc@currext - \else - \etoc@tocbibind@dotoctitle - \fi - }% - {\toc@finish}% -} -\def\etoc@tocbibind@dotoctitle {% - \if@bibchapter - \etocifisstarred - {\chapter*{\contentsname}\prw@mkboth{\contentsname} % id. - }% - {\ifEtoc@maintoctotoc - \toc@chapter{\contentsname} %<-space from original - \else - \chapter*{\contentsname}\prw@mkboth{\contentsname} % id. - \fi - }% - \else - \etocifisstarred - {\@nameuse{\@tocextra}*{\contentsname\prw@mkboth{\contentsname}} %<-space - } - {\ifEtoc@maintoctotoc - \toc@section{\@tocextra}{\contentsname} %<-space from original - \else - \@nameuse{\@tocextra}*{\contentsname\prw@mkboth{\contentsname}} % id. - \fi - }% - \fi -}% -\@ifclassloaded{memoir} -{} -{% memoir not loaded - \@ifpackageloaded{tocloft} - {\if@cftnctoc\else - \ifEtoc@keeporiginaltoc - \else - \AtBeginDocument{\let\tableofcontents\etoctableofcontents}% - \fi - \fi } - {\AtBeginDocument - {\@ifpackageloaded{tocloft} - {\if@cftnctoc\else - \PackageWarningNoLine {etoc} - {Package `tocloft' was loaded after `etoc'.\MessageBreak - To prevent it from overwriting \protect\tableofcontents, it will\MessageBreak - be tricked into believing to have been loaded with its\MessageBreak - option `titles'. \space But this will cause the `tocloft'\MessageBreak - customization of the titles of the main list of figures\MessageBreak - and list of tables to not apply either.\MessageBreak - You should load `tocloft' before `etoc'.}% - \AtEndDocument{\PackageWarning{etoc} - {Please load `tocloft' before `etoc'!\@gobbletwo}}% - \fi - \@cftnctoctrue }% - {}% - }% - }% -} -\@ifclassloaded{memoir} -{} -{% memoir not loaded - \AtBeginDocument{% - \@ifpackageloaded{tocloft} - {% - \def\etocclasstocstyle{% - \etoctocloftstyle - \Etoc@classstyletrue - }% - \ifEtoc@etocstyle - \ifEtoc@classstyle - \etocclasstocstyle - \Etoc@etocstyletrue - \fi - \else - \ifEtoc@classstyle - \etocclasstocstyle - \fi - \fi - }% - {% no tocloft - \@ifpackageloaded {tocbibind} - {\if@dotoctoc - \def\etocclasstocstyle{% - \etoctocbibindstyle - \Etoc@classstyletrue - }% - \ifEtoc@etocstyle - \ifEtoc@classstyle - \etocclasstocstyle - \Etoc@etocstyletrue - \fi - \else - \ifEtoc@classstyle - \etocclasstocstyle - \fi - \fi - \ifEtoc@keeporiginaltoc - \else - \let\tableofcontents\etoctableofcontents - \fi - }% - {}% - }% - \@ifpackageloaded{tocbibind} - {% tocbibind, perhaps with tocloft - \if@dotoctoc - \ifEtoc@keeporiginaltoc - \else - \let\tableofcontents\etoctableofcontents - \fi - \etocsetup{maintoctotoc,localtoctotoc}% - \PackageInfo{etoc}{% - Setting (or re-setting) the options `maintoctotoc' and\MessageBreak - `localtoctotoc' to true as tocbibind was detected and\MessageBreak - found to be configured for `TOC to toc'.\MessageBreak - Reported at begin document}% - \fi - \if@dotoclof - \ifEtoc@lof - \etocsetup{localloftotoc}% - \PackageInfo{etoc}{% - Setting (or re-setting) `localloftotoc=true' as the\MessageBreak - package tocbibind was detected and is configured for\MessageBreak - `LOF to toc'. Reported at begin document}% - \fi - \fi - \if@dotoclot - \ifEtoc@lot - \etocsetup{locallottotoc}% - \PackageInfo{etoc}{% - Setting (or re-setting) `locallottotoc=true' as the\MessageBreak - package tocbibind was detected and is configured for\MessageBreak - `LOT to toc'. Reported at begin document}% - \fi - \fi - }% end of tocbibind branch - {}% - }% end of at begin document -}% end of not with memoir branch -\def\Etoc@addtocontents #1#2{% - \addtocontents {toc}{% - \protect\contentsline{#1}{#2}{\thepage}{\ifEtoc@hyperref\@currentHref\fi}% - \ifdefined\protected@file@percent\protected@file@percent\fi - }% -} -\def\Etoc@addcontentsline@ #1#2#3{% - \@namedef{toclevel@#1}{#3}\addcontentsline {toc}{#1}{#2}% -} -\DeclareRobustCommand*{\etoctoccontentsline} - {\@ifstar{\Etoc@addcontentsline@}{\Etoc@addtocontents}} -\def\Etoc@addtocontents@immediately#1#2{% - \begingroup - \let\Etoc@originalwrite\write - \def\write{\immediate\Etoc@originalwrite}% - \Etoc@addtocontents{#1}{#2}% - \endgroup -} -\def\Etoc@addcontentsline@@immediately#1#2#3{% - \begingroup - \let\Etoc@originalwrite\write - \def\write{\immediate\Etoc@originalwrite}% - \Etoc@addcontentsline@{#1}{#2}{#3}% - \endgoroup -} -\DeclareRobustCommand*{\etocimmediatetoccontentsline} - {\@ifstar{\Etoc@addcontentsline@@immediately}{\Etoc@addtocontents@immediately}} -\def\Etoc@storetocdepth {\xdef\Etoc@savedtocdepth{\number\c@tocdepth}} -\def\Etoc@restoretocdepth {\global\c@tocdepth\Etoc@savedtocdepth\relax} -\def\etocobeytoctocdepth {\def\etoc@settocdepth - {\afterassignment\Etoc@@nottoodeep \global\c@tocdepth}} -\def\Etoc@@nottoodeep {\ifnum\Etoc@savedtocdepth<\c@tocdepth - \global\c@tocdepth\Etoc@savedtocdepth\relax\fi } -\def\etocignoretoctocdepth {\let\etoc@settocdepth\@gobble } -\def\etocsettocdepth {\futurelet\Etoc@nexttoken\Etoc@set@tocdepth } -\def\Etoc@set@tocdepth {\ifx\Etoc@nexttoken\bgroup - \expandafter\Etoc@set@tocdepth@ - \else\expandafter\Etoc@set@toctocdepth - \fi } -\def\Etoc@set@tocdepth@ #1{\@ifundefined {Etoc@#1@@} - {\PackageWarning{etoc} - {Unknown sectioning unit #1, \protect\etocsettocdepth\space ignored}} - {\global\c@tocdepth\csname Etoc@#1@@\endcsname}% -} -\def\Etoc@set@toctocdepth #1#{\Etoc@set@toctocdepth@ } -\def\Etoc@set@toctocdepth@ #1{% - \@ifundefined{Etoc@#1@@}% - {\PackageWarning{etoc} - {Unknown sectioning depth #1, \protect\etocsettocdepth.toc ignored}}% - {\addtocontents {toc} - {\protect\etoc@settocdepth\expandafter\protect\csname Etoc@#1@@\endcsname}}% -} -\def\etocimmediatesettocdepth #1#{\Etoc@set@toctocdepth@immediately} -\def\Etoc@set@toctocdepth@immediately #1{% - \@ifundefined{Etoc@#1@@}% - {\PackageWarning{etoc} - {Unknown sectioning depth #1, \protect\etocimmediatesettocdepth.toc ignored}}% - {\begingroup - \let\Etoc@originalwrite\write - \def\write{\immediate\Etoc@originalwrite}% - \addtocontents {toc} - {\protect\etoc@settocdepth\expandafter\protect - \csname Etoc@#1@@\endcsname}% - \endgroup - }% -} -\def\etocdepthtag #1#{\Etoc@depthtag } -\def\Etoc@depthtag #1{\addtocontents {toc}{\protect\etoc@depthtag {#1}}} -\def\etocimmediatedepthtag #1#{\Etoc@depthtag@immediately } -\def\Etoc@depthtag@immediately #1{% - \begingroup - \let\Etoc@originalwrite\write - \def\write{\immediate\Etoc@originalwrite}% - \addtocontents {toc}{\protect\etoc@depthtag {#1}}% - \endgroup -} -\def\etocignoredepthtags {\let\etoc@depthtag \@gobble } -\def\etocobeydepthtags {\let\etoc@depthtag \Etoc@depthtag@ } -\def\Etoc@depthtag@ #1{\@ifundefined{Etoc@depthof@#1}% - {}% ignore in silence if tag has no associated depth - {\afterassignment\Etoc@@nottoodeep - \global\c@tocdepth\csname Etoc@depthof@#1\endcsname}% -} -\def\etocsettagdepth #1#2{\@ifundefined{Etoc@#2@@}% - {\PackageWarning{etoc} - {Unknown sectioning depth #2, \protect\etocsettagdepth\space ignored}}% - {\@namedef{Etoc@depthof@#1}{\@nameuse{Etoc@#2@@}}}% -} -\def\Etoc@tocvsec@err #1{\PackageError {etoc} - {The command \protect#1\space is incompatible with `etoc'} - {Use \protect\etocsettocdepth.toc as replacement}% -}% -\AtBeginDocument {% - \@ifclassloaded{memoir} - {\PackageInfo {etoc} - {Regarding `memoir' class command \protect\settocdepth, consider\MessageBreak - \protect\etocsettocdepth.toc as a drop-in replacement with more\MessageBreak - capabilities (see `etoc' manual). \space - Also, \protect\etocsettocdepth\MessageBreak - and \protect\etocsetnexttocdepth\space should be used in place of\MessageBreak - `memoir' command \protect\maxtocdepth\@gobble}% - }% - {\@ifpackageloaded {tocvsec2}{% - \def\maxtocdepth #1{\Etoc@tocvsec@err \maxtocdepth }% - \def\settocdepth #1{\Etoc@tocvsec@err \settocdepth }% - \def\resettocdepth {\@ifstar {\Etoc@tocvsec@err \resettocdepth }% - {\Etoc@tocvsec@err \resettocdepth }% - }% - \def\save@tocdepth #1#2#3{}% - \let\reset@tocdepth\relax - \let\remax@tocdepth\relax - \let\tableofcontents\etoctableofcontents - \PackageWarningNoLine {etoc} - {Package `tocvsec2' detected and its modification of\MessageBreak - \protect\tableofcontents\space reverted. \space Use - \protect\etocsettocdepth.toc\MessageBreak as a replacement - for `tocvsec2' toc-related commands}% - }% tocvsec2 loaded - {}% tocvsec2 not loaded - }% -}% -\def\invisibletableofcontents {\etocsetnexttocdepth {-3}\tableofcontents }% -\def\invisiblelocaltableofcontents - {\etocsetnexttocdepth {-3}\localtableofcontents }% -\def\etocsetnexttocdepth #1{% - \@ifundefined{Etoc@#1@@} - {\PackageWarning{etoc} - {Unknown sectioning unit #1, \protect\etocsetnextocdepth\space ignored}} - {\Etoc@setnexttocdepth{\csname Etoc@#1@@\endcsname}}% -}% -\def\Etoc@setnexttocdepth#1{% - \def\Etoc@tocdepthset{% - \Etoc@tocdepthreset - \edef\Etoc@tocdepthreset {% - \global\c@tocdepth\the\c@tocdepth\space - \global\let\noexpand\Etoc@tocdepthreset\noexpand\@empty - }% - \global\c@tocdepth#1% - \global\let\Etoc@tocdepthset\@empty - }% -}% -\let\Etoc@tocdepthreset\@empty -\let\Etoc@tocdepthset \@empty -\def\etocsetlocaltop #1#{\Etoc@set@localtop}% -\def\Etoc@set@localtop #1{% - \@ifundefined{Etoc@#1@@}% - {\PackageWarning{etoc} - {Unknown sectioning depth #1, \protect\etocsetlocaltop.toc ignored}}% - {\addtocontents {toc} - {\protect\etoc@setlocaltop\expandafter\protect\csname Etoc@#1@@\endcsname}}% -}% -\def\etocimmediatesetlocaltop #1#{\Etoc@set@localtop@immediately}% -\def\Etoc@set@localtop@immediately #1{% - \@ifundefined{Etoc@#1@@}% - {\PackageWarning{etoc} - {Unknown sectioning depth #1, \protect\etocimmediatesetlocaltop.toc ignored}}% - {\begingroup - \let\Etoc@originalwrite\write - \def\write{\immediate\Etoc@originalwrite}% - \addtocontents {toc} - {\protect\etoc@setlocaltop\expandafter\protect - \csname Etoc@#1@@\endcsname}% - \endgroup - }% -}% -\def\etoc@setlocaltop #1{% - \ifnum#1=\Etoc@maxlevel - \Etoc@skipthisonetrue - \else - \Etoc@skipthisonefalse - \global\let\Etoc@level #1% - \global\let\Etoc@virtualtop #1% - \ifEtoc@localtoc - \ifEtoc@stoptoc - \Etoc@skipthisonetrue - \else - \ifEtoc@notactive - \Etoc@skipthisonetrue - \else - \unless\ifnum\Etoc@level>\etoclocaltop - \Etoc@skipthisonetrue - \global\Etoc@stoptoctrue - \fi - \fi - \fi - \fi - \fi - \let\Etoc@next\@empty - \ifEtoc@skipthisone - \else - \ifnum\Etoc@level>\c@tocdepth - \else - \ifEtoc@standardlines - \else - \let\Etoc@next\Etoc@setlocaltop@doendsandbegin - \fi - \fi - \fi - \Etoc@next -}% -\def\Etoc@setlocaltop@doendsandbegin{% - \Etoc@doendsandbegin - \global\Etoc@skipprefixfalse -} -\addtocontents {toc}{\protect\@ifundefined{etoctocstyle}% - {\let\protect\etoc@startlocaltoc\protect\@gobble - \let\protect\etoc@settocdepth\protect\@gobble - \let\protect\etoc@depthtag\protect\@gobble - \let\protect\etoc@setlocaltop\protect\@gobble}{}}% -\def\etocstandardlines {\Etoc@standardlinestrue} -\def\etoctoclines {\Etoc@standardlinesfalse} -\etocdefaultlines -\etocstandardlines -\def\etocstandarddisplaystyle{% - \PackageWarningNoLine{etoc}{% - \string\etocstandarddisplaystyle \on@line\MessageBreak - is deprecated. \space Please use \string\etocclasstocstyle}% -} -\expandafter\def\expandafter\etocclasstocstyle\expandafter{% - \etocclasstocstyle - \Etoc@classstyletrue -} -\def\etocetoclocaltocstyle{\Etoc@etocstyletrue} -\def\etocusertocstyle{\Etoc@etocstylefalse} -\etocclasstocstyle -\etocetoclocaltocstyle -\etocobeytoctocdepth -\etocobeydepthtags -\let\etocbeforetitlehook \@empty -\let\etocaftertitlehook \@empty -\let\etocaftercontentshook \@empty -\let\etocaftertochook \@empty -\def\etockeeporiginaltableofcontents - {\Etoc@keeporiginaltoctrue\let\tableofcontents\etocoriginaltableofcontents}% -\endinput -%% -%% End of file `etoc.sty'. diff --git a/docs/latex/files.tex b/docs/latex/files.tex deleted file mode 100644 index 2133aa5..0000000 --- a/docs/latex/files.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{File List} -Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot_8h}{ciot.\+h}} }{\pageref{ciot_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__ble_8h}{ciot\+\_\+ble.\+h}} \\*Defines functions and types for CIOT Bluetooth Low Energy (BLE) module }{\pageref{ciot__ble_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__ble__scn_8h}{ciot\+\_\+ble\+\_\+scn.\+h}} \\*Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner }{\pageref{ciot__ble__scn_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__bridge_8h}{ciot\+\_\+bridge.\+h}} \\*Defines functions and types for CIOT Bridge module }{\pageref{ciot__bridge_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__common__types_8h}{ciot\+\_\+common\+\_\+types.\+h}} \\*Defines common types used in CIOT modules }{\pageref{ciot__common__types_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__config_8h}{ciot\+\_\+config.\+h}} \\*Configuration options for the CIOT library }{\pageref{ciot__config_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__crc_8h}{ciot\+\_\+crc.\+h}} }{\pageref{ciot__crc_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__default_8h}{ciot\+\_\+default.\+h}} \\*Default configuration options for CIOT library }{\pageref{ciot__default_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__dfu_8h}{ciot\+\_\+dfu.\+h}} \\*Header file for Device Firmware Update (DFU) functionality in CIOT library }{\pageref{ciot__dfu_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__err_8h}{ciot\+\_\+err.\+h}} \\*Header file for CIOT error handling }{\pageref{ciot__err_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__eth_8h}{ciot\+\_\+eth.\+h}} \\*Header file for CIOT Ethernet interface }{\pageref{ciot__eth_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__gpio_8h}{ciot\+\_\+gpio.\+h}} \\*Header file for CIOT GPIO interface }{\pageref{ciot__gpio_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__httpc_8h}{ciot\+\_\+httpc.\+h}} \\*Header file for CIOT HTTP client interface }{\pageref{ciot__httpc_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__https_8h}{ciot\+\_\+https.\+h}} \\*Header file for CIOT HTTP server interface }{\pageref{ciot__https_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}} \\*Header file for the CIOT interface }{\pageref{ciot__iface_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__ifaces_8h}{ciot\+\_\+ifaces.\+h}} \\*Header file for CIOT interfaces }{\pageref{ciot__ifaces_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__lib_8h}{ciot\+\_\+lib.\+h}} \\*CioT library header file }{\pageref{ciot__lib_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__log_8h}{ciot\+\_\+log.\+h}} \\*Header file for CIOT logging functionality }{\pageref{ciot__log_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__mqttc_8h}{ciot\+\_\+mqttc.\+h}} }{\pageref{ciot__mqttc_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__nrf__dfu_8h}{ciot\+\_\+nrf\+\_\+dfu.\+h}} \\*Header file for CIOT Nordic DFU functionality }{\pageref{ciot__nrf__dfu_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__ntp_8h}{ciot\+\_\+ntp.\+h}} \\*Header file for CIOT NTP (Network Time Protocol) functionality }{\pageref{ciot__ntp_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__opcuas_8h}{ciot\+\_\+opcuas.\+h}} \\*Header file for CIOT OPC UA Server (OPCUAS) functionality }{\pageref{ciot__opcuas_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__ota_8h}{ciot\+\_\+ota.\+h}} \\*Header file for CIOT OTA (Over-\/the-\/\+Air) functionality }{\pageref{ciot__ota_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__s_8h}{ciot\+\_\+s.\+h}} \\*Header file for CIOT\+\_\+S (Communication Interface Over Transport) module }{\pageref{ciot__s_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__serializer_8h}{ciot\+\_\+serializer.\+h}} \\*Header file for CIOT Serializer module }{\pageref{ciot__serializer_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__slip_8h}{ciot\+\_\+slip.\+h}} \\*This module encodes and decodes SLIP packages }{\pageref{ciot__slip_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__storage_8h}{ciot\+\_\+storage.\+h}} \\*Header file for CIOT Storage module }{\pageref{ciot__storage_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__sys_8h}{ciot\+\_\+sys.\+h}} \\*Header file for CIOT System module }{\pageref{ciot__sys_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__tcp_8h}{ciot\+\_\+tcp.\+h}} \\*Header file for CIOT TCP module }{\pageref{ciot__tcp_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__timer_8h}{ciot\+\_\+timer.\+h}} \\*Header file for CIOT timer module }{\pageref{ciot__timer_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__uart_8h}{ciot\+\_\+uart.\+h}} \\*Header file for CIOT UART module }{\pageref{ciot__uart_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__usb_8h}{ciot\+\_\+usb.\+h}} \\*Header file for CIOT USB module }{\pageref{ciot__usb_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__utils_8h}{ciot\+\_\+utils.\+h}} }{\pageref{ciot__utils_8h}}{} -\item\contentsline{section}{include/\mbox{\hyperlink{ciot__wifi_8h}{ciot\+\_\+wifi.\+h}} \\*Header file for CIOT Wi-\/\+Fi module }{\pageref{ciot__wifi_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}} \\*Defines data types and structures for CIOT BLE SCN }{\pageref{ciot__ble__scn__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}} \\*Defines data types and structures for CIOT BLE }{\pageref{ciot__ble__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}} \\*Defines data types and structures for CIOT bridge }{\pageref{ciot__bridge__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}} }{\pageref{ciot__data__model__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}} \\*Defines data types and structures for CIOT DFU (Device Firmware Update) }{\pageref{ciot__dfu__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}} \\*Defines data types and structures for CIOT GPIO (General Purpose Input/\+Output) }{\pageref{ciot__gpio__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}} \\*Defines data types and structures for CIOT HTTP client }{\pageref{ciot__httpc__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}} \\*Defines data types and structures for CIOT HTTP server }{\pageref{ciot__https__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}} \\*Defines data types and structures for CIOT MQTT client }{\pageref{ciot__mqttc__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}} \\*Defines data types and structures for CIOT messaging }{\pageref{ciot__msg__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}} \\*Defines data types and structures for CIOT NTP functionality }{\pageref{ciot__ntp__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}} \\*Defines data types and structures for CIOT OPC UA Server functionality }{\pageref{ciot__opcuas__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}} \\*Defines data types and structures for CIOT Over-\/\+The-\/\+Air (OTA) functionality }{\pageref{ciot__ota__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}} \\*Defines data types and structures for CIOT storage functionality }{\pageref{ciot__storage__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}} \\*Defines data types and structures for CIOT system functionality }{\pageref{ciot__sys__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}} \\*Defines data types and structures for CIOT TCP functionality }{\pageref{ciot__tcp__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}} \\*Defines types and structures for CIOT functionality }{\pageref{ciot__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}} \\*Defines data structures and types for CIOT UART functionality }{\pageref{ciot__uart__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}} \\*Defines data structures and types for CIOT USB functionality }{\pageref{ciot__usb__types_8h}}{} -\item\contentsline{section}{include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}} \\*Defines data structures and types for CIOT Wi\+Fi functionality }{\pageref{ciot__wifi__types_8h}}{} -\end{DoxyCompactList} diff --git a/docs/latex/group___common.tex b/docs/latex/group___common.tex deleted file mode 100644 index be02a87..0000000 --- a/docs/latex/group___common.tex +++ /dev/null @@ -1,21 +0,0 @@ -\doxysection{constants} -\hypertarget{group___common}{}\label{group___common}\index{constants@{constants}} - - -Header file for CIOT error handling. - - -Header file for CIOT error handling. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/09 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} diff --git a/docs/latex/group___hardware.tex b/docs/latex/group___hardware.tex deleted file mode 100644 index 77f4563..0000000 --- a/docs/latex/group___hardware.tex +++ /dev/null @@ -1,21 +0,0 @@ -\doxysection{interfaces} -\hypertarget{group___hardware}{}\label{group___hardware}\index{interfaces@{interfaces}} - - -Header file for CIOT Ethernet interface. - - -Header file for CIOT Ethernet interface. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/10-\/17 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} diff --git a/docs/latex/group___software.tex b/docs/latex/group___software.tex deleted file mode 100644 index d03d20c..0000000 --- a/docs/latex/group___software.tex +++ /dev/null @@ -1,37 +0,0 @@ -\doxysection{interfaces} -\hypertarget{group___software}{}\label{group___software}\index{interfaces@{interfaces}} - - -Defines functions and types for CIOT Bridge module. - - -Defines functions and types for CIOT Bridge module. - -Header file for Device Firmware Update (DFU) functionality in CIOT library. - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2023-\/11-\/13 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2023 -\end{DoxyCopyright} - - -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/03-\/20 -\end{DoxyDate} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} diff --git a/docs/latex/group___utils.tex b/docs/latex/group___utils.tex deleted file mode 100644 index 54f4048..0000000 --- a/docs/latex/group___utils.tex +++ /dev/null @@ -1,14 +0,0 @@ -\doxysection{Utils} -\hypertarget{group___utils}{}\label{group___utils}\index{Utils@{Utils}} -\begin{DoxyAuthor}{Author} -Wesley Santos (\href{mailto:wesleypro37@gmail.com}{\texttt{ wesleypro37@gmail.\+com}}) -\end{DoxyAuthor} -\begin{DoxyVersion}{Version} -0.\+1 -\end{DoxyVersion} -\begin{DoxyDate}{Date} -2024-\/04-\/19 -\end{DoxyDate} -\begin{DoxyCopyright}{Copyright} -Copyright (c) 2024 -\end{DoxyCopyright} diff --git a/docs/latex/group__hardware__interfaces.tex b/docs/latex/group__hardware__interfaces.tex deleted file mode 100644 index 7800ca2..0000000 --- a/docs/latex/group__hardware__interfaces.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{Hardware\+\_\+interfaces} -\hypertarget{group__hardware__interfaces}{}\label{group__hardware__interfaces}\index{Hardware\_interfaces@{Hardware\_interfaces}} - - -Interfaces that implements hardware resources. - - -\doxysubsubsection*{Files} -\begin{DoxyCompactItemize} -\item -file \mbox{\hyperlink{ciot__ble_8h}{ciot\+\_\+ble.\+h}} -\begin{DoxyCompactList}\small\item\em Defines functions and types for CIOT Bluetooth Low Energy (BLE) module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ble__scn_8h}{ciot\+\_\+ble\+\_\+scn.\+h}} -\begin{DoxyCompactList}\small\item\em Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__eth_8h}{ciot\+\_\+eth.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Ethernet interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__gpio_8h}{ciot\+\_\+gpio.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT GPIO interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__storage_8h}{ciot\+\_\+storage.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Storage module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__tcp_8h}{ciot\+\_\+tcp.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT TCP module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__uart_8h}{ciot\+\_\+uart.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT UART module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__usb_8h}{ciot\+\_\+usb.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT USB module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__wifi_8h}{ciot\+\_\+wifi.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Wi-\/\+Fi module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Interfaces that implements hardware resources. - diff --git a/docs/latex/group__hardware__types.tex b/docs/latex/group__hardware__types.tex deleted file mode 100644 index 1dfabca..0000000 --- a/docs/latex/group__hardware__types.tex +++ /dev/null @@ -1,31 +0,0 @@ -\doxysection{Hardware\+\_\+types} -\hypertarget{group__hardware__types}{}\label{group__hardware__types}\index{Hardware\_types@{Hardware\_types}} - - -Types definitions of hardware resources. - - -\doxysubsubsection*{Files} -\begin{DoxyCompactItemize} -\item -file \mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT BLE SCN. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT BLE. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT GPIO (General Purpose Input/\+Output). \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT storage functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT TCP functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data structures and types for CIOT UART functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data structures and types for CIOT USB functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data structures and types for CIOT Wi\+Fi functionality. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Types definitions of hardware resources. - diff --git a/docs/latex/group__slip.tex b/docs/latex/group__slip.tex deleted file mode 100644 index 7320ab5..0000000 --- a/docs/latex/group__slip.tex +++ /dev/null @@ -1,126 +0,0 @@ -\doxysection{SLIP encoding and decoding} -\hypertarget{group__slip}{}\label{group__slip}\index{SLIP encoding and decoding@{SLIP encoding and decoding}} - - -This module encodes and decodes SLIP packages. - - -\doxysubsubsection*{Data Structures} -\begin{DoxyCompactItemize} -\item -struct \mbox{\hyperlink{structciot__slip__t}{ciot\+\_\+slip\+\_\+t}} -\begin{DoxyCompactList}\small\item\em Representation of a SLIP packet. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Enumerations} -\begin{DoxyCompactItemize} -\item -enum \mbox{\hyperlink{group__slip_ga290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}} \{ \mbox{\hyperlink{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+DECODING}} -, \mbox{\hyperlink{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+ESC\+\_\+\+RECEIVED}} -, \mbox{\hyperlink{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+CLEARING\+\_\+\+INVALID\+\_\+\+PACKET}} - \} -\begin{DoxyCompactList}\small\item\em Status information that is used while receiving and decoding a packet. \end{DoxyCompactList}\end{DoxyCompactItemize} -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -int \mbox{\hyperlink{group__slip_ga31ccb83d79170663a4a74c3a073b6d45}{ciot\+\_\+slip\+\_\+encode}} (uint8\+\_\+t \texorpdfstring{$\ast$}{*}p\+\_\+output, uint8\+\_\+t \texorpdfstring{$\ast$}{*}p\+\_\+input, uint32\+\_\+t input\+\_\+length, uint32\+\_\+t \texorpdfstring{$\ast$}{*}p\+\_\+output\+\_\+buffer\+\_\+length) -\begin{DoxyCompactList}\small\item\em Function for encoding a SLIP packet. \end{DoxyCompactList}\item -int \mbox{\hyperlink{group__slip_ga13b065e0e7ef6b2b98aa59e136929654}{ciot\+\_\+slip\+\_\+decode\+\_\+add\+\_\+byte}} (\mbox{\hyperlink{structciot__slip__t}{ciot\+\_\+slip\+\_\+t}} \texorpdfstring{$\ast$}{*}p\+\_\+slip, uint8\+\_\+t c) -\begin{DoxyCompactList}\small\item\em Function for decoding a SLIP packet. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -This module encodes and decodes SLIP packages. - -The SLIP protocol is described in @link\+SLIP. - -\doxysubsection{Enumeration Type Documentation} -\Hypertarget{group__slip_ga290de618dbd8ce83c3c43ec2e9c393a1}\label{group__slip_ga290de618dbd8ce83c3c43ec2e9c393a1} -\index{SLIP encoding and decoding@{SLIP encoding and decoding}!ciot\_slip\_read\_state\_t@{ciot\_slip\_read\_state\_t}} -\index{ciot\_slip\_read\_state\_t@{ciot\_slip\_read\_state\_t}!SLIP encoding and decoding@{SLIP encoding and decoding}} -\doxysubsubsection{\texorpdfstring{ciot\_slip\_read\_state\_t}{ciot\_slip\_read\_state\_t}} -{\footnotesize\ttfamily enum \mbox{\hyperlink{group__slip_ga290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}}} - - - -Status information that is used while receiving and decoding a packet. - -\begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SLIP\_STATE\_DECODING@{CIOT\_SLIP\_STATE\_DECODING}!SLIP encoding and decoding@{SLIP encoding and decoding}}\index{SLIP encoding and decoding@{SLIP encoding and decoding}!CIOT\_SLIP\_STATE\_DECODING@{CIOT\_SLIP\_STATE\_DECODING}}}\Hypertarget{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e}\label{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e} -CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+DECODING&Ready to receive the next byte. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SLIP\_STATE\_ESC\_RECEIVED@{CIOT\_SLIP\_STATE\_ESC\_RECEIVED}!SLIP encoding and decoding@{SLIP encoding and decoding}}\index{SLIP encoding and decoding@{SLIP encoding and decoding}!CIOT\_SLIP\_STATE\_ESC\_RECEIVED@{CIOT\_SLIP\_STATE\_ESC\_RECEIVED}}}\Hypertarget{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834}\label{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1af7e80dc7da481b7a5541ba44c10a1834} -CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+ESC\+\_\+\+RECEIVED&An ESC byte has been received and the next byte must be decoded differently. \\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET@{CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET}!SLIP encoding and decoding@{SLIP encoding and decoding}}\index{SLIP encoding and decoding@{SLIP encoding and decoding}!CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET@{CIOT\_SLIP\_STATE\_CLEARING\_INVALID\_PACKET}}}\Hypertarget{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06}\label{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06} -CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+CLEARING\+\_\+\+INVALID\+\_\+\+PACKET&The received data is invalid and transfer must be restarted. \\ -\hline - -\end{DoxyEnumFields} - - -\doxysubsection{Function Documentation} -\Hypertarget{group__slip_ga13b065e0e7ef6b2b98aa59e136929654}\label{group__slip_ga13b065e0e7ef6b2b98aa59e136929654} -\index{SLIP encoding and decoding@{SLIP encoding and decoding}!ciot\_slip\_decode\_add\_byte@{ciot\_slip\_decode\_add\_byte}} -\index{ciot\_slip\_decode\_add\_byte@{ciot\_slip\_decode\_add\_byte}!SLIP encoding and decoding@{SLIP encoding and decoding}} -\doxysubsubsection{\texorpdfstring{ciot\_slip\_decode\_add\_byte()}{ciot\_slip\_decode\_add\_byte()}} -{\footnotesize\ttfamily int ciot\+\_\+slip\+\_\+decode\+\_\+add\+\_\+byte (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structciot__slip__t}{ciot\+\_\+slip\+\_\+t}} \texorpdfstring{$\ast$}{*}}]{p\+\_\+slip, }\item[{uint8\+\_\+t}]{c }\end{DoxyParamCaption})} - - - -Function for decoding a SLIP packet. - -The decoded packet is put into {\ttfamily p\+\_\+slip\+::p\+\_\+buffer}. The index and buffer state is updated. - -Ensure that {\ttfamily p\+\_\+slip} is properly initialized. The initial state must be set to \doxylink{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a6eac8f93f0b78328812025bc26c2515e}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+DECODING}. - - -\begin{DoxyParams}[1]{Parameters} -\mbox{\texttt{ in,out}} & {\em p\+\_\+slip} & State of the decoding process. \\ -\hline -\mbox{\texttt{ in}} & {\em c} & Byte to decode.\\ -\hline -\end{DoxyParams} - -\begin{DoxyRetVals}{Return values} -{\em NRF\+\_\+\+SUCCESS} & If a packet has been parsed. The received packet can be retrieved from {\ttfamily p\+\_\+slip}. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+NULL} & If {\ttfamily p\+\_\+slip} is NULL. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+NO\+\_\+\+MEM} & If there is no more room in the buffer provided by {\ttfamily p\+\_\+slip}. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+BUSY} & If the packet has not been parsed completely yet. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+INVALID\+\_\+\+DATA} & If the packet is encoded wrong. In this case, {\ttfamily p\+\_\+slip\+::state} is set to \doxylink{group__slip_gga290de618dbd8ce83c3c43ec2e9c393a1a788289583399742eda50d8bd9e88fb06}{CIOT\+\_\+\+SLIP\+\_\+\+STATE\+\_\+\+CLEARING\+\_\+\+INVALID\+\_\+\+PACKET}, and decoding will stay in this state until the END byte is received. \\ -\hline -\end{DoxyRetVals} -\Hypertarget{group__slip_ga31ccb83d79170663a4a74c3a073b6d45}\label{group__slip_ga31ccb83d79170663a4a74c3a073b6d45} -\index{SLIP encoding and decoding@{SLIP encoding and decoding}!ciot\_slip\_encode@{ciot\_slip\_encode}} -\index{ciot\_slip\_encode@{ciot\_slip\_encode}!SLIP encoding and decoding@{SLIP encoding and decoding}} -\doxysubsubsection{\texorpdfstring{ciot\_slip\_encode()}{ciot\_slip\_encode()}} -{\footnotesize\ttfamily int ciot\+\_\+slip\+\_\+encode (\begin{DoxyParamCaption}\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{p\+\_\+output, }\item[{uint8\+\_\+t \texorpdfstring{$\ast$}{*}}]{p\+\_\+input, }\item[{uint32\+\_\+t}]{input\+\_\+length, }\item[{uint32\+\_\+t \texorpdfstring{$\ast$}{*}}]{p\+\_\+output\+\_\+buffer\+\_\+length }\end{DoxyParamCaption})} - - - -Function for encoding a SLIP packet. - -The maximum size of the output data is (2\texorpdfstring{$\ast$}{*}input size + 1) bytes. Ensure that the provided buffer is large enough. - - -\begin{DoxyParams}[1]{Parameters} -\mbox{\texttt{ in,out}} & {\em p\+\_\+output} & The buffer where the encoded SLIP packet is stored. Ensure that it is large enough. \\ -\hline -\mbox{\texttt{ in,out}} & {\em p\+\_\+input} & The buffer to be encoded. \\ -\hline -\mbox{\texttt{ in,out}} & {\em input\+\_\+length} & The length of the input buffer. \\ -\hline -\mbox{\texttt{ out}} & {\em p\+\_\+output\+\_\+buffer\+\_\+length} & The length of the output buffer after the input has been encoded.\\ -\hline -\end{DoxyParams} - -\begin{DoxyRetVals}{Return values} -{\em NRF\+\_\+\+SUCCESS} & If the input was successfully encoded into output. \\ -\hline -{\em NRF\+\_\+\+ERROR\+\_\+\+NULL} & If one of the provided parameters is NULL. \\ -\hline -\end{DoxyRetVals} diff --git a/docs/latex/group__software__interfaces.tex b/docs/latex/group__software__interfaces.tex deleted file mode 100644 index 6f82239..0000000 --- a/docs/latex/group__software__interfaces.tex +++ /dev/null @@ -1,31 +0,0 @@ -\doxysection{Software\+\_\+interfaces} -\hypertarget{group__software__interfaces}{}\label{group__software__interfaces}\index{Software\_interfaces@{Software\_interfaces}} - - -Interfaces that implements software resources. - - -\doxysubsubsection*{Files} -\begin{DoxyCompactItemize} -\item -file \mbox{\hyperlink{ciot__bridge_8h}{ciot\+\_\+bridge.\+h}} -\begin{DoxyCompactList}\small\item\em Defines functions and types for CIOT Bridge module. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__dfu_8h}{ciot\+\_\+dfu.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for Device Firmware Update (DFU) functionality in CIOT library. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__https_8h}{ciot\+\_\+https.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT HTTP server interface. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__nrf__dfu_8h}{ciot\+\_\+nrf\+\_\+dfu.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT Nordic DFU functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ntp_8h}{ciot\+\_\+ntp.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT NTP (Network Time Protocol) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__opcuas_8h}{ciot\+\_\+opcuas.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT OPC UA Server (OPCUAS) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ota_8h}{ciot\+\_\+ota.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT OTA (Over-\/the-\/\+Air) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__sys_8h}{ciot\+\_\+sys.\+h}} -\begin{DoxyCompactList}\small\item\em Header file for CIOT System module. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Interfaces that implements software resources. - diff --git a/docs/latex/group__software__types.tex b/docs/latex/group__software__types.tex deleted file mode 100644 index a0d6b6c..0000000 --- a/docs/latex/group__software__types.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{Software\+\_\+types} -\hypertarget{group__software__types}{}\label{group__software__types}\index{Software\_types@{Software\_types}} - - -Types definitions of software resources. - - -\doxysubsubsection*{Files} -\begin{DoxyCompactItemize} -\item -file \mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT bridge. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT DFU (Device Firmware Update). \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT HTTP client. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT HTTP server. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT MQTT client. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT NTP functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT OPC UA Server functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT Over-\/\+The-\/\+Air (OTA) functionality. \end{DoxyCompactList}\item -file \mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}} -\begin{DoxyCompactList}\small\item\em Defines data types and structures for CIOT system functionality. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Types definitions of software resources. - diff --git a/docs/latex/group__uart__apis.tex b/docs/latex/group__uart__apis.tex deleted file mode 100644 index 4e216a6..0000000 --- a/docs/latex/group__uart__apis.tex +++ /dev/null @@ -1,162 +0,0 @@ -\doxysection{, uart configuration and communication related apis} -\hypertarget{group__uart__apis}{}\label{group__uart__apis}\index{, uart configuration and communication related apis@{, uart configuration and communication related apis}} - - -uart apis - - -\doxysubsubsection*{Functions} -\begin{DoxyCompactItemize} -\item -uint32\+\_\+t \mbox{\hyperlink{group__uart__apis_gad020e1771e2ff7a25a068ccc1b3d1331}{ciot\+\_\+crc32\+\_\+le}} (uint32\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC32 value that is in little endian. \end{DoxyCompactList}\item -uint32\+\_\+t \mbox{\hyperlink{group__uart__apis_gaeed9b1c0c84b16c8e4e4b65be0787ae4}{ciot\+\_\+crc32\+\_\+be}} (uint32\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC32 value that is in big endian. \end{DoxyCompactList}\item -uint16\+\_\+t \mbox{\hyperlink{group__uart__apis_ga73a6ce791d6f000bad7ee2eedd0d8350}{ciot\+\_\+crc16\+\_\+le}} (uint16\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC16 value that is in little endian. \end{DoxyCompactList}\item -uint16\+\_\+t \mbox{\hyperlink{group__uart__apis_ga5d59ce0d0ffe65eaf7944d695bde59e3}{ciot\+\_\+crc16\+\_\+be}} (uint16\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC16 value that is in big endian. \end{DoxyCompactList}\item -uint8\+\_\+t \mbox{\hyperlink{group__uart__apis_ga39da2d632baf462933f90f3fbe7a63e7}{ciot\+\_\+crc8\+\_\+le}} (uint8\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC8 value that is in little endian. \end{DoxyCompactList}\item -uint8\+\_\+t \mbox{\hyperlink{group__uart__apis_gae831c4d3ed93d649df5ed07e5b9d1c46}{ciot\+\_\+crc8\+\_\+be}} (uint8\+\_\+t crc, uint8\+\_\+t const \texorpdfstring{$\ast$}{*}buf, uint32\+\_\+t len) -\begin{DoxyCompactList}\small\item\em CRC8 value that is in big endian. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -uart apis - - - -\doxysubsection{Function Documentation} -\Hypertarget{group__uart__apis_ga5d59ce0d0ffe65eaf7944d695bde59e3}\label{group__uart__apis_ga5d59ce0d0ffe65eaf7944d695bde59e3} -\index{, uart configuration and communication related apis@{, uart configuration and communication related apis}!ciot\_crc16\_be@{ciot\_crc16\_be}} -\index{ciot\_crc16\_be@{ciot\_crc16\_be}!, uart configuration and communication related apis@{, uart configuration and communication related apis}} -\doxysubsubsection{\texorpdfstring{ciot\_crc16\_be()}{ciot\_crc16\_be()}} -{\footnotesize\ttfamily uint16\+\_\+t ciot\+\_\+crc16\+\_\+be (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC16 value that is in big endian. - - -\begin{DoxyParams}{Parameters} -{\em uint16\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{group__uart__apis_ga73a6ce791d6f000bad7ee2eedd0d8350}\label{group__uart__apis_ga73a6ce791d6f000bad7ee2eedd0d8350} -\index{, uart configuration and communication related apis@{, uart configuration and communication related apis}!ciot\_crc16\_le@{ciot\_crc16\_le}} -\index{ciot\_crc16\_le@{ciot\_crc16\_le}!, uart configuration and communication related apis@{, uart configuration and communication related apis}} -\doxysubsubsection{\texorpdfstring{ciot\_crc16\_le()}{ciot\_crc16\_le()}} -{\footnotesize\ttfamily uint16\+\_\+t ciot\+\_\+crc16\+\_\+le (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC16 value that is in little endian. - - -\begin{DoxyParams}{Parameters} -{\em uint16\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{group__uart__apis_gaeed9b1c0c84b16c8e4e4b65be0787ae4}\label{group__uart__apis_gaeed9b1c0c84b16c8e4e4b65be0787ae4} -\index{, uart configuration and communication related apis@{, uart configuration and communication related apis}!ciot\_crc32\_be@{ciot\_crc32\_be}} -\index{ciot\_crc32\_be@{ciot\_crc32\_be}!, uart configuration and communication related apis@{, uart configuration and communication related apis}} -\doxysubsubsection{\texorpdfstring{ciot\_crc32\_be()}{ciot\_crc32\_be()}} -{\footnotesize\ttfamily uint32\+\_\+t ciot\+\_\+crc32\+\_\+be (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC32 value that is in big endian. - - -\begin{DoxyParams}{Parameters} -{\em uint32\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{group__uart__apis_gad020e1771e2ff7a25a068ccc1b3d1331}\label{group__uart__apis_gad020e1771e2ff7a25a068ccc1b3d1331} -\index{, uart configuration and communication related apis@{, uart configuration and communication related apis}!ciot\_crc32\_le@{ciot\_crc32\_le}} -\index{ciot\_crc32\_le@{ciot\_crc32\_le}!, uart configuration and communication related apis@{, uart configuration and communication related apis}} -\doxysubsubsection{\texorpdfstring{ciot\_crc32\_le()}{ciot\_crc32\_le()}} -{\footnotesize\ttfamily uint32\+\_\+t ciot\+\_\+crc32\+\_\+le (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC32 value that is in little endian. - - -\begin{DoxyParams}{Parameters} -{\em uint32\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{group__uart__apis_gae831c4d3ed93d649df5ed07e5b9d1c46}\label{group__uart__apis_gae831c4d3ed93d649df5ed07e5b9d1c46} -\index{, uart configuration and communication related apis@{, uart configuration and communication related apis}!ciot\_crc8\_be@{ciot\_crc8\_be}} -\index{ciot\_crc8\_be@{ciot\_crc8\_be}!, uart configuration and communication related apis@{, uart configuration and communication related apis}} -\doxysubsubsection{\texorpdfstring{ciot\_crc8\_be()}{ciot\_crc8\_be()}} -{\footnotesize\ttfamily uint8\+\_\+t ciot\+\_\+crc8\+\_\+be (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC8 value that is in big endian. - - -\begin{DoxyParams}{Parameters} -{\em uint32\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\Hypertarget{group__uart__apis_ga39da2d632baf462933f90f3fbe7a63e7}\label{group__uart__apis_ga39da2d632baf462933f90f3fbe7a63e7} -\index{, uart configuration and communication related apis@{, uart configuration and communication related apis}!ciot\_crc8\_le@{ciot\_crc8\_le}} -\index{ciot\_crc8\_le@{ciot\_crc8\_le}!, uart configuration and communication related apis@{, uart configuration and communication related apis}} -\doxysubsubsection{\texorpdfstring{ciot\_crc8\_le()}{ciot\_crc8\_le()}} -{\footnotesize\ttfamily uint8\+\_\+t ciot\+\_\+crc8\+\_\+le (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{crc, }\item[{uint8\+\_\+t const \texorpdfstring{$\ast$}{*}}]{buf, }\item[{uint32\+\_\+t}]{len }\end{DoxyParamCaption})} - - - -CRC8 value that is in little endian. - - -\begin{DoxyParams}{Parameters} -{\em uint8\+\_\+t} & crc \+: init crc value, use 0 at the first use.\\ -\hline -{\em uint8\+\_\+t} & const \texorpdfstring{$\ast$}{*}buf \+: buffer to start calculate crc.\\ -\hline -{\em uint32\+\_\+t} & len \+: buffer length in byte.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} diff --git a/docs/latex/longtable_doxygen.sty b/docs/latex/longtable_doxygen.sty deleted file mode 100644 index e94b78b..0000000 --- a/docs/latex/longtable_doxygen.sty +++ /dev/null @@ -1,456 +0,0 @@ -%% -%% This is file `longtable.sty', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% longtable.dtx (with options: `package') -%% -%% This is a generated file. -%% -%% The source is maintained by the LaTeX Project team and bug -%% reports for it can be opened at http://latex-project.org/bugs.html -%% (but please observe conditions on bug reports sent to that address!) -%% -%% Copyright 1993-2016 -%% The LaTeX3 Project and any individual authors listed elsewhere -%% in this file. -%% -%% This file was generated from file(s) of the Standard LaTeX `Tools Bundle'. -%% -------------------------------------------------------------------------- -%% -%% It may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either version 1.3c -%% of this license or (at your option) any later version. -%% The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% and version 1.3c or later is part of all distributions of LaTeX -%% version 2005/12/01 or later. -%% -%% This file may only be distributed together with a copy of the LaTeX -%% `Tools Bundle'. You may however distribute the LaTeX `Tools Bundle' -%% without such generated files. -%% -%% The list of all files belonging to the LaTeX `Tools Bundle' is -%% given in the file `manifest.txt'. -%% -%% File: longtable.dtx Copyright (C) 1990-2001 David Carlisle -\NeedsTeXFormat{LaTeX2e}[1995/06/01] -\ProvidesPackage{longtable_doxygen} - [2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen] -\def\LT@err{\PackageError{longtable}} -\def\LT@warn{\PackageWarning{longtable}} -\def\LT@final@warn{% - \AtEndDocument{% - \LT@warn{Table \@width s have changed. Rerun LaTeX.\@gobbletwo}}% - \global\let\LT@final@warn\relax} -\DeclareOption{errorshow}{% - \def\LT@warn{\PackageInfo{longtable}}} -\DeclareOption{pausing}{% - \def\LT@warn#1{% - \LT@err{#1}{This is not really an error}}} -\DeclareOption{set}{} -\DeclareOption{final}{} -\ProcessOptions -\newskip\LTleft \LTleft=\fill -\newskip\LTright \LTright=\fill -\newskip\LTpre \LTpre=\bigskipamount -\newskip\LTpost \LTpost=\bigskipamount -\newcount\LTchunksize \LTchunksize=20 -\let\c@LTchunksize\LTchunksize -\newdimen\LTcapwidth \LTcapwidth=4in -\newbox\LT@head -\newbox\LT@firsthead -\newbox\LT@foot -\newbox\LT@lastfoot -\newcount\LT@cols -\newcount\LT@rows -\newcounter{LT@tables} -\newcounter{LT@chunks}[LT@tables] -\ifx\c@table\undefined - \newcounter{table} - \def\fnum@table{\tablename~\thetable} -\fi -\ifx\tablename\undefined - \def\tablename{Table} -\fi -\newtoks\LT@p@ftn -\mathchardef\LT@end@pen=30000 -\def\longtable{% - \par - \ifx\multicols\@undefined - \else - \ifnum\col@number>\@ne - \@twocolumntrue - \fi - \fi - \if@twocolumn - \LT@err{longtable not in 1-column mode}\@ehc - \fi - \begingroup - \@ifnextchar[\LT@array{\LT@array[x]}} -\def\LT@array[#1]#2{% - \refstepcounter{table}\stepcounter{LT@tables}% - \if l#1% - \LTleft\z@ \LTright\fill - \else\if r#1% - \LTleft\fill \LTright\z@ - \else\if c#1% - \LTleft\fill \LTright\fill - \fi\fi\fi - \let\LT@mcol\multicolumn - \let\LT@@tabarray\@tabarray - \let\LT@@hl\hline - \def\@tabarray{% - \let\hline\LT@@hl - \LT@@tabarray}% - \let\\\LT@tabularcr\let\tabularnewline\\% - \def\newpage{\noalign{\break}}% - \def\pagebreak{\noalign{\ifnum`}=0\fi\@testopt{\LT@no@pgbk-}4}% - \def\nopagebreak{\noalign{\ifnum`}=0\fi\@testopt\LT@no@pgbk4}% - \let\hline\LT@hline \let\kill\LT@kill\let\caption\LT@caption - \@tempdima\ht\strutbox - \let\@endpbox\LT@endpbox - \ifx\extrarowheight\@undefined - \let\@acol\@tabacol - \let\@classz\@tabclassz \let\@classiv\@tabclassiv - \def\@startpbox{\vtop\LT@startpbox}% - \let\@@startpbox\@startpbox - \let\@@endpbox\@endpbox - \let\LT@LL@FM@cr\@tabularcr - \else - \advance\@tempdima\extrarowheight - \col@sep\tabcolsep - \let\@startpbox\LT@startpbox\let\LT@LL@FM@cr\@arraycr - \fi - \setbox\@arstrutbox\hbox{\vrule - \@height \arraystretch \@tempdima - \@depth \arraystretch \dp \strutbox - \@width \z@}% - \let\@sharp##\let\protect\relax - \begingroup - \@mkpream{#2}% - \xdef\LT@bchunk{% - \global\advance\c@LT@chunks\@ne - \global\LT@rows\z@\setbox\z@\vbox\bgroup - \LT@setprevdepth - \tabskip\LTleft \noexpand\halign to\hsize\bgroup - \tabskip\z@ \@arstrut \@preamble \tabskip\LTright \cr}% - \endgroup - \expandafter\LT@nofcols\LT@bchunk&\LT@nofcols - \LT@make@row - \m@th\let\par\@empty - \everycr{}\lineskip\z@\baselineskip\z@ - \LT@bchunk} -\def\LT@no@pgbk#1[#2]{\penalty #1\@getpen{#2}\ifnum`{=0\fi}} -\def\LT@start{% - \let\LT@start\endgraf - \endgraf\penalty\z@\vskip\LTpre - \dimen@\pagetotal - \advance\dimen@ \ht\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi - \advance\dimen@ \dp\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi - \advance\dimen@ \ht\LT@foot - \dimen@ii\vfuzz - \vfuzz\maxdimen - \setbox\tw@\copy\z@ - \setbox\tw@\vsplit\tw@ to \ht\@arstrutbox - \setbox\tw@\vbox{\unvbox\tw@}% - \vfuzz\dimen@ii - \advance\dimen@ \ht - \ifdim\ht\@arstrutbox>\ht\tw@\@arstrutbox\else\tw@\fi - \advance\dimen@\dp - \ifdim\dp\@arstrutbox>\dp\tw@\@arstrutbox\else\tw@\fi - \advance\dimen@ -\pagegoal - \ifdim \dimen@>\z@\vfil\break\fi - \global\@colroom\@colht - \ifvoid\LT@foot\else - \advance\vsize-\ht\LT@foot - \global\advance\@colroom-\ht\LT@foot - \dimen@\pagegoal\advance\dimen@-\ht\LT@foot\pagegoal\dimen@ - \maxdepth\z@ - \fi - \ifvoid\LT@firsthead\copy\LT@head\else\box\LT@firsthead\fi\nobreak - \output{\LT@output}} -\def\endlongtable{% - \crcr - \noalign{% - \let\LT@entry\LT@entry@chop - \xdef\LT@save@row{\LT@save@row}}% - \LT@echunk - \LT@start - \unvbox\z@ - \LT@get@widths - \if@filesw - {\let\LT@entry\LT@entry@write\immediate\write\@auxout{% - \gdef\expandafter\noexpand - \csname LT@\romannumeral\c@LT@tables\endcsname - {\LT@save@row}}}% - \fi - \ifx\LT@save@row\LT@@save@row - \else - \LT@warn{Column \@width s have changed\MessageBreak - in table \thetable}% - \LT@final@warn - \fi - \endgraf\penalty -\LT@end@pen - \endgroup - \global\@mparbottom\z@ - \pagegoal\vsize - \endgraf\penalty\z@\addvspace\LTpost - \ifvoid\footins\else\insert\footins{}\fi} -\def\LT@nofcols#1&{% - \futurelet\@let@token\LT@n@fcols} -\def\LT@n@fcols{% - \advance\LT@cols\@ne - \ifx\@let@token\LT@nofcols - \expandafter\@gobble - \else - \expandafter\LT@nofcols - \fi} -\def\LT@tabularcr{% - \relax\iffalse{\fi\ifnum0=`}\fi - \@ifstar - {\def\crcr{\LT@crcr\noalign{\nobreak}}\let\cr\crcr - \LT@t@bularcr}% - {\LT@t@bularcr}} -\let\LT@crcr\crcr -\let\LT@setprevdepth\relax -\def\LT@t@bularcr{% - \global\advance\LT@rows\@ne - \ifnum\LT@rows=\LTchunksize - \gdef\LT@setprevdepth{% - \prevdepth\z@\global - \global\let\LT@setprevdepth\relax}% - \expandafter\LT@xtabularcr - \else - \ifnum0=`{}\fi - \expandafter\LT@LL@FM@cr - \fi} -\def\LT@xtabularcr{% - \@ifnextchar[\LT@argtabularcr\LT@ntabularcr} -\def\LT@ntabularcr{% - \ifnum0=`{}\fi - \LT@echunk - \LT@start - \unvbox\z@ - \LT@get@widths - \LT@bchunk} -\def\LT@argtabularcr[#1]{% - \ifnum0=`{}\fi - \ifdim #1>\z@ - \unskip\@xargarraycr{#1}% - \else - \@yargarraycr{#1}% - \fi - \LT@echunk - \LT@start - \unvbox\z@ - \LT@get@widths - \LT@bchunk} -\def\LT@echunk{% - \crcr\LT@save@row\cr\egroup - \global\setbox\@ne\lastbox - \unskip - \egroup} -\def\LT@entry#1#2{% - \ifhmode\@firstofone{&}\fi\omit - \ifnum#1=\c@LT@chunks - \else - \kern#2\relax - \fi} -\def\LT@entry@chop#1#2{% - \noexpand\LT@entry - {\ifnum#1>\c@LT@chunks - 1}{0pt% - \else - #1}{#2% - \fi}} -\def\LT@entry@write{% - \noexpand\LT@entry^^J% - \@spaces} -\def\LT@kill{% - \LT@echunk - \LT@get@widths - \expandafter\LT@rebox\LT@bchunk} -\def\LT@rebox#1\bgroup{% - #1\bgroup - \unvbox\z@ - \unskip - \setbox\z@\lastbox} -\def\LT@blank@row{% - \xdef\LT@save@row{\expandafter\LT@build@blank - \romannumeral\number\LT@cols 001 }} -\def\LT@build@blank#1{% - \if#1m% - \noexpand\LT@entry{1}{0pt}% - \expandafter\LT@build@blank - \fi} -\def\LT@make@row{% - \global\expandafter\let\expandafter\LT@save@row - \csname LT@\romannumeral\c@LT@tables\endcsname - \ifx\LT@save@row\relax - \LT@blank@row - \else - {\let\LT@entry\or - \if!% - \ifcase\expandafter\expandafter\expandafter\LT@cols - \expandafter\@gobble\LT@save@row - \or - \else - \relax - \fi - !% - \else - \aftergroup\LT@blank@row - \fi}% - \fi} -\let\setlongtables\relax -\def\LT@get@widths{% - \setbox\tw@\hbox{% - \unhbox\@ne - \let\LT@old@row\LT@save@row - \global\let\LT@save@row\@empty - \count@\LT@cols - \loop - \unskip - \setbox\tw@\lastbox - \ifhbox\tw@ - \LT@def@row - \advance\count@\m@ne - \repeat}% - \ifx\LT@@save@row\@undefined - \let\LT@@save@row\LT@save@row - \fi} -\def\LT@def@row{% - \let\LT@entry\or - \edef\@tempa{% - \ifcase\expandafter\count@\LT@old@row - \else - {1}{0pt}% - \fi}% - \let\LT@entry\relax - \xdef\LT@save@row{% - \LT@entry - \expandafter\LT@max@sel\@tempa - \LT@save@row}} -\def\LT@max@sel#1#2{% - {\ifdim#2=\wd\tw@ - #1% - \else - \number\c@LT@chunks - \fi}% - {\the\wd\tw@}} -\def\LT@hline{% - \noalign{\ifnum0=`}\fi - \penalty\@M - \futurelet\@let@token\LT@@hline} -\def\LT@@hline{% - \ifx\@let@token\hline - \global\let\@gtempa\@gobble - \gdef\LT@sep{\penalty-\@medpenalty\vskip\doublerulesep}% - \else - \global\let\@gtempa\@empty - \gdef\LT@sep{\penalty-\@lowpenalty\vskip-\arrayrulewidth}% - \fi - \ifnum0=`{\fi}% - \multispan\LT@cols - \unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr - \noalign{\LT@sep}% - \multispan\LT@cols - \unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr - \noalign{\penalty\@M}% - \@gtempa} -\def\LT@caption{% - \noalign\bgroup - \@ifnextchar[{\egroup\LT@c@ption\@firstofone}\LT@capti@n} -\def\LT@c@ption#1[#2]#3{% - \LT@makecaption#1\fnum@table{#3}% - \def\@tempa{#2}% - \ifx\@tempa\@empty\else - {\let\\\space - \addcontentsline{lot}{table}{\protect\numberline{\thetable}{#2}}}% - \fi} -\def\LT@capti@n{% - \@ifstar - {\egroup\LT@c@ption\@gobble[]}% - {\egroup\@xdblarg{\LT@c@ption\@firstofone}}} -\def\LT@makecaption#1#2#3{% - \LT@mcol\LT@cols c{\hbox to\z@{\hss\parbox[t]\LTcapwidth{% - \sbox\@tempboxa{#1{#2: }#3}% - \ifdim\wd\@tempboxa>\hsize - #1{#2: }#3% - \else - \hbox to\hsize{\hfil\box\@tempboxa\hfil}% - \fi - \endgraf\vskip\baselineskip}% - \hss}}} -\def\LT@output{% - \ifnum\outputpenalty <-\@Mi - \ifnum\outputpenalty > -\LT@end@pen - \LT@err{floats and marginpars not allowed in a longtable}\@ehc - \else - \setbox\z@\vbox{\unvbox\@cclv}% - \ifdim \ht\LT@lastfoot>\ht\LT@foot - \dimen@\pagegoal - \advance\dimen@-\ht\LT@lastfoot - \ifdim\dimen@<\ht\z@ - \setbox\@cclv\vbox{\unvbox\z@\copy\LT@foot\vss}% - \@makecol - \@outputpage - \setbox\z@\vbox{\box\LT@head}% - \fi - \fi - \global\@colroom\@colht - \global\vsize\@colht - \vbox - {\unvbox\z@\box\ifvoid\LT@lastfoot\LT@foot\else\LT@lastfoot\fi}% - \fi - \else - \setbox\@cclv\vbox{\unvbox\@cclv\copy\LT@foot\vss}% - \@makecol - \@outputpage - \global\vsize\@colroom - \copy\LT@head\nobreak - \fi} -\def\LT@end@hd@ft#1{% - \LT@echunk - \ifx\LT@start\endgraf - \LT@err - {Longtable head or foot not at start of table}% - {Increase LTchunksize}% - \fi - \setbox#1\box\z@ - \LT@get@widths - \LT@bchunk} -\def\endfirsthead{\LT@end@hd@ft\LT@firsthead} -\def\endhead{\LT@end@hd@ft\LT@head} -\def\endfoot{\LT@end@hd@ft\LT@foot} -\def\endlastfoot{\LT@end@hd@ft\LT@lastfoot} -\def\LT@startpbox#1{% - \bgroup - \let\@footnotetext\LT@p@ftntext - \setlength\hsize{#1}% - \@arrayparboxrestore - \vrule \@height \ht\@arstrutbox \@width \z@} -\def\LT@endpbox{% - \@finalstrut\@arstrutbox - \egroup - \the\LT@p@ftn - \global\LT@p@ftn{}% - \hfil} -%% added \long to prevent: -% LaTeX Warning: Command \LT@p@ftntext has changed. -% -% from the original repository (https://github.com/latex3/latex2e/blob/develop/required/tools/longtable.dtx): -% \changes{v4.15}{2021/03/28} -% {make long for gh/364} -% Inside the `p' column, just save up the footnote text in a token -% register. -\long\def\LT@p@ftntext#1{% - \edef\@tempa{\the\LT@p@ftn\noexpand\footnotetext[\the\c@footnote]}% - \global\LT@p@ftn\expandafter{\@tempa{#1}}}% - -\@namedef{ver@longtable.sty}{2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen} -\endinput -%% -%% End of file `longtable.sty'. diff --git a/docs/latex/make.bat b/docs/latex/make.bat deleted file mode 100644 index 96da1c8..0000000 --- a/docs/latex/make.bat +++ /dev/null @@ -1,56 +0,0 @@ -pushd %~dp0 -if not %errorlevel% == 0 goto :end - -set ORG_LATEX_CMD=%LATEX_CMD% -set ORG_MKIDX_CMD=%MKIDX_CMD% -set ORG_BIBTEX_CMD=%BIBTEX_CMD% -set ORG_LATEX_COUNT=%LATEX_COUNT% -set ORG_MANUAL_FILE=%MANUAL_FILE% -if "X"%LATEX_CMD% == "X" set LATEX_CMD=pdflatex -if "X"%MKIDX_CMD% == "X" set MKIDX_CMD=makeindex -if "X"%BIBTEX_CMD% == "X" set BIBTEX_CMD=bibtex -if "X"%LATEX_COUNT% == "X" set LATEX_COUNT=8 -if "X"%MANUAL_FILE% == "X" set MANUAL_FILE=refman - -del /s /f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl %MANUAL_FILE%.pdf - - -%LATEX_CMD% %MANUAL_FILE% -echo ---- -%MKIDX_CMD% %MANUAL_FILE%.idx -echo ---- -%LATEX_CMD% %MANUAL_FILE% - -setlocal enabledelayedexpansion -set count=%LATEX_COUNT% -:repeat -set content=X -for /F "tokens=*" %%T in ( 'findstr /C:"Rerun LaTeX" %MANUAL_FILE%.log' ) do set content="%%~T" -if !content! == X for /F "tokens=*" %%T in ( 'findstr /C:"Rerun to get cross-references right" %MANUAL_FILE%.log' ) do set content="%%~T" -if !content! == X for /F "tokens=*" %%T in ( 'findstr /C:"Rerun to get bibliographical references right" %MANUAL_FILE%.log' ) do set content="%%~T" -if !content! == X goto :skip -set /a count-=1 -if !count! EQU 0 goto :skip - -echo ---- -%LATEX_CMD% %MANUAL_FILE% -goto :repeat -:skip -endlocal -%MKIDX_CMD% %MANUAL_FILE%.idx -%LATEX_CMD% %MANUAL_FILE% - -@REM reset environment -popd -set LATEX_CMD=%ORG_LATEX_CMD% -set ORG_LATEX_CMD= -set MKIDX_CMD=%ORG_MKIDX_CMD% -set ORG_MKIDX_CMD= -set BIBTEX_CMD=%ORG_BIBTEX_CMD% -set ORG_BIBTEX_CMD= -set MANUAL_FILE=%ORG_MANUAL_FILE% -set ORG_MANUAL_FILE= -set LATEX_COUNT=%ORG_LATEX_COUNT% -set ORG_LATEX_COUNT= - -:end diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex deleted file mode 100644 index b8c64f9..0000000 --- a/docs/latex/refman.tex +++ /dev/null @@ -1,509 +0,0 @@ - % Handle batch mode - % to overcome problems with too many open files - \let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage} - \pdfminorversion=7 - % Set document class depending on configuration - \documentclass[twoside]{book} - %% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package - \usepackage{ifthen} - \ifx\requestedLaTeXdate\undefined - \usepackage{array} - \else - \usepackage{array}[=2016-10-06] - \fi - %% - % Packages required by doxygen - \makeatletter - \providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion} - % suppress package identification of infwarerr as it contains the word "warning" - \let\@@protected@wlog\protected@wlog - \def\protected@wlog#1{\wlog{package info suppressed}} - \RequirePackage{infwarerr} - \let\protected@wlog\@@protected@wlog - \makeatother - \IfFormatAtLeastTF{2016/01/01}{}{\usepackage{fixltx2e}} % for \textsubscript - \IfFormatAtLeastTF{2015/01/01}{\pdfsuppresswarningpagegroup=1}{} - \usepackage{doxygen} - \usepackage{graphicx} - \usepackage[utf8]{inputenc} - \usepackage{makeidx} - \PassOptionsToPackage{warn}{textcomp} - \usepackage{textcomp} - \usepackage[nointegrals]{wasysym} - \usepackage{ifxetex} - % NLS support packages - % Define default fonts - % Font selection - \usepackage[T1]{fontenc} - % set main and monospaced font - \usepackage[scaled=.90]{helvet} -\usepackage{courier} -\renewcommand{\familydefault}{\sfdefault} - \doxyallsectionsfont{% - \fontseries{bc}\selectfont% - \color{darkgray}% - } - \renewcommand{\DoxyLabelFont}{% - \fontseries{bc}\selectfont% - \color{darkgray}% - } - \newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}} - % Arguments of doxygenemoji: - % 1) '::' form of the emoji, already LaTeX-escaped - % 2) file with the name of the emoji without the .png extension - % in case image exist use this otherwise use the '::' form - \newcommand{\doxygenemoji}[2]{% - \IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}% - } - % Page & text layout - \usepackage{geometry} - \geometry{% - a4paper,% - top=2.5cm,% - bottom=2.5cm,% - left=2.5cm,% - right=2.5cm% - } - \usepackage{changepage} - % Allow a bit of overflow to go unnoticed by other means - \tolerance=750 - \hfuzz=15pt - \hbadness=750 - \setlength{\emergencystretch}{15pt} - \setlength{\parindent}{0cm} - \newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}} - \newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}} - \doxynormalparskip - % Redefine paragraph/subparagraph environments, using sectsty fonts - \makeatletter - \renewcommand{\paragraph}{% - \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{% - \normalfont\normalsize\bfseries\SS@parafont% - }% - } - \renewcommand{\subparagraph}{% - \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{% - \normalfont\normalsize\bfseries\SS@subparafont% - }% - } - \makeatother - \makeatletter - \newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@} - \makeatother - % Headers & footers - \usepackage{fancyhdr} - \pagestyle{fancyplain} - \renewcommand{\footrulewidth}{0.4pt} - \fancypagestyle{fancyplain}{ - \fancyhf{} - \fancyhead[LE, RO]{\bfseries\thepage} - \fancyhead[LO]{\bfseries\rightmark} - \fancyhead[RE]{\bfseries\leftmark} - \fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen } - } - \fancypagestyle{plain}{ - \fancyhf{} - \fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen } - \renewcommand{\headrulewidth}{0pt} - } - \pagestyle{fancyplain} - \renewcommand{\chaptermark}[1]{% - \markboth{#1}{}% - } - \renewcommand{\sectionmark}[1]{% - \markright{\thesection\ #1}% - } - % ToC, LoF, LoT, bibliography, and index - % Indices & bibliography - \usepackage{natbib} - \usepackage[titles]{tocloft} - \setcounter{tocdepth}{3} - \setcounter{secnumdepth}{5} - % creating indexes - \makeindex - \usepackage{newunicodechar} - \makeatletter - \def\doxynewunicodechar#1#2{% - \@tempswafalse - \edef\nuc@tempa{\detokenize{#1}}% - \if\relax\nuc@tempa\relax - \nuc@emptyargerr - \else - \edef\@tempb{\expandafter\@car\nuc@tempa\@nil}% - \nuc@check - \if@tempswa - \@namedef{u8:\nuc@tempa}{#2}% - \fi - \fi - } - \makeatother - \doxynewunicodechar{⁻}{${}^{-}$}% Superscript minus - \doxynewunicodechar{²}{${}^{2}$}% Superscript two - \doxynewunicodechar{³}{${}^{3}$}% Superscript three - % Hyperlinks - % Hyperlinks (required, but should be loaded last) - \ifpdf - \usepackage[pdftex,pagebackref=true]{hyperref} - \else - \ifxetex - \usepackage[pagebackref=true]{hyperref} - \else - \usepackage[ps2pdf,pagebackref=true]{hyperref} - \fi - \fi - \hypersetup{% - colorlinks=true,% - linkcolor=blue,% - citecolor=blue,% - unicode,% - pdftitle={CioT},% - pdfsubject={Connected IoT}% - } - % Custom commands used by the header - % Custom commands - \newcommand{\clearemptydoublepage}{% - \newpage{\pagestyle{empty}\cleardoublepage}% - } - % caption style definition - \usepackage{caption} - \captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top} - % in page table of contents - \IfFormatAtLeastTF{2023/05/01}{\usepackage[deeplevels]{etoc}}{\usepackage[deeplevels]{etoc_doxygen}} - \etocsettocstyle{\doxytocparskip}{\doxynormalparskip} - \etocsetlevel{subsubsubsection}{4} - \etocsetlevel{subsubsubsubsection}{5} - \etocsetlevel{subsubsubsubsubsection}{6} - \etocsetlevel{subsubsubsubsubsubsection}{7} - \etocsetlevel{paragraph}{8} - \etocsetlevel{subparagraph}{9} - % prevent numbers overlap the titles in toc - \renewcommand{\numberline}[1]{#1~} -% End of preamble, now comes the document contents -%===== C O N T E N T S ===== -\begin{document} - \raggedbottom - % Titlepage & ToC - % To avoid duplicate page anchors due to reuse of same numbers for - % the index (be it as roman numbers) - \hypersetup{pageanchor=false, - bookmarksnumbered=true, - pdfencoding=unicode - } - \pagenumbering{alph} - \begin{titlepage} - \vspace*{7cm} - \begin{center}% - {\Large CioT}\\ - [1ex]\large 0.\+1.\+0 \\ - \vspace*{1cm} - {\large Generated by Doxygen 1.10.0}\\ - \end{center} - \end{titlepage} - \clearemptydoublepage - \pagenumbering{roman} - \tableofcontents - \clearemptydoublepage - \pagenumbering{arabic} - % re-enable anchors again - \hypersetup{pageanchor=true} -%--- Begin generated contents --- -\chapter{Topic Index} -\input{topics} -\chapter{Data Structure Index} -\input{annotated} -\chapter{File Index} -\input{files} -\chapter{Topic Documentation} -\input{group__hardware__types} -\input{group__hardware__interfaces} -\input{group__software__types} -\input{group__software__interfaces} -\chapter{Data Structure Documentation} -\input{structciot__ble__cfg__t} -\input{unionciot__ble__data__u} -\input{structciot__ble__ifaces} -\input{structciot__ble__info__t} -\input{unionciot__ble__req__data__u} -\input{structciot__ble__req__t} -\input{structciot__ble__scn__adv__info__t} -\input{structciot__ble__scn__cfg__t} -\input{unionciot__ble__scn__data__u} -\input{unionciot__ble__scn__req__data__u} -\input{structciot__ble__scn__req__t} -\input{structciot__ble__scn__status__msg__t} -\input{structciot__ble__scn__status__t} -\input{structciot__ble__status__msg__t} -\input{structciot__ble__status__t} -\input{structciot__bridge__cfg__t} -\input{unionciot__bridge__data__u} -\input{unionciot__bridge__req__data__u} -\input{structciot__bridge__req__t} -\input{structciot__bridge__status__msg__t} -\input{structciot__bridge__status__t} -\input{structciot__cfg} -\input{structciot__data__model__cfg__t} -\input{unionciot__data__model__data__u} -\input{unionciot__data__model__req__data__u} -\input{structciot__data__model__req__t} -\input{structciot__data__model__status__t} -\input{unionciot__data__u} -\input{structciot__dfu__cfg__t} -\input{unionciot__dfu__data__u} -\input{unionciot__dfu__req__data__u} -\input{structciot__dfu__req__t} -\input{structciot__dfu__status__msg__t} -\input{structciot__dfu__status__t} -\input{structciot__eth__status__msg__t} -\input{structciot__event__data} -\input{structciot__gpio__cfg__t} -\input{unionciot__gpio__data__u} -\input{unionciot__gpio__req__data__u} -\input{structciot__gpio__req__get__state__t} -\input{structciot__gpio__req__t} -\input{structciot__gpio__state__info__t} -\input{structciot__gpio__status__msg__t} -\input{structciot__gpio__status__t} -\input{structciot__httpc__cfg__t} -\input{unionciot__httpc__data__u} -\input{unionciot__httpc__event} -\input{structciot__httpc__event__data} -\input{unionciot__httpc__req__data} -\input{structciot__httpc__req__send__t} -\input{structciot__httpc__req__set__header__t} -\input{structciot__httpc__req__t} -\input{structciot__httpc__status__msg__t} -\input{structciot__httpc__status__t} -\input{structciot__https__cfg__t} -\input{unionciot__https__data__u} -\input{structciot__https__event} -\input{structciot__https__event__data} -\input{unionciot__https__req__data__u} -\input{structciot__https__req__t} -\input{structciot__https__status__msg__t} -\input{structciot__https__status__t} -\input{structciot__iface} -\input{structciot__iface__base} -\input{structciot__iface__base__data} -\input{structciot__iface__cfg__t} -\input{unionciot__iface__event__data__u} -\input{structciot__iface__event__t} -\input{structciot__iface__req__info} -\input{structciot__ifaces} -\input{structciot__info__t} -\input{structciot__mqttc__cfg__t} -\input{unionciot__mqttc__data__u} -\input{structciot__mqttc__error__t} -\input{structciot__mqttc__event} -\input{structciot__mqttc__event__data} -\input{unionciot__mqttc__req__data__u} -\input{structciot__mqttc__req__publish__t} -\input{structciot__mqttc__req__subscribe__t} -\input{structciot__mqttc__req__t} -\input{structciot__mqttc__status__msg__t} -\input{structciot__mqttc__status__t} -\input{structciot__mqttc__topics__cfg__t} -\input{unionciot__msg__data__u} -\input{structciot__msg__error__t} -\input{structciot__msg__header__t} -\input{structciot__msg__iface__info__t} -\input{structciot__msg__t} -\input{structciot__nrf__dfu__cfg} -\input{structciot__nrf__dfu__packet} -\input{structciot__ntp__cfg__t} -\input{unionciot__ntp__data__u} -\input{unionciot__ntp__req__data__u} -\input{structciot__ntp__req__t} -\input{structciot__ntp__status__msg__t} -\input{structciot__ntp__status__t} -\input{structciot__opcuas__cfg__t} -\input{unionciot__opcuas__data__u} -\input{structciot__opcuas__req__add__node__t} -\input{unionciot__opcuas__req__data__u} -\input{structciot__opcuas__req__t} -\input{structciot__opcuas__status__msg__t} -\input{structciot__opcuas__status__t} -\input{structciot__ota__cfg__t} -\input{unionciot__ota__data__u} -\input{unionciot__ota__req__data__u} -\input{structciot__ota__req__t} -\input{structciot__ota__status__msg__t} -\input{structciot__ota__status__t} -\input{unionciot__req__data__u} -\input{structciot__req__delete__iface__cfg__t} -\input{structciot__req__proxy__msg__t} -\input{structciot__req__result__t} -\input{structciot__req__save__iface__cfg__t} -\input{structciot__req__t} -\input{structciot__s__cfg} -\input{structciot__serializer} -\input{structciot__slip__t} -\input{structciot__status__t} -\input{structciot__storage__cfg__t} -\input{unionciot__storage__data__u} -\input{structciot__storage__req__file__data__t} -\input{structciot__storage__req__t} -\input{structciot__storage__status__msg__t} -\input{structciot__storage__status__t} -\input{structciot__sys__cfg__t} -\input{unionciot__sys__data__u} -\input{structciot__sys__features__t} -\input{structciot__sys__hw__features__t} -\input{structciot__sys__info__t} -\input{unionciot__sys__req__data__u} -\input{structciot__sys__req__t} -\input{structciot__sys__status__msg__t} -\input{structciot__sys__status__t} -\input{structciot__sys__sw__features__t} -\input{structciot__tcp__cfg__t} -\input{unionciot__tcp__data__u} -\input{structciot__tcp__dhcp__status__t} -\input{structciot__tcp__handle} -\input{structciot__tcp__info__t} -\input{unionciot__tcp__req__data__u} -\input{structciot__tcp__req__t} -\input{structciot__tcp__status__msg__t} -\input{structciot__tcp__status__t} -\input{structciot__timer__cfg} -\input{structciot__uart__base} -\input{structciot__uart__cfg__t} -\input{unionciot__uart__data__u} -\input{unionciot__uart__event} -\input{unionciot__uart__req__data__u} -\input{structciot__uart__req__send__data__t} -\input{structciot__uart__req__t} -\input{structciot__uart__status__msg__t} -\input{structciot__uart__status__t} -\input{structciot__usb__cfg__t} -\input{unionciot__usb__data__u} -\input{unionciot__usb__event} -\input{unionciot__usb__req__data__u} -\input{structciot__usb__req__t} -\input{structciot__usb__status__msg__t} -\input{structciot__usb__status__t} -\input{structciot__wifi__ap__info__t} -\input{structciot__wifi__cfg__t} -\input{unionciot__wifi__data__u} -\input{unionciot__wifi__req__data__u} -\input{structciot__wifi__req__t} -\input{structciot__wifi__scan__result__t} -\input{structciot__wifi__status__msg__t} -\input{structciot__wifi__status__t} -\chapter{File Documentation} -\input{ciot_8h} -\input{ciot_8h_source} -\input{ciot__ble_8h} -\input{ciot__ble_8h_source} -\input{ciot__ble__scn_8h} -\input{ciot__ble__scn_8h_source} -\input{ciot__bridge_8h} -\input{ciot__bridge_8h_source} -\input{ciot__common__types_8h} -\input{ciot__common__types_8h_source} -\input{ciot__config_8h} -\input{ciot__config_8h_source} -\input{ciot__crc_8h} -\input{ciot__crc_8h_source} -\input{ciot__default_8h} -\input{ciot__default_8h_source} -\input{ciot__dfu_8h} -\input{ciot__dfu_8h_source} -\input{ciot__err_8h} -\input{ciot__err_8h_source} -\input{ciot__eth_8h} -\input{ciot__eth_8h_source} -\input{ciot__gpio_8h} -\input{ciot__gpio_8h_source} -\input{ciot__httpc_8h} -\input{ciot__httpc_8h_source} -\input{ciot__https_8h} -\input{ciot__https_8h_source} -\input{ciot__iface_8h} -\input{ciot__iface_8h_source} -\input{ciot__ifaces_8h} -\input{ciot__ifaces_8h_source} -\input{ciot__lib_8h} -\input{ciot__lib_8h_source} -\input{ciot__log_8h} -\input{ciot__log_8h_source} -\input{ciot__mqttc_8h} -\input{ciot__mqttc_8h_source} -\input{ciot__nrf__dfu_8h} -\input{ciot__nrf__dfu_8h_source} -\input{ciot__ntp_8h} -\input{ciot__ntp_8h_source} -\input{ciot__opcuas_8h} -\input{ciot__opcuas_8h_source} -\input{ciot__ota_8h} -\input{ciot__ota_8h_source} -\input{ciot__s_8h} -\input{ciot__s_8h_source} -\input{ciot__serializer_8h} -\input{ciot__serializer_8h_source} -\input{ciot__slip_8h} -\input{ciot__slip_8h_source} -\input{ciot__storage_8h} -\input{ciot__storage_8h_source} -\input{ciot__sys_8h} -\input{ciot__sys_8h_source} -\input{ciot__tcp_8h} -\input{ciot__tcp_8h_source} -\input{ciot__timer_8h} -\input{ciot__timer_8h_source} -\input{ciot__uart_8h} -\input{ciot__uart_8h_source} -\input{ciot__usb_8h} -\input{ciot__usb_8h_source} -\input{ciot__utils_8h} -\input{ciot__utils_8h_source} -\input{ciot__wifi_8h} -\input{ciot__wifi_8h_source} -\input{ciot__ble__scn__types_8h} -\input{ciot__ble__scn__types_8h_source} -\input{ciot__ble__types_8h} -\input{ciot__ble__types_8h_source} -\input{ciot__bridge__types_8h} -\input{ciot__bridge__types_8h_source} -\input{ciot__data__model__types_8h} -\input{ciot__data__model__types_8h_source} -\input{ciot__dfu__types_8h} -\input{ciot__dfu__types_8h_source} -\input{ciot__gpio__types_8h} -\input{ciot__gpio__types_8h_source} -\input{ciot__httpc__types_8h} -\input{ciot__httpc__types_8h_source} -\input{ciot__https__types_8h} -\input{ciot__https__types_8h_source} -\input{ciot__mqttc__types_8h} -\input{ciot__mqttc__types_8h_source} -\input{ciot__msg__types_8h} -\input{ciot__msg__types_8h_source} -\input{ciot__ntp__types_8h} -\input{ciot__ntp__types_8h_source} -\input{ciot__opcuas__types_8h} -\input{ciot__opcuas__types_8h_source} -\input{ciot__ota__types_8h} -\input{ciot__ota__types_8h_source} -\input{ciot__storage__types_8h} -\input{ciot__storage__types_8h_source} -\input{ciot__sys__types_8h} -\input{ciot__sys__types_8h_source} -\input{ciot__tcp__types_8h} -\input{ciot__tcp__types_8h_source} -\input{ciot__types_8h} -\input{ciot__types_8h_source} -\input{ciot__uart__types_8h} -\input{ciot__uart__types_8h_source} -\input{ciot__usb__types_8h} -\input{ciot__usb__types_8h_source} -\input{ciot__wifi__types_8h} -\input{ciot__wifi__types_8h_source} -%--- End generated contents --- -% Index - \backmatter - \newpage - \phantomsection - \clearemptydoublepage - \addcontentsline{toc}{chapter}{\indexname} - \printindex -% Required for some languages (in combination with latexdocumentpre from the header) -\end{document} diff --git a/docs/latex/structciot__ble__cfg__t.tex b/docs/latex/structciot__ble__cfg__t.tex deleted file mode 100644 index e8bca6e..0000000 --- a/docs/latex/structciot__ble__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__ble__cfg__t}{}\label{structciot__ble__cfg__t}\index{ciot\_ble\_cfg\_t@{ciot\_ble\_cfg\_t}} - - -Structure for CIOT BLE configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ble__cfg__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1}{mac}} \mbox{[}6\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__cfg__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1}\label{structciot__ble__cfg__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1} -\index{ciot\_ble\_cfg\_t@{ciot\_ble\_cfg\_t}!mac@{mac}} -\index{mac@{mac}!ciot\_ble\_cfg\_t@{ciot\_ble\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{mac}{mac}} -{\footnotesize\ttfamily uint8\+\_\+t mac\mbox{[}6\mbox{]}} - -MAC address - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__ifaces.tex b/docs/latex/structciot__ble__ifaces.tex deleted file mode 100644 index 372ef1b..0000000 --- a/docs/latex/structciot__ble__ifaces.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+ifaces Struct Reference} -\hypertarget{structciot__ble__ifaces}{}\label{structciot__ble__ifaces}\index{ciot\_ble\_ifaces@{ciot\_ble\_ifaces}} - - -Structure for CIOT BLE interface configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} \mbox{\hyperlink{structciot__ble__ifaces_a9ef3a8d93d750f948c6a3db1563132b4}{scanner}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE interface configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__ifaces_a9ef3a8d93d750f948c6a3db1563132b4}\label{structciot__ble__ifaces_a9ef3a8d93d750f948c6a3db1563132b4} -\index{ciot\_ble\_ifaces@{ciot\_ble\_ifaces}!scanner@{scanner}} -\index{scanner@{scanner}!ciot\_ble\_ifaces@{ciot\_ble\_ifaces}} -\doxysubsubsection{\texorpdfstring{scanner}{scanner}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} scanner} - -BLE scanner object - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__ble_8h}{ciot\+\_\+ble.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__info__t.tex b/docs/latex/structciot__ble__info__t.tex deleted file mode 100644 index 2d92834..0000000 --- a/docs/latex/structciot__ble__info__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__ble__info__t}{}\label{structciot__ble__info__t}\index{ciot\_ble\_info\_t@{ciot\_ble\_info\_t}} - - -Structure for CIOT BLE information. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ble__info__t_a42c07f83a6226da7e6271b3f070ac0d7}{hw\+\_\+mac}} \mbox{[}6\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ble__info__t_a21008d923a4d8cacdc7622aae81197aa}{sw\+\_\+mac}} \mbox{[}6\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__info__t_a42c07f83a6226da7e6271b3f070ac0d7}\label{structciot__ble__info__t_a42c07f83a6226da7e6271b3f070ac0d7} -\index{ciot\_ble\_info\_t@{ciot\_ble\_info\_t}!hw\_mac@{hw\_mac}} -\index{hw\_mac@{hw\_mac}!ciot\_ble\_info\_t@{ciot\_ble\_info\_t}} -\doxysubsubsection{\texorpdfstring{hw\_mac}{hw\_mac}} -{\footnotesize\ttfamily uint8\+\_\+t hw\+\_\+mac\mbox{[}6\mbox{]}} - -Hardware MAC address \Hypertarget{structciot__ble__info__t_a21008d923a4d8cacdc7622aae81197aa}\label{structciot__ble__info__t_a21008d923a4d8cacdc7622aae81197aa} -\index{ciot\_ble\_info\_t@{ciot\_ble\_info\_t}!sw\_mac@{sw\_mac}} -\index{sw\_mac@{sw\_mac}!ciot\_ble\_info\_t@{ciot\_ble\_info\_t}} -\doxysubsubsection{\texorpdfstring{sw\_mac}{sw\_mac}} -{\footnotesize\ttfamily uint8\+\_\+t sw\+\_\+mac\mbox{[}6\mbox{]}} - -Software MAC address - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__req__t.tex b/docs/latex/structciot__ble__req__t.tex deleted file mode 100644 index 937c844..0000000 --- a/docs/latex/structciot__ble__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__ble__req__t}{}\label{structciot__ble__req__t}\index{ciot\_ble\_req\_t@{ciot\_ble\_req\_t}} - - -Structure for CIOT BLE request. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a}{ciot\+\_\+ble\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__ble__req__t_a1387b7c38bc20d7cf6308e7cbecff167}{type}} -\item -\mbox{\hyperlink{unionciot__ble__req__data__u}{ciot\+\_\+ble\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__ble__req__t_af05fffb7425971f74862815fe4169b7d}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__req__t_af05fffb7425971f74862815fe4169b7d}\label{structciot__ble__req__t_af05fffb7425971f74862815fe4169b7d} -\index{ciot\_ble\_req\_t@{ciot\_ble\_req\_t}!data@{data}} -\index{data@{data}!ciot\_ble\_req\_t@{ciot\_ble\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ble__req__data__u}{ciot\+\_\+ble\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__ble__req__t_a1387b7c38bc20d7cf6308e7cbecff167}\label{structciot__ble__req__t_a1387b7c38bc20d7cf6308e7cbecff167} -\index{ciot\_ble\_req\_t@{ciot\_ble\_req\_t}!type@{type}} -\index{type@{type}!ciot\_ble\_req\_t@{ciot\_ble\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_a8807333f11d56d9ed98b547b14a73c0a}{ciot\+\_\+ble\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__scn__adv__info__t.tex b/docs/latex/structciot__ble__scn__adv__info__t.tex deleted file mode 100644 index 281dc33..0000000 --- a/docs/latex/structciot__ble__scn__adv__info__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__ble__scn__adv__info__t}{}\label{structciot__ble__scn__adv__info__t}\index{ciot\_ble\_scn\_adv\_info\_t@{ciot\_ble\_scn\_adv\_info\_t}} - - -Structure for CIOT BLE SCN advertising information. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ble__scn__adv__info__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1}{mac}} \mbox{[}6\mbox{]} -\item -int8\+\_\+t \mbox{\hyperlink{structciot__ble__scn__adv__info__t_a3b962e67ba74725bd60ca3c29f785abe}{rssi}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE SCN advertising information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__scn__adv__info__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1}\label{structciot__ble__scn__adv__info__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1} -\index{ciot\_ble\_scn\_adv\_info\_t@{ciot\_ble\_scn\_adv\_info\_t}!mac@{mac}} -\index{mac@{mac}!ciot\_ble\_scn\_adv\_info\_t@{ciot\_ble\_scn\_adv\_info\_t}} -\doxysubsubsection{\texorpdfstring{mac}{mac}} -{\footnotesize\ttfamily uint8\+\_\+t mac\mbox{[}6\mbox{]}} - -MAC address \Hypertarget{structciot__ble__scn__adv__info__t_a3b962e67ba74725bd60ca3c29f785abe}\label{structciot__ble__scn__adv__info__t_a3b962e67ba74725bd60ca3c29f785abe} -\index{ciot\_ble\_scn\_adv\_info\_t@{ciot\_ble\_scn\_adv\_info\_t}!rssi@{rssi}} -\index{rssi@{rssi}!ciot\_ble\_scn\_adv\_info\_t@{ciot\_ble\_scn\_adv\_info\_t}} -\doxysubsubsection{\texorpdfstring{rssi}{rssi}} -{\footnotesize\ttfamily int8\+\_\+t rssi} - -RSSI value - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__scn__cfg__t.tex b/docs/latex/structciot__ble__scn__cfg__t.tex deleted file mode 100644 index 69c67d6..0000000 --- a/docs/latex/structciot__ble__scn__cfg__t.tex +++ /dev/null @@ -1,73 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__ble__scn__cfg__t}{}\label{structciot__ble__scn__cfg__t}\index{ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}} - - -Structure for CIOT BLE SCN configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__ble__scn__cfg__t_a6c52a3d605c056768b59164ce8df8334}{interval}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__ble__scn__cfg__t_a6b307b5083cf92aca29549d780b44bd5}{window}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__ble__scn__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}{timeout}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ble__scn__cfg__t_a05c940dbc220f5a723afd70071aebff8}{active}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ble__scn__cfg__t_ad44fdec90acd6e513033d8af6d0a7774}{brigde\+\_\+mode}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ble__scn__cfg__t_acb7bc06bed6f6408d719334fc41698c7}{reserved}}\+: 6 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE SCN configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__scn__cfg__t_a05c940dbc220f5a723afd70071aebff8}\label{structciot__ble__scn__cfg__t_a05c940dbc220f5a723afd70071aebff8} -\index{ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}!active@{active}} -\index{active@{active}!ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{active}{active}} -{\footnotesize\ttfamily uint8\+\_\+t active} - -Active flag \Hypertarget{structciot__ble__scn__cfg__t_ad44fdec90acd6e513033d8af6d0a7774}\label{structciot__ble__scn__cfg__t_ad44fdec90acd6e513033d8af6d0a7774} -\index{ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}!brigde\_mode@{brigde\_mode}} -\index{brigde\_mode@{brigde\_mode}!ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{brigde\_mode}{brigde\_mode}} -{\footnotesize\ttfamily uint8\+\_\+t brigde\+\_\+mode} - -Bridge mode flag \Hypertarget{structciot__ble__scn__cfg__t_a6c52a3d605c056768b59164ce8df8334}\label{structciot__ble__scn__cfg__t_a6c52a3d605c056768b59164ce8df8334} -\index{ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}!interval@{interval}} -\index{interval@{interval}!ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{interval}{interval}} -{\footnotesize\ttfamily uint16\+\_\+t interval} - -Interval value \Hypertarget{structciot__ble__scn__cfg__t_acb7bc06bed6f6408d719334fc41698c7}\label{structciot__ble__scn__cfg__t_acb7bc06bed6f6408d719334fc41698c7} -\index{ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}!reserved@{reserved}} -\index{reserved@{reserved}!ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{reserved}{reserved}} -{\footnotesize\ttfamily uint8\+\_\+t reserved} - -Reserved bits \Hypertarget{structciot__ble__scn__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}\label{structciot__ble__scn__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae} -\index{ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}!timeout@{timeout}} -\index{timeout@{timeout}!ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{timeout}{timeout}} -{\footnotesize\ttfamily uint16\+\_\+t timeout} - -Timeout value \Hypertarget{structciot__ble__scn__cfg__t_a6b307b5083cf92aca29549d780b44bd5}\label{structciot__ble__scn__cfg__t_a6b307b5083cf92aca29549d780b44bd5} -\index{ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}!window@{window}} -\index{window@{window}!ciot\_ble\_scn\_cfg\_t@{ciot\_ble\_scn\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{window}{window}} -{\footnotesize\ttfamily uint16\+\_\+t window} - -Window value - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__scn__req__t.tex b/docs/latex/structciot__ble__scn__req__t.tex deleted file mode 100644 index 85f767d..0000000 --- a/docs/latex/structciot__ble__scn__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__ble__scn__req__t}{}\label{structciot__ble__scn__req__t}\index{ciot\_ble\_scn\_req\_t@{ciot\_ble\_scn\_req\_t}} - - -Structure for CIOT BLE SCN request. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__ble__scn__req__t_abc70ef515ab30b52d6a58e0c72ee3688}{type}} -\item -\mbox{\hyperlink{unionciot__ble__scn__req__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__ble__scn__req__t_ad255c0633c486a2ba3c6d2875d5a7fe5}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE SCN request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__scn__req__t_ad255c0633c486a2ba3c6d2875d5a7fe5}\label{structciot__ble__scn__req__t_ad255c0633c486a2ba3c6d2875d5a7fe5} -\index{ciot\_ble\_scn\_req\_t@{ciot\_ble\_scn\_req\_t}!data@{data}} -\index{data@{data}!ciot\_ble\_scn\_req\_t@{ciot\_ble\_scn\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ble__scn__req__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__ble__scn__req__t_abc70ef515ab30b52d6a58e0c72ee3688}\label{structciot__ble__scn__req__t_abc70ef515ab30b52d6a58e0c72ee3688} -\index{ciot\_ble\_scn\_req\_t@{ciot\_ble\_scn\_req\_t}!type@{type}} -\index{type@{type}!ciot\_ble\_scn\_req\_t@{ciot\_ble\_scn\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_af3789825b72a0e08e09e4c8682a45aaa}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__scn__status__msg__t.tex b/docs/latex/structciot__ble__scn__status__msg__t.tex deleted file mode 100644 index 49a7bf4..0000000 --- a/docs/latex/structciot__ble__scn__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__ble__scn__status__msg__t}{}\label{structciot__ble__scn__status__msg__t}\index{ciot\_ble\_scn\_status\_msg\_t@{ciot\_ble\_scn\_status\_msg\_t}} - - -Structure for CIOT BLE scanner status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+scn.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__ble__scn__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__ble__scn__status__msg__t_aa7ad441170fdff42b419665a6652a09f}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE scanner status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__scn__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__ble__scn__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_ble\_scn\_status\_msg\_t@{ciot\_ble\_scn\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_ble\_scn\_status\_msg\_t@{ciot\_ble\_scn\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__ble__scn__status__msg__t_aa7ad441170fdff42b419665a6652a09f}\label{structciot__ble__scn__status__msg__t_aa7ad441170fdff42b419665a6652a09f} -\index{ciot\_ble\_scn\_status\_msg\_t@{ciot\_ble\_scn\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_ble\_scn\_status\_msg\_t@{ciot\_ble\_scn\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} status} - -BLE scanner status - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__ble__scn_8h}{ciot\+\_\+ble\+\_\+scn.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__scn__status__t.tex b/docs/latex/structciot__ble__scn__status__t.tex deleted file mode 100644 index 64e6ccc..0000000 --- a/docs/latex/structciot__ble__scn__status__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__ble__scn__status__t}{}\label{structciot__ble__scn__status__t}\index{ciot\_ble\_scn\_status\_t@{ciot\_ble\_scn\_status\_t}} - - -Structure for CIOT BLE SCN status. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c}{ciot\+\_\+ble\+\_\+scn\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__ble__scn__status__t_a9b3c50f82a67373296513704001266bb}{state}} -\item -\mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__ble__scn__status__t_a9c267320c088f215b9649f93a8d955c1}{adv\+\_\+info}} -\item -int \mbox{\hyperlink{structciot__ble__scn__status__t_a18c05079c393f6c94543830ac5360604}{err\+\_\+code}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE SCN status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__scn__status__t_a9c267320c088f215b9649f93a8d955c1}\label{structciot__ble__scn__status__t_a9c267320c088f215b9649f93a8d955c1} -\index{ciot\_ble\_scn\_status\_t@{ciot\_ble\_scn\_status\_t}!adv\_info@{adv\_info}} -\index{adv\_info@{adv\_info}!ciot\_ble\_scn\_status\_t@{ciot\_ble\_scn\_status\_t}} -\doxysubsubsection{\texorpdfstring{adv\_info}{adv\_info}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__scn__adv__info__t}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} adv\+\_\+info} - -Advertising information \Hypertarget{structciot__ble__scn__status__t_a18c05079c393f6c94543830ac5360604}\label{structciot__ble__scn__status__t_a18c05079c393f6c94543830ac5360604} -\index{ciot\_ble\_scn\_status\_t@{ciot\_ble\_scn\_status\_t}!err\_code@{err\_code}} -\index{err\_code@{err\_code}!ciot\_ble\_scn\_status\_t@{ciot\_ble\_scn\_status\_t}} -\doxysubsubsection{\texorpdfstring{err\_code}{err\_code}} -{\footnotesize\ttfamily int err\+\_\+code} - -Error code \Hypertarget{structciot__ble__scn__status__t_a9b3c50f82a67373296513704001266bb}\label{structciot__ble__scn__status__t_a9b3c50f82a67373296513704001266bb} -\index{ciot\_ble\_scn\_status\_t@{ciot\_ble\_scn\_status\_t}!state@{state}} -\index{state@{state}!ciot\_ble\_scn\_status\_t@{ciot\_ble\_scn\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_a7c7da8f1c7400acef0666d271a0cae3c}{ciot\+\_\+ble\+\_\+scn\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__status__msg__t.tex b/docs/latex/structciot__ble__status__msg__t.tex deleted file mode 100644 index 3c38385..0000000 --- a/docs/latex/structciot__ble__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__ble__status__msg__t}{}\label{structciot__ble__status__msg__t}\index{ciot\_ble\_status\_msg\_t@{ciot\_ble\_status\_msg\_t}} - - -Structure for CIOT BLE status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__ble__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__ble__status__t}{ciot\+\_\+ble\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__ble__status__msg__t_ae334becb4d9815b900b4cc43b5b9e49b}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__ble__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_ble\_status\_msg\_t@{ciot\_ble\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_ble\_status\_msg\_t@{ciot\_ble\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__ble__status__msg__t_ae334becb4d9815b900b4cc43b5b9e49b}\label{structciot__ble__status__msg__t_ae334becb4d9815b900b4cc43b5b9e49b} -\index{ciot\_ble\_status\_msg\_t@{ciot\_ble\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_ble\_status\_msg\_t@{ciot\_ble\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__status__t}{ciot\+\_\+ble\+\_\+status\+\_\+t}} status} - -BLE status - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__ble_8h}{ciot\+\_\+ble.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ble__status__t.tex b/docs/latex/structciot__ble__status__t.tex deleted file mode 100644 index 762dfee..0000000 --- a/docs/latex/structciot__ble__status__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__ble__status__t}{}\label{structciot__ble__status__t}\index{ciot\_ble\_status\_t@{ciot\_ble\_status\_t}} - - -Structure for CIOT BLE status. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e}{ciot\+\_\+ble\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__ble__status__t_aa5d08015bd3ed92217c40487bd42e433}{state}} -\item -int \mbox{\hyperlink{structciot__ble__status__t_a18c05079c393f6c94543830ac5360604}{err\+\_\+code}} -\item -\mbox{\hyperlink{structciot__ble__info__t}{ciot\+\_\+ble\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__ble__status__t_a7a8ead7f37f7534cd955cbefd78043ce}{info}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ble__status__t_a18c05079c393f6c94543830ac5360604}\label{structciot__ble__status__t_a18c05079c393f6c94543830ac5360604} -\index{ciot\_ble\_status\_t@{ciot\_ble\_status\_t}!err\_code@{err\_code}} -\index{err\_code@{err\_code}!ciot\_ble\_status\_t@{ciot\_ble\_status\_t}} -\doxysubsubsection{\texorpdfstring{err\_code}{err\_code}} -{\footnotesize\ttfamily int err\+\_\+code} - -Error code \Hypertarget{structciot__ble__status__t_a7a8ead7f37f7534cd955cbefd78043ce}\label{structciot__ble__status__t_a7a8ead7f37f7534cd955cbefd78043ce} -\index{ciot\_ble\_status\_t@{ciot\_ble\_status\_t}!info@{info}} -\index{info@{info}!ciot\_ble\_status\_t@{ciot\_ble\_status\_t}} -\doxysubsubsection{\texorpdfstring{info}{info}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__info__t}{ciot\+\_\+ble\+\_\+info\+\_\+t}} info} - -Information \Hypertarget{structciot__ble__status__t_aa5d08015bd3ed92217c40487bd42e433}\label{structciot__ble__status__t_aa5d08015bd3ed92217c40487bd42e433} -\index{ciot\_ble\_status\_t@{ciot\_ble\_status\_t}!state@{state}} -\index{state@{state}!ciot\_ble\_status\_t@{ciot\_ble\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_a01d21e1f3012f0fb9ea61d858db2359e}{ciot\+\_\+ble\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__bridge__cfg__t.tex b/docs/latex/structciot__bridge__cfg__t.tex deleted file mode 100644 index 64f2aaa..0000000 --- a/docs/latex/structciot__bridge__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+bridge\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__bridge__cfg__t}{}\label{structciot__bridge__cfg__t}\index{ciot\_bridge\_cfg\_t@{ciot\_bridge\_cfg\_t}} - - -Structure for CIOT bridge configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+bridge\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__bridge__cfg__t_a56eef1c57392c0c3144874c536410da1}{ifaces\+\_\+id}} \mbox{[}2\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT bridge configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__bridge__cfg__t_a56eef1c57392c0c3144874c536410da1}\label{structciot__bridge__cfg__t_a56eef1c57392c0c3144874c536410da1} -\index{ciot\_bridge\_cfg\_t@{ciot\_bridge\_cfg\_t}!ifaces\_id@{ifaces\_id}} -\index{ifaces\_id@{ifaces\_id}!ciot\_bridge\_cfg\_t@{ciot\_bridge\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{ifaces\_id}{ifaces\_id}} -{\footnotesize\ttfamily uint8\+\_\+t ifaces\+\_\+id\mbox{[}2\mbox{]}} - -Interface IDs - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__bridge__req__t.tex b/docs/latex/structciot__bridge__req__t.tex deleted file mode 100644 index 93713f6..0000000 --- a/docs/latex/structciot__bridge__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+bridge\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__bridge__req__t}{}\label{structciot__bridge__req__t}\index{ciot\_bridge\_req\_t@{ciot\_bridge\_req\_t}} - - -Structure for CIOT bridge request. - - - - -{\ttfamily \#include $<$ciot\+\_\+bridge\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13}{ciot\+\_\+bridge\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__bridge__req__t_a2ef6bd06414538f347bd722b6c4e064c}{type}} -\item -\mbox{\hyperlink{unionciot__bridge__req__data__u}{ciot\+\_\+bridge\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__bridge__req__t_a2f53bd6c51629c8cac0040526230998e}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT bridge request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__bridge__req__t_a2f53bd6c51629c8cac0040526230998e}\label{structciot__bridge__req__t_a2f53bd6c51629c8cac0040526230998e} -\index{ciot\_bridge\_req\_t@{ciot\_bridge\_req\_t}!data@{data}} -\index{data@{data}!ciot\_bridge\_req\_t@{ciot\_bridge\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__bridge__req__data__u}{ciot\+\_\+bridge\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__bridge__req__t_a2ef6bd06414538f347bd722b6c4e064c}\label{structciot__bridge__req__t_a2ef6bd06414538f347bd722b6c4e064c} -\index{ciot\_bridge\_req\_t@{ciot\_bridge\_req\_t}!type@{type}} -\index{type@{type}!ciot\_bridge\_req\_t@{ciot\_bridge\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_a2cf15072a075c300521fd081fe207f13}{ciot\+\_\+bridge\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__bridge__status__msg__t.tex b/docs/latex/structciot__bridge__status__msg__t.tex deleted file mode 100644 index cf83430..0000000 --- a/docs/latex/structciot__bridge__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+bridge\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__bridge__status__msg__t}{}\label{structciot__bridge__status__msg__t}\index{ciot\_bridge\_status\_msg\_t@{ciot\_bridge\_status\_msg\_t}} - - -Structure for CIOT Bridge status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+bridge.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__bridge__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__bridge__status__t}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__bridge__status__msg__t_ab50a6b7e2887ecb6625b540edae99138}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Bridge status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__bridge__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__bridge__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_bridge\_status\_msg\_t@{ciot\_bridge\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_bridge\_status\_msg\_t@{ciot\_bridge\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__bridge__status__msg__t_ab50a6b7e2887ecb6625b540edae99138}\label{structciot__bridge__status__msg__t_ab50a6b7e2887ecb6625b540edae99138} -\index{ciot\_bridge\_status\_msg\_t@{ciot\_bridge\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_bridge\_status\_msg\_t@{ciot\_bridge\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__bridge__status__t}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} status} - -Bridge status - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__bridge_8h}{ciot\+\_\+bridge.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__bridge__status__t.tex b/docs/latex/structciot__bridge__status__t.tex deleted file mode 100644 index f54c279..0000000 --- a/docs/latex/structciot__bridge__status__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+bridge\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__bridge__status__t}{}\label{structciot__bridge__status__t}\index{ciot\_bridge\_status\_t@{ciot\_bridge\_status\_t}} - - -Structure for CIOT bridge status. - - - - -{\ttfamily \#include $<$ciot\+\_\+bridge\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d}{ciot\+\_\+bridge\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__bridge__status__t_a75d538f4bd5c29ec545f1e37dae43f0e}{state}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT bridge status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__bridge__status__t_a75d538f4bd5c29ec545f1e37dae43f0e}\label{structciot__bridge__status__t_a75d538f4bd5c29ec545f1e37dae43f0e} -\index{ciot\_bridge\_status\_t@{ciot\_bridge\_status\_t}!state@{state}} -\index{state@{state}!ciot\_bridge\_status\_t@{ciot\_bridge\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_a51ac52a0b49fa4695a6fe70fcdbee55d}{ciot\+\_\+bridge\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__cfg.tex b/docs/latex/structciot__cfg.tex deleted file mode 100644 index dd83ad4..0000000 --- a/docs/latex/structciot__cfg.tex +++ /dev/null @@ -1,61 +0,0 @@ -\doxysection{ciot\+\_\+cfg Struct Reference} -\hypertarget{structciot__cfg}{}\label{structciot__cfg}\index{ciot\_cfg@{ciot\_cfg}} - - -CIOT configuration structure. - - - - -{\ttfamily \#include $<$ciot.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__cfg_abcdb687b2ecbb5e6f9125c1ea584bb68}{ifaces}} -\begin{DoxyCompactList}\small\item\em Array of CIOT interfaces. \end{DoxyCompactList}\item -void \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__cfg_a428c51338631d897b42d617f8db50410}{cfgs}} -\begin{DoxyCompactList}\small\item\em Array of configurations for the interfaces. \end{DoxyCompactList}\item -uint8\+\_\+t \mbox{\hyperlink{structciot__cfg_a20302e2c99a60d3f612dba57e3f6333b}{count}} -\begin{DoxyCompactList}\small\item\em Number of interfaces. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -CIOT configuration structure. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__cfg_a428c51338631d897b42d617f8db50410}\label{structciot__cfg_a428c51338631d897b42d617f8db50410} -\index{ciot\_cfg@{ciot\_cfg}!cfgs@{cfgs}} -\index{cfgs@{cfgs}!ciot\_cfg@{ciot\_cfg}} -\doxysubsubsection{\texorpdfstring{cfgs}{cfgs}} -{\footnotesize\ttfamily void\texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*} cfgs} - - - -Array of configurations for the interfaces. - -\Hypertarget{structciot__cfg_a20302e2c99a60d3f612dba57e3f6333b}\label{structciot__cfg_a20302e2c99a60d3f612dba57e3f6333b} -\index{ciot\_cfg@{ciot\_cfg}!count@{count}} -\index{count@{count}!ciot\_cfg@{ciot\_cfg}} -\doxysubsubsection{\texorpdfstring{count}{count}} -{\footnotesize\ttfamily uint8\+\_\+t count} - - - -Number of interfaces. - -\Hypertarget{structciot__cfg_abcdb687b2ecbb5e6f9125c1ea584bb68}\label{structciot__cfg_abcdb687b2ecbb5e6f9125c1ea584bb68} -\index{ciot\_cfg@{ciot\_cfg}!ifaces@{ifaces}} -\index{ifaces@{ifaces}!ciot\_cfg@{ciot\_cfg}} -\doxysubsubsection{\texorpdfstring{ifaces}{ifaces}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}}\texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*} ifaces} - - - -Array of CIOT interfaces. - - - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot_8h}{ciot.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__data__model__cfg__t.tex b/docs/latex/structciot__data__model__cfg__t.tex deleted file mode 100644 index 3b907d3..0000000 --- a/docs/latex/structciot__data__model__cfg__t.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+data\+\_\+model\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__data__model__cfg__t}{}\label{structciot__data__model__cfg__t}\index{ciot\_data\_model\_cfg\_t@{ciot\_data\_model\_cfg\_t}} - - -Structure for CIOT data model configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+data\+\_\+model\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Structure for CIOT data model configuration. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__data__model__req__t.tex b/docs/latex/structciot__data__model__req__t.tex deleted file mode 100644 index 3acf9f3..0000000 --- a/docs/latex/structciot__data__model__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__data__model__req__t}{}\label{structciot__data__model__req__t}\index{ciot\_data\_model\_req\_t@{ciot\_data\_model\_req\_t}} - - -Structure for CIOT data model request. - - - - -{\ttfamily \#include $<$ciot\+\_\+data\+\_\+model\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__data__model__req__t_a1cc8da72a2d329be4f8ff647f04884a0}{type}} -\item -\mbox{\hyperlink{unionciot__data__model__req__data__u}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__data__model__req__t_adbf84251d29a448cb6b3f3b4b402ebd0}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT data model request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__data__model__req__t_adbf84251d29a448cb6b3f3b4b402ebd0}\label{structciot__data__model__req__t_adbf84251d29a448cb6b3f3b4b402ebd0} -\index{ciot\_data\_model\_req\_t@{ciot\_data\_model\_req\_t}!data@{data}} -\index{data@{data}!ciot\_data\_model\_req\_t@{ciot\_data\_model\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__data__model__req__data__u}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__data__model__req__t_a1cc8da72a2d329be4f8ff647f04884a0}\label{structciot__data__model__req__t_a1cc8da72a2d329be4f8ff647f04884a0} -\index{ciot\_data\_model\_req\_t@{ciot\_data\_model\_req\_t}!type@{type}} -\index{type@{type}!ciot\_data\_model\_req\_t@{ciot\_data\_model\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_a07451ab717eebb18aa8bd2b63252454c}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__data__model__status__t.tex b/docs/latex/structciot__data__model__status__t.tex deleted file mode 100644 index 8a41744..0000000 --- a/docs/latex/structciot__data__model__status__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+data\+\_\+model\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__data__model__status__t}{}\label{structciot__data__model__status__t}\index{ciot\_data\_model\_status\_t@{ciot\_data\_model\_status\_t}} - - -Structure for CIOT data model status. - - - - -{\ttfamily \#include $<$ciot\+\_\+data\+\_\+model\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a}{ciot\+\_\+data\+\_\+model\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__data__model__status__t_a350c6a3720c9b7d1b3300e38430117e7}{state}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT data model status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__data__model__status__t_a350c6a3720c9b7d1b3300e38430117e7}\label{structciot__data__model__status__t_a350c6a3720c9b7d1b3300e38430117e7} -\index{ciot\_data\_model\_status\_t@{ciot\_data\_model\_status\_t}!state@{state}} -\index{state@{state}!ciot\_data\_model\_status\_t@{ciot\_data\_model\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_a08dca9e6529c70ebf13cda514ebbf05a}{ciot\+\_\+data\+\_\+model\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__dfu__cfg__t.tex b/docs/latex/structciot__dfu__cfg__t.tex deleted file mode 100644 index 6e860f3..0000000 --- a/docs/latex/structciot__dfu__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+dfu\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__dfu__cfg__t}{}\label{structciot__dfu__cfg__t}\index{ciot\_dfu\_cfg\_t@{ciot\_dfu\_cfg\_t}} - - -Structure for CIOT DFU configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+dfu\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a}{ciot\+\_\+dfu\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__dfu__cfg__t_afa34dcfb78399ee2321831a93d8bce73}{type}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT DFU configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__dfu__cfg__t_afa34dcfb78399ee2321831a93d8bce73}\label{structciot__dfu__cfg__t_afa34dcfb78399ee2321831a93d8bce73} -\index{ciot\_dfu\_cfg\_t@{ciot\_dfu\_cfg\_t}!type@{type}} -\index{type@{type}!ciot\_dfu\_cfg\_t@{ciot\_dfu\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_a7b0d6e81874e327b06555f8c312b963a}{ciot\+\_\+dfu\+\_\+type\+\_\+t}} type} - -DFU type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__dfu__req__t.tex b/docs/latex/structciot__dfu__req__t.tex deleted file mode 100644 index 0bbc27f..0000000 --- a/docs/latex/structciot__dfu__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+dfu\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__dfu__req__t}{}\label{structciot__dfu__req__t}\index{ciot\_dfu\_req\_t@{ciot\_dfu\_req\_t}} - - -Structure for CIOT DFU request. - - - - -{\ttfamily \#include $<$ciot\+\_\+dfu\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572}{ciot\+\_\+dfu\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__dfu__req__t_adb76936a18a28e534879c6f9d6f07868}{type}} -\item -\mbox{\hyperlink{unionciot__dfu__req__data__u}{ciot\+\_\+dfu\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__dfu__req__t_a1d31b0b31c62cd6a2a3c3b5193efd5f9}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT DFU request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__dfu__req__t_a1d31b0b31c62cd6a2a3c3b5193efd5f9}\label{structciot__dfu__req__t_a1d31b0b31c62cd6a2a3c3b5193efd5f9} -\index{ciot\_dfu\_req\_t@{ciot\_dfu\_req\_t}!data@{data}} -\index{data@{data}!ciot\_dfu\_req\_t@{ciot\_dfu\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__dfu__req__data__u}{ciot\+\_\+dfu\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__dfu__req__t_adb76936a18a28e534879c6f9d6f07868}\label{structciot__dfu__req__t_adb76936a18a28e534879c6f9d6f07868} -\index{ciot\_dfu\_req\_t@{ciot\_dfu\_req\_t}!type@{type}} -\index{type@{type}!ciot\_dfu\_req\_t@{ciot\_dfu\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_a844cd7a14810224e2865786b830ec572}{ciot\+\_\+dfu\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__dfu__status__msg__t.tex b/docs/latex/structciot__dfu__status__msg__t.tex deleted file mode 100644 index ad648b0..0000000 --- a/docs/latex/structciot__dfu__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+dfu\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__dfu__status__msg__t}{}\label{structciot__dfu__status__msg__t}\index{ciot\_dfu\_status\_msg\_t@{ciot\_dfu\_status\_msg\_t}} - - -Struct for DFU status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+dfu.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__dfu__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__dfu__status__t}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__dfu__status__msg__t_a9fb48f785812375d586c71a02b453e64}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Struct for DFU status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__dfu__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__dfu__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_dfu\_status\_msg\_t@{ciot\_dfu\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_dfu\_status\_msg\_t@{ciot\_dfu\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Header for the DFU status message. \Hypertarget{structciot__dfu__status__msg__t_a9fb48f785812375d586c71a02b453e64}\label{structciot__dfu__status__msg__t_a9fb48f785812375d586c71a02b453e64} -\index{ciot\_dfu\_status\_msg\_t@{ciot\_dfu\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_dfu\_status\_msg\_t@{ciot\_dfu\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__dfu__status__t}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} status} - -Status of the DFU operation. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__dfu_8h}{ciot\+\_\+dfu.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__dfu__status__t.tex b/docs/latex/structciot__dfu__status__t.tex deleted file mode 100644 index 59d9fe3..0000000 --- a/docs/latex/structciot__dfu__status__t.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+dfu\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__dfu__status__t}{}\label{structciot__dfu__status__t}\index{ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}} - - -Structure for CIOT DFU status. - - - - -{\ttfamily \#include $<$ciot\+\_\+dfu\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365}{ciot\+\_\+dfu\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__dfu__status__t_a587d059d905fdf8cceb8643720812de4}{state}} -\item -int \mbox{\hyperlink{structciot__dfu__status__t_a45a5b7c00a796a23f01673cef1dbe0a9}{code}} -\item -int \mbox{\hyperlink{structciot__dfu__status__t_a11614f44ef4d939bdd984953346a7572}{error}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__dfu__status__t_a42539ea8650b094f66be7a689243c5ef}{image\+\_\+size}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__dfu__status__t_a990d41db67b3605c9184428e72edcea1}{image\+\_\+read}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT DFU status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__dfu__status__t_a45a5b7c00a796a23f01673cef1dbe0a9}\label{structciot__dfu__status__t_a45a5b7c00a796a23f01673cef1dbe0a9} -\index{ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}!code@{code}} -\index{code@{code}!ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}} -\doxysubsubsection{\texorpdfstring{code}{code}} -{\footnotesize\ttfamily int code} - -Code \Hypertarget{structciot__dfu__status__t_a11614f44ef4d939bdd984953346a7572}\label{structciot__dfu__status__t_a11614f44ef4d939bdd984953346a7572} -\index{ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}!error@{error}} -\index{error@{error}!ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}} -\doxysubsubsection{\texorpdfstring{error}{error}} -{\footnotesize\ttfamily int error} - -Error \Hypertarget{structciot__dfu__status__t_a990d41db67b3605c9184428e72edcea1}\label{structciot__dfu__status__t_a990d41db67b3605c9184428e72edcea1} -\index{ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}!image\_read@{image\_read}} -\index{image\_read@{image\_read}!ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}} -\doxysubsubsection{\texorpdfstring{image\_read}{image\_read}} -{\footnotesize\ttfamily uint32\+\_\+t image\+\_\+read} - -Image read \Hypertarget{structciot__dfu__status__t_a42539ea8650b094f66be7a689243c5ef}\label{structciot__dfu__status__t_a42539ea8650b094f66be7a689243c5ef} -\index{ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}!image\_size@{image\_size}} -\index{image\_size@{image\_size}!ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}} -\doxysubsubsection{\texorpdfstring{image\_size}{image\_size}} -{\footnotesize\ttfamily uint32\+\_\+t image\+\_\+size} - -Image size \Hypertarget{structciot__dfu__status__t_a587d059d905fdf8cceb8643720812de4}\label{structciot__dfu__status__t_a587d059d905fdf8cceb8643720812de4} -\index{ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}!state@{state}} -\index{state@{state}!ciot\_dfu\_status\_t@{ciot\_dfu\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_a10bd8bfc4bc24520f6fe74ffa7d60365}{ciot\+\_\+dfu\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__eth__status__msg__t.tex b/docs/latex/structciot__eth__status__msg__t.tex deleted file mode 100644 index cb80f2e..0000000 --- a/docs/latex/structciot__eth__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+eth\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__eth__status__msg__t}{}\label{structciot__eth__status__msg__t}\index{ciot\_eth\_status\_msg\_t@{ciot\_eth\_status\_msg\_t}} - - -Structure representing the CIOT Ethernet status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+eth.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__eth__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__eth__status__msg__t_a290455b77155aab0d086fb8c69f76364}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing the CIOT Ethernet status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__eth__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__eth__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_eth\_status\_msg\_t@{ciot\_eth\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_eth\_status\_msg\_t@{ciot\_eth\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header. \Hypertarget{structciot__eth__status__msg__t_a290455b77155aab0d086fb8c69f76364}\label{structciot__eth__status__msg__t_a290455b77155aab0d086fb8c69f76364} -\index{ciot\_eth\_status\_msg\_t@{ciot\_eth\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_eth\_status\_msg\_t@{ciot\_eth\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} status} - -TCP status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__eth_8h}{ciot\+\_\+eth.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__event__data.tex b/docs/latex/structciot__event__data.tex deleted file mode 100644 index 28aa637..0000000 --- a/docs/latex/structciot__event__data.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+event\+\_\+data Struct Reference} -\hypertarget{structciot__event__data}{}\label{structciot__event__data}\index{ciot\_event\_data@{ciot\_event\_data}} - - -Structure for event data in CIOT modules. - - - - -{\ttfamily \#include $<$ciot\+\_\+common\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__event__data_aaa8222c604b0b520bc2205ddcc42d855}{ptr}} -\item -int \mbox{\hyperlink{structciot__event__data_a439227feff9d7f55384e8780cfc2eb82}{size}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for event data in CIOT modules. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__event__data_aaa8222c604b0b520bc2205ddcc42d855}\label{structciot__event__data_aaa8222c604b0b520bc2205ddcc42d855} -\index{ciot\_event\_data@{ciot\_event\_data}!ptr@{ptr}} -\index{ptr@{ptr}!ciot\_event\_data@{ciot\_event\_data}} -\doxysubsubsection{\texorpdfstring{ptr}{ptr}} -{\footnotesize\ttfamily uint8\+\_\+t\texorpdfstring{$\ast$}{*} ptr} - -Pointer to the event data \Hypertarget{structciot__event__data_a439227feff9d7f55384e8780cfc2eb82}\label{structciot__event__data_a439227feff9d7f55384e8780cfc2eb82} -\index{ciot\_event\_data@{ciot\_event\_data}!size@{size}} -\index{size@{size}!ciot\_event\_data@{ciot\_event\_data}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily int size} - -Size of the event data in bytes - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__common__types_8h}{ciot\+\_\+common\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__gpio__cfg__t.tex b/docs/latex/structciot__gpio__cfg__t.tex deleted file mode 100644 index 50240b9..0000000 --- a/docs/latex/structciot__gpio__cfg__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__gpio__cfg__t}{}\label{structciot__gpio__cfg__t}\index{ciot\_gpio\_cfg\_t@{ciot\_gpio\_cfg\_t}} - - -Structure for CIOT GPIO configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint64\+\_\+t \mbox{\hyperlink{structciot__gpio__cfg__t_a3feeb7044549691a36c39cc7c9b2ed2c}{pin\+\_\+mask}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71}{ciot\+\_\+gpio\+\_\+mode\+\_\+t}} \mbox{\hyperlink{structciot__gpio__cfg__t_a7d76e224ede8a4fa709cc3a505a81975}{mode}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe}{ciot\+\_\+gpio\+\_\+pull\+\_\+mode\+\_\+t}} \mbox{\hyperlink{structciot__gpio__cfg__t_a5ee68c0e31fa06f342fad371023bdc4e}{pull}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT GPIO configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__gpio__cfg__t_a7d76e224ede8a4fa709cc3a505a81975}\label{structciot__gpio__cfg__t_a7d76e224ede8a4fa709cc3a505a81975} -\index{ciot\_gpio\_cfg\_t@{ciot\_gpio\_cfg\_t}!mode@{mode}} -\index{mode@{mode}!ciot\_gpio\_cfg\_t@{ciot\_gpio\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{mode}{mode}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ad768bc05ac4cc4639fe4cb7b8ab52c71}{ciot\+\_\+gpio\+\_\+mode\+\_\+t}} mode} - -Mode \Hypertarget{structciot__gpio__cfg__t_a3feeb7044549691a36c39cc7c9b2ed2c}\label{structciot__gpio__cfg__t_a3feeb7044549691a36c39cc7c9b2ed2c} -\index{ciot\_gpio\_cfg\_t@{ciot\_gpio\_cfg\_t}!pin\_mask@{pin\_mask}} -\index{pin\_mask@{pin\_mask}!ciot\_gpio\_cfg\_t@{ciot\_gpio\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{pin\_mask}{pin\_mask}} -{\footnotesize\ttfamily uint64\+\_\+t pin\+\_\+mask} - -Pin mask \Hypertarget{structciot__gpio__cfg__t_a5ee68c0e31fa06f342fad371023bdc4e}\label{structciot__gpio__cfg__t_a5ee68c0e31fa06f342fad371023bdc4e} -\index{ciot\_gpio\_cfg\_t@{ciot\_gpio\_cfg\_t}!pull@{pull}} -\index{pull@{pull}!ciot\_gpio\_cfg\_t@{ciot\_gpio\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{pull}{pull}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ae4bc515fbd35a99c9107751c09e69dfe}{ciot\+\_\+gpio\+\_\+pull\+\_\+mode\+\_\+t}} pull} - -Pull mode - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__gpio__req__get__state__t.tex b/docs/latex/structciot__gpio__req__get__state__t.tex deleted file mode 100644 index 8e2ec70..0000000 --- a/docs/latex/structciot__gpio__req__get__state__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+req\+\_\+get\+\_\+state\+\_\+t Struct Reference} -\hypertarget{structciot__gpio__req__get__state__t}{}\label{structciot__gpio__req__get__state__t}\index{ciot\_gpio\_req\_get\_state\_t@{ciot\_gpio\_req\_get\_state\_t}} - - -Structure for CIOT GPIO request to get state. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__gpio__req__get__state__t_a7beea8f6745c478347f244cadef771c2}{num}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT GPIO request to get state. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__gpio__req__get__state__t_a7beea8f6745c478347f244cadef771c2}\label{structciot__gpio__req__get__state__t_a7beea8f6745c478347f244cadef771c2} -\index{ciot\_gpio\_req\_get\_state\_t@{ciot\_gpio\_req\_get\_state\_t}!num@{num}} -\index{num@{num}!ciot\_gpio\_req\_get\_state\_t@{ciot\_gpio\_req\_get\_state\_t}} -\doxysubsubsection{\texorpdfstring{num}{num}} -{\footnotesize\ttfamily uint32\+\_\+t num} - -Number - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__gpio__req__t.tex b/docs/latex/structciot__gpio__req__t.tex deleted file mode 100644 index 10411ad..0000000 --- a/docs/latex/structciot__gpio__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__gpio__req__t}{}\label{structciot__gpio__req__t}\index{ciot\_gpio\_req\_t@{ciot\_gpio\_req\_t}} - - -Structure for CIOT GPIO request. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d}{ciot\+\_\+gpio\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__gpio__req__t_ab949dccfc732240972d8a27cf46f3e76}{type}} -\item -\mbox{\hyperlink{unionciot__gpio__req__data__u}{ciot\+\_\+gpio\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__gpio__req__t_a8742485122a2b9e44392d5d51ddc2076}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT GPIO request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__gpio__req__t_a8742485122a2b9e44392d5d51ddc2076}\label{structciot__gpio__req__t_a8742485122a2b9e44392d5d51ddc2076} -\index{ciot\_gpio\_req\_t@{ciot\_gpio\_req\_t}!data@{data}} -\index{data@{data}!ciot\_gpio\_req\_t@{ciot\_gpio\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__gpio__req__data__u}{ciot\+\_\+gpio\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__gpio__req__t_ab949dccfc732240972d8a27cf46f3e76}\label{structciot__gpio__req__t_ab949dccfc732240972d8a27cf46f3e76} -\index{ciot\_gpio\_req\_t@{ciot\_gpio\_req\_t}!type@{type}} -\index{type@{type}!ciot\_gpio\_req\_t@{ciot\_gpio\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_a86bf6bee2d4762a09459175504b9cc2d}{ciot\+\_\+gpio\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__gpio__state__info__t.tex b/docs/latex/structciot__gpio__state__info__t.tex deleted file mode 100644 index a936fba..0000000 --- a/docs/latex/structciot__gpio__state__info__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+state\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__gpio__state__info__t}{}\label{structciot__gpio__state__info__t}\index{ciot\_gpio\_state\_info\_t@{ciot\_gpio\_state\_info\_t}} - - -Structure for CIOT GPIO state information. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__gpio__state__info__t_a7beea8f6745c478347f244cadef771c2}{num}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__gpio__state__info__t_a939fe9a85b37a0ce4a0701b655c799ea}{state}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT GPIO state information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__gpio__state__info__t_a7beea8f6745c478347f244cadef771c2}\label{structciot__gpio__state__info__t_a7beea8f6745c478347f244cadef771c2} -\index{ciot\_gpio\_state\_info\_t@{ciot\_gpio\_state\_info\_t}!num@{num}} -\index{num@{num}!ciot\_gpio\_state\_info\_t@{ciot\_gpio\_state\_info\_t}} -\doxysubsubsection{\texorpdfstring{num}{num}} -{\footnotesize\ttfamily uint32\+\_\+t num} - -Number \Hypertarget{structciot__gpio__state__info__t_a939fe9a85b37a0ce4a0701b655c799ea}\label{structciot__gpio__state__info__t_a939fe9a85b37a0ce4a0701b655c799ea} -\index{ciot\_gpio\_state\_info\_t@{ciot\_gpio\_state\_info\_t}!state@{state}} -\index{state@{state}!ciot\_gpio\_state\_info\_t@{ciot\_gpio\_state\_info\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ac566dcf32b51c83a8f37164f23fc2cd9}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__gpio__status__msg__t.tex b/docs/latex/structciot__gpio__status__msg__t.tex deleted file mode 100644 index a0897c5..0000000 --- a/docs/latex/structciot__gpio__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__gpio__status__msg__t}{}\label{structciot__gpio__status__msg__t}\index{ciot\_gpio\_status\_msg\_t@{ciot\_gpio\_status\_msg\_t}} - - -Structure representing the CIOT GPIO status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__gpio__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__gpio__status__t}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__gpio__status__msg__t_af7b93aeb68c1648ccb2617ff8217e7b0}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing the CIOT GPIO status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__gpio__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__gpio__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_gpio\_status\_msg\_t@{ciot\_gpio\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_gpio\_status\_msg\_t@{ciot\_gpio\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header. \Hypertarget{structciot__gpio__status__msg__t_af7b93aeb68c1648ccb2617ff8217e7b0}\label{structciot__gpio__status__msg__t_af7b93aeb68c1648ccb2617ff8217e7b0} -\index{ciot\_gpio\_status\_msg\_t@{ciot\_gpio\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_gpio\_status\_msg\_t@{ciot\_gpio\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__gpio__status__t}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} status} - -GPIO status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__gpio_8h}{ciot\+\_\+gpio.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__gpio__status__t.tex b/docs/latex/structciot__gpio__status__t.tex deleted file mode 100644 index d68e4f5..0000000 --- a/docs/latex/structciot__gpio__status__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__gpio__status__t}{}\label{structciot__gpio__status__t}\index{ciot\_gpio\_status\_t@{ciot\_gpio\_status\_t}} - - -Structure for CIOT GPIO status. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint64\+\_\+t \mbox{\hyperlink{structciot__gpio__status__t_af557caa253a733e218e1e71c2a91eef4}{status\+\_\+mask}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT GPIO status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__gpio__status__t_af557caa253a733e218e1e71c2a91eef4}\label{structciot__gpio__status__t_af557caa253a733e218e1e71c2a91eef4} -\index{ciot\_gpio\_status\_t@{ciot\_gpio\_status\_t}!status\_mask@{status\_mask}} -\index{status\_mask@{status\_mask}!ciot\_gpio\_status\_t@{ciot\_gpio\_status\_t}} -\doxysubsubsection{\texorpdfstring{status\_mask}{status\_mask}} -{\footnotesize\ttfamily uint64\+\_\+t status\+\_\+mask} - -Status mask - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__httpc__cfg__t.tex b/docs/latex/structciot__httpc__cfg__t.tex deleted file mode 100644 index ea7e70b..0000000 --- a/docs/latex/structciot__httpc__cfg__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__httpc__cfg__t}{}\label{structciot__httpc__cfg__t}\index{ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}} - - -Structure for CIOT HTTP client configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__httpc__cfg__t_aa37877f676f256b0b0989f354000a1bf}{url}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ab32b0446ee870bfb7a79c056a81e6683}{CIOT\+\_\+\+HTTPC\+\_\+\+URL\+\_\+\+LEN}}\mbox{]} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7}{ciot\+\_\+httpc\+\_\+method\+\_\+t}} \mbox{\hyperlink{structciot__httpc__cfg__t_ad10985b96579c7c2030050715bcad45d}{method}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2}{ciot\+\_\+httpc\+\_\+transport\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__httpc__cfg__t_a7e007ade3b5b7cfcc2ee06d35d52d4e1}{transport}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__httpc__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}{timeout}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP client configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__httpc__cfg__t_ad10985b96579c7c2030050715bcad45d}\label{structciot__httpc__cfg__t_ad10985b96579c7c2030050715bcad45d} -\index{ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}!method@{method}} -\index{method@{method}!ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{method}{method}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_adb6734aba3ebc70d40f85695053de4a7}{ciot\+\_\+httpc\+\_\+method\+\_\+t}} method} - -HTTP method \Hypertarget{structciot__httpc__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}\label{structciot__httpc__cfg__t_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae} -\index{ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}!timeout@{timeout}} -\index{timeout@{timeout}!ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{timeout}{timeout}} -{\footnotesize\ttfamily uint16\+\_\+t timeout} - -Timeout \Hypertarget{structciot__httpc__cfg__t_a7e007ade3b5b7cfcc2ee06d35d52d4e1}\label{structciot__httpc__cfg__t_a7e007ade3b5b7cfcc2ee06d35d52d4e1} -\index{ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}!transport@{transport}} -\index{transport@{transport}!ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{transport}{transport}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_ae5d45fa37052b0149488422933d4b7c2}{ciot\+\_\+httpc\+\_\+transport\+\_\+type\+\_\+t}} transport} - -Transport type \Hypertarget{structciot__httpc__cfg__t_aa37877f676f256b0b0989f354000a1bf}\label{structciot__httpc__cfg__t_aa37877f676f256b0b0989f354000a1bf} -\index{ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}!url@{url}} -\index{url@{url}!ciot\_httpc\_cfg\_t@{ciot\_httpc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{url}{url}} -{\footnotesize\ttfamily char url\mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ab32b0446ee870bfb7a79c056a81e6683}{CIOT\+\_\+\+HTTPC\+\_\+\+URL\+\_\+\+LEN}}\mbox{]}} - -URL - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__httpc__event__data.tex b/docs/latex/structciot__httpc__event__data.tex deleted file mode 100644 index 9dac3a5..0000000 --- a/docs/latex/structciot__httpc__event__data.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+event\+\_\+data Struct Reference} -\hypertarget{structciot__httpc__event__data}{}\label{structciot__httpc__event__data}\index{ciot\_httpc\_event\_data@{ciot\_httpc\_event\_data}} - - -Structure for CIOT HTTP client event data. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__httpc__event__data_ac824ce50cc96c6354577281b657d14b6}{body}} -\item -char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__httpc__event__data_ab135e5154c1828bef226a3df98ee3333}{url}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP client event data. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__httpc__event__data_ac824ce50cc96c6354577281b657d14b6}\label{structciot__httpc__event__data_ac824ce50cc96c6354577281b657d14b6} -\index{ciot\_httpc\_event\_data@{ciot\_httpc\_event\_data}!body@{body}} -\index{body@{body}!ciot\_httpc\_event\_data@{ciot\_httpc\_event\_data}} -\doxysubsubsection{\texorpdfstring{body}{body}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} body} - -Event body \Hypertarget{structciot__httpc__event__data_ab135e5154c1828bef226a3df98ee3333}\label{structciot__httpc__event__data_ab135e5154c1828bef226a3df98ee3333} -\index{ciot\_httpc\_event\_data@{ciot\_httpc\_event\_data}!url@{url}} -\index{url@{url}!ciot\_httpc\_event\_data@{ciot\_httpc\_event\_data}} -\doxysubsubsection{\texorpdfstring{url}{url}} -{\footnotesize\ttfamily char\texorpdfstring{$\ast$}{*} url} - -URL - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__httpc__req__send__t.tex b/docs/latex/structciot__httpc__req__send__t.tex deleted file mode 100644 index 752e365..0000000 --- a/docs/latex/structciot__httpc__req__send__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+req\+\_\+send\+\_\+t Struct Reference} -\hypertarget{structciot__httpc__req__send__t}{}\label{structciot__httpc__req__send__t}\index{ciot\_httpc\_req\_send\_t@{ciot\_httpc\_req\_send\_t}} - - -Structure for CIOT HTTP client send data request. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structciot__httpc__req__send__t_a301d9747f184171d8a1ee19d25d8e4ab}{cfg}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__httpc__req__send__t_afc1b0964d9fa89030c055cbc08315c58}{body}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd}{CIOT\+\_\+\+HTTPC\+\_\+\+BODY\+\_\+\+LEN}}\mbox{]} -\item -int \mbox{\hyperlink{structciot__httpc__req__send__t_a675a47f46ecd9d8ec01c738e04c28cbe}{content\+\_\+length}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP client send data request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__httpc__req__send__t_afc1b0964d9fa89030c055cbc08315c58}\label{structciot__httpc__req__send__t_afc1b0964d9fa89030c055cbc08315c58} -\index{ciot\_httpc\_req\_send\_t@{ciot\_httpc\_req\_send\_t}!body@{body}} -\index{body@{body}!ciot\_httpc\_req\_send\_t@{ciot\_httpc\_req\_send\_t}} -\doxysubsubsection{\texorpdfstring{body}{body}} -{\footnotesize\ttfamily uint8\+\_\+t body\mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd}{CIOT\+\_\+\+HTTPC\+\_\+\+BODY\+\_\+\+LEN}}\mbox{]}} - -Body \Hypertarget{structciot__httpc__req__send__t_a301d9747f184171d8a1ee19d25d8e4ab}\label{structciot__httpc__req__send__t_a301d9747f184171d8a1ee19d25d8e4ab} -\index{ciot\_httpc\_req\_send\_t@{ciot\_httpc\_req\_send\_t}!cfg@{cfg}} -\index{cfg@{cfg}!ciot\_httpc\_req\_send\_t@{ciot\_httpc\_req\_send\_t}} -\doxysubsubsection{\texorpdfstring{cfg}{cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} cfg} - -Configuration \Hypertarget{structciot__httpc__req__send__t_a675a47f46ecd9d8ec01c738e04c28cbe}\label{structciot__httpc__req__send__t_a675a47f46ecd9d8ec01c738e04c28cbe} -\index{ciot\_httpc\_req\_send\_t@{ciot\_httpc\_req\_send\_t}!content\_length@{content\_length}} -\index{content\_length@{content\_length}!ciot\_httpc\_req\_send\_t@{ciot\_httpc\_req\_send\_t}} -\doxysubsubsection{\texorpdfstring{content\_length}{content\_length}} -{\footnotesize\ttfamily int content\+\_\+length} - -Content length - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__httpc__req__set__header__t.tex b/docs/latex/structciot__httpc__req__set__header__t.tex deleted file mode 100644 index bc8c63e..0000000 --- a/docs/latex/structciot__httpc__req__set__header__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+req\+\_\+set\+\_\+header\+\_\+t Struct Reference} -\hypertarget{structciot__httpc__req__set__header__t}{}\label{structciot__httpc__req__set__header__t}\index{ciot\_httpc\_req\_set\_header\_t@{ciot\_httpc\_req\_set\_header\_t}} - - -Structure for CIOT HTTP client set header request. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__httpc__req__set__header__t_a376ba7d15e815aecda5b6276de7ff292}{header}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structciot__httpc__req__set__header__t_a82c2b14036a5b80ae9b5a4a6e2812a44}{value}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+VAL}}\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP client set header request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__httpc__req__set__header__t_a376ba7d15e815aecda5b6276de7ff292}\label{structciot__httpc__req__set__header__t_a376ba7d15e815aecda5b6276de7ff292} -\index{ciot\_httpc\_req\_set\_header\_t@{ciot\_httpc\_req\_set\_header\_t}!header@{header}} -\index{header@{header}!ciot\_httpc\_req\_set\_header\_t@{ciot\_httpc\_req\_set\_header\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily char header\mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+LEN}}\mbox{]}} - -Header \Hypertarget{structciot__httpc__req__set__header__t_a82c2b14036a5b80ae9b5a4a6e2812a44}\label{structciot__httpc__req__set__header__t_a82c2b14036a5b80ae9b5a4a6e2812a44} -\index{ciot\_httpc\_req\_set\_header\_t@{ciot\_httpc\_req\_set\_header\_t}!value@{value}} -\index{value@{value}!ciot\_httpc\_req\_set\_header\_t@{ciot\_httpc\_req\_set\_header\_t}} -\doxysubsubsection{\texorpdfstring{value}{value}} -{\footnotesize\ttfamily char value\mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+VAL}}\mbox{]}} - -Value - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__httpc__req__t.tex b/docs/latex/structciot__httpc__req__t.tex deleted file mode 100644 index d85ed5c..0000000 --- a/docs/latex/structciot__httpc__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__httpc__req__t}{}\label{structciot__httpc__req__t}\index{ciot\_httpc\_req\_t@{ciot\_httpc\_req\_t}} - - -Structure for CIOT HTTP client request. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb}{ciot\+\_\+httpc\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__httpc__req__t_ac4330d2b9fc6473e00966f8dd66a477c}{type}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}{ciot\+\_\+httpc\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__httpc__req__t_a3623cfec7a7da849fd22ce7ec1c3e10f}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP client request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__httpc__req__t_a3623cfec7a7da849fd22ce7ec1c3e10f}\label{structciot__httpc__req__t_a3623cfec7a7da849fd22ce7ec1c3e10f} -\index{ciot\_httpc\_req\_t@{ciot\_httpc\_req\_t}!data@{data}} -\index{data@{data}!ciot\_httpc\_req\_t@{ciot\_httpc\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}{ciot\+\_\+httpc\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__httpc__req__t_ac4330d2b9fc6473e00966f8dd66a477c}\label{structciot__httpc__req__t_ac4330d2b9fc6473e00966f8dd66a477c} -\index{ciot\_httpc\_req\_t@{ciot\_httpc\_req\_t}!type@{type}} -\index{type@{type}!ciot\_httpc\_req\_t@{ciot\_httpc\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a2b96aed46d17bb281ae66a3ed099c4cb}{ciot\+\_\+httpc\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__httpc__status__msg__t.tex b/docs/latex/structciot__httpc__status__msg__t.tex deleted file mode 100644 index 2fc476d..0000000 --- a/docs/latex/structciot__httpc__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__httpc__status__msg__t}{}\label{structciot__httpc__status__msg__t}\index{ciot\_httpc\_status\_msg\_t@{ciot\_httpc\_status\_msg\_t}} - - -Structure representing the CIOT HTTP client status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__httpc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__httpc__status__t}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__httpc__status__msg__t_ac5c1eb82650b9d0161a399175c459ad3}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing the CIOT HTTP client status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__httpc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__httpc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_httpc\_status\_msg\_t@{ciot\_httpc\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_httpc\_status\_msg\_t@{ciot\_httpc\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header. \Hypertarget{structciot__httpc__status__msg__t_ac5c1eb82650b9d0161a399175c459ad3}\label{structciot__httpc__status__msg__t_ac5c1eb82650b9d0161a399175c459ad3} -\index{ciot\_httpc\_status\_msg\_t@{ciot\_httpc\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_httpc\_status\_msg\_t@{ciot\_httpc\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__httpc__status__t}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} status} - -HTTP client status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__httpc_8h}{ciot\+\_\+httpc.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__httpc__status__t.tex b/docs/latex/structciot__httpc__status__t.tex deleted file mode 100644 index 91661c3..0000000 --- a/docs/latex/structciot__httpc__status__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__httpc__status__t}{}\label{structciot__httpc__status__t}\index{ciot\_httpc\_status\_t@{ciot\_httpc\_status\_t}} - - -Structure for CIOT HTTP client status. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5}{ciot\+\_\+httpc\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__httpc__status__t_a37c663f5a0040d827e450c52efe59882}{state}} -\item -int \mbox{\hyperlink{structciot__httpc__status__t_a11614f44ef4d939bdd984953346a7572}{error}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP client status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__httpc__status__t_a11614f44ef4d939bdd984953346a7572}\label{structciot__httpc__status__t_a11614f44ef4d939bdd984953346a7572} -\index{ciot\_httpc\_status\_t@{ciot\_httpc\_status\_t}!error@{error}} -\index{error@{error}!ciot\_httpc\_status\_t@{ciot\_httpc\_status\_t}} -\doxysubsubsection{\texorpdfstring{error}{error}} -{\footnotesize\ttfamily int error} - -Error \Hypertarget{structciot__httpc__status__t_a37c663f5a0040d827e450c52efe59882}\label{structciot__httpc__status__t_a37c663f5a0040d827e450c52efe59882} -\index{ciot\_httpc\_status\_t@{ciot\_httpc\_status\_t}!state@{state}} -\index{state@{state}!ciot\_httpc\_status\_t@{ciot\_httpc\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_aaaa5ea5ab9829620d53957b82e15e5b5}{ciot\+\_\+httpc\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__https__cfg__t.tex b/docs/latex/structciot__https__cfg__t.tex deleted file mode 100644 index f262a2d..0000000 --- a/docs/latex/structciot__https__cfg__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__https__cfg__t}{}\label{structciot__https__cfg__t}\index{ciot\_https\_cfg\_t@{ciot\_https\_cfg\_t}} - - -Structure for CIOT HTTP server configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+https\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__https__cfg__t_aaf2deef29cfe3fe5b18f00f49ff23d42}{address}} \mbox{[}\mbox{\hyperlink{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623}{CIOT\+\_\+\+HTTPS\+\_\+\+ADDRESS\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structciot__https__cfg__t_a98bcbc9e1ebf74ba486f246d76f5bac1}{route}} \mbox{[}\mbox{\hyperlink{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749}{CIOT\+\_\+\+HTTPS\+\_\+\+ROUTE\+\_\+\+LEN}}\mbox{]} -\item -int \mbox{\hyperlink{structciot__https__cfg__t_a63c89c04d1feae07ca35558055155ffb}{port}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP server configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__https__cfg__t_aaf2deef29cfe3fe5b18f00f49ff23d42}\label{structciot__https__cfg__t_aaf2deef29cfe3fe5b18f00f49ff23d42} -\index{ciot\_https\_cfg\_t@{ciot\_https\_cfg\_t}!address@{address}} -\index{address@{address}!ciot\_https\_cfg\_t@{ciot\_https\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{address}{address}} -{\footnotesize\ttfamily char address\mbox{[}\mbox{\hyperlink{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623}{CIOT\+\_\+\+HTTPS\+\_\+\+ADDRESS\+\_\+\+LEN}}\mbox{]}} - -Address \Hypertarget{structciot__https__cfg__t_a63c89c04d1feae07ca35558055155ffb}\label{structciot__https__cfg__t_a63c89c04d1feae07ca35558055155ffb} -\index{ciot\_https\_cfg\_t@{ciot\_https\_cfg\_t}!port@{port}} -\index{port@{port}!ciot\_https\_cfg\_t@{ciot\_https\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{port}{port}} -{\footnotesize\ttfamily int port} - -Port \Hypertarget{structciot__https__cfg__t_a98bcbc9e1ebf74ba486f246d76f5bac1}\label{structciot__https__cfg__t_a98bcbc9e1ebf74ba486f246d76f5bac1} -\index{ciot\_https\_cfg\_t@{ciot\_https\_cfg\_t}!route@{route}} -\index{route@{route}!ciot\_https\_cfg\_t@{ciot\_https\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{route}{route}} -{\footnotesize\ttfamily char route\mbox{[}\mbox{\hyperlink{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749}{CIOT\+\_\+\+HTTPS\+\_\+\+ROUTE\+\_\+\+LEN}}\mbox{]}} - -Route - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__https__event.tex b/docs/latex/structciot__https__event.tex deleted file mode 100644 index e24886d..0000000 --- a/docs/latex/structciot__https__event.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+event Struct Reference} -\hypertarget{structciot__https__event}{}\label{structciot__https__event}\index{ciot\_https\_event@{ciot\_https\_event}} - - -Union for CIOT HTTP server event. - - - - -{\ttfamily \#include $<$ciot\+\_\+https\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__https__types_8h_a2c6c4aa32536b02785ca49d2716498b3}{ciot\+\_\+https\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__https__event_af26174e3b6aead3c5f7d4deea8ea6fc0}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT HTTP server event. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__https__event_af26174e3b6aead3c5f7d4deea8ea6fc0}\label{structciot__https__event_af26174e3b6aead3c5f7d4deea8ea6fc0} -\index{ciot\_https\_event@{ciot\_https\_event}!data@{data}} -\index{data@{data}!ciot\_https\_event@{ciot\_https\_event}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_a2c6c4aa32536b02785ca49d2716498b3}{ciot\+\_\+https\+\_\+event\+\_\+data\+\_\+t}} data} - -Event data - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__https__event__data.tex b/docs/latex/structciot__https__event__data.tex deleted file mode 100644 index 60ec0bd..0000000 --- a/docs/latex/structciot__https__event__data.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+event\+\_\+data Struct Reference} -\hypertarget{structciot__https__event__data}{}\label{structciot__https__event__data}\index{ciot\_https\_event\_data@{ciot\_https\_event\_data}} - - -Structure for CIOT HTTP server event data. - - - - -{\ttfamily \#include $<$ciot\+\_\+https\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__https__event__data_ac824ce50cc96c6354577281b657d14b6}{body}} -\item -\mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__https__event__data_ad31b04303ebf9721f2537ea359199783}{url}} -\item -\mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__https__event__data_af63c670f07c4a0a799e8581e95d4810e}{method}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP server event data. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__https__event__data_ac824ce50cc96c6354577281b657d14b6}\label{structciot__https__event__data_ac824ce50cc96c6354577281b657d14b6} -\index{ciot\_https\_event\_data@{ciot\_https\_event\_data}!body@{body}} -\index{body@{body}!ciot\_https\_event\_data@{ciot\_https\_event\_data}} -\doxysubsubsection{\texorpdfstring{body}{body}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} body} - -Event body \Hypertarget{structciot__https__event__data_af63c670f07c4a0a799e8581e95d4810e}\label{structciot__https__event__data_af63c670f07c4a0a799e8581e95d4810e} -\index{ciot\_https\_event\_data@{ciot\_https\_event\_data}!method@{method}} -\index{method@{method}!ciot\_https\_event\_data@{ciot\_https\_event\_data}} -\doxysubsubsection{\texorpdfstring{method}{method}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} method} - -Method \Hypertarget{structciot__https__event__data_ad31b04303ebf9721f2537ea359199783}\label{structciot__https__event__data_ad31b04303ebf9721f2537ea359199783} -\index{ciot\_https\_event\_data@{ciot\_https\_event\_data}!url@{url}} -\index{url@{url}!ciot\_https\_event\_data@{ciot\_https\_event\_data}} -\doxysubsubsection{\texorpdfstring{url}{url}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} url} - -URL - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__https__req__t.tex b/docs/latex/structciot__https__req__t.tex deleted file mode 100644 index d4af749..0000000 --- a/docs/latex/structciot__https__req__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__https__req__t}{}\label{structciot__https__req__t}\index{ciot\_https\_req\_t@{ciot\_https\_req\_t}} - - -Structure for CIOT HTTP server request. - - - - -{\ttfamily \#include $<$ciot\+\_\+https\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3}{ciot\+\_\+https\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__https__req__t_adf00e5263d183b9b74cd9dd06dd98856}{type}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP server request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__https__req__t_adf00e5263d183b9b74cd9dd06dd98856}\label{structciot__https__req__t_adf00e5263d183b9b74cd9dd06dd98856} -\index{ciot\_https\_req\_t@{ciot\_https\_req\_t}!type@{type}} -\index{type@{type}!ciot\_https\_req\_t@{ciot\_https\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_ade314c7fe1c013e8f3e60935bc820de3}{ciot\+\_\+https\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__https__status__msg__t.tex b/docs/latex/structciot__https__status__msg__t.tex deleted file mode 100644 index b1f9be2..0000000 --- a/docs/latex/structciot__https__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__https__status__msg__t}{}\label{structciot__https__status__msg__t}\index{ciot\_https\_status\_msg\_t@{ciot\_https\_status\_msg\_t}} - - -Structure representing the CIOT HTTP server status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+https.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__https__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__https__status__t}{ciot\+\_\+https\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__https__status__msg__t_ae71d44b4ec9b04f2b3eb183ae791f6ca}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing the CIOT HTTP server status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__https__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__https__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_https\_status\_msg\_t@{ciot\_https\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_https\_status\_msg\_t@{ciot\_https\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header. \Hypertarget{structciot__https__status__msg__t_ae71d44b4ec9b04f2b3eb183ae791f6ca}\label{structciot__https__status__msg__t_ae71d44b4ec9b04f2b3eb183ae791f6ca} -\index{ciot\_https\_status\_msg\_t@{ciot\_https\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_https\_status\_msg\_t@{ciot\_https\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__https__status__t}{ciot\+\_\+https\+\_\+status\+\_\+t}} status} - -HTTP server status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__https_8h}{ciot\+\_\+https.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__https__status__t.tex b/docs/latex/structciot__https__status__t.tex deleted file mode 100644 index 1b4d805..0000000 --- a/docs/latex/structciot__https__status__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__https__status__t}{}\label{structciot__https__status__t}\index{ciot\_https\_status\_t@{ciot\_https\_status\_t}} - - -Structure for CIOT HTTP server status. - - - - -{\ttfamily \#include $<$ciot\+\_\+https\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd}{ciot\+\_\+https\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__https__status__t_a28c09b101362530d97e51b712b741f63}{state}} -\item -int \mbox{\hyperlink{structciot__https__status__t_a11614f44ef4d939bdd984953346a7572}{error}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT HTTP server status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__https__status__t_a11614f44ef4d939bdd984953346a7572}\label{structciot__https__status__t_a11614f44ef4d939bdd984953346a7572} -\index{ciot\_https\_status\_t@{ciot\_https\_status\_t}!error@{error}} -\index{error@{error}!ciot\_https\_status\_t@{ciot\_https\_status\_t}} -\doxysubsubsection{\texorpdfstring{error}{error}} -{\footnotesize\ttfamily int error} - -Error \Hypertarget{structciot__https__status__t_a28c09b101362530d97e51b712b741f63}\label{structciot__https__status__t_a28c09b101362530d97e51b712b741f63} -\index{ciot\_https\_status\_t@{ciot\_https\_status\_t}!state@{state}} -\index{state@{state}!ciot\_https\_status\_t@{ciot\_https\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_a17a6b65526ea731de25e9da2f1fad0fd}{ciot\+\_\+https\+\_\+state\+\_\+t}} state} - -State - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__iface.tex b/docs/latex/structciot__iface.tex deleted file mode 100644 index 1fb5ee7..0000000 --- a/docs/latex/structciot__iface.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+iface Struct Reference} -\hypertarget{structciot__iface}{}\label{structciot__iface}\index{ciot\_iface@{ciot\_iface}} - - -Structure representing a CIOT interface. - - - - -{\ttfamily \#include $<$ciot\+\_\+iface.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__iface_8h_abe9d78b6b8e29546fe52054115bea7a0}{ciot\+\_\+iface\+\_\+base\+\_\+t}} \mbox{\hyperlink{structciot__iface_a853cb7e7d6095705dfa3c0cef66ec736}{base}} -\item -\mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__iface_a3d19d97719cf13cda1f021cf5dbaabb6}{info}} -\item -\mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface_a6c29272de72de0546f7cb703993eb1f5}{event\+\_\+handler}} -\item -\mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}} \mbox{\hyperlink{structciot__iface_ae1afa3b8277cc9c96f891782785c4b34}{serializer}} -\item -void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface_a702f51681c5c1dd8d6ad5aaa41d80f29}{event\+\_\+args}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing a CIOT interface. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__iface_a853cb7e7d6095705dfa3c0cef66ec736}\label{structciot__iface_a853cb7e7d6095705dfa3c0cef66ec736} -\index{ciot\_iface@{ciot\_iface}!base@{base}} -\index{base@{base}!ciot\_iface@{ciot\_iface}} -\doxysubsubsection{\texorpdfstring{base}{base}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_abe9d78b6b8e29546fe52054115bea7a0}{ciot\+\_\+iface\+\_\+base\+\_\+t}} base} - -Base of the interface. \Hypertarget{structciot__iface_a702f51681c5c1dd8d6ad5aaa41d80f29}\label{structciot__iface_a702f51681c5c1dd8d6ad5aaa41d80f29} -\index{ciot\_iface@{ciot\_iface}!event\_args@{event\_args}} -\index{event\_args@{event\_args}!ciot\_iface@{ciot\_iface}} -\doxysubsubsection{\texorpdfstring{event\_args}{event\_args}} -{\footnotesize\ttfamily void\texorpdfstring{$\ast$}{*} event\+\_\+args} - -Event arguments. \Hypertarget{structciot__iface_a6c29272de72de0546f7cb703993eb1f5}\label{structciot__iface_a6c29272de72de0546f7cb703993eb1f5} -\index{ciot\_iface@{ciot\_iface}!event\_handler@{event\_handler}} -\index{event\_handler@{event\_handler}!ciot\_iface@{ciot\_iface}} -\doxysubsubsection{\texorpdfstring{event\_handler}{event\_handler}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_aa95e39f8029362c17172c4ab860b9b2c}{ciot\+\_\+iface\+\_\+event\+\_\+handler\+\_\+t}}\texorpdfstring{$\ast$}{*} event\+\_\+handler} - -Event handler function pointer. \Hypertarget{structciot__iface_a3d19d97719cf13cda1f021cf5dbaabb6}\label{structciot__iface_a3d19d97719cf13cda1f021cf5dbaabb6} -\index{ciot\_iface@{ciot\_iface}!info@{info}} -\index{info@{info}!ciot\_iface@{ciot\_iface}} -\doxysubsubsection{\texorpdfstring{info}{info}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} info} - -Interface information. \Hypertarget{structciot__iface_ae1afa3b8277cc9c96f891782785c4b34}\label{structciot__iface_ae1afa3b8277cc9c96f891782785c4b34} -\index{ciot\_iface@{ciot\_iface}!serializer@{serializer}} -\index{serializer@{serializer}!ciot\_iface@{ciot\_iface}} -\doxysubsubsection{\texorpdfstring{serializer}{serializer}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__serializer_8h_ad996f78559d787df7e8f20e6e2c837ac}{ciot\+\_\+serializer\+\_\+t}} serializer} - -Serializer for the interface. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__iface__base.tex b/docs/latex/structciot__iface__base.tex deleted file mode 100644 index 35651e4..0000000 --- a/docs/latex/structciot__iface__base.tex +++ /dev/null @@ -1,89 +0,0 @@ -\doxysection{ciot\+\_\+iface\+\_\+base Struct Reference} -\hypertarget{structciot__iface__base}{}\label{structciot__iface__base}\index{ciot\_iface\_base@{ciot\_iface\_base}} - - -Structure representing the base of an interface. - - - - -{\ttfamily \#include $<$ciot\+\_\+iface.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface__base_add9af9569af79ec26dd741fb226b38ba}{ptr}} -\item -\mbox{\hyperlink{ciot__iface_8h_afa768ec7c39932d18718c66358303d16}{ciot\+\_\+iface\+\_\+start\+\_\+fn}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface__base_abd070cd5170ccae6d490974e511dd41b}{start}} -\item -\mbox{\hyperlink{ciot__iface_8h_adbb3382dd13c68ed5090d0021bfd8f29}{ciot\+\_\+iface\+\_\+stop\+\_\+fn}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface__base_ac99445311cef9672f346b7a3ab22d879}{stop}} -\item -\mbox{\hyperlink{ciot__iface_8h_ae586597c42a97043136f6afe51e7ebe8}{ciot\+\_\+iface\+\_\+process\+\_\+req\+\_\+fn}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface__base_ae2b271bbc55ea5a64e70f8566010f2cb}{process\+\_\+req}} -\item -\mbox{\hyperlink{ciot__iface_8h_affffc532ae0b36b941fc0ed0376a0a5a}{ciot\+\_\+iface\+\_\+send\+\_\+data\+\_\+fn}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface__base_ad0e5b143f45f5ccb026a527086ddb15f}{send\+\_\+data}} -\item -\mbox{\hyperlink{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}{ciot\+\_\+iface\+\_\+base\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__iface__base_a6894fb208d021352bc4a53806a2a38dc}{cfg}} -\item -\mbox{\hyperlink{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}{ciot\+\_\+iface\+\_\+base\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__iface__base_ac0223aea9839f62092995675d1e38339}{status}} -\item -\mbox{\hyperlink{ciot__iface_8h_a3c7fbbc6d64e6ea8584c014743e20fb9}{ciot\+\_\+iface\+\_\+req\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__iface__base_aa04a90d2225ba674bcdc0c62f4a78c2c}{req}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing the base of an interface. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__iface__base_a6894fb208d021352bc4a53806a2a38dc}\label{structciot__iface__base_a6894fb208d021352bc4a53806a2a38dc} -\index{ciot\_iface\_base@{ciot\_iface\_base}!cfg@{cfg}} -\index{cfg@{cfg}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{cfg}{cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}{ciot\+\_\+iface\+\_\+base\+\_\+data\+\_\+t}} cfg} - -Configuration data. \Hypertarget{structciot__iface__base_ae2b271bbc55ea5a64e70f8566010f2cb}\label{structciot__iface__base_ae2b271bbc55ea5a64e70f8566010f2cb} -\index{ciot\_iface\_base@{ciot\_iface\_base}!process\_req@{process\_req}} -\index{process\_req@{process\_req}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{process\_req}{process\_req}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_ae586597c42a97043136f6afe51e7ebe8}{ciot\+\_\+iface\+\_\+process\+\_\+req\+\_\+fn}}\texorpdfstring{$\ast$}{*} process\+\_\+req} - -Function pointer for processing a request. \Hypertarget{structciot__iface__base_add9af9569af79ec26dd741fb226b38ba}\label{structciot__iface__base_add9af9569af79ec26dd741fb226b38ba} -\index{ciot\_iface\_base@{ciot\_iface\_base}!ptr@{ptr}} -\index{ptr@{ptr}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{ptr}{ptr}} -{\footnotesize\ttfamily void\texorpdfstring{$\ast$}{*} ptr} - -Pointer to interface data. \Hypertarget{structciot__iface__base_aa04a90d2225ba674bcdc0c62f4a78c2c}\label{structciot__iface__base_aa04a90d2225ba674bcdc0c62f4a78c2c} -\index{ciot\_iface\_base@{ciot\_iface\_base}!req@{req}} -\index{req@{req}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{req}{req}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_a3c7fbbc6d64e6ea8584c014743e20fb9}{ciot\+\_\+iface\+\_\+req\+\_\+info\+\_\+t}} req} - -Request information. \Hypertarget{structciot__iface__base_ad0e5b143f45f5ccb026a527086ddb15f}\label{structciot__iface__base_ad0e5b143f45f5ccb026a527086ddb15f} -\index{ciot\_iface\_base@{ciot\_iface\_base}!send\_data@{send\_data}} -\index{send\_data@{send\_data}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{send\_data}{send\_data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_affffc532ae0b36b941fc0ed0376a0a5a}{ciot\+\_\+iface\+\_\+send\+\_\+data\+\_\+fn}}\texorpdfstring{$\ast$}{*} send\+\_\+data} - -Function pointer for sending data. \Hypertarget{structciot__iface__base_abd070cd5170ccae6d490974e511dd41b}\label{structciot__iface__base_abd070cd5170ccae6d490974e511dd41b} -\index{ciot\_iface\_base@{ciot\_iface\_base}!start@{start}} -\index{start@{start}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{start}{start}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_afa768ec7c39932d18718c66358303d16}{ciot\+\_\+iface\+\_\+start\+\_\+fn}}\texorpdfstring{$\ast$}{*} start} - -Function pointer for starting the interface. \Hypertarget{structciot__iface__base_ac0223aea9839f62092995675d1e38339}\label{structciot__iface__base_ac0223aea9839f62092995675d1e38339} -\index{ciot\_iface\_base@{ciot\_iface\_base}!status@{status}} -\index{status@{status}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_a107b2c0cf1b5767a1b482f19bc3fb0ae}{ciot\+\_\+iface\+\_\+base\+\_\+data\+\_\+t}} status} - -Status data. \Hypertarget{structciot__iface__base_ac99445311cef9672f346b7a3ab22d879}\label{structciot__iface__base_ac99445311cef9672f346b7a3ab22d879} -\index{ciot\_iface\_base@{ciot\_iface\_base}!stop@{stop}} -\index{stop@{stop}!ciot\_iface\_base@{ciot\_iface\_base}} -\doxysubsubsection{\texorpdfstring{stop}{stop}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_adbb3382dd13c68ed5090d0021bfd8f29}{ciot\+\_\+iface\+\_\+stop\+\_\+fn}}\texorpdfstring{$\ast$}{*} stop} - -Function pointer for stopping the interface. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__iface__base__data.tex b/docs/latex/structciot__iface__base__data.tex deleted file mode 100644 index 5243283..0000000 --- a/docs/latex/structciot__iface__base__data.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+iface\+\_\+base\+\_\+data Struct Reference} -\hypertarget{structciot__iface__base__data}{}\label{structciot__iface__base__data}\index{ciot\_iface\_base\_data@{ciot\_iface\_base\_data}} - - -Structure representing base data for an interface. - - - - -{\ttfamily \#include $<$ciot\+\_\+iface.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface__base__data_add9af9569af79ec26dd741fb226b38ba}{ptr}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__iface__base__data_aaba88b24a21a6c70c895c0d55f4a69a0}{size}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing base data for an interface. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__iface__base__data_add9af9569af79ec26dd741fb226b38ba}\label{structciot__iface__base__data_add9af9569af79ec26dd741fb226b38ba} -\index{ciot\_iface\_base\_data@{ciot\_iface\_base\_data}!ptr@{ptr}} -\index{ptr@{ptr}!ciot\_iface\_base\_data@{ciot\_iface\_base\_data}} -\doxysubsubsection{\texorpdfstring{ptr}{ptr}} -{\footnotesize\ttfamily void\texorpdfstring{$\ast$}{*} ptr} - -Pointer to data. \Hypertarget{structciot__iface__base__data_aaba88b24a21a6c70c895c0d55f4a69a0}\label{structciot__iface__base__data_aaba88b24a21a6c70c895c0d55f4a69a0} -\index{ciot\_iface\_base\_data@{ciot\_iface\_base\_data}!size@{size}} -\index{size@{size}!ciot\_iface\_base\_data@{ciot\_iface\_base\_data}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily uint16\+\_\+t size} - -Size of data. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__iface__cfg__t.tex b/docs/latex/structciot__iface__cfg__t.tex deleted file mode 100644 index dd84c55..0000000 --- a/docs/latex/structciot__iface__cfg__t.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+iface\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__iface__cfg__t}{}\label{structciot__iface__cfg__t}\index{ciot\_iface\_cfg\_t@{ciot\_iface\_cfg\_t}} - - -Structure for CIOT interface configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Structure for CIOT interface configuration. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__iface__event__t.tex b/docs/latex/structciot__iface__event__t.tex deleted file mode 100644 index 399a8e9..0000000 --- a/docs/latex/structciot__iface__event__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+iface\+\_\+event\+\_\+t Struct Reference} -\hypertarget{structciot__iface__event__t}{}\label{structciot__iface__event__t}\index{ciot\_iface\_event\_t@{ciot\_iface\_event\_t}} - - -Structure representing an interface event. - - - - -{\ttfamily \#include $<$ciot\+\_\+iface.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}{ciot\+\_\+iface\+\_\+event\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__iface__event__t_a5cd16071ec4ec2b6bb4c625e53b07c5b}{type}} -\item -\mbox{\hyperlink{unionciot__iface__event__data__u}{ciot\+\_\+iface\+\_\+event\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__iface__event__t_a6714610a8d6e593a48b14b3c5600fef0}{data}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__iface__event__t_aaba88b24a21a6c70c895c0d55f4a69a0}{size}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing an interface event. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__iface__event__t_a6714610a8d6e593a48b14b3c5600fef0}\label{structciot__iface__event__t_a6714610a8d6e593a48b14b3c5600fef0} -\index{ciot\_iface\_event\_t@{ciot\_iface\_event\_t}!data@{data}} -\index{data@{data}!ciot\_iface\_event\_t@{ciot\_iface\_event\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__iface__event__data__u}{ciot\+\_\+iface\+\_\+event\+\_\+data\+\_\+u}}\texorpdfstring{$\ast$}{*} data} - -Event data. \Hypertarget{structciot__iface__event__t_aaba88b24a21a6c70c895c0d55f4a69a0}\label{structciot__iface__event__t_aaba88b24a21a6c70c895c0d55f4a69a0} -\index{ciot\_iface\_event\_t@{ciot\_iface\_event\_t}!size@{size}} -\index{size@{size}!ciot\_iface\_event\_t@{ciot\_iface\_event\_t}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily uint16\+\_\+t size} - -Size of the event data. \Hypertarget{structciot__iface__event__t_a5cd16071ec4ec2b6bb4c625e53b07c5b}\label{structciot__iface__event__t_a5cd16071ec4ec2b6bb4c625e53b07c5b} -\index{ciot\_iface\_event\_t@{ciot\_iface\_event\_t}!type@{type}} -\index{type@{type}!ciot\_iface\_event\_t@{ciot\_iface\_event\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}{ciot\+\_\+iface\+\_\+event\+\_\+type\+\_\+t}} type} - -Event type. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__iface__req__info.tex b/docs/latex/structciot__iface__req__info.tex deleted file mode 100644 index e82f6e7..0000000 --- a/docs/latex/structciot__iface__req__info.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+iface\+\_\+req\+\_\+info Struct Reference} -\hypertarget{structciot__iface__req__info}{}\label{structciot__iface__req__info}\index{ciot\_iface\_req\_info@{ciot\_iface\_req\_info}} - - -Structure representing request information for an interface. - - - - -{\ttfamily \#include $<$ciot\+\_\+iface.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\+\_\+iface\+\_\+req\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__iface__req__info_a2a773bc681a41b29b21f8c106c0161ef}{status}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__iface__req__info_a1e6927fa1486224044e568f9c370519b}{id}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__iface__req__info_ac3305f4a165c4d898ce7988191102e46}{type}} -\item -\mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__iface__req__info_a3501e3667f1031fb2f00b333b7b2269a}{iface}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__iface__req__info_a0b61a5ca677a324b62936d18d21ff362}{response\+\_\+size}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing request information for an interface. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__iface__req__info_a1e6927fa1486224044e568f9c370519b}\label{structciot__iface__req__info_a1e6927fa1486224044e568f9c370519b} -\index{ciot\_iface\_req\_info@{ciot\_iface\_req\_info}!id@{id}} -\index{id@{id}!ciot\_iface\_req\_info@{ciot\_iface\_req\_info}} -\doxysubsubsection{\texorpdfstring{id}{id}} -{\footnotesize\ttfamily uint8\+\_\+t id} - -Request ID. \Hypertarget{structciot__iface__req__info_a3501e3667f1031fb2f00b333b7b2269a}\label{structciot__iface__req__info_a3501e3667f1031fb2f00b333b7b2269a} -\index{ciot\_iface\_req\_info@{ciot\_iface\_req\_info}!iface@{iface}} -\index{iface@{iface}!ciot\_iface\_req\_info@{ciot\_iface\_req\_info}} -\doxysubsubsection{\texorpdfstring{iface}{iface}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} iface} - -Interface information. \Hypertarget{structciot__iface__req__info_a0b61a5ca677a324b62936d18d21ff362}\label{structciot__iface__req__info_a0b61a5ca677a324b62936d18d21ff362} -\index{ciot\_iface\_req\_info@{ciot\_iface\_req\_info}!response\_size@{response\_size}} -\index{response\_size@{response\_size}!ciot\_iface\_req\_info@{ciot\_iface\_req\_info}} -\doxysubsubsection{\texorpdfstring{response\_size}{response\_size}} -{\footnotesize\ttfamily uint16\+\_\+t response\+\_\+size} - -Size of response. \Hypertarget{structciot__iface__req__info_a2a773bc681a41b29b21f8c106c0161ef}\label{structciot__iface__req__info_a2a773bc681a41b29b21f8c106c0161ef} -\index{ciot\_iface\_req\_info@{ciot\_iface\_req\_info}!status@{status}} -\index{status@{status}!ciot\_iface\_req\_info@{ciot\_iface\_req\_info}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_a53ef55e31fed0fb7bbc727b4b45c8b18}{ciot\+\_\+iface\+\_\+req\+\_\+status\+\_\+t}} status} - -Request status. \Hypertarget{structciot__iface__req__info_ac3305f4a165c4d898ce7988191102e46}\label{structciot__iface__req__info_ac3305f4a165c4d898ce7988191102e46} -\index{ciot\_iface\_req\_info@{ciot\_iface\_req\_info}!type@{type}} -\index{type@{type}!ciot\_iface\_req\_info@{ciot\_iface\_req\_info}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} type} - -Message type. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ifaces.tex b/docs/latex/structciot__ifaces.tex deleted file mode 100644 index da14647..0000000 --- a/docs/latex/structciot__ifaces.tex +++ /dev/null @@ -1,153 +0,0 @@ -\doxysection{ciot\+\_\+ifaces Struct Reference} -\hypertarget{structciot__ifaces}{}\label{structciot__ifaces}\index{ciot\_ifaces@{ciot\_ifaces}} - - -Structure representing CIOT interfaces. - - - - -{\ttfamily \#include $<$ciot\+\_\+ifaces.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a56416f6eac2692c41c82d053ba002af2}{ciot}} -\item -\mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_aaed783b786fd40c5690a32bebe9f0326}{storage}} -\item -\mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a5cd7a867e5e008c3dd064684a180a470}{system}} -\item -\mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a114aac4c4bd60245dda949be0febdcd2}{uart}} -\item -\mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a5d16ffd7a66e7e0e0c5fd07876f5a964}{usb}} -\item -\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_ac80889c5f3c6d9ed2cd6bba3616bdf4f}{tcp}} -\item -\mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_ab20831600cb6d38f235145fee948813b}{eth}} -\item -\mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a688b2e35a1af524849eab17acfc86317}{wifi}} -\item -\mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_ae23a932dbacce6377227a4654618111e}{ble}} -\item -\mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_abac8466359f1900dd232e80aaa8f8069}{ble\+\_\+scn}} -\item -\mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a3ee37815964e9fd49d2dfee631dacedf}{ntp}} -\item -\mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a72c8d347d1c888290c5c6c8ecd4c58c5}{ota}} -\item -\mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a1ed8d43c3f1f21fa7c17cc87a6fe7797}{https}} -\item -\mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_a54c2caecbbbf05be0157f3ab02cc7d24}{httpc}} -\item -\mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_afda8467a92fbc5a6bb84aa0703cf6605}{mqtt}} -\item -\mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} \mbox{\hyperlink{structciot__ifaces_ab80591df7743604e3f3961fc9c52b0e3}{bridge}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing CIOT interfaces. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ifaces_ae23a932dbacce6377227a4654618111e}\label{structciot__ifaces_ae23a932dbacce6377227a4654618111e} -\index{ciot\_ifaces@{ciot\_ifaces}!ble@{ble}} -\index{ble@{ble}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{ble}{ble}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble_8h_a04af8d5e1d4ca0f72ceacb6e313d9087}{ciot\+\_\+ble\+\_\+t}} ble} - -BLE interface. \Hypertarget{structciot__ifaces_abac8466359f1900dd232e80aaa8f8069}\label{structciot__ifaces_abac8466359f1900dd232e80aaa8f8069} -\index{ciot\_ifaces@{ciot\_ifaces}!ble\_scn@{ble\_scn}} -\index{ble\_scn@{ble\_scn}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{ble\_scn}{ble\_scn}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn_8h_a2bd73555d4a7af0131f01560fb39e895}{ciot\+\_\+ble\+\_\+scn\+\_\+t}} ble\+\_\+scn} - -BLE SCN interface. \Hypertarget{structciot__ifaces_ab80591df7743604e3f3961fc9c52b0e3}\label{structciot__ifaces_ab80591df7743604e3f3961fc9c52b0e3} -\index{ciot\_ifaces@{ciot\_ifaces}!bridge@{bridge}} -\index{bridge@{bridge}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{bridge}{bridge}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge_8h_a7888ef6aa3b9be435a47e5658c32af8c}{ciot\+\_\+bridge\+\_\+t}} bridge} - -Bridge interface. \Hypertarget{structciot__ifaces_a56416f6eac2692c41c82d053ba002af2}\label{structciot__ifaces_a56416f6eac2692c41c82d053ba002af2} -\index{ciot\_ifaces@{ciot\_ifaces}!ciot@{ciot}} -\index{ciot@{ciot}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{ciot}{ciot}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot_8h_a8543fc73092a47512369c90b44059bb6}{ciot\+\_\+t}} ciot} - -CIOT interface. \Hypertarget{structciot__ifaces_ab20831600cb6d38f235145fee948813b}\label{structciot__ifaces_ab20831600cb6d38f235145fee948813b} -\index{ciot\_ifaces@{ciot\_ifaces}!eth@{eth}} -\index{eth@{eth}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{eth}{eth}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} eth} - -Ethernet interface. \Hypertarget{structciot__ifaces_a54c2caecbbbf05be0157f3ab02cc7d24}\label{structciot__ifaces_a54c2caecbbbf05be0157f3ab02cc7d24} -\index{ciot\_ifaces@{ciot\_ifaces}!httpc@{httpc}} -\index{httpc@{httpc}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{httpc}{httpc}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc_8h_a2c213f8a3a59ead35d64cf064f894fe1}{ciot\+\_\+httpc\+\_\+t}} httpc} - -HTTP client interface. \Hypertarget{structciot__ifaces_a1ed8d43c3f1f21fa7c17cc87a6fe7797}\label{structciot__ifaces_a1ed8d43c3f1f21fa7c17cc87a6fe7797} -\index{ciot\_ifaces@{ciot\_ifaces}!https@{https}} -\index{https@{https}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{https}{https}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https_8h_acfd2fcf5803562e750dea3815e1cbd49}{ciot\+\_\+https\+\_\+t}} https} - -HTTP server interface. \Hypertarget{structciot__ifaces_afda8467a92fbc5a6bb84aa0703cf6605}\label{structciot__ifaces_afda8467a92fbc5a6bb84aa0703cf6605} -\index{ciot\_ifaces@{ciot\_ifaces}!mqtt@{mqtt}} -\index{mqtt@{mqtt}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{mqtt}{mqtt}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc_8h_a1952c9049b9ddd9b40368e332dec8374}{ciot\+\_\+mqttc\+\_\+t}} mqtt} - -MQTT client interface. \Hypertarget{structciot__ifaces_a3ee37815964e9fd49d2dfee631dacedf}\label{structciot__ifaces_a3ee37815964e9fd49d2dfee631dacedf} -\index{ciot\_ifaces@{ciot\_ifaces}!ntp@{ntp}} -\index{ntp@{ntp}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{ntp}{ntp}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp_8h_ac7f8701cb756dab2bc3292c002d6da9e}{ciot\+\_\+ntp\+\_\+t}} ntp} - -NTP interface. \Hypertarget{structciot__ifaces_a72c8d347d1c888290c5c6c8ecd4c58c5}\label{structciot__ifaces_a72c8d347d1c888290c5c6c8ecd4c58c5} -\index{ciot\_ifaces@{ciot\_ifaces}!ota@{ota}} -\index{ota@{ota}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{ota}{ota}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota_8h_a7639d0166916697e2b3024ff7daa823c}{ciot\+\_\+ota\+\_\+t}} ota} - -OTA interface. \Hypertarget{structciot__ifaces_aaed783b786fd40c5690a32bebe9f0326}\label{structciot__ifaces_aaed783b786fd40c5690a32bebe9f0326} -\index{ciot\_ifaces@{ciot\_ifaces}!storage@{storage}} -\index{storage@{storage}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{storage}{storage}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage_8h_abd15a0b08206e1aee533659f5c760024}{ciot\+\_\+storage\+\_\+t}} storage} - -Storage interface. \Hypertarget{structciot__ifaces_a5cd7a867e5e008c3dd064684a180a470}\label{structciot__ifaces_a5cd7a867e5e008c3dd064684a180a470} -\index{ciot\_ifaces@{ciot\_ifaces}!system@{system}} -\index{system@{system}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{system}{system}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys_8h_a000d7e2a946477d024a46584409a95cd}{ciot\+\_\+sys\+\_\+t}} system} - -System interface. \Hypertarget{structciot__ifaces_ac80889c5f3c6d9ed2cd6bba3616bdf4f}\label{structciot__ifaces_ac80889c5f3c6d9ed2cd6bba3616bdf4f} -\index{ciot\_ifaces@{ciot\_ifaces}!tcp@{tcp}} -\index{tcp@{tcp}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{tcp}{tcp}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp_8h_a85ab6c7fac206851e1183e84d8920b04}{ciot\+\_\+tcp\+\_\+t}} tcp} - -TCP interface. \Hypertarget{structciot__ifaces_a114aac4c4bd60245dda949be0febdcd2}\label{structciot__ifaces_a114aac4c4bd60245dda949be0febdcd2} -\index{ciot\_ifaces@{ciot\_ifaces}!uart@{uart}} -\index{uart@{uart}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{uart}{uart}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart_8h_a9e4ec933947db50204ef964efdf776bf}{ciot\+\_\+uart\+\_\+t}} uart} - -UART interface. \Hypertarget{structciot__ifaces_a5d16ffd7a66e7e0e0c5fd07876f5a964}\label{structciot__ifaces_a5d16ffd7a66e7e0e0c5fd07876f5a964} -\index{ciot\_ifaces@{ciot\_ifaces}!usb@{usb}} -\index{usb@{usb}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{usb}{usb}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb_8h_a5a423546430ff5b539cecd7181fdf90d}{ciot\+\_\+usb\+\_\+t}} usb} - -USB interface. \Hypertarget{structciot__ifaces_a688b2e35a1af524849eab17acfc86317}\label{structciot__ifaces_a688b2e35a1af524849eab17acfc86317} -\index{ciot\_ifaces@{ciot\_ifaces}!wifi@{wifi}} -\index{wifi@{wifi}!ciot\_ifaces@{ciot\_ifaces}} -\doxysubsubsection{\texorpdfstring{wifi}{wifi}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi_8h_a8a68a35d54f44cd102efdaf03d75d29a}{ciot\+\_\+wifi\+\_\+t}} wifi} - -Wi\+Fi interface. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__ifaces_8h}{ciot\+\_\+ifaces.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__info__t.tex b/docs/latex/structciot__info__t.tex deleted file mode 100644 index 816036e..0000000 --- a/docs/latex/structciot__info__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__info__t}{}\label{structciot__info__t}\index{ciot\_info\_t@{ciot\_info\_t}} - - -Structure for CIOT information. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__info__t_a857436941aa8d7df5abfa34bcd054d35}{version}} \mbox{[}3\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__info__t_a857436941aa8d7df5abfa34bcd054d35}\label{structciot__info__t_a857436941aa8d7df5abfa34bcd054d35} -\index{ciot\_info\_t@{ciot\_info\_t}!version@{version}} -\index{version@{version}!ciot\_info\_t@{ciot\_info\_t}} -\doxysubsubsection{\texorpdfstring{version}{version}} -{\footnotesize\ttfamily uint8\+\_\+t version\mbox{[}3\mbox{]}} - -Version information - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__cfg__t.tex b/docs/latex/structciot__mqttc__cfg__t.tex deleted file mode 100644 index 94eac83..0000000 --- a/docs/latex/structciot__mqttc__cfg__t.tex +++ /dev/null @@ -1,89 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__cfg__t}{}\label{structciot__mqttc__cfg__t}\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} - - -Structure for CIOT MQTT client configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__mqttc__cfg__t_a71a2e48797aa4b94b9164ea22564c158}{client\+\_\+id}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+CLIENT\+\_\+\+ID\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structciot__mqttc__cfg__t_a86d66ae1379f0dead7b0744b77d4f4f4}{url}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_aeb924d17fcd585c2612e41f7f4ad9a1f}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+URL\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structciot__mqttc__cfg__t_a40c9809e1d381340b5d342ef3a838715}{user}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+USER\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structciot__mqttc__cfg__t_a0559811c61c36a1df8aa9ac0c4d56d53}{pass}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+PASS\+\_\+\+LEN}}\mbox{]} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__mqttc__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6}{port}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__mqttc__cfg__t_a65ee2b4b16f25052c441ff9959dcc7e7}{qos}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684}{ciot\+\_\+mqttc\+\_\+transport\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__cfg__t_addf4bba19daf5bd5b49b033e239931da}{transport}} -\item -\mbox{\hyperlink{structciot__mqttc__topics__cfg__t}{ciot\+\_\+mqttc\+\_\+topics\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__cfg__t_a2a5888184d23c617efb05a871a705673}{topics}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__cfg__t_a71a2e48797aa4b94b9164ea22564c158}\label{structciot__mqttc__cfg__t_a71a2e48797aa4b94b9164ea22564c158} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!client\_id@{client\_id}} -\index{client\_id@{client\_id}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{client\_id}{client\_id}} -{\footnotesize\ttfamily char client\+\_\+id\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+CLIENT\+\_\+\+ID\+\_\+\+LEN}}\mbox{]}} - -Client ID \Hypertarget{structciot__mqttc__cfg__t_a0559811c61c36a1df8aa9ac0c4d56d53}\label{structciot__mqttc__cfg__t_a0559811c61c36a1df8aa9ac0c4d56d53} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!pass@{pass}} -\index{pass@{pass}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{pass}{pass}} -{\footnotesize\ttfamily char pass\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+PASS\+\_\+\+LEN}}\mbox{]}} - -MQTT password \Hypertarget{structciot__mqttc__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6}\label{structciot__mqttc__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!port@{port}} -\index{port@{port}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{port}{port}} -{\footnotesize\ttfamily uint32\+\_\+t port} - -MQTT port \Hypertarget{structciot__mqttc__cfg__t_a65ee2b4b16f25052c441ff9959dcc7e7}\label{structciot__mqttc__cfg__t_a65ee2b4b16f25052c441ff9959dcc7e7} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!qos@{qos}} -\index{qos@{qos}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{qos}{qos}} -{\footnotesize\ttfamily uint8\+\_\+t qos} - -MQTT quality of service \Hypertarget{structciot__mqttc__cfg__t_a2a5888184d23c617efb05a871a705673}\label{structciot__mqttc__cfg__t_a2a5888184d23c617efb05a871a705673} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!topics@{topics}} -\index{topics@{topics}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{topics}{topics}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__topics__cfg__t}{ciot\+\_\+mqttc\+\_\+topics\+\_\+cfg\+\_\+t}} topics} - -MQTT topics configuration \Hypertarget{structciot__mqttc__cfg__t_addf4bba19daf5bd5b49b033e239931da}\label{structciot__mqttc__cfg__t_addf4bba19daf5bd5b49b033e239931da} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!transport@{transport}} -\index{transport@{transport}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{transport}{transport}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_ac27be04d218be91a37994c044f65e684}{ciot\+\_\+mqttc\+\_\+transport\+\_\+t}} transport} - -MQTT transport type \Hypertarget{structciot__mqttc__cfg__t_a86d66ae1379f0dead7b0744b77d4f4f4}\label{structciot__mqttc__cfg__t_a86d66ae1379f0dead7b0744b77d4f4f4} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!url@{url}} -\index{url@{url}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{url}{url}} -{\footnotesize\ttfamily char url\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_aeb924d17fcd585c2612e41f7f4ad9a1f}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+URL\+\_\+\+LEN}}\mbox{]}} - -MQTT URL \Hypertarget{structciot__mqttc__cfg__t_a40c9809e1d381340b5d342ef3a838715}\label{structciot__mqttc__cfg__t_a40c9809e1d381340b5d342ef3a838715} -\index{ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}!user@{user}} -\index{user@{user}!ciot\_mqttc\_cfg\_t@{ciot\_mqttc\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{user}{user}} -{\footnotesize\ttfamily char user\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+USER\+\_\+\+LEN}}\mbox{]}} - -MQTT username - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__error__t.tex b/docs/latex/structciot__mqttc__error__t.tex deleted file mode 100644 index bec7758..0000000 --- a/docs/latex/structciot__mqttc__error__t.tex +++ /dev/null @@ -1,73 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+error\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__error__t}{}\label{structciot__mqttc__error__t}\index{ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}} - - -Structure for CIOT MQTT client error information. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -int \mbox{\hyperlink{structciot__mqttc__error__t_af8b9db3223039d525df4371413d3c2f3}{tls\+\_\+last\+\_\+err}} -\item -int \mbox{\hyperlink{structciot__mqttc__error__t_a9006960d969e505489e2a46434d60ebb}{tls\+\_\+stack\+\_\+err}} -\item -int \mbox{\hyperlink{structciot__mqttc__error__t_abde2f3e27511cfb7307766339fed98e9}{tls\+\_\+cert\+\_\+verify\+\_\+flags}} -\item -int \mbox{\hyperlink{structciot__mqttc__error__t_ac765329451135abec74c45e1897abf26}{type}} -\item -int \mbox{\hyperlink{structciot__mqttc__error__t_a45a5b7c00a796a23f01673cef1dbe0a9}{code}} -\item -int \mbox{\hyperlink{structciot__mqttc__error__t_a2d16d2a81fde684b4c79c0d71f8090b5}{transport\+\_\+sock}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client error information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__error__t_a45a5b7c00a796a23f01673cef1dbe0a9}\label{structciot__mqttc__error__t_a45a5b7c00a796a23f01673cef1dbe0a9} -\index{ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}!code@{code}} -\index{code@{code}!ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}} -\doxysubsubsection{\texorpdfstring{code}{code}} -{\footnotesize\ttfamily int code} - -Error code \Hypertarget{structciot__mqttc__error__t_abde2f3e27511cfb7307766339fed98e9}\label{structciot__mqttc__error__t_abde2f3e27511cfb7307766339fed98e9} -\index{ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}!tls\_cert\_verify\_flags@{tls\_cert\_verify\_flags}} -\index{tls\_cert\_verify\_flags@{tls\_cert\_verify\_flags}!ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}} -\doxysubsubsection{\texorpdfstring{tls\_cert\_verify\_flags}{tls\_cert\_verify\_flags}} -{\footnotesize\ttfamily int tls\+\_\+cert\+\_\+verify\+\_\+flags} - -TLS certificate verification flags \Hypertarget{structciot__mqttc__error__t_af8b9db3223039d525df4371413d3c2f3}\label{structciot__mqttc__error__t_af8b9db3223039d525df4371413d3c2f3} -\index{ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}!tls\_last\_err@{tls\_last\_err}} -\index{tls\_last\_err@{tls\_last\_err}!ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}} -\doxysubsubsection{\texorpdfstring{tls\_last\_err}{tls\_last\_err}} -{\footnotesize\ttfamily int tls\+\_\+last\+\_\+err} - -Last TLS error \Hypertarget{structciot__mqttc__error__t_a9006960d969e505489e2a46434d60ebb}\label{structciot__mqttc__error__t_a9006960d969e505489e2a46434d60ebb} -\index{ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}!tls\_stack\_err@{tls\_stack\_err}} -\index{tls\_stack\_err@{tls\_stack\_err}!ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}} -\doxysubsubsection{\texorpdfstring{tls\_stack\_err}{tls\_stack\_err}} -{\footnotesize\ttfamily int tls\+\_\+stack\+\_\+err} - -TLS stack error \Hypertarget{structciot__mqttc__error__t_a2d16d2a81fde684b4c79c0d71f8090b5}\label{structciot__mqttc__error__t_a2d16d2a81fde684b4c79c0d71f8090b5} -\index{ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}!transport\_sock@{transport\_sock}} -\index{transport\_sock@{transport\_sock}!ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}} -\doxysubsubsection{\texorpdfstring{transport\_sock}{transport\_sock}} -{\footnotesize\ttfamily int transport\+\_\+sock} - -Transport socket \Hypertarget{structciot__mqttc__error__t_ac765329451135abec74c45e1897abf26}\label{structciot__mqttc__error__t_ac765329451135abec74c45e1897abf26} -\index{ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}!type@{type}} -\index{type@{type}!ciot\_mqttc\_error\_t@{ciot\_mqttc\_error\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily int type} - -Error type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__event.tex b/docs/latex/structciot__mqttc__event.tex deleted file mode 100644 index 3665a15..0000000 --- a/docs/latex/structciot__mqttc__event.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+event Struct Reference} -\hypertarget{structciot__mqttc__event}{}\label{structciot__mqttc__event}\index{ciot\_mqttc\_event@{ciot\_mqttc\_event}} - - -Union for CIOT MQTT client event. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_ac871b56a938626c38c705618405ee350}{ciot\+\_\+mqttc\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__event_acd187e9c28c27f14c5eb518411a273cb}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT MQTT client event. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__event_acd187e9c28c27f14c5eb518411a273cb}\label{structciot__mqttc__event_acd187e9c28c27f14c5eb518411a273cb} -\index{ciot\_mqttc\_event@{ciot\_mqttc\_event}!data@{data}} -\index{data@{data}!ciot\_mqttc\_event@{ciot\_mqttc\_event}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_ac871b56a938626c38c705618405ee350}{ciot\+\_\+mqttc\+\_\+event\+\_\+data\+\_\+t}} data} - -Event data - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__event__data.tex b/docs/latex/structciot__mqttc__event__data.tex deleted file mode 100644 index 3540e81..0000000 --- a/docs/latex/structciot__mqttc__event__data.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+event\+\_\+data Struct Reference} -\hypertarget{structciot__mqttc__event__data}{}\label{structciot__mqttc__event__data}\index{ciot\_mqttc\_event\_data@{ciot\_mqttc\_event\_data}} - - -Structure for CIOT MQTT client event data. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__event__data_a2dbb61af8fd36dccbf3662d0c7a64839}{payload}} -\item -char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__mqttc__event__data_affecb48e716753e10b44feac31f12529}{topic}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client event data. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__event__data_a2dbb61af8fd36dccbf3662d0c7a64839}\label{structciot__mqttc__event__data_a2dbb61af8fd36dccbf3662d0c7a64839} -\index{ciot\_mqttc\_event\_data@{ciot\_mqttc\_event\_data}!payload@{payload}} -\index{payload@{payload}!ciot\_mqttc\_event\_data@{ciot\_mqttc\_event\_data}} -\doxysubsubsection{\texorpdfstring{payload}{payload}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} payload} - -Event payload \Hypertarget{structciot__mqttc__event__data_affecb48e716753e10b44feac31f12529}\label{structciot__mqttc__event__data_affecb48e716753e10b44feac31f12529} -\index{ciot\_mqttc\_event\_data@{ciot\_mqttc\_event\_data}!topic@{topic}} -\index{topic@{topic}!ciot\_mqttc\_event\_data@{ciot\_mqttc\_event\_data}} -\doxysubsubsection{\texorpdfstring{topic}{topic}} -{\footnotesize\ttfamily char\texorpdfstring{$\ast$}{*} topic} - -Event topic - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__req__publish__t.tex b/docs/latex/structciot__mqttc__req__publish__t.tex deleted file mode 100644 index d187da3..0000000 --- a/docs/latex/structciot__mqttc__req__publish__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+req\+\_\+publish\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__req__publish__t}{}\label{structciot__mqttc__req__publish__t}\index{ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}} - - -Structure for CIOT MQTT client publish request. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__mqttc__req__publish__t_adb8c125563b301bb6f5b4f57f6547bc0}{topic}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__mqttc__req__publish__t_a2a544a28a9461b0de1f303ca407c459f}{msg}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+MSG\+\_\+\+LEN}}\mbox{]} -\item -int \mbox{\hyperlink{structciot__mqttc__req__publish__t_a439227feff9d7f55384e8780cfc2eb82}{size}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__mqttc__req__publish__t_a65ee2b4b16f25052c441ff9959dcc7e7}{qos}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client publish request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__req__publish__t_a2a544a28a9461b0de1f303ca407c459f}\label{structciot__mqttc__req__publish__t_a2a544a28a9461b0de1f303ca407c459f} -\index{ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}!msg@{msg}} -\index{msg@{msg}!ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}} -\doxysubsubsection{\texorpdfstring{msg}{msg}} -{\footnotesize\ttfamily uint8\+\_\+t msg\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+MSG\+\_\+\+LEN}}\mbox{]}} - -MQTT message \Hypertarget{structciot__mqttc__req__publish__t_a65ee2b4b16f25052c441ff9959dcc7e7}\label{structciot__mqttc__req__publish__t_a65ee2b4b16f25052c441ff9959dcc7e7} -\index{ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}!qos@{qos}} -\index{qos@{qos}!ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}} -\doxysubsubsection{\texorpdfstring{qos}{qos}} -{\footnotesize\ttfamily uint8\+\_\+t qos} - -Quality of service \Hypertarget{structciot__mqttc__req__publish__t_a439227feff9d7f55384e8780cfc2eb82}\label{structciot__mqttc__req__publish__t_a439227feff9d7f55384e8780cfc2eb82} -\index{ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}!size@{size}} -\index{size@{size}!ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily int size} - -Size of message \Hypertarget{structciot__mqttc__req__publish__t_adb8c125563b301bb6f5b4f57f6547bc0}\label{structciot__mqttc__req__publish__t_adb8c125563b301bb6f5b4f57f6547bc0} -\index{ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}!topic@{topic}} -\index{topic@{topic}!ciot\_mqttc\_req\_publish\_t@{ciot\_mqttc\_req\_publish\_t}} -\doxysubsubsection{\texorpdfstring{topic}{topic}} -{\footnotesize\ttfamily char topic\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]}} - -MQTT topic - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__req__subscribe__t.tex b/docs/latex/structciot__mqttc__req__subscribe__t.tex deleted file mode 100644 index c1b507a..0000000 --- a/docs/latex/structciot__mqttc__req__subscribe__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+req\+\_\+subscribe\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__req__subscribe__t}{}\label{structciot__mqttc__req__subscribe__t}\index{ciot\_mqttc\_req\_subscribe\_t@{ciot\_mqttc\_req\_subscribe\_t}} - - -Structure for CIOT MQTT client subscribe request. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__mqttc__req__subscribe__t_adb8c125563b301bb6f5b4f57f6547bc0}{topic}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__mqttc__req__subscribe__t_a65ee2b4b16f25052c441ff9959dcc7e7}{qos}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client subscribe request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__req__subscribe__t_a65ee2b4b16f25052c441ff9959dcc7e7}\label{structciot__mqttc__req__subscribe__t_a65ee2b4b16f25052c441ff9959dcc7e7} -\index{ciot\_mqttc\_req\_subscribe\_t@{ciot\_mqttc\_req\_subscribe\_t}!qos@{qos}} -\index{qos@{qos}!ciot\_mqttc\_req\_subscribe\_t@{ciot\_mqttc\_req\_subscribe\_t}} -\doxysubsubsection{\texorpdfstring{qos}{qos}} -{\footnotesize\ttfamily uint8\+\_\+t qos} - -Quality of service \Hypertarget{structciot__mqttc__req__subscribe__t_adb8c125563b301bb6f5b4f57f6547bc0}\label{structciot__mqttc__req__subscribe__t_adb8c125563b301bb6f5b4f57f6547bc0} -\index{ciot\_mqttc\_req\_subscribe\_t@{ciot\_mqttc\_req\_subscribe\_t}!topic@{topic}} -\index{topic@{topic}!ciot\_mqttc\_req\_subscribe\_t@{ciot\_mqttc\_req\_subscribe\_t}} -\doxysubsubsection{\texorpdfstring{topic}{topic}} -{\footnotesize\ttfamily char topic\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]}} - -MQTT topic - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__req__t.tex b/docs/latex/structciot__mqttc__req__t.tex deleted file mode 100644 index 8f8360e..0000000 --- a/docs/latex/structciot__mqttc__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__req__t}{}\label{structciot__mqttc__req__t}\index{ciot\_mqttc\_req\_t@{ciot\_mqttc\_req\_t}} - - -Structure for CIOT MQTT client request. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43}{ciot\+\_\+mqttc\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__req__t_a8e287bd3b319b246d8346f46ed6c4580}{type}} -\item -\mbox{\hyperlink{unionciot__mqttc__req__data__u}{ciot\+\_\+mqttc\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__mqttc__req__t_ad609e57ec1fe769dd7f41602cae320ca}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__req__t_ad609e57ec1fe769dd7f41602cae320ca}\label{structciot__mqttc__req__t_ad609e57ec1fe769dd7f41602cae320ca} -\index{ciot\_mqttc\_req\_t@{ciot\_mqttc\_req\_t}!data@{data}} -\index{data@{data}!ciot\_mqttc\_req\_t@{ciot\_mqttc\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__mqttc__req__data__u}{ciot\+\_\+mqttc\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__mqttc__req__t_a8e287bd3b319b246d8346f46ed6c4580}\label{structciot__mqttc__req__t_a8e287bd3b319b246d8346f46ed6c4580} -\index{ciot\_mqttc\_req\_t@{ciot\_mqttc\_req\_t}!type@{type}} -\index{type@{type}!ciot\_mqttc\_req\_t@{ciot\_mqttc\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a2fcaf55ed84bd01f16ae5184e60aab43}{ciot\+\_\+mqttc\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__status__msg__t.tex b/docs/latex/structciot__mqttc__status__msg__t.tex deleted file mode 100644 index 7467198..0000000 --- a/docs/latex/structciot__mqttc__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__status__msg__t}{}\label{structciot__mqttc__status__msg__t}\index{ciot\_mqttc\_status\_msg\_t@{ciot\_mqttc\_status\_msg\_t}} - - -Structure representing a CIOT MQTT client status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__mqttc__status__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__status__msg__t_a0bd4162002c890f2775878d4da138c03}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure representing a CIOT MQTT client status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__mqttc__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_mqttc\_status\_msg\_t@{ciot\_mqttc\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_mqttc\_status\_msg\_t@{ciot\_mqttc\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Header information. \Hypertarget{structciot__mqttc__status__msg__t_a0bd4162002c890f2775878d4da138c03}\label{structciot__mqttc__status__msg__t_a0bd4162002c890f2775878d4da138c03} -\index{ciot\_mqttc\_status\_msg\_t@{ciot\_mqttc\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_mqttc\_status\_msg\_t@{ciot\_mqttc\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__status__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} status} - -MQTT client status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__mqttc_8h}{ciot\+\_\+mqttc.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__status__t.tex b/docs/latex/structciot__mqttc__status__t.tex deleted file mode 100644 index b9d53b8..0000000 --- a/docs/latex/structciot__mqttc__status__t.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__status__t}{}\label{structciot__mqttc__status__t}\index{ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}} - - -Structure for CIOT MQTT client status. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce}{ciot\+\_\+mqttc\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__status__t_a28daf783134e0bed0e611de3ea451e4a}{state}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__mqttc__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4}{conn\+\_\+count}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__mqttc__status__t_af7750329f3654d2f6fe5a20adeae49dd}{data\+\_\+rate}} -\item -time\+\_\+t \mbox{\hyperlink{structciot__mqttc__status__t_a44794759868576e0404c9cf629863797}{last\+\_\+msg\+\_\+time}} -\item -\mbox{\hyperlink{structciot__mqttc__error__t}{ciot\+\_\+mqttc\+\_\+error\+\_\+t}} \mbox{\hyperlink{structciot__mqttc__status__t_acee85046d884f9e69d341dafac56cd22}{error}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4}\label{structciot__mqttc__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4} -\index{ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}!conn\_count@{conn\_count}} -\index{conn\_count@{conn\_count}!ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}} -\doxysubsubsection{\texorpdfstring{conn\_count}{conn\_count}} -{\footnotesize\ttfamily uint8\+\_\+t conn\+\_\+count} - -Connection count \Hypertarget{structciot__mqttc__status__t_af7750329f3654d2f6fe5a20adeae49dd}\label{structciot__mqttc__status__t_af7750329f3654d2f6fe5a20adeae49dd} -\index{ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}!data\_rate@{data\_rate}} -\index{data\_rate@{data\_rate}!ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}} -\doxysubsubsection{\texorpdfstring{data\_rate}{data\_rate}} -{\footnotesize\ttfamily uint16\+\_\+t data\+\_\+rate} - -Data rate \Hypertarget{structciot__mqttc__status__t_acee85046d884f9e69d341dafac56cd22}\label{structciot__mqttc__status__t_acee85046d884f9e69d341dafac56cd22} -\index{ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}!error@{error}} -\index{error@{error}!ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}} -\doxysubsubsection{\texorpdfstring{error}{error}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__error__t}{ciot\+\_\+mqttc\+\_\+error\+\_\+t}} error} - -Error information \Hypertarget{structciot__mqttc__status__t_a44794759868576e0404c9cf629863797}\label{structciot__mqttc__status__t_a44794759868576e0404c9cf629863797} -\index{ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}!last\_msg\_time@{last\_msg\_time}} -\index{last\_msg\_time@{last\_msg\_time}!ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}} -\doxysubsubsection{\texorpdfstring{last\_msg\_time}{last\_msg\_time}} -{\footnotesize\ttfamily time\+\_\+t last\+\_\+msg\+\_\+time} - -Last message time \Hypertarget{structciot__mqttc__status__t_a28daf783134e0bed0e611de3ea451e4a}\label{structciot__mqttc__status__t_a28daf783134e0bed0e611de3ea451e4a} -\index{ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}!state@{state}} -\index{state@{state}!ciot\_mqttc\_status\_t@{ciot\_mqttc\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a5ee7ab2e590208687470cf07d7adb2ce}{ciot\+\_\+mqttc\+\_\+state\+\_\+t}} state} - -MQTT client state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__mqttc__topics__cfg__t.tex b/docs/latex/structciot__mqttc__topics__cfg__t.tex deleted file mode 100644 index 2ada0c7..0000000 --- a/docs/latex/structciot__mqttc__topics__cfg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+topics\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__mqttc__topics__cfg__t}{}\label{structciot__mqttc__topics__cfg__t}\index{ciot\_mqttc\_topics\_cfg\_t@{ciot\_mqttc\_topics\_cfg\_t}} - - -Structure for CIOT MQTT client topics configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__mqttc__topics__cfg__t_a6b1fde5b6926d1fec0c3102bbf1ada9f}{d2b}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structciot__mqttc__topics__cfg__t_a7e49cda0ef28302730e05911cb7a9d3c}{b2d}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT MQTT client topics configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__mqttc__topics__cfg__t_a7e49cda0ef28302730e05911cb7a9d3c}\label{structciot__mqttc__topics__cfg__t_a7e49cda0ef28302730e05911cb7a9d3c} -\index{ciot\_mqttc\_topics\_cfg\_t@{ciot\_mqttc\_topics\_cfg\_t}!b2d@{b2d}} -\index{b2d@{b2d}!ciot\_mqttc\_topics\_cfg\_t@{ciot\_mqttc\_topics\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{b2d}{b2d}} -{\footnotesize\ttfamily char b2d\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]}} - -Broker to device topic \Hypertarget{structciot__mqttc__topics__cfg__t_a6b1fde5b6926d1fec0c3102bbf1ada9f}\label{structciot__mqttc__topics__cfg__t_a6b1fde5b6926d1fec0c3102bbf1ada9f} -\index{ciot\_mqttc\_topics\_cfg\_t@{ciot\_mqttc\_topics\_cfg\_t}!d2b@{d2b}} -\index{d2b@{d2b}!ciot\_mqttc\_topics\_cfg\_t@{ciot\_mqttc\_topics\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{d2b}{d2b}} -{\footnotesize\ttfamily char d2b\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]}} - -Device to broker topic - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__msg__error__t.tex b/docs/latex/structciot__msg__error__t.tex deleted file mode 100644 index 968e311..0000000 --- a/docs/latex/structciot__msg__error__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+msg\+\_\+error\+\_\+t Struct Reference} -\hypertarget{structciot__msg__error__t}{}\label{structciot__msg__error__t}\index{ciot\_msg\_error\_t@{ciot\_msg\_error\_t}} - - -Structure for CIOT message error information. - - - - -{\ttfamily \#include $<$ciot\+\_\+msg\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__msg__error__t_a61e21da913274adbd45e28f694651b11}{msg\+\_\+type}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__msg__error__t_afe73fa7a655419b386e0a10c7beaace3}{code}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT message error information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__msg__error__t_afe73fa7a655419b386e0a10c7beaace3}\label{structciot__msg__error__t_afe73fa7a655419b386e0a10c7beaace3} -\index{ciot\_msg\_error\_t@{ciot\_msg\_error\_t}!code@{code}} -\index{code@{code}!ciot\_msg\_error\_t@{ciot\_msg\_error\_t}} -\doxysubsubsection{\texorpdfstring{code}{code}} -{\footnotesize\ttfamily uint32\+\_\+t code} - -Error code \Hypertarget{structciot__msg__error__t_a61e21da913274adbd45e28f694651b11}\label{structciot__msg__error__t_a61e21da913274adbd45e28f694651b11} -\index{ciot\_msg\_error\_t@{ciot\_msg\_error\_t}!msg\_type@{msg\_type}} -\index{msg\_type@{msg\_type}!ciot\_msg\_error\_t@{ciot\_msg\_error\_t}} -\doxysubsubsection{\texorpdfstring{msg\_type}{msg\_type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} msg\+\_\+type} - -Message type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__msg__header__t.tex b/docs/latex/structciot__msg__header__t.tex deleted file mode 100644 index 7ecc778..0000000 --- a/docs/latex/structciot__msg__header__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+msg\+\_\+header\+\_\+t Struct Reference} -\hypertarget{structciot__msg__header__t}{}\label{structciot__msg__header__t}\index{ciot\_msg\_header\_t@{ciot\_msg\_header\_t}} - - -Structure for CIOT message header. - - - - -{\ttfamily \#include $<$ciot\+\_\+msg\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__msg__header__t_a1e6927fa1486224044e568f9c370519b}{id}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__msg__header__t_ac3305f4a165c4d898ce7988191102e46}{type}} -\item -\mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__msg__header__t_a3501e3667f1031fb2f00b333b7b2269a}{iface}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT message header. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__msg__header__t_a1e6927fa1486224044e568f9c370519b}\label{structciot__msg__header__t_a1e6927fa1486224044e568f9c370519b} -\index{ciot\_msg\_header\_t@{ciot\_msg\_header\_t}!id@{id}} -\index{id@{id}!ciot\_msg\_header\_t@{ciot\_msg\_header\_t}} -\doxysubsubsection{\texorpdfstring{id}{id}} -{\footnotesize\ttfamily uint8\+\_\+t id} - -Message ID \Hypertarget{structciot__msg__header__t_a3501e3667f1031fb2f00b333b7b2269a}\label{structciot__msg__header__t_a3501e3667f1031fb2f00b333b7b2269a} -\index{ciot\_msg\_header\_t@{ciot\_msg\_header\_t}!iface@{iface}} -\index{iface@{iface}!ciot\_msg\_header\_t@{ciot\_msg\_header\_t}} -\doxysubsubsection{\texorpdfstring{iface}{iface}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} iface} - -Interface information \Hypertarget{structciot__msg__header__t_ac3305f4a165c4d898ce7988191102e46}\label{structciot__msg__header__t_ac3305f4a165c4d898ce7988191102e46} -\index{ciot\_msg\_header\_t@{ciot\_msg\_header\_t}!type@{type}} -\index{type@{type}!ciot\_msg\_header\_t@{ciot\_msg\_header\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} type} - -Message type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__msg__iface__info__t.tex b/docs/latex/structciot__msg__iface__info__t.tex deleted file mode 100644 index 04867f6..0000000 --- a/docs/latex/structciot__msg__iface__info__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__msg__iface__info__t}{}\label{structciot__msg__iface__info__t}\index{ciot\_msg\_iface\_info\_t@{ciot\_msg\_iface\_info\_t}} - - -Structure for CIOT message interface information. - - - - -{\ttfamily \#include $<$ciot\+\_\+msg\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__msg__iface__info__t_a1e6927fa1486224044e568f9c370519b}{id}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__msg__iface__info__t_ab9b24d9114ce832a5b9cbc962c9cea28}{type}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT message interface information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__msg__iface__info__t_a1e6927fa1486224044e568f9c370519b}\label{structciot__msg__iface__info__t_a1e6927fa1486224044e568f9c370519b} -\index{ciot\_msg\_iface\_info\_t@{ciot\_msg\_iface\_info\_t}!id@{id}} -\index{id@{id}!ciot\_msg\_iface\_info\_t@{ciot\_msg\_iface\_info\_t}} -\doxysubsubsection{\texorpdfstring{id}{id}} -{\footnotesize\ttfamily uint8\+\_\+t id} - -Interface ID \Hypertarget{structciot__msg__iface__info__t_ab9b24d9114ce832a5b9cbc962c9cea28}\label{structciot__msg__iface__info__t_ab9b24d9114ce832a5b9cbc962c9cea28} -\index{ciot\_msg\_iface\_info\_t@{ciot\_msg\_iface\_info\_t}!type@{type}} -\index{type@{type}!ciot\_msg\_iface\_info\_t@{ciot\_msg\_iface\_info\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_ab6f673a5ce5d4f6d33343a054480f608}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}} type} - -Interface type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__msg__t.tex b/docs/latex/structciot__msg__t.tex deleted file mode 100644 index 556feb9..0000000 --- a/docs/latex/structciot__msg__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__msg__t}{}\label{structciot__msg__t}\index{ciot\_msg\_t@{ciot\_msg\_t}} - - -Structure for CIOT message. - - - - -{\ttfamily \#include $<$ciot\+\_\+msg\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__msg__t_a1e6927fa1486224044e568f9c370519b}{id}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__msg__t_ac3305f4a165c4d898ce7988191102e46}{type}} -\item -\mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__msg__t_a3501e3667f1031fb2f00b333b7b2269a}{iface}} -\item -\mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__msg__t_ac498d2909bc3de66ee0b1a597fa8e0b6}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__msg__t_ac498d2909bc3de66ee0b1a597fa8e0b6}\label{structciot__msg__t_ac498d2909bc3de66ee0b1a597fa8e0b6} -\index{ciot\_msg\_t@{ciot\_msg\_t}!data@{data}} -\index{data@{data}!ciot\_msg\_t@{ciot\_msg\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__msg__data__u}{ciot\+\_\+msg\+\_\+data\+\_\+u}} data} - -Message data \Hypertarget{structciot__msg__t_a1e6927fa1486224044e568f9c370519b}\label{structciot__msg__t_a1e6927fa1486224044e568f9c370519b} -\index{ciot\_msg\_t@{ciot\_msg\_t}!id@{id}} -\index{id@{id}!ciot\_msg\_t@{ciot\_msg\_t}} -\doxysubsubsection{\texorpdfstring{id}{id}} -{\footnotesize\ttfamily uint8\+\_\+t id} - -Message ID \Hypertarget{structciot__msg__t_a3501e3667f1031fb2f00b333b7b2269a}\label{structciot__msg__t_a3501e3667f1031fb2f00b333b7b2269a} -\index{ciot\_msg\_t@{ciot\_msg\_t}!iface@{iface}} -\index{iface@{iface}!ciot\_msg\_t@{ciot\_msg\_t}} -\doxysubsubsection{\texorpdfstring{iface}{iface}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__iface__info__t}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} iface} - -Interface information \Hypertarget{structciot__msg__t_ac3305f4a165c4d898ce7988191102e46}\label{structciot__msg__t_ac3305f4a165c4d898ce7988191102e46} -\index{ciot\_msg\_t@{ciot\_msg\_t}!type@{type}} -\index{type@{type}!ciot\_msg\_t@{ciot\_msg\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a3519ce8c894c6e69c9969c9b419c09cb}{ciot\+\_\+msg\+\_\+type\+\_\+t}} type} - -Message type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__nrf__dfu__cfg.tex b/docs/latex/structciot__nrf__dfu__cfg.tex deleted file mode 100644 index b3a2901..0000000 --- a/docs/latex/structciot__nrf__dfu__cfg.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+nrf\+\_\+dfu\+\_\+cfg Struct Reference} -\hypertarget{structciot__nrf__dfu__cfg}{}\label{structciot__nrf__dfu__cfg}\index{ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}} - - -Structure for CIOT Nordic DFU configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+nrf\+\_\+dfu.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structciot__nrf__dfu__cfg_a6c2ee01676a3fac944277ac66f411267}{dfu}} -\item -\mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}} \mbox{\hyperlink{structciot__nrf__dfu__cfg_a795b5a3aa5d9214e635ad47549f52f15}{init\+\_\+packet}} -\item -\mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}} \mbox{\hyperlink{structciot__nrf__dfu__cfg_a22016a576f391282c8806fc79a64b1f2}{app\+\_\+image}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__nrf__dfu__cfg_a9e30754c48462959a3efdef7ac582744}{max\+\_\+package\+\_\+len}} -\item -\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__nrf__dfu__cfg_add0d24e0065c33f7e1da60ac94e6988b}{iface}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Nordic DFU configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__nrf__dfu__cfg_a22016a576f391282c8806fc79a64b1f2}\label{structciot__nrf__dfu__cfg_a22016a576f391282c8806fc79a64b1f2} -\index{ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}!app\_image@{app\_image}} -\index{app\_image@{app\_image}!ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}} -\doxysubsubsection{\texorpdfstring{app\_image}{app\_image}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}} app\+\_\+image} - -Application image packet. \Hypertarget{structciot__nrf__dfu__cfg_a6c2ee01676a3fac944277ac66f411267}\label{structciot__nrf__dfu__cfg_a6c2ee01676a3fac944277ac66f411267} -\index{ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}!dfu@{dfu}} -\index{dfu@{dfu}!ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}} -\doxysubsubsection{\texorpdfstring{dfu}{dfu}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} dfu} - -DFU configuration. \Hypertarget{structciot__nrf__dfu__cfg_add0d24e0065c33f7e1da60ac94e6988b}\label{structciot__nrf__dfu__cfg_add0d24e0065c33f7e1da60ac94e6988b} -\index{ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}!iface@{iface}} -\index{iface@{iface}!ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}} -\doxysubsubsection{\texorpdfstring{iface}{iface}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}}\texorpdfstring{$\ast$}{*} iface} - -Interface pointer. \Hypertarget{structciot__nrf__dfu__cfg_a795b5a3aa5d9214e635ad47549f52f15}\label{structciot__nrf__dfu__cfg_a795b5a3aa5d9214e635ad47549f52f15} -\index{ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}!init\_packet@{init\_packet}} -\index{init\_packet@{init\_packet}!ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}} -\doxysubsubsection{\texorpdfstring{init\_packet}{init\_packet}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__nrf__dfu_8h_a6b399382dcb80638fd681cded2599bba}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+t}} init\+\_\+packet} - -Initialization packet. \Hypertarget{structciot__nrf__dfu__cfg_a9e30754c48462959a3efdef7ac582744}\label{structciot__nrf__dfu__cfg_a9e30754c48462959a3efdef7ac582744} -\index{ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}!max\_package\_len@{max\_package\_len}} -\index{max\_package\_len@{max\_package\_len}!ciot\_nrf\_dfu\_cfg@{ciot\_nrf\_dfu\_cfg}} -\doxysubsubsection{\texorpdfstring{max\_package\_len}{max\_package\_len}} -{\footnotesize\ttfamily uint32\+\_\+t max\+\_\+package\+\_\+len} - -Maximum packet length. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__nrf__dfu_8h}{ciot\+\_\+nrf\+\_\+dfu.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__nrf__dfu__packet.tex b/docs/latex/structciot__nrf__dfu__packet.tex deleted file mode 100644 index 276970f..0000000 --- a/docs/latex/structciot__nrf__dfu__packet.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet Struct Reference} -\hypertarget{structciot__nrf__dfu__packet}{}\label{structciot__nrf__dfu__packet}\index{ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}} - - -Structure for CIOT Nordic DFU packet. - - - - -{\ttfamily \#include $<$ciot\+\_\+nrf\+\_\+dfu.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__nrf__dfu__packet_a50c8cebed3105b196315a23d0634f1a5}{type}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__nrf__dfu__packet_ab2c6b258f02add8fdf4cfc7c371dd772}{size}} -\item -uint8\+\_\+t \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__nrf__dfu__packet_abe222f6d3581e7920dcad5306cc906a8}{data}} -\item -bool \mbox{\hyperlink{structciot__nrf__dfu__packet_a3e7bef03191254ebdc38d44d1c2dad91}{transferred}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Nordic DFU packet. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__nrf__dfu__packet_abe222f6d3581e7920dcad5306cc906a8}\label{structciot__nrf__dfu__packet_abe222f6d3581e7920dcad5306cc906a8} -\index{ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}!data@{data}} -\index{data@{data}!ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily uint8\+\_\+t\texorpdfstring{$\ast$}{*} data} - -Packet data. \Hypertarget{structciot__nrf__dfu__packet_ab2c6b258f02add8fdf4cfc7c371dd772}\label{structciot__nrf__dfu__packet_ab2c6b258f02add8fdf4cfc7c371dd772} -\index{ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}!size@{size}} -\index{size@{size}!ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily uint32\+\_\+t size} - -Packet size. \Hypertarget{structciot__nrf__dfu__packet_a3e7bef03191254ebdc38d44d1c2dad91}\label{structciot__nrf__dfu__packet_a3e7bef03191254ebdc38d44d1c2dad91} -\index{ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}!transferred@{transferred}} -\index{transferred@{transferred}!ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}} -\doxysubsubsection{\texorpdfstring{transferred}{transferred}} -{\footnotesize\ttfamily bool transferred} - -Transferred flag. \Hypertarget{structciot__nrf__dfu__packet_a50c8cebed3105b196315a23d0634f1a5}\label{structciot__nrf__dfu__packet_a50c8cebed3105b196315a23d0634f1a5} -\index{ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}!type@{type}} -\index{type@{type}!ciot\_nrf\_dfu\_packet@{ciot\_nrf\_dfu\_packet}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__nrf__dfu_8h_ad1e2509ab93366447d9f971d533419b0}{ciot\+\_\+nrf\+\_\+dfu\+\_\+packet\+\_\+type\+\_\+t}} type} - -Packet type. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__nrf__dfu_8h}{ciot\+\_\+nrf\+\_\+dfu.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ntp__cfg__t.tex b/docs/latex/structciot__ntp__cfg__t.tex deleted file mode 100644 index 48f90ae..0000000 --- a/docs/latex/structciot__ntp__cfg__t.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+ntp\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__ntp__cfg__t}{}\label{structciot__ntp__cfg__t}\index{ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}} - - -Structure for CIOT NTP configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+ntp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ntp__cfg__t_aec948fb30e99b1eda7e3d9ff741d417a}{op\+\_\+mode}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ntp__cfg__t_ac752937b32320cf191fe3abd0e8daed6}{sync\+\_\+mode}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__ntp__cfg__t_a5150de065f0b170644b21514c7530542}{sync\+\_\+interval}} -\item -char \mbox{\hyperlink{structciot__ntp__cfg__t_a4dc1e4fba8f7fec6b1579961829b34f7}{timezone}} \mbox{[}16\mbox{]} -\item -char \mbox{\hyperlink{structciot__ntp__cfg__t_ab80672fab5b8d7864411603053aaffa4}{server}} \mbox{[}\mbox{\hyperlink{ciot__ntp__types_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT}}\mbox{]}\mbox{[}64\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT NTP configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ntp__cfg__t_aec948fb30e99b1eda7e3d9ff741d417a}\label{structciot__ntp__cfg__t_aec948fb30e99b1eda7e3d9ff741d417a} -\index{ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}!op\_mode@{op\_mode}} -\index{op\_mode@{op\_mode}!ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{op\_mode}{op\_mode}} -{\footnotesize\ttfamily uint8\+\_\+t op\+\_\+mode} - -Operation mode \Hypertarget{structciot__ntp__cfg__t_ab80672fab5b8d7864411603053aaffa4}\label{structciot__ntp__cfg__t_ab80672fab5b8d7864411603053aaffa4} -\index{ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}!server@{server}} -\index{server@{server}!ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{server}{server}} -{\footnotesize\ttfamily char server\mbox{[}\mbox{\hyperlink{ciot__ntp__types_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT}}\mbox{]}\mbox{[}64\mbox{]}} - -NTP servers \Hypertarget{structciot__ntp__cfg__t_a5150de065f0b170644b21514c7530542}\label{structciot__ntp__cfg__t_a5150de065f0b170644b21514c7530542} -\index{ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}!sync\_interval@{sync\_interval}} -\index{sync\_interval@{sync\_interval}!ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{sync\_interval}{sync\_interval}} -{\footnotesize\ttfamily uint32\+\_\+t sync\+\_\+interval} - -Sync interval \Hypertarget{structciot__ntp__cfg__t_ac752937b32320cf191fe3abd0e8daed6}\label{structciot__ntp__cfg__t_ac752937b32320cf191fe3abd0e8daed6} -\index{ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}!sync\_mode@{sync\_mode}} -\index{sync\_mode@{sync\_mode}!ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{sync\_mode}{sync\_mode}} -{\footnotesize\ttfamily uint8\+\_\+t sync\+\_\+mode} - -Sync mode \Hypertarget{structciot__ntp__cfg__t_a4dc1e4fba8f7fec6b1579961829b34f7}\label{structciot__ntp__cfg__t_a4dc1e4fba8f7fec6b1579961829b34f7} -\index{ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}!timezone@{timezone}} -\index{timezone@{timezone}!ciot\_ntp\_cfg\_t@{ciot\_ntp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{timezone}{timezone}} -{\footnotesize\ttfamily char timezone\mbox{[}16\mbox{]}} - -Timezone - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ntp__req__t.tex b/docs/latex/structciot__ntp__req__t.tex deleted file mode 100644 index cb7880f..0000000 --- a/docs/latex/structciot__ntp__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ntp\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__ntp__req__t}{}\label{structciot__ntp__req__t}\index{ciot\_ntp\_req\_t@{ciot\_ntp\_req\_t}} - - -Structure for CIOT NTP request. - - - - -{\ttfamily \#include $<$ciot\+\_\+ntp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa}{ciot\+\_\+ntp\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__ntp__req__t_a54590843a59febd0e8055f9249974adc}{type}} -\item -\mbox{\hyperlink{unionciot__ntp__req__data__u}{ciot\+\_\+ntp\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__ntp__req__t_a9401df5c514eae3e23f4468d8ca7795e}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT NTP request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ntp__req__t_a9401df5c514eae3e23f4468d8ca7795e}\label{structciot__ntp__req__t_a9401df5c514eae3e23f4468d8ca7795e} -\index{ciot\_ntp\_req\_t@{ciot\_ntp\_req\_t}!data@{data}} -\index{data@{data}!ciot\_ntp\_req\_t@{ciot\_ntp\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ntp__req__data__u}{ciot\+\_\+ntp\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__ntp__req__t_a54590843a59febd0e8055f9249974adc}\label{structciot__ntp__req__t_a54590843a59febd0e8055f9249974adc} -\index{ciot\_ntp\_req\_t@{ciot\_ntp\_req\_t}!type@{type}} -\index{type@{type}!ciot\_ntp\_req\_t@{ciot\_ntp\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_a53a7f745407650095dbb3e38c09861fa}{ciot\+\_\+ntp\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ntp__status__msg__t.tex b/docs/latex/structciot__ntp__status__msg__t.tex deleted file mode 100644 index d238904..0000000 --- a/docs/latex/structciot__ntp__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ntp\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__ntp__status__msg__t}{}\label{structciot__ntp__status__msg__t}\index{ciot\_ntp\_status\_msg\_t@{ciot\_ntp\_status\_msg\_t}} - - -Structure for CIOT NTP status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+ntp.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__ntp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__ntp__status__t}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__ntp__status__msg__t_a95d5fa474c00a79ee883e78048ea7c4c}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT NTP status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ntp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__ntp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_ntp\_status\_msg\_t@{ciot\_ntp\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_ntp\_status\_msg\_t@{ciot\_ntp\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header. \Hypertarget{structciot__ntp__status__msg__t_a95d5fa474c00a79ee883e78048ea7c4c}\label{structciot__ntp__status__msg__t_a95d5fa474c00a79ee883e78048ea7c4c} -\index{ciot\_ntp\_status\_msg\_t@{ciot\_ntp\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_ntp\_status\_msg\_t@{ciot\_ntp\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ntp__status__t}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} status} - -NTP status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__ntp_8h}{ciot\+\_\+ntp.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ntp__status__t.tex b/docs/latex/structciot__ntp__status__t.tex deleted file mode 100644 index 062ce5c..0000000 --- a/docs/latex/structciot__ntp__status__t.tex +++ /dev/null @@ -1,73 +0,0 @@ -\doxysection{ciot\+\_\+ntp\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__ntp__status__t}{}\label{structciot__ntp__status__t}\index{ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}} - - -Structure for CIOT NTP status. - - - - -{\ttfamily \#include $<$ciot\+\_\+ntp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8}{ciot\+\_\+ntp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__ntp__status__t_a28ce8249c3bcacad6a7698b7697739b8}{state}} -\item -uint64\+\_\+t \mbox{\hyperlink{structciot__ntp__status__t_a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d}{last\+\_\+sync}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__ntp__status__t_a69671f26529c8f6076d53b96a1e1627f}{sync\+\_\+count}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ntp__status__t_a49f666045d24aa8becc5244bc2396aca}{init}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ntp__status__t_adb4b09387463cd61bf8f7217366310ef}{sync}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ntp__status__t_ac6c17ab632a9c78bc9fa846e9baeea7b}{reserve}}\+: 6 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT NTP status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ntp__status__t_a49f666045d24aa8becc5244bc2396aca}\label{structciot__ntp__status__t_a49f666045d24aa8becc5244bc2396aca} -\index{ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}!init@{init}} -\index{init@{init}!ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}} -\doxysubsubsection{\texorpdfstring{init}{init}} -{\footnotesize\ttfamily uint8\+\_\+t init} - -Initialization flag \Hypertarget{structciot__ntp__status__t_a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d}\label{structciot__ntp__status__t_a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d} -\index{ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}!last\_sync@{last\_sync}} -\index{last\_sync@{last\_sync}!ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}} -\doxysubsubsection{\texorpdfstring{last\_sync}{last\_sync}} -{\footnotesize\ttfamily uint64\+\_\+t last\+\_\+sync} - -Last synchronization timestamp \Hypertarget{structciot__ntp__status__t_ac6c17ab632a9c78bc9fa846e9baeea7b}\label{structciot__ntp__status__t_ac6c17ab632a9c78bc9fa846e9baeea7b} -\index{ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}!reserve@{reserve}} -\index{reserve@{reserve}!ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}} -\doxysubsubsection{\texorpdfstring{reserve}{reserve}} -{\footnotesize\ttfamily uint8\+\_\+t reserve} - -Reserved bits \Hypertarget{structciot__ntp__status__t_a28ce8249c3bcacad6a7698b7697739b8}\label{structciot__ntp__status__t_a28ce8249c3bcacad6a7698b7697739b8} -\index{ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}!state@{state}} -\index{state@{state}!ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_aa8a357ab71d5a3765f6444a442c00dd8}{ciot\+\_\+ntp\+\_\+state\+\_\+t}} state} - -NTP state \Hypertarget{structciot__ntp__status__t_adb4b09387463cd61bf8f7217366310ef}\label{structciot__ntp__status__t_adb4b09387463cd61bf8f7217366310ef} -\index{ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}!sync@{sync}} -\index{sync@{sync}!ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}} -\doxysubsubsection{\texorpdfstring{sync}{sync}} -{\footnotesize\ttfamily uint8\+\_\+t sync} - -Sync flag \Hypertarget{structciot__ntp__status__t_a69671f26529c8f6076d53b96a1e1627f}\label{structciot__ntp__status__t_a69671f26529c8f6076d53b96a1e1627f} -\index{ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}!sync\_count@{sync\_count}} -\index{sync\_count@{sync\_count}!ciot\_ntp\_status\_t@{ciot\_ntp\_status\_t}} -\doxysubsubsection{\texorpdfstring{sync\_count}{sync\_count}} -{\footnotesize\ttfamily uint16\+\_\+t sync\+\_\+count} - -Synchronization count - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__opcuas__cfg__t.tex b/docs/latex/structciot__opcuas__cfg__t.tex deleted file mode 100644 index 8ef0b48..0000000 --- a/docs/latex/structciot__opcuas__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__opcuas__cfg__t}{}\label{structciot__opcuas__cfg__t}\index{ciot\_opcuas\_cfg\_t@{ciot\_opcuas\_cfg\_t}} - - -Structure for CIOT OPC UA Server configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+opcuas\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__opcuas__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6}{port}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OPC UA Server configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__opcuas__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6}\label{structciot__opcuas__cfg__t_a83a04ad582de2b7d36b96f9db429c2c6} -\index{ciot\_opcuas\_cfg\_t@{ciot\_opcuas\_cfg\_t}!port@{port}} -\index{port@{port}!ciot\_opcuas\_cfg\_t@{ciot\_opcuas\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{port}{port}} -{\footnotesize\ttfamily uint32\+\_\+t port} - -Port number - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__opcuas__req__add__node__t.tex b/docs/latex/structciot__opcuas__req__add__node__t.tex deleted file mode 100644 index 8c089be..0000000 --- a/docs/latex/structciot__opcuas__req__add__node__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+req\+\_\+add\+\_\+node\+\_\+t Struct Reference} -\hypertarget{structciot__opcuas__req__add__node__t}{}\label{structciot__opcuas__req__add__node__t}\index{ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}} - - -Structure for CIOT OPC UA Server add node request. - - - - -{\ttfamily \#include $<$ciot\+\_\+opcuas\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__opcuas__req__add__node__t_acb5cfd209ba75c853d03f701e7f91679}{type}} -\item -char \mbox{\hyperlink{structciot__opcuas__req__add__node__t_aa5f4b442eedc591f6e6e03787e6343bc}{localization}} \mbox{[}8\mbox{]} -\item -char \mbox{\hyperlink{structciot__opcuas__req__add__node__t_acfcef1819c1ec84a215884bb45ed99b6}{display\+\_\+name}} \mbox{[}32\mbox{]} -\item -char \mbox{\hyperlink{structciot__opcuas__req__add__node__t_a381f93ba5743e8813f554bda3c272257}{node\+\_\+id}} \mbox{[}64\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OPC UA Server add node request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__opcuas__req__add__node__t_acfcef1819c1ec84a215884bb45ed99b6}\label{structciot__opcuas__req__add__node__t_acfcef1819c1ec84a215884bb45ed99b6} -\index{ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}!display\_name@{display\_name}} -\index{display\_name@{display\_name}!ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}} -\doxysubsubsection{\texorpdfstring{display\_name}{display\_name}} -{\footnotesize\ttfamily char display\+\_\+name\mbox{[}32\mbox{]}} - -Display name \Hypertarget{structciot__opcuas__req__add__node__t_aa5f4b442eedc591f6e6e03787e6343bc}\label{structciot__opcuas__req__add__node__t_aa5f4b442eedc591f6e6e03787e6343bc} -\index{ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}!localization@{localization}} -\index{localization@{localization}!ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}} -\doxysubsubsection{\texorpdfstring{localization}{localization}} -{\footnotesize\ttfamily char localization\mbox{[}8\mbox{]}} - -Localization \Hypertarget{structciot__opcuas__req__add__node__t_a381f93ba5743e8813f554bda3c272257}\label{structciot__opcuas__req__add__node__t_a381f93ba5743e8813f554bda3c272257} -\index{ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}!node\_id@{node\_id}} -\index{node\_id@{node\_id}!ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}} -\doxysubsubsection{\texorpdfstring{node\_id}{node\_id}} -{\footnotesize\ttfamily char node\+\_\+id\mbox{[}64\mbox{]}} - -Node ID \Hypertarget{structciot__opcuas__req__add__node__t_acb5cfd209ba75c853d03f701e7f91679}\label{structciot__opcuas__req__add__node__t_acb5cfd209ba75c853d03f701e7f91679} -\index{ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}!type@{type}} -\index{type@{type}!ciot\_opcuas\_req\_add\_node\_t@{ciot\_opcuas\_req\_add\_node\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily uint16\+\_\+t type} - -Node type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__opcuas__req__t.tex b/docs/latex/structciot__opcuas__req__t.tex deleted file mode 100644 index aaebce3..0000000 --- a/docs/latex/structciot__opcuas__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__opcuas__req__t}{}\label{structciot__opcuas__req__t}\index{ciot\_opcuas\_req\_t@{ciot\_opcuas\_req\_t}} - - -Structure for CIOT OPC UA Server request. - - - - -{\ttfamily \#include $<$ciot\+\_\+opcuas\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c}{ciot\+\_\+opcuas\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__opcuas__req__t_a6a535362b7c81b40f3ed9f6cb292a469}{type}} -\item -\mbox{\hyperlink{unionciot__opcuas__req__data__u}{ciot\+\_\+opcuas\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__opcuas__req__t_a18e3465478724c7b699bb5077661ea35}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OPC UA Server request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__opcuas__req__t_a18e3465478724c7b699bb5077661ea35}\label{structciot__opcuas__req__t_a18e3465478724c7b699bb5077661ea35} -\index{ciot\_opcuas\_req\_t@{ciot\_opcuas\_req\_t}!data@{data}} -\index{data@{data}!ciot\_opcuas\_req\_t@{ciot\_opcuas\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__opcuas__req__data__u}{ciot\+\_\+opcuas\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__opcuas__req__t_a6a535362b7c81b40f3ed9f6cb292a469}\label{structciot__opcuas__req__t_a6a535362b7c81b40f3ed9f6cb292a469} -\index{ciot\_opcuas\_req\_t@{ciot\_opcuas\_req\_t}!type@{type}} -\index{type@{type}!ciot\_opcuas\_req\_t@{ciot\_opcuas\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_a8acb0e423808124be763be38feed658c}{ciot\+\_\+opcuas\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__opcuas__status__msg__t.tex b/docs/latex/structciot__opcuas__status__msg__t.tex deleted file mode 100644 index a477a5d..0000000 --- a/docs/latex/structciot__opcuas__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__opcuas__status__msg__t}{}\label{structciot__opcuas__status__msg__t}\index{ciot\_opcuas\_status\_msg\_t@{ciot\_opcuas\_status\_msg\_t}} - - -Structure for CIOT OPCUAS status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+opcuas.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__opcuas__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__opcuas__status__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__opcuas__status__msg__t_ac3be6c0c62c2999a9dd9fa0099945876}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OPCUAS status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__opcuas__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__opcuas__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_opcuas\_status\_msg\_t@{ciot\_opcuas\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_opcuas\_status\_msg\_t@{ciot\_opcuas\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header. \Hypertarget{structciot__opcuas__status__msg__t_ac3be6c0c62c2999a9dd9fa0099945876}\label{structciot__opcuas__status__msg__t_ac3be6c0c62c2999a9dd9fa0099945876} -\index{ciot\_opcuas\_status\_msg\_t@{ciot\_opcuas\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_opcuas\_status\_msg\_t@{ciot\_opcuas\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__opcuas__status__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} status} - -OPCUAS status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__opcuas_8h}{ciot\+\_\+opcuas.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__opcuas__status__t.tex b/docs/latex/structciot__opcuas__status__t.tex deleted file mode 100644 index b6c74de..0000000 --- a/docs/latex/structciot__opcuas__status__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__opcuas__status__t}{}\label{structciot__opcuas__status__t}\index{ciot\_opcuas\_status\_t@{ciot\_opcuas\_status\_t}} - - -Structure for CIOT OPC UA Server status. - - - - -{\ttfamily \#include $<$ciot\+\_\+opcuas\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1}{ciot\+\_\+opcuas\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__opcuas__status__t_a584e26c042d8a98bf6161b7aa27ba4cf}{state}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OPC UA Server status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__opcuas__status__t_a584e26c042d8a98bf6161b7aa27ba4cf}\label{structciot__opcuas__status__t_a584e26c042d8a98bf6161b7aa27ba4cf} -\index{ciot\_opcuas\_status\_t@{ciot\_opcuas\_status\_t}!state@{state}} -\index{state@{state}!ciot\_opcuas\_status\_t@{ciot\_opcuas\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_ae5b6595b6e677b21cc33b747865552a1}{ciot\+\_\+opcuas\+\_\+state\+\_\+t}} state} - -OPC UA Server state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ota__cfg__t.tex b/docs/latex/structciot__ota__cfg__t.tex deleted file mode 100644 index 3f200ec..0000000 --- a/docs/latex/structciot__ota__cfg__t.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+ota\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__ota__cfg__t}{}\label{structciot__ota__cfg__t}\index{ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}} - - -Structure for CIOT OTA configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+ota\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__ota__cfg__t_a153935e13b871590c5521d1b258d017f}{url}} \mbox{[}128\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ota__cfg__t_a268d99c2d888dd67e8ea77d3be0a5021}{force}}\+:1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ota__cfg__t_afe60ab2756fb1ea1c1de6f3ec6dbea98}{encrypted}}\+:1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ota__cfg__t_a63de528fa8d98b79adfe7f9f68880c17}{restart}}\+:1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__ota__cfg__t_acb7bc06bed6f6408d719334fc41698c7}{reserved}}\+:5 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OTA configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ota__cfg__t_afe60ab2756fb1ea1c1de6f3ec6dbea98}\label{structciot__ota__cfg__t_afe60ab2756fb1ea1c1de6f3ec6dbea98} -\index{ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}!encrypted@{encrypted}} -\index{encrypted@{encrypted}!ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{encrypted}{encrypted}} -{\footnotesize\ttfamily uint8\+\_\+t encrypted} - -Flag for encrypted update \Hypertarget{structciot__ota__cfg__t_a268d99c2d888dd67e8ea77d3be0a5021}\label{structciot__ota__cfg__t_a268d99c2d888dd67e8ea77d3be0a5021} -\index{ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}!force@{force}} -\index{force@{force}!ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{force}{force}} -{\footnotesize\ttfamily uint8\+\_\+t force} - -Flag for forcing update \Hypertarget{structciot__ota__cfg__t_acb7bc06bed6f6408d719334fc41698c7}\label{structciot__ota__cfg__t_acb7bc06bed6f6408d719334fc41698c7} -\index{ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}!reserved@{reserved}} -\index{reserved@{reserved}!ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{reserved}{reserved}} -{\footnotesize\ttfamily uint8\+\_\+t reserved} - -Reserved bits \Hypertarget{structciot__ota__cfg__t_a63de528fa8d98b79adfe7f9f68880c17}\label{structciot__ota__cfg__t_a63de528fa8d98b79adfe7f9f68880c17} -\index{ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}!restart@{restart}} -\index{restart@{restart}!ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{restart}{restart}} -{\footnotesize\ttfamily uint8\+\_\+t restart} - -Flag for restarting after update \Hypertarget{structciot__ota__cfg__t_a153935e13b871590c5521d1b258d017f}\label{structciot__ota__cfg__t_a153935e13b871590c5521d1b258d017f} -\index{ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}!url@{url}} -\index{url@{url}!ciot\_ota\_cfg\_t@{ciot\_ota\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{url}{url}} -{\footnotesize\ttfamily char url\mbox{[}128\mbox{]}} - -URL for OTA update - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ota__req__t.tex b/docs/latex/structciot__ota__req__t.tex deleted file mode 100644 index 0116c52..0000000 --- a/docs/latex/structciot__ota__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ota\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__ota__req__t}{}\label{structciot__ota__req__t}\index{ciot\_ota\_req\_t@{ciot\_ota\_req\_t}} - - -Structure for CIOT OTA request. - - - - -{\ttfamily \#include $<$ciot\+\_\+ota\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20}{ciot\+\_\+ota\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__ota__req__t_a19605616d62f4ee24f6aefb6c34480e2}{type}} -\item -\mbox{\hyperlink{unionciot__ota__req__data__u}{ciot\+\_\+ota\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__ota__req__t_a77dc06e65f4b0aed4a3f44e1b6a32aa0}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OTA request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ota__req__t_a77dc06e65f4b0aed4a3f44e1b6a32aa0}\label{structciot__ota__req__t_a77dc06e65f4b0aed4a3f44e1b6a32aa0} -\index{ciot\_ota\_req\_t@{ciot\_ota\_req\_t}!data@{data}} -\index{data@{data}!ciot\_ota\_req\_t@{ciot\_ota\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ota__req__data__u}{ciot\+\_\+ota\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__ota__req__t_a19605616d62f4ee24f6aefb6c34480e2}\label{structciot__ota__req__t_a19605616d62f4ee24f6aefb6c34480e2} -\index{ciot\_ota\_req\_t@{ciot\_ota\_req\_t}!type@{type}} -\index{type@{type}!ciot\_ota\_req\_t@{ciot\_ota\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_ae4c439b857456a91d723985a8f600c20}{ciot\+\_\+ota\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ota__status__msg__t.tex b/docs/latex/structciot__ota__status__msg__t.tex deleted file mode 100644 index 2eaeb01..0000000 --- a/docs/latex/structciot__ota__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+ota\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__ota__status__msg__t}{}\label{structciot__ota__status__msg__t}\index{ciot\_ota\_status\_msg\_t@{ciot\_ota\_status\_msg\_t}} - - -Structure for CIOT OTA status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+ota.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__ota__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__ota__status__t}{ciot\+\_\+ota\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__ota__status__msg__t_a86de670b32fc6ad5c7a44fefb41e6e3a}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OTA status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ota__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__ota__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_ota\_status\_msg\_t@{ciot\_ota\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_ota\_status\_msg\_t@{ciot\_ota\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header. \Hypertarget{structciot__ota__status__msg__t_a86de670b32fc6ad5c7a44fefb41e6e3a}\label{structciot__ota__status__msg__t_a86de670b32fc6ad5c7a44fefb41e6e3a} -\index{ciot\_ota\_status\_msg\_t@{ciot\_ota\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_ota\_status\_msg\_t@{ciot\_ota\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ota__status__t}{ciot\+\_\+ota\+\_\+status\+\_\+t}} status} - -OTA status. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__ota_8h}{ciot\+\_\+ota.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__ota__status__t.tex b/docs/latex/structciot__ota__status__t.tex deleted file mode 100644 index c3b28fe..0000000 --- a/docs/latex/structciot__ota__status__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+ota\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__ota__status__t}{}\label{structciot__ota__status__t}\index{ciot\_ota\_status\_t@{ciot\_ota\_status\_t}} - - -Structure for CIOT OTA status. - - - - -{\ttfamily \#include $<$ciot\+\_\+ota\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15}{ciot\+\_\+ota\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__ota__status__t_a796f1aeb4c800b653ee018b20c818804}{state}} -\item -int \mbox{\hyperlink{structciot__ota__status__t_a11614f44ef4d939bdd984953346a7572}{error}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__ota__status__t_a42539ea8650b094f66be7a689243c5ef}{image\+\_\+size}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__ota__status__t_a990d41db67b3605c9184428e72edcea1}{image\+\_\+read}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT OTA status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__ota__status__t_a11614f44ef4d939bdd984953346a7572}\label{structciot__ota__status__t_a11614f44ef4d939bdd984953346a7572} -\index{ciot\_ota\_status\_t@{ciot\_ota\_status\_t}!error@{error}} -\index{error@{error}!ciot\_ota\_status\_t@{ciot\_ota\_status\_t}} -\doxysubsubsection{\texorpdfstring{error}{error}} -{\footnotesize\ttfamily int error} - -Error code \Hypertarget{structciot__ota__status__t_a990d41db67b3605c9184428e72edcea1}\label{structciot__ota__status__t_a990d41db67b3605c9184428e72edcea1} -\index{ciot\_ota\_status\_t@{ciot\_ota\_status\_t}!image\_read@{image\_read}} -\index{image\_read@{image\_read}!ciot\_ota\_status\_t@{ciot\_ota\_status\_t}} -\doxysubsubsection{\texorpdfstring{image\_read}{image\_read}} -{\footnotesize\ttfamily uint32\+\_\+t image\+\_\+read} - -Number of bytes read \Hypertarget{structciot__ota__status__t_a42539ea8650b094f66be7a689243c5ef}\label{structciot__ota__status__t_a42539ea8650b094f66be7a689243c5ef} -\index{ciot\_ota\_status\_t@{ciot\_ota\_status\_t}!image\_size@{image\_size}} -\index{image\_size@{image\_size}!ciot\_ota\_status\_t@{ciot\_ota\_status\_t}} -\doxysubsubsection{\texorpdfstring{image\_size}{image\_size}} -{\footnotesize\ttfamily uint32\+\_\+t image\+\_\+size} - -Size of the image \Hypertarget{structciot__ota__status__t_a796f1aeb4c800b653ee018b20c818804}\label{structciot__ota__status__t_a796f1aeb4c800b653ee018b20c818804} -\index{ciot\_ota\_status\_t@{ciot\_ota\_status\_t}!state@{state}} -\index{state@{state}!ciot\_ota\_status\_t@{ciot\_ota\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_a50dd94be7278926fa9490e0209fe3a15}{ciot\+\_\+ota\+\_\+state\+\_\+t}} state} - -OTA state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__req__delete__iface__cfg__t.tex b/docs/latex/structciot__req__delete__iface__cfg__t.tex deleted file mode 100644 index f08284d..0000000 --- a/docs/latex/structciot__req__delete__iface__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+req\+\_\+delete\+\_\+iface\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__req__delete__iface__cfg__t}{}\label{structciot__req__delete__iface__cfg__t}\index{ciot\_req\_delete\_iface\_cfg\_t@{ciot\_req\_delete\_iface\_cfg\_t}} - - -Structure for CIOT delete interface configuration request. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__req__delete__iface__cfg__t_a5aca650808126ada7193361ab8921e7a}{iface\+\_\+id}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT delete interface configuration request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__req__delete__iface__cfg__t_a5aca650808126ada7193361ab8921e7a}\label{structciot__req__delete__iface__cfg__t_a5aca650808126ada7193361ab8921e7a} -\index{ciot\_req\_delete\_iface\_cfg\_t@{ciot\_req\_delete\_iface\_cfg\_t}!iface\_id@{iface\_id}} -\index{iface\_id@{iface\_id}!ciot\_req\_delete\_iface\_cfg\_t@{ciot\_req\_delete\_iface\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{iface\_id}{iface\_id}} -{\footnotesize\ttfamily uint8\+\_\+t iface\+\_\+id} - -Interface ID - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__req__proxy__msg__t.tex b/docs/latex/structciot__req__proxy__msg__t.tex deleted file mode 100644 index 2983b2a..0000000 --- a/docs/latex/structciot__req__proxy__msg__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+req\+\_\+proxy\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__req__proxy__msg__t}{}\label{structciot__req__proxy__msg__t}\index{ciot\_req\_proxy\_msg\_t@{ciot\_req\_proxy\_msg\_t}} - - -Structure for CIOT proxy message request. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__req__proxy__msg__t_a82eb8e84b1ff534e368a647470a626c3}{iface}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__req__proxy__msg__t_aaba88b24a21a6c70c895c0d55f4a69a0}{size}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__req__proxy__msg__t_a71ed92c04817c761b6de921899b330d6}{data}} \mbox{[}256\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT proxy message request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__req__proxy__msg__t_a71ed92c04817c761b6de921899b330d6}\label{structciot__req__proxy__msg__t_a71ed92c04817c761b6de921899b330d6} -\index{ciot\_req\_proxy\_msg\_t@{ciot\_req\_proxy\_msg\_t}!data@{data}} -\index{data@{data}!ciot\_req\_proxy\_msg\_t@{ciot\_req\_proxy\_msg\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily uint8\+\_\+t data\mbox{[}256\mbox{]}} - -Message data \Hypertarget{structciot__req__proxy__msg__t_a82eb8e84b1ff534e368a647470a626c3}\label{structciot__req__proxy__msg__t_a82eb8e84b1ff534e368a647470a626c3} -\index{ciot\_req\_proxy\_msg\_t@{ciot\_req\_proxy\_msg\_t}!iface@{iface}} -\index{iface@{iface}!ciot\_req\_proxy\_msg\_t@{ciot\_req\_proxy\_msg\_t}} -\doxysubsubsection{\texorpdfstring{iface}{iface}} -{\footnotesize\ttfamily uint8\+\_\+t iface} - -Interface \Hypertarget{structciot__req__proxy__msg__t_aaba88b24a21a6c70c895c0d55f4a69a0}\label{structciot__req__proxy__msg__t_aaba88b24a21a6c70c895c0d55f4a69a0} -\index{ciot\_req\_proxy\_msg\_t@{ciot\_req\_proxy\_msg\_t}!size@{size}} -\index{size@{size}!ciot\_req\_proxy\_msg\_t@{ciot\_req\_proxy\_msg\_t}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily uint16\+\_\+t size} - -Message size - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__req__result__t.tex b/docs/latex/structciot__req__result__t.tex deleted file mode 100644 index 9acfe17..0000000 --- a/docs/latex/structciot__req__result__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+req\+\_\+result\+\_\+t Struct Reference} -\hypertarget{structciot__req__result__t}{}\label{structciot__req__result__t}\index{ciot\_req\_result\_t@{ciot\_req\_result\_t}} - - -Structure for CIOT request result. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__req__result__t_a5aca650808126ada7193361ab8921e7a}{iface\+\_\+id}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__req__result__t_a2dd2df43c7a23b9fb91e6e462c592477}{err}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT request result. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__req__result__t_a2dd2df43c7a23b9fb91e6e462c592477}\label{structciot__req__result__t_a2dd2df43c7a23b9fb91e6e462c592477} -\index{ciot\_req\_result\_t@{ciot\_req\_result\_t}!err@{err}} -\index{err@{err}!ciot\_req\_result\_t@{ciot\_req\_result\_t}} -\doxysubsubsection{\texorpdfstring{err}{err}} -{\footnotesize\ttfamily uint32\+\_\+t err} - -Error code \Hypertarget{structciot__req__result__t_a5aca650808126ada7193361ab8921e7a}\label{structciot__req__result__t_a5aca650808126ada7193361ab8921e7a} -\index{ciot\_req\_result\_t@{ciot\_req\_result\_t}!iface\_id@{iface\_id}} -\index{iface\_id@{iface\_id}!ciot\_req\_result\_t@{ciot\_req\_result\_t}} -\doxysubsubsection{\texorpdfstring{iface\_id}{iface\_id}} -{\footnotesize\ttfamily uint8\+\_\+t iface\+\_\+id} - -Interface ID - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__req__save__iface__cfg__t.tex b/docs/latex/structciot__req__save__iface__cfg__t.tex deleted file mode 100644 index 330937a..0000000 --- a/docs/latex/structciot__req__save__iface__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+req\+\_\+save\+\_\+iface\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__req__save__iface__cfg__t}{}\label{structciot__req__save__iface__cfg__t}\index{ciot\_req\_save\_iface\_cfg\_t@{ciot\_req\_save\_iface\_cfg\_t}} - - -Structure for CIOT save interface configuration request. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__req__save__iface__cfg__t_a5aca650808126ada7193361ab8921e7a}{iface\+\_\+id}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT save interface configuration request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__req__save__iface__cfg__t_a5aca650808126ada7193361ab8921e7a}\label{structciot__req__save__iface__cfg__t_a5aca650808126ada7193361ab8921e7a} -\index{ciot\_req\_save\_iface\_cfg\_t@{ciot\_req\_save\_iface\_cfg\_t}!iface\_id@{iface\_id}} -\index{iface\_id@{iface\_id}!ciot\_req\_save\_iface\_cfg\_t@{ciot\_req\_save\_iface\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{iface\_id}{iface\_id}} -{\footnotesize\ttfamily uint8\+\_\+t iface\+\_\+id} - -Interface ID - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__req__t.tex b/docs/latex/structciot__req__t.tex deleted file mode 100644 index 2260f17..0000000 --- a/docs/latex/structciot__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__req__t}{}\label{structciot__req__t}\index{ciot\_req\_t@{ciot\_req\_t}} - - -Structure for CIOT request. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3}{ciot\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__req__t_a55a6010bd818c4c1b94eca45963f09a9}{type}} -\item -\mbox{\hyperlink{unionciot__req__data__u}{ciot\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__req__t_aeecdef82363bc7b7d7ba9bf5f8f51908}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__req__t_aeecdef82363bc7b7d7ba9bf5f8f51908}\label{structciot__req__t_aeecdef82363bc7b7d7ba9bf5f8f51908} -\index{ciot\_req\_t@{ciot\_req\_t}!data@{data}} -\index{data@{data}!ciot\_req\_t@{ciot\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__req__data__u}{ciot\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__req__t_a55a6010bd818c4c1b94eca45963f09a9}\label{structciot__req__t_a55a6010bd818c4c1b94eca45963f09a9} -\index{ciot\_req\_t@{ciot\_req\_t}!type@{type}} -\index{type@{type}!ciot\_req\_t@{ciot\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a03b3036727499342240dda078a6c69a3}{ciot\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__s__cfg.tex b/docs/latex/structciot__s__cfg.tex deleted file mode 100644 index 551cba0..0000000 --- a/docs/latex/structciot__s__cfg.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+s\+\_\+cfg Struct Reference} -\hypertarget{structciot__s__cfg}{}\label{structciot__s__cfg}\index{ciot\_s\_cfg@{ciot\_s\_cfg}} - - -CIOT\+\_\+S config struct. - - - - -{\ttfamily \#include $<$ciot\+\_\+s.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\+\_\+s\+\_\+msg\+\_\+handler\+\_\+t}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__s__cfg_a8a3b67e9e535387d32be766122edf704}{send\+\_\+bytes}} -\item -\mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\+\_\+s\+\_\+msg\+\_\+handler\+\_\+t}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__s__cfg_a104dd7ebfd24bb8b26a683a795e169d2}{on\+\_\+message\+\_\+cb}} -\item -\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__s__cfg_add0d24e0065c33f7e1da60ac94e6988b}{iface}} -\item -bool \mbox{\hyperlink{structciot__s__cfg_a4e8946f8a10777bc88814da1c657815c}{bridge\+\_\+mode}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -CIOT\+\_\+S config struct. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__s__cfg_a4e8946f8a10777bc88814da1c657815c}\label{structciot__s__cfg_a4e8946f8a10777bc88814da1c657815c} -\index{ciot\_s\_cfg@{ciot\_s\_cfg}!bridge\_mode@{bridge\_mode}} -\index{bridge\_mode@{bridge\_mode}!ciot\_s\_cfg@{ciot\_s\_cfg}} -\doxysubsubsection{\texorpdfstring{bridge\_mode}{bridge\_mode}} -{\footnotesize\ttfamily bool bridge\+\_\+mode} - -Enable bridge mode. In this mode, CIOT\+\_\+S protocol will be disabled \Hypertarget{structciot__s__cfg_add0d24e0065c33f7e1da60ac94e6988b}\label{structciot__s__cfg_add0d24e0065c33f7e1da60ac94e6988b} -\index{ciot\_s\_cfg@{ciot\_s\_cfg}!iface@{iface}} -\index{iface@{iface}!ciot\_s\_cfg@{ciot\_s\_cfg}} -\doxysubsubsection{\texorpdfstring{iface}{iface}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}}\texorpdfstring{$\ast$}{*} iface} - -Interface instance pointer \Hypertarget{structciot__s__cfg_a104dd7ebfd24bb8b26a683a795e169d2}\label{structciot__s__cfg_a104dd7ebfd24bb8b26a683a795e169d2} -\index{ciot\_s\_cfg@{ciot\_s\_cfg}!on\_message\_cb@{on\_message\_cb}} -\index{on\_message\_cb@{on\_message\_cb}!ciot\_s\_cfg@{ciot\_s\_cfg}} -\doxysubsubsection{\texorpdfstring{on\_message\_cb}{on\_message\_cb}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\+\_\+s\+\_\+msg\+\_\+handler\+\_\+t}}\texorpdfstring{$\ast$}{*} on\+\_\+message\+\_\+cb} - -Callback called when receiving message \Hypertarget{structciot__s__cfg_a8a3b67e9e535387d32be766122edf704}\label{structciot__s__cfg_a8a3b67e9e535387d32be766122edf704} -\index{ciot\_s\_cfg@{ciot\_s\_cfg}!send\_bytes@{send\_bytes}} -\index{send\_bytes@{send\_bytes}!ciot\_s\_cfg@{ciot\_s\_cfg}} -\doxysubsubsection{\texorpdfstring{send\_bytes}{send\_bytes}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__s_8h_a4ed3963449a508259fadfdd0842d7c5d}{ciot\+\_\+s\+\_\+msg\+\_\+handler\+\_\+t}}\texorpdfstring{$\ast$}{*} send\+\_\+bytes} - -Function used to send bytes - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__s_8h}{ciot\+\_\+s.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__serializer.tex b/docs/latex/structciot__serializer.tex deleted file mode 100644 index aec7214..0000000 --- a/docs/latex/structciot__serializer.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+serializer Struct Reference} -\hypertarget{structciot__serializer}{}\label{structciot__serializer}\index{ciot\_serializer@{ciot\_serializer}} - - -CIOT Serializer structure. - - - - -{\ttfamily \#include $<$ciot\+\_\+serializer.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7}{ciot\+\_\+serializer\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__serializer_a592dc1023ebe4d8247de4f601b4c20f5}{type}} -\item -\mbox{\hyperlink{ciot__serializer_8h_ad5f4d77f37d8f97c45e7ac3684c6240d}{ciot\+\_\+serializer\+\_\+to\+\_\+bytes\+\_\+fn}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__serializer_a5134e67f23ff9c0bf8efd1e393d8d2c1}{to\+\_\+bytes}} -\item -\mbox{\hyperlink{ciot__serializer_8h_ad4e6ec6f4f6b2794af860108e701a284}{ciot\+\_\+serializer\+\_\+from\+\_\+bytes\+\_\+fn}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__serializer_a54d8784095e9490e44f8ddc37679ef81}{from\+\_\+bytes}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -CIOT Serializer structure. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__serializer_a54d8784095e9490e44f8ddc37679ef81}\label{structciot__serializer_a54d8784095e9490e44f8ddc37679ef81} -\index{ciot\_serializer@{ciot\_serializer}!from\_bytes@{from\_bytes}} -\index{from\_bytes@{from\_bytes}!ciot\_serializer@{ciot\_serializer}} -\doxysubsubsection{\texorpdfstring{from\_bytes}{from\_bytes}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__serializer_8h_ad4e6ec6f4f6b2794af860108e701a284}{ciot\+\_\+serializer\+\_\+from\+\_\+bytes\+\_\+fn}}\texorpdfstring{$\ast$}{*} from\+\_\+bytes} - -Function pointer for deserializing from bytes \Hypertarget{structciot__serializer_a5134e67f23ff9c0bf8efd1e393d8d2c1}\label{structciot__serializer_a5134e67f23ff9c0bf8efd1e393d8d2c1} -\index{ciot\_serializer@{ciot\_serializer}!to\_bytes@{to\_bytes}} -\index{to\_bytes@{to\_bytes}!ciot\_serializer@{ciot\_serializer}} -\doxysubsubsection{\texorpdfstring{to\_bytes}{to\_bytes}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__serializer_8h_ad5f4d77f37d8f97c45e7ac3684c6240d}{ciot\+\_\+serializer\+\_\+to\+\_\+bytes\+\_\+fn}}\texorpdfstring{$\ast$}{*} to\+\_\+bytes} - -Function pointer for serializing to bytes \Hypertarget{structciot__serializer_a592dc1023ebe4d8247de4f601b4c20f5}\label{structciot__serializer_a592dc1023ebe4d8247de4f601b4c20f5} -\index{ciot\_serializer@{ciot\_serializer}!type@{type}} -\index{type@{type}!ciot\_serializer@{ciot\_serializer}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__serializer_8h_a3c892bb829d28086be610a8f850066f7}{ciot\+\_\+serializer\+\_\+type\+\_\+t}} type} - -Serializer type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__serializer_8h}{ciot\+\_\+serializer.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__slip__t.tex b/docs/latex/structciot__slip__t.tex deleted file mode 100644 index 61ef09e..0000000 --- a/docs/latex/structciot__slip__t.tex +++ /dev/null @@ -1,73 +0,0 @@ -\doxysection{ciot\+\_\+slip\+\_\+t Struct Reference} -\hypertarget{structciot__slip__t}{}\label{structciot__slip__t}\index{ciot\_slip\_t@{ciot\_slip\_t}} - - -Representation of a SLIP packet. - - - - -{\ttfamily \#include $<$ciot\+\_\+slip.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__slip__t_accaf0db15b7c2817f00fed318f13fe5b}{state}} -\begin{DoxyCompactList}\small\item\em Current state of the packet (see \doxylink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}). \end{DoxyCompactList}\item -uint8\+\_\+t \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__slip__t_a247b6cc8b5cd8bd49b0c4c62ed59f7b8}{p\+\_\+buffer}} -\begin{DoxyCompactList}\small\item\em Decoded data. \end{DoxyCompactList}\item -uint32\+\_\+t \mbox{\hyperlink{structciot__slip__t_ad1e3bc5a59e7ed48387fb95383fae12f}{current\+\_\+index}} -\begin{DoxyCompactList}\small\item\em Current length of the packet that has been received. \end{DoxyCompactList}\item -uint32\+\_\+t \mbox{\hyperlink{structciot__slip__t_a899cec1e08bcfa497396baa3584d18e1}{buffer\+\_\+len}} -\begin{DoxyCompactList}\small\item\em Size of the buffer that is available. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Representation of a SLIP packet. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__slip__t_a899cec1e08bcfa497396baa3584d18e1}\label{structciot__slip__t_a899cec1e08bcfa497396baa3584d18e1} -\index{ciot\_slip\_t@{ciot\_slip\_t}!buffer\_len@{buffer\_len}} -\index{buffer\_len@{buffer\_len}!ciot\_slip\_t@{ciot\_slip\_t}} -\doxysubsubsection{\texorpdfstring{buffer\_len}{buffer\_len}} -{\footnotesize\ttfamily uint32\+\_\+t buffer\+\_\+len} - - - -Size of the buffer that is available. - -\Hypertarget{structciot__slip__t_ad1e3bc5a59e7ed48387fb95383fae12f}\label{structciot__slip__t_ad1e3bc5a59e7ed48387fb95383fae12f} -\index{ciot\_slip\_t@{ciot\_slip\_t}!current\_index@{current\_index}} -\index{current\_index@{current\_index}!ciot\_slip\_t@{ciot\_slip\_t}} -\doxysubsubsection{\texorpdfstring{current\_index}{current\_index}} -{\footnotesize\ttfamily uint32\+\_\+t current\+\_\+index} - - - -Current length of the packet that has been received. - -\Hypertarget{structciot__slip__t_a247b6cc8b5cd8bd49b0c4c62ed59f7b8}\label{structciot__slip__t_a247b6cc8b5cd8bd49b0c4c62ed59f7b8} -\index{ciot\_slip\_t@{ciot\_slip\_t}!p\_buffer@{p\_buffer}} -\index{p\_buffer@{p\_buffer}!ciot\_slip\_t@{ciot\_slip\_t}} -\doxysubsubsection{\texorpdfstring{p\_buffer}{p\_buffer}} -{\footnotesize\ttfamily uint8\+\_\+t\texorpdfstring{$\ast$}{*} p\+\_\+buffer} - - - -Decoded data. - -\Hypertarget{structciot__slip__t_accaf0db15b7c2817f00fed318f13fe5b}\label{structciot__slip__t_accaf0db15b7c2817f00fed318f13fe5b} -\index{ciot\_slip\_t@{ciot\_slip\_t}!state@{state}} -\index{state@{state}!ciot\_slip\_t@{ciot\_slip\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}} state} - - - -Current state of the packet (see \doxylink{ciot__slip_8h_a290de618dbd8ce83c3c43ec2e9c393a1}{ciot\+\_\+slip\+\_\+read\+\_\+state\+\_\+t}). - - - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__slip_8h}{ciot\+\_\+slip.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__status__t.tex b/docs/latex/structciot__status__t.tex deleted file mode 100644 index 46abdad..0000000 --- a/docs/latex/structciot__status__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__status__t}{}\label{structciot__status__t}\index{ciot\_status\_t@{ciot\_status\_t}} - - -Structure for CIOT status. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2}{ciot\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__status__t_ab3a7653fc8a3bfebedb322cceec24c38}{state}} -\item -\mbox{\hyperlink{structciot__info__t}{ciot\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__status__t_a92c867a7e919ec76d2e58647718b633a}{info}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__status__t_a92c867a7e919ec76d2e58647718b633a}\label{structciot__status__t_a92c867a7e919ec76d2e58647718b633a} -\index{ciot\_status\_t@{ciot\_status\_t}!info@{info}} -\index{info@{info}!ciot\_status\_t@{ciot\_status\_t}} -\doxysubsubsection{\texorpdfstring{info}{info}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__info__t}{ciot\+\_\+info\+\_\+t}} info} - -CIOT information \Hypertarget{structciot__status__t_ab3a7653fc8a3bfebedb322cceec24c38}\label{structciot__status__t_ab3a7653fc8a3bfebedb322cceec24c38} -\index{ciot\_status\_t@{ciot\_status\_t}!state@{state}} -\index{state@{state}!ciot\_status\_t@{ciot\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a95856e0042526f191649883a3a46dfe2}{ciot\+\_\+state\+\_\+t}} state} - -CIOT state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__storage__cfg__t.tex b/docs/latex/structciot__storage__cfg__t.tex deleted file mode 100644 index 0abd5da..0000000 --- a/docs/latex/structciot__storage__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+storage\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__storage__cfg__t}{}\label{structciot__storage__cfg__t}\index{ciot\_storage\_cfg\_t@{ciot\_storage\_cfg\_t}} - - -Structure for CIOT storage configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+storage\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239}{ciot\+\_\+storage\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__storage__cfg__t_aa03a710482f738f9fe6095f1d4c6774a}{type}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT storage configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__storage__cfg__t_aa03a710482f738f9fe6095f1d4c6774a}\label{structciot__storage__cfg__t_aa03a710482f738f9fe6095f1d4c6774a} -\index{ciot\_storage\_cfg\_t@{ciot\_storage\_cfg\_t}!type@{type}} -\index{type@{type}!ciot\_storage\_cfg\_t@{ciot\_storage\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_abb72c818894c3c97f955258320bae239}{ciot\+\_\+storage\+\_\+type\+\_\+t}} type} - -Storage type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__storage__req__file__data__t.tex b/docs/latex/structciot__storage__req__file__data__t.tex deleted file mode 100644 index b17de9c..0000000 --- a/docs/latex/structciot__storage__req__file__data__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+storage\+\_\+req\+\_\+file\+\_\+data\+\_\+t Struct Reference} -\hypertarget{structciot__storage__req__file__data__t}{}\label{structciot__storage__req__file__data__t}\index{ciot\_storage\_req\_file\_data\_t@{ciot\_storage\_req\_file\_data\_t}} - - -Structure for CIOT storage file data in a request. - - - - -{\ttfamily \#include $<$ciot\+\_\+storage\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__storage__req__file__data__t_ace45f567511d3f9ff978c679ae38b5b0}{path}} \mbox{[}16\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__storage__req__file__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0}{size}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__storage__req__file__data__t_afe23ad4b14c014e0c70c96d93e44005c}{data}} \mbox{[}255\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT storage file data in a request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__storage__req__file__data__t_afe23ad4b14c014e0c70c96d93e44005c}\label{structciot__storage__req__file__data__t_afe23ad4b14c014e0c70c96d93e44005c} -\index{ciot\_storage\_req\_file\_data\_t@{ciot\_storage\_req\_file\_data\_t}!data@{data}} -\index{data@{data}!ciot\_storage\_req\_file\_data\_t@{ciot\_storage\_req\_file\_data\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily uint8\+\_\+t data\mbox{[}255\mbox{]}} - -Data content \Hypertarget{structciot__storage__req__file__data__t_ace45f567511d3f9ff978c679ae38b5b0}\label{structciot__storage__req__file__data__t_ace45f567511d3f9ff978c679ae38b5b0} -\index{ciot\_storage\_req\_file\_data\_t@{ciot\_storage\_req\_file\_data\_t}!path@{path}} -\index{path@{path}!ciot\_storage\_req\_file\_data\_t@{ciot\_storage\_req\_file\_data\_t}} -\doxysubsubsection{\texorpdfstring{path}{path}} -{\footnotesize\ttfamily char path\mbox{[}16\mbox{]}} - -File path \Hypertarget{structciot__storage__req__file__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0}\label{structciot__storage__req__file__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0} -\index{ciot\_storage\_req\_file\_data\_t@{ciot\_storage\_req\_file\_data\_t}!size@{size}} -\index{size@{size}!ciot\_storage\_req\_file\_data\_t@{ciot\_storage\_req\_file\_data\_t}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily uint8\+\_\+t size} - -Data size - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__storage__req__t.tex b/docs/latex/structciot__storage__req__t.tex deleted file mode 100644 index be7c3d2..0000000 --- a/docs/latex/structciot__storage__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+storage\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__storage__req__t}{}\label{structciot__storage__req__t}\index{ciot\_storage\_req\_t@{ciot\_storage\_req\_t}} - - -Structure for CIOT storage request. - - - - -{\ttfamily \#include $<$ciot\+\_\+storage\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541}{ciot\+\_\+storage\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__storage__req__t_a7b3cbcb3aea8c25ecc00d1316d1a79d6}{type}} -\item -\mbox{\hyperlink{structciot__storage__req__file__data__t}{ciot\+\_\+storage\+\_\+req\+\_\+file\+\_\+data\+\_\+t}} \mbox{\hyperlink{structciot__storage__req__t_a6b5e08e2800e812e2ee5294c83ac9fe6}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT storage request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__storage__req__t_a6b5e08e2800e812e2ee5294c83ac9fe6}\label{structciot__storage__req__t_a6b5e08e2800e812e2ee5294c83ac9fe6} -\index{ciot\_storage\_req\_t@{ciot\_storage\_req\_t}!data@{data}} -\index{data@{data}!ciot\_storage\_req\_t@{ciot\_storage\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__storage__req__file__data__t}{ciot\+\_\+storage\+\_\+req\+\_\+file\+\_\+data\+\_\+t}} data} - -Request data \Hypertarget{structciot__storage__req__t_a7b3cbcb3aea8c25ecc00d1316d1a79d6}\label{structciot__storage__req__t_a7b3cbcb3aea8c25ecc00d1316d1a79d6} -\index{ciot\_storage\_req\_t@{ciot\_storage\_req\_t}!type@{type}} -\index{type@{type}!ciot\_storage\_req\_t@{ciot\_storage\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_ab7057228a41784a8075f122e0c436541}{ciot\+\_\+storage\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__storage__status__msg__t.tex b/docs/latex/structciot__storage__status__msg__t.tex deleted file mode 100644 index 639e0b0..0000000 --- a/docs/latex/structciot__storage__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+storage\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__storage__status__msg__t}{}\label{structciot__storage__status__msg__t}\index{ciot\_storage\_status\_msg\_t@{ciot\_storage\_status\_msg\_t}} - - -CIOT Storage status message structure. - - - - -{\ttfamily \#include $<$ciot\+\_\+storage.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__storage__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__storage__status__t}{ciot\+\_\+storage\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__storage__status__msg__t_ac1a66aa256f203858bb2477b812e36fb}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -CIOT Storage status message structure. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__storage__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__storage__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_storage\_status\_msg\_t@{ciot\_storage\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_storage\_status\_msg\_t@{ciot\_storage\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__storage__status__msg__t_ac1a66aa256f203858bb2477b812e36fb}\label{structciot__storage__status__msg__t_ac1a66aa256f203858bb2477b812e36fb} -\index{ciot\_storage\_status\_msg\_t@{ciot\_storage\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_storage\_status\_msg\_t@{ciot\_storage\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__storage__status__t}{ciot\+\_\+storage\+\_\+status\+\_\+t}} status} - -Storage status - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__storage_8h}{ciot\+\_\+storage.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__storage__status__t.tex b/docs/latex/structciot__storage__status__t.tex deleted file mode 100644 index d57b84a..0000000 --- a/docs/latex/structciot__storage__status__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+storage\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__storage__status__t}{}\label{structciot__storage__status__t}\index{ciot\_storage\_status\_t@{ciot\_storage\_status\_t}} - - -Structure for CIOT storage status. - - - - -{\ttfamily \#include $<$ciot\+\_\+storage\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86}{ciot\+\_\+storage\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__storage__status__t_aabc97b8fe1b1624b67ee7bc472d5b0b0}{state}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT storage status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__storage__status__t_aabc97b8fe1b1624b67ee7bc472d5b0b0}\label{structciot__storage__status__t_aabc97b8fe1b1624b67ee7bc472d5b0b0} -\index{ciot\_storage\_status\_t@{ciot\_storage\_status\_t}!state@{state}} -\index{state@{state}!ciot\_storage\_status\_t@{ciot\_storage\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a904b5a0e6bb3f9a7880c9d25250ddb86}{ciot\+\_\+storage\+\_\+state\+\_\+t}} state} - -Storage state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__cfg__t.tex b/docs/latex/structciot__sys__cfg__t.tex deleted file mode 100644 index 2478a5c..0000000 --- a/docs/latex/structciot__sys__cfg__t.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__sys__cfg__t}{}\label{structciot__sys__cfg__t}\index{ciot\_sys\_cfg\_t@{ciot\_sys\_cfg\_t}} - - -Structure for CIOT system configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Structure for CIOT system configuration. - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__features__t.tex b/docs/latex/structciot__sys__features__t.tex deleted file mode 100644 index 0a7c35f..0000000 --- a/docs/latex/structciot__sys__features__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+features\+\_\+t Struct Reference} -\hypertarget{structciot__sys__features__t}{}\label{structciot__sys__features__t}\index{ciot\_sys\_features\_t@{ciot\_sys\_features\_t}} - - -Structure for CIOT system features combining hardware and software features. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__sys__hw__features__t}{ciot\+\_\+sys\+\_\+hw\+\_\+features\+\_\+t}} \mbox{\hyperlink{structciot__sys__features__t_a68d421729d1895d3b9a6f4cc1dedbb42}{hw}} -\item -\mbox{\hyperlink{structciot__sys__sw__features__t}{ciot\+\_\+sys\+\_\+sw\+\_\+features\+\_\+t}} \mbox{\hyperlink{structciot__sys__features__t_aeb930ea2d960351877d7ef0a126173ff}{sw}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT system features combining hardware and software features. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__sys__features__t_a68d421729d1895d3b9a6f4cc1dedbb42}\label{structciot__sys__features__t_a68d421729d1895d3b9a6f4cc1dedbb42} -\index{ciot\_sys\_features\_t@{ciot\_sys\_features\_t}!hw@{hw}} -\index{hw@{hw}!ciot\_sys\_features\_t@{ciot\_sys\_features\_t}} -\doxysubsubsection{\texorpdfstring{hw}{hw}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__hw__features__t}{ciot\+\_\+sys\+\_\+hw\+\_\+features\+\_\+t}} hw} - -Hardware features \Hypertarget{structciot__sys__features__t_aeb930ea2d960351877d7ef0a126173ff}\label{structciot__sys__features__t_aeb930ea2d960351877d7ef0a126173ff} -\index{ciot\_sys\_features\_t@{ciot\_sys\_features\_t}!sw@{sw}} -\index{sw@{sw}!ciot\_sys\_features\_t@{ciot\_sys\_features\_t}} -\doxysubsubsection{\texorpdfstring{sw}{sw}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__sw__features__t}{ciot\+\_\+sys\+\_\+sw\+\_\+features\+\_\+t}} sw} - -Software features - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__hw__features__t.tex b/docs/latex/structciot__sys__hw__features__t.tex deleted file mode 100644 index d9cb2d9..0000000 --- a/docs/latex/structciot__sys__hw__features__t.tex +++ /dev/null @@ -1,97 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+hw\+\_\+features\+\_\+t Struct Reference} -\hypertarget{structciot__sys__hw__features__t}{}\label{structciot__sys__hw__features__t}\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} - - -Structure for CIOT system hardware features. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_ab8549384ff6a90d5fedec40cd3535ebf}{storage}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_a2e90afcc174ac8d99edf7229774986db}{system}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_ab56ae378dca42f3463d9dab3f4462045}{uart}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_a71f3331b8fa338b8bb771e9c60142df8}{usb}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_a634aacbacba6e5a795fbebf904d6f827}{ethernet}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_abf7485e5a2b2214d69dd780eddc62f39}{wifi}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_a3541968d9c0a8b544893692fb34cfdee}{ble\+\_\+scn}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_a633be9f96069e4c7cb47b431f80ca974}{gpio}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__hw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3}{reserved}}\+: 8 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT system hardware features. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__sys__hw__features__t_a3541968d9c0a8b544893692fb34cfdee}\label{structciot__sys__hw__features__t_a3541968d9c0a8b544893692fb34cfdee} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!ble\_scn@{ble\_scn}} -\index{ble\_scn@{ble\_scn}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{ble\_scn}{ble\_scn}} -{\footnotesize\ttfamily uint16\+\_\+t ble\+\_\+scn} - -BLE SCN (Serial Control) feature \Hypertarget{structciot__sys__hw__features__t_a634aacbacba6e5a795fbebf904d6f827}\label{structciot__sys__hw__features__t_a634aacbacba6e5a795fbebf904d6f827} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!ethernet@{ethernet}} -\index{ethernet@{ethernet}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{ethernet}{ethernet}} -{\footnotesize\ttfamily uint16\+\_\+t ethernet} - -Ethernet feature \Hypertarget{structciot__sys__hw__features__t_a633be9f96069e4c7cb47b431f80ca974}\label{structciot__sys__hw__features__t_a633be9f96069e4c7cb47b431f80ca974} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!gpio@{gpio}} -\index{gpio@{gpio}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{gpio}{gpio}} -{\footnotesize\ttfamily uint16\+\_\+t gpio} - -GPIO feature \Hypertarget{structciot__sys__hw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3}\label{structciot__sys__hw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!reserved@{reserved}} -\index{reserved@{reserved}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{reserved}{reserved}} -{\footnotesize\ttfamily uint16\+\_\+t reserved} - -Reserved bits \Hypertarget{structciot__sys__hw__features__t_ab8549384ff6a90d5fedec40cd3535ebf}\label{structciot__sys__hw__features__t_ab8549384ff6a90d5fedec40cd3535ebf} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!storage@{storage}} -\index{storage@{storage}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{storage}{storage}} -{\footnotesize\ttfamily uint16\+\_\+t storage} - -Storage feature \Hypertarget{structciot__sys__hw__features__t_a2e90afcc174ac8d99edf7229774986db}\label{structciot__sys__hw__features__t_a2e90afcc174ac8d99edf7229774986db} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!system@{system}} -\index{system@{system}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{system}{system}} -{\footnotesize\ttfamily uint16\+\_\+t system} - -System feature \Hypertarget{structciot__sys__hw__features__t_ab56ae378dca42f3463d9dab3f4462045}\label{structciot__sys__hw__features__t_ab56ae378dca42f3463d9dab3f4462045} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!uart@{uart}} -\index{uart@{uart}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{uart}{uart}} -{\footnotesize\ttfamily uint16\+\_\+t uart} - -UART feature \Hypertarget{structciot__sys__hw__features__t_a71f3331b8fa338b8bb771e9c60142df8}\label{structciot__sys__hw__features__t_a71f3331b8fa338b8bb771e9c60142df8} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!usb@{usb}} -\index{usb@{usb}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{usb}{usb}} -{\footnotesize\ttfamily uint16\+\_\+t usb} - -USB feature \Hypertarget{structciot__sys__hw__features__t_abf7485e5a2b2214d69dd780eddc62f39}\label{structciot__sys__hw__features__t_abf7485e5a2b2214d69dd780eddc62f39} -\index{ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}!wifi@{wifi}} -\index{wifi@{wifi}!ciot\_sys\_hw\_features\_t@{ciot\_sys\_hw\_features\_t}} -\doxysubsubsection{\texorpdfstring{wifi}{wifi}} -{\footnotesize\ttfamily uint16\+\_\+t wifi} - -Wi\+Fi feature - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__info__t.tex b/docs/latex/structciot__sys__info__t.tex deleted file mode 100644 index 21197c6..0000000 --- a/docs/latex/structciot__sys__info__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__sys__info__t}{}\label{structciot__sys__info__t}\index{ciot\_sys\_info\_t@{ciot\_sys\_info\_t}} - - -Structure for CIOT system information. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__sys__info__t_adc57848c0c5ba85f8662d618bcbd80a7}{hw\+\_\+name}} \mbox{[}16\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__sys__info__t_a33414ac5d16ad70f9ff7696f7922beec}{app\+\_\+ver}} \mbox{[}3\mbox{]} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\+\_\+sys\+\_\+hw\+\_\+t}} \mbox{\hyperlink{structciot__sys__info__t_a978e0f986a3de1feb66ebf37cd43b274}{hardware}} -\item -\mbox{\hyperlink{structciot__sys__features__t}{ciot\+\_\+sys\+\_\+features\+\_\+t}} \mbox{\hyperlink{structciot__sys__info__t_a08bf5c347b3e2c3525c382eaab3d6f97}{features}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT system information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__sys__info__t_a33414ac5d16ad70f9ff7696f7922beec}\label{structciot__sys__info__t_a33414ac5d16ad70f9ff7696f7922beec} -\index{ciot\_sys\_info\_t@{ciot\_sys\_info\_t}!app\_ver@{app\_ver}} -\index{app\_ver@{app\_ver}!ciot\_sys\_info\_t@{ciot\_sys\_info\_t}} -\doxysubsubsection{\texorpdfstring{app\_ver}{app\_ver}} -{\footnotesize\ttfamily uint8\+\_\+t app\+\_\+ver\mbox{[}3\mbox{]}} - -Application version \Hypertarget{structciot__sys__info__t_a08bf5c347b3e2c3525c382eaab3d6f97}\label{structciot__sys__info__t_a08bf5c347b3e2c3525c382eaab3d6f97} -\index{ciot\_sys\_info\_t@{ciot\_sys\_info\_t}!features@{features}} -\index{features@{features}!ciot\_sys\_info\_t@{ciot\_sys\_info\_t}} -\doxysubsubsection{\texorpdfstring{features}{features}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__features__t}{ciot\+\_\+sys\+\_\+features\+\_\+t}} features} - -System features \Hypertarget{structciot__sys__info__t_a978e0f986a3de1feb66ebf37cd43b274}\label{structciot__sys__info__t_a978e0f986a3de1feb66ebf37cd43b274} -\index{ciot\_sys\_info\_t@{ciot\_sys\_info\_t}!hardware@{hardware}} -\index{hardware@{hardware}!ciot\_sys\_info\_t@{ciot\_sys\_info\_t}} -\doxysubsubsection{\texorpdfstring{hardware}{hardware}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a7f47e5291a35126d37482ded0232e5ef}{ciot\+\_\+sys\+\_\+hw\+\_\+t}} hardware} - -Hardware type \Hypertarget{structciot__sys__info__t_adc57848c0c5ba85f8662d618bcbd80a7}\label{structciot__sys__info__t_adc57848c0c5ba85f8662d618bcbd80a7} -\index{ciot\_sys\_info\_t@{ciot\_sys\_info\_t}!hw\_name@{hw\_name}} -\index{hw\_name@{hw\_name}!ciot\_sys\_info\_t@{ciot\_sys\_info\_t}} -\doxysubsubsection{\texorpdfstring{hw\_name}{hw\_name}} -{\footnotesize\ttfamily char hw\+\_\+name\mbox{[}16\mbox{]}} - -Hardware name - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__req__t.tex b/docs/latex/structciot__sys__req__t.tex deleted file mode 100644 index 80ad0f1..0000000 --- a/docs/latex/structciot__sys__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__sys__req__t}{}\label{structciot__sys__req__t}\index{ciot\_sys\_req\_t@{ciot\_sys\_req\_t}} - - -Structure for CIOT system request. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7}{ciot\+\_\+sys\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__sys__req__t_a4341eac7e0a50f29b2101e5b7584db32}{type}} -\item -\mbox{\hyperlink{unionciot__sys__req__data__u}{ciot\+\_\+sys\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__sys__req__t_a3acb986a68044c354bb4e34cb18e4d3c}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT system request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__sys__req__t_a3acb986a68044c354bb4e34cb18e4d3c}\label{structciot__sys__req__t_a3acb986a68044c354bb4e34cb18e4d3c} -\index{ciot\_sys\_req\_t@{ciot\_sys\_req\_t}!data@{data}} -\index{data@{data}!ciot\_sys\_req\_t@{ciot\_sys\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__sys__req__data__u}{ciot\+\_\+sys\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__sys__req__t_a4341eac7e0a50f29b2101e5b7584db32}\label{structciot__sys__req__t_a4341eac7e0a50f29b2101e5b7584db32} -\index{ciot\_sys\_req\_t@{ciot\_sys\_req\_t}!type@{type}} -\index{type@{type}!ciot\_sys\_req\_t@{ciot\_sys\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a1ee0e84a0f7250d41f9c39d795d6e3a7}{ciot\+\_\+sys\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__status__msg__t.tex b/docs/latex/structciot__sys__status__msg__t.tex deleted file mode 100644 index bf24223..0000000 --- a/docs/latex/structciot__sys__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__sys__status__msg__t}{}\label{structciot__sys__status__msg__t}\index{ciot\_sys\_status\_msg\_t@{ciot\_sys\_status\_msg\_t}} - - -CIOT System status message structure. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__sys__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__sys__status__t}{ciot\+\_\+sys\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__sys__status__msg__t_ad3dbfc73fddab4d58bde12f27edab41b}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -CIOT System status message structure. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__sys__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__sys__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_sys\_status\_msg\_t@{ciot\_sys\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_sys\_status\_msg\_t@{ciot\_sys\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__sys__status__msg__t_ad3dbfc73fddab4d58bde12f27edab41b}\label{structciot__sys__status__msg__t_ad3dbfc73fddab4d58bde12f27edab41b} -\index{ciot\_sys\_status\_msg\_t@{ciot\_sys\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_sys\_status\_msg\_t@{ciot\_sys\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__status__t}{ciot\+\_\+sys\+\_\+status\+\_\+t}} status} - -System status - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__sys_8h}{ciot\+\_\+sys.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__status__t.tex b/docs/latex/structciot__sys__status__t.tex deleted file mode 100644 index 5cd13e5..0000000 --- a/docs/latex/structciot__sys__status__t.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__sys__status__t}{}\label{structciot__sys__status__t}\index{ciot\_sys\_status\_t@{ciot\_sys\_status\_t}} - - -Structure for CIOT system status. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__sys__status__t_aa4f71758f86d92d3ae60a541335f579d}{rst\+\_\+reason}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__sys__status__t_acc644e0c68521fc2c21bdf5acb5f5812}{rst\+\_\+count}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__sys__status__t_aa455685612d3d0967fd32c32256a8bd3}{free\+\_\+memory}} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__sys__status__t_a569e06e92ec3d06c5ebf7f40d7f9a84e}{lifetime}} -\item -\mbox{\hyperlink{structciot__sys__info__t}{ciot\+\_\+sys\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__sys__status__t_a29734819b12e849f2f27b8663d023d8f}{info}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT system status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__sys__status__t_aa455685612d3d0967fd32c32256a8bd3}\label{structciot__sys__status__t_aa455685612d3d0967fd32c32256a8bd3} -\index{ciot\_sys\_status\_t@{ciot\_sys\_status\_t}!free\_memory@{free\_memory}} -\index{free\_memory@{free\_memory}!ciot\_sys\_status\_t@{ciot\_sys\_status\_t}} -\doxysubsubsection{\texorpdfstring{free\_memory}{free\_memory}} -{\footnotesize\ttfamily uint32\+\_\+t free\+\_\+memory} - -Free memory \Hypertarget{structciot__sys__status__t_a29734819b12e849f2f27b8663d023d8f}\label{structciot__sys__status__t_a29734819b12e849f2f27b8663d023d8f} -\index{ciot\_sys\_status\_t@{ciot\_sys\_status\_t}!info@{info}} -\index{info@{info}!ciot\_sys\_status\_t@{ciot\_sys\_status\_t}} -\doxysubsubsection{\texorpdfstring{info}{info}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__info__t}{ciot\+\_\+sys\+\_\+info\+\_\+t}} info} - -System information \Hypertarget{structciot__sys__status__t_a569e06e92ec3d06c5ebf7f40d7f9a84e}\label{structciot__sys__status__t_a569e06e92ec3d06c5ebf7f40d7f9a84e} -\index{ciot\_sys\_status\_t@{ciot\_sys\_status\_t}!lifetime@{lifetime}} -\index{lifetime@{lifetime}!ciot\_sys\_status\_t@{ciot\_sys\_status\_t}} -\doxysubsubsection{\texorpdfstring{lifetime}{lifetime}} -{\footnotesize\ttfamily uint32\+\_\+t lifetime} - -System lifetime \Hypertarget{structciot__sys__status__t_acc644e0c68521fc2c21bdf5acb5f5812}\label{structciot__sys__status__t_acc644e0c68521fc2c21bdf5acb5f5812} -\index{ciot\_sys\_status\_t@{ciot\_sys\_status\_t}!rst\_count@{rst\_count}} -\index{rst\_count@{rst\_count}!ciot\_sys\_status\_t@{ciot\_sys\_status\_t}} -\doxysubsubsection{\texorpdfstring{rst\_count}{rst\_count}} -{\footnotesize\ttfamily uint8\+\_\+t rst\+\_\+count} - -Restart count \Hypertarget{structciot__sys__status__t_aa4f71758f86d92d3ae60a541335f579d}\label{structciot__sys__status__t_aa4f71758f86d92d3ae60a541335f579d} -\index{ciot\_sys\_status\_t@{ciot\_sys\_status\_t}!rst\_reason@{rst\_reason}} -\index{rst\_reason@{rst\_reason}!ciot\_sys\_status\_t@{ciot\_sys\_status\_t}} -\doxysubsubsection{\texorpdfstring{rst\_reason}{rst\_reason}} -{\footnotesize\ttfamily uint8\+\_\+t rst\+\_\+reason} - -Restart reason - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__sys__sw__features__t.tex b/docs/latex/structciot__sys__sw__features__t.tex deleted file mode 100644 index e1bb7cb..0000000 --- a/docs/latex/structciot__sys__sw__features__t.tex +++ /dev/null @@ -1,97 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+sw\+\_\+features\+\_\+t Struct Reference} -\hypertarget{structciot__sys__sw__features__t}{}\label{structciot__sys__sw__features__t}\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} - - -Structure for CIOT system software features. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_a34018b7bbca3d89088500ca3a47a66fd}{ntp}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_aa20473f3745555bec85f491e13188f4e}{ota}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_a6adae5024e1ef3cf7e6209bf7f0c58a0}{dfu}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_ae536bd73f6eaace274e55d4779276e5e}{http\+\_\+client}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_a8081e8e6e70c0ae11cc3996fe07f6dde}{http\+\_\+server}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_a1f1d5466bff3ee92c8a67e4b067159a2}{mqtt\+\_\+client}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_aea00c2c1dec6e8f58532f25c65210d9e}{timer}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_a720e2a2aba3a8aa7ec09162d3a522d60}{serializer}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__sys__sw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3}{reserved}}\+: 8 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT system software features. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__sys__sw__features__t_a6adae5024e1ef3cf7e6209bf7f0c58a0}\label{structciot__sys__sw__features__t_a6adae5024e1ef3cf7e6209bf7f0c58a0} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!dfu@{dfu}} -\index{dfu@{dfu}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{dfu}{dfu}} -{\footnotesize\ttfamily uint16\+\_\+t dfu} - -DFU (Device Firmware Update) feature \Hypertarget{structciot__sys__sw__features__t_ae536bd73f6eaace274e55d4779276e5e}\label{structciot__sys__sw__features__t_ae536bd73f6eaace274e55d4779276e5e} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!http\_client@{http\_client}} -\index{http\_client@{http\_client}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{http\_client}{http\_client}} -{\footnotesize\ttfamily uint16\+\_\+t http\+\_\+client} - -HTTP client feature \Hypertarget{structciot__sys__sw__features__t_a8081e8e6e70c0ae11cc3996fe07f6dde}\label{structciot__sys__sw__features__t_a8081e8e6e70c0ae11cc3996fe07f6dde} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!http\_server@{http\_server}} -\index{http\_server@{http\_server}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{http\_server}{http\_server}} -{\footnotesize\ttfamily uint16\+\_\+t http\+\_\+server} - -HTTP server feature \Hypertarget{structciot__sys__sw__features__t_a1f1d5466bff3ee92c8a67e4b067159a2}\label{structciot__sys__sw__features__t_a1f1d5466bff3ee92c8a67e4b067159a2} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!mqtt\_client@{mqtt\_client}} -\index{mqtt\_client@{mqtt\_client}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{mqtt\_client}{mqtt\_client}} -{\footnotesize\ttfamily uint16\+\_\+t mqtt\+\_\+client} - -MQTT client feature \Hypertarget{structciot__sys__sw__features__t_a34018b7bbca3d89088500ca3a47a66fd}\label{structciot__sys__sw__features__t_a34018b7bbca3d89088500ca3a47a66fd} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!ntp@{ntp}} -\index{ntp@{ntp}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{ntp}{ntp}} -{\footnotesize\ttfamily uint16\+\_\+t ntp} - -NTP (Network Time Protocol) feature \Hypertarget{structciot__sys__sw__features__t_aa20473f3745555bec85f491e13188f4e}\label{structciot__sys__sw__features__t_aa20473f3745555bec85f491e13188f4e} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!ota@{ota}} -\index{ota@{ota}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{ota}{ota}} -{\footnotesize\ttfamily uint16\+\_\+t ota} - -OTA (Over-\/\+The-\/\+Air) update feature \Hypertarget{structciot__sys__sw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3}\label{structciot__sys__sw__features__t_a5a6ed8c04a3db86066924b1a1bf4dad3} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!reserved@{reserved}} -\index{reserved@{reserved}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{reserved}{reserved}} -{\footnotesize\ttfamily uint16\+\_\+t reserved} - -Reserved bits \Hypertarget{structciot__sys__sw__features__t_a720e2a2aba3a8aa7ec09162d3a522d60}\label{structciot__sys__sw__features__t_a720e2a2aba3a8aa7ec09162d3a522d60} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!serializer@{serializer}} -\index{serializer@{serializer}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{serializer}{serializer}} -{\footnotesize\ttfamily uint16\+\_\+t serializer} - -Serializer feature \Hypertarget{structciot__sys__sw__features__t_aea00c2c1dec6e8f58532f25c65210d9e}\label{structciot__sys__sw__features__t_aea00c2c1dec6e8f58532f25c65210d9e} -\index{ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}!timer@{timer}} -\index{timer@{timer}!ciot\_sys\_sw\_features\_t@{ciot\_sys\_sw\_features\_t}} -\doxysubsubsection{\texorpdfstring{timer}{timer}} -{\footnotesize\ttfamily uint16\+\_\+t timer} - -Timer feature - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__tcp__cfg__t.tex b/docs/latex/structciot__tcp__cfg__t.tex deleted file mode 100644 index 63bde76..0000000 --- a/docs/latex/structciot__tcp__cfg__t.tex +++ /dev/null @@ -1,65 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__tcp__cfg__t}{}\label{structciot__tcp__cfg__t}\index{ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}} - - -Structure for CIOT TCP configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structciot__tcp__cfg__t_a689764758640d8f794e755c07c602667}{dhcp}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__tcp__cfg__t_ae81515e082f9bc33e8968181945586da}{ip}} \mbox{[}4\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__tcp__cfg__t_a0beca1eecd2529c061a6dc4cb8a412fd}{gateway}} \mbox{[}4\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__tcp__cfg__t_ada50f0e7b89816d02459e3e520b018bf}{mask}} \mbox{[}4\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__tcp__cfg__t_a9bf249fa42db4caf84d05f92ed1f9718}{dns}} \mbox{[}4\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT TCP configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__tcp__cfg__t_a689764758640d8f794e755c07c602667}\label{structciot__tcp__cfg__t_a689764758640d8f794e755c07c602667} -\index{ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}!dhcp@{dhcp}} -\index{dhcp@{dhcp}!ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{dhcp}{dhcp}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a6b9f05d16358111acd3b846a7086f32d}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+cfg\+\_\+t}} dhcp} - -DHCP configuration \Hypertarget{structciot__tcp__cfg__t_a9bf249fa42db4caf84d05f92ed1f9718}\label{structciot__tcp__cfg__t_a9bf249fa42db4caf84d05f92ed1f9718} -\index{ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}!dns@{dns}} -\index{dns@{dns}!ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{dns}{dns}} -{\footnotesize\ttfamily uint8\+\_\+t dns\mbox{[}4\mbox{]}} - -DNS address \Hypertarget{structciot__tcp__cfg__t_a0beca1eecd2529c061a6dc4cb8a412fd}\label{structciot__tcp__cfg__t_a0beca1eecd2529c061a6dc4cb8a412fd} -\index{ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}!gateway@{gateway}} -\index{gateway@{gateway}!ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{gateway}{gateway}} -{\footnotesize\ttfamily uint8\+\_\+t gateway\mbox{[}4\mbox{]}} - -Gateway address \Hypertarget{structciot__tcp__cfg__t_ae81515e082f9bc33e8968181945586da}\label{structciot__tcp__cfg__t_ae81515e082f9bc33e8968181945586da} -\index{ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}!ip@{ip}} -\index{ip@{ip}!ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{ip}{ip}} -{\footnotesize\ttfamily uint8\+\_\+t ip\mbox{[}4\mbox{]}} - -IP address \Hypertarget{structciot__tcp__cfg__t_ada50f0e7b89816d02459e3e520b018bf}\label{structciot__tcp__cfg__t_ada50f0e7b89816d02459e3e520b018bf} -\index{ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}!mask@{mask}} -\index{mask@{mask}!ciot\_tcp\_cfg\_t@{ciot\_tcp\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{mask}{mask}} -{\footnotesize\ttfamily uint8\+\_\+t mask\mbox{[}4\mbox{]}} - -Subnet mask - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__tcp__dhcp__status__t.tex b/docs/latex/structciot__tcp__dhcp__status__t.tex deleted file mode 100644 index eaf823d..0000000 --- a/docs/latex/structciot__tcp__dhcp__status__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+dhcp\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__tcp__dhcp__status__t}{}\label{structciot__tcp__dhcp__status__t}\index{ciot\_tcp\_dhcp\_status\_t@{ciot\_tcp\_dhcp\_status\_t}} - - -Structure for CIOT TCP DHCP status. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__tcp__dhcp__status__t_acb22641cf860e836e7394d14b9adae4b}{client}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__tcp__dhcp__status__t_afdb30da7a1b29e70c8b5051adcaf649b}{server}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT TCP DHCP status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__tcp__dhcp__status__t_acb22641cf860e836e7394d14b9adae4b}\label{structciot__tcp__dhcp__status__t_acb22641cf860e836e7394d14b9adae4b} -\index{ciot\_tcp\_dhcp\_status\_t@{ciot\_tcp\_dhcp\_status\_t}!client@{client}} -\index{client@{client}!ciot\_tcp\_dhcp\_status\_t@{ciot\_tcp\_dhcp\_status\_t}} -\doxysubsubsection{\texorpdfstring{client}{client}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} client} - -DHCP client state \Hypertarget{structciot__tcp__dhcp__status__t_afdb30da7a1b29e70c8b5051adcaf649b}\label{structciot__tcp__dhcp__status__t_afdb30da7a1b29e70c8b5051adcaf649b} -\index{ciot\_tcp\_dhcp\_status\_t@{ciot\_tcp\_dhcp\_status\_t}!server@{server}} -\index{server@{server}!ciot\_tcp\_dhcp\_status\_t@{ciot\_tcp\_dhcp\_status\_t}} -\doxysubsubsection{\texorpdfstring{server}{server}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a5352e5a5aa4b1ddf306f31d22ceb5823}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} server} - -DHCP server state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__tcp__handle.tex b/docs/latex/structciot__tcp__handle.tex deleted file mode 100644 index bbeb9f2..0000000 --- a/docs/latex/structciot__tcp__handle.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+handle Struct Reference} -\hypertarget{structciot__tcp__handle}{}\label{structciot__tcp__handle}\index{ciot\_tcp\_handle@{ciot\_tcp\_handle}} - - -Handle structure for CIOT TCP. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__tcp__handle_af47c5ec8385375f1765e2728e856714a}{netif}} -\item -\mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__tcp__handle_a34be4afa8e4bf3487bbf19439633a0f8}{cfg}} -\item -\mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__tcp__handle_a1f53b649c735819db1618409eec01b05}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Handle structure for CIOT TCP. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__tcp__handle_a34be4afa8e4bf3487bbf19439633a0f8}\label{structciot__tcp__handle_a34be4afa8e4bf3487bbf19439633a0f8} -\index{ciot\_tcp\_handle@{ciot\_tcp\_handle}!cfg@{cfg}} -\index{cfg@{cfg}!ciot\_tcp\_handle@{ciot\_tcp\_handle}} -\doxysubsubsection{\texorpdfstring{cfg}{cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}}\texorpdfstring{$\ast$}{*} cfg} - -TCP configuration pointer \Hypertarget{structciot__tcp__handle_af47c5ec8385375f1765e2728e856714a}\label{structciot__tcp__handle_af47c5ec8385375f1765e2728e856714a} -\index{ciot\_tcp\_handle@{ciot\_tcp\_handle}!netif@{netif}} -\index{netif@{netif}!ciot\_tcp\_handle@{ciot\_tcp\_handle}} -\doxysubsubsection{\texorpdfstring{netif}{netif}} -{\footnotesize\ttfamily void\texorpdfstring{$\ast$}{*} netif} - -Network interface pointer \Hypertarget{structciot__tcp__handle_a1f53b649c735819db1618409eec01b05}\label{structciot__tcp__handle_a1f53b649c735819db1618409eec01b05} -\index{ciot\_tcp\_handle@{ciot\_tcp\_handle}!status@{status}} -\index{status@{status}!ciot\_tcp\_handle@{ciot\_tcp\_handle}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}}\texorpdfstring{$\ast$}{*} status} - -TCP status pointer - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__tcp_8h}{ciot\+\_\+tcp.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__tcp__info__t.tex b/docs/latex/structciot__tcp__info__t.tex deleted file mode 100644 index bc70329..0000000 --- a/docs/latex/structciot__tcp__info__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__tcp__info__t}{}\label{structciot__tcp__info__t}\index{ciot\_tcp\_info\_t@{ciot\_tcp\_info\_t}} - - -Structure for CIOT TCP information. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__tcp__info__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1}{mac}} \mbox{[}6\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__tcp__info__t_ae81515e082f9bc33e8968181945586da}{ip}} \mbox{[}4\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT TCP information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__tcp__info__t_ae81515e082f9bc33e8968181945586da}\label{structciot__tcp__info__t_ae81515e082f9bc33e8968181945586da} -\index{ciot\_tcp\_info\_t@{ciot\_tcp\_info\_t}!ip@{ip}} -\index{ip@{ip}!ciot\_tcp\_info\_t@{ciot\_tcp\_info\_t}} -\doxysubsubsection{\texorpdfstring{ip}{ip}} -{\footnotesize\ttfamily uint8\+\_\+t ip\mbox{[}4\mbox{]}} - -IP address \Hypertarget{structciot__tcp__info__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1}\label{structciot__tcp__info__t_a2f32c75fb4bc7ba39243ef4a9f8eacc1} -\index{ciot\_tcp\_info\_t@{ciot\_tcp\_info\_t}!mac@{mac}} -\index{mac@{mac}!ciot\_tcp\_info\_t@{ciot\_tcp\_info\_t}} -\doxysubsubsection{\texorpdfstring{mac}{mac}} -{\footnotesize\ttfamily uint8\+\_\+t mac\mbox{[}6\mbox{]}} - -MAC address - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__tcp__req__t.tex b/docs/latex/structciot__tcp__req__t.tex deleted file mode 100644 index 467c19c..0000000 --- a/docs/latex/structciot__tcp__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__tcp__req__t}{}\label{structciot__tcp__req__t}\index{ciot\_tcp\_req\_t@{ciot\_tcp\_req\_t}} - - -Structure for CIOT TCP request. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210}{ciot\+\_\+tcp\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__tcp__req__t_acd8fb37e86ba410b191b31dc8cf154c3}{type}} -\item -\mbox{\hyperlink{unionciot__tcp__req__data__u}{ciot\+\_\+tcp\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__tcp__req__t_ab9836dbdec18617a3ddefdeb64d68c5f}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT TCP request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__tcp__req__t_ab9836dbdec18617a3ddefdeb64d68c5f}\label{structciot__tcp__req__t_ab9836dbdec18617a3ddefdeb64d68c5f} -\index{ciot\_tcp\_req\_t@{ciot\_tcp\_req\_t}!data@{data}} -\index{data@{data}!ciot\_tcp\_req\_t@{ciot\_tcp\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__tcp__req__data__u}{ciot\+\_\+tcp\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__tcp__req__t_acd8fb37e86ba410b191b31dc8cf154c3}\label{structciot__tcp__req__t_acd8fb37e86ba410b191b31dc8cf154c3} -\index{ciot\_tcp\_req\_t@{ciot\_tcp\_req\_t}!type@{type}} -\index{type@{type}!ciot\_tcp\_req\_t@{ciot\_tcp\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a7bba37dedd9e8a5d5374ffa220088210}{ciot\+\_\+tcp\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__tcp__status__msg__t.tex b/docs/latex/structciot__tcp__status__msg__t.tex deleted file mode 100644 index d662980..0000000 --- a/docs/latex/structciot__tcp__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__tcp__status__msg__t}{}\label{structciot__tcp__status__msg__t}\index{ciot\_tcp\_status\_msg\_t@{ciot\_tcp\_status\_msg\_t}} - - -CIOT TCP status message structure. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__tcp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__tcp__status__msg__t_a290455b77155aab0d086fb8c69f76364}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -CIOT TCP status message structure. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__tcp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__tcp__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_tcp\_status\_msg\_t@{ciot\_tcp\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_tcp\_status\_msg\_t@{ciot\_tcp\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__tcp__status__msg__t_a290455b77155aab0d086fb8c69f76364}\label{structciot__tcp__status__msg__t_a290455b77155aab0d086fb8c69f76364} -\index{ciot\_tcp\_status\_msg\_t@{ciot\_tcp\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_tcp\_status\_msg\_t@{ciot\_tcp\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} status} - -TCP status - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__tcp_8h}{ciot\+\_\+tcp.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__tcp__status__t.tex b/docs/latex/structciot__tcp__status__t.tex deleted file mode 100644 index 81cefa7..0000000 --- a/docs/latex/structciot__tcp__status__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__tcp__status__t}{}\label{structciot__tcp__status__t}\index{ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}} - - -Structure for CIOT TCP status. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4}{ciot\+\_\+tcp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__tcp__status__t_a771cb8893000d5d94fc8bc2d21347412}{state}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__tcp__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4}{conn\+\_\+count}} -\item -\mbox{\hyperlink{structciot__tcp__dhcp__status__t}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__tcp__status__t_acf265b9f6bf6e80f8d16a9aaade7e8cd}{dhcp}} -\item -\mbox{\hyperlink{structciot__tcp__info__t}{ciot\+\_\+tcp\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__tcp__status__t_a086ac86c52dfa147af9f5afed658c7cb}{info}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT TCP status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__tcp__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4}\label{structciot__tcp__status__t_acaf4be12cb0cee4fbea5e8e121f6d2e4} -\index{ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}!conn\_count@{conn\_count}} -\index{conn\_count@{conn\_count}!ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}} -\doxysubsubsection{\texorpdfstring{conn\_count}{conn\_count}} -{\footnotesize\ttfamily uint8\+\_\+t conn\+\_\+count} - -Connection count \Hypertarget{structciot__tcp__status__t_acf265b9f6bf6e80f8d16a9aaade7e8cd}\label{structciot__tcp__status__t_acf265b9f6bf6e80f8d16a9aaade7e8cd} -\index{ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}!dhcp@{dhcp}} -\index{dhcp@{dhcp}!ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}} -\doxysubsubsection{\texorpdfstring{dhcp}{dhcp}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__dhcp__status__t}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+status\+\_\+t}} dhcp} - -DHCP status \Hypertarget{structciot__tcp__status__t_a086ac86c52dfa147af9f5afed658c7cb}\label{structciot__tcp__status__t_a086ac86c52dfa147af9f5afed658c7cb} -\index{ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}!info@{info}} -\index{info@{info}!ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}} -\doxysubsubsection{\texorpdfstring{info}{info}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__info__t}{ciot\+\_\+tcp\+\_\+info\+\_\+t}} info} - -TCP information \Hypertarget{structciot__tcp__status__t_a771cb8893000d5d94fc8bc2d21347412}\label{structciot__tcp__status__t_a771cb8893000d5d94fc8bc2d21347412} -\index{ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}!state@{state}} -\index{state@{state}!ciot\_tcp\_status\_t@{ciot\_tcp\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_aad64ae7daa8a2c6eefb794318c7c88c4}{ciot\+\_\+tcp\+\_\+state\+\_\+t}} state} - -TCP state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__timer__cfg.tex b/docs/latex/structciot__timer__cfg.tex deleted file mode 100644 index 2f40c1b..0000000 --- a/docs/latex/structciot__timer__cfg.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+timer\+\_\+cfg Struct Reference} -\hypertarget{structciot__timer__cfg}{}\label{structciot__timer__cfg}\index{ciot\_timer\_cfg@{ciot\_timer\_cfg}} - - -Configuration structure for CIOT timer. - - - - -{\ttfamily \#include $<$ciot\+\_\+timer.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__timer_8h_ae11839d456d62e3e384c7122812fcefc}{ciot\+\_\+timer\+\_\+event\+\_\+handler\+\_\+t}} \mbox{\hyperlink{structciot__timer__cfg_ac792c2b1c6a52954e47c8a9ed5ac8582}{event\+\_\+handler}} -\item -void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structciot__timer__cfg_a702f51681c5c1dd8d6ad5aaa41d80f29}{event\+\_\+args}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Configuration structure for CIOT timer. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__timer__cfg_a702f51681c5c1dd8d6ad5aaa41d80f29}\label{structciot__timer__cfg_a702f51681c5c1dd8d6ad5aaa41d80f29} -\index{ciot\_timer\_cfg@{ciot\_timer\_cfg}!event\_args@{event\_args}} -\index{event\_args@{event\_args}!ciot\_timer\_cfg@{ciot\_timer\_cfg}} -\doxysubsubsection{\texorpdfstring{event\_args}{event\_args}} -{\footnotesize\ttfamily void\texorpdfstring{$\ast$}{*} event\+\_\+args} - -Event handler arguments \Hypertarget{structciot__timer__cfg_ac792c2b1c6a52954e47c8a9ed5ac8582}\label{structciot__timer__cfg_ac792c2b1c6a52954e47c8a9ed5ac8582} -\index{ciot\_timer\_cfg@{ciot\_timer\_cfg}!event\_handler@{event\_handler}} -\index{event\_handler@{event\_handler}!ciot\_timer\_cfg@{ciot\_timer\_cfg}} -\doxysubsubsection{\texorpdfstring{event\_handler}{event\_handler}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__timer_8h_ae11839d456d62e3e384c7122812fcefc}{ciot\+\_\+timer\+\_\+event\+\_\+handler\+\_\+t}} event\+\_\+handler} - -Event handler function pointer - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__timer_8h}{ciot\+\_\+timer.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__uart__base.tex b/docs/latex/structciot__uart__base.tex deleted file mode 100644 index c3d7e8d..0000000 --- a/docs/latex/structciot__uart__base.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+base Struct Reference} -\hypertarget{structciot__uart__base}{}\label{structciot__uart__base}\index{ciot\_uart\_base@{ciot\_uart\_base}} - - -Base structure for CIOT UART module. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} \mbox{\hyperlink{structciot__uart__base_a05aee9079d36e8f1c1f55a4803c9048f}{iface}} -\item -\mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structciot__uart__base_a3f98eeddc8b251dcbfd39459c99f9c72}{cfg}} -\item -\mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__uart__base_aa311cb42bbd477c3bfd5371dd0b8bedd}{status}} -\item -\mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} \mbox{\hyperlink{structciot__uart__base_a233ade82acc15e44b91d5b225bb2ba98}{s}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Base structure for CIOT UART module. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__uart__base_a3f98eeddc8b251dcbfd39459c99f9c72}\label{structciot__uart__base_a3f98eeddc8b251dcbfd39459c99f9c72} -\index{ciot\_uart\_base@{ciot\_uart\_base}!cfg@{cfg}} -\index{cfg@{cfg}!ciot\_uart\_base@{ciot\_uart\_base}} -\doxysubsubsection{\texorpdfstring{cfg}{cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} cfg} - -Configuration for UART module \Hypertarget{structciot__uart__base_a05aee9079d36e8f1c1f55a4803c9048f}\label{structciot__uart__base_a05aee9079d36e8f1c1f55a4803c9048f} -\index{ciot\_uart\_base@{ciot\_uart\_base}!iface@{iface}} -\index{iface@{iface}!ciot\_uart\_base@{ciot\_uart\_base}} -\doxysubsubsection{\texorpdfstring{iface}{iface}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__iface_8h_ac87bf8f245c1f7cc82f57bc87de9ad71}{ciot\+\_\+iface\+\_\+t}} iface} - -CIOT interface instance \Hypertarget{structciot__uart__base_a233ade82acc15e44b91d5b225bb2ba98}\label{structciot__uart__base_a233ade82acc15e44b91d5b225bb2ba98} -\index{ciot\_uart\_base@{ciot\_uart\_base}!s@{s}} -\index{s@{s}!ciot\_uart\_base@{ciot\_uart\_base}} -\doxysubsubsection{\texorpdfstring{s}{s}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__s_8h_a4fb0c1250873e751db7adffc9620b776}{ciot\+\_\+s\+\_\+t}} s} - -CIOT S module instance \Hypertarget{structciot__uart__base_aa311cb42bbd477c3bfd5371dd0b8bedd}\label{structciot__uart__base_aa311cb42bbd477c3bfd5371dd0b8bedd} -\index{ciot\_uart\_base@{ciot\_uart\_base}!status@{status}} -\index{status@{status}!ciot\_uart\_base@{ciot\_uart\_base}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} status} - -Status information for UART module - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__uart_8h}{ciot\+\_\+uart.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__uart__cfg__t.tex b/docs/latex/structciot__uart__cfg__t.tex deleted file mode 100644 index 602e483..0000000 --- a/docs/latex/structciot__uart__cfg__t.tex +++ /dev/null @@ -1,113 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__uart__cfg__t}{}\label{structciot__uart__cfg__t}\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} - - -Structure for CIOT UART configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint32\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_a148f33bbcda8087a77d8ba30f7e3c502}{baud\+\_\+rate}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_abea371f9030e15a5d2a4c181576833d8}{num}} -\item -int8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_ab461fda70a78750930429bcc68db5a98}{rx\+\_\+pin}} -\item -int8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_abc8367b5354c54835c1d74192f355c1c}{tx\+\_\+pin}} -\item -int8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_a3c82534f71c473adbf7fa380db7badc2}{rts\+\_\+pin}} -\item -int8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_a73580a66f00a6a0ea4a56441d529797f}{cts\+\_\+pin}} -\item -uint16\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_ae5290e95682932917ab6a7fd7897abb4}{parity}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_a9498b6790752dd532f6465f3efb59cbf}{flow\+\_\+control}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_a5b495a42fbde79adb797b1e9f6a4e039}{dtr}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_a7550d74d56b36307b64a75f5d4eb8dad}{bridge\+\_\+mode}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__uart__cfg__t_acb7bc06bed6f6408d719334fc41698c7}{reserved}}\+: 5 -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT UART configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__uart__cfg__t_a148f33bbcda8087a77d8ba30f7e3c502}\label{structciot__uart__cfg__t_a148f33bbcda8087a77d8ba30f7e3c502} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!baud\_rate@{baud\_rate}} -\index{baud\_rate@{baud\_rate}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{baud\_rate}{baud\_rate}} -{\footnotesize\ttfamily uint32\+\_\+t baud\+\_\+rate} - -Baud rate \Hypertarget{structciot__uart__cfg__t_a7550d74d56b36307b64a75f5d4eb8dad}\label{structciot__uart__cfg__t_a7550d74d56b36307b64a75f5d4eb8dad} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!bridge\_mode@{bridge\_mode}} -\index{bridge\_mode@{bridge\_mode}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{bridge\_mode}{bridge\_mode}} -{\footnotesize\ttfamily uint8\+\_\+t bridge\+\_\+mode} - -Bridge mode flag \Hypertarget{structciot__uart__cfg__t_a73580a66f00a6a0ea4a56441d529797f}\label{structciot__uart__cfg__t_a73580a66f00a6a0ea4a56441d529797f} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!cts\_pin@{cts\_pin}} -\index{cts\_pin@{cts\_pin}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{cts\_pin}{cts\_pin}} -{\footnotesize\ttfamily int8\+\_\+t cts\+\_\+pin} - -CTS pin \Hypertarget{structciot__uart__cfg__t_a5b495a42fbde79adb797b1e9f6a4e039}\label{structciot__uart__cfg__t_a5b495a42fbde79adb797b1e9f6a4e039} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!dtr@{dtr}} -\index{dtr@{dtr}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{dtr}{dtr}} -{\footnotesize\ttfamily uint8\+\_\+t dtr} - -DTR flag \Hypertarget{structciot__uart__cfg__t_a9498b6790752dd532f6465f3efb59cbf}\label{structciot__uart__cfg__t_a9498b6790752dd532f6465f3efb59cbf} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!flow\_control@{flow\_control}} -\index{flow\_control@{flow\_control}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{flow\_control}{flow\_control}} -{\footnotesize\ttfamily uint8\+\_\+t flow\+\_\+control} - -Flow control flag \Hypertarget{structciot__uart__cfg__t_abea371f9030e15a5d2a4c181576833d8}\label{structciot__uart__cfg__t_abea371f9030e15a5d2a4c181576833d8} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!num@{num}} -\index{num@{num}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{num}{num}} -{\footnotesize\ttfamily uint8\+\_\+t num} - -UART number \Hypertarget{structciot__uart__cfg__t_ae5290e95682932917ab6a7fd7897abb4}\label{structciot__uart__cfg__t_ae5290e95682932917ab6a7fd7897abb4} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!parity@{parity}} -\index{parity@{parity}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{parity}{parity}} -{\footnotesize\ttfamily uint16\+\_\+t parity} - -Parity \Hypertarget{structciot__uart__cfg__t_acb7bc06bed6f6408d719334fc41698c7}\label{structciot__uart__cfg__t_acb7bc06bed6f6408d719334fc41698c7} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!reserved@{reserved}} -\index{reserved@{reserved}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{reserved}{reserved}} -{\footnotesize\ttfamily uint8\+\_\+t reserved} - -Reserved bits \Hypertarget{structciot__uart__cfg__t_a3c82534f71c473adbf7fa380db7badc2}\label{structciot__uart__cfg__t_a3c82534f71c473adbf7fa380db7badc2} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!rts\_pin@{rts\_pin}} -\index{rts\_pin@{rts\_pin}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{rts\_pin}{rts\_pin}} -{\footnotesize\ttfamily int8\+\_\+t rts\+\_\+pin} - -RTS pin \Hypertarget{structciot__uart__cfg__t_ab461fda70a78750930429bcc68db5a98}\label{structciot__uart__cfg__t_ab461fda70a78750930429bcc68db5a98} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!rx\_pin@{rx\_pin}} -\index{rx\_pin@{rx\_pin}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{rx\_pin}{rx\_pin}} -{\footnotesize\ttfamily int8\+\_\+t rx\+\_\+pin} - -RX pin \Hypertarget{structciot__uart__cfg__t_abc8367b5354c54835c1d74192f355c1c}\label{structciot__uart__cfg__t_abc8367b5354c54835c1d74192f355c1c} -\index{ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}!tx\_pin@{tx\_pin}} -\index{tx\_pin@{tx\_pin}!ciot\_uart\_cfg\_t@{ciot\_uart\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{tx\_pin}{tx\_pin}} -{\footnotesize\ttfamily int8\+\_\+t tx\+\_\+pin} - -TX pin - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__uart__req__send__data__t.tex b/docs/latex/structciot__uart__req__send__data__t.tex deleted file mode 100644 index 9226c07..0000000 --- a/docs/latex/structciot__uart__req__send__data__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+req\+\_\+send\+\_\+data\+\_\+t Struct Reference} -\hypertarget{structciot__uart__req__send__data__t}{}\label{structciot__uart__req__send__data__t}\index{ciot\_uart\_req\_send\_data\_t@{ciot\_uart\_req\_send\_data\_t}} - - -Structure for CIOT UART send data request. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__uart__req__send__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0}{size}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__uart__req__send__data__t_afe23ad4b14c014e0c70c96d93e44005c}{data}} \mbox{[}255\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT UART send data request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__uart__req__send__data__t_afe23ad4b14c014e0c70c96d93e44005c}\label{structciot__uart__req__send__data__t_afe23ad4b14c014e0c70c96d93e44005c} -\index{ciot\_uart\_req\_send\_data\_t@{ciot\_uart\_req\_send\_data\_t}!data@{data}} -\index{data@{data}!ciot\_uart\_req\_send\_data\_t@{ciot\_uart\_req\_send\_data\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily uint8\+\_\+t data\mbox{[}255\mbox{]}} - -Data buffer \Hypertarget{structciot__uart__req__send__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0}\label{structciot__uart__req__send__data__t_ae5dc6ffcd9b7605c7787791e40cc6bb0} -\index{ciot\_uart\_req\_send\_data\_t@{ciot\_uart\_req\_send\_data\_t}!size@{size}} -\index{size@{size}!ciot\_uart\_req\_send\_data\_t@{ciot\_uart\_req\_send\_data\_t}} -\doxysubsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily uint8\+\_\+t size} - -Data size - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__uart__req__t.tex b/docs/latex/structciot__uart__req__t.tex deleted file mode 100644 index ddc1ebf..0000000 --- a/docs/latex/structciot__uart__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__uart__req__t}{}\label{structciot__uart__req__t}\index{ciot\_uart\_req\_t@{ciot\_uart\_req\_t}} - - -Structure for CIOT UART request. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c}{ciot\+\_\+uart\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__uart__req__t_a21d88bf4d17b9837d25893a4000044db}{type}} -\item -\mbox{\hyperlink{unionciot__uart__req__data__u}{ciot\+\_\+uart\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__uart__req__t_a8abbd25f85c295a54f54d2815908d273}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT UART request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__uart__req__t_a8abbd25f85c295a54f54d2815908d273}\label{structciot__uart__req__t_a8abbd25f85c295a54f54d2815908d273} -\index{ciot\_uart\_req\_t@{ciot\_uart\_req\_t}!data@{data}} -\index{data@{data}!ciot\_uart\_req\_t@{ciot\_uart\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__uart__req__data__u}{ciot\+\_\+uart\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__uart__req__t_a21d88bf4d17b9837d25893a4000044db}\label{structciot__uart__req__t_a21d88bf4d17b9837d25893a4000044db} -\index{ciot\_uart\_req\_t@{ciot\_uart\_req\_t}!type@{type}} -\index{type@{type}!ciot\_uart\_req\_t@{ciot\_uart\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a9b29402e0c8e8eaed7be0fa4ca22751c}{ciot\+\_\+uart\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__uart__status__msg__t.tex b/docs/latex/structciot__uart__status__msg__t.tex deleted file mode 100644 index 6baf1fa..0000000 --- a/docs/latex/structciot__uart__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__uart__status__msg__t}{}\label{structciot__uart__status__msg__t}\index{ciot\_uart\_status\_msg\_t@{ciot\_uart\_status\_msg\_t}} - - -Status message structure for CIOT UART module. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__uart__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__uart__status__msg__t_aa311cb42bbd477c3bfd5371dd0b8bedd}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Status message structure for CIOT UART module. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__uart__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__uart__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_uart\_status\_msg\_t@{ciot\_uart\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_uart\_status\_msg\_t@{ciot\_uart\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__uart__status__msg__t_aa311cb42bbd477c3bfd5371dd0b8bedd}\label{structciot__uart__status__msg__t_aa311cb42bbd477c3bfd5371dd0b8bedd} -\index{ciot\_uart\_status\_msg\_t@{ciot\_uart\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_uart\_status\_msg\_t@{ciot\_uart\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} status} - -Status information - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__uart_8h}{ciot\+\_\+uart.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__uart__status__t.tex b/docs/latex/structciot__uart__status__t.tex deleted file mode 100644 index b77d60b..0000000 --- a/docs/latex/structciot__uart__status__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__uart__status__t}{}\label{structciot__uart__status__t}\index{ciot\_uart\_status\_t@{ciot\_uart\_status\_t}} - - -Structure for CIOT UART status. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec}{ciot\+\_\+uart\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__uart__status__t_a00c2e8ab24db2cabd968dcd6aa86a7c3}{state}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a}{ciot\+\_\+uart\+\_\+error\+\_\+t}} \mbox{\hyperlink{structciot__uart__status__t_ad02fff01b7a3add4e201ad4fd60bb06d}{error}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT UART status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__uart__status__t_ad02fff01b7a3add4e201ad4fd60bb06d}\label{structciot__uart__status__t_ad02fff01b7a3add4e201ad4fd60bb06d} -\index{ciot\_uart\_status\_t@{ciot\_uart\_status\_t}!error@{error}} -\index{error@{error}!ciot\_uart\_status\_t@{ciot\_uart\_status\_t}} -\doxysubsubsection{\texorpdfstring{error}{error}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_aef6ecadc19ff8f271719099d4858494a}{ciot\+\_\+uart\+\_\+error\+\_\+t}} error} - -UART error \Hypertarget{structciot__uart__status__t_a00c2e8ab24db2cabd968dcd6aa86a7c3}\label{structciot__uart__status__t_a00c2e8ab24db2cabd968dcd6aa86a7c3} -\index{ciot\_uart\_status\_t@{ciot\_uart\_status\_t}!state@{state}} -\index{state@{state}!ciot\_uart\_status\_t@{ciot\_uart\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a00c2af7c6795f37afe35ce3882ab48ec}{ciot\+\_\+uart\+\_\+state\+\_\+t}} state} - -UART state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__usb__cfg__t.tex b/docs/latex/structciot__usb__cfg__t.tex deleted file mode 100644 index 6938d40..0000000 --- a/docs/latex/structciot__usb__cfg__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__usb__cfg__t}{}\label{structciot__usb__cfg__t}\index{ciot\_usb\_cfg\_t@{ciot\_usb\_cfg\_t}} - - -Structure for CIOT USB configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+usb\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -bool \mbox{\hyperlink{structciot__usb__cfg__t_a4e8946f8a10777bc88814da1c657815c}{bridge\+\_\+mode}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT USB configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__usb__cfg__t_a4e8946f8a10777bc88814da1c657815c}\label{structciot__usb__cfg__t_a4e8946f8a10777bc88814da1c657815c} -\index{ciot\_usb\_cfg\_t@{ciot\_usb\_cfg\_t}!bridge\_mode@{bridge\_mode}} -\index{bridge\_mode@{bridge\_mode}!ciot\_usb\_cfg\_t@{ciot\_usb\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{bridge\_mode}{bridge\_mode}} -{\footnotesize\ttfamily bool bridge\+\_\+mode} - -Bridge mode flag - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__usb__req__t.tex b/docs/latex/structciot__usb__req__t.tex deleted file mode 100644 index c73444c..0000000 --- a/docs/latex/structciot__usb__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__usb__req__t}{}\label{structciot__usb__req__t}\index{ciot\_usb\_req\_t@{ciot\_usb\_req\_t}} - - -Structure for CIOT USB request. - - - - -{\ttfamily \#include $<$ciot\+\_\+usb\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef}{ciot\+\_\+usb\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__usb__req__t_aa027ba4e6f58da1f5204e16dd15d5136}{type}} -\item -\mbox{\hyperlink{unionciot__usb__req__data__u}{ciot\+\_\+usb\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__usb__req__t_a91cc22753d20b8e288bae1944e5c5fce}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT USB request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__usb__req__t_a91cc22753d20b8e288bae1944e5c5fce}\label{structciot__usb__req__t_a91cc22753d20b8e288bae1944e5c5fce} -\index{ciot\_usb\_req\_t@{ciot\_usb\_req\_t}!data@{data}} -\index{data@{data}!ciot\_usb\_req\_t@{ciot\_usb\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__usb__req__data__u}{ciot\+\_\+usb\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__usb__req__t_aa027ba4e6f58da1f5204e16dd15d5136}\label{structciot__usb__req__t_aa027ba4e6f58da1f5204e16dd15d5136} -\index{ciot\_usb\_req\_t@{ciot\_usb\_req\_t}!type@{type}} -\index{type@{type}!ciot\_usb\_req\_t@{ciot\_usb\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_a71fe5023c4df31cb959b5b9b8aae41ef}{ciot\+\_\+usb\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__usb__status__msg__t.tex b/docs/latex/structciot__usb__status__msg__t.tex deleted file mode 100644 index b8df925..0000000 --- a/docs/latex/structciot__usb__status__msg__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__usb__status__msg__t}{}\label{structciot__usb__status__msg__t}\index{ciot\_usb\_status\_msg\_t@{ciot\_usb\_status\_msg\_t}} - - -Status message structure for CIOT USB module. - - - - -{\ttfamily \#include $<$ciot\+\_\+usb.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__usb__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\item -\mbox{\hyperlink{structciot__usb__status__t}{ciot\+\_\+usb\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__usb__status__msg__t_ab26791741e383cec2107fa1540a14342}{status}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Status message structure for CIOT USB module. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__usb__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__usb__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_usb\_status\_msg\_t@{ciot\_usb\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_usb\_status\_msg\_t@{ciot\_usb\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - -Message header \Hypertarget{structciot__usb__status__msg__t_ab26791741e383cec2107fa1540a14342}\label{structciot__usb__status__msg__t_ab26791741e383cec2107fa1540a14342} -\index{ciot\_usb\_status\_msg\_t@{ciot\_usb\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_usb\_status\_msg\_t@{ciot\_usb\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__usb__status__t}{ciot\+\_\+usb\+\_\+status\+\_\+t}} status} - -Status information - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__usb_8h}{ciot\+\_\+usb.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__usb__status__t.tex b/docs/latex/structciot__usb__status__t.tex deleted file mode 100644 index 27536c6..0000000 --- a/docs/latex/structciot__usb__status__t.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__usb__status__t}{}\label{structciot__usb__status__t}\index{ciot\_usb\_status\_t@{ciot\_usb\_status\_t}} - - -Structure for CIOT USB status. - - - - -{\ttfamily \#include $<$ciot\+\_\+usb\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4}{ciot\+\_\+usb\+\_\+state\+\_\+t}} \mbox{\hyperlink{structciot__usb__status__t_a3442f594ec1fc76781d93b1a28b55cba}{state}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT USB status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__usb__status__t_a3442f594ec1fc76781d93b1a28b55cba}\label{structciot__usb__status__t_a3442f594ec1fc76781d93b1a28b55cba} -\index{ciot\_usb\_status\_t@{ciot\_usb\_status\_t}!state@{state}} -\index{state@{state}!ciot\_usb\_status\_t@{ciot\_usb\_status\_t}} -\doxysubsubsection{\texorpdfstring{state}{state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_a3dc18e37f557a829c8d80f95824d61d4}{ciot\+\_\+usb\+\_\+state\+\_\+t}} state} - -USB state - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__wifi__ap__info__t.tex b/docs/latex/structciot__wifi__ap__info__t.tex deleted file mode 100644 index fb51912..0000000 --- a/docs/latex/structciot__wifi__ap__info__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t Struct Reference} -\hypertarget{structciot__wifi__ap__info__t}{}\label{structciot__wifi__ap__info__t}\index{ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}} - - -Structure for CIOT Wi\+Fi access point information. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__wifi__ap__info__t_a19c52baafe5797c359c5e0f5776499d7}{bssid}} \mbox{[}6\mbox{]} -\item -char \mbox{\hyperlink{structciot__wifi__ap__info__t_aa59121500c79646486524afe23a3593e}{ssid}} \mbox{[}33\mbox{]} -\item -int8\+\_\+t \mbox{\hyperlink{structciot__wifi__ap__info__t_a3b962e67ba74725bd60ca3c29f785abe}{rssi}} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__wifi__ap__info__t_a62cb83d5528e0d152b4e179fea395cab}{authmode}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Wi\+Fi access point information. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__wifi__ap__info__t_a62cb83d5528e0d152b4e179fea395cab}\label{structciot__wifi__ap__info__t_a62cb83d5528e0d152b4e179fea395cab} -\index{ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}!authmode@{authmode}} -\index{authmode@{authmode}!ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}} -\doxysubsubsection{\texorpdfstring{authmode}{authmode}} -{\footnotesize\ttfamily uint8\+\_\+t authmode} - -Authentication mode \Hypertarget{structciot__wifi__ap__info__t_a19c52baafe5797c359c5e0f5776499d7}\label{structciot__wifi__ap__info__t_a19c52baafe5797c359c5e0f5776499d7} -\index{ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}!bssid@{bssid}} -\index{bssid@{bssid}!ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}} -\doxysubsubsection{\texorpdfstring{bssid}{bssid}} -{\footnotesize\ttfamily uint8\+\_\+t bssid\mbox{[}6\mbox{]}} - -BSSID \Hypertarget{structciot__wifi__ap__info__t_a3b962e67ba74725bd60ca3c29f785abe}\label{structciot__wifi__ap__info__t_a3b962e67ba74725bd60ca3c29f785abe} -\index{ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}!rssi@{rssi}} -\index{rssi@{rssi}!ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}} -\doxysubsubsection{\texorpdfstring{rssi}{rssi}} -{\footnotesize\ttfamily int8\+\_\+t rssi} - -RSSI \Hypertarget{structciot__wifi__ap__info__t_aa59121500c79646486524afe23a3593e}\label{structciot__wifi__ap__info__t_aa59121500c79646486524afe23a3593e} -\index{ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}!ssid@{ssid}} -\index{ssid@{ssid}!ciot\_wifi\_ap\_info\_t@{ciot\_wifi\_ap\_info\_t}} -\doxysubsubsection{\texorpdfstring{ssid}{ssid}} -{\footnotesize\ttfamily char ssid\mbox{[}33\mbox{]}} - -SSID - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__wifi__cfg__t.tex b/docs/latex/structciot__wifi__cfg__t.tex deleted file mode 100644 index bf0157c..0000000 --- a/docs/latex/structciot__wifi__cfg__t.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+cfg\+\_\+t Struct Reference} -\hypertarget{structciot__wifi__cfg__t}{}\label{structciot__wifi__cfg__t}\index{ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}} - - -Structure for CIOT Wi\+Fi configuration. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -char \mbox{\hyperlink{structciot__wifi__cfg__t_ad254d41fb741fd973215d202786b5737}{ssid}} \mbox{[}32\mbox{]} -\item -char \mbox{\hyperlink{structciot__wifi__cfg__t_ae3a23efe266762659e03567d6afc26dd}{password}} \mbox{[}64\mbox{]} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\+\_\+wifi\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__wifi__cfg__t_a35cbcdf247b4952f8c35e071bed5a1d8}{type}} -\item -\mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structciot__wifi__cfg__t_afa68a8b5194df4f630408f99085e4ab8}{tcp}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Wi\+Fi configuration. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__wifi__cfg__t_ae3a23efe266762659e03567d6afc26dd}\label{structciot__wifi__cfg__t_ae3a23efe266762659e03567d6afc26dd} -\index{ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}!password@{password}} -\index{password@{password}!ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{password}{password}} -{\footnotesize\ttfamily char password\mbox{[}64\mbox{]}} - -Password \Hypertarget{structciot__wifi__cfg__t_ad254d41fb741fd973215d202786b5737}\label{structciot__wifi__cfg__t_ad254d41fb741fd973215d202786b5737} -\index{ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}!ssid@{ssid}} -\index{ssid@{ssid}!ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{ssid}{ssid}} -{\footnotesize\ttfamily char ssid\mbox{[}32\mbox{]}} - -SSID \Hypertarget{structciot__wifi__cfg__t_afa68a8b5194df4f630408f99085e4ab8}\label{structciot__wifi__cfg__t_afa68a8b5194df4f630408f99085e4ab8} -\index{ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}!tcp@{tcp}} -\index{tcp@{tcp}!ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{tcp}{tcp}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} tcp} - -TCP configuration \Hypertarget{structciot__wifi__cfg__t_a35cbcdf247b4952f8c35e071bed5a1d8}\label{structciot__wifi__cfg__t_a35cbcdf247b4952f8c35e071bed5a1d8} -\index{ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}!type@{type}} -\index{type@{type}!ciot\_wifi\_cfg\_t@{ciot\_wifi\_cfg\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_af32b4aaa2c6d9132e310a2d368ca3a6f}{ciot\+\_\+wifi\+\_\+type\+\_\+t}} type} - -Wi\+Fi interface type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__wifi__req__t.tex b/docs/latex/structciot__wifi__req__t.tex deleted file mode 100644 index 06902f1..0000000 --- a/docs/latex/structciot__wifi__req__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+req\+\_\+t Struct Reference} -\hypertarget{structciot__wifi__req__t}{}\label{structciot__wifi__req__t}\index{ciot\_wifi\_req\_t@{ciot\_wifi\_req\_t}} - - -Structure for CIOT Wi\+Fi request. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395}{ciot\+\_\+wifi\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structciot__wifi__req__t_a6f6c1937c79d949cdf73c68cf9ad3493}{type}} -\item -\mbox{\hyperlink{unionciot__wifi__req__data__u}{ciot\+\_\+wifi\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structciot__wifi__req__t_a01f8ce506c08d4070208e71aef019ff9}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Wi\+Fi request. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__wifi__req__t_a01f8ce506c08d4070208e71aef019ff9}\label{structciot__wifi__req__t_a01f8ce506c08d4070208e71aef019ff9} -\index{ciot\_wifi\_req\_t@{ciot\_wifi\_req\_t}!data@{data}} -\index{data@{data}!ciot\_wifi\_req\_t@{ciot\_wifi\_req\_t}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__wifi__req__data__u}{ciot\+\_\+wifi\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structciot__wifi__req__t_a6f6c1937c79d949cdf73c68cf9ad3493}\label{structciot__wifi__req__t_a6f6c1937c79d949cdf73c68cf9ad3493} -\index{ciot\_wifi\_req\_t@{ciot\_wifi\_req\_t}!type@{type}} -\index{type@{type}!ciot\_wifi\_req\_t@{ciot\_wifi\_req\_t}} -\doxysubsubsection{\texorpdfstring{type}{type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a2408faec8016bff6cd0590f0db3b8395}{ciot\+\_\+wifi\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__wifi__scan__result__t.tex b/docs/latex/structciot__wifi__scan__result__t.tex deleted file mode 100644 index f48d5fc..0000000 --- a/docs/latex/structciot__wifi__scan__result__t.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+scan\+\_\+result\+\_\+t Struct Reference} -\hypertarget{structciot__wifi__scan__result__t}{}\label{structciot__wifi__scan__result__t}\index{ciot\_wifi\_scan\_result\_t@{ciot\_wifi\_scan\_result\_t}} - - -Structure for CIOT Wi\+Fi scan result. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__wifi__scan__result__t_a20302e2c99a60d3f612dba57e3f6333b}{count}} -\item -\mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__wifi__scan__result__t_a1f0703f0199d2ac8ec80081ea898e0cf}{ap\+\_\+list}} \mbox{[}8\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Wi\+Fi scan result. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__wifi__scan__result__t_a1f0703f0199d2ac8ec80081ea898e0cf}\label{structciot__wifi__scan__result__t_a1f0703f0199d2ac8ec80081ea898e0cf} -\index{ciot\_wifi\_scan\_result\_t@{ciot\_wifi\_scan\_result\_t}!ap\_list@{ap\_list}} -\index{ap\_list@{ap\_list}!ciot\_wifi\_scan\_result\_t@{ciot\_wifi\_scan\_result\_t}} -\doxysubsubsection{\texorpdfstring{ap\_list}{ap\_list}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} ap\+\_\+list\mbox{[}8\mbox{]}} - -Access point list \Hypertarget{structciot__wifi__scan__result__t_a20302e2c99a60d3f612dba57e3f6333b}\label{structciot__wifi__scan__result__t_a20302e2c99a60d3f612dba57e3f6333b} -\index{ciot\_wifi\_scan\_result\_t@{ciot\_wifi\_scan\_result\_t}!count@{count}} -\index{count@{count}!ciot\_wifi\_scan\_result\_t@{ciot\_wifi\_scan\_result\_t}} -\doxysubsubsection{\texorpdfstring{count}{count}} -{\footnotesize\ttfamily uint8\+\_\+t count} - -Number of access points - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__wifi__status__msg__t.tex b/docs/latex/structciot__wifi__status__msg__t.tex deleted file mode 100644 index 41eaa45..0000000 --- a/docs/latex/structciot__wifi__status__msg__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+status\+\_\+msg\+\_\+t Struct Reference} -\hypertarget{structciot__wifi__status__msg__t}{}\label{structciot__wifi__status__msg__t}\index{ciot\_wifi\_status\_msg\_t@{ciot\_wifi\_status\_msg\_t}} - - -Packed structure for Wi-\/\+Fi status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structciot__wifi__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\begin{DoxyCompactList}\small\item\em Message header. \end{DoxyCompactList}\item -\mbox{\hyperlink{structciot__wifi__status__t}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__wifi__status__msg__t_a09cb5a4aa60e39d810f1c21089103503}{status}} -\begin{DoxyCompactList}\small\item\em Wi-\/\+Fi status. \end{DoxyCompactList}\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Packed structure for Wi-\/\+Fi status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__wifi__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structciot__wifi__status__msg__t_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{ciot\_wifi\_status\_msg\_t@{ciot\_wifi\_status\_msg\_t}!header@{header}} -\index{header@{header}!ciot\_wifi\_status\_msg\_t@{ciot\_wifi\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{header}{header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__header__t}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - - - -Message header. - -\Hypertarget{structciot__wifi__status__msg__t_a09cb5a4aa60e39d810f1c21089103503}\label{structciot__wifi__status__msg__t_a09cb5a4aa60e39d810f1c21089103503} -\index{ciot\_wifi\_status\_msg\_t@{ciot\_wifi\_status\_msg\_t}!status@{status}} -\index{status@{status}!ciot\_wifi\_status\_msg\_t@{ciot\_wifi\_status\_msg\_t}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__wifi__status__t}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} status} - - - -Wi-\/\+Fi status. - - - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__wifi_8h}{ciot\+\_\+wifi.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structciot__wifi__status__t.tex b/docs/latex/structciot__wifi__status__t.tex deleted file mode 100644 index c2a951f..0000000 --- a/docs/latex/structciot__wifi__status__t.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+status\+\_\+t Struct Reference} -\hypertarget{structciot__wifi__status__t}{}\label{structciot__wifi__status__t}\index{ciot\_wifi\_status\_t@{ciot\_wifi\_status\_t}} - - -Structure for CIOT Wi\+Fi status. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{structciot__wifi__status__t_ae5b995148e44c51fc076af577ec1acc8}{disconnect\+\_\+reason}} -\item -\mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} \mbox{\hyperlink{structciot__wifi__status__t_ac1b76e51a84c5050063165be909dd70a}{info}} -\item -\mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structciot__wifi__status__t_ac4061ebe19bc469e9a7569aa132010a8}{tcp}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT Wi\+Fi status. - -\doxysubsection{Field Documentation} -\Hypertarget{structciot__wifi__status__t_ae5b995148e44c51fc076af577ec1acc8}\label{structciot__wifi__status__t_ae5b995148e44c51fc076af577ec1acc8} -\index{ciot\_wifi\_status\_t@{ciot\_wifi\_status\_t}!disconnect\_reason@{disconnect\_reason}} -\index{disconnect\_reason@{disconnect\_reason}!ciot\_wifi\_status\_t@{ciot\_wifi\_status\_t}} -\doxysubsubsection{\texorpdfstring{disconnect\_reason}{disconnect\_reason}} -{\footnotesize\ttfamily uint8\+\_\+t disconnect\+\_\+reason} - -Disconnect reason \Hypertarget{structciot__wifi__status__t_ac1b76e51a84c5050063165be909dd70a}\label{structciot__wifi__status__t_ac1b76e51a84c5050063165be909dd70a} -\index{ciot\_wifi\_status\_t@{ciot\_wifi\_status\_t}!info@{info}} -\index{info@{info}!ciot\_wifi\_status\_t@{ciot\_wifi\_status\_t}} -\doxysubsubsection{\texorpdfstring{info}{info}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__wifi__ap__info__t}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} info} - -Access point information \Hypertarget{structciot__wifi__status__t_ac4061ebe19bc469e9a7569aa132010a8}\label{structciot__wifi__status__t_ac4061ebe19bc469e9a7569aa132010a8} -\index{ciot\_wifi\_status\_t@{ciot\_wifi\_status\_t}!tcp@{tcp}} -\index{tcp@{tcp}!ciot\_wifi\_status\_t@{ciot\_wifi\_status\_t}} -\doxysubsubsection{\texorpdfstring{tcp}{tcp}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} tcp} - -TCP status - -The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/structpacked.tex b/docs/latex/structpacked.tex deleted file mode 100644 index 82b31b7..0000000 --- a/docs/latex/structpacked.tex +++ /dev/null @@ -1,2835 +0,0 @@ -\doxysection{packed Union Reference} -\hypertarget{structpacked}{}\label{structpacked}\index{packed@{packed}} - - -Structure for CIOT BLE status message. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a3aef63a65def0876c8b3b4a0ec6a9b04}{ciot\+\_\+msg\+\_\+header\+\_\+t}} \mbox{\hyperlink{structpacked_ac82086f11a03c9e8ff189f5ca9c26f0f}{header}} -\begin{DoxyCompactList}\small\item\em Message header. \end{DoxyCompactList}\item -\mbox{\hyperlink{ciot__ble__types_8h_ad2ea1a97ee8d4ffdc7556561eb75220c}{ciot\+\_\+ble\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a09cb5a4aa60e39d810f1c21089103503}{status}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_ab0eb15151a41b8a487ddebd49457a272}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_aa7ad441170fdff42b419665a6652a09f}{status}} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_ad43e78cb02839dcd178e2b32922b0ebd}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ab50a6b7e2887ecb6625b540edae99138}{status}} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_afd48b494cf6b8f85fe80130aeb21d624}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a9fb48f785812375d586c71a02b453e64}{status}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_aaecc680c841484771c1b04ae62f7de6e}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a290455b77155aab0d086fb8c69f76364}{status}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_afffcff4ee1824ad4fdcb57626c37b98f}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_af7b93aeb68c1648ccb2617ff8217e7b0}{status}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a564b9c4a182a8f6246f70b28b6aab6a4}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ac5c1eb82650b9d0161a399175c459ad3}{status}} -\item -\mbox{\hyperlink{ciot__https__types_8h_afbbf86e234bfeb73c639ea5c7fc89d5a}{ciot\+\_\+https\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ae71d44b4ec9b04f2b3eb183ae791f6ca}{status}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_ac8366b2c0571e1d0b3b9f61dd193f21c}{ciot\+\_\+msg\+\_\+t}} \mbox{\hyperlink{structpacked_abd6b36b1e2c07eaa53b376fdbf0e9345}{msg}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_ab4f3fec57a517448f7d55021dbdbeba2}{payload}} \mbox{[}sizeof(\mbox{\hyperlink{ciot__msg__types_8h_ac8366b2c0571e1d0b3b9f61dd193f21c}{ciot\+\_\+msg\+\_\+t}})\mbox{]} -\item -\mbox{\hyperlink{ciot__iface_8h_ab7cf61a0bac326bd528c23e6ce924c57}{ciot\+\_\+iface\+\_\+event\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_ac3305f4a165c4d898ce7988191102e46}{type}} -\item -\mbox{\hyperlink{ciot__iface_8h_a0965016408f42f5312281df612d0d297}{ciot\+\_\+iface\+\_\+event\+\_\+data\+\_\+u}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structpacked_a325819a8e492ac69542e8b31705af6e9}{data}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_ae5dc6ffcd9b7605c7787791e40cc6bb0}{size}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a8b57d3db91385a3c5383531fd5eb999a}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a0bd4162002c890f2775878d4da138c03}{status}} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_a2460e85462928503379907d9d6e15718}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a95d5fa474c00a79ee883e78048ea7c4c}{status}} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_a3bb6c01197e5a26a19e66339acf44a8f}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ac3be6c0c62c2999a9dd9fa0099945876}{status}} -\item -\mbox{\hyperlink{ciot__ota__types_8h_a60db3988c822f5f5479928ba9c1d8e53}{ciot\+\_\+ota\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a86de670b32fc6ad5c7a44fefb41e6e3a}{status}} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a6990561e69999a83a97f34e225c9b335}{ciot\+\_\+storage\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ac1a66aa256f203858bb2477b812e36fb}{status}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a22f15bbe83314779e819248e5f1a1a7b}{ciot\+\_\+sys\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ad3dbfc73fddab4d58bde12f27edab41b}{status}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a96c14238164bc11945633bdd70387309}{ciot\+\_\+uart\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_aa311cb42bbd477c3bfd5371dd0b8bedd}{status}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_a77dcad2d6b3eb46be679b0b7c023b2c9}{ciot\+\_\+usb\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ab26791741e383cec2107fa1540a14342}{status}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a8f1461812fa7d3f5a1d891fef3b83a57}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a09cb5a4aa60e39d810f1c21089103503}{status}} -\begin{DoxyCompactList}\small\item\em Wi-\/\+Fi status. \end{DoxyCompactList}\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a6c52a3d605c056768b59164ce8df8334}{interval}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a6b307b5083cf92aca29549d780b44bd5}{window}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}{timeout}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a05c940dbc220f5a723afd70071aebff8}{active}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_ad44fdec90acd6e513033d8af6d0a7774}{brigde\+\_\+mode}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_acb7bc06bed6f6408d719334fc41698c7}{reserved}}\+: 6 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a5084f88290d959c1f5469ad840b599b5}{mac}} \mbox{[}6\mbox{]} -\item -int8\+\_\+t \mbox{\hyperlink{structpacked_a3b962e67ba74725bd60ca3c29f785abe}{rssi}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_a6fe0f15cfea3b1febe65bac76c170e39}{ciot\+\_\+ble\+\_\+scn\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a9b3c50f82a67373296513704001266bb}{state}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_a08e9ac1ac5b76905767d35878680d60b}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a9c267320c088f215b9649f93a8d955c1}{adv\+\_\+info}} -\item -int \mbox{\hyperlink{structpacked_a18c05079c393f6c94543830ac5360604}{err\+\_\+code}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_a91b8cb6733aea2072bfa0c9da7fab4ba}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_abc70ef515ab30b52d6a58e0c72ee3688}{type}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_aef815ed67e1b76ed5b9e55d360866cac}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_ad255c0633c486a2ba3c6d2875d5a7fe5}{data}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_a50fd573ce1f125d558ad49eef361e33d}{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a15039efacca36cdba57c2ccf7b0a3d4f}{config}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_a1ff36c6a0e92073157e4e6db1a68c13b}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a4fff0375f4b234a60fcd5e6723d9c8a9}{request}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a42c07f83a6226da7e6271b3f070ac0d7}{hw\+\_\+mac}} \mbox{[}6\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a21008d923a4d8cacdc7622aae81197aa}{sw\+\_\+mac}} \mbox{[}6\mbox{]} -\item -\mbox{\hyperlink{ciot__ble__types_8h_ab3295ccbe32deefbca1e21f16254c6f6}{ciot\+\_\+ble\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_aa5d08015bd3ed92217c40487bd42e433}{state}} -\item -\mbox{\hyperlink{ciot__ble__types_8h_a126c79cdf1e55b5978cc8d20686ab5c8}{ciot\+\_\+ble\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a7a8ead7f37f7534cd955cbefd78043ce}{info}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a62a0efca13351bcf8980bde96c09854e}{set\+\_\+mac}} \mbox{[}6\mbox{]} -\item -\mbox{\hyperlink{ciot__ble__types_8h_a489f19de0628f044234def5f7b34d4b3}{ciot\+\_\+ble\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a1387b7c38bc20d7cf6308e7cbecff167}{type}} -\item -\mbox{\hyperlink{ciot__ble__types_8h_a37dcb6ec26fe529264d483e55537f67b}{ciot\+\_\+ble\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_af05fffb7425971f74862815fe4169b7d}{data}} -\item -\mbox{\hyperlink{ciot__ble__types_8h_add2206059e767da280ff5e6f22882e90}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a3bb879297495825c0895764c1b7593b1}{config}} -\item -\mbox{\hyperlink{ciot__ble__types_8h_a507c363eda1cdff6ff3e30807c34cf25}{ciot\+\_\+ble\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a6aeefeee1b018d7d77c41f66f6015cf9}{request}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a56eef1c57392c0c3144874c536410da1}{ifaces\+\_\+id}} \mbox{[}2\mbox{]} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_a16f08addb892c1ae0f1a82445cc9777e}{ciot\+\_\+bridge\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a75d538f4bd5c29ec545f1e37dae43f0e}{state}} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_ac6748f1175cddeca97c7b0a3ffb268f0}{ciot\+\_\+bridge\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a2ef6bd06414538f347bd722b6c4e064c}{type}} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_a2c5e9c4a62211951d178d372bc1db7a9}{ciot\+\_\+bridge\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a2f53bd6c51629c8cac0040526230998e}{data}} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_a74f4612ecb542e5e9c465b481ea8853b}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a422a3539477ec835aea97b889564f22a}{config}} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_ade176fed03561c5c5800a3e425ba0728}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a21b1ec52268024ae8c4b0eca1dc2a491}{request}} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_acb357b6adaf4fd6f6d754d9aa2825571}{ciot\+\_\+data\+\_\+model\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a350c6a3720c9b7d1b3300e38430117e7}{state}} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_a3bafaff463a2ae4ae97940fe4b22c557}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a1cc8da72a2d329be4f8ff647f04884a0}{type}} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_adbcc0f7df8eb978d649875d0e76567fa}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_adbf84251d29a448cb6b3f3b4b402ebd0}{data}} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_ac7b037266fe0f2c6db0eb7424ffe9032}{ciot\+\_\+data\+\_\+model\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a0a7b5df86de5bd60d09108b02de9d89d}{config}} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_ac6570d06779555f9d5ef10c92ff79bd2}{ciot\+\_\+data\+\_\+model\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_a3f4172ed60af91f49f998cde97dd28cb}{status}} -\item -\mbox{\hyperlink{ciot__data__model__types_8h_ade96f01f5205b28cd03f71300b4b121a}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a8342e156b9596a1154ff4ce550adb30f}{request}} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_af34028f666fa4c0113b0fa0bfbfbefeb}{ciot\+\_\+dfu\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a587d059d905fdf8cceb8643720812de4}{state}} -\item -int \mbox{\hyperlink{structpacked_a45a5b7c00a796a23f01673cef1dbe0a9}{code}} -\item -int \mbox{\hyperlink{structpacked_a11614f44ef4d939bdd984953346a7572}{error}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a42539ea8650b094f66be7a689243c5ef}{image\+\_\+size}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a990d41db67b3605c9184428e72edcea1}{image\+\_\+read}} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_a1da00f2ad7935e7bd07aed5f1b75fc78}{ciot\+\_\+dfu\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_adb76936a18a28e534879c6f9d6f07868}{type}} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_a9d1f804edec9aa8526cbf69a90be44a6}{ciot\+\_\+dfu\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a1d31b0b31c62cd6a2a3c3b5193efd5f9}{data}} -\item -\mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a8d4be68066e35bb11aecfff26e3cb30b}{config}} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_a94941fed93d460349e5b6a4471910c1b}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_aeec32200114264e8556110d5c2ffc44c}{request}} -\item -uint64\+\_\+t \mbox{\hyperlink{structpacked_a3feeb7044549691a36c39cc7c9b2ed2c}{pin\+\_\+mask}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_a823f059cc679fb8bde1970fe03627122}{ciot\+\_\+gpio\+\_\+mode\+\_\+t}} \mbox{\hyperlink{structpacked_a7d76e224ede8a4fa709cc3a505a81975}{mode}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_a5353b26458c680242066bf2976ca0fa4}{ciot\+\_\+gpio\+\_\+pull\+\_\+mode\+\_\+t}} \mbox{\hyperlink{structpacked_a5ee68c0e31fa06f342fad371023bdc4e}{pull}} -\item -uint64\+\_\+t \mbox{\hyperlink{structpacked_af557caa253a733e218e1e71c2a91eef4}{status\+\_\+mask}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a7beea8f6745c478347f244cadef771c2}{num}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_a8d5e9ed96129b8e9037b2151957bc140}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a939fe9a85b37a0ce4a0701b655c799ea}{state}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_ae18edafa23cb123abc3ddc7e10250c82}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a15039efacca36cdba57c2ccf7b0a3d4f}{config}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_ac481a1b453d60c67133f9a95561ac0d2}{ciot\+\_\+gpio\+\_\+state\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a5cc92c2a01be84c116055f80d77e5140}{set\+\_\+state}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_aa7ad8f8f8a543adc1127c439b4ea2f94}{ciot\+\_\+gpio\+\_\+req\+\_\+get\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a93559a0f91d62042000a3276dc457506}{get\+\_\+state}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_ac4f6f7988547fdc0e361c6e208fb0372}{ciot\+\_\+gpio\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_ab949dccfc732240972d8a27cf46f3e76}{type}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_a412b6320a0f6b154f8614106688a16cf}{ciot\+\_\+gpio\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a8742485122a2b9e44392d5d51ddc2076}{data}} -\item -\mbox{\hyperlink{ciot__gpio__types_8h_abd54692515f23a32c3adbeaf2310f0d8}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_ac3fb50fe28f5e2ea50c6f662aa19beca}{request}} -\item -char \mbox{\hyperlink{structpacked_ac4d7124a13340adca15d6f760640b66f}{url}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ab32b0446ee870bfb7a79c056a81e6683}{CIOT\+\_\+\+HTTPC\+\_\+\+URL\+\_\+\+LEN}}\mbox{]} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_ac7dd11f4b86517d5cd42e320c7d5b15e}{ciot\+\_\+httpc\+\_\+method\+\_\+t}} \mbox{\hyperlink{structpacked_ad10985b96579c7c2030050715bcad45d}{method}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a3d85386d7caa5c9c925042f58586789f}{ciot\+\_\+httpc\+\_\+transport\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a7e007ade3b5b7cfcc2ee06d35d52d4e1}{transport}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a4096719d317fa183409fb8c8c2c373a3}{ciot\+\_\+httpc\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a37c663f5a0040d827e450c52efe59882}{state}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_aad8887eccace7d8c75f5466fa52c9a99}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a301d9747f184171d8a1ee19d25d8e4ab}{cfg}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_afc1b0964d9fa89030c055cbc08315c58}{body}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd}{CIOT\+\_\+\+HTTPC\+\_\+\+BODY\+\_\+\+LEN}}\mbox{]} -\item -int \mbox{\hyperlink{structpacked_a675a47f46ecd9d8ec01c738e04c28cbe}{content\+\_\+length}} -\item -char \mbox{\hyperlink{structpacked_a376ba7d15e815aecda5b6276de7ff292}{header}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a82c2b14036a5b80ae9b5a4a6e2812a44}{value}} \mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+VAL}}\mbox{]} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a9b56a78696c5b95d67a47879369219dd}{ciot\+\_\+httpc\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_ac4330d2b9fc6473e00966f8dd66a477c}{type}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}{ciot\+\_\+httpc\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a3623cfec7a7da849fd22ce7ec1c3e10f}{data}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_aad8887eccace7d8c75f5466fa52c9a99}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a0ddab1f295ea5861939322623d313037}{config}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a9f6479442d8891c33f6b16d1f7c090ed}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a57c784a27da9399f6d1a7bd2122a3c65}{request}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}{ciot\+\_\+httpc\+\_\+event\+\_\+u}} \mbox{\hyperlink{structpacked_a28206abcb96418175c4998aaff04c99a}{event}} -\item -char \mbox{\hyperlink{structpacked_aaf2deef29cfe3fe5b18f00f49ff23d42}{address}} \mbox{[}\mbox{\hyperlink{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623}{CIOT\+\_\+\+HTTPS\+\_\+\+ADDRESS\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a98bcbc9e1ebf74ba486f246d76f5bac1}{route}} \mbox{[}\mbox{\hyperlink{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749}{CIOT\+\_\+\+HTTPS\+\_\+\+ROUTE\+\_\+\+LEN}}\mbox{]} -\item -int \mbox{\hyperlink{structpacked_a83a04ad582de2b7d36b96f9db429c2c6}{port}} -\item -\mbox{\hyperlink{ciot__https__types_8h_a89e9a1e11014985783ee949b6ae43a0b}{ciot\+\_\+https\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a28c09b101362530d97e51b712b741f63}{state}} -\item -\mbox{\hyperlink{ciot__https__types_8h_a81d94d04aed05a61d2f9f8d53f57b237}{ciot\+\_\+https\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_adf00e5263d183b9b74cd9dd06dd98856}{type}} -\item -\mbox{\hyperlink{ciot__https__types_8h_ab3d90db6496a253e83a9ab5caf2c770f}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a07d1ec38980b47dde9caaa52c42163cf}{config}} -\item -\mbox{\hyperlink{ciot__https__types_8h_a684d3d6198069ef8c4084f197d00968a}{ciot\+\_\+https\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_af4b02bc60804013ff8623f078ec43efe}{request}} -\item -\mbox{\hyperlink{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}{ciot\+\_\+https\+\_\+event\+\_\+u}} \mbox{\hyperlink{structpacked_ad463eb5d86dcaf2c866494686da9ce6e}{event}} -\item -int \mbox{\hyperlink{structpacked_af8b9db3223039d525df4371413d3c2f3}{tls\+\_\+last\+\_\+err}} -\item -int \mbox{\hyperlink{structpacked_a9006960d969e505489e2a46434d60ebb}{tls\+\_\+stack\+\_\+err}} -\item -int \mbox{\hyperlink{structpacked_abde2f3e27511cfb7307766339fed98e9}{tls\+\_\+cert\+\_\+verify\+\_\+flags}} -\item -int \mbox{\hyperlink{structpacked_ac765329451135abec74c45e1897abf26}{type}} -\item -int \mbox{\hyperlink{structpacked_a2d16d2a81fde684b4c79c0d71f8090b5}{transport\+\_\+sock}} -\item -char \mbox{\hyperlink{structpacked_a6b1fde5b6926d1fec0c3102bbf1ada9f}{d2b}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a7e49cda0ef28302730e05911cb7a9d3c}{b2d}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a71a2e48797aa4b94b9164ea22564c158}{client\+\_\+id}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+CLIENT\+\_\+\+ID\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a40c9809e1d381340b5d342ef3a838715}{user}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+USER\+\_\+\+LEN}}\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a0559811c61c36a1df8aa9ac0c4d56d53}{pass}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+PASS\+\_\+\+LEN}}\mbox{]} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a83a04ad582de2b7d36b96f9db429c2c6}{port}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a65ee2b4b16f25052c441ff9959dcc7e7}{qos}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_afd743a10fc2e70f18169d7fc302c1127}{ciot\+\_\+mqttc\+\_\+transport\+\_\+t}} \mbox{\hyperlink{structpacked_addf4bba19daf5bd5b49b033e239931da}{transport}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a6795bc471854cafb8d3fd93073151c87}{ciot\+\_\+mqttc\+\_\+topics\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a2a5888184d23c617efb05a871a705673}{topics}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_ae298cb176ef6424532a9092d71dbf242}{ciot\+\_\+mqttc\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a28daf783134e0bed0e611de3ea451e4a}{state}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_acaf4be12cb0cee4fbea5e8e121f6d2e4}{conn\+\_\+count}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_af7750329f3654d2f6fe5a20adeae49dd}{data\+\_\+rate}} -\item -time\+\_\+t \mbox{\hyperlink{structpacked_a44794759868576e0404c9cf629863797}{last\+\_\+msg\+\_\+time}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a728f084cfc7a50c63fdb6c10cf9599a2}{ciot\+\_\+mqttc\+\_\+error\+\_\+t}} \mbox{\hyperlink{structpacked_acee85046d884f9e69d341dafac56cd22}{error}} -\item -char \mbox{\hyperlink{structpacked_ae14de85dbf4b99a847daee53083331cb}{topic}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a2a544a28a9461b0de1f303ca407c459f}{msg}} \mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+MSG\+\_\+\+LEN}}\mbox{]} -\item -int \mbox{\hyperlink{structpacked_a439227feff9d7f55384e8780cfc2eb82}{size}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a07954226247942ae3c365ee4da3a5f4b}{ciot\+\_\+mqttc\+\_\+req\+\_\+publish\+\_\+t}} \mbox{\hyperlink{structpacked_ae7b5bde19c99952b5a737b600f3c21e6}{publish}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_ab88409e0f45bc860164159a2db15e903}{ciot\+\_\+mqttc\+\_\+req\+\_\+subscribe\+\_\+t}} \mbox{\hyperlink{structpacked_a061e16f43670bc7f5d29c3971b4088c3}{subscribe}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_aab9e593df0f97788f5bc430a6fdc4900}{ciot\+\_\+mqttc\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a8e287bd3b319b246d8346f46ed6c4580}{type}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a7a428f31b27e3b177d13b4e5780589cc}{ciot\+\_\+mqttc\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_ad609e57ec1fe769dd7f41602cae320ca}{data}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_aef4f897fe6d744683d6c9b418a59b594}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a79c158a8d9a5ddac01d944ca9485764b}{config}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_ac93643bb92edae40c419fb1d3b7ed444}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_af4d809ae5adfaf23b4229995212f0ded}{request}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}{ciot\+\_\+mqttc\+\_\+event\+\_\+u}} \mbox{\hyperlink{structpacked_aea75f103343a18512b1024505e9766de}{event}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a1e6927fa1486224044e568f9c370519b}{id}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a85783fa0fe06a19feac7e7583d8d4c23}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_ab9b24d9114ce832a5b9cbc962c9cea28}{type}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a519d2e79d46983ef76576bc21bdb2bd0}{ciot\+\_\+msg\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a61e21da913274adbd45e28f694651b11}{msg\+\_\+type}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_afe73fa7a655419b386e0a10c7beaace3}{code}} -\item -\mbox{\hyperlink{ciot__types_8h_a2aaa66ac49fb2ae24b530b78cf2abc58}{ciot\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_afedab1afecebfb5eb8554e3b1b056502}{ciot}} -\item -\mbox{\hyperlink{ciot__storage__types_8h_ab2ccb7172389ac0c0e35c3ca1b1cf385}{ciot\+\_\+storage\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a4c64bed640d14af56502dd8dceb9ab20}{storage}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_aa586541b31ba598322ba3a51fc0367e2}{ciot\+\_\+sys\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a04c7e159105631b657e5b65f977a2c4a}{system}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a173e2c17ac72cd49e4d9b2db777ba2a4}{ciot\+\_\+uart\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_aeaf49cc638f1cc4fac1c69fa12502d32}{uart}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_a61ca0aa9e6c4f975c2d5fbd0d06aa4dd}{ciot\+\_\+usb\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_acd0961872f365a2b54fef650ac190f50}{usb}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a33ef59c41d0f68ebb4e062d425da2d50}{ciot\+\_\+tcp\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a2744efd5cf43b6d40d61ea66f7f620d3}{tcp}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a2687337a6d518758bdc08cf5d43b75ac}{ciot\+\_\+wifi\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_ac06a3086376da2d8a84120762824336c}{wifi}} -\item -\mbox{\hyperlink{ciot__ble__types_8h_a0382aed3d5adc1c08ad6ecee8126fd49}{ciot\+\_\+ble\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a8c90dd3961baa84d90870ce1f180006d}{ble}} -\item -\mbox{\hyperlink{ciot__ble__scn__types_8h_a81776baa60f9a76e913265d2a37348fc}{ciot\+\_\+ble\+\_\+scn\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a30ef17c042c5a942dc6491370179966c}{ble\+\_\+scn}} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_a8508ff9b406ed496c100cd6374df7480}{ciot\+\_\+ntp\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a562d7a6cdd9053ec0bf7431017972903}{ntp}} -\item -\mbox{\hyperlink{ciot__ota__types_8h_ac452af306a47644a27053323462de163}{ciot\+\_\+ota\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a466cfd56b729d0efcfa70cff1a8b7b85}{ota}} -\item -\mbox{\hyperlink{ciot__dfu__types_8h_a956c6a31577f123c974ebd246e4fcb2e}{ciot\+\_\+dfu\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a818d9af5834bb69bdafd6513ae494405}{dfu}} -\item -\mbox{\hyperlink{ciot__https__types_8h_a20b32feb134a49d1467ab019ac6fddf8}{ciot\+\_\+https\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a6a8bc746dffc95f0f7b3c468023e10ae}{https}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a51e582709a4c65d0b8e926ffc0bda412}{ciot\+\_\+httpc\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a7d6cac53c9bf51f572908dc2a5b383f0}{httpc}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_a3c806bc4b4ee2215fedf2e1def42983d}{ciot\+\_\+mqttc\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a57eed7a24887f5d1adba0df0ca8f29f5}{mqtt}} -\item -\mbox{\hyperlink{ciot__bridge__types_8h_a4ffebf24e780fbc9a43f0d7373be0fc8}{ciot\+\_\+bridge\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a2f12825330d395d82f01240cf84e6328}{bridge}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a0b17c50c1097aacec28afcf80a796cc9}{ciot\+\_\+msg\+\_\+error\+\_\+t}} \mbox{\hyperlink{structpacked_a460f5e2f775eebdacec0950914ab87a9}{error}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a519d2e79d46983ef76576bc21bdb2bd0}{ciot\+\_\+msg\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_ac3305f4a165c4d898ce7988191102e46}{type}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_a49343989f0ed7cf686deeead9a1e72a3}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a3501e3667f1031fb2f00b333b7b2269a}{iface}} -\item -\mbox{\hyperlink{ciot__msg__types_8h_ad82c5ce860ba7f07f814c767e5d8c906}{ciot\+\_\+msg\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_ac498d2909bc3de66ee0b1a597fa8e0b6}{data}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_aec948fb30e99b1eda7e3d9ff741d417a}{op\+\_\+mode}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_ac752937b32320cf191fe3abd0e8daed6}{sync\+\_\+mode}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a5150de065f0b170644b21514c7530542}{sync\+\_\+interval}} -\item -char \mbox{\hyperlink{structpacked_a4dc1e4fba8f7fec6b1579961829b34f7}{timezone}} \mbox{[}16\mbox{]} -\item -char \mbox{\hyperlink{structpacked_ab80672fab5b8d7864411603053aaffa4}{server}} \mbox{[}\mbox{\hyperlink{ciot__default_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT}}\mbox{]}\mbox{[}64\mbox{]} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_a5cf1c811a4381df356837f1b7e5b9cee}{ciot\+\_\+ntp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a28ce8249c3bcacad6a7698b7697739b8}{state}} -\item -uint64\+\_\+t \mbox{\hyperlink{structpacked_a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d}{last\+\_\+sync}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a69671f26529c8f6076d53b96a1e1627f}{sync\+\_\+count}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a49f666045d24aa8becc5244bc2396aca}{init}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_adb4b09387463cd61bf8f7217366310ef}{sync}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_ac6c17ab632a9c78bc9fa846e9baeea7b}{reserve}}\+: 6 -\item -\mbox{\hyperlink{ciot__ntp__types_8h_a9a8025151a758fca7adb564d5db891e5}{ciot\+\_\+ntp\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a54590843a59febd0e8055f9249974adc}{type}} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_ac41efbba6bf96d623576650325d5f98d}{ciot\+\_\+ntp\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a9401df5c514eae3e23f4468d8ca7795e}{data}} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_acd95cd79edf4b8cd64fe091ec0b18d05}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a6c17383e9465f668d1e9dcb3cf8d4f4a}{config}} -\item -\mbox{\hyperlink{ciot__ntp__types_8h_adb3b9e40223505389621e54062d4d67d}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a0a55111acf65b88d386268c615a69499}{request}} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_a93530965d3e3611bb7b821c606b1a7bd}{ciot\+\_\+opcuas\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a584e26c042d8a98bf6161b7aa27ba4cf}{state}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_acb5cfd209ba75c853d03f701e7f91679}{type}} -\item -char \mbox{\hyperlink{structpacked_aa5f4b442eedc591f6e6e03787e6343bc}{localization}} \mbox{[}8\mbox{]} -\item -char \mbox{\hyperlink{structpacked_acfcef1819c1ec84a215884bb45ed99b6}{display\+\_\+name}} \mbox{[}32\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a381f93ba5743e8813f554bda3c272257}{node\+\_\+id}} \mbox{[}64\mbox{]} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_ac8279c0a0efe8276365f34158ca9a347}{ciot\+\_\+opcuas\+\_\+req\+\_\+add\+\_\+node\+\_\+t}} \mbox{\hyperlink{structpacked_a79aa371ccd92a505f5c26dcd8218a131}{add\+\_\+node}} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_a42ad73195f6a447e8af05ab7f0c4e7a8}{ciot\+\_\+opcuas\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a6a535362b7c81b40f3ed9f6cb292a469}{type}} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_a6aae98feb30c02d06272598af5bfce8a}{ciot\+\_\+opcuas\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a18e3465478724c7b699bb5077661ea35}{data}} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_a1570668bff5d3bb52d4d3b8558de1457}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_aa976951e468c754fef849731243b0acb}{config}} -\item -\mbox{\hyperlink{ciot__opcuas__types_8h_a0fb4cfd7bd281429f1ac9b129ee08148}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a66e033d989ec031368788f08deba7feb}{request}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a268d99c2d888dd67e8ea77d3be0a5021}{force}}\+:1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_afe60ab2756fb1ea1c1de6f3ec6dbea98}{encrypted}}\+:1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a63de528fa8d98b79adfe7f9f68880c17}{restart}}\+:1 -\item -\mbox{\hyperlink{ciot__ota__types_8h_a7bbfc7a06831f7244a0008a085046bb1}{ciot\+\_\+ota\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a796f1aeb4c800b653ee018b20c818804}{state}} -\item -\mbox{\hyperlink{ciot__ota__types_8h_abceb933881a3b5d8844b03841cb5c3ea}{ciot\+\_\+ota\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a19605616d62f4ee24f6aefb6c34480e2}{type}} -\item -\mbox{\hyperlink{ciot__ota__types_8h_a95a9d95c7ed53f4fa9e337cad3be3df5}{ciot\+\_\+ota\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a77dc06e65f4b0aed4a3f44e1b6a32aa0}{data}} -\item -\mbox{\hyperlink{ciot__ota__types_8h_a65a913c723017cac6c102f19075c391c}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a62fb934187d712f56dc1289eda8f8cac}{config}} -\item -\mbox{\hyperlink{ciot__ota__types_8h_aaf0b6171ec4a1f2bfa2eb3b37aabda45}{ciot\+\_\+ota\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a4e22c6ea4c9d8fad6bbd0d3894c82627}{request}} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a4baf00c99923bb372e3eb3673935ed17}{ciot\+\_\+storage\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_aa03a710482f738f9fe6095f1d4c6774a}{type}} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a3c7a971dfa6df181c9d30f5ee90e18ab}{ciot\+\_\+storage\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_aabc97b8fe1b1624b67ee7bc472d5b0b0}{state}} -\item -char \mbox{\hyperlink{structpacked_ace45f567511d3f9ff978c679ae38b5b0}{path}} \mbox{[}16\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_ae5dc6ffcd9b7605c7787791e40cc6bb0}{size}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_afe23ad4b14c014e0c70c96d93e44005c}{data}} \mbox{[}255\mbox{]} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a33ad06132b9a63bcca2850e4deec0147}{ciot\+\_\+storage\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a7b3cbcb3aea8c25ecc00d1316d1a79d6}{type}} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a6c2a3023a87afa286532ee37504817ce}{ciot\+\_\+storage\+\_\+req\+\_\+file\+\_\+data\+\_\+t}} \mbox{\hyperlink{structpacked_a6b5e08e2800e812e2ee5294c83ac9fe6}{data}} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a5f42c3c4dbb4dd85cf85709898a1c791}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_aabe6a902449529e66a1bb460116af784}{config}} -\item -\mbox{\hyperlink{ciot__storage__types_8h_a6cf1904dcacbf10aa82f0b00209cce7e}{ciot\+\_\+storage\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_ae35bc5d21998e1401aa886359cafd044}{request}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_ab8549384ff6a90d5fedec40cd3535ebf}{storage}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a2e90afcc174ac8d99edf7229774986db}{system}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_ab56ae378dca42f3463d9dab3f4462045}{uart}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a71f3331b8fa338b8bb771e9c60142df8}{usb}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a634aacbacba6e5a795fbebf904d6f827}{ethernet}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_abf7485e5a2b2214d69dd780eddc62f39}{wifi}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a3541968d9c0a8b544893692fb34cfdee}{ble\+\_\+scn}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a633be9f96069e4c7cb47b431f80ca974}{gpio}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a5a6ed8c04a3db86066924b1a1bf4dad3}{reserved}}\+: 8 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a34018b7bbca3d89088500ca3a47a66fd}{ntp}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_aa20473f3745555bec85f491e13188f4e}{ota}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a6adae5024e1ef3cf7e6209bf7f0c58a0}{dfu}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_ae536bd73f6eaace274e55d4779276e5e}{http\+\_\+client}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a8081e8e6e70c0ae11cc3996fe07f6dde}{http\+\_\+server}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a1f1d5466bff3ee92c8a67e4b067159a2}{mqtt\+\_\+client}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_aea00c2c1dec6e8f58532f25c65210d9e}{timer}}\+: 1 -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_a720e2a2aba3a8aa7ec09162d3a522d60}{serializer}}\+: 1 -\item -\mbox{\hyperlink{ciot__sys__types_8h_ae454e8987e8ced54221cd2314ca35179}{ciot\+\_\+sys\+\_\+hw\+\_\+features\+\_\+t}} \mbox{\hyperlink{structpacked_a68d421729d1895d3b9a6f4cc1dedbb42}{hw}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a86b848978871af9156529a213a7b2964}{ciot\+\_\+sys\+\_\+sw\+\_\+features\+\_\+t}} \mbox{\hyperlink{structpacked_aeb930ea2d960351877d7ef0a126173ff}{sw}} -\item -char \mbox{\hyperlink{structpacked_adc57848c0c5ba85f8662d618bcbd80a7}{hw\+\_\+name}} \mbox{[}16\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a33414ac5d16ad70f9ff7696f7922beec}{app\+\_\+ver}} \mbox{[}3\mbox{]} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a19527d6d8e26c211aab4582840515d87}{ciot\+\_\+sys\+\_\+hw\+\_\+t}} \mbox{\hyperlink{structpacked_a978e0f986a3de1feb66ebf37cd43b274}{hardware}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a4dfa490253aaae67732c02c2f2956498}{ciot\+\_\+sys\+\_\+features\+\_\+t}} \mbox{\hyperlink{structpacked_a08bf5c347b3e2c3525c382eaab3d6f97}{features}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_aa4f71758f86d92d3ae60a541335f579d}{rst\+\_\+reason}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_acc644e0c68521fc2c21bdf5acb5f5812}{rst\+\_\+count}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_aa455685612d3d0967fd32c32256a8bd3}{free\+\_\+memory}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a569e06e92ec3d06c5ebf7f40d7f9a84e}{lifetime}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_ac2068c2ccad79ab6f2939e6521d6f8dc}{ciot\+\_\+sys\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a29734819b12e849f2f27b8663d023d8f}{info}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a68ad4161ca2e18dd35627284ab0a9a03}{ciot\+\_\+sys\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a4341eac7e0a50f29b2101e5b7584db32}{type}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_ad026367d794b4b32817688953294a598}{ciot\+\_\+sys\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a3acb986a68044c354bb4e34cb18e4d3c}{data}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a08490c4ad9ae77c762d0ce3d5ee87553}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a9d2eb5a0a1a2ed5d529672a8229a8fe8}{config}} -\item -\mbox{\hyperlink{ciot__sys__types_8h_a3eeb20290c9050c851dfd5b90c91fddc}{ciot\+\_\+sys\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a7146ff86f43fac1f87c45f31c3a3bd20}{request}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_aa374c9c6202f8a72f195068863b3159d}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a689764758640d8f794e755c07c602667}{dhcp}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a02f666cd85720a1af519b6a39c44b95a}{ip}} \mbox{[}4\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a0beca1eecd2529c061a6dc4cb8a412fd}{gateway}} \mbox{[}4\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_ada50f0e7b89816d02459e3e520b018bf}{mask}} \mbox{[}4\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a9bf249fa42db4caf84d05f92ed1f9718}{dns}} \mbox{[}4\mbox{]} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a7f05e1346cbd89193fe25fb8ca3617f7}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_acb22641cf860e836e7394d14b9adae4b}{client}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a7f05e1346cbd89193fe25fb8ca3617f7}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_afdb30da7a1b29e70c8b5051adcaf649b}{server}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a0cef319e1c591fef1f183c5f38405f28}{ciot\+\_\+tcp\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a771cb8893000d5d94fc8bc2d21347412}{state}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a9f1a85d0984278cc2effabb9a9765a63}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_acf265b9f6bf6e80f8d16a9aaade7e8cd}{dhcp}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a07aaf742d2f18de8dcf29cec27a6f697}{ciot\+\_\+tcp\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a086ac86c52dfa147af9f5afed658c7cb}{info}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a7fadfe9c543207b391d461a1b7db38c1}{ciot\+\_\+tcp\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_acd8fb37e86ba410b191b31dc8cf154c3}{type}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_aab1d223b98b3a0515aee3f94df513b61}{ciot\+\_\+tcp\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_ab9836dbdec18617a3ddefdeb64d68c5f}{data}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_ac80e90daf748eaa0b4e1d1732125cdd0}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a71821427aa3817c68209a151bed81e56}{config}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_a9a92bafd6999ad2c9229af4d11a606dc}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_aaf3b24e7b5d38ca3f76ca38e5e43ad7e}{request}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a857436941aa8d7df5abfa34bcd054d35}{version}} \mbox{[}3\mbox{]} -\item -\mbox{\hyperlink{ciot__types_8h_a761a6a322d1df76417eabd409388e765}{ciot\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_ab3a7653fc8a3bfebedb322cceec24c38}{state}} -\item -\mbox{\hyperlink{ciot__types_8h_ace705fe0e4de79261605cb2ae6584a76}{ciot\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a92c867a7e919ec76d2e58647718b633a}{info}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a5aca650808126ada7193361ab8921e7a}{iface\+\_\+id}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a2dd2df43c7a23b9fb91e6e462c592477}{err}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a82eb8e84b1ff534e368a647470a626c3}{iface}} -\item -\mbox{\hyperlink{ciot__types_8h_acfbe12a2ec8eba54fb5039db68d0f708}{ciot\+\_\+req\+\_\+save\+\_\+iface\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_af24d10404fe7693abc12d43b4edea249}{save\+\_\+iface\+\_\+cfg}} -\item -\mbox{\hyperlink{ciot__types_8h_ac0dc91dcb3dba9e8ed3c763416916293}{ciot\+\_\+req\+\_\+delete\+\_\+iface\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_abaf229d7f984c35aa24c89632a544934}{delete\+\_\+iface\+\_\+cfg}} -\item -\mbox{\hyperlink{ciot__types_8h_a14b8314f1fa07b94542d824f3d58ac69}{ciot\+\_\+req\+\_\+proxy\+\_\+msg\+\_\+t}} \mbox{\hyperlink{structpacked_a778eb3ed59eb3397b9efad8d48d34b62}{proxy\+\_\+msg}} -\item -\mbox{\hyperlink{ciot__types_8h_a3a49770e58a83e77136fda7bed12af91}{ciot\+\_\+req\+\_\+result\+\_\+t}} \mbox{\hyperlink{structpacked_a90808ce2b0f0710bbe9799c64e8df0db}{result}} -\item -\mbox{\hyperlink{ciot__types_8h_a9dc21f9381920f5fad134a55af258e76}{ciot\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a55a6010bd818c4c1b94eca45963f09a9}{type}} -\item -\mbox{\hyperlink{ciot__types_8h_aa1998ccca78c6c238f57c692ed4a622e}{ciot\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_aeecdef82363bc7b7d7ba9bf5f8f51908}{data}} -\item -\mbox{\hyperlink{ciot__types_8h_ad58b5c3ac7e3db3b466b8cf21663f045}{ciot\+\_\+iface\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a82e7ef84cdd4eb20f2da20f0df751fd3}{config}} -\item -\mbox{\hyperlink{ciot__types_8h_af97e5c236fd3ba09dc3c0d8d64db6492}{ciot\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ac4db33ce66ac8ec09d4b5b088eb88ead}{status}} -\item -\mbox{\hyperlink{ciot__types_8h_a2447b2be2fbce5ae85a0a2441887b04c}{ciot\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a8975b1b5a295a8ee8669dfcce942dcd5}{request}} -\item -uint32\+\_\+t \mbox{\hyperlink{structpacked_a148f33bbcda8087a77d8ba30f7e3c502}{baud\+\_\+rate}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_abea371f9030e15a5d2a4c181576833d8}{num}} -\item -int8\+\_\+t \mbox{\hyperlink{structpacked_ab461fda70a78750930429bcc68db5a98}{rx\+\_\+pin}} -\item -int8\+\_\+t \mbox{\hyperlink{structpacked_abc8367b5354c54835c1d74192f355c1c}{tx\+\_\+pin}} -\item -int8\+\_\+t \mbox{\hyperlink{structpacked_a3c82534f71c473adbf7fa380db7badc2}{rts\+\_\+pin}} -\item -int8\+\_\+t \mbox{\hyperlink{structpacked_a73580a66f00a6a0ea4a56441d529797f}{cts\+\_\+pin}} -\item -uint16\+\_\+t \mbox{\hyperlink{structpacked_ae5290e95682932917ab6a7fd7897abb4}{parity}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a9498b6790752dd532f6465f3efb59cbf}{flow\+\_\+control}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a5b495a42fbde79adb797b1e9f6a4e039}{dtr}}\+: 1 -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a7550d74d56b36307b64a75f5d4eb8dad}{bridge\+\_\+mode}}\+: 1 -\item -\mbox{\hyperlink{ciot__uart__types_8h_a379e740e1f6e093f3171f683e37edb46}{ciot\+\_\+uart\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a00c2e8ab24db2cabd968dcd6aa86a7c3}{state}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_af9a79ce82018578a321e3022f69a5710}{ciot\+\_\+uart\+\_\+error\+\_\+t}} \mbox{\hyperlink{structpacked_ad02fff01b7a3add4e201ad4fd60bb06d}{error}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a7e0448049ed056aac193026e6db7f8b6}{ciot\+\_\+uart\+\_\+req\+\_\+send\+\_\+data\+\_\+t}} \mbox{\hyperlink{structpacked_a64001c4b28083877216a64df74dff823}{send\+\_\+data}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a7169a8b5d899c7d39631d2e3504000f0}{ciot\+\_\+uart\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a21d88bf4d17b9837d25893a4000044db}{type}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a98a4805d6e8622685aacbcaf5c7d662a}{ciot\+\_\+uart\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a8abbd25f85c295a54f54d2815908d273}{data}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a328b387fef8643ace899107317a2d026}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a107556abf8506af23fc4f92aa4d20cea}{config}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_ad06e49ddd42e711bfaf23efcc4cfb227}{ciot\+\_\+uart\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_aeac55f9a4429aa466599b8875763ff38}{request}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}{ciot\+\_\+uart\+\_\+event\+\_\+u}} \mbox{\hyperlink{structpacked_af5207c84edf0697170da962f465640a0}{event}} -\item -bool \mbox{\hyperlink{structpacked_a4e8946f8a10777bc88814da1c657815c}{bridge\+\_\+mode}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_adc042f264191411a452df2234c1259d4}{ciot\+\_\+usb\+\_\+state\+\_\+t}} \mbox{\hyperlink{structpacked_a3442f594ec1fc76781d93b1a28b55cba}{state}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_af55c58ec7098f36787f3b5dc3920f329}{ciot\+\_\+usb\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_aa027ba4e6f58da1f5204e16dd15d5136}{type}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_aa5c798854d1c16136e13b08b7338f4be}{ciot\+\_\+usb\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a91cc22753d20b8e288bae1944e5c5fce}{data}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_ab7c11252685450f706584c776412d897}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a5a3eefbe6f21d662a5e318bbf323a00e}{config}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_a51b485c991167b9b599cb94a6922138c}{ciot\+\_\+usb\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_aebb2adef59fcdc91db3d185996066c6a}{request}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}{ciot\+\_\+usb\+\_\+event\+\_\+u}} \mbox{\hyperlink{structpacked_abe630baacf2cedc1090a81ef4e39a081}{event}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a19c52baafe5797c359c5e0f5776499d7}{bssid}} \mbox{[}6\mbox{]} -\item -char \mbox{\hyperlink{structpacked_a431ea94992ad903ffe97cf85b3763ab0}{ssid}} \mbox{[}33\mbox{]} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a62cb83d5528e0d152b4e179fea395cab}{authmode}} -\item -char \mbox{\hyperlink{structpacked_ae3a23efe266762659e03567d6afc26dd}{password}} \mbox{[}64\mbox{]} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_ad1995b212559b6b98eed49478c579ebd}{ciot\+\_\+wifi\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a35cbcdf247b4952f8c35e071bed5a1d8}{type}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_ac80e90daf748eaa0b4e1d1732125cdd0}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_afa68a8b5194df4f630408f99085e4ab8}{tcp}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_ae5b995148e44c51fc076af577ec1acc8}{disconnect\+\_\+reason}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a6795a3a48e28e8918fee3ad0c599695d}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_ac1b76e51a84c5050063165be909dd70a}{info}} -\item -\mbox{\hyperlink{ciot__tcp__types_8h_aaecc680c841484771c1b04ae62f7de6e}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{structpacked_ac4061ebe19bc469e9a7569aa132010a8}{tcp}} -\item -uint8\+\_\+t \mbox{\hyperlink{structpacked_a20302e2c99a60d3f612dba57e3f6333b}{count}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a6795a3a48e28e8918fee3ad0c599695d}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} \mbox{\hyperlink{structpacked_a1f0703f0199d2ac8ec80081ea898e0cf}{ap\+\_\+list}} \mbox{[}8\mbox{]} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_aab66103615da49426d9475a0216fa2e5}{ciot\+\_\+wifi\+\_\+scan\+\_\+result\+\_\+t}} \mbox{\hyperlink{structpacked_a23723a81650d6544d7da572eb4bf33b9}{scan\+\_\+result}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a69a78d9e2c718561c3b3d10a5f0e2870}{ciot\+\_\+wifi\+\_\+req\+\_\+type\+\_\+t}} \mbox{\hyperlink{structpacked_a6f6c1937c79d949cdf73c68cf9ad3493}{type}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_aa6dfae24cc98778e0abf5b76d70469dc}{ciot\+\_\+wifi\+\_\+req\+\_\+data\+\_\+u}} \mbox{\hyperlink{structpacked_a01f8ce506c08d4070208e71aef019ff9}{data}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a8d42278408ea731a4ee5a729bf9abdd9}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{structpacked_a711c5a971ab69b9cfa4850692e6bbaad}{config}} -\item -\mbox{\hyperlink{ciot__wifi__types_8h_a7672a0bfaa531684471175c3c46b2c6f}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} \mbox{\hyperlink{structpacked_a95d1196af9ebc0b64f6f7e2842812448}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Structure for CIOT BLE status message. - -Union for CIOT Wi\+Fi data. - -Structure for CIOT Wi\+Fi request. - -Union for CIOT Wi\+Fi request data. - -Structure for CIOT Wi\+Fi scan result. - -Structure for CIOT Wi\+Fi status. - -Structure for CIOT Wi\+Fi configuration. - -Structure for CIOT Wi\+Fi access point information. - -Union for CIOT USB data. - -Structure for CIOT USB request. - -Union for CIOT USB request data. - -Structure for CIOT USB status. - -Structure for CIOT USB configuration. - -Union for CIOT UART data. - -Structure for CIOT UART request. - -Union for CIOT UART request data. - -Structure for CIOT UART send data request. - -Structure for CIOT UART status. - -Structure for CIOT UART configuration. - -Union for CIOT data. - -Structure for CIOT request. - -Union for CIOT request data. - -Structure for CIOT proxy message request. - -Structure for CIOT request result. - -Structure for CIOT delete interface configuration request. - -Structure for CIOT save interface configuration request. - -Structure for CIOT status. - -Structure for CIOT information. - -Structure for CIOT interface configuration. - -Union for CIOT TCP data. - -Structure for CIOT TCP request. - -Union for CIOT TCP request data. - -Structure for CIOT TCP status. - -Structure for CIOT TCP information. - -Structure for CIOT TCP DHCP status. - -Structure for CIOT TCP configuration. - -Union for CIOT system data. - -Structure for CIOT system request. - -Union for CIOT system request data. - -Structure for CIOT system configuration. - -Structure for CIOT system status. - -Structure for CIOT system information. - -Structure for CIOT system features combining hardware and software features. - -Structure for CIOT system software features. - -Structure for CIOT system hardware features. - -Union for CIOT storage data. - -Structure for CIOT storage request. - -Structure for CIOT storage file data in a request. - -Structure for CIOT storage status. - -Structure for CIOT storage configuration. - -Union for CIOT OTA data. - -Structure for CIOT OTA request. - -Union for CIOT OTA request data. - -Structure for CIOT OTA status. - -Structure for CIOT OTA configuration. - -Union for CIOT OPC UA Server data. - -Structure for CIOT OPC UA Server request. - -Union for CIOT OPC UA Server request data. - -Structure for CIOT OPC UA Server add node request. - -Structure for CIOT OPC UA Server status. - -Structure for CIOT OPC UA Server configuration. - -Union for CIOT NTP data. - -Structure for CIOT NTP request. - -Union for CIOT NTP request data. - -Structure for CIOT NTP status. - -Structure for CIOT NTP configuration. - -Structure for CIOT message. - -Structure for CIOT message header. - -Union for CIOT message data. - -Structure for CIOT message error information. - -Structure for CIOT message interface information. - -Union for CIOT MQTT client data. - -Structure for CIOT MQTT client request. - -Union for CIOT MQTT client request data. - -Structure for CIOT MQTT client subscribe request. - -Structure for CIOT MQTT client publish request. - -Structure for CIOT MQTT client status. - -Structure for CIOT MQTT client configuration. - -Structure for CIOT MQTT client topics configuration. - -Structure for CIOT MQTT client error information. - -Union for CIOT HTTP server data. - -Structure for CIOT HTTP server request. - -Union for CIOT HTTP server request data. - -Structure for CIOT HTTP server status. - -Structure for CIOT HTTP server configuration. - -Union for CIOT HTTP client data. - -Structure for CIOT HTTP client request. - -Structure for CIOT HTTP client set header request. - -Structure for CIOT HTTP client send data request. - -Structure for CIOT HTTP client status. - -Structure for CIOT HTTP client configuration. - -Union for CIOT GPIO data. - -Structure for CIOT GPIO request. - -Union for CIOT GPIO request data. - -Structure for CIOT GPIO request to get state. - -Structure for CIOT GPIO state information. - -Structure for CIOT GPIO status. - -Structure for CIOT GPIO configuration. - -Union for CIOT DFU data. - -Structure for CIOT DFU request. - -Union for CIOT DFU request data. - -Structure for CIOT DFU status. - -Union for CIOT data model data. - -Structure for CIOT data model request. - -Union for CIOT data model request data. - -Structure for CIOT data model status. - -Structure for CIOT data model configuration. - -Union for CIOT bridge data. - -Structure for CIOT bridge request. - -Union for CIOT bridge request data. - -Structure for CIOT bridge status. - -Structure for CIOT bridge configuration. - -Union for CIOT BLE data. - -Structure for CIOT BLE request. - -Union for CIOT BLE request data. - -Structure for CIOT BLE status. - -Structure for CIOT BLE information. - -Structure for CIOT BLE configuration. - -Union for CIOT BLE SCN data. - -Structure for CIOT BLE SCN request. - -Union for CIOT BLE SCN request data. - -Structure for CIOT BLE SCN status. - -Structure for CIOT BLE SCN advertising information. - -Structure for CIOT BLE SCN configuration. - -Packed structure for Wi-\/\+Fi status message. - -Status message structure for CIOT USB module. - -Status message structure for CIOT UART module. - -CIOT TCP status message structure. - -CIOT System status message structure. - -CIOT Storage status message structure. - -Structure for CIOT OTA status message. - -Structure for CIOT OPCUAS status message. - -Structure for CIOT NTP status message. - -Structure representing a CIOT MQTT client status message. - -Structure representing an interface event. - -Union for CIOT interface event data. - -Structure representing the CIOT HTTP server status message. - -Structure representing the CIOT HTTP client status message. - -Structure representing the CIOT GPIO status message. - -Structure representing the CIOT Ethernet status message. - -Struct for DFU status message. - -Structure for CIOT Bridge status message. - -Structure for CIOT BLE scanner status message. - -\doxysubsection{Field Documentation} -\Hypertarget{structpacked_a05c940dbc220f5a723afd70071aebff8}\label{structpacked_a05c940dbc220f5a723afd70071aebff8} -\index{packed@{packed}!active@{active}} -\index{active@{active}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{active}{active}} -{\footnotesize\ttfamily uint8\+\_\+t active} - -Active flag \Hypertarget{structpacked_a79aa371ccd92a505f5c26dcd8218a131}\label{structpacked_a79aa371ccd92a505f5c26dcd8218a131} -\index{packed@{packed}!add\_node@{add\_node}} -\index{add\_node@{add\_node}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{add\_node}{add\_node}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_ac8279c0a0efe8276365f34158ca9a347}{ciot\+\_\+opcuas\+\_\+req\+\_\+add\+\_\+node\+\_\+t}} add\+\_\+node} - -Add node request data \Hypertarget{structpacked_aaf2deef29cfe3fe5b18f00f49ff23d42}\label{structpacked_aaf2deef29cfe3fe5b18f00f49ff23d42} -\index{packed@{packed}!address@{address}} -\index{address@{address}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{address}{address}} -{\footnotesize\ttfamily char address\mbox{[}\mbox{\hyperlink{ciot__https__types_8h_abe1cc7f5311018e78e8a49734cce3623}{CIOT\+\_\+\+HTTPS\+\_\+\+ADDRESS\+\_\+\+LEN}}\mbox{]}} - -Address \Hypertarget{structpacked_a9c267320c088f215b9649f93a8d955c1}\label{structpacked_a9c267320c088f215b9649f93a8d955c1} -\index{packed@{packed}!adv\_info@{adv\_info}} -\index{adv\_info@{adv\_info}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{adv\_info}{adv\_info}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_a08e9ac1ac5b76905767d35878680d60b}{ciot\+\_\+ble\+\_\+scn\+\_\+adv\+\_\+info\+\_\+t}} adv\+\_\+info} - -Advertising information \Hypertarget{structpacked_a1f0703f0199d2ac8ec80081ea898e0cf}\label{structpacked_a1f0703f0199d2ac8ec80081ea898e0cf} -\index{packed@{packed}!ap\_list@{ap\_list}} -\index{ap\_list@{ap\_list}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ap\_list}{ap\_list}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a6795a3a48e28e8918fee3ad0c599695d}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} ap\+\_\+list\mbox{[}8\mbox{]}} - -Access point list \Hypertarget{structpacked_a33414ac5d16ad70f9ff7696f7922beec}\label{structpacked_a33414ac5d16ad70f9ff7696f7922beec} -\index{packed@{packed}!app\_ver@{app\_ver}} -\index{app\_ver@{app\_ver}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{app\_ver}{app\_ver}} -{\footnotesize\ttfamily uint8\+\_\+t app\+\_\+ver\mbox{[}3\mbox{]}} - -Application version \Hypertarget{structpacked_a62cb83d5528e0d152b4e179fea395cab}\label{structpacked_a62cb83d5528e0d152b4e179fea395cab} -\index{packed@{packed}!authmode@{authmode}} -\index{authmode@{authmode}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{authmode}{authmode}} -{\footnotesize\ttfamily uint8\+\_\+t authmode} - -Authentication mode \Hypertarget{structpacked_a7e49cda0ef28302730e05911cb7a9d3c}\label{structpacked_a7e49cda0ef28302730e05911cb7a9d3c} -\index{packed@{packed}!b2d@{b2d}} -\index{b2d@{b2d}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{b2d}{b2d}} -{\footnotesize\ttfamily char b2d\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]}} - -Broker to device topic \Hypertarget{structpacked_a148f33bbcda8087a77d8ba30f7e3c502}\label{structpacked_a148f33bbcda8087a77d8ba30f7e3c502} -\index{packed@{packed}!baud\_rate@{baud\_rate}} -\index{baud\_rate@{baud\_rate}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{baud\_rate}{baud\_rate}} -{\footnotesize\ttfamily uint32\+\_\+t baud\+\_\+rate} - -Baud rate \Hypertarget{structpacked_a8c90dd3961baa84d90870ce1f180006d}\label{structpacked_a8c90dd3961baa84d90870ce1f180006d} -\index{packed@{packed}!ble@{ble}} -\index{ble@{ble}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ble}{ble}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_a0382aed3d5adc1c08ad6ecee8126fd49}{ciot\+\_\+ble\+\_\+data\+\_\+u}} ble} - -BLE data \Hypertarget{structpacked_a30ef17c042c5a942dc6491370179966c}\label{structpacked_a30ef17c042c5a942dc6491370179966c} -\index{packed@{packed}!ble\_scn@{ble\_scn}} -\index{ble\_scn@{ble\_scn}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ble\_scn}{ble\_scn}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_a81776baa60f9a76e913265d2a37348fc}{ciot\+\_\+ble\+\_\+scn\+\_\+data\+\_\+u}} ble\+\_\+scn} - -BLE SCN data \Hypertarget{structpacked_a3541968d9c0a8b544893692fb34cfdee}\label{structpacked_a3541968d9c0a8b544893692fb34cfdee} -\index{packed@{packed}!ble\_scn@{ble\_scn}} -\index{ble\_scn@{ble\_scn}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ble\_scn}{ble\_scn}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t ble\+\_\+scn} - -BLE SCN (Serial Control) feature \Hypertarget{structpacked_afc1b0964d9fa89030c055cbc08315c58}\label{structpacked_afc1b0964d9fa89030c055cbc08315c58} -\index{packed@{packed}!body@{body}} -\index{body@{body}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{body}{body}} -{\footnotesize\ttfamily uint8\+\_\+t body\mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ac029ebf7c40c24f8ad4cd380f7a3f8dd}{CIOT\+\_\+\+HTTPC\+\_\+\+BODY\+\_\+\+LEN}}\mbox{]}} - -Body \Hypertarget{structpacked_a2f12825330d395d82f01240cf84e6328}\label{structpacked_a2f12825330d395d82f01240cf84e6328} -\index{packed@{packed}!bridge@{bridge}} -\index{bridge@{bridge}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{bridge}{bridge}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_a4ffebf24e780fbc9a43f0d7373be0fc8}{ciot\+\_\+bridge\+\_\+data\+\_\+u}} bridge} - -Bridge data \Hypertarget{structpacked_a7550d74d56b36307b64a75f5d4eb8dad}\label{structpacked_a7550d74d56b36307b64a75f5d4eb8dad} -\index{packed@{packed}!bridge\_mode@{bridge\_mode}} -\index{bridge\_mode@{bridge\_mode}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{bridge\_mode}{bridge\_mode}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily uint8\+\_\+t bridge\+\_\+mode} - -Bridge mode flag \Hypertarget{structpacked_a4e8946f8a10777bc88814da1c657815c}\label{structpacked_a4e8946f8a10777bc88814da1c657815c} -\index{packed@{packed}!bridge\_mode@{bridge\_mode}} -\index{bridge\_mode@{bridge\_mode}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{bridge\_mode}{bridge\_mode}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily bool bridge\+\_\+mode} - -Bridge mode flag \Hypertarget{structpacked_ad44fdec90acd6e513033d8af6d0a7774}\label{structpacked_ad44fdec90acd6e513033d8af6d0a7774} -\index{packed@{packed}!brigde\_mode@{brigde\_mode}} -\index{brigde\_mode@{brigde\_mode}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{brigde\_mode}{brigde\_mode}} -{\footnotesize\ttfamily uint8\+\_\+t brigde\+\_\+mode} - -Bridge mode flag \Hypertarget{structpacked_a19c52baafe5797c359c5e0f5776499d7}\label{structpacked_a19c52baafe5797c359c5e0f5776499d7} -\index{packed@{packed}!bssid@{bssid}} -\index{bssid@{bssid}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{bssid}{bssid}} -{\footnotesize\ttfamily uint8\+\_\+t bssid\mbox{[}6\mbox{]}} - -BSSID \Hypertarget{structpacked_a301d9747f184171d8a1ee19d25d8e4ab}\label{structpacked_a301d9747f184171d8a1ee19d25d8e4ab} -\index{packed@{packed}!cfg@{cfg}} -\index{cfg@{cfg}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{cfg}{cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_aad8887eccace7d8c75f5466fa52c9a99}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} cfg} - -Configuration \Hypertarget{structpacked_afedab1afecebfb5eb8554e3b1b056502}\label{structpacked_afedab1afecebfb5eb8554e3b1b056502} -\index{packed@{packed}!ciot@{ciot}} -\index{ciot@{ciot}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ciot}{ciot}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a2aaa66ac49fb2ae24b530b78cf2abc58}{ciot\+\_\+data\+\_\+u}} ciot} - -CIOT data \Hypertarget{structpacked_acb22641cf860e836e7394d14b9adae4b}\label{structpacked_acb22641cf860e836e7394d14b9adae4b} -\index{packed@{packed}!client@{client}} -\index{client@{client}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{client}{client}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a7f05e1346cbd89193fe25fb8ca3617f7}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} client} - -DHCP client state \Hypertarget{structpacked_a71a2e48797aa4b94b9164ea22564c158}\label{structpacked_a71a2e48797aa4b94b9164ea22564c158} -\index{packed@{packed}!client\_id@{client\_id}} -\index{client\_id@{client\_id}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{client\_id}{client\_id}} -{\footnotesize\ttfamily char client\+\_\+id\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a6d8667859c659ff145c1ff7cc6a2296e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+CLIENT\+\_\+\+ID\+\_\+\+LEN}}\mbox{]}} - -Client ID \Hypertarget{structpacked_a45a5b7c00a796a23f01673cef1dbe0a9}\label{structpacked_a45a5b7c00a796a23f01673cef1dbe0a9} -\index{packed@{packed}!code@{code}} -\index{code@{code}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{code}{code}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily int code} - -Code - -Error code \Hypertarget{structpacked_afe73fa7a655419b386e0a10c7beaace3}\label{structpacked_afe73fa7a655419b386e0a10c7beaace3} -\index{packed@{packed}!code@{code}} -\index{code@{code}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{code}{code}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint32\+\_\+t code} - -Error code \Hypertarget{structpacked_a15039efacca36cdba57c2ccf7b0a3d4f}\label{structpacked_a15039efacca36cdba57c2ccf7b0a3d4f} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [1/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ae18edafa23cb123abc3ddc7e10250c82}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a3bb879297495825c0895764c1b7593b1}\label{structpacked_a3bb879297495825c0895764c1b7593b1} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [2/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_add2206059e767da280ff5e6f22882e90}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a422a3539477ec835aea97b889564f22a}\label{structpacked_a422a3539477ec835aea97b889564f22a} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [3/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_a74f4612ecb542e5e9c465b481ea8853b}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a0a7b5df86de5bd60d09108b02de9d89d}\label{structpacked_a0a7b5df86de5bd60d09108b02de9d89d} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [4/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_ac7b037266fe0f2c6db0eb7424ffe9032}{ciot\+\_\+data\+\_\+model\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a8d4be68066e35bb11aecfff26e3cb30b}\label{structpacked_a8d4be68066e35bb11aecfff26e3cb30b} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [5/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a15039efacca36cdba57c2ccf7b0a3d4f}\label{structpacked_a15039efacca36cdba57c2ccf7b0a3d4f} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [6/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ae18edafa23cb123abc3ddc7e10250c82}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a0ddab1f295ea5861939322623d313037}\label{structpacked_a0ddab1f295ea5861939322623d313037} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [7/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_aad8887eccace7d8c75f5466fa52c9a99}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a07d1ec38980b47dde9caaa52c42163cf}\label{structpacked_a07d1ec38980b47dde9caaa52c42163cf} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [8/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_ab3d90db6496a253e83a9ab5caf2c770f}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{structpacked_a79c158a8d9a5ddac01d944ca9485764b}\label{structpacked_a79c158a8d9a5ddac01d944ca9485764b} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [9/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_aef4f897fe6d744683d6c9b418a59b594}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{structpacked_a6c17383e9465f668d1e9dcb3cf8d4f4a}\label{structpacked_a6c17383e9465f668d1e9dcb3cf8d4f4a} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [10/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_acd95cd79edf4b8cd64fe091ec0b18d05}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} config} - -NTP configuration \Hypertarget{structpacked_aa976951e468c754fef849731243b0acb}\label{structpacked_aa976951e468c754fef849731243b0acb} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [11/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_a1570668bff5d3bb52d4d3b8558de1457}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} config} - -OPC UA Server configuration \Hypertarget{structpacked_a62fb934187d712f56dc1289eda8f8cac}\label{structpacked_a62fb934187d712f56dc1289eda8f8cac} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [12/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_a65a913c723017cac6c102f19075c391c}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} config} - -OTA configuration \Hypertarget{structpacked_aabe6a902449529e66a1bb460116af784}\label{structpacked_aabe6a902449529e66a1bb460116af784} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [13/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a5f42c3c4dbb4dd85cf85709898a1c791}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} config} - -Storage configuration \Hypertarget{structpacked_a9d2eb5a0a1a2ed5d529672a8229a8fe8}\label{structpacked_a9d2eb5a0a1a2ed5d529672a8229a8fe8} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [14/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a08490c4ad9ae77c762d0ce3d5ee87553}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} config} - -System configuration \Hypertarget{structpacked_a71821427aa3817c68209a151bed81e56}\label{structpacked_a71821427aa3817c68209a151bed81e56} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [15/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_ac80e90daf748eaa0b4e1d1732125cdd0}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} config} - -TCP configuration \Hypertarget{structpacked_a82e7ef84cdd4eb20f2da20f0df751fd3}\label{structpacked_a82e7ef84cdd4eb20f2da20f0df751fd3} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [16/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_ad58b5c3ac7e3db3b466b8cf21663f045}{ciot\+\_\+iface\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{structpacked_a107556abf8506af23fc4f92aa4d20cea}\label{structpacked_a107556abf8506af23fc4f92aa4d20cea} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [17/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a328b387fef8643ace899107317a2d026}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{structpacked_a5a3eefbe6f21d662a5e318bbf323a00e}\label{structpacked_a5a3eefbe6f21d662a5e318bbf323a00e} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [18/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_ab7c11252685450f706584c776412d897}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{structpacked_a711c5a971ab69b9cfa4850692e6bbaad}\label{structpacked_a711c5a971ab69b9cfa4850692e6bbaad} -\index{packed@{packed}!config@{config}} -\index{config@{config}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{config}{config}\hspace{0.1cm}{\footnotesize\ttfamily [19/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a8d42278408ea731a4ee5a729bf9abdd9}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{structpacked_acaf4be12cb0cee4fbea5e8e121f6d2e4}\label{structpacked_acaf4be12cb0cee4fbea5e8e121f6d2e4} -\index{packed@{packed}!conn\_count@{conn\_count}} -\index{conn\_count@{conn\_count}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{conn\_count}{conn\_count}} -{\footnotesize\ttfamily uint8\+\_\+t conn\+\_\+count} - -Connection count \Hypertarget{structpacked_a675a47f46ecd9d8ec01c738e04c28cbe}\label{structpacked_a675a47f46ecd9d8ec01c738e04c28cbe} -\index{packed@{packed}!content\_length@{content\_length}} -\index{content\_length@{content\_length}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{content\_length}{content\_length}} -{\footnotesize\ttfamily int content\+\_\+length} - -Content length \Hypertarget{structpacked_a20302e2c99a60d3f612dba57e3f6333b}\label{structpacked_a20302e2c99a60d3f612dba57e3f6333b} -\index{packed@{packed}!count@{count}} -\index{count@{count}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{count}{count}} -{\footnotesize\ttfamily uint8\+\_\+t count} - -Number of access points \Hypertarget{structpacked_a73580a66f00a6a0ea4a56441d529797f}\label{structpacked_a73580a66f00a6a0ea4a56441d529797f} -\index{packed@{packed}!cts\_pin@{cts\_pin}} -\index{cts\_pin@{cts\_pin}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{cts\_pin}{cts\_pin}} -{\footnotesize\ttfamily int8\+\_\+t cts\+\_\+pin} - -CTS pin \Hypertarget{structpacked_a6b1fde5b6926d1fec0c3102bbf1ada9f}\label{structpacked_a6b1fde5b6926d1fec0c3102bbf1ada9f} -\index{packed@{packed}!d2b@{d2b}} -\index{d2b@{d2b}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{d2b}{d2b}} -{\footnotesize\ttfamily char d2b\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_af67c4f0b899c64fc5cb38c9e920abde6}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+TOPIC\+\_\+\+LEN}}\mbox{]}} - -Device to broker topic \Hypertarget{structpacked_a325819a8e492ac69542e8b31705af6e9}\label{structpacked_a325819a8e492ac69542e8b31705af6e9} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [1/21]}} -{\footnotesize\ttfamily uint8\+\_\+t data} - -Event data. - -Message data - -Data buffer \Hypertarget{structpacked_ad255c0633c486a2ba3c6d2875d5a7fe5}\label{structpacked_ad255c0633c486a2ba3c6d2875d5a7fe5} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [2/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_aef815ed67e1b76ed5b9e55d360866cac}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_af05fffb7425971f74862815fe4169b7d}\label{structpacked_af05fffb7425971f74862815fe4169b7d} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [3/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_a37dcb6ec26fe529264d483e55537f67b}{ciot\+\_\+ble\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a2f53bd6c51629c8cac0040526230998e}\label{structpacked_a2f53bd6c51629c8cac0040526230998e} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [4/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_a2c5e9c4a62211951d178d372bc1db7a9}{ciot\+\_\+bridge\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_adbf84251d29a448cb6b3f3b4b402ebd0}\label{structpacked_adbf84251d29a448cb6b3f3b4b402ebd0} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [5/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_adbcc0f7df8eb978d649875d0e76567fa}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a1d31b0b31c62cd6a2a3c3b5193efd5f9}\label{structpacked_a1d31b0b31c62cd6a2a3c3b5193efd5f9} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [6/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_a9d1f804edec9aa8526cbf69a90be44a6}{ciot\+\_\+dfu\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a8742485122a2b9e44392d5d51ddc2076}\label{structpacked_a8742485122a2b9e44392d5d51ddc2076} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [7/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_a412b6320a0f6b154f8614106688a16cf}{ciot\+\_\+gpio\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a3623cfec7a7da849fd22ce7ec1c3e10f}\label{structpacked_a3623cfec7a7da849fd22ce7ec1c3e10f} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [8/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a2ea83a6895d0ef313aa7381a2d56ca51}{ciot\+\_\+httpc\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_ad609e57ec1fe769dd7f41602cae320ca}\label{structpacked_ad609e57ec1fe769dd7f41602cae320ca} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [9/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a7a428f31b27e3b177d13b4e5780589cc}{ciot\+\_\+mqttc\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_ac498d2909bc3de66ee0b1a597fa8e0b6}\label{structpacked_ac498d2909bc3de66ee0b1a597fa8e0b6} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [10/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_ad82c5ce860ba7f07f814c767e5d8c906}{ciot\+\_\+msg\+\_\+data\+\_\+u}} data} - -Message data \Hypertarget{structpacked_a9401df5c514eae3e23f4468d8ca7795e}\label{structpacked_a9401df5c514eae3e23f4468d8ca7795e} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [11/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_ac41efbba6bf96d623576650325d5f98d}{ciot\+\_\+ntp\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a18e3465478724c7b699bb5077661ea35}\label{structpacked_a18e3465478724c7b699bb5077661ea35} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [12/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_a6aae98feb30c02d06272598af5bfce8a}{ciot\+\_\+opcuas\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a77dc06e65f4b0aed4a3f44e1b6a32aa0}\label{structpacked_a77dc06e65f4b0aed4a3f44e1b6a32aa0} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [13/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_a95a9d95c7ed53f4fa9e337cad3be3df5}{ciot\+\_\+ota\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_afe23ad4b14c014e0c70c96d93e44005c}\label{structpacked_afe23ad4b14c014e0c70c96d93e44005c} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [14/21]}} -{\footnotesize\ttfamily uint8\+\_\+t data\mbox{[}255\mbox{]}} - -Data content - -Message data - -Data buffer \Hypertarget{structpacked_a6b5e08e2800e812e2ee5294c83ac9fe6}\label{structpacked_a6b5e08e2800e812e2ee5294c83ac9fe6} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [15/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a6c2a3023a87afa286532ee37504817ce}{ciot\+\_\+storage\+\_\+req\+\_\+file\+\_\+data\+\_\+t}} data} - -Request data \Hypertarget{structpacked_a3acb986a68044c354bb4e34cb18e4d3c}\label{structpacked_a3acb986a68044c354bb4e34cb18e4d3c} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [16/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_ad026367d794b4b32817688953294a598}{ciot\+\_\+sys\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_ab9836dbdec18617a3ddefdeb64d68c5f}\label{structpacked_ab9836dbdec18617a3ddefdeb64d68c5f} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [17/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_aab1d223b98b3a0515aee3f94df513b61}{ciot\+\_\+tcp\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_aeecdef82363bc7b7d7ba9bf5f8f51908}\label{structpacked_aeecdef82363bc7b7d7ba9bf5f8f51908} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [18/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_aa1998ccca78c6c238f57c692ed4a622e}{ciot\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a8abbd25f85c295a54f54d2815908d273}\label{structpacked_a8abbd25f85c295a54f54d2815908d273} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [19/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a98a4805d6e8622685aacbcaf5c7d662a}{ciot\+\_\+uart\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a91cc22753d20b8e288bae1944e5c5fce}\label{structpacked_a91cc22753d20b8e288bae1944e5c5fce} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [20/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_aa5c798854d1c16136e13b08b7338f4be}{ciot\+\_\+usb\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_a01f8ce506c08d4070208e71aef019ff9}\label{structpacked_a01f8ce506c08d4070208e71aef019ff9} -\index{packed@{packed}!data@{data}} -\index{data@{data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data}{data}\hspace{0.1cm}{\footnotesize\ttfamily [21/21]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_aa6dfae24cc98778e0abf5b76d70469dc}{ciot\+\_\+wifi\+\_\+req\+\_\+data\+\_\+u}} data} - -Request data \Hypertarget{structpacked_af7750329f3654d2f6fe5a20adeae49dd}\label{structpacked_af7750329f3654d2f6fe5a20adeae49dd} -\index{packed@{packed}!data\_rate@{data\_rate}} -\index{data\_rate@{data\_rate}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{data\_rate}{data\_rate}} -{\footnotesize\ttfamily uint16\+\_\+t data\+\_\+rate} - -Data rate \Hypertarget{structpacked_abaf229d7f984c35aa24c89632a544934}\label{structpacked_abaf229d7f984c35aa24c89632a544934} -\index{packed@{packed}!delete\_iface\_cfg@{delete\_iface\_cfg}} -\index{delete\_iface\_cfg@{delete\_iface\_cfg}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{delete\_iface\_cfg}{delete\_iface\_cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_ac0dc91dcb3dba9e8ed3c763416916293}{ciot\+\_\+req\+\_\+delete\+\_\+iface\+\_\+cfg\+\_\+t}} delete\+\_\+iface\+\_\+cfg} - -Delete interface configuration request data \Hypertarget{structpacked_a818d9af5834bb69bdafd6513ae494405}\label{structpacked_a818d9af5834bb69bdafd6513ae494405} -\index{packed@{packed}!dfu@{dfu}} -\index{dfu@{dfu}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{dfu}{dfu}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_a956c6a31577f123c974ebd246e4fcb2e}{ciot\+\_\+dfu\+\_\+data\+\_\+u}} dfu} - -DFU data \Hypertarget{structpacked_a6adae5024e1ef3cf7e6209bf7f0c58a0}\label{structpacked_a6adae5024e1ef3cf7e6209bf7f0c58a0} -\index{packed@{packed}!dfu@{dfu}} -\index{dfu@{dfu}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{dfu}{dfu}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t dfu} - -DFU (Device Firmware Update) feature \Hypertarget{structpacked_a689764758640d8f794e755c07c602667}\label{structpacked_a689764758640d8f794e755c07c602667} -\index{packed@{packed}!dhcp@{dhcp}} -\index{dhcp@{dhcp}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{dhcp}{dhcp}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_aa374c9c6202f8a72f195068863b3159d}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+cfg\+\_\+t}} dhcp} - -DHCP configuration \Hypertarget{structpacked_acf265b9f6bf6e80f8d16a9aaade7e8cd}\label{structpacked_acf265b9f6bf6e80f8d16a9aaade7e8cd} -\index{packed@{packed}!dhcp@{dhcp}} -\index{dhcp@{dhcp}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{dhcp}{dhcp}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a9f1a85d0984278cc2effabb9a9765a63}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+status\+\_\+t}} dhcp} - -DHCP status \Hypertarget{structpacked_ae5b995148e44c51fc076af577ec1acc8}\label{structpacked_ae5b995148e44c51fc076af577ec1acc8} -\index{packed@{packed}!disconnect\_reason@{disconnect\_reason}} -\index{disconnect\_reason@{disconnect\_reason}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{disconnect\_reason}{disconnect\_reason}} -{\footnotesize\ttfamily uint8\+\_\+t disconnect\+\_\+reason} - -Disconnect reason \Hypertarget{structpacked_acfcef1819c1ec84a215884bb45ed99b6}\label{structpacked_acfcef1819c1ec84a215884bb45ed99b6} -\index{packed@{packed}!display\_name@{display\_name}} -\index{display\_name@{display\_name}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{display\_name}{display\_name}} -{\footnotesize\ttfamily char display\+\_\+name\mbox{[}32\mbox{]}} - -Display name \Hypertarget{structpacked_a9bf249fa42db4caf84d05f92ed1f9718}\label{structpacked_a9bf249fa42db4caf84d05f92ed1f9718} -\index{packed@{packed}!dns@{dns}} -\index{dns@{dns}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{dns}{dns}} -{\footnotesize\ttfamily uint8\+\_\+t dns\mbox{[}4\mbox{]}} - -DNS address \Hypertarget{structpacked_a5b495a42fbde79adb797b1e9f6a4e039}\label{structpacked_a5b495a42fbde79adb797b1e9f6a4e039} -\index{packed@{packed}!dtr@{dtr}} -\index{dtr@{dtr}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{dtr}{dtr}} -{\footnotesize\ttfamily uint8\+\_\+t dtr} - -DTR flag \Hypertarget{structpacked_afe60ab2756fb1ea1c1de6f3ec6dbea98}\label{structpacked_afe60ab2756fb1ea1c1de6f3ec6dbea98} -\index{packed@{packed}!encrypted@{encrypted}} -\index{encrypted@{encrypted}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{encrypted}{encrypted}} -{\footnotesize\ttfamily uint8\+\_\+t encrypted} - -Flag for encrypted update \Hypertarget{structpacked_a2dd2df43c7a23b9fb91e6e462c592477}\label{structpacked_a2dd2df43c7a23b9fb91e6e462c592477} -\index{packed@{packed}!err@{err}} -\index{err@{err}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{err}{err}} -{\footnotesize\ttfamily uint32\+\_\+t err} - -Error code \Hypertarget{structpacked_a18c05079c393f6c94543830ac5360604}\label{structpacked_a18c05079c393f6c94543830ac5360604} -\index{packed@{packed}!err\_code@{err\_code}} -\index{err\_code@{err\_code}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{err\_code}{err\_code}} -{\footnotesize\ttfamily int err\+\_\+code} - -Error code \Hypertarget{structpacked_a11614f44ef4d939bdd984953346a7572}\label{structpacked_a11614f44ef4d939bdd984953346a7572} -\index{packed@{packed}!error@{error}} -\index{error@{error}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{error}{error}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}} -{\footnotesize\ttfamily int error} - -Error - -Error code \Hypertarget{structpacked_acee85046d884f9e69d341dafac56cd22}\label{structpacked_acee85046d884f9e69d341dafac56cd22} -\index{packed@{packed}!error@{error}} -\index{error@{error}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{error}{error}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a728f084cfc7a50c63fdb6c10cf9599a2}{ciot\+\_\+mqttc\+\_\+error\+\_\+t}} error} - -Error information \Hypertarget{structpacked_a460f5e2f775eebdacec0950914ab87a9}\label{structpacked_a460f5e2f775eebdacec0950914ab87a9} -\index{packed@{packed}!error@{error}} -\index{error@{error}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{error}{error}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a0b17c50c1097aacec28afcf80a796cc9}{ciot\+\_\+msg\+\_\+error\+\_\+t}} error} - -Error data \Hypertarget{structpacked_ad02fff01b7a3add4e201ad4fd60bb06d}\label{structpacked_ad02fff01b7a3add4e201ad4fd60bb06d} -\index{packed@{packed}!error@{error}} -\index{error@{error}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{error}{error}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_af9a79ce82018578a321e3022f69a5710}{ciot\+\_\+uart\+\_\+error\+\_\+t}} error} - -UART error \Hypertarget{structpacked_a634aacbacba6e5a795fbebf904d6f827}\label{structpacked_a634aacbacba6e5a795fbebf904d6f827} -\index{packed@{packed}!ethernet@{ethernet}} -\index{ethernet@{ethernet}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ethernet}{ethernet}} -{\footnotesize\ttfamily uint16\+\_\+t ethernet} - -Ethernet feature \Hypertarget{structpacked_a28206abcb96418175c4998aaff04c99a}\label{structpacked_a28206abcb96418175c4998aaff04c99a} -\index{packed@{packed}!event@{event}} -\index{event@{event}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{event}{event}\hspace{0.1cm}{\footnotesize\ttfamily [1/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}{ciot\+\_\+httpc\+\_\+event\+\_\+u}} event} - -Event \Hypertarget{structpacked_ad463eb5d86dcaf2c866494686da9ce6e}\label{structpacked_ad463eb5d86dcaf2c866494686da9ce6e} -\index{packed@{packed}!event@{event}} -\index{event@{event}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{event}{event}\hspace{0.1cm}{\footnotesize\ttfamily [2/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}{ciot\+\_\+https\+\_\+event\+\_\+u}} event} - -Event \Hypertarget{structpacked_aea75f103343a18512b1024505e9766de}\label{structpacked_aea75f103343a18512b1024505e9766de} -\index{packed@{packed}!event@{event}} -\index{event@{event}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{event}{event}\hspace{0.1cm}{\footnotesize\ttfamily [3/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}{ciot\+\_\+mqttc\+\_\+event\+\_\+u}} event} - -Event data \Hypertarget{structpacked_af5207c84edf0697170da962f465640a0}\label{structpacked_af5207c84edf0697170da962f465640a0} -\index{packed@{packed}!event@{event}} -\index{event@{event}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{event}{event}\hspace{0.1cm}{\footnotesize\ttfamily [4/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}{ciot\+\_\+uart\+\_\+event\+\_\+u}} event} - -Event data \Hypertarget{structpacked_abe630baacf2cedc1090a81ef4e39a081}\label{structpacked_abe630baacf2cedc1090a81ef4e39a081} -\index{packed@{packed}!event@{event}} -\index{event@{event}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{event}{event}\hspace{0.1cm}{\footnotesize\ttfamily [5/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}{ciot\+\_\+usb\+\_\+event\+\_\+u}} event} - -Event data \Hypertarget{structpacked_a08bf5c347b3e2c3525c382eaab3d6f97}\label{structpacked_a08bf5c347b3e2c3525c382eaab3d6f97} -\index{packed@{packed}!features@{features}} -\index{features@{features}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{features}{features}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a4dfa490253aaae67732c02c2f2956498}{ciot\+\_\+sys\+\_\+features\+\_\+t}} features} - -System features \Hypertarget{structpacked_a9498b6790752dd532f6465f3efb59cbf}\label{structpacked_a9498b6790752dd532f6465f3efb59cbf} -\index{packed@{packed}!flow\_control@{flow\_control}} -\index{flow\_control@{flow\_control}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{flow\_control}{flow\_control}} -{\footnotesize\ttfamily uint8\+\_\+t flow\+\_\+control} - -Flow control flag \Hypertarget{structpacked_a268d99c2d888dd67e8ea77d3be0a5021}\label{structpacked_a268d99c2d888dd67e8ea77d3be0a5021} -\index{packed@{packed}!force@{force}} -\index{force@{force}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{force}{force}} -{\footnotesize\ttfamily uint8\+\_\+t force} - -Flag for forcing update \Hypertarget{structpacked_aa455685612d3d0967fd32c32256a8bd3}\label{structpacked_aa455685612d3d0967fd32c32256a8bd3} -\index{packed@{packed}!free\_memory@{free\_memory}} -\index{free\_memory@{free\_memory}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{free\_memory}{free\_memory}} -{\footnotesize\ttfamily uint32\+\_\+t free\+\_\+memory} - -Free memory \Hypertarget{structpacked_a0beca1eecd2529c061a6dc4cb8a412fd}\label{structpacked_a0beca1eecd2529c061a6dc4cb8a412fd} -\index{packed@{packed}!gateway@{gateway}} -\index{gateway@{gateway}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{gateway}{gateway}} -{\footnotesize\ttfamily uint8\+\_\+t gateway\mbox{[}4\mbox{]}} - -Gateway address \Hypertarget{structpacked_a93559a0f91d62042000a3276dc457506}\label{structpacked_a93559a0f91d62042000a3276dc457506} -\index{packed@{packed}!get\_state@{get\_state}} -\index{get\_state@{get\_state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{get\_state}{get\_state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_aa7ad8f8f8a543adc1127c439b4ea2f94}{ciot\+\_\+gpio\+\_\+req\+\_\+get\+\_\+state\+\_\+t}} get\+\_\+state} - -Get state request \Hypertarget{structpacked_a633be9f96069e4c7cb47b431f80ca974}\label{structpacked_a633be9f96069e4c7cb47b431f80ca974} -\index{packed@{packed}!gpio@{gpio}} -\index{gpio@{gpio}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{gpio}{gpio}} -{\footnotesize\ttfamily uint16\+\_\+t gpio} - -GPIO feature \Hypertarget{structpacked_a978e0f986a3de1feb66ebf37cd43b274}\label{structpacked_a978e0f986a3de1feb66ebf37cd43b274} -\index{packed@{packed}!hardware@{hardware}} -\index{hardware@{hardware}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{hardware}{hardware}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a19527d6d8e26c211aab4582840515d87}{ciot\+\_\+sys\+\_\+hw\+\_\+t}} hardware} - -Hardware type \Hypertarget{structpacked_ac82086f11a03c9e8ff189f5ca9c26f0f}\label{structpacked_ac82086f11a03c9e8ff189f5ca9c26f0f} -\index{packed@{packed}!header@{header}} -\index{header@{header}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{header}{header}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a3aef63a65def0876c8b3b4a0ec6a9b04}{ciot\+\_\+msg\+\_\+header\+\_\+t}} header} - - - -Message header. - -Message header - -Header for the DFU status message. - -Message header. - -Header information. \Hypertarget{structpacked_a376ba7d15e815aecda5b6276de7ff292}\label{structpacked_a376ba7d15e815aecda5b6276de7ff292} -\index{packed@{packed}!header@{header}} -\index{header@{header}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{header}{header}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily char header\mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_ab752d46c4d848b82390c300cd1ae19b9}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+LEN}}\mbox{]}} - -Header \Hypertarget{structpacked_ae536bd73f6eaace274e55d4779276e5e}\label{structpacked_ae536bd73f6eaace274e55d4779276e5e} -\index{packed@{packed}!http\_client@{http\_client}} -\index{http\_client@{http\_client}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{http\_client}{http\_client}} -{\footnotesize\ttfamily uint16\+\_\+t http\+\_\+client} - -HTTP client feature \Hypertarget{structpacked_a8081e8e6e70c0ae11cc3996fe07f6dde}\label{structpacked_a8081e8e6e70c0ae11cc3996fe07f6dde} -\index{packed@{packed}!http\_server@{http\_server}} -\index{http\_server@{http\_server}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{http\_server}{http\_server}} -{\footnotesize\ttfamily uint16\+\_\+t http\+\_\+server} - -HTTP server feature \Hypertarget{structpacked_a7d6cac53c9bf51f572908dc2a5b383f0}\label{structpacked_a7d6cac53c9bf51f572908dc2a5b383f0} -\index{packed@{packed}!httpc@{httpc}} -\index{httpc@{httpc}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{httpc}{httpc}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a51e582709a4c65d0b8e926ffc0bda412}{ciot\+\_\+httpc\+\_\+data\+\_\+u}} httpc} - -HTTP client data \Hypertarget{structpacked_a6a8bc746dffc95f0f7b3c468023e10ae}\label{structpacked_a6a8bc746dffc95f0f7b3c468023e10ae} -\index{packed@{packed}!https@{https}} -\index{https@{https}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{https}{https}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_a20b32feb134a49d1467ab019ac6fddf8}{ciot\+\_\+https\+\_\+data\+\_\+u}} https} - -HTTP server data \Hypertarget{structpacked_a68d421729d1895d3b9a6f4cc1dedbb42}\label{structpacked_a68d421729d1895d3b9a6f4cc1dedbb42} -\index{packed@{packed}!hw@{hw}} -\index{hw@{hw}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{hw}{hw}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_ae454e8987e8ced54221cd2314ca35179}{ciot\+\_\+sys\+\_\+hw\+\_\+features\+\_\+t}} hw} - -Hardware features \Hypertarget{structpacked_a42c07f83a6226da7e6271b3f070ac0d7}\label{structpacked_a42c07f83a6226da7e6271b3f070ac0d7} -\index{packed@{packed}!hw\_mac@{hw\_mac}} -\index{hw\_mac@{hw\_mac}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{hw\_mac}{hw\_mac}} -{\footnotesize\ttfamily uint8\+\_\+t hw\+\_\+mac\mbox{[}6\mbox{]}} - -Hardware MAC address \Hypertarget{structpacked_adc57848c0c5ba85f8662d618bcbd80a7}\label{structpacked_adc57848c0c5ba85f8662d618bcbd80a7} -\index{packed@{packed}!hw\_name@{hw\_name}} -\index{hw\_name@{hw\_name}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{hw\_name}{hw\_name}} -{\footnotesize\ttfamily char hw\+\_\+name\mbox{[}16\mbox{]}} - -Hardware name \Hypertarget{structpacked_a1e6927fa1486224044e568f9c370519b}\label{structpacked_a1e6927fa1486224044e568f9c370519b} -\index{packed@{packed}!id@{id}} -\index{id@{id}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{id}{id}} -{\footnotesize\ttfamily uint8\+\_\+t id} - -Interface ID - -Message ID \Hypertarget{structpacked_a3501e3667f1031fb2f00b333b7b2269a}\label{structpacked_a3501e3667f1031fb2f00b333b7b2269a} -\index{packed@{packed}!iface@{iface}} -\index{iface@{iface}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{iface}{iface}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a49343989f0ed7cf686deeead9a1e72a3}{ciot\+\_\+msg\+\_\+iface\+\_\+info\+\_\+t}} iface} - -Interface information \Hypertarget{structpacked_a82eb8e84b1ff534e368a647470a626c3}\label{structpacked_a82eb8e84b1ff534e368a647470a626c3} -\index{packed@{packed}!iface@{iface}} -\index{iface@{iface}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{iface}{iface}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint8\+\_\+t iface} - -Interface \Hypertarget{structpacked_a5aca650808126ada7193361ab8921e7a}\label{structpacked_a5aca650808126ada7193361ab8921e7a} -\index{packed@{packed}!iface\_id@{iface\_id}} -\index{iface\_id@{iface\_id}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{iface\_id}{iface\_id}} -{\footnotesize\ttfamily uint8\+\_\+t iface\+\_\+id} - -Interface ID \Hypertarget{structpacked_a56eef1c57392c0c3144874c536410da1}\label{structpacked_a56eef1c57392c0c3144874c536410da1} -\index{packed@{packed}!ifaces\_id@{ifaces\_id}} -\index{ifaces\_id@{ifaces\_id}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ifaces\_id}{ifaces\_id}} -{\footnotesize\ttfamily uint8\+\_\+t ifaces\+\_\+id\mbox{[}2\mbox{]}} - -Interface IDs \Hypertarget{structpacked_a990d41db67b3605c9184428e72edcea1}\label{structpacked_a990d41db67b3605c9184428e72edcea1} -\index{packed@{packed}!image\_read@{image\_read}} -\index{image\_read@{image\_read}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{image\_read}{image\_read}} -{\footnotesize\ttfamily uint32\+\_\+t image\+\_\+read} - -Image read - -Number of bytes read \Hypertarget{structpacked_a42539ea8650b094f66be7a689243c5ef}\label{structpacked_a42539ea8650b094f66be7a689243c5ef} -\index{packed@{packed}!image\_size@{image\_size}} -\index{image\_size@{image\_size}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{image\_size}{image\_size}} -{\footnotesize\ttfamily uint32\+\_\+t image\+\_\+size} - -Image size - -Size of the image \Hypertarget{structpacked_a7a8ead7f37f7534cd955cbefd78043ce}\label{structpacked_a7a8ead7f37f7534cd955cbefd78043ce} -\index{packed@{packed}!info@{info}} -\index{info@{info}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{info}{info}\hspace{0.1cm}{\footnotesize\ttfamily [1/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_a126c79cdf1e55b5978cc8d20686ab5c8}{ciot\+\_\+ble\+\_\+info\+\_\+t}} info} - -Information \Hypertarget{structpacked_a29734819b12e849f2f27b8663d023d8f}\label{structpacked_a29734819b12e849f2f27b8663d023d8f} -\index{packed@{packed}!info@{info}} -\index{info@{info}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{info}{info}\hspace{0.1cm}{\footnotesize\ttfamily [2/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_ac2068c2ccad79ab6f2939e6521d6f8dc}{ciot\+\_\+sys\+\_\+info\+\_\+t}} info} - -System information \Hypertarget{structpacked_a086ac86c52dfa147af9f5afed658c7cb}\label{structpacked_a086ac86c52dfa147af9f5afed658c7cb} -\index{packed@{packed}!info@{info}} -\index{info@{info}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{info}{info}\hspace{0.1cm}{\footnotesize\ttfamily [3/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a07aaf742d2f18de8dcf29cec27a6f697}{ciot\+\_\+tcp\+\_\+info\+\_\+t}} info} - -TCP information \Hypertarget{structpacked_a92c867a7e919ec76d2e58647718b633a}\label{structpacked_a92c867a7e919ec76d2e58647718b633a} -\index{packed@{packed}!info@{info}} -\index{info@{info}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{info}{info}\hspace{0.1cm}{\footnotesize\ttfamily [4/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_ace705fe0e4de79261605cb2ae6584a76}{ciot\+\_\+info\+\_\+t}} info} - -CIOT information \Hypertarget{structpacked_ac1b76e51a84c5050063165be909dd70a}\label{structpacked_ac1b76e51a84c5050063165be909dd70a} -\index{packed@{packed}!info@{info}} -\index{info@{info}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{info}{info}\hspace{0.1cm}{\footnotesize\ttfamily [5/5]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a6795a3a48e28e8918fee3ad0c599695d}{ciot\+\_\+wifi\+\_\+ap\+\_\+info\+\_\+t}} info} - -Access point information \Hypertarget{structpacked_a49f666045d24aa8becc5244bc2396aca}\label{structpacked_a49f666045d24aa8becc5244bc2396aca} -\index{packed@{packed}!init@{init}} -\index{init@{init}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{init}{init}} -{\footnotesize\ttfamily uint8\+\_\+t init} - -Initialization flag \Hypertarget{structpacked_a6c52a3d605c056768b59164ce8df8334}\label{structpacked_a6c52a3d605c056768b59164ce8df8334} -\index{packed@{packed}!interval@{interval}} -\index{interval@{interval}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{interval}{interval}} -{\footnotesize\ttfamily uint16\+\_\+t interval} - -Interval value \Hypertarget{structpacked_a02f666cd85720a1af519b6a39c44b95a}\label{structpacked_a02f666cd85720a1af519b6a39c44b95a} -\index{packed@{packed}!ip@{ip}} -\index{ip@{ip}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ip}{ip}} -{\footnotesize\ttfamily uint8\+\_\+t ip} - -IP address \Hypertarget{structpacked_a44794759868576e0404c9cf629863797}\label{structpacked_a44794759868576e0404c9cf629863797} -\index{packed@{packed}!last\_msg\_time@{last\_msg\_time}} -\index{last\_msg\_time@{last\_msg\_time}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{last\_msg\_time}{last\_msg\_time}} -{\footnotesize\ttfamily time\+\_\+t last\+\_\+msg\+\_\+time} - -Last message time \Hypertarget{structpacked_a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d}\label{structpacked_a1fd97d69dc5fc2ad2bd7be4f1d6e1a3d} -\index{packed@{packed}!last\_sync@{last\_sync}} -\index{last\_sync@{last\_sync}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{last\_sync}{last\_sync}} -{\footnotesize\ttfamily uint64\+\_\+t last\+\_\+sync} - -Last synchronization timestamp \Hypertarget{structpacked_a569e06e92ec3d06c5ebf7f40d7f9a84e}\label{structpacked_a569e06e92ec3d06c5ebf7f40d7f9a84e} -\index{packed@{packed}!lifetime@{lifetime}} -\index{lifetime@{lifetime}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{lifetime}{lifetime}} -{\footnotesize\ttfamily uint32\+\_\+t lifetime} - -System lifetime \Hypertarget{structpacked_aa5f4b442eedc591f6e6e03787e6343bc}\label{structpacked_aa5f4b442eedc591f6e6e03787e6343bc} -\index{packed@{packed}!localization@{localization}} -\index{localization@{localization}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{localization}{localization}} -{\footnotesize\ttfamily char localization\mbox{[}8\mbox{]}} - -Localization \Hypertarget{structpacked_a5084f88290d959c1f5469ad840b599b5}\label{structpacked_a5084f88290d959c1f5469ad840b599b5} -\index{packed@{packed}!mac@{mac}} -\index{mac@{mac}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{mac}{mac}} -{\footnotesize\ttfamily uint8\+\_\+t mac} - -MAC address \Hypertarget{structpacked_ada50f0e7b89816d02459e3e520b018bf}\label{structpacked_ada50f0e7b89816d02459e3e520b018bf} -\index{packed@{packed}!mask@{mask}} -\index{mask@{mask}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{mask}{mask}} -{\footnotesize\ttfamily uint8\+\_\+t mask\mbox{[}4\mbox{]}} - -Subnet mask \Hypertarget{structpacked_ad10985b96579c7c2030050715bcad45d}\label{structpacked_ad10985b96579c7c2030050715bcad45d} -\index{packed@{packed}!method@{method}} -\index{method@{method}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{method}{method}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_ac7dd11f4b86517d5cd42e320c7d5b15e}{ciot\+\_\+httpc\+\_\+method\+\_\+t}} method} - -HTTP method \Hypertarget{structpacked_a7d76e224ede8a4fa709cc3a505a81975}\label{structpacked_a7d76e224ede8a4fa709cc3a505a81975} -\index{packed@{packed}!mode@{mode}} -\index{mode@{mode}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{mode}{mode}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_a823f059cc679fb8bde1970fe03627122}{ciot\+\_\+gpio\+\_\+mode\+\_\+t}} mode} - -Mode \Hypertarget{structpacked_a57eed7a24887f5d1adba0df0ca8f29f5}\label{structpacked_a57eed7a24887f5d1adba0df0ca8f29f5} -\index{packed@{packed}!mqtt@{mqtt}} -\index{mqtt@{mqtt}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{mqtt}{mqtt}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a3c806bc4b4ee2215fedf2e1def42983d}{ciot\+\_\+mqttc\+\_\+data\+\_\+u}} mqtt} - -MQTT client data \Hypertarget{structpacked_a1f1d5466bff3ee92c8a67e4b067159a2}\label{structpacked_a1f1d5466bff3ee92c8a67e4b067159a2} -\index{packed@{packed}!mqtt\_client@{mqtt\_client}} -\index{mqtt\_client@{mqtt\_client}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{mqtt\_client}{mqtt\_client}} -{\footnotesize\ttfamily uint16\+\_\+t mqtt\+\_\+client} - -MQTT client feature \Hypertarget{structpacked_abd6b36b1e2c07eaa53b376fdbf0e9345}\label{structpacked_abd6b36b1e2c07eaa53b376fdbf0e9345} -\index{packed@{packed}!msg@{msg}} -\index{msg@{msg}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{msg}{msg}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_ac8366b2c0571e1d0b3b9f61dd193f21c}{ciot\+\_\+msg\+\_\+t}} msg} - -CIOT message. \Hypertarget{structpacked_a2a544a28a9461b0de1f303ca407c459f}\label{structpacked_a2a544a28a9461b0de1f303ca407c459f} -\index{packed@{packed}!msg@{msg}} -\index{msg@{msg}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{msg}{msg}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint8\+\_\+t msg\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a52eaecd264e5b7ce58372236bc489086}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+MSG\+\_\+\+LEN}}\mbox{]}} - -MQTT message \Hypertarget{structpacked_a61e21da913274adbd45e28f694651b11}\label{structpacked_a61e21da913274adbd45e28f694651b11} -\index{packed@{packed}!msg\_type@{msg\_type}} -\index{msg\_type@{msg\_type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{msg\_type}{msg\_type}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a519d2e79d46983ef76576bc21bdb2bd0}{ciot\+\_\+msg\+\_\+type\+\_\+t}} msg\+\_\+type} - -Message type \Hypertarget{structpacked_a381f93ba5743e8813f554bda3c272257}\label{structpacked_a381f93ba5743e8813f554bda3c272257} -\index{packed@{packed}!node\_id@{node\_id}} -\index{node\_id@{node\_id}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{node\_id}{node\_id}} -{\footnotesize\ttfamily char node\+\_\+id\mbox{[}64\mbox{]}} - -Node ID \Hypertarget{structpacked_a562d7a6cdd9053ec0bf7431017972903}\label{structpacked_a562d7a6cdd9053ec0bf7431017972903} -\index{packed@{packed}!ntp@{ntp}} -\index{ntp@{ntp}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ntp}{ntp}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_a8508ff9b406ed496c100cd6374df7480}{ciot\+\_\+ntp\+\_\+data\+\_\+u}} ntp} - -NTP data \Hypertarget{structpacked_a34018b7bbca3d89088500ca3a47a66fd}\label{structpacked_a34018b7bbca3d89088500ca3a47a66fd} -\index{packed@{packed}!ntp@{ntp}} -\index{ntp@{ntp}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ntp}{ntp}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t ntp} - -NTP (Network Time Protocol) feature \Hypertarget{structpacked_a7beea8f6745c478347f244cadef771c2}\label{structpacked_a7beea8f6745c478347f244cadef771c2} -\index{packed@{packed}!num@{num}} -\index{num@{num}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{num}{num}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily uint32\+\_\+t num} - -Number \Hypertarget{structpacked_abea371f9030e15a5d2a4c181576833d8}\label{structpacked_abea371f9030e15a5d2a4c181576833d8} -\index{packed@{packed}!num@{num}} -\index{num@{num}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{num}{num}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint8\+\_\+t num} - -UART number \Hypertarget{structpacked_aec948fb30e99b1eda7e3d9ff741d417a}\label{structpacked_aec948fb30e99b1eda7e3d9ff741d417a} -\index{packed@{packed}!op\_mode@{op\_mode}} -\index{op\_mode@{op\_mode}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{op\_mode}{op\_mode}} -{\footnotesize\ttfamily uint8\+\_\+t op\+\_\+mode} - -Operation mode \Hypertarget{structpacked_a466cfd56b729d0efcfa70cff1a8b7b85}\label{structpacked_a466cfd56b729d0efcfa70cff1a8b7b85} -\index{packed@{packed}!ota@{ota}} -\index{ota@{ota}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ota}{ota}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_ac452af306a47644a27053323462de163}{ciot\+\_\+ota\+\_\+data\+\_\+u}} ota} - -OTA data \Hypertarget{structpacked_aa20473f3745555bec85f491e13188f4e}\label{structpacked_aa20473f3745555bec85f491e13188f4e} -\index{packed@{packed}!ota@{ota}} -\index{ota@{ota}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ota}{ota}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t ota} - -OTA (Over-\/\+The-\/\+Air) update feature \Hypertarget{structpacked_ae5290e95682932917ab6a7fd7897abb4}\label{structpacked_ae5290e95682932917ab6a7fd7897abb4} -\index{packed@{packed}!parity@{parity}} -\index{parity@{parity}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{parity}{parity}} -{\footnotesize\ttfamily uint16\+\_\+t parity} - -Parity \Hypertarget{structpacked_a0559811c61c36a1df8aa9ac0c4d56d53}\label{structpacked_a0559811c61c36a1df8aa9ac0c4d56d53} -\index{packed@{packed}!pass@{pass}} -\index{pass@{pass}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{pass}{pass}} -{\footnotesize\ttfamily char pass\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_ac313545fb49c7e509b76bf009b915b50}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+PASS\+\_\+\+LEN}}\mbox{]}} - -MQTT password \Hypertarget{structpacked_ae3a23efe266762659e03567d6afc26dd}\label{structpacked_ae3a23efe266762659e03567d6afc26dd} -\index{packed@{packed}!password@{password}} -\index{password@{password}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{password}{password}} -{\footnotesize\ttfamily char password\mbox{[}64\mbox{]}} - -Password \Hypertarget{structpacked_ace45f567511d3f9ff978c679ae38b5b0}\label{structpacked_ace45f567511d3f9ff978c679ae38b5b0} -\index{packed@{packed}!path@{path}} -\index{path@{path}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{path}{path}} -{\footnotesize\ttfamily char path\mbox{[}16\mbox{]}} - -File path \Hypertarget{structpacked_ab4f3fec57a517448f7d55021dbdbeba2}\label{structpacked_ab4f3fec57a517448f7d55021dbdbeba2} -\index{packed@{packed}!payload@{payload}} -\index{payload@{payload}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{payload}{payload}} -{\footnotesize\ttfamily uint8\+\_\+t payload} - -Payload data. - -Payload data \Hypertarget{structpacked_a3feeb7044549691a36c39cc7c9b2ed2c}\label{structpacked_a3feeb7044549691a36c39cc7c9b2ed2c} -\index{packed@{packed}!pin\_mask@{pin\_mask}} -\index{pin\_mask@{pin\_mask}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{pin\_mask}{pin\_mask}} -{\footnotesize\ttfamily uint64\+\_\+t pin\+\_\+mask} - -Pin mask \Hypertarget{structpacked_a83a04ad582de2b7d36b96f9db429c2c6}\label{structpacked_a83a04ad582de2b7d36b96f9db429c2c6} -\index{packed@{packed}!port@{port}} -\index{port@{port}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{port}{port}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily uint32\+\_\+t port} - -Port - -Port number \Hypertarget{structpacked_a83a04ad582de2b7d36b96f9db429c2c6}\label{structpacked_a83a04ad582de2b7d36b96f9db429c2c6} -\index{packed@{packed}!port@{port}} -\index{port@{port}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{port}{port}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint32\+\_\+t port} - -MQTT port - -Port number \Hypertarget{structpacked_a778eb3ed59eb3397b9efad8d48d34b62}\label{structpacked_a778eb3ed59eb3397b9efad8d48d34b62} -\index{packed@{packed}!proxy\_msg@{proxy\_msg}} -\index{proxy\_msg@{proxy\_msg}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{proxy\_msg}{proxy\_msg}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a14b8314f1fa07b94542d824f3d58ac69}{ciot\+\_\+req\+\_\+proxy\+\_\+msg\+\_\+t}} proxy\+\_\+msg} - -Proxy message request data \Hypertarget{structpacked_ae7b5bde19c99952b5a737b600f3c21e6}\label{structpacked_ae7b5bde19c99952b5a737b600f3c21e6} -\index{packed@{packed}!publish@{publish}} -\index{publish@{publish}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{publish}{publish}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a07954226247942ae3c365ee4da3a5f4b}{ciot\+\_\+mqttc\+\_\+req\+\_\+publish\+\_\+t}} publish} - -Publish request data \Hypertarget{structpacked_a5ee68c0e31fa06f342fad371023bdc4e}\label{structpacked_a5ee68c0e31fa06f342fad371023bdc4e} -\index{packed@{packed}!pull@{pull}} -\index{pull@{pull}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{pull}{pull}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_a5353b26458c680242066bf2976ca0fa4}{ciot\+\_\+gpio\+\_\+pull\+\_\+mode\+\_\+t}} pull} - -Pull mode \Hypertarget{structpacked_a65ee2b4b16f25052c441ff9959dcc7e7}\label{structpacked_a65ee2b4b16f25052c441ff9959dcc7e7} -\index{packed@{packed}!qos@{qos}} -\index{qos@{qos}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{qos}{qos}} -{\footnotesize\ttfamily uint8\+\_\+t qos} - -MQTT quality of service - -Quality of service \Hypertarget{structpacked_a4fff0375f4b234a60fcd5e6723d9c8a9}\label{structpacked_a4fff0375f4b234a60fcd5e6723d9c8a9} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [1/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_a1ff36c6a0e92073157e4e6db1a68c13b}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_a6aeefeee1b018d7d77c41f66f6015cf9}\label{structpacked_a6aeefeee1b018d7d77c41f66f6015cf9} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [2/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_a507c363eda1cdff6ff3e30807c34cf25}{ciot\+\_\+ble\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_a21b1ec52268024ae8c4b0eca1dc2a491}\label{structpacked_a21b1ec52268024ae8c4b0eca1dc2a491} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [3/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_ade176fed03561c5c5800a3e425ba0728}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_a8342e156b9596a1154ff4ce550adb30f}\label{structpacked_a8342e156b9596a1154ff4ce550adb30f} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [4/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_ade96f01f5205b28cd03f71300b4b121a}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_aeec32200114264e8556110d5c2ffc44c}\label{structpacked_aeec32200114264e8556110d5c2ffc44c} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [5/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_a94941fed93d460349e5b6a4471910c1b}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_ac3fb50fe28f5e2ea50c6f662aa19beca}\label{structpacked_ac3fb50fe28f5e2ea50c6f662aa19beca} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [6/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_abd54692515f23a32c3adbeaf2310f0d8}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_a57c784a27da9399f6d1a7bd2122a3c65}\label{structpacked_a57c784a27da9399f6d1a7bd2122a3c65} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [7/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a9f6479442d8891c33f6b16d1f7c090ed}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_af4b02bc60804013ff8623f078ec43efe}\label{structpacked_af4b02bc60804013ff8623f078ec43efe} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [8/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_a684d3d6198069ef8c4084f197d00968a}{ciot\+\_\+https\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{structpacked_af4d809ae5adfaf23b4229995212f0ded}\label{structpacked_af4d809ae5adfaf23b4229995212f0ded} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [9/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_ac93643bb92edae40c419fb1d3b7ed444}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{structpacked_a0a55111acf65b88d386268c615a69499}\label{structpacked_a0a55111acf65b88d386268c615a69499} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [10/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_adb3b9e40223505389621e54062d4d67d}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} request} - -NTP request \Hypertarget{structpacked_a66e033d989ec031368788f08deba7feb}\label{structpacked_a66e033d989ec031368788f08deba7feb} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [11/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_a0fb4cfd7bd281429f1ac9b129ee08148}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} request} - -OPC UA Server request \Hypertarget{structpacked_a4e22c6ea4c9d8fad6bbd0d3894c82627}\label{structpacked_a4e22c6ea4c9d8fad6bbd0d3894c82627} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [12/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_aaf0b6171ec4a1f2bfa2eb3b37aabda45}{ciot\+\_\+ota\+\_\+req\+\_\+t}} request} - -OTA request \Hypertarget{structpacked_ae35bc5d21998e1401aa886359cafd044}\label{structpacked_ae35bc5d21998e1401aa886359cafd044} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [13/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a6cf1904dcacbf10aa82f0b00209cce7e}{ciot\+\_\+storage\+\_\+req\+\_\+t}} request} - -Storage request \Hypertarget{structpacked_a7146ff86f43fac1f87c45f31c3a3bd20}\label{structpacked_a7146ff86f43fac1f87c45f31c3a3bd20} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [14/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a3eeb20290c9050c851dfd5b90c91fddc}{ciot\+\_\+sys\+\_\+req\+\_\+t}} request} - -System request \Hypertarget{structpacked_aaf3b24e7b5d38ca3f76ca38e5e43ad7e}\label{structpacked_aaf3b24e7b5d38ca3f76ca38e5e43ad7e} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [15/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a9a92bafd6999ad2c9229af4d11a606dc}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} request} - -TCP request \Hypertarget{structpacked_a8975b1b5a295a8ee8669dfcce942dcd5}\label{structpacked_a8975b1b5a295a8ee8669dfcce942dcd5} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [16/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a2447b2be2fbce5ae85a0a2441887b04c}{ciot\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{structpacked_aeac55f9a4429aa466599b8875763ff38}\label{structpacked_aeac55f9a4429aa466599b8875763ff38} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [17/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_ad06e49ddd42e711bfaf23efcc4cfb227}{ciot\+\_\+uart\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{structpacked_aebb2adef59fcdc91db3d185996066c6a}\label{structpacked_aebb2adef59fcdc91db3d185996066c6a} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [18/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_a51b485c991167b9b599cb94a6922138c}{ciot\+\_\+usb\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{structpacked_a95d1196af9ebc0b64f6f7e2842812448}\label{structpacked_a95d1196af9ebc0b64f6f7e2842812448} -\index{packed@{packed}!request@{request}} -\index{request@{request}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{request}{request}\hspace{0.1cm}{\footnotesize\ttfamily [19/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a7672a0bfaa531684471175c3c46b2c6f}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{structpacked_ac6c17ab632a9c78bc9fa846e9baeea7b}\label{structpacked_ac6c17ab632a9c78bc9fa846e9baeea7b} -\index{packed@{packed}!reserve@{reserve}} -\index{reserve@{reserve}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{reserve}{reserve}} -{\footnotesize\ttfamily uint8\+\_\+t reserve} - -Reserved bits \Hypertarget{structpacked_acb7bc06bed6f6408d719334fc41698c7}\label{structpacked_acb7bc06bed6f6408d719334fc41698c7} -\index{packed@{packed}!reserved@{reserved}} -\index{reserved@{reserved}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{reserved}{reserved}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily uint8\+\_\+t reserved} - -Reserved bits \Hypertarget{structpacked_a5a6ed8c04a3db86066924b1a1bf4dad3}\label{structpacked_a5a6ed8c04a3db86066924b1a1bf4dad3} -\index{packed@{packed}!reserved@{reserved}} -\index{reserved@{reserved}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{reserved}{reserved}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t reserved} - -Reserved bits \Hypertarget{structpacked_a63de528fa8d98b79adfe7f9f68880c17}\label{structpacked_a63de528fa8d98b79adfe7f9f68880c17} -\index{packed@{packed}!restart@{restart}} -\index{restart@{restart}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{restart}{restart}} -{\footnotesize\ttfamily uint8\+\_\+t restart} - -Flag for restarting after update \Hypertarget{structpacked_a90808ce2b0f0710bbe9799c64e8df0db}\label{structpacked_a90808ce2b0f0710bbe9799c64e8df0db} -\index{packed@{packed}!result@{result}} -\index{result@{result}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{result}{result}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a3a49770e58a83e77136fda7bed12af91}{ciot\+\_\+req\+\_\+result\+\_\+t}} result} - -Request result data \Hypertarget{structpacked_a98bcbc9e1ebf74ba486f246d76f5bac1}\label{structpacked_a98bcbc9e1ebf74ba486f246d76f5bac1} -\index{packed@{packed}!route@{route}} -\index{route@{route}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{route}{route}} -{\footnotesize\ttfamily char route\mbox{[}\mbox{\hyperlink{ciot__https__types_8h_a8b84b36e97ad2c3a2e7ac72e4d6b2749}{CIOT\+\_\+\+HTTPS\+\_\+\+ROUTE\+\_\+\+LEN}}\mbox{]}} - -Route \Hypertarget{structpacked_a3b962e67ba74725bd60ca3c29f785abe}\label{structpacked_a3b962e67ba74725bd60ca3c29f785abe} -\index{packed@{packed}!rssi@{rssi}} -\index{rssi@{rssi}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{rssi}{rssi}} -{\footnotesize\ttfamily int8\+\_\+t rssi} - -RSSI value - -RSSI \Hypertarget{structpacked_acc644e0c68521fc2c21bdf5acb5f5812}\label{structpacked_acc644e0c68521fc2c21bdf5acb5f5812} -\index{packed@{packed}!rst\_count@{rst\_count}} -\index{rst\_count@{rst\_count}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{rst\_count}{rst\_count}} -{\footnotesize\ttfamily uint8\+\_\+t rst\+\_\+count} - -Restart count \Hypertarget{structpacked_aa4f71758f86d92d3ae60a541335f579d}\label{structpacked_aa4f71758f86d92d3ae60a541335f579d} -\index{packed@{packed}!rst\_reason@{rst\_reason}} -\index{rst\_reason@{rst\_reason}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{rst\_reason}{rst\_reason}} -{\footnotesize\ttfamily uint8\+\_\+t rst\+\_\+reason} - -Restart reason \Hypertarget{structpacked_a3c82534f71c473adbf7fa380db7badc2}\label{structpacked_a3c82534f71c473adbf7fa380db7badc2} -\index{packed@{packed}!rts\_pin@{rts\_pin}} -\index{rts\_pin@{rts\_pin}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{rts\_pin}{rts\_pin}} -{\footnotesize\ttfamily int8\+\_\+t rts\+\_\+pin} - -RTS pin \Hypertarget{structpacked_ab461fda70a78750930429bcc68db5a98}\label{structpacked_ab461fda70a78750930429bcc68db5a98} -\index{packed@{packed}!rx\_pin@{rx\_pin}} -\index{rx\_pin@{rx\_pin}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{rx\_pin}{rx\_pin}} -{\footnotesize\ttfamily int8\+\_\+t rx\+\_\+pin} - -RX pin \Hypertarget{structpacked_af24d10404fe7693abc12d43b4edea249}\label{structpacked_af24d10404fe7693abc12d43b4edea249} -\index{packed@{packed}!save\_iface\_cfg@{save\_iface\_cfg}} -\index{save\_iface\_cfg@{save\_iface\_cfg}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{save\_iface\_cfg}{save\_iface\_cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_acfbe12a2ec8eba54fb5039db68d0f708}{ciot\+\_\+req\+\_\+save\+\_\+iface\+\_\+cfg\+\_\+t}} save\+\_\+iface\+\_\+cfg} - -Save interface configuration request data \Hypertarget{structpacked_a23723a81650d6544d7da572eb4bf33b9}\label{structpacked_a23723a81650d6544d7da572eb4bf33b9} -\index{packed@{packed}!scan\_result@{scan\_result}} -\index{scan\_result@{scan\_result}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{scan\_result}{scan\_result}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_aab66103615da49426d9475a0216fa2e5}{ciot\+\_\+wifi\+\_\+scan\+\_\+result\+\_\+t}} scan\+\_\+result} - -Wi\+Fi scan result \Hypertarget{structpacked_a64001c4b28083877216a64df74dff823}\label{structpacked_a64001c4b28083877216a64df74dff823} -\index{packed@{packed}!send\_data@{send\_data}} -\index{send\_data@{send\_data}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{send\_data}{send\_data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a7e0448049ed056aac193026e6db7f8b6}{ciot\+\_\+uart\+\_\+req\+\_\+send\+\_\+data\+\_\+t}} send\+\_\+data} - -Send data request data \Hypertarget{structpacked_a720e2a2aba3a8aa7ec09162d3a522d60}\label{structpacked_a720e2a2aba3a8aa7ec09162d3a522d60} -\index{packed@{packed}!serializer@{serializer}} -\index{serializer@{serializer}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{serializer}{serializer}} -{\footnotesize\ttfamily uint16\+\_\+t serializer} - -Serializer feature \Hypertarget{structpacked_ab80672fab5b8d7864411603053aaffa4}\label{structpacked_ab80672fab5b8d7864411603053aaffa4} -\index{packed@{packed}!server@{server}} -\index{server@{server}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{server}{server}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily char server\mbox{[}\mbox{\hyperlink{ciot__default_8h_ab853f3aa6a7e0229c80b1f5a4fae0fbf}{CIOT\+\_\+\+CONFIG\+\_\+\+NTP\+\_\+\+SERVERS\+\_\+\+COUNT}}\mbox{]}\mbox{[}64\mbox{]}} - -NTP servers \Hypertarget{structpacked_afdb30da7a1b29e70c8b5051adcaf649b}\label{structpacked_afdb30da7a1b29e70c8b5051adcaf649b} -\index{packed@{packed}!server@{server}} -\index{server@{server}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{server}{server}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a7f05e1346cbd89193fe25fb8ca3617f7}{ciot\+\_\+tcp\+\_\+dhcp\+\_\+state\+\_\+t}} server} - -DHCP server state \Hypertarget{structpacked_a62a0efca13351bcf8980bde96c09854e}\label{structpacked_a62a0efca13351bcf8980bde96c09854e} -\index{packed@{packed}!set\_mac@{set\_mac}} -\index{set\_mac@{set\_mac}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{set\_mac}{set\_mac}} -{\footnotesize\ttfamily uint8\+\_\+t set\+\_\+mac\mbox{[}6\mbox{]}} - -Set MAC data \Hypertarget{structpacked_a5cc92c2a01be84c116055f80d77e5140}\label{structpacked_a5cc92c2a01be84c116055f80d77e5140} -\index{packed@{packed}!set\_state@{set\_state}} -\index{set\_state@{set\_state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{set\_state}{set\_state}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ac481a1b453d60c67133f9a95561ac0d2}{ciot\+\_\+gpio\+\_\+state\+\_\+info\+\_\+t}} set\+\_\+state} - -Set state information \Hypertarget{structpacked_ae5dc6ffcd9b7605c7787791e40cc6bb0}\label{structpacked_ae5dc6ffcd9b7605c7787791e40cc6bb0} -\index{packed@{packed}!size@{size}} -\index{size@{size}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{size}{size}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} -{\footnotesize\ttfamily uint8\+\_\+t size} - -Size of the event data. - -Message size - -Data size \Hypertarget{structpacked_a439227feff9d7f55384e8780cfc2eb82}\label{structpacked_a439227feff9d7f55384e8780cfc2eb82} -\index{packed@{packed}!size@{size}} -\index{size@{size}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{size}{size}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} -{\footnotesize\ttfamily int size} - -Size of message \Hypertarget{structpacked_ae5dc6ffcd9b7605c7787791e40cc6bb0}\label{structpacked_ae5dc6ffcd9b7605c7787791e40cc6bb0} -\index{packed@{packed}!size@{size}} -\index{size@{size}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{size}{size}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} -{\footnotesize\ttfamily uint8\+\_\+t size} - -Data size \Hypertarget{structpacked_a431ea94992ad903ffe97cf85b3763ab0}\label{structpacked_a431ea94992ad903ffe97cf85b3763ab0} -\index{packed@{packed}!ssid@{ssid}} -\index{ssid@{ssid}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{ssid}{ssid}} -{\footnotesize\ttfamily char ssid} - -SSID \Hypertarget{structpacked_a9b3c50f82a67373296513704001266bb}\label{structpacked_a9b3c50f82a67373296513704001266bb} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [1/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_a6fe0f15cfea3b1febe65bac76c170e39}{ciot\+\_\+ble\+\_\+scn\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_aa5d08015bd3ed92217c40487bd42e433}\label{structpacked_aa5d08015bd3ed92217c40487bd42e433} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [2/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_ab3295ccbe32deefbca1e21f16254c6f6}{ciot\+\_\+ble\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_a75d538f4bd5c29ec545f1e37dae43f0e}\label{structpacked_a75d538f4bd5c29ec545f1e37dae43f0e} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [3/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_a16f08addb892c1ae0f1a82445cc9777e}{ciot\+\_\+bridge\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_a350c6a3720c9b7d1b3300e38430117e7}\label{structpacked_a350c6a3720c9b7d1b3300e38430117e7} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [4/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_acb357b6adaf4fd6f6d754d9aa2825571}{ciot\+\_\+data\+\_\+model\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_a587d059d905fdf8cceb8643720812de4}\label{structpacked_a587d059d905fdf8cceb8643720812de4} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [5/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_af34028f666fa4c0113b0fa0bfbfbefeb}{ciot\+\_\+dfu\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_a939fe9a85b37a0ce4a0701b655c799ea}\label{structpacked_a939fe9a85b37a0ce4a0701b655c799ea} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [6/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_a8d5e9ed96129b8e9037b2151957bc140}{ciot\+\_\+gpio\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_a37c663f5a0040d827e450c52efe59882}\label{structpacked_a37c663f5a0040d827e450c52efe59882} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [7/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a4096719d317fa183409fb8c8c2c373a3}{ciot\+\_\+httpc\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_a28c09b101362530d97e51b712b741f63}\label{structpacked_a28c09b101362530d97e51b712b741f63} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [8/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_a89e9a1e11014985783ee949b6ae43a0b}{ciot\+\_\+https\+\_\+state\+\_\+t}} state} - -State \Hypertarget{structpacked_a28daf783134e0bed0e611de3ea451e4a}\label{structpacked_a28daf783134e0bed0e611de3ea451e4a} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [9/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_ae298cb176ef6424532a9092d71dbf242}{ciot\+\_\+mqttc\+\_\+state\+\_\+t}} state} - -MQTT client state \Hypertarget{structpacked_a28ce8249c3bcacad6a7698b7697739b8}\label{structpacked_a28ce8249c3bcacad6a7698b7697739b8} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [10/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_a5cf1c811a4381df356837f1b7e5b9cee}{ciot\+\_\+ntp\+\_\+state\+\_\+t}} state} - -NTP state \Hypertarget{structpacked_a584e26c042d8a98bf6161b7aa27ba4cf}\label{structpacked_a584e26c042d8a98bf6161b7aa27ba4cf} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [11/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_a93530965d3e3611bb7b821c606b1a7bd}{ciot\+\_\+opcuas\+\_\+state\+\_\+t}} state} - -OPC UA Server state \Hypertarget{structpacked_a796f1aeb4c800b653ee018b20c818804}\label{structpacked_a796f1aeb4c800b653ee018b20c818804} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [12/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_a7bbfc7a06831f7244a0008a085046bb1}{ciot\+\_\+ota\+\_\+state\+\_\+t}} state} - -OTA state \Hypertarget{structpacked_aabc97b8fe1b1624b67ee7bc472d5b0b0}\label{structpacked_aabc97b8fe1b1624b67ee7bc472d5b0b0} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [13/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a3c7a971dfa6df181c9d30f5ee90e18ab}{ciot\+\_\+storage\+\_\+state\+\_\+t}} state} - -Storage state \Hypertarget{structpacked_a771cb8893000d5d94fc8bc2d21347412}\label{structpacked_a771cb8893000d5d94fc8bc2d21347412} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [14/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a0cef319e1c591fef1f183c5f38405f28}{ciot\+\_\+tcp\+\_\+state\+\_\+t}} state} - -TCP state \Hypertarget{structpacked_ab3a7653fc8a3bfebedb322cceec24c38}\label{structpacked_ab3a7653fc8a3bfebedb322cceec24c38} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [15/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a761a6a322d1df76417eabd409388e765}{ciot\+\_\+state\+\_\+t}} state} - -CIOT state \Hypertarget{structpacked_a00c2e8ab24db2cabd968dcd6aa86a7c3}\label{structpacked_a00c2e8ab24db2cabd968dcd6aa86a7c3} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [16/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a379e740e1f6e093f3171f683e37edb46}{ciot\+\_\+uart\+\_\+state\+\_\+t}} state} - -UART state \Hypertarget{structpacked_a3442f594ec1fc76781d93b1a28b55cba}\label{structpacked_a3442f594ec1fc76781d93b1a28b55cba} -\index{packed@{packed}!state@{state}} -\index{state@{state}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{state}{state}\hspace{0.1cm}{\footnotesize\ttfamily [17/17]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_adc042f264191411a452df2234c1259d4}{ciot\+\_\+usb\+\_\+state\+\_\+t}} state} - -USB state \Hypertarget{structpacked_a09cb5a4aa60e39d810f1c21089103503}\label{structpacked_a09cb5a4aa60e39d810f1c21089103503} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [1/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a8f1461812fa7d3f5a1d891fef3b83a57}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} status} - -BLE status - -Status - -TCP status - -Status data - -NTP status - -OPC UA Server status - -OTA status - -Storage status - -System status \Hypertarget{structpacked_aa7ad441170fdff42b419665a6652a09f}\label{structpacked_aa7ad441170fdff42b419665a6652a09f} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [2/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_ab0eb15151a41b8a487ddebd49457a272}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} status} - -BLE scanner status - -Status \Hypertarget{structpacked_ab50a6b7e2887ecb6625b540edae99138}\label{structpacked_ab50a6b7e2887ecb6625b540edae99138} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [3/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_ad43e78cb02839dcd178e2b32922b0ebd}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} status} - -Bridge status - -Status \Hypertarget{structpacked_a9fb48f785812375d586c71a02b453e64}\label{structpacked_a9fb48f785812375d586c71a02b453e64} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [4/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_afd48b494cf6b8f85fe80130aeb21d624}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} status} - -Status of the DFU operation. - -Status \Hypertarget{structpacked_a290455b77155aab0d086fb8c69f76364}\label{structpacked_a290455b77155aab0d086fb8c69f76364} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [5/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_aaecc680c841484771c1b04ae62f7de6e}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} status} - -TCP status. - -TCP status \Hypertarget{structpacked_af7b93aeb68c1648ccb2617ff8217e7b0}\label{structpacked_af7b93aeb68c1648ccb2617ff8217e7b0} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [6/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_afffcff4ee1824ad4fdcb57626c37b98f}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} status} - -GPIO status. - -Status \Hypertarget{structpacked_ac5c1eb82650b9d0161a399175c459ad3}\label{structpacked_ac5c1eb82650b9d0161a399175c459ad3} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [7/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a564b9c4a182a8f6246f70b28b6aab6a4}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} status} - -HTTP client status. - -Status \Hypertarget{structpacked_ae71d44b4ec9b04f2b3eb183ae791f6ca}\label{structpacked_ae71d44b4ec9b04f2b3eb183ae791f6ca} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [8/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_afbbf86e234bfeb73c639ea5c7fc89d5a}{ciot\+\_\+https\+\_\+status\+\_\+t}} status} - -HTTP server status. - -Status \Hypertarget{structpacked_a0bd4162002c890f2775878d4da138c03}\label{structpacked_a0bd4162002c890f2775878d4da138c03} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [9/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a8b57d3db91385a3c5383531fd5eb999a}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} status} - -MQTT client status. - -Status data \Hypertarget{structpacked_a95d5fa474c00a79ee883e78048ea7c4c}\label{structpacked_a95d5fa474c00a79ee883e78048ea7c4c} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [10/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_a2460e85462928503379907d9d6e15718}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} status} - -NTP status. - -NTP status \Hypertarget{structpacked_ac3be6c0c62c2999a9dd9fa0099945876}\label{structpacked_ac3be6c0c62c2999a9dd9fa0099945876} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [11/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_a3bb6c01197e5a26a19e66339acf44a8f}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} status} - -OPCUAS status. - -OPC UA Server status \Hypertarget{structpacked_a86de670b32fc6ad5c7a44fefb41e6e3a}\label{structpacked_a86de670b32fc6ad5c7a44fefb41e6e3a} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [12/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_a60db3988c822f5f5479928ba9c1d8e53}{ciot\+\_\+ota\+\_\+status\+\_\+t}} status} - -OTA status. - -OTA status \Hypertarget{structpacked_ac1a66aa256f203858bb2477b812e36fb}\label{structpacked_ac1a66aa256f203858bb2477b812e36fb} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [13/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a6990561e69999a83a97f34e225c9b335}{ciot\+\_\+storage\+\_\+status\+\_\+t}} status} - -Storage status \Hypertarget{structpacked_ad3dbfc73fddab4d58bde12f27edab41b}\label{structpacked_ad3dbfc73fddab4d58bde12f27edab41b} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [14/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a22f15bbe83314779e819248e5f1a1a7b}{ciot\+\_\+sys\+\_\+status\+\_\+t}} status} - -System status \Hypertarget{structpacked_aa311cb42bbd477c3bfd5371dd0b8bedd}\label{structpacked_aa311cb42bbd477c3bfd5371dd0b8bedd} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [15/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a96c14238164bc11945633bdd70387309}{ciot\+\_\+uart\+\_\+status\+\_\+t}} status} - -Status information - -Status data \Hypertarget{structpacked_ab26791741e383cec2107fa1540a14342}\label{structpacked_ab26791741e383cec2107fa1540a14342} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [16/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_a77dcad2d6b3eb46be679b0b7c023b2c9}{ciot\+\_\+usb\+\_\+status\+\_\+t}} status} - -Status information - -Status data \Hypertarget{structpacked_a09cb5a4aa60e39d810f1c21089103503}\label{structpacked_a09cb5a4aa60e39d810f1c21089103503} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [17/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a8f1461812fa7d3f5a1d891fef3b83a57}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} status} - - - -Wi-\/\+Fi status. - -Status data \Hypertarget{structpacked_a3f4172ed60af91f49f998cde97dd28cb}\label{structpacked_a3f4172ed60af91f49f998cde97dd28cb} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [18/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_ac6570d06779555f9d5ef10c92ff79bd2}{ciot\+\_\+data\+\_\+model\+\_\+status\+\_\+t}} status} - -Status \Hypertarget{structpacked_ac4db33ce66ac8ec09d4b5b088eb88ead}\label{structpacked_ac4db33ce66ac8ec09d4b5b088eb88ead} -\index{packed@{packed}!status@{status}} -\index{status@{status}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status}{status}\hspace{0.1cm}{\footnotesize\ttfamily [19/19]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_af97e5c236fd3ba09dc3c0d8d64db6492}{ciot\+\_\+status\+\_\+t}} status} - -Status data \Hypertarget{structpacked_af557caa253a733e218e1e71c2a91eef4}\label{structpacked_af557caa253a733e218e1e71c2a91eef4} -\index{packed@{packed}!status\_mask@{status\_mask}} -\index{status\_mask@{status\_mask}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{status\_mask}{status\_mask}} -{\footnotesize\ttfamily uint64\+\_\+t status\+\_\+mask} - -Status mask \Hypertarget{structpacked_a4c64bed640d14af56502dd8dceb9ab20}\label{structpacked_a4c64bed640d14af56502dd8dceb9ab20} -\index{packed@{packed}!storage@{storage}} -\index{storage@{storage}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{storage}{storage}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_ab2ccb7172389ac0c0e35c3ca1b1cf385}{ciot\+\_\+storage\+\_\+data\+\_\+u}} storage} - -Storage data \Hypertarget{structpacked_ab8549384ff6a90d5fedec40cd3535ebf}\label{structpacked_ab8549384ff6a90d5fedec40cd3535ebf} -\index{packed@{packed}!storage@{storage}} -\index{storage@{storage}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{storage}{storage}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t storage} - -Storage feature \Hypertarget{structpacked_a061e16f43670bc7f5d29c3971b4088c3}\label{structpacked_a061e16f43670bc7f5d29c3971b4088c3} -\index{packed@{packed}!subscribe@{subscribe}} -\index{subscribe@{subscribe}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{subscribe}{subscribe}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_ab88409e0f45bc860164159a2db15e903}{ciot\+\_\+mqttc\+\_\+req\+\_\+subscribe\+\_\+t}} subscribe} - -Subscribe request data \Hypertarget{structpacked_aeb930ea2d960351877d7ef0a126173ff}\label{structpacked_aeb930ea2d960351877d7ef0a126173ff} -\index{packed@{packed}!sw@{sw}} -\index{sw@{sw}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{sw}{sw}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a86b848978871af9156529a213a7b2964}{ciot\+\_\+sys\+\_\+sw\+\_\+features\+\_\+t}} sw} - -Software features \Hypertarget{structpacked_a21008d923a4d8cacdc7622aae81197aa}\label{structpacked_a21008d923a4d8cacdc7622aae81197aa} -\index{packed@{packed}!sw\_mac@{sw\_mac}} -\index{sw\_mac@{sw\_mac}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{sw\_mac}{sw\_mac}} -{\footnotesize\ttfamily uint8\+\_\+t sw\+\_\+mac\mbox{[}6\mbox{]}} - -Software MAC address \Hypertarget{structpacked_adb4b09387463cd61bf8f7217366310ef}\label{structpacked_adb4b09387463cd61bf8f7217366310ef} -\index{packed@{packed}!sync@{sync}} -\index{sync@{sync}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{sync}{sync}} -{\footnotesize\ttfamily uint8\+\_\+t sync} - -Sync flag \Hypertarget{structpacked_a69671f26529c8f6076d53b96a1e1627f}\label{structpacked_a69671f26529c8f6076d53b96a1e1627f} -\index{packed@{packed}!sync\_count@{sync\_count}} -\index{sync\_count@{sync\_count}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{sync\_count}{sync\_count}} -{\footnotesize\ttfamily uint16\+\_\+t sync\+\_\+count} - -Synchronization count \Hypertarget{structpacked_a5150de065f0b170644b21514c7530542}\label{structpacked_a5150de065f0b170644b21514c7530542} -\index{packed@{packed}!sync\_interval@{sync\_interval}} -\index{sync\_interval@{sync\_interval}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{sync\_interval}{sync\_interval}} -{\footnotesize\ttfamily uint32\+\_\+t sync\+\_\+interval} - -Sync interval \Hypertarget{structpacked_ac752937b32320cf191fe3abd0e8daed6}\label{structpacked_ac752937b32320cf191fe3abd0e8daed6} -\index{packed@{packed}!sync\_mode@{sync\_mode}} -\index{sync\_mode@{sync\_mode}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{sync\_mode}{sync\_mode}} -{\footnotesize\ttfamily uint8\+\_\+t sync\+\_\+mode} - -Sync mode \Hypertarget{structpacked_a04c7e159105631b657e5b65f977a2c4a}\label{structpacked_a04c7e159105631b657e5b65f977a2c4a} -\index{packed@{packed}!system@{system}} -\index{system@{system}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{system}{system}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_aa586541b31ba598322ba3a51fc0367e2}{ciot\+\_\+sys\+\_\+data\+\_\+u}} system} - -System data \Hypertarget{structpacked_a2e90afcc174ac8d99edf7229774986db}\label{structpacked_a2e90afcc174ac8d99edf7229774986db} -\index{packed@{packed}!system@{system}} -\index{system@{system}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{system}{system}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t system} - -System feature \Hypertarget{structpacked_a2744efd5cf43b6d40d61ea66f7f620d3}\label{structpacked_a2744efd5cf43b6d40d61ea66f7f620d3} -\index{packed@{packed}!tcp@{tcp}} -\index{tcp@{tcp}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{tcp}{tcp}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a33ef59c41d0f68ebb4e062d425da2d50}{ciot\+\_\+tcp\+\_\+data\+\_\+u}} tcp} - -TCP data \Hypertarget{structpacked_afa68a8b5194df4f630408f99085e4ab8}\label{structpacked_afa68a8b5194df4f630408f99085e4ab8} -\index{packed@{packed}!tcp@{tcp}} -\index{tcp@{tcp}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{tcp}{tcp}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_ac80e90daf748eaa0b4e1d1732125cdd0}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} tcp} - -TCP configuration \Hypertarget{structpacked_ac4061ebe19bc469e9a7569aa132010a8}\label{structpacked_ac4061ebe19bc469e9a7569aa132010a8} -\index{packed@{packed}!tcp@{tcp}} -\index{tcp@{tcp}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{tcp}{tcp}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_aaecc680c841484771c1b04ae62f7de6e}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} tcp} - -TCP status \Hypertarget{structpacked_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae}\label{structpacked_a7f1ad43d3bf79b40bc39dbb5a6c3a5ae} -\index{packed@{packed}!timeout@{timeout}} -\index{timeout@{timeout}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{timeout}{timeout}} -{\footnotesize\ttfamily uint16\+\_\+t timeout} - -Timeout value - -Timeout \Hypertarget{structpacked_aea00c2c1dec6e8f58532f25c65210d9e}\label{structpacked_aea00c2c1dec6e8f58532f25c65210d9e} -\index{packed@{packed}!timer@{timer}} -\index{timer@{timer}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{timer}{timer}} -{\footnotesize\ttfamily uint16\+\_\+t timer} - -Timer feature \Hypertarget{structpacked_a4dc1e4fba8f7fec6b1579961829b34f7}\label{structpacked_a4dc1e4fba8f7fec6b1579961829b34f7} -\index{packed@{packed}!timezone@{timezone}} -\index{timezone@{timezone}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{timezone}{timezone}} -{\footnotesize\ttfamily char timezone\mbox{[}16\mbox{]}} - -Timezone \Hypertarget{structpacked_abde2f3e27511cfb7307766339fed98e9}\label{structpacked_abde2f3e27511cfb7307766339fed98e9} -\index{packed@{packed}!tls\_cert\_verify\_flags@{tls\_cert\_verify\_flags}} -\index{tls\_cert\_verify\_flags@{tls\_cert\_verify\_flags}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{tls\_cert\_verify\_flags}{tls\_cert\_verify\_flags}} -{\footnotesize\ttfamily int tls\+\_\+cert\+\_\+verify\+\_\+flags} - -TLS certificate verification flags \Hypertarget{structpacked_af8b9db3223039d525df4371413d3c2f3}\label{structpacked_af8b9db3223039d525df4371413d3c2f3} -\index{packed@{packed}!tls\_last\_err@{tls\_last\_err}} -\index{tls\_last\_err@{tls\_last\_err}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{tls\_last\_err}{tls\_last\_err}} -{\footnotesize\ttfamily int tls\+\_\+last\+\_\+err} - -Last TLS error \Hypertarget{structpacked_a9006960d969e505489e2a46434d60ebb}\label{structpacked_a9006960d969e505489e2a46434d60ebb} -\index{packed@{packed}!tls\_stack\_err@{tls\_stack\_err}} -\index{tls\_stack\_err@{tls\_stack\_err}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{tls\_stack\_err}{tls\_stack\_err}} -{\footnotesize\ttfamily int tls\+\_\+stack\+\_\+err} - -TLS stack error \Hypertarget{structpacked_ae14de85dbf4b99a847daee53083331cb}\label{structpacked_ae14de85dbf4b99a847daee53083331cb} -\index{packed@{packed}!topic@{topic}} -\index{topic@{topic}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{topic}{topic}} -{\footnotesize\ttfamily char topic} - -MQTT topic \Hypertarget{structpacked_a2a5888184d23c617efb05a871a705673}\label{structpacked_a2a5888184d23c617efb05a871a705673} -\index{packed@{packed}!topics@{topics}} -\index{topics@{topics}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{topics}{topics}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_a6795bc471854cafb8d3fd93073151c87}{ciot\+\_\+mqttc\+\_\+topics\+\_\+cfg\+\_\+t}} topics} - -MQTT topics configuration \Hypertarget{structpacked_a7e007ade3b5b7cfcc2ee06d35d52d4e1}\label{structpacked_a7e007ade3b5b7cfcc2ee06d35d52d4e1} -\index{packed@{packed}!transport@{transport}} -\index{transport@{transport}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{transport}{transport}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a3d85386d7caa5c9c925042f58586789f}{ciot\+\_\+httpc\+\_\+transport\+\_\+type\+\_\+t}} transport} - -Transport type \Hypertarget{structpacked_addf4bba19daf5bd5b49b033e239931da}\label{structpacked_addf4bba19daf5bd5b49b033e239931da} -\index{packed@{packed}!transport@{transport}} -\index{transport@{transport}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{transport}{transport}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_afd743a10fc2e70f18169d7fc302c1127}{ciot\+\_\+mqttc\+\_\+transport\+\_\+t}} transport} - -MQTT transport type \Hypertarget{structpacked_a2d16d2a81fde684b4c79c0d71f8090b5}\label{structpacked_a2d16d2a81fde684b4c79c0d71f8090b5} -\index{packed@{packed}!transport\_sock@{transport\_sock}} -\index{transport\_sock@{transport\_sock}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{transport\_sock}{transport\_sock}} -{\footnotesize\ttfamily int transport\+\_\+sock} - -Transport socket \Hypertarget{structpacked_abc8367b5354c54835c1d74192f355c1c}\label{structpacked_abc8367b5354c54835c1d74192f355c1c} -\index{packed@{packed}!tx\_pin@{tx\_pin}} -\index{tx\_pin@{tx\_pin}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{tx\_pin}{tx\_pin}} -{\footnotesize\ttfamily int8\+\_\+t tx\+\_\+pin} - -TX pin \Hypertarget{structpacked_ac3305f4a165c4d898ce7988191102e46}\label{structpacked_ac3305f4a165c4d898ce7988191102e46} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [1/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a519d2e79d46983ef76576bc21bdb2bd0}{ciot\+\_\+msg\+\_\+type\+\_\+t}} type} - -Event type. - -Message type \Hypertarget{structpacked_abc70ef515ab30b52d6a58e0c72ee3688}\label{structpacked_abc70ef515ab30b52d6a58e0c72ee3688} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [2/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__scn__types_8h_a91b8cb6733aea2072bfa0c9da7fab4ba}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a1387b7c38bc20d7cf6308e7cbecff167}\label{structpacked_a1387b7c38bc20d7cf6308e7cbecff167} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [3/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ble__types_8h_a489f19de0628f044234def5f7b34d4b3}{ciot\+\_\+ble\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a2ef6bd06414538f347bd722b6c4e064c}\label{structpacked_a2ef6bd06414538f347bd722b6c4e064c} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [4/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__bridge__types_8h_ac6748f1175cddeca97c7b0a3ffb268f0}{ciot\+\_\+bridge\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a1cc8da72a2d329be4f8ff647f04884a0}\label{structpacked_a1cc8da72a2d329be4f8ff647f04884a0} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [5/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__data__model__types_8h_a3bafaff463a2ae4ae97940fe4b22c557}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_adb76936a18a28e534879c6f9d6f07868}\label{structpacked_adb76936a18a28e534879c6f9d6f07868} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [6/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__dfu__types_8h_a1da00f2ad7935e7bd07aed5f1b75fc78}{ciot\+\_\+dfu\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_ab949dccfc732240972d8a27cf46f3e76}\label{structpacked_ab949dccfc732240972d8a27cf46f3e76} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [7/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__gpio__types_8h_ac4f6f7988547fdc0e361c6e208fb0372}{ciot\+\_\+gpio\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_ac4330d2b9fc6473e00966f8dd66a477c}\label{structpacked_ac4330d2b9fc6473e00966f8dd66a477c} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [8/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a9b56a78696c5b95d67a47879369219dd}{ciot\+\_\+httpc\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_adf00e5263d183b9b74cd9dd06dd98856}\label{structpacked_adf00e5263d183b9b74cd9dd06dd98856} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [9/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_a81d94d04aed05a61d2f9f8d53f57b237}{ciot\+\_\+https\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_ac765329451135abec74c45e1897abf26}\label{structpacked_ac765329451135abec74c45e1897abf26} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [10/26]}} -{\footnotesize\ttfamily int type} - -Error type \Hypertarget{structpacked_a8e287bd3b319b246d8346f46ed6c4580}\label{structpacked_a8e287bd3b319b246d8346f46ed6c4580} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [11/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_aab9e593df0f97788f5bc430a6fdc4900}{ciot\+\_\+mqttc\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_ab9b24d9114ce832a5b9cbc962c9cea28}\label{structpacked_ab9b24d9114ce832a5b9cbc962c9cea28} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [12/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a85783fa0fe06a19feac7e7583d8d4c23}{ciot\+\_\+msg\+\_\+iface\+\_\+type\+\_\+t}} type} - -Interface type \Hypertarget{structpacked_ac3305f4a165c4d898ce7988191102e46}\label{structpacked_ac3305f4a165c4d898ce7988191102e46} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [13/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__msg__types_8h_a519d2e79d46983ef76576bc21bdb2bd0}{ciot\+\_\+msg\+\_\+type\+\_\+t}} type} - -Message type \Hypertarget{structpacked_a54590843a59febd0e8055f9249974adc}\label{structpacked_a54590843a59febd0e8055f9249974adc} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [14/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ntp__types_8h_a9a8025151a758fca7adb564d5db891e5}{ciot\+\_\+ntp\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_acb5cfd209ba75c853d03f701e7f91679}\label{structpacked_acb5cfd209ba75c853d03f701e7f91679} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [15/26]}} -{\footnotesize\ttfamily uint16\+\_\+t type} - -Node type \Hypertarget{structpacked_a6a535362b7c81b40f3ed9f6cb292a469}\label{structpacked_a6a535362b7c81b40f3ed9f6cb292a469} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [16/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__opcuas__types_8h_a42ad73195f6a447e8af05ab7f0c4e7a8}{ciot\+\_\+opcuas\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a19605616d62f4ee24f6aefb6c34480e2}\label{structpacked_a19605616d62f4ee24f6aefb6c34480e2} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [17/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__ota__types_8h_abceb933881a3b5d8844b03841cb5c3ea}{ciot\+\_\+ota\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_aa03a710482f738f9fe6095f1d4c6774a}\label{structpacked_aa03a710482f738f9fe6095f1d4c6774a} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [18/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a4baf00c99923bb372e3eb3673935ed17}{ciot\+\_\+storage\+\_\+type\+\_\+t}} type} - -Storage type \Hypertarget{structpacked_a7b3cbcb3aea8c25ecc00d1316d1a79d6}\label{structpacked_a7b3cbcb3aea8c25ecc00d1316d1a79d6} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [19/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__storage__types_8h_a33ad06132b9a63bcca2850e4deec0147}{ciot\+\_\+storage\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a4341eac7e0a50f29b2101e5b7584db32}\label{structpacked_a4341eac7e0a50f29b2101e5b7584db32} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [20/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__sys__types_8h_a68ad4161ca2e18dd35627284ab0a9a03}{ciot\+\_\+sys\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_acd8fb37e86ba410b191b31dc8cf154c3}\label{structpacked_acd8fb37e86ba410b191b31dc8cf154c3} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [21/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__tcp__types_8h_a7fadfe9c543207b391d461a1b7db38c1}{ciot\+\_\+tcp\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a55a6010bd818c4c1b94eca45963f09a9}\label{structpacked_a55a6010bd818c4c1b94eca45963f09a9} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [22/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__types_8h_a9dc21f9381920f5fad134a55af258e76}{ciot\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a21d88bf4d17b9837d25893a4000044db}\label{structpacked_a21d88bf4d17b9837d25893a4000044db} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [23/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a7169a8b5d899c7d39631d2e3504000f0}{ciot\+\_\+uart\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_aa027ba4e6f58da1f5204e16dd15d5136}\label{structpacked_aa027ba4e6f58da1f5204e16dd15d5136} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [24/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_af55c58ec7098f36787f3b5dc3920f329}{ciot\+\_\+usb\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_a35cbcdf247b4952f8c35e071bed5a1d8}\label{structpacked_a35cbcdf247b4952f8c35e071bed5a1d8} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [25/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_ad1995b212559b6b98eed49478c579ebd}{ciot\+\_\+wifi\+\_\+type\+\_\+t}} type} - -Wi\+Fi interface type \Hypertarget{structpacked_a6f6c1937c79d949cdf73c68cf9ad3493}\label{structpacked_a6f6c1937c79d949cdf73c68cf9ad3493} -\index{packed@{packed}!type@{type}} -\index{type@{type}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{type}{type}\hspace{0.1cm}{\footnotesize\ttfamily [26/26]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a69a78d9e2c718561c3b3d10a5f0e2870}{ciot\+\_\+wifi\+\_\+req\+\_\+type\+\_\+t}} type} - -Request type \Hypertarget{structpacked_aeaf49cc638f1cc4fac1c69fa12502d32}\label{structpacked_aeaf49cc638f1cc4fac1c69fa12502d32} -\index{packed@{packed}!uart@{uart}} -\index{uart@{uart}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{uart}{uart}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a173e2c17ac72cd49e4d9b2db777ba2a4}{ciot\+\_\+uart\+\_\+data\+\_\+u}} uart} - -UART data \Hypertarget{structpacked_ab56ae378dca42f3463d9dab3f4462045}\label{structpacked_ab56ae378dca42f3463d9dab3f4462045} -\index{packed@{packed}!uart@{uart}} -\index{uart@{uart}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{uart}{uart}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t uart} - -UART feature \Hypertarget{structpacked_ac4d7124a13340adca15d6f760640b66f}\label{structpacked_ac4d7124a13340adca15d6f760640b66f} -\index{packed@{packed}!url@{url}} -\index{url@{url}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{url}{url}} -{\footnotesize\ttfamily char url} - -URL - -MQTT URL - -URL for OTA update \Hypertarget{structpacked_acd0961872f365a2b54fef650ac190f50}\label{structpacked_acd0961872f365a2b54fef650ac190f50} -\index{packed@{packed}!usb@{usb}} -\index{usb@{usb}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{usb}{usb}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_a61ca0aa9e6c4f975c2d5fbd0d06aa4dd}{ciot\+\_\+usb\+\_\+data\+\_\+u}} usb} - -USB data \Hypertarget{structpacked_a71f3331b8fa338b8bb771e9c60142df8}\label{structpacked_a71f3331b8fa338b8bb771e9c60142df8} -\index{packed@{packed}!usb@{usb}} -\index{usb@{usb}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{usb}{usb}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t usb} - -USB feature \Hypertarget{structpacked_a40c9809e1d381340b5d342ef3a838715}\label{structpacked_a40c9809e1d381340b5d342ef3a838715} -\index{packed@{packed}!user@{user}} -\index{user@{user}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{user}{user}} -{\footnotesize\ttfamily char user\mbox{[}\mbox{\hyperlink{ciot__mqttc__types_8h_a2612e7ea304728eebf26c76ba9a4935e}{CIOT\+\_\+\+CONFIG\+\_\+\+MQTT\+\_\+\+USER\+\_\+\+LEN}}\mbox{]}} - -MQTT username \Hypertarget{structpacked_a82c2b14036a5b80ae9b5a4a6e2812a44}\label{structpacked_a82c2b14036a5b80ae9b5a4a6e2812a44} -\index{packed@{packed}!value@{value}} -\index{value@{value}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{value}{value}} -{\footnotesize\ttfamily char value\mbox{[}\mbox{\hyperlink{ciot__httpc__types_8h_a2a4af7d3487c220befa4d68c66758bc6}{CIOT\+\_\+\+HTTPC\+\_\+\+HEADER\+\_\+\+VAL}}\mbox{]}} - -Value \Hypertarget{structpacked_a857436941aa8d7df5abfa34bcd054d35}\label{structpacked_a857436941aa8d7df5abfa34bcd054d35} -\index{packed@{packed}!version@{version}} -\index{version@{version}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{version}{version}} -{\footnotesize\ttfamily uint8\+\_\+t version\mbox{[}3\mbox{]}} - -Version information \Hypertarget{structpacked_ac06a3086376da2d8a84120762824336c}\label{structpacked_ac06a3086376da2d8a84120762824336c} -\index{packed@{packed}!wifi@{wifi}} -\index{wifi@{wifi}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{wifi}{wifi}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__wifi__types_8h_a2687337a6d518758bdc08cf5d43b75ac}{ciot\+\_\+wifi\+\_\+data\+\_\+u}} wifi} - -Wi\+Fi data \Hypertarget{structpacked_abf7485e5a2b2214d69dd780eddc62f39}\label{structpacked_abf7485e5a2b2214d69dd780eddc62f39} -\index{packed@{packed}!wifi@{wifi}} -\index{wifi@{wifi}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{wifi}{wifi}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily uint16\+\_\+t wifi} - -Wi\+Fi feature \Hypertarget{structpacked_a6b307b5083cf92aca29549d780b44bd5}\label{structpacked_a6b307b5083cf92aca29549d780b44bd5} -\index{packed@{packed}!window@{window}} -\index{window@{window}!packed@{packed}} -\doxysubsubsection{\texorpdfstring{window}{window}} -{\footnotesize\ttfamily uint16\+\_\+t window} - -Window value - -The documentation for this union was generated from the following files\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__ble_8h}{ciot\+\_\+ble.\+h}}\item -include/\mbox{\hyperlink{ciot__ble__scn_8h}{ciot\+\_\+ble\+\_\+scn.\+h}}\item -include/\mbox{\hyperlink{ciot__bridge_8h}{ciot\+\_\+bridge.\+h}}\item -include/\mbox{\hyperlink{ciot__dfu_8h}{ciot\+\_\+dfu.\+h}}\item -include/\mbox{\hyperlink{ciot__eth_8h}{ciot\+\_\+eth.\+h}}\item -include/\mbox{\hyperlink{ciot__gpio_8h}{ciot\+\_\+gpio.\+h}}\item -include/\mbox{\hyperlink{ciot__httpc_8h}{ciot\+\_\+httpc.\+h}}\item -include/\mbox{\hyperlink{ciot__https_8h}{ciot\+\_\+https.\+h}}\item -include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}}\item -include/\mbox{\hyperlink{ciot__mqttc_8h}{ciot\+\_\+mqttc.\+h}}\item -include/\mbox{\hyperlink{ciot__ntp_8h}{ciot\+\_\+ntp.\+h}}\item -include/\mbox{\hyperlink{ciot__opcuas_8h}{ciot\+\_\+opcuas.\+h}}\item -include/\mbox{\hyperlink{ciot__ota_8h}{ciot\+\_\+ota.\+h}}\item -include/\mbox{\hyperlink{ciot__storage_8h}{ciot\+\_\+storage.\+h}}\item -include/\mbox{\hyperlink{ciot__sys_8h}{ciot\+\_\+sys.\+h}}\item -include/\mbox{\hyperlink{ciot__tcp_8h}{ciot\+\_\+tcp.\+h}}\item -include/\mbox{\hyperlink{ciot__uart_8h}{ciot\+\_\+uart.\+h}}\item -include/\mbox{\hyperlink{ciot__usb_8h}{ciot\+\_\+usb.\+h}}\item -include/\mbox{\hyperlink{ciot__wifi_8h}{ciot\+\_\+wifi.\+h}}\item -include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}}\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/tabu_doxygen.sty b/docs/latex/tabu_doxygen.sty deleted file mode 100644 index 3f17d1d..0000000 --- a/docs/latex/tabu_doxygen.sty +++ /dev/null @@ -1,2557 +0,0 @@ -%% -%% This is file `tabu.sty', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% tabu.dtx (with options: `package') -%% -%% This is a generated file. -%% Copyright (FC) 2010-2011 - lppl -%% -%% tabu : 2011/02/26 v2.8 - tabu : Flexible LaTeX tabulars -%% -%% ********************************************************************************************** -%% \begin{tabu} { preamble } => default target: \linewidth or \linegoal -%% \begin{tabu} to { preamble } => target specified -%% \begin{tabu} spread { preamble } => target relative to the ``natural width'' -%% -%% tabu works in text and in math modes. -%% -%% X columns: automatic width adjustment + horizontal and vertical alignment -%% \begin{tabu} { X[4c] X[1c] X[-2ml] } -%% -%% Horizontal lines and / or leaders: -%% \hline\hline => double horizontal line -%% \firsthline\hline => for nested tabulars -%% \lasthline\hline => for nested tabulars -%% \tabucline[line spec]{column-column} => ``funny'' lines (dash/leader) -%% Automatic lines / leaders : -%% \everyrow{\hline\hline} -%% -%% Vertical lines and / or leaders: -%% \begin{tabu} { |[3pt red] X[4c] X[1c] X[-2ml] |[3pt blue] } -%% \begin{tabu} { |[3pt red] X[4c] X[1c] X[-2ml] |[3pt on 2pt off 4pt blue] } -%% -%% Fixed vertical spacing adjustment: -%% \extrarowheight= \extrarowdepth= -%% or: \extrarowsep= => may be prefixed by \global -%% -%% Dynamic vertical spacing adjustment: -%% \abovetabulinesep= \belowtabulinesep= -%% or: \tabulinesep= => may be prefixed by \global -%% -%% delarray.sty shortcuts: in math and text modes -%% \begin{tabu} .... \({ preamble }\) -%% -%% Algorithms reports: -%% \tracingtabu=1 \tracingtabu=2 -%% -%% ********************************************************************************************** -%% -%% This work may be distributed and/or modified under the -%% conditions of the LaTeX Project Public License, either -%% version 1.3 of this license or (at your option) any later -%% version. The latest version of this license is in -%% http://www.latex-project.org/lppl.txt -%% -%% This work consists of the main source file tabu.dtx -%% and the derived files -%% tabu.sty, tabu.pdf, tabu.ins -%% -%% tabu : Flexible LaTeX tabulars -%% lppl copyright 2010-2011 by FC -%% - -\NeedsTeXFormat{LaTeX2e}[2005/12/01] -\ProvidesPackage{tabu_doxygen}[2011/02/26 v2.8 - flexible LaTeX tabulars (FC), frozen version for doxygen] -\RequirePackage{array}[2008/09/09] -\RequirePackage{varwidth}[2009/03/30] -\AtEndOfPackage{\tabu@AtEnd \let\tabu@AtEnd \@undefined} -\let\tabu@AtEnd\@empty -\def\TMP@EnsureCode#1={% - \edef\tabu@AtEnd{\tabu@AtEnd - \catcode#1 \the\catcode#1}% - \catcode#1=% -}% \TMP@EnsureCode -\TMP@EnsureCode 33 = 12 % ! -\TMP@EnsureCode 58 = 12 % : (for siunitx) -\TMP@EnsureCode124 = 12 % | -\TMP@EnsureCode 36 = 3 % $ = math shift -\TMP@EnsureCode 38 = 4 % & = tab alignment character -\TMP@EnsureCode 32 = 10 % space -\TMP@EnsureCode 94 = 7 % ^ -\TMP@EnsureCode 95 = 8 % _ -%% Constants -------------------------------------------------------- -\newcount \c@taburow \def\thetaburow {\number\c@taburow} -\newcount \tabu@nbcols -\newcount \tabu@cnt -\newcount \tabu@Xcol -\let\tabu@start \@tempcnta -\let\tabu@stop \@tempcntb -\newcount \tabu@alloc \tabu@alloc=\m@ne -\newcount \tabu@nested -\def\tabu@alloc@{\global\advance\tabu@alloc \@ne \tabu@nested\tabu@alloc} -\newdimen \tabu@target -\newdimen \tabu@spreadtarget -\newdimen \tabu@naturalX -\newdimen \tabucolX -\let\tabu@DELTA \@tempdimc -\let\tabu@thick \@tempdima -\let\tabu@on \@tempdimb -\let\tabu@off \@tempdimc -\newdimen \tabu@Xsum -\newdimen \extrarowdepth -\newdimen \abovetabulinesep -\newdimen \belowtabulinesep -\newdimen \tabustrutrule \tabustrutrule \z@ -\newtoks \tabu@thebody -\newtoks \tabu@footnotes -\newsavebox \tabu@box -\newsavebox \tabu@arstrutbox -\newsavebox \tabu@hleads -\newsavebox \tabu@vleads -\newif \iftabu@colortbl -\newif \iftabu@siunitx -\newif \iftabu@measuring -\newif \iftabu@spread -\newif \iftabu@negcoef -\newif \iftabu@everyrow -\def\tabu@everyrowtrue {\global\let\iftabu@everyrow \iftrue} -\def\tabu@everyrowfalse{\global\let\iftabu@everyrow \iffalse} -\newif \iftabu@long -\newif \iftabuscantokens -\def\tabu@rescan {\tabu@verbatim \scantokens } -%% Utilities (for internal usage) ----------------------------------- -\def\tabu@gobblespace #1 {#1} -\def\tabu@gobbletoken #1#2{#1} -\def\tabu@gobbleX{\futurelet\@let@token \tabu@gobblex} -\def\tabu@gobblex{\if ^^J\noexpand\@let@token \expandafter\@gobble - \else\ifx \@sptoken\@let@token - \expandafter\tabu@gobblespace\expandafter\tabu@gobbleX - \fi\fi -}% \tabu@gobblex -\def\tabu@X{^^J} -{\obeyspaces -\global\let\tabu@spxiii= % saves an active space (for \ifx) -\gdef\tabu@@spxiii{ }} -\def\tabu@ifenvir {% only for \multicolumn - \expandafter\tabu@if@nvir\csname\@currenvir\endcsname -}% \tabu@ifenvir -\def\tabu@if@nvir #1{\csname @\ifx\tabu#1first\else - \ifx\longtabu#1first\else - second\fi\fi oftwo\endcsname -}% \tabu@ifenvir -\def\tabu@modulo #1#2{\numexpr\ifnum\numexpr#1=\z@ 0\else #1-(#1-(#2-1)/2)/(#2)*(#2)\fi} -{\catcode`\&=3 -\gdef\tabu@strtrim #1{% #1 = control sequence to trim - \ifodd 1\ifx #1\@empty \else \ifx #1\space \else 0\fi \fi - \let\tabu@c@l@r \@empty \let#1\@empty - \else \expandafter \tabu@trimspaces #1\@nnil - \fi -}% \tabu@strtrim -\gdef\tabu@trimspaces #1\@nnil{\let\tabu@c@l@r=#2\tabu@firstspace .#1& }% -\gdef\tabu@firstspace #1#2#3 &{\tabu@lastspace #2#3&} -\gdef\tabu@lastspace #1{\def #3{#1}% - \ifx #3\tabu@c@l@r \def\tabu@c@l@r{\protect\color{#1}}\expandafter\remove@to@nnil \fi - \tabu@trimspaces #1\@nnil} -}% \catcode -\def\tabu@sanitizearg #1#2{{% - \csname \ifcsname if@safe@actives\endcsname % - @safe@activestrue\else - relax\fi \endcsname - \edef#2{#1}\tabu@strtrim#2\@onelevel@sanitize#2% - \expandafter}\expandafter\def\expandafter#2\expandafter{#2}% -}% \tabu@sanitizearg -\def\tabu@textbar #1{\begingroup \endlinechar\m@ne \scantokens{\def\:{|}}% - \expandafter\endgroup \expandafter#1\:% !!! semi simple group !!! -}% \tabu@textbar -\def\tabu@everyrow@bgroup{\iftabu@everyrow \begingroup \else \noalign{\ifnum0=`}\fi \fi} -\def\tabu@everyrow@egroup{% - \iftabu@everyrow \expandafter \endgroup \the\toks@ - \else \ifnum0=`{\fi}% - \fi -}% \tabu@everyrow@egroup -\def\tabu@arstrut {\global\setbox\@arstrutbox \hbox{\vrule - height \arraystretch \dimexpr\ht\strutbox+\extrarowheight - depth \arraystretch \dimexpr\dp\strutbox+\extrarowdepth - width \z@}% -}% \tabu@arstrut -\def\tabu@rearstrut {% - \@tempdima \arraystretch\dimexpr\ht\strutbox+\extrarowheight \relax - \@tempdimb \arraystretch\dimexpr\dp\strutbox+\extrarowdepth \relax - \ifodd 1\ifdim \ht\@arstrutbox=\@tempdima - \ifdim \dp\@arstrutbox=\@tempdimb 0 \fi\fi - \tabu@mkarstrut - \fi -}% \tabu@rearstrut -\def\tabu@@DBG #1{\ifdim\tabustrutrule>\z@ \color{#1}\fi} -\def\tabu@DBG@arstrut {\global\setbox\@arstrutbox - \hbox to\z@{\hbox to\z@{\hss - {\tabu@DBG{cyan}\vrule - height \arraystretch \dimexpr\ht\strutbox+\extrarowheight - depth \z@ - width \tabustrutrule}\kern-\tabustrutrule - {\tabu@DBG{pink}\vrule - height \z@ - depth \arraystretch \dimexpr\dp\strutbox+\extrarowdepth - width \tabustrutrule}}}% -}% \tabu@DBG@arstrut -\def\tabu@save@decl{\toks\count@ \expandafter{\the\toks\expandafter\count@ - \@nextchar}}% -\def\tabu@savedecl{\ifcat$\d@llarend\else - \let\save@decl \tabu@save@decl \fi % no inversion of tokens in text mode -}% \tabu@savedecl -\def\tabu@finalstrut #1{\unskip\ifhmode\nobreak\fi\vrule height\z@ depth\z@ width\z@} -\newcommand*\tabuDisableCommands {\g@addto@macro\tabu@trialh@@k } -\let\tabu@trialh@@k \@empty -\def\tabu@nowrite #1#{{\afterassignment}\toks@} -\let\tabu@write\write -\let\tabu@immediate\immediate -\def\tabu@WRITE{\begingroup - \def\immediate\write{\aftergroup\endgroup - \tabu@immediate\tabu@write}% -}% \tabu@WRITE -\expandafter\def\expandafter\tabu@GenericError\expandafter{% - \expandafter\tabu@WRITE\GenericError} -\def\tabu@warn{\tabu@WRITE\PackageWarning{tabu}} -\def\tabu@noxfootnote [#1]{\@gobble} -\def\tabu@nocolor #1#{\@gobble} -\newcommand*\tabu@norowcolor[2][]{} -\def\tabu@maybesiunitx #1{\def\tabu@temp{#1}% - \futurelet\@let@token \tabu@m@ybesiunitx} -\def\tabu@m@ybesiunitx #1{\def\tabu@m@ybesiunitx {% - \ifx #1\@let@token \let\tabu@cellleft \@empty \let\tabu@cellright \@empty \fi - \tabu@temp}% \tabu@m@ybesiunitx -}\expandafter\tabu@m@ybesiunitx \csname siunitx_table_collect_begin:Nn\endcsname -\def\tabu@celllalign@def #1{\def\tabu@celllalign{\tabu@maybesiunitx{#1}}}% -%% Fixed vertical spacing adjustment: \extrarowsep ------------------ -\newcommand*\extrarowsep{\edef\tabu@C@extra{\the\numexpr\tabu@C@extra+1}% - \iftabu@everyrow \aftergroup\tabu@Gextra - \else \aftergroup\tabu@n@Gextra - \fi - \@ifnextchar={\tabu@gobbletoken\tabu@extra} \tabu@extra -}% \extrarowsep -\def\tabu@extra {\@ifnextchar_% - {\tabu@gobbletoken{\tabu@setextra\extrarowheight \extrarowdepth}} - {\ifx ^\@let@token \def\tabu@temp{% - \tabu@gobbletoken{\tabu@setextra\extrarowdepth \extrarowheight}}% - \else \let\tabu@temp \@empty - \afterassignment \tabu@setextrasep \extrarowdepth - \fi \tabu@temp}% -}% \tabu@extra -\def\tabu@setextra #1#2{\def\tabu@temp{\tabu@extr@#1#2}\afterassignment\tabu@temp#2} -\def\tabu@extr@ #1#2{\@ifnextchar^% - {\tabu@gobbletoken{\tabu@setextra\extrarowdepth \extrarowheight}} - {\ifx _\@let@token \def\tabu@temp{% - \tabu@gobbletoken{\tabu@setextra\extrarowheight \extrarowdepth}}% - \else \let\tabu@temp \@empty - \tabu@Gsave \tabu@G@extra \tabu@C@extra \extrarowheight \extrarowdepth - \fi \tabu@temp}% -}% \tabu@extr@ -\def\tabu@setextrasep {\extrarowheight=\extrarowdepth - \tabu@Gsave \tabu@G@extra \tabu@C@extra \extrarowheight \extrarowdepth -}% \tabu@setextrasep -\def\tabu@Gextra{\ifx \tabu@G@extra\@empty \else {\tabu@Rextra}\fi} -\def\tabu@n@Gextra{\ifx \tabu@G@extra\@empty \else \noalign{\tabu@Rextra}\fi} -\def\tabu@Rextra{\tabu@Grestore \tabu@G@extra \tabu@C@extra} -\let\tabu@C@extra \z@ -\let\tabu@G@extra \@empty -%% Dynamic vertical spacing adjustment: \tabulinesep ---------------- -\newcommand*\tabulinesep{\edef\tabu@C@linesep{\the\numexpr\tabu@C@linesep+1}% - \iftabu@everyrow \aftergroup\tabu@Glinesep - \else \aftergroup\tabu@n@Glinesep - \fi - \@ifnextchar={\tabu@gobbletoken\tabu@linesep} \tabu@linesep -}% \tabulinesep -\def\tabu@linesep {\@ifnextchar_% - {\tabu@gobbletoken{\tabu@setsep\abovetabulinesep \belowtabulinesep}} - {\ifx ^\@let@token \def\tabu@temp{% - \tabu@gobbletoken{\tabu@setsep\belowtabulinesep \abovetabulinesep}}% - \else \let\tabu@temp \@empty - \afterassignment \tabu@setlinesep \abovetabulinesep - \fi \tabu@temp}% -}% \tabu@linesep -\def\tabu@setsep #1#2{\def\tabu@temp{\tabu@sets@p#1#2}\afterassignment\tabu@temp#2} -\def\tabu@sets@p #1#2{\@ifnextchar^% - {\tabu@gobbletoken{\tabu@setsep\belowtabulinesep \abovetabulinesep}} - {\ifx _\@let@token \def\tabu@temp{% - \tabu@gobbletoken{\tabu@setsep\abovetabulinesep \belowtabulinesep}}% - \else \let\tabu@temp \@empty - \tabu@Gsave \tabu@G@linesep \tabu@C@linesep \abovetabulinesep \belowtabulinesep - \fi \tabu@temp}% -}% \tabu@sets@p -\def\tabu@setlinesep {\belowtabulinesep=\abovetabulinesep - \tabu@Gsave \tabu@G@linesep \tabu@C@linesep \abovetabulinesep \belowtabulinesep -}% \tabu@setlinesep -\def\tabu@Glinesep{\ifx \tabu@G@linesep\@empty \else {\tabu@Rlinesep}\fi} -\def\tabu@n@Glinesep{\ifx \tabu@G@linesep\@empty \else \noalign{\tabu@Rlinesep}\fi} -\def\tabu@Rlinesep{\tabu@Grestore \tabu@G@linesep \tabu@C@linesep} -\let\tabu@C@linesep \z@ -\let\tabu@G@linesep \@empty -%% \global\extrarowsep and \global\tabulinesep ------------------- -\def\tabu@Gsave #1#2#3#4{\xdef#1{#1% - \toks#2{\toks\the\currentgrouplevel{\global#3\the#3\global#4\the#4}}}% -}% \tabu@Gsave -\def\tabu@Grestore#1#2{% - \toks#2{}#1\toks\currentgrouplevel\expandafter{\expandafter}\the\toks#2\relax - \ifcat$\the\toks\currentgrouplevel$\else - \global\let#1\@empty \global\let#2\z@ - \the\toks\currentgrouplevel - \fi -}% \tabu@Grestore -%% Setting code for every row --------------------------------------- -\newcommand*\everyrow{\tabu@everyrow@bgroup - \tabu@start \z@ \tabu@stop \z@ \tabu@evrstartstop -}% \everyrow -\def\tabu@evrstartstop {\@ifnextchar^% - {\afterassignment \tabu@evrstartstop \tabu@stop=}% - {\ifx ^\@let@token - \afterassignment\tabu@evrstartstop \tabu@start=% - \else \afterassignment\tabu@everyr@w \toks@ - \fi}% -}% \tabu@evrstartstop -\def\tabu@everyr@w {% - \xdef\tabu@everyrow{% - \noexpand\tabu@everyrowfalse - \let\noalign \relax - \noexpand\tabu@rowfontreset - \iftabu@colortbl \noexpand\tabu@rc@ \fi % \taburowcolors - \let\noexpand\tabu@docline \noexpand\tabu@docline@evr - \the\toks@ - \noexpand\tabu@evrh@@k - \noexpand\tabu@rearstrut - \global\advance\c@taburow \@ne}% - \iftabu@everyrow \toks@\expandafter - {\expandafter\def\expandafter\tabu@evr@L\expandafter{\the\toks@}\ignorespaces}% - \else \xdef\tabu@evr@G{\the\toks@}% - \fi - \tabu@everyrow@egroup -}% \tabu@everyr@w -\def\tabu@evr {\def\tabu@evrh@@k} % for internal use only -\tabu@evr{} -%% line style and leaders ------------------------------------------- -\newcommand*\newtabulinestyle [1]{% - {\@for \@tempa :=#1\do{\expandafter\tabu@newlinestyle \@tempa==\@nil}}% -}% \newtabulinestyle -\def\tabu@newlinestyle #1=#2=#3\@nil{\tabu@getline {#2}% - \tabu@sanitizearg {#1}\@tempa - \ifodd 1\ifx \@tempa\@empty \ifdefined\tabu@linestyle@ 0 \fi\fi - \global\expandafter\let - \csname tabu@linestyle@\@tempa \endcsname =\tabu@thestyle \fi -}% \tabu@newlinestyle -\newcommand*\tabulinestyle [1]{\tabu@everyrow@bgroup \tabu@getline{#1}% - \iftabu@everyrow - \toks@\expandafter{\expandafter \def \expandafter - \tabu@ls@L\expandafter{\tabu@thestyle}\ignorespaces}% - \gdef\tabu@ls@{\tabu@ls@L}% - \else - \global\let\tabu@ls@G \tabu@thestyle - \gdef\tabu@ls@{\tabu@ls@G}% - \fi - \tabu@everyrow@egroup -}% \tabulinestyle -\newcommand*\taburulecolor{\tabu@everyrow@bgroup \tabu@textbar \tabu@rulecolor} -\def\tabu@rulecolor #1{\toks@{}% - \def\tabu@temp #1##1#1{\tabu@ruledrsc{##1}}\@ifnextchar #1% - \tabu@temp - \tabu@rulearc -}% \tabu@rulecolor -\def\tabu@ruledrsc #1{\edef\tabu@temp{#1}\tabu@strtrim\tabu@temp - \ifx \tabu@temp\@empty \def\tabu@temp{\tabu@rule@drsc@ {}{}}% - \else \edef\tabu@temp{\noexpand\tabu@rule@drsc@ {}{\tabu@temp}}% - \fi - \tabu@temp -}% \tabu@ruledrsc@ -\def\tabu@ruledrsc@ #1#{\tabu@rule@drsc@ {#1}} -\def\tabu@rule@drsc@ #1#2{% - \iftabu@everyrow - \ifx \\#1#2\\\toks@{\let\CT@drsc@ \relax}% - \else \toks@{\def\CT@drsc@{\color #1{#2}}}% - \fi - \else - \ifx \\#1#2\\\global\let\CT@drsc@ \relax - \else \gdef\CT@drsc@{\color #1{#2}}% - \fi - \fi - \tabu@rulearc -}% \tabu@rule@drsc@ -\def\tabu@rulearc #1#{\tabu@rule@arc@ {#1}} -\def\tabu@rule@arc@ #1#2{% - \iftabu@everyrow - \ifx \\#1#2\\\toks@\expandafter{\the\toks@ \def\CT@arc@{}}% - \else \toks@\expandafter{\the\toks@ \def\CT@arc@{\color #1{#2}}}% - \fi - \toks@\expandafter{\the\toks@ - \let\tabu@arc@L \CT@arc@ - \let\tabu@drsc@L \CT@drsc@ - \ignorespaces}% - \else - \ifx \\#1#2\\\gdef\CT@arc@{}% - \else \gdef\CT@arc@{\color #1{#2}}% - \fi - \global\let\tabu@arc@G \CT@arc@ - \global\let\tabu@drsc@G \CT@drsc@ - \fi - \tabu@everyrow@egroup -}% \tabu@rule@arc@ -\def\taburowcolors {\tabu@everyrow@bgroup \@testopt \tabu@rowcolors 1} -\def\tabu@rowcolors [#1]#2#{\tabu@rowc@lors{#1}{#2}} -\def\tabu@rowc@lors #1#2#3{% - \toks@{}\@defaultunits \count@ =\number0#2\relax \@nnil - \@defaultunits \tabu@start =\number0#1\relax \@nnil - \ifnum \count@<\tw@ \count@=\tw@ \fi - \advance\tabu@start \m@ne - \ifnum \tabu@start<\z@ \tabu@start \z@ \fi - \tabu@rowcolorseries #3\in@..\in@ \@nnil -}% \tabu@rowcolors -\def\tabu@rowcolorseries #1..#2\in@ #3\@nnil {% - \ifx \in@#1\relax - \iftabu@everyrow \toks@{\def\tabu@rc@{}\let\tabu@rc@L \tabu@rc@}% - \else \gdef\tabu@rc@{}\global\let\tabu@rc@G \tabu@rc@ - \fi - \else - \ifx \\#2\\\tabu@rowcolorserieserror \fi - \tabu@sanitizearg{#1}\tabu@temp - \tabu@sanitizearg{#2}\@tempa - \advance\count@ \m@ne - \iftabu@everyrow - \def\tabu@rc@ ##1##2##3##4{\def\tabu@rc@{% - \ifnum ##2=\c@taburow - \definecolorseries{tabu@rcseries@\the\tabu@nested}{rgb}{last}{##3}{##4}\fi - \ifnum \c@taburow<##2 \else - \ifnum \tabu@modulo {\c@taburow-##2}{##1+1}=\z@ - \resetcolorseries[{##1}]{tabu@rcseries@\the\tabu@nested}\fi - \xglobal\colorlet{tabu@rc@\the\tabu@nested}{tabu@rcseries@\the\tabu@nested!!+}% - \rowcolor{tabu@rc@\the\tabu@nested}\fi}% - }\edef\x{\noexpand\tabu@rc@ {\the\count@} - {\the\tabu@start} - {\tabu@temp} - {\@tempa}% - }\x - \toks@\expandafter{\expandafter\def\expandafter\tabu@rc@\expandafter{\tabu@rc@}}% - \toks@\expandafter{\the\toks@ \let\tabu@rc@L \tabu@rc@ \ignorespaces}% - \else % inside \noalign - \definecolorseries{tabu@rcseries@\the\tabu@nested}{rgb}{last}{\tabu@temp}{\@tempa}% - \expandafter\resetcolorseries\expandafter[\the\count@]{tabu@rcseries@\the\tabu@nested}% - \xglobal\colorlet{tabu@rc@\the\tabu@nested}{tabu@rcseries@\the\tabu@nested!!+}% - \let\noalign \relax \rowcolor{tabu@rc@\the\tabu@nested}% - \def\tabu@rc@ ##1##2{\gdef\tabu@rc@{% - \ifnum \tabu@modulo {\c@taburow-##2}{##1+1}=\@ne - \resetcolorseries[{##1}]{tabu@rcseries@\the\tabu@nested}\fi - \xglobal\colorlet{tabu@rc@\the\tabu@nested}{tabu@rcseries@\the\tabu@nested!!+}% - \rowcolor{tabu@rc@\the\tabu@nested}}% - }\edef\x{\noexpand\tabu@rc@{\the\count@}{\the\c@taburow}}\x - \global\let\tabu@rc@G \tabu@rc@ - \fi - \fi - \tabu@everyrow@egroup -}% \tabu@rowcolorseries -\tabuDisableCommands {\let\tabu@rc@ \@empty } -\def\tabu@rowcolorserieserror {\PackageError{tabu} - {Invalid syntax for \string\taburowcolors - \MessageBreak Please look at the documentation!}\@ehd -}% \tabu@rowcolorserieserror -\newcommand*\tabureset {% - \tabulinesep=\z@ \extrarowsep=\z@ \extratabsurround=\z@ - \tabulinestyle{}\everyrow{}\taburulecolor||{}\taburowcolors{}% -}% \tabureset -%% Parsing the line styles ------------------------------------------ -\def\tabu@getline #1{\begingroup - \csname \ifcsname if@safe@actives\endcsname % - @safe@activestrue\else - relax\fi \endcsname - \edef\tabu@temp{#1}\tabu@sanitizearg{#1}\@tempa - \let\tabu@thestyle \relax - \ifcsname tabu@linestyle@\@tempa \endcsname - \edef\tabu@thestyle{\endgroup - \def\tabu@thestyle{\expandafter\noexpand - \csname tabu@linestyle@\@tempa\endcsname}% - }\tabu@thestyle - \else \expandafter\tabu@definestyle \tabu@temp \@nil - \fi -}% \tabu@getline -\def\tabu@definestyle #1#2\@nil {\endlinechar \m@ne \makeatletter - \tabu@thick \maxdimen \tabu@on \maxdimen \tabu@off \maxdimen - \let\tabu@c@lon \@undefined \let\tabu@c@loff \@undefined - \ifodd 1\ifcat .#1\else\ifcat\relax #1\else 0\fi\fi % catcode 12 or non expandable cs - \def\tabu@temp{\tabu@getparam{thick}}% - \else \def\tabu@temp{\tabu@getparam{thick}\maxdimen}% - \fi - {% - \let\tabu@ \relax - \def\:{\obeyspaces \tabu@oXIII \tabu@commaXIII \edef\:}% (space active \: happy ;-)) - \scantokens{\:{\tabu@temp #1#2 \tabu@\tabu@}}% - \expandafter}\expandafter - \def\expandafter\:\expandafter{\:}% line spec rewritten now ;-) - \def\;{\def\:}% - \scantokens\expandafter{\expandafter\;\expandafter{\:}}% space is now inactive (catcode 10) - \let\tabu@ \tabu@getcolor \:% all arguments are ready now ;-) - \ifdefined\tabu@c@lon \else \let\tabu@c@lon\@empty \fi - \ifx \tabu@c@lon\@empty \def\tabu@c@lon{\CT@arc@}\fi - \ifdefined\tabu@c@loff \else \let\tabu@c@loff \@empty \fi - \ifdim \tabu@on=\maxdimen \ifdim \tabu@off<\maxdimen - \tabu@on \tabulineon \fi\fi - \ifdim \tabu@off=\maxdimen \ifdim \tabu@on<\maxdimen - \tabu@off \tabulineoff \fi\fi - \ifodd 1\ifdim \tabu@off=\maxdimen \ifdim \tabu@on=\maxdimen 0 \fi\fi - \in@true % - \else \in@false % - \fi - \ifdim\tabu@thick=\maxdimen \def\tabu@thick{\arrayrulewidth}% - \else \edef\tabu@thick{\the\tabu@thick}% - \fi - \edef \tabu@thestyle ##1##2{\endgroup - \def\tabu@thestyle{% - \ifin@ \noexpand\tabu@leadersstyle {\tabu@thick} - {\the\tabu@on}{##1} - {\the\tabu@off}{##2}% - \else \noexpand\tabu@rulesstyle - {##1\vrule width \tabu@thick}% - {##1\leaders \hrule height \tabu@thick \hfil}% - \fi}% - }\expandafter \expandafter - \expandafter \tabu@thestyle \expandafter - \expandafter \expandafter - {\expandafter\tabu@c@lon\expandafter}\expandafter{\tabu@c@loff}% -}% \tabu@definestyle -{\catcode`\O=\active \lccode`\O=`\o \catcode`\,=\active - \lowercase{\gdef\tabu@oXIII {\catcode`\o=\active \let O=\tabu@oxiii}} - \gdef\tabu@commaXIII {\catcode`\,=\active \let ,=\space} -}% \catcode -\def\tabu@oxiii #1{% - \ifcase \ifx n#1\z@ \else - \ifx f#1\@ne\else - \tw@ \fi\fi - \expandafter\tabu@onxiii - \or \expandafter\tabu@ofxiii - \else o% - \fi#1}% -\def\tabu@onxiii #1#2{% - \ifcase \ifx !#2\tw@ \else - \ifcat.\noexpand#2\z@ \else - \ifx \tabu@spxiii#2\@ne\else - \tw@ \fi\fi\fi - \tabu@getparam{on}#2\expandafter\@gobble - \or \expandafter\tabu@onxiii % (space is active) - \else o\expandafter\@firstofone - \fi{#1#2}}% -\def\tabu@ofxiii #1#2{% - \ifx #2f\expandafter\tabu@offxiii - \else o\expandafter\@firstofone - \fi{#1#2}} -\def\tabu@offxiii #1#2{% - \ifcase \ifx !#2\tw@ \else - \ifcat.\noexpand#2\z@ \else - \ifx\tabu@spxiii#2\@ne \else - \tw@ \fi\fi\fi - \tabu@getparam{off}#2\expandafter\@gobble - \or \expandafter\tabu@offxiii % (space is active) - \else o\expandafter\@firstofone - \fi{#1#2}} -\def\tabu@getparam #1{\tabu@ \csname tabu@#1\endcsname=} -\def\tabu@getcolor #1{% \tabu@ <- \tabu@getcolor after \edef - \ifx \tabu@#1\else % no more spec - \let\tabu@theparam=#1\afterassignment \tabu@getc@l@r #1\fi -}% \tabu@getcolor -\def\tabu@getc@l@r #1\tabu@ {% - \def\tabu@temp{#1}\tabu@strtrim \tabu@temp - \ifx \tabu@temp\@empty - \else%\ifcsname \string\color@\tabu@temp \endcsname % if the color exists - \ifx \tabu@theparam \tabu@off \let\tabu@c@loff \tabu@c@l@r - \else \let\tabu@c@lon \tabu@c@l@r - \fi - %\else \tabu@warncolour{\tabu@temp}% - \fi%\fi - \tabu@ % next spec -}% \tabu@getc@l@r -\def\tabu@warncolour #1{\PackageWarning{tabu} - {Color #1 is not defined. Default color used}% -}% \tabu@warncolour -\def\tabu@leadersstyle #1#2#3#4#5{\def\tabu@leaders{{#1}{#2}{#3}{#4}{#5}}% - \ifx \tabu@leaders\tabu@leaders@G \else - \tabu@LEADERS{#1}{#2}{#3}{#4}{#5}\fi -}% \tabu@leadersstyle -\def\tabu@rulesstyle #1#2{\let\tabu@leaders \@undefined - \gdef\tabu@thevrule{#1}\gdef\tabu@thehrule{#2}% -}% \tabu@rulesstyle -%% The leaders boxes ------------------------------------------------ -\def\tabu@LEADERS #1#2#3#4#5{%% width, dash, dash color, gap, gap color - {\let\color \tabu@color % => during trials -> \color = \tabu@nocolor - {% % but the leaders boxes should have colors ! - \def\@therule{\vrule}\def\@thick{height}\def\@length{width}% - \def\@box{\hbox}\def\@unbox{\unhbox}\def\@elt{\wd}% - \def\@skip{\hskip}\def\@ss{\hss}\def\tabu@leads{\tabu@hleads}% - \tabu@l@@d@rs {#1}{#2}{#3}{#4}{#5}% - \global\let\tabu@thehleaders \tabu@theleaders - }% - {% - \def\@therule{\hrule}\def\@thick{width}\def\@length{height}% - \def\@box{\vbox}\def\@unbox{\unvbox}\def\@elt{\ht}% - \def\@skip{\vskip}\def\@ss{\vss}\def\tabu@leads{\tabu@vleads}% - \tabu@l@@d@rs {#1}{#2}{#3}{#4}{#5}% - \global\let\tabu@thevleaders \tabu@theleaders - }% - \gdef\tabu@leaders@G{{#1}{#2}{#3}{#4}{#5}}% - }% -}% \tabu@LEADERS -\def\tabu@therule #1#2{\@therule \@thick#1\@length\dimexpr#2/2 \@depth\z@} -\def\tabu@l@@d@rs #1#2#3#4#5{%% width, dash, dash color, gap, gap color - \global\setbox \tabu@leads=\@box{% - {#3\tabu@therule{#1}{#2}}% - \ifx\\#5\\\@skip#4\else{#5\tabu@therule{#1}{#4*2}}\fi - {#3\tabu@therule{#1}{#2}}}% - \global\setbox\tabu@leads=\@box to\@elt\tabu@leads{\@ss - {#3\tabu@therule{#1}{#2}}\@unbox\tabu@leads}% - \edef\tabu@theleaders ##1{\def\noexpand\tabu@theleaders {% - {##1\tabu@therule{#1}{#2}}% - \xleaders \copy\tabu@leads \@ss - \tabu@therule{0pt}{-#2}{##1\tabu@therule{#1}{#2}}}% - }\tabu@theleaders{#3}% -}% \tabu@l@@d@rs -%% \tabu \endtabu \tabu* \longtabu \endlongtabu \longtabu* ---------- -\newcommand*\tabu {\tabu@longfalse - \ifmmode \def\tabu@ {\array}\def\endtabu {\endarray}% - \else \def\tabu@ {\tabu@tabular}\def\endtabu {\endtabular}\fi - \expandafter\let\csname tabu*\endcsname \tabu - \expandafter\def\csname endtabu*\endcsname{\endtabu}% - \tabu@spreadfalse \tabu@negcoeffalse \tabu@settarget -}% {tabu} -\let\tabu@tabular \tabular % -\expandafter\def\csname tabu*\endcsname{\tabuscantokenstrue \tabu} -\newcommand*\longtabu {\tabu@longtrue - \ifmmode\PackageError{tabu}{longtabu not allowed in math mode}\fi - \def\tabu@{\longtable}\def\endlongtabu{\endlongtable}% - \LTchunksize=\@M - \expandafter\let\csname tabu*\endcsname \tabu - \expandafter\def\csname endlongtabu*\endcsname{\endlongtabu}% - \let\LT@startpbox \tabu@LT@startpbox % \everypar{ array struts } - \tabu@spreadfalse \tabu@negcoeffalse \tabu@settarget -}% {longtabu} -\expandafter\def\csname longtabu*\endcsname{\tabuscantokenstrue \longtabu} -\def\tabu@nolongtabu{\PackageError{tabu} - {longtabu requires the longtable package}\@ehd} -%% Read the target and then : \tabular or \@array ------------------ -\def\tabu@settarget {\futurelet\@let@token \tabu@sett@rget } -\def\tabu@sett@rget {\tabu@target \z@ - \ifcase \ifx \bgroup\@let@token \z@ \else - \ifx \@sptoken\@let@token \@ne \else - \if t\@let@token \tw@ \else - \if s\@let@token \thr@@\else - \z@\fi\fi\fi\fi - \expandafter\tabu@begin - \or \expandafter\tabu@gobblespace\expandafter\tabu@settarget - \or \expandafter\tabu@to - \or \expandafter\tabu@spread - \fi -}% \tabu@sett@rget -\def\tabu@to to{\def\tabu@halignto{to}\tabu@gettarget} -\def\tabu@spread spread{\tabu@spreadtrue\def\tabu@halignto{spread}\tabu@gettarget} -\def\tabu@gettarget {\afterassignment\tabu@linegoaltarget \tabu@target } -\def\tabu@linegoaltarget {\futurelet\tabu@temp \tabu@linegoalt@rget } -\def\tabu@linegoalt@rget {% - \ifx \tabu@temp\LNGL@setlinegoal - \LNGL@setlinegoal \expandafter \@firstoftwo \fi % @gobbles \LNGL@setlinegoal - \tabu@begin -}% \tabu@linegoalt@rget -\def\tabu@begin #1#{% - \iftabu@measuring \expandafter\tabu@nestedmeasure \fi - \ifdim \tabu@target=\z@ \let\tabu@halignto \@empty - \else \edef\tabu@halignto{\tabu@halignto\the\tabu@target}% - \fi - \@testopt \tabu@tabu@ \tabu@aligndefault #1\@nil -}% \tabu@begin -\long\def\tabu@tabu@ [#1]#2\@nil #3{\tabu@setup - \def\tabu@align {#1}\def\tabu@savedpream{\NC@find #3}% - \tabu@ [\tabu@align ]#2{#3\tabu@rewritefirst }% -}% \tabu@tabu@ -\def\tabu@nestedmeasure {% - \ifodd 1\iftabu@spread \else \ifdim\tabu@target=\z@ \else 0 \fi\fi\relax - \tabu@spreadtrue - \else \begingroup \iffalse{\fi \ifnum0=`}\fi - \toks@{}\def\tabu@stack{b}% - \expandafter\tabu@collectbody\expandafter\tabu@quickrule - \expandafter\endgroup - \fi -}% \tabu@nestedmeasure -\def\tabu@quickrule {\indent\vrule height\z@ depth\z@ width\tabu@target} -%% \tabu@setup \tabu@init \tabu@indent -\def\tabu@setup{\tabu@alloc@ - \ifcase \tabu@nested - \ifmmode \else \iftabu@spread\else \ifdim\tabu@target=\z@ - \let\tabu@afterendpar \par - \fi\fi\fi - \def\tabu@aligndefault{c}\tabu@init \tabu@indent - \else % - \def\tabu@aligndefault{t}\let\tabudefaulttarget \linewidth - \fi - \let\tabu@thetarget \tabudefaulttarget \let\tabu@restored \@undefined - \edef\tabu@NC@list{\the\NC@list}\NC@list{\NC@do \tabu@rewritefirst}% - \everycr{}\let\@startpbox \tabu@startpbox % for nested tabu inside longtabu... - \let\@endpbox \tabu@endpbox % idem " " " " " " - \let\@tabarray \tabu@tabarray % idem " " " " " " - \tabu@setcleanup \tabu@setreset -}% \tabu@setup -\def\tabu@init{\tabu@starttimer \tabu@measuringfalse - \edef\tabu@hfuzz {\the\dimexpr\hfuzz+1sp}\global\tabu@footnotes{}% - \let\firsthline \tabu@firsthline \let\lasthline \tabu@lasthline - \let\firstline \tabu@firstline \let\lastline \tabu@lastline - \let\hline \tabu@hline \let\@xhline \tabu@xhline - \let\color \tabu@color \let\@arstrutbox \tabu@arstrutbox - \iftabu@colortbl\else\let\LT@@hline \tabu@LT@@hline \fi - \tabu@trivlist % - \let\@footnotetext \tabu@footnotetext \let\@xfootnotetext \tabu@xfootnotetext - \let\@xfootnote \tabu@xfootnote \let\centering \tabu@centering - \let\raggedright \tabu@raggedright \let\raggedleft \tabu@raggedleft - \let\tabudecimal \tabu@tabudecimal \let\Centering \tabu@Centering - \let\RaggedRight \tabu@RaggedRight \let\RaggedLeft \tabu@RaggedLeft - \let\justifying \tabu@justifying \let\rowfont \tabu@rowfont - \let\fbox \tabu@fbox \let\color@b@x \tabu@color@b@x - \let\tabu@@everycr \everycr \let\tabu@@everypar \everypar - \let\tabu@prepnext@tokORI \prepnext@tok\let\prepnext@tok \tabu@prepnext@tok - \let\tabu@multicolumnORI\multicolumn \let\multicolumn \tabu@multicolumn - \let\tabu@startpbox \@startpbox % for nested tabu inside longtabu pfff !!! - \let\tabu@endpbox \@endpbox % idem " " " " " " " - \let\tabu@tabarray \@tabarray % idem " " " " " " " - \tabu@adl@fix \let\endarray \tabu@endarray % colortbl & arydshln (delarray) - \iftabu@colortbl\CT@everycr\expandafter{\expandafter\iftabu@everyrow \the\CT@everycr \fi}\fi -}% \tabu@init -\def\tabu@indent{% correction for indentation - \ifdim \parindent>\z@\ifx \linewidth\tabudefaulttarget - \everypar\expandafter{% - \the\everypar\everypar\expandafter{\the\everypar}% - \setbox\z@=\lastbox - \ifdim\wd\z@>\z@ \edef\tabu@thetarget - {\the\dimexpr -\wd\z@+\tabudefaulttarget}\fi - \box\z@}% - \fi\fi -}% \tabu@indent -\def\tabu@setcleanup {% saves last global assignments - \ifodd 1\ifmmode \else \iftabu@long \else 0\fi\fi\relax - \def\tabu@aftergroupcleanup{% - \def\tabu@aftergroupcleanup{\aftergroup\tabu@cleanup}}% - \else - \def\tabu@aftergroupcleanup{% - \aftergroup\aftergroup\aftergroup\tabu@cleanup - \let\tabu@aftergroupcleanup \relax}% - \fi - \let\tabu@arc@Gsave \tabu@arc@G - \let\tabu@arc@G \tabu@arc@L % - \let\tabu@drsc@Gsave \tabu@drsc@G - \let\tabu@drsc@G \tabu@drsc@L % - \let\tabu@ls@Gsave \tabu@ls@G - \let\tabu@ls@G \tabu@ls@L % - \let\tabu@rc@Gsave \tabu@rc@G - \let\tabu@rc@G \tabu@rc@L % - \let\tabu@evr@Gsave \tabu@evr@G - \let\tabu@evr@G \tabu@evr@L % - \let\tabu@celllalign@save \tabu@celllalign - \let\tabu@cellralign@save \tabu@cellralign - \let\tabu@cellleft@save \tabu@cellleft - \let\tabu@cellright@save \tabu@cellright - \let\tabu@@celllalign@save \tabu@@celllalign - \let\tabu@@cellralign@save \tabu@@cellralign - \let\tabu@@cellleft@save \tabu@@cellleft - \let\tabu@@cellright@save \tabu@@cellright - \let\tabu@rowfontreset@save \tabu@rowfontreset - \let\tabu@@rowfontreset@save\tabu@@rowfontreset - \let\tabu@rowfontreset \@empty - \edef\tabu@alloc@save {\the\tabu@alloc}% restore at \tabu@reset - \edef\c@taburow@save {\the\c@taburow}% - \edef\tabu@naturalX@save {\the\tabu@naturalX}% - \let\tabu@naturalXmin@save \tabu@naturalXmin - \let\tabu@naturalXmax@save \tabu@naturalXmax - \let\tabu@mkarstrut@save \tabu@mkarstrut - \edef\tabu@clarstrut{% - \extrarowheight \the\dimexpr \ht\@arstrutbox-\ht\strutbox \relax - \extrarowdepth \the\dimexpr \dp\@arstrutbox-\dp\strutbox \relax - \let\noexpand\@arraystretch \@ne \noexpand\tabu@rearstrut}% -}% \tabu@setcleanup -\def\tabu@cleanup {\begingroup - \globaldefs\@ne \tabu@everyrowtrue - \let\tabu@arc@G \tabu@arc@Gsave - \let\CT@arc@ \tabu@arc@G - \let\tabu@drsc@G \tabu@drsc@Gsave - \let\CT@drsc@ \tabu@drsc@G - \let\tabu@ls@G \tabu@ls@Gsave - \let\tabu@ls@ \tabu@ls@G - \let\tabu@rc@G \tabu@rc@Gsave - \let\tabu@rc@ \tabu@rc@G - \let\CT@do@color \relax - \let\tabu@evr@G \tabu@evr@Gsave - \let\tabu@celllalign \tabu@celllalign@save - \let\tabu@cellralign \tabu@cellralign@save - \let\tabu@cellleft \tabu@cellleft@save - \let\tabu@cellright \tabu@cellright@save - \let\tabu@@celllalign \tabu@@celllalign@save - \let\tabu@@cellralign \tabu@@cellralign@save - \let\tabu@@cellleft \tabu@@cellleft@save - \let\tabu@@cellright \tabu@@cellright@save - \let\tabu@rowfontreset \tabu@rowfontreset@save - \let\tabu@@rowfontreset \tabu@@rowfontreset@save - \tabu@naturalX =\tabu@naturalX@save - \let\tabu@naturalXmax \tabu@naturalXmax@save - \let\tabu@naturalXmin \tabu@naturalXmin@save - \let\tabu@mkarstrut \tabu@mkarstrut@save - \c@taburow =\c@taburow@save - \ifcase \tabu@nested \tabu@alloc \m@ne\fi - \endgroup % - \ifcase \tabu@nested - \the\tabu@footnotes \global\tabu@footnotes{}% - \tabu@afterendpar \tabu@elapsedtime - \fi - \tabu@clarstrut - \everyrow\expandafter {\tabu@evr@G}% -}% \tabu@cleanup -\let\tabu@afterendpar \relax -\def\tabu@setreset {% - \edef\tabu@savedparams {% \relax for \tabu@message@save - \ifmmode \col@sep \the\arraycolsep - \else \col@sep \the\tabcolsep \fi \relax - \arrayrulewidth \the\arrayrulewidth \relax - \doublerulesep \the\doublerulesep \relax - \extratabsurround \the\extratabsurround \relax - \extrarowheight \the\extrarowheight \relax - \extrarowdepth \the\extrarowdepth \relax - \abovetabulinesep \the\abovetabulinesep \relax - \belowtabulinesep \the\belowtabulinesep \relax - \def\noexpand\arraystretch{\arraystretch}% - \ifdefined\minrowclearance \minrowclearance\the\minrowclearance\relax\fi}% - \begingroup - \@temptokena\expandafter{\tabu@savedparams}% => only for \savetabu / \usetabu - \ifx \tabu@arc@L\relax \else \tabu@setsave \tabu@arc@L \fi - \ifx \tabu@drsc@L\relax \else \tabu@setsave \tabu@drsc@L \fi - \tabu@setsave \tabu@ls@L \tabu@setsave \tabu@evr@L - \expandafter \endgroup \expandafter - \def\expandafter\tabu@saved@ \expandafter{\the\@temptokena - \let\tabu@arc@G \tabu@arc@L - \let\tabu@drsc@G \tabu@drsc@L - \let\tabu@ls@G \tabu@ls@L - \let\tabu@rc@G \tabu@rc@L - \let\tabu@evr@G \tabu@evr@L}% - \def\tabu@reset{\tabu@savedparams - \tabu@everyrowtrue \c@taburow \z@ - \let\CT@arc@ \tabu@arc@L - \let\CT@drsc@ \tabu@drsc@L - \let\tabu@ls@ \tabu@ls@L - \let\tabu@rc@ \tabu@rc@L - \global\tabu@alloc \tabu@alloc@save - \everyrow\expandafter{\tabu@evr@L}}% -}% \tabu@reset -\def\tabu@setsave #1{\expandafter\tabu@sets@ve #1\@nil{#1}} -\long\def\tabu@sets@ve #1\@nil #2{\@temptokena\expandafter{\the\@temptokena \def#2{#1}}} -%% The Rewriting Process ------------------------------------------- -\def\tabu@newcolumntype #1{% - \expandafter\tabu@new@columntype - \csname NC@find@\string#1\expandafter\endcsname - \csname NC@rewrite@\string#1\endcsname - {#1}% -}% \tabu@newcolumntype -\def\tabu@new@columntype #1#2#3{% - \def#1##1#3{\NC@{##1}}% - \let#2\relax \newcommand*#2% -}% \tabu@new@columntype -\def\tabu@privatecolumntype #1{% - \expandafter\tabu@private@columntype - \csname NC@find@\string#1\expandafter\endcsname - \csname NC@rewrite@\string#1\expandafter\endcsname - \csname tabu@NC@find@\string#1\expandafter\endcsname - \csname tabu@NC@rewrite@\string#1\endcsname - {#1}% -}% \tabu@privatecolumntype -\def\tabu@private@columntype#1#2#3#4{% - \g@addto@macro\tabu@privatecolumns{\let#1#3\let#2#4}% - \tabu@new@columntype#3#4% -}% \tabu@private@columntype -\let\tabu@privatecolumns \@empty -\newcommand*\tabucolumn [1]{\expandafter \def \expandafter - \tabu@highprioritycolumns\expandafter{\tabu@highprioritycolumns - \NC@do #1}}% -\let\tabu@highprioritycolumns \@empty -%% The | ``column'' : rewriting process -------------------------- -\tabu@privatecolumntype |{\tabu@rewritevline} -\newcommand*\tabu@rewritevline[1][]{\tabu@vlinearg{#1}% - \expandafter \NC@find \tabu@rewritten} -\def\tabu@lines #1{% - \ifx|#1\else \tabu@privatecolumntype #1{\tabu@rewritevline}\fi - \NC@list\expandafter{\the\NC@list \NC@do #1}% -}% \tabu@lines@ -\def\tabu@vlinearg #1{% - \ifx\\#1\\\def\tabu@thestyle {\tabu@ls@}% - \else\tabu@getline {#1}% - \fi - \def\tabu@rewritten ##1{\def\tabu@rewritten{!{##1\tabu@thevline}}% - }\expandafter\tabu@rewritten\expandafter{\tabu@thestyle}% - \expandafter \tabu@keepls \tabu@thestyle \@nil -}% \tabu@vlinearg -\def\tabu@keepls #1\@nil{% - \ifcat $\@cdr #1\@nil $% - \ifx \relax#1\else - \ifx \tabu@ls@#1\else - \let#1\relax - \xdef\tabu@mkpreambuffer{\tabu@mkpreambuffer - \tabu@savels\noexpand#1}\fi\fi\fi -}% \tabu@keepls -\def\tabu@thevline {\begingroup - \ifdefined\tabu@leaders - \setbox\@tempboxa=\vtop to\dimexpr - \ht\@arstrutbox+\dp\@arstrutbox{{\tabu@thevleaders}}% - \ht\@tempboxa=\ht\@arstrutbox \dp\@tempboxa=\dp\@arstrutbox - \box\@tempboxa - \else - \tabu@thevrule - \fi \endgroup -}% \tabu@thevline -\def\tabu@savels #1{% - \expandafter\let\csname\string#1\endcsname #1% - \expandafter\def\expandafter\tabu@reset\expandafter{\tabu@reset - \tabu@resetls#1}}% -\def\tabu@resetls #1{\expandafter\let\expandafter#1\csname\string#1\endcsname}% -%% \multicolumn inside tabu environment ----------------------------- -\tabu@newcolumntype \tabu@rewritemulticolumn{% - \aftergroup \tabu@endrewritemulticolumn % after \@mkpream group - \NC@list{\NC@do *}\tabu@textbar \tabu@lines - \tabu@savedecl - \tabu@privatecolumns - \NC@list\expandafter{\the\expandafter\NC@list \tabu@NC@list}% - \let\tabu@savels \relax - \NC@find -}% \tabu@rewritemulticolumn -\def\tabu@endrewritemulticolumn{\gdef\tabu@mkpreambuffer{}\endgroup} -\def\tabu@multicolumn{\tabu@ifenvir \tabu@multic@lumn \tabu@multicolumnORI} -\long\def\tabu@multic@lumn #1#2#3{\multispan{#1}\begingroup - \tabu@everyrowtrue - \NC@list{\NC@do \tabu@rewritemulticolumn}% - \expandafter\@gobbletwo % gobbles \multispan{#1} - \tabu@multicolumnORI{#1}{\tabu@rewritemulticolumn #2}% - {\iftabuscantokens \tabu@rescan \else \expandafter\@firstofone \fi - {#3}}% -}% \tabu@multic@lumn -%% The X column(s): rewriting process ----------------------------- -\tabu@privatecolumntype X[1][]{\begingroup \tabu@siunitx{\endgroup \tabu@rewriteX {#1}}} -\def\tabu@nosiunitx #1{#1{}{}\expandafter \NC@find \tabu@rewritten } -\def\tabu@siunitx #1{\@ifnextchar \bgroup - {\tabu@rewriteX@Ss{#1}} - {\tabu@nosiunitx{#1}}} -\def\tabu@rewriteX@Ss #1#2{\@temptokena{}% - \@defaultunits \let\tabu@temp =#2\relax\@nnil - \ifodd 1\ifx S\tabu@temp \else \ifx s\tabu@temp \else 0 \fi\fi - \def\NC@find{\def\NC@find >####1####2<####3\relax{#1 {####1}{####3}% - }\expandafter\NC@find \the\@temptokena \relax - }\expandafter\NC@rewrite@S \@gobble #2\relax - \else \tabu@siunitxerror - \fi - \expandafter \NC@find \tabu@rewritten -}% \tabu@rewriteX@Ss -\def\tabu@siunitxerror {\PackageError{tabu}{Not a S nor s column ! - \MessageBreak X column can only embed siunitx S or s columns}\@ehd -}% \tabu@siunitxerror -\def\tabu@rewriteX #1#2#3{\tabu@Xarg {#1}{#2}{#3}% - \iftabu@measuring - \else \tabu@measuringtrue % first X column found in the preamble - \let\@halignto \relax \let\tabu@halignto \relax - \iftabu@spread \tabu@spreadtarget \tabu@target \tabu@target \z@ - \else \tabu@spreadtarget \z@ \fi - \ifdim \tabu@target=\z@ - \setlength\tabu@target \tabu@thetarget - \tabu@message{\tabu@message@defaulttarget}% - \else \tabu@message{\tabu@message@target}\fi - \fi -}% \tabu@rewriteX -\def\tabu@rewriteXrestore #1#2#3{\let\@halignto \relax - \def\tabu@rewritten{l}} -\def\tabu@Xarg #1#2#3{% - \advance\tabu@Xcol \@ne \let\tabu@Xlcr \@empty - \let\tabu@Xdisp \@empty \let\tabu@Xmath \@empty - \ifx\\#1\\% - \def\tabu@rewritten{p}\tabucolX \p@ % - \else - \let\tabu@rewritten \@empty \let\tabu@temp \@empty \tabucolX \z@ - \tabu@Xparse {}#1\relax - \fi - \tabu@Xrewritten{#2}{#3}% -}% \tabu@Xarg -\def\tabu@Xparse #1{\futurelet\@let@token \tabu@Xtest} -\expandafter\def\expandafter\tabu@Xparsespace\space{\tabu@Xparse{}} -\def\tabu@Xtest{% - \ifcase \ifx \relax\@let@token \z@ \else - \if ,\@let@token \m@ne\else - \if p\@let@token 1\else - \if m\@let@token 2\else - \if b\@let@token 3\else - \if l\@let@token 4\else - \if c\@let@token 5\else - \if r\@let@token 6\else - \if j\@let@token 7\else - \if L\@let@token 8\else - \if C\@let@token 9\else - \if R\@let@token 10\else - \if J\@let@token 11\else - \ifx \@sptoken\@let@token 12\else - \if .\@let@token 13\else - \if -\@let@token 13\else - \ifcat $\@let@token 14\else - 15\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\relax - \or \tabu@Xtype {p}% - \or \tabu@Xtype {m}% - \or \tabu@Xtype {b}% - \or \tabu@Xalign \raggedright\relax - \or \tabu@Xalign \centering\relax - \or \tabu@Xalign \raggedleft\relax - \or \tabu@Xalign \tabu@justify\relax - \or \tabu@Xalign \RaggedRight\raggedright - \or \tabu@Xalign \Centering\centering - \or \tabu@Xalign \RaggedLeft\raggedleft - \or \tabu@Xalign \justifying\tabu@justify - \or \expandafter \tabu@Xparsespace - \or \expandafter \tabu@Xcoef - \or \expandafter \tabu@Xm@th - \or \tabu@Xcoef{}% - \else\expandafter \tabu@Xparse - \fi -}% \tabu@Xtest -\def\tabu@Xalign #1#2{% - \ifx \tabu@Xlcr\@empty \else \PackageWarning{tabu} - {Duplicate horizontal alignment specification}\fi - \ifdefined#1\def\tabu@Xlcr{#1}\let#1\relax - \else \def\tabu@Xlcr{#2}\let#2\relax\fi - \expandafter\tabu@Xparse -}% \tabu@Xalign -\def\tabu@Xtype #1{% - \ifx \tabu@rewritten\@empty \else \PackageWarning{tabu} - {Duplicate vertical alignment specification}\fi - \def\tabu@rewritten{#1}\expandafter\tabu@Xparse -}% \tabu@Xtype -\def\tabu@Xcoef#1{\edef\tabu@temp{\tabu@temp#1}% - \afterassignment\tabu@Xc@ef \tabu@cnt\number\if-#10\fi -}% \tabu@Xcoef -\def\tabu@Xc@ef{\advance\tabucolX \tabu@temp\the\tabu@cnt\p@ - \tabu@Xparse{}% -}% \tabu@Xc@ef -\def\tabu@Xm@th #1{\futurelet \@let@token \tabu@Xd@sp} -\def\tabu@Xd@sp{\let\tabu@Xmath=$% - \ifx $\@let@token \def\tabu@Xdisp{\displaystyle}% - \expandafter\tabu@Xparse - \else \expandafter\tabu@Xparse\expandafter{\expandafter}% - \fi -}% \tabu@Xd@sp -\def\tabu@Xrewritten {% - \ifx \tabu@rewritten\@empty \def\tabu@rewritten{p}\fi - \ifdim \tabucolX<\z@ \tabu@negcoeftrue - \else\ifdim \tabucolX=\z@ \tabucolX \p@ - \fi\fi - \edef\tabu@temp{{\the\tabu@Xcol}{\tabu@strippt\tabucolX}}% - \edef\tabu@Xcoefs{\tabu@Xcoefs \tabu@ \tabu@temp}% - \edef\tabu@rewritten ##1##2{\def\noexpand\tabu@rewritten{% - >{\tabu@Xlcr \ifx$\tabu@Xmath$\tabu@Xdisp\fi ##1}% - \tabu@rewritten {\tabu@hsize \tabu@temp}% - <{##2\ifx$\tabu@Xmath$\fi}}% - }\tabu@rewritten -}% \tabu@Xrewritten -\def\tabu@hsize #1#2{% - \ifdim #2\p@<\z@ - \ifdim \tabucolX=\maxdimen \tabu@wd{#1}\else - \ifdim \tabu@wd{#1}<-#2\tabucolX \tabu@wd{#1}\else -#2\tabucolX\fi - \fi - \else #2\tabucolX - \fi -}% \tabu@hsize -%% \usetabu and \preamble: rewriting process --------------------- -\tabu@privatecolumntype \usetabu [1]{% - \ifx\\#1\\\tabu@saveerr{}\else - \@ifundefined{tabu@saved@\string#1} - {\tabu@saveerr{#1}} - {\let\tabu@rewriteX \tabu@rewriteXrestore - \csname tabu@saved@\string#1\expandafter\endcsname\expandafter\@ne}% - \fi -}% \NC@rewrite@\usetabu -\tabu@privatecolumntype \preamble [1]{% - \ifx\\#1\\\tabu@saveerr{}\else - \@ifundefined{tabu@saved@\string#1} - {\tabu@saveerr{#1}} - {\csname tabu@saved@\string#1\expandafter\endcsname\expandafter\z@}% - \fi -}% \NC@rewrite@\preamble -%% Controlling the rewriting process ------------------------------- -\tabu@newcolumntype \tabu@rewritefirst{% - \iftabu@long \aftergroup \tabu@longpream % - \else \aftergroup \tabu@pream - \fi - \let\tabu@ \relax \let\tabu@hsize \relax - \let\tabu@Xcoefs \@empty \let\tabu@savels \relax - \tabu@Xcol \z@ \tabu@cnt \tw@ - \gdef\tabu@mkpreambuffer{\tabu@{}}\tabu@measuringfalse - \global\setbox\@arstrutbox \box\@arstrutbox - \NC@list{\NC@do *}\tabu@textbar \tabu@lines - \NC@list\expandafter{\the\NC@list \NC@do X}% - \iftabu@siunitx % - \NC@list\expandafter{\the\NC@list \NC@do S\NC@do s}\fi - \NC@list\expandafter{\the\expandafter\NC@list \tabu@highprioritycolumns}% - \expandafter\def\expandafter\tabu@NC@list\expandafter{% - \the\expandafter\NC@list \tabu@NC@list}% % * | X S - \NC@list\expandafter{\expandafter \NC@do \expandafter\usetabu - \expandafter \NC@do \expandafter\preamble - \the\NC@list \NC@do \tabu@rewritemiddle - \NC@do \tabu@rewritelast}% - \tabu@savedecl - \tabu@privatecolumns - \edef\tabu@prev{\the\@temptokena}\NC@find \tabu@rewritemiddle -}% NC@rewrite@\tabu@rewritefirst -\tabu@newcolumntype \tabu@rewritemiddle{% - \edef\tabu@temp{\the\@temptokena}\NC@find \tabu@rewritelast -}% \NC@rewrite@\tabu@rewritemiddle -\tabu@newcolumntype \tabu@rewritelast{% - \ifx \tabu@temp\tabu@prev \advance\tabu@cnt \m@ne - \NC@list\expandafter{\tabu@NC@list \NC@do \tabu@rewritemiddle - \NC@do \tabu@rewritelast}% - \else \let\tabu@prev\tabu@temp - \fi - \ifcase \tabu@cnt \expandafter\tabu@endrewrite - \else \expandafter\NC@find \expandafter\tabu@rewritemiddle - \fi -}% \NC@rewrite@\tabu@rewritelast -%% Choosing the strategy -------------------------------------------- -\def\tabu@endrewrite {% - \let\tabu@temp \NC@find - \ifx \@arrayright\relax \let\@arrayright \@empty \fi - \count@=% - \ifx \@finalstrut\tabu@finalstrut \z@ % outer in mode 0 print - \iftabu@measuring - \xdef\tabu@mkpreambuffer{\tabu@mkpreambuffer - \tabu@target \csname tabu@\the\tabu@nested.T\endcsname - \tabucolX \csname tabu@\the\tabu@nested.X\endcsname - \edef\@halignto {\ifx\@arrayright\@empty to\tabu@target\fi}}% - \fi - \else\iftabu@measuring 4 % X columns - \xdef\tabu@mkpreambuffer{\tabu@{\tabu@mkpreambuffer - \tabu@target \the\tabu@target - \tabu@spreadtarget \the\tabu@spreadtarget}% - \def\noexpand\tabu@Xcoefs{\tabu@Xcoefs}% - \edef\tabu@halignto{\ifx \@arrayright\@empty to\tabu@target\fi}}% - \let\tabu@Xcoefs \relax - \else\ifcase\tabu@nested \thr@@ % outer, no X - \global\let\tabu@afterendpar \relax - \else \@ne % inner, no X, outer in mode 1 or 2 - \fi - \ifdefined\tabu@usetabu - \else \ifdim\tabu@target=\z@ - \else \let\tabu@temp \tabu@extracolsep - \fi\fi - \fi - \fi - \xdef\tabu@mkpreambuffer{\count@ \the\count@ \tabu@mkpreambuffer}% - \tabu@temp -}% \tabu@endrewrite -\def\tabu@extracolsep{\@defaultunits \expandafter\let - \expandafter\tabu@temp \expandafter=\the\@temptokena \relax\@nnil - \ifx \tabu@temp\@sptoken - \expandafter\tabu@gobblespace \expandafter\tabu@extracolsep - \else - \edef\tabu@temp{\noexpand\NC@find - \if |\noexpand\tabu@temp @% - \else\if !\noexpand\tabu@temp @% - \else !% - \fi\fi - {\noexpand\extracolsep\noexpand\@flushglue}}% - \fi - \tabu@temp -}% \tabu@extrac@lsep -%% Implementing the strategy ---------------------------------------- -\long\def\tabu@pream #1\@preamble {% - \let\tabu@ \tabu@@ \tabu@mkpreambuffer \tabu@aftergroupcleanup - \NC@list\expandafter {\tabu@NC@list}% in case of nesting... - \ifdefined\tabu@usetabu \tabu@usetabu \tabu@target \z@ \fi - \let\tabu@savedpreamble \@preamble - \global\let\tabu@elapsedtime \relax - \tabu@thebody ={#1\tabu@aftergroupcleanup}% - \tabu@thebody =\expandafter{\the\expandafter\tabu@thebody - \@preamble}% - \edef\tabuthepreamble {\the\tabu@thebody}% ( no @ allowed for \scantokens ) - \tabu@select -}% \tabu@pream -\long\def\tabu@longpream #1\LT@bchunk #2\LT@bchunk{% - \let\tabu@ \tabu@@ \tabu@mkpreambuffer \tabu@aftergroupcleanup - \NC@list\expandafter {\tabu@NC@list}% in case of nesting... - \let\tabu@savedpreamble \@preamble - \global\let\tabu@elapsedtime \relax - \tabu@thebody ={#1\LT@bchunk #2\tabu@aftergroupcleanup \LT@bchunk}% - \edef\tabuthepreamble {\the\tabu@thebody}% ( no @ allowed for \scantokens ) - \tabu@select -}% \tabu@longpream -\def\tabu@select {% - \ifnum\tabu@nested>\z@ \tabuscantokensfalse \fi - \ifnum \count@=\@ne \iftabu@measuring \count@=\tw@ \fi\fi - \ifcase \count@ - \global\let\tabu@elapsedtime \relax - \tabu@seteverycr - \expandafter \tabuthepreamble % vertical adjustment (inherited from outer) - \or % exit in vertical measure + struts per cell because no X and outer in mode 3 - \tabu@evr{\tabu@verticalinit}\tabu@celllalign@def{\tabu@verticalmeasure}% - \def\tabu@cellralign{\tabu@verticalspacing}% - \tabu@seteverycr - \expandafter \tabuthepreamble - \or % exit without measure because no X and outer in mode 4 - \tabu@evr{}\tabu@celllalign@def{}\let\tabu@cellralign \@empty - \tabu@seteverycr - \expandafter \tabuthepreamble - \else % needs trials - \tabu@evr{}\tabu@celllalign@def{}\let\tabu@cellralign \@empty - \tabu@savecounters - \expandafter \tabu@setstrategy - \fi -}% \tabu@select -\def\tabu@@ {\gdef\tabu@mkpreambuffer} -%% Protections to set up before trials ------------------------------ -\def\tabu@setstrategy {\begingroup % - \tabu@trialh@@k \tabu@cnt \z@ % number of trials - \hbadness \@M \let\hbadness \@tempcnta - \hfuzz \maxdimen \let\hfuzz \@tempdima - \let\write \tabu@nowrite\let\GenericError \tabu@GenericError - \let\savetabu \@gobble \let\tabudefaulttarget \linewidth - \let\@footnotetext \@gobble \let\@xfootnote \tabu@xfootnote - \let\color \tabu@nocolor\let\rowcolor \tabu@norowcolor - \let\tabu@aftergroupcleanup \relax % only after the last trial - \tabu@mkpreambuffer - \ifnum \count@>\thr@@ \let\@halignto \@empty \tabucolX@init - \def\tabu@lasttry{\m@ne\p@}\fi - \begingroup \iffalse{\fi \ifnum0=`}\fi - \toks@{}\def\tabu@stack{b}\iftabuscantokens \endlinechar=10 \obeyspaces \fi % - \tabu@collectbody \tabu@strategy % -}% \tabu@setstrategy -\def\tabu@savecounters{% - \def\@elt ##1{\csname c@##1\endcsname\the\csname c@##1\endcsname}% - \edef\tabu@clckpt {\begingroup \globaldefs=\@ne \cl@@ckpt \endgroup}\let\@elt \relax -}% \tabu@savecounters -\def\tabucolX@init {% \tabucolX <= \tabu@target / (sum coefs > 0) - \dimen@ \z@ \tabu@Xsum \z@ \tabucolX \z@ \let\tabu@ \tabu@Xinit \tabu@Xcoefs - \ifdim \dimen@>\z@ - \@tempdima \dimexpr \tabu@target *\p@/\dimen@ + \tabu@hfuzz\relax - \ifdim \tabucolX<\@tempdima \tabucolX \@tempdima \fi - \fi -}% \tabucolX@init -\def\tabu@Xinit #1#2{\tabu@Xcol #1 \advance \tabu@Xsum - \ifdim #2\p@>\z@ #2\p@ \advance\dimen@ #2\p@ - \else -#2\p@ \tabu@negcoeftrue - \@tempdima \dimexpr \tabu@target*\p@/\dimexpr-#2\p@\relax \relax - \ifdim \tabucolX<\@tempdima \tabucolX \@tempdima \fi - \tabu@wddef{#1}{0pt}% - \fi -}% \tabu@Xinit -%% Collecting the environment body ---------------------------------- -\long\def\tabu@collectbody #1#2\end #3{% - \edef\tabu@stack{\tabu@pushbegins #2\begin\end\expandafter\@gobble\tabu@stack}% - \ifx \tabu@stack\@empty - \toks@\expandafter{\expandafter\tabu@thebody\expandafter{\the\toks@ #2}% - \def\tabu@end@envir{\end{#3}}% - \iftabuscantokens - \iftabu@long \def\tabu@endenvir {\end{#3}\tabu@gobbleX}% - \else \def\tabu@endenvir {\let\endarray \@empty - \end{#3}\tabu@gobbleX}% - \fi - \else \def\tabu@endenvir {\end{#3}}\fi}% - \let\tabu@collectbody \tabu@endofcollect - \else\def\tabu@temp{#3}% - \ifx \tabu@temp\@empty \toks@\expandafter{\the\toks@ #2\end }% - \else \ifx\tabu@temp\tabu@@spxiii \toks@\expandafter{\the\toks@ #2\end #3}% - \else \ifx\tabu@temp\tabu@X \toks@\expandafter{\the\toks@ #2\end #3}% - \else \toks@\expandafter{\the\toks@ #2\end{#3}}% - \fi\fi\fi - \fi - \tabu@collectbody{#1}% -}% \tabu@collectbody -\long\def\tabu@pushbegins#1\begin#2{\ifx\end#2\else b\expandafter\tabu@pushbegins\fi}% -\def\tabu@endofcollect #1{\ifnum0=`{}\fi - \expandafter\endgroup \the\toks@ #1% -}% \tabu@endofcollect -%% The trials: switching between strategies ------------------------- -\def\tabu@strategy {\relax % stops \count@ assignment ! - \ifcase\count@ % case 0 = print with vertical adjustment (outer is finished) - \expandafter \tabu@endoftrials - \or % case 1 = exit in vertical measure (outer in mode 3) - \expandafter\xdef\csname tabu@\the\tabu@nested.T\endcsname{\the\tabu@target}% - \expandafter\xdef\csname tabu@\the\tabu@nested.X\endcsname{\the\tabucolX}% - \expandafter \tabu@endoftrials - \or % case 2 = exit with a rule replacing the table (outer in mode 4) - \expandafter \tabu@quickend - \or % case 3 = outer is in mode 3 because of no X - \begingroup - \tabu@evr{\tabu@verticalinit}\tabu@celllalign@def{\tabu@verticalmeasure}% - \def\tabu@cellralign{\tabu@verticalspacing}% - \expandafter \tabu@measuring - \else % case 4 = horizontal measure - \begingroup - \global\let\tabu@elapsedtime \tabu@message@etime - \long\def\multicolumn##1##2##3{\multispan{##1}}% - \let\tabu@startpboxORI \@startpbox - \iftabu@spread - \def\tabu@naturalXmax {\z@}% - \let\tabu@naturalXmin \tabu@naturalXmax - \tabu@evr{\global\tabu@naturalX \z@}% - \let\@startpbox \tabu@startpboxmeasure - \else\iftabu@negcoef - \let\@startpbox \tabu@startpboxmeasure - \else \let\@startpbox \tabu@startpboxquick - \fi\fi - \expandafter \tabu@measuring - \fi -}% \tabu@strategy -\def\tabu@measuring{\expandafter \tabu@trial \expandafter - \count@ \the\count@ \tabu@endtrial -}% \tabu@measuring -\def\tabu@trial{\iftabu@long \tabu@longtrial \else \tabu@shorttrial \fi} -\def\tabu@shorttrial {\setbox\tabu@box \hbox\bgroup \tabu@seteverycr - \ifx \tabu@savecounters\relax \else - \let\tabu@savecounters \relax \tabu@clckpt \fi - $\iftabuscantokens \tabu@rescan \else \expandafter\@secondoftwo \fi - \expandafter{\expandafter \tabuthepreamble - \the\tabu@thebody - \csname tabu@adl@endtrial\endcsname - \endarray}$\egroup % got \tabu@box -}% \tabu@shorttrial -\def\tabu@longtrial {\setbox\tabu@box \hbox\bgroup \tabu@seteverycr - \ifx \tabu@savecounters\relax \else - \let\tabu@savecounters \relax \tabu@clckpt \fi - \iftabuscantokens \tabu@rescan \else \expandafter\@secondoftwo \fi - \expandafter{\expandafter \tabuthepreamble - \the\tabu@thebody - \tabuendlongtrial}\egroup % got \tabu@box -}% \tabu@longtrial -\def\tabuendlongtrial{% no @ allowed for \scantokens - \LT@echunk \global\setbox\@ne \hbox{\unhbox\@ne}\kern\wd\@ne - \LT@get@widths -}% \tabuendlongtrial -\def\tabu@adl@endtrial{% - \crcr \noalign{\global\adl@ncol \tabu@nbcols}}% anything global is crap, junky and fails ! -\def\tabu@seteverycr {\tabu@reset - \everycr \expandafter{\the\everycr \tabu@everycr}% - \let\everycr \tabu@noeverycr % -}% \tabu@seteverycr -\def\tabu@noeverycr{{\aftergroup\tabu@restoreeverycr \afterassignment}\toks@} -\def\tabu@restoreeverycr {\let\everycr \tabu@@everycr} -\def\tabu@everycr {\iftabu@everyrow \noalign{\tabu@everyrow}\fi} -\def\tabu@endoftrials {% - \iftabuscantokens \expandafter\@firstoftwo - \else \expandafter\@secondoftwo - \fi - {\expandafter \tabu@closetrialsgroup \expandafter - \tabu@rescan \expandafter{% - \expandafter\tabuthepreamble - \the\expandafter\tabu@thebody - \iftabu@long \else \endarray \fi}} - {\expandafter\tabu@closetrialsgroup \expandafter - \tabuthepreamble - \the\tabu@thebody}% - \tabu@endenvir % Finish ! -}% \tabu@endoftrials -\def\tabu@closetrialsgroup {% - \toks@\expandafter{\tabu@endenvir}% - \edef\tabu@bufferX{\endgroup - \tabucolX \the\tabucolX - \tabu@target \the\tabu@target - \tabu@cnt \the\tabu@cnt - \def\noexpand\tabu@endenvir{\the\toks@}% - %Quid de \@halignto = \tabu@halignto ?? - }% \tabu@bufferX - \tabu@bufferX - \ifcase\tabu@nested % print out (outer in mode 0) - \global\tabu@cnt \tabu@cnt - \tabu@evr{\tabu@verticaldynamicadjustment}% - \tabu@celllalign@def{\everypar{}}\let\tabu@cellralign \@empty - \let\@finalstrut \tabu@finalstrut - \else % vertical measure of nested tabu - \tabu@evr{\tabu@verticalinit}% - \tabu@celllalign@def{\tabu@verticalmeasure}% - \def\tabu@cellralign{\tabu@verticalspacing}% - \fi - \tabu@clckpt \let\@halignto \tabu@halignto - \let\@halignto \@empty - \tabu@seteverycr - \ifdim \tabustrutrule>\z@ \ifnum\tabu@nested=\z@ - \setbox\@arstrutbox \box\voidb@x % force \@arstrutbox to be rebuilt (visible struts) - \fi\fi -}% \tabu@closetrialsgroup -\def\tabu@quickend {\expandafter \endgroup \expandafter - \tabu@target \the\tabu@target \tabu@quickrule - \let\endarray \relax \tabu@endenvir -}% \tabu@quickend -\def\tabu@endtrial {\relax % stops \count@ assignment ! - \ifcase \count@ \tabu@err % case 0 = impossible here - \or \tabu@err % case 1 = impossible here - \or \tabu@err % case 2 = impossible here - \or % case 3 = outer goes into mode 0 - \def\tabu@bufferX{\endgroup}\count@ \z@ - \else % case 4 = outer goes into mode 3 - \iftabu@spread \tabu@spreadarith % inner into mode 1 (outer in mode 3) - \else \tabu@arith % or 2 (outer in mode 4) - \fi - \count@=% - \ifcase\tabu@nested \thr@@ % outer goes into mode 3 - \else\iftabu@measuring \tw@ % outer is in mode 4 - \else \@ne % outer is in mode 3 - \fi\fi - \edef\tabu@bufferX{\endgroup - \tabucolX \the\tabucolX - \tabu@target \the\tabu@target}% - \fi - \expandafter \tabu@bufferX \expandafter - \count@ \the\count@ \tabu@strategy -}% \tabu@endtrial -\def\tabu@err{\errmessage{(tabu) Internal impossible error! (\count@=\the\count@)}} -%% The algorithms: compute the widths / stop or go on --------------- -\def\tabu@arithnegcoef {% - \@tempdima \z@ \dimen@ \z@ \let\tabu@ \tabu@arith@negcoef \tabu@Xcoefs -}% \tabu@arithnegcoef -\def\tabu@arith@negcoef #1#2{% - \ifdim #2\p@>\z@ \advance\dimen@ #2\p@ % saturated by definition - \advance\@tempdima #2\tabucolX - \else - \ifdim -#2\tabucolX <\tabu@wd{#1}% c_i X < natural width <= \tabu@target-> saturated - \advance\dimen@ -#2\p@ - \advance\@tempdima -#2\tabucolX - \else - \advance\@tempdima \tabu@wd{#1}% natural width <= c_i X => neutralised - \ifdim \tabu@wd{#1}<\tabu@target \else % neutralised - \advance\dimen@ -#2\p@ % saturated (natural width = tabu@target) - \fi - \fi - \fi -}% \tabu@arith@negcoef -\def\tabu@givespace #1#2{% here \tabu@DELTA < \z@ - \ifdim \@tempdima=\z@ - \tabu@wddef{#1}{\the\dimexpr -\tabu@DELTA*\p@/\tabu@Xsum}% - \else - \tabu@wddef{#1}{\the\dimexpr \tabu@hsize{#1}{#2} - *(\p@ -\tabu@DELTA*\p@/\@tempdima)/\p@\relax}% - \fi -}% \tabu@givespace -\def\tabu@arith {\advance\tabu@cnt \@ne - \ifnum \tabu@cnt=\@ne \tabu@message{\tabu@titles}\fi - \tabu@arithnegcoef - \@tempdimb \dimexpr \wd\tabu@box -\@tempdima \relax % - \tabu@DELTA = \dimexpr \wd\tabu@box - \tabu@target \relax - \tabu@message{\tabu@message@arith}% - \ifdim \tabu@DELTA <\tabu@hfuzz - \ifdim \tabu@DELTA<\z@ % wd (tabu)<\tabu@target ? - \let\tabu@ \tabu@givespace \tabu@Xcoefs - \advance\@tempdima \@tempdimb \advance\@tempdima -\tabu@DELTA % for message - \else % already converged: nothing to do but nearly impossible... - \fi - \tabucolX \maxdimen - \tabu@measuringfalse - \else % need for narrower X columns - \tabucolX =\dimexpr (\@tempdima -\tabu@DELTA) *\p@/\tabu@Xsum \relax - \tabu@measuringtrue - \@whilesw \iftabu@measuring\fi {% - \advance\tabu@cnt \@ne - \tabu@arithnegcoef - \tabu@DELTA =\dimexpr \@tempdima+\@tempdimb -\tabu@target \relax % always < 0 here - \tabu@message{\tabu@header - \tabu@msgalign \tabucolX { }{ }{ }{ }{ }\@@ - \tabu@msgalign \@tempdima+\@tempdimb { }{ }{ }{ }{ }\@@ - \tabu@msgalign \tabu@target { }{ }{ }{ }{ }\@@ - \tabu@msgalign@PT \dimen@ { }{}{}{}{}{}{}\@@ - \ifdim -\tabu@DELTA<\tabu@hfuzz \tabu@spaces target ok\else - \tabu@msgalign \dimexpr -\tabu@DELTA *\p@/\dimen@ {}{}{}{}{}\@@ - \fi}% - \ifdim -\tabu@DELTA<\tabu@hfuzz - \advance\@tempdima \@tempdimb % for message - \tabu@measuringfalse - \else - \advance\tabucolX \dimexpr -\tabu@DELTA *\p@/\dimen@ \relax - \fi - }% - \fi - \tabu@message{\tabu@message@reached}% - \edef\tabu@bufferX{\endgroup \tabu@cnt \the\tabu@cnt - \tabucolX \the\tabucolX - \tabu@target \the\tabu@target}% -}% \tabu@arith -\def\tabu@spreadarith {% - \dimen@ \z@ \@tempdima \tabu@naturalXmax \let\tabu@ \tabu@spread@arith \tabu@Xcoefs - \edef\tabu@naturalXmin {\the\dimexpr\tabu@naturalXmin*\dimen@/\p@}% - \@tempdimc =\dimexpr \wd\tabu@box -\tabu@naturalXmax+\tabu@naturalXmin \relax - \iftabu@measuring - \tabu@target =\dimexpr \@tempdimc+\tabu@spreadtarget \relax - \edef\tabu@bufferX{\endgroup \tabucolX \the\tabucolX \tabu@target\the\tabu@target}% - \else - \tabu@message{\tabu@message@spreadarith}% - \ifdim \dimexpr \@tempdimc+\tabu@spreadtarget >\tabu@target - \tabu@message{(tabu) spread - \ifdim \@tempdimc>\tabu@target useless here: default target used% - \else too large: reduced to fit default target\fi.}% - \else - \tabu@target =\dimexpr \@tempdimc+\tabu@spreadtarget \relax - \tabu@message{(tabu) spread: New target set to \the\tabu@target^^J}% - \fi - \begingroup \let\tabu@wddef \@gobbletwo - \@tempdimb \@tempdima - \tabucolX@init - \tabu@arithnegcoef - \wd\tabu@box =\dimexpr \wd\tabu@box +\@tempdima-\@tempdimb \relax - \expandafter\endgroup \expandafter\tabucolX \the\tabucolX - \tabu@arith - \fi -}% \tabu@spreadarith -\def\tabu@spread@arith #1#2{% - \ifdim #2\p@>\z@ \advance\dimen@ #2\p@ - \else \advance\@tempdima \tabu@wd{#1}\relax - \fi -}% \tabu@spread@arith -%% Reporting in the .log file --------------------------------------- -\def\tabu@message@defaulttarget{% - \ifnum\tabu@nested=\z@^^J(tabu) Default target: - \ifx\tabudefaulttarget\linewidth \string\linewidth - \ifdim \tabu@thetarget=\linewidth \else - -\the\dimexpr\linewidth-\tabu@thetarget\fi = - \else\ifx\tabudefaulttarget\linegoal\string\linegoal= - \fi\fi - \else (tabu) Default target (nested): \fi - \the\tabu@target \on@line - \ifnum\tabu@nested=\z@ , page \the\c@page\fi} -\def\tabu@message@target {^^J(tabu) Target specified: - \the\tabu@target \on@line, page \the\c@page} -\def\tabu@message@arith {\tabu@header - \tabu@msgalign \tabucolX { }{ }{ }{ }{ }\@@ - \tabu@msgalign \wd\tabu@box { }{ }{ }{ }{ }\@@ - \tabu@msgalign \tabu@target { }{ }{ }{ }{ }\@@ - \tabu@msgalign@PT \dimen@ { }{}{}{}{}{}{}\@@ - \ifdim \tabu@DELTA<\tabu@hfuzz giving space\else - \tabu@msgalign \dimexpr (\@tempdima-\tabu@DELTA) *\p@/\tabu@Xsum -\tabucolX {}{}{}{}{}\@@ - \fi -}% \tabu@message@arith -\def\tabu@message@spreadarith {\tabu@spreadheader - \tabu@msgalign \tabu@spreadtarget { }{ }{ }{ }{}\@@ - \tabu@msgalign \wd\tabu@box { }{ }{ }{ }{}\@@ - \tabu@msgalign -\tabu@naturalXmax { }{}{}{}{}\@@ - \tabu@msgalign \tabu@naturalXmin { }{ }{ }{ }{}\@@ - \tabu@msgalign \ifdim \dimexpr\@tempdimc>\tabu@target \tabu@target - \else \@tempdimc+\tabu@spreadtarget \fi - {}{}{}{}{}\@@} -\def\tabu@message@negcoef #1#2{ - \tabu@spaces\tabu@spaces\space * #1. X[\rem@pt#2]: - \space width = \tabu@wd {#1} - \expandafter\string\csname tabu@\the\tabu@nested.W\number#1\endcsname - \ifdim -\tabu@pt#2\tabucolX<\tabu@target - < \number-\rem@pt#2 X - = \the\dimexpr -\tabu@pt#2\tabucolX \relax - \else - <= \the\tabu@target\space < \number-\rem@pt#2 X\fi} -\def\tabu@message@reached{\tabu@header - ******* Reached Target: - hfuzz = \tabu@hfuzz\on@line\space *******} -\def\tabu@message@etime{\edef\tabu@stoptime{\the\pdfelapsedtime}% - \tabu@message{(tabu)\tabu@spaces Time elapsed during measure: - \the\numexpr(\tabu@stoptime-\tabu@starttime-32767)/65536\relax sec - \the\numexpr\numexpr(\tabu@stoptime-\tabu@starttime) - -\numexpr(\tabu@stoptime-\tabu@starttime-32767)/65536\relax*65536\relax - *1000/65536\relax ms \tabu@spaces(\the\tabu@cnt\space - cycle\ifnum\tabu@cnt>\@ne s\fi)^^J^^J}} -\def\tabu@message@verticalsp {% - \ifdim \@tempdima>\tabu@ht - \ifdim \@tempdimb>\tabu@dp - \expandafter\expandafter\expandafter\string\tabu@ht = - \tabu@msgalign \@tempdima { }{ }{ }{ }{ }\@@ - \expandafter\expandafter\expandafter\string\tabu@dp = - \tabu@msgalign \@tempdimb { }{ }{ }{ }{ }\@@^^J% - \else - \expandafter\expandafter\expandafter\string\tabu@ht = - \tabu@msgalign \@tempdima { }{ }{ }{ }{ }\@@^^J% - \fi - \else\ifdim \@tempdimb>\tabu@dp - \tabu@spaces\tabu@spaces\tabu@spaces - \expandafter\expandafter\expandafter\string\tabu@dp = - \tabu@msgalign \@tempdimb { }{ }{ }{ }{ }\@@^^J\fi - \fi -}% \tabu@message@verticalsp -\edef\tabu@spaces{\@spaces} -\def\tabu@strippt{\expandafter\tabu@pt\the} -{\@makeother\P \@makeother\T\lowercase{\gdef\tabu@pt #1PT{#1}}} -\def\tabu@msgalign{\expandafter\tabu@msg@align\the\dimexpr} -\def\tabu@msgalign@PT{\expandafter\tabu@msg@align\romannumeral-`\0\tabu@strippt} -\def\do #1{% - \def\tabu@msg@align##1.##2##3##4##5##6##7##8##9\@@{% - \ifnum##1<10 #1 #1\else - \ifnum##1<100 #1 \else - \ifnum##1<\@m #1\fi\fi\fi - ##1.##2##3##4##5##6##7##8#1}% - \def\tabu@header{(tabu) \ifnum\tabu@cnt<10 #1\fi\the\tabu@cnt) }% - \def\tabu@titles{\ifnum \tabu@nested=\z@ - (tabu) Try#1 #1 tabu X #1 #1 #1tabu Width #1 #1 Target - #1 #1 #1 Coefs #1 #1 #1 Update^^J\fi}% - \def\tabu@spreadheader{% - (tabu) Try#1 #1 Spread #1 #1 tabu Width #1 #1 #1 Nat. X #1 #1 #1 #1Nat. Min. - #1 New Target^^J% - (tabu) sprd} - \def\tabu@message@save {\begingroup - \def\x ####1{\tabu@msg@align ####1{ }{ }{ }{ }{}\@@} - \def\z ####1{\expandafter\x\expandafter{\romannumeral-`\0\tabu@strippt - \dimexpr####1\p@{ }{ }}}% - \let\color \relax \def\tabu@rulesstyle ####1####2{\detokenize{####1}}% - \let\CT@arc@ \relax \let\@preamble \@gobble - \let\tabu@savedpream \@firstofone - \let\tabu@savedparams \@firstofone - \def\tabu@target ####1\relax {(tabu) target #1 #1 #1 #1 #1 = \x{####1}^^J}% - \def\tabucolX ####1\relax {(tabu) X columns width#1 = \x{####1}^^J}% - \def\tabu@nbcols ####1\relax {(tabu) Number of columns: \z{####1}^^J}% - \def\tabu@aligndefault ####1{(tabu) Default alignment: #1 #1 ####1^^J}% - \def\col@sep ####1\relax {(tabu) column sep #1 #1 #1 = \x{####1}^^J}% - \def\arrayrulewidth ####1\relax{(tabu) arrayrulewidth #1 = \x{####1}}% - \def\doublerulesep ####1\relax { doublerulesep = \x{####1}^^J}% - \def\extratabsurround####1\relax{(tabu) extratabsurround = \x{####1}^^J}% - \def\extrarowheight ####1\relax{(tabu) extrarowheight #1 = \x{####1}}% - \def\extrarowdepth ####1\relax {extrarowdepth = \x{####1}^^J}% - \def\abovetabulinesep####1\relax{(tabu) abovetabulinesep=\x{####1} }% - \def\belowtabulinesep####1\relax{ belowtabulinesep=\x{####1}^^J}% - \def\arraystretch ####1{(tabu) arraystretch #1 #1 = \z{####1}^^J}% - \def\minrowclearance####1\relax{(tabu) minrowclearance #1 = \x{####1}^^J}% - \def\tabu@arc@L ####1{(tabu) taburulecolor #1 #1 = ####1^^J}% - \def\tabu@drsc@L ####1{(tabu) tabudoublerulecolor= ####1^^J}% - \def\tabu@evr@L ####1{(tabu) everyrow #1 #1 #1 #1 = \detokenize{####1}^^J}% - \def\tabu@ls@L ####1{(tabu) line style = \detokenize{####1}^^J}% - \def\NC@find ####1\@nil{(tabu) tabu preamble#1 #1 = \detokenize{####1}^^J}% - \def\tabu@wddef####1####2{(tabu) Natural width ####1 = \x{####2}^^J}% - \let\edef \@gobbletwo \let\def \@empty \let\let \@gobbletwo - \tabu@message{% - (tabu) \string\savetabu{\tabu@temp}: \on@line^^J% - \tabu@usetabu \@nil^^J}% - \endgroup} -}\do{ } -%% Measuring the natural width (varwidth) - store the results ------- -\def\tabu@startpboxmeasure #1{\bgroup % entering \vtop - \edef\tabu@temp{\expandafter\@secondoftwo \ifx\tabu@hsize #1\else\relax\fi}% - \ifodd 1\ifx \tabu@temp\@empty 0 \else % starts with \tabu@hsize ? - \iftabu@spread \else % if spread -> measure - \ifdim \tabu@temp\p@>\z@ 0 \fi\fi\fi% if coef>0 -> do not measure - \let\@startpbox \tabu@startpboxORI % restore immediately (nesting) - \tabu@measuringtrue % for the quick option... - \tabu@Xcol =\expandafter\@firstoftwo\ifx\tabu@hsize #1\fi - \ifdim \tabu@temp\p@>\z@ \ifdim \tabu@temp\tabucolX<\tabu@target - \tabu@target=\tabu@temp\tabucolX \fi\fi - \setbox\tabu@box \hbox \bgroup - \begin{varwidth}\tabu@target - \let\FV@ListProcessLine \tabu@FV@ListProcessLine % \hbox to natural width... - \narrowragged \arraybackslash \parfillskip \@flushglue - \ifdefined\pdfadjustspacing \pdfadjustspacing\z@ \fi - \bgroup \aftergroup\tabu@endpboxmeasure - \ifdefined \cellspacetoplimit \tabu@cellspacepatch \fi - \else \expandafter\@gobble - \tabu@startpboxquick{#1}% \@gobble \bgroup - \fi -}% \tabu@startpboxmeasure -\def\tabu@cellspacepatch{\def\bcolumn##1\@nil{}\let\ecolumn\@empty - \bgroup\color@begingroup} -\def\tabu@endpboxmeasure {% - \@finalstrut \@arstrutbox - \end{varwidth}\egroup % - \ifdim \tabu@temp\p@ <\z@ % neg coef - \ifdim \tabu@wd\tabu@Xcol <\wd\tabu@box - \tabu@wddef\tabu@Xcol {\the\wd\tabu@box}% - \tabu@debug{\tabu@message@endpboxmeasure}% - \fi - \else % spread coef>0 - \global\advance \tabu@naturalX \wd\tabu@box - \@tempdima =\dimexpr \wd\tabu@box *\p@/\dimexpr \tabu@temp\p@\relax \relax - \ifdim \tabu@naturalXmax <\tabu@naturalX - \xdef\tabu@naturalXmax {\the\tabu@naturalX}\fi - \ifdim \tabu@naturalXmin <\@tempdima - \xdef\tabu@naturalXmin {\the\@tempdima}\fi - \fi - \box\tabu@box \egroup % end of \vtop (measure) restore \tabu@target -}% \tabu@endpboxmeasure -\def\tabu@wddef #1{\expandafter\xdef - \csname tabu@\the\tabu@nested.W\number#1\endcsname} -\def\tabu@wd #1{\csname tabu@\the\tabu@nested.W\number#1\endcsname} -\def\tabu@message@endpboxmeasure{\tabu@spaces\tabu@spaces<-> % <-> save natural wd - \the\tabu@Xcol. X[\tabu@temp]: - target = \the\tabucolX \space - \expandafter\expandafter\expandafter\string\tabu@wd\tabu@Xcol - =\tabu@wd\tabu@Xcol -}% \tabu@message@endpboxmeasure -\def\tabu@startpboxquick {\bgroup - \let\@startpbox \tabu@startpboxORI % restore immediately - \let\tabu \tabu@quick % \begin is expanded before... - \expandafter\@gobble \@startpbox % gobbles \bgroup -}% \tabu@startpboxquick -\def\tabu@quick {\begingroup \iffalse{\fi \ifnum0=`}\fi - \toks@{}\def\tabu@stack{b}\tabu@collectbody \tabu@endquick -}% \tabu@quick -\def\tabu@endquick {% - \ifodd 1\ifx\tabu@end@envir\tabu@endtabu \else - \ifx\tabu@end@envir\tabu@endtabus \else 0\fi\fi\relax - \endgroup - \else \let\endtabu \relax - \tabu@end@envir - \fi -}% \tabu@quick -\def\tabu@endtabu {\end{tabu}} -\def\tabu@endtabus {\end{tabu*}} -%% Measuring the heights and depths - store the results ------------- -\def\tabu@verticalmeasure{\everypar{}% - \ifnum \currentgrouptype>12 % 14=semi-simple, 15=math shift group - \setbox\tabu@box =\hbox\bgroup - \let\tabu@verticalspacing \tabu@verticalsp@lcr - \d@llarbegin % after \hbox ... - \else - \edef\tabu@temp{\ifnum\currentgrouptype=5\vtop - \else\ifnum\currentgrouptype=12\vcenter - \else\vbox\fi\fi}% - \setbox\tabu@box \hbox\bgroup$\tabu@temp \bgroup - \let\tabu@verticalspacing \tabu@verticalsp@pmb - \fi -}% \tabu@verticalmeasure -\def\tabu@verticalsp@lcr{% - \d@llarend \egroup % - \@tempdima \dimexpr \ht\tabu@box+\abovetabulinesep - \@tempdimb \dimexpr \dp\tabu@box+\belowtabulinesep \relax - \ifdim\tabustrutrule>\z@ \tabu@debug{\tabu@message@verticalsp}\fi - \ifdim \tabu@ht<\@tempdima \tabu@htdef{\the\@tempdima}\fi - \ifdim \tabu@dp<\@tempdimb \tabu@dpdef{\the\@tempdimb}\fi - \noindent\vrule height\@tempdima depth\@tempdimb -}% \tabu@verticalsp@lcr -\def\tabu@verticalsp@pmb{% inserts struts as needed - \par \expandafter\egroup - \expandafter$\expandafter - \egroup \expandafter - \@tempdimc \the\prevdepth - \@tempdima \dimexpr \ht\tabu@box+\abovetabulinesep - \@tempdimb \dimexpr \dp\tabu@box+\belowtabulinesep \relax - \ifdim\tabustrutrule>\z@ \tabu@debug{\tabu@message@verticalsp}\fi - \ifdim \tabu@ht<\@tempdima \tabu@htdef{\the\@tempdima}\fi - \ifdim \tabu@dp<\@tempdimb \tabu@dpdef{\the\@tempdimb}\fi - \let\@finalstrut \@gobble - \hrule height\@tempdima depth\@tempdimb width\hsize -%% \box\tabu@box -}% \tabu@verticalsp@pmb - -\def\tabu@verticalinit{% - \ifnum \c@taburow=\z@ \tabu@rearstrut \fi % after \tabu@reset ! - \advance\c@taburow \@ne - \tabu@htdef{\the\ht\@arstrutbox}\tabu@dpdef{\the\dp\@arstrutbox}% - \advance\c@taburow \m@ne -}% \tabu@verticalinit -\def\tabu@htdef {\expandafter\xdef \csname tabu@\the\tabu@nested.H\the\c@taburow\endcsname} -\def\tabu@ht {\csname tabu@\the\tabu@nested.H\the\c@taburow\endcsname} -\def\tabu@dpdef {\expandafter\xdef \csname tabu@\the\tabu@nested.D\the\c@taburow\endcsname} -\def\tabu@dp {\csname tabu@\the\tabu@nested.D\the\c@taburow\endcsname} -\def\tabu@verticaldynamicadjustment {% - \advance\c@taburow \@ne - \extrarowheight \dimexpr\tabu@ht - \ht\strutbox - \extrarowdepth \dimexpr\tabu@dp - \dp\strutbox - \let\arraystretch \@empty - \advance\c@taburow \m@ne -}% \tabu@verticaldynamicadjustment -\def\tabuphantomline{\crcr \noalign{% - {\globaldefs \@ne - \setbox\@arstrutbox \box\voidb@x - \let\tabu@@celllalign \tabu@celllalign - \let\tabu@@cellralign \tabu@cellralign - \let\tabu@@cellleft \tabu@cellleft - \let\tabu@@cellright \tabu@cellright - \let\tabu@@thevline \tabu@thevline - \let\tabu@celllalign \@empty - \let\tabu@cellralign \@empty - \let\tabu@cellright \@empty - \let\tabu@cellleft \@empty - \let\tabu@thevline \relax}% - \edef\tabu@temp{\tabu@multispan \tabu@nbcols{\noindent &}}% - \toks@\expandafter{\tabu@temp \noindent\tabu@everyrowfalse \cr - \noalign{\tabu@rearstrut - {\globaldefs\@ne - \let\tabu@celllalign \tabu@@celllalign - \let\tabu@cellralign \tabu@@cellralign - \let\tabu@cellleft \tabu@@cellleft - \let\tabu@cellright \tabu@@cellright - \let\tabu@thevline \tabu@@thevline}}}% - \expandafter}\the\toks@ -}% \tabuphantomline -%% \firsthline and \lasthline corrections --------------------------- -\def\tabu@firstline {\tabu@hlineAZ \tabu@firsthlinecorrection {}} -\def\tabu@firsthline{\tabu@hlineAZ \tabu@firsthlinecorrection \hline} -\def\tabu@lastline {\tabu@hlineAZ \tabu@lasthlinecorrection {}} -\def\tabu@lasthline {\tabu@hlineAZ \tabu@lasthlinecorrection \hline} -\def\tabu@hline {% replaces \hline if no colortbl (see \AtBeginDocument) - \noalign{\ifnum0=`}\fi - {\CT@arc@\hrule height\arrayrulewidth}% - \futurelet \tabu@temp \tabu@xhline -}% \tabu@hline -\def\tabu@xhline{% - \ifx \tabu@temp \hline - {\ifx \CT@drsc@\relax \vskip - \else\ifx \CT@drsc@\@empty \vskip - \else \CT@drsc@\hrule height - \fi\fi - \doublerulesep}% - \fi - \ifnum0=`{\fi}% -}% \tabu@xhline -\def\tabu@hlineAZ #1#2{\noalign{\ifnum0=`}\fi \dimen@ \z@ \count@ \z@ - \toks@{}\def\tabu@hlinecorrection{#1}\def\tabu@temp{#2}% - \tabu@hlineAZsurround -}% \tabu@hlineAZ -\newcommand*\tabu@hlineAZsurround[1][\extratabsurround]{% - \extratabsurround #1\let\tabucline \tabucline@scan - \let\hline \tabu@hlinescan \let\firsthline \hline - \let\cline \tabu@clinescan \let\lasthline \hline - \expandafter \futurelet \expandafter \tabu@temp - \expandafter \tabu@nexthlineAZ \tabu@temp -}% \tabu@hlineAZsurround -\def\tabu@hlinescan {\tabu@thick \arrayrulewidth \tabu@xhlineAZ \hline} -\def\tabu@clinescan #1{\tabu@thick \arrayrulewidth \tabu@xhlineAZ {\cline{#1}}} -\def\tabucline@scan{\@testopt \tabucline@sc@n {}} -\def\tabucline@sc@n #1[#2]{\tabu@xhlineAZ {\tabucline[{#1}]{#2}}} -\def\tabu@nexthlineAZ{% - \ifx \tabu@temp\hline \else - \ifx \tabu@temp\cline \else - \ifx \tabu@temp\tabucline \else - \tabu@hlinecorrection - \fi\fi\fi -}% \tabu@nexthlineAZ -\def\tabu@xhlineAZ #1{% - \toks@\expandafter{\the\toks@ #1}% - \@tempdimc \tabu@thick % The last line width - \ifcase\count@ \@tempdimb \tabu@thick % The first line width - \else \advance\dimen@ \dimexpr \tabu@thick+\doublerulesep \relax - \fi - \advance\count@ \@ne \futurelet \tabu@temp \tabu@nexthlineAZ -}% \tabu@xhlineAZ -\def\tabu@firsthlinecorrection{% \count@ = number of \hline -1 - \@tempdima \dimexpr \ht\@arstrutbox+\dimen@ - \edef\firsthline{% - \omit \hbox to\z@{\hss{\noexpand\tabu@DBG{yellow}\vrule - height \the\dimexpr\@tempdima+\extratabsurround - depth \dp\@arstrutbox - width \tabustrutrule}\hss}\cr - \noalign{\vskip -\the\dimexpr \@tempdima+\@tempdimb - +\dp\@arstrutbox \relax}% - \the\toks@ - }\ifnum0=`{\fi - \expandafter}\firsthline % we are then ! -}% \tabu@firsthlinecorrection -\def\tabu@lasthlinecorrection{% - \@tempdima \dimexpr \dp\@arstrutbox+\dimen@+\@tempdimb+\@tempdimc - \edef\lasthline{% - \the\toks@ - \noalign{\vskip -\the\dimexpr\dimen@+\@tempdimb+\dp\@arstrutbox}% - \omit \hbox to\z@{\hss{\noexpand\tabu@DBG{yellow}\vrule - depth \the\dimexpr \dp\@arstrutbox+\@tempdimb+\dimen@ - +\extratabsurround-\@tempdimc - height \z@ - width \tabustrutrule}\hss}\cr - }\ifnum0=`{\fi - \expandafter}\lasthline % we are then ! -}% \tabu@lasthlinecorrection -\def\tabu@LT@@hline{% - \ifx\LT@next\hline - \global\let\LT@next \@gobble - \ifx \CT@drsc@\relax - \gdef\CT@LT@sep{% - \noalign{\penalty-\@medpenalty\vskip\doublerulesep}}% - \else - \gdef\CT@LT@sep{% - \multispan\LT@cols{% - \CT@drsc@\leaders\hrule\@height\doublerulesep\hfill}\cr}% - \fi - \else - \global\let\LT@next\empty - \gdef\CT@LT@sep{% - \noalign{\penalty-\@lowpenalty\vskip-\arrayrulewidth}}% - \fi - \ifnum0=`{\fi}% - \multispan\LT@cols - {\CT@arc@\leaders\hrule\@height\arrayrulewidth\hfill}\cr - \CT@LT@sep - \multispan\LT@cols - {\CT@arc@\leaders\hrule\@height\arrayrulewidth\hfill}\cr - \noalign{\penalty\@M}% - \LT@next -}% \tabu@LT@@hline -%% Horizontal lines : \tabucline ------------------------------------ -\let\tabu@start \@tempcnta -\let\tabu@stop \@tempcntb -\newcommand*\tabucline{\noalign{\ifnum0=`}\fi \tabu@cline} -\newcommand*\tabu@cline[2][]{\tabu@startstop{#2}% - \ifnum \tabu@stop<\z@ \toks@{}% - \else \tabu@clinearg{#1}\tabu@thestyle - \edef\tabucline{\toks@{% - \ifnum \tabu@start>\z@ \omit - \tabu@multispan\tabu@start {\span\omit}&\fi - \omit \tabu@multispan\tabu@stop {\span\omit}% - \tabu@thehline\cr - }}\tabucline - \tabu@tracinglines{(tabu:tabucline) Style: #1^^J\the\toks@^^J^^J}% - \fi - \futurelet \tabu@temp \tabu@xcline -}% \tabu@cline -\def\tabu@clinearg #1{% - \ifx\\#1\\\let\tabu@thestyle \tabu@ls@ - \else \@defaultunits \expandafter\let\expandafter\@tempa - \romannumeral-`\0#1\relax \@nnil - \ifx \hbox\@tempa \tabu@clinebox{#1}% - \else\ifx \box\@tempa \tabu@clinebox{#1}% - \else\ifx \vbox\@tempa \tabu@clinebox{#1}% - \else\ifx \vtop\@tempa \tabu@clinebox{#1}% - \else\ifx \copy\@tempa \tabu@clinebox{#1}% - \else\ifx \leaders\@tempa \tabu@clineleads{#1}% - \else\ifx \cleaders\@tempa \tabu@clineleads{#1}% - \else\ifx \xleaders\@tempa \tabu@clineleads{#1}% - \else\tabu@getline {#1}% - \fi\fi\fi\fi\fi\fi\fi\fi - \fi -}% \tabu@clinearg -\def\tabu@clinebox #1{\tabu@clineleads{\xleaders#1\hss}} -\def\tabu@clineleads #1{% - \let\tabu@thestyle \relax \let\tabu@leaders \@undefined - \gdef\tabu@thehrule{#1}} -\def\tabu@thehline{\begingroup - \ifdefined\tabu@leaders - \noexpand\tabu@thehleaders - \else \noexpand\tabu@thehrule - \fi \endgroup -}% \tabu@thehline -\def\tabu@xcline{% - \ifx \tabu@temp\tabucline - \toks@\expandafter{\the\toks@ \noalign - {\ifx\CT@drsc@\relax \vskip - \else \CT@drsc@\hrule height - \fi - \doublerulesep}}% - \fi - \tabu@docline -}% \tabu@xcline -\def\tabu@docline {\ifnum0=`{\fi \expandafter}\the\toks@} -\def\tabu@docline@evr {\xdef\tabu@doclineafter{\the\toks@}% - \ifnum0=`{\fi}\aftergroup\tabu@doclineafter} -\def\tabu@multispan #1#2{% - \ifnum\numexpr#1>\@ne #2\expandafter\tabu@multispan - \else \expandafter\@gobbletwo - \fi {#1-1}{#2}% -}% \tabu@multispan -\def\tabu@startstop #1{\tabu@start@stop #1\relax 1-\tabu@nbcols \@nnil} -\def\tabu@start@stop #1-#2\@nnil{% - \@defaultunits \tabu@start\number 0#1\relax \@nnil - \@defaultunits \tabu@stop \number 0#2\relax \@nnil - \tabu@stop \ifnum \tabu@start>\tabu@nbcols \m@ne - \else\ifnum \tabu@stop=\z@ \tabu@nbcols - \else\ifnum \tabu@stop>\tabu@nbcols \tabu@nbcols - \else \tabu@stop - \fi\fi\fi - \advance\tabu@start \m@ne - \ifnum \tabu@start>\z@ \advance\tabu@stop -\tabu@start \fi -}% \tabu@start@stop -%% Numbers: siunitx S columns (and \tabudecimal) ------------------- -\def\tabu@tabudecimal #1{% - \def\tabu@decimal{#1}\@temptokena{}% - \let\tabu@getdecimal@ \tabu@getdecimal@ignorespaces - \tabu@scandecimal -}% \tabu@tabudecimal -\def\tabu@scandecimal{\futurelet \tabu@temp \tabu@getdecimal@} -\def\tabu@skipdecimal#1{#1\tabu@scandecimal} -\def\tabu@getdecimal@ignorespaces{% - \ifcase 0\ifx\tabu@temp\ignorespaces\else - \ifx\tabu@temp\@sptoken1\else - 2\fi\fi\relax - \let\tabu@getdecimal@ \tabu@getdecimal - \expandafter\tabu@skipdecimal - \or \expandafter\tabu@gobblespace\expandafter\tabu@scandecimal - \else \expandafter\tabu@skipdecimal - \fi -}% \tabu@getdecimal@ignorespaces -\def\tabu@get@decimal#1{\@temptokena\expandafter{\the\@temptokena #1}% - \tabu@scandecimal} -\def\do#1{% - \def\tabu@get@decimalspace#1{% - \@temptokena\expandafter{\the\@temptokena #1}\tabu@scandecimal}% -}\do{ } -\let\tabu@@tabudecimal \tabu@tabudecimal -\def\tabu@getdecimal{% - \ifcase 0\ifx 0\tabu@temp\else - \ifx 1\tabu@temp\else - \ifx 2\tabu@temp\else - \ifx 3\tabu@temp\else - \ifx 4\tabu@temp\else - \ifx 5\tabu@temp\else - \ifx 6\tabu@temp\else - \ifx 7\tabu@temp\else - \ifx 8\tabu@temp\else - \ifx 9\tabu@temp\else - \ifx .\tabu@temp\else - \ifx ,\tabu@temp\else - \ifx -\tabu@temp\else - \ifx +\tabu@temp\else - \ifx e\tabu@temp\else - \ifx E\tabu@temp\else - \ifx\tabu@cellleft\tabu@temp1\else - \ifx\ignorespaces\tabu@temp1\else - \ifx\@sptoken\tabu@temp2\else - 3\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\relax - \expandafter\tabu@get@decimal - \or \expandafter\tabu@skipdecimal - \or \expandafter\tabu@get@decimalspace - \else\expandafter\tabu@printdecimal - \fi -}% \tabu@getdecimal -\def\tabu@printdecimal{% - \edef\tabu@temp{\the\@temptokena}% - \ifx\tabu@temp\@empty\else - \ifx\tabu@temp\space\else - \expandafter\tabu@decimal\expandafter{\the\@temptokena}% - \fi\fi -}% \tabu@printdecimal -%% Verbatim inside X columns ---------------------------------------- -\def\tabu@verbatim{% - \let\verb \tabu@verb - \let\FV@DefineCheckEnd \tabu@FV@DefineCheckEnd -}% \tabu@verbatim -\let\tabu@ltx@verb \verb -\def\tabu@verb{\@ifstar {\tabu@ltx@verb*} \tabu@ltx@verb} -\def\tabu@fancyvrb {% - \def\tabu@FV@DefineCheckEnd ##1{% - \def\tabu@FV@DefineCheckEnd{% - ##1% - \let\FV@CheckEnd \tabu@FV@CheckEnd - \let\FV@@CheckEnd \tabu@FV@@CheckEnd - \let\FV@@@CheckEnd \tabu@FV@@@CheckEnd - \edef\FV@EndScanning{% - \def\noexpand\next{\noexpand\end{\FV@EnvironName}}% - \global\let\noexpand\FV@EnvironName\relax - \noexpand\next}% - \xdef\FV@EnvironName{\detokenize\expandafter{\FV@EnvironName}}}% - }\expandafter\tabu@FV@DefineCheckEnd\expandafter{\FV@DefineCheckEnd} -}% \tabu@fancyvrb -\def\tabu@FV@CheckEnd #1{\expandafter\FV@@CheckEnd \detokenize{#1\end{}}\@nil} -\edef\tabu@FV@@@CheckEnd {\detokenize{\end{}}} -\begingroup -\catcode`\[1 \catcode`\]2 -\@makeother\{ \@makeother\} - \edef\x[\endgroup - \def\noexpand\tabu@FV@@CheckEnd ##1\detokenize[\end{]##2\detokenize[}]##3% - ]\x \@nil{\def\@tempa{#2}\def\@tempb{#3}} -\def\tabu@FV@ListProcessLine #1{% - \hbox {%to \hsize{% - \kern\leftmargin - \hbox {%to \linewidth{% - \FV@LeftListNumber - \FV@LeftListFrame - \FancyVerbFormatLine{#1}\hss -%% DG/SR modification begin - Jan. 28, 1998 (for numbers=right add-on) -%% \FV@RightListFrame}% - \FV@RightListFrame - \FV@RightListNumber}% -%% DG/SR modification end - \hss}} -%% \savetabu -------------------------------------------------------- -\newcommand*\savetabu[1]{\noalign{% - \tabu@sanitizearg{#1}\tabu@temp - \ifx \tabu@temp\@empty \tabu@savewarn{}{The tabu will not be saved}\else - \@ifundefined{tabu@saved@\tabu@temp}{}{\tabu@savewarn{#1}{Overwriting}}% - \ifdefined\tabu@restored \expandafter\let - \csname tabu@saved@\tabu@temp \endcsname \tabu@restored - \else {\tabu@save}% - \fi - \fi}% -}% \savetabu -\def\tabu@save {% - \toks0\expandafter{\tabu@saved@}% - \iftabu@negcoef - \let\tabu@wddef \relax \let\tabu@ \tabu@savewd \edef\tabu@savewd{\tabu@Xcoefs}% - \toks0\expandafter{\the\toks\expandafter0\tabu@savewd}\fi - \toks1\expandafter{\tabu@savedpream}% - \toks2\expandafter{\tabu@savedpreamble}% - \let\@preamble \relax - \let\tabu@savedpream \relax \let\tabu@savedparams \relax - \edef\tabu@preamble{% - \def\noexpand\tabu@aligndefault{\tabu@align}% - \def\tabu@savedparams {\noexpand\the\toks0}% - \def\tabu@savedpream {\noexpand\the\toks1}}% - \edef\tabu@usetabu{% - \def\@preamble {\noexpand\the\toks2}% - \tabu@target \the\tabu@target \relax - \tabucolX \the\tabucolX \relax - \tabu@nbcols \the\tabu@nbcols \relax - \def\noexpand\tabu@aligndefault{\tabu@align}% - \def\tabu@savedparams {\noexpand\the\toks0}% - \def\tabu@savedpream {\noexpand\the\toks1}}% - \let\tabu@aligndefault \relax \let\@sharp \relax - \edef\@tempa{\noexpand\tabu@s@ved - {\tabu@usetabu} - {\tabu@preamble} - {\the\toks1}}\@tempa - \tabu@message@save -}% \tabu@save -\long\def\tabu@s@ved #1#2#3{% - \def\tabu@usetabu{#1}% - \expandafter\gdef\csname tabu@saved@\tabu@temp\endcsname ##1{% - \ifodd ##1% \usetabu - \tabu@measuringfalse \tabu@spreadfalse % Just in case... - \gdef\tabu@usetabu {% - \ifdim \tabu@target>\z@ \tabu@warn@usetabu \fi - \global\let\tabu@usetabu \@undefined - \def\@halignto {to\tabu@target}% - #1% - \ifx \tabu@align\tabu@aligndefault@text - \ifnum \tabu@nested=\z@ - \let\tabu@align \tabu@aligndefault \fi\fi}% - \else % \preamble - \gdef\tabu@preamble {% - \global\let\tabu@preamble \@undefined - #2% - \ifx \tabu@align\tabu@aligndefault@text - \ifnum \tabu@nested=\z@ - \let\tabu@align \tabu@aligndefault \fi\fi}% - \fi - #3}% -}% \tabu@s@ved -\def\tabu@aligndefault@text {\tabu@aligndefault}% -\def\tabu@warn@usetabu {\PackageWarning{tabu} - {Specifying a target with \string\usetabu\space is useless - \MessageBreak The target cannot be changed!}} -\def\tabu@savewd #1#2{\ifdim #2\p@<\z@ \tabu@wddef{#1}{\tabu@wd{#1}}\fi} -\def\tabu@savewarn#1#2{\PackageInfo{tabu} - {User-name `#1' already used for \string\savetabu - \MessageBreak #2}}% -\def\tabu@saveerr#1{\PackageError{tabu} - {User-name `#1' is unknown for \string\usetabu - \MessageBreak I cannot restore an unknown preamble!}\@ehd} -%% \rowfont --------------------------------------------------------- -\newskip \tabu@cellskip -\def\tabu@rowfont{\ifdim \baselineskip=\z@\noalign\fi - {\ifnum0=`}\fi \tabu@row@font} -\newcommand*\tabu@row@font[2][]{% - \ifnum7=\currentgrouptype - \global\let\tabu@@cellleft \tabu@cellleft - \global\let\tabu@@cellright \tabu@cellright - \global\let\tabu@@celllalign \tabu@celllalign - \global\let\tabu@@cellralign \tabu@cellralign - \global\let\tabu@@rowfontreset\tabu@rowfontreset - \fi - \global\let\tabu@rowfontreset \tabu@rowfont@reset - \expandafter\gdef\expandafter\tabu@cellleft\expandafter{\tabu@cellleft #2}% - \ifcsname tabu@cell@#1\endcsname % row alignment - \csname tabu@cell@#1\endcsname \fi - \ifnum0=`{\fi}% end of group / noalign group -}% \rowfont -\def\tabu@ifcolorleavevmode #1{\let\color \tabu@leavevmodecolor #1\let\color\tabu@color}% -\def\tabu@rowfont@reset{% - \global\let\tabu@rowfontreset \tabu@@rowfontreset - \global\let\tabu@cellleft \tabu@@cellleft - \global\let\tabu@cellright \tabu@@cellright - \global\let\tabu@cellfont \@empty - \global\let\tabu@celllalign \tabu@@celllalign - \global\let\tabu@cellralign \tabu@@cellralign -}% \tabu@@rowfontreset -\let\tabu@rowfontreset \@empty % overwritten \AtBeginDocument if colortbl -%% \tabu@prepnext@tok ----------------------------------------------- -\newif \iftabu@cellright -\def\tabu@prepnext@tok{% - \ifnum \count@<\z@ % - \@tempcnta \@M % - \tabu@nbcols\z@ - \let\tabu@fornoopORI \@fornoop - \tabu@cellrightfalse - \else - \ifcase \numexpr \count@-\@tempcnta \relax % (case 0): prev. token is left - \advance \tabu@nbcols \@ne - \iftabu@cellright % before-previous token is right and is finished - \tabu@cellrightfalse % - \tabu@righttok - \fi - \tabu@lefttok - \or % (case 1) previous token is right - \tabu@cellrighttrue \let\@fornoop \tabu@lastnoop - \else % special column: do not change the token - \iftabu@cellright % before-previous token is right - \tabu@cellrightfalse - \tabu@righttok - \fi - \fi % \ifcase - \fi - \tabu@prepnext@tokORI -}% \tabu@prepnext@tok -\long\def\tabu@lastnoop#1\@@#2#3{\tabu@lastn@@p #2\@nextchar \in@\in@@} -\def\tabu@lastn@@p #1\@nextchar #2#3\in@@{% - \ifx \in@#2\else - \let\@fornoop \tabu@fornoopORI - \xdef\tabu@mkpreambuffer{\tabu@nbcols\the\tabu@nbcols \tabu@mkpreambuffer}% - \toks0\expandafter{\expandafter\tabu@everyrowtrue \the\toks0}% - \expandafter\prepnext@tok - \fi -}% \tabu@lastnoop -\def\tabu@righttok{% - \advance \count@ \m@ne - \toks\count@\expandafter {\the\toks\count@ \tabu@cellright \tabu@cellralign}% - \advance \count@ \@ne -}% \tabu@righttok -\def\tabu@lefttok{\toks\count@\expandafter{\expandafter\tabu@celllalign - \the\toks\count@ \tabu@cellleft}% after because of $ -}% \tabu@lefttok -%% Neutralisation of glues ------------------------------------------ -\let\tabu@cellleft \@empty -\let\tabu@cellright \@empty -\tabu@celllalign@def{\tabu@cellleft}% -\let\tabu@cellralign \@empty -\def\tabu@cell@align #1#2#3{% - \let\tabu@maybesiunitx \toks@ \tabu@celllalign - \global \expandafter \tabu@celllalign@def \expandafter {\the\toks@ #1}% - \toks@\expandafter{\tabu@cellralign #2}% - \xdef\tabu@cellralign{\the\toks@}% - \toks@\expandafter{\tabu@cellleft #3}% - \xdef\tabu@cellleft{\the\toks@}% -}% \tabu@cell@align -\def\tabu@cell@l{% force alignment to left - \tabu@cell@align - {\tabu@removehfil \raggedright \tabu@cellleft}% left - {\tabu@flush1\tabu@ignorehfil}% right - \raggedright -}% \tabu@cell@l -\def\tabu@cell@c{% force alignment to center - \tabu@cell@align - {\tabu@removehfil \centering \tabu@flush{.5}\tabu@cellleft} - {\tabu@flush{.5}\tabu@ignorehfil} - \centering -}% \tabu@cell@c -\def\tabu@cell@r{% force alignment to right - \tabu@cell@align - {\tabu@removehfil \raggedleft \tabu@flush1\tabu@cellleft} - \tabu@ignorehfil - \raggedleft -}% \tabu@cell@r -\def\tabu@cell@j{% force justification (for p, m, b columns) - \tabu@cell@align - {\tabu@justify\tabu@cellleft} - {} - \tabu@justify -}% \tabu@cell@j -\def\tabu@justify{% - \leftskip\z@skip \@rightskip\leftskip \rightskip\@rightskip - \parfillskip\@flushglue -}% \tabu@justify -%% ragged2e settings -\def\tabu@cell@L{% force alignment to left (ragged2e) - \tabu@cell@align - {\tabu@removehfil \RaggedRight \tabu@cellleft} - {\tabu@flush 1\tabu@ignorehfil} - \RaggedRight -}% \tabu@cell@L -\def\tabu@cell@C{% force alignment to center (ragged2e) - \tabu@cell@align - {\tabu@removehfil \Centering \tabu@flush{.5}\tabu@cellleft} - {\tabu@flush{.5}\tabu@ignorehfil} - \Centering -}% \tabu@cell@C -\def\tabu@cell@R{% force alignment to right (ragged2e) - \tabu@cell@align - {\tabu@removehfil \RaggedLeft \tabu@flush 1\tabu@cellleft} - \tabu@ignorehfil - \RaggedLeft -}% \tabu@cell@R -\def\tabu@cell@J{% force justification (ragged2e) - \tabu@cell@align - {\justifying \tabu@cellleft} - {} - \justifying -}% \tabu@cell@J -\def\tabu@flush#1{% - \iftabu@colortbl % colortbl uses \hfill rather than \hfil - \hskip \ifnum13<\currentgrouptype \stretch{#1}% - \else \ifdim#1pt<\p@ \tabu@cellskip - \else \stretch{#1} - \fi\fi \relax - \else % array.sty - \ifnum 13<\currentgrouptype - \hfil \hskip1sp \relax \fi - \fi -}% \tabu@flush -\let\tabu@hfil \hfil -\let\tabu@hfill \hfill -\let\tabu@hskip \hskip -\def\tabu@removehfil{% - \iftabu@colortbl - \unkern \tabu@cellskip =\lastskip - \ifnum\gluestretchorder\tabu@cellskip =\tw@ \hskip-\tabu@cellskip - \else \tabu@cellskip \z@skip - \fi - \else - \ifdim\lastskip=1sp\unskip\fi - \ifnum\gluestretchorder\lastskip =\@ne - \hfilneg % \hfilneg for array.sty but not for colortbl... - \fi - \fi -}% \tabu@removehfil -\def\tabu@ignorehfil{\aftergroup \tabu@nohfil} -\def\tabu@nohfil{% \hfil -> do nothing + restore original \hfil - \def\hfil{\let\hfil \tabu@hfil}% local to (alignment template) group -}% \tabu@nohfil -\def\tabu@colortblalignments {% if colortbl - \def\tabu@nohfil{% - \def\hfil {\let\hfil \tabu@hfil}% local to (alignment template) group - \def\hfill {\let\hfill \tabu@hfill}% (colortbl uses \hfill) pfff... - \def\hskip ####1\relax{\let\hskip \tabu@hskip}}% local -}% \tabu@colortblalignments -%% Taking care of footnotes and hyperfootnotes ---------------------- -\long\def\tabu@footnotetext #1{% - \edef\@tempa{\the\tabu@footnotes - \noexpand\footnotetext [\the\csname c@\@mpfn\endcsname]}% - \global\tabu@footnotes\expandafter{\@tempa {#1}}}% -\long\def\tabu@xfootnotetext [#1]#2{% - \global\tabu@footnotes\expandafter{\the\tabu@footnotes - \footnotetext [{#1}]{#2}}} -\let\tabu@xfootnote \@xfootnote -\long\def\tabu@Hy@ftntext{\tabu@Hy@ftntxt {\the \c@footnote }} -\long\def\tabu@Hy@xfootnote [#1]{% - \begingroup - \value\@mpfn #1\relax - \protected@xdef \@thefnmark {\thempfn}% - \endgroup - \@footnotemark \tabu@Hy@ftntxt {#1}% -}% \tabu@Hy@xfootnote -\long\def\tabu@Hy@ftntxt #1#2{% - \edef\@tempa{% - \the\tabu@footnotes - \begingroup - \value\@mpfn #1\relax - \noexpand\protected@xdef\noexpand\@thefnmark {\noexpand\thempfn}% - \expandafter \noexpand \expandafter - \tabu@Hy@footnotetext \expandafter{\Hy@footnote@currentHref}% - }% - \global\tabu@footnotes\expandafter{\@tempa {#2}% - \endgroup}% -}% \tabu@Hy@ftntxt -\long\def\tabu@Hy@footnotetext #1#2{% - \H@@footnotetext{% - \ifHy@nesting - \hyper@@anchor {#1}{#2}% - \else - \Hy@raisedlink{% - \hyper@@anchor {#1}{\relax}% - }% - \def\@currentHref {#1}% - \let\@currentlabelname \@empty - #2% - \fi - }% -}% \tabu@Hy@footnotetext -%% No need for \arraybackslash ! ------------------------------------ -\def\tabu@latextwoe {% -\def\tabu@temp##1##2##3{{\toks@\expandafter{##2##3}\xdef##1{\the\toks@}}} -\tabu@temp \tabu@centering \centering \arraybackslash -\tabu@temp \tabu@raggedleft \raggedleft \arraybackslash -\tabu@temp \tabu@raggedright \raggedright \arraybackslash -}% \tabu@latextwoe -\def\tabu@raggedtwoe {% -\def\tabu@temp ##1##2##3{{\toks@\expandafter{##2##3}\xdef##1{\the\toks@}}} -\tabu@temp \tabu@Centering \Centering \arraybackslash -\tabu@temp \tabu@RaggedLeft \RaggedLeft \arraybackslash -\tabu@temp \tabu@RaggedRight \RaggedRight \arraybackslash -\tabu@temp \tabu@justifying \justifying \arraybackslash -}% \tabu@raggedtwoe -\def\tabu@normalcrbackslash{\let\\\@normalcr} -\def\tabu@trivlist{\expandafter\def\expandafter\@trivlist\expandafter{% - \expandafter\tabu@normalcrbackslash \@trivlist}} -%% Utilities: \fbox \fcolorbox and \tabudecimal ------------------- -\def\tabu@fbox {\leavevmode\afterassignment\tabu@beginfbox \setbox\@tempboxa\hbox} -\def\tabu@beginfbox {\bgroup \kern\fboxsep - \bgroup\aftergroup\tabu@endfbox} -\def\tabu@endfbox {\kern\fboxsep\egroup\egroup - \@frameb@x\relax} -\def\tabu@color@b@x #1#2{\leavevmode \bgroup - \def\tabu@docolor@b@x{#1{#2\color@block{\wd\z@}{\ht\z@}{\dp\z@}\box\z@}}% - \afterassignment\tabu@begincolor@b@x \setbox\z@ \hbox -}% \tabu@color@b@x -\def\tabu@begincolor@b@x {\kern\fboxsep \bgroup - \aftergroup\tabu@endcolor@b@x \set@color} -\def\tabu@endcolor@b@x {\kern\fboxsep \egroup - \dimen@\ht\z@ \advance\dimen@ \fboxsep \ht\z@ \dimen@ - \dimen@\dp\z@ \advance\dimen@ \fboxsep \dp\z@ \dimen@ - \tabu@docolor@b@x \egroup -}% \tabu@endcolor@b@x -%% Corrections (arydshln, delarray, colortbl) ----------------------- -\def\tabu@fix@arrayright {%% \@arrayright is missing from \endarray - \iftabu@colortbl - \ifdefined\adl@array % - \def\tabu@endarray{% - \adl@endarray \egroup \adl@arrayrestore \CT@end \egroup % - \@arrayright % - \gdef\@preamble{}}% - \else % - \def\tabu@endarray{% - \crcr \egroup \egroup % - \@arrayright % - \gdef\@preamble{}\CT@end}% - \fi - \else - \ifdefined\adl@array % - \def\tabu@endarray{% - \adl@endarray \egroup \adl@arrayrestore \egroup % - \@arrayright % - \gdef\@preamble{}}% - \else % - \PackageWarning{tabu} - {\string\@arrayright\space is missing from the - \MessageBreak definition of \string\endarray. - \MessageBreak Compatibility with delarray.sty is broken.}% - \fi\fi -}% \tabu@fix@arrayright -\def\tabu@adl@xarraydashrule #1#2#3{% - \ifnum\@lastchclass=\adl@class@start\else - \ifnum\@lastchclass=\@ne\else - \ifnum\@lastchclass=5 \else % @-arg (class 5) and !-arg (class 1) - \adl@leftrulefalse \fi\fi % must be treated the same - \fi - \ifadl@zwvrule\else \ifadl@inactive\else - \@addtopreamble{\vrule\@width\arrayrulewidth - \@height\z@ \@depth\z@}\fi \fi - \ifadl@leftrule - \@addtopreamble{\adl@vlineL{\CT@arc@}{\adl@dashgapcolor}% - {\number#1}#3}% - \else \@addtopreamble{\adl@vlineR{\CT@arc@}{\adl@dashgapcolor}% - {\number#2}#3} - \fi -}% \tabu@adl@xarraydashrule -\def\tabu@adl@act@endpbox {% - \unskip \ifhmode \nobreak \fi \@finalstrut \@arstrutbox - \egroup \egroup - \adl@colhtdp \box\adl@box \hfil -}% \tabu@adl@act@endpbox -\def\tabu@adl@fix {% - \let\adl@xarraydashrule \tabu@adl@xarraydashrule % arydshln - \let\adl@act@endpbox \tabu@adl@act@endpbox % arydshln - \let\adl@act@@endpbox \tabu@adl@act@endpbox % arydshln - \let\@preamerror \@preamerr % arydshln -}% \tabu@adl@fix -%% Correction for longtable' \@startbox definition ------------------ -%% => \everypar is ``missing'' : TeX should be in vertical mode -\def\tabu@LT@startpbox #1{% - \bgroup - \let\@footnotetext\LT@p@ftntext - \setlength\hsize{#1}% - \@arrayparboxrestore - \everypar{% - \vrule \@height \ht\@arstrutbox \@width \z@ - \everypar{}}% -}% \tabu@LT@startpbox -%% \tracingtabu and the package options ------------------ -\DeclareOption{delarray}{\AtEndOfPackage{\RequirePackage{delarray}}} -\DeclareOption{linegoal}{% - \AtEndOfPackage{% - \RequirePackage{linegoal}[2010/12/07]% - \let\tabudefaulttarget \linegoal% \linegoal is \linewidth if not pdfTeX -}} -\DeclareOption{scantokens}{\tabuscantokenstrue} -\DeclareOption{debugshow}{\AtEndOfPackage{\tracingtabu=\tw@}} -\def\tracingtabu {\begingroup\@ifnextchar=% - {\afterassignment\tabu@tracing\count@} - {\afterassignment\tabu@tracing\count@1\relax}} -\def\tabu@tracing{\expandafter\endgroup - \expandafter\tabu@tr@cing \the\count@ \relax -}% \tabu@tracing -\def\tabu@tr@cing #1\relax {% - \ifnum#1>\thr@@ \let\tabu@tracinglines\message - \else \let\tabu@tracinglines\@gobble - \fi - \ifnum#1>\tw@ \let\tabu@DBG \tabu@@DBG - \def\tabu@mkarstrut {\tabu@DBG@arstrut}% - \tabustrutrule 1.5\p@ - \else \let\tabu@DBG \@gobble - \def\tabu@mkarstrut {\tabu@arstrut}% - \tabustrutrule \z@ - \fi - \ifnum#1>\@ne \let\tabu@debug \message - \else \let\tabu@debug \@gobble - \fi - \ifnum#1>\z@ - \let\tabu@message \message - \let\tabu@tracing@save \tabu@message@save - \let\tabu@starttimer \tabu@pdftimer - \else - \let\tabu@message \@gobble - \let\tabu@tracing@save \@gobble - \let\tabu@starttimer \relax - \fi -}% \tabu@tr@cing -%% Setup \AtBeginDocument -\AtBeginDocument{\tabu@AtBeginDocument} -\def\tabu@AtBeginDocument{\let\tabu@AtBeginDocument \@undefined - \ifdefined\arrayrulecolor \tabu@colortbltrue % - \tabu@colortblalignments % different glues are used - \else \tabu@colortblfalse \fi - \ifdefined\CT@arc@ \else \let\CT@arc@ \relax \fi - \ifdefined\CT@drsc@\else \let\CT@drsc@ \relax \fi - \let\tabu@arc@L \CT@arc@ \let\tabu@drsc@L \CT@drsc@ - \ifodd 1\ifcsname siunitx_table_collect_begin:Nn\endcsname % - \expandafter\ifx - \csname siunitx_table_collect_begin:Nn\endcsname\relax 0\fi\fi\relax - \tabu@siunitxtrue - \else \let\tabu@maybesiunitx \@firstofone % - \let\tabu@siunitx \tabu@nosiunitx - \tabu@siunitxfalse - \fi - \ifdefined\adl@array % - \else \let\tabu@adl@fix \relax - \let\tabu@adl@endtrial \@empty \fi - \ifdefined\longtable % - \else \let\longtabu \tabu@nolongtabu \fi - \ifdefined\cellspacetoplimit \tabu@warn@cellspace\fi - \csname\ifcsname ifHy@hyperfootnotes\endcsname % - ifHy@hyperfootnotes\else iffalse\fi\endcsname - \let\tabu@footnotetext \tabu@Hy@ftntext - \let\tabu@xfootnote \tabu@Hy@xfootnote \fi - \ifdefined\FV@DefineCheckEnd% - \tabu@fancyvrb \fi - \ifdefined\color % - \let\tabu@color \color - \def\tabu@leavevmodecolor ##1{% - \def\tabu@leavevmodecolor {\leavevmode ##1}% - }\expandafter\tabu@leavevmodecolor\expandafter{\color}% - \else - \let\tabu@color \tabu@nocolor - \let\tabu@leavevmodecolor \@firstofone \fi - \tabu@latextwoe - \ifdefined\@raggedtwoe@everyselectfont % - \tabu@raggedtwoe - \else - \let\tabu@cell@L \tabu@cell@l - \let\tabu@cell@R \tabu@cell@r - \let\tabu@cell@C \tabu@cell@c - \let\tabu@cell@J \tabu@cell@j \fi - \expandafter\in@ \expandafter\@arrayright \expandafter{\endarray}% - \ifin@ \let\tabu@endarray \endarray - \else \tabu@fix@arrayright \fi% - \everyrow{}% -}% \tabu@AtBeginDocument -\def\tabu@warn@cellspace{% - \PackageWarning{tabu}{% - Package cellspace has some limitations - \MessageBreak And redefines some macros of array.sty. - \MessageBreak Please use \string\tabulinesep\space to control - \MessageBreak vertical spacing of lines inside tabu environment}% -}% \tabu@warn@cellspace -%% tabu Package initialisation -\tabuscantokensfalse -\let\tabu@arc@G \relax -\let\tabu@drsc@G \relax -\let\tabu@evr@G \@empty -\let\tabu@rc@G \@empty -\def\tabu@ls@G {\tabu@linestyle@}% -\let\tabu@@rowfontreset \@empty % -\let\tabu@@celllalign \@empty -\let\tabu@@cellralign \@empty -\let\tabu@@cellleft \@empty -\let\tabu@@cellright \@empty -\def\tabu@naturalXmin {\z@} -\def\tabu@naturalXmax {\z@} -\let\tabu@rowfontreset \@empty -\def\tabulineon {4pt}\let\tabulineoff \tabulineon -\tabu@everyrowtrue -\ifdefined\pdfelapsedtime % - \def\tabu@pdftimer {\xdef\tabu@starttime{\the\pdfelapsedtime}}% -\else \let\tabu@pdftimer \relax \let\tabu@message@etime \relax -\fi -\tracingtabu=\z@ -\newtabulinestyle {=\maxdimen}% creates the 'factory' settings \tabu@linestyle@ -\tabulinestyle{} -\taburowcolors{} -\let\tabudefaulttarget \linewidth -\ProcessOptions* % \ProcessOptions* is quicker ! -\endinput -%% -%% End of file `tabu.sty'. diff --git a/docs/latex/topics.tex b/docs/latex/topics.tex deleted file mode 100644 index f9ec04d..0000000 --- a/docs/latex/topics.tex +++ /dev/null @@ -1,7 +0,0 @@ -\doxysection{Topics} -Here is a list of all topics with brief descriptions\+:\begin{DoxyCompactList} -\item \contentsline{section}{Hardware\+\_\+types}{\pageref{group__hardware__types}}{} -\item \contentsline{section}{Hardware\+\_\+interfaces}{\pageref{group__hardware__interfaces}}{} -\item \contentsline{section}{Software\+\_\+types}{\pageref{group__software__types}}{} -\item \contentsline{section}{Software\+\_\+interfaces}{\pageref{group__software__interfaces}}{} -\end{DoxyCompactList} diff --git a/docs/latex/unionciot__ble__data__u.tex b/docs/latex/unionciot__ble__data__u.tex deleted file mode 100644 index 64e2782..0000000 --- a/docs/latex/unionciot__ble__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ble__data__u}{}\label{unionciot__ble__data__u}\index{ciot\_ble\_data\_u@{ciot\_ble\_data\_u}} - - -Union for CIOT BLE data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__ble__cfg__t}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__ble__data__u_a3bb879297495825c0895764c1b7593b1}{config}} -\item -\mbox{\hyperlink{structciot__ble__status__t}{ciot\+\_\+ble\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__ble__data__u_ae334becb4d9815b900b4cc43b5b9e49b}{status}} -\item -\mbox{\hyperlink{structciot__ble__req__t}{ciot\+\_\+ble\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__ble__data__u_a6aeefeee1b018d7d77c41f66f6015cf9}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT BLE data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__ble__data__u_a3bb879297495825c0895764c1b7593b1}\label{unionciot__ble__data__u_a3bb879297495825c0895764c1b7593b1} -\index{ciot\_ble\_data\_u@{ciot\_ble\_data\_u}!config@{config}} -\index{config@{config}!ciot\_ble\_data\_u@{ciot\_ble\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__cfg__t}{ciot\+\_\+ble\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__ble__data__u_a6aeefeee1b018d7d77c41f66f6015cf9}\label{unionciot__ble__data__u_a6aeefeee1b018d7d77c41f66f6015cf9} -\index{ciot\_ble\_data\_u@{ciot\_ble\_data\_u}!request@{request}} -\index{request@{request}!ciot\_ble\_data\_u@{ciot\_ble\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__req__t}{ciot\+\_\+ble\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__ble__data__u_ae334becb4d9815b900b4cc43b5b9e49b}\label{unionciot__ble__data__u_ae334becb4d9815b900b4cc43b5b9e49b} -\index{ciot\_ble\_data\_u@{ciot\_ble\_data\_u}!status@{status}} -\index{status@{status}!ciot\_ble\_data\_u@{ciot\_ble\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__status__t}{ciot\+\_\+ble\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__ble__req__data__u.tex b/docs/latex/unionciot__ble__req__data__u.tex deleted file mode 100644 index edfbedd..0000000 --- a/docs/latex/unionciot__ble__req__data__u.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ble__req__data__u}{}\label{unionciot__ble__req__data__u}\index{ciot\_ble\_req\_data\_u@{ciot\_ble\_req\_data\_u}} - - -Union for CIOT BLE request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -uint8\+\_\+t \mbox{\hyperlink{unionciot__ble__req__data__u_a62a0efca13351bcf8980bde96c09854e}{set\+\_\+mac}} \mbox{[}6\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT BLE request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__ble__req__data__u_a62a0efca13351bcf8980bde96c09854e}\label{unionciot__ble__req__data__u_a62a0efca13351bcf8980bde96c09854e} -\index{ciot\_ble\_req\_data\_u@{ciot\_ble\_req\_data\_u}!set\_mac@{set\_mac}} -\index{set\_mac@{set\_mac}!ciot\_ble\_req\_data\_u@{ciot\_ble\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{set\_mac}{set\_mac}} -{\footnotesize\ttfamily uint8\+\_\+t set\+\_\+mac\mbox{[}6\mbox{]}} - -Set MAC data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__types_8h}{ciot\+\_\+ble\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__ble__scn__data__u.tex b/docs/latex/unionciot__ble__scn__data__u.tex deleted file mode 100644 index d1df592..0000000 --- a/docs/latex/unionciot__ble__scn__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ble__scn__data__u}{}\label{unionciot__ble__scn__data__u}\index{ciot\_ble\_scn\_data\_u@{ciot\_ble\_scn\_data\_u}} - - -Union for CIOT BLE SCN data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__ble__scn__data__u_a77ffb25407771dd73e21b56e0976b3b7}{config}} -\item -\mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__ble__scn__data__u_aa7ad441170fdff42b419665a6652a09f}{status}} -\item -\mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__ble__scn__data__u_a4fff0375f4b234a60fcd5e6723d9c8a9}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT BLE SCN data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__ble__scn__data__u_a77ffb25407771dd73e21b56e0976b3b7}\label{unionciot__ble__scn__data__u_a77ffb25407771dd73e21b56e0976b3b7} -\index{ciot\_ble\_scn\_data\_u@{ciot\_ble\_scn\_data\_u}!config@{config}} -\index{config@{config}!ciot\_ble\_scn\_data\_u@{ciot\_ble\_scn\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__scn__cfg__t}{ciot\+\_\+ble\+\_\+scn\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__ble__scn__data__u_a4fff0375f4b234a60fcd5e6723d9c8a9}\label{unionciot__ble__scn__data__u_a4fff0375f4b234a60fcd5e6723d9c8a9} -\index{ciot\_ble\_scn\_data\_u@{ciot\_ble\_scn\_data\_u}!request@{request}} -\index{request@{request}!ciot\_ble\_scn\_data\_u@{ciot\_ble\_scn\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__scn__req__t}{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__ble__scn__data__u_aa7ad441170fdff42b419665a6652a09f}\label{unionciot__ble__scn__data__u_aa7ad441170fdff42b419665a6652a09f} -\index{ciot\_ble\_scn\_data\_u@{ciot\_ble\_scn\_data\_u}!status@{status}} -\index{status@{status}!ciot\_ble\_scn\_data\_u@{ciot\_ble\_scn\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ble__scn__status__t}{ciot\+\_\+ble\+\_\+scn\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__ble__scn__req__data__u.tex b/docs/latex/unionciot__ble__scn__req__data__u.tex deleted file mode 100644 index ac6d9ea..0000000 --- a/docs/latex/unionciot__ble__scn__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+ble\+\_\+scn\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ble__scn__req__data__u}{}\label{unionciot__ble__scn__req__data__u}\index{ciot\_ble\_scn\_req\_data\_u@{ciot\_ble\_scn\_req\_data\_u}} - - -Union for CIOT BLE SCN request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT BLE SCN request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ble__scn__types_8h}{ciot\+\_\+ble\+\_\+scn\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__bridge__data__u.tex b/docs/latex/unionciot__bridge__data__u.tex deleted file mode 100644 index 5acc188..0000000 --- a/docs/latex/unionciot__bridge__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+bridge\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__bridge__data__u}{}\label{unionciot__bridge__data__u}\index{ciot\_bridge\_data\_u@{ciot\_bridge\_data\_u}} - - -Union for CIOT bridge data. - - - - -{\ttfamily \#include $<$ciot\+\_\+bridge\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__bridge__data__u_a422a3539477ec835aea97b889564f22a}{config}} -\item -\mbox{\hyperlink{structciot__bridge__status__t}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__bridge__data__u_ab50a6b7e2887ecb6625b540edae99138}{status}} -\item -\mbox{\hyperlink{structciot__bridge__req__t}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__bridge__data__u_a21b1ec52268024ae8c4b0eca1dc2a491}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT bridge data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__bridge__data__u_a422a3539477ec835aea97b889564f22a}\label{unionciot__bridge__data__u_a422a3539477ec835aea97b889564f22a} -\index{ciot\_bridge\_data\_u@{ciot\_bridge\_data\_u}!config@{config}} -\index{config@{config}!ciot\_bridge\_data\_u@{ciot\_bridge\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__bridge__cfg__t}{ciot\+\_\+bridge\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__bridge__data__u_a21b1ec52268024ae8c4b0eca1dc2a491}\label{unionciot__bridge__data__u_a21b1ec52268024ae8c4b0eca1dc2a491} -\index{ciot\_bridge\_data\_u@{ciot\_bridge\_data\_u}!request@{request}} -\index{request@{request}!ciot\_bridge\_data\_u@{ciot\_bridge\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__bridge__req__t}{ciot\+\_\+bridge\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__bridge__data__u_ab50a6b7e2887ecb6625b540edae99138}\label{unionciot__bridge__data__u_ab50a6b7e2887ecb6625b540edae99138} -\index{ciot\_bridge\_data\_u@{ciot\_bridge\_data\_u}!status@{status}} -\index{status@{status}!ciot\_bridge\_data\_u@{ciot\_bridge\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__bridge__status__t}{ciot\+\_\+bridge\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__bridge__req__data__u.tex b/docs/latex/unionciot__bridge__req__data__u.tex deleted file mode 100644 index 7165bb7..0000000 --- a/docs/latex/unionciot__bridge__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+bridge\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__bridge__req__data__u}{}\label{unionciot__bridge__req__data__u}\index{ciot\_bridge\_req\_data\_u@{ciot\_bridge\_req\_data\_u}} - - -Union for CIOT bridge request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+bridge\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT bridge request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__bridge__types_8h}{ciot\+\_\+bridge\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__data__model__data__u.tex b/docs/latex/unionciot__data__model__data__u.tex deleted file mode 100644 index 1bc93e9..0000000 --- a/docs/latex/unionciot__data__model__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+data\+\_\+model\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__data__model__data__u}{}\label{unionciot__data__model__data__u}\index{ciot\_data\_model\_data\_u@{ciot\_data\_model\_data\_u}} - - -Union for CIOT data model data. - - - - -{\ttfamily \#include $<$ciot\+\_\+data\+\_\+model\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__data__model__cfg__t}{ciot\+\_\+data\+\_\+model\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__data__model__data__u_a0a7b5df86de5bd60d09108b02de9d89d}{config}} -\item -\mbox{\hyperlink{structciot__data__model__status__t}{ciot\+\_\+data\+\_\+model\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__data__model__data__u_a3f4172ed60af91f49f998cde97dd28cb}{status}} -\item -\mbox{\hyperlink{structciot__data__model__req__t}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__data__model__data__u_a8342e156b9596a1154ff4ce550adb30f}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT data model data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__data__model__data__u_a0a7b5df86de5bd60d09108b02de9d89d}\label{unionciot__data__model__data__u_a0a7b5df86de5bd60d09108b02de9d89d} -\index{ciot\_data\_model\_data\_u@{ciot\_data\_model\_data\_u}!config@{config}} -\index{config@{config}!ciot\_data\_model\_data\_u@{ciot\_data\_model\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__data__model__cfg__t}{ciot\+\_\+data\+\_\+model\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__data__model__data__u_a8342e156b9596a1154ff4ce550adb30f}\label{unionciot__data__model__data__u_a8342e156b9596a1154ff4ce550adb30f} -\index{ciot\_data\_model\_data\_u@{ciot\_data\_model\_data\_u}!request@{request}} -\index{request@{request}!ciot\_data\_model\_data\_u@{ciot\_data\_model\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__data__model__req__t}{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__data__model__data__u_a3f4172ed60af91f49f998cde97dd28cb}\label{unionciot__data__model__data__u_a3f4172ed60af91f49f998cde97dd28cb} -\index{ciot\_data\_model\_data\_u@{ciot\_data\_model\_data\_u}!status@{status}} -\index{status@{status}!ciot\_data\_model\_data\_u@{ciot\_data\_model\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__data__model__status__t}{ciot\+\_\+data\+\_\+model\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__data__model__req__data__u.tex b/docs/latex/unionciot__data__model__req__data__u.tex deleted file mode 100644 index b9a43f5..0000000 --- a/docs/latex/unionciot__data__model__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+data\+\_\+model\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__data__model__req__data__u}{}\label{unionciot__data__model__req__data__u}\index{ciot\_data\_model\_req\_data\_u@{ciot\_data\_model\_req\_data\_u}} - - -Union for CIOT data model request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+data\+\_\+model\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT data model request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__data__model__types_8h}{ciot\+\_\+data\+\_\+model\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__data__u.tex b/docs/latex/unionciot__data__u.tex deleted file mode 100644 index 78ad7e7..0000000 --- a/docs/latex/unionciot__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__data__u}{}\label{unionciot__data__u}\index{ciot\_data\_u@{ciot\_data\_u}} - - -Union for CIOT data. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__iface__cfg__t}{ciot\+\_\+iface\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__data__u_a82e7ef84cdd4eb20f2da20f0df751fd3}{config}} -\item -\mbox{\hyperlink{structciot__status__t}{ciot\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__data__u_ac4db33ce66ac8ec09d4b5b088eb88ead}{status}} -\item -\mbox{\hyperlink{structciot__req__t}{ciot\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__data__u_a8975b1b5a295a8ee8669dfcce942dcd5}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__data__u_a82e7ef84cdd4eb20f2da20f0df751fd3}\label{unionciot__data__u_a82e7ef84cdd4eb20f2da20f0df751fd3} -\index{ciot\_data\_u@{ciot\_data\_u}!config@{config}} -\index{config@{config}!ciot\_data\_u@{ciot\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__iface__cfg__t}{ciot\+\_\+iface\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{unionciot__data__u_a8975b1b5a295a8ee8669dfcce942dcd5}\label{unionciot__data__u_a8975b1b5a295a8ee8669dfcce942dcd5} -\index{ciot\_data\_u@{ciot\_data\_u}!request@{request}} -\index{request@{request}!ciot\_data\_u@{ciot\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__req__t}{ciot\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{unionciot__data__u_ac4db33ce66ac8ec09d4b5b088eb88ead}\label{unionciot__data__u_ac4db33ce66ac8ec09d4b5b088eb88ead} -\index{ciot\_data\_u@{ciot\_data\_u}!status@{status}} -\index{status@{status}!ciot\_data\_u@{ciot\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__status__t}{ciot\+\_\+status\+\_\+t}} status} - -Status data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__dfu__data__u.tex b/docs/latex/unionciot__dfu__data__u.tex deleted file mode 100644 index b652fb5..0000000 --- a/docs/latex/unionciot__dfu__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+dfu\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__dfu__data__u}{}\label{unionciot__dfu__data__u}\index{ciot\_dfu\_data\_u@{ciot\_dfu\_data\_u}} - - -Union for CIOT DFU data. - - - - -{\ttfamily \#include $<$ciot\+\_\+dfu\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__dfu__data__u_a8d4be68066e35bb11aecfff26e3cb30b}{config}} -\item -\mbox{\hyperlink{structciot__dfu__status__t}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__dfu__data__u_a9fb48f785812375d586c71a02b453e64}{status}} -\item -\mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__dfu__data__u_aeec32200114264e8556110d5c2ffc44c}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT DFU data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__dfu__data__u_a8d4be68066e35bb11aecfff26e3cb30b}\label{unionciot__dfu__data__u_a8d4be68066e35bb11aecfff26e3cb30b} -\index{ciot\_dfu\_data\_u@{ciot\_dfu\_data\_u}!config@{config}} -\index{config@{config}!ciot\_dfu\_data\_u@{ciot\_dfu\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__dfu__cfg__t}{ciot\+\_\+dfu\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__dfu__data__u_aeec32200114264e8556110d5c2ffc44c}\label{unionciot__dfu__data__u_aeec32200114264e8556110d5c2ffc44c} -\index{ciot\_dfu\_data\_u@{ciot\_dfu\_data\_u}!request@{request}} -\index{request@{request}!ciot\_dfu\_data\_u@{ciot\_dfu\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__dfu__req__t}{ciot\+\_\+dfu\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__dfu__data__u_a9fb48f785812375d586c71a02b453e64}\label{unionciot__dfu__data__u_a9fb48f785812375d586c71a02b453e64} -\index{ciot\_dfu\_data\_u@{ciot\_dfu\_data\_u}!status@{status}} -\index{status@{status}!ciot\_dfu\_data\_u@{ciot\_dfu\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__dfu__status__t}{ciot\+\_\+dfu\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__dfu__req__data__u.tex b/docs/latex/unionciot__dfu__req__data__u.tex deleted file mode 100644 index 8b3c74f..0000000 --- a/docs/latex/unionciot__dfu__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+dfu\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__dfu__req__data__u}{}\label{unionciot__dfu__req__data__u}\index{ciot\_dfu\_req\_data\_u@{ciot\_dfu\_req\_data\_u}} - - -Union for CIOT DFU request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+dfu\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT DFU request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__dfu__types_8h}{ciot\+\_\+dfu\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__gpio__data__u.tex b/docs/latex/unionciot__gpio__data__u.tex deleted file mode 100644 index f42135e..0000000 --- a/docs/latex/unionciot__gpio__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__gpio__data__u}{}\label{unionciot__gpio__data__u}\index{ciot\_gpio\_data\_u@{ciot\_gpio\_data\_u}} - - -Union for CIOT GPIO data. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__gpio__data__u_a15039efacca36cdba57c2ccf7b0a3d4f}{config}} -\item -\mbox{\hyperlink{structciot__gpio__status__t}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__gpio__data__u_af7b93aeb68c1648ccb2617ff8217e7b0}{status}} -\item -\mbox{\hyperlink{structciot__gpio__req__t}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__gpio__data__u_ac3fb50fe28f5e2ea50c6f662aa19beca}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT GPIO data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__gpio__data__u_a15039efacca36cdba57c2ccf7b0a3d4f}\label{unionciot__gpio__data__u_a15039efacca36cdba57c2ccf7b0a3d4f} -\index{ciot\_gpio\_data\_u@{ciot\_gpio\_data\_u}!config@{config}} -\index{config@{config}!ciot\_gpio\_data\_u@{ciot\_gpio\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__gpio__data__u_ac3fb50fe28f5e2ea50c6f662aa19beca}\label{unionciot__gpio__data__u_ac3fb50fe28f5e2ea50c6f662aa19beca} -\index{ciot\_gpio\_data\_u@{ciot\_gpio\_data\_u}!request@{request}} -\index{request@{request}!ciot\_gpio\_data\_u@{ciot\_gpio\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__gpio__req__t}{ciot\+\_\+gpio\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__gpio__data__u_af7b93aeb68c1648ccb2617ff8217e7b0}\label{unionciot__gpio__data__u_af7b93aeb68c1648ccb2617ff8217e7b0} -\index{ciot\_gpio\_data\_u@{ciot\_gpio\_data\_u}!status@{status}} -\index{status@{status}!ciot\_gpio\_data\_u@{ciot\_gpio\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__gpio__status__t}{ciot\+\_\+gpio\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__gpio__req__data__u.tex b/docs/latex/unionciot__gpio__req__data__u.tex deleted file mode 100644 index aa7d083..0000000 --- a/docs/latex/unionciot__gpio__req__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+gpio\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__gpio__req__data__u}{}\label{unionciot__gpio__req__data__u}\index{ciot\_gpio\_req\_data\_u@{ciot\_gpio\_req\_data\_u}} - - -Union for CIOT GPIO request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+gpio\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__gpio__req__data__u_a15039efacca36cdba57c2ccf7b0a3d4f}{config}} -\item -\mbox{\hyperlink{structciot__gpio__state__info__t}{ciot\+\_\+gpio\+\_\+state\+\_\+info\+\_\+t}} \mbox{\hyperlink{unionciot__gpio__req__data__u_a5cc92c2a01be84c116055f80d77e5140}{set\+\_\+state}} -\item -\mbox{\hyperlink{structciot__gpio__req__get__state__t}{ciot\+\_\+gpio\+\_\+req\+\_\+get\+\_\+state\+\_\+t}} \mbox{\hyperlink{unionciot__gpio__req__data__u_a93559a0f91d62042000a3276dc457506}{get\+\_\+state}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT GPIO request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__gpio__req__data__u_a15039efacca36cdba57c2ccf7b0a3d4f}\label{unionciot__gpio__req__data__u_a15039efacca36cdba57c2ccf7b0a3d4f} -\index{ciot\_gpio\_req\_data\_u@{ciot\_gpio\_req\_data\_u}!config@{config}} -\index{config@{config}!ciot\_gpio\_req\_data\_u@{ciot\_gpio\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__gpio__cfg__t}{ciot\+\_\+gpio\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__gpio__req__data__u_a93559a0f91d62042000a3276dc457506}\label{unionciot__gpio__req__data__u_a93559a0f91d62042000a3276dc457506} -\index{ciot\_gpio\_req\_data\_u@{ciot\_gpio\_req\_data\_u}!get\_state@{get\_state}} -\index{get\_state@{get\_state}!ciot\_gpio\_req\_data\_u@{ciot\_gpio\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{get\_state}{get\_state}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__gpio__req__get__state__t}{ciot\+\_\+gpio\+\_\+req\+\_\+get\+\_\+state\+\_\+t}} get\+\_\+state} - -Get state request \Hypertarget{unionciot__gpio__req__data__u_a5cc92c2a01be84c116055f80d77e5140}\label{unionciot__gpio__req__data__u_a5cc92c2a01be84c116055f80d77e5140} -\index{ciot\_gpio\_req\_data\_u@{ciot\_gpio\_req\_data\_u}!set\_state@{set\_state}} -\index{set\_state@{set\_state}!ciot\_gpio\_req\_data\_u@{ciot\_gpio\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{set\_state}{set\_state}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__gpio__state__info__t}{ciot\+\_\+gpio\+\_\+state\+\_\+info\+\_\+t}} set\+\_\+state} - -Set state information - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__gpio__types_8h}{ciot\+\_\+gpio\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__httpc__data__u.tex b/docs/latex/unionciot__httpc__data__u.tex deleted file mode 100644 index 8bcc3d4..0000000 --- a/docs/latex/unionciot__httpc__data__u.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__httpc__data__u}{}\label{unionciot__httpc__data__u}\index{ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}} - - -Union for CIOT HTTP client data. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__httpc__data__u_a0ddab1f295ea5861939322623d313037}{config}} -\item -\mbox{\hyperlink{structciot__httpc__status__t}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__httpc__data__u_ac5c1eb82650b9d0161a399175c459ad3}{status}} -\item -\mbox{\hyperlink{structciot__httpc__req__t}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__httpc__data__u_a57c784a27da9399f6d1a7bd2122a3c65}{request}} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}{ciot\+\_\+httpc\+\_\+event\+\_\+u}} \mbox{\hyperlink{unionciot__httpc__data__u_a28206abcb96418175c4998aaff04c99a}{event}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT HTTP client data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__httpc__data__u_a0ddab1f295ea5861939322623d313037}\label{unionciot__httpc__data__u_a0ddab1f295ea5861939322623d313037} -\index{ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}!config@{config}} -\index{config@{config}!ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__httpc__cfg__t}{ciot\+\_\+httpc\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__httpc__data__u_a28206abcb96418175c4998aaff04c99a}\label{unionciot__httpc__data__u_a28206abcb96418175c4998aaff04c99a} -\index{ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}!event@{event}} -\index{event@{event}!ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}} -\doxysubsubsection{\texorpdfstring{event}{event}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a7bb2afccf9d5b80356508aae726c6196}{ciot\+\_\+httpc\+\_\+event\+\_\+u}} event} - -Event \Hypertarget{unionciot__httpc__data__u_a57c784a27da9399f6d1a7bd2122a3c65}\label{unionciot__httpc__data__u_a57c784a27da9399f6d1a7bd2122a3c65} -\index{ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}!request@{request}} -\index{request@{request}!ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__httpc__req__t}{ciot\+\_\+httpc\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__httpc__data__u_ac5c1eb82650b9d0161a399175c459ad3}\label{unionciot__httpc__data__u_ac5c1eb82650b9d0161a399175c459ad3} -\index{ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}!status@{status}} -\index{status@{status}!ciot\_httpc\_data\_u@{ciot\_httpc\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__httpc__status__t}{ciot\+\_\+httpc\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__httpc__event.tex b/docs/latex/unionciot__httpc__event.tex deleted file mode 100644 index b761ed5..0000000 --- a/docs/latex/unionciot__httpc__event.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+event Union Reference} -\hypertarget{unionciot__httpc__event}{}\label{unionciot__httpc__event}\index{ciot\_httpc\_event@{ciot\_httpc\_event}} - - -Union for CIOT HTTP client event. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__httpc__types_8h_a491fa8406af26b99bd40ebb9ab2329da}{ciot\+\_\+httpc\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{unionciot__httpc__event_a6ec8e644d05e4d629a77959492eee5d3}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT HTTP client event. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__httpc__event_a6ec8e644d05e4d629a77959492eee5d3}\label{unionciot__httpc__event_a6ec8e644d05e4d629a77959492eee5d3} -\index{ciot\_httpc\_event@{ciot\_httpc\_event}!data@{data}} -\index{data@{data}!ciot\_httpc\_event@{ciot\_httpc\_event}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__httpc__types_8h_a491fa8406af26b99bd40ebb9ab2329da}{ciot\+\_\+httpc\+\_\+event\+\_\+data\+\_\+t}} data} - -Event data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__httpc__req__data.tex b/docs/latex/unionciot__httpc__req__data.tex deleted file mode 100644 index e45a31a..0000000 --- a/docs/latex/unionciot__httpc__req__data.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+httpc\+\_\+req\+\_\+data Union Reference} -\hypertarget{unionciot__httpc__req__data}{}\label{unionciot__httpc__req__data}\index{ciot\_httpc\_req\_data@{ciot\_httpc\_req\_data}} - - -Union for CIOT HTTP client request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+httpc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__httpc__req__send__t}{ciot\+\_\+httpc\+\_\+req\+\_\+send\+\_\+t}} \mbox{\hyperlink{unionciot__httpc__req__data_ad6a0d166be37b6649d30122842622328}{send}} -\item -\mbox{\hyperlink{structciot__httpc__req__set__header__t}{ciot\+\_\+httpc\+\_\+req\+\_\+set\+\_\+header\+\_\+t}} \mbox{\hyperlink{unionciot__httpc__req__data_aa49303f9ec122aab28d291d44dcd0da5}{set\+\_\+header}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT HTTP client request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__httpc__req__data_ad6a0d166be37b6649d30122842622328}\label{unionciot__httpc__req__data_ad6a0d166be37b6649d30122842622328} -\index{ciot\_httpc\_req\_data@{ciot\_httpc\_req\_data}!send@{send}} -\index{send@{send}!ciot\_httpc\_req\_data@{ciot\_httpc\_req\_data}} -\doxysubsubsection{\texorpdfstring{send}{send}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__httpc__req__send__t}{ciot\+\_\+httpc\+\_\+req\+\_\+send\+\_\+t}} send} - -Send data request \Hypertarget{unionciot__httpc__req__data_aa49303f9ec122aab28d291d44dcd0da5}\label{unionciot__httpc__req__data_aa49303f9ec122aab28d291d44dcd0da5} -\index{ciot\_httpc\_req\_data@{ciot\_httpc\_req\_data}!set\_header@{set\_header}} -\index{set\_header@{set\_header}!ciot\_httpc\_req\_data@{ciot\_httpc\_req\_data}} -\doxysubsubsection{\texorpdfstring{set\_header}{set\_header}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__httpc__req__set__header__t}{ciot\+\_\+httpc\+\_\+req\+\_\+set\+\_\+header\+\_\+t}} set\+\_\+header} - -Set header request - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__httpc__types_8h}{ciot\+\_\+httpc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__https__data__u.tex b/docs/latex/unionciot__https__data__u.tex deleted file mode 100644 index 9fa3fce..0000000 --- a/docs/latex/unionciot__https__data__u.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__https__data__u}{}\label{unionciot__https__data__u}\index{ciot\_https\_data\_u@{ciot\_https\_data\_u}} - - -Union for CIOT HTTP server data. - - - - -{\ttfamily \#include $<$ciot\+\_\+https\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__https__cfg__t}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__https__data__u_a07d1ec38980b47dde9caaa52c42163cf}{config}} -\item -\mbox{\hyperlink{structciot__https__status__t}{ciot\+\_\+https\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__https__data__u_ae71d44b4ec9b04f2b3eb183ae791f6ca}{status}} -\item -\mbox{\hyperlink{structciot__https__req__t}{ciot\+\_\+https\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__https__data__u_af4b02bc60804013ff8623f078ec43efe}{request}} -\item -\mbox{\hyperlink{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}{ciot\+\_\+https\+\_\+event\+\_\+u}} \mbox{\hyperlink{unionciot__https__data__u_ad463eb5d86dcaf2c866494686da9ce6e}{event}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT HTTP server data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__https__data__u_a07d1ec38980b47dde9caaa52c42163cf}\label{unionciot__https__data__u_a07d1ec38980b47dde9caaa52c42163cf} -\index{ciot\_https\_data\_u@{ciot\_https\_data\_u}!config@{config}} -\index{config@{config}!ciot\_https\_data\_u@{ciot\_https\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__https__cfg__t}{ciot\+\_\+https\+\_\+cfg\+\_\+t}} config} - -Configuration \Hypertarget{unionciot__https__data__u_ad463eb5d86dcaf2c866494686da9ce6e}\label{unionciot__https__data__u_ad463eb5d86dcaf2c866494686da9ce6e} -\index{ciot\_https\_data\_u@{ciot\_https\_data\_u}!event@{event}} -\index{event@{event}!ciot\_https\_data\_u@{ciot\_https\_data\_u}} -\doxysubsubsection{\texorpdfstring{event}{event}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__https__types_8h_aec67a3b9fe62b79e7252d89476bd4704}{ciot\+\_\+https\+\_\+event\+\_\+u}} event} - -Event \Hypertarget{unionciot__https__data__u_af4b02bc60804013ff8623f078ec43efe}\label{unionciot__https__data__u_af4b02bc60804013ff8623f078ec43efe} -\index{ciot\_https\_data\_u@{ciot\_https\_data\_u}!request@{request}} -\index{request@{request}!ciot\_https\_data\_u@{ciot\_https\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__https__req__t}{ciot\+\_\+https\+\_\+req\+\_\+t}} request} - -Request \Hypertarget{unionciot__https__data__u_ae71d44b4ec9b04f2b3eb183ae791f6ca}\label{unionciot__https__data__u_ae71d44b4ec9b04f2b3eb183ae791f6ca} -\index{ciot\_https\_data\_u@{ciot\_https\_data\_u}!status@{status}} -\index{status@{status}!ciot\_https\_data\_u@{ciot\_https\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__https__status__t}{ciot\+\_\+https\+\_\+status\+\_\+t}} status} - -Status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__https__req__data__u.tex b/docs/latex/unionciot__https__req__data__u.tex deleted file mode 100644 index b07e81b..0000000 --- a/docs/latex/unionciot__https__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+https\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__https__req__data__u}{}\label{unionciot__https__req__data__u}\index{ciot\_https\_req\_data\_u@{ciot\_https\_req\_data\_u}} - - -Union for CIOT HTTP server request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+https\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT HTTP server request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__https__types_8h}{ciot\+\_\+https\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__iface__event__data__u.tex b/docs/latex/unionciot__iface__event__data__u.tex deleted file mode 100644 index 2dcb868..0000000 --- a/docs/latex/unionciot__iface__event__data__u.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+iface\+\_\+event\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__iface__event__data__u}{}\label{unionciot__iface__event__data__u}\index{ciot\_iface\_event\_data\_u@{ciot\_iface\_event\_data\_u}} - - -Union for CIOT interface event data. - - - - -{\ttfamily \#include $<$ciot\+\_\+iface.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} \mbox{\hyperlink{unionciot__iface__event__data__u_abd6b36b1e2c07eaa53b376fdbf0e9345}{msg}} -\item -uint8\+\_\+t \mbox{\hyperlink{unionciot__iface__event__data__u_a7aa0ef98c65d1029e00692392d89bebe}{payload}} \mbox{[}sizeof(\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}})\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT interface event data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__iface__event__data__u_abd6b36b1e2c07eaa53b376fdbf0e9345}\label{unionciot__iface__event__data__u_abd6b36b1e2c07eaa53b376fdbf0e9345} -\index{ciot\_iface\_event\_data\_u@{ciot\_iface\_event\_data\_u}!msg@{msg}} -\index{msg@{msg}!ciot\_iface\_event\_data\_u@{ciot\_iface\_event\_data\_u}} -\doxysubsubsection{\texorpdfstring{msg}{msg}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}} msg} - -CIOT message. \Hypertarget{unionciot__iface__event__data__u_a7aa0ef98c65d1029e00692392d89bebe}\label{unionciot__iface__event__data__u_a7aa0ef98c65d1029e00692392d89bebe} -\index{ciot\_iface\_event\_data\_u@{ciot\_iface\_event\_data\_u}!payload@{payload}} -\index{payload@{payload}!ciot\_iface\_event\_data\_u@{ciot\_iface\_event\_data\_u}} -\doxysubsubsection{\texorpdfstring{payload}{payload}} -{\footnotesize\ttfamily uint8\+\_\+t payload\mbox{[}sizeof(\mbox{\hyperlink{structciot__msg__t}{ciot\+\_\+msg\+\_\+t}})\mbox{]}} - -Payload data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/\mbox{\hyperlink{ciot__iface_8h}{ciot\+\_\+iface.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__mqttc__data__u.tex b/docs/latex/unionciot__mqttc__data__u.tex deleted file mode 100644 index 4926cfc..0000000 --- a/docs/latex/unionciot__mqttc__data__u.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__mqttc__data__u}{}\label{unionciot__mqttc__data__u}\index{ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}} - - -Union for CIOT MQTT client data. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__mqttc__data__u_a79c158a8d9a5ddac01d944ca9485764b}{config}} -\item -\mbox{\hyperlink{structciot__mqttc__status__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__mqttc__data__u_a0bd4162002c890f2775878d4da138c03}{status}} -\item -\mbox{\hyperlink{structciot__mqttc__req__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__mqttc__data__u_af4d809ae5adfaf23b4229995212f0ded}{request}} -\item -\mbox{\hyperlink{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}{ciot\+\_\+mqttc\+\_\+event\+\_\+u}} \mbox{\hyperlink{unionciot__mqttc__data__u_aea75f103343a18512b1024505e9766de}{event}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT MQTT client data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__mqttc__data__u_a79c158a8d9a5ddac01d944ca9485764b}\label{unionciot__mqttc__data__u_a79c158a8d9a5ddac01d944ca9485764b} -\index{ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}!config@{config}} -\index{config@{config}!ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__cfg__t}{ciot\+\_\+mqttc\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{unionciot__mqttc__data__u_aea75f103343a18512b1024505e9766de}\label{unionciot__mqttc__data__u_aea75f103343a18512b1024505e9766de} -\index{ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}!event@{event}} -\index{event@{event}!ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}} -\doxysubsubsection{\texorpdfstring{event}{event}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__mqttc__types_8h_ab0721513ba2621aaa8012e6a5f6e79ea}{ciot\+\_\+mqttc\+\_\+event\+\_\+u}} event} - -Event data \Hypertarget{unionciot__mqttc__data__u_af4d809ae5adfaf23b4229995212f0ded}\label{unionciot__mqttc__data__u_af4d809ae5adfaf23b4229995212f0ded} -\index{ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}!request@{request}} -\index{request@{request}!ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__req__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{unionciot__mqttc__data__u_a0bd4162002c890f2775878d4da138c03}\label{unionciot__mqttc__data__u_a0bd4162002c890f2775878d4da138c03} -\index{ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}!status@{status}} -\index{status@{status}!ciot\_mqttc\_data\_u@{ciot\_mqttc\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__status__t}{ciot\+\_\+mqttc\+\_\+status\+\_\+t}} status} - -Status data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__mqttc__req__data__u.tex b/docs/latex/unionciot__mqttc__req__data__u.tex deleted file mode 100644 index f60e57e..0000000 --- a/docs/latex/unionciot__mqttc__req__data__u.tex +++ /dev/null @@ -1,41 +0,0 @@ -\doxysection{ciot\+\_\+mqttc\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__mqttc__req__data__u}{}\label{unionciot__mqttc__req__data__u}\index{ciot\_mqttc\_req\_data\_u@{ciot\_mqttc\_req\_data\_u}} - - -Union for CIOT MQTT client request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+mqttc\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__mqttc__req__publish__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+publish\+\_\+t}} \mbox{\hyperlink{unionciot__mqttc__req__data__u_ae7b5bde19c99952b5a737b600f3c21e6}{publish}} -\item -\mbox{\hyperlink{structciot__mqttc__req__subscribe__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+subscribe\+\_\+t}} \mbox{\hyperlink{unionciot__mqttc__req__data__u_a061e16f43670bc7f5d29c3971b4088c3}{subscribe}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT MQTT client request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__mqttc__req__data__u_ae7b5bde19c99952b5a737b600f3c21e6}\label{unionciot__mqttc__req__data__u_ae7b5bde19c99952b5a737b600f3c21e6} -\index{ciot\_mqttc\_req\_data\_u@{ciot\_mqttc\_req\_data\_u}!publish@{publish}} -\index{publish@{publish}!ciot\_mqttc\_req\_data\_u@{ciot\_mqttc\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{publish}{publish}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__req__publish__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+publish\+\_\+t}} publish} - -Publish request data \Hypertarget{unionciot__mqttc__req__data__u_a061e16f43670bc7f5d29c3971b4088c3}\label{unionciot__mqttc__req__data__u_a061e16f43670bc7f5d29c3971b4088c3} -\index{ciot\_mqttc\_req\_data\_u@{ciot\_mqttc\_req\_data\_u}!subscribe@{subscribe}} -\index{subscribe@{subscribe}!ciot\_mqttc\_req\_data\_u@{ciot\_mqttc\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{subscribe}{subscribe}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__mqttc__req__subscribe__t}{ciot\+\_\+mqttc\+\_\+req\+\_\+subscribe\+\_\+t}} subscribe} - -Subscribe request data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__mqttc__types_8h}{ciot\+\_\+mqttc\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__msg__data__u.tex b/docs/latex/unionciot__msg__data__u.tex deleted file mode 100644 index 690e134..0000000 --- a/docs/latex/unionciot__msg__data__u.tex +++ /dev/null @@ -1,169 +0,0 @@ -\doxysection{ciot\+\_\+msg\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__msg__data__u}{}\label{unionciot__msg__data__u}\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} - - -Union for CIOT message data. - - - - -{\ttfamily \#include $<$ciot\+\_\+msg\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{unionciot__data__u}{ciot\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_afedab1afecebfb5eb8554e3b1b056502}{ciot}} -\item -\mbox{\hyperlink{unionciot__storage__data__u}{ciot\+\_\+storage\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a4c64bed640d14af56502dd8dceb9ab20}{storage}} -\item -\mbox{\hyperlink{unionciot__sys__data__u}{ciot\+\_\+sys\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a04c7e159105631b657e5b65f977a2c4a}{system}} -\item -\mbox{\hyperlink{unionciot__uart__data__u}{ciot\+\_\+uart\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_aeaf49cc638f1cc4fac1c69fa12502d32}{uart}} -\item -\mbox{\hyperlink{unionciot__usb__data__u}{ciot\+\_\+usb\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_acd0961872f365a2b54fef650ac190f50}{usb}} -\item -\mbox{\hyperlink{unionciot__tcp__data__u}{ciot\+\_\+tcp\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a2744efd5cf43b6d40d61ea66f7f620d3}{tcp}} -\item -\mbox{\hyperlink{unionciot__wifi__data__u}{ciot\+\_\+wifi\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_ac06a3086376da2d8a84120762824336c}{wifi}} -\item -\mbox{\hyperlink{unionciot__ble__data__u}{ciot\+\_\+ble\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a8c90dd3961baa84d90870ce1f180006d}{ble}} -\item -\mbox{\hyperlink{unionciot__ble__scn__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a30ef17c042c5a942dc6491370179966c}{ble\+\_\+scn}} -\item -\mbox{\hyperlink{unionciot__ntp__data__u}{ciot\+\_\+ntp\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a562d7a6cdd9053ec0bf7431017972903}{ntp}} -\item -\mbox{\hyperlink{unionciot__ota__data__u}{ciot\+\_\+ota\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a466cfd56b729d0efcfa70cff1a8b7b85}{ota}} -\item -\mbox{\hyperlink{unionciot__dfu__data__u}{ciot\+\_\+dfu\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a818d9af5834bb69bdafd6513ae494405}{dfu}} -\item -\mbox{\hyperlink{unionciot__https__data__u}{ciot\+\_\+https\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a6a8bc746dffc95f0f7b3c468023e10ae}{https}} -\item -\mbox{\hyperlink{unionciot__httpc__data__u}{ciot\+\_\+httpc\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a7d6cac53c9bf51f572908dc2a5b383f0}{httpc}} -\item -\mbox{\hyperlink{unionciot__mqttc__data__u}{ciot\+\_\+mqttc\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a57eed7a24887f5d1adba0df0ca8f29f5}{mqtt}} -\item -\mbox{\hyperlink{unionciot__bridge__data__u}{ciot\+\_\+bridge\+\_\+data\+\_\+u}} \mbox{\hyperlink{unionciot__msg__data__u_a2f12825330d395d82f01240cf84e6328}{bridge}} -\item -\mbox{\hyperlink{structciot__msg__error__t}{ciot\+\_\+msg\+\_\+error\+\_\+t}} \mbox{\hyperlink{unionciot__msg__data__u_a460f5e2f775eebdacec0950914ab87a9}{error}} -\item -uint8\+\_\+t \mbox{\hyperlink{unionciot__msg__data__u_aa1e13a945a02b050ffc85c83d3ebce1c}{payload}} \mbox{[}256\mbox{]} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT message data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__msg__data__u_a8c90dd3961baa84d90870ce1f180006d}\label{unionciot__msg__data__u_a8c90dd3961baa84d90870ce1f180006d} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!ble@{ble}} -\index{ble@{ble}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{ble}{ble}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ble__data__u}{ciot\+\_\+ble\+\_\+data\+\_\+u}} ble} - -BLE data \Hypertarget{unionciot__msg__data__u_a30ef17c042c5a942dc6491370179966c}\label{unionciot__msg__data__u_a30ef17c042c5a942dc6491370179966c} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!ble\_scn@{ble\_scn}} -\index{ble\_scn@{ble\_scn}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{ble\_scn}{ble\_scn}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ble__scn__data__u}{ciot\+\_\+ble\+\_\+scn\+\_\+data\+\_\+u}} ble\+\_\+scn} - -BLE SCN data \Hypertarget{unionciot__msg__data__u_a2f12825330d395d82f01240cf84e6328}\label{unionciot__msg__data__u_a2f12825330d395d82f01240cf84e6328} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!bridge@{bridge}} -\index{bridge@{bridge}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{bridge}{bridge}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__bridge__data__u}{ciot\+\_\+bridge\+\_\+data\+\_\+u}} bridge} - -Bridge data \Hypertarget{unionciot__msg__data__u_afedab1afecebfb5eb8554e3b1b056502}\label{unionciot__msg__data__u_afedab1afecebfb5eb8554e3b1b056502} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!ciot@{ciot}} -\index{ciot@{ciot}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{ciot}{ciot}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__data__u}{ciot\+\_\+data\+\_\+u}} ciot} - -CIOT data \Hypertarget{unionciot__msg__data__u_a818d9af5834bb69bdafd6513ae494405}\label{unionciot__msg__data__u_a818d9af5834bb69bdafd6513ae494405} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!dfu@{dfu}} -\index{dfu@{dfu}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{dfu}{dfu}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__dfu__data__u}{ciot\+\_\+dfu\+\_\+data\+\_\+u}} dfu} - -DFU data \Hypertarget{unionciot__msg__data__u_a460f5e2f775eebdacec0950914ab87a9}\label{unionciot__msg__data__u_a460f5e2f775eebdacec0950914ab87a9} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!error@{error}} -\index{error@{error}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{error}{error}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__msg__error__t}{ciot\+\_\+msg\+\_\+error\+\_\+t}} error} - -Error data \Hypertarget{unionciot__msg__data__u_a7d6cac53c9bf51f572908dc2a5b383f0}\label{unionciot__msg__data__u_a7d6cac53c9bf51f572908dc2a5b383f0} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!httpc@{httpc}} -\index{httpc@{httpc}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{httpc}{httpc}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__httpc__data__u}{ciot\+\_\+httpc\+\_\+data\+\_\+u}} httpc} - -HTTP client data \Hypertarget{unionciot__msg__data__u_a6a8bc746dffc95f0f7b3c468023e10ae}\label{unionciot__msg__data__u_a6a8bc746dffc95f0f7b3c468023e10ae} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!https@{https}} -\index{https@{https}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{https}{https}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__https__data__u}{ciot\+\_\+https\+\_\+data\+\_\+u}} https} - -HTTP server data \Hypertarget{unionciot__msg__data__u_a57eed7a24887f5d1adba0df0ca8f29f5}\label{unionciot__msg__data__u_a57eed7a24887f5d1adba0df0ca8f29f5} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!mqtt@{mqtt}} -\index{mqtt@{mqtt}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{mqtt}{mqtt}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__mqttc__data__u}{ciot\+\_\+mqttc\+\_\+data\+\_\+u}} mqtt} - -MQTT client data \Hypertarget{unionciot__msg__data__u_a562d7a6cdd9053ec0bf7431017972903}\label{unionciot__msg__data__u_a562d7a6cdd9053ec0bf7431017972903} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!ntp@{ntp}} -\index{ntp@{ntp}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{ntp}{ntp}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ntp__data__u}{ciot\+\_\+ntp\+\_\+data\+\_\+u}} ntp} - -NTP data \Hypertarget{unionciot__msg__data__u_a466cfd56b729d0efcfa70cff1a8b7b85}\label{unionciot__msg__data__u_a466cfd56b729d0efcfa70cff1a8b7b85} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!ota@{ota}} -\index{ota@{ota}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{ota}{ota}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__ota__data__u}{ciot\+\_\+ota\+\_\+data\+\_\+u}} ota} - -OTA data \Hypertarget{unionciot__msg__data__u_aa1e13a945a02b050ffc85c83d3ebce1c}\label{unionciot__msg__data__u_aa1e13a945a02b050ffc85c83d3ebce1c} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!payload@{payload}} -\index{payload@{payload}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{payload}{payload}} -{\footnotesize\ttfamily uint8\+\_\+t payload\mbox{[}256\mbox{]}} - -Payload data \Hypertarget{unionciot__msg__data__u_a4c64bed640d14af56502dd8dceb9ab20}\label{unionciot__msg__data__u_a4c64bed640d14af56502dd8dceb9ab20} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!storage@{storage}} -\index{storage@{storage}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{storage}{storage}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__storage__data__u}{ciot\+\_\+storage\+\_\+data\+\_\+u}} storage} - -Storage data \Hypertarget{unionciot__msg__data__u_a04c7e159105631b657e5b65f977a2c4a}\label{unionciot__msg__data__u_a04c7e159105631b657e5b65f977a2c4a} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!system@{system}} -\index{system@{system}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{system}{system}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__sys__data__u}{ciot\+\_\+sys\+\_\+data\+\_\+u}} system} - -System data \Hypertarget{unionciot__msg__data__u_a2744efd5cf43b6d40d61ea66f7f620d3}\label{unionciot__msg__data__u_a2744efd5cf43b6d40d61ea66f7f620d3} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!tcp@{tcp}} -\index{tcp@{tcp}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{tcp}{tcp}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__tcp__data__u}{ciot\+\_\+tcp\+\_\+data\+\_\+u}} tcp} - -TCP data \Hypertarget{unionciot__msg__data__u_aeaf49cc638f1cc4fac1c69fa12502d32}\label{unionciot__msg__data__u_aeaf49cc638f1cc4fac1c69fa12502d32} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!uart@{uart}} -\index{uart@{uart}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{uart}{uart}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__uart__data__u}{ciot\+\_\+uart\+\_\+data\+\_\+u}} uart} - -UART data \Hypertarget{unionciot__msg__data__u_acd0961872f365a2b54fef650ac190f50}\label{unionciot__msg__data__u_acd0961872f365a2b54fef650ac190f50} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!usb@{usb}} -\index{usb@{usb}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{usb}{usb}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__usb__data__u}{ciot\+\_\+usb\+\_\+data\+\_\+u}} usb} - -USB data \Hypertarget{unionciot__msg__data__u_ac06a3086376da2d8a84120762824336c}\label{unionciot__msg__data__u_ac06a3086376da2d8a84120762824336c} -\index{ciot\_msg\_data\_u@{ciot\_msg\_data\_u}!wifi@{wifi}} -\index{wifi@{wifi}!ciot\_msg\_data\_u@{ciot\_msg\_data\_u}} -\doxysubsubsection{\texorpdfstring{wifi}{wifi}} -{\footnotesize\ttfamily \mbox{\hyperlink{unionciot__wifi__data__u}{ciot\+\_\+wifi\+\_\+data\+\_\+u}} wifi} - -Wi\+Fi data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__msg__types_8h}{ciot\+\_\+msg\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__ntp__data__u.tex b/docs/latex/unionciot__ntp__data__u.tex deleted file mode 100644 index 595262f..0000000 --- a/docs/latex/unionciot__ntp__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+ntp\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ntp__data__u}{}\label{unionciot__ntp__data__u}\index{ciot\_ntp\_data\_u@{ciot\_ntp\_data\_u}} - - -Union for CIOT NTP data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ntp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__ntp__data__u_a6c17383e9465f668d1e9dcb3cf8d4f4a}{config}} -\item -\mbox{\hyperlink{structciot__ntp__status__t}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__ntp__data__u_a95d5fa474c00a79ee883e78048ea7c4c}{status}} -\item -\mbox{\hyperlink{structciot__ntp__req__t}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__ntp__data__u_a0a55111acf65b88d386268c615a69499}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT NTP data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__ntp__data__u_a6c17383e9465f668d1e9dcb3cf8d4f4a}\label{unionciot__ntp__data__u_a6c17383e9465f668d1e9dcb3cf8d4f4a} -\index{ciot\_ntp\_data\_u@{ciot\_ntp\_data\_u}!config@{config}} -\index{config@{config}!ciot\_ntp\_data\_u@{ciot\_ntp\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ntp__cfg__t}{ciot\+\_\+ntp\+\_\+cfg\+\_\+t}} config} - -NTP configuration \Hypertarget{unionciot__ntp__data__u_a0a55111acf65b88d386268c615a69499}\label{unionciot__ntp__data__u_a0a55111acf65b88d386268c615a69499} -\index{ciot\_ntp\_data\_u@{ciot\_ntp\_data\_u}!request@{request}} -\index{request@{request}!ciot\_ntp\_data\_u@{ciot\_ntp\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ntp__req__t}{ciot\+\_\+ntp\+\_\+req\+\_\+t}} request} - -NTP request \Hypertarget{unionciot__ntp__data__u_a95d5fa474c00a79ee883e78048ea7c4c}\label{unionciot__ntp__data__u_a95d5fa474c00a79ee883e78048ea7c4c} -\index{ciot\_ntp\_data\_u@{ciot\_ntp\_data\_u}!status@{status}} -\index{status@{status}!ciot\_ntp\_data\_u@{ciot\_ntp\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ntp__status__t}{ciot\+\_\+ntp\+\_\+status\+\_\+t}} status} - -NTP status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__ntp__req__data__u.tex b/docs/latex/unionciot__ntp__req__data__u.tex deleted file mode 100644 index 063001d..0000000 --- a/docs/latex/unionciot__ntp__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+ntp\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ntp__req__data__u}{}\label{unionciot__ntp__req__data__u}\index{ciot\_ntp\_req\_data\_u@{ciot\_ntp\_req\_data\_u}} - - -Union for CIOT NTP request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ntp\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT NTP request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ntp__types_8h}{ciot\+\_\+ntp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__opcuas__data__u.tex b/docs/latex/unionciot__opcuas__data__u.tex deleted file mode 100644 index beaef62..0000000 --- a/docs/latex/unionciot__opcuas__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__opcuas__data__u}{}\label{unionciot__opcuas__data__u}\index{ciot\_opcuas\_data\_u@{ciot\_opcuas\_data\_u}} - - -Union for CIOT OPC UA Server data. - - - - -{\ttfamily \#include $<$ciot\+\_\+opcuas\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__opcuas__data__u_aa976951e468c754fef849731243b0acb}{config}} -\item -\mbox{\hyperlink{structciot__opcuas__status__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__opcuas__data__u_ac3be6c0c62c2999a9dd9fa0099945876}{status}} -\item -\mbox{\hyperlink{structciot__opcuas__req__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__opcuas__data__u_a66e033d989ec031368788f08deba7feb}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT OPC UA Server data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__opcuas__data__u_aa976951e468c754fef849731243b0acb}\label{unionciot__opcuas__data__u_aa976951e468c754fef849731243b0acb} -\index{ciot\_opcuas\_data\_u@{ciot\_opcuas\_data\_u}!config@{config}} -\index{config@{config}!ciot\_opcuas\_data\_u@{ciot\_opcuas\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__opcuas__cfg__t}{ciot\+\_\+opcuas\+\_\+cfg\+\_\+t}} config} - -OPC UA Server configuration \Hypertarget{unionciot__opcuas__data__u_a66e033d989ec031368788f08deba7feb}\label{unionciot__opcuas__data__u_a66e033d989ec031368788f08deba7feb} -\index{ciot\_opcuas\_data\_u@{ciot\_opcuas\_data\_u}!request@{request}} -\index{request@{request}!ciot\_opcuas\_data\_u@{ciot\_opcuas\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__opcuas__req__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+t}} request} - -OPC UA Server request \Hypertarget{unionciot__opcuas__data__u_ac3be6c0c62c2999a9dd9fa0099945876}\label{unionciot__opcuas__data__u_ac3be6c0c62c2999a9dd9fa0099945876} -\index{ciot\_opcuas\_data\_u@{ciot\_opcuas\_data\_u}!status@{status}} -\index{status@{status}!ciot\_opcuas\_data\_u@{ciot\_opcuas\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__opcuas__status__t}{ciot\+\_\+opcuas\+\_\+status\+\_\+t}} status} - -OPC UA Server status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__opcuas__req__data__u.tex b/docs/latex/unionciot__opcuas__req__data__u.tex deleted file mode 100644 index fceca79..0000000 --- a/docs/latex/unionciot__opcuas__req__data__u.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+opcuas\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__opcuas__req__data__u}{}\label{unionciot__opcuas__req__data__u}\index{ciot\_opcuas\_req\_data\_u@{ciot\_opcuas\_req\_data\_u}} - - -Union for CIOT OPC UA Server request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+opcuas\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__opcuas__req__add__node__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+add\+\_\+node\+\_\+t}} \mbox{\hyperlink{unionciot__opcuas__req__data__u_a79aa371ccd92a505f5c26dcd8218a131}{add\+\_\+node}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT OPC UA Server request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__opcuas__req__data__u_a79aa371ccd92a505f5c26dcd8218a131}\label{unionciot__opcuas__req__data__u_a79aa371ccd92a505f5c26dcd8218a131} -\index{ciot\_opcuas\_req\_data\_u@{ciot\_opcuas\_req\_data\_u}!add\_node@{add\_node}} -\index{add\_node@{add\_node}!ciot\_opcuas\_req\_data\_u@{ciot\_opcuas\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{add\_node}{add\_node}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__opcuas__req__add__node__t}{ciot\+\_\+opcuas\+\_\+req\+\_\+add\+\_\+node\+\_\+t}} add\+\_\+node} - -Add node request data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__opcuas__types_8h}{ciot\+\_\+opcuas\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__ota__data__u.tex b/docs/latex/unionciot__ota__data__u.tex deleted file mode 100644 index d014e09..0000000 --- a/docs/latex/unionciot__ota__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+ota\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ota__data__u}{}\label{unionciot__ota__data__u}\index{ciot\_ota\_data\_u@{ciot\_ota\_data\_u}} - - -Union for CIOT OTA data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ota\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__ota__cfg__t}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__ota__data__u_a62fb934187d712f56dc1289eda8f8cac}{config}} -\item -\mbox{\hyperlink{structciot__ota__status__t}{ciot\+\_\+ota\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__ota__data__u_a86de670b32fc6ad5c7a44fefb41e6e3a}{status}} -\item -\mbox{\hyperlink{structciot__ota__req__t}{ciot\+\_\+ota\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__ota__data__u_a4e22c6ea4c9d8fad6bbd0d3894c82627}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT OTA data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__ota__data__u_a62fb934187d712f56dc1289eda8f8cac}\label{unionciot__ota__data__u_a62fb934187d712f56dc1289eda8f8cac} -\index{ciot\_ota\_data\_u@{ciot\_ota\_data\_u}!config@{config}} -\index{config@{config}!ciot\_ota\_data\_u@{ciot\_ota\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ota__cfg__t}{ciot\+\_\+ota\+\_\+cfg\+\_\+t}} config} - -OTA configuration \Hypertarget{unionciot__ota__data__u_a4e22c6ea4c9d8fad6bbd0d3894c82627}\label{unionciot__ota__data__u_a4e22c6ea4c9d8fad6bbd0d3894c82627} -\index{ciot\_ota\_data\_u@{ciot\_ota\_data\_u}!request@{request}} -\index{request@{request}!ciot\_ota\_data\_u@{ciot\_ota\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ota__req__t}{ciot\+\_\+ota\+\_\+req\+\_\+t}} request} - -OTA request \Hypertarget{unionciot__ota__data__u_a86de670b32fc6ad5c7a44fefb41e6e3a}\label{unionciot__ota__data__u_a86de670b32fc6ad5c7a44fefb41e6e3a} -\index{ciot\_ota\_data\_u@{ciot\_ota\_data\_u}!status@{status}} -\index{status@{status}!ciot\_ota\_data\_u@{ciot\_ota\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__ota__status__t}{ciot\+\_\+ota\+\_\+status\+\_\+t}} status} - -OTA status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__ota__req__data__u.tex b/docs/latex/unionciot__ota__req__data__u.tex deleted file mode 100644 index b7a7b48..0000000 --- a/docs/latex/unionciot__ota__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+ota\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__ota__req__data__u}{}\label{unionciot__ota__req__data__u}\index{ciot\_ota\_req\_data\_u@{ciot\_ota\_req\_data\_u}} - - -Union for CIOT OTA request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+ota\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT OTA request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__ota__types_8h}{ciot\+\_\+ota\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__req__data__u.tex b/docs/latex/unionciot__req__data__u.tex deleted file mode 100644 index 1385276..0000000 --- a/docs/latex/unionciot__req__data__u.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__req__data__u}{}\label{unionciot__req__data__u}\index{ciot\_req\_data\_u@{ciot\_req\_data\_u}} - - -Union for CIOT request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__req__save__iface__cfg__t}{ciot\+\_\+req\+\_\+save\+\_\+iface\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__req__data__u_af24d10404fe7693abc12d43b4edea249}{save\+\_\+iface\+\_\+cfg}} -\item -\mbox{\hyperlink{structciot__req__delete__iface__cfg__t}{ciot\+\_\+req\+\_\+delete\+\_\+iface\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__req__data__u_abaf229d7f984c35aa24c89632a544934}{delete\+\_\+iface\+\_\+cfg}} -\item -\mbox{\hyperlink{structciot__req__proxy__msg__t}{ciot\+\_\+req\+\_\+proxy\+\_\+msg\+\_\+t}} \mbox{\hyperlink{unionciot__req__data__u_a778eb3ed59eb3397b9efad8d48d34b62}{proxy\+\_\+msg}} -\item -\mbox{\hyperlink{structciot__req__result__t}{ciot\+\_\+req\+\_\+result\+\_\+t}} \mbox{\hyperlink{unionciot__req__data__u_a90808ce2b0f0710bbe9799c64e8df0db}{result}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__req__data__u_abaf229d7f984c35aa24c89632a544934}\label{unionciot__req__data__u_abaf229d7f984c35aa24c89632a544934} -\index{ciot\_req\_data\_u@{ciot\_req\_data\_u}!delete\_iface\_cfg@{delete\_iface\_cfg}} -\index{delete\_iface\_cfg@{delete\_iface\_cfg}!ciot\_req\_data\_u@{ciot\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{delete\_iface\_cfg}{delete\_iface\_cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__req__delete__iface__cfg__t}{ciot\+\_\+req\+\_\+delete\+\_\+iface\+\_\+cfg\+\_\+t}} delete\+\_\+iface\+\_\+cfg} - -Delete interface configuration request data \Hypertarget{unionciot__req__data__u_a778eb3ed59eb3397b9efad8d48d34b62}\label{unionciot__req__data__u_a778eb3ed59eb3397b9efad8d48d34b62} -\index{ciot\_req\_data\_u@{ciot\_req\_data\_u}!proxy\_msg@{proxy\_msg}} -\index{proxy\_msg@{proxy\_msg}!ciot\_req\_data\_u@{ciot\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{proxy\_msg}{proxy\_msg}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__req__proxy__msg__t}{ciot\+\_\+req\+\_\+proxy\+\_\+msg\+\_\+t}} proxy\+\_\+msg} - -Proxy message request data \Hypertarget{unionciot__req__data__u_a90808ce2b0f0710bbe9799c64e8df0db}\label{unionciot__req__data__u_a90808ce2b0f0710bbe9799c64e8df0db} -\index{ciot\_req\_data\_u@{ciot\_req\_data\_u}!result@{result}} -\index{result@{result}!ciot\_req\_data\_u@{ciot\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{result}{result}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__req__result__t}{ciot\+\_\+req\+\_\+result\+\_\+t}} result} - -Request result data \Hypertarget{unionciot__req__data__u_af24d10404fe7693abc12d43b4edea249}\label{unionciot__req__data__u_af24d10404fe7693abc12d43b4edea249} -\index{ciot\_req\_data\_u@{ciot\_req\_data\_u}!save\_iface\_cfg@{save\_iface\_cfg}} -\index{save\_iface\_cfg@{save\_iface\_cfg}!ciot\_req\_data\_u@{ciot\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{save\_iface\_cfg}{save\_iface\_cfg}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__req__save__iface__cfg__t}{ciot\+\_\+req\+\_\+save\+\_\+iface\+\_\+cfg\+\_\+t}} save\+\_\+iface\+\_\+cfg} - -Save interface configuration request data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__types_8h}{ciot\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__storage__data__u.tex b/docs/latex/unionciot__storage__data__u.tex deleted file mode 100644 index 910176c..0000000 --- a/docs/latex/unionciot__storage__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+storage\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__storage__data__u}{}\label{unionciot__storage__data__u}\index{ciot\_storage\_data\_u@{ciot\_storage\_data\_u}} - - -Union for CIOT storage data. - - - - -{\ttfamily \#include $<$ciot\+\_\+storage\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__storage__cfg__t}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__storage__data__u_aabe6a902449529e66a1bb460116af784}{config}} -\item -\mbox{\hyperlink{structciot__storage__status__t}{ciot\+\_\+storage\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__storage__data__u_ac1a66aa256f203858bb2477b812e36fb}{status}} -\item -\mbox{\hyperlink{structciot__storage__req__t}{ciot\+\_\+storage\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__storage__data__u_ae35bc5d21998e1401aa886359cafd044}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT storage data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__storage__data__u_aabe6a902449529e66a1bb460116af784}\label{unionciot__storage__data__u_aabe6a902449529e66a1bb460116af784} -\index{ciot\_storage\_data\_u@{ciot\_storage\_data\_u}!config@{config}} -\index{config@{config}!ciot\_storage\_data\_u@{ciot\_storage\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__storage__cfg__t}{ciot\+\_\+storage\+\_\+cfg\+\_\+t}} config} - -Storage configuration \Hypertarget{unionciot__storage__data__u_ae35bc5d21998e1401aa886359cafd044}\label{unionciot__storage__data__u_ae35bc5d21998e1401aa886359cafd044} -\index{ciot\_storage\_data\_u@{ciot\_storage\_data\_u}!request@{request}} -\index{request@{request}!ciot\_storage\_data\_u@{ciot\_storage\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__storage__req__t}{ciot\+\_\+storage\+\_\+req\+\_\+t}} request} - -Storage request \Hypertarget{unionciot__storage__data__u_ac1a66aa256f203858bb2477b812e36fb}\label{unionciot__storage__data__u_ac1a66aa256f203858bb2477b812e36fb} -\index{ciot\_storage\_data\_u@{ciot\_storage\_data\_u}!status@{status}} -\index{status@{status}!ciot\_storage\_data\_u@{ciot\_storage\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__storage__status__t}{ciot\+\_\+storage\+\_\+status\+\_\+t}} status} - -Storage status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__storage__types_8h}{ciot\+\_\+storage\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__sys__data__u.tex b/docs/latex/unionciot__sys__data__u.tex deleted file mode 100644 index 0a76a64..0000000 --- a/docs/latex/unionciot__sys__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__sys__data__u}{}\label{unionciot__sys__data__u}\index{ciot\_sys\_data\_u@{ciot\_sys\_data\_u}} - - -Union for CIOT system data. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__sys__cfg__t}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__sys__data__u_a9d2eb5a0a1a2ed5d529672a8229a8fe8}{config}} -\item -\mbox{\hyperlink{structciot__sys__status__t}{ciot\+\_\+sys\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__sys__data__u_ad3dbfc73fddab4d58bde12f27edab41b}{status}} -\item -\mbox{\hyperlink{structciot__sys__req__t}{ciot\+\_\+sys\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__sys__data__u_a7146ff86f43fac1f87c45f31c3a3bd20}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT system data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__sys__data__u_a9d2eb5a0a1a2ed5d529672a8229a8fe8}\label{unionciot__sys__data__u_a9d2eb5a0a1a2ed5d529672a8229a8fe8} -\index{ciot\_sys\_data\_u@{ciot\_sys\_data\_u}!config@{config}} -\index{config@{config}!ciot\_sys\_data\_u@{ciot\_sys\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__cfg__t}{ciot\+\_\+sys\+\_\+cfg\+\_\+t}} config} - -System configuration \Hypertarget{unionciot__sys__data__u_a7146ff86f43fac1f87c45f31c3a3bd20}\label{unionciot__sys__data__u_a7146ff86f43fac1f87c45f31c3a3bd20} -\index{ciot\_sys\_data\_u@{ciot\_sys\_data\_u}!request@{request}} -\index{request@{request}!ciot\_sys\_data\_u@{ciot\_sys\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__req__t}{ciot\+\_\+sys\+\_\+req\+\_\+t}} request} - -System request \Hypertarget{unionciot__sys__data__u_ad3dbfc73fddab4d58bde12f27edab41b}\label{unionciot__sys__data__u_ad3dbfc73fddab4d58bde12f27edab41b} -\index{ciot\_sys\_data\_u@{ciot\_sys\_data\_u}!status@{status}} -\index{status@{status}!ciot\_sys\_data\_u@{ciot\_sys\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__sys__status__t}{ciot\+\_\+sys\+\_\+status\+\_\+t}} status} - -System status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__sys__req__data__u.tex b/docs/latex/unionciot__sys__req__data__u.tex deleted file mode 100644 index 9548939..0000000 --- a/docs/latex/unionciot__sys__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+sys\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__sys__req__data__u}{}\label{unionciot__sys__req__data__u}\index{ciot\_sys\_req\_data\_u@{ciot\_sys\_req\_data\_u}} - - -Union for CIOT system request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+sys\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT system request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__sys__types_8h}{ciot\+\_\+sys\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__tcp__data__u.tex b/docs/latex/unionciot__tcp__data__u.tex deleted file mode 100644 index 99872a6..0000000 --- a/docs/latex/unionciot__tcp__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__tcp__data__u}{}\label{unionciot__tcp__data__u}\index{ciot\_tcp\_data\_u@{ciot\_tcp\_data\_u}} - - -Union for CIOT TCP data. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__tcp__data__u_a71821427aa3817c68209a151bed81e56}{config}} -\item -\mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__tcp__data__u_a290455b77155aab0d086fb8c69f76364}{status}} -\item -\mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__tcp__data__u_aaf3b24e7b5d38ca3f76ca38e5e43ad7e}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT TCP data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__tcp__data__u_a71821427aa3817c68209a151bed81e56}\label{unionciot__tcp__data__u_a71821427aa3817c68209a151bed81e56} -\index{ciot\_tcp\_data\_u@{ciot\_tcp\_data\_u}!config@{config}} -\index{config@{config}!ciot\_tcp\_data\_u@{ciot\_tcp\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__cfg__t}{ciot\+\_\+tcp\+\_\+cfg\+\_\+t}} config} - -TCP configuration \Hypertarget{unionciot__tcp__data__u_aaf3b24e7b5d38ca3f76ca38e5e43ad7e}\label{unionciot__tcp__data__u_aaf3b24e7b5d38ca3f76ca38e5e43ad7e} -\index{ciot\_tcp\_data\_u@{ciot\_tcp\_data\_u}!request@{request}} -\index{request@{request}!ciot\_tcp\_data\_u@{ciot\_tcp\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__req__t}{ciot\+\_\+tcp\+\_\+req\+\_\+t}} request} - -TCP request \Hypertarget{unionciot__tcp__data__u_a290455b77155aab0d086fb8c69f76364}\label{unionciot__tcp__data__u_a290455b77155aab0d086fb8c69f76364} -\index{ciot\_tcp\_data\_u@{ciot\_tcp\_data\_u}!status@{status}} -\index{status@{status}!ciot\_tcp\_data\_u@{ciot\_tcp\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__tcp__status__t}{ciot\+\_\+tcp\+\_\+status\+\_\+t}} status} - -TCP status - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__tcp__req__data__u.tex b/docs/latex/unionciot__tcp__req__data__u.tex deleted file mode 100644 index 55c6636..0000000 --- a/docs/latex/unionciot__tcp__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+tcp\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__tcp__req__data__u}{}\label{unionciot__tcp__req__data__u}\index{ciot\_tcp\_req\_data\_u@{ciot\_tcp\_req\_data\_u}} - - -Union for CIOT TCP request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+tcp\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT TCP request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__tcp__types_8h}{ciot\+\_\+tcp\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__uart__data__u.tex b/docs/latex/unionciot__uart__data__u.tex deleted file mode 100644 index 7d61754..0000000 --- a/docs/latex/unionciot__uart__data__u.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__uart__data__u}{}\label{unionciot__uart__data__u}\index{ciot\_uart\_data\_u@{ciot\_uart\_data\_u}} - - -Union for CIOT UART data. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__uart__data__u_a107556abf8506af23fc4f92aa4d20cea}{config}} -\item -\mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__uart__data__u_aa311cb42bbd477c3bfd5371dd0b8bedd}{status}} -\item -\mbox{\hyperlink{structciot__uart__req__t}{ciot\+\_\+uart\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__uart__data__u_aeac55f9a4429aa466599b8875763ff38}{request}} -\item -\mbox{\hyperlink{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}{ciot\+\_\+uart\+\_\+event\+\_\+u}} \mbox{\hyperlink{unionciot__uart__data__u_af5207c84edf0697170da962f465640a0}{event}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT UART data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__uart__data__u_a107556abf8506af23fc4f92aa4d20cea}\label{unionciot__uart__data__u_a107556abf8506af23fc4f92aa4d20cea} -\index{ciot\_uart\_data\_u@{ciot\_uart\_data\_u}!config@{config}} -\index{config@{config}!ciot\_uart\_data\_u@{ciot\_uart\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__uart__cfg__t}{ciot\+\_\+uart\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{unionciot__uart__data__u_af5207c84edf0697170da962f465640a0}\label{unionciot__uart__data__u_af5207c84edf0697170da962f465640a0} -\index{ciot\_uart\_data\_u@{ciot\_uart\_data\_u}!event@{event}} -\index{event@{event}!ciot\_uart\_data\_u@{ciot\_uart\_data\_u}} -\doxysubsubsection{\texorpdfstring{event}{event}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__uart__types_8h_a1c20b2ee6a468d46d74b5868e93a3aca}{ciot\+\_\+uart\+\_\+event\+\_\+u}} event} - -Event data \Hypertarget{unionciot__uart__data__u_aeac55f9a4429aa466599b8875763ff38}\label{unionciot__uart__data__u_aeac55f9a4429aa466599b8875763ff38} -\index{ciot\_uart\_data\_u@{ciot\_uart\_data\_u}!request@{request}} -\index{request@{request}!ciot\_uart\_data\_u@{ciot\_uart\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__uart__req__t}{ciot\+\_\+uart\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{unionciot__uart__data__u_aa311cb42bbd477c3bfd5371dd0b8bedd}\label{unionciot__uart__data__u_aa311cb42bbd477c3bfd5371dd0b8bedd} -\index{ciot\_uart\_data\_u@{ciot\_uart\_data\_u}!status@{status}} -\index{status@{status}!ciot\_uart\_data\_u@{ciot\_uart\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__uart__status__t}{ciot\+\_\+uart\+\_\+status\+\_\+t}} status} - -Status data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__uart__event.tex b/docs/latex/unionciot__uart__event.tex deleted file mode 100644 index 367a00b..0000000 --- a/docs/latex/unionciot__uart__event.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+event Union Reference} -\hypertarget{unionciot__uart__event}{}\label{unionciot__uart__event}\index{ciot\_uart\_event@{ciot\_uart\_event}} - - -Union for CIOT UART event. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{unionciot__uart__event_a998bffd5567753ef3f6b652a400de36b}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT UART event. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__uart__event_a998bffd5567753ef3f6b652a400de36b}\label{unionciot__uart__event_a998bffd5567753ef3f6b652a400de36b} -\index{ciot\_uart\_event@{ciot\_uart\_event}!data@{data}} -\index{data@{data}!ciot\_uart\_event@{ciot\_uart\_event}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} data} - -Event data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__uart__req__data__u.tex b/docs/latex/unionciot__uart__req__data__u.tex deleted file mode 100644 index 42dfca2..0000000 --- a/docs/latex/unionciot__uart__req__data__u.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+uart\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__uart__req__data__u}{}\label{unionciot__uart__req__data__u}\index{ciot\_uart\_req\_data\_u@{ciot\_uart\_req\_data\_u}} - - -Union for CIOT UART request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+uart\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__uart__req__send__data__t}{ciot\+\_\+uart\+\_\+req\+\_\+send\+\_\+data\+\_\+t}} \mbox{\hyperlink{unionciot__uart__req__data__u_a64001c4b28083877216a64df74dff823}{send\+\_\+data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT UART request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__uart__req__data__u_a64001c4b28083877216a64df74dff823}\label{unionciot__uart__req__data__u_a64001c4b28083877216a64df74dff823} -\index{ciot\_uart\_req\_data\_u@{ciot\_uart\_req\_data\_u}!send\_data@{send\_data}} -\index{send\_data@{send\_data}!ciot\_uart\_req\_data\_u@{ciot\_uart\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{send\_data}{send\_data}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__uart__req__send__data__t}{ciot\+\_\+uart\+\_\+req\+\_\+send\+\_\+data\+\_\+t}} send\+\_\+data} - -Send data request data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__uart__types_8h}{ciot\+\_\+uart\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__usb__data__u.tex b/docs/latex/unionciot__usb__data__u.tex deleted file mode 100644 index 9fad7cd..0000000 --- a/docs/latex/unionciot__usb__data__u.tex +++ /dev/null @@ -1,57 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__usb__data__u}{}\label{unionciot__usb__data__u}\index{ciot\_usb\_data\_u@{ciot\_usb\_data\_u}} - - -Union for CIOT USB data. - - - - -{\ttfamily \#include $<$ciot\+\_\+usb\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__usb__cfg__t}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__usb__data__u_a5a3eefbe6f21d662a5e318bbf323a00e}{config}} -\item -\mbox{\hyperlink{structciot__usb__status__t}{ciot\+\_\+usb\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__usb__data__u_ab26791741e383cec2107fa1540a14342}{status}} -\item -\mbox{\hyperlink{structciot__usb__req__t}{ciot\+\_\+usb\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__usb__data__u_aebb2adef59fcdc91db3d185996066c6a}{request}} -\item -\mbox{\hyperlink{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}{ciot\+\_\+usb\+\_\+event\+\_\+u}} \mbox{\hyperlink{unionciot__usb__data__u_abe630baacf2cedc1090a81ef4e39a081}{event}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT USB data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__usb__data__u_a5a3eefbe6f21d662a5e318bbf323a00e}\label{unionciot__usb__data__u_a5a3eefbe6f21d662a5e318bbf323a00e} -\index{ciot\_usb\_data\_u@{ciot\_usb\_data\_u}!config@{config}} -\index{config@{config}!ciot\_usb\_data\_u@{ciot\_usb\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__usb__cfg__t}{ciot\+\_\+usb\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{unionciot__usb__data__u_abe630baacf2cedc1090a81ef4e39a081}\label{unionciot__usb__data__u_abe630baacf2cedc1090a81ef4e39a081} -\index{ciot\_usb\_data\_u@{ciot\_usb\_data\_u}!event@{event}} -\index{event@{event}!ciot\_usb\_data\_u@{ciot\_usb\_data\_u}} -\doxysubsubsection{\texorpdfstring{event}{event}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__usb__types_8h_a666a674ab97cf1c7bdf8ca4e6ec67948}{ciot\+\_\+usb\+\_\+event\+\_\+u}} event} - -Event data \Hypertarget{unionciot__usb__data__u_aebb2adef59fcdc91db3d185996066c6a}\label{unionciot__usb__data__u_aebb2adef59fcdc91db3d185996066c6a} -\index{ciot\_usb\_data\_u@{ciot\_usb\_data\_u}!request@{request}} -\index{request@{request}!ciot\_usb\_data\_u@{ciot\_usb\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__usb__req__t}{ciot\+\_\+usb\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{unionciot__usb__data__u_ab26791741e383cec2107fa1540a14342}\label{unionciot__usb__data__u_ab26791741e383cec2107fa1540a14342} -\index{ciot\_usb\_data\_u@{ciot\_usb\_data\_u}!status@{status}} -\index{status@{status}!ciot\_usb\_data\_u@{ciot\_usb\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__usb__status__t}{ciot\+\_\+usb\+\_\+status\+\_\+t}} status} - -Status data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__usb__event.tex b/docs/latex/unionciot__usb__event.tex deleted file mode 100644 index aa58259..0000000 --- a/docs/latex/unionciot__usb__event.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+event Union Reference} -\hypertarget{unionciot__usb__event}{}\label{unionciot__usb__event}\index{ciot\_usb\_event@{ciot\_usb\_event}} - - -Union for CIOT USB event. - - - - -{\ttfamily \#include $<$ciot\+\_\+usb\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} \mbox{\hyperlink{unionciot__usb__event_a998bffd5567753ef3f6b652a400de36b}{data}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT USB event. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__usb__event_a998bffd5567753ef3f6b652a400de36b}\label{unionciot__usb__event_a998bffd5567753ef3f6b652a400de36b} -\index{ciot\_usb\_event@{ciot\_usb\_event}!data@{data}} -\index{data@{data}!ciot\_usb\_event@{ciot\_usb\_event}} -\doxysubsubsection{\texorpdfstring{data}{data}} -{\footnotesize\ttfamily \mbox{\hyperlink{ciot__common__types_8h_aacdc43deb8af6baf83220c9c6a29c32e}{ciot\+\_\+event\+\_\+data\+\_\+t}} data} - -Event data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__usb__req__data__u.tex b/docs/latex/unionciot__usb__req__data__u.tex deleted file mode 100644 index 9f49c05..0000000 --- a/docs/latex/unionciot__usb__req__data__u.tex +++ /dev/null @@ -1,19 +0,0 @@ -\doxysection{ciot\+\_\+usb\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__usb__req__data__u}{}\label{unionciot__usb__req__data__u}\index{ciot\_usb\_req\_data\_u@{ciot\_usb\_req\_data\_u}} - - -Union for CIOT USB request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+usb\+\_\+types.\+h$>$} - - - -\doxysubsection{Detailed Description} -Union for CIOT USB request data. - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__usb__types_8h}{ciot\+\_\+usb\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__wifi__data__u.tex b/docs/latex/unionciot__wifi__data__u.tex deleted file mode 100644 index d673ff2..0000000 --- a/docs/latex/unionciot__wifi__data__u.tex +++ /dev/null @@ -1,49 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__wifi__data__u}{}\label{unionciot__wifi__data__u}\index{ciot\_wifi\_data\_u@{ciot\_wifi\_data\_u}} - - -Union for CIOT Wi\+Fi data. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} \mbox{\hyperlink{unionciot__wifi__data__u_a711c5a971ab69b9cfa4850692e6bbaad}{config}} -\item -\mbox{\hyperlink{structciot__wifi__status__t}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} \mbox{\hyperlink{unionciot__wifi__data__u_a09cb5a4aa60e39d810f1c21089103503}{status}} -\item -\mbox{\hyperlink{structciot__wifi__req__t}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} \mbox{\hyperlink{unionciot__wifi__data__u_a95d1196af9ebc0b64f6f7e2842812448}{request}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT Wi\+Fi data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__wifi__data__u_a711c5a971ab69b9cfa4850692e6bbaad}\label{unionciot__wifi__data__u_a711c5a971ab69b9cfa4850692e6bbaad} -\index{ciot\_wifi\_data\_u@{ciot\_wifi\_data\_u}!config@{config}} -\index{config@{config}!ciot\_wifi\_data\_u@{ciot\_wifi\_data\_u}} -\doxysubsubsection{\texorpdfstring{config}{config}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__wifi__cfg__t}{ciot\+\_\+wifi\+\_\+cfg\+\_\+t}} config} - -Configuration data \Hypertarget{unionciot__wifi__data__u_a95d1196af9ebc0b64f6f7e2842812448}\label{unionciot__wifi__data__u_a95d1196af9ebc0b64f6f7e2842812448} -\index{ciot\_wifi\_data\_u@{ciot\_wifi\_data\_u}!request@{request}} -\index{request@{request}!ciot\_wifi\_data\_u@{ciot\_wifi\_data\_u}} -\doxysubsubsection{\texorpdfstring{request}{request}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__wifi__req__t}{ciot\+\_\+wifi\+\_\+req\+\_\+t}} request} - -Request data \Hypertarget{unionciot__wifi__data__u_a09cb5a4aa60e39d810f1c21089103503}\label{unionciot__wifi__data__u_a09cb5a4aa60e39d810f1c21089103503} -\index{ciot\_wifi\_data\_u@{ciot\_wifi\_data\_u}!status@{status}} -\index{status@{status}!ciot\_wifi\_data\_u@{ciot\_wifi\_data\_u}} -\doxysubsubsection{\texorpdfstring{status}{status}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__wifi__status__t}{ciot\+\_\+wifi\+\_\+status\+\_\+t}} status} - -Status data - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/latex/unionciot__wifi__req__data__u.tex b/docs/latex/unionciot__wifi__req__data__u.tex deleted file mode 100644 index b09cbbc..0000000 --- a/docs/latex/unionciot__wifi__req__data__u.tex +++ /dev/null @@ -1,33 +0,0 @@ -\doxysection{ciot\+\_\+wifi\+\_\+req\+\_\+data\+\_\+u Union Reference} -\hypertarget{unionciot__wifi__req__data__u}{}\label{unionciot__wifi__req__data__u}\index{ciot\_wifi\_req\_data\_u@{ciot\_wifi\_req\_data\_u}} - - -Union for CIOT Wi\+Fi request data. - - - - -{\ttfamily \#include $<$ciot\+\_\+wifi\+\_\+types.\+h$>$} - -\doxysubsubsection*{Data Fields} -\begin{DoxyCompactItemize} -\item -\mbox{\hyperlink{structciot__wifi__scan__result__t}{ciot\+\_\+wifi\+\_\+scan\+\_\+result\+\_\+t}} \mbox{\hyperlink{unionciot__wifi__req__data__u_a23723a81650d6544d7da572eb4bf33b9}{scan\+\_\+result}} -\end{DoxyCompactItemize} - - -\doxysubsection{Detailed Description} -Union for CIOT Wi\+Fi request data. - -\doxysubsection{Field Documentation} -\Hypertarget{unionciot__wifi__req__data__u_a23723a81650d6544d7da572eb4bf33b9}\label{unionciot__wifi__req__data__u_a23723a81650d6544d7da572eb4bf33b9} -\index{ciot\_wifi\_req\_data\_u@{ciot\_wifi\_req\_data\_u}!scan\_result@{scan\_result}} -\index{scan\_result@{scan\_result}!ciot\_wifi\_req\_data\_u@{ciot\_wifi\_req\_data\_u}} -\doxysubsubsection{\texorpdfstring{scan\_result}{scan\_result}} -{\footnotesize\ttfamily \mbox{\hyperlink{structciot__wifi__scan__result__t}{ciot\+\_\+wifi\+\_\+scan\+\_\+result\+\_\+t}} scan\+\_\+result} - -Wi\+Fi scan result - -The documentation for this union was generated from the following file\+:\begin{DoxyCompactItemize} -\item -include/types/\mbox{\hyperlink{ciot__wifi__types_8h}{ciot\+\_\+wifi\+\_\+types.\+h}}\end{DoxyCompactItemize} diff --git a/docs/html/menu.js b/docs/menu.js similarity index 100% rename from docs/html/menu.js rename to docs/menu.js diff --git a/docs/html/menudata.js b/docs/menudata.js similarity index 100% rename from docs/html/menudata.js rename to docs/menudata.js diff --git a/docs/html/minus.svg b/docs/minus.svg similarity index 100% rename from docs/html/minus.svg rename to docs/minus.svg diff --git a/docs/html/minusd.svg b/docs/minusd.svg similarity index 100% rename from docs/html/minusd.svg rename to docs/minusd.svg diff --git a/docs/html/nav_f.png b/docs/nav_f.png similarity index 100% rename from docs/html/nav_f.png rename to docs/nav_f.png diff --git a/docs/html/nav_fd.png b/docs/nav_fd.png similarity index 100% rename from docs/html/nav_fd.png rename to docs/nav_fd.png diff --git a/docs/html/nav_g.png b/docs/nav_g.png similarity index 100% rename from docs/html/nav_g.png rename to docs/nav_g.png diff --git a/docs/html/nav_h.png b/docs/nav_h.png similarity index 100% rename from docs/html/nav_h.png rename to docs/nav_h.png diff --git a/docs/html/nav_hd.png b/docs/nav_hd.png similarity index 100% rename from docs/html/nav_hd.png rename to docs/nav_hd.png diff --git a/docs/html/navtree.css b/docs/navtree.css similarity index 100% rename from docs/html/navtree.css rename to docs/navtree.css diff --git a/docs/html/navtree.js b/docs/navtree.js similarity index 100% rename from docs/html/navtree.js rename to docs/navtree.js diff --git a/docs/html/navtreedata.js b/docs/navtreedata.js similarity index 100% rename from docs/html/navtreedata.js rename to docs/navtreedata.js diff --git a/docs/html/navtreeindex0.js b/docs/navtreeindex0.js similarity index 100% rename from docs/html/navtreeindex0.js rename to docs/navtreeindex0.js diff --git a/docs/html/navtreeindex1.js b/docs/navtreeindex1.js similarity index 100% rename from docs/html/navtreeindex1.js rename to docs/navtreeindex1.js diff --git a/docs/html/navtreeindex2.js b/docs/navtreeindex2.js similarity index 100% rename from docs/html/navtreeindex2.js rename to docs/navtreeindex2.js diff --git a/docs/html/navtreeindex3.js b/docs/navtreeindex3.js similarity index 100% rename from docs/html/navtreeindex3.js rename to docs/navtreeindex3.js diff --git a/docs/html/navtreeindex4.js b/docs/navtreeindex4.js similarity index 100% rename from docs/html/navtreeindex4.js rename to docs/navtreeindex4.js diff --git a/docs/html/open.png b/docs/open.png similarity index 100% rename from docs/html/open.png rename to docs/open.png diff --git a/docs/html/plus.svg b/docs/plus.svg similarity index 100% rename from docs/html/plus.svg rename to docs/plus.svg diff --git a/docs/html/plusd.svg b/docs/plusd.svg similarity index 100% rename from docs/html/plusd.svg rename to docs/plusd.svg diff --git a/docs/html/resize.js b/docs/resize.js similarity index 100% rename from docs/html/resize.js rename to docs/resize.js diff --git a/docs/html/search/all_0.js b/docs/search/all_0.js similarity index 100% rename from docs/html/search/all_0.js rename to docs/search/all_0.js diff --git a/docs/html/search/all_1.js b/docs/search/all_1.js similarity index 100% rename from docs/html/search/all_1.js rename to docs/search/all_1.js diff --git a/docs/html/search/all_10.js b/docs/search/all_10.js similarity index 100% rename from docs/html/search/all_10.js rename to docs/search/all_10.js diff --git a/docs/html/search/all_11.js b/docs/search/all_11.js similarity index 100% rename from docs/html/search/all_11.js rename to docs/search/all_11.js diff --git a/docs/html/search/all_12.js b/docs/search/all_12.js similarity index 100% rename from docs/html/search/all_12.js rename to docs/search/all_12.js diff --git a/docs/html/search/all_13.js b/docs/search/all_13.js similarity index 100% rename from docs/html/search/all_13.js rename to docs/search/all_13.js diff --git a/docs/html/search/all_14.js b/docs/search/all_14.js similarity index 100% rename from docs/html/search/all_14.js rename to docs/search/all_14.js diff --git a/docs/html/search/all_2.js b/docs/search/all_2.js similarity index 100% rename from docs/html/search/all_2.js rename to docs/search/all_2.js diff --git a/docs/html/search/all_3.js b/docs/search/all_3.js similarity index 100% rename from docs/html/search/all_3.js rename to docs/search/all_3.js diff --git a/docs/html/search/all_4.js b/docs/search/all_4.js similarity index 100% rename from docs/html/search/all_4.js rename to docs/search/all_4.js diff --git a/docs/html/search/all_5.js b/docs/search/all_5.js similarity index 100% rename from docs/html/search/all_5.js rename to docs/search/all_5.js diff --git a/docs/html/search/all_6.js b/docs/search/all_6.js similarity index 100% rename from docs/html/search/all_6.js rename to docs/search/all_6.js diff --git a/docs/html/search/all_7.js b/docs/search/all_7.js similarity index 100% rename from docs/html/search/all_7.js rename to docs/search/all_7.js diff --git a/docs/html/search/all_8.js b/docs/search/all_8.js similarity index 100% rename from docs/html/search/all_8.js rename to docs/search/all_8.js diff --git a/docs/html/search/all_9.js b/docs/search/all_9.js similarity index 100% rename from docs/html/search/all_9.js rename to docs/search/all_9.js diff --git a/docs/html/search/all_a.js b/docs/search/all_a.js similarity index 100% rename from docs/html/search/all_a.js rename to docs/search/all_a.js diff --git a/docs/html/search/all_b.js b/docs/search/all_b.js similarity index 100% rename from docs/html/search/all_b.js rename to docs/search/all_b.js diff --git a/docs/html/search/all_c.js b/docs/search/all_c.js similarity index 100% rename from docs/html/search/all_c.js rename to docs/search/all_c.js diff --git a/docs/html/search/all_d.js b/docs/search/all_d.js similarity index 100% rename from docs/html/search/all_d.js rename to docs/search/all_d.js diff --git a/docs/html/search/all_e.js b/docs/search/all_e.js similarity index 100% rename from docs/html/search/all_e.js rename to docs/search/all_e.js diff --git a/docs/html/search/all_f.js b/docs/search/all_f.js similarity index 100% rename from docs/html/search/all_f.js rename to docs/search/all_f.js diff --git a/docs/html/search/classes_0.js b/docs/search/classes_0.js similarity index 100% rename from docs/html/search/classes_0.js rename to docs/search/classes_0.js diff --git a/docs/html/search/close.svg b/docs/search/close.svg similarity index 100% rename from docs/html/search/close.svg rename to docs/search/close.svg diff --git a/docs/html/search/defines_0.js b/docs/search/defines_0.js similarity index 100% rename from docs/html/search/defines_0.js rename to docs/search/defines_0.js diff --git a/docs/html/search/defines_1.js b/docs/search/defines_1.js similarity index 100% rename from docs/html/search/defines_1.js rename to docs/search/defines_1.js diff --git a/docs/html/search/enums_0.js b/docs/search/enums_0.js similarity index 100% rename from docs/html/search/enums_0.js rename to docs/search/enums_0.js diff --git a/docs/html/search/enumvalues_0.js b/docs/search/enumvalues_0.js similarity index 100% rename from docs/html/search/enumvalues_0.js rename to docs/search/enumvalues_0.js diff --git a/docs/html/search/enumvalues_1.js b/docs/search/enumvalues_1.js similarity index 100% rename from docs/html/search/enumvalues_1.js rename to docs/search/enumvalues_1.js diff --git a/docs/html/search/enumvalues_2.js b/docs/search/enumvalues_2.js similarity index 100% rename from docs/html/search/enumvalues_2.js rename to docs/search/enumvalues_2.js diff --git a/docs/html/search/files_0.js b/docs/search/files_0.js similarity index 100% rename from docs/html/search/files_0.js rename to docs/search/files_0.js diff --git a/docs/html/search/functions_0.js b/docs/search/functions_0.js similarity index 100% rename from docs/html/search/functions_0.js rename to docs/search/functions_0.js diff --git a/docs/html/search/functions_1.js b/docs/search/functions_1.js similarity index 100% rename from docs/html/search/functions_1.js rename to docs/search/functions_1.js diff --git a/docs/html/search/groups_0.js b/docs/search/groups_0.js similarity index 100% rename from docs/html/search/groups_0.js rename to docs/search/groups_0.js diff --git a/docs/html/search/groups_1.js b/docs/search/groups_1.js similarity index 100% rename from docs/html/search/groups_1.js rename to docs/search/groups_1.js diff --git a/docs/html/search/mag.svg b/docs/search/mag.svg similarity index 100% rename from docs/html/search/mag.svg rename to docs/search/mag.svg diff --git a/docs/html/search/mag_d.svg b/docs/search/mag_d.svg similarity index 100% rename from docs/html/search/mag_d.svg rename to docs/search/mag_d.svg diff --git a/docs/html/search/mag_sel.svg b/docs/search/mag_sel.svg similarity index 100% rename from docs/html/search/mag_sel.svg rename to docs/search/mag_sel.svg diff --git a/docs/html/search/mag_seld.svg b/docs/search/mag_seld.svg similarity index 100% rename from docs/html/search/mag_seld.svg rename to docs/search/mag_seld.svg diff --git a/docs/html/search/search.css b/docs/search/search.css similarity index 100% rename from docs/html/search/search.css rename to docs/search/search.css diff --git a/docs/html/search/search.js b/docs/search/search.js similarity index 100% rename from docs/html/search/search.js rename to docs/search/search.js diff --git a/docs/html/search/searchdata.js b/docs/search/searchdata.js similarity index 100% rename from docs/html/search/searchdata.js rename to docs/search/searchdata.js diff --git a/docs/html/search/typedefs_0.js b/docs/search/typedefs_0.js similarity index 100% rename from docs/html/search/typedefs_0.js rename to docs/search/typedefs_0.js diff --git a/docs/html/search/variables_0.js b/docs/search/variables_0.js similarity index 100% rename from docs/html/search/variables_0.js rename to docs/search/variables_0.js diff --git a/docs/html/search/variables_1.js b/docs/search/variables_1.js similarity index 100% rename from docs/html/search/variables_1.js rename to docs/search/variables_1.js diff --git a/docs/html/search/variables_10.js b/docs/search/variables_10.js similarity index 100% rename from docs/html/search/variables_10.js rename to docs/search/variables_10.js diff --git a/docs/html/search/variables_11.js b/docs/search/variables_11.js similarity index 100% rename from docs/html/search/variables_11.js rename to docs/search/variables_11.js diff --git a/docs/html/search/variables_12.js b/docs/search/variables_12.js similarity index 100% rename from docs/html/search/variables_12.js rename to docs/search/variables_12.js diff --git a/docs/html/search/variables_13.js b/docs/search/variables_13.js similarity index 100% rename from docs/html/search/variables_13.js rename to docs/search/variables_13.js diff --git a/docs/html/search/variables_14.js b/docs/search/variables_14.js similarity index 100% rename from docs/html/search/variables_14.js rename to docs/search/variables_14.js diff --git a/docs/html/search/variables_2.js b/docs/search/variables_2.js similarity index 100% rename from docs/html/search/variables_2.js rename to docs/search/variables_2.js diff --git a/docs/html/search/variables_3.js b/docs/search/variables_3.js similarity index 100% rename from docs/html/search/variables_3.js rename to docs/search/variables_3.js diff --git a/docs/html/search/variables_4.js b/docs/search/variables_4.js similarity index 100% rename from docs/html/search/variables_4.js rename to docs/search/variables_4.js diff --git a/docs/html/search/variables_5.js b/docs/search/variables_5.js similarity index 100% rename from docs/html/search/variables_5.js rename to docs/search/variables_5.js diff --git a/docs/html/search/variables_6.js b/docs/search/variables_6.js similarity index 100% rename from docs/html/search/variables_6.js rename to docs/search/variables_6.js diff --git a/docs/html/search/variables_7.js b/docs/search/variables_7.js similarity index 100% rename from docs/html/search/variables_7.js rename to docs/search/variables_7.js diff --git a/docs/html/search/variables_8.js b/docs/search/variables_8.js similarity index 100% rename from docs/html/search/variables_8.js rename to docs/search/variables_8.js diff --git a/docs/html/search/variables_9.js b/docs/search/variables_9.js similarity index 100% rename from docs/html/search/variables_9.js rename to docs/search/variables_9.js diff --git a/docs/html/search/variables_a.js b/docs/search/variables_a.js similarity index 100% rename from docs/html/search/variables_a.js rename to docs/search/variables_a.js diff --git a/docs/html/search/variables_b.js b/docs/search/variables_b.js similarity index 100% rename from docs/html/search/variables_b.js rename to docs/search/variables_b.js diff --git a/docs/html/search/variables_c.js b/docs/search/variables_c.js similarity index 100% rename from docs/html/search/variables_c.js rename to docs/search/variables_c.js diff --git a/docs/html/search/variables_d.js b/docs/search/variables_d.js similarity index 100% rename from docs/html/search/variables_d.js rename to docs/search/variables_d.js diff --git a/docs/html/search/variables_e.js b/docs/search/variables_e.js similarity index 100% rename from docs/html/search/variables_e.js rename to docs/search/variables_e.js diff --git a/docs/html/search/variables_f.js b/docs/search/variables_f.js similarity index 100% rename from docs/html/search/variables_f.js rename to docs/search/variables_f.js diff --git a/docs/html/splitbar.png b/docs/splitbar.png similarity index 100% rename from docs/html/splitbar.png rename to docs/splitbar.png diff --git a/docs/html/splitbard.png b/docs/splitbard.png similarity index 100% rename from docs/html/splitbard.png rename to docs/splitbard.png diff --git a/docs/html/structciot__ble__cfg__t.html b/docs/structciot__ble__cfg__t.html similarity index 100% rename from docs/html/structciot__ble__cfg__t.html rename to docs/structciot__ble__cfg__t.html diff --git a/docs/html/structciot__ble__cfg__t.js b/docs/structciot__ble__cfg__t.js similarity index 100% rename from docs/html/structciot__ble__cfg__t.js rename to docs/structciot__ble__cfg__t.js diff --git a/docs/html/structciot__ble__ifaces.html b/docs/structciot__ble__ifaces.html similarity index 100% rename from docs/html/structciot__ble__ifaces.html rename to docs/structciot__ble__ifaces.html diff --git a/docs/html/structciot__ble__ifaces.js b/docs/structciot__ble__ifaces.js similarity index 100% rename from docs/html/structciot__ble__ifaces.js rename to docs/structciot__ble__ifaces.js diff --git a/docs/html/structciot__ble__info__t.html b/docs/structciot__ble__info__t.html similarity index 100% rename from docs/html/structciot__ble__info__t.html rename to docs/structciot__ble__info__t.html diff --git a/docs/html/structciot__ble__info__t.js b/docs/structciot__ble__info__t.js similarity index 100% rename from docs/html/structciot__ble__info__t.js rename to docs/structciot__ble__info__t.js diff --git a/docs/html/structciot__ble__req__t.html b/docs/structciot__ble__req__t.html similarity index 100% rename from docs/html/structciot__ble__req__t.html rename to docs/structciot__ble__req__t.html diff --git a/docs/html/structciot__ble__req__t.js b/docs/structciot__ble__req__t.js similarity index 100% rename from docs/html/structciot__ble__req__t.js rename to docs/structciot__ble__req__t.js diff --git a/docs/html/structciot__ble__scn__adv__info__t.html b/docs/structciot__ble__scn__adv__info__t.html similarity index 100% rename from docs/html/structciot__ble__scn__adv__info__t.html rename to docs/structciot__ble__scn__adv__info__t.html diff --git a/docs/html/structciot__ble__scn__adv__info__t.js b/docs/structciot__ble__scn__adv__info__t.js similarity index 100% rename from docs/html/structciot__ble__scn__adv__info__t.js rename to docs/structciot__ble__scn__adv__info__t.js diff --git a/docs/html/structciot__ble__scn__cfg__t.html b/docs/structciot__ble__scn__cfg__t.html similarity index 100% rename from docs/html/structciot__ble__scn__cfg__t.html rename to docs/structciot__ble__scn__cfg__t.html diff --git a/docs/html/structciot__ble__scn__cfg__t.js b/docs/structciot__ble__scn__cfg__t.js similarity index 100% rename from docs/html/structciot__ble__scn__cfg__t.js rename to docs/structciot__ble__scn__cfg__t.js diff --git a/docs/html/structciot__ble__scn__req__t.html b/docs/structciot__ble__scn__req__t.html similarity index 100% rename from docs/html/structciot__ble__scn__req__t.html rename to docs/structciot__ble__scn__req__t.html diff --git a/docs/html/structciot__ble__scn__req__t.js b/docs/structciot__ble__scn__req__t.js similarity index 100% rename from docs/html/structciot__ble__scn__req__t.js rename to docs/structciot__ble__scn__req__t.js diff --git a/docs/html/structciot__ble__scn__status__msg__t.html b/docs/structciot__ble__scn__status__msg__t.html similarity index 100% rename from docs/html/structciot__ble__scn__status__msg__t.html rename to docs/structciot__ble__scn__status__msg__t.html diff --git a/docs/html/structciot__ble__scn__status__msg__t.js b/docs/structciot__ble__scn__status__msg__t.js similarity index 100% rename from docs/html/structciot__ble__scn__status__msg__t.js rename to docs/structciot__ble__scn__status__msg__t.js diff --git a/docs/html/structciot__ble__scn__status__t.html b/docs/structciot__ble__scn__status__t.html similarity index 100% rename from docs/html/structciot__ble__scn__status__t.html rename to docs/structciot__ble__scn__status__t.html diff --git a/docs/html/structciot__ble__scn__status__t.js b/docs/structciot__ble__scn__status__t.js similarity index 100% rename from docs/html/structciot__ble__scn__status__t.js rename to docs/structciot__ble__scn__status__t.js diff --git a/docs/html/structciot__ble__status__msg__t.html b/docs/structciot__ble__status__msg__t.html similarity index 100% rename from docs/html/structciot__ble__status__msg__t.html rename to docs/structciot__ble__status__msg__t.html diff --git a/docs/html/structciot__ble__status__msg__t.js b/docs/structciot__ble__status__msg__t.js similarity index 100% rename from docs/html/structciot__ble__status__msg__t.js rename to docs/structciot__ble__status__msg__t.js diff --git a/docs/html/structciot__ble__status__t.html b/docs/structciot__ble__status__t.html similarity index 100% rename from docs/html/structciot__ble__status__t.html rename to docs/structciot__ble__status__t.html diff --git a/docs/html/structciot__ble__status__t.js b/docs/structciot__ble__status__t.js similarity index 100% rename from docs/html/structciot__ble__status__t.js rename to docs/structciot__ble__status__t.js diff --git a/docs/html/structciot__bridge__cfg__t.html b/docs/structciot__bridge__cfg__t.html similarity index 100% rename from docs/html/structciot__bridge__cfg__t.html rename to docs/structciot__bridge__cfg__t.html diff --git a/docs/html/structciot__bridge__cfg__t.js b/docs/structciot__bridge__cfg__t.js similarity index 100% rename from docs/html/structciot__bridge__cfg__t.js rename to docs/structciot__bridge__cfg__t.js diff --git a/docs/html/structciot__bridge__req__t.html b/docs/structciot__bridge__req__t.html similarity index 100% rename from docs/html/structciot__bridge__req__t.html rename to docs/structciot__bridge__req__t.html diff --git a/docs/html/structciot__bridge__req__t.js b/docs/structciot__bridge__req__t.js similarity index 100% rename from docs/html/structciot__bridge__req__t.js rename to docs/structciot__bridge__req__t.js diff --git a/docs/html/structciot__bridge__status__msg__t.html b/docs/structciot__bridge__status__msg__t.html similarity index 100% rename from docs/html/structciot__bridge__status__msg__t.html rename to docs/structciot__bridge__status__msg__t.html diff --git a/docs/html/structciot__bridge__status__msg__t.js b/docs/structciot__bridge__status__msg__t.js similarity index 100% rename from docs/html/structciot__bridge__status__msg__t.js rename to docs/structciot__bridge__status__msg__t.js diff --git a/docs/html/structciot__bridge__status__t.html b/docs/structciot__bridge__status__t.html similarity index 100% rename from docs/html/structciot__bridge__status__t.html rename to docs/structciot__bridge__status__t.html diff --git a/docs/html/structciot__bridge__status__t.js b/docs/structciot__bridge__status__t.js similarity index 100% rename from docs/html/structciot__bridge__status__t.js rename to docs/structciot__bridge__status__t.js diff --git a/docs/html/structciot__cfg.html b/docs/structciot__cfg.html similarity index 100% rename from docs/html/structciot__cfg.html rename to docs/structciot__cfg.html diff --git a/docs/html/structciot__cfg.js b/docs/structciot__cfg.js similarity index 100% rename from docs/html/structciot__cfg.js rename to docs/structciot__cfg.js diff --git a/docs/html/structciot__data__model__cfg__t.html b/docs/structciot__data__model__cfg__t.html similarity index 100% rename from docs/html/structciot__data__model__cfg__t.html rename to docs/structciot__data__model__cfg__t.html diff --git a/docs/html/structciot__data__model__req__t.html b/docs/structciot__data__model__req__t.html similarity index 100% rename from docs/html/structciot__data__model__req__t.html rename to docs/structciot__data__model__req__t.html diff --git a/docs/html/structciot__data__model__req__t.js b/docs/structciot__data__model__req__t.js similarity index 100% rename from docs/html/structciot__data__model__req__t.js rename to docs/structciot__data__model__req__t.js diff --git a/docs/html/structciot__data__model__status__t.html b/docs/structciot__data__model__status__t.html similarity index 100% rename from docs/html/structciot__data__model__status__t.html rename to docs/structciot__data__model__status__t.html diff --git a/docs/html/structciot__data__model__status__t.js b/docs/structciot__data__model__status__t.js similarity index 100% rename from docs/html/structciot__data__model__status__t.js rename to docs/structciot__data__model__status__t.js diff --git a/docs/html/structciot__dfu__cfg__t.html b/docs/structciot__dfu__cfg__t.html similarity index 100% rename from docs/html/structciot__dfu__cfg__t.html rename to docs/structciot__dfu__cfg__t.html diff --git a/docs/html/structciot__dfu__cfg__t.js b/docs/structciot__dfu__cfg__t.js similarity index 100% rename from docs/html/structciot__dfu__cfg__t.js rename to docs/structciot__dfu__cfg__t.js diff --git a/docs/html/structciot__dfu__req__t.html b/docs/structciot__dfu__req__t.html similarity index 100% rename from docs/html/structciot__dfu__req__t.html rename to docs/structciot__dfu__req__t.html diff --git a/docs/html/structciot__dfu__req__t.js b/docs/structciot__dfu__req__t.js similarity index 100% rename from docs/html/structciot__dfu__req__t.js rename to docs/structciot__dfu__req__t.js diff --git a/docs/html/structciot__dfu__status__msg__t.html b/docs/structciot__dfu__status__msg__t.html similarity index 100% rename from docs/html/structciot__dfu__status__msg__t.html rename to docs/structciot__dfu__status__msg__t.html diff --git a/docs/html/structciot__dfu__status__msg__t.js b/docs/structciot__dfu__status__msg__t.js similarity index 100% rename from docs/html/structciot__dfu__status__msg__t.js rename to docs/structciot__dfu__status__msg__t.js diff --git a/docs/html/structciot__dfu__status__t.html b/docs/structciot__dfu__status__t.html similarity index 100% rename from docs/html/structciot__dfu__status__t.html rename to docs/structciot__dfu__status__t.html diff --git a/docs/html/structciot__dfu__status__t.js b/docs/structciot__dfu__status__t.js similarity index 100% rename from docs/html/structciot__dfu__status__t.js rename to docs/structciot__dfu__status__t.js diff --git a/docs/html/structciot__eth__status__msg__t.html b/docs/structciot__eth__status__msg__t.html similarity index 100% rename from docs/html/structciot__eth__status__msg__t.html rename to docs/structciot__eth__status__msg__t.html diff --git a/docs/html/structciot__eth__status__msg__t.js b/docs/structciot__eth__status__msg__t.js similarity index 100% rename from docs/html/structciot__eth__status__msg__t.js rename to docs/structciot__eth__status__msg__t.js diff --git a/docs/html/structciot__event__data.html b/docs/structciot__event__data.html similarity index 100% rename from docs/html/structciot__event__data.html rename to docs/structciot__event__data.html diff --git a/docs/html/structciot__event__data.js b/docs/structciot__event__data.js similarity index 100% rename from docs/html/structciot__event__data.js rename to docs/structciot__event__data.js diff --git a/docs/html/structciot__gpio__cfg__t.html b/docs/structciot__gpio__cfg__t.html similarity index 100% rename from docs/html/structciot__gpio__cfg__t.html rename to docs/structciot__gpio__cfg__t.html diff --git a/docs/html/structciot__gpio__cfg__t.js b/docs/structciot__gpio__cfg__t.js similarity index 100% rename from docs/html/structciot__gpio__cfg__t.js rename to docs/structciot__gpio__cfg__t.js diff --git a/docs/html/structciot__gpio__req__get__state__t.html b/docs/structciot__gpio__req__get__state__t.html similarity index 100% rename from docs/html/structciot__gpio__req__get__state__t.html rename to docs/structciot__gpio__req__get__state__t.html diff --git a/docs/html/structciot__gpio__req__get__state__t.js b/docs/structciot__gpio__req__get__state__t.js similarity index 100% rename from docs/html/structciot__gpio__req__get__state__t.js rename to docs/structciot__gpio__req__get__state__t.js diff --git a/docs/html/structciot__gpio__req__t.html b/docs/structciot__gpio__req__t.html similarity index 100% rename from docs/html/structciot__gpio__req__t.html rename to docs/structciot__gpio__req__t.html diff --git a/docs/html/structciot__gpio__req__t.js b/docs/structciot__gpio__req__t.js similarity index 100% rename from docs/html/structciot__gpio__req__t.js rename to docs/structciot__gpio__req__t.js diff --git a/docs/html/structciot__gpio__state__info__t.html b/docs/structciot__gpio__state__info__t.html similarity index 100% rename from docs/html/structciot__gpio__state__info__t.html rename to docs/structciot__gpio__state__info__t.html diff --git a/docs/html/structciot__gpio__state__info__t.js b/docs/structciot__gpio__state__info__t.js similarity index 100% rename from docs/html/structciot__gpio__state__info__t.js rename to docs/structciot__gpio__state__info__t.js diff --git a/docs/html/structciot__gpio__status__msg__t.html b/docs/structciot__gpio__status__msg__t.html similarity index 100% rename from docs/html/structciot__gpio__status__msg__t.html rename to docs/structciot__gpio__status__msg__t.html diff --git a/docs/html/structciot__gpio__status__msg__t.js b/docs/structciot__gpio__status__msg__t.js similarity index 100% rename from docs/html/structciot__gpio__status__msg__t.js rename to docs/structciot__gpio__status__msg__t.js diff --git a/docs/html/structciot__gpio__status__t.html b/docs/structciot__gpio__status__t.html similarity index 100% rename from docs/html/structciot__gpio__status__t.html rename to docs/structciot__gpio__status__t.html diff --git a/docs/html/structciot__gpio__status__t.js b/docs/structciot__gpio__status__t.js similarity index 100% rename from docs/html/structciot__gpio__status__t.js rename to docs/structciot__gpio__status__t.js diff --git a/docs/html/structciot__httpc__cfg__t.html b/docs/structciot__httpc__cfg__t.html similarity index 100% rename from docs/html/structciot__httpc__cfg__t.html rename to docs/structciot__httpc__cfg__t.html diff --git a/docs/html/structciot__httpc__cfg__t.js b/docs/structciot__httpc__cfg__t.js similarity index 100% rename from docs/html/structciot__httpc__cfg__t.js rename to docs/structciot__httpc__cfg__t.js diff --git a/docs/html/structciot__httpc__event__data.html b/docs/structciot__httpc__event__data.html similarity index 100% rename from docs/html/structciot__httpc__event__data.html rename to docs/structciot__httpc__event__data.html diff --git a/docs/html/structciot__httpc__event__data.js b/docs/structciot__httpc__event__data.js similarity index 100% rename from docs/html/structciot__httpc__event__data.js rename to docs/structciot__httpc__event__data.js diff --git a/docs/html/structciot__httpc__req__send__t.html b/docs/structciot__httpc__req__send__t.html similarity index 100% rename from docs/html/structciot__httpc__req__send__t.html rename to docs/structciot__httpc__req__send__t.html diff --git a/docs/html/structciot__httpc__req__send__t.js b/docs/structciot__httpc__req__send__t.js similarity index 100% rename from docs/html/structciot__httpc__req__send__t.js rename to docs/structciot__httpc__req__send__t.js diff --git a/docs/html/structciot__httpc__req__set__header__t.html b/docs/structciot__httpc__req__set__header__t.html similarity index 100% rename from docs/html/structciot__httpc__req__set__header__t.html rename to docs/structciot__httpc__req__set__header__t.html diff --git a/docs/html/structciot__httpc__req__set__header__t.js b/docs/structciot__httpc__req__set__header__t.js similarity index 100% rename from docs/html/structciot__httpc__req__set__header__t.js rename to docs/structciot__httpc__req__set__header__t.js diff --git a/docs/html/structciot__httpc__req__t.html b/docs/structciot__httpc__req__t.html similarity index 100% rename from docs/html/structciot__httpc__req__t.html rename to docs/structciot__httpc__req__t.html diff --git a/docs/html/structciot__httpc__req__t.js b/docs/structciot__httpc__req__t.js similarity index 100% rename from docs/html/structciot__httpc__req__t.js rename to docs/structciot__httpc__req__t.js diff --git a/docs/html/structciot__httpc__status__msg__t.html b/docs/structciot__httpc__status__msg__t.html similarity index 100% rename from docs/html/structciot__httpc__status__msg__t.html rename to docs/structciot__httpc__status__msg__t.html diff --git a/docs/html/structciot__httpc__status__msg__t.js b/docs/structciot__httpc__status__msg__t.js similarity index 100% rename from docs/html/structciot__httpc__status__msg__t.js rename to docs/structciot__httpc__status__msg__t.js diff --git a/docs/html/structciot__httpc__status__t.html b/docs/structciot__httpc__status__t.html similarity index 100% rename from docs/html/structciot__httpc__status__t.html rename to docs/structciot__httpc__status__t.html diff --git a/docs/html/structciot__httpc__status__t.js b/docs/structciot__httpc__status__t.js similarity index 100% rename from docs/html/structciot__httpc__status__t.js rename to docs/structciot__httpc__status__t.js diff --git a/docs/html/structciot__https__cfg__t.html b/docs/structciot__https__cfg__t.html similarity index 100% rename from docs/html/structciot__https__cfg__t.html rename to docs/structciot__https__cfg__t.html diff --git a/docs/html/structciot__https__cfg__t.js b/docs/structciot__https__cfg__t.js similarity index 100% rename from docs/html/structciot__https__cfg__t.js rename to docs/structciot__https__cfg__t.js diff --git a/docs/html/structciot__https__event.html b/docs/structciot__https__event.html similarity index 100% rename from docs/html/structciot__https__event.html rename to docs/structciot__https__event.html diff --git a/docs/html/structciot__https__event.js b/docs/structciot__https__event.js similarity index 100% rename from docs/html/structciot__https__event.js rename to docs/structciot__https__event.js diff --git a/docs/html/structciot__https__event__data.html b/docs/structciot__https__event__data.html similarity index 100% rename from docs/html/structciot__https__event__data.html rename to docs/structciot__https__event__data.html diff --git a/docs/html/structciot__https__event__data.js b/docs/structciot__https__event__data.js similarity index 100% rename from docs/html/structciot__https__event__data.js rename to docs/structciot__https__event__data.js diff --git a/docs/html/structciot__https__req__t.html b/docs/structciot__https__req__t.html similarity index 100% rename from docs/html/structciot__https__req__t.html rename to docs/structciot__https__req__t.html diff --git a/docs/html/structciot__https__req__t.js b/docs/structciot__https__req__t.js similarity index 100% rename from docs/html/structciot__https__req__t.js rename to docs/structciot__https__req__t.js diff --git a/docs/html/structciot__https__status__msg__t.html b/docs/structciot__https__status__msg__t.html similarity index 100% rename from docs/html/structciot__https__status__msg__t.html rename to docs/structciot__https__status__msg__t.html diff --git a/docs/html/structciot__https__status__msg__t.js b/docs/structciot__https__status__msg__t.js similarity index 100% rename from docs/html/structciot__https__status__msg__t.js rename to docs/structciot__https__status__msg__t.js diff --git a/docs/html/structciot__https__status__t.html b/docs/structciot__https__status__t.html similarity index 100% rename from docs/html/structciot__https__status__t.html rename to docs/structciot__https__status__t.html diff --git a/docs/html/structciot__https__status__t.js b/docs/structciot__https__status__t.js similarity index 100% rename from docs/html/structciot__https__status__t.js rename to docs/structciot__https__status__t.js diff --git a/docs/html/structciot__iface.html b/docs/structciot__iface.html similarity index 100% rename from docs/html/structciot__iface.html rename to docs/structciot__iface.html diff --git a/docs/html/structciot__iface.js b/docs/structciot__iface.js similarity index 100% rename from docs/html/structciot__iface.js rename to docs/structciot__iface.js diff --git a/docs/html/structciot__iface__base.html b/docs/structciot__iface__base.html similarity index 100% rename from docs/html/structciot__iface__base.html rename to docs/structciot__iface__base.html diff --git a/docs/html/structciot__iface__base.js b/docs/structciot__iface__base.js similarity index 100% rename from docs/html/structciot__iface__base.js rename to docs/structciot__iface__base.js diff --git a/docs/html/structciot__iface__base__data.html b/docs/structciot__iface__base__data.html similarity index 100% rename from docs/html/structciot__iface__base__data.html rename to docs/structciot__iface__base__data.html diff --git a/docs/html/structciot__iface__base__data.js b/docs/structciot__iface__base__data.js similarity index 100% rename from docs/html/structciot__iface__base__data.js rename to docs/structciot__iface__base__data.js diff --git a/docs/html/structciot__iface__cfg__t.html b/docs/structciot__iface__cfg__t.html similarity index 100% rename from docs/html/structciot__iface__cfg__t.html rename to docs/structciot__iface__cfg__t.html diff --git a/docs/html/structciot__iface__event__t.html b/docs/structciot__iface__event__t.html similarity index 100% rename from docs/html/structciot__iface__event__t.html rename to docs/structciot__iface__event__t.html diff --git a/docs/html/structciot__iface__event__t.js b/docs/structciot__iface__event__t.js similarity index 100% rename from docs/html/structciot__iface__event__t.js rename to docs/structciot__iface__event__t.js diff --git a/docs/html/structciot__iface__req__info.html b/docs/structciot__iface__req__info.html similarity index 100% rename from docs/html/structciot__iface__req__info.html rename to docs/structciot__iface__req__info.html diff --git a/docs/html/structciot__iface__req__info.js b/docs/structciot__iface__req__info.js similarity index 100% rename from docs/html/structciot__iface__req__info.js rename to docs/structciot__iface__req__info.js diff --git a/docs/html/structciot__ifaces.html b/docs/structciot__ifaces.html similarity index 100% rename from docs/html/structciot__ifaces.html rename to docs/structciot__ifaces.html diff --git a/docs/html/structciot__ifaces.js b/docs/structciot__ifaces.js similarity index 100% rename from docs/html/structciot__ifaces.js rename to docs/structciot__ifaces.js diff --git a/docs/html/structciot__info__t.html b/docs/structciot__info__t.html similarity index 100% rename from docs/html/structciot__info__t.html rename to docs/structciot__info__t.html diff --git a/docs/html/structciot__info__t.js b/docs/structciot__info__t.js similarity index 100% rename from docs/html/structciot__info__t.js rename to docs/structciot__info__t.js diff --git a/docs/html/structciot__mqttc__cfg__t.html b/docs/structciot__mqttc__cfg__t.html similarity index 100% rename from docs/html/structciot__mqttc__cfg__t.html rename to docs/structciot__mqttc__cfg__t.html diff --git a/docs/html/structciot__mqttc__cfg__t.js b/docs/structciot__mqttc__cfg__t.js similarity index 100% rename from docs/html/structciot__mqttc__cfg__t.js rename to docs/structciot__mqttc__cfg__t.js diff --git a/docs/html/structciot__mqttc__error__t.html b/docs/structciot__mqttc__error__t.html similarity index 100% rename from docs/html/structciot__mqttc__error__t.html rename to docs/structciot__mqttc__error__t.html diff --git a/docs/html/structciot__mqttc__error__t.js b/docs/structciot__mqttc__error__t.js similarity index 100% rename from docs/html/structciot__mqttc__error__t.js rename to docs/structciot__mqttc__error__t.js diff --git a/docs/html/structciot__mqttc__event.html b/docs/structciot__mqttc__event.html similarity index 100% rename from docs/html/structciot__mqttc__event.html rename to docs/structciot__mqttc__event.html diff --git a/docs/html/structciot__mqttc__event.js b/docs/structciot__mqttc__event.js similarity index 100% rename from docs/html/structciot__mqttc__event.js rename to docs/structciot__mqttc__event.js diff --git a/docs/html/structciot__mqttc__event__data.html b/docs/structciot__mqttc__event__data.html similarity index 100% rename from docs/html/structciot__mqttc__event__data.html rename to docs/structciot__mqttc__event__data.html diff --git a/docs/html/structciot__mqttc__event__data.js b/docs/structciot__mqttc__event__data.js similarity index 100% rename from docs/html/structciot__mqttc__event__data.js rename to docs/structciot__mqttc__event__data.js diff --git a/docs/html/structciot__mqttc__req__publish__t.html b/docs/structciot__mqttc__req__publish__t.html similarity index 100% rename from docs/html/structciot__mqttc__req__publish__t.html rename to docs/structciot__mqttc__req__publish__t.html diff --git a/docs/html/structciot__mqttc__req__publish__t.js b/docs/structciot__mqttc__req__publish__t.js similarity index 100% rename from docs/html/structciot__mqttc__req__publish__t.js rename to docs/structciot__mqttc__req__publish__t.js diff --git a/docs/html/structciot__mqttc__req__subscribe__t.html b/docs/structciot__mqttc__req__subscribe__t.html similarity index 100% rename from docs/html/structciot__mqttc__req__subscribe__t.html rename to docs/structciot__mqttc__req__subscribe__t.html diff --git a/docs/html/structciot__mqttc__req__subscribe__t.js b/docs/structciot__mqttc__req__subscribe__t.js similarity index 100% rename from docs/html/structciot__mqttc__req__subscribe__t.js rename to docs/structciot__mqttc__req__subscribe__t.js diff --git a/docs/html/structciot__mqttc__req__t.html b/docs/structciot__mqttc__req__t.html similarity index 100% rename from docs/html/structciot__mqttc__req__t.html rename to docs/structciot__mqttc__req__t.html diff --git a/docs/html/structciot__mqttc__req__t.js b/docs/structciot__mqttc__req__t.js similarity index 100% rename from docs/html/structciot__mqttc__req__t.js rename to docs/structciot__mqttc__req__t.js diff --git a/docs/html/structciot__mqttc__status__msg__t.html b/docs/structciot__mqttc__status__msg__t.html similarity index 100% rename from docs/html/structciot__mqttc__status__msg__t.html rename to docs/structciot__mqttc__status__msg__t.html diff --git a/docs/html/structciot__mqttc__status__msg__t.js b/docs/structciot__mqttc__status__msg__t.js similarity index 100% rename from docs/html/structciot__mqttc__status__msg__t.js rename to docs/structciot__mqttc__status__msg__t.js diff --git a/docs/html/structciot__mqttc__status__t.html b/docs/structciot__mqttc__status__t.html similarity index 100% rename from docs/html/structciot__mqttc__status__t.html rename to docs/structciot__mqttc__status__t.html diff --git a/docs/html/structciot__mqttc__status__t.js b/docs/structciot__mqttc__status__t.js similarity index 100% rename from docs/html/structciot__mqttc__status__t.js rename to docs/structciot__mqttc__status__t.js diff --git a/docs/html/structciot__mqttc__topics__cfg__t.html b/docs/structciot__mqttc__topics__cfg__t.html similarity index 100% rename from docs/html/structciot__mqttc__topics__cfg__t.html rename to docs/structciot__mqttc__topics__cfg__t.html diff --git a/docs/html/structciot__mqttc__topics__cfg__t.js b/docs/structciot__mqttc__topics__cfg__t.js similarity index 100% rename from docs/html/structciot__mqttc__topics__cfg__t.js rename to docs/structciot__mqttc__topics__cfg__t.js diff --git a/docs/html/structciot__msg__error__t.html b/docs/structciot__msg__error__t.html similarity index 100% rename from docs/html/structciot__msg__error__t.html rename to docs/structciot__msg__error__t.html diff --git a/docs/html/structciot__msg__error__t.js b/docs/structciot__msg__error__t.js similarity index 100% rename from docs/html/structciot__msg__error__t.js rename to docs/structciot__msg__error__t.js diff --git a/docs/html/structciot__msg__header__t.html b/docs/structciot__msg__header__t.html similarity index 100% rename from docs/html/structciot__msg__header__t.html rename to docs/structciot__msg__header__t.html diff --git a/docs/html/structciot__msg__header__t.js b/docs/structciot__msg__header__t.js similarity index 100% rename from docs/html/structciot__msg__header__t.js rename to docs/structciot__msg__header__t.js diff --git a/docs/html/structciot__msg__iface__info__t.html b/docs/structciot__msg__iface__info__t.html similarity index 100% rename from docs/html/structciot__msg__iface__info__t.html rename to docs/structciot__msg__iface__info__t.html diff --git a/docs/html/structciot__msg__iface__info__t.js b/docs/structciot__msg__iface__info__t.js similarity index 100% rename from docs/html/structciot__msg__iface__info__t.js rename to docs/structciot__msg__iface__info__t.js diff --git a/docs/html/structciot__msg__t.html b/docs/structciot__msg__t.html similarity index 100% rename from docs/html/structciot__msg__t.html rename to docs/structciot__msg__t.html diff --git a/docs/html/structciot__msg__t.js b/docs/structciot__msg__t.js similarity index 100% rename from docs/html/structciot__msg__t.js rename to docs/structciot__msg__t.js diff --git a/docs/html/structciot__nrf__dfu__cfg.html b/docs/structciot__nrf__dfu__cfg.html similarity index 100% rename from docs/html/structciot__nrf__dfu__cfg.html rename to docs/structciot__nrf__dfu__cfg.html diff --git a/docs/html/structciot__nrf__dfu__cfg.js b/docs/structciot__nrf__dfu__cfg.js similarity index 100% rename from docs/html/structciot__nrf__dfu__cfg.js rename to docs/structciot__nrf__dfu__cfg.js diff --git a/docs/html/structciot__nrf__dfu__packet.html b/docs/structciot__nrf__dfu__packet.html similarity index 100% rename from docs/html/structciot__nrf__dfu__packet.html rename to docs/structciot__nrf__dfu__packet.html diff --git a/docs/html/structciot__nrf__dfu__packet.js b/docs/structciot__nrf__dfu__packet.js similarity index 100% rename from docs/html/structciot__nrf__dfu__packet.js rename to docs/structciot__nrf__dfu__packet.js diff --git a/docs/html/structciot__ntp__cfg__t.html b/docs/structciot__ntp__cfg__t.html similarity index 100% rename from docs/html/structciot__ntp__cfg__t.html rename to docs/structciot__ntp__cfg__t.html diff --git a/docs/html/structciot__ntp__cfg__t.js b/docs/structciot__ntp__cfg__t.js similarity index 100% rename from docs/html/structciot__ntp__cfg__t.js rename to docs/structciot__ntp__cfg__t.js diff --git a/docs/html/structciot__ntp__req__t.html b/docs/structciot__ntp__req__t.html similarity index 100% rename from docs/html/structciot__ntp__req__t.html rename to docs/structciot__ntp__req__t.html diff --git a/docs/html/structciot__ntp__req__t.js b/docs/structciot__ntp__req__t.js similarity index 100% rename from docs/html/structciot__ntp__req__t.js rename to docs/structciot__ntp__req__t.js diff --git a/docs/html/structciot__ntp__status__msg__t.html b/docs/structciot__ntp__status__msg__t.html similarity index 100% rename from docs/html/structciot__ntp__status__msg__t.html rename to docs/structciot__ntp__status__msg__t.html diff --git a/docs/html/structciot__ntp__status__msg__t.js b/docs/structciot__ntp__status__msg__t.js similarity index 100% rename from docs/html/structciot__ntp__status__msg__t.js rename to docs/structciot__ntp__status__msg__t.js diff --git a/docs/html/structciot__ntp__status__t.html b/docs/structciot__ntp__status__t.html similarity index 100% rename from docs/html/structciot__ntp__status__t.html rename to docs/structciot__ntp__status__t.html diff --git a/docs/html/structciot__ntp__status__t.js b/docs/structciot__ntp__status__t.js similarity index 100% rename from docs/html/structciot__ntp__status__t.js rename to docs/structciot__ntp__status__t.js diff --git a/docs/html/structciot__opcuas__cfg__t.html b/docs/structciot__opcuas__cfg__t.html similarity index 100% rename from docs/html/structciot__opcuas__cfg__t.html rename to docs/structciot__opcuas__cfg__t.html diff --git a/docs/html/structciot__opcuas__cfg__t.js b/docs/structciot__opcuas__cfg__t.js similarity index 100% rename from docs/html/structciot__opcuas__cfg__t.js rename to docs/structciot__opcuas__cfg__t.js diff --git a/docs/html/structciot__opcuas__req__add__node__t.html b/docs/structciot__opcuas__req__add__node__t.html similarity index 100% rename from docs/html/structciot__opcuas__req__add__node__t.html rename to docs/structciot__opcuas__req__add__node__t.html diff --git a/docs/html/structciot__opcuas__req__add__node__t.js b/docs/structciot__opcuas__req__add__node__t.js similarity index 100% rename from docs/html/structciot__opcuas__req__add__node__t.js rename to docs/structciot__opcuas__req__add__node__t.js diff --git a/docs/html/structciot__opcuas__req__t.html b/docs/structciot__opcuas__req__t.html similarity index 100% rename from docs/html/structciot__opcuas__req__t.html rename to docs/structciot__opcuas__req__t.html diff --git a/docs/html/structciot__opcuas__req__t.js b/docs/structciot__opcuas__req__t.js similarity index 100% rename from docs/html/structciot__opcuas__req__t.js rename to docs/structciot__opcuas__req__t.js diff --git a/docs/html/structciot__opcuas__status__msg__t.html b/docs/structciot__opcuas__status__msg__t.html similarity index 100% rename from docs/html/structciot__opcuas__status__msg__t.html rename to docs/structciot__opcuas__status__msg__t.html diff --git a/docs/html/structciot__opcuas__status__msg__t.js b/docs/structciot__opcuas__status__msg__t.js similarity index 100% rename from docs/html/structciot__opcuas__status__msg__t.js rename to docs/structciot__opcuas__status__msg__t.js diff --git a/docs/html/structciot__opcuas__status__t.html b/docs/structciot__opcuas__status__t.html similarity index 100% rename from docs/html/structciot__opcuas__status__t.html rename to docs/structciot__opcuas__status__t.html diff --git a/docs/html/structciot__opcuas__status__t.js b/docs/structciot__opcuas__status__t.js similarity index 100% rename from docs/html/structciot__opcuas__status__t.js rename to docs/structciot__opcuas__status__t.js diff --git a/docs/html/structciot__ota__cfg__t.html b/docs/structciot__ota__cfg__t.html similarity index 100% rename from docs/html/structciot__ota__cfg__t.html rename to docs/structciot__ota__cfg__t.html diff --git a/docs/html/structciot__ota__cfg__t.js b/docs/structciot__ota__cfg__t.js similarity index 100% rename from docs/html/structciot__ota__cfg__t.js rename to docs/structciot__ota__cfg__t.js diff --git a/docs/html/structciot__ota__req__t.html b/docs/structciot__ota__req__t.html similarity index 100% rename from docs/html/structciot__ota__req__t.html rename to docs/structciot__ota__req__t.html diff --git a/docs/html/structciot__ota__req__t.js b/docs/structciot__ota__req__t.js similarity index 100% rename from docs/html/structciot__ota__req__t.js rename to docs/structciot__ota__req__t.js diff --git a/docs/html/structciot__ota__status__msg__t.html b/docs/structciot__ota__status__msg__t.html similarity index 100% rename from docs/html/structciot__ota__status__msg__t.html rename to docs/structciot__ota__status__msg__t.html diff --git a/docs/html/structciot__ota__status__msg__t.js b/docs/structciot__ota__status__msg__t.js similarity index 100% rename from docs/html/structciot__ota__status__msg__t.js rename to docs/structciot__ota__status__msg__t.js diff --git a/docs/html/structciot__ota__status__t.html b/docs/structciot__ota__status__t.html similarity index 100% rename from docs/html/structciot__ota__status__t.html rename to docs/structciot__ota__status__t.html diff --git a/docs/html/structciot__ota__status__t.js b/docs/structciot__ota__status__t.js similarity index 100% rename from docs/html/structciot__ota__status__t.js rename to docs/structciot__ota__status__t.js diff --git a/docs/html/structciot__req__delete__iface__cfg__t.html b/docs/structciot__req__delete__iface__cfg__t.html similarity index 100% rename from docs/html/structciot__req__delete__iface__cfg__t.html rename to docs/structciot__req__delete__iface__cfg__t.html diff --git a/docs/html/structciot__req__delete__iface__cfg__t.js b/docs/structciot__req__delete__iface__cfg__t.js similarity index 100% rename from docs/html/structciot__req__delete__iface__cfg__t.js rename to docs/structciot__req__delete__iface__cfg__t.js diff --git a/docs/html/structciot__req__proxy__msg__t.html b/docs/structciot__req__proxy__msg__t.html similarity index 100% rename from docs/html/structciot__req__proxy__msg__t.html rename to docs/structciot__req__proxy__msg__t.html diff --git a/docs/html/structciot__req__proxy__msg__t.js b/docs/structciot__req__proxy__msg__t.js similarity index 100% rename from docs/html/structciot__req__proxy__msg__t.js rename to docs/structciot__req__proxy__msg__t.js diff --git a/docs/html/structciot__req__result__t.html b/docs/structciot__req__result__t.html similarity index 100% rename from docs/html/structciot__req__result__t.html rename to docs/structciot__req__result__t.html diff --git a/docs/html/structciot__req__result__t.js b/docs/structciot__req__result__t.js similarity index 100% rename from docs/html/structciot__req__result__t.js rename to docs/structciot__req__result__t.js diff --git a/docs/html/structciot__req__save__iface__cfg__t.html b/docs/structciot__req__save__iface__cfg__t.html similarity index 100% rename from docs/html/structciot__req__save__iface__cfg__t.html rename to docs/structciot__req__save__iface__cfg__t.html diff --git a/docs/html/structciot__req__save__iface__cfg__t.js b/docs/structciot__req__save__iface__cfg__t.js similarity index 100% rename from docs/html/structciot__req__save__iface__cfg__t.js rename to docs/structciot__req__save__iface__cfg__t.js diff --git a/docs/html/structciot__req__t.html b/docs/structciot__req__t.html similarity index 100% rename from docs/html/structciot__req__t.html rename to docs/structciot__req__t.html diff --git a/docs/html/structciot__req__t.js b/docs/structciot__req__t.js similarity index 100% rename from docs/html/structciot__req__t.js rename to docs/structciot__req__t.js diff --git a/docs/html/structciot__s__cfg.html b/docs/structciot__s__cfg.html similarity index 100% rename from docs/html/structciot__s__cfg.html rename to docs/structciot__s__cfg.html diff --git a/docs/html/structciot__s__cfg.js b/docs/structciot__s__cfg.js similarity index 100% rename from docs/html/structciot__s__cfg.js rename to docs/structciot__s__cfg.js diff --git a/docs/html/structciot__serializer.html b/docs/structciot__serializer.html similarity index 100% rename from docs/html/structciot__serializer.html rename to docs/structciot__serializer.html diff --git a/docs/html/structciot__serializer.js b/docs/structciot__serializer.js similarity index 100% rename from docs/html/structciot__serializer.js rename to docs/structciot__serializer.js diff --git a/docs/html/structciot__slip__t.html b/docs/structciot__slip__t.html similarity index 100% rename from docs/html/structciot__slip__t.html rename to docs/structciot__slip__t.html diff --git a/docs/html/structciot__slip__t.js b/docs/structciot__slip__t.js similarity index 100% rename from docs/html/structciot__slip__t.js rename to docs/structciot__slip__t.js diff --git a/docs/html/structciot__status__t.html b/docs/structciot__status__t.html similarity index 100% rename from docs/html/structciot__status__t.html rename to docs/structciot__status__t.html diff --git a/docs/html/structciot__status__t.js b/docs/structciot__status__t.js similarity index 100% rename from docs/html/structciot__status__t.js rename to docs/structciot__status__t.js diff --git a/docs/html/structciot__storage__cfg__t.html b/docs/structciot__storage__cfg__t.html similarity index 100% rename from docs/html/structciot__storage__cfg__t.html rename to docs/structciot__storage__cfg__t.html diff --git a/docs/html/structciot__storage__cfg__t.js b/docs/structciot__storage__cfg__t.js similarity index 100% rename from docs/html/structciot__storage__cfg__t.js rename to docs/structciot__storage__cfg__t.js diff --git a/docs/html/structciot__storage__req__file__data__t.html b/docs/structciot__storage__req__file__data__t.html similarity index 100% rename from docs/html/structciot__storage__req__file__data__t.html rename to docs/structciot__storage__req__file__data__t.html diff --git a/docs/html/structciot__storage__req__file__data__t.js b/docs/structciot__storage__req__file__data__t.js similarity index 100% rename from docs/html/structciot__storage__req__file__data__t.js rename to docs/structciot__storage__req__file__data__t.js diff --git a/docs/html/structciot__storage__req__t.html b/docs/structciot__storage__req__t.html similarity index 100% rename from docs/html/structciot__storage__req__t.html rename to docs/structciot__storage__req__t.html diff --git a/docs/html/structciot__storage__req__t.js b/docs/structciot__storage__req__t.js similarity index 100% rename from docs/html/structciot__storage__req__t.js rename to docs/structciot__storage__req__t.js diff --git a/docs/html/structciot__storage__status__msg__t.html b/docs/structciot__storage__status__msg__t.html similarity index 100% rename from docs/html/structciot__storage__status__msg__t.html rename to docs/structciot__storage__status__msg__t.html diff --git a/docs/html/structciot__storage__status__msg__t.js b/docs/structciot__storage__status__msg__t.js similarity index 100% rename from docs/html/structciot__storage__status__msg__t.js rename to docs/structciot__storage__status__msg__t.js diff --git a/docs/html/structciot__storage__status__t.html b/docs/structciot__storage__status__t.html similarity index 100% rename from docs/html/structciot__storage__status__t.html rename to docs/structciot__storage__status__t.html diff --git a/docs/html/structciot__storage__status__t.js b/docs/structciot__storage__status__t.js similarity index 100% rename from docs/html/structciot__storage__status__t.js rename to docs/structciot__storage__status__t.js diff --git a/docs/html/structciot__sys__cfg__t.html b/docs/structciot__sys__cfg__t.html similarity index 100% rename from docs/html/structciot__sys__cfg__t.html rename to docs/structciot__sys__cfg__t.html diff --git a/docs/html/structciot__sys__features__t.html b/docs/structciot__sys__features__t.html similarity index 100% rename from docs/html/structciot__sys__features__t.html rename to docs/structciot__sys__features__t.html diff --git a/docs/html/structciot__sys__features__t.js b/docs/structciot__sys__features__t.js similarity index 100% rename from docs/html/structciot__sys__features__t.js rename to docs/structciot__sys__features__t.js diff --git a/docs/html/structciot__sys__hw__features__t.html b/docs/structciot__sys__hw__features__t.html similarity index 100% rename from docs/html/structciot__sys__hw__features__t.html rename to docs/structciot__sys__hw__features__t.html diff --git a/docs/html/structciot__sys__hw__features__t.js b/docs/structciot__sys__hw__features__t.js similarity index 100% rename from docs/html/structciot__sys__hw__features__t.js rename to docs/structciot__sys__hw__features__t.js diff --git a/docs/html/structciot__sys__info__t.html b/docs/structciot__sys__info__t.html similarity index 100% rename from docs/html/structciot__sys__info__t.html rename to docs/structciot__sys__info__t.html diff --git a/docs/html/structciot__sys__info__t.js b/docs/structciot__sys__info__t.js similarity index 100% rename from docs/html/structciot__sys__info__t.js rename to docs/structciot__sys__info__t.js diff --git a/docs/html/structciot__sys__req__t.html b/docs/structciot__sys__req__t.html similarity index 100% rename from docs/html/structciot__sys__req__t.html rename to docs/structciot__sys__req__t.html diff --git a/docs/html/structciot__sys__req__t.js b/docs/structciot__sys__req__t.js similarity index 100% rename from docs/html/structciot__sys__req__t.js rename to docs/structciot__sys__req__t.js diff --git a/docs/html/structciot__sys__status__msg__t.html b/docs/structciot__sys__status__msg__t.html similarity index 100% rename from docs/html/structciot__sys__status__msg__t.html rename to docs/structciot__sys__status__msg__t.html diff --git a/docs/html/structciot__sys__status__msg__t.js b/docs/structciot__sys__status__msg__t.js similarity index 100% rename from docs/html/structciot__sys__status__msg__t.js rename to docs/structciot__sys__status__msg__t.js diff --git a/docs/html/structciot__sys__status__t.html b/docs/structciot__sys__status__t.html similarity index 100% rename from docs/html/structciot__sys__status__t.html rename to docs/structciot__sys__status__t.html diff --git a/docs/html/structciot__sys__status__t.js b/docs/structciot__sys__status__t.js similarity index 100% rename from docs/html/structciot__sys__status__t.js rename to docs/structciot__sys__status__t.js diff --git a/docs/html/structciot__sys__sw__features__t.html b/docs/structciot__sys__sw__features__t.html similarity index 100% rename from docs/html/structciot__sys__sw__features__t.html rename to docs/structciot__sys__sw__features__t.html diff --git a/docs/html/structciot__sys__sw__features__t.js b/docs/structciot__sys__sw__features__t.js similarity index 100% rename from docs/html/structciot__sys__sw__features__t.js rename to docs/structciot__sys__sw__features__t.js diff --git a/docs/html/structciot__tcp__cfg__t.html b/docs/structciot__tcp__cfg__t.html similarity index 100% rename from docs/html/structciot__tcp__cfg__t.html rename to docs/structciot__tcp__cfg__t.html diff --git a/docs/html/structciot__tcp__cfg__t.js b/docs/structciot__tcp__cfg__t.js similarity index 100% rename from docs/html/structciot__tcp__cfg__t.js rename to docs/structciot__tcp__cfg__t.js diff --git a/docs/html/structciot__tcp__dhcp__status__t.html b/docs/structciot__tcp__dhcp__status__t.html similarity index 100% rename from docs/html/structciot__tcp__dhcp__status__t.html rename to docs/structciot__tcp__dhcp__status__t.html diff --git a/docs/html/structciot__tcp__dhcp__status__t.js b/docs/structciot__tcp__dhcp__status__t.js similarity index 100% rename from docs/html/structciot__tcp__dhcp__status__t.js rename to docs/structciot__tcp__dhcp__status__t.js diff --git a/docs/html/structciot__tcp__handle.html b/docs/structciot__tcp__handle.html similarity index 100% rename from docs/html/structciot__tcp__handle.html rename to docs/structciot__tcp__handle.html diff --git a/docs/html/structciot__tcp__handle.js b/docs/structciot__tcp__handle.js similarity index 100% rename from docs/html/structciot__tcp__handle.js rename to docs/structciot__tcp__handle.js diff --git a/docs/html/structciot__tcp__info__t.html b/docs/structciot__tcp__info__t.html similarity index 100% rename from docs/html/structciot__tcp__info__t.html rename to docs/structciot__tcp__info__t.html diff --git a/docs/html/structciot__tcp__info__t.js b/docs/structciot__tcp__info__t.js similarity index 100% rename from docs/html/structciot__tcp__info__t.js rename to docs/structciot__tcp__info__t.js diff --git a/docs/html/structciot__tcp__req__t.html b/docs/structciot__tcp__req__t.html similarity index 100% rename from docs/html/structciot__tcp__req__t.html rename to docs/structciot__tcp__req__t.html diff --git a/docs/html/structciot__tcp__req__t.js b/docs/structciot__tcp__req__t.js similarity index 100% rename from docs/html/structciot__tcp__req__t.js rename to docs/structciot__tcp__req__t.js diff --git a/docs/html/structciot__tcp__status__msg__t.html b/docs/structciot__tcp__status__msg__t.html similarity index 100% rename from docs/html/structciot__tcp__status__msg__t.html rename to docs/structciot__tcp__status__msg__t.html diff --git a/docs/html/structciot__tcp__status__msg__t.js b/docs/structciot__tcp__status__msg__t.js similarity index 100% rename from docs/html/structciot__tcp__status__msg__t.js rename to docs/structciot__tcp__status__msg__t.js diff --git a/docs/html/structciot__tcp__status__t.html b/docs/structciot__tcp__status__t.html similarity index 100% rename from docs/html/structciot__tcp__status__t.html rename to docs/structciot__tcp__status__t.html diff --git a/docs/html/structciot__tcp__status__t.js b/docs/structciot__tcp__status__t.js similarity index 100% rename from docs/html/structciot__tcp__status__t.js rename to docs/structciot__tcp__status__t.js diff --git a/docs/html/structciot__timer__cfg.html b/docs/structciot__timer__cfg.html similarity index 100% rename from docs/html/structciot__timer__cfg.html rename to docs/structciot__timer__cfg.html diff --git a/docs/html/structciot__timer__cfg.js b/docs/structciot__timer__cfg.js similarity index 100% rename from docs/html/structciot__timer__cfg.js rename to docs/structciot__timer__cfg.js diff --git a/docs/html/structciot__uart__base.html b/docs/structciot__uart__base.html similarity index 100% rename from docs/html/structciot__uart__base.html rename to docs/structciot__uart__base.html diff --git a/docs/html/structciot__uart__base.js b/docs/structciot__uart__base.js similarity index 100% rename from docs/html/structciot__uart__base.js rename to docs/structciot__uart__base.js diff --git a/docs/html/structciot__uart__cfg__t.html b/docs/structciot__uart__cfg__t.html similarity index 100% rename from docs/html/structciot__uart__cfg__t.html rename to docs/structciot__uart__cfg__t.html diff --git a/docs/html/structciot__uart__cfg__t.js b/docs/structciot__uart__cfg__t.js similarity index 100% rename from docs/html/structciot__uart__cfg__t.js rename to docs/structciot__uart__cfg__t.js diff --git a/docs/html/structciot__uart__req__send__data__t.html b/docs/structciot__uart__req__send__data__t.html similarity index 100% rename from docs/html/structciot__uart__req__send__data__t.html rename to docs/structciot__uart__req__send__data__t.html diff --git a/docs/html/structciot__uart__req__send__data__t.js b/docs/structciot__uart__req__send__data__t.js similarity index 100% rename from docs/html/structciot__uart__req__send__data__t.js rename to docs/structciot__uart__req__send__data__t.js diff --git a/docs/html/structciot__uart__req__t.html b/docs/structciot__uart__req__t.html similarity index 100% rename from docs/html/structciot__uart__req__t.html rename to docs/structciot__uart__req__t.html diff --git a/docs/html/structciot__uart__req__t.js b/docs/structciot__uart__req__t.js similarity index 100% rename from docs/html/structciot__uart__req__t.js rename to docs/structciot__uart__req__t.js diff --git a/docs/html/structciot__uart__status__msg__t.html b/docs/structciot__uart__status__msg__t.html similarity index 100% rename from docs/html/structciot__uart__status__msg__t.html rename to docs/structciot__uart__status__msg__t.html diff --git a/docs/html/structciot__uart__status__msg__t.js b/docs/structciot__uart__status__msg__t.js similarity index 100% rename from docs/html/structciot__uart__status__msg__t.js rename to docs/structciot__uart__status__msg__t.js diff --git a/docs/html/structciot__uart__status__t.html b/docs/structciot__uart__status__t.html similarity index 100% rename from docs/html/structciot__uart__status__t.html rename to docs/structciot__uart__status__t.html diff --git a/docs/html/structciot__uart__status__t.js b/docs/structciot__uart__status__t.js similarity index 100% rename from docs/html/structciot__uart__status__t.js rename to docs/structciot__uart__status__t.js diff --git a/docs/html/structciot__usb__cfg__t.html b/docs/structciot__usb__cfg__t.html similarity index 100% rename from docs/html/structciot__usb__cfg__t.html rename to docs/structciot__usb__cfg__t.html diff --git a/docs/html/structciot__usb__cfg__t.js b/docs/structciot__usb__cfg__t.js similarity index 100% rename from docs/html/structciot__usb__cfg__t.js rename to docs/structciot__usb__cfg__t.js diff --git a/docs/html/structciot__usb__req__t.html b/docs/structciot__usb__req__t.html similarity index 100% rename from docs/html/structciot__usb__req__t.html rename to docs/structciot__usb__req__t.html diff --git a/docs/html/structciot__usb__req__t.js b/docs/structciot__usb__req__t.js similarity index 100% rename from docs/html/structciot__usb__req__t.js rename to docs/structciot__usb__req__t.js diff --git a/docs/html/structciot__usb__status__msg__t.html b/docs/structciot__usb__status__msg__t.html similarity index 100% rename from docs/html/structciot__usb__status__msg__t.html rename to docs/structciot__usb__status__msg__t.html diff --git a/docs/html/structciot__usb__status__msg__t.js b/docs/structciot__usb__status__msg__t.js similarity index 100% rename from docs/html/structciot__usb__status__msg__t.js rename to docs/structciot__usb__status__msg__t.js diff --git a/docs/html/structciot__usb__status__t.html b/docs/structciot__usb__status__t.html similarity index 100% rename from docs/html/structciot__usb__status__t.html rename to docs/structciot__usb__status__t.html diff --git a/docs/html/structciot__usb__status__t.js b/docs/structciot__usb__status__t.js similarity index 100% rename from docs/html/structciot__usb__status__t.js rename to docs/structciot__usb__status__t.js diff --git a/docs/html/structciot__wifi__ap__info__t.html b/docs/structciot__wifi__ap__info__t.html similarity index 100% rename from docs/html/structciot__wifi__ap__info__t.html rename to docs/structciot__wifi__ap__info__t.html diff --git a/docs/html/structciot__wifi__ap__info__t.js b/docs/structciot__wifi__ap__info__t.js similarity index 100% rename from docs/html/structciot__wifi__ap__info__t.js rename to docs/structciot__wifi__ap__info__t.js diff --git a/docs/html/structciot__wifi__cfg__t.html b/docs/structciot__wifi__cfg__t.html similarity index 100% rename from docs/html/structciot__wifi__cfg__t.html rename to docs/structciot__wifi__cfg__t.html diff --git a/docs/html/structciot__wifi__cfg__t.js b/docs/structciot__wifi__cfg__t.js similarity index 100% rename from docs/html/structciot__wifi__cfg__t.js rename to docs/structciot__wifi__cfg__t.js diff --git a/docs/html/structciot__wifi__req__t.html b/docs/structciot__wifi__req__t.html similarity index 100% rename from docs/html/structciot__wifi__req__t.html rename to docs/structciot__wifi__req__t.html diff --git a/docs/html/structciot__wifi__req__t.js b/docs/structciot__wifi__req__t.js similarity index 100% rename from docs/html/structciot__wifi__req__t.js rename to docs/structciot__wifi__req__t.js diff --git a/docs/html/structciot__wifi__scan__result__t.html b/docs/structciot__wifi__scan__result__t.html similarity index 100% rename from docs/html/structciot__wifi__scan__result__t.html rename to docs/structciot__wifi__scan__result__t.html diff --git a/docs/html/structciot__wifi__scan__result__t.js b/docs/structciot__wifi__scan__result__t.js similarity index 100% rename from docs/html/structciot__wifi__scan__result__t.js rename to docs/structciot__wifi__scan__result__t.js diff --git a/docs/html/structciot__wifi__status__msg__t.html b/docs/structciot__wifi__status__msg__t.html similarity index 100% rename from docs/html/structciot__wifi__status__msg__t.html rename to docs/structciot__wifi__status__msg__t.html diff --git a/docs/html/structciot__wifi__status__msg__t.js b/docs/structciot__wifi__status__msg__t.js similarity index 100% rename from docs/html/structciot__wifi__status__msg__t.js rename to docs/structciot__wifi__status__msg__t.js diff --git a/docs/html/structciot__wifi__status__t.html b/docs/structciot__wifi__status__t.html similarity index 100% rename from docs/html/structciot__wifi__status__t.html rename to docs/structciot__wifi__status__t.html diff --git a/docs/html/structciot__wifi__status__t.js b/docs/structciot__wifi__status__t.js similarity index 100% rename from docs/html/structciot__wifi__status__t.js rename to docs/structciot__wifi__status__t.js diff --git a/docs/html/sync_off.png b/docs/sync_off.png similarity index 100% rename from docs/html/sync_off.png rename to docs/sync_off.png diff --git a/docs/html/sync_on.png b/docs/sync_on.png similarity index 100% rename from docs/html/sync_on.png rename to docs/sync_on.png diff --git a/docs/html/tab_a.png b/docs/tab_a.png similarity index 100% rename from docs/html/tab_a.png rename to docs/tab_a.png diff --git a/docs/html/tab_ad.png b/docs/tab_ad.png similarity index 100% rename from docs/html/tab_ad.png rename to docs/tab_ad.png diff --git a/docs/html/tab_b.png b/docs/tab_b.png similarity index 100% rename from docs/html/tab_b.png rename to docs/tab_b.png diff --git a/docs/html/tab_bd.png b/docs/tab_bd.png similarity index 100% rename from docs/html/tab_bd.png rename to docs/tab_bd.png diff --git a/docs/html/tab_h.png b/docs/tab_h.png similarity index 100% rename from docs/html/tab_h.png rename to docs/tab_h.png diff --git a/docs/html/tab_hd.png b/docs/tab_hd.png similarity index 100% rename from docs/html/tab_hd.png rename to docs/tab_hd.png diff --git a/docs/html/tab_s.png b/docs/tab_s.png similarity index 100% rename from docs/html/tab_s.png rename to docs/tab_s.png diff --git a/docs/html/tab_sd.png b/docs/tab_sd.png similarity index 100% rename from docs/html/tab_sd.png rename to docs/tab_sd.png diff --git a/docs/html/tabs.css b/docs/tabs.css similarity index 100% rename from docs/html/tabs.css rename to docs/tabs.css diff --git a/docs/html/topics.html b/docs/topics.html similarity index 100% rename from docs/html/topics.html rename to docs/topics.html diff --git a/docs/html/topics.js b/docs/topics.js similarity index 100% rename from docs/html/topics.js rename to docs/topics.js diff --git a/docs/html/unionciot__ble__data__u.html b/docs/unionciot__ble__data__u.html similarity index 100% rename from docs/html/unionciot__ble__data__u.html rename to docs/unionciot__ble__data__u.html diff --git a/docs/html/unionciot__ble__data__u.js b/docs/unionciot__ble__data__u.js similarity index 100% rename from docs/html/unionciot__ble__data__u.js rename to docs/unionciot__ble__data__u.js diff --git a/docs/html/unionciot__ble__req__data__u.html b/docs/unionciot__ble__req__data__u.html similarity index 100% rename from docs/html/unionciot__ble__req__data__u.html rename to docs/unionciot__ble__req__data__u.html diff --git a/docs/html/unionciot__ble__req__data__u.js b/docs/unionciot__ble__req__data__u.js similarity index 100% rename from docs/html/unionciot__ble__req__data__u.js rename to docs/unionciot__ble__req__data__u.js diff --git a/docs/html/unionciot__ble__scn__data__u.html b/docs/unionciot__ble__scn__data__u.html similarity index 100% rename from docs/html/unionciot__ble__scn__data__u.html rename to docs/unionciot__ble__scn__data__u.html diff --git a/docs/html/unionciot__ble__scn__data__u.js b/docs/unionciot__ble__scn__data__u.js similarity index 100% rename from docs/html/unionciot__ble__scn__data__u.js rename to docs/unionciot__ble__scn__data__u.js diff --git a/docs/html/unionciot__ble__scn__req__data__u.html b/docs/unionciot__ble__scn__req__data__u.html similarity index 100% rename from docs/html/unionciot__ble__scn__req__data__u.html rename to docs/unionciot__ble__scn__req__data__u.html diff --git a/docs/html/unionciot__bridge__data__u.html b/docs/unionciot__bridge__data__u.html similarity index 100% rename from docs/html/unionciot__bridge__data__u.html rename to docs/unionciot__bridge__data__u.html diff --git a/docs/html/unionciot__bridge__data__u.js b/docs/unionciot__bridge__data__u.js similarity index 100% rename from docs/html/unionciot__bridge__data__u.js rename to docs/unionciot__bridge__data__u.js diff --git a/docs/html/unionciot__bridge__req__data__u.html b/docs/unionciot__bridge__req__data__u.html similarity index 100% rename from docs/html/unionciot__bridge__req__data__u.html rename to docs/unionciot__bridge__req__data__u.html diff --git a/docs/html/unionciot__data__model__data__u.html b/docs/unionciot__data__model__data__u.html similarity index 100% rename from docs/html/unionciot__data__model__data__u.html rename to docs/unionciot__data__model__data__u.html diff --git a/docs/html/unionciot__data__model__data__u.js b/docs/unionciot__data__model__data__u.js similarity index 100% rename from docs/html/unionciot__data__model__data__u.js rename to docs/unionciot__data__model__data__u.js diff --git a/docs/html/unionciot__data__model__req__data__u.html b/docs/unionciot__data__model__req__data__u.html similarity index 100% rename from docs/html/unionciot__data__model__req__data__u.html rename to docs/unionciot__data__model__req__data__u.html diff --git a/docs/html/unionciot__data__u.html b/docs/unionciot__data__u.html similarity index 100% rename from docs/html/unionciot__data__u.html rename to docs/unionciot__data__u.html diff --git a/docs/html/unionciot__data__u.js b/docs/unionciot__data__u.js similarity index 100% rename from docs/html/unionciot__data__u.js rename to docs/unionciot__data__u.js diff --git a/docs/html/unionciot__dfu__data__u.html b/docs/unionciot__dfu__data__u.html similarity index 100% rename from docs/html/unionciot__dfu__data__u.html rename to docs/unionciot__dfu__data__u.html diff --git a/docs/html/unionciot__dfu__data__u.js b/docs/unionciot__dfu__data__u.js similarity index 100% rename from docs/html/unionciot__dfu__data__u.js rename to docs/unionciot__dfu__data__u.js diff --git a/docs/html/unionciot__dfu__req__data__u.html b/docs/unionciot__dfu__req__data__u.html similarity index 100% rename from docs/html/unionciot__dfu__req__data__u.html rename to docs/unionciot__dfu__req__data__u.html diff --git a/docs/html/unionciot__gpio__data__u.html b/docs/unionciot__gpio__data__u.html similarity index 100% rename from docs/html/unionciot__gpio__data__u.html rename to docs/unionciot__gpio__data__u.html diff --git a/docs/html/unionciot__gpio__data__u.js b/docs/unionciot__gpio__data__u.js similarity index 100% rename from docs/html/unionciot__gpio__data__u.js rename to docs/unionciot__gpio__data__u.js diff --git a/docs/html/unionciot__gpio__req__data__u.html b/docs/unionciot__gpio__req__data__u.html similarity index 100% rename from docs/html/unionciot__gpio__req__data__u.html rename to docs/unionciot__gpio__req__data__u.html diff --git a/docs/html/unionciot__gpio__req__data__u.js b/docs/unionciot__gpio__req__data__u.js similarity index 100% rename from docs/html/unionciot__gpio__req__data__u.js rename to docs/unionciot__gpio__req__data__u.js diff --git a/docs/html/unionciot__httpc__data__u.html b/docs/unionciot__httpc__data__u.html similarity index 100% rename from docs/html/unionciot__httpc__data__u.html rename to docs/unionciot__httpc__data__u.html diff --git a/docs/html/unionciot__httpc__data__u.js b/docs/unionciot__httpc__data__u.js similarity index 100% rename from docs/html/unionciot__httpc__data__u.js rename to docs/unionciot__httpc__data__u.js diff --git a/docs/html/unionciot__httpc__event.html b/docs/unionciot__httpc__event.html similarity index 100% rename from docs/html/unionciot__httpc__event.html rename to docs/unionciot__httpc__event.html diff --git a/docs/html/unionciot__httpc__event.js b/docs/unionciot__httpc__event.js similarity index 100% rename from docs/html/unionciot__httpc__event.js rename to docs/unionciot__httpc__event.js diff --git a/docs/html/unionciot__httpc__req__data.html b/docs/unionciot__httpc__req__data.html similarity index 100% rename from docs/html/unionciot__httpc__req__data.html rename to docs/unionciot__httpc__req__data.html diff --git a/docs/html/unionciot__httpc__req__data.js b/docs/unionciot__httpc__req__data.js similarity index 100% rename from docs/html/unionciot__httpc__req__data.js rename to docs/unionciot__httpc__req__data.js diff --git a/docs/html/unionciot__https__data__u.html b/docs/unionciot__https__data__u.html similarity index 100% rename from docs/html/unionciot__https__data__u.html rename to docs/unionciot__https__data__u.html diff --git a/docs/html/unionciot__https__data__u.js b/docs/unionciot__https__data__u.js similarity index 100% rename from docs/html/unionciot__https__data__u.js rename to docs/unionciot__https__data__u.js diff --git a/docs/html/unionciot__https__req__data__u.html b/docs/unionciot__https__req__data__u.html similarity index 100% rename from docs/html/unionciot__https__req__data__u.html rename to docs/unionciot__https__req__data__u.html diff --git a/docs/html/unionciot__iface__event__data__u.html b/docs/unionciot__iface__event__data__u.html similarity index 100% rename from docs/html/unionciot__iface__event__data__u.html rename to docs/unionciot__iface__event__data__u.html diff --git a/docs/html/unionciot__iface__event__data__u.js b/docs/unionciot__iface__event__data__u.js similarity index 100% rename from docs/html/unionciot__iface__event__data__u.js rename to docs/unionciot__iface__event__data__u.js diff --git a/docs/html/unionciot__mqttc__data__u.html b/docs/unionciot__mqttc__data__u.html similarity index 100% rename from docs/html/unionciot__mqttc__data__u.html rename to docs/unionciot__mqttc__data__u.html diff --git a/docs/html/unionciot__mqttc__data__u.js b/docs/unionciot__mqttc__data__u.js similarity index 100% rename from docs/html/unionciot__mqttc__data__u.js rename to docs/unionciot__mqttc__data__u.js diff --git a/docs/html/unionciot__mqttc__req__data__u.html b/docs/unionciot__mqttc__req__data__u.html similarity index 100% rename from docs/html/unionciot__mqttc__req__data__u.html rename to docs/unionciot__mqttc__req__data__u.html diff --git a/docs/html/unionciot__mqttc__req__data__u.js b/docs/unionciot__mqttc__req__data__u.js similarity index 100% rename from docs/html/unionciot__mqttc__req__data__u.js rename to docs/unionciot__mqttc__req__data__u.js diff --git a/docs/html/unionciot__msg__data__u.html b/docs/unionciot__msg__data__u.html similarity index 100% rename from docs/html/unionciot__msg__data__u.html rename to docs/unionciot__msg__data__u.html diff --git a/docs/html/unionciot__msg__data__u.js b/docs/unionciot__msg__data__u.js similarity index 100% rename from docs/html/unionciot__msg__data__u.js rename to docs/unionciot__msg__data__u.js diff --git a/docs/html/unionciot__ntp__data__u.html b/docs/unionciot__ntp__data__u.html similarity index 100% rename from docs/html/unionciot__ntp__data__u.html rename to docs/unionciot__ntp__data__u.html diff --git a/docs/html/unionciot__ntp__data__u.js b/docs/unionciot__ntp__data__u.js similarity index 100% rename from docs/html/unionciot__ntp__data__u.js rename to docs/unionciot__ntp__data__u.js diff --git a/docs/html/unionciot__ntp__req__data__u.html b/docs/unionciot__ntp__req__data__u.html similarity index 100% rename from docs/html/unionciot__ntp__req__data__u.html rename to docs/unionciot__ntp__req__data__u.html diff --git a/docs/html/unionciot__opcuas__data__u.html b/docs/unionciot__opcuas__data__u.html similarity index 100% rename from docs/html/unionciot__opcuas__data__u.html rename to docs/unionciot__opcuas__data__u.html diff --git a/docs/html/unionciot__opcuas__data__u.js b/docs/unionciot__opcuas__data__u.js similarity index 100% rename from docs/html/unionciot__opcuas__data__u.js rename to docs/unionciot__opcuas__data__u.js diff --git a/docs/html/unionciot__opcuas__req__data__u.html b/docs/unionciot__opcuas__req__data__u.html similarity index 100% rename from docs/html/unionciot__opcuas__req__data__u.html rename to docs/unionciot__opcuas__req__data__u.html diff --git a/docs/html/unionciot__opcuas__req__data__u.js b/docs/unionciot__opcuas__req__data__u.js similarity index 100% rename from docs/html/unionciot__opcuas__req__data__u.js rename to docs/unionciot__opcuas__req__data__u.js diff --git a/docs/html/unionciot__ota__data__u.html b/docs/unionciot__ota__data__u.html similarity index 100% rename from docs/html/unionciot__ota__data__u.html rename to docs/unionciot__ota__data__u.html diff --git a/docs/html/unionciot__ota__data__u.js b/docs/unionciot__ota__data__u.js similarity index 100% rename from docs/html/unionciot__ota__data__u.js rename to docs/unionciot__ota__data__u.js diff --git a/docs/html/unionciot__ota__req__data__u.html b/docs/unionciot__ota__req__data__u.html similarity index 100% rename from docs/html/unionciot__ota__req__data__u.html rename to docs/unionciot__ota__req__data__u.html diff --git a/docs/html/unionciot__req__data__u.html b/docs/unionciot__req__data__u.html similarity index 100% rename from docs/html/unionciot__req__data__u.html rename to docs/unionciot__req__data__u.html diff --git a/docs/html/unionciot__req__data__u.js b/docs/unionciot__req__data__u.js similarity index 100% rename from docs/html/unionciot__req__data__u.js rename to docs/unionciot__req__data__u.js diff --git a/docs/html/unionciot__storage__data__u.html b/docs/unionciot__storage__data__u.html similarity index 100% rename from docs/html/unionciot__storage__data__u.html rename to docs/unionciot__storage__data__u.html diff --git a/docs/html/unionciot__storage__data__u.js b/docs/unionciot__storage__data__u.js similarity index 100% rename from docs/html/unionciot__storage__data__u.js rename to docs/unionciot__storage__data__u.js diff --git a/docs/html/unionciot__sys__data__u.html b/docs/unionciot__sys__data__u.html similarity index 100% rename from docs/html/unionciot__sys__data__u.html rename to docs/unionciot__sys__data__u.html diff --git a/docs/html/unionciot__sys__data__u.js b/docs/unionciot__sys__data__u.js similarity index 100% rename from docs/html/unionciot__sys__data__u.js rename to docs/unionciot__sys__data__u.js diff --git a/docs/html/unionciot__sys__req__data__u.html b/docs/unionciot__sys__req__data__u.html similarity index 100% rename from docs/html/unionciot__sys__req__data__u.html rename to docs/unionciot__sys__req__data__u.html diff --git a/docs/html/unionciot__tcp__data__u.html b/docs/unionciot__tcp__data__u.html similarity index 100% rename from docs/html/unionciot__tcp__data__u.html rename to docs/unionciot__tcp__data__u.html diff --git a/docs/html/unionciot__tcp__data__u.js b/docs/unionciot__tcp__data__u.js similarity index 100% rename from docs/html/unionciot__tcp__data__u.js rename to docs/unionciot__tcp__data__u.js diff --git a/docs/html/unionciot__tcp__req__data__u.html b/docs/unionciot__tcp__req__data__u.html similarity index 100% rename from docs/html/unionciot__tcp__req__data__u.html rename to docs/unionciot__tcp__req__data__u.html diff --git a/docs/html/unionciot__uart__data__u.html b/docs/unionciot__uart__data__u.html similarity index 100% rename from docs/html/unionciot__uart__data__u.html rename to docs/unionciot__uart__data__u.html diff --git a/docs/html/unionciot__uart__data__u.js b/docs/unionciot__uart__data__u.js similarity index 100% rename from docs/html/unionciot__uart__data__u.js rename to docs/unionciot__uart__data__u.js diff --git a/docs/html/unionciot__uart__event.html b/docs/unionciot__uart__event.html similarity index 100% rename from docs/html/unionciot__uart__event.html rename to docs/unionciot__uart__event.html diff --git a/docs/html/unionciot__uart__event.js b/docs/unionciot__uart__event.js similarity index 100% rename from docs/html/unionciot__uart__event.js rename to docs/unionciot__uart__event.js diff --git a/docs/html/unionciot__uart__req__data__u.html b/docs/unionciot__uart__req__data__u.html similarity index 100% rename from docs/html/unionciot__uart__req__data__u.html rename to docs/unionciot__uart__req__data__u.html diff --git a/docs/html/unionciot__uart__req__data__u.js b/docs/unionciot__uart__req__data__u.js similarity index 100% rename from docs/html/unionciot__uart__req__data__u.js rename to docs/unionciot__uart__req__data__u.js diff --git a/docs/html/unionciot__usb__data__u.html b/docs/unionciot__usb__data__u.html similarity index 100% rename from docs/html/unionciot__usb__data__u.html rename to docs/unionciot__usb__data__u.html diff --git a/docs/html/unionciot__usb__data__u.js b/docs/unionciot__usb__data__u.js similarity index 100% rename from docs/html/unionciot__usb__data__u.js rename to docs/unionciot__usb__data__u.js diff --git a/docs/html/unionciot__usb__event.html b/docs/unionciot__usb__event.html similarity index 100% rename from docs/html/unionciot__usb__event.html rename to docs/unionciot__usb__event.html diff --git a/docs/html/unionciot__usb__event.js b/docs/unionciot__usb__event.js similarity index 100% rename from docs/html/unionciot__usb__event.js rename to docs/unionciot__usb__event.js diff --git a/docs/html/unionciot__usb__req__data__u.html b/docs/unionciot__usb__req__data__u.html similarity index 100% rename from docs/html/unionciot__usb__req__data__u.html rename to docs/unionciot__usb__req__data__u.html diff --git a/docs/html/unionciot__wifi__data__u.html b/docs/unionciot__wifi__data__u.html similarity index 100% rename from docs/html/unionciot__wifi__data__u.html rename to docs/unionciot__wifi__data__u.html diff --git a/docs/html/unionciot__wifi__data__u.js b/docs/unionciot__wifi__data__u.js similarity index 100% rename from docs/html/unionciot__wifi__data__u.js rename to docs/unionciot__wifi__data__u.js diff --git a/docs/html/unionciot__wifi__req__data__u.html b/docs/unionciot__wifi__req__data__u.html similarity index 100% rename from docs/html/unionciot__wifi__req__data__u.html rename to docs/unionciot__wifi__req__data__u.html diff --git a/docs/html/unionciot__wifi__req__data__u.js b/docs/unionciot__wifi__req__data__u.js similarity index 100% rename from docs/html/unionciot__wifi__req__data__u.js rename to docs/unionciot__wifi__req__data__u.js