From 837016043eab8d2ab4e4c4160e944c4b8dba65c5 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Wed, 16 Jan 2019 21:39:20 +0100 Subject: [PATCH] :pencil2: Spelling, grammar, styling and fixes (#8187) --- source/_components/switch.vultr.markdown | 19 +++++---- source/_components/switch.wemo.markdown | 1 - source/_components/switch.wink.markdown | 9 ++-- .../_components/switch.xiaomi_aqara.markdown | 8 ++-- .../_components/switch.xiaomi_miio.markdown | 42 +++++++++---------- source/_components/system_log.markdown | 14 ++++--- 6 files changed, 45 insertions(+), 48 deletions(-) diff --git a/source/_components/switch.vultr.markdown b/source/_components/switch.vultr.markdown index c02e5273b1e..8844c897dad 100644 --- a/source/_components/switch.vultr.markdown +++ b/source/_components/switch.vultr.markdown @@ -13,13 +13,13 @@ ha_release: "0.58" ha_iot_class: "Cloud Polling" --- -The `vultr` switch platform allows you to control (start/stop) your [Vultr](https://www.vultr.com/) subscription. +The `vultr` switch platform allows you to control (start/stop) your +[Vultr](https://www.vultr.com/) subscription. -To control your Vultr subscription, you first have to set up your [Vultr hub](/components/vultr/). +To control your Vultr subscription, you first have to set up +your [Vultr hub](/components/vultr/). -

-The following examples assume a subscription that has an ID of `123456` and a label of `Web Server` -

+## {% linkable_title Configuration %} Minimal `configuration.yaml` (produces `switch.vultr_web_server`): @@ -27,7 +27,7 @@ Minimal `configuration.yaml` (produces `switch.vultr_web_server`): # Example configuration.yaml entry switch: - platform: vultr - subscription: 123456 + subscription: YOUR_SUBSCRIPTION_ID ``` {% configuration %} @@ -42,14 +42,15 @@ name: type: string {% endconfiguration %} +## {% linkable_title Additional Examples %} -Full `configuration.yaml` (produces `switch.amazing_server`): +Full example that produces `switch.amazing_server`, assuming a subscription +that has an ID of `123456` and a label of `Web Server`: ```yaml +# Example configuration.yaml entry switch: - platform: vultr name: Amazing Server subscription: 123456 ``` - - diff --git a/source/_components/switch.wemo.markdown b/source/_components/switch.wemo.markdown index d069e93c160..9afefdc77a1 100644 --- a/source/_components/switch.wemo.markdown +++ b/source/_components/switch.wemo.markdown @@ -12,7 +12,6 @@ ha_category: Switch ha_iot_class: "Local Push" --- - The `wemo` platform allows you to control your [Belkin WeMo](http://www.belkin.com/us/p/P-F7C027/) switches from within Home Assistant. This includes support for Wemo enabled [Mr. Coffee](http://www.mrcoffee.com/wemo-landing-page.html) smart coffee makers. WeMo devices are automatically discovered if the `discovery` component is enabled. For more configuration information, see the [WeMo component](/components/wemo/) documentation. diff --git a/source/_components/switch.wink.markdown b/source/_components/switch.wink.markdown index 9a026077925..f3a6c80e07e 100644 --- a/source/_components/switch.wink.markdown +++ b/source/_components/switch.wink.markdown @@ -13,18 +13,15 @@ ha_release: pre 0.7 ha_iot_class: "Cloud Polling" --- - The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches. -The requirement is that you have setup [Wink](/components/wink/). +The requirement is that you have set up [Wink](/components/wink/). - -### Supported switch devices +## {% linkable_title Supported switch devices %} - Wink Pivot power genius (No Wink hub required) -- non-dimming Z-wave in wall switches (dimming switches show up as lights) +- non-dimming Z-wave in-wall switches (dimming switches show up as lights) - Wink Relay load controlling switches - Rachio sprinkler controller (No Wink hub required) - iHome smart plug (No Wink hub required) - Wink switch groups (User created groups of switches) - diff --git a/source/_components/switch.xiaomi_aqara.markdown b/source/_components/switch.xiaomi_aqara.markdown index 0306ba29213..b19adf44314 100644 --- a/source/_components/switch.xiaomi_aqara.markdown +++ b/source/_components/switch.xiaomi_aqara.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Xiaomi Switch" -description: "Instructions on how to setup the Xiaomi switch within Home Assistant." +description: "Instructions on how to set up the Xiaomi switch within Home Assistant." date: 2017-07-21 16:34 sidebar: true comments: false @@ -13,8 +13,6 @@ ha_release: "0.50" ha_iot_class: "Local Push" --- +The `xiaomi_aqara` switch platform allows you to get data from your [Xiaomi aqara](http://www.mi.com/en/) switches. -The `xiaomi aqara` switch platform allows you to get data from your [Xiaomi aqara](http://www.mi.com/en/) switches. - -The requirement is that you have setup [Xiaomi aqara](/components/xiaomi_aqara/). - +The requirement is that you have set up [Xiaomi aqara](/components/xiaomi_aqara/). diff --git a/source/_components/switch.xiaomi_miio.markdown b/source/_components/switch.xiaomi_miio.markdown index efe0e9c89fd..e2f8d92b3b7 100644 --- a/source/_components/switch.xiaomi_miio.markdown +++ b/source/_components/switch.xiaomi_miio.markdown @@ -17,50 +17,50 @@ The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. -## Features +## {% linkable_title Features %} -### Xiaomi Smart WiFi Socket +### {% linkable_title Xiaomi Smart WiFi Socket %} Supported models: `chuangmi.plug.m1`, `chuangmi.plug.v2`, `chuangmi.plug.hmi205` -* Power (on, off) -* Attributes +- Power (on, off) +- Attributes - Temperature -### Xiaomi Chuangmi Plug V1 +### {% linkable_title Xiaomi Chuangmi Plug V1 %} Supported models: `chuangmi.plug.v1`, `chuangmi.plug.v3` -* Power (on, off) -* USB (on, off) -* Attributes +- Power (on, off) +- USB (on, off) +- Attributes - Temperature -### Xiaomi Smart Power Strip +### {% linkable_title Xiaomi Smart Power Strip %} Supported models: `qmi.powerstrip.v1`, `zimi.powerstrip.v2` -* Power (on, off) -* Wifi LED (on, off) -* Power Price (0...999) -* Power Mode (green, normal) (Power Strip V1 only) -* Attributes +- Power (on, off) +- Wifi LED (on, off) +- Power Price (0...999) +- Power Mode (green, normal) (Power Strip V1 only) +- Attributes - Temperature - Current - Load power - Wifi LED - Mode (Power Strip V1 only) +## {% linkable_title Configuration %} + To add a plug to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entries switch: - platform: xiaomi_miio - name: Original Xiaomi Mi Smart WiFi Socket - host: 192.168.130.59 + host: MIIO_IP_ADDRESS token: YOUR_TOKEN - model: chuangmi.plug.m1 ``` {% configuration %} @@ -91,7 +91,7 @@ Turn the wifi led on. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. | ### {% linkable_title Service `switch.xiaomi_miio_set_wifi_led_off` %} (Power Strip only) @@ -99,7 +99,7 @@ Turn the wifi led off. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. | ### {% linkable_title Service `switch.xiaomi_miio_set_power_price` %} (Power Strip) @@ -107,7 +107,7 @@ Set the power price. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| -| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. | | `price` | no | Power price, between 0 and 999. | ### {% linkable_title Service `switch.xiaomi_miio_set_power_mode` %} (Power Strip V1 only) @@ -116,5 +116,5 @@ Set the power mode. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------------| -| `entity_id` | yes | Only act on a specific xiaomi miio switch entity. Else targets all. | +| `entity_id` | yes | Only act on a specific Xiaomi miio switch entity. Else targets all. | | `mode` | no | Power mode, valid values are 'normal' and 'green' | diff --git a/source/_components/system_log.markdown b/source/_components/system_log.markdown index 9d80c4a6145..c95bf4915ed 100644 --- a/source/_components/system_log.markdown +++ b/source/_components/system_log.markdown @@ -15,7 +15,9 @@ ha_qa_scale: internal The `system_log` component stores information about all logged errors and warnings in Home Assistant. All collected information is accessible directly in the frontend, just navigate to the `Info` section under `Developer Tools`. In order to not overload Home Assistant with log data, only the 50 last errors and warnings will be stored. Older entries are automatically discarded from the log. It is possible to change the number of stored log entries using the parameter `max_entries`. -This component is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file: +## {% linkable_title Configuration %} + +This component is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file: ```yaml system_log: @@ -45,11 +47,11 @@ To manually clear the system log, call this service. Errors and warnings are posted as the event `system_log_event`, so it is possible to write automations that trigger whenever a warning or error occurs. The following information is included in each event: -| Field | Description | -|------------------------------------------------------------------------------------------| -| `level` | Either `WARNING` or `ERROR` depending on severity. | +| Field | Description | +|-------------------------------------------------------------------------------------------| +| `level` | Either `WARNING` or `ERROR` depending on severity. | | `source` | File that triggered the error, e.g., `core.py` or `media_player/yamaha.py`. | -| `exception` | Full stack trace if available, otherwise empty string. | +| `exception` | Full stack trace if available, an empty string otherwise. | | `message` | Descriptive message of the error, e.g., "Error handling request". | | `timestamp` | Unix timestamp with as a double, e.g., 1517241010.237416. | @@ -57,7 +59,7 @@ Live examples of these events can be found in the Home Assistant log file or by -The message ("Unable to find service..."), source (`core.py`) and level (`WARNING`) can easily be extracted from the image. Exact timestamp and stack trace is shown if the entry is selected. +The message ("Unable to find service..."), source (`core.py`) and level (`WARNING`) can easily be extracted from the image. The exact timestamp and stack trace is shown in the selected entry. ## {% linkable_title Examples %}