Update variables and add description to fix #48

This commit is contained in:
Fabian Affolter 2015-09-10 18:29:45 +02:00
parent 72136af365
commit 9c62f00180

View File

@ -19,14 +19,22 @@ To integrate MQTT into Home Assistant, add the following section to your `config
# Example configuration.yaml entry
mqtt:
broker: IP_ADDRESS_BROKER
# All the other options are optional:
port: 1883
client_id: home-assistant-1
keepalive: 60
qos: 0
username: your_username
password: your_secret_password
username: USERNAME
password: PASSWORD
```
Configuration variables:
- **broker** (*Required*): The IP address of your MQTT broker, e.g. 192.168.1.32.
- **port** (*Optional*): The network port to connect to. Default is 1883.
- **client_id** (*Optional*): Client ID that Home Assistant will use. Has to be unique on the server. Default is a random generated one.
- **keepalive** (*Optional*): The keep alive in seconds for this client. Default is 60.
- **username** (*Optional*): The username to use with your MQTT broker.
- **password** (*Optional*): The corresponding password for the username to use with your MQTT broker.
<p class='note'>
The MQTT component has no TLS support at the moment. This means that only plain-text communication is possible.
</p>