From 98ea438d47abc4d3f2150dd70bbc9cd0aebcf0e0 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 14 Feb 2019 13:07:59 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9DSpelling,=20grammar,=20styling=20an?= =?UTF-8?q?d=20fixes=20(#8571)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * :pencil2: Spelling, grammar, styling and fixes * :ambulance: Fixes build error --- source/_components/sensor.scrape.markdown | 1 - source/_components/sensor.season.markdown | 9 ++++---- source/_components/sensor.sensehat.markdown | 12 +++++----- source/_components/sensor.serial.markdown | 11 +++++----- source/_components/sensor.serial_pm.markdown | 1 - source/_components/sensor.shodan.markdown | 2 -- source/_components/sensor.sht31.markdown | 2 +- source/_components/sensor.sigfox.markdown | 1 - source/_components/sensor.skybeacon.markdown | 1 - source/_components/sensor.sma.markdown | 12 +++++----- source/_components/sensor.sochain.markdown | 1 - .../_components/sensor.socialblade.markdown | 8 +++---- source/_components/sensor.sonarr.markdown | 1 - .../_components/sensor.starlingbank.markdown | 7 +++--- source/_components/sensor.startca.markdown | 1 - source/_components/sensor.statistics.markdown | 3 +-- .../_components/sensor.steam_online.markdown | 1 - .../_components/sensor.supervisord.markdown | 3 +-- .../sensor.swiss_public_transport.markdown | 5 ++--- .../_components/sensor.synologydsm.markdown | 1 - .../_components/sensor.systemmonitor.markdown | 2 +- .../_components/sensor.tank_utility.markdown | 1 - source/_components/sensor.tcp.markdown | 4 +++- source/_components/sensor.ted5000.markdown | 2 -- source/_components/sensor.teksavvy.markdown | 1 - .../sensor.thermoworks_smoke.markdown | 4 ++-- .../sensor.thethingsnetwork.markdown | 3 +-- source/_components/sensor.time_date.markdown | 2 -- ...ensor.trafikverket_weatherstation.markdown | 22 +++++++++---------- .../_components/sensor.transport_nsw.markdown | 3 +-- source/_components/sensor.twitch.markdown | 2 -- source/_components/sensor.uber.markdown | 1 - source/_components/sensor.uptime.markdown | 1 - source/_components/sensor.version.markdown | 2 +- .../_components/sensor.viaggiatreno.markdown | 4 ++-- .../_components/sensor.volkszaehler.markdown | 1 - source/_components/sensor.vultr.markdown | 2 -- .../sensor.waze_travel_time.markdown | 7 +++--- source/_components/sensor.whois.markdown | 2 -- source/_components/tado.markdown | 1 + 40 files changed, 61 insertions(+), 89 deletions(-) diff --git a/source/_components/sensor.scrape.markdown b/source/_components/sensor.scrape.markdown index 86ebfe26ce2..82241743ae0 100644 --- a/source/_components/sensor.scrape.markdown +++ b/source/_components/sensor.scrape.markdown @@ -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: diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index e12c1c401f2..e6000b37eb8 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -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 %} - diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index 608f749db35..f2440de1c71 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -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: diff --git a/source/_components/sensor.serial.markdown b/source/_components/sensor.serial.markdown index 4954fb15fc6..5386914e1da 100644 --- a/source/_components/sensor.serial.markdown +++ b/source/_components/sensor.serial.markdown @@ -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 void setup() { diff --git a/source/_components/sensor.serial_pm.markdown b/source/_components/sensor.serial_pm.markdown index 5d579cc9a9b..0d93a15cd0b 100644 --- a/source/_components/sensor.serial_pm.markdown +++ b/source/_components/sensor.serial_pm.markdown @@ -65,4 +65,3 @@ sensor: name: Nova brand: novafitness,sds011 ``` - diff --git a/source/_components/sensor.shodan.markdown b/source/_components/sensor.shodan.markdown index 6a98ad30422..4634d7cba7f 100644 --- a/source/_components/sensor.shodan.markdown +++ b/source/_components/sensor.shodan.markdown @@ -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 %} - diff --git a/source/_components/sensor.sht31.markdown b/source/_components/sensor.sht31.markdown index f1a46c17810..07d17e1305c 100644 --- a/source/_components/sensor.sht31.markdown +++ b/source/_components/sensor.sht31.markdown @@ -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. diff --git a/source/_components/sensor.sigfox.markdown b/source/_components/sensor.sigfox.markdown index 4e34dcb41f7..8491f48ae3a 100644 --- a/source/_components/sensor.sigfox.markdown +++ b/source/_components/sensor.sigfox.markdown @@ -51,4 +51,3 @@ name: default: "sigfox" type: string {% endconfiguration %} - diff --git a/source/_components/sensor.skybeacon.markdown b/source/_components/sensor.skybeacon.markdown index 01d34fe65ba..d0bcc5522b1 100644 --- a/source/_components/sensor.skybeacon.markdown +++ b/source/_components/sensor.skybeacon.markdown @@ -48,4 +48,3 @@ monitored_conditions: humidity: description: Humidity at the sensor's location. {% endconfiguration %} - diff --git a/source/_components/sensor.sma.markdown b/source/_components/sensor.sma.markdown index 8ce932e4d38..588377c1a87 100644 --- a/source/_components/sensor.sma.markdown +++ b/source/_components/sensor.sma.markdown @@ -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: diff --git a/source/_components/sensor.sochain.markdown b/source/_components/sensor.sochain.markdown index 26ff8d5fd1b..246a920ed22 100644 --- a/source/_components/sensor.sochain.markdown +++ b/source/_components/sensor.sochain.markdown @@ -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: diff --git a/source/_components/sensor.socialblade.markdown b/source/_components/sensor.socialblade.markdown index 143feb80e9d..521e2f71375 100644 --- a/source/_components/sensor.socialblade.markdown +++ b/source/_components/sensor.socialblade.markdown @@ -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/). diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 9b70848868d..8f02530b192 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -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 %} diff --git a/source/_components/sensor.starlingbank.markdown b/source/_components/sensor.starlingbank.markdown index 5accaf731d5..852fbbb8203 100644 --- a/source/_components/sensor.starlingbank.markdown +++ b/source/_components/sensor.starlingbank.markdown @@ -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.

- 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).

