Configuración
Esta sección permite la configuración de IoT.
GET /iot
Este método devuelve la lista de elementos disponibles.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- process [obligatorio]: el Id. del proceso.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la lista de elementos.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Ejemplo de respuesta:
{ "status": 0, "data": [{ active: "1", consumptiontype: "", deadband: "0", description: "", device: "INIT", endpoint: "Kontron.OPCFatek.1", event: "0", function: "Production", host: "HOST", id: "343", identifier: "", item: "RS1.CTR.CTR0000", minimumcycle: "0", password: "", process: "A0L1", resetevery: "32000", senddescription: "0", storedb: "1", threshold: "50", type: "Counter", upd: "20190610130338", url: "localhost", user: "", value: "26469", variablenumber: "1", vendor: "edinnHIP" }, { active: "1", consumptiontype: "", deadband: "0", description: "", device: "INIT", endpoint: "Kontron.OPCFatek.1", event: "0", function: "Production", host: "HOST", id: "346", identifier: "", item: "RS1.CTR.CTR0000", minimumcycle: "0", password: "", process: "A0L1", resetevery: "32000", senddescription: "0", storedb: "1", threshold: "80", type: "Counter", upd: "20190610130338", url: "localhost", user: "", value: "26469", variablenumber: "0", vendor: "edinnHIP" }], "message": "Success" } |
POST /iot
Este método crea un nuevo elemento. El usuario debe ser administrador.
Recuerde que para los contadores que desea supervisar, necesita al menos 2 entradas en la tabla IoT: 1 para el número variable 0 (el total) y otro para el número variable 1. Esto se aplica a los siguientes tipos de elementos:
- PType_Production = 0
- PType_Scrap = 1
- PType_Rework = 2
- ...
- Vea la lista completa en funciones.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- host: localhost si no se especifica.
- device [obligatorio]: el dispositivo fuente para el elemento.
- vendor [obligatorio]: la fuente de la que IoT obtiene datos. Por favor vea constantes.
- url: OPC UA es donde se pueden encontrar los puntos finales. OPC DA es la dirección IP del servidor OPC. Si no se especifica, se tomará "localhost".
- endpoint [obligatorio]: en OPC UA esto indica el punto final para conectarse. En OPC DA esto indica el nombre del DCOM.
- process: el id. del proceso.
- item [obligatorio]: el id. del elemento.
- function [obligatorio]: la funcionalidad del elemento, por favor vea constantes.
- type [obligatorio]: si el elemento es un contador, una señal o una lógica definida por el usuario (UDL), por favor vea constantes.
- threshold [obligatorio] [0-100]: la velocidad mínima para considerar que el proceso está funcionando. Esto es obligatorio cuando se inserta una producción (función), contador (tipo) y la variable es totales.
- minimumcycle [obligatorio] [0-100]: el tiempo mínimo de ciclo que debe alcanzarse para considerar la producción.
- description: un texto libre para describir el elemento.
- variablenumber [obligatorio]: el número de la variable que representa este elemento, de acuerdo con el tipo de cálculo asociado con el proceso.
- consumption_type [opcional]: el Id. del tipo de consumo.
- identifier [opcional]: indica el Id. del:
- resultado que se insertará automáticamente si este elemento está funcionando como elemento de desecho o retrabajo.
- estado que se insertará automáticamente si este elemento está funcionando como una justificación de justificar todos los elementos.
- deadband [opcional][0-100]: este valor permite filtrar e ignorar los cambios de la señal que son más pequeños que un cierto porcentaje.
- activate [obligatorio]: activa (1) o desactiva (0) el elemento.
- storedb [obligatorio]: cuando storedb = 0, indica que el elemento se mantendrá sólo en la memoria. Si storedb = 1, indica que el valor del elemento también se almacenará en la base de datos en tiempo real.
- resetevery: se aplica únicamente a los elementos que son contadores, e indica cada cuántos conteos el contador se reseteará.
- senddescription [obligatorio]: indica que la descripción indicada anteriormente será (1) o no será (0) enviada relacionada a el registro del resultado generado.
- event [obligatorio] [100-200]: indica si el artículo se enviará al Registro en la forma de este número de evento.
- user [obligatorio]: el usuario para conectar al OPC UA.
- password [obligatorio]: la contraseña para conectarse al OPC UA.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la lista de elementos.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
PUT /iot
Este método actualiza un elemento. El usuario debe tener permiso administrativo. Se utiliza principalmente para actualizar el valor del contador de producción.
Parámetros de solicitud:
o company [obligatorio]: el nombre de la empresa o id.
o session [obligatorio]: el ID de la sesión activa.
o Id [obligatorio]: el id del artículo.
o "value" or "inc": con "valor" se puede cambiar el valor del artículo, con "inc" (que significa incremento) se puede agregar una cantidad determinada al valor actual del artículo.
o host: localhost si no se especifica.
o vendor: la fuente de la cual IoT obtiene los datos. Por favor vea las constantes.
o url: en OPC UA aquí es donde se pueden encontrar los puntos finales. En OPC DA, esta es la dirección IP del servidor OPC. Si no se especifica, se tomará "localhost".
o endpoint: en OPC UA, esto indica el punto extremo al que se debe conectar. En OPC DA esto indica el nombre del DCOM.
o process: el identificador del proceso.
o item: el identificador del item.
o function: la funcionalidad del elemento, por favor vea las constantes.
o type: si el elemento es un contador, una señal o una lógica definida por el usuario (UDL). Por favor vea las constantes.
o threshold [0-100]: la velocidad mínima para considerar que el proceso está funcionando. Esto es obligatorio cuando se insertan una producción (función), un contador (tipo) y la variable son los totales.
o minimumcycle [0-100]: el tiempo de ciclo mínimo que se debe alcanzar para considerar la producción.
o variablenumber: el número de la variable que representa este elemento, según el tipo de cálculo asociado con el proceso.
o consumptiontype: el id del tipo de consumo.
o identifier: indica el id del:
■resultado que se insertará automáticamente si este artículo funciona como un artículo de chatarra o reelaboración.
■ estado que se insertará automáticamente si este elemento funciona como justificación de justificar todo.
o deadband [0-100]: este valor permite filtrar e ignorar que los cambios de la señal son más pequeños que un cierto porcentaje.
o activate: activa (1) o desactiva (0) este elemento.
o storedb: cuando almacenadob = 0 indica que el elemento se guardará solo en la memoria. Si es 1, indica que el valor del elemento se almacenará también en la base de datos en tiempo real.
o resetevery: se aplica solo a los elementos que son de tipo contadores, e indica cuántas cuentas se restablecerá este contador.
o senddescription: indica que la descripción indicada anteriormente (1) o no (0) se enviará vinculada al registro del resultado generado.
o event [100-200]: indica si el elemento se enviará al Registro en la forma de este número de evento.
o user: el usuario para conectarse a la OPC UA.
o password: la contraseña para conectarse a OPC UA.
Response:
o status: returns "0" on success, and an error code in any other case.
o message: "success" or a descriptive information of the error in any other case.
DELETE /iot
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- id [obligatorio]: el Id. del elemento a eliminar.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la lista de procesos y sus descripciones.
- message: "Success" o una información descriptiva del error en cualquier otro caso.