Notice: For the full RPNlib documentation, see https://github.com/mcspr/rpnlib#expressions

The "RPN Rules" module is an advanced feature that let's you define pretty flexible custom rules to execute actions based on different inputs. Rules are defined as a series of commands using Reverse Polish Notation, also called "postfix" notation, where operators come after the operands.

This might look somewhat complicated but it actually has major benefits over the usual "infix" notation:

• Commands (rules) are faster to process
• Rules are simple to understand
• It's easier to implement

• RPN Rules
  • Table of Contents
  • Main concepts
    • Postfix notation
    • Tokens
    • Stack
    • Operators
    • Variables
    • MQTT variables
    • Rule execution
  • Examples
    • Toggle a heater depending on a temperature sensor
    • Open light at night if there is presence
    • Emulate the schedule
    • Light color following power consumption
    • Individually synchronize relays
  • Terminal commands

First you should familiarize yourself with RPN calculation. Reverse Polish notation (RPN) is a mathematical notation in which operators follow their operands. It does not need any parentheses as long as each operator has a fixed number of operands.

A simple calculation in infix notation might look like this:

( 4 - 2 ) * 5 + 1 =

The same calculation in RPN (postfix) will look like this:

4 2 - 5 * 1 +

It results in a shorter expression since parenthesis are unnecessary. Also the equals sign is not needed since all results are stored in the stack. From the computer point of view is much simpler to evaluate since it doesn't have to look forward for the operands.

Each element in an expression is called "token" (not a standard name). Tokens can be:

• Numbers, always considered as real numbers (floats)
• Operators (+, -, ...)
• Variables (starting with a $ sign)

As I already mentioned, operands (numbers) are pushed into a stack and later operators pop the number of operands from the stack. Let's take a closer look to a simple RPN expression: 4 2 - 5 * 1 +. The first column shows the next token to process and the third column the status of the stack after processing the token. At the beginning the stack is (usually) empty.

Notice: For the full list of operators, see https://github.com/mcspr/rpnlib#operators

Of course you need to know the vocabulary, i.e. the available operators. There are different types of operators:

• Mathematical (+, -, *, ...)
• Stack manipulation (dup, swap, ...)
• Comparison (eq, gt, cmp, ...)
• Logical (and, or, ...)
• Time management (now, hour, minute,...)
• ESPurna related (relay, channel, oneshot_ms, every_ms,...)

Both require that the operator is reached at least once for the timer to start; we don't parse the expression before hand to figure out the timers, operator itself starts the timer. Until the timer is expired, operator will stop the current rule execution. After the timer is expired, rule will be allowed to continue.

If timer was specified as 'oneshot_ms', to restart the timer it would need to be called again and the timer will be removed after the last RPN rule.
For 'every_ms', timer is restarted automatically.

Both operators are intended to be used with rpnRule#, rpn.test won't be able to trigger things based off of the timer expiration.

Every received code is preserved in the internal cache (see RFB.CODES terminal output)

Cache configuration:

Protocol argument depends on the RFB_PROVIDER flag. For the stock RFBridge, there is only a single protocol (0u, 2nd argument of the rfb_match). For example, to update $movement value each time we see code "123456":

1u 0u "123456" rfb_match millis &movement =

Or, to toggle the relay when the code is received twice:

2u 0u "567891" rfb_match 2 0 relay

₁ See https://github.com/esp8266/Arduino/tree/master/libraries/esp8266/examples/LowPowerDemo#low-power-demo for more information about the WiFi operation.
₂ JustWifi boot sequence will interfere with the RF_DISABLED by always enabling the WiFi connection.

Note that ifn, unlike generic programming language's if, does not allow different 'branches' and RPNlib does not allow operator references (yet) to be stored on the stack. Any token encountered while parsing the expression and matching with the operator name will immediately call the associated function.

Variables are stored in the module context so they can be used from your expressions. Variables are fed from different sources:

• Relay status ($relay0, $relay1,...)
• Lights channel values ($channel0, $channel1,...)
• Sensors ($temperature0, $humidity0,...)
• MQTT (custom names)

By default they are persistent (meaning that once defined they are available for any rule execution in the future) but they do not persist across reboots. This behavior is called "sticky variables" and can be changed from the UI. Non sticky variables get deleted after the next rule execution. This can be useful to avoid dead locks when used with other features like relay pulses.

It is possible to create or overwrite the existing variable by changing '$' to '&' before the variable's name and using a special operator =. For example:

11 &variable = 

