!Logo

[![NPM version][npm-version-image]][npm-url]

[![NPM downloads per month][npm-downloads-month-image]][npm-url]

[![NPM downloads total][npm-downloads-total-image]][npm-url]

[![MIT License][license-image]][license-url]



[![youtube][youtube-image]][youtube-url]

A set of Node-RED enhanced boolean logic and utility nodes, with persistent values after reboot. Compatible also with Homeassistant values.

CHANGELOG

- See here the changelog

EXAMPLES

Importable Node-RED example flows are available in the examples/ folder (one JSON per node). See examples/README.md for a quick overview.

How to import

- Node-RED editor → Menu (☰) → Import → Examples and select an example from node-red-contrib-boolean-logic-ultimate

TRANSLATOR NODE

Other than true/false, all nodes accepts Homeassistant output strings.

You can even add your own input translation word list, thanks to the translator-config node.

The translator node can translate an input payload, to a true/false boolean values.

Each row in the text box, represents a translation command.

There are some default translation's rows, to make the _boolean-logic-ultimate_ nodes compatible with Homeassistant as default.

You can add your own translation row.

| | Description |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Translate | Add, delete or edit your own translation command. The row's translation command must be input string:true(or false). For example: open:true closed:false. You can also use an expressions to be evaluated, like this {{value>=50}}:true and {{value<50}}:false. In this case, the tranlsator will evaluate (javascript eval) the expression and, if true, returns the choosen value. |

!alt text

BOOLEAN LOGIC

The node performs Boolean logic on the incoming payloads.

The node expects a fixed number of topics (configured in the settings) on which it will operate. It will only output a value

when it has seen the expected number of topics. If it ever sees more than the configured number of topics it will log a message then reset its state and start over.

The input message is preserved and passed to the output, changing only the topic and the payload.

The node performs some checks on the incoming boolean payloads and outputs all results at the same time, as follow:

- Output "AND": true or false

- Output "OR": true or false

- Output "XOR": true or false

If you need _"NAND"_ or _"NOR"_ gate, just put an InvertUltimate node respectively after the "AND" or "OR" output.

The node can have a persistent input: the input values are retained after a node-red reboot. That means, that if you reboot your node-red, you don't need to wait all inputs to arrive and initialize the node, before the node can output a payload.

You can also set the default values of the topic inputs.

The node can convert arbitrary input values to true/false. It supports Homeassistant string to boolean conversion as well. For enabling auto conversion, please be sure to disable Reject non boolean (true/false) input values

$3

