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-08 18:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use the new style for configuration variables description for ping sensor (#6527)

Browse Source 
Implement the new style for configuration variables description as requested by #6385
This commit is contained in:
Oncleben31 2018-10-05 11:36:51 +02:00 committed by Franck Nijhof
parent 7c10ab9a2a
commit 73a55b353d
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
source/_components/binary_sensor.ping.markdown
View File

@ -26,12 +26,22 @@ binary_sensor:
- platform: ping
host: 192.168.0.1
```
Configuration variables:
- **host** (*Required*): The IP address or hostname of the system you want to track.
- **count** (*Optional*): Number of packets to send. Defaults to 5.
- **name** (*Optional*): Let you overwrite the name of the device. Defaults to `Ping Binary sensor`.
{% configuration %}
host:
description: The IP address or hostname of the system you want to track.
required: true
type: string
count:
description: Number of packets to send.
required: false
type: integer
default: 5
name:
description: Let you overwrite the name of the device.
required: false
type: string
default: "`Ping Binary sensor`"
{% endconfiguration %}
The sensor exposes the different round trip times values measured by `ping` as attributes: