Review/Edit components starting with the letter U-Z (#3229)

This commit is contained in:
Franck Nijhof 2017-08-24 08:32:12 +02:00 committed by Fabian Affolter
parent ef83caf598
commit a24e142eaf
18 changed files with 55 additions and 55 deletions

View File

@ -11,9 +11,9 @@ logo: home-assistant.png
ha_category: Other
---
The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version was found.
The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found.
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the timezone, Python version and operating system information. No identifiable information (i.e. IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). For further information about the Updater's data please check the [detailed overview](/docs/backend/updater/).
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/).
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:

View File

@ -86,7 +86,7 @@ Tell the vacuum cleaner to do a spot clean-up.
#### {% linkable_title Service `vacuum/set_fanspeed` %}
Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number, it depends of the `vacuum` platform.
Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|

View File

@ -15,7 +15,7 @@ ha_release: 0.51
The `roomba` component allows you to control your [Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx).
<p class='note'>
This platform has only been tested with an iRobot Roomba 980, but should work find
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>

View File

@ -28,17 +28,17 @@ $ sudo su -s /bin/bash homeassistant
$ source /srv/homeassistant/bin/activate
```
In order to fetch the token follow these instructions depending on your mobile phone platform.
To fetch the token follow these instructions depending on your mobile phone platform.
### Windows and Android
1. Configure the robot with the Mi-Home app.
2. Enable developer mode and USB debugging on the Android phone and plug it into the computer.
3. Get ADB tool for Windows : https://developer.android.com/studio/releases/platform-tools.html
3. Get ADB tool for Windows: https://developer.android.com/studio/releases/platform-tools.html
4. Create a backup of the application com.xiaomi.smarthome:
```bash
.\adb backup -noapk com.xiaomi.smarthome -f backup.ab
```
5. If you have this message : "More than one device or emulator", use this command to list all devices:
5. If you have this message: "More than one device or emulator", use this command to list all devices:
```bash
.\adb devices
```
@ -47,14 +47,14 @@ and execute this command:
.\adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command)
```
6. On the phone, you must confirm the backup. DO NOT enter any password and press button to make the backup.
7. Get ADB Backup Extractor : https://sourceforge.net/projects/adbextractor/
7. Get ADB Backup Extractor: https://sourceforge.net/projects/adbextractor/
8. Extract All files from the backup:
```bash
java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar ""
```
9. Unzip the ".tar" file.
10. Open the sqlite DB miio2.db with a tool like SQLite Manager extension for FireFox.
11. Get token from "devicerecord" table.
10. Open the SQLite DB miio2.db with a tool like SQLite Manager extension for FireFox.
11. Get the token from "devicerecord" table.
### macOS and iOS
@ -116,7 +116,7 @@ Remote control the vacuum cleaner, make sure you first set it in remote control
#### {% linkable_title Service `vacuum/xiaomi_remote_control_move_step` %}
Use this call to enter the remote control mode, make one movement, and stop and exit the remote control mode.
Use this call to enter the remote control mode, make one move, and stop and exit the remote control mode.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|

View File

@ -33,9 +33,9 @@ Configuration variables:
### {% 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.
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.
Vera imports detailed Z-Wave devices into Home Assistant. This can include system devices and other devices that you don't use, you can tell Home Assistant not to load these devices using the `exclude:` parameter as shown below.
Vera imports detailed Z-Wave devices into Home Assistant. This can include system devices and other devices that you don't use; you can tell Home Assistant not to load these devices using the `exclude:` parameter as shown below.
You can find the Vera device id either via the advanced properties of the device in the Vera UI or by checking the `Vera Device Id` attribute on each device imported into Home Assistant (under the developer tools).
@ -50,4 +50,4 @@ vera:
### {% 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, you'll find the entity id on the left.
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.

View File

@ -14,7 +14,7 @@ ha_iot_class: "Cloud Polling"
---
The `volvooncall` platform offers integrates 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.
The `volvooncall` platform 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.
To use Volvo On Call in your installation, add the following to your `configuration.yaml` file:

View File

@ -13,7 +13,7 @@ ha_release: "0.49"
ha_iot_class: "Local Push"
---
The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, in order to turn them on.
The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to them on.
To use this component in your installation, add the following to your `configuration.yaml` file:

View File

@ -13,10 +13,10 @@ ha_release: 0.47
ha_iot_class: "Cloud Polling"
---
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands.
The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weatherstations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands.
The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
To add the buienradar weather to your installation, add the following to your `configuration.yaml` file:
To add the Buienradar weather to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -26,9 +26,9 @@ weather:
Configuration variables:
- **name** (*Optional*): You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of 'weather.[name]'; if no name is specified, it will try to set its name to 'weather.BR_[stationname]'. However at the moment in time the entity is created, no data has been retrieved yet, so the entity will get named 'weather.BR_unknown_station'. Later the station name will be known and get updated, but the entity name remains.
- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
- **longitude**(*Optional*): Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
- **name** (*Optional*): You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of 'weather.[name]'; if no name is specified, it will try to set its name to 'weather.BR_[stationname]'. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named 'weather.BR_unknown_station'. Later the station name will be known and get updated, but the entity name remains.
- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar.
- **longitude**(*Optional*): Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar.
- **forecast** (*Optional*): 'True' to add a temperature forecast, 'False' to suppress it.
@ -51,4 +51,4 @@ The weather platform is easier to configure but less customisable.
</p>
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
> Buienradar makes free weatherdata available for use by individuals and businesses (website/intranet). The use of the weatherdata is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission.
> Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission.

