Update Roomba Vacuum component configuration variable (#6691)

Update style of Roomba vacuum component documentation to follow new configuration variables description.
Related to #6385.
This commit is contained in:
Klaas Schoute 2018-10-11 19:46:05 +02:00 committed by Franck Nijhof
parent 18792533e9
commit 9e7ac7bb7e

View File

@ -29,14 +29,35 @@ vacuum:
password: PASSWORD password: PASSWORD
``` ```
Configuration variables: {% configuration %}
host:
- **host** (*Required*): Hostname or IP address of the Roomba. description: Hostname or IP address of the Roomba.
- **username** (*Required*): The username (BLID) for your device. required: true
- **password** (*Required*): The password for your device. type: string
- **name** (*Optional*): The name of the vacuum. username:
- **certificate** (*Optional*): Path to your certificate store. Defaults to `/etc/ssl/certs/ca-certificates.crt`. description: The username (BLID) for your device.
- **continuous** (*Optional*): Whether to operate in continuous mode. Defaults to `True`. required: true
type: string
password:
description: The password for your device.
required: true
type: string
name:
description: The name of the vacuum.
required: false
default: Roomba
type: string
certificate:
description: Path to your certificate store.
required: false
default: /etc/ssl/certs/ca-certificates.crt
type: string
continuous:
description: Whether to operate in continuous mode.
required: false
default: true
type: boolean
{% endconfiguration %}
<p class='note'> <p class='note'>
The Roomba's MQTT server only allows a single connection. Enabling continuous mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes) The Roomba's MQTT server only allows a single connection. Enabling continuous mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes)