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-22 00:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minimizing of the configuration sample (#1047)

Browse Source
This commit is contained in:
Fabian Affolter 2016-10-02 17:14:23 +02:00 committed by GitHub
parent dfb2c94112
commit a2776110aa
24 changed files with 104 additions and 157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,11 +21,8 @@ To use your Acer Projector in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: acer_projector - platform: acer_projector
filename: /dev/ttyUSB0 filename: /dev/ttyUSB0
name: Projector
timeout: 1
write_timeout: 1
``` ```
Configuration variables: Configuration variables:

31
source/_components/switch.arest.markdown
View File

@ -20,14 +20,13 @@ To use your aREST enabled device with pins in your installation, add the followi
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: arest - platform: arest
resource: http://IP_ADDRESS resource: http://IP_ADDRESS
name: Office pins:
pins: 11:
11: name: Fan
name: Fan 12:
12: name: Light Desk
name: Light Desk
``` ```
If you want to use custom functions, then add the following to your `configuration.yaml` file: If you want to use custom functions, then add the following to your `configuration.yaml` file:
@ -35,14 +34,14 @@ If you want to use custom functions, then add the following to your `configurati
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: arest - platform: arest
resource: http://IP_ADDRESS resource: http://IP_ADDRESS
name: Office name: Office
functions: functions:
function1: function1:
name: name:
function2: function2:
name: Light Desk name: Light Desk
``` ```
Configuration variables: Configuration variables:

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

@ -26,9 +26,6 @@ switch:
kitchen_light: kitchen_light:
command_on: switch_command on kitchen command_on: switch_command on kitchen
command_off: switch_command off kitchen command_off: switch_command off kitchen
command_state: query_command kitchen
value_template: '{% raw %}{{ value == "online" }}{% endraw %}'
friendly_name: Kitchen switch
``` ```
Configuration variables: Configuration variables:
@ -57,6 +54,9 @@ switch:
arest_pin4: arest_pin4:
command_on: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/1" command_on: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/1"
command_off: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/0" command_off: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/0"
command_state: "/usr/bin/curl -X GET http://192.168.1.10/digital/4"
value_template: '{% raw %}{{ return_value == "1" }}{% endraw %}'
friendly_name: aREST Pin 4
``` ```
### {% linkable_title Shutdown your local host %} ### {% linkable_title Shutdown your local host %}

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

@ -28,10 +28,8 @@ To use your D-Link smart plugs in your installation, add the following to your `
switch: switch:
platform: dlink platform: dlink
host: IP_ADRRESS host: IP_ADRRESS
name: D-Link plug
username: YOUR_USERNAME username: YOUR_USERNAME
password: YOUR_PASSWORD password: YOUR_PASSWORD
use_legacy_protocol: False
``` ```
Configuration variables: Configuration variables:

13
source/_components/switch.edimax.markdown
View File

@ -20,17 +20,14 @@ To use your Edimax switch in your installation, add the following to your `confi
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: edimax - platform: edimax
host: 192.168.1.32 host: 192.168.1.32
username: YOUR_USERNAME
password: YOUR_PASSWORD
name: Edimax Smart Plug
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your Edimax switch, eg. 192.168.1.32 - **host** (*Required*): The IP address of your Edimax switch, eg. `192.168.1.32`.
- **username** (*Optional*): Your username for the Edimax switch. Defaults to "admin". - **username** (*Optional*): Your username for the Edimax switch. Defaults to `admin`.
- **password** (*Optional*): Your password for the Edimax switch. Defaults to "1234". - **password** (*Optional*): Your password for the Edimax switch. Defaults to `1234`.
- **name** (*Optional*): The name to use when displaying this switch. - **name** (*Optional*): The name to use when displaying this switch.

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

@ -21,7 +21,6 @@ To use your EnOcean device, you first have to set up your [EnOcean hub](/compone
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
- platform: enocean - platform: enocean
name: Front door
id: [0x01,0x90,0x84,0x3C] id: [0x01,0x90,0x84,0x3C]
``` ```

14
source/_components/switch.hikvision.markdown
View File

@ -24,18 +24,14 @@ To use your Hikvision cam in your installation, add the following to your `confi
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: hikvisioncam - platform: hikvisioncam
host: 192.168.1.32 host: 192.168.1.32
port: 80
name: Hikvision Cam 1 Motion Detection
username: USERNAME
password: PASSWORD
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your Hikvision camera, eg. 192.168.1.32 - **host** (*Required*): The IP address of your Hikvision camera, eg. `192.168.1.32`.
- **port** (*Optional*): The port to connec to your Hikvision camera. Defaults to 80. - **port** (*Optional*): The port to connec to your Hikvision camera. Defaults to `80`.
- **name** (*Optional*): This parameter allows you to override the name of your camera. - **name** (*Optional*): This parameter allows you to override the name of your camera.
- **username** (*Optional*): The username for accessing your Hikvision camera. Defaults to "admin". - **username** (*Optional*): The username for accessing your Hikvision camera. Defaults to `admin`.
- **password** (*Optional*): The password to access your Hikvision camera. Defaults to "12345". - **password** (*Optional*): The password to access your Hikvision camera. Defaults to `12345`.

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

@ -19,13 +19,10 @@ To add this platform to your installation, add the following to your `configurat
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: mfi - platform: mfi
host: IP_ADDRESS host: IP_ADDRESS
port: PORT username: USERNAME
username: USERNAME password: PASSWORD
password: PASSWORD
ssl: true
verify_ssl: true
``` ```
Configuration variables: Configuration variables:

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

@ -26,16 +26,8 @@ To enable this switch in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yml entry # Example configuration.yml entry
switch: switch:
platform: mqtt - platform: mqtt
name: "Bedroom Switch" command_topic: "home/bedroom/switch1/set"
state_topic: "home/bedroom/switch1"
command_topic: "home/bedroom/switch1/set"
payload_on: "ON"
payload_off: "OFF"
optimistic: false
qos: 0
retain: true
value_template: '{% raw %}{{ value.x }}{% endraw %}'
``` ```
Configuration variables: Configuration variables:
@ -53,3 +45,31 @@ Configuration variables:
<p class='note warning'> <p class='note warning'>
Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics. Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics.
</p> </p>
## {% linkable_title Examples %}
In this section you find some real life examples of how to use this sensor.
### {% linkable_title Full configuration %}
The example below shows a full configuration for a switch.
```yaml
# Example configuration.yml entry
switch:
- platform: mqtt
name: "Bedroom Switch"
state_topic: "home/bedroom/switch1"
command_topic: "home/bedroom/switch1/set"
payload_on: "ON"
payload_off: "OFF"
optimistic: false
qos: 0
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 cover manually:
```bash
$ mosquitto_pub -h 127.0.0.1 -t home/bedroom/switch1set -m "ON"
```

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

@ -10,6 +10,7 @@ footer: true
logo: mysensors.png logo: mysensors.png
ha_category: Switch ha_category: Switch
featured: false featured: false
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.

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

@ -19,14 +19,13 @@ To use your myStrom switch in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: mystrom - platform: mystrom
host: IP_ADRRESS host: IP_ADRRESS
name: MyStrom Switch
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your myStrom switch, eg. http://192.168.1.32 - **host** (*Required*): The IP address of your myStrom switch, eg. `http://192.168.1.32`.
- **name** (*Optional*): The name to use when displaying this switch. - **name** (*Optional*): The name to use when displaying this switch.
Check if you are able to access the device located at `http://IP_ADRRESS`. The details about your switch is provided as a JSON response. Check if you are able to access the device located at `http://IP_ADRRESS`. The details about your switch is provided as a JSON response.

53
source/_components/switch.netio.markdown
View File

@ -23,9 +23,8 @@ To use Netio devices in your installation, add the following to your `configurat
switch: switch:
- platform: netio - platform: netio
host: 192.168.1.43 host: 192.168.1.43
port: 1234 username: YOUR_USERNAME
username: user password: YOUR_PASSWORD
password: pwd
outlets: outlets:
1: Free 1: Free
2: TV 2: TV
@ -34,17 +33,14 @@ switch:
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your Netio plug, eg. http://192.168.1.32 - **host** (*Required*): The IP address of your Netio plug, eg. `http://192.168.1.32`.
- **port** (*Optional*): The port to communicate with the switch. Defaults to `1234`. - **port** (*Optional*): The port to communicate with the switch. Defaults to `1234`.
- **username** (*Required*): The username for your plug. - **username** (*Required*): The username for your plug.
- **password** (*Required*): The password for your plug. - **password** (*Required*): The password for your plug.
- **outlets** (*Required*) array: List of all outlets. - **outlets** (*Required*) array: List of all outlets.
- **[No.]: [Name]** (*Required*): Identification of an outlet. - **[No.]: [Name]** (*Required*): Identification of an outlet.
To get pushed updates from the Netio devices, one can add this Lua code in the device interface as an action triggered on "Netio" "System variables updated" with an 'Always' schedule:
To get pushed updates from the Netio devices, one can add this Lua code in the device interface as an action triggered on "Netio" "System variables updated"
with an 'Always' schedule:
```lua ```lua
@ -69,44 +65,3 @@ local url = string.format('http://%s%s?%s', address, path, qs)
devices.system.CustomCGI{url=url} devices.system.CustomCGI{url=url}
``` ```
The `dlink` switch platform allows you to control the state of your [D-Link Wi-Fi Smart Plugs](http://us.dlink.com/product-category/home-solutions/connected-home/smart-plugs/).
Supported devices (tested):
- DSP-W215
- DSP-W110
To use your D-Link smart plugs in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
platform: dlink
host: IP_ADRRESS
name: D-Link plug
username: YOUR_USERNAME
password: YOUR_PASSWORD
```

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

@ -16,27 +16,29 @@ The `orvibo` switch platform allows you to toggle your Orvibo S20 Wifi Smart Soc
To automatically discover Orvibo sockets on your network: To automatically discover Orvibo sockets on your network:
```yaml ```yaml
# Example configuration.yaml entry
switch: switch:
platform: orvibo - platform: orvibo
``` ```
To specify Orvibo sockets and skip discovery: To specify Orvibo sockets and skip discovery:
```yaml ```yaml
# Example configuration.yaml entry
switch: switch:
platform: orvibo - platform: orvibo
discovery: false discovery: false
switches: switches:
- host: IP_ADDRESS - host: IP_ADDRESS
mac: MA:CA:DD:RE:SS:00 mac: MA:CA:DD:RE:SS:00
name: "My Socket" name: "My Socket"
``` ```
Configuration variables: Configuration variables:
- **discovery** (*Optional*): Whether to discover sockets (default true). - **discovery** (*Optional*): Whether to discover sockets. Defaults to `true`.
- **switches** (*Optional*): - **switches** (*Optional*):
- **host** (*Required*): IP address of your socket, eg. 192.168.1.10. - **host** (*Required*): IP address of your socket, eg. `192.168.1.10`.
- **mac** (*Optional*): MAC address of the socket, eg "AA:BB:CC:DD:EE:FF". This is required if the socket is connected to a different subnet to the machine running Home Assistant - **mac** (*Optional*): MAC address of the socket, eg "AA:BB:CC:DD:EE:FF". This is required if the socket is connected to a different subnet to the machine running Home Assistant.
- **name** (*Optional*): Your name for the socket. - **name** (*Optional*): Your name for the socket.

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

@ -28,11 +28,6 @@ To enable this switch, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
- platform: pulseaudio_loopback - platform: pulseaudio_loopback
name: mpd1 -> bedroom
host: 127.0.0.1
port: 4712
source_name: mpd1.monitor
sink_name: bedroom
``` ```
Configuration variables: Configuration variables:

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

@ -19,11 +19,8 @@ To enable this switch, add the following lines to your `configuration.yaml` file
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: rest - platform: rest
resource: http://IP_ADDRESS/ENDPOINT resource: http://IP_ADDRESS/ENDPOINT
name: "Bedroom Switch"
body_on: "ON"
body_off: "OFF"
``` ```
Configuration variables: Configuration variables:

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

@ -18,6 +18,7 @@ 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`:
```yaml ```yaml
# Example configuration.yaml entry
switch: switch:
platform: rfxtrx platform: rfxtrx
automatic_add: True automatic_add: True
@ -34,6 +35,7 @@ Here the name is `0b11000102ef9f210010f70` and you can verify that it works from
Then you should update your configuration to: Then you should update your configuration to:
```yaml ```yaml
# Example configuration.yaml entry
switch: switch:
platform: rfxtrx platform: rfxtrx
devices: devices:

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

@ -20,11 +20,10 @@ To use your Raspberry Pi's GPIO in your installation, add the following to your
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: rpi_gpio - platform: rpi_gpio
ports: ports:
11: Fan Office 11: Fan Office
12: Light Desk 12: Light Desk
invert_logic: false
``` ```
Configuration variables: Configuration variables:

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

@ -19,11 +19,10 @@ To enable SCSGate switches in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: scsgate - platform: scsgate
devices: devices:
living_room: living_room:
name: Living Room scs_id: XXXXX
scs_id: XXXXX
``` ```
Configuration variables: Configuration variables:

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

@ -12,6 +12,5 @@ ha_category: Switch
featured: false featured: false
--- ---
Integrates Telldus Live switches into Home Assistant. See the [main component] for configuration instructions. Integrates Telldus Live switches into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.
[main component]: /components/tellduslive/

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

@ -20,5 +20,5 @@ To use your TellStick device, you first have to set up your [Tellstick hub](http
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: tellstick - platform: tellstick
``` ```

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

@ -27,7 +27,6 @@ switch:
- platform: template - platform: template
switches: switches:
skylight: skylight:
friendly_name: 'Skylight'
value_template: {% raw %}'{{ is_state('sensor.skylight', 'on') }}'{% endraw %} value_template: {% raw %}'{{ is_state('sensor.skylight', 'on') }}'{% endraw %}
turn_on: turn_on:
service: switch.turn_on service: switch.turn_on

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

@ -20,7 +20,7 @@ To enable this switch in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: thinkingcleaner - platform: thinkingcleaner
``` ```
This will automatically add switches for each Thinking Cleaner in your network. This will automatically add switches for each Thinking Cleaner in your network.

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

@ -24,14 +24,13 @@ To use your TPLink switch in your installation, add the following to your `confi
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
switch: switch:
platform: tplink - platform: tplink
host: IP_ADRRESS host: IP_ADRRESS
name: TP-Link Switch
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your myStrom switch, eg. http://192.168.1.32 - **host** (*Required*): The IP address of your myStrom switch, eg. `http://192.168.1.32`.
- **name** (*Optional*): The name to use when displaying this switch. - **name** (*Optional*): The name to use when displaying this switch.

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

@ -23,10 +23,8 @@ To enable this switch in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yml entry # Example configuration.yml entry
switch: switch:
platform: wake_on_lan - platform: wake_on_lan
mac_address: "00-01-02-03-04-05" mac_address: "00-01-02-03-04-05"
name: "WOL"
host: "192.168.1.1"
``` ```
Configuration variables: Configuration variables: