diff --git a/source/_integrations/ping.markdown b/source/_integrations/ping.markdown index 0e6b2cc6c89..45dc9e4ddc4 100644 --- a/source/_integrations/ping.markdown +++ b/source/_integrations/ping.markdown @@ -13,6 +13,7 @@ ha_platforms: - binary_sensor - device_tracker ha_integration_type: integration +ha_config_flow: true ha_codeowners: - '@jpbede' --- @@ -22,35 +23,12 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Presence Detection](#presence-detection) +{% include integrations/config_flow.md %} + ## Binary Sensor The `ping` binary sensor platform allows you to use `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system. - -To use this sensor in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: ping - host: 192.168.0.1 -``` - -{% 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 be sent up to a maximum of 100. - required: false - type: integer - default: 5 -name: - description: Let you overwrite the name of the device. - required: false - type: string - default: Ping [hostname] -{% endconfiguration %} +This sensor is enabled by default. The default polling interval is 5 minutes. The sensor exposes the different round trip times in milliseconds measured by `ping` as attributes: @@ -59,18 +37,6 @@ The sensor exposes the different round trip times in milliseconds measured by `p - `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 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 -``` -