Sofia4Cities Node-RED

Ver en otros idiomas: Inglés, Español.

Copyright

© 2013-18 Minsait

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

API documentation

Antes de utilizar el API SSAP por primera vez, le recomendamos que se familiarice con los conceptos básicos de la plataforma Sofia2. Están incluidos en la documentación de desarrollo de Sofia2, que puede descargarse desde http://sofia2.com/desarrollador.html.

El Api viene con una test suite en la que se pueden ver ejemplos de uso de cada una de las consultas posibles.

Contenido del repositorio

Este repositorio contiene los siguientes nodos para consultar a Sofia4Cities desde Node-RED:

• sofia4cities-connection-config: Los nodos de configuración tienen un alcance global por defecto, esto significa que el estado se compartirá entre flujos. Este nodo representa una conexión compartida con un sistema remoto. En este caso, el nodo de configuración es responsable de crear la conexión (MQTT) y ponerla a disposición de los nodos que utilizan el nodo de configuración. Los siguientes parámetros son necesarios para definir la conexión:

  • Protocol: El protocolo puede ser MQTT. Para estas conexiones es necesario indicar la IP y el número del puerto.
  • Device y Instance: Esto sirve para indicar la Instancia Device a la que hace referencia.
  • Token: Número de identificación del Device.
  • Renovate session: Tiempo de regeneración de la sesión

• sofia4cities-delete: Este nodo borra datos de una ontología de acuerdo con la query, se necesitan los siguientes parámetros:

  • Ontology: Nombre de la ontología.
  • Delete Type: El tipo puede ser por consulta o por Id.
  • Query/Id: Query o Id para borrar los datos según la opción elegida anteriormente.
  • Query Type: Tipo de la query, que puede ser Nativo.

• sofia4cities-insert: Este nodo inserta datos en una ontología, es necesario indicar el nombre de la ontología, así como los datos que van a ser insertados en formato JSON.

• sofia4cities-leave: Este nodo libera la conexión, es necesario indicar la sessionKey de la conexión que va a ser liberada.

• sofia4cities-query: Este nodo ejecuta una query sobre una ontología, son necesarios los siguientes parámetros:

  • Ontology: Nombre de la ontología.
  • Query: Query a ejecutar.
  • Query Type: Tipo de la query, que puede ser SQL o Nativo.

• sofia4cities-update: Este nodo actualiza los datos de una ontología, es necesario poner los siguientes parámetros:

  • Ontology: Nombre de la ontología.
  • Update Type: El tipo puede ser por consulta o por Id.
  • Id: Id de la instancia a ser actualizada.
  • Query: Query para actualizar los datos.
  • Query Type: Tipo de la query, que puede ser Nativo.

• sofia4cities-subscribe: Este nodo se suscribe a una ontología cuando se cumplan las consultas, es necesario poner los siguientes parámetros:

  • Ontology: Nombre de la ontología.
  • Query: Query para suscribirse a los cambios de ontologia.
  • Query Type: Tipo de la query, que puede ser Nativo.

Este repositorio contiene también los siguientes directorios:

• libraries: Este directorio contiene los archivos necesarios para construir el mensaje SSAP y el Device necesario para la conexión MQTT.
• icons: Este nodo contiene los iconos usados en los nodos.

Información de contacto

Si necesita recibir soporte, puede contactar con nosotros enviando un correo electrónico a select4cities@gmail.com.

Además, si desea contribuir al API, no dude en enviarnos una pull request.