docs: Added Internet Connection Status description#6171
docs: Added Internet Connection Status description#6171sfiorani merged 1 commit intodocs-developfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the gateway configuration documentation to describe the “Internet connection status” field shown on the Device Profile page, and refreshes the related screenshot to match the UI.
Changes:
- Added documentation describing how “Internet connection status” is computed and what each status value means.
- Updated the Device Profile screenshot used in the documentation.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/gateway-configuration/images/device-profile.png | Updated screenshot to reflect the “Internet connection status” field in the UI. |
| docs/gateway-configuration/device-information.md | Added a new “Internet connection status” description and status definitions under the Profile section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
|  | ||
|
|
||
| **Internet connection status**: Displays the status of the internet connection. This is updated every 30 seconds through an ICMP request to a configured IP address and host. By default, these are 198.41.30.198 and eclipse.org. The IP address can be in IPv4 or IPv6 format. |
There was a problem hiding this comment.
Line ends with trailing whitespace. In Markdown this is easy to miss in reviews and can cause unintended formatting (e.g., hard line breaks if it becomes two spaces). Please remove the trailing space at the end of the sentence.
| **Internet connection status**: Displays the status of the internet connection. This is updated every 30 seconds through an ICMP request to a configured IP address and host. By default, these are 198.41.30.198 and eclipse.org. The IP address can be in IPv4 or IPv6 format. | |
| **Internet connection status**: Displays the status of the internet connection. This is updated every 30 seconds through an ICMP request to a configured IP address and host. By default, these are 198.41.30.198 and eclipse.org. The IP address can be in IPv4 or IPv6 format. |
| **Internet connection status**: Displays the status of the internet connection. This is updated every 30 seconds through an ICMP request to a configured IP address and host. By default, these are 198.41.30.198 and eclipse.org. The IP address can be in IPv4 or IPv6 format. | ||
|
|
||
| The status can be: | ||
| - `FULL`: The internet connection is fully available. | ||
| - `IP_ONLY`: The system can ping the configured address, but cannot resolve the host name. | ||
| - `UNAVAILABLE`: The internet connection is unavailable. |
There was a problem hiding this comment.
The description is ambiguous about what the ICMP check does: an ICMP echo request targets an IP or a hostname (after DNS resolution), but the text suggests a single ICMP request is made to both a configured IP and a host. Consider clarifying that the implementation pings the configured IP address and separately performs a DNS resolution/ping for the configured hostname (and that IP_ONLY corresponds to “IP ping ok, DNS/hostname resolution failed”).
| **Internet connection status**: Displays the status of the internet connection. This is updated every 30 seconds through an ICMP request to a configured IP address and host. By default, these are 198.41.30.198 and eclipse.org. The IP address can be in IPv4 or IPv6 format. | |
| The status can be: | |
| - `FULL`: The internet connection is fully available. | |
| - `IP_ONLY`: The system can ping the configured address, but cannot resolve the host name. | |
| - `UNAVAILABLE`: The internet connection is unavailable. | |
| **Internet connection status**: Displays the status of the internet connection. This is updated every 30 seconds by sending an ICMP echo request to a configured IP address and, separately, resolving and checking reachability of a configured host name. By default, these are 198.41.30.198 and eclipse.org. The IP address can be in IPv4 or IPv6 format. | |
| The status can be: | |
| - `FULL`: The internet connection is fully available (the configured IP address responds to ICMP echo requests and the configured host name can be resolved and reached). | |
| - `IP_ONLY`: The system can ping the configured IP address, but DNS resolution and/or reachability of the configured host name fails. | |
| - `UNAVAILABLE`: The internet connection is unavailable (the configured IP address does not respond to ICMP echo requests). |
| - `IP_ONLY`: The system can ping the configured address, but cannot resolve the host name. | ||
| - `UNAVAILABLE`: The internet connection is unavailable. | ||
|
|
||
|
|
There was a problem hiding this comment.
There is an extra blank line after the status list (two consecutive blank lines) before the next section header. Consider removing one to keep the spacing consistent with the rest of the document.
Added Internet Connection Status description