docs updated

This commit is contained in:
serversdwn
2025-12-04 17:24:20 -05:00
parent 73204ee92e
commit 58ba506f54
3 changed files with 68 additions and 26 deletions

View File

@@ -5,9 +5,8 @@ It scans the event folder, reads `.MLG` headers to identify unit IDs, and prints
- Last event received
- Age since last call-in
- OK / Pending / Missing states
- Bench and ignored units
- Unexpected units
- Notes from the roster file
- Detected units (no roster required)
- Optional API heartbeat to Seismograph Fleet Manager backend
This script is part of the larger **Seismograph Fleet Manager** project.
@@ -17,7 +16,6 @@ This script is part of the larger **Seismograph Fleet Manager** project.
- Python 3.8 (Windows 7 compatible)
- Blastware 10 event folder available locally
- `series3_roster.csv` in the configured path
- `config.ini` in the same directory as the script
Install dependencies with:
@@ -34,12 +32,11 @@ Run the emitter from the folder containing the script:
The script will:
1. Load the roster file
2. Scan the Blastware event folder for `.MLG` files
3. Sniff each file header for the unit ID
4. Print a status line for each active unit
5. Refresh the roster automatically if `ROSTER_URL` is set
6. Write logs into the `emitter_logs/` folder
1. Scan the Blastware event folder for `.MLG` files (within a max age window).
2. Sniff each file header for the unit ID.
3. Print a status line for each detected unit (OK / Pending / Missing).
4. Optionally POST a heartbeat payload on an interval when `API_ENABLED=true`.
5. Write logs into the `emitter_logs/` folder and auto-clean old logs.
---
@@ -49,11 +46,18 @@ All settings are stored in `config.ini`.
Key fields:
- `SERIES3_PATH` folder containing `.MLG` files
- `ROSTER_FILE` path to the local roster CSV
- `ROSTER_URL` optional URL for automatic roster downloads
- `SCAN_INTERVAL_SECONDS` how often to scan
- `OK_HOURS` / `MISSING_HOURS` thresholds for status
- `SERIES3_PATH` folder containing `.MLG` files
- `SCAN_INTERVAL_SECONDS` — how often to scan
- `OK_HOURS` / `MISSING_HOURS` — thresholds for status
- `MLG_HEADER_BYTES` how many bytes to sniff from each `.MLG` header
- `RECENT_WARN_DAYS` — log unsniffable files newer than this window
- `MAX_EVENT_AGE_DAYS` — ignore events older than this many days
- `API_ENABLED` — enable/disable heartbeat POST
- `API_URL` — heartbeat endpoint
- `API_INTERVAL_SECONDS` — heartbeat frequency
- `SOURCE_ID` / `SOURCE_TYPE` — identifiers included in the API payload
- `LOG_RETENTION_DAYS` — auto-delete logs older than this many days
- `COLORIZE` — ANSI color output (off by default for Win7)
---
@@ -68,7 +72,7 @@ Git ignores all log files but keeps the folder itself.
This repo follows **Semantic Versioning (SemVer)**.
Current release: **v1.0.0** stable baseline emitter.
Current release: **v1.2.0** — rosterless scanning with API heartbeat option.
See `CHANGELOG.md` for details.
---
@@ -76,4 +80,3 @@ See `CHANGELOG.md` for details.
## License
Private / internal project.
```