View File

@ -9,8 +9,8 @@ sharing: true
footer: true
---
The `weather` platforms are gathering meteorological information from web services and displays the conditions and other details about the weather at the given location.
The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location.
Home Assistant currently supports free web services and such which requires a registration. Please check the sidebar for a full list of supported `weather` platforms.
Home Assistant currently supports free web services and such which require a registration. Please check the sidebar for a full list of supported `weather` platforms.

View File

@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling"
The `metoffice` weather platform uses the Met Office's [DataPoint API][datapoint] for weather data.
To add the Met Office weather platform to your installation you'll need to register for a free api key at the link above and then add the following to your `configuration.yaml` file:
To add the Met Office weather platform to your installation, you'll need to register for a free API key at the link above and then add the following to your `configuration.yaml` file:
```yaml
weather:

View File

@ -13,7 +13,7 @@ ha_release: 0.32
ha_iot_class: "Cloud Polling"
---
The `openweathermap` weather platform uses [OpenWeatherMap](http://openweathermap.org/) as an source for current meteorological data for your location.
The `openweathermap` weather platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location.
You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up).

View File

@ -13,13 +13,13 @@ ha_release: 0.47
---
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. This component will show you the condition and tempratures for max. 10 days.
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as a source for current meteorological data. This component will show you the condition and temperatures for max. 10 days.
<p class='note warning'>
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
</p>
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it generate it from Home Assistant's latitude and longitude.
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID, it will be generated from Home Assistant's latitude and longitude.
To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file:

View File

@ -15,14 +15,14 @@ ha_release: pre 0.7
The `wemo` component is the main component to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant.
Supported devices will be automatically discovered if the discovery component is enabled. If you are not using the discovery component, loading the `wemo` component will scan for WeMo devices on the local network.
Supported devices will be automatically discovered if the discovery component is enabled. Loading the `wemo` component will scan the local network for WeMo devices, even if you are not using the discovery component
```yaml
# Example configuration.yaml entry
wemo:
```
Alternately, WeMo devices that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, and/or devices in a remote location reachable over a VPN, you will need to manually configure them. This is also useful if you wish to disable discovery for some wemos, even if they are local. Example static configuration:
Alternately, WeMo devices that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, or devices in a remote location reachable over a VPN, you will need to configure them manually. This is also useful if you wish to disable discovery for some WeMo's, even if they are local. Example static configuration:
```yaml
wemo:
@ -33,6 +33,6 @@ wemo:
Any WeMo devices that are not statically configured but reachable via discovery will still be added automatically.
Note that if you use this, you may want to configure your router (or whatever runs your DHCP server) to force your WeMo devices to use a static IP address. Check the DHCP section of your router configuration for this ability.
Note that if you use this, you may want to set up your router (or whatever runs your DHCP server) to force your WeMo devices to use a static IP address. Check the DHCP section of your router configuration for this ability.
If the device doesn't seem to work and all you see is the state "unavailable" on your dashboard, check that your firewall doesn't block incoming request on port 8989 since this is the address to which the WeMo devices sends their update.
If the device doesn't seem to work and all you see is the state "unavailable" on your dashboard, check that your firewall doesn't block incoming request on port 8989 since this is the address to which the WeMo devices send their update.

View File

@ -22,14 +22,14 @@ ha_release: pre 0.7
Home Assistant integrates with the Wink API and automatically sets up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.
Check the related components pages for actual devices that are support.
Check the related components pages for actual devices that are supported.
Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.
### Authenticate using [developer.wink.com](https://developer.wink.com)
This method will require you to setup a developer account with Wink. This process can take a few days to get approved, but is the recommended form of authentication. If you would like to use Wink in Home Assistant while you wait, you can use the email and password authentication below.
This method will require you to setup a developer account with Wink. This process can take a few days to get approved but is the recommended form of authentication. If you would like to use Wink in Home Assistant while you wait, you can use the email and password authentication below.
This form of authentication doesn't require any settings in the configuration.yaml other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
@ -68,27 +68,27 @@ wink:
Configuration variables:
- **email** (*Required for email/password auth or legacy oauth*): Your Wink login email.
- **password** (*Required for email/password auth or legacy oauth*): Your Wink login password.
- **client_id** (*Required for legacy oauth*): Your provided Wink client_id.
- **client_secret** (*Required for legacy oauth*): Your provided Wink client_secret.
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be issue to the local hub.
- **email** (*Required for email/password auth or legacy OAuth*): Your Wink login email.
- **password** (*Required for email/password auth or legacy OAuth*): Your Wink login password.
- **client_id** (*Required for legacy OAuth*): Your provided Wink client_id.
- **client_secret** (*Required for legacy OAuth*): Your provided Wink client_secret.
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be an issue to the local hub.
Local control:
- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `False`
- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `False`.
- Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage.
- Local control is also only available for the Wink hub v1 and v2, not the Wink relay.
- Local control isn't used during startup of Home Assistant, this means initial setup requires an active internet connection.
- Local control isn't used during start-up of Home Assistant; this means initial setup requires an active internet connection.
- Local control requests are first sent to the controlling hub. In the event that a request fails, that request will attempt to go online.
- Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online.
<p class='note'>
It is possible for the hub to get into a bad state where it stops accepting local control request. If this happens you will notice requests taking significantly longer as they are redirected online. This doesn't happen often, but when it does, it appears to be resolved by rebooting the hub.
It is possible for the hub to get into a bad state where it stops accepting local control request. If this happens, you will notice requests taking significantly longer as they are redirected online. This doesn't happen often, but when it does, it appears to be resolved by rebooting the hub.
The following error will be logged in the event that the hub is rejecting local requests.
The following error will be logged if the hub is rejecting local requests.
```
Error sending local control request. Sending request online
@ -98,7 +98,7 @@ Error sending local control request. Sending request online
### {% linkable_title Service `refresh_state_from_wink` %}
The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions were an update isn't pushed device states can be out of sync.
The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync.
You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `True` states will be pulled from the devices controlling hub, not the online API.
@ -107,6 +107,6 @@ You can use the service wink/refresh_state_from_wink to pull the most recent sta
You can use the service wink/add_new_devices to pull any newly paired Wink devices to an already running instance of Home-Assistant. Any new devices will also be added if Home-Assistant is restarted.
<p class='note'>
The Wink hub, by default can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling and updating devices (~3s).
The Wink hub, by default, can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling and updating devices (~3s).
</p>

View File

@ -96,7 +96,7 @@ Configuration variables:
## {% linkable_title Services %}
The gateway provides two services: `xiaomi.play_ringtone` and `xiaomi.stop_ringtone`. To play ringtones by Home Assistant the version of the gateway firmware must be `1.4.1_145` at least. A `ringtone_id` and `gw_mac` must be supplied. The parameter `ringtone_vol` (percent) is optional. Allowed values of the `ringtone_id` are:
The gateway provides two services: `xiaomi.play_ringtone` and `xiaomi.stop_ringtone`. To play ringtones by Home Assistant, the version of the gateway firmware must be `1.4.1_145` at least. A `ringtone_id` and `gw_mac` must be supplied. The parameter `ringtone_vol` (percent) is optional. Allowed values of the `ringtone_id` are:
- alarm ringtones [0-8]
- doorbell ring [10-13]
@ -148,4 +148,4 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
- Turn off the firewall on the HA computer
- Try to leave the mac address blank.
- Try to set `discovery_retry: 10`
- Try to disable and then renable LAN access
- Try to disable and then enable LAN access

View File

@ -12,7 +12,7 @@ ha_category: "Other"
ha_release: 0.18
---
The `zeroconf` component exposes your Home Assistant to the local network using [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking). Zeroconf is also sometimes known as Bonjour, Rendezvous and Avahi.
The `zeroconf` component exposes your Home Assistant to the local network using [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking). Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi.
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:

View File

@ -13,7 +13,7 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---
[ZigBee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilise modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local ZigBee device to be connected over a serial port. Through this it will send and receive commands to and from other devices on the ZigBee mesh network.
[ZigBee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local ZigBee device to be connected to a serial port. Through this it will send and receive commands to and from other devices on the ZigBee mesh network.
There is currently support for the following device types within Home Assistant:

View File

@ -40,18 +40,18 @@ zone 3:
Configuration variables:
- **name** (*Optional*): Friendly name of entry.
- **name** (*Optional*): Friendly name of the zone.
- **latitude** (*Required*): Latitude of the center point of the zone.
- **longitude** (*Required*): Longitude of the center point of the zone.
- **radius** (*Optional*): Optional radius in meters. Defaults to 100 meters.
- **icon** (*Optional*): Optional icon to show instead of name.
- **passive** (*Optional*): Optional boolean to only use the zone for automation and hide it from the UI and not use the zone for device tracker name. Defaults to false.
To find your latitude / longtitude of a certain place you can use for example [Google Maps](https://www.google.nl/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
To find your latitude/longitude of a certain place you can use for example [Google Maps](https://www.google.nl/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
#### {% linkable_title Home zone %}
If no configuration is given, the `zone` component will create a zone for home. This zone will use location given in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.
If no configuration is given, the `zone` component will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.
<p class='note'>
Devices that are in the zone **'Home'** will not appear on the map in the Home Assistant UI.
@ -63,4 +63,4 @@ It is preferred to pick an icon to use for your zone. Pick any icon that you can
#### State
`zoning` is the state a `zone` has when it is configured. A `zone` doesn't have another state, all configured zones are `zoning` all the time.
`zoning` is the state a `zone` has when it is configured. A `zone` doesn't have another state; all configured zones are `zoning` all the time.