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 23:36:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding scan_interval and name to configuration documentation (#14703)

Browse Source
This commit is contained in:
scheric 2020-10-03 11:26:16 +02:00 committed by GitHub
parent 8cedd2a029
commit 43c24738ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
source/_integrations/ping.markdown
View File

@ -34,7 +34,7 @@ host:
required: true required: true
type: string type: string
count: count:
description: Number of packets to send. description: Number of packages to be sent up to a maximum of 100.
required: false required: false
type: integer type: integer
default: 5 default: 5
@ -42,7 +42,7 @@ name:
description: Let you overwrite the name of the device. description: Let you overwrite the name of the device.
required: false required: false
type: string type: string
default: Ping Binary sensor default: Binary sensor Ping [hostname]
{% endconfiguration %} {% endconfiguration %}
The sensor exposes the different round trip times values measured by `ping` as attributes: The sensor exposes the different round trip times values measured by `ping` as attributes:
@ -52,13 +52,14 @@ The sensor exposes the different round trip times values measured by `ping` as a
- `round trip time min` - `round trip time min`
- `round trip time max` - `round trip time max`
The default polling interval is 5 minutes. As many integrations [based on the entity class](/docs/configuration/platform_options), it is possible to overwrite this scan interval by specifying a `scan_interval` configuration key (value in seconds). In the example below we setup the `ping` binary sensor to poll the devices every 30 seconds. The default polling interval is 5 minutes. As many integrations [based on the entity class](/docs/configuration/platform_options), it is possible to overwrite this scan interval by specifying a `scan_interval` configuration key (value in seconds). In the example below we setup the `ping` binary sensor to poll the device every 30 seconds.
```yaml ```yaml
# Example configuration.yaml entry to ping host 192.168.0.1 with 2 packets every 30 seconds. # Example configuration.yaml entry to ping host 192.168.0.1 with 2 packets every 30 seconds.
binary_sensor: binary_sensor:
- platform: ping - platform: ping
host: 192.168.0.1 host: 192.168.0.1
name: "device name"
count: 2 count: 2
scan_interval: 30 scan_interval: 30
``` ```
@ -84,7 +85,7 @@ To use this presence detection in your installation, add the following to your `
device_tracker: device_tracker:
- platform: ping - platform: ping
hosts: hosts:
hostone: 192.168.2.10 hostname: 192.168.2.10
``` ```
{% configuration %} {% configuration %}