✏️ Spelling, grammar, styling and fixes (#8173)

This commit is contained in:
Franck Nijhof 2019-01-15 13:37:57 +01:00 committed by Fabian Affolter
parent ab90d02dcf
commit c095eef8e5
12 changed files with 62 additions and 70 deletions

View File

@ -35,7 +35,7 @@ You may need to install platform-specific [dependencies for PyUserInput](https:/
pip3 install [package name]
```
#### {% linkable_title Windows %}
### {% linkable_title Windows %}
x64 Windows users may have trouble installing pywin through pip. Using an [executable installer](http://sourceforge.net/projects/pywin32/files/pywin32/) should work around this issue.

View File

@ -36,13 +36,14 @@ notify:
username: YOUR_ACCOUNT_ID
access_token: TOKEN
```
{% configuration %}
username:
username:
description: This is the id given by FreeMobile to access to your online account.
required: true
type: string
access_token:
description: You can get this token by activating the SMS API in your online account.
required: true
type: string
required: true
type: string
access_token:
description: You can get this token by activating the SMS API in your online account.
required: true
type: string
{% endconfiguration %}

View File

@ -68,7 +68,7 @@ queries:
## {% linkable_title Examples %}
In this section you find some real-life examples of how to use this sensor.
In this section, you find some real-life examples of how to use this sensor.
### {% linkable_title Current state of an entity %}
@ -81,7 +81,7 @@ sensor:
unit_of_measurement: '°C'
```
The query will look like this:
The query will look like this:
```sql
SELECT * FROM states WHERE entity_id = 'sensor.temperature_in' ORDER BY state_id DESC LIMIT 1;
@ -99,7 +99,6 @@ sensor:
```
{% endraw %}
Note that the SQL sensor state corresponds to the last row of the SQL result set.
### {% linkable_title Previous state of an entity %}
@ -123,7 +122,7 @@ sensor:
- name: DB size
query: "SELECT (pg_database_size('dsmrreader')/1024/1024) as db_size;"
column: "db_size"
unit_of_measurement: MB
unit_of_measurement: MB
```
{% endraw %}

View File

@ -55,7 +55,7 @@ sensor:
required: false
type: string, list
unit_of_measurement:
description: "Defines the units of measurement of the sensor, if any. This will also influence the graphical presentation in the history visualisation as continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values."
description: "Defines the units of measurement of the sensor, if any. This will also influence the graphical presentation in the history visualization as a continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values."
required: false
type: string
default: None
@ -80,18 +80,19 @@ sensor:
## {% linkable_title Considerations %}
### Startup
### {% linkable_title Startup %}
If you are using the state of a platform that takes extra time to load, the Template Sensor may get an `unknown` state during startup. To avoid this (and the resulting error messages in your log file), you can use `is_state()` function in your template. For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an `unknown` result:
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
### Entity IDs
### {% linkable_title Entity IDs %}
The template engine will attempt to work out what entities should trigger an update of the sensor. This can fail, for example if your template loops over the contents of a group. In this case you can use `entity_id` to provide a list of entity IDs that will cause the sensor to update or you can run the service `homeassistant.update_entity` to update the sensor at will.
The template engine will attempt to work out what entities should trigger an update of the sensor. This can fail, for example, if your template loops over the contents of a group. In this case, you can use `entity_id` to provide a list of entity IDs that will cause the sensor to update or you can run the service `homeassistant.update_entity` to update the sensor at will.
## {% linkable_title Examples %}
In this section you find some real-life examples of how to use this sensor.
In this section, you find some real-life examples of how to use this sensor.
### {% linkable_title Sun Angle %}
@ -111,7 +112,7 @@ sensor:
### {% linkable_title Renaming Sensor Output %}
If you don't like the wording of a sensor output then the Template Sensor can help too. Let's rename the output of the [Sun component](/components/sun/) as
If you don't like the wording of a sensor output, then the Template Sensor can help too. Let's rename the output of the [Sun component](/components/sun/) as
a simple example:
{% raw %}
@ -156,7 +157,7 @@ sensor:
### {% linkable_title Change The Unit of Measurement %}
With a Template Sensor it's easy to convert given values into others if the unit of measurement doesn't fit your needs.
With a Template Sensor, it's easy to convert given values into others if the unit of measurement doesn't fit your needs.
{% raw %}
```yaml
@ -267,7 +268,7 @@ sensor:
```
{% endraw %}
Useful entities to choose might be `sensor.date` which update once per day, or `sensor.time` which updates once per minute.
Useful entities to choose might be `sensor.date` which update once per day or `sensor.time` which updates once per minute.
An alternative to this is to create an interval-based automation that calls the service `homeassistant.update_entity` for the entities requiring updates. This modified example updates every 5 minutes:

View File

@ -1,7 +1,7 @@
---
layout: page
title: "Wink"
description: "Instructions on how to setup the Wink hub within Home Assistant."
description: "Instructions on how to set up the Wink hub within Home Assistant."
date: 2015-01-20 22:36
sidebar: true
comments: false
@ -24,17 +24,17 @@ Home Assistant integrates with the Wink API and automatically sets up any switch
Check the related components pages for actual devices that are supported.
### {% linkable_title Authenticate using [developer.wink.com](https://developer.wink.com) %}
## {% linkable_title Authenticate using [developer.wink.com](https://developer.wink.com) %}
You need to setup a developer account with Wink. This process can take a few days to get approved.
You need to set up a developer account with Wink. This process can take a few days to get approved.
Wink requests three pieces of information from the user when they sign up for a developer account.
1. `Name:` This can be anything, for example "Home Assistant"
1. `Name:` This can be anything, for example, "Home Assistant"
2. `Website:` The external address of your Home Assistant instance. If not externally accessible you can use your email address.
3. `Redirect URI:` This should be "http://192.168.1.5:8123/auth/wink/callback" replacing the IP with the internal IP of your Home Assistant box.
3. `Redirect URI:` This should be `http://192.168.1.5:8123/auth/wink/callback` replacing the IP with the internal IP of your Home Assistant box.
No settings are required in the configuration.yaml other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
No settings are required in the `configuration.yaml` other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
<p class='note'>
When using the configurator make sure the initial setup is performed on the same local network as the Home Assistant server, if not from the same box Home Assistant is running on. This will allow for authentication redirects to happen correctly.
@ -44,7 +44,7 @@ When using the configurator make sure the initial setup is performed on the same
wink:
```
### {% linkable_title Full oauth authentication (legacy) %}
## {% linkable_title Full oauth authentication (legacy) %}
This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existence.
@ -87,7 +87,7 @@ 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`.
- 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 start-up of Home Assistant; this means initial setup requires an active internet connection.
- Local control isn't used during the start-up of Home Assistant; this means initial setup requires an active internet connection.
- Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online.
<p class='note'>
@ -95,23 +95,23 @@ It is possible for the hub to get into a bad state where it stops accepting loca
The following error will be logged if the hub is rejecting local requests.
```
```txt
Error sending local control request. Sending request online
```
</p>
### {% linkable_title Service `refresh_state_from_wink` %}
## {% 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 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.
### {% linkable_title Service `pull_newly_added_devices_from_wink` %}
## {% linkable_title Service `pull_newly_added_devices_from_wink` %}
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.
### {% linkable_title Service `delete_wink_device` %}
## {% linkable_title Service `delete_wink_device` %}
You can use the service wink/delete_wink_device to remove/unpair a device from Wink.
@ -119,7 +119,7 @@ You can use the service wink/delete_wink_device to remove/unpair a device from W
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String that points at the `entity_id` of device to delete.
### {% linkable_title Service `pair_new_device` %}
## {% linkable_title Service `pair_new_device` %}
You can use the service wink/pair_new_device to pair a new device to your Wink hub/relay
@ -133,7 +133,7 @@ You can use the service wink/pair_new_device to pair a new device to your Wink h
Calling service wink/pull_newly_added_wink_devices after a device is paired will add that new device to Home Assistant. The device will also show up on the next restart of Home Assistant.
</p>
### {% linkable_title Service `rename_wink_device` %}
## {% linkable_title Service `rename_wink_device` %}
You can use the service wink/rename_wink_device to change the name of a device.
@ -150,17 +150,15 @@ Home Assistant entity_ids for Wink devices are based on the Wink device's name.
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>
### Custom Wink devices and their services
## {% linkable_title Custom Wink devices and their services %}
- GoControl siren and strobe
- Dome siren/chime/strobe
- Quirky Nimbus (Legacy device) These can no longer be officially added to your Wink account
### {% linkable_title Service `set_siren_auto_shutoff` %}
You can use the service wink/set_siren_auto_shutoff to set how long the siren will sound before shuting off.
You can use the service wink/set_siren_auto_shutoff to set how long the siren will sound before shutting off.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
@ -189,7 +187,7 @@ You can use the service wink/set_chime_volume to set the volume for the chime on
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `volume` | no | String. One of ["low", "medium", "high"]
| `entity_id` | yes | String or list of strings that point at `entity_id`s of siren/chime.
| `entity_id` | yes | String or list of strings that point at `entity_id`s of the siren/chime.
Example:

View File

@ -12,16 +12,14 @@ ha_category: Calendar
ha_release: 0.84
---
The `wunderlist` component allows you to create tasks in [Wunderlist](https://www.wunderlist.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that
you should not forget, e.g., Congratulate Dani.
The `wunderlist` component allows you to create tasks in [Wunderlist](https://www.wunderlist.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., Congratulate Dani.
## {% linkable_title Setup %}
Wunderlist API uses OAuth2, so you need to obtain a `client_id` and an `access_token`.
Wunderlist API uses OAuth2, so you need to obtain a `client_id` and an `access_token`.
There are two ways:
1. Go to the [Wunderlist IOT app page](https://wunderlist-iot.herokuapp.com), login with your Wunderlist account and accept the application permissions.
1. Go to the [Wunderlist IOT app page](https://wunderlist-iot.herokuapp.com), log in with your Wunderlist account and accept the application permissions.
It will print for you the `client_id` and the `access_token`.
2. Or you can create your own application and `access_token` following the instructions at the [Wunderlist developer page](https://developer.wunderlist.com/).
@ -29,20 +27,16 @@ Store the parameters in your Home Assistant configuration:
```yaml
# Example configuration.yaml entry
wunderlist:
client_id: YOUR_CLIENT_ID
access_token: YOUR_ACCESS_TOKEN
```
{% configuration %}
client_id:
description: The ID of your Wunderlist application (OAuth2).
required: true
type: string
access_token:
description: A token for your Wunderlist personal account (For the ``client_id`` application).
required: true
@ -51,15 +45,15 @@ access_token:
## {% linkable_title Creating tasks with service `create_task`%}
This component offers a new service domain `wunderlist` with the service `create_task`.
You can call this service with the argument `list_name` the argument `name` and the optional parameter `starred` to create a new task.
This component offers a new service domain `wunderlist` with the service `create_task`.
You can call this service with the argument `list_name` the argument `name` and the optional parameter `starred` to create a new task.
|Service data attribute | Optional | Description | Example |
|-----------------------|----------|-------------|---------|
| Service data attribute | Optional | Description | Example |
|------------------------|----------|-------------|---------|
| list_name | no | Name of the list | "Shopping list"
| name | no | Name of the new task | "Spanish Jam" |
| starred | yes | Create the task starred or not | false |
## {% linkable_title Disclaimer %}
This product uses the Wunderlist API but is not endorsed or certified by Wunderlist.

View File

@ -16,7 +16,7 @@ redirect_from: /components/xiaomi/
The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/en/) Aqara-compatible devices into Home Assistant.
#### {% linkable_title Supported Devices %}
## {% linkable_title Supported Devices %}
- Aqara Air Conditioning Companion (lumi.acpartner.v3)
- Aqara Intelligent Door Lock (lock.aq1)
@ -35,7 +35,7 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/
- Gateway (Light, Illumination Sensor, Ringtone play)
- Intelligent Curtain
- Motion Sensor (1st and 2nd generation)
- Plug aka Socket (Zigbee version, reports power consumed, power load, statem and if device in use)
- Plug aka Socket (Zigbee version, reports power consumed, power load, state and if the device is in use)
- Smoke Detector (reports alarm and density)
- Temperature and Humidity Sensor (1st and 2nd generation)
- Vibration Sensor
@ -43,7 +43,7 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/
- Water Leak Sensor
- Xiaomi Mijia Gateway (lumi.gateway.v2, lumi.gateway.v3)
#### {% linkable_title Unsupported Devices %}
## {% linkable_title Unsupported Devices %}
- Xiaomi Aqara Gateway (lumi.gateway.aqhm01), as it is not possible to activate dev mode in the Mi Home App.
- Gateway Radio
@ -250,7 +250,6 @@ This example toggles the living room lamp on a double click of the button.
entity_id: light.living_room_lamp
```
## {% linkable_title Troubleshooting %}
### {% linkable_title Initial setup problem %}
@ -265,6 +264,7 @@ If you run into trouble initializing the gateway with your app, try another smar
```
That means that Home Assistant is not getting any response from your Xiaomi gateway. Might be a local network problem or your firewall.
- Make sure you have [enabled LAN access](https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz).
- Turn off the firewall on the system where Home Assistant is running.
- Ensure your router supports multicast as this is a requirement of the Xiaomi Gateway.
@ -274,6 +274,6 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
- Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch.
- If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`.
- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light
- You should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application.
- You should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances, there is an issue with keys being generated using the iOS application.
- You need to make sure to have multicast support on your network. If you are running Home Assistant in a virtual machine (like Proxmox), try `echo 0 >/sys/class/net/vmbr0/bridge/multicast_snooping` on the host and restart the service or reboot the host.
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`).

View File

@ -41,6 +41,6 @@ Browsing domain 'local' on -1.-1 ...
Browsing for services of type '_home-assistant._tcp' in domain 'local' on 4.0 ...
Found service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0.
Service data for service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0:
Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data:
Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data:
['requires_api_password=true', 'base_url=http://192.168.0.70:8123', 'version=0.41.0']
```

View File

@ -14,7 +14,7 @@ ha_iot_class: "Local Polling"
---
[Zigbee Home Automation](http://www.zigbee.org/zigbee-for-developers/applicationstandards/zigbeehomeautomation/)
integration for Home Assistant allows you to connect many off-the-shelf Zigbee based devices to Home Assistant, using one of the available Zigbee radio modules compatible with [zigpy](https://github.com/zigpy/zigpy) (an open source Python library implementing a Zigbee stack, which in turn relies on seperate libraries which can each interface a with Zigbee radio module a different manufacturer).
integration for Home Assistant allows you to connect many off-the-shelf Zigbee based devices to Home Assistant, using one of the available Zigbee radio modules compatible with [zigpy](https://github.com/zigpy/zigpy) (an open source Python library implementing a Zigbee stack, which in turn relies on separate libraries which can each interface a with Zigbee radio module a different manufacturer).
There is currently support for the following device types within Home Assistant:
@ -71,8 +71,6 @@ enable_quirks:
default: true
{% endconfiguration %}
To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset.
To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset.
In case you want to add Philips Hue bulbs that have previously been added to another bridge, have a look at: [https://github.com/vanviegen/hue-thief/](https://github.com/vanviegen/hue-thief/)

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 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.
[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:
@ -49,7 +49,7 @@ baud:
To find the possible serial port names of your device, run:
```bash
$ ls /dev/ttyUSB*
ls /dev/ttyUSB*
```
<p class='note'>

View File

@ -1,7 +1,7 @@
---
layout: page
title: "Zone"
description: "Instructions on how to setup zones within Home Assistant."
description: "Instructions on how to set up zones within Home Assistant."
date: 2015-10-04 09:23
sidebar: true
comments: false
@ -68,7 +68,7 @@ passive:
To find the latitude/longitude of a certain place you can use [Google Maps](https://www.google.com/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 %}
## {% linkable_title Home zone %}
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'**.
@ -76,10 +76,10 @@ If no configuration is given, the `zone` component will create a zone for home.
Devices that are in the zone **'Home'** will not appear on the map in the Home Assistant UI.
</p>
#### {% linkable_title Icons %}
## {% linkable_title Icons %}
It is preferred to pick an icon to use for your zone. Pick any icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) and prefix the name with `mdi:`. For example `mdi:school`, `mdi:worker`, `mdi:home`, `mdi:cart`, or `mdi:castle`.
#### State
## {% linkable_title 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.

View File

@ -82,6 +82,7 @@ Once loaded, the `zoneminder` platform will expose a service (`set_run_state`) t
| `name` | no | Name of the new run state to set. |
For example, if your ZoneMinder instance was configured with a run state called "Home", you could write an [automation](/getting-started/automation/) that changes ZoneMinder to the "Home" run state by including the following [action](/getting-started/automation-action/):
```yaml
action:
service: zoneminder.set_run_state