- Primeros pasos
1.1 Herramientas a usar
1.2 Configuraciones generales del proyecto - Estructura del proyecto
- API REST
- ArduinoJson
- Referencias
-
Arduino
-
Instalar Las Librerías De esp8266 en arduino
📄 NOTA: Si falta alguna librería tanto el Visual Code como el IDE de Arduino les imprimirá por pantalla el error y tendrían que instalar desde el manejador del Arduino IDE
-
-
Visual Code
-
Instalar Y Configurar Las Extensiones
- Instalar las siguientes extensiones dentro del Visual Code (👀Tutorial)
- Arduino
- C/C++
- Ir a la ruta para configurar la extensión de arduino
- Barra de opciones (parte superior): Archivo => Preferencias => Settings (Configuración)
- En la barra de búsqueda escribir: Arduino
- En Arduino: Path (Scroll para abajo)
- Copiar la ruta por default del Arduino (C:\Program Files (x86)\Arduino)
- Presionar F1 dentro del Visual Code para mostrar en la parte superior un menú de opciones
- Escribir Arduino en el menú que aparece en la parte de arriba (> Arduino)
- Observar que estén los comandos del Arduino (Arduino: Upload, Arduino: Verify, Arduino: Examples)
- Instalar las siguientes extensiones dentro del Visual Code (👀Tutorial)
-
Configuración De La Extensión "ARduino"
Se debe de generar el archivo de configuración de la extensión de Arduino en el Visual Code (c_cpp_properties.json).
- Aplastar F1 dentro del Visual Code
- Escribir "Arduino" en el menú que aparece en la parte de arriba (>)
- Seleccionar la opción que dice: "Arduino: Examples"
- Se les abrirá una nueva pestaña den
- Abrir la carpeta dedicado a NodeMCU o ESP8266
- Abrir cualquier ejemplo, y se les abrirá una nueva ventana.
- Copiar el archivo "c_cpp_properties.json" dentro del ./vscode del ejemplo, a la misma carpeta del proyecto.
📄 NOTA: El archivo c_cpp_properties.json, debe de tener una configuración parecida al siguiente formato.
{ "configurations": [ { "name": "Win32", "defines": ["ARDUINO=10800"], "includePath": [ "${workspaceRoot}", "C:\\Users\\camog\\AppData\\Local\\Arduino15\\packages\\esp8266\\hardware\\esp8266\\2.7.4\\**", "C:\\Users\\camog\\AppData\\Local\\Arduino15\\packages\\esp8266\\tools\\**", "C:\\Program Files (x86)\\Arduino\\hardware\\tools\\**", "C:\\Program Files (x86)\\Arduino\\libraries\\**", "C:\\Documents\\Arduino\\hardware\\tools\\**", "C:\\Documents\\Arduino\\libraries\\**" ], "forcedInclude": [], "intelliSenseMode": "clang-x64", "cStandard": "c11", "cppStandard": "c++17", "compilerPath": "/usr/bin/gcc" } ], "version": 4 } -
Agregar Las Variables De Entorno La variables de entorno son aquellas que deberían ser ocultas para las demás personas, como ejemplo tenemos: La configuración de la red de un hogar para realizar pruebas
- Copiar el archivo llamado: env.example.h
- Renombrarlo a: .env
- Editar las variables acorde a sus preferencias.
- Ejemplos usando ESP8266👀
-
📄 arduino.ino........................ℹ **Archivo principal del proyecto**
📄 env.h..............................ℹ Variables de entorno
📂 config/............................ℹ Todas las configuraciones
|-- 📄 lcd-config.hpp
|-- 📄 wifi-config
📂 Infraestructure/
|--📂 bd/............................ℹ Contiene a la base de datos a usar
|--+-- 📄 sd-card.repository.hpp......ℹ Funciones básicas de una SD. (Leer, escribir, borrar, mostrar directorios y archivos, etc)
|--📂 server/
|--+-- 📄 Server.hpp.....................ℹ Servidor Web
📂 adapter/............................ℹ Adaptador de interfaz.
|-- 📄 router.hpp.....................ℹ Reglas o políticas que permite el API REST para comunicarse con el cliente.
📂 api/
|-- 📂 utils..........................ℹ utilidades usadas en todo el proyecto)
|--+-- 📄 api.utils.hpp...............ℹ Funciones para manejar partes del api
|--+-- 📄 json.utils.hpp
|--+-- 📄 time.utils.hpp
|-- 📂 components/
|--+-- 📂 device/.....................ℹ Activa el dispositivo para una acción específica
|--+--+-- 📂 2.adapter/
|--+--+--+-- 📄 controller.hpp........ℹ Recibe las peticiones del cliente, las procesa y devuelve una respuesta
|--+--+-- 📂 3.use-case/..............ℹ Lógica de la aplicación, o las acciones que hace el componente
|--+--+--+-- 📄 start.hpp.............ℹ Inicia el proceso de censado y guardado de datos
|--+-- 📁 LCD/
|--+-- 📁 measurement/................ℹ Todo lo relacionado con mediciones o censado (lectura, tratamiento de los datos, etc)
|--+-- 📂 sd-card/
|--+--+-- 📂 2.adapter/
|--+--+--+-- 📄 controller.hpp
|--+--+-- 📂 3.use-case/..............ℹ Lógica de la aplicación, o las acciones que hace el componente
|--+--+--+-- 📄 execFiles.hpp.........ℹ Ejecuta funciones para manejar archivos
|--+--+--+-- 📄 printDirectory.hpp....ℹ Imprime y muestra los directorios y carpetas.
|--+--+-- 📂 4.domain/................ℹ Es la lódigo del negocio, para tratar los datos u objetos que maneja el proyecto.
|--+--+--+-- 📄 dirModel.hpp
|--+--+--+-- 📄 fileModel.hpp.........ℹ Modela la estructura y lo convierte en json
|--+--+--+-- 📄 filename.hpp..........ℹ Establece el nombre final del archivo
|--+-- 📁 sensor/.....................ℹ Acciones para ejecutar o tratar la información de los sensores.
|--+-- 📂 share/......................ℹ Area del código con alcance a todos los componentes
|--+--+-- 📂 4.domain/
|--+--+--+-- 📂 interface/............ℹ Guarda todas las estructuras de todos los componentes
|--+--+--+--+-- 📄 measurement.hpp....ℹ structura para la mediciónEl proyecto presenta una arquitectura por capas de manera jerárquica a nivel general como en cada componente usado. Cada capa tiene un fin específico dentro del proyecto y un flujo el cual se debe de respetar, esto significa que las capas superiores únicamente pueden acceder a las inferiores o comunicarse de manera adyacentes a ellas. Por ningún motivo una capa inferior puede acceder a una capa de nivel superior. En otras palabras, cuando se incluye o se usa una función del sistema se debe de considerar en que capa se encuentra.
Las capas a trabajar serían las siguientes:
Infraestructura☁ ➡ Adaptadores de interfaz🔗 ➡ Casos de uso🛒 ➡ Dominio🎁
Se dará una breve explicación de cada capa para conocer que función cumple en el proyecto,
-
☁ Infraestructura: Servidor y configuraciones
La infraestructura es la capa más externa de la arquitectura compuesta por frameworks, herramientas y base de datos, etc (Detalles del sistema). Esta capa es la que se encuentra más cerca del cliente, en otras palabras, primero pasa por esta capa y luego por las demás. Ejemplos:
Server.hpp➡ Activa el servidorsd-card.repository.hpp➡ Funciones para manejar la base de datos
Se les denomina detalles del sistema por el hecho de que no deberían ser significativos a la hora de hacer pruebas (testing) de funcionamiento. Además de que pueden ser fácilmente sustituido por alguna otra alternativa. Con respecto a la base de datos, se puede usar tanto la SD-CARD como el sistema de archivos (FS) del dispositivo.
-
🔗 Adaptador de interfaz
Se encarga de adaptar los datos que le llegan del cliente hacia los casos de uso y viceversa. Esta capa es la que recibe las peticiones hechas por el cliente y se le devuelve una respuesta. Para esta oportunidad tenemos dos formas de manejar las peticiones:
-
📋 Router
Define las reglas de como el usuario debe de interactuar con el api, se divide en:
RutaEs la dirección o rama que trabajará el api: /ruta1, /ruta1/subruta2Método: Son los verbos del protocolo a usar, en este caso del Http. Estos pueden ser: get, post, patch, delete, entre otros.RequestEs la que encapsula la petición o datos que el cliente ha enviado al servidor (API).Manejador de funcionesSon las funciones que se ejecutan para realizar la acción solicitada por el cliente. Aquí estarían las funciones del controlador.
Ejemplo:
Server.on(“/item”, HTTP_GET, getAllData) Server.on(“/item”, HTTP_PUT, *request, null, editConfiguration) Server.on(“/item”, HTTP_POST, *request, null, createPool) Server.on(“/item”, HTTP_POST, *request, validationPool, createPool)
📝 En el último ejemplo se agrega una función que valida la información que envía el cliente. Si la respuesta es correcta pasaría a la siguiente función, caso contrario podría detenerse y responder al cliente.
-
🗣 Controlador
Esta subcapa se encarga de recibir las peticiones y datos del cliente, devolviendo siempre una respuesta al mismo, en esta respuesta puede ser un mensaje con el estado 200 OK, o un error 404, además que también se puede incluir el dato que el cliente ha solicitado. Aquí no debería de haber nada de la lógica del negocio o extensas funciones, sólo una función que realice la acción asignada.
Ejemplo de Responsabilidad única
Si el controlador indica: readingMeasurement Significa que debe de ejecutar alguna función (readAllMeasurement) que permite realizar la acción correspondiente (leer los datos de algún lado), retornarlo al controlador y este le responderá al cliente. La función a ejecutar debe ser totalmente agnóstica al controlador, eso significa que el controlador no debe de conocer como dicha función hará el proceso, sólo le interesa que le devuelva algún dato.
-
-
🛒 Casos de uso En esta capa es donde están todas las reglas de la aplicación, o las funciones generales que realiza el proyecto. Su responsabilidad es la de ensamblar las diferentes funciones y servicios de dominio para resolver una solución en concreto. Hay que saber que sólo recibe datos,ejecuta varias funciones y devuelve más datos.
Ejemplo: Si queremos que el API permita iniciar el proceso de medición de los parámetros de entrada (temperatura, ph, oxígeno) necesitamos ejecutar ciertas funciones de manera ordenada para satisfacer la solución, y estas pueden ser: _ Recibir el id de la piscina a censar. _ Recibir la cantidad de iteraciones o mediciones que se desea realizar _ Inicializar los sensores _ Comenzar con el proceso de medición _ Establecer el nombre del archivo a guardar _ Crear un archivo con los datos medidos. \* Retornar la informaciónComo podemos notar, la aplicación deberá de ejecutar una serie de procesos o funciones para solucionar un caso en particular, cada una de estas funciones, por lo general, pertenecen a la misma capa (Caso de uso).
-
🎁 Dominio Es donde se encuentra la lógica del negocio. Aquí podemos encontrar los objetos con sus respectivos métodos, que pueden ser un conjunto de estructuras de datos y funciones. Esta capa es la que menos cambios debería de sufrir si alguna de las capas superiores cambia. ¿Qué podemos encontrar aquí?
- Funciones que modelan los datos o los estructura, en este caso le pasamos una serie de datos y nos devuelve en formato JSON.
- Establecer el nombre de un archivo
- Establecer el formato o ajustar la unidad de espacio ocupado (KB, MB).
- Las interfaces o estructura a usar en el proyecto (api/componets/share/4.domain/interface).
Entonces, cuál sería la diferencia entre los casos de uso y el dominio? Bajo mi conocimiento podré el siguiente ejemplo:
📱 Cliente (Celular) ➡ ☁ Servidor (API REST) ➡ 📋 Router ➡ 🗣 Controller ➡ 🛒 Casos de uso ➡ 🎁 Dominio
-
💻 Cliente
- Envía la petición desde un equipo hacia el servidor
- La petición es la siguiente:
- Type: GET
- URL: http://IP_NODEMCU/directory_sd`
-
☁ Servidor (API REST)
- El servidor escucha la petición y buscará en
router.hppla que coincide
- El servidor escucha la petición y buscará en
-
📋 Router
- De la ruta se dirije al
controllerque ejecutará sóla una función (use-case) - Ruta: Arduino/router/router.hpp
server.on("/directory_sd", HTTP_GET, directorySD)
- De la ruta se dirije al
-
🗣 Controller
- Dentro del controller se redirije hacia la función
directorySD, el cual sólo debería de ejecutar un proceso (printDirectory) y devolver una respuesta al cliente.
- Ruta: Arduino/api/sd-card/4.adapter/controller.hpp
La función devuelve una seria de objetos anidados ("{},{}") por una ",". Por eso se debe de encerrar en corchetes
- Dentro del controller se redirije hacia la función
- 🛒 Casos de Uso
- La función
printDirectoryentrará en un ciclo continuo hasta que no encuentre más datos, dentro del bucle preguntará si es un directorio o es un archivo. Para cada caso irá al dominio a modelarlos para devolver un archivo en formato "JSON" y luego concatenarlo.
- Ruta:
/Arduino/api/sd-card/3.use-case/crudSD.hpp
La función tiene la responsabilidad única de buscar directorio y archivos para ser devueltos, no cumple otra función externa o ajena a su responsabilidad.
- La función
- 🎁 Dominio
- En este caso el Caso de uso, solo necesita modelar los datos para dos modelos diferentes. Por eso que se dirije a dir.model.hpp para los directorios y a file.model.hpp para los archivos.
- Ruta: /Arduino/api/sd-card/4.domain/dir.model.hpp
- Ruta: /Arduino/api/sd-card/4.domain/file.model.hpp
- En este caso el Caso de uso, solo necesita modelar los datos para dos modelos diferentes. Por eso que se dirije a dir.model.hpp para los directorios y a file.model.hpp para los archivos.
Luego todos los datos se van retornando hasta el controlador que enviará la respuesta al cliente
3.1 ¿Qué es una API? VIDEO👀
API es el acrónimo de Application Programming Interfaces, en español sería Interfaz de programación de aplicaciones. Es la agrupación de diferentes funciones ,bibliotecas, procesos y subrutinas que pueden ser integrados en otro software.
Permite que sus productos y servicios puedan comunicarse con otros de una manera sencilla. Las APIs permiten simplificar el diseño, brindan flexibilidad para ser usado en otros desarrollos, administración de los recursos y dan paso a que la innovación fluya al permitir usar alguna característica en particular. En este caso, las APIs nos ayuda en la comunicación entre los diferentes periféricos del dispositivo (NodeMCU) a otros dispositivo conectado en la red (celular).
3.3 REST REST es un estilo de arquitectura basados en el protocolo HTTP que permite conectar vraios sistemas, como un servidor con un cliente. Para obtener o enviar los datos se puede usar cualquier formato, siendo los más usados XML, JSON.
Es cuando una API usa como arquitectura REST para comunicar entre el cliente y servidor. El cliente envía una petición hacia el servidor mediante algún verbo del http (get, post, put, patch, delete, etc), el servidor recoge esta peitición, realiza la acción correspondiente a la petición y luego devuelve una respuesta hacia el cliente, en algún tipo de formato, en este caso, JSON.
El servidor web trabaja de manera asíncrona, el cual se mantiene escuchando a la espera de alguna petición por parte del cliente. Tiene la capacidad de manejar varias conexiones al mismo tiempo.
En perspectiva es como las interrucciones en un microcontrolador, que se mantienen a la espera de una acción. Y pueden salir de un código secuencial en cualquier momento, incluso de un delay.
Es importante aclarar que el servidor no se ejecuta dentro del void loop(), dado que estaría trabajando de manera "paralela" por es importante evitar el uso de funciones dentro del servidor, que puedad provocar que el equipo se quede en stand by, como: delay, yield, entre otros parecidos.
Pasos que realiza el servidor
- Escucha las conexiones
- Envuelve la petición del cliente en REQUEST
- Realiza un seguimiento de los clientes y limpia la memoria
- Gestiona los
Rewritesy las aplica en la URL de la solicitud (tipo, url, parametros, versión http, etc) - Administra los
Handler (Controladores)y los adjunta en la solicitud
- Parameters
- path (String) // default: "/"
-
Response: 200 (application/json)
- body
[ { "name": "System Volume Information", "type": 1, "content": [ { "name": "IndexerVolumeGuid", "type": 0, "size": 76 }, { "name": "WPSettings.dat", "type": 0, "size": 12 } ] }, { "name": "config", "type": 1, "content": [ { "name": "sensor", "type": 1, "content": [ { "name": "temp.json", "type": 0, "size": 45 }, { "name": "ph.json", "type": 0, "size": 40 }, { "name": "do.json", "type": 0, "size": 38 } ] } ] }, { "name": "data", "type": 1, "content": [ { "name": "P2_1619314606000.json", "type": 0, "size": 357 }, { "name": "P1_1619314616000.json", "type": 0, "size": 355 }, { "name": "P2_1619308071000.json", "type": 0, "size": 360 } ] } ]
- body
-
Response: 200 (application/json)
- body
[ { "name": "data", "type": 1, "content": [ { "name": "P2_1619314606000.json", "type": 0, "size": 357 }, { "name": "P1_1619314616000.json", "type": 0, "size": 355 }, { "name": "P2_1619308071000.json", "type": 0, "size": 360 } ] } ]
- body
-
Parameters
- filename (String)
- data (String)
-
Example
-
/write_sd?filename=data.json&data={"data": "OK"}
-
-
Response: 200 (application/json)
- body
{ "data": "OK" }
- body
- Parameters
- filename (String)
- Example
-
/read_sd?filename=data.json
-
- Response: 200 (application/json)
- body
{ "data": "OK" }
- body
- Parameters
- filename (String)
- Example
-
/delete_sd?filename=data.json
-
- Response: 200 (application/json)
- body
json { "data": "data.json" }
- body
- Parameters
- filename (Array[String])
- filemax (number) // default: 10
- Example
-
/delete_sd?filename=data1.json,data2.json,data3.json&filemax=2
-
- Response: 200 (application/json)
- body
{ "data": "data1.json,data2.json" }
- body
- Parameters
- pool_id (number)
- nMeditions (number) // default: 10
- time (String)
- Example
-
/device/start?pool_id=1&nMeditions=2
-
- Response: 200 (application/json)
- body
[ { "pool_id": 1, "device_id": "ABCD", "created_at": "1619285911000", "status": "OK", "params": null }, { "pool_id": 1, "device_id": "ABCD", "created_at": "1619285911000", "status": "OK", "params": null } ]
- body
- Parameters
- pool_id (number)
- nMeditions (number) // default: 10
- time (String)
- Example
-
/device/start?pool_id=1&nMeditions=2&time=1619000000001
-
- Response: 200 (application/json)
- body
[ { "pool_id": 1, "device_id": "ABCD", "created_at": "1619000000001", "status": "OK", "params": [ { "value": 31.875, "name": "Temperature" }, { "value": 10.7075, "name": "PH" }, { "value": 21, "name": "DO" } ] }, { "pool_id": 1, "device_id": "ABCD", "created_at": "1619000000001", "status": "OK", "params": [ { "value": 31.875, "name": "Temperature" }, { "value": 10.7075, "name": "PH" }, { "value": 21, "name": "DO" } ] } ]
- body
- Parameters
- filemax (number) // default: 10
- prefix (String) // default: P_
- path (String) // default: /data/
- Example
-
/measurement
-
- Response: 200 (application/json)
- body
[ { "pool_id": 2, "device_id": "ABCD", "created_at": "1619308071000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.70167, "name": "PH" }, { "value": 21, "name": "DO" } ] }, { "pool_id": 2, "device_id": "ABCD", "created_at": "1619308071000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.6975, "name": "PH" }, { "value": 21, "name": "DO" } ] }, { "pool_id": 1, "device_id": "ABCD", "created_at": "1619314616000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.705, "name": "PH" }, { "value": 21, "name": "DO" } ] }, { "pool_id": 1, "device_id": "ABCD", "created_at": "1619314616000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.7, "name": "PH" }, { "value": 21, "name": "DO" } ] }, { "pool_id": 2, "device_id": "ABCD", "created_at": "1619314606000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.70667, "name": "PH" }, { "value": 21, "name": "DO" } ] }, { "pool_id": 2, "device_id": "ABCD", "created_at": "1619314606000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.7, "name": "PH" }, { "value": 21, "name": "DO" } ] } ]
- body
-
Parameters
- filemax (number) // default: 10
- prefix (String) // default: P{id}_
- path (String) // default: /data/
-
Example
-
/measurement/1?filemax=3
-
-
Response: 200 (application/json)
-
body
[ { "pool_id": 1, "device_id": "ABCD", "created_at": "1619314616000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.705, "name": "PH" }, { "value": 21, "name": "DO" } ] }, { "pool_id": 1, "device_id": "ABCD", "created_at": "1619314616000", "status": "OK", "params": [ { "value": 31.75, "name": "Temperature" }, { "value": 10.7, "name": "PH" }, { "value": 21, "name": "DO" } ] } ]
-
Es una librería que permite codificar y decodificar los datos en formato JSON.
Página Oficial: https://arduinojson.org/
Asistente: https://arduinojson.org/v6/assistant/
Es el proceso que genera documentos en formato JSON.
String output;
int sizeDoc // Usar el asistente de ArduinoJson para saber el tamaño
DynamicJsonDocument doc(sizeDoc);
doc["name"] = "COMUNITARIAS";
doc["id"] = 10;
serielizeJson(doc, output);
// output => {"name": "COMUNITARIAS", "id": 10}Extrae la información desde un documento de JSON.
String input = "{\"name\": \"COMUNITARIAS\", \"id\": 10}"; // \" => "
int sizeDoc = input.length();
DynamicJsonDocument doc(sizeDoc)
DeserializationError err = deserilezejson(doc, input);
// Manejo de errores
if (err) {
Serial.print(F("deserializeJson() failed with code "));
Serial.println(err.c_str());
}
String name = doc["name"];
byte id = = doc["id"];http://aitorrm.github.io/t%C3%A9cnicas%20y%20metodolog%C3%ADas/arquitectura_software_limpia/
http://aitorrm.github.io/t%C3%A9cnicas%20y%20metodolog%C3%ADas/arquitectura_software_limpia/
https://medium.com/@BryanSBarrios/arquitectura-limpia-para-el-resto-de-nosotros-440a4fba4d92