Reactor (Multi-System/Multi-Hub) Announcements
-
Reactor build 24212
- PR 0000376: Search by name is now available on the Reactions list (similar to Entities list).
- Attribute
security_mode.state
recognizesmax
value. - Action
security_mode.set_mode
now takescode
argument (if not given, the default code in the Controller's configuration will be applied, if available). - Dashboard: support
/dashboard/group/<group-canonical-id>
path for direct display of a group. - PR 0000375: Fix a path where a global variable (expressionless) could have its value modified and not update variables that depend on it.
- HassController: Bless Hass to 2024.7.3
-
toggledbitswrote on Aug 30, 2024, 3:25 PM last edited by toggledbits Oct 29, 2024, 8:42 AM
Reactor build 24243
POTENTIAL BREAKING CHANGE: The conditions in a Reaction's repeat...while group are meant to be Constraints, not Triggers -- they are stateless, meaning that they are evaluated each time they are run, not when an underlying condition triggers them (such as a timer expiring on a sustained for option). This was always meant to be the case, but an error in the UI implementation permitted certain condition options applicable only to trigger conditions. This is now fixed, and any constraints containing condition options will have those options removed during later editing, and the options will not function (they haven't been working correctly anyway) until that time.
- Shell Command action now supports expression substitution. This makes an already dangerous (security-wise) action even moreso, so it must be enabled explicitly by setting
allow_shell_action_substitution: true
in theengine
configuration section ofreactor.yaml
. It is highly recommended that Shell Command actions only be used on systems that have HTTPS access and Access Control (user authentication) enabled, to reduce the possibility that the action could be a vector for attacking the host system and your network. - PR 0000378: VirtualEntityController: fix configuration collision between virtual entities affecting time-series aggregations.
- PR 0000369: Add
error
attribute forev_charger
system capability documentation. - PR 0000349: Support custom sounds for Pushover notification.
- PR 0000290: Display rule ID in rule editor (convenience).
- HassController: Bless Hass to 2024.8.3
ZWaveJSController 24242
BREAKING CHANGE WARNING: The entity IDs of certain child entities may change to reflect a more deterministic naming style. Entities principally effected would be those created in 2022 and earlier for scene activation. Rules that use these entities will need to be updated.
- Handle notification special events (in Notification CC 113 type 6) for locks for better performance of
keypad
capability attributes (where the device and Z-Wave JS support it). - Update Fibaro FGR222/FGRM222 handling for manufacturer proprietary venetian blind position and tilt
- Creation of child entities is expanded to include all command classes that result in capability/attribute collisions on an entity. That is, if two or more values (from Z-Wave JS) on an endpoint resolve to the same Reactor capability, a new child entity is created.
- Shell Command action now supports expression substitution. This makes an already dangerous (security-wise) action even moreso, so it must be enabled explicitly by setting
-
Reactor build 24257
- System Capabilities: the new
tag
system capability has been introduced to extend data and behavior for RFID tags and similar devices. - HassController: Implement
tag_scanned
event handling, which creates a new entity from the tag ID. This entity is updated whenever Hass reports that the tag is detected any scanning device. This automatic event handling does not preempt or prevent user-configurable event handling for different behavior, if desired. - HassController: Improve the initialization of event-driven entities so they are not cleared every time Reactor is restarted (they will be cleared only if a configuration change is detected).
- HassController: The event processor now ensures that
time_fired
is included in the event data before handling. If not, Reactor will provide it. In addition, since Hass passestime_fired
as a string, Reactor will parse the string to an Epoch time (seconds since midnight Jan 1, 1970 UTC) and provide it intime_fired_epoch
, which can be used in user configuration for events. - HassController: Allow filtering of state attributes to reduce rule re-evaluation traffic for related entities. (see docs)
- HassController: Bless Hass to 2024.9.1
ZWaveJSController build 24257
- Fix an issue with polling rescheduling that can cause polling to take too long to re-poll a node after the initial poll.
- Handle forced-write of attributes when processing events for the Notification Command Class.
MQTTController build 24257
- Code cleanups and minor bug fixes; mostly changes to sync with evolution of various system capabilities.
- System Capabilities: the new
-
toggledbitswrote on Oct 19, 2024, 7:37 PM last edited by toggledbits Oct 24, 2024, 2:53 PM
Reactor build 24293
BARE-METAL USERS: UPDATE YOUR PACKAGES! You must remove any
package-lock.json
file in your Reactor install directory and runnpm i --no-save --no-package-lock --omit dev
after unpacking the Reactor distribution archive. Failure to do so will result in a non-functioning UI (notably non-working dark mode) and many other issues.POTENTIAL BREAKING CHANGE: The validity of characters in entity IDs is now enforced. Previously, only a warning was written to the log if the ID contained invalid characters; now, the entity will not be allowed to exist. If you use VirtualEntityController, MQTTController, or other Controllers where you can configurably create entities, the IDs you establish for those entities must now contain only valid characters, which are ASCII alphanumerics, dash (
-
), underscore (_
), and the high ASCII ranges 192-214, 216-246, and 248-255 (which covers some letters with diacritics). Other characters, including Unicode characters outside this range, are not permitted.POTENTIAL BREAKING CHANGE: The alert attributes have been moved off of the Reactor System (
reactor_system>system
) entity on to a separate Reactor System Alerts (reactor_system>alerts
) entity. If you have Rules or Reactions that use alert data in conditions, you will need to point them to the new entity/attributes.LOCALIZATION UPDATE: There are several new strings in the reference localization template (new version 24293). See the Github repository for the current reference version and change log.
- Entity action implementations can now return values/results and store them directly to a local (Rule-based) or global variable for further processing. Note that HassController was previously (in build 24115) given this ability in a slightly different form, where the response was written to a single attribute from which it could be retrieved by other expressions. HassController will support both mechanisms for the foreseeable future, but transition to the new mechanism is recommended.
- New Script Action action in Reactions allows you to run an expression/script in-line in a Reaction. This is intended to simplify handing of results from Entity Actions that return results.
- Fixed a bug in the changes operator where, if there were terminal values (values for changes from, to, or both), the output would pulse rather than "stick." The design intent was such that it should stick, because a change with terminal values is predictably persistent (i.e. a condition that watches for an alarm panel state change from
disarmed
toaway
will go true and should stay true as long as the alarm panel remains inaway
state). When there are no terminal values, a change is still signalled with a pulse (i.e. a change from any value to any other value produces a pulse, and is then ready to signal a change to yet another value). - Capabilities may now define user-writable attributes, and the user may set the value of such an attribute on an entity. The intent of this feature is to provide storage for user preference in actions (such as the amount to change the light level when performing
dimming.up
), but could have many other uses. To make an attribute user-writable, the developer must includewritable: true
in the attribute definition. Attributes derived from device data (like switch state or blind position; i.e. where a Controller instance controls the value) are not writable by the user and should not be made user-writable by developers. User-writable attribute values can be set using the new Set Attribute button in Entity list detail cards, or using thereactor_entity.set_attribute
action. - New
reactor_entity
capability is extended to all entities, and contains actions to rename the entity and set its writable attributes. - Additional work to preserve the state of attributes across upgrades/changes to underlying capabilities and implementations. The new Controller methods
refreshCapabilites()
andrefreshCapability()
provide a mechanism for updating an Entity's stored capability data without losing the values of attributes and metadata that exist in both the old and new versions of a capability. - Logger now supports (via
logging.yaml
entry) the rotation of log files on specific intervals. Themaxage: time
configuration can be added, wheretime
is an integer followed bysecs
,mins
,hours
, ordays
. These may be abbreviated to a single character (e.g.1d
or4h
). If thetime
is an integer only, the units are assumed to bedays
. - DynamicGroupController now supports an expanded form of
group_actions
configuration to more narrowly specify which actions are to be made available as group actions. See the Group Actions section of the documentation for DynamicGroupController. - UI now has a dark theme (long-awaited).
- UI (Reaction Editor) for HTTP Request action now shows more clearly that when storing response to a variable, it must wait for the response to complete (i.e. when you choose a target variable, it automatically checks the "Wait for" checkbox in addition to disabling it). The semantics of this have been documented since inception, but the UI now reinforces the concept in its display.
- UI (Entities List) detail cards for Entities now have a Perform dropdown to run actions, rather than a list of links. The selected action is performed immediately if it has no arguments; otherwise, the arguments are requested in a modal dialog as before. This should improve access to actions on entities from this area.
- New expression functions from updated
lexpjs
:isvalue()
,scale()
,constrain()
. See docs for Expressions. - PR 0000380: Resolve an issue with an optional argument in a HAss-specific service requiring a value in the action editor (service climate.set_temperature for example).
- A (very) simple log file viewer/fetcher is now available at
/api/v1/log
. The optionalfile
query parameter can be given to select which log file (by name); by default,reactor.log
is displayed. This endpoint is protected when access control is enabled, so if you are using access control, you may need to modify an existing ACL or create a new one to enable access to it. - HassController: Bless Hass to 2024.10.3
-
Reactor build 24296
UPGRADE NOTICE: If you are upgrading to this version from earlier than 24293, please update your packages! See the notes and instructions for build 24293 above for instructions and other notices.
- Fix a race condition when painting the Status tab when painting a widget that must traverse the ruleset index.
- Make sure errors thrown by widgets show in the widget container, not by popping the exception dialog.
- Fix activation of the Expressions tab so it paints every time (a guard for edit mode was too aggressive, because this tab is always in edit mode).
- Fix a number of reported appearance issues, and some new ones.
-
toggledbitswrote on Oct 29, 2024, 12:01 PM last edited by toggledbits Oct 29, 2024, 8:13 AM
Reactor build 24302
UPGRADE NOTICE: If you are upgrading to this version from earlier than 24293, please see the notes and instructions for 24293 for additional actions you need to perform during upgrade.
- You may supply a CSS (Cascading Style Sheet) containing customizations for Bootstrap 5.3 in a file called
config/customstyles.css
. This allows you to further adjust theme colors to your liking. For instructions on how to customize Bootstrap styles, refer to its documentation. - PR 0000383 (and 385): The changes operator was not allowing "pulse" output option. It is now allowed (whether terminal values are used or not).
NUTController build 24303
- PR 0000384: Fix an error that may be thrown when the NUT client library fails to get the UPS list from the service. This error prevents the real error from being logged properly.
- You may supply a CSS (Cascading Style Sheet) containing customizations for Bootstrap 5.3 in a file called
-
toggledbitswrote on Oct 29, 2024, 1:00 PM last edited by toggledbits Oct 29, 2024, 9:03 AM
Reactor STABLE Update
The stable branch of Reactor is now updated to build 24257. For changes, please scroll back and see the changes and advisory listed since the previous stable branch build (which was 24057).
IMPORTANT: Bare-metal users will need to update installed packages (run
npm i --no-save --no-package-lock --omit-dev
in the Reactor install directory).NOTE: This stable branch build no longer supports nodejs versions under 18. If you are installing Reactor bare-metal (i.e. not using docker), please make sure you have upgraded to nodejs 18+. An even-numbered LTS (Long-Term Support) version of nodejs is recommended.
-
Reactor build 24343
BARE-METAL USERS: Please run
npm run deps
from your Reactor install directory to upgrade packages. Remove any existingpackage-lock.json
file first if it exists. These steps are only required for bare-metal installs (does not apply to Docker).NOTE: Notable UI Change: removing widgets on the Status tab now requires you to drag the widget (by its header) to the top navigation bar and release it there. Previously, moving a widget anywhere outside the content panel would remove it, but this was troublesome for small touch displays (too easy to remove items while scrolling).
NOTE: If your Current Alerts widget displays two menu icons in its header, remove the widget (by dragging it to the top nav bar and releasing it), and then create a new replacement Current Alerts widget.
- PR 0000389: Improve mobile device compatibility. Although many aspects of the UI have been tweaked for better presentation on small displays, it will continue to be the case that editing of major system objects (Rules, Reactions, Expressions) is a high-interactivity task, and the design goals do not and will not include "mobile first" compatibility for that.
- PR 0000387: Make VirtualEntityController operation of
reactor_system.set_attribute
action identical to (and in fact, just an alias for)x_virtualentity.set_attribute
. On virtual entities, all attributes are de-facto writable. - PR 0000386: Fix an issue with HubitatController where it could attempt to set
NaN
on an attribute, generating a warning in the log. - The Reaction List has been modified to show a spinner while a Reaction is running, rather than holding a green highlight.
- Fix an issue with the Reaction List not repainting correctly after editing a (global) reaction.
- Additional hard-coded colors in some CSS styles have been removed in favor of CSS variables (Bootstrap- or Reactor-defined). This should help user making custom themes.
- Improve the error message given when a script/expression attempts to set a global variable that is not writable (i.e. it's not expressionless).
- The default action handlers for increasing/decreasing values in
dimming
,position
, andvolume
capabilities has been updated to more consistently move in increments of the related step value. For example, when the current dimming level is 0.55 (55%), thedimming.up
action with a step of 0.1 will move to 0.6 rather than 0.65 as previously implemented. Not all devices/Controllers use the default action handlers for these actions — if the Controller implements its own semantics, this change has no effect. - VirtualEntityController can now do HTTP requests in actions. This allows you to create a virtual entity that functions as an interface for a device that is HTTP-controllable without the need to write a custom Controller instance. See the docs for VirtualEntityController for updated section on actions.
- HassController: Bless Hass to 2024.11.3
I am working on some bigger structural changes to Reactor, and have been for a while now. In the interest of finishing those changes, the rate of
latest
builds is going to go down for a bit. I will, of course, address any serious issues that need fixing during that time. -
Reactor build 24366
- Fix an issue with the Entities list not filtering by group correctly.
- Fix an issue with the Entities list not presenting the "Primary Value" alternate selector when a capability filter is active.
- Fix an issue with the Global Expression editor not freeing resources when closing (since 24302).
- Dashboard: adjust the action areas of Level widgets for more predictable touches on small devices.
- HassController: Force a refresh of extended capabilities when the Home Assistant server version changes.
- Entities List: adjust spacing of rows for improved appearance.
- Rule Sets: Fix alignment of title for Rule Set selection panel (offcanvas).
- Rules/conditions: Fix appearance (size) of fields in Interval condition.
- Rules: (experimental) Show the rule state history on the detail panel (Rules tab, open rule panel).
- Status: Fix an issue where widget frames may not be correctly upgraded when upgrading Reactor to 24343 (and beyond).
- HassController: Bless Hass to 2024.12.5
-
Reactor build 25016
HOME ASSISTANT NOTE: Versions of Home Assistant earlier that 2024.1.0 are no longer supported. They may continue to work, but I won't be troubleshooting any issues that come up with them. Generally speaking, HA releases are supported one year in arears from current.
NODEJS V18 EOL: If you are using nodejs version 18, it will go off maintenance on April 15, 2025, and is therefore now deprecated. Please update to a more recent version before this date. Even-numbered LTS versions are recommended. Version 20 will go EOL in April 2026, and version 22 (recommended) in 2028.
- Reaction List: Fix an error thrown when creating a new Reaction.
- Dashboard: improve display of ValueSensor class objects for capabilities temperature_sensor, humidity_sensor, battery_level, and volume.
- HassController: Support new vacuum
activity
attribute and values (see HA 2025.1 release info). - HassController: Support state for lawn mowers.
- HassController: Add
x_hass_system.reload_configuration
andx_hass_system.restart
actions. - HassController: Bless Hass to 2025.1.2
-
Reactor build 25060
- Reactions: Reactions can now be assigned to a Rule Set. This is strictly an organizational tool/capability for user convenience. For purposes of the Engine, Reactions in Rule Sets are still Global Reactions. That means, for example, that a Rule from one Rule Set can still run a Reaction in another Rule Set.
- UI: The login page background should now look better on ultra-wide or beyond XXL monitors.
- Docs: clarify formatting requirement for YAML octal values (must use 1.2 spec
0o
prefix; the old0
prefix withouto
no longer works). - Structure: improve startup handling of controllers and messages around controller startup and status (e.g. inability to load an implementation, etc.). These changes are cosmetic and intended to provide more helpful log messages when things don't go well.
- Fix a sync problem in the Current Alerts and Controller Status Status tab widgets across restarts of the Reactor service.
- VeraController: Fix an issue with
lock.set
affecting both it andtoggle.toggle
for locks. - HassController: Bless Hass to 2025.2.5
-
Reactor build 25067
- Fix a runtime error thrown when creating a Reaction in a Rule Set.
- Fix a race condition causing a runtime error in some browsers when the "Exit" button is hit on a Reaction Editor instance. The error was discovered to be more reliably reproducible when the Reaction being edited had a group (i.e. used an interior/child instance of a Reaction Editor).
- Fix deletion of global expression.
There are workarounds for the first two issues if upgrading is a hassle for you. For the first, create the Reaction under Global Reactions and then move it to the target Rule Set. For the second, you can safely ignore the error as it occurs after all save and cleanup have already taken place.
-
Reactor build 25082
NOTE: Bare-metal users, please run
npm run deps
in your Reactor directory after updating, then restart Reactor. Generally, you should always do this after upgrading to a new build, but for this build in particular, it's necessary.- Status Tab: fix an error that could cause lost notifications on object changes to some widgets.
- Packages: update some packages and force one dependency to eliminate a warning from node about a deprecated subsystem (not every package has caught up yet).
- Reactor UI: improve cleanup and memory utilization of tabs when switching between them.
- Engine: The
isRuleSet()
andisRuleEnabled()
expression functions now trigger re-evaluation of expressions in which they appear when the subject rule changes state. - HassController: Bless Hass to 2025.3.4
ZWaveJSController build 25082
This build of ZWaveJSController requires Reactor build 25082 or higher.
BREAKING CHANGE: For RGBW/RGBWW devices, the
color_temperature
capability is no longer used; white channels will now be mapped to thedimming
capability. If you have such devices and usecolor_temperature
attributes and actions, you will need to make appropriate adjustments to your Rules and Reactions.- Add support for start and stop heal actions (in
zwave_network
capability). - Improve connection retry decay computation (use slow initial decay with rapid ramp).
- Improve handling of white channels in RGBW/RGBWW devices. Mapping them to
color_temperature
seems to be incorrect in most cases, so they are now mapped todimming
. If the device has multiple channels, the white or color channels may be pushed to child entities. - The
zwave_device.set_value
action now accepts JSON in the value fields for Z-Wave JS values that support it. Some devices are able to report or set multiple values simultaneously by using a dictionary as the value (aka JSON object with key/value pairs). RGBWW devices, for example, may support thecurrentColor
andtargetColor
property with a value object like{ "warmWhite": 0, "coldWhite": 0, "red": 128, "green": 0, "blue": 240 }
.
-
Reactor build 25097
- Expression syntax enhancement: it is now possible to use a variable's value as a key when creating an object on the fly. For example, if the variable
cmd
contains the word "econo" (presumably derived from configuration or some other dynamic source), it is now possible to create an object{ econo: true }
by enclosing the key source in square brackets:obj = { [cmd]: true }
. For reference, this syntax mimicks JavaScript. - Fixed a UI crash when bringing up Reactor initially after using the About page bypass.
- OWMWeatherController: implement
sys_system.restart
, which will cause all locations to be refreshed immediately. - OWMWeatherController: new config option (boolean)
ignore_certs
can be set to ignore certificate errors. These seem to pop up occasionally, perhaps because of a misconfiguration in the load balancing at OWM.
- Expression syntax enhancement: it is now possible to use a variable's value as a key when creating an object on the fly. For example, if the variable