homebridge-dolphin
v0.5.5
Published
Dolphin Boiler - Smart Water Heating Control: https://www.dolphinboiler.com/
Downloads
12
Maintainers
Readme
homebridge-dolphin
Homebridge Plugin for Dolphin Boiler - Smart Water Heating Control.
Requirements
check with: node -v
& homebridge -V
and update if needed
Installation
This plugin can be easily installed and configured through Homebridge/Hoobs UI.
If you don't use Homebridge UI or HOOBS, or if you want to know more about the plugin features and options, keep reading...
- Install homebridge using:
sudo npm install -g homebridge --unsafe-perm
- Install this plugin using:
sudo npm install -g homebridge-dolphin
- Update your configuration file. See
sample-config.json
in this repository for a sample.
* install from git: sudo npm install -g git+https://github.com/nitaybz/homebridge-dolphin.git
Config file
"platforms": [
{
"platform": "Dolphin",
"email": "[email protected]",
"password": "*************",
"devices": [
{
"serial": "YFUY323DG43",
"name": "Dolphin Boiler",
"enableShowerSwitches": true,
"connectionSensor": true,
"hotWaterSensor": "OccupancySensor"
}
],
"enableHistoryStorage": true,
"debug": true
}
]
Configurations
| Parameter | Description | Required | Default | type |
| -------------------------------- | ------------------------------------------------------- |:--------:|:---------:|:---------:|
| platform
| always "Dolphin" | ✓ | - | String |
| email
| your Dolphin account email | ✓ | - | String |
| password
| your Dolphin account password | ✓ | - | String |
| debug
| When set to true
, the plugin will produce extra logs for debugging purposes | | false
| Boolean / Array* |
| Devices | List of Dolphin devices (with the below information) | ✓ | - | Array |
| serial
| Your Dolphin device serial number | ✓ | - | String |
| name
| The accessory name that will appear in HomeKit | ✓ | - | String |
| enableShowerSwitches
| Enabling this will create switch for each amount of showers your boiler is capable of. It will allow you to turn on the boiler for X showers | ✓ | true | Boolean |
Troubleshooting
Report Issues & Debug
If you experience any issues with the plugins please refer to the Issues tab and check if your issue is already described there, if it doesn't, please create a new issue with as much detailed information as you can give (logs are crucial).
if you want to even speed up the process, you can add "debug": true
to your config, which will give me more details on the logs and speed up fixing the issue.
Support homebridge-dolphin
homebridge-dolphin is a free plugin under the MIT license. it was developed as a contribution to the homebridge/hoobs community with lots of love and thoughts. Creating and maintaining Homebridge plugins consume a lot of time and effort and if you would like to share your appreciation, feel free to "Star" or donate.