serversdown/series3-watcher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

doc: readme bummped to 1.4.1

Browse Source
This commit is contained in:
serversdwn
2026-03-17 01:23:01 -04:00
parent 504ee1d470
commit 326658ed26
1 changed files with 8 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -1,4 +1,4 @@
# Series 3 Watcher v1.4 # Series 3 Watcher v1.4.1
Monitors Instantel **Series 3 (Minimate)** call-in activity on a Blastware server. Runs as a **system tray app** that starts automatically on login, reports heartbeats to terra-view, and self-updates from Gitea. Monitors Instantel **Series 3 (Minimate)** call-in activity on a Blastware server. Runs as a **system tray app** that starts automatically on login, reports heartbeats to terra-view, and self-updates from Gitea.
@@ -23,21 +23,12 @@ Updates can also be pushed remotely from terra-view → **Settings → Developer
--- ---
## Building from Source ## Building & Releasing
Prerequisites (on a **Python 3.8** machine — required for Win7 compatibility): See [BUILDING.md](BUILDING.md) for the full step-by-step process covering:
- First-time build and installer creation
``` - Publishing a release to Gitea
pip install pystray Pillow pyinstaller - Releasing hotfix updates (auto-updater picks them up automatically)
```
Then run:
```
build.bat
```
This produces `dist\series3-watcher.exe`. To build the installer, open `installer.iss` in [Inno Setup](https://jrsoftware.org/isinfo.php) and click Build.
--- ---
@@ -62,7 +53,7 @@ All settings live in `config.ini`. The Setup Wizard covers every field, but here
| Key | Description | | Key | Description |
|-----|-------------| |-----|-------------|
| `API_ENABLED` | `true` to send heartbeats to terra-view | | `API_ENABLED` | `true` to send heartbeats to terra-view |
| `API_URL` | terra-view heartbeat endpoint, e.g. `http://192.168.1.10:8000/api/series3/heartbeat` | | `API_URL` | Terra-View base URL, e.g. `http://192.168.1.10:8000` — the `/api/series3/heartbeat` endpoint is appended automatically |
| `API_INTERVAL_SECONDS` | How often to POST (default `300`) | | `API_INTERVAL_SECONDS` | How often to POST (default `300`) |
| `SOURCE_ID` | Identifier for this machine (defaults to hostname) | | `SOURCE_ID` | Identifier for this machine (defaults to hostname) |
| `SOURCE_TYPE` | Always `series3_watcher` | | `SOURCE_TYPE` | Always `series3_watcher` |
@@ -126,7 +117,7 @@ To view connected watchers: **Settings → Developer → Watcher Manager**.
## Versioning ## Versioning
Follows **Semantic Versioning**. Current release: **v1.4.0**. Follows **Semantic Versioning**. Current release: **v1.4.1**.
See `CHANGELOG.md` for full history. See `CHANGELOG.md` for full history.
--- ---