From 78dff1c11a1b1769496012a25887a235e5445c05 Mon Sep 17 00:00:00 2001 From: Tomoyuki Sakurai Date: Mon, 9 Aug 2021 11:05:47 +0700 Subject: [PATCH] doc: add what exactly the component does --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4098312..760da0b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # `esphome-component-ping` -A `esphome` sensor component that sends and receives `ICMP`. +A `esphome` sensor component that sends and receives `ICMP`. It implements two +sensors: `loss` and `latency`. `loss` publishes packet loss rate of an ICMP +session, and `latency` publishes arithmetic mean of latencies in an ICMP +session. ![Visualization of ICMP latency and packet loss on ESP8266](assets/esp8266.png "Visualization of ICMP latency and packet loss on ESP8266")