Upgrade advice - upgrade from aarch64 to ARM64 image

[toggledbits]

Reactor 21138

• 0000208 Cloning action in group clones group rather than action;
• 0000206 Restrict sun condition offset results to current day (prevents overrun and state lock when very large offsets are used);
• 0000204 Button text and color consistency on editors;

Documentatation (Installation) updates; IP filtering for API access; code refactoring/cleanup; bless Hass to 2021.5.4; UI improvements (autogrow input fields, improve expand/collapse aesthetics); log message cleanup.

Docker images are available on DockerHub as (now) usual. Generic package downloadable via Download button in the bug tracker.

[toggledbits]

Build 21139:

• 0000211 Injection caused while fixing Sun conditions for 206.
• 0000209 Cloning rule leaves "Set Variable" actions tied to source rule's expressions.

[toggledbits]

Build 21140

• 0000213 Timer change causes queue stall on Vera actions (seen as stalled reactions in Status panel)

[toggledbits]

Build 21146

• 0000214 Fix "each" examples in documentation
• 0000144 Feature: per-entity overrides/exceptions for Vera
• 0000143 Feature: per-device overrides on name, capabilities, primary attribute

Documentation updates; UI usability/consistency tweaks.

[toggledbits]

Build 21153

• 0000215 Hubitat connections may stall after hub reboot when "Hub Login Security" is enabled. See #215 for details.

Also: updates to lexpjs to allow min()/max() of array arguments; fix to pushbutton attributes for Hubitat; installation doc updates.

BARE-METAL (NOT DOCKER) USERS -- PLEASE RUN npm update --no-save IN YOUR REACTOR DIRECTORY AFTER UPDATING/BEFORE RESTARTING.

SYNOLOGY DOCKER USERS: Build 21160 (next week) will be the last build of the Synology-specific image (latest-synology-amd64). After that, Synology will be supported exclusively via the generic-amd64 image. If you are currently using the latest-synology-amd64 image, you will need to rebuild your container using the latest-generic-amd64 image (soon).

[toggledbits]

Build 21158

• 0000217 Fix path handling for Windows causing error loading Notifiers. This only applies to Windows

Documentation tweaks; header now shows both host (MSR server) and browser time.

[toggledbits]

Build 21163

• Fix 0000219 On Weekday conditions, the quick-set links for Weekday and Weekend don't stick unless you do other edits.
• (No PR fix) The UI's host time display now shows the "engine" time, which is the host time unless test_time is in effect, in which case the current test time is shown.

Debug log level 5 messages for Engine have been enhanced to more clearly show actions in reactions as they execute, and in particular, can now be more easily used to tell what rule or reaction is causing another reaction to run (i.e. if a global reaction can be run by several different rules, you'll be able to tell which started it). Support for Telegram notification is now native and this no longer requires the Vera plugin (or a Vera, for that matter); please see the dist-config/notification.yaml for configuration information. There is also a new Shell Command action in reactions, but since it carries with it some potential security risks (e.g. arbitrary code execution), its use requires that you add allow_shell_action: true to the engine section of your reactor.yaml configuration file. By default, shell actions will not be run (although you can still put them in your reactions; they just won't run).

Other things to note:

• As previously advertised, the Synology-specific docker container latest-synology-amd64 is no longer being updated. Please switch to latest-generic-amd64.
• All docker images have grown a bit in size as a result of best-practice recommendations for stable builds of docker images. As part of these changes, all containers now run nodejs version 14.17 (current LTS) on Alpine 3.13 (except the RPI image, where 3.12 is used due to certificate issues). Additional changes are coming! Currently, the service runs as root within the docker container, and while running in a container has to-date constrained the risk normally associated with privileged services, the addition of the Shell Command action changes the risk potential dramatically. As a result, likely starting with the first build in July, all containers will run the service as a non-privileged user. I'm still pondering all of this, and there are several potential paths to consider.

[toggledbits]

Build 21168

• 0000220 Using default values on Telegram notification action causes UI to (incorrectly) flag error in field.
• 0000222 A broken reference in the "Run" action may cause an exception.

An experimental (still) exporter/feeder for InfluxDB is also available for testing.

POTENTIAL BREAKING CHANGE FOR HOMEASSISTANT

Because "state" values on HomeAssistant can be any data type, the data type for the value_sensor capability attribute value was destabilized; it's supposed to be numeric. But some Hass entities were assigning string values, because they were generally being identified as a sensor class device, but had non-numeric state values. The float-iness of value_sensor.value is now enforced (and once again consistent across all controllers). But this enforcement means any non-convertible string (string that doesn't contain a number) will result in null in value_sensor.value. To make sure that the original string is still available, a new string_sensor capability has been added, and Hass sensor class devices where the type cannot be explicitly determined from the device class will have both the value_sensor (with a float, if possible) and string_sensor (with the string) capabilities/values. What this change may break is any condition in triggers or constraints that use string tests against the value_sensor.value attribute (e.g. testing if value_sensor.value is equal to the word "idle"). You will need to switch those conditions to use string_sensor.value. Numeric tests are not affected by this change and so do not need to be modified. You will only run into trouble if you have been testing a value_sensor against a string. A check has been added with a warning notification to simplify finding these cases in your rules if you have any.

[toggledbits]

Build 21189

• 0000224: Unable to save rule set or reaction is only change is to switch a notification profile (doesn't enable save button)
• 0000223: Support for newer-style Hass color mode attributes (RGB[W] devices)

Fix an issue with the /variable/set HTTP API throwing an error (not new, but newly discovered and no PR open; attn @cw-kid ). Support for Hass up to 2021.7.1. Updated to new lexpjs with numeric coalesce operator. Internal improvements in the loading of extensions (notifiers, controllers, etc.). Update icon library to latest version. Now supports InfluxDB natively.

[toggledbits]

Build 21196

This build contains the eZLO interface (development level). There are no other significant user-facing changes, although many changes have been made in preparation for the upcoming 1.0 release (this is release candidate 2).

Users of the archive package (i.e. not docker) please npm update --no-save in your reactor directory after unpacking the archive.

Please refer to the documentation for configuration instructions.

I expect lots of issues in every range of possibility. I don't have many devices on my eZLO Plus to test with, so we're going to cover a lot of new ground, mostly by long distance, as I mentioned before. Please open PRs in Mantis for everything you find. Please post/upload all of the files prefixed ezlo_ from the logs directory with every report. If you are reporting an issue with a specific device, please be as specific as possible about which device it is and how it's not working. If you are including a log snip, please remember to include plenty of context (extra lines) both before and after the part you think is relevant (more is better than less).

In addition to the required configuration above, please add the following to the end of your logging.yaml file:

  EzloController:    # this line indent TWO spaces
    level: 7         # this line indent FOUR spaces

[toggledbits]

Build 21197 (1.0 release candidate 3)

• Additional capabilties for eZLO devices
• PR 0000229: Fixed an issue with attempt NaN write when certain sun conditions cannot be calculated in some "extreme" latitudes (e.g. sunset in Tromso NO in mid-summer: sun doesn't set; no astro dusk/dawn in mid-summer northern UK, etc.).
• PR 0000228: Fixed an issue with sequence (..after..) condition option not reselecting predecessor condition on subsequent rule edit.

I don't regard this as a vital update; this is mostly just informational. But if you're affected by either of the above PRs, you may want to make the upgrade.

On track for 1.0 release in 7/19. I've already changed the structure of the download directory.