Documentation for Balboa Spa integration (#20177)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Tim Rightnour 2021-11-29 06:27:24 -07:00 committed by GitHub
parent 339a8fbe7c
commit f10fdadb57
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,56 @@
---
title: "Balboa Spa"
description: "Instructions on how to integrate Balboa Spa WiFi within Home Assistant."
ha_category:
- Climate
ha_release: 2021.12
ha_iot_class: Local Push
ha_domain: balboa
ha_platforms:
- climate
ha_codeowners:
- '@garbled1'
ha_config_flow: true
---
This integration adds support for [Balboa](http://www.balboawatergroup.com/) Spa WiFi Modules to be used within Home Assistant.
There is currently support for the following device types within Home Assistant:
- Climate
{% include integrations/config_flow.md %}
{% configuration_basic %}
host:
description: "Hostname or IP address of your Balboa Spa Wifi Device, e.g., `192.168.1.58`."
required: true
type: string
{% endconfiguration_basic %}
{% include integrations/option_flow.md %}
{% configuration_basic %}
sync_time:
description: Sync the Spa's internal clock with Home Assistant daily
type: boolean
default: false
{% endconfiguration_basic %}
## Known limitations
- The WiFi Module is a direct connection to the control panel of the spa. Certain combinations of settings are not possible due to limitations of the spa.
- Turning on certain pumps, depending on the spa configuration, may cause other pumps to come online as well.
- The spa WiFi Module will need to be configured initially by the phone app to authenticate and get an IP on your network.
- The WiFi Module will automatically disconnect from Home Assistant periodically, and then be automatically reconnected. The disconnect is built-in to the hardware.
## Debugging integration
If you have problems with Balboa or the integration you can add debug prints to the log.
```yaml
logger:
default: info
logs:
pybalboa: debug
homeassistant.components.balboa: debug
```