Add ADS Valve documentation (#34666)

* Add ADS Valve documentation

* fix: remove not necessary TOC contents

* tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Adam Pasztor 2024-09-23 09:43:06 +02:00 committed by GitHub
parent 2ec23ed10b
commit f5c293f30d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -8,6 +8,7 @@ ha_category:
- Light
- Sensor
- Switch
- Valve
ha_release: '0.60'
ha_iot_class: Local Push
ha_domain: ads
@ -17,6 +18,7 @@ ha_platforms:
- light
- sensor
- switch
- valve
ha_integration_type: integration
related:
- docs: /docs/configuration/
@ -32,6 +34,7 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Switch](#switch)
- [Cover](#cover)
- [Valve](#valve)
## Configuration
@ -253,3 +256,28 @@ device_class:
description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend.
type: device_class
{% endconfiguration %}
## Valve
The `ads` valve entity accesses a boolean variable on the connected ADS device. The variable is identified by its name.
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
file:
```yaml
# Example configuration.yaml entry
valve:
- platform: ads
adsvar: MAIN.bValveControl
```
{% configuration %}
adsvar:
required: true
description: The name of the variable which you want to access on the ADS device.
type: string
name:
required: false
description: An identifier for the valve in the frontend.
type: string
{% endconfiguration %}