Skip to content

Add Homebridge Config UI for Script2 with on_off/stateless sections and schema updates#101

Merged
pponce merged 2 commits into
betafrom
codex/refactor-configuration-ui-and-update-documentation-midy7u
May 24, 2026
Merged

Add Homebridge Config UI for Script2 with on_off/stateless sections and schema updates#101
pponce merged 2 commits into
betafrom
codex/refactor-configuration-ui-and-update-documentation-midy7u

Conversation

@pponce
Copy link
Copy Markdown
Owner

@pponce pponce commented May 24, 2026

Motivation

  • Provide a richer Homebridge Config UI X experience by exposing separate on_off_switches and stateless_switches sections and a custom UI rather than relying on raw JSON devices only.
  • Preserve backward compatibility with existing devices legacy configs while encouraging migration to structured sections for reliable UI editing.
  • Ship an in-plugin UI and server so users can add/manage Script2 accessories without manual JSON editing.

Description

  • Updated README.md to document the new recommended configuration shape (on_off_switches and stateless_switches), migration notes, examples, and installation steps.
  • Extended config.schema.json to add customUi, customUiPath, a full schema for on_off_switches and stateless_switches, and a conditional devices legacy section for backward compatibility, with improved form metadata and validation rules.
  • Added a minimal plugin UI under homebridge-ui/public (index.html, index.js) and a UI server homebridge-ui/server.js that uses @homebridge/plugin-ui-utils to enable the custom config experience.
  • Bumped package version and added the UI dependency @homebridge/plugin-ui-utils and ensured node engine requirement is present in package.json.

Testing

  • No automated tests were run as part of this change.

Codex Task

@pponce pponce merged commit 48df1ab into beta May 24, 2026
@pponce pponce deleted the codex/refactor-configuration-ui-and-update-documentation-midy7u branch May 24, 2026 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant