KiParameters

kiParameters

kiParameters is a desktop tool for Windows 10 that facilitates the configuration of Modbus devices locally or remotely (taking advantage of the power of the kiconex libraries).

Session management

To use the functionalities that require connection to the mykiconex platform, you must log in with your user name and password. At startup, kiParameters will check if there is an active session. If so, it will automatically log in. If not, the following pop-up window will be displayed. If you want to use online functionalities, enter your credentials and click on the "Login" button. You can also check the box "Remember me" to keep the information for other sessions.

If you want to use the software in offline mode, click on the button "Continue offline". If you do not want the login dialog to appear again the next time you start the program, select the check box "Do not ask again".

Once the session is (or is not) logged in, the session information will be displayed in lower right corner.

When a change in the session is needed, click on the "Session" menu in top bar. To log out and activate the offline mode, click on "Logout". If you wish to log in with another user, click on "Login" and the program will automatically close the current session and the pop-up window will be shown again.

Parameter map

Parameter map refers to an operating configuration applied to a control. For example, in mykiconex the parameter map can be consulted and modified via the "Parameters" tab (see Controls).

This configuration could be exported for modification in a spreadsheet editor and imported back to the platform, allowing the modification of configurations remotely or even the generation and resetting of factory settings, although by itself it has two drawbacks:

1. If you modify a parameter with metadata, you must first know the values that correspond to the different options.
2. You cannot upload these settings to a controller that you have connected directly to the network or to the computer. We depend on a kibox or it must be done manually on the machine, parameter by parameter.

kiParameters aims to make up for these shortcomings by making the process more automatic and simple.

When loading/reading a parameter map the result will be displayed as a table with the values read from the file or control, where the only editable column is the Value column.

Parameters map

miniatureimage

• Las celdas en color blanco son parámetros con valores numéricos, haga doble click sobre ellos para editarlos y pulse Enter para realizar el cambio.
• Las celdas en color azul son parámetros con metadatos, haga click sobre ellos para mostrar la lista de opciones y seleccione el valor al que quiera cambiarlo.
• Las celdas en color rojo son parámetros que se encuentran fuera del rango configurado en la librería.

Cuando realice un cambio en una celda, si está dentro del rango establecido en las columnas Min. y Max., se volverá verde lo que significa que la celda del valor ha cambiado correctamente. En caso contrario, se pondrá de color rojo y se ignorará en las operaciones de escritura sobre controles por seguridad.

Inicialmente, el mapa de parámetros vendrá ordenado ascendentemente por la columna ID. Aun así, es posible reordenar el mapa a su gusto haciendo clic izquierdo sobre el nombre de cualquier columna.

Nuevo mapa

Se podrá crear un nuevo mapa de parámetros pulsando la opción "New". En el diálogo, seleccionar la librería en la que se basará el nuevo mapa (habrá que tenerla descargada previamente).

Cargar un mapa

Botón de cargado de mapa de parámetros.

Para cargar un mapa a partir de un archivo de mapa de parámetros, basta con pulsar en "Cargar mapa".

Se abrirá un diálogo para seleccionar el archivo de mapa de parámetros, que deberá estar en formato .xls o .ods (Excel u OpenDocument). Una vez localizado, pulse "Abrir".

Inicialmente, kiParameters buscará la librería correspondiente al mapa entre las que se encuentren descargadas y, si no la encuentra y dispone de conexión, entre las que se encuentras alojadas en la plataforma mykiconex.

Para una operación lo más eficiente posible, descargue o importe previamente las librerías que utilice con más frecuencia. Vea cómo hacerlo en el apartado Librerias.

Guardar un mapa

Botón de guardado de mapa de parámetros.

Una vez cargado y modificado un mapa, podrá generar un archivo de hoja de cálculo pulsando en “Guardar mapa”.

Creará un archivo Excel u OpenDocument (.xls o .ods) que se podrá volver a cargar en kiParameters para modificarlo de nuevo, o subirlo a mykiconex para aplicar la configuración a una instalación remota.

Leer un mapa desde un control

Botón de lectura de un dispositivo.

Pulse en “Leer dispositivo” para cargar un mapa de parámetros a partir de un dispositivo, no de un archivo.

Leer un mapa localmente

