Using build 25328 and having the following users.yaml configuration:
users:
# This section defines your valid users.
admin: *******
groups:
# This section defines your user groups. Optionally, it defines application
# and API access restrictions (ACLs) for the group. Users may belong to
# more than one group. Again, no required or special groups here.
admin_group:
users:
- admin
applications: true # special form allows access to ALL applications
guests:
users: "*"
applications:
- dashboard
api_acls:
# This ACL allows users in the "admin" group to access the API
- url: "/api"
group: admin_group
allow: true
log: true
# This ACL allows anyone/thing to access the /api/v1/alive API endpoint
- url: "/api/v1/alive"
allow: true
session:
timeout: 7200 # (seconds)
rolling: true # activity extends timeout when true
# If log_acls is true, the selected ACL for every API access is logged.
log_acls: true
# If debug_acls is true, even more information about ACL selection is logged.
debug_acls: true
My goal is to allow anonymous user to dashboard, but MSR is still asking for a password when trying to access that. Nothing in the logs related to dashboard access. Probably an error in the configuration, but help needed to find that. Tried to put url: "/dashboard" under api_acls, but that was a long shot and didn't work.
I use Virtual Entity Controller virtual switches which I turn on via webhooks from other applications. Once a switch triggers and turns on, I can then activate associated rules.
I would like each virtual switch to automatically turn off after a configurable time (e.g., 5 seconds, 10 seconds).
Is there a better way to achieve this auto-off behavior instead of creating a separate rule for each switch that uses the 'Condition must be sustained for' option to turn it off?
With a large number of these switches (and the associated turn-off rules), I'm checking to see if there is a simpler approach.If not, could this be a feature request to add an auto-off timer directly to the virtual switches.
Thanks
Reactor (Multi-hub) latest-26011-c621bbc7
VirtualEntityController v25356
Synology Docker
TL;DR: Format of data in storage directory will soon change. Make sure you are backing up the contents of that directory in its entirety, and you preserve your backups for an extended period, particularly the backup you take right before upgrading to the build containing this change (date of that is still to be determined, but soon). The old data format will remain readable (so you'll be able to read your pre-change backups) for the foreseeable future.
In support of a number of other changes in the works, I have found it necessary to change the storage format for Reactor objects in storage at the physical level.
Until now, plain, standard JSON has been used to store the data (everything under the storage directory). This has served well, but has a few limitations, including no real support for native JavaScript objects like Date, Map, Set, and others. It also is unable to store data that contains "loops" — objects that reference themselves in some way.
I'm not sure exactly when, but in the not-too-distant future I will publish a build using the new data format. It will automatically convert existing JSON data to the new format. For the moment, it will save data in both the new format and the old JSON format, preferring the former when loading data from storage. I have been running my own home with this new format for several months, and have no issues with data loss or corruption.
A few other things to know:
If you are not already backing up your storage directory, you should be. At a minimum, back this directory up every time you make big changes to your Rules, Reactions, etc.
Your existing JSON-format backups will continue to be readable for the long-term (years). The code that loads data from these files looks for the new file format first (which will have a .dval suffix), and if not found, will happily read (and convert) a same-basenamed .json file (i.e. it looks for ruleid.dval first, and if it doesn't find it, it tries to load ruleid.json). I'll publish detailed instructions for restoring from old backups when the build is posted (it's easy).
The new .dval files are not directly human-readable or editable as easily as the old .json files. A new utility will be provided in the tools directory to convert .dval data to .json format, which you can then read or edit if you find that necessary. However, that may not work for all future data, as my intent is to make more native JavaScript objects directly storable, and many of those objects cannot be stored in JSON.
You may need to modify your backup tools/scripts to pick up the new files: if you explicitly name .json files (rather than just specifying the entire storage directory) in your backup configuration, you will need to add .dval files to get a complete, accurate backup. I don't think this will be an issue for any of you; I imagine that you're all just backing up the entire contents of storage regardless of format/name, that is the safest (and IMO most correct) way to go (if that's not what you're doing, consider changing your approach).
The current code stores the data in both the .dval form and the .json form to hedge against any real-world problems I don't encounter in my own use. Some future build will drop this redundancy (i.e. save only to .dval form). However, the read code for the .json form will remain in any case.
This applies only to persistent storage that Reactor creates and controls under the storage tree. All other JSON data files (e.g. device data for Controllers) are unaffected by this change and will remain in that form. YAML files are also unaffected by this change.
This thread is open for any questions or concerns.
Just another thought. Adding devices from my Home Assistant / Zigbee2MQTT integration. Works perfectly but they always add as their IEEE address. Some of these devices have up to 10 entities associated, and the moment they are renamed to something sensible, each of those entities 'ceases to exist' in MSR. I like things tidy, and deleting each defunct entity needs 3 clicks.
Any chance of a 'bulk delete' option?
No biggy as I've pretty much finished my Z-wave migration and I don't expect to be adding more than 2 new Zigbee devices
Cheers
C
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.
I have tried numerous ways to define a recurring annual period, for example from December 15 to January 15. No matter which method I try - after and before, between, after and/not after, Reactor reports "waiting for invalid date, invalid date. Some constructs also seem to cause Reactor to hang, timeout and restart. For example "before January 15 is evaluated as true, but reports "waiting for invalid date, invalid date". Does anyone have a tried and true method to define a recurring annual period? I think the "between" that I used successfully in the past may have broken with one of the updates.
Good evening all,
For about the past week or so, I've been having problems with a specific rule in my home automation that controls when my home goes from an Away mode to Home mode. One of the conditions it checked for was my alarm panel, when it changed from Armed Away to Disarmed. There seems to have been a firmware update on the panel that added an intermittent step of "pending", and I can't say for certain it happens 100% of the time.
Is there a way to write a condition that so it changes from one condition, to the next, and then another condition? As in, Home alarm changes from armed_away to pending to disarmed.
Thanks.
No idea how easy this would be. During my migration away from Z-wave I've been replacing the Z-wave devices with Sonoff which has broken some of my automations.
Any chance of a 'Test Reaction' function to call out which ones are broken because an entity no longer exists? Without actually running the reaction?
Or does this exist already and I'm just not aware of how to do it? Obviously I can see entities that are no longer available, but not quite what I'm looking for.
I guess it's something of an edge case so no huge issue.
TIA!
C
I'm sure this has been asked, and answered, but damned if I can figure it out
Use case: I have a rear garden with lights. A door from the kitchen into the garden and a door from the garage.
Currently if I open the kitchen door the lights come on (yay) and a 3 minute delay starts.
After 3 minutes, no matter what else happens, the lights go off (Boo! But also yay!)
What I would like is for the 3 minute delay until the lights go off to start from the latest door open event.
That is, if I'm going from kitchen to garage, and back again, the lights stay on until there's three minutes of no activity.
I've tried 'hacking' with a virtual switch, but can't seem to stop the delay.
Any pointers?
TIA
C
Reactor (Multi-System/Multi-Hub) Announcements
-
Build 21286
- InfluxFeed now supports InfluxDB version 1.8+ and 2.0. InfluxDB versions prior to 1.8 are no longer supported. Please see the documentation for configuration details, as the configuration requirements for 1.x and 2.0 are different. Users of InfluxFeed also need to
npm update --nosaveif they are bare-metal installed. - The behavior of rules when throttled has been improved. Note, however, that any time a rule is throttled, events could be missed (e.g. if a light that is a dependency of a rule is turned on and back off quickly when throttled, the rule may not "see" the on event).
- Ongoing documentation updates.
- Bless Hass to 2021.10.4
- First version to contain a foreign language translation, Swedish! Thank you @Crille for your work on the translation and helping me get localization working.
- Address possible evaluation loop while using SetVariable in a rule reaction on a rule variable, where the value is an expression that contains a
getEntity()reference. - Documentation updates
- Further i18n fixes (thank you @Crille)
- InfluxFeed now supports InfluxDB version 1.8+ and 2.0. InfluxDB versions prior to 1.8 are no longer supported. Please see the documentation for configuration details, as the configuration requirements for 1.x and 2.0 are different. Users of InfluxFeed also need to
-
Build 21292
- PR 0000262: Fix an error in handling date/time conditions with M/D across new year boundary.
- PR 0000261: HubitatController: Resolve an order of operations issue preventing extended attributes from being assigned as primary in local config.
- PR 0000258: (i18n) Fix string reference for condition option
- HassController: treat controller reporting NOT_RUNNING as an error and disconnect/retry
- Bless Hass to 2021.10.6
-
Build 21294
- PR 000263: Fix spurious log messages after deleting a global expression that contained a
getEntity(). - Fixed a UI issue with an expression being sorted to the top of the list then ending up at the bottom.
- The expression function
strftime()is now locale-aware. - Docker containers are now running on nodejs version 16.
- PR 000263: Fix spurious log messages after deleting a global expression that contained a
-
Build 21297
- PR 0000264: Fix an error in the rule editor on a particular value test used in several places that could cause the entered value of a condition option to not be saved (most notable on the "repeats within" field, but also found in two other locations).
- Update to lexpjs 21296 to get
sort()function for arrays, and user-definable functions from expressions. Default sort in Reactor Engine for the implemention of expressionsort()function is (host) locale-aware. Please refer to the documentation for details.
-
Build 21306
Note: this release includes changes to package dependencies. Bare-metal users please run
npm update --no-saveto resolve.- HTTP Request action now has explicit control over HTTP auth, with type selection (none, Basic, Digest) and credential fields (username and password).
- PR 0000265: Correct a string that is not translated in the alerts status panel.
- i18n: Found an additional string that was not localizable.
- The HTTP Request action will now suppress all alerts for any error it encounters, not just HTTP errors, if the "no error alerts" option is checked.
- Update lexpjs to get new array set functions:
arrayIntersection(),arrayUnion(),arrayDifference(),arrayExclusive()andarrayConcat().
-
Build 21307
- PR 0000266: An issue introduced at 21306 saves certain substitutions with the wrong data type.
- HubitatController: Resolve (hopefully) a race condition at startup.
-
Build 21313
- Bless Home Assistant to version 2021.11.2
- New system capability
buttonto express state of a single button or contact closure. - PR 0000268: Sun condition shows "not between" as "between" in rule detail card.
- Add
/alert/:tagHTTP API endpoint (DELETE method); this deprecates/alert/:tag/dismiss.
-
Build 21321
- HassController: Additional updates for event handling (
initsupport). - HubitatController: Map additional capabilities.
- Internal support additionals for MQTTController
MQTTController - Build 21321
- Fix incorrect scope reference is tasmota_generic_relay payload.
- Additional helpful debug.
Upgrading MQTTController, which is a standalone/add-on component, is the same procedure as initial installation.
- HassController: Additional updates for event handling (
-
Build 21331
Please note that Hubitat has released version 2.30 of its firmware, but it has not yet been tested with HubitatController and is not yet supported.
- DynamicGroupController: new controller to build dynamic groups. Refer to the docs for configuration information.
- Logger: new
recycleflag, when true, each startup rotates the log file so the new run starts in a fresh file (makes some debugging easier); the file mode of the logs created can now be set by setting themodekey. - Bump recommended nodejs version to 16.13.0; versions 14 and 15 will continue to be supported through March 31, 2022; docker containers are built with recommended versions, and require no user action, but bare-metal users should check their node version (
node -v) and if necessary make a plan to upgrade before 3/31. - Update to lexpjs 31330; adds built-in
median( array )function; provides extendedfirst...insyntax with (new) optional result expression; refer to docs. - PR 0000270: [HubitatController] Apparently Hubitat needs action pacing like VeraController (that is, it can be overwhelmed if too many actions are sent at once). Pacing is now enabled with a default of 25ms delay between actions.
- PR 0000269: [UI] Rename Reaction dialog for global reactions prepopulates name from start of editor session rather than most recent name given if rename is used several times within one session.
- Bless Home Assistant to version 2021.11.5
MQTTController - Build 21331
- More carefully guard sensors (in templates) from payloads that don't contain the sensor data (i.e. avoid setting null value if an update is published with data missing).
- Additional templates for Tasmota and Shelly.
- Documentation updates and clarifications.
-
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!
