From 6801dc25d3a0ebcee28299686cab0cff7189e011 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 24 Jan 2019 23:14:04 +0100 Subject: [PATCH] :pencil2: Spelling, grammar, styling and fixes (#8260) --- source/_components/switch.homematic.markdown | 1 - source/_components/switch.hook.markdown | 4 ++-- source/_components/switch.hydrawise.markdown | 3 +-- source/_components/switch.ihc.markdown | 4 +++- source/_components/switch.insteon.markdown | 4 ++-- source/_components/switch.kankun.markdown | 3 ++- source/_components/switch.knx.markdown | 2 -- source/_components/switch.konnected.markdown | 3 +-- source/_components/switch.linode.markdown | 1 - source/_components/switch.markdown | 10 +++++----- source/_components/switch.mfi.markdown | 1 - source/_components/switch.modbus.markdown | 1 - 12 files changed, 16 insertions(+), 21 deletions(-) diff --git a/source/_components/switch.homematic.markdown b/source/_components/switch.homematic.markdown index 7902ae4974d..ceaa29fc9e6 100644 --- a/source/_components/switch.homematic.markdown +++ b/source/_components/switch.homematic.markdown @@ -13,7 +13,6 @@ ha_release: 0.23 ha_iot_class: "Local Push" --- - The `homematic` switch platform lets you control [Homematic](http://www.homematic.com/) switches through Home Assistant. Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. \ No newline at end of file diff --git a/source/_components/switch.hook.markdown b/source/_components/switch.hook.markdown index fbfeef75b4b..71ef1bc45c6 100644 --- a/source/_components/switch.hook.markdown +++ b/source/_components/switch.hook.markdown @@ -14,7 +14,7 @@ ha_release: 0.34 The `hook` component allows you to control the [Hook Smart Home Hub](http://www.hooksmarthome.com/) from within Home Assistant. -Hook allows you to control cheap mains electrical outlets, like these ones at [Amazon](https://www.amazon.com/Etekcity-Wireless-Electrical-Household-Appliances/dp/B00DQELHBS). +Hook allows you to control cheap mains electrical outlets, like these ones at [Amazon](https://www.amazon.com/Etekcity-Wireless-Electrical-Household-Appliances/dp/B00DQELHBS). In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive commands at 315MHz and 433MHz. Unfortunately, this does not allow Hook to determine if the command was successful, so the state is assumed. @@ -28,7 +28,7 @@ To enable this platform in your installation, add the following to your `configu ```yaml # Example configuration.yaml entry -switch: +switch: - platform: hook username: YOUR_E_MAIL_ADDRESS password: YOUR_HOOK diff --git a/source/_components/switch.hydrawise.markdown b/source/_components/switch.hydrawise.markdown index fc584f75a7e..2fc830e844c 100644 --- a/source/_components/switch.hydrawise.markdown +++ b/source/_components/switch.hydrawise.markdown @@ -27,7 +27,7 @@ switch: {% configuration %} watering_minutes: - description: When manual watering is enabled this will determine the length of time in minutes that irrigation zone will run. The allowed values are 5, 10, 15, 30, 45, or 60. + description: When manual watering is enabled this will determine the length of time in minutes that the irrigation zone will run. The allowed values are 5, 10, 15, 30, 45, or 60. required: false type: integer default: 15 @@ -63,5 +63,4 @@ switch: monitored_conditions: manual_watering ``` - Finish the configuration by visiting the [Hydrawise binary sensor](/components/binary_sensor.hydrawise) and [Hydrawise sensor](/components/sensor.hydrawise/) documentation. diff --git a/source/_components/switch.ihc.markdown b/source/_components/switch.ihc.markdown index 0830439c8e1..21b2e5ecdcc 100644 --- a/source/_components/switch.ihc.markdown +++ b/source/_components/switch.ihc.markdown @@ -24,6 +24,8 @@ project and setup as switch devices: - Mobile wireless relay - Dataline plug outlet +## {% linkable_title Configuration %} + To manually configure IHC switches insert the "switch" section in your IHC configuration: @@ -32,7 +34,7 @@ ihc: - url: 'http://192.168.1.3' username: YOUR_USERNAME password: YOUR_PASSWORD - info: true + info: true switch: - id: 12345 - id: 12346 diff --git a/source/_components/switch.insteon.markdown b/source/_components/switch.insteon.markdown index 0af789e8a3e..216837be65b 100644 --- a/source/_components/switch.insteon.markdown +++ b/source/_components/switch.insteon.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon Switch" -description: "Instructions on how to setup the Insteon switches locally within Home Assistant." +description: "Instructions on how to set up the Insteon switches locally within Home Assistant." date: 2018-08-20 16:00 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_iot_class: "Local Push" ha_version: 0.77 --- -The `insteon` switch platform lets you control your on/off switches through +The `insteon` switch platform lets you control on/off switches through an INSTEON Modem (PLM and Hub) device connected directly to your system on a USB, serial port or TCPIP connection. To add support, set up the primary [insteon] component. diff --git a/source/_components/switch.kankun.markdown b/source/_components/switch.kankun.markdown index 264a6b98a45..68e715784a5 100644 --- a/source/_components/switch.kankun.markdown +++ b/source/_components/switch.kankun.markdown @@ -12,13 +12,14 @@ ha_release: 0.36 ha_iot_class: "Local Polling" --- - The `kankun` switch platform allows you to toggle customized Kankun SP3 Wifi switches. Switches are modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi) script to provide an HTTP API. Details of the necessary modifications can be found [here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version of the script as linked above). +## {% linkable_title Configuration %} + To enable it, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index 47e9e720d4c..5b712dc043a 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -13,7 +13,6 @@ ha_release: 0.24 ha_iot_class: "Local Polling" --- - The `knx` switch component is used as in interface to switching actuators. The `knx` component must be configured correctly, see [KNX Component](/components/knx). @@ -47,4 +46,3 @@ state_address: Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. - diff --git a/source/_components/switch.konnected.markdown b/source/_components/switch.konnected.markdown index 8eecdd41801..e3c02df87dc 100644 --- a/source/_components/switch.konnected.markdown +++ b/source/_components/switch.konnected.markdown @@ -15,5 +15,4 @@ ha_iot_class: "Local Push" The `konnected` switch platform allows you to actuate an alarm system siren, strobe light, buzzer or any other wired device using a [Konnected Alarm Panel board](https://konnected.io) or relay module and a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security). -See the [`konnected`](/components/konnected/) component for configuration and setup instructions. - +See the [`konnected`](/components/konnected/) component for configuration and setup instructions. diff --git a/source/_components/switch.linode.markdown b/source/_components/switch.linode.markdown index f0afd3dd84b..f996d96959e 100644 --- a/source/_components/switch.linode.markdown +++ b/source/_components/switch.linode.markdown @@ -31,4 +31,3 @@ switch: required: true type: string {% endconfiguration %} - diff --git a/source/_components/switch.markdown b/source/_components/switch.markdown index 6e93003ceeb..0ea76993aaa 100644 --- a/source/_components/switch.markdown +++ b/source/_components/switch.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Switches" -description: "Instructions on how to setup your switches with Home Assistant." +description: "Instructions on how to set up your switches with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -11,10 +11,10 @@ footer: true Keeps track which switches are in your environment, their state and allows you to control them. - * Maintains a state per switch and a combined state `all_switches`. - * Registers services `switch.turn_on`, `switch.turn_off`, and `switch.toggle` to control switches. +- Maintains a state per switch and a combined state `all_switches`. +- Registers services `switch.turn_on`, `switch.turn_off`, and `switch.toggle` to control switches. -### {% linkable_title Use the services %} +## {% linkable_title Use the services %} In the frontend open the sidebar. At the bottom, under **Developer Tools**, click **Services**. From the Service dropdown menu choose `switch.turn_on` or `switch.turn_off` from the list of available services. In the Entity dropdown menu choose or enter the entity ID you want to work with. This will enter something like the sample below into the **Service Data** field. Now hit **CALL SERVICE**. @@ -24,4 +24,4 @@ In the frontend open the sidebar. At the bottom, under **Developer Tools**, clic | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | Only act on a specific switch. Otherwise it targets all switches. +| `entity_id` | yes | Only act on a specific switch. Otherwise, it targets all switches. diff --git a/source/_components/switch.mfi.markdown b/source/_components/switch.mfi.markdown index 03841394858..19a5f58d8d4 100644 --- a/source/_components/switch.mfi.markdown +++ b/source/_components/switch.mfi.markdown @@ -12,7 +12,6 @@ ha_category: Switch ha_iot_class: "Local Polling" --- - The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). ## {% linkable_title Configuration %} diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown index c6219ed3ee1..4e897a296b3 100644 --- a/source/_components/switch.modbus.markdown +++ b/source/_components/switch.modbus.markdown @@ -13,7 +13,6 @@ ha_release: pre 0.7 ha_iot_class: "Local Push" --- - The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers. ## {% linkable_title Configuration %}