Ayudaría mucho si apoyaras este proyecto con una ⭐ en Github!
CoAP es un protocolo de capa de aplicación de internet especializado para dispositivos restringidos. Permite que los dispositivos - llamados nodos - se comuniquen con internet a través de un protocolo simple que hace foco en varios aspectos propios de IoT. Si querés conocer más al respecto de CoAP podés leer el documento de Introducción a CoAP que se encuentra en nuestra web.
Este proyecto es una interfaz que sirve para interactuar con un servidor CoAP desde un cliente HTTP como puede ser un navegador web, o cualquier otro tipo de cliente. Tiene una HTTP REST API como interfaz que te permite enviar requests CoAP hacia un servidor y devuelve la respuesta del servidor formateada adecuadamente en JSON para que la puedas interpretar. Está desarrollado en Python y se ejecuta sobre un contenedor de Docker.
Es importante que sepas que este servicio no es un proxy. Un proxy es un servicio que transcribe literalmente los requests HTTP a CoAP y sus correspondientes respuestas. Este servicio es una interfaz, que permite interactuar con cualquier servidor CoAP pero sin actuar como un proxy.
Para correr este proyecto es necesario que instales Docker y Docker Compose.
Mira cómo instalar las dependencias
En este artículo publicado en nuestra web están los detalles para instalar Docker y Docker Compose en una máquina Linux. Si querés instalar ambas herramientas en una Raspberry Pi podés seguir este artículo de nuestra web que te muestra todos los pasos necesarios.
En caso que quieras instalar las herramientas en otra plataforma o tengas algún incoveniente, podes leer la documentación oficial de Docker y también la de Docker Compose.
Continua con la descarga del código cuando tengas las dependencias instaladas y funcionando.
Para descargar el código, lo más conveniente es que realices un fork de este proyecto a tu cuenta personal haciendo click en este link. Una vez que ya tengas el fork a tu cuenta, descargalo con este comando (acordate de poner tu usuario en el link):
git clone https://github.com/USER/service-http-coap-interface.git
En caso que no tengas una cuenta en Github podes clonar directamente este repo.
Cuando tengas el código descargado, desde una terminal en la raíz del proyecto ejecuta el comando docker-compose build http-coap-interface que se va encargar de compilar la imagen de la interfaz en tu máquina (este proceso puede durar unos minutos dependiento tu conexión a internet).
Una vez que haya compilado, ejecutá el comando docker-compose up para poner en funcionamiento el servicio. En la terminal (entre un log inicial y las configuraciones) deberías ver una salida similar a la siguiente:
...
...
/$$$$$$ /$$ /$$$$$$ /$$$$$$$$
/$$__ $$ | $$ |_ $$_/ |__ $$__/
| $$ \__/ /$$$$$$ /$$$$$$ /$$$$$$ | $$ /$$$$$$| $$
| $$ /$$$$/$$__ $|_ $$_/ /$$__ $$ | $$ /$$__ $| $$
| $$|_ $| $$ \ $$ | $$ | $$ \ $$ | $$ | $$ \ $| $$
| $$ \ $| $$ | $$ | $$ /$| $$ | $$ | $$ | $$ | $| $$
| $$$$$$| $$$$$$/ | $$$$| $$$$$$/ /$$$$$| $$$$$$| $$
\______/ \______/ \___/ \______/ |______/\______/|__/
SERVICE HTTP-COAP INTERFACE
---------------------------
...
...
Si ves esta salida significa que el servicio se encuentra corriendo adecuadamente. Podés leer la información útil para tener un mejor entendimiento de la aplicación.
En esta sección vas a encontrar información que te va a servir para tener un mayor contexto.
Mira todos los detalles
El objetivo de la aplicación es recibir un request HTTP, convertirlo en un request CoAP, ejecutarlo y devolver una respuesta. Yendo más a detalle, los pasos que realiza el servicio para la ejecución de un request son los siguientes:
- El servicio comienza su ejecución a través del comando
docker-compose upy pone a disposición los endpoints para recibir request. Podés ver más información sobre los endpoints disponibles en el apartadoInterfaz HTTP. - El usuario realiza un request hacia este servicio indicando la IP del servidor CoAP al cual desea ejecutar un request, el puerto, el método y un payload si es necesario. Para conocer más al respecto podés consultar el archivo de test requests.http que muestra cómo deben ejecutarse los requests.
- Este servicio recibe el request HTTP del usuario, lo analiza, y genera un comando para ejecutar un request CoAP a través de la herramienta libcoap.
- Una vez que el comando está armado lo ejecuta y se queda esperando la respuesta del server CoAP.
- Cuando el server CoAP responde, analiza la respuesta y la convierte a JSON.
- Finalmente con la respuesta armada la devuelve al cliente HTTP.
Para que puedas correr adecuadamente los requests hacia el server CoAP es necesario que este servicio se encuentre dentro de la misma red que el server CoAP.
Si querés realizar alguna modificación o agregar tus propias configuraciones, podés editar el archivo _storage/settings.json.
La configuración de toda la aplicación está alojada en el archivo _storage/settings.json. Podés cambiarla escribiendo en este archivo directamente. Si por casualidad llegás a borrar la configuración, podés copiar y modificar esta:
{
"API_PREFIX": "http_coap",
"EVENTS_TO_OMIT": "HttpCoapRequest, CoapHttpResponse"
}Los parámetros de configuración significan lo siguiente:
- API_PREFIX: El prefijo que tendrá la API de la interfaz HTTP-CoAP. Podés dejarlo con la opción por defecto o poner otra.
- EVENTS_TO_OMIT: La lista de eventos que no se publicaran en caso que sucedan.
Si querés modificar algúna configuración como variable de entorno podés modificar el archivo env. Por lo general la configuración por defecto funciona sin necesidad que la modifiques.
A través de la interfaz HTTP podés acceder a todos los recursos del servicio. A continuación están los detalles de cada uno de los endpoints con los métodos que acepta.
Obtener el estado del servicio
- URL: http://localhost:5000/status
- METHOD: GET
Testear un request HTTP enviado por el cliente.
- URL: http://localhost:5000/http_coap/test
- METHOD: PUT
- EXAMPLE BODY: {"message": "Hello World!"}
Ejecutar un request a un server CoAP que tiene asignada la IP 192.168.0.103, en el puerto 5683, usando el metodo GET, en un recurso llamado button.
- URL: http://localhost:5000/http_coap/interface
- METHOD: PUT
- EXAMPLE BODY: { "coap_server_ip" : "192.168.0.103", "coap_server_port" : 5683, "coap_server_resource" : "button", "coap_method" : "get" }
Ejecutar un request a un server CoAP que tiene asignada la IP 192.168.0.103, en el puerto 5683, usando el metodo PUT, en un recurso llamado light.
- URL: http://localhost:5000/http_coap/interface
- METHOD: PUT
- EXAMPLE BODY: { "coap_server_ip" : "192.168.0.103", "coap_server_port" : 5683, "coap_server_resource" : "button", "coap_method" : "get", "coap_payload" : { "light": true } }
La mejor forma de probar el servicio es a través de un cliente HTTP. En el directorio test/other/requests.http tenés un archivo para probar todas las funcionalidades provistas. Para correr estos requests es necesario que los ejecutes dentro de Visual Studio Code y que instales la extensión REST Client. Sino, podés correr los requests desde Postman, CURL o cualquier otro.
Mira la lista de tecnologías usadas en el proyecto
- Docker - Ecosistema que permite la ejecución de contenedores de software.
- Docker Compose - Herramienta que permite administrar múltiples contenedores de Docker.
- Python - Lenguaje en el que están realizados los servicios.
Si estás interesado en el proyecto y te gustaría sumar fuerzas para que siga creciendo y mejorando, podés abrir un hilo de discusión para charlar tus propuestas en este link. Así mismo podés leer el archivo Contribuir.md de nuestra Wiki donde están bien explicados los pasos para que puedas enviarnos pull requests.
Goto IoT es una plataforma que publica material y proyectos de código abierto bien documentados junto a una comunidad libre que colabora y promueve el conocimiento sobre IoT entre sus miembros. Acá podés ver los links más importantes:
- Sitio web: Donde se publican los artículos y proyectos sobre IoT.
- Github de Goto IoT: Donde están alojados los proyectos para descargar y utilizar.
- Comunidad de Goto IoT: Donde los miembros de la comunidad intercambian información e ideas, realizan consultas, solucionan problemas y comparten novedades.
- Twitter de Goto IoT: Donde se publican las novedades del sitio y temas relacionados con IoT.
- Wiki de Goto IoT: Donde hay información de desarrollo complementaria para ampliar el contexto.
Si te gustó este proyecto y quisieras apoyarlo, cualquiera de estas acciones estaría más que bien para nosotros:
- Apoyar este proyecto con una ⭐ en Github para llegar a más personas.
- Sumarte a nuestra comunidad abierta y dejar un feedback sobre qué te pareció el proyecto.
- Seguirnos en twitter y dejar algún comentario o like.
- Compartir este proyecto con otras personas.
Las colaboraciones principales fueron realizadas por:
- Agustin Bassi: Ideación, puesta en marcha y mantenimiento del proyecto.
También podés mirar todas las personas que han participado en la lista completa de contribuyentes.
Este proyecto está bajo Licencia (MIT). Podés ver el archivo LICENSE.md para más detalles sobre el uso de este material.
Copyright © Goto IoT 2021 - Website - Group - Github - Twitter - Wiki