Use case:
When performing home maintenance, such as air conditioning, I want all rules involving air conditioning to be disabled.
To do this, to day, I have a virtual switch that I placed within all rules involving air conditioning, meaning that if I turn it off, none of them work.
Then another situation: the water pump system and garden irrigation, another switch.
In short, I had to create several virtual switches in Hubitat to disable rules in MSR.
Unfortunately, however, I was unable to cover all scenarios, so I wondered if it would be possible for MSR to support a virtual MSR switch, which, when configured in the reactor settings, would function as a general on/off switch for MSR.
If it is configured and turned off, the entire rules and actions in MSR stops working, except for the status change reading process, specifically for this switch, which, when turned on, would restart the MSR.
Would it be possible to do something like this? Any recommendations from the experts?
@toggledbits, not sure if this is a feature request or I'm using the search tool wrong. You have a "Search for rule" in the Rules Set tab in MSR. It works nicely to find a rule and bring up said rule, but can it/could it be used for as a "where used?" global search? For instance, I have a fairly large set of rules, divided up into 10 different rulesets. There's easily a hundred individual rules, and many of the rules have Rule State triggers, which of course refer to other rules. Amongst my troubleshooting today, I came across what may have been a duplicate or troubleshooting attempt, but I can't tell if it's actually used as a Rule State in another rule without opening each rule that I suspect it may be a part of.
Thanks.
I'm running MSR build 25139 on Docker, using MQTT controller 24293, and everything working as expected. But if I try to upgrade to MQTTController build 25139, I'm getting the following errors on MSR UI:
An Entity Attribute condition in "Lay-Z-Spa auto heating off" (Terrace) failed because the referenced entity "Lay-Z-Spa States" (mqtt>layzspa_states) does not have attribute value_sensor.god
Last 11:20:37
An Entity Attribute condition in "Lay-Z-Spa auto heating off" (Terrace) failed because the referenced entity "Lay-Z-Spa States" (mqtt>layzspa_states) does not have attribute temperature_sensor.green
Last 11:20:37
An Entity Attribute condition in "Lay-Z-Spa filter pump auto off" (Terrace) failed because the referenced entity "Lay-Z-Spa States" (mqtt>layzspa_states) does not have attribute temperature_sensor.red
Last 11:20:37
An Entity Attribute condition in "Lay-Z-Spa filter pump auto run" (Terrace) failed because the referenced entity "Lay-Z-Spa States" (mqtt>layzspa_states) does not have attribute value_sensor.pump
Last 11:20:37
An Entity Attribute condition in "Lay-Z-Spa watchdog" (Terrace) failed because the referenced entity "Lay-Z-Spa States" (mqtt>layzspa_states) does not have attribute value_sensor.status
Last 11:20:37
My MQTT configuration (local_mqtt_devices.yaml) for the related entity is:
layzspa_message:
type: ValueSensor
capabilities: ["temperature_sensor", "value_sensor", "power_sensor"]
primary_attribute: power_sensor.value
events:
"layzspa/message":
"power_sensor.value":
json_payload: true
if_expr: '! isnull( payload?.PWR )'
expr: "float(payload.PWR)"
"value_sensor.air":
json_payload: true
if_expr: '! isnull( payload?.AIR )'
expr: "float(payload.AIR)"
"value_sensor.pump":
json_payload: true
if_expr: '! isnull( payload?.FLT )'
expr: "float(payload.FLT)"
"value_sensor.god":
json_payload: true
if_expr: '! isnull( payload?.GOD )'
expr: "float(payload.GOD)"
"value_sensor.lock":
json_payload: true
if_expr: '! isnull( payload?.LCK )'
expr: "float(payload.LCK)"
"value_sensor.unit":
json_payload: true
if_expr: '! isnull( payload?.UNT )'
expr: "float(payload.UNT)"
"value_sensor.error":
json_payload: true
if_expr: '! isnull( payload?.ERR )'
expr: "float(payload.ERR)"
"temperature_sensor.green":
json_payload: true
if_expr: '! isnull( payload?.GRN )'
expr: "float(payload.GRN)"
"temperature_sensor.red":
json_payload: true
if_expr: '! isnull( payload?.RED )'
expr: "float(payload.RED)"
"temperature_sensor.target":
json_payload: true
if_expr: '! isnull( payload?.TGT )'
expr: "float(payload.TGT)"
"temperature_sensor.value":
json_payload: true
if_expr: '! isnull( payload?.TMP )'
expr: "float(payload.TMP)"
"temperature_sensor.virtual":
json_payload: true
if_expr: '! isnull( payload?.VTM )'
expr: "round(float(payload.VTM), 1)"
"temperature_sensor.ambient":
json_payload: true
if_expr: '! isnull( payload?.AMB )'
expr: "float(payload.AMB)"
"layzspa/Status":
"value_sensor.status":
if_expr: '! isnull( payload )'
expr: "payload"
"layzspa/button":
"value_sensor.button":
if_expr: '! isnull( payload )'
expr: "payload"
and in reactor.yaml I have:
"layzspa_states":
name: "Lay-Z-Spa States"
friendly_name: 'Lay-Z-Spa States'
include: layzspa_message
I realize my MQTT configuration might be a bit unorthodox, but could there still be something unintentional in the latest MQTTController build? If needed, I can provide detailed logs.
Since today is my birthday - and I still pretend to be unconventional - I'm giving away a present to this wonderful community and I'm releasing my first OpenSprinkler controller for MSR. It was real fun to code it - and while it's still WIP, it seems to work OK for me. It's polling-based at the moment, but I'll add support for updates via MQTT very soon (it's already partially coded).
Get it at (install is similar to MQTTController and such):
https://github.com/dbochicchio/reactor-opensprinkler
Feel free to try it. It's beta software, but it's stable. I'll update it weekly until all the tasks from my todo list are empty.
Since I've learnt a lot from this controller, I'll explore new controllers soon.
Good day all,
I'm in the process of trying to shut down my 10 year old Linux home server that served many purposes, but primarily it's what I used for my NAS/Plex Media server. I migrated the NAS aspect of the server in November of last year to a true NAS solution (Ubiquti UNAS Pro), which is rack mount and much more efficient than my old tower, which it's only side benefit was heating my home office during the winter. Unfortunately it also means heating my home office during the summer, which were about to be in full swing.
I have two things running on this 10 year old server at this point. MSR and pi-hole. I'm running Plex Media Server on Fedora Workstation in Podman on mini PC, which is much more energy efficient than my old tower. My next step is to migrate MSR. I know there are images of MSR out there, and creating it is well documented. I'm going to be using Podman instead of Docker for various reasons, but they work very similar. What I don't know, is what I need to do to migrate my existing Bare Metal installation over to a container.
Has anyone done this? Any advice?
Build 21228 has been released. Docker images available from DockerHub as usual, and bare-metal packages here.
Home Assistant up to version 2021.8.6 supported; the online version of the manual will now state the current supported versions;
Fix an error in OWMWeatherController that could cause it to stop updating;
Unify the approach to entity filtering on all hub interface classes (controllers); this works for device entities only; it may be extended to other entities later;
Improve error detail in messages for EzloController during auth phase;
Add isRuleSet() and isRuleEnabled() functions to expressions extensions;
Implement set action for lock and passage capabilities (makes them more easily scriptable in some cases);
Fix a place in the UI where 24-hour time was not being displayed.
Hi guys,
Just wondering how you guys organize your rule sets and rules. I wish I had an extra layer to have some more granularity, but my feature request was not popular.
Maybe there are better ways to organize my rule sets.
I use the rule sets now primarily for rooms. So a rule set per room. But maybe grouping by functionality works better. Any examples/ suggestions would be appreciated.
I have the following yaml configuration in local_mqtt_devices file
x_mqtt_device:
set_speed:
arguments:
speed:
type: str
topic: "command/%friendly_name%"
payload:
type: json
expr: '{ "fan": parameters.speed }'
While this works fine, I'm wondering how this could be changed to "fixed" parameters, as in this case "fan" only accepts "A", "Q" or a numeric value of 1-5?
Reactor (Multi-System/Multi-Hub) Announcements
-
Build 21332
- DynamicGroupController: Fix missing initialization in preload for some selectors (blocking bug, no PR in Mantis).
- Documentation build fix so all documents receive correct left navigation.
- Condition operator is [not] EMPTY has been added to ease checking of group member arrays and other values for emptiness; see the docs Entity Attribute conditions for details on what "empty" means in this context.
-
Build 21336
If you have been with Reactor since before 21075 (March 15, 2021), your
logging.yamlconfiguration may have a relative path in thenamekeys of the default streams (e.g../logs/reactor.log). These must be changed to just a simple filename (e.g.reactor.log). Reactor has been warning you at startup (in the log file) about this since 21075, if it applies to you (i.e. your logging config uses a relative path), but if you haven't seen it, you may not have changed it. The time to check it/change it is now, because the next version of Reactor that is released will not allow pathnames (relative or absolute) in this key, and will not run if it finds one.- DynamicGroupController: map actions in known capabilities of selected objects, so that groups can perform actions on their members. For example, performing the
power_switch.offaction on a group will do so on all of its members that support that action. - Logging: Fix support of log streams so that subsystems declaring their own log streams operate correctly; fix a number of long-standing annoyances in the configuration and handling (no changes to user configuration requirements except as noted above); improved "panic mode" (used when no configured stream is writable).
- Dashboard: improved layout for
string_sensorcapability objects. - HubitatController: Bless firmware 2.3.0.113
- HubitatController: extend recent additions to capabilities (
string_sensor) to the mode and HSM entities. Reduce reliance on the custom/hub-specific extension capability. - HubitatController: New "type guessing", experimental, to try to reduce effort for this hub in particular in determining device types and primary attributes. This is a work in progress (but then, what isn't?).
- PR 0000271: Fix a missing localization in rule detail panel, operator in group titles (reported by @Crille).
- Improvements to
rpi-install.shscript to handle upgrade of systemd script when upgrading nodejs. - A number of internal fixes related to linting of the code.
- As always, a number of documentation updates.
- DynamicGroupController: map actions in known capabilities of selected objects, so that groups can perform actions on their members. For example, performing the
-
Build 21337
- Document additional keys for logging in the
dist-configtemplate. There is also existing, but not well-organized, docs on the Logging page of the manual (which at the moment lives under Troubleshooting). - HubitatController: ensure
x_hubitatandx_hubitat_extra_attributecapabilites are declared and extended so their attributes can be assigned as primary. - PR 0000272: Localization issue in input fields for date/time condition.
- PR 0000273: Pulse after sustained for delay is shortened by the delay.
- Document additional keys for logging in the
-
Build 21338
This is a hotfix build for users of Hubitat only, and specifically for users of Hubitat Modes. If you do not use Hubitat Modes, or Hubitat at all, you do not need to upgrade to this version.
- HubitatController: Fix handling of mode query response (injection from additional changes in 21336).
-
Build 21342
- PR 0000275: Fix sun angle not updating in
reactor_system>sun(Sun Information) entity. - PR 0000274: Fix missing localization of condition operand labels in rule editor.
- HassController: More tightly map reported service_data field types into Reactor types (to improve UI experience on Hass-native actions).
- Support "object" data type in action data more universally, not just in controllers that need it.
- PR 0000275: Fix sun angle not updating in
-
Build 21349
If you grabbed this release before 06:00 on 16-Dec-2021 UTC, please grab it again and reinstall. There was an issue with the next-day rollover computing sunset times that I fixed in-line.
- Make sure client API uses port for WebSocket connection, so the UI works when on a proxy or tunnel.
- Global reactions now support action groups with constraints.
- EzloController: Additional energy capabilities on certain devices/items.
- InfluxFeed: Fix an error in parsing the configuration for
select_capabilitywith attributes listed. - The
suninfocapability (used by the Sun Information entityreactor_system>sun) has been expanded to include theelevationandazimuthof the sun's current position. Theelevationis given in degrees above the horizon. Theazimuthis given in degrees clockwise from North (compass direction). - The
suninfoattributesun_angleis now deprecated and will be removed from a future release. If you are using it in conditions, please switch to usingelevation, which is a better representation of the sun's position. - A bug in the computation of
day_length(in hours) in the extreme latitudes (i.e. where the sun does not cross the horizon at certain times of year) is fixed. During periods during in which the sun never rises, day length will be 0; during periods in which the sun never sets, it will be 24. Similarly,periodcould give incorrect results and will now report correctly or the conditions.
-
Build 21351
Users are advised only to upgrade to this release if they are affected by an issue related to the changes below; specifically, if you are not a user of Hubitat and you do not use constraints in rules or reactions, there is no need to upgrade to this release.
- HubitatController: Aggressive management of the event websocket connection, with additional diagnostic output by default.
- HubitatController: Fix error in setup of task queue (part of attempt to control pace of outgoing actions).
- Constraints: Loosen rules on condition options for constraints in rules (a stateful context), as opposed to those in global reactions (which are stateless).
- Docs: Improve description of the
time()function so that it's clear it can convert time strings (in ISO 8601 format).
-
Build 21356
- PR 0000278: Fix an untranslated string in rule reaction name generator.
- SystemController: publish alert data on entity, making it available for use in conditions.
- EzloController: Fix bug where cancelling a house mode change causes the mode name to get the ID rather than the name.
- EzloController: support for additional items (power-related and seismicity).
- EzloController: remove
power_switchas automatic capability on dimmable lights; not all Ezlo dimmable lights publishswitchitems, so use the presence of theswitchitem on a device as the trigger to extendpower_switch. - EzloController: Fix an error thrown when handling certain extension items (e.g.
electric_meter_kwh, only on some devices). - HubitatController: Fix handling of TamperAlert capability.
- HubitatController: Add config
warn_unresponsive(boolean) to turn off (when set false) warnings for quiet channel reconnects. - HubitatController: Support for extension capabilities where an attribute like
currentis provided without a matching capability. - VeraController: Log slow responses from hub (helps troubleshooting bottlenecks).
- Engine: Fix error in restore of running tasks across a reboot.
- PR 0000279: Fix an error that leaves Variable Value conditions in global reaction constraints with no variable list from which to choose (should list global variables).
HubitatController - Additional Notes
The connection health probes have some new settings, described in the docs, to make the health checks as reliable as possible and eliminate false positives in the quiet channel checks. Primary among these is recognition of a device under control of the Hub Information (community) driver. I recommend that Hubitat users install this driver (and create a device that uses the driver, and publish that device through Maker API), as it has some predictable behaviors that make it perfect for health checks, and it gives you access to other information about the hub you may find useful in Reactor. This is not required; just recommended.
-
Build 21360
- PR 0000282: DynamicGroupController: fix an error that could cause preloading of entities to fail (started in 21356).
- Updated lexpjs to 21360 to correctly handle assignment to object/array members.
-
Build 21365
- HassController: Add
fire_eventaction on system device, to fire any event. - Deprecation warning when starting on nodejs version < 16 (still runs, just a notice).
- HubitatController: Enforce strict ordering on initial mode and HSM queries.
- HassController: Bless Hass version to 2021.12.7
- Docs: Add startup troubleshooting page to Troubleshooting section.
- HassController: Add
-
Build 22001
- PR 0000284: Rule Editor: Add function to clone condition or group
- PR 0000287: Date comparison error in "between" that spans year (MDHM form); resets incorrectly at 01-01T00:00 Fix end check for next edge
Happy New Year!
-
Build 22002
This version has only an EzloController fix, so those of you that don't use Ezlo hubs can skip this version.
- EzloController: Fix fast update attribute issue (hopefully). I can't fully test because my device selection is limited, but it works for what I have.
-
Build 22004
- PR 0000289: Fix detection of loops in expressions, and add more aggressive checks for some conditions previously missed; make sure self-referencing expressions are not considered loops.
- EzloController: Update connection error recovery; cloud auth and token requests are now only done when the controller specifically denies the current token, or when too many connection retries occur. Implement retry decay, to further reduce queries to Ezlo's cloud. Overall, this makes EzloController more resilient in the face of Internet and Ezlo cloud outages.
- Update the little-used (that may be about to change) encrypted status packager to work in docker containers.
-
Build 22021
Bare-metal install: you must run
npm i --no-save --omit devin your Reactor install directory to install new dependencies.- UI: Make it possible to bypass the About page at startup.
- UI: Status page now has movable, resizable widgets. A couple of new widgets have been introduced as well.
- HubitatController: Fix
volume.setaction (media players) - Support for
usermediadirectory insideconfig; if present at startup, the built-in HTTP server will serve files from this directory (meant primarily for media/audio files, but will serve most common file types). This allows the user to serve files from the Reactor installation without the need to separately install Apache or another web server. - HassController: Bless Hass to 2021.12.10
- Engine: predicates have been refactored to tidy up the code and remove some duplication of functionality created when reaction group contraints were introduced.
- Clean up the
reactor_inet_check.shscript (intools). - Docker: the OS base for x64 generic and armv7l (RPi) is now Alpine version 3.14 (was 3.12);
-
Build 22022
Bare-metal users: you must remove any existing
package-lock.jsonfile from your Reactor install directory, and then runnpm i --no-save --omit devto update package dependencies. You will get a vulnerability warning; see this post. DO NOT runnpm audit fix— it will break your Reactor install.Docker users on Raspbian Buster (Raspberry Pi): you must install a patch to run the Reactor image in a container. See the install instructions for the steps to install the patch.
Engine: New and very experimental Repeat While action group, repeats as long as its conditions are met. The group must have at least one condition or it will not run at all. The repeat will stop if either (a) the conditions result in false, or (b) if it's in a rule-based reaction, the contra-reaction is started by a change of rule state. It is quite possible to make reaction groups that never stop, so be careful with your logic here.This feature was not included.- UI: Fix "Recently Changed Entities" not updating dynamically.
- UI: Fix an error in the new widget text on the Status panel.
- The
node-fetchpackage requirement has been updated to version 2.6.7 or higher (in the 2.x release path). This version is patched against CVE-2022-0235 according to the package author. Bare-metal users will need to remove any existingpackage-lock.jsonfile in their Reactor install directory, and then runnpm install --no-save --omit dev. DO NOT runnpm audit fix— it will break your Reactor install. - Docs: Update package install instructions for bare-metal installs, and in the Troubleshooting section.
- Docs: Update docker container installation instructions for users of Raspbian Buster (only) with additional steps to install
libseccomp2patch required to run the image.
-
Build 22023
Bare-metal users: you must remove any existing
package-lock.jsonfile from your Reactor install directory, and then runnpm i --no-save --omit devto update package dependencies. The previously reported vulnerability warning should no longer be present.Docker users on Raspbian Buster (Raspberry Pi): Reactor images since 22021 require that you install an OS patch to run the Reactor image in a container. See the install instructions for the steps to install it.
- PR 0000296: Fixed rule throttling caused by constraints subscribing for events when they should not.
- PR 0000297: Duplicate report for 0000296.
- PR 0000298: Global expressions not updating correctly, not triggering rules correctly.
- Engine: New and very experimental Repeat While action (a form of group), repeats as long as its conditions are met. The group must have at least one condition or it will not run at all. The repeat will stop if either (a) the conditions result in false or null, or (b) if it's in a rule-based reaction, the contra-reaction is started by a change of rule state. It is quite possible to make reaction groups that never stop, so be careful with your logic here.
-
Build 22025
Bare-metal users: updating package dependencies when updating Reactor is recommended. To update packages, you must first remove any existing
package-lock.jsonfile from your Reactor install directory, and then runnpm i --no-save --omit dev.**Docker users on Raspbian Buster (Raspberry Pi): Reactor images since 22021 require that you install an OS patch to run the Reactor image in a container. See the install instructions for the steps to install it.
- VeraController: allow arrays for
filter_entityandaccept_entityto be consistent with other similar applications. - Fix an issue with setting a Rule's timebase before evaluation that may affect some rule-based expressions. Likely related to PR 0000301.
- VeraController: allow arrays for
-
Build 22028
Bare-metal users: updating package dependencies when updating Reactor is recommended. To update packages, you must first remove any existing
package-lock.jsonfile from your Reactor install directory, and then runnpm i --no-save --omit dev.Docker users on Raspbian Buster (Raspberry Pi): Reactor images since 22021 require that you install an OS patch to run the Reactor image in a container. See the install instructions for the steps to install it.
- PR 0000301: Fix excess sensitivity to apparently unrelated devices in some conditions. I'm leaving this PR open; I think I know why this happened, and for my system it's working great, but I want to make sure I've covered all the bases, and because the fix was pretty aggressive, didn't inject anything new.
- Fix exception trying to subscribe to non-Observer in Variable Value condition.
- Logger: Allow
maxsize: 0in log stream configuration for no log rotation at all. - Fix condition value seen on Date/Time conditions in rule status display (cosmetic).
- HubitatController: implement Reactor
energy_sensorcapability; replacesx_hubitat_energymeter, which is now deprecated.
-
MQTTController Build 22029 -- download
Please run the install script after unpacking the update.
- Echo function now publishes rule states and global variables. Please see the docs for more information.
-
Build 22044
- PR 0000306: Certain condition options not being saved for rule-based constraints.
- PR 0000305: Copying rule expression can renumber expression in source rule.
- PR 0000302: Reaction delay "from start" working same as "from this point".
- InfluxDB: Support for more extensive control of written measurements, including name and type modification; see docs
- Reactions: Fix an issue where missing device in a rule reaction does not flag trouble on the rule.
- Three new capabilities:
valve,scene_activationandbattery_maintenance. These will be fully integrated with eligible Controllers and Entities in a future release. - Reactions: An error in a special form on the Comment action is fixed (simple notification).
- Expressions: New expression
casestatement; see docs - Expressions: Fix sort in
median()function. - Expressions: An error in the
fileRead()function has been fixed.
