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-28 11:47:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Franck Nijhof 2019-01-22 14:07:34 +01:00 committed by Fabian Affolter
parent e054444546
commit 3741164746
5 changed files with 30 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -140,7 +140,7 @@ Make sure that your topic matches exactly. `some-topic/` and `some-topic` are di
## {% linkable_title Examples %} ## {% linkable_title Examples %}
In this section you will find some real-life examples of how to use this sensor. In this section, you will find some real-life examples of how to use this sensor.
### {% linkable_title Full configuration %} ### {% linkable_title Full configuration %}
@ -163,20 +163,20 @@ switch:
retain: true retain: true
``` ```
For a check you can use the command line tools `mosquitto_pub` shipped with `mosquitto` to send MQTT messages. This allows you to operate your switch manually: For a check, you can use the command line tools `mosquitto_pub` shipped with `mosquitto` to send MQTT messages. This allows you to operate your switch manually:
```bash ```bash
$ mosquitto_pub -h 127.0.0.1 -t home/bedroom/switch1 -m "ON" mosquitto_pub -h 127.0.0.1 -t home/bedroom/switch1 -m "ON"
``` ```
### {% linkable_title Set the state of a device with ESPEasy %} ### {% linkable_title Set the state of a device with ESPEasy %}
Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". There is no further configuration needed as the [GPIOs](https://www.letscontrolit.com/wiki/index.php/GPIO) can be controlled with MQTT directly. Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example, the topics are prefixed with "home". There is no further configuration needed as the [GPIOs](https://www.letscontrolit.com/wiki/index.php/GPIO) can be controlled with MQTT directly.
Manually you can set pin 13 to high with `mosquitto_pub` or another MQTT tool: Manually you can set pin 13 to high with `mosquitto_pub` or another MQTT tool:
```bash ```bash
$ mosquitto_pub -h 127.0.0.1 -t home/bathroom/gpio/13 -m "1" mosquitto_pub -h 127.0.0.1 -t home/bathroom/gpio/13 -m "1"
``` ```
The configuration will look like the example below: The configuration will look like the example below:
@ -193,4 +193,3 @@ switch:
payload_off: "0" payload_off: "0"
``` ```
{% endraw %} {% endraw %}

22
source/_components/switch.mysensors.markdown
View File

@ -15,9 +15,11 @@ ha_iot_class: "Local Push"
Integrates MySensors switches into Home Assistant. See the [main component] for configuration instructions. Integrates MySensors switches into Home Assistant. See the [main component] for configuration instructions.
## {% linkable_title Supported actuator types %}
The following actuator types are supported: The following actuator types are supported:
##### MySensors version 1.4 and higher ### {% linkable_title MySensors version 1.4 and higher %}
S_TYPE | V_TYPE S_TYPE | V_TYPE
---------|------------------- ---------|-------------------
@ -28,7 +30,7 @@ S_LIGHT | V_LIGHT
S_LOCK | V_LOCK_STATUS S_LOCK | V_LOCK_STATUS
S_IR | V_IR_SEND, V_LIGHT S_IR | V_IR_SEND, V_LIGHT
##### MySensors version 1.5 and higher ### {% linkable_title MySensors version 1.5 and higher %}
S_TYPE | V_TYPE S_TYPE | V_TYPE
-------------|---------------------- -------------|----------------------
@ -40,7 +42,7 @@ S_SOUND | V_ARMED
S_VIBRATION | V_ARMED S_VIBRATION | V_ARMED
S_MOISTURE | V_ARMED S_MOISTURE | V_ARMED
##### MySensors version 2.0 and higher ### {% linkable_title MySensors version 2.0 and higher %}
S_TYPE | V_TYPE S_TYPE | V_TYPE
----------------|--------- ----------------|---------
@ -50,7 +52,7 @@ All V_TYPES for each S_TYPE above are required to activate the actuator for the
For more information, visit the [serial api] of MySensors. For more information, visit the [serial api] of MySensors.
### {% linkable_title Services %} ## {% linkable_title Services %}
The MySensors switch platform exposes a service to change an IR code attribute for an IR switch device and turn the switch on. The IR switch will automatically be turned off after being turned on, if `optimistic` is set to `true` in the [config](/components/mysensors/#configuration) for the MySensors component. This will simulate a push button on a remote. If `optimistic` is `false`, the MySensors device will have to report its updated state to reset the switch. See the [example sketch](#ir-switch-sketch) for the IR switch below. The MySensors switch platform exposes a service to change an IR code attribute for an IR switch device and turn the switch on. The IR switch will automatically be turned off after being turned on, if `optimistic` is set to `true` in the [config](/components/mysensors/#configuration) for the MySensors component. This will simulate a push button on a remote. If `optimistic` is `false`, the MySensors device will have to report its updated state to reset the switch. See the [example sketch](#ir-switch-sketch) for the IR switch below.
@ -63,7 +65,7 @@ The service can be used as part of an automation script. For example:
```yaml ```yaml
# Example configuration.yaml automation entry # Example configuration.yaml automation entry
automation: automation:
- alias: turn hvac on - alias: Turn HVAC on
trigger: trigger:
platform: time platform: time
at: '5:30:00' at: '5:30:00'
@ -73,7 +75,7 @@ automation:
data: data:
V_IR_SEND: '0xC284' # the IR code to send V_IR_SEND: '0xC284' # the IR code to send
- alias: turn hvac off - alias: Turn HVAC off
trigger: trigger:
platform: time platform: time
at: '0:30:00' at: '0:30:00'
@ -84,9 +86,10 @@ automation:
V_IR_SEND: '0xC288' # the IR code to send V_IR_SEND: '0xC288' # the IR code to send
``` ```
### {% linkable_title Example sketches %} ## {% linkable_title Example sketches %}
### {% linkable_title Switch sketch %}
#### {% linkable_title Switch sketch %}
```cpp ```cpp
/* /*
* Documentation: http://www.mysensors.org * Documentation: http://www.mysensors.org
@ -131,7 +134,8 @@ void incomingMessage(const MyMessage &message)
} }
``` ```
#### {% linkable_title IR switch sketch %} ### {% linkable_title IR switch sketch %}
```cpp ```cpp
/* /*
* Documentation: http://www.mysensors.org * Documentation: http://www.mysensors.org

7
source/_components/switch.mystrom.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.9
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches. The built-in sensor is measuring the power consumption while the switch is on. The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches. The built-in sensor is measuring the power consumption while the switch is on.
## {% linkable_title Setup %} ## {% linkable_title Setup %}
@ -24,7 +23,6 @@ Make sure that you have enabled the REST API under **Advanced** in the web front
<img src='{{site_root}}/images/components/mystrom/mystrom-advanced.png' /> <img src='{{site_root}}/images/components/mystrom/mystrom-advanced.png' />
</p> </p>
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
To use your myStrom switch in your installation, add the following to your `configuration.yaml` file: To use your myStrom switch in your installation, add the following to your `configuration.yaml` file:
@ -61,10 +59,10 @@ $ curl -X GET -H "Content-Type: application/json" http://IP_ADDRESS/report
or change its state: or change its state:
```bash ```bash
$ curl -G -X GET http://IP_ADDRESS/relay -d 'state=1' curl -G -X GET http://IP_ADDRESS/relay -d 'state=1'
``` ```
### {% linkable_title Get the current power consumption %} ## {% linkable_title Get the current power consumption %}
The switch is measuring the current power consumption. To expose this as a sensor use a [`template` sensor](/components/sensor.template/). The switch is measuring the current power consumption. To expose this as a sensor use a [`template` sensor](/components/sensor.template/).
@ -80,4 +78,3 @@ sensor:
value_template: "{{ states.switch.office.attributes.current_power_w }}" value_template: "{{ states.switch.office.attributes.current_power_w }}"
``` ```
{% endraw %} {% endraw %}

6
source/_components/switch.pencom.markdown
View File

@ -13,11 +13,11 @@ ha_release: 0.85
ha_iot_class: "Local Polling" ha_iot_class: "Local Polling"
--- ---
[Pencom Design](http://www.pencomdesign.com/) is a manufacturer of computer controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards/) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read. [Pencom Design](http://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards/) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
The Pencom relays can be daisychained to allow for up to 8 boards. The Pencom relays can be daisy-chained to allow for up to 8 boards.
``` yaml ``` yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -46,7 +46,7 @@ port:
required: true required: true
type: port (positive integer between 1-65535) type: port (positive integer between 1-65535)
boards: boards:
description: Number of boards daisychained together (default is 1). description: Number of boards daisy-chained together (default is 1).
required: false required: false
type: int between 1 and 8 type: int between 1 and 8
relays: relays:

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

@ -13,7 +13,6 @@ ha_iot_class: "Local Push"
ha_release: "0.20" ha_release: "0.20"
--- ---
The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant. The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant.
If the device name in the QS Mobile application ends with `Switch` it will be created as a switch, otherwise as a [light](/components/light.qwikswitch/). If the device name in the QS Mobile application ends with `Switch` it will be created as a switch, otherwise as a [light](/components/light.qwikswitch/).