| Property | Description |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Inputs count | Set the number of different topics to be evaluated. The node will output a message to the flow, after this number of _different_ topics arrives. _Remember: each input topic must be different. For example, if you set this field to 3, the node expects 3 different topics._ |
| Evaluate | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |
| Filter output | Output both 'true' and 'false' results: Standard behaviour, the node will output true and false whenever it receives an input and calculate the boolean logics as output. Output only 'true' results: whenever the node receives an input, it outputs a payload true only if the result of the logic is true. False results are filtered out. |
| Trigger mode | All topics: standard behaviour, the node will evaluate each input topic and ouputs the values. At each input change, it will output a msg on the flow. Single topic + eval other inputs: the node evaluates all the input topics, but only whenever it receives a msg input with the specified topic, it outputs a msg to the flow. |
| If input states are undefined | Every time you create a node or modify the node, all inputs are set to undefined. This means that the node will wait the arrive of all topics (for example 3 topics, if you've selected 3 topics in the option), before it can output a payload. This can be a problem if your logic must be operative as soon as you deploy the flow. To overcome this problem, you can "initialize" all the undefined inputs with True or False. Leave undefined: Standard behaviour, the node will wait all the "undefined" topics to arrive, then starts a flow with the result. True or False: The node is immediately operative, by force the initialization of the "undefined" inputs with "true" or "false". |
| Remember latest input values after reboot | If checked, the input values are retained after a node-red reboot. That means, that if you reboot your node-red, you don't need to wait all inputs to arrive and initialize the node, before the node can output a payload. Every time you modify the node's config, the retained values are cleared. |
| Reject non boolean (true/false) input values | If checked, the node will accept only boolean true/false values. Otherwise, it will try to convert the payload value to a logic true/false boolean. |
| Delay evaluation (ms) | Delays the evaluation until this time (in milliseconds) is elapsed. Each time a message or "topic trigger message" (see Trigger mode) arrives, the delay is restarted. This option is useful for debouncing pourposes or simply for adding some delay. For example, you can turn on a light if the room is occupied for a long time, allowing people to fast transit repeatedly, without the need of turning the light on. Another example, if you have many sensors changing state rapidly, you can wait until these sensor reach a quiet state, then evaluate the inputs. |

INPUT MSG TO THE NODE

| Input msg | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| msg.reset = true | Resets all saved input values to undefined |
| msg.inputcount | Changes the inputs count property. For example, msg.inputcount = 3 Whenever you lower the inputcount from a higher number to a lower one, for example from 3 to 2, it's suggested to do a msg.reset=true to reset all stored input values. |

INTERRUPT FLOWS ULTIMATE

The interrupt flows is able to stop the input messages to exiting the node.

$3

| Property | Description |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Trigger by topic | Whenever the node receives a payload = false from this topic,it stops output messages to the flow. As soon it receives payload = true from this topic, the output messages start to flow out again. The node will output the current stored message plus an added property "isReplay = true", as soon as it receives a _msg.play = true_ from this topic. The node will clear the current stored message, as soon as it receives a _msg.reset = true_ from this topic. |
| With Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |
| Then | This property, allow you to auto toggle the selected start state (pass or block) after a timer has elapsed. You can choose from some pre-defined delays. If you have, for example, an Homekit-Bridged nodeset with a thermostat node or security system node in your flow, once node-red restarts, these homekit nodes output a default message to the flow. Just put an InterruptFlow node with a "block at start" behaviour and a toggle delay enabled behind homekit nodes, to temporary stop the chained nodes to receive the unwanted startup message. |

INPUT MSG WITH "TRIGGER" TOPIC

Pass msg.payload = true to allow messages to pass through

Pass msg.payload = false to prevent messages from passing through

Pass msg.play = true from a message having the "trigger" topic, to replay the last stored message

Pass msg.reset = true from a message having the "trigger" topic, to clear the last stored message


// Assume you set the "trigger by topic" field to "trigger"
// This code replays the last message and adds the property msg.isReplay = true to the output message.
msg.topic = "trigger"
msg.play = true;



// Assume you set the "trigger by topic" field to "trigger"
// This code clears the last stored message
msg.topic = "trigger"
msg.reset = true;


See the example below.

In this other example, you can see the property "play" in action. This property allow you to replay the last previously stored message.

This allow to save the state of a node and then replay it back whenever you want.

INVERT ULTIMATE

Outputs the inverted input. For example true -> false

The input message is preserved and passed to the output, changing only the topic and the payload. If the input message has it's own topic, it'll be preserved as well.

$3

| Property | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |

FILTER ULTIMATE

This node has 2 outputs.

If the input payload is true, the node will send true on output 1 and nothing on output 2

If the input payload is false, the node will send nothing on output 1 and false on output 2

The input message is preserved and passed to the output, changing only the topic and the payload. If the input message has it's own topic, it'll be preserved as well.

$3

| Property | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |

BLINKER ULTIMATE

The pourpose of this node is to blink a led or something.

output1 : outputs the value true/false

output2 : outputs the inverted value false/true

$3

| Property | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |

Pass msg.payload = true to start blinking

Pass msg.payload = false to stop blinking

Pass msg.interval = 2000 to change the blinking interval

- output1 stop behavior : when the blinker receives the stop message, you can select the behavior of the output1

- output2 stop behavior : when the blinker receives the stop message, you can select the behavior of the output2

SIMPLE OUTPUT ULTIMATE

The pourpose of this node is to send a message with payload TRUE on the first output and FALSE on second output, independently from the msg input.

This is useful if you need to simply send a true or false payload.

$3

| Property | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |

INJECT ULTIMATE

The pourpose of this node is to send a message with payload TRUE on the first output, FALSE on second output and a TOGGLE (true/false) on the third output, by pressing the pushbutton.

This is useful if you need to simply test your flow.

STATUS ULTIMATE

The pourpose of this node is to show a status of the passingthrough message.

Show msg.

- Write here the property you want to get the status from. For example, "payload", "mycar.color", etc.

IMPULSE ULTIMATE

The pourpose of this node is to send a sequence of pulsed commands to for example, open a garage door or to command an appliance requiring a set of timed commands.

$3

| Property | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |

Avaiable Commands

Commands are to be wrote in the format: command:value. For example _send:200_, _wait:2000_. Each row represents a command.

send

sends a value. For example: _send:true_ or _send:100_ or _send:Hello_


wait

wait for specified time (in milliseconds). For example _wait:500_ waits for 500 milliseconds


restart

Restart the sequence from the beginning. Use _restart_ alone, without : and extra value. For example _restart_


//

comment. For example: _// This opens the garage_. The comment are ignored, so you can write what you want.

Pass msg.payload = true to the node to start the sequence

Pass msg.payload = false to the node to stop the running sequence

- Output: the node outputs a message you specified in the command textbox

MATH ULTIMATE

The pourpose of this node is to do maths on the incoming values. Each incoming message MUST HAVE OWN TOPIC.

$3

| Property | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |

INPUT

msg.reset

resets the values to zero.

- Output: the node outputs a message as follows:

{
  "payload": 30, // This is the math result
  "topic": "MyMath", // Node  Topic
  "average": 15, // This is the AVERAGE, in case of SUM
  "measurements": 2 // This is the number of topics that have been evaluated
}

br/>

TOGGLE ULTIMATE

The pourpose of this node is to toggle between true/false, everytime an inboud message arrives.

$3

| Property | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |

INPUT

Any message that arrives on input, will be passwd through to the output with the payload toggled between true and false.

RAILWAY SWITCH ULTIMATE

The railway switcher, redirect the incoming messages to one ot the avaiable output pins, just like a railway jinction switch.

$3

| Property | Description |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Switcher topic | Whenever the node receives a payload from this topic, it redirects the input messages to a choosen output PIN. |
| Output pins | Number of output pins (outputs) to show. Default is 5, range is 1..10. |
| With Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |
| Translator | Translates the incoming payload value. This allows the compatibility with, for example, HomeAssistant nodes. |

$3

The _Switcher topic_ controls where the railway switch must be switched, between the output PINs.

Once an output PIN has been choosen, all messages passing through the node will be deviated to te choosen output PIN.

: topic (string|number) : this is the topic of the switcher message.

: payload (number|boolean) : this is the ouput PIN selector, base 0 (0 is the first output PIN). Valid range is 0..(outputs-1).

$3

Take the example where you choosen such properties:

Switcher topic: "switcher"

With Input: "payload"

this JSON input message redirects all input messages to the first PIN

``json
{
"topic": "switcher",
"payload": 0
}
`

this JSON input message redirects all input messages to the second PIN

`json
{
"topic": "switcher",
"payload": 1
}
`

this JSON input message redirects all input messages to the third PIN, and so on...

`json
{
"topic": "switcher",
"payload": 2
}
`

See the example below.


Copy and paste it into your flow

`javascript
[
{
id: "8243309f7c926112",
type: "RailwaySwitchUltimate",
z: "aa3efc585a6c7b9b",
name: "Railway Switch",
triggertopic: "switcher",
outputs: 5,
initializewith: "3",
payloadPropName: "payload",
translatorConfig: "",
x: 350,
y: 260,
wires: [["7f5a2c19a9ef64c8"], ["5a35a650b225d910"], [], [], []],
},
{
id: "d7bbc077bc20f4ea",
type: "InjectUltimate",
z: "aa3efc585a6c7b9b",
name: "Junction switcher to Rail 0",
topic: "",
curVal: true,
outputJSON: '{ \n\t"payload":0,\n\t"topic":"switcher"\n}',
x: 350,
y: 80,
wires: [[], [], [], ["8243309f7c926112"]],
},
{
id: "5656d0c2ba66ed5e",
type: "InjectUltimate",
z: "aa3efc585a6c7b9b",
name: "Junction switcher to Rail 1",
topic: "",
curVal: true,
outputJSON: '{ \n\t"payload":"1",\n\t"topic":"switcher"\n}',
x: 350,
y: 160,
wires: [[], [], [], ["8243309f7c926112"]],
},
{
id: "2253336fa8374c78",
type: "InjectUltimate",
z: "aa3efc585a6c7b9b",
name: "Train",
topic: "",
curVal: true,
outputJSON: '{ \n\t"payload":"hello",\n\t"topic":"I\'m a train!"\n}',
x: 110,
y: 280,
wires: [["8243309f7c926112"], [], [], []],
},
{
id: "7f5a2c19a9ef64c8",
type: "debug",
z: "aa3efc585a6c7b9b",
name: "Rail 0",
active: true,
tosidebar: true,
console: false,
tostatus: true,
complete: "payload",
targetType: "msg",
statusVal: "payload",
statusType: "auto",
x: 590,
y: 260,
wires: [],
},
{
id: "5a35a650b225d910",
type: "debug",
z: "aa3efc585a6c7b9b",
name: "Rail 1",
active: true,
tosidebar: true,
console: false,
tostatus: true,
complete: "payload",
targetType: "msg",
statusVal: "payload",
statusType: "auto",
x: 590,
y: 300,
wires: [],
},
];
`

KALMAN FILTER ULTIMATE

Outputs the Kalman filtered input.

Please refer to this link, on how it works.

!image.png

| Property | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Input | It's the msg property to be evaluated. _By default, it is "payload", but you can also specify other properties, for example "payload.value"_ |
| Measurement noise | Kalman's R parameter. |
| Process noise | Kalman's Q parameter. |
| Translator Input | Translates the incoming payload value, to true/false. This allows the compatibility with, for example, HomeAssistant nodes. |

$3

: reset (any) : by passing msg.reset, the Kalman filter will be reset.

: payload (number) : the payload containing the number. If you've changed the incoming evaluation property in the _Input_ field, the number to be evaluated must be put in such message's property, instead of the _payload_ property.

RATE LIMITER ULTIMATE

Gateway per sensori e dispositivi troppo “chiacchieroni”: limita burst e rimbalzi con modalità Debounce, Throttle e Window. Lo stato del nodo riporta sempre modalità corrente, contatori di messaggi inoltrati e bloccati.

$3

| Property | Description |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Mode | Seleziona la logica: _Debounce_ (attende quiete), _Throttle_ (impone un intervallo minimo), _Window_ (massimo N messaggi per finestra temporale). |
| Wait (ms) | Ritardo di quiete per la modalità debounce. |
| Emit | Per debounce: scegli tra _Leading_ (subito), _Trailing_ (ultimo), _Both_. |
| Interval (ms) | Intervallo minimo tra messaggi in modalità throttle. |
| Emit trailing | In throttle, inoltra l’ultimo messaggio ricevuto allo scadere dell’intervallo. |
| Window size (ms) | Larghezza della finestra mobile in modalità window. |
| Max messages | Numero di messaggi ammessi nella finestra. |
| On limit | _Drop_ scarta i messaggi extra, _Queue last_ accoda l’ultimo e lo riproduce appena possibile. |
| Control topic | Topic dei messaggi di controllo (default rate). |
| With Input | Proprietà del messaggio da monitorare (default msg.payload). |
| Stats every (s) | Ogni quanti secondi emettere un riepilogo statistico (0 = disattivato). |
| Translator | Nodo translator-config opzionale per adattare le stringhe d’ingresso a true/false. |

$3

- Output 1: messaggi inoltrati, invariati.
- Output 2: diagnostica ({mode, reason, passed, dropped, msg, propertyValue}) e statistiche periodiche su controlTopic/stats.

$3

- msg.reset = true → azzera contatori, accoda azzerata e timer cancellati.
- msg.flush = true → forza l’emissione immediata del messaggio in attesa.
- msg.mode = 'debounce'|'throttle'|'window' → cambia modalità runtime e resetta lo stato.
- msg.interval, msg.wait, msg.windowSize, msg.maxInWindow → aggiorna i parametri corrispondenti.

PRESENCE SIMULATOR ULTIMATE

The purpose of this node is to replay a programmable sequence of messages in order to simulate occupancy when you are away.

$3

| Property | Description |
| ------------- | ---------------------------------------------------------------------------------------------- |
| Control topic | Topic used for runtime commands such as start/stop/reset. |
| Auto start | Starts the sequence automatically after deploy or restart. |
| Loop sequence | Repeats the sequence when it reaches the end. |
| Random delays | Enables a random variation of the programmed delays. |
| Jitter (%) | Maximum percentage of variation applied when random delays are enabled. |
| With Input | Message property to inspect for inline events (default payload). |
| Translator | Optional translator-config to convert incoming values. |
| Sequence | One JSON object per line, each containing at least delay (ms) plus the properties to output. |

$3

- msg.command = 'start' / msg.start = true → begin playback.
- msg.command = 'stop' / msg.stop = true → halt playback.
- msg.reset = true → reset counters and start position.
- msg.sequence = [...] → load a new sequence at runtime.
- msg.loop, msg.randomize, msg.jitter → update the corresponding options.

Each event in the sequence outputs a message configured in the JSON line. When random delays are enabled, the effective delay is varied within the configured jitter.

ALARM SYSTEM ULTIMATE (BETA)

This node implements an alarm control panel with multi-mode arming, zones, entry/exit delays, bypass, tamper/fire 24h zones, siren control, status and event log.

Example flow: examples/AlarmSystemUltimate.json

$3

| Property | Description |
| --------------------------- | ------------------------------------------------------------------------------------------------------------ |
| Control topic | Topic that receives runtime commands such as arm/disarm/status/bypass. |
| With Input | Message property evaluated as sensor value (default payload). |
| Persist state | Persists arming mode, bypass list and last log entries across restarts. |
| Require code for arm/disarm | Enables PIN checks using msg.code (or msg.pin). |
| Exit/Entry delay (s) | Global exit/entry delays (each zone can override entry delay). |
| Siren topic | Topic used on output 2 to turn the siren on/off. |
| Siren payloads | Values emitted on output 2 for siren on/off (typed). |
| Siren duration (s) | Auto stop duration (0 = latch until disarm). |
| Emit restore events | Emits zone_restore when a zone returns to false. |
| Event log size | Max stored log entries in node context. |
| Zones | One JSON object per line (legacy) or a JSON array (formatted). Use Format in the editor to pretty-print. |

Esempio JSON di una zona:

`json
{
"id": "front_door",
"name": "Front Door",
"topic": "house/door/front",
"type": "perimeter",
"modes": ["away", "night"],
"entry": true,
"entryDelaySeconds": 30,
"bypassable": true,
"chime": true
}
`

$3

- Output 1 (Events): msg.topic = /event, with msg.event and msg.payload (state + details).
- Output 2 (Siren): emits siren on/off commands on sirenTopic with the configured payloads.

$3

- Arm: msg.command = 'arm_away'|'arm_home'|'arm_night' or msg.arm = 'away'|'home'|'night'
- Disarm: msg.command = 'disarm' or msg.disarm = true
- Status: msg.command = 'status' or msg.status = true
- Bypass: msg.command = 'bypass'|'unbypass' with msg.zone = ''
- Panic: msg.command = 'panic' or msg.command = 'panic_silent'
- Siren: msg.command = 'siren_on'|'siren_off'
- Reset: msg.command = 'reset' or msg.reset = true

When codes are enabled, pass msg.code (or msg.pin). If duressCode matches, the node raises a silent duress alarm event.

STAIRCASE LIGHT ULTIMATE

The purpose of this node is to control staircase lighting with a timer, pre-off warning and optional extension on every trigger.

$3

| Property | Description |
| ------------------ | ------------------------------------------------------------------ |
| Control topic | Topic that receives manual commands such as on, off, extend. |
| Duration (s) | Lighting duration for each trigger. |
| Warning before off | Enables emission of a pre-off warning on output 2. |
| Warning offset (s) | Seconds before switch-off when the warning is sent. |
| Restart on trigger | Restarts the timer when a new trigger arrives while active. |
| Allow off input | Allows a false from the main input to switch off immediately. |
| With Input | Message property evaluated as trigger (default payload). |
| Translator | Optional translator-config for true/false conversion. |
| On/Off payload | Values emitted on output 1 to turn the light on/off. |
| Warning payload | Value emitted on output 2 when the warning fires. |

$3

- msg.command = 'on' / msg.start = true → start the timer and turn on the light.
- msg.command = 'off' / msg.stop = true → switch off immediately.
- msg.command = 'extend' / msg.extend = true → refresh the timer while keeping the light on.
- msg.duration, msg.warningEnabled, msg.warningOffset → adjust runtime settings.

Output 1 delivers the ON/OFF command. Output 2 delivers the warning and includes msg.remaining` with the seconds left.

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/LICENSE
[npm-url]: https://npmjs.org/package/node-red-contrib-boolean-logic-ultimate
[npm-version-image]: https://img.shields.io/npm/v/node-red-contrib-boolean-logic-ultimate.svg
[npm-downloads-month-image]: https://img.shields.io/npm/dm/node-red-contrib-boolean-logic-ultimate.svg
[npm-downloads-total-image]: https://img.shields.io/npm/dt/node-red-contrib-boolean-logic-ultimate.svg
[youtube-image]: https://img.shields.io/badge/Visit%20me-youtube-red
[youtube-url]: https://youtube.com/playlist?list=PL9Yh1bjbLAYoRH4IyQB7EL5srHAihiKpy