Seleccione la opción “Local” y la modalidad Modbus en la que quiere realizar la lectura (Modbus RTU o Modbus TCP). Deberá de rellenar la configuración de la comunicación para continuar:

• Si selecciona "RTU", elija el puerto serie (consulte cual es el correcto en “Administrador de dispositivos” de Windows), la dirección Modbus del control, la velocidad, el tamaño del mensaje, el tipo de paridad y el número de bits de parada.
• Si selecciona "TCP", incluya la dirección IP y puerto.

• Configuración de una lectura de dispositivo mediante Modbus RTU (izda.) o TCP (dcha.).
• 
• 

Continúe seleccionando una librería de entre las que tenga descargadas. (para descargar una librería, consulte el apartado Librerias y pulse en “Leer dispositivo”.

Leer un mapa a través de kiconex

Esta opción permite cargar un mapa de parámetros sin necesidad de descargar una hoja de cálculo desde mykiconex.

Seleccione “kiconex” y haga clic en la entrada de instalaciones, aparecerá un listado con todas la instalaciones a las que tiene acceso el usuario, seleccione la deseada.

Haga clic en la entrada de controles y, de igual modo, seleccione del listado el control del que quiere leer el mapa de parámetros y pulse el botón “Leer dispositivo”.

Configuración de una lectura de dispositivo utilizando kiconex.

Escribir un mapa

Botón de escritura de un dispositivo.

Para enviar un mapa de parámetros a un control, deberá de cargar o leer un mapa de parámetros y pulsa el botón “Escribir dispositivo”.

Escribir un mapa localmente

Al igual que en la funcionalidad de lectura del mapa, seleccione la modalidad Modbus en la que quiere realizar la lectura (Modbus RTU o Modbus TCP). Deberá de rellenar la configuración de la comunicación para continuar:

1. Si selecciona RTU, elija el puerto serie (consulte cual es el correcto en “Administrador de dispositivos” de Windows), la dirección Modbus del control, la velocidad, el tamaño del mensaje, el tipo de paridad y el número de bits de parada.

   

   Configuración de una escritura de dispositivo utilizando Modbus RTU.

2. Si selecciona TCP, incluya la dirección IP y puerto.

En ambos casos, tendrá la posibilidad de enviar todos los parámetros o sólo los sobre los que se han hecho cambios (las celdas en verde).

Escribir un mapa a través de kiconex

Lamentablemente esta opción no esta disponible actualmente, aunque puede guardar el mapa y subirlo al control remotamente utilizando mykiconex y su funcionalidad de importación de parámetros.

Exportar mapa a PDF

Botón de exportación a PDF de un mapa de parámetros.

Es posible generar un archivo de texto PDF con el mapa de parámetros. Una vez haya cargado un mapa, pulse en “Exportar a PDF”.

Se abrirá una ventana emergente en la que podrá configurar los parámetros de su PDF:

• Ruta del PDF (obligatorio): lugar donde guardará el PDF generado.
• Ruta logo (obligatorio): podrá incluir el logo de su organización en la cabecera del PDF. Si no lo hace, se incluirá por defecto el logo de kiconex.
• Nombre: Identificador que se le quiera dar al mapa de parámetros.
• Librería: en la que está basado el mapa.
• Notas: campo para incluir texto que sirva de información auxiliar para el mapa.
• Columnas opcionales: podrá añadir de forma opcional dos columnas con el ID de parámetro de la librería y el registro Modbus del mismo.

Una vez termine, pulse en “Guardar”.

Cerrar mapa

Botón para cerrar un mapa de parámetros activo.

Reinicie la vista del programa haciendo clic en el botón “Cerrar mapa”.

Gestión de librerías

En la pestaña “Librerías” se encontrarán las acciones relacionadas con la gestión de librerías.

Buscador de controles a partir de librerías

Botón para buscar controles a partir de una librería.

kiParameters permite localizar todos los controles en mykiconex que tienen cargados una librería, de forma que se puede localizar y depurar errores fácilmente. Para utilizar esta funcionalidad deberá de tener una sesión activa. Pulse en el botón "Buscador de controles".

Aparecerá una ventana emergente con el listado de librerías, busque y seleccione la que quiera consultar y pulse en "Buscar".

Listado con las librerías disponibles para ese usuario en mykiconex.

Se creará otra ventana emergente, en este caso con una tabla donde se muestra el listado de controles que tienen cargada la librería seleccionada en mykiconex. En la lista aparecerá la información necesaria para identificarlos en la plataforma:

Listado con los resultados en el buscador de controles por librería.

Exportación e importación de librerías

Si tiene una sesión de kiconex activa y acceso a las librerías, podrá ver el listado de las librerías que hay disponibles en kiconex a la derecha. En caso contrario, esta estará deshabilitada. Podrá descargarlas seleccionándolas y pulsando el botón de descarga. Aparecerá en el listado de la derecha cuando la descarga finalice.

En este listado aparecen las librerías que kiParameters tiene disponibles. Los botones de la derecha se utilizan para gestionarlas, entre los que destacan los de exportación (genera un archivo en formato JSON con todos los datos de la librería) y el de importación (que admite dicho tipo de archivos y lo incluye en kiParameters).

Las librerías que estén descargadas serán las que estén disponibles para la lectura y carga de mapa de parámetros cuando el programa esté en modo offline.

Test Modbus

Esta pestaña, como su propio nombre indica, se utiliza para realizar peticiones Modbus, ya sea local o remotamente. Primero, deberá de configurar los parámetros de comunicación:

• En caso de conectarse de forma local:
  • RTU: puerto (consulte el correcto en “Administrador de dispositivos”), dirección Modbus, velocidad, bits de datos, tipo de paridad y número de bits de parada.
  • TCP: dirección IP y puerto.

• Configuración de un test Modbus de forma local mediante RTU (izda.) o TCP (dcha.).
• 
• 

• A través de kiconex, seleccione la instalación y para:
  • RTU: El índice del puerto y la dirección Modbus.
  • TCP: dirección IP y puerto.

• Configuración de un test Modbus de forma remota mediante RTU (izda.) o TCP (dcha.).
• 
• 

Después, configure la petición: registro Modbus donde se inicia la consulta, número de registros a consultar y función Modbus que se utilizará. En caso de que la función sea de escritura, se habilitará el campo “Valor” para indicar el valor a escribir.

• Configuración de un test Modbus de forma remota mediante RTU (izda.) o TCP (dcha.).
• 
• 

Una vez lista la petición, pulse en enviar, si todo ha ido bien se mostrará la respuesta en distintos formatos. En caso contrario, se mostrará que ha habido un error en la lectura.

Exportación de datos

Esta funcionalidad replica a la funcionalidad de Informes de mykiconex, para poder exportar en hojas de cálculo los datos recogidos y guardados en la plataforma. Seleccione el rango de tiempo que desea consultar.

Seleccione instalación, control y añada las variables de las que quiere obtener datos. Podrá seleccionar varias a la vez e incluso varias de distintos controles e instalaciones, pero no de distintos rangos temporales.

Las variables añadidas aparecerán en la tabla inferior, podrá seleccionar y eliminar o exportar los datos. Aparecerá un dialogo para localizar y nombrar el archivo.

Configuración

En esta pestaña se podrá modificar la configuración por defecto de las comunicaciones Modbus. La configuración que guarde será la que aparecerá automáticamente en los pop-ups de la pestaña Mapa o en la pestaña de Test Modbus.

Actualización de kiParameters

Puede consultar la versión que tiene instalada en el apartado Ayuda / Acerca de... en la propia aplicación. Si tiene una versión obsoleta y quiere actualizar el programa con una versión nueva, se deben de seguir los siguientes pasos:

1. En Panel de Control / Programas / Programas y características aparecerá un listado con todos los programas instalados en su equipo. Haga click derecho en kiParameters y seleccione "Desinstalar".
2. Aparecerá una ventana de confirmación. Pulse "Sí".
3. Cuando el proceso finalice, proceda a ejecutar el instalador de la nueva versión.

Reporte de bugs

Para comunicar al equipo de kiconex problemas o sugerencias para el programa, envíen un mensaje a nuestro equipo de soporte o generen una petición en nuestra plataforma de soporte.

Incluyan lo siguiente en el mensaje:

1. Pestaña donde ocurrió.
2. Pasos que se hicieron para generar el error (si es posible).
3. Si se utilizó alguna funcionalidad de mykiconex, indiquen librería o instalación y control.
4. Captura de la ventana de terminal que se abre cuando se ejecuta el programa.