https://github.com/homebridge-plugins/homebridge-smarthq
https://github.com/homebridge-plugins/homebridge-smarthq
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/homebridge-plugins/homebridge-smarthq
- Owner: homebridge-plugins
- License: isc
- Created: 2024-11-09T04:16:48.000Z (over 1 year ago)
- Default Branch: latest
- Last Pushed: 2026-01-14T20:46:56.000Z (6 months ago)
- Last Synced: 2026-01-15T00:45:08.073Z (6 months ago)
- Language: TypeScript
- Size: 883 KB
- Stars: 15
- Watchers: 5
- Forks: 7
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Homebridge SmartHQ
The Homebridge SmartHQ
plugin allows which allows to interact with SmartHQ API.
## Installation
1. Search for "SmartHQ" on the plugin screen of [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x).
2. Click **Install**.
## Configuration
1. Input Username & Password
2. Click Save
3. Restart Homebridge
## Supported SmartHQ Features
This plugin is in development
## Homekit Controller Notifications
Currently Homekit Controller Notifications are supported for the Opal Ice Maker, to setup, install Homekit Controller App and configure notifications for each respective event. Put your Homekit Controller client secret in the Plugin Advanced Options, and the path associated with each available notifcation in the Opal device options.
These are the events that are currently supported:
- Ice Bucket Full
- Production Progress Complete
- Filter Maintenance Change Alert
- Descale Needed Alert
- Add Water Alert
## Contributing
This project uses a beta-first workflow for all contributions:
- 🎯 **All PRs must target beta branches first**, never the main `latest` branch
- 🏷️ **Required labels**: Set `patch`, `minor`, or `major` labels before assigning issues to Copilot
- 🌿 **Current beta branch**: `beta-0.5.0` (active development)
For detailed contribution guidelines, see [.github/copilot-instructions.md](.github/copilot-instructions.md).
Use the branch helper tool to determine the correct target branch:
```bash
.github/scripts/branch-helper.sh
```