Contexto y Variables de Entorno en Node-RED

Contexto

En Node-RED, una consideración es cómo administrar cualquier información de estado en sus flujos. Por ejemplo, llevar un recuento de cuántos mensajes pasan por un flujo o el estado actual de un sensor externo.

Node-RED proporciona el sistema de contexto para administrar el estado dentro del tiempo de ejecución. El contexto puede tener el alcance de la misma pestaña, subflujo o estar disponible globalmente.

Si solo los nodos de una pestaña en particular necesitan una parte de la información de estado, debe utilizar un ámbito de flujo en lugar de global. También debe elegir con cuidado los nombres de las variables de contexto; asegúrese de que sean descriptivos y fáciles de identificar.

Si un solo nodo necesita acceder a un valor, como un nodo de función o un contador, el contexto de nodo es suficiente.

Otra opción es administrar el estado fuera de Node-RED, como usar mensajes MQTT retenidos o una base de datos de algún tipo. Esas opciones agregan una dependencia externa para administrar y no están tan convenientemente integradas como las variables de contexto, pero también se pueden usar junto con el contexto y no como un reemplazo completo. Por ejemplo, cuando desee compartir la información de estado en varias instancias de Node-RED, o en el caso de MQTT, poder activar un flujo siempre que cambie un valor.

Documentación oficial: https://nodered.org/docs/user-guide/context 

Api context: https://nodered.org/docs/api/context/

Node-RED proporciona una forma de almacenar información que se puede compartir entre diferentes nodos sin utilizar los mensajes que pasan por un flujo. Esto se llama «contexto».

En node-red se puede trabajar con variables de contexto:

  • Contexto – solo aplica a un nodo
  • Flujo – aplica solo al flujo
  • globales – aplica a todo.

Por defecto, Node-RED utiliza un almacén de contexto en memoria, los valores no se guardan entre reinicios. Se puede configurar para usar un almacén basado en el sistema de archivos para que los valores sean persistentes. También es posible conectar complementos de almacenamiento alternativos.

Node-RED proporciona dos módulos integrados para esto: memory y localfilesystem. Es posible configurar Node-RED para guardar datos de contexto en disco para que esté disponible en todos los reinicios, se almacena en caché los valores en la memoria y solo los escribe en el sistema de archivos cada 30 segundos.

La forma más fácil de establecer un valor en contexto es usar el nodo Change. Por ejemplo, la siguiente regla de cambio de nodo almacenará el valor de msg.payload en el contexto de flujo bajo la clave de myData.

Varios nodos pueden acceder al contexto directamente. Por ejemplo, el nodo Inject puede configurarse para inyectar un valor de contexto y el nodo Switch puede enrutar mensajes en función de un valor almacenado en contexto.

El contexto se puede eliminar de forma permanente mediante el uso de un conjunto de nodos Change para eliminar o desde la barra lateral en la pestaña “Context Data”

Mas información: http://www.steves-internet-guide.com/node-red-variables/ 

La barra lateral de contexto muestra el contenido del almacén de datos de contexto. El panel se divide en tres secciones, una para cada ámbito de contexto; nodo, flujo y global. Se debe hacer clic en el botón de actualización para cargar el contenido del contexto.

Las secciones Nodo y Flujo tienen una casilla de verificación junto a su botón de actualización para activar la actualización automática de los contenidos cada vez que cambia el nodo o flujo seleccionado.

Al pasar el mouse sobre cualquier nombre de propiedad de contexto, se mostrará un botón de actualización que se puede usar para actualizar solo ese valor.

Al pasar el cursor sobre el valor de una propiedad de contexto, se mostrará un botón para copiar su contenido en el portapapeles del sistema.

Addon para ver el context en node red: https://flows.nodered.org/node/node-red-contrib-contextbrowser

Varios nodos pueden acceder al contexto directamente. Por ejemplo, el nodo Inject puede configurarse para inyectar un valor de contexto y el nodo Switch puede enrutar mensajes en función de un valor almacenado en contexto.

