homebridge-config-ui-x 5.0.0-beta.1 → 5.0.0-beta.100

package/CHANGELOG.md

@@ -2,14 +2,248 @@
 
 All notable changes to `homebridge-config-ui-x` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).
 
-## BETA
+## v5.0.0 (Unreleased)
 
 ### ⚠️ Breaking Changes
 
-- This version of the Homebridge UI will drop support for:
-  - Node.js `v16` and earlier, so please update to `v18` or `v20` or `v22` - [more info on updating](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js)
-  - Raspberry Pi devices running on the `armv6` architecture (like the Pi 1 and Pi Zero) - please update your hardware
-  - Instances using `pnpm` as the package manager - consider updating your Homebridge instance to use npm instead - [more info on updating](https://github.com/homebridge/homebridge-apt-pkg/blob/latest/README.md#using-apt)
+- This version of the Homebridge UI:
+  - Is compatible with Homebridge `v1` and `v2-beta`
+  - Drops support for Node.js `v18` and earlier, so please update to `v20` or `v22` - [more info on updating](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js)
+  - Drops support for Raspberry Pi devices running on the `armv6` architecture (like the Pi 1 and Pi Zero) - please update your hardware
+  - Drops support for instances using `pnpm` as the package manager - consider updating your Homebridge instance to use npm instead - [more info on updating](https://github.com/homebridge/homebridge-apt-pkg/blob/latest/README.md#using-apt)
+
+### UI Changes
+
+- updates to the `fi.json` language file (#2253) (@l1500s)
+- update default dashboard layout
+- add support for dark mode switching with custom plugin uis (@NorthernMan54)
+
+### Other Changes
+
+- retire use of `pnpm` and code references
+- bump the default node version from 20 to 22
+- make terminal enabled by default on new macOS hb-service installs
+- set service mode as default, remove standalone
+- Initial support for NodeJS 24 in preparation for LTS in Fall of 2025 (#2451) (@NorthernMan54)
+- update `fastify` and `nestjs` dependencies
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v3.0.0`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.13.0-beta`
+- `@homebridge/plugin-ui-utils` @ `v2.1.0`
+
+## v4.77.0 (Unreleased)
+
+### UI Changes
+
+- auto restart after version change of hb or ui
+- redesigned setup wizard page
+- style HBv2/UIv5 icons on status page based on readiness
+- security system modal only show valid modes
+- refactor settings page with immediate saving
+- add support for `uiSchema` within plugin configurations
+- add option to hide update notifications for specific plugins
+- improve plugin search and result ordering (@justjam2013)
+
+### Other Changes
+
+- Removed redundant Google Smart Home components (@NorthernMan54)
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v3.1.0`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.1.0`
+
+## v4.76.0 (2025-06-07)
+
+### UI Changes
+
+- updates to the `th.json` language file (#2443) (@tomzt)
+- improvements to various accessory tiles and modals
+- fix occasional issue in backup/restore, revert recent change
+- improvements to plugin config validation
+  - use `ajv-keywords` to allow validation of unique properties in arrays
+- fix form field error state font colour (make it red)
+- redesigned login page
+- improve wallpaper selection with new modal to upload a file
+- refactor HBv2 and UIv5 readiness modals
+- move backup settings from ui advanced settings to backup/restore modal
+- show lock management service info on lock mechanism info modal
+- show characteristic descriptions in info modal when available
+
+### Other Changes
+
+- upgrade to angular `v20`
+- bump `plugin-ui-utils` for new theme method
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.2.0`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.1.0`
+
+## v4.75.0 (2025-05-25)
+
+### UI Changes
+
+- updates to the uk.json language file (#2436) (@xrust83)
+- updates to the th.json language file (#2437) (@tomzt)
+- updates to the `manual_update_command` language string
+- show restart modal after installing an already configured plugin
+- add long click modal for lock mechanism + management
+- improvements to heater/humidifier/thermostat icon+modal
+- improvements to battery icon
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.1.0`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.2`
+
+## v4.74.0 (2025-05-18)
+
+### UI Changes
+
+- improve plugin manage version ui (#2424) (@apexskier)
+- capitalise time zone in system info widget
+- add architecture to system info widget
+- add checks on system for updating to ui v5
+- added screen for ui v5 readiness check
+- add color temperature to lightbulb screen (@justjam2013)
+- add temperature units to heatercooler (@justjam2013)
+- add valve control modal (@justjam2013)
+- update speaker tile + control modal (@justjam2013)
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.1.0`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.2`
+
+## v4.73.0 (2025-04-19)
+
+### UI Changes
+
+- updates to the `en.json` language file (#2389) (@HenryGelderbloem)
+- updates to the `de.json` language file (#2403) (@Staubgeborener)
+- updates to the `de.json` language file (#2404) (@Staubgeborener)
+- improve icons in bridges widget
+- fix individual accessory deselect on remove modal
+- improve accessory icons for CO and CO2 sensors
+- make secondary blue colour in light mode more distinct
+
+### Other Changes
+
+- fix do not include `--omit=dev` flag in `pnpm` commands
+- add lint job for checking all pull requests
+- allow package mode users to disable the terminal
+- various copilot improvements for file paths
+- updated dependencies
+- remove `ubuntu-20.04` from actions as unsupported
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.1.0`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.2`
+
+## v4.72.0 (2025-03-22)
+
+### UI Changes
+
+- updates to the `th.json` language file (#2365) (@tomzt)
+- updates to the `es.json` language file (#2376) (@kyrokode)
+- updates to the `id.json` language file (#2377) (@dwaan)
+- updates to the `ru.json` language file (#2384) (@SeregaTarasov)
+- fixed issue with UI config incorrectly reporting as invalid
+- don't allow adding multiple config blocks for singular plugins
+
+### Other Changes
+
+- updated dependencies
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.6`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.1`
+
+## v4.71.2 (2025-02-23)
+
+### Other Changes
+
+- fix alpha/beta update checks for bundled ui (#2363) (@dnicolson)
+- fix ui config validation when default theme selected
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.1`
+
+## v4.71.1 (2025-02-22)
+
+### UI Changes
+
+- updates to the `uk.json` language file (#2352) (@xrust83)
+- add missing add section button to plugin config screens
+- improve active/stale bridge detection
+- fix error state on plugin search input
+
+### Other Changes
+
+- re-add `reflect-metadata` to `dependencies` in `package.json`
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.1`
+
+## v4.71.0 (2025-02-09)
+
+### UI Changes
+
+- updates to the `uk.json` language file (#2348) (@xrust83)
+- allow docker users to disable the UI terminal via env
+  - set `HOMEBRIDGE_CONFIG_UI_TERMINAL_ENABLED=0`
+  - note that this has not been extensively tested
+- fix opening control accessory modal on mobile devices
+
+### Other Changes
+
+- update `@ng-formworks/` dependencies
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.1`
+
+## v4.70.0 (2025-02-08)
+
+### UI Changes
+
+- updates to the `th.json` language file (#2338) (@tomzt)
+- improvements to long-click accessory control
+  - also fixes accessory and room rearranging on the accessories page
+  - accessory and status page layout will now be locked by default on each visit
+- add message for docker/synology users in node update info modal
+
+### Other Changes
+
+- append `--omit=dev` to `npm i` commands
+- clean up `npm` cache before any install/uninstall
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.1`
+
+## v4.69.0 (2025-01-25)
 
 ### ⚠️ Plugin Config Validation
 
@@ -25,28 +259,217 @@ If you have a plugin which can be configured multiple times, then an icon will b
 
 Plugin developers:
 
-- Please do not rely on this validation and assume that a user's configuration will be valid
-- All plugins should still validate a configuration when the plugin is started
+- Please do not rely on this validation and assume that a user's configuration will be valid: you should still validate the user's config on plugin startup
 - Remember that some users do not use the UI at all, and other users may prefer to configure using raw `JSON` rather than config screens
-- Please report any cases where the validation is not working as expected, or where the 'Save' button is incorrectly disabled when using custom UIs
+- For custom UI screens, the validation icon will be hidden when the save button is disabled (using `homebridge.disableSaveButton()` from `@homebridge/plugin-ui-utils`)
+- Please report any cases where the validation is not working as expected
 
 ### UI Changes
 
-- implement and allow switching to scoped plugins
+- updates to the `uk.json` language file (#2312) (@xrust83)
+- updates to the `cs.json` language file (#2332) (@DavidHuljak)
+- fix typos in hb/ui settings schemas (#2317) (@dnicolson)
+- fix margins in update plugin modal
 - add plugin config validation functionality
 - refactor status and child bridge widgets
-- update default dashboard layout
+  - the existing 'status' widget has been renamed to 'update info' widget
+  - the existing 'child bridges' widget has been renamed to 'bridges' widget
+  - the homebridge status (from the old status widget) is now shown as a bridge in the new bridges widget
+  - node update information has been added to the new update info widget
+    - a widget option has been added to hide node update information: this may be useful for docker/synology users
+  - homebridge and ui version information has been moved from the footer to the new update info widget
+- add 'homebridge name' setting to settings page
+- migrate bootstrap from `v4` to `v5`
+- fix plugin config/bridge screens for certain plugins
+- add lighting mode option for terminal and log widgets
+  - only available when the UI is already in light mode
+- fix long press on mobile devices
+- control fan rotation direction from the ui
 
 ### Other Changes
 
-- retire use of `pnpm` and code references
-- enable strict config validation for the UI
-- bump the default node version from 20 to 22
+- improvements to GH actions and build processes (@NorthernMan54)
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.1`
+
+## v4.68.0 (2025-01-08)
+
+Happy 2025 to all our users! 🎉
+
+### UI Changes
+
+- updates to the `cs.json` language file (#2311) (@DavidHuljak)
+- improved messaging on plugin child bridge modal
+- further improvements to plugin search
+- implement and allow switching to scoped plugins
+- merge plugin info and verified modals
+  - condensing plugin card into title + three lines of description
+- consistent formatting of child bridge names across the ui
+- general improvements across the ui
+  - status page:
+    - individual widget setting form design made consistent with other forms
+    - added pairing status to qr code widget
+  - plugins page:
+    - visual improvements to plugin child bridge settings modal
+    - allow plugins to disable/enable the save button in custom uis (see below section)
+    - allow configuring [multiple accessories on the same child bridge](https://github.com/homebridge/homebridge/wiki/Child-Bridges#multiple-accessories-on-the-same-child-bridge) via the ui
+  - accessories page:
+    - changed accessory spanner icon to info icon (more descriptive)
+    - accessory info modal redesigned and provides more info where possible like the accessory UUID (including a link to remove from the cache)
+    - added support modal with some info about rooms and accessories (visible on desktop)
+  - json config page:
+    - redesigned restore modal to be more consistent with other modals
+  - settings page:
+    - chevron icons replaced with arrow-right icons
+    - removed restore modal from settings page and is accessible from the backup modal
+    - backup modal redesigned to be more consistent with other modals
+    - added new display -> menu mode setting which allows keeping the side menu from expanding out on desktop
+    - redesigned and improved accessories and bridges sections and modals
+  - users page:
+    - add user and edit user modals redesigned to be more consistent with other modals
+    - user card updated with icon buttons for edit/delete rather than text buttons
+
+### Plugin Custom UI Changes
+
+The UI has recently been updated with `@homebridge/plugin-ui-utils` @ `v2.0.0`, which includes a new feature to allow plugin developers to dynamically enable and disable the `Save` button in the custom UI modal.
+Two new methods have been added for this purpose:
+
+- `homebridge.disableSaveButton()`
+- `homebridge.enableSaveButton()`
+
+Developers: to maintain compatibility with older versions of the Homebridge UI, it is recommended to check if the methods exist before calling them in your custom UIs:
+
+- `homebridge.disableSaveButton?.()`
+- `homebridge.enableSaveButton?.()`
+
+### Other Changes
+
+- auto-fix ui theme setting property if existing value is not valid
+- do not allow `armv6l` users to update to UI `v5`
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.0`
+
+## v4.67.0 (2024-12-28)
+
+### UI Changes
+
+- add explanation of deleting child bridges when un-toggling
+- add filtering to search to improve results (#2286) (@justjam2013) (fixes [#2266](https://github.com/homebridge/homebridge-config-ui-x/issues/2266))
+- fix spacing issue with hidden accessories
+- make margins consistent of un/lock buttons on status screen
+- fix ui not restarting properly after updating the ui
+- use broom icon in remove bridge accessories (to match similar modal from plugin menu)
+
+### Other Changes
+
+- improve and finish up previous angular migration
+- update `hap-client` + `plugin-ui-utils` hb dependencies
+- update dependencies
+- improve lint sorting of imports
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.0`
+
+## v4.66.0 (2024-12-25)
+
+### UI Changes
+
+- fix verified plugins link in support module (fixes [#2295](https://github.com/homebridge/homebridge-config-ui-x/issues/2295))
+- add missing modal footer `<div>`s to accessory control modals
+- fix radio button groups in certain accessory control modals (fixes [#2294](https://github.com/homebridge/homebridge-config-ui-x/issues/2294))
+
+### Other Changes
+
+- format svg files nicely as part of lint
+- upgrade angular from `v18` to `v19`
+- delete unpaired bridges when toggling bridges off (#2284) (@justjam2013) (fixes [#2257](https://github.com/homebridge/homebridge-config-ui-x/issues/2257))
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.65.2 (2024-12-15)
+
+### UI Changes
+
+- Rollback recent changes to plugin search (#2289) (@justjam2013)
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.65.1 (2024-12-13)
+
+### UI Changes
+
+- updates to the `th.json` language file (#2271) (@tomzt)
+- updates to the `de.json` language file (#2250) (@Staubgeborener)
+- Remove unrelated plugins from search (#2272) (@justjam2013)
+
+### Other Changes
+
+- fix types + update dependencies
+- fix attach artifacts to release workflow
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.65.0 (2024-12-08)
+
+### UI Changes
+
+- updates to the `uk.json` language file (#2262) (@xrust83)
+- logo and `homebridge` text should link to status page
+- Add icons for shower head and water faucet valve types (#2267) (@justjam2013)
+- Removed conditional for displaying search exit component (#2269) (@justjam2013)
+
+### Other Changes
+
+- Fix typo in console message (#2264) (@markholland)
+- updated dependencies
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.64.0 (2024-11-30)
+
+### UI Changes
+
+- updates to the `de.json` language file (#2249) (@Staubgeborener)
+- updates to the `ko.json` language file (#2251) (@alphaorderly)
+- updates to the `uk.json` language file (#2255) (@xrust83)
+- add reload menu item when using as a PWA
+
+### Other Changes
+
+- dependency updates
+- fix npm search max character limit
 
 ### Homebridge Dependencies
 
-- `@homebridge/hap-client` @ `v2.0.4`
-- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.12.0-beta`
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
 - `@homebridge/plugin-ui-utils` @ `v1.0.3`
 
 ## v4.63.0 (2024-11-17)
@@ -72,8 +495,6 @@ Plugin developers:
 - migrate `@zajsf/*` to `@ng-formworks/*` for plugin schema forms
 - check for service mode when querying child bridge status
 - perform a full restart when updating `homebridge`
-- make terminal enabled by default on new macOS hb-service installs
-- update node pty beta `v0.12.0-beta`
 
 ### Homebridge Dependencies
 
@@ -549,7 +970,7 @@ Merry Christmas and Happy Holidays to all our users celebrating later this month
 - Various changes to the plugin cards
   - Plugin settings now accessible from the plugin card menu, called 'Config'
   - Icons: plugin devs can request an icon for their verified plugin at:
-    - https://github.com/homebridge/verified/issues/new/choose
+    - https://github.com/homebridge/plugins/issues/new/choose
 
 ### UI Changes
 

package/CONTRIBUTING.md

@@ -2,11 +2,12 @@
 
 Pull requests are welcome from everyone.
 
-This project is written in [TypeScript](https://www.typescriptlang.org/) and uses [Nest.js](https://nestjs.com/) for the server and [Angular](https://angular.io/) for the client UI.
+This project is written in [TypeScript](https://www.typescriptlang.org/) and uses [Nest.js](https://nestjs.com/) for the server and [Angular](https://angular.dev/) for the client UI.
 
 ## Getting Setup
 
-_Note: The Raspberry Pi and similar boards do not meet the memory or CPU requirements required to set up the development environment._
+> [!NOTE]
+> The Raspberry Pi and similar boards do not meet the memory or CPU requirements required to set up the development environment.
 
 First, remove any globally installed versions of `homebridge-config-ui-x` you may have installed on your development machine:
 
@@ -38,7 +39,7 @@ Symlink your development directory to global:
 npm link
 ```
 
-If you don't have homebridge installed already run:
+If you don't have Homebridge installed already run:
 
 ```sh
 npm install -g homebridge
@@ -52,7 +53,7 @@ This will start the Angular development server on port `4200` and a standalone s
 npm run watch
 ```
 
-You should now be able to navigate to `https://localhost:4200` in your browser which will connect to your `homebridge` instance running on port `8581`. The UI will automatically reload whenever you make changes to the code.
+You should now be able to navigate to `https://localhost:4200` in your browser which will connect to your Homebridge instance running on port `8581`. The UI will automatically reload whenever you make changes to the code.
 
 ## Running Tests
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 Homebridge
+Copyright (c) 2023-2025 Homebridge
 Copyright (c) 2017-2023 oznu <dev@oz.nu>
 Copyright (c) 2017 Michael Kellsy
 

package/README.md

@@ -28,8 +28,6 @@
 
 Homebridge UI also provides a tool called [`hb-service`](https://github.com/homebridge/homebridge-config-ui-x/wiki/Homebridge-Service-Command) which makes it easy to set up Homebridge as a service on Linux/Raspbian, macOS and Windows 10.
 
-[![Status](screenshots/homebridge-config-ui-x-darkmode-status.png?2020-01-07)](#usage)
-
 ## Installation Instructions
 
 For detailed instructions on how to set up Node.js and Homebridge with Homebridge UI as a service, see the guides on the wiki:
@@ -54,35 +52,35 @@ The UI can be accessed via web browser by default on port `8581` (e.g. `http://l
 
 This shows an overview of your Homebridge system. The dashboard is widget-based and completely customisable with a number of themes available.
 
-![Status](screenshots/homebridge-config-ui-x-status.png?2020-01-07)
+![Status](screenshots/homebridge-config-ui-x-status.png)
 
 ### Plugin Screen
 
 This shows you the currently installed plugins and allows you to install, configure, update and remove plugins.
 
-![Plugin](screenshots/homebridge-config-ui-x-darkmode-plugins.png?2020-01-07)
+![Plugin](screenshots/homebridge-config-ui-x-darkmode-plugins.png)
 
 You can configure supported plugins using the graphical settings editor, or by editing the config JSON directly.
 
-![Plugin Settings](screenshots/homebridge-config-ui-x-darkmode-alexa-settings.png?2020-01-07)
+![Plugin Settings](screenshots/homebridge-config-ui-x-darkmode-alexa-settings.png)
 
 ### Configuration Screen
 
 The configuration screen allows you to modify your Homebridge `config.json`. The built-in editor automatically syntax-checks your JSON and makes a backup of your config every time you make a change.
 
-![Config](screenshots/homebridge-config-ui-x-config.png?2020-01-07)
+![Config](screenshots/homebridge-config-ui-x-config.png)
 
 ### Log Screen
 
 This shows you the Homebridge rolling log. This is helpful for troubleshooting.
 
-![Log](screenshots/homebridge-config-ui-x-logs.png?2020-01-07)
+![Log](screenshots/homebridge-config-ui-x-logs.png)
 
 ### Accessories Screen
 
 This shows you the Homebridge accessories for all the Homebridge instances on your network. You can use this to control accessories from a web browser and works well on mobile devices which allows users to control Homebridge from non-Apple devices.
 
-![Accessories](screenshots/homebridge-config-ui-x-accessories.png?2020-01-07)
+![Accessories](screenshots/homebridge-config-ui-x-accessories.png)
 
 ## Plugin Development