diff --git a/Doxyfile b/Doxyfile index 31bf226..4949596 100644 --- a/Doxyfile +++ b/Doxyfile @@ -74,7 +74,7 @@ PROJECT_ICON = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = F:/projects/hedrosistemas/ciot_c/doc +OUTPUT_DIRECTORY = F:/projects/hedrosistemas/ciot_c/docs # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format @@ -1338,7 +1338,7 @@ GENERATE_HTML = YES # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = html +HTML_OUTPUT = ../docs # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). @@ -1996,7 +1996,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/docs/_r_e_a_d_m_e_8md.html b/docs/_r_e_a_d_m_e_8md.html new file mode 100644 index 0000000..2ab8cd8 --- /dev/null +++ b/docs/_r_e_a_d_m_e_8md.html @@ -0,0 +1,108 @@ + + +
+ + + + +
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
Macro to print an error message if an operation fails.
Macro to check for a null pointer and return an error if found.
CioT library header file. More...
-#include "types/ciot_ble_types.h"
#include "ciot.h"
#include "ciot_iface.h"
#include "ciot_err.h"
#include "ciot_log.h"
#include "types/ciot_ble_types.h"
#include "types/ciot_ble_scn_types.h"
#include "types/ciot_tcp_types.h"
#include "types/ciot_gpio_types.h"
#include "ciot_opcuas.h"
#include "ciot_ota.h"
#include "ciot_sys.h"
#include "ciot_s.h"
#include "ciot_serializer.h"
#include "ciot_timer.h"
#include "ciot_utils.h"
Go to the source code of this file.
Macro to log hexadecimal data.
@@ -399,7 +399,7 @@Macro to log error level messages.
@@ -437,7 +437,7 @@Macro to log info level messages.
@@ -475,7 +475,7 @@Macro to log verbose level messages.
@@ -513,7 +513,7 @@Macro to log warning level messages.
diff --git a/docs/ciot__log_8h_source.html b/docs/ciot__log_8h_source.html index 4f0387a..4f42767 100644 --- a/docs/ciot__log_8h_source.html +++ b/docs/ciot__log_8h_source.html @@ -101,166 +101,166 @@
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
The core of CIoT library. +More...
++Files | |
file | ciot_err.h |
Header file for CIOT error handling. | |
file | ciot_iface.h |
Header file for the CIOT interface. | |
file | ciot_log.h |
Header file for CIOT logging functionality. | |
The core of CIoT library.
+Interfaces that implements hardware resources. +
Interfaces that represents a hardware abstraction. More...
@@ -132,7 +132,7 @@
| |
Interfaces that implements hardware resources.
+Interfaces that represents a hardware abstraction.
Types definitions of hardware resources. +
Types related to hardware abstraction interfaces. More...
@@ -129,7 +129,7 @@
| |
Types definitions of hardware resources.
+Types related to hardware abstraction interfaces.
Interfaces that implements software resources. +
Interfaces that represents a software abstraction. More...
@@ -129,7 +129,7 @@
| |
Interfaces that implements software resources.
+Interfaces that represents a software abstraction.
Types definitions of software resources. +
Types related to software abstraction interfaces. More...
@@ -132,7 +132,7 @@
| |
Types definitions of software resources.
+Types related to software abstraction interfaces.
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
Auxilliary implementations like encoding/decoding, serialization/deserialization, conversions, math operations, etc. +More...
++Files | |
file | ciot_s.h |
Header file for CIOT_S (Communication Interface Over Transport) module. | |
file | ciot_serializer.h |
Header file for CIOT Serializer module. | |
file | ciot_timer.h |
Header file for CIOT timer module. | |
Auxilliary implementations like encoding/decoding, serialization/deserialization, conversions, math operations, etc.
+This is the documentation for Connected IoT (CIOT). CIoT is a library created to facilitate the implementation of IoT devices. This document describes how to use CIoT APIs. This library is based on interfaces implementations. Each interface have it own tyes. CIoT implementations are divided in four topics:
Each interface implementation follow an general common abstraction defined by the CIoT Core. An interface header file must implement the following methods:
This software is under development. Use at your own risk.
- Mingw32 for Windows +- ESP IDF for Espressif devices +- nRF5 SDK 17 for Nordic devices +
Create a more detailed version of this documentation
+Implement ciot_mbus interface
+Implement ciot_opcuas interface
+Implement ciot_opcuac interface
+Implement unit tests
+Create GHA to generate TAGs and Releases
+
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
Definition of class Template. +More...
+ +Go to the source code of this file.
+Definition of class Template.
+
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
Todo List |
+ CioT 0.1.0
+
+ Connected IoT
+ |
+
Create a more detailed version of this documentation
+ +Implement ciot_mbus interface
+ +Implement ciot_opcuas interface
+ +Implement ciot_opcuac interface
+ +Implement unit tests
+ +Create GHA to generate TAGs and Releases
+Hardware_types | Types definitions of hardware resources |
Hardware_interfaces | Interfaces that implements hardware resources |
Software_types | Types definitions of software resources |
Software_interfaces | Interfaces that implements software resources |
Core | The core of CIoT library |
Hardware_types | Types related to hardware abstraction interfaces |
Hardware_interfaces | Interfaces that represents a hardware abstraction |
Software_types | Types related to software abstraction interfaces |
Software_interfaces | Interfaces that represents a software abstraction |
Utils | Auxilliary implementations like encoding/decoding, serialization/deserialization, conversions, math operations, etc |
Each interface implementation follow an general common abstraction defined by the CIoT Core. An interface header file must implement the following methods: +* - ciot_iface_new(handle): Create a new interface instance +* - ciot_iface_start(self, cfg): Start the interface using the specified configuration +* - ciot_iface_stop(self): Stop the interface +* - ciot_iface_process_req(self, req): Use the interface to process an external request +* - ciot_iface_send_data(self, data, size): User the interface to send data +*