-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. diff --git a/source/_components/sensor.startca.markdown b/source/_components/sensor.startca.markdown index 5d36a629eec..c91b0a5b709 100644 --- a/source/_components/sensor.startca.markdown +++ b/source/_components/sensor.startca.markdown @@ -83,4 +83,3 @@ monitored_conditions: used_remaining: description: Remaining bandwidth calucated from used and supplied total bandwidth (gigabytes). {% endconfiguration %} - diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown index ad60be7beb0..75a1d8cd8f9 100644 --- a/source/_components/sensor.statistics.markdown +++ b/source/_components/sensor.statistics.markdown @@ -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 %} diff --git a/source/_components/sensor.steam_online.markdown b/source/_components/sensor.steam_online.markdown index b42e343aeea..7914ab33826 100644 --- a/source/_components/sensor.steam_online.markdown +++ b/source/_components/sensor.steam_online.markdown @@ -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 %} diff --git a/source/_components/sensor.supervisord.markdown b/source/_components/sensor.supervisord.markdown index bc1c2880b90..2e0464e0484 100644 --- a/source/_components/sensor.supervisord.markdown +++ b/source/_components/sensor.supervisord.markdown @@ -28,7 +28,6 @@ After a restart of `supervisord` you should be able to access the web interface.

- 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 %} diff --git a/source/_components/sensor.swiss_public_transport.markdown b/source/_components/sensor.swiss_public_transport.markdown index b702c2dc50a..f58ab765f2b 100644 --- a/source/_components/sensor.swiss_public_transport.markdown +++ b/source/_components/sensor.swiss_public_transport.markdown @@ -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). diff --git a/source/_components/sensor.synologydsm.markdown b/source/_components/sensor.synologydsm.markdown index 3c97a8feebd..ee39a0c854d 100644 --- a/source/_components/sensor.synologydsm.markdown +++ b/source/_components/sensor.synologydsm.markdown @@ -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 %} diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index 2f3f1004533..8c28c152579 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -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 %} diff --git a/source/_components/sensor.tank_utility.markdown b/source/_components/sensor.tank_utility.markdown index 6446f5e8949..a77dbc4f3a3 100644 --- a/source/_components/sensor.tank_utility.markdown +++ b/source/_components/sensor.tank_utility.markdown @@ -55,4 +55,3 @@ unit_of_measurement: required: true type: map {% endconfiguration %} - diff --git a/source/_components/sensor.tcp.markdown b/source/_components/sensor.tcp.markdown index f3638d48bd8..526c6d85e1f 100644 --- a/source/_components/sensor.tcp.markdown +++ b/source/_components/sensor.tcp.markdown @@ -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 diff --git a/source/_components/sensor.ted5000.markdown b/source/_components/sensor.ted5000.markdown index 1e498eb1ca0..23e82fc9e3f 100644 --- a/source/_components/sensor.ted5000.markdown +++ b/source/_components/sensor.ted5000.markdown @@ -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._mtu_power sensor._mtu_voltage ``` - diff --git a/source/_components/sensor.teksavvy.markdown b/source/_components/sensor.teksavvy.markdown index c55d05f3f39..0cf50bdf67a 100644 --- a/source/_components/sensor.teksavvy.markdown +++ b/source/_components/sensor.teksavvy.markdown @@ -75,4 +75,3 @@ monitored_conditions: onpeak_remaining: description: Remaining bandwidth (gigabytes). {% endconfiguration %} - diff --git a/source/_components/sensor.thermoworks_smoke.markdown b/source/_components/sensor.thermoworks_smoke.markdown index 11098e72a8c..c50ddfb8c39 100644 --- a/source/_components/sensor.thermoworks_smoke.markdown +++ b/source/_components/sensor.thermoworks_smoke.markdown @@ -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: diff --git a/source/_components/sensor.thethingsnetwork.markdown b/source/_components/sensor.thethingsnetwork.markdown index faeb8b7e650..b5a27540f1e 100644 --- a/source/_components/sensor.thethingsnetwork.markdown +++ b/source/_components/sensor.thethingsnetwork.markdown @@ -42,7 +42,7 @@ Click **Add integration** to finish the process. Add a The Things Network Data Storage integration

-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.

@@ -80,4 +80,3 @@ sensor: required: true type: list {% endconfiguration %} - diff --git a/source/_components/sensor.time_date.markdown b/source/_components/sensor.time_date.markdown index 4a922a7e408..2f7d8d94981 100644 --- a/source/_components/sensor.time_date.markdown +++ b/source/_components/sensor.time_date.markdown @@ -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:

- diff --git a/source/_components/sensor.trafikverket_weatherstation.markdown b/source/_components/sensor.trafikverket_weatherstation.markdown index 7c8888b7806..e0cf88bf535 100644 --- a/source/_components/sensor.trafikverket_weatherstation.markdown +++ b/source/_components/sensor.trafikverket_weatherstation.markdown @@ -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

-##### {% linkable_title Examples %} +## {% linkable_title Examples %} ```yaml sensor: diff --git a/source/_components/sensor.transport_nsw.markdown b/source/_components/sensor.transport_nsw.markdown index 8296ffdedea..fc72f408cdc 100644 --- a/source/_components/sensor.transport_nsw.markdown +++ b/source/_components/sensor.transport_nsw.markdown @@ -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 diff --git a/source/_components/sensor.twitch.markdown b/source/_components/sensor.twitch.markdown index abeb4b6571f..7d692ebbac1 100644 --- a/source/_components/sensor.twitch.markdown +++ b/source/_components/sensor.twitch.markdown @@ -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 %} - diff --git a/source/_components/sensor.uber.markdown b/source/_components/sensor.uber.markdown index cfec12282a1..3f151040a92 100644 --- a/source/_components/sensor.uber.markdown +++ b/source/_components/sensor.uber.markdown @@ -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 %} diff --git a/source/_components/sensor.uptime.markdown b/source/_components/sensor.uptime.markdown index a4b3a97f585..665cfe9bc43 100644 --- a/source/_components/sensor.uptime.markdown +++ b/source/_components/sensor.uptime.markdown @@ -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 %} diff --git a/source/_components/sensor.version.markdown b/source/_components/sensor.version.markdown index 10ce29b4ac3..edc8c29b572 100644 --- a/source/_components/sensor.version.markdown +++ b/source/_components/sensor.version.markdown @@ -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 service developer tool icon **Info** section of the **Developer Tools**. diff --git a/source/_components/sensor.viaggiatreno.markdown b/source/_components/sensor.viaggiatreno.markdown index e313e903b12..a8c4c8c1678 100644 --- a/source/_components/sensor.viaggiatreno.markdown +++ b/source/_components/sensor.viaggiatreno.markdown @@ -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/` +`http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/` (e.g., `http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/ROMA` will list all station names (with ids) that starts with *ROMA*).

diff --git a/source/_components/sensor.volkszaehler.markdown b/source/_components/sensor.volkszaehler.markdown index 0d9d7c6f89d..06bae90dc2c 100644 --- a/source/_components/sensor.volkszaehler.markdown +++ b/source/_components/sensor.volkszaehler.markdown @@ -76,4 +76,3 @@ sensor: - min - max ``` - diff --git a/source/_components/sensor.vultr.markdown b/source/_components/sensor.vultr.markdown index 5aa03c73931..89f87369f76 100644 --- a/source/_components/sensor.vultr.markdown +++ b/source/_components/sensor.vultr.markdown @@ -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 ``` - diff --git a/source/_components/sensor.waze_travel_time.markdown b/source/_components/sensor.waze_travel_time.markdown index a1a02c7dd0f..4886e21ce55 100644 --- a/source/_components/sensor.waze_travel_time.markdown +++ b/source/_components/sensor.waze_travel_time.markdown @@ -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 diff --git a/source/_components/sensor.whois.markdown b/source/_components/sensor.whois.markdown index 95e351dd9e7..596f12e802c 100644 --- a/source/_components/sensor.whois.markdown +++ b/source/_components/sensor.whois.markdown @@ -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 %} - diff --git a/source/_components/tado.markdown b/source/_components/tado.markdown index f0178b047e4..efd8c821113 100644 --- a/source/_components/tado.markdown +++ b/source/_components/tado.markdown @@ -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