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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

dovado sensor configuration variable format (#6700)

Browse Source 
* Update configuration variable for dovado

Update configuration variable format.
Remove two optional configurations from the example configuration.

Section underneath configuration variable has a list of allowed values for the *sensors* array there. I am not sure how to describe this using the configuration block format. Possibly related to home-assistant/developers.home-assistant/issues/107

* Change format of accepted keys

Change format of accepted keys to pattern seen in other components.
Move additional information about the component (registering an SMS notifier) up to the top of the document.

* Minor changes
This commit is contained in:
Nicholas Westerhausen 2018-10-13 16:30:15 -04:00 committed by Fabian Affolter
parent 1599305a7b
commit 9d13c99849
1 changed files with 36 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
source/_components/sensor.dovado.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.32
ha_iot_class: "Local Polling"
---
The `dovado` platform let you monitor your router from [Dovado](http://www.dovado.com/)
The `dovado` platform let you monitor your router from [Dovado](http://www.dovado.com/). If the router provides SMS functionality, a service for sending SMS will also be registered in Home Assistant.
To add a Dovado sensor to your installation, add the following to your `configuration.yaml` file:
@ -23,23 +23,42 @@ sensor:
- platform: dovado
username: YOUR_USERNAME
password: YOUR_PASSWORD
host: IP_ADDRESS
port: PORT
sensors:
- network
```
Configuration variables:
- **username** (*Required*): Your username.
- **password** (*Required*): Your password.
- **host** (*Optional*): The IP address of your router, e.g., `192.168.1.1`. If no host is provided, the gateway for the same network as Home Assistant will automatically be used.
- **port** (*Optional*): The port number of your router, e.g., `999`. If no port is provided, the default API port (6435) will be used.
- **sensors** array (*Required*): Conditions to display in the frontend.
- **network**: Network state (3G, 4G, etc).
- **signal**: The signal strength (%).
- **download**: The download speed.
- **upload**: The upload speed.
- **sms**: Number of unread text messages
If the router provides SMS functionality, a service for sending SMS will also be registered in Home Assistant.
{% configuration %}
username:
description: Your Dovado username.
required: true
type: string
password:
description: Your Dovado password.
required: true
type: string
host:
description: The IP address of your router.
required: false
type: string
default: Home Assistant's default gateway
port:
description: The port number of your router.
required: false
type: integer
default: 6435
sensors:
description: Conditions to display in the frontend. Only accepts the values listed here.
required: true
type: list
keys:
network:
description: Creates a sensor for Network State (3G, 4G, etc.).
signal:
description: Creates a sensor for the signal strength.
download:
description: Creates a sensor for download speed.
upload:
description: Creates a sensor for download speed.
sms:
description: Creates a sensor for number of unread text messages.
{% endconfiguration %}