core-plugins-smarttelia v1.0.1

CORE para todos los plugins de SmartTelia

Este paquete es el encargado de instalar, actualizar y desinstalar un plugin en la plataforma de Smarttelia.

Node.js (Instalación)

Requisitos:

• Node.js
• npm

npm install core-plugins-smarttelia

Uso

Para hacer uso del paquete es necesario importarlo de esta manera

const core = require('core-plugins-smarttelia')

Una vez importado, podremos utilizar la función processPlugin() que según para lo que vayamos a utilizarla hará una determinada acción u otra: instalar, desinstalar o actualizar.

Para la función processPlugin se utilizan tres parámetros:

• la ruta del XML de configuración
• la dirección IP y puerto del servidor (formato x.x.x.x:PORT)
• La acción a realizar (0 - Instalar, 1 - Desinstalar y 2 - Actualizar)

Por otra parte la llamada a dicha función se tendrá que hacer dentro de un Try...Catch... puesto que siempre que se produzca un error, o se le haya pasado un parámetro de forma incorrecta, "levantará" un error.

Instalar

await core.processPlugin('/schema/device-types.xml', 'localhost:3001', 0)

Creará en la base de datos de SmartTelia, todos los datos relativos al plugin. Creará los tipos de devices, los device (aunque con los datos vacíos, estos hay que rellenarlos desde SmartTelia), los sections que componen los devices, y los parámetros de configuración.

Desinstalar

await core.processPlugin('/schema/device-types.xml', 'localhost:3001', 1)

Eliminará de la base de datos de SmartTelia toda la información relativa a los plugins. Incluidos los devices asociados, las sections de los diferentes devices y su cofiguración.

Actualizar

await core.processPlugin('/schema/device-types.xml', 'localhost:3001', 2)

"¡¡¡IMPORTANTE!!! Aún sin funcionalidad definida....". Si se realiza la llamada a la función de esta manera retornará un excepción de funcionalidad no implementada.

Release note

1.0.2

Se documenta el uso del paquete en el archivo README.md

1.0.1

Se crea toda la funcionalidad del core, exceptuando la actulización del plugin.

1.0.0

Subida inicial al repositorio, sin incluir funcionalidad