Nodo para almacenar información de configuración en una ubicación central y usarla para establecer propiedades de contexto de flujo y globales al inicio (fase de inicialización) o durante el tiempo de ejecución. Se pueden usar varios nodos de configuración para almacenar ajustes de configuración alternativos y cambiar entre ellos durante el tiempo de ejecución: https://flows.nodered.org/node/node-red-contrib-config 

Ejemplo, enrutar un mensaje en función del valor de una variable de contexto: https://cookbook.nodered.org/basic/route-on-context 

Variables de Entorno

Las variables de entorno se pueden utilizar más ampliamente dentro de Node-RED para crear flujos que se pueden personalizar para diferentes plataformas sin tener que realizar cambios manuales.

Por ejemplo, puede tener un flujo que planea ejecutar en varios dispositivos, pero cada dispositivo debe suscribirse a su propio tema MQTT único.

Al igual que en el ejemplo de subflujo, puede configurar el nodo MQTT para publicar en $ {MY_TOPIC} y luego establecerlo como una variable de entorno antes de ejecutar Node-RED. Eso permite que esas personalizaciones específicas del dispositivo se mantengan por separado de los flujos que deberían ser comunes a todos los dispositivos.

Se puede usar el mismo enfoque cuando los flujos pueden ejecutarse en diferentes sistemas operativos, donde la ruta a un archivo utilizado por los flujos puede ser diferente según el sistema operativo.

Los nodos Inject y Change pueden acceder a las variables de entorno utilizando la opción «env» en su TypedInput. El nodo Función puede usar la función env.get ().

Trabajar con variables de entorno:

Cualquier propiedad de nodo se puede establecer con una variable de entorno estableciendo su valor en una cadena de la forma ${ENV_VAR}. Cuando el tiempo de ejecución carga los flujos, sustituirá el valor de esa variable de entorno antes de pasarla al nodo.

Esto solo funciona si reemplaza toda la propiedad; no se puede usar para reemplazar solo una parte del valor. Por ejemplo, no es posible utilizar CLIENT-${HOST}

Como los nodos proporcionan su propio diálogo de edición, no todas las propiedades proporcionarán una entrada de texto que se pueda utilizar para introducir la cadena env-var. En ese caso, puede considerar editar manualmente el archivo de flujo para establecer la propiedad.

No puede establecer variables de entorno en tiempo de ejecución. Solo se evalúan cuando se inician los flujos.

El tiempo de ejecución obtiene sus valores antes de pasarlos a nodos individuales. Los nodos no saben que el valor proviene de una variable de entorno. Si cambia una var env, no hace que mágicamente el nodo cambie su configuración. Debería reiniciar Node-RED para recoger los cambios.

Una forma de configurar las variables de entorno es en su archivo settings.js.

Lo siguiente establecerá la variable de entorno MY_ENV_VAR: process.env.MY_ENV_VAR = «Hello World»;

Puede agregar líneas como esa en la parte superior de su archivo de configuración.

La otra opción es configurarlos completamente fuera de Node-RED en el shell en el que está ejecutando Node-RED. Cómo lo haga dependerá de su sistema operativo y de cómo esté ejecutando Node-RED.

Nodo para leer variables de entorno https://flows.nodered.org/node/node-red-contrib-env

Ejemplo de uso de env var: https://flows.nodered.org/flow/8a13d11dfe80e279df83341e3e17bcc1 

Usando el Widget TypedInput

Dentro del editor, el widget TypedInput puede ofrecer «variable de entorno» como tipo. Cuando se selecciona este tipo, su valor se evaluará de la siguiente manera:

  • si no hay $ {} presente, usa el valor completo como el nombre de la variable de entorno. Por ejemplo, «FOO» se reemplazará con el valor de process.env.FOO
  • si $ {} está presente, sustituirá la variable de entorno correspondiente en el resultado: por ejemplo, dado el valor «Hola ${FOO}» y la var env FOO se establece en Mundo, esto da como resultado el valor «Hola mundo»

