Todas las responses tendrán la siguiente forma
{ "data": "Contenido de la response", "message": "Descripcion de lo que paso", }Las siguientes definiciones solo detallarán el valor esperado del campo data.
Definición
GET /dispositivos
200 OKon success
[ { "identificador": "luz-habitacion", "nombre": "Luz de habitacion", "tipo_dispositivo": "led", "pin_dispositivo": "10", "parametros":{ "encendido": false } }, { "identificador": "temp-humedad", "nombre": "Temperatura y humedad", "tipo_dispositivo": "sensor", "pin_dispositivo": "A10", "parametros":{ "temperatura": 25.0, "humedad": 50.0 } } ]Definición
POST /dispositivos
Argumentos
"identificador":string, identificador globalmente único para este dispositivo"nombre":string, un nombre amigable para este dispositivo"tipo_dispositivo":string, el tipo de dispositivo entendido por el cliente"pin_dispositivo":string, número de pin en microcontrolador (Uso sugerido: Arduino)"parametros":json, objeto JSON con parámetros e información del dispositivo
Si el dispositivo con el identificador asignado ya existe, será sobre-escrito.
Response
201 Createdon success
{ "identificador": "luz-habitacion", "nombre": "Luz de habitacion", "tipo_dispositivo": "led", "pin_dispositivo": "10", "parametros": { "encendido": false } }GET /dispositivo/<identificador>
Response
404 Not Foundsi el dispositivo no existe200 OKon success
{ "identificador": "luz-habitacion", "nombre": "Luz de habitacion", "tipo_dispositivo": "led", "pin_dispositivo": "10", "parametros": { "encendido": false } }Definición
DELETE /dispositivo/<identificador>
Response
404 Not Foundsi el dispositivo no existe204 No Contenton success
Definición
GET /dispositivo/luz-<sala>
Response
200 OKon success404 Not Foundsi el identificador no existe
[ { "identificador": "luz-habitacion", "nombre": "Luz de habitacion", "tipo_dispositivo": "led", "pin_dispositivo": "2", "parametros": { "encendido": false } }, { "identificador": "luz-estancia", "nombre": "Luz de estancia", "tipo_dispositivo": "led", "pin_dispositivo": "3", "parametros": { "encendido": false } }, { "identificador": "luz-baño", "nombre": "Luz de baño", "tipo_dispositivo": "led", "pin_dispositivo": "4", "parametros": { "encendido": false } }, { "identificador": "luz-cocina", "nombre": "Luz de cocina", "tipo_dispositivo": "led", "pin_dispositivo": "5", "parametros": { "encendido": false } }, { "identificador": "luz-entrada", "nombre": "Luz de entrada", "tipo_dispositivo": "led", "pin_dispositivo": "6", "parametros": { "encendido": false } }, { "identificador": "luz-comedor", "nombre": "Luz de comedor", "tipo_dispositivo": "led", "pin_dispositivo": "7", "parametros": { "encendido": false } } ]Definición
PUT /dispositivo/<identificador>
Argumentos
"encendido":boolean, indicar si el led del identificador estará encendido o apagado
Response
200 OKon success404 Not Foundsi el identificador no existe
[ { "identificador": "luz-comedor", "nombre": "Luz de comedor", "tipo_dispositivo": "led", "pin_dispositivo": "7", "parametros": { "encendido": true } } ]Definición
GET /dispositivos/sensores/temp-y-humedad
Response
200 OKon success404 Not Foundsi el identificador no existe
[ { "identificador": "temp-y-humedad", "nombre": "Temperatura y humedad", "tipo_dispositivo": "sensor", "pin_dispositivo": "A0", "parametros": { "temperatura": 23.4, "humedad": 50.0 } } ]Definición
GET /dispositivo/ultrasonico
Response
200 OKon success404 Not Foundsi el identificador no existe
[ { "identificador": "ultrasonico", "nombre": "Sensor ultrasónico", "tipo_dispositivo": "sensor", "pin_dispositivo": ["10", "11"], "parametros": { "distancia": 23.43, } } ]Definición
GET /dispositivo/puertas
Response
200 OKon success404 Not Foundsi el identificador no existe
[ { "identificador": "puertas", "nombre": "Puertas principales", "tipo_dispositivo": "motor", "pin_dispositivo": "8", "parametros": { "dato_serial": "S", "abierto": false } } ]Definición
PUT /dispositivos/puertas
Argumentos
"abierto":boolean, indica si el servomotor está abierto o cerrado. Estos motores están encargados de abrir y cerrar la casa, y ambos deben estar siempre en el mismo estado."parametros": {"dato_serial": "A"}, gira los servomotores para abrir las puertas de la casa."parametros": {"dato_serial": "S"}, gira los servomotores para cerrar las puertas de la casa.
Response
200 OKon success404 Not Foundsi el identificador no existe
[ { "identificador": "puertas", "nombre": "Puertas principales", "tipo_dispositivo": "motor", "pin_dispositivo": "8", "parametros": { "dato_serial": "S", "abierto": false } } ]