Initial release v0.2.0

2026-08-21 12:38:20 +02:00
commit d6a4b4c27e
5 changed files with 315 additions and 0 deletions
@@ -0,0 +1,87 @@
+# AWTRIX NG Internet Monitor
+
+Native AWTRIX NG script that monitors Internet connectivity and displays the current public IPv4 address directly on the device.
+
+No Home Assistant, Node-RED, MQTT, ioBroker or API key is required.
+
+## Features
+- Public IPv4 display
+- ONLINE / OFFLINE status
+- Animated HSV rainbow effect for the public IP
+- Two complete IP scroll passes
+- Primary IP service plus AWS fallback
+- Hardened offline detection
+- Faster retry interval after failed checks
+- Last known public IPv4 stored locally
+- Configurable timings, scroll speed and colors
+- No API key required
+
+## Display sequence
+
+Online:
+
+```text
+MY IP
+  ↓
+✓ ONLINE
+  ↓
+Public IPv4 with animated rainbow effect
+(two complete scroll passes)
+```
+
+Offline:
+
+```text
+MY IP
+  ↓
+✕ OFFLINE
+```
+
+## Reliability
+A single failed HTTP request does not immediately mean the Internet connection is offline. Each failed check cycle tries both services. By default, three consecutive failed cycles are required before `OFFLINE` is shown. After a failed cycle, the script retries after 15 seconds. Any successful check immediately resets the failure counter.
+
+## Configuration
+
+| Setting | Default | Description |
+|---|---:|---|
+| `refresh` | 60 s | Normal check interval |
+| `retry_seconds` | 15 s | Retry interval after a failed cycle |
+| `fail_threshold` | 3 | Failed cycles required before OFFLINE |
+| `intro_seconds` | 3 s | Duration of `MY IP` |
+| `view_seconds` | 3 s | Duration of ONLINE/OFFLINE |
+| `scroll_speed` | 100 % | Public IP scroll speed |
+| `online_color` | `#00FF00` | ONLINE color |
+| `offline_color` | `#FF0000` | OFFLINE color |
+| `info_color` | `#FFFFFF` | Neutral information color |
+
+## Public IP services
+1. `https://api.ipify.org`
+2. `https://checkip.global.api.aws/` as fallback
+
+## Privacy
+The external IP-check services necessarily receive the public source IP address of the request. The script does not intentionally transmit additional personal data.
+
+## Requirements
+- AWTRIX NG
+- Internet access from the device
+- IPv4 connectivity
+
+## IPv6
+Version 0.2.0 supports public IPv4 only.
+
+## Installation
+1. Open the AWTRIX NG web interface.
+2. Go to **Scripts**.
+3. Create a script named `InternetMonitor`.
+4. Paste `InternetMonitor.ax`.
+5. Save it.
+6. Configure it under **Apps → InternetMonitor → Settings** if required.
+
+## Version
+**0.2.0**
+
+## Author
+Spectral
+
+## License
+MIT