Local API

5.1 {BEARER}

El campo {BEARER} lo obtenemos en la petición de información Get_Buildings y este dato nos ayuda a autentificarnos en la API LOCAL disponible en nuestros dispositivos.

Este dato acompañará la trama de comunicación para cada una de las peticiones disponibles, dependiendo del tipo de dispositivo.

5.2 Comunicación

5.2.1 EndPoint

Las comunicaciones TCP se dirigirán a la {IP} del dispositivo dentro de la red del hogar y el {PORT} es el 443.

5.2.2 Request

La trama JSON de comunicación con la API LOCAL es la siguiente:

{ "bearer": {BEARER}, "type": "plain", "op": {OPERATION_CODE}, "args": {VALUE} }

 

FIELD	DESCRIPTION
BEARER	Autentificación de Seguridad.
TYPE	Por defecto “plain”, se deja la puerta abierta a una expansión de tipos de encriptación en futuras revisiones.
OP	Código de Operación Operaciones y Servicios
ARGS	Si fuera necesario según Operación Operaciones y Servicios

5.2.3 Response

Dependiendo del tipo de petición: Actuación o Sensor.

Actuación:

{ "ack": true }

 

FIELD	DESCRIPTION
ACK	Confirmación de Operación y Autentificación correcta.

Sensor:

{ "op": {OPERATION_CODE} (Number), "value": {SENSOR_VALUE} (Number)(precisión: 1 decimal), "ack": true }

 

FIELD	DESCRIPTION
OP	Identificación de Valor de Sensor enviado.
VALUE	Valor de Sensor con 1 decimal de precisión.
ACK	Confirmación de Operación y Autentificación correcta.

5.3 Operación HELLO

Cuando un Developer quiere obtener las IP’S y Servicios que componen la arquitectura MySmartWindow del hogar dispone de 2 alternativas:

• Servicio Cloud Get_Buildings
• Servicio Local HELLO

El developer realizará un sondeo de la red lanzando la siguiente petición:

Request:

{ "bearer": {BEARER}, "type": "plain", "op": 70, "args": 0 }

 

Response:

{ "id": {ID_WINDOW} (string), "ip": {IP} (string), "type": "sentry/essential/.."(string), "services": ["S1","S2",…] Array["string"] }

Obteniendo de esta forma toda la información de identificación necesario para la preparación del entorno operativo.

5.4 Ejemplos

5.4.1 Petición de Subida de Persiana

Request:

{ "bearer": {BEARER}, "type": "plain", "op": 7, "args": 0 }

 

Response:

{ "ack": true }

 

5.4.1 Petición de Sensorización de Temperatura

Request:

{ "bearer": {BEARER}, "type": "plain", "op": 4, "args": 0 }

 

Response:

{ "op": 4, "value": 25.4, "ack": true }

 

5.4.1 Petición de Posición de Persiana x Unidad

Request:

{ "bearer": {BEARER}, "type": "plain", "op": 63, "args": 25 }

 

Response:

{ "ack": true }