If 'variable' exists, it's value will be replaced with '11'. If 'variable' does not exist, it will be automatically created and assigned the value.

When using '$variable' syntax, expression will not continue if 'variable' does not exist.

MQTT variables are a special type of variable that gets its content from MQTT topics. You can define an MQTT and a variable name and every time the topic receives a message the variables will get updated and the rules will be executed.

At this time, the only type available for MQTT variables is floating point.

Rules get executed X milliseconds after the last execution trigger. The execution delay is 100ms by default but it can be changed from the web UI. This allows for a buffer time so all variables coming from sensors get updated before rules are executed.

All variables changes trigger the rule execution after the delay time. So every time a relay is toggled, every time a sensor reports values or every time one of the MQTT topic gets updated the rules will be executed.

Imagine you have a device with a relay controlling a heater and a temperature sensor. You can implement a simple thermostat with hysteresis using the input variables of the sensor ($temperature0) and the relay ($relay0):

$temperature0 18 24 cmp3 1 + [ 1 $relay0 0 ] index 0 relay

Let's split the expression in parts:

This expression will ensure the relay in ON if the temperature is below 18C and OFF if it's above 24C. If the reported temperature is in between 18 and 24 the relay status will not change.

In this case image we have a simple WiFi relay device and a PIR in the same room that reports presence via MQTT to the /livingroom/motion topic. We first define an MQTT topic for it using motion as the variable name. Then we can trigger the light if there is motion between 22h and 8h in the morning.

now hour 8 23 cmp3 abs $motion and 0 relay

Again, let's analyze it step by step

Since our device will only have a relay, this rule will be executed every minute (triggered by the NTP module) and when there is a new value in the motion topic. Alternatively, if you disable the "stickiness" of the variables, the expression will fail except when the $motion is defined which will only happen after we receive a message to the motion topic.

Keep in mind that if the result changed the relay status, the relay change will trigger the rule execution again! Try to avoid loops in the rules like, for instance: 1 $relay0 - 0 relay. This simple expression will turn the relay ON and OFF and ON again and OFF again forever!!

The schedule is different to the previous examples since it will only perform an action at a given time, not every time there is a time or status update like the RPN Rules module. But we can easily emulate this behaviour by using $tick1m variable that is set every minute:

$tick1m dup minute 0 eq end hour 8 eq end null &tick1m = 1 0 relay 

The $tick1m variable contains the timestamp, while the 2nd expression using &tick1m resets it to null, removing it from variables list after the expression is done. The end operator takes and argument from the stack and ends the execution if the argument resolves to false. Hence:

It is also possible to schedule execution to happen every hour by checking for $tick1h variable.

RPN allows to start a periodic or one-shot timers (aka RPN runners), that will trigger rule execution when expired.

For example, execute the right part of the expression after timer is done:

5000u every_ms 2 0 relay

Execute the right part of the expression when variable is set to true, but wait 5 seconds first and then set variable to false:

$test end 5000u oneshot_ms false &test = "topic" "message" mqtt_send

Note that 5000u every_ms defined in multiple rules will create a single timer.

Some devices, like the Smartlife Mini Smart Socket, have an LED light (sometime RGB) and a power consumption monitor. Wouldn't it be cool that the light would turn more and more red as the power consumption rises?

black $power0 0 1000 0 255 map 0 channel update

This expression maps a power value between 0 and 1000W to a number between 0 and 255 and then it feeds it to channel 0 (usually red). Initially, it sets all channels to 0 (black) and at the end forces the light driver to update the color. Nice.

ESPurna has a relay synchronization feature that offers different ways to synchronize relays when there is more than one available, but all of these options perform actions of all the relays, turning them ON or OFF to match the required pattern. What if you have 4 different relays and you want to synchronize relays 0 and 1 together but leave 2 and 3 untied? Easy.

$relay0 1 relay

What if you want them to have opposite value?

1 $relay0 - 1 relay

Now you can control relays 0 and 1 by just changing relay 0. If you want to be able to perform an action on either 0 or 1 and toggle the other as well, you can create one rule for each but remember to disable "Sticky variables" to avoid getting into a loop:

1 $relay0 - 1 relay
1 $relay1 - 0 relay

The module exposes different terminal commands to test and evaluate expressions and variables.

• RPN.OPS will output the list of available operators and the number of required arguments for each of them
• RPN.TEST "<expression>" will execute the expression and output the stack at the end, useful to do partial tests of sub-expressions
• RPN.VARS will output the current defined variables and their values
• RPN.RUNNERS will show the currently running timers