mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Clean up - uv (#7024)
trailing spaces code quotes empty lines grammar titles
This commit is contained in:
Jorim Tielemans
Fabian Affolter
parent
06dba4975d
commit
4504576383
@ -13,7 +13,6 @@ logo: upcloud.png
|
||||
ha_iot_class: Cloud Polling
|
||||
---
|
||||
|
||||
|
||||
The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant.
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
@ -15,7 +15,9 @@ ha_release: 0.51
|
||||
|
||||
The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuum.
|
||||
|
||||
You have first to setup the [Dyson component](/components/dyson/)
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You have to set up the [Dyson component](/components/dyson/) first.
|
||||
|
||||
### {% linkable_title Component services %}
|
||||
|
||||
|
||||
@ -15,7 +15,9 @@ ha_release: 0.77
|
||||
|
||||
The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums.
|
||||
|
||||
You have first to setup the [Ecovacs component](/components/ecovacs/)
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You have to set up the [Ecovacs component](/components/ecovacs/) first.
|
||||
|
||||
### {% linkable_title Component Lifespans %}
|
||||
|
||||
|
||||
@ -11,6 +11,8 @@ footer: true
|
||||
|
||||
The `vacuum` component enables the ability to control home cleaning robots within Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/).
|
||||
|
||||
```yaml
|
||||
|
||||
@ -14,6 +14,8 @@ ha_release: 0.54
|
||||
|
||||
The `mqtt` vacuum component allows you to control your MQTT-enabled vacuum.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add your MQTT vacuum to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -21,6 +21,8 @@ The status will contain attributes on the robots last clean session.
|
||||
If you notice the robot stops responding to commands check the status attribute to see if the robot is offline. If you see "Robot Offline" check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add `neato` vacuum to your installation, please follow instructions in [Neato component](/components/neato/).
|
||||
|
||||
Currently supported services are:
|
||||
|
||||
@ -18,6 +18,8 @@ The `roomba` component allows you to control your [iRobot Roomba](http://www.iro
|
||||
This platform has only been tested with an iRobot Roomba 980 but should work find with any Wi-Fi enabled Roomba like the 690, 890 or the 960.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -31,7 +33,7 @@ vacuum:
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: Hostname or IP address of the Roomba.
|
||||
description: The hostname or IP address of the Roomba.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
@ -45,18 +47,18 @@ password:
|
||||
name:
|
||||
description: The name of the vacuum.
|
||||
required: false
|
||||
default: Roomba
|
||||
type: string
|
||||
default: Roomba
|
||||
certificate:
|
||||
description: Path to your certificate store.
|
||||
required: false
|
||||
default: /etc/ssl/certs/ca-certificates.crt
|
||||
type: string
|
||||
default: /etc/ssl/certs/ca-certificates.crt
|
||||
continuous:
|
||||
description: Whether to operate in continuous mode.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
|
||||
@ -26,11 +26,11 @@ Currently supported services are:
|
||||
- `set_fan_speed`
|
||||
- remote control of your robot.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Please follow [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to retrieve the API token used in
|
||||
`configuration.yaml`.
|
||||
|
||||
## {% linkable_title Configuring the Platform %}
|
||||
|
||||
To add a vacuum to your installation, add the following to `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
@ -41,18 +41,19 @@ vacuum:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP of your robot.
|
||||
required: true
|
||||
type: string
|
||||
token:
|
||||
description: The API token of your robot.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name of your robot.
|
||||
required: false
|
||||
type: string
|
||||
host:
|
||||
description: The IP address of your robot.
|
||||
required: true
|
||||
type: string
|
||||
token:
|
||||
description: The API token of your robot.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name of your robot.
|
||||
required: false
|
||||
type: string
|
||||
default: Xiaomi Vacuum cleaner
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Platform Services %}
|
||||
|
||||
@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
[Velux](http://www.velux.com) integration for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
A `velux` section must be present in the `configuration.yaml` file and contain the following options as required:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -16,6 +16,8 @@ The [Vera](http://getvera.com) hub is a controller mainly connecting to Z-Wave d
|
||||
|
||||
Switches, Lights (inc Dimmers), Locks, Sensors, Binary sensors, and Scenes are supported - and will be automatically added when HA connects to your Vera controller.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use Vera devices in your installation, add the following to your configuration.yaml file using the IP and port number of your Vera controller:
|
||||
|
||||
```yaml
|
||||
@ -34,7 +36,7 @@ vera_controller_url:
|
||||
It is recommended to assign a static IP address to your Vera Controller. This ensures that it won't change IP addresses, so you won't have to change the `vera_controller_url` if it reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Vera, check the label on the bottom.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Configure devices %}
|
||||
### {% linkable_title Configure devices %}
|
||||
|
||||
By default your switches will be added to Home Assistant as switches, however, if some of them are light switches, you can tell Home Assistant this using the optional `lights` parameter as shown below.
|
||||
|
||||
@ -51,6 +53,6 @@ vera:
|
||||
lights: [15, 17, 19, 21, 22, 24, 26, 43, 64, 70, 87]
|
||||
```
|
||||
|
||||
### {% linkable_title Using Z-Wave devices in automation %}
|
||||
### {% linkable_title Using Z-Wave devices in automation %}
|
||||
|
||||
If you want to use a Z-Wave device from the Vera controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under the <img src='/images/screenshots/developer-tool-states-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> icon of the Developer Tools section. Look for entities that contain 'Vera Device Id' in their attributes, and you'll find the entity id on the left.
|
||||
|
||||
@ -24,6 +24,8 @@ We support:
|
||||
* [Locks](/components/lock.verisure/)
|
||||
* [Door & Window](/components/binary_sensor.verisure/)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate Verisure with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -43,45 +45,45 @@ password:
|
||||
required: true
|
||||
type: string
|
||||
alarm:
|
||||
description: Set to true to show alarm, false to disable.
|
||||
description: Set to `true` to show alarm, `false` to disable.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
hygrometers:
|
||||
description: Set to true to show hygrometers, false to disable.
|
||||
description: Set to `true` to show hygrometers, `false` to disable.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
smartplugs:
|
||||
description: Set to true to show smartplugs, false to disable.
|
||||
description: Set to `true` to show smartplugs, `false` to disable.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
locks:
|
||||
description: Set to true to show locks, false to disable.
|
||||
description: Set to `true` to show locks, `false` to disable.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
thermometers:
|
||||
description: Set to true to show thermometers, false to disable.
|
||||
description: Set to `true` to show thermometers, `false` to disable.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
mouse:
|
||||
description: Set to true to show mouse detectors, false to disable.
|
||||
description: Set to `true` to show mouse detectors, `false` to disable.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
door_window:
|
||||
description: Set to true to show mouse detectors, false to disable.
|
||||
description: Set to `true` to show mouse detectors, `false` to disable.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
default: true
|
||||
code_digits:
|
||||
description: Number of digits in PIN code.
|
||||
required: false
|
||||
default: 4
|
||||
type: integer
|
||||
default: 4
|
||||
giid:
|
||||
description: The GIID of your installation (If you have more then one alarm system). To find the GIID for your systems run 'python verisure.py EMAIL PASSWORD installations'.
|
||||
required: false
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: 0.39
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `volvooncall` component offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
@ -90,6 +89,6 @@ resources:
|
||||
scandinavian_miles:
|
||||
description: If set to true, Scandinavian miles ("mil") are used for distances and fuel range.
|
||||
required: false
|
||||
defaults: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -14,9 +14,10 @@ logo: vultr.png
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#settingsapi).
|
||||
|
||||
<p class='note'>
|
||||
@ -37,4 +38,3 @@ api_key:
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user