From 43c24738ad0437c4c6d5e65f444a1e8b17726b16 Mon Sep 17 00:00:00 2001 From: scheric <38077357+scheric@users.noreply.github.com> Date: Sat, 3 Oct 2020 11:26:16 +0200 Subject: [PATCH] Adding scan_interval and name to configuration documentation (#14703) --- source/_integrations/ping.markdown | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/_integrations/ping.markdown b/source/_integrations/ping.markdown index 245b9c15be4..78a924c5526 100644 --- a/source/_integrations/ping.markdown +++ b/source/_integrations/ping.markdown @@ -34,7 +34,7 @@ host: required: true type: string count: - description: Number of packets to send. + description: Number of packages to be sent up to a maximum of 100. required: false type: integer default: 5 @@ -42,7 +42,7 @@ name: description: Let you overwrite the name of the device. required: false type: string - default: Ping Binary sensor + default: Binary sensor Ping [hostname] {% endconfiguration %} 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 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 # Example configuration.yaml entry to ping host 192.168.0.1 with 2 packets every 30 seconds. binary_sensor: - platform: ping host: 192.168.0.1 + name: "device name" count: 2 scan_interval: 30 ``` @@ -84,7 +85,7 @@ To use this presence detection in your installation, add the following to your ` device_tracker: - platform: ping hosts: - hostone: 192.168.2.10 + hostname: 192.168.2.10 ``` {% configuration %}