node-red-contrib-persistent-fsm 1.2.1

A Node Red node for implementing a finite state machine.

npm install node-red-contrib-persistent-fsm

A Node-Red node that wraps around the Javascript State Machine to implement a finite state machine for Node-Red.

Combination of DeanCording's and lutzer's similar libraries with the following notable changes:

  • State can optionally persist during re-deployment of nodes.
  • Deprecated Node-RED events have been replaced.
  • Invalid transition error includes details of request.
  • Excellent input UI from DeanCording combined with simple graphical rendering from lutzer. Best of both worlds.

Note: If you want to use this library instead of node-red-contrib-state-machine, simply remove that node from your palette, then install this one. All node configuration should be saved.

Usage

The node is configured with a number of states and triggers that will cause the node to transition from one state to another. At any time, the node can only be in one of the defined states and it will only transition to another state when it receives a trigger defined for the current state. The same trigger can be used to cause transitions from more than one state.

Triggers that are not valid for the current state can either be ignored or cause an error to be throw that can be caught by a Catch node.

The node will always start in the first state on the state list (unless "Persist on re-deploy" is enabled) and will (optionally) emit a message with the initial (or saved) state if the state output is set to a message property.

Global and flow context properties can be used as trigger inputs but state transitions will only occur when the node receives a message.

The current state can be set to a msg property or stored as a flow or global context property. If the state output is set to a msg property, that property is set in the original message and passed through, otherwise no messages are output.

Node Info

Version: 1.2.1
Updated 1 year, 3 months ago
License: MIT
Rating: 5.0 2

Actions

Rate:

Downloads

154 in the last week

Nodes

  • state-machine

Keywords

  • node-red
  • iot
  • state machine
  • finite state machine
  • state
  • transition

Maintainers