jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Franck Nijhof 2019-01-22 09:43:41 +01:00 committed by Joakim Sørensen
parent 62b6ba872b
commit 8a7789f81f
17 changed files with 51 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
source/_components/switch.rainmachine.markdown
View File

@ -28,8 +28,7 @@ After Home Assistant loads, new switches will be added for every enabled
program and zone. These work as expected: program and zone. These work as expected:
- Program On/Off: starts/stops a program - Program On/Off: starts/stops a program
- Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to - Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to determine how long to run for)
determine how long to run for)
Programs and zones are linked. While a program is running, you will see both Programs and zones are linked. While a program is running, you will see both
the program and zone switches turned on; turning either one off will turn the the program and zone switches turned on; turning either one off will turn the

9
source/_components/switch.raspihats.markdown
View File

@ -13,12 +13,11 @@ ha_release: 0.45
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `raspihats` switch platform allows you to control the digital outputs of your [Raspihats](http://www.raspihats.com/) boards.
The `raspihats` switch platform allows you to control the digital outputs of your [raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
To use your raspihats boards in your installation, add the following to your `configuration.yaml` file: To use your Raspihats boards in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -96,12 +95,12 @@ $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-de
$ sudo usermod -a -G i2c homeassistant $ sudo usermod -a -G i2c homeassistant
``` ```
### {% linkable_title Check the i2c address of the sensor %} ## {% linkable_title Check the i2c address of the sensor %}
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address: After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
```bash ```bash
$ /usr/sbin/i2cdetect -y 1 /usr/sbin/i2cdetect -y 1
``` ```
It will output a table like this: It will output a table like this:

11
source/_components/switch.raspyrfm.markdown
View File

@ -17,8 +17,9 @@ The `raspyrfm` component adds support for cheap RC 433 MHz outlets via one of th
Initially, this component was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi. Initially, this component was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi.
Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this component like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html) Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this component like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html).
## {% linkable_title Configuration %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -77,15 +78,15 @@ switches:
type: dict type: dict
{% endconfiguration %} {% endconfiguration %}
### {% linkable_title Device support %} ## {% linkable_title Device support %}
Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to check what gateways and control units (outlets) are supported. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to check what gateways and control units (outlets) are supported.
### {% linkable_title Channel configuration %} ## {% linkable_title Channel configuration %}
Depending on the control unit the channel config can have varying formats. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to find out about a specific model. Depending on the control unit the channel config can have varying formats. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to find out about a specific model.
### {% linkable_title Switch state %} ## {% linkable_title Switch state %}
Initially, the state of a switch is unknown. When the switch is turned on or off (via frontend) the state is known and will be shown in the frontend. Initially, the state of a switch is unknown. When the switch is turned on or off (via frontend) the state is known and will be shown in the frontend.
@ -93,7 +94,7 @@ Initially, the state of a switch is unknown. When the switch is turned on or off
Note that due to the way those cheap RC units work it is **not possible to query their current state**. Therefore the only way to preserve a consistent state within Home Assistant is to only use Home Assistant as the controller. Note that due to the way those cheap RC units work it is **not possible to query their current state**. Therefore the only way to preserve a consistent state within Home Assistant is to only use Home Assistant as the controller.
</p> </p>
### {% linkable_title Full example %} ## {% linkable_title Full example %}
```yaml ```yaml
switch: switch:

3
source/_components/switch.recswitch.markdown
View File

@ -17,10 +17,11 @@ ha_iot_class: "Local Polling"
The `recswitch` switch platform allows you to control the Ankuoo Rec Switch devices. The `recswitch` switch platform allows you to control the Ankuoo Rec Switch devices.
Supported devices (tested): Supported devices (tested):
- Ankuoo RecSwitch MS6126 - Ankuoo RecSwitch MS6126
- Lumitek CSW201 NEO WiFi - Lumitek CSW201 NEO WiFi
### {% linkable_title Configuration %} ## {% linkable_title Configuration %}
To enable this switch, add the following lines to your `configuration.yaml`: To enable this switch, add the following lines to your `configuration.yaml`:

