XS1 component (#7771)

* added icon
added documentation

* added configuration docs
added info on how to combine climate sensor and actuator into a single device

* updated doc to use "username" instead of "user" key
added full yaml conf example

* added documentation for every subcomponent
moved parts to appropriate sections
removed newlines

* updated Hass release to 0.88

* updated Hass release to 0.88

* updated Hass release to 0.88

* review fixes

* review fixes

* Delete climate.xs1.markdown

* Delete sensor.xs1.markdown

* Delete switch.xs1.markdown

* review fix

* review fix

* ✏️ Try to fix the build error

* ✏️ Tweaks
This commit is contained in:
Markus Ressel 2019-02-12 00:28:26 +01:00 committed by Franck Nijhof
parent 9b08846451
commit 676e753de9
2 changed files with 106 additions and 0 deletions

View File

@ -0,0 +1,106 @@
---
layout: page
title: "EZcontrol XS1"
description: "Instructions on how to integrate an XS1 Gateway within Home Assistant."
date: 2018-12-04 20:00
sidebar: true
comments: false
sharing: true
footer: true
logo: xs1.jpg
ha_category:
- Hub
- Climate
- Sensor
- Switch
ha_release: 0.88
featured: false
ha_iot_class: "Local Polling"
---
The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) integration for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official docs for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf).
## {% linkable_title Configuration %}
Add the following entry to the `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
xs1:
host: "192.168.2.100"
```
The component will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects.
{% configuration %}
host:
description: Host of the XS1 Gateway.
required: true
type: string
port:
description: Custom port if you are running your gateway behind some kind of proxy.
required: false
type: integer
default: 80
ssl:
description: Defines if `https` should be used for API requests (only possible via your own proxy).
required: false
type: boolean
default: false
username:
description: User to access XS1 web API.
required: false
type: string
password:
description: Password to access XS1 web API.
required: false
type: string
{% endconfiguration %}
## {% linkable_title Supported Device Types %}
<p class='note warning'>
This component currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored.
</p>
### {% linkable_title Sensors %}
Any type of sensor is supported.
<p class='note warning'>
If you are using climate devices the "current temp" sensor will be automatically used by the actuator (if named correctly). To make this work have a look at the actuator description below.
</p>
### {% linkable_title Actuators %}
| Type | Supported | Notes |
|---------------|-----------|--------------------------------------------------|
| `switch` | Yes | |
| `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :(|
| `temperature` | Yes | |
### {% linkable_title Climate Actuator/Sensor%}
Home Assistant can combine temperature sensors and climate actuators into a single device. The XS1 gateway does not allow this, but a sensor and actuator can be configured separately. To make Home Assistant register them in the same climate device just prefix the **sensor** name with the actuator name on the XS1 gateway configuration, f.ex:
- Actuator device name: "Bedroom_Temp"
- Sensor device name: "Bedroom_Temp_Sensor"
## {% linkable_title Examples %}
In this section, you find some real-life examples of how to use this component.
### {% linkable_title Full configuration %}
This example shows how you can use the optional configuration options.
```yaml
# Example configuration.yaml entry
xs1:
host: "192.168.2.100"
port: 80
ssl: false
username: myuser
password: 123totallySecure
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB