Minimizing of the configuration sample (#1020)

This commit is contained in:
Fabian Affolter 2016-10-01 12:09:08 +02:00 committed by GitHub
parent c7aaf72bbc
commit 227d5a3f4f
24 changed files with 69 additions and 56 deletions

View File

@ -19,8 +19,6 @@ To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
apcupsd:
host: IP_ADDRESS
port: PORT
```
Configuration variables:

View File

@ -10,6 +10,8 @@ footer: true
logo: ecobee.png
ha_category: Hub
featured: true
ha_release: 0.9
ha_iot_class: "Cloud Push"
---
@ -48,7 +50,6 @@ To set it up, add the following information to your `configuration.yaml` file:
# Example configuration.yaml entry
ecobee:
api_key: asdfghjklqwertyuiopzxcvbnm
hold_temp: True
```
Configuration variables:

View File

@ -26,14 +26,6 @@ To enable the emulated Hue bridge, add the following to your `configuration.yaml
```yaml
# Example configuration.yaml entry
emulated_hue:
host_ip: 192.168.1.186
listen_port: 8300
off_maps_to_on_domains:
- script
- scene
expose_by_default: true
exposed_domains:
- light
```
Configuration variables:
@ -58,6 +50,21 @@ Configuration variables:
- `input_boolean`
- `media_player`
A full configuration sample looks like the one below.
```yaml
# Example configuration.yaml entry
emulated_hue:
host_ip: 192.168.1.186
listen_port: 8300
off_maps_to_on_domains:
- script
- scene
expose_by_default: true
exposed_domains:
- light
```
With additional customization you will be able to specify the behaviour of the existing entities.
```yaml

View File

@ -21,14 +21,12 @@ To set it up, add the following information to your `configuration.yaml` file:
```yaml
ffmpeg:
ffmpeg_bin: /usr/bin/ffmpeg
run_test: True
```
Configuration variables:
- **ffmpeg_bin** (*Optional*): Default 'ffmpeg'. Set the ffmpeg binary.
- **run_test** (*Optional*): Default True. Check if `input` is usable by ffmpeg.
- **ffmpeg_bin** (*Optional*): Set the ffmpeg binary (eg. `/usr/bin/ffmpeg`). Default 'ffmpeg'.
- **run_test** (*Optional*): Check if `input` is usable by ffmpeg. Default True.
### {% linkable_title Troubleshooting %}

View File

@ -34,9 +34,6 @@ To set up the component, add the following information to your `configuration.ya
```yaml
homematic:
local_ip: 127.0.0.1
local_port: 8943
remote_ip: 127.0.0.1
remote_port: 2001
```
Configuration variables:

View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: insteon.png
ha_category: Hub
ha_iot_class: "Cloud Polling"
---
The `insteon` component lets you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant.

View File

@ -10,6 +10,7 @@ footer: true
logo: universal_devices.png
ha_category: Hub
ha_release: 0.28
ha_iot_class: "Local Push"
---
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices.
@ -27,16 +28,12 @@ isy994:
host: ISY_ADDRESS
username: ISY_USERNAME
password: ISY_PASSWORD
sensor_string: SENSOR_STRING
hidden_string: HIDDEN_STRING
tls: TLS_VERSION
```
Configuration variables:
- **host** (*Required*): The host entry should be in full URL format, eg. http://192.168.10.100:80
- **username** (*Required*): The username that used to access the ISY interface.
- **password** (*Required*): The password that used to access the ISY interface.
- **sensor_string** (*Optional*): This is the string that is used to identify which devices are to be assumed to be sensors instead of lights of switches. By default, this string is 'sensor'. If this string is found in the device name or folder, Home Assistant will assume it is as a sensor or binary sensor (if the device has on/off or true/false states).
- **hidden_string** (*Optional*): The HIDDEN_STRING is a string that is used to identify which devices are to be hidden on Home Assistant's front page. This string will be stripped from the device's name before being used. By default, this value is '{HIDE ME}'.
- **tls** (*Optional*): This entry should refelct the version of TLS that the ISY controller is using for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not set, it is assumed to be version 1.1. This is the default for most users. ISY994 Pro users may likely be using 1.2. When using HTTPS in the host entry, it is best practice to set this value.

View File

@ -13,9 +13,9 @@ ha_release: "0.24"
---
The Join platform exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the the component allows us to access the other special features that Join offers.
The Join platform exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the the component allows us to access the other special features that Join offers.
In the configuartion.yaml you need to provide the device id of the target device. If you want to send to a group of devices, you need to provide an api key. You can find you device id and api key [here](https://joinjoaomgcd.appspot.com/).
In the `configuration.yaml` file you need to provide the device id of the target device. If you want to send to a group of devices, you need to provide an api key. You can find you device id and api key [here](https://joinjoaomgcd.appspot.com/).
To set it up, add the following information to your `configuration.yaml` file:
@ -32,7 +32,12 @@ joaoapps_join:
api_key: asd97823jb628a34fwsdfwefd5384345tf2d
```
The notify service has a few optional parameters such as icon and smallicon. You can use them like so:
Configuration variables:
- **device_id** (*Required*): The Id of your device.
- **api_key** (*Required*): The API key for Join.
The notify service has a few optional parameters such as icon and small icon. You can use them like so:
```json
{"message":"Hello!","title":"From Hass","data":{"icon":"https://goo.gl/KVqcYi","smallicon":"http://goo.gl/AU4Wf1"}}

View File

@ -10,6 +10,7 @@ footer: true
logo: modbus.png
ha_category: Hub
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---

View File

@ -61,6 +61,11 @@ Home Assistant contains an embedded MQTT broker. If no broker configuration is g
| Password | Your API [password](/components/http/)
| Websocket port | 8080
```yaml
# Example configuration.yaml entry
mqtt:
```
<p class='note'>
This broker does not currently work with OwnTracks because of a protocol version issue.
</p>

View File

@ -10,6 +10,7 @@ footer: true
logo: mysensors.png
ha_category: Hub
featured: true
ha_iot_class: "Local Polling"
---
The [MySensors](https://www.mysensors.org) project combines Arduino boards with NRF24L01 radio boards to build sensor networks. The component will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done.

View File

@ -12,7 +12,7 @@ ha_category: Hub
featured: true
---
The Nest component is the main component to integrate all Nest related platforms. Besides this component you will have to setup your thermostat and any connected sensors separately.
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. Besides this component you will have to setup your thermostat and any connected sensors separately.
```yaml
# Example configuration.yaml entry

View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: netatmo.png
ha_category: Hub
ha_release: "0.2x"
ha_release: "0.20"
---

View File

@ -10,7 +10,7 @@ footer: true
logo: nuimo.png
ha_category: Hub
ha_release: 0.29
ha_iot_class: "Local Poll"
ha_iot_class: "Local Polling"
---
The `nuimo_controller` component allows you to connect to a [Nuimo](http://www.senic.com/) device for receiving input events and displaying on the LED matrix via the [Nuimo SDK for Python on Linux](https://github.com/getSenic/nuimo-linux-python).
@ -18,9 +18,8 @@ The `nuimo_controller` component allows you to connect to a [Nuimo](http://www.s
To connect to a Nuimo device add the following section to your `configuration.yaml` file:
```yaml
nuimo_controller:
mac: 'CE:B5:12:25:21:89'
name:
# Example configuration.yaml entry
nuimo_controller:
```
Configuration variables:

View File

@ -11,6 +11,7 @@ logo: octoprint.png
ha_category: Hub
featured: false
ha_release: 0.19
ha_iot_class: "Local Polling"
---
[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors, you will have to setup sensors and binary sensors separately.

View File

@ -10,7 +10,7 @@ footer: true
logo: pilight.png
ha_category: Hub
ha_release: 0.26
ha_iot_class: Local Push
ha_iot_class: "Local Push"
---
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://wiki.pilight.org/doku.php/protocols) are already available.
@ -26,12 +26,6 @@ To integrate pilight into Home Assistant, add the following section to your `con
pilight:
host: 127.0.0.1
port: 5000
whitelist: # optional
protocol:
- daycom
- intertechno
id:
- 42
```
Configuration variables:
@ -42,6 +36,21 @@ Configuration variables:
In this example only received RF codes using a daycom or intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://www.pilight.org/development/api/).
A full configuration sample could look like the sample below:
```yaml
# Example configuration.yaml entry
pilight:
host: 127.0.0.1
port: 5000
whitelist: # optional
protocol:
- daycom
- intertechno
id:
- 42
```
## {% linkable_title Troubleshooting %}
- A list of tested RF transceiver hardware is available [here](https://wiki.pilight.org/doku.php/electronics). This might be usefull before buying.

View File

@ -25,7 +25,7 @@ Example configuration:
```yaml
# Example configuration.yaml entry
qwikswitch:
url: 'http://127.0.0.1:2020'
url: http://127.0.0.1:2020
```
Configuration variables:

View File

@ -20,8 +20,6 @@ To enable RFXtrx in your installation, add the following to your `configuration.
# Example configuration.yaml entry
rfxtrx:
device: PATH_TO_DEVICE
debug: True
dummy: False
```
Configuration variables:

View File

@ -26,7 +26,7 @@ Configuration variables:
- **device** (*Required*): The path to your device, e.g. `/dev/ttyACM0`
### How to find the scs_id for your devices
### {% linkable_title How to find the scs_id for your devices %}
The SCSGate component relies on the [scsgate](https://github.com/flavio/scsgate) python module.

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: sleepiq
logo: sleepiq.png
ha_category: Hub
ha_release: 0.29
ha_iot_class: "Local Polling"

View File

@ -19,10 +19,9 @@ To get started, add the devices to your `configuration.yaml` file.
```yaml
# Example configuration.yaml entry
tellstick:
signal_repetitions: X
```
Configuration variables:
- **signal_repetitions** *Optional*: Because the tellstick 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 and light to try to send each signal repeatedly.
- **signal_repetitions** (*Optional*): Because the tellstick 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 and light to try to send each signal repeatedly.

View File

@ -22,15 +22,19 @@ vera:
vera_controller_url: http://192.168.1.161:3480/
```
Configuration variables:
- **vera_controller_url** (*Required*): The URL for your Vera device.
<p class='note'>
It is recommended to assign a static IP address to your Vera Controller. This ensures that it won't change IP addresses, so you won't have to change the `vera_controller_url` if it reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Vera, check the label on the bottom.
</p>
By default your switches will be added to HA as switches, however if some of them are light switches, you can tell HA this using the optional ```lights``` parameter as shown below.
By default your switches will be added to Home Assistant as switches, however if some of them are light switches, you can tell Home Assistant this using the optional `lights` parameter as shown below.
Vera imports detailed zwave devices into HA - this can include system devices and other devices that you don't use, you can tell HA not to load these devices using the ```exclude:``` parameter as shown below.
Vera imports detailed zwave devices into Home Assistant. This can include system devices and other devices that you don't use, you can tell Home Assistant not to load these devices using the `exclude:` parameter as shown below.
You can find the vera device id either by looking at your vera controller - or by checking the ```Vera Device Id``` attribute on each device imported into HA.
You can find the vera device id either by looking at your vera controller or by checking the `Vera Device Id` attribute on each device imported into Home Assistant.
```yaml
vera:

View File

@ -29,13 +29,6 @@ To integrate Verisure with Home Assistant, add the following section to your `co
verisure:
username: USERNAME
password: PASSWORD
alarm: 1
hygrometers: 0
smartplugs: 1
thermometers: 0
locks: 0
mouse: 1
code_digits: 4
```
Configuration variables:

View File

@ -21,7 +21,6 @@ weblink:
entities:
- name: Router
url: http://192.168.1.1/
icon: mdi:router-wireless
- name: Home Assistant
url: https://home-assistant.io
```