17
source/_components/switch.rflink.markdown
View File

@ -12,15 +12,17 @@ ha_category: Switch
ha_release: 0.38 ha_release: 0.38
--- ---
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First you have to set up your [rflink hub](/components/rflink/). ## {% linkable_title Configuration %}
First, you have to set up your [rflink hub](/components/rflink/).
The RFLink component does not know the difference between a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default. The RFLink component does not know the difference between a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
RFLink switch/light ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`. RFLink switch/light ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`.
Once the ID of a switch is known it can be used to configure it as a switch type in HA, for example to add it to a different group, hide it or configure a nice name. Once the ID of a switch is known it can be used to configure it as a switch type in HA, for example, to add it to a different group, hide it or configure a nice name.
Configuring a device as switch with a nice name: Configuring a device as switch with a nice name:
@ -36,7 +38,6 @@ switch:
name: Ceiling fan name: Ceiling fan
conrad_00785c_0a: conrad_00785c_0a:
name: Motion sensor kitchen name: Motion sensor kitchen
``` ```
{% configuration %} {% configuration %}
@ -92,9 +93,9 @@ devices:
type: boolean type: boolean
{% endconfiguration %} {% endconfiguration %}
### {% linkable_title Switch state %} ## {% linkable_title Switch state %}
Initially the state of a switch is unknown. When the switch is turned on or off (via frontend or wireless remote) the state is known and will be shown in the frontend. Initially, the state of a switch is unknown. When the switch is turned on or off (via frontend or wireless remote) the state is known and will be shown in the frontend.
Sometimes a switch is controlled by multiple wireless remotes, each remote has its own code programmed in the switch. To allow tracking of the state when switched via other remotes add the corresponding remote codes as aliases: Sometimes a switch is controlled by multiple wireless remotes, each remote has its own code programmed in the switch. To allow tracking of the state when switched via other remotes add the corresponding remote codes as aliases:
@ -111,8 +112,8 @@ switch:
- kaku_000001_a - kaku_000001_a
``` ```
Any on/off command from any alias ID updates the current state of the switch. However when sending a command through the frontend only the primary ID is used. Any on/off command from any alias ID updates the current state of the switch. However, when sending a command through the frontend only the primary ID is used.
### {% linkable_title Device support %} ## {% linkable_title Device support %}
See [device support](/components/rflink/#device-support) See [device support](/components/rflink/#device-support)

12
source/_components/switch.rfxtrx.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.7.5
The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz. The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz.
## {% linkable_title Configuration %}
First you have to set up your [rfxtrx hub](/components/rfxtrx/). First you have to set up your [rfxtrx hub](/components/rfxtrx/).
The easiest way to find your switches is to add this to your `configuration.yaml`: The easiest way to find your switches is to add this to your `configuration.yaml`:
@ -24,7 +26,7 @@ switch:
automatic_add: true automatic_add: true
``` ```
Launch your Home Assistant and go the website. Launch your Home Assistant and go to the website.
Push your remote and your device should be added: Push your remote and your device should be added:
<p class='img'> <p class='img'>
@ -54,7 +56,7 @@ devices:
required: true required: true
type: string type: string
fire_event: fire_event:
description: Fires an event even if the state is the same as before, for example a doorbell switch. Can also be used for automations. description: Fires an event even if the state is the same as before, for example, a doorbell switch. Can also be used for automations.
required: false required: false
default: false default: false
type: boolean type: boolean
@ -64,7 +66,7 @@ automatic_add:
default: false default: false
type: boolean type: boolean
signal_repetitions: signal_repetitions:
description: Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly. description: Because the RFXtrx device sends its actions via radio and from most receivers, it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly.
required: false required: false
type: integer type: integer
{% endconfiguration %} {% endconfiguration %}
@ -90,7 +92,7 @@ If you need to generate codes for switches you can use a template (useful for ex
``` ```
- Use this code to add a new switch in your configuration.yaml - Use this code to add a new switch in your configuration.yaml
- Launch your Home Assistant and go the website. - Launch your Home Assistant and go to the website.
- Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket) - Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket)
- Toggle your new switch in the Home Assistant interface - Toggle your new switch in the Home Assistant interface
@ -129,7 +131,7 @@ switch:
fire_event: true fire_event: true
automation: automation:
- alias: Switch light on when door bell rings if sun is below horizon and light was off - alias: Switch the light on when doorbell rings if the sun is below the horizon and the light was off
trigger: trigger:
platform: event platform: event
event_type: button_pressed event_type: button_pressed

3
source/_components/switch.rpi_gpio.markdown
View File

@ -13,7 +13,6 @@ ha_release: pre 0.7
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -52,7 +51,7 @@ For more details about the GPIO layout, visit the Wikipedia [article](https://en
Note that a pin managed by HASS is expected to be exclusive to HASS. Note that a pin managed by HASS is expected to be exclusive to HASS.
</p> </p>
A common question is what does Port refer to, this number is the actual GPIO # not the pin #. A common question is what does Port refer to, this number is the actual GPIO #, not the pin #.
For example, if you have a relay connected to pin 11 its GPIO # is 17. For example, if you have a relay connected to pin 11 its GPIO # is 17.
```yaml ```yaml

5
source/_components/switch.rpi_rf.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.19
ha_iot_class: "Assumed state" ha_iot_class: "Assumed state"
--- ---
The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/SRD signals with generic low-cost GPIO RF modules on a [Raspberry Pi](https://www.raspberrypi.org/). The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/SRD signals with generic low-cost GPIO RF modules on a [Raspberry Pi](https://www.raspberrypi.org/).
Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch). Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch).
@ -72,11 +71,11 @@ switches:
default: 1 default: 1
type: integer type: integer
pulselength: pulselength:
description: Pulselength description: Pulselength.
required: false required: false
type: integer type: integer
signal_repetitions: signal_repetitions:
description: Number of times to repeat transmission description: Number of times to repeat transmission.
required: false required: false
default: 10 default: 10
type: integer type: integer

