📝Spelling, grammar, styling and fixes (#8571)

* ✏️ Spelling, grammar, styling and fixes

* 🚑 Fixes build error
This commit is contained in:
Franck Nijhof 2019-02-14 13:07:59 +01:00 committed by Fabian Affolter
parent 7e0d3ab4ab
commit 98ea438d47
40 changed files with 61 additions and 89 deletions

View File

@ -13,7 +13,6 @@ ha_release: 0.31
ha_iot_class: "Cloud Polling"
---
The `scrape` sensor platform is scraping information from websites. The sensor loads a HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section.
To enable this sensor, add the following lines to your `configuration.yaml` file:

View File

@ -18,13 +18,13 @@ The `season` sensor will display the current astronomical or meteorological seas
For information on the difference between astronomical and meteorological seasons please see the link below:
- [https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons](https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons)
- [https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons](https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons)
All information about how the seasons work was taken from Wikipedia:
- [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical)
- [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox)
- [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice)
- [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical)
- [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox)
- [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice)
## {% linkable_title Configuration %}
@ -44,4 +44,3 @@ type:
type: string
default: astronomical
{% endconfiguration %}

View File

@ -53,7 +53,7 @@ is_hat_attached:
type: boolean
{% endconfiguration %}
#### {% linkable_title Customizing the Sense HAT data %}
## {% linkable_title Customizing the Sense HAT data %}
**Format the sensor values**
Add the following to your `sensor`:
@ -124,11 +124,11 @@ group:
- group.sense_hat
```
### {% linkable_title Directions for installing on Raspberry Pi All-In-One installer and HASSbian: %}
## {% linkable_title Directions for installing on Raspberry Pi All-In-One installer and HASSbian: %}
Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual environment versions.
#### {% linkable_title Install SenseHAT package to _homeassistant_venv_ %}
### {% linkable_title Install SenseHAT package to _homeassistant_venv_ %}
```bash
# switch to the homeassistant_venv environment
@ -140,13 +140,13 @@ pip3 install sense-hat
# be patient, this will take a long while
```
#### {% linkable_title Return to `pi` %}
### {% linkable_title Return to `pi` %}
Type `exit` to quit out of the _homeassistant_venv_ back to your `pi` environment.
As all of the following steps should be under the `pi` user environment.
#### {% linkable_title Install _RTIMU_ %}
### {% linkable_title Install _RTIMU_ %}
```bash
# pi user environment: Install RTIMU
@ -166,7 +166,7 @@ sudo reboot
Unfortunately enabling the SenseHAT Sensor component for a Virtual Environment install of Home Assistant fails with errors.
_(The Raspberry Pi All-In-One installer and HASSbian both run Home Assistant in an virtual environment)._
These issues have been discussed in the repository issue (#5093)[https://github.com/home-assistant/home-assistant/issues/5093)
These issues have been discussed in the repository issue [#5093](https://github.com/home-assistant/home-assistant/issues/5093)
This fix has been tested with a clean install of:

View File

@ -15,12 +15,14 @@ ha_iot_class: "Local Polling"
The `serial` sensor platform is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](http://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system.
To check what kind of data is arriving at your serial port, use a command-line tool like `minicom` or `picocom` on Linux, on a macOS you can use `screen` or on Windows `putty`.
To check what kind of data is arriving at your serial port, use a command-line tool like `minicom` or `picocom` on Linux, on a macOS you can use `screen` or on Windows `putty`.
```bash
$ sudo minicom -D /dev/ttyACM0
sudo minicom -D /dev/ttyACM0
```
## {% linkable_title Configuration %}
To setup a serial sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -47,10 +49,9 @@ baudrate:
value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the serial line."
required: false
type: template
type: template
{% endconfiguration %}
## {% linkable_title `value_template` for Template sensor %}
### {% linkable_title TMP36 %}
@ -67,7 +68,7 @@ value_template:
For controllers of the Arduino family a possible sketch to read the temperature and the humidity could look like the sample below.
```
```c
#include <ArduinoJson.h>
void setup() {

View File

@ -65,4 +65,3 @@ sensor:
name: Nova
brand: novafitness,sds011
```

View File

@ -13,7 +13,6 @@ logo: shodan.png
ha_release: 0.51
---
The `shodan` sensor platform is displaying the total of result of a
[Shodan](https://www.shodan.io/) query.
@ -45,4 +44,3 @@ sensor:
required: false
type: string
{% endconfiguration %}

View File

@ -47,7 +47,7 @@ sensor:
default: All conditions
type: list
keys:
temperature:
temperature:
description: The current temperature of the SHT31.
humidity:
description: The current humidity of the SHT31.

View File

@ -51,4 +51,3 @@ name:
default: "sigfox"
type: string
{% endconfiguration %}

View File

@ -48,4 +48,3 @@ monitored_conditions:
humidity:
description: Humidity at the sensor's location.
{% endconfiguration %}

View File

@ -71,12 +71,12 @@ sensors:
description: Total power yield from solar installation (kWh).
daily_yield:
description: The yield for today (Wh)
current_consumption:
description: Power that you are currently drawing, depending on your installation it can be a combination of the inverter and the grid (W).
total_consumption:
description: Total power consumption (kWh).
grid_power_supplied:
description: Power supplied (W)
grid_power_absorbed:
@ -84,8 +84,8 @@ sensors:
grid_total_yield:
description: Total power fom the grid (kWh)
grid_total_absorbed:
description: Total power supplied to the grid
description: Total power supplied to the grid
grid_power:
description: Power supplied by the grid (W)
frequency:
@ -96,10 +96,10 @@ sensors:
description: Voltage for phase 2 (V)
voltage_l2:
description: Voltage for phase 3 (V)
status:
description: Status of the solar plant.
your-custom-sensor:
description: Any sensor name defined in the `custom:` section
custom:

View File

@ -13,7 +13,6 @@ ha_release: 0.61
ha_iot_class: "Cloud Polling"
---
The `SoChain` sensor platform displays supported cryptocurrency wallet balances from [SoChain](https://chain.so).
To add the SoChain sensor to your installation, specify a network and address to watch in the `configuration.yaml` file:

View File

@ -13,11 +13,11 @@ ha_release: 0.69
ha_iot_class: "Cloud Polling"
---
The `socialblade` sensor platform allows you get updates on a Youtube channel using your social blade channel ID. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/).
The `socialblade` sensor platform allows you get updates on a Youtube channel using your social blade channel ID. The sensor gets the subscribers and total views count from [Social Blade Website](https://socialblade.com).
## {% linkable_title Setup %}
To get the channel ID you can go to [Social Blade Website]( https://socialblade.com/) and search for Youtube channel by username, then select the channel and grab the ID from the URL. The channel ID will be the last part of the URL: https://socialblade.com/youtube/channel/{channel_id}
To get the channel ID you can go to [Social Blade Website](https://socialblade.com) and search for Youtube channel by username, then select the channel and grab the ID from the URL. The channel ID will be the last part of the URL: `https://socialblade.com/youtube/channel/{channel_id}`
## {% linkable_title Configuration %}
@ -32,9 +32,9 @@ sensor:
{% configuration %}
channel_id:
description: Channel id number optained from the URL when you access Social Blade web client.
description: Channel id number optained from the URL when you access Social Blade web client.
required: true
type: string
{% endconfiguration %}
All the data will be fetch from [Social Blade]( https://socialblade.com/).
All the data will be fetch from [Social Blade]( https://socialblade.com/).

View File

@ -13,7 +13,6 @@ ha_release: 0.34
ha_iot_class: "Local Polling"
---
This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance.
## {% linkable_title Configuration %}

View File

@ -27,11 +27,12 @@ You can find more information about Starling Bank at [their website](https://www
Once you have your own Starling bank account you will need to sign up for a Starling developer account [here](https://developer.starlingbank.com/signup). You won't need to do any development but you will need to get a "Personal Access Token" that will allow the integration to access your account balance.
<p class='note info'>
You control what access is granted using this token. This integration only needs very basic access (see below).
You control what access is granted using this token. This integration only needs very basic access (see below).
</p>
Once you've signed up:
1. Head to the [Personal Access Section](https://developer.starlingbank.com/personal/token) of your developer account.
Once you've signed up:
1. Head to the [Personal Access Section](https://developer.starlingbank.com/personal/token) of your developer account.
2. Click "Create Token".
3. Give your token a name e.g., "Home Assistant".
4. Tick the permissions "account:read" and "balance:read". The others you can leave un-ticked.

View File

@ -83,4 +83,3 @@ monitored_conditions:
used_remaining:
description: Remaining bandwidth calucated from used and supplied total bandwidth (gigabytes).
{% endconfiguration %}

View File

@ -14,11 +14,10 @@ ha_release: "0.30"
ha_qa_scale: internal
---
The `statistics` sensor platform consumes the state from other sensors. It exports the `mean` value as state and the following values as attributes: `count`, `mean`, `median`, `stdev`, `variance`, `total`, `min`, `max`, `min_age`, `max_age`, `change`, `average_change` and `change_rate`. If it's a binary sensor then only state changes are counted.
If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` component on startup.
If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation.
If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation.
## {% linkable_title Configuration %}

View File

@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.14
---
The `steam` sensor platform will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts.
## {% linkable_title Setup %}

View File

@ -28,7 +28,6 @@ After a restart of `supervisord` you should be able to access the web interface.
<img src='{{site_root}}/images/screenshots/supervisor.png' />
</p>
To use this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -41,6 +40,6 @@ sensor:
url:
description: The URL to track.
required: false
default: "http://localhost:9001/RPC2"
default: "`http://localhost:9001/RPC2`"
type: string
{% endconfiguration %}

View File

@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: pre 0.7
---
The `swiss_public_transport` sensor will give you the next three departure times from a given location to another one in Switzerland.
The [Swiss public transport API](http://transport.opendata.ch/) only allows 1000 requests per 24 hours.
@ -40,10 +39,10 @@ to:
required: true
type: string
name:
description: The name of the sensor.
description: The name of the sensor.
required: false
type: string
default: Next Departure
{% endconfiguration %}
{% endconfiguration %}
The public timetables are coming from [Swiss public transport](http://transport.opendata.ch).

View File

@ -13,7 +13,6 @@ ha_release: 0.32
ha_iot_class: "Local Polling"
---
The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com).
## {% linkable_title Configuration %}

View File

@ -77,7 +77,7 @@ To retrieve all available network interfaces on a Linux System, execute the
`ifconfig` command.
```bash
$ ifconfig -a | sed 's/[ \t].*//;/^$/d'
ifconfig -a | sed 's/[ \t].*//;/^$/d'
```
## {% linkable_title Windows specific %}

View File

@ -55,4 +55,3 @@ unit_of_measurement:
required: true
type: map
{% endconfiguration %}

View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
The TCP component allows the integration of some services for which a specific Home Assistant component does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this component will allow integration with it.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
@ -67,7 +69,7 @@ sensor:
### {% linkable_title hddtemp %}
The tool `hddtemp` collects the temperature of your hard disks.
The tool `hddtemp` collects the temperature of your hard disks.
```bash
$ hddtemp

View File

@ -24,7 +24,6 @@ sensor:
host: 192.168.1.100
```
{% configuration %}
host:
description: The IP address of your ted gateway.
@ -48,4 +47,3 @@ For each plugged MTU, using an index starting at 1, the platform creates 2 senso
sensor.<name>_mtu<MTU id>_power
sensor.<name>_mtu<MTU id>_voltage
```

View File

@ -75,4 +75,3 @@ monitored_conditions:
onpeak_remaining:
description: Remaining bandwidth (gigabytes).
{% endconfiguration %}

View File

@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling"
The `thermoworks_smoke` sensor platform pulls data for your [ThermoWorks Smoke Thermometer](https://www.thermoworks.com/Smoke).
This requires a [Smoke WiFi Gateway](https://www.thermoworks.com/Smoke-Gateway) with an internet connection.
You will need to have previously registered your smoke to your account via the mobile app and provide
You will need to have previously registered your smoke to your account via the mobile app and provide
the email and password you used to in the configuration for this sensor in order to connect and pull your data.
## {% linkable_title Configuration %}
@ -109,7 +109,7 @@ input_number:
step: 0.5
unit_of_measurement: '°F'
icon: mdi:thermometer
automation:
- alias: Alert when My Smoke Probe 1 is above threshold
trigger:

View File

@ -42,7 +42,7 @@ Click **Add integration** to finish the process.
Add a The Things Network Data Storage integration
</p>
When done, the status of the integration should be **Running**. You could check the output after clicking on **go to platform** in an interactive web interface.
When done, the status of the integration should be **Running**. You could check the output after clicking on **go to platform** in an interactive web interface.
<p class='img'>
<img src='/images/components/thethingsnetwork/storage_integration.png' />
@ -80,4 +80,3 @@ sensor:
required: true
type: list
{% endconfiguration %}

View File

@ -14,7 +14,6 @@ ha_release: pre 0.7
ha_qa_scale: internal
---
The time and date (`time_date`) sensor platform simple displays the time in various formats, the date, or both.
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
@ -37,4 +36,3 @@ sensor:
<p class='img'>
<img src='{{site_root}}/images/screenshots/time_date.png' />
</p>

View File

@ -13,15 +13,15 @@ ha_release: 0.66.0
ha_iot_class: "Cloud Polling"
---
Showing weather information provided by [Trafikverket](https://www.trafikverket.se/) weather stations in Sweden.
Showing weather information provided by [Trafikverket](https://www.trafikverket.se/) weather stations in Sweden.
Potential use cases:
- Get weather data in general.
- You live near a weather station and want to know the current weather conditions at home.
- Setup automations for your car heating system. If the road is frozen along the way to work, you might want the car heating system to start earlier.
##### {% linkable_title Configuration %}
- Get weather data in general.
- You live near a weather station and want to know the current weather conditions at home.
- Setup automations for your car heating system. If the road is frozen along the way to work, you might want the car heating system to start earlier.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`.
@ -54,7 +54,7 @@ station:
description: Name of the weather station from Trafikverket.
required: true
type: string
monitored_conditions:
monitored_conditions:
description: Specify what measurement data to retrieve from the weather station.
required: true
type: map
@ -72,14 +72,14 @@ monitored_conditions:
wind_direction_text:
description: Rough wind direction in twelve variants (Swedish text).
wind_speed:
description: Average wind speed during the last 10 minutes.
description: Average wind speed during the last 10 minutes.
{% endconfiguration %}
##### {% linkable_title Obtaining API key %}
## {% linkable_title Obtaining API key %}
Please click [here](https://api.trafikinfo.trafikverket.se/) and register to obtain the API key.
##### {% linkable_title Weather stations %}
## {% linkable_title Weather stations %}
Click [here](https://www.trafikverket.se/trafikinformation/vag/?TrafficType=personalTraffic&map=1/606442.17/6886316.22/&Layers=RoadWeather%2b) to get a map of valid weather stations. Once a station is found, copy the name according to the below picture and paste it in your `configuration.yaml` file as the `station` variable.
@ -87,7 +87,7 @@ Click [here](https://www.trafikverket.se/trafikinformation/vag/?TrafficType=pers
<img src='{{site_root}}/images/screenshots/get_trafikverket_weather_station_example.png' />
</p>
##### {% linkable_title Examples %}
## {% linkable_title Examples %}
```yaml
sensor:

View File

@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.81
---
The `transport_nsw` sensor will give you the time until the next departure from a Transport NSW stop for bus, train, light rail or ferry.
## {% linkable_title Setup %}
@ -63,7 +62,7 @@ The public information is provided from [Transport NSW](https://opendata.transpo
## {% linkable_title Examples %}
More example configurations for bus or ferry.
More example configurations for bus or ferry.
```yaml
# Example bus route configuration.yaml entry

View File

@ -13,7 +13,6 @@ ha_release: "0.10"
ha_iot_class: "Cloud Polling"
---
The `twitch` platform will allow you to monitor [Twitch](http://www.twitch.tv/) channel status from within Home Assistant and setup automation based on the information.
## {% linkable_title Setup %}
@ -47,4 +46,3 @@ channels:
channel_id:
description: Name of the channel.
{% endconfiguration %}

View File

@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.16
---
The `uber` sensor will give you time and price estimates for all available [Uber](https://uber.com) products at the given location. The `ATTRIBUTES` are used to provide extra information about products, such as estimated trip duration, distance and vehicle capacity. By default, 2 sensors will be created for each product at the given `start` location, one for pickup time and one for current price. The sensor is powered by the official Uber [API](https://developer.uber.com/).
## {% linkable_title Setup %}

View File

@ -14,7 +14,6 @@ ha_release: 0.56
ha_qa_scale: internal
---
The `uptime` sensor platform displays the time since the last Home Assistant restart.
## {% linkable_title Configuration %}

View File

@ -60,7 +60,7 @@ result through various platforms.
Remember that you can easily get the installed version on the command line.
```bash
$ hass --version
hass --version
```
Or go to the <img src='/images/screenshots/developer-tool-about-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Info** section of the **Developer Tools**.

View File

@ -15,10 +15,10 @@ ha_release: 0.58
The `viaggiatreno` sensor will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API.
To activate the sensor you need at least two parameters: the `train_id` and the `station_id`.
To activate the sensor you need at least two parameters: the `train_id` and the `station_id`.
The first is available just looking at the [ViaggiaTreno](http://viaggiatreno.it/) timetable, the latter can be obtained using the dedicated API endpoint:
`http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/<Station name>`
`http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/<Station name>`
(e.g., `http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/ROMA` will list all station names (with ids) that starts with *ROMA*).
<p class='note'>

View File

@ -76,4 +76,3 @@ sensor:
- min
- max
```

View File

@ -13,7 +13,6 @@ ha_category: System Monitor
ha_iot_class: "Cloud Polling"
---
The `vultr` sensor platform will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription.
To use this sensor, you must set up your [Vultr hub](/components/vultr/).
@ -73,4 +72,3 @@ sensor:
monitored_conditions:
- current_bandwidth_used
```

View File

@ -62,10 +62,9 @@ realtime:
type: boolean
{% endconfiguration %}
## {% linkable_title Example using dynamic destination %}
Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze component that will calculate travel time to multiple optional locations on demand.
Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze component that will calculate travel time to multiple optional locations on demand.
In the following example, the `Input Select` is converted into an address which is used to modify the destination for Waze route calculation from `device_tracker.myphone` location (It takes a few minutes for the value to update due to the interval set to fetch Waze data).
@ -78,7 +77,7 @@ input_select:
- Home
- Work
- Parents
sensor:
- platform: template
sensors:
@ -93,7 +92,7 @@ sensor:
{%- else -%}
Unknown
{%- endif %}
- platform: waze_travel_time
name: "Me to destination"
origin: device_tracker.myphone

View File

@ -13,7 +13,6 @@ ha_release: "0.57"
ha_iot_class: "Cloud Polling"
---
The `whois` sensor platform allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details.
## {% linkable_title Configuration %}
@ -38,4 +37,3 @@ sensor:
default: Whois
type: string
{% endconfiguration %}

View File

@ -93,6 +93,7 @@ Polling Tado API for presence information will happen at most once every 30 seco
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status.
### {% linkable_title Finding your `home_id` %}
Find your `home_id` by browsing to `https://my.tado.com/api/v2/me?username=YOUR_USERNAME&password=YOUR_PASSWORD`. There you'll see something like the following:
```json