⚠️ Upcoming Deprecations:
- The next major version
v5
of the Homebridge UI will:- Be compatible with Homebridge
v1
andv2
- Drop support for Node.js
v18
and earlier, so please update tov20
orv22
- more info on updating - Drop support for Raspberry Pi devices running on the
armv6
architecture (like the Pi 1 and Pi Zero) - please update your hardware - Drop support for instances using
pnpm
as the package manager - consider updating your Homebridge instance to use npm instead - more info on updating
- Be compatible with Homebridge
- Note that these are not requirements for UI
v4.69.0
⚠️ Plugin Config Validation
This version of Homebridge UI adds validation to plugin config screens. This does not apply to manual plugin configuration (with raw JSON
).
- If your entered configuration is valid, then you will see a green tick by the save button.
- If your configuration is not valid, then you will see an orange warning triangle by the save button. You will still be allowed to save the configuration.
- A plugin can enforce strict validation:
- For plugin developers: if you want to enforce a valid configuration, you can add
"strictValidation": true
as a root property to yourconfig.schema.json
file. - For users: if the plugin developer has enabled this setting and your configuration is invalid, then you will see a red warning triangle by the save button. You will not be allowed to save the configuration until it is valid.
- For plugin developers: if you want to enforce a valid configuration, you can add
If you have a plugin which can be configured multiple times, then an icon will be shown on each configuration block.
Plugin developers:
- 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 - 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
- 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
- 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
tov5
- 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
- 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