2
source/_components/switch.switchbot.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.78
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
This `Switchbot` switch platform allow you to control Switchbot [devices]( https://www.switch-bot.com/). This `Switchbot` switch platform allows you to control Switchbot [devices]( https://www.switch-bot.com/).
To enable it, add the following lines to your `configuration.yaml`: To enable it, add the following lines to your `configuration.yaml`:

3
source/_components/switch.switchmate.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
This `Switchmate` switch platform allows you to control Switchmate [devices]( https://www.mysimplysmarthome.com/products/switchmate-switches/). This `Switchmate` switch platform allows you to control Switchmate [devices]( https://www.mysimplysmarthome.com/products/switchmate-switches/).
## {% linkable_title Configuration %}
To enable it, add the following lines to your `configuration.yaml`: To enable it, add the following lines to your `configuration.yaml`:
```yaml ```yaml
@ -39,5 +41,4 @@ flip_on_off:
default: false default: false
{% endconfiguration %} {% endconfiguration %}
The component is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle. The component is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle.

1
source/_components/switch.tellduslive.markdown
View File

@ -13,4 +13,3 @@ featured: false
--- ---
Integrates Telldus Live switches into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions. Integrates Telldus Live switches into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.

1
source/_components/switch.tellstick.markdown
View File

@ -12,7 +12,6 @@ ha_category: Switch
ha_iot_class: "Assumed State" ha_iot_class: "Assumed State"
--- ---
This `tellstick` switch platform allows you to control [TellStick](http://www.telldus.se/products/tellstick) devices. This `tellstick` switch platform allows you to control [TellStick](http://www.telldus.se/products/tellstick) devices.
To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file: To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file:

2
source/_components/switch.tplink.markdown
View File

@ -63,7 +63,7 @@ switch:
host: SECOND_IP_ADDRESS host: SECOND_IP_ADDRESS
``` ```
## {% linkable_title Configure Energy Sensors %} ## ## {% linkable_title Configure Energy Sensors %}
In order to get the power consumption readings from the HS110, you'll have to create a [template sensor](/components/switch.template/). In the example below, change all of the `my_tp_switch`'s to match your switch's entity ID. In order to get the power consumption readings from the HS110, you'll have to create a [template sensor](/components/switch.template/). In the example below, change all of the `my_tp_switch`'s to match your switch's entity ID.

5
source/_components/switch.transmission.markdown
View File

@ -13,9 +13,10 @@ ha_release: pre 0.7
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
The `transmission` switch platform allows you to control your [Transmission](http://www.transmissionbt.com/) client from within Home Assistant. The platform enables you switch to your 'Alternative Speed Limits' (aka 'Turtle mode') setting. The `transmission` switch platform allows you to control your [Transmission](http://www.transmissionbt.com/) client from within Home Assistant. The platform enables you switch to your 'Alternative Speed Limits' (aka 'Turtle mode') setting.
## {% linkable_title Configuration %}
To add Transmission to your installation, add the following to your `configuration.yaml` file: To add Transmission to your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -29,7 +30,7 @@ switch:
host: host:
required: true required: true
type: string type: string
description: This is the IP address of your Transmission daemon, e.g., 192.168.1.32. description: This is the IP address of your Transmission daemon, e.g., `192.168.1.32`.
port: port:
required: false required: false
type: integer type: integer

3
source/_components/switch.tuya.markdown
View File

@ -1,7 +1,7 @@
--- ---
layout: page layout: page
title: "Tuya Switch" title: "Tuya Switch"
description: "Instructions on how to setup the Tuya switch within Home Assistant." description: "Instructions on how to set up the Tuya switch within Home Assistant."
date: 2018-07-09 09:00 date: 2018-07-09 09:00
sidebar: true sidebar: true
comments: false comments: false
@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.74 ha_release: 0.74
--- ---
The `tuya` switch platform allows you to control your [Tuya Smart](https://www.tuya.com) switch. The `tuya` switch platform allows you to control your [Tuya Smart](https://www.tuya.com) switch.
The platform supports switch and socket. The platform supports switch and socket.

4
source/_components/switch.verisure.markdown
View File

@ -12,8 +12,6 @@ ha_category: Switch
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Polling"
--- ---
The Verisure switch platform allows you to control your [Verisure](https://www.verisure.com/) SmartPlugs. The Verisure switch platform allows you to control your [Verisure](https://www.verisure.com/) SmartPlugs.
The requirement is that you have setup your [Verisure hub](/components/verisure/). The requirement is that you have set up your [Verisure hub](/components/verisure/).

4
source/_components/switch.vesync.markdown
View File

@ -16,6 +16,8 @@ The `vesync` switch platform enables integration with Etekcity VeSync smart swit
VeSync switches are low-cost wifi smart plugs that offer energy monitoring and work with popular voice assistants. VeSync switches are low-cost wifi smart plugs that offer energy monitoring and work with popular voice assistants.
## {% linkable_title Configuration %}
To use your VeSync switches, you must first register your switches with the VeSync app. Once registration is complete you must add the following to your `configuration.yaml` file: To use your VeSync switches, you must first register your switches with the VeSync app. Once registration is complete you must add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -37,7 +39,7 @@ password:
type: string type: string
{% endconfiguration %} {% endconfiguration %}
### {% linkable_title Exposed Attributes %} ## {% linkable_title Exposed Attributes %}
VeSync switches will expose the following details. VeSync switches will expose the following details.