Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 3.38 KB

README.md

File metadata and controls

69 lines (46 loc) · 3.38 KB

Nodes for user-friendly use of the Node-RED context stores.

Platform npm version MIT License GitHub issues open GitHub Actions Coverage Status

A user-friendly abstraction of the Node-RED context stores.

The idea behind persistent values is the user-friendly abstraction of the Node-RED core context functionality. Instead of using a string name to access the context storage a central configuration node with all known persistent values is used.

The persistent values itself can then be comfortably accessed with nodes just referencing the central configuration and the persistent value to be accessed.

Persistent values are typically states, configuration options etc. which shall survive a restart of Node-RED.

Features

  • Central configuration of all known persistent values (states, config options, ...).
    • Dataypes: Bool, Number, String, JSON
    • Default value
    • Scope and Storage type
    • Optional description
  • Node to read, write or reset a concrete persistent value referenced via the config.
  • Configurable msg property for input of new persistent value or output of the current value.
  • Configurable msg property for output of previous persisted value.
  • Append the current persistent value as object attribute to an configurable msg property.
  • Block further flow processing (no output) if the current value matches with a configured rule.
  • Dynamic override of configured command and value with msg properties.

Installation

You can install the nodes using the Node-RED 'Manage palette' in the side bar.

Or run the following command in the root directory of your Node-RED installation

npm install @waldbaer/node-red-persistent-values

NPM

Changelog

Changes can be followed here.

Usage

Introduction

  1. Add all necessary values to be persisted (states, config options, ...) to one or multiple configuration nodes.

  2. Select the desired configuration and value for read / write operations.

  3. Read, write or collect the persistet values in your flows!

Examples

Import into Node-RED instance via Node-RED -> Import -> Examples.