Added docs for AquaLogic component. (#6327)

* Added docs for AquaLogic component.

* Update AquaLogic docs as per review.

* Update as per review.
This commit is contained in:
Sean Wilson 2018-10-03 11:11:37 -04:00 committed by Fabian Affolter
parent 5e41099b93
commit 3ad0337b0d
4 changed files with 151 additions and 0 deletions

View File

@ -0,0 +1,38 @@
---
layout: page
title: "AquaLogic"
description: "Instructions on how to integrate an AquaLogic controller within Home Assistant."
date: 2018-09-17 9:16
sidebar: true
comments: false
sharing: true
footer: true
logo: hayward.png
ha_category: Hub
ha_release: "0.80"
ha_iot_class: "Local Push"
---
The AquaLogic component provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required.
## {% linkable_title Configuration %}
To add the AquaLogic component to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
aqualogic:
host: 192.168.1.1
port: 23
```
{% configuration %}
host:
description: The domain name or IP address of the RS-485 to Ethernet adapter connected to the pool controller, eg. 192.168.1.1.
required: true
type: string
port:
description: The port provided by the RS-485 to Ethernet adapter.
required: true
type: int
{% endconfiguration %}

View File

@ -0,0 +1,55 @@
---
layout: page
title: "AquaLogic Sensor"
description: "Instructions on how to integrate your AquaLogic devices within Home Assistant."
date: 2018-09-17 9:16
sidebar: true
comments: false
sharing: true
footer: true
logo: hayward.png
ha_category: Sensor
ha_release: "0.80"
ha_iot_class: "Local Push"
---
To get your AquaLogic sensors working within Home Assistant, please follow the instructions for the general [AquaLogic component](/components/aqualogic).
## {% linkable_title Configuration %}
Once you have enabled the [AquaLogic component](/components/aqualogic), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: aqualogic
monitored_conditions:
- pool_temp
```
{% configuration %}
monitored_conditions:
description: List of items you want to monitor.
required: false
default: all
type: list
keys:
air_temp:
description: The air temperature.
pool_temp:
description: The pool temperature.
spa_temp:
description: The spa temperature.
pool_chlorinator:
description: The pool chlorinator setting.
spa_chlorinator:
description: The spa chlorinator setting.
salt_level:
description: The current salt level.
pump_speed:
description: The current pump speed (Hayward VS pumps only).
pump_power:
description: The current pump power usage (Hayward VS pumps only).
status:
description: The current system status.
{% endconfiguration %}

View File

@ -0,0 +1,58 @@
---
layout: page
title: "AquaLogic Switch"
description: "Instructions on how to integrate your AquaLogic devices within Home Assistant."
date: 2018-09-17 9:16
sidebar: true
comments: false
sharing: true
footer: true
logo: hayward.png
ha_category: Switch
ha_release: "0.80"
ha_iot_class: "Local Push"
---
To get your AquaLogic switches working within Home Assistant, please follow the instructions for the general [AquaLogic component](/components/aqualogic).
## {% linkable_title Configuration %}
Once you have enabled the [AquaLogic component](/components/aqualogic), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: aqualogic
monitored_conditions:
- lights
- filter
```
{% configuration %}
monitored_conditions:
description: List of items you want to monitor/control.
required: false
default: all
type: list
keys:
filter:
description: Controls the filter pump.
filter_low_speed:
description: Controls low speed mode on the filter pump (multi-speed pumps only).
lights:
description: Controls the Lights relay.
aux_1:
description: Controls the Aux 1 relay.
aux_2:
description: Controls the Aux 2 relay.
aux_3:
description: Controls the Aux 3 relay.
aux_4:
description: Controls the Aux 4 relay.
aux_5:
description: Controls the Aux 5 relay.
aux_6:
description: Controls the Aux 6 relay.
aux_7:
description: Controls the Aux 7 relay.
{% endconfiguration %}

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB