Skip to content

Commit

Permalink
Review/Edit components starting with the letter U-Z (home-assistant#3229
Browse files Browse the repository at this point in the history
)
  • Loading branch information
frenck authored and fabaff committed Aug 24, 2017
1 parent ef83caf commit a24e142
Show file tree
Hide file tree
Showing 18 changed files with 55 additions and 55 deletions.
4 changes: 2 additions & 2 deletions source/_components/updater.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion source/_components/vacuum.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|---------------------------|----------|-------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion source/_components/vacuum.roomba.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
14 changes: 7 additions & 7 deletions source/_components/vacuum.xiaomi.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
Expand Down Expand Up @@ -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 |
|---------------------------|----------|-------------------------------------------------------|
Expand Down
6 changes: 3 additions & 3 deletions source/_components/vera.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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.
2 changes: 1 addition & 1 deletion source/_components/volvooncall.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion source/_components/wake_on_lan.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
14 changes: 7 additions & 7 deletions source/_components/weather.buienradar.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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.
4 changes: 2 additions & 2 deletions source/_components/weather.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.


2 changes: 1 addition & 1 deletion source/_components/weather.metoffice.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/weather.openweathermap.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
4 changes: 2 additions & 2 deletions source/_components/weather.yweather.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
8 changes: 4 additions & 4 deletions source/_components/wemo.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Loading

0 comments on commit a24e142

Please sign in to comment.