Variables de Entorno en Subflows

Desde 0.20, los subflujos se pueden configurar con propiedades de instancia. Estos aparecen como variables de entorno dentro del subflujo y se pueden personalizar para instancias individuales del subflujo.

Por ejemplo, dada una API REST que proporciona acceso a diferentes tipos de registro, se podría crear un subflujo para acceder a la API y manejar la respuesta, utilizando una variable de entorno para identificar a qué tipo de registro se debe acceder. Las instancias individuales del subflujo se pueden personalizar para esos tipos particulares.

Almacenamiento de Contexto

Por defecto, el contexto se almacena sólo en la memoria. Esto significa que su contenido se borra cada vez que se reinicia el Node-RED. Con la versión 0.19, es posible configurar Node-RED para guardar datos de contexto de modo que estén disponibles en los reinicios.

La propiedad contextStorage de settings.js puede utilizarse para configurar cómo se almacenan los datos de contexto.

Node-RED proporciona dos módulos incorporados para ello: memory y localfilesystem. También es posible crear plugins de almacenamiento personalizados para guardar los datos en otro lugar.

Para habilitar el almacenamiento basado en archivos, se puede utilizar la siguiente opción:

 contextStorage: {
    default: {
        module: "localfilesystem"
    }
 } 

Esto establece que el almacén contextual por defecto sea una instancia del plugin localfilesystem, con todos sus ajustes por defecto. Esto significa que:

  • almacenará los datos de contexto en archivos bajo ~/.node-red/context/
  • almacena los valores en la memoria y sólo los escribe en el sistema de archivos cada 30 segundos.

Es posible configurar más de un almacén para que algunos valores se guarden en el sistema de archivos local y otros sólo se mantengan en la memoria.

Por ejemplo, para configurar el almacén predeterminado para que sólo esté en memoria, y un segundo almacén para el sistema de archivos, se pueden utilizar las siguientes opciones:

 contextStorage: {
    default: "memoryOnly",
    memoryOnly: { module: 'memory' },
    file: { module: 'localfilesystem' }
 } 

En este ejemplo, la propiedad por defecto le dice a Node-RED que guarde en memoria el contexto, si una solicitud de acceso al contexto no especifica un almacenamiento concreto.

Los detalles completos de los módulos incorporados, las opciones de configuración que ofrecen y cómo crear módulos personalizados, están disponibles en las páginas de la API: https://nodered.org/docs/api/context/

Opciones de guardado en fichero local el contexto: https://nodered.org/docs/api/context/store/localfilesystem

Varios nodos pueden acceder directamente al contexto. Por ejemplo, el nodo Inject puede configurarse para inyectar un valor de contexto y el nodo Switch puede enrutar mensajes basados en un valor almacenado en el contexto.

Si tiene varios almacenes de contexto configurados, la interfaz de usuario le permitirá elegir en qué almacén debe almacenarse un valor.

El contexto puede ser eliminado permanentemente usando un nodo de change establecido para eliminarlo.

Si se guarda en disco, los datos de las variables de contexto se almacenan en el directorio: .node-red/context

Se debe tener en cuenta que los datos se guardan en disco cada 30 segundos, lo que puede ser suficiente para algunas aplicaciones, pero para otras no.

Para hacer mediante código, debe hacerse set la variable de contexto a undefined.

Por ejemplo, para eliminar todas las variables del contexto de flow:

 var keys = flow.keys();
 keys.forEach(element => flow.set(element,undefined)); 

Más información: https://nodered.org/docs/user-guide/context#context-stores

3 comentarios en “Contexto y Variables de Entorno en Node-RED

  1. Pingback: Saber Más Node-RED Developer | Aprendiendo Arduino

  2. Pingback: Contexto y Variables de Entorno en Node-RED -

  3. Pingback: Diario del Curso IoT, Smart Cities y Node-RED | Aprendiendo Arduino

Deja una respuesta

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Salir /  Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Salir /  Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Salir /  Cambiar )

Conectando a %s

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.