Compare commits
73
Commits
db818f716c
..
dev
+248
@@ -4,6 +4,254 @@ All notable changes to seismo-relay are documented here.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **Waveform event times were the monitoring-session start, not the trigger
|
||||||
|
(~hours off).** `read_blastware_file` stamped events with footer `ts1`, which
|
||||||
|
for a waveform is the session start a unit shares across every event that day
|
||||||
|
(a unit arming at 06:00 stamped 06:00 on all of them — the modal and PDF both
|
||||||
|
showed it, since it's the stored value). The event time is footer `ts2` (the
|
||||||
|
recording stop), and Blastware's trigger = `ts2 - record time`. The record
|
||||||
|
time is a big-endian float32 in the recording-setup config block (30 bytes
|
||||||
|
before the `Standard Recording Setup` marker), so the **exact trigger is now
|
||||||
|
recovered from the binary alone** — all 7 BE12844 oracle events decode to
|
||||||
|
their exact Blastware time (e.g. N844LQHB 10:33:29), no paired `.TXT` needed.
|
||||||
|
Histograms keep `ts1` (the ~24 h window start). A paired report's
|
||||||
|
`event_datetime` stays authoritative (unit-clock drift).
|
||||||
|
⚠ **Needs a re-decode backfill** to correct existing stored events' timestamps.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **Diagnostics tab in the SFM standalone webapp.** Surfaces the device
|
||||||
|
endpoints that previously existed only as `curl`: `events/storage_range` and
|
||||||
|
`events/index` alongside `monitor/status`, then stop monitoring, disable ACH
|
||||||
|
(`rescue?erase=false`, so stored events survive), and erase. The wedged-unit
|
||||||
|
ladder — slow drip and blind stop — sits under its own heading pointing at
|
||||||
|
`docs/runbooks/wedged_unit_recovery.md`, with the reminder that `slow_drip`'s
|
||||||
|
success signal is `bytes_received > 0` and not a clean duration. Erase is
|
||||||
|
guarded by typing the unit's serial: auth answers *who*, not *did you mean
|
||||||
|
it*, and Swagger's try-it-out button on `/device/events/erase` is live on
|
||||||
|
`:8200/docs`.
|
||||||
|
|
||||||
|
- **`docs/sfm_tool_status.md`** — an honest per-capability maturity assessment:
|
||||||
|
what is production-grade (the codec library, the data side), what is
|
||||||
|
emergency-grade (the device side), what is a research artifact, the
|
||||||
|
known-issues table, and the gap to a real tool. Also records the **5A
|
||||||
|
page-boundary bug** as known: `parse_strt_end_offset()` discards the key's
|
||||||
|
page byte, so once a unit has recorded more than 64 KB since its last erase,
|
||||||
|
an event spanning the boundary reads an `end_offset` *behind* its own start —
|
||||||
|
the chunk loop fetches nothing and TERM packs a negative `offset_word`, which
|
||||||
|
500s. Reproduced on BE12599. Production is unaffected: it ingests complete
|
||||||
|
files via the watcher path and never runs this walk.
|
||||||
|
|
||||||
|
- **The Micromate (Series IV) live wire protocol, reverse-engineered end to
|
||||||
|
end** — `docs/micromate_protocol_reference.md`. Worked out against a bench
|
||||||
|
UM12947 over USB and a recording relay, with THOR driving every write so that
|
||||||
|
no command has ever been originated against a unit by this project. **A
|
||||||
|
Micromate answers Series III command frames**, with three framing differences:
|
||||||
|
responses carry no leading `DLE`, `payload[1]` is `0xC5` (Blastware firmware)
|
||||||
|
or `0x03` (Thor firmware) rather than `0x10`, and the data length is a
|
||||||
|
**uint16 BE at `payload[8:10]`** — read as a single byte it under-reads
|
||||||
|
`SUB 0x1A` by 47x. Read path, event chain, and `SUB 0x5A` streaming the
|
||||||
|
`.IDFW` file verbatim are all confirmed.
|
||||||
|
- **Series IV setup management, fully mapped.** `0x41` reads the active setup
|
||||||
|
name, `0x1A` its config block, `0xDA` names the target `.MMB`, `0x71`/`0x72`
|
||||||
|
write it back. **Setups are read-modify-write** — the written block is the
|
||||||
|
read block, 91% byte-identical at a fixed 11-byte shift. `0xDA` **creates**
|
||||||
|
files rather than only overwriting, confirmed on the unit's own screen, and an
|
||||||
|
overwrite is protocol-identical to a create: no handshake, no warning, and no
|
||||||
|
protection even over the *active* setup of a monitoring unit.
|
||||||
|
- **The scheduler file decoded** — `\system\schedule\schedule.dat`, 260-byte
|
||||||
|
records carrying an action bitmask (2 start, 4 stop, 8 self-check, 16 ACH), a
|
||||||
|
half-hour slot (48/day), day-of-week (0 = Sunday) and a length-prefixed setup
|
||||||
|
name. Verified entry-for-entry against the operator's own THOR screen.
|
||||||
|
- **A generic file transfer addressed by full path** — `0x94`/`0x48` read,
|
||||||
|
`0x8D`/`0x8E` write. This **retracts** an earlier conclusion in the same
|
||||||
|
document that no such command existed; that was inferred from absent firmware
|
||||||
|
strings and was wrong.
|
||||||
|
- **Monitoring control and per-event delete.** `0x96`/`0x97` start and stop as
|
||||||
|
on Series III, but the monitoring flag at `SUB 0x1C` `data[12]` must be tested
|
||||||
|
for **non-zero** (observed as both `0x0E` and `0x0C`) rather than compared to a
|
||||||
|
constant. Deletion is **per-event** — `0xA8` with the event key, then `0xAA` —
|
||||||
|
which is safer than Series III's erase-everything. `SUB 0x1C` also carries the
|
||||||
|
device clock.
|
||||||
|
- **`bridges/mm_probe.py`** — distinguishes the four faults THOR reports
|
||||||
|
identically as "disconnected": refused, connect timeout (the silent-drop
|
||||||
|
signature of a trusted-IP whitelist), **connected but no reply** (the modem
|
||||||
|
answered and the unit did not), and replied. Each verdict names what to try
|
||||||
|
next. `--slots N` tests single-session modem behaviour.
|
||||||
|
- **`bridges/mm_link.py`** — a bench stand-in for a cellular modem, with a
|
||||||
|
decoded timestamped log and fault injection (`blackhole`, `drop`, `delay`,
|
||||||
|
`onewaydev`) driven by a control file. No pyserial; stdlib `termios` only.
|
||||||
|
- **`scratch/mm_frame_parse.py`**, **`socat_log_split.py`** and **`fake_unit.py`**
|
||||||
|
— a Micromate-aware frame parser (`S3FrameParser` cannot see these responses at
|
||||||
|
all, since it scans for `DLE+STX`), byte-exact capture recovery from a
|
||||||
|
`socat -x` relay log, and a serial-port stand-in that answers as a unit.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- **Connecting to a unit no longer walks its event chain.** `/device/events`
|
||||||
|
reads every event header over the cellular link; on a unit with a large or
|
||||||
|
wrapped chain that takes minutes or fails outright, and it fired
|
||||||
|
automatically on every connect. Connect now uses only ~2 s probes —
|
||||||
|
`/device/info` (which already carried the compliance config the walk was
|
||||||
|
re-reading) plus `events/storage_range` — and the Device tab gains an Event
|
||||||
|
Chain card. The walk moved behind a **Load events** button in the Events
|
||||||
|
toolbar. Knowing whether a unit's ACH is on no longer requires reading every
|
||||||
|
event it has stored.
|
||||||
|
|
||||||
|
- **Recorded what THOR actually does on the wire**, measured rather than assumed.
|
||||||
|
A "status check" is **eleven commands, ~2.2 KB including TCP setup** — 18.8
|
||||||
|
MB/day per unit at a 10 s cadence, against ~0.2 MB/day for a `POLL` +
|
||||||
|
`MONITOR_STATUS` check at 60 s. The **status interval is honoured; the
|
||||||
|
connection interval is not** — it sets `(status / connection) - 1` checks per
|
||||||
|
cycle, so equal values yield *zero* cheap checks and every connection becomes
|
||||||
|
the expensive one.
|
||||||
|
- **Two THOR defects reproduced with timestamps.** After a connection drops
|
||||||
|
mid-download it retries **once**, stops polling entirely and **never resumes**,
|
||||||
|
while displaying `Connected` for as long as it is left alone — and `Idle` for a
|
||||||
|
unit that is actively recording. Separately, THOR's own log shows a
|
||||||
|
**subscription leak**: one logical event dispatched to a growing number of
|
||||||
|
handlers, **1 to 12 over ten hours** of uptime, consistent with the field
|
||||||
|
report that only a restart recovers it.
|
||||||
|
- **The Micromate's USB host supports FTDI and CDC-ACM only** — no Prolific, in
|
||||||
|
either firmware line. A PL2303 cable (Benfei) leaves a unit with no working
|
||||||
|
modem port; an FTDI cable (Sabrent) works. Both are in circulation and
|
||||||
|
indistinguishable by eye — identify by `lsusb` VID, `0403` against `067b`.
|
||||||
|
|
||||||
|
### Migration
|
||||||
|
|
||||||
|
**None.** Frontend, documentation and bench tooling only — no codec,
|
||||||
|
waveform-store or DB change, no schema change, and no `TOOL_VERSION` bump. The
|
||||||
|
webapp is served from the image, so its changes appear after the next `sfm`
|
||||||
|
rebuild. The Series-4 work adds `docs/`, `bridges/` and `scratch/` files only;
|
||||||
|
nothing under `sfm/`, `minimateplus/` or `micromate/` was touched.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## v0.31.0 — 2026-09-18
|
||||||
|
|
||||||
|
**Report parity, and a second way to rescue a runaway unit.** Two threads.
|
||||||
|
|
||||||
|
The first closes out Blastware Event/FFT-Report parity: the FFT, the USBM
|
||||||
|
RI8507 compliance chart and the sensor self-check now render on the event
|
||||||
|
report, reverse-engineered against BE12844 (MiniMate Plus) and UM (Thor)
|
||||||
|
events. The sensor check is decoded for **both** series and standardized into
|
||||||
|
the `.h5` (schema **v2**, a new `/sensor_check` group), so SFM serves it
|
||||||
|
device-agnostically rather than decoding at report time. The Inspector — an
|
||||||
|
annotated hex reader for series-3 binaries — is what made the trailing-block
|
||||||
|
structure findable, and it earned its keep by *ruling out* a stored FFT block
|
||||||
|
and proving Blastware computes it from the samples.
|
||||||
|
|
||||||
|
The second came out of a field emergency. BE12599's connector fault drove its
|
||||||
|
Tran channel to its trigger level, so the unit recorded back-to-back and dialed
|
||||||
|
the office ACH server every ~75 s, unreachable the whole time.
|
||||||
|
`bridges/ach_server.py` gained `--stop-monitoring` / `--disable-ach` /
|
||||||
|
`--rescue`, which **invert** the recovery: instead of racing a Stop into the
|
||||||
|
gaps between dial-outs, point the modem's Destination at our own ACH server and
|
||||||
|
answer the call. Proven in production the same night — the stop landed on the
|
||||||
|
first call-in and held. See `docs/runbooks/wedged_unit_recovery.md`.
|
||||||
|
|
||||||
|
⚠ **This release owes prod a backfill** — see Migration below.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **Rescue-on-connect for `bridges/ach_server.py`** — `--stop-monitoring`
|
||||||
|
(SUB 0x97), `--disable-ach` (SUB 0x2C read → 0x7E write → 0x7F confirm) and
|
||||||
|
`--rescue` (both). They fire immediately after the startup handshake and
|
||||||
|
**before** the event walk, so a unit that is recording back-to-back on a
|
||||||
|
stuck-triggered geophone is quieted as early in the session as possible.
|
||||||
|
Each action is independently guarded — a failure does not abort the download
|
||||||
|
— and the outcome is written to `rescue.json` in the session directory.
|
||||||
|
|
||||||
|
This inverts the `docs/runbooks/wedged_unit_recovery.md` approach. That
|
||||||
|
runbook reaches the unit *inbound* and clears the modem's Destination Address
|
||||||
|
to stop it dialing. When the device is instead wedged mid-modem-init — ALEOS
|
||||||
|
logs `tcpmode trying to send to invalid socket` and re-runs `Initialize Auto
|
||||||
|
answer` every ~75 s, orphaning any held inbound session — inbound cannot win.
|
||||||
|
Pointing the modem's Destination at an `ach_server` and letting the unit call
|
||||||
|
*us* gives a device-initiated session the modem bridges properly.
|
||||||
|
|
||||||
|
⚠ Prefer `--stop-monitoring` alone on first contact. `--disable-ach` stops
|
||||||
|
the unit calling, which is the only channel to a unit in this state; stopping
|
||||||
|
the recording ends the call-home loop on its own when ACH is
|
||||||
|
"after event recorded".
|
||||||
|
|
||||||
|
- **Blastware-compatible channel FFT (`waveform_fft`).** Reproduces Blastware's
|
||||||
|
FFT Report: DC-removed, no window, zero-padded to 4096 (0.25 Hz bins at
|
||||||
|
1024 sps), single-sided `2/N` amplitude. Matches Blastware's dominant
|
||||||
|
frequency to the exact bin and the amplitude to report precision across all
|
||||||
|
28 channels of the 7-event BE12844 oracle set. `channel_spectrum()` /
|
||||||
|
`dominant_frequency()`; tests in `tests/test_waveform_fft.py`.
|
||||||
|
|
||||||
|
- **USBM RI8507 / OSMRE compliance chart on the event-report PDF
|
||||||
|
(`sfm/compliance.py`).** The velocity-vs-frequency blasting-compliance
|
||||||
|
scatter Blastware draws in the upper-right of its Event Report: each channel's
|
||||||
|
significant cycles as `(frequency, peak velocity)` points (zero-crossing
|
||||||
|
method, so each channel's cloud tops out at its PPV) plotted against the
|
||||||
|
RI8507 Drywall (0.75 in/s) and plaster (0.50 in/s) limit curves, drawn
|
||||||
|
continuous (constant-displacement bounds meeting the plateaus — no vertical
|
||||||
|
steps). Sized and positioned to match a Blastware report, measured off the
|
||||||
|
reference PDF. A technical breakdown of the curve is in
|
||||||
|
`docs/ri8507_compliance_curve.md`.
|
||||||
|
|
||||||
|
- **Sensor self-check waveforms decoded and drawn — both series.** The little
|
||||||
|
"Sensor Check" traces (geophone ring-downs — the transducer's damped impulse
|
||||||
|
response — plus a MicL pulse train, the mic's known-signal gain check) are the
|
||||||
|
unit's proof its sensors were healthy when it recorded the event.
|
||||||
|
- **Series-3** (`minimateplus.sensor_check`): four records (`0x3c`–`0x3f`) in
|
||||||
|
the binary's trailing block, same delta-block codec as the main waveform.
|
||||||
|
Verified against all 7 BE12844 reports (mic zero-crossing = 20.1 Hz exact;
|
||||||
|
geophone ring-downs ~7.5 Hz, overswing ~3.5).
|
||||||
|
- **Series-4** (`micromate.sensor_check`): the same self-test in the Thor IDFW
|
||||||
|
fixed header — four `01 0e 3c/3d/3e/3f` records (same channel ids) storing
|
||||||
|
raw int16 traces; three-channel (mic-disabled) units carry only the three
|
||||||
|
geophones. Validated by shape + cross-event consistency.
|
||||||
|
- **Standardized into the `.h5`** (`/sensor_check`, schema v2): each series'
|
||||||
|
decoder attaches the traces to the event at decode, the writer persists
|
||||||
|
them, and `gather_report_data` reads them back — so SFM renders the strip
|
||||||
|
(flush against the waveform panel) plus the **Sensor Check → Frequency /
|
||||||
|
Overswing Ratio** sub-rows without knowing the source instrument.
|
||||||
|
- Tests: `tests/test_sensor_check.py`, `tests/test_sensor_check_idf.py`,
|
||||||
|
`tests/test_event_hdf5_sensor_check.py`.
|
||||||
|
|
||||||
|
- **Inspector tab in `seismo_lab.py` — annotated hex reader for series-3
|
||||||
|
binaries (`minimateplus/binary_annotate.py`).** Tiles a raw Blastware file
|
||||||
|
into labeled spans (header / STRT / body record-chain / trailing metadata +
|
||||||
|
calibration + sensor-check records / footer) so a binary can be combed by eye.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- **Event-report waveform panel — stacked-lane y-tick collision.** The lanes
|
||||||
|
touch, so each lane's bottom `-1.0` overprinted the next lane's top `1.0` at
|
||||||
|
the shared boundary. Prune the extreme ticks so each lane shows clean interior
|
||||||
|
ticks only.
|
||||||
|
- **Event-report header — serial+firmware line ran off the page.** The long
|
||||||
|
`BE##### V ##.##-#.## MiniMate Plus` string overflowed the right margin;
|
||||||
|
tighter right-column indent + BW's slightly smaller header size so it fits.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Migration
|
||||||
|
|
||||||
|
⚠ **The sensor-check needs a backfill.** Existing `.h5` files are schema v1
|
||||||
|
and carry no `/sensor_check` group, so their reports show no sensor-check strip
|
||||||
|
until regenerated. `TOOL_VERSION` is bumped to **0.31.0**, so the standard
|
||||||
|
backfill regenerates every event and picks up the traces with **no `--force`**:
|
||||||
|
`scripts/backfill_thor_events.py` for series-4 (it already owed a v0.30.0 Thor
|
||||||
|
backfill — this rides along) and the series-3 sidecar/shape backfill for
|
||||||
|
MiniMate events. Purely additive — no decoded value changes, and v1 `.h5`
|
||||||
|
files read fine until then (empty strip). DB backup first, as always.
|
||||||
|
|
||||||
|
⚠ Budget **~2 h on the NAS** — ~1.5 files/sec there versus ~85/sec on the dev
|
||||||
|
box (gzip-4 in `sfm/event_hdf5.py` against a Synology CPU).
|
||||||
|
|
||||||
|
Everything else in this release owes nothing: the FFT, the USBM compliance
|
||||||
|
chart and the `ach_server` rescue flags are additive and read data already on
|
||||||
|
disk — no schema change, no DB migration.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## v0.30.0 — 2026-09-12
|
## v0.30.0 — 2026-09-12
|
||||||
|
|
||||||
**The series-4 correctness release** — the Thor / Micromate counterpart to
|
**The series-4 correctness release** — the Thor / Micromate counterpart to
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Ground-up Python replacement for **Blastware**, Instantel's Windows-only software for
|
Ground-up Python replacement for **Blastware**, Instantel's Windows-only software for
|
||||||
managing MiniMate Plus seismographs. Connects over direct RS-232 or cellular modem
|
managing MiniMate Plus seismographs. Connects over direct RS-232 or cellular modem
|
||||||
(Sierra Wireless RV50 / RV55). Current version: **v0.30.0**.
|
(Sierra Wireless RV50 / RV55). Current version: **v0.31.0**.
|
||||||
|
|
||||||
Stack-level context — which repo owns what, and how the three project versions
|
Stack-level context — which repo owns what, and how the three project versions
|
||||||
pair — lives in `../terra-view/docs/tmi-stack.md`, which is also loaded as
|
pair — lives in `../terra-view/docs/tmi-stack.md`, which is also loaded as
|
||||||
@@ -61,6 +61,24 @@ Read this first when picking the project back up.
|
|||||||
4th-decimal tick and are Thor's own rounding — no single linear LSB can
|
4th-decimal tick and are Thor's own rounding — no single linear LSB can
|
||||||
reproduce every printed value (the constraints are infeasible by 7e-5
|
reproduce every printed value (the constraints are infeasible by 7e-5
|
||||||
relative), so do NOT retune `_GEO_LSB_IPS`.
|
relative), so do NOT retune `_GEO_LSB_IPS`.
|
||||||
|
- **⚠ KNOWN BUG — the 5A walk breaks once a unit's buffer crosses 64 KB.**
|
||||||
|
`parse_strt_end_offset()` returns only `(end_key[2] << 8) | end_key[3]`,
|
||||||
|
discarding the key's page byte. An event starting at `0x0111F2A2` and ending
|
||||||
|
at `0x0112_1010` therefore reads `end_offset = 0x1010` — *behind* its own
|
||||||
|
start. The chunk loop then exits before fetching anything and TERM computes
|
||||||
|
a negative `offset_word`, which `struct.pack(">H", ...)` rejects: the
|
||||||
|
`/device/events` walk 500s. Reproduced on BE12599 (2026-09-19), which had
|
||||||
|
78 KB stored and had rolled into page `0x12`.
|
||||||
|
**Why it hid so long:** every 5A capture the walk was verified against came
|
||||||
|
from a freshly-erased BE11529 — all three confirmed TERM examples in
|
||||||
|
`framing.py` (`0x1ABE`, `0x21F2`, `0x417E`) sit inside page `0x11`. Prod is
|
||||||
|
unaffected: it ingests complete files via BW ACH, never this walk.
|
||||||
|
**Fixing it has two layers** — the arithmetic (`if end < start: end +=
|
||||||
|
0x10000`) stops the crash and bounds the loop correctly; carrying the page
|
||||||
|
byte through the chunk requests (`params[1]` 0x11 -> 0x12, counter rolling
|
||||||
|
over) needs a BW capture of a spanning event first. Do not ship layer one
|
||||||
|
alone without a loud truncation warning — a silently short event is the
|
||||||
|
failure mode this codec has been bitten by repeatedly.
|
||||||
- **Open, not blocking:** 14 sensitive-range files show an exact 8x
|
- **Open, not blocking:** 14 sensitive-range files show an exact 8x
|
||||||
(= 10.0/1.25) units discrepancy; `scripts/backfill_sidecars.py --force` also
|
(= 10.0/1.25) units discrepancy; `scripts/backfill_sidecars.py --force` also
|
||||||
inserts DB rows for store files that have none (one-time per store) and the
|
inserts DB rows for store files that have none (one-time per store) and the
|
||||||
@@ -89,6 +107,47 @@ When new information about the protocol is discovered, please update the instant
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Changelog & release convention
|
||||||
|
|
||||||
|
**Feature branches do NOT touch `CHANGELOG.md`. Write the entry on `dev`, as
|
||||||
|
part of finishing the merge, under `## Unreleased`. Cut the version on `dev` in a
|
||||||
|
dedicated release commit when you are ready to ship to `main`.**
|
||||||
|
|
||||||
|
- **The changelog is written on `dev`, never on a feature branch.** With
|
||||||
|
several branches in flight they all edit the same few lines at the top of
|
||||||
|
the file and conflict every time. Writing it once, after the merge, also
|
||||||
|
lets it describe what actually *landed* — including anything that changed
|
||||||
|
during conflict resolution.
|
||||||
|
- ⚠ **The merge is not finished until `## Unreleased` is updated.** Same sitting,
|
||||||
|
not "later" — that is the one failure mode of writing it after the fact.
|
||||||
|
Reconstruct from the branch's own commit messages:
|
||||||
|
`git log --oneline dev..<branch>` before you merge, or
|
||||||
|
`git log --oneline <merge-base>..<branch>` after.
|
||||||
|
- **No preamble under `## Unreleased`** — just the `### Added` / `### Changed` /
|
||||||
|
`### Fixed` lists. The themed opening paragraph gets written at release
|
||||||
|
time, when the whole release is visible and can be named honestly. A theme
|
||||||
|
written when the first item landed is stale by the third.
|
||||||
|
- ⚠ **State the operational consequence** on any entry touching the codec, the
|
||||||
|
waveform store, or the DB — **including when it is "none."** "requires
|
||||||
|
`backfill_sidecars.py` + `backfill_event_shape.py`, ~2 h on the NAS",
|
||||||
|
"`TOOL_VERSION` bumped", "no schema change, no migration". Silence is
|
||||||
|
ambiguous; "none" is information. This repo's changelog is how future-you
|
||||||
|
learns whether a deploy costs two hours.
|
||||||
|
- **Releases are cut on judgement, not on a schedule or a merge.** `Unreleased`
|
||||||
|
is the staging area for whatever is going into the next release; when enough
|
||||||
|
has accumulated to be worth shipping, it gets a number and a date. Nothing
|
||||||
|
about a merge to `dev` triggers a release.
|
||||||
|
- **Cutting a release** is its own `chore(release): vX.Y.Z — <theme>` commit on
|
||||||
|
`dev`, renaming `## Unreleased` → `## vX.Y.Z — YYYY-MM-DD` and touching:
|
||||||
|
`CHANGELOG.md`, `pyproject.toml`, the version line in `CLAUDE.md` and
|
||||||
|
`README.md`, and `minimateplus/event_file_io.py` (`TOOL_VERSION`) **when the
|
||||||
|
codec changed** — that constant gates `.h5` regeneration.
|
||||||
|
- **`main` carries only released versions.** No `## Unreleased` section there;
|
||||||
|
it lands via the `dev` → `main` PR. `main` lagging `dev` by a version is
|
||||||
|
normal.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Architecture: three-tier conceptual model
|
## Architecture: three-tier conceptual model
|
||||||
|
|
||||||
seismo-relay is a **suite of cooperating components**, not a single app.
|
seismo-relay is a **suite of cooperating components**, not a single app.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# seismo-relay `v0.30.0`
|
# seismo-relay `v0.31.0`
|
||||||
|
|
||||||
A ground-up replacement for **Blastware** — Instantel's aging Windows-only
|
A ground-up replacement for **Blastware** — Instantel's aging Windows-only
|
||||||
software for managing seismographs. Supports both the **MiniMate Plus
|
software for managing seismographs. Supports both the **MiniMate Plus
|
||||||
@@ -496,6 +496,11 @@ Use **com0com** or **VSPD** to create the virtual COM pair on Windows.
|
|||||||
|
|
||||||
## Roadmap (Future)
|
## Roadmap (Future)
|
||||||
|
|
||||||
|
> **Where it stands *today*** — an honest per-capability maturity assessment,
|
||||||
|
> what to rely on, known issues, and the gap to a real tool:
|
||||||
|
> [`docs/sfm_tool_status.md`](docs/sfm_tool_status.md). This section covers
|
||||||
|
> where it is *going*.
|
||||||
|
|
||||||
### Strategic direction — where this is going
|
### Strategic direction — where this is going
|
||||||
|
|
||||||
seismo-relay is being built as a **suite of cooperating components**
|
seismo-relay is being built as a **suite of cooperating components**
|
||||||
|
|||||||
@@ -177,6 +177,8 @@ class AchSession:
|
|||||||
store: "WaveformStore",
|
store: "WaveformStore",
|
||||||
clear_after_download: bool = False,
|
clear_after_download: bool = False,
|
||||||
restart_monitoring: bool = False,
|
restart_monitoring: bool = False,
|
||||||
|
rescue_stop_monitoring: bool = False,
|
||||||
|
rescue_disable_ach: bool = False,
|
||||||
force_redownload: bool = False,
|
force_redownload: bool = False,
|
||||||
) -> None:
|
) -> None:
|
||||||
self.sock = sock
|
self.sock = sock
|
||||||
@@ -190,6 +192,9 @@ class AchSession:
|
|||||||
self.store = store
|
self.store = store
|
||||||
self.clear_after_download = clear_after_download
|
self.clear_after_download = clear_after_download
|
||||||
self.restart_monitoring = restart_monitoring
|
self.restart_monitoring = restart_monitoring
|
||||||
|
# Rescue actions for a runaway unit — fired before the event walk.
|
||||||
|
self.rescue_stop_monitoring = rescue_stop_monitoring
|
||||||
|
self.rescue_disable_ach = rescue_disable_ach
|
||||||
# `force_redownload` tells this session to ignore ach_state and
|
# `force_redownload` tells this session to ignore ach_state and
|
||||||
# re-download every event currently on the device, regardless of any
|
# re-download every event currently on the device, regardless of any
|
||||||
# (key, timestamp) match. Useful as a manual override when state has
|
# (key, timestamp) match. Useful as a manual override when state has
|
||||||
@@ -290,6 +295,41 @@ class AchSession:
|
|||||||
root_logger.addHandler(fh)
|
root_logger.addHandler(fh)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
# ── Step 1.5: rescue actions ──────────────────────────────────────
|
||||||
|
# Fired BEFORE the event walk so a runaway unit is quieted as early
|
||||||
|
# in the session as possible. A unit whose geophone sits above the
|
||||||
|
# trigger threshold records back-to-back and, with ACH set to "after
|
||||||
|
# event recorded", re-dials every time — saturating its own firmware
|
||||||
|
# so it never services inbound requests. See
|
||||||
|
# docs/runbooks/wedged_unit_recovery.md.
|
||||||
|
#
|
||||||
|
# Each action is independently guarded: a failure here must not
|
||||||
|
# abort the download that follows.
|
||||||
|
if self.rescue_stop_monitoring or self.rescue_disable_ach:
|
||||||
|
rescue: dict = {"peer": self.peer, "ts": ts}
|
||||||
|
|
||||||
|
if self.rescue_stop_monitoring:
|
||||||
|
log.info("Step 1.5: RESCUE — stop monitoring (SUB 0x97)")
|
||||||
|
try:
|
||||||
|
client.stop_monitoring()
|
||||||
|
rescue["stop_monitoring"] = "ok"
|
||||||
|
log.info(" stop monitoring OK — device should stop recording")
|
||||||
|
except Exception as exc:
|
||||||
|
rescue["stop_monitoring"] = f"failed: {exc}"
|
||||||
|
log.error(" stop monitoring FAILED: %s", exc)
|
||||||
|
|
||||||
|
if self.rescue_disable_ach:
|
||||||
|
log.info("Step 1.5: RESCUE — disable auto call home (SUB 0x2C/0x7E/0x7F)")
|
||||||
|
try:
|
||||||
|
client.set_call_home_config(auto_call_home_enabled=False)
|
||||||
|
rescue["disable_ach"] = "ok"
|
||||||
|
log.info(" disable ACH OK — unit should stop calling home")
|
||||||
|
except Exception as exc:
|
||||||
|
rescue["disable_ach"] = f"failed: {exc}"
|
||||||
|
log.error(" disable ACH FAILED: %s", exc)
|
||||||
|
|
||||||
|
_save_json(session_dir / "rescue.json", rescue)
|
||||||
|
|
||||||
# ── Step 2: device info ───────────────────────────────────────────
|
# ── Step 2: device info ───────────────────────────────────────────
|
||||||
device_info = None
|
device_info = None
|
||||||
if not self.events_only:
|
if not self.events_only:
|
||||||
@@ -747,6 +787,13 @@ def serve(args: argparse.Namespace) -> None:
|
|||||||
print(f" Max events per session: {max_ev if max_ev else 'unlimited'}")
|
print(f" Max events per session: {max_ev if max_ev else 'unlimited'}")
|
||||||
print(f" Clear device after download: {'YES' if args.clear_after_download else 'no'}")
|
print(f" Clear device after download: {'YES' if args.clear_after_download else 'no'}")
|
||||||
print(f" Restart monitoring after download: {'YES' if args.restart_monitoring else 'no'}")
|
print(f" Restart monitoring after download: {'YES' if args.restart_monitoring else 'no'}")
|
||||||
|
_stop_mon = args.stop_monitoring or args.rescue
|
||||||
|
_dis_ach = args.disable_ach or args.rescue
|
||||||
|
print(f" RESCUE stop monitoring on connect: {'YES' if _stop_mon else 'no'}")
|
||||||
|
print(f" RESCUE disable auto call home: {'YES' if _dis_ach else 'no'}")
|
||||||
|
if _stop_mon and args.restart_monitoring:
|
||||||
|
print(" !! --restart-monitoring will re-start the unit after download,")
|
||||||
|
print(" undoing --stop-monitoring. Drop one of them.")
|
||||||
print(f" Force re-download all (ignore state): {'YES' if args.force_redownload_all else 'no'}")
|
print(f" Force re-download all (ignore state): {'YES' if args.force_redownload_all else 'no'}")
|
||||||
print(f"{'='*60}")
|
print(f"{'='*60}")
|
||||||
print(f"\n Point your test unit's ACEmanager call-home settings to:")
|
print(f"\n Point your test unit's ACEmanager call-home settings to:")
|
||||||
@@ -788,6 +835,8 @@ def serve(args: argparse.Namespace) -> None:
|
|||||||
store=store,
|
store=store,
|
||||||
clear_after_download=args.clear_after_download,
|
clear_after_download=args.clear_after_download,
|
||||||
restart_monitoring=args.restart_monitoring,
|
restart_monitoring=args.restart_monitoring,
|
||||||
|
rescue_stop_monitoring=args.stop_monitoring or args.rescue,
|
||||||
|
rescue_disable_ach=args.disable_ach or args.rescue,
|
||||||
force_redownload=args.force_redownload_all,
|
force_redownload=args.force_redownload_all,
|
||||||
)
|
)
|
||||||
t = threading.Thread(target=session.run, daemon=True, name=f"ach-{peer}")
|
t = threading.Thread(target=session.run, daemon=True, name=f"ach-{peer}")
|
||||||
@@ -862,6 +911,32 @@ def parse_args() -> argparse.Namespace:
|
|||||||
"DCD on disconnect — without this the unit stays idle after a call-home."
|
"DCD on disconnect — without this the unit stays idle after a call-home."
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
p.add_argument(
|
||||||
|
"--stop-monitoring",
|
||||||
|
action="store_true",
|
||||||
|
default=False,
|
||||||
|
help=(
|
||||||
|
"RESCUE: send SUB 0x97 (stop monitoring) immediately after the "
|
||||||
|
"handshake, before any event download. Use on a unit that is "
|
||||||
|
"recording back-to-back because of a stuck-triggered geophone."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
p.add_argument(
|
||||||
|
"--disable-ach",
|
||||||
|
action="store_true",
|
||||||
|
default=False,
|
||||||
|
help=(
|
||||||
|
"RESCUE: disable Auto Call Home on the device (SUB 0x2C read → "
|
||||||
|
"0x7E write → 0x7F confirm) immediately after the handshake. The "
|
||||||
|
"unit stops dialing out until ACH is explicitly re-enabled."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
p.add_argument(
|
||||||
|
"--rescue",
|
||||||
|
action="store_true",
|
||||||
|
default=False,
|
||||||
|
help="Shorthand for --stop-monitoring --disable-ach.",
|
||||||
|
)
|
||||||
p.add_argument(
|
p.add_argument(
|
||||||
"--clear-after-download",
|
"--clear-after-download",
|
||||||
action="store_true",
|
action="store_true",
|
||||||
|
|||||||
@@ -0,0 +1,338 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
mm_link.py — a "perfect modem" between THOR and a Micromate, with a readable
|
||||||
|
log and deliberate fault injection.
|
||||||
|
|
||||||
|
Why
|
||||||
|
---
|
||||||
|
THOR gives almost no visibility into a connection: a refresh button, two poll
|
||||||
|
intervals, and no way to see whether a check succeeded, timed out, or was never
|
||||||
|
sent. When a unit "won't stay connected" there is nothing to look at.
|
||||||
|
|
||||||
|
This sits where the cellular modem would sit and answers the question directly:
|
||||||
|
|
||||||
|
* **What is THOR actually doing?** Every frame is decoded and timestamped —
|
||||||
|
`POLL`, `MONITOR_STATUS`, `SETUP_NAME_READ` — not a hex dump.
|
||||||
|
* **Is it even trying?** Silence is visible: the log shows gaps.
|
||||||
|
* **How does it behave when the link misbehaves?** Faults can be injected on
|
||||||
|
demand, which a real cell link will not do on cue.
|
||||||
|
|
||||||
|
Point THOR at this host and port exactly as if it were a modem (Communication:
|
||||||
|
TCP, IP: <this host>, Port: <--listen>).
|
||||||
|
|
||||||
|
Fault injection
|
||||||
|
---------------
|
||||||
|
Write a mode into the control file (default `mm_link.ctl`) and it takes effect
|
||||||
|
on the next byte:
|
||||||
|
|
||||||
|
echo pass > mm_link.ctl # normal relay
|
||||||
|
echo blackhole > mm_link.ctl # TCP stays up, bytes are swallowed
|
||||||
|
echo drop > mm_link.ctl # close the connection abruptly (RST-ish)
|
||||||
|
echo delay:2.0 > mm_link.ctl # forward, but 2 s late in both directions
|
||||||
|
echo onewaydev > mm_link.ctl # THOR->unit passes, unit->THOR is swallowed
|
||||||
|
|
||||||
|
**`blackhole` is the one that matters.** It reproduces the classic cellular
|
||||||
|
failure: the socket is still open as far as both ends are concerned, but nothing
|
||||||
|
crosses. A client that relies on TCP to tell it the peer is gone will sit there
|
||||||
|
until the OS keepalive fires — which by default is about two hours.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
python3 bridges/mm_link.py --serial /dev/ttyACM0 --baud 115200 \\
|
||||||
|
--listen 12345 --logdir ~/mm-captures
|
||||||
|
|
||||||
|
Writes, per session:
|
||||||
|
<logdir>/mmlink_<ts>/session.log decoded, timestamped, human-readable
|
||||||
|
<logdir>/mmlink_<ts>/raw_bw.bin THOR -> unit, raw
|
||||||
|
<logdir>/mmlink_<ts>/raw_s3.bin unit -> THOR, raw
|
||||||
|
|
||||||
|
The raw pair loads straight into `scratch/mm_frame_parse.py`.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import datetime
|
||||||
|
import os
|
||||||
|
import socket
|
||||||
|
import sys
|
||||||
|
import threading
|
||||||
|
import time
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "scratch"))
|
||||||
|
try:
|
||||||
|
from mm_frame_parse import SUBNAME, destuff # noqa: F401
|
||||||
|
except Exception: # pragma: no cover
|
||||||
|
SUBNAME = {}
|
||||||
|
|
||||||
|
import errno
|
||||||
|
import select
|
||||||
|
import termios
|
||||||
|
|
||||||
|
DLE, STX, ETX, ACK = 0x10, 0x02, 0x03, 0x41
|
||||||
|
|
||||||
|
_BAUD = {9600: termios.B9600, 19200: termios.B19200, 38400: termios.B38400,
|
||||||
|
57600: termios.B57600, 115200: termios.B115200}
|
||||||
|
|
||||||
|
|
||||||
|
class SerialPort:
|
||||||
|
"""Minimal raw serial port on stdlib termios — no pyserial dependency.
|
||||||
|
|
||||||
|
The bench hosts are whatever is to hand; requiring a pip install on someone
|
||||||
|
else's machine is a poor trade for the ~30 lines this saves.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, path: str, baud: int):
|
||||||
|
if baud not in _BAUD:
|
||||||
|
raise ValueError(f"unsupported baud {baud}; pick one of {sorted(_BAUD)}")
|
||||||
|
self.fd = os.open(path, os.O_RDWR | os.O_NOCTTY | os.O_NONBLOCK)
|
||||||
|
a = termios.tcgetattr(self.fd)
|
||||||
|
a[0] = 0 # iflag: no translation
|
||||||
|
a[1] = 0 # oflag: raw
|
||||||
|
a[2] = termios.CS8 | termios.CREAD | termios.CLOCAL # cflag: 8N1, ignore modem lines
|
||||||
|
a[3] = 0 # lflag: non-canonical, no echo
|
||||||
|
a[4] = a[5] = _BAUD[baud]
|
||||||
|
a[6] = list(a[6])
|
||||||
|
a[6][termios.VMIN] = 0
|
||||||
|
a[6][termios.VTIME] = 0
|
||||||
|
termios.tcsetattr(self.fd, termios.TCSANOW, a)
|
||||||
|
termios.tcflush(self.fd, termios.TCIOFLUSH)
|
||||||
|
|
||||||
|
def read(self, n: int) -> bytes:
|
||||||
|
r, _, _ = select.select([self.fd], [], [], 0.2)
|
||||||
|
if not r:
|
||||||
|
return b""
|
||||||
|
try:
|
||||||
|
return os.read(self.fd, n)
|
||||||
|
except OSError as e:
|
||||||
|
if e.errno in (errno.EAGAIN, errno.EWOULDBLOCK):
|
||||||
|
return b""
|
||||||
|
raise
|
||||||
|
|
||||||
|
def write(self, data: bytes) -> None:
|
||||||
|
while data:
|
||||||
|
try:
|
||||||
|
data = data[os.write(self.fd, data):]
|
||||||
|
except OSError as e:
|
||||||
|
if e.errno in (errno.EAGAIN, errno.EWOULDBLOCK):
|
||||||
|
select.select([], [self.fd], [], 0.2)
|
||||||
|
continue
|
||||||
|
raise
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
try:
|
||||||
|
os.close(self.fd)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def name_of(sub: int, is_request: bool) -> str:
|
||||||
|
if is_request:
|
||||||
|
return SUBNAME.get(sub, f"SUB_{sub:02X}")
|
||||||
|
return "rsp " + SUBNAME.get(0xFF - sub, f"SUB_{0xFF - sub:02X}")
|
||||||
|
|
||||||
|
|
||||||
|
class FrameSniffer:
|
||||||
|
"""Accumulate bytes and report complete frames, without altering the stream."""
|
||||||
|
|
||||||
|
def __init__(self, is_request: bool):
|
||||||
|
self.is_request = is_request
|
||||||
|
self.buf = bytearray()
|
||||||
|
|
||||||
|
def feed(self, data: bytes):
|
||||||
|
"""Yield (sub, payload_len) for each complete frame seen."""
|
||||||
|
self.buf.extend(data)
|
||||||
|
while True:
|
||||||
|
start = -1
|
||||||
|
for i, b in enumerate(self.buf):
|
||||||
|
if self.is_request and b == ACK and i + 1 < len(self.buf) and self.buf[i + 1] == STX:
|
||||||
|
start = i
|
||||||
|
break
|
||||||
|
if not self.is_request and b == STX:
|
||||||
|
start = i
|
||||||
|
break
|
||||||
|
if start < 0:
|
||||||
|
if len(self.buf) > 8192:
|
||||||
|
del self.buf[:-16]
|
||||||
|
return
|
||||||
|
j = start + (2 if self.is_request else 1)
|
||||||
|
end = -1
|
||||||
|
while j < len(self.buf):
|
||||||
|
if self.buf[j] == DLE and j + 1 < len(self.buf):
|
||||||
|
j += 2
|
||||||
|
continue
|
||||||
|
if self.buf[j] == ETX:
|
||||||
|
end = j
|
||||||
|
break
|
||||||
|
j += 1
|
||||||
|
if end < 0:
|
||||||
|
return # wait for more bytes
|
||||||
|
body = self.buf[start:end + 1]
|
||||||
|
del self.buf[:end + 1]
|
||||||
|
# SUB sits at a fixed spot past the leading framing -- but it is
|
||||||
|
# DLE-escaped when its own value is 0x02/0x03/0x04/0x10, so a raw
|
||||||
|
# read reports 0x10 for those. SUB 0x02 was being logged as
|
||||||
|
# "SUB_10" until this was handled.
|
||||||
|
off = 5 if self.is_request else 3
|
||||||
|
if len(body) > off:
|
||||||
|
sub = body[off]
|
||||||
|
if sub == DLE and len(body) > off + 1:
|
||||||
|
sub = body[off + 1]
|
||||||
|
yield sub, len(body)
|
||||||
|
|
||||||
|
|
||||||
|
class Link:
|
||||||
|
def __init__(self, args):
|
||||||
|
self.args = args
|
||||||
|
self.mode = "pass"
|
||||||
|
self.delay = 0.0
|
||||||
|
self.ctl = Path(args.control)
|
||||||
|
self.session: Path | None = None
|
||||||
|
self.log_fh = None
|
||||||
|
self.raw = {}
|
||||||
|
self.t0 = time.time()
|
||||||
|
self.counts = {}
|
||||||
|
|
||||||
|
# ── logging ────────────────────────────────────────────────────────────
|
||||||
|
def open_session(self):
|
||||||
|
ts = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")
|
||||||
|
self.session = Path(self.args.logdir) / f"mmlink_{ts}"
|
||||||
|
self.session.mkdir(parents=True, exist_ok=True)
|
||||||
|
self.log_fh = open(self.session / "session.log", "a", buffering=1)
|
||||||
|
self.raw = {
|
||||||
|
"bw": open(self.session / "raw_bw.bin", "ab"),
|
||||||
|
"s3": open(self.session / "raw_s3.bin", "ab"),
|
||||||
|
}
|
||||||
|
self.say(f"=== session {ts} — serial {self.args.serial} @ {self.args.baud} ===")
|
||||||
|
|
||||||
|
def say(self, text: str):
|
||||||
|
line = f"{datetime.datetime.now().strftime('%H:%M:%S.%f')[:-3]} {text}"
|
||||||
|
print(line, flush=True)
|
||||||
|
if self.log_fh:
|
||||||
|
self.log_fh.write(line + "\n")
|
||||||
|
|
||||||
|
# ── control file ───────────────────────────────────────────────────────
|
||||||
|
def poll_control(self):
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
if self.ctl.exists():
|
||||||
|
want = self.ctl.read_text().strip().lower()
|
||||||
|
if want.startswith("delay:"):
|
||||||
|
d = float(want.split(":", 1)[1])
|
||||||
|
if ("delay", d) != (self.mode, self.delay):
|
||||||
|
self.mode, self.delay = "delay", d
|
||||||
|
self.say(f"*** MODE -> delay {d}s ***")
|
||||||
|
elif want and want != self.mode:
|
||||||
|
self.mode, self.delay = want, 0.0
|
||||||
|
self.say(f"*** MODE -> {want} ***")
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
time.sleep(0.25)
|
||||||
|
|
||||||
|
# ── the relay ──────────────────────────────────────────────────────────
|
||||||
|
def pump(self, src, dst, tag: str, is_request: bool, stop: threading.Event):
|
||||||
|
sniff = FrameSniffer(is_request)
|
||||||
|
arrow = "THOR->unit" if is_request else "unit->THOR"
|
||||||
|
last = time.time()
|
||||||
|
while not stop.is_set():
|
||||||
|
timed_out = False
|
||||||
|
try:
|
||||||
|
data = src.recv(4096) if isinstance(src, socket.socket) else src.read(4096)
|
||||||
|
except TimeoutError:
|
||||||
|
timed_out = True
|
||||||
|
# socket.timeout subclasses OSError, so it MUST be caught first.
|
||||||
|
# Treating it as a dead socket closes the connection after 200 ms
|
||||||
|
# of quiet -- which is exactly what `blackhole` produces, so the
|
||||||
|
# relay killed the link it was supposed to be faking a fault on.
|
||||||
|
data = b""
|
||||||
|
except OSError:
|
||||||
|
break
|
||||||
|
if isinstance(src, socket.socket) and data == b"" and not timed_out:
|
||||||
|
self.say(f"{arrow}: peer closed the connection")
|
||||||
|
break
|
||||||
|
if not data:
|
||||||
|
if time.time() - last > self.args.quiet_after and self.counts:
|
||||||
|
self.say(f"--- {self.args.quiet_after:.0f}s with no traffic ---")
|
||||||
|
last = time.time()
|
||||||
|
continue
|
||||||
|
last = time.time()
|
||||||
|
|
||||||
|
self.raw[tag].write(data)
|
||||||
|
self.raw[tag].flush()
|
||||||
|
for sub, ln in sniff.feed(data):
|
||||||
|
label = name_of(sub, is_request)
|
||||||
|
self.counts[label] = self.counts.get(label, 0) + 1
|
||||||
|
self.say(f"{arrow} {label:<20} ({ln} B)"
|
||||||
|
+ ("" if self.mode == "pass" else f" [mode={self.mode}]"))
|
||||||
|
|
||||||
|
mode = self.mode
|
||||||
|
if mode == "drop":
|
||||||
|
self.say(f"{arrow}: DROPPING the connection (fault injection)")
|
||||||
|
stop.set()
|
||||||
|
break
|
||||||
|
if mode == "blackhole":
|
||||||
|
continue # swallow, keep the socket open
|
||||||
|
if mode == "onewaydev" and not is_request:
|
||||||
|
continue # unit's replies never reach THOR
|
||||||
|
if mode == "delay" and self.delay:
|
||||||
|
time.sleep(self.delay)
|
||||||
|
try:
|
||||||
|
if isinstance(dst, socket.socket):
|
||||||
|
dst.sendall(data)
|
||||||
|
else:
|
||||||
|
dst.write(data)
|
||||||
|
except OSError:
|
||||||
|
break
|
||||||
|
stop.set()
|
||||||
|
|
||||||
|
def serve(self):
|
||||||
|
srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||||
|
srv.bind(("0.0.0.0", self.args.listen))
|
||||||
|
srv.listen(5)
|
||||||
|
self.open_session()
|
||||||
|
self.say(f"listening on 0.0.0.0:{self.args.listen} control file: {self.ctl}")
|
||||||
|
self.say("point THOR at this host/port as Communication=TCP")
|
||||||
|
threading.Thread(target=self.poll_control, daemon=True).start()
|
||||||
|
|
||||||
|
while True:
|
||||||
|
conn, addr = srv.accept()
|
||||||
|
conn.settimeout(0.2)
|
||||||
|
self.say(f"+++ THOR connected from {addr[0]}:{addr[1]} +++")
|
||||||
|
try:
|
||||||
|
ser = SerialPort(self.args.serial, self.args.baud)
|
||||||
|
except OSError as e:
|
||||||
|
self.say(f"!!! cannot open {self.args.serial}: {e}")
|
||||||
|
conn.close()
|
||||||
|
continue
|
||||||
|
stop = threading.Event()
|
||||||
|
ts = [
|
||||||
|
threading.Thread(target=self.pump, args=(conn, ser, "bw", True, stop), daemon=True),
|
||||||
|
threading.Thread(target=self.pump, args=(ser, conn, "s3", False, stop), daemon=True),
|
||||||
|
]
|
||||||
|
for t in ts:
|
||||||
|
t.start()
|
||||||
|
for t in ts:
|
||||||
|
t.join()
|
||||||
|
conn.close()
|
||||||
|
ser.close()
|
||||||
|
summary = ", ".join(f"{k}x{v}" for k, v in sorted(self.counts.items()))
|
||||||
|
self.say(f"--- connection closed. frames this session: {summary or 'none'} ---")
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
ap = argparse.ArgumentParser(description=__doc__,
|
||||||
|
formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||||
|
ap.add_argument("--serial", default="/dev/ttyACM0")
|
||||||
|
ap.add_argument("--baud", type=int, default=115200)
|
||||||
|
ap.add_argument("--listen", type=int, default=12345)
|
||||||
|
ap.add_argument("--logdir", default=os.path.expanduser("~/mm-captures"))
|
||||||
|
ap.add_argument("--control", default="mm_link.ctl")
|
||||||
|
ap.add_argument("--quiet-after", type=float, default=30.0,
|
||||||
|
help="log a marker after this many seconds of silence")
|
||||||
|
Link(ap.parse_args()).serve()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,226 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
mm_probe.py — answer "why can't we reach this unit?" in one command.
|
||||||
|
|
||||||
|
THOR reports a failed connection as "disconnected" and nothing else. That single
|
||||||
|
word covers at least four completely different faults with four different fixes,
|
||||||
|
and telling them apart is the difference between a modem reboot and a site visit:
|
||||||
|
|
||||||
|
* **connection refused** something answered and said no — wrong port, or the
|
||||||
|
modem is refusing a further session
|
||||||
|
* **connect timed out** nothing answered at all — trusted-IP whitelist,
|
||||||
|
firewall, or the modem is off the network
|
||||||
|
* **connected, no reply** the MODEM answered but the unit did not. The TCP
|
||||||
|
path is fine; the modem is not forwarding to serial.
|
||||||
|
This is the signature of a wedged transparent-TCP
|
||||||
|
session, and it is the one THOR cannot distinguish
|
||||||
|
from any of the others
|
||||||
|
* **replied** the unit is alive; the problem is upstream software
|
||||||
|
|
||||||
|
Read-only. It sends `POLL`, then optionally `SERIAL` and the state read — the
|
||||||
|
same three commands THOR's own connection check uses — and never writes.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
python3 bridges/mm_probe.py 63.45.161.30:9034
|
||||||
|
python3 bridges/mm_probe.py 10.0.0.8:12345 --timeout 5
|
||||||
|
python3 bridges/mm_probe.py <host:port> --slots 3
|
||||||
|
|
||||||
|
`--slots N` opens N connections at once and reports how many the far end accepts.
|
||||||
|
A transparent-TCP modem typically serves **one** session; if the first succeeds
|
||||||
|
and the rest are refused or hang, that confirms the single-slot behaviour and
|
||||||
|
explains why a leaked session takes a unit offline until the slot frees.
|
||||||
|
|
||||||
|
Works for both series: a Series III reply opens `DLE STX`, a Micromate reply
|
||||||
|
opens with a bare `STX`, so the probe also tells you which one answered.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import socket
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
|
||||||
|
from minimateplus.framing import build_bw_frame # noqa: E402
|
||||||
|
|
||||||
|
DLE, STX, ETX = 0x10, 0x02, 0x03
|
||||||
|
|
||||||
|
|
||||||
|
def destuff(raw: bytes) -> bytes:
|
||||||
|
"""Strip framing and DLE escapes; return the payload without its checksum."""
|
||||||
|
i = 1 if raw and raw[0] == STX else (2 if len(raw) > 1 and raw[1] == STX else 0)
|
||||||
|
out = bytearray()
|
||||||
|
while i < len(raw):
|
||||||
|
b = raw[i]
|
||||||
|
if b == DLE and i + 1 < len(raw):
|
||||||
|
out.append(raw[i + 1])
|
||||||
|
i += 2
|
||||||
|
continue
|
||||||
|
if b == ETX:
|
||||||
|
break
|
||||||
|
out.append(b)
|
||||||
|
i += 1
|
||||||
|
return bytes(out[:-1]) if len(out) > 1 else b""
|
||||||
|
|
||||||
|
|
||||||
|
# Reads are two-step on Series III: a probe at offset 0, then a data read at the
|
||||||
|
# block's length. THOR sends these offsets, and they also work on a Micromate.
|
||||||
|
OFFSETS = {0x5B: 0x0030, 0x15: 0x000A, 0x49: 0xFFFF}
|
||||||
|
|
||||||
|
|
||||||
|
def exchange(sock: socket.socket, sub: int, timeout: float) -> tuple[bytes, float]:
|
||||||
|
sock.sendall(build_bw_frame(sub, OFFSETS.get(sub, 0)))
|
||||||
|
t0 = time.time()
|
||||||
|
buf, deadline = b"", t0 + timeout
|
||||||
|
sock.settimeout(0.3)
|
||||||
|
while time.time() < deadline:
|
||||||
|
try:
|
||||||
|
chunk = sock.recv(4096)
|
||||||
|
if not chunk:
|
||||||
|
break
|
||||||
|
buf += chunk
|
||||||
|
if buf.endswith(bytes([ETX])) and len(buf) > 8:
|
||||||
|
break
|
||||||
|
except TimeoutError:
|
||||||
|
continue
|
||||||
|
except OSError:
|
||||||
|
break
|
||||||
|
return buf, time.time() - t0
|
||||||
|
|
||||||
|
|
||||||
|
def step(n: int, label: str, result: str) -> None:
|
||||||
|
print(f" [{n}] {label:.<28} {result}")
|
||||||
|
|
||||||
|
|
||||||
|
def probe(host: str, port: int, timeout: float) -> int:
|
||||||
|
print(f"\ntarget {host}:{port} (read-only: POLL, SERIAL, state)\n")
|
||||||
|
|
||||||
|
# ── 1. TCP ────────────────────────────────────────────────────────────
|
||||||
|
t0 = time.time()
|
||||||
|
try:
|
||||||
|
sock = socket.create_connection((host, port), timeout=timeout)
|
||||||
|
except ConnectionRefusedError:
|
||||||
|
step(1, "TCP connect", f"REFUSED after {1000*(time.time()-t0):.0f} ms")
|
||||||
|
print("\nverdict: something answered and actively refused.")
|
||||||
|
print(" Not a silent firewall drop — the host is reachable.")
|
||||||
|
print(" Wrong port, the service is down, or the modem is refusing")
|
||||||
|
print(" an additional session because its one slot is in use.")
|
||||||
|
return 2
|
||||||
|
except (TimeoutError, socket.timeout):
|
||||||
|
step(1, "TCP connect", f"TIMED OUT after {time.time()-t0:.1f} s")
|
||||||
|
print("\nverdict: nothing answered at all.")
|
||||||
|
print(" A silent drop, which is what a trusted-IP whitelist looks")
|
||||||
|
print(" like — it discards rather than refuses. Check the modem's")
|
||||||
|
print(" Trusted IPs (and note a VPN changes the IP you arrive from),")
|
||||||
|
print(" the firewall, and whether the modem is on the network.")
|
||||||
|
return 3
|
||||||
|
except OSError as e:
|
||||||
|
step(1, "TCP connect", f"FAILED: {e}")
|
||||||
|
return 4
|
||||||
|
step(1, "TCP connect", f"ok ({1000*(time.time()-t0):.0f} ms)")
|
||||||
|
|
||||||
|
# ── 2. POLL ───────────────────────────────────────────────────────────
|
||||||
|
try:
|
||||||
|
raw, dt = exchange(sock, 0x5B, timeout)
|
||||||
|
except OSError as e:
|
||||||
|
step(2, "POLL", f"send failed: {e}")
|
||||||
|
sock.close()
|
||||||
|
return 4
|
||||||
|
|
||||||
|
if not raw:
|
||||||
|
step(2, "POLL", f"NO REPLY in {timeout:.1f} s")
|
||||||
|
print("\nverdict: the MODEM answered but the unit did not.")
|
||||||
|
print(" TCP is fine end to end — something accepted the connection.")
|
||||||
|
print(" What is missing is the serial side. Most likely the modem is")
|
||||||
|
print(" not forwarding to its serial port, which is what a wedged")
|
||||||
|
print(" transparent-TCP session looks like: the slot is held by a")
|
||||||
|
print(" connection that never closed.")
|
||||||
|
print("\n Try, in order:")
|
||||||
|
print(" 1. ACEmanager -> TCP Idle Timeout. If 0/disabled, a stale")
|
||||||
|
print(" session holds the slot forever. 2 minutes is the value")
|
||||||
|
print(" this project standardised on.")
|
||||||
|
print(" 2. Reboot the modem. If that fixes it, the modem was")
|
||||||
|
print(" holding state and the timeout is the permanent fix.")
|
||||||
|
print(" 3. Check the unit's own screen — serial cable, power.")
|
||||||
|
sock.close()
|
||||||
|
return 5
|
||||||
|
|
||||||
|
series = "Series III (DLE STX)" if raw[0] == DLE else "Micromate (bare STX)"
|
||||||
|
step(2, "POLL", f"reply {len(raw)} B in {1000*dt:.0f} ms")
|
||||||
|
p = destuff(raw)
|
||||||
|
ok = len(p) > 3 and p[2] == 0xFF - 0x5B
|
||||||
|
step(3, "frame", f"{'valid' if ok else 'MALFORMED'}, {series}")
|
||||||
|
if not ok:
|
||||||
|
print("\nverdict: something replied, but not a seismograph.")
|
||||||
|
print(" Another service is on this port, or the modem is in a mode")
|
||||||
|
print(" that injects its own text (check Quiet Mode / AT echo).")
|
||||||
|
print(f" first bytes: {raw[:16].hex(' ')}")
|
||||||
|
sock.close()
|
||||||
|
return 6
|
||||||
|
|
||||||
|
# ── 3. identity + state ───────────────────────────────────────────────
|
||||||
|
for n, (sub, label) in enumerate(((0x15, "serial"), (0x49, "state")), start=4):
|
||||||
|
try:
|
||||||
|
r, dt = exchange(sock, sub, timeout)
|
||||||
|
d = destuff(r)[5:]
|
||||||
|
if sub == 0x15:
|
||||||
|
# serial is a null-terminated run; a further field follows it
|
||||||
|
serial = bytes(d[11:]).split(b"\x00")[0]
|
||||||
|
step(n, label, serial.decode("ascii", "replace") or "(empty)")
|
||||||
|
else:
|
||||||
|
step(n, label, "MONITORING" if len(d) > 11 and d[11] else "idle")
|
||||||
|
except OSError:
|
||||||
|
step(n, label, "no reply")
|
||||||
|
|
||||||
|
sock.close()
|
||||||
|
print("\nverdict: the unit is alive and answering.")
|
||||||
|
print(" If THOR still shows it disconnected, the fault is in THOR, not")
|
||||||
|
print(" the network or the device.")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def slots(host: str, port: int, n: int, timeout: float) -> None:
|
||||||
|
print(f"\nopening {n} simultaneous connections to {host}:{port}\n")
|
||||||
|
held = []
|
||||||
|
for i in range(n):
|
||||||
|
try:
|
||||||
|
s = socket.create_connection((host, port), timeout=timeout)
|
||||||
|
held.append(s)
|
||||||
|
step(i + 1, f"connection {i+1}", "accepted")
|
||||||
|
except ConnectionRefusedError:
|
||||||
|
step(i + 1, f"connection {i+1}", "REFUSED")
|
||||||
|
except (TimeoutError, socket.timeout):
|
||||||
|
step(i + 1, f"connection {i+1}", "timed out")
|
||||||
|
except OSError as e:
|
||||||
|
step(i + 1, f"connection {i+1}", f"failed: {e}")
|
||||||
|
print(f"\n{len(held)} of {n} accepted.")
|
||||||
|
if len(held) == 1:
|
||||||
|
print(" Single-slot behaviour confirmed — this far end serves ONE")
|
||||||
|
print(" session at a time. A connection that is never closed takes")
|
||||||
|
print(" the unit offline until the idle timeout frees the slot.")
|
||||||
|
for s in held:
|
||||||
|
s.close()
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
ap = argparse.ArgumentParser(description=__doc__,
|
||||||
|
formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||||
|
ap.add_argument("target", help="host:port, e.g. 63.45.161.30:9034")
|
||||||
|
ap.add_argument("--timeout", type=float, default=10.0)
|
||||||
|
ap.add_argument("--slots", type=int, metavar="N",
|
||||||
|
help="open N simultaneous connections to test single-slot behaviour")
|
||||||
|
a = ap.parse_args()
|
||||||
|
host, _, port = a.target.rpartition(":")
|
||||||
|
if not host:
|
||||||
|
ap.error("target must be host:port")
|
||||||
|
if a.slots:
|
||||||
|
slots(host, int(port), a.slots, a.timeout)
|
||||||
|
return 0
|
||||||
|
return probe(host, int(port), a.timeout)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,7 @@
|
|||||||
# Runbook — Recovering a wedged unit stuck in a call-home loop
|
# Runbook — Recovering a wedged unit stuck in a call-home loop
|
||||||
|
|
||||||
**Original incident:** BE9558H at `166.246.130.1:9034`, recovered 2026-05-17.
|
**Incidents:** BE9558H at `166.246.130.1:9034`, 2026-05-17 (Method B) ·
|
||||||
|
BE12599 at `166.246.64.226:9034`, 2026-09-16 (Method A).
|
||||||
|
|
||||||
A field unit with a stuck-triggered geophone (or any hardware fault causing
|
A field unit with a stuck-triggered geophone (or any hardware fault causing
|
||||||
constant event triggering) will record events back-to-back, and if Auto Call
|
constant event triggering) will record events back-to-back, and if Auto Call
|
||||||
@@ -14,6 +15,33 @@ This runbook describes how to break the loop and recover control.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## ⚠ Two cures for one disease — intercept first
|
||||||
|
|
||||||
|
Both incidents below are the **same failure**: a geophone offset crosses the
|
||||||
|
trigger level, the unit records back-to-back, ACH set to "after event
|
||||||
|
recorded" dials continuously, and the unit becomes unreachable because its
|
||||||
|
modem is in client mode almost all of the time.
|
||||||
|
|
||||||
|
There are two ways to get a Stop Monitoring command into it.
|
||||||
|
|
||||||
|
| | **A — intercept the call** (preferred) | **B — catch it between calls** (original) |
|
||||||
|
|---|---|---|
|
||||||
|
| Idea | Be the server it dials. Point the modem's Destination at our own ACH server and answer it. | Clear the Destination so it stops dialing, then race a Stop into the gap. |
|
||||||
|
| Needs inbound? | **No — the unit calls us** | Yes: working inbound TCP to the modem |
|
||||||
|
| Determinism | Deterministic — it dials every ~75 s, we only have to be listening | A race. BE9558H took ~7 h of attempts before one landed. |
|
||||||
|
| Tool | `bridges/ach_server.py --stop-monitoring` | `scripts/slow_drip.sh` |
|
||||||
|
| Proven on | BE12599, 2026-09-16 | BE9558H, 2026-05-17 |
|
||||||
|
|
||||||
|
**Method A is the standard procedure now.** The unit won't answer us because
|
||||||
|
it is on the phone — so stop dialing it and be the one it calls. It rings,
|
||||||
|
we pick up, take its data, and tell it to stop calling here.
|
||||||
|
|
||||||
|
Method B is kept because it is proven, and because A needs a listener the
|
||||||
|
modem can actually reach (public IP + forwarded port). When you have that,
|
||||||
|
don't race it — intercept it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Symptoms
|
## Symptoms
|
||||||
|
|
||||||
- Terra-View / SFM `/device/info` either hangs or fails on `count_events()`.
|
- Terra-View / SFM `/device/info` either hangs or fails on `count_events()`.
|
||||||
@@ -31,9 +59,85 @@ If you see *all* of these, the unit is in this exact failure mode.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Quick reference — how to recover
|
## Method A (preferred) — intercept the call
|
||||||
|
|
||||||
You need **ACEmanager access** to the unit's modem.
|
You need **ACEmanager access** and a host the modem can dial: public IP with
|
||||||
|
the listener's port forwarded to it.
|
||||||
|
|
||||||
|
### A1 — start the listener BEFORE touching the modem
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /home/serversdown/seismo-relay
|
||||||
|
tmux new -s rescue
|
||||||
|
.venv/bin/python -u bridges/ach_server.py --port 12345 \
|
||||||
|
-o bridges/captures/<unit>-diag --stop-monitoring -v
|
||||||
|
```
|
||||||
|
|
||||||
|
⚠ **Listener first, always.** A Destination pointed at a dead port is the
|
||||||
|
worst state available — the device still dials, the modem still flips to
|
||||||
|
client mode, inbound stays blocked, and nothing gets delivered.
|
||||||
|
|
||||||
|
Do **not** add `--events-only` (it silently breaks dedup — see gotchas), and
|
||||||
|
do **not** add `--disable-ach` yet (see A4).
|
||||||
|
|
||||||
|
### A2 — point the modem at it
|
||||||
|
|
||||||
|
ACEmanager → **Serial → Port Configuration**:
|
||||||
|
|
||||||
|
| Field | Set to |
|
||||||
|
|---|---|
|
||||||
|
| **Destination Address** | the listener's public IP |
|
||||||
|
| **Destination Port** | the listener's port (e.g. `12345`) |
|
||||||
|
|
||||||
|
Apply. The modem auto-dials its Destination whenever serial data arrives
|
||||||
|
while the serial port is closed — so the unit's own retry cycle now lands on
|
||||||
|
you instead of nowhere.
|
||||||
|
|
||||||
|
### A3 — answer, and stop the bleeding
|
||||||
|
|
||||||
|
Within ~75 s you should see a call-in. `--stop-monitoring` fires SUB 0x97 at
|
||||||
|
step 1.5 — after the handshake, **before** the event walk — so the recording
|
||||||
|
halts at the earliest possible moment in the session. Confirm via
|
||||||
|
`rescue.json` in the session directory:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"peer": "166.246.64.226:60921", "stop_monitoring": "ok"}
|
||||||
|
```
|
||||||
|
|
||||||
|
That is the bleeding stopped. Everything after this is cleanup.
|
||||||
|
|
||||||
|
### A4 — drain the backlog, THEN disable ACH
|
||||||
|
|
||||||
|
⚠ **Order matters, and it is counter-intuitive.** Stopping monitoring also
|
||||||
|
removes your call-in trigger: ACH fires on "after event recorded", so with
|
||||||
|
recording stopped the unit has no reason to dial again. The backlog sitting
|
||||||
|
in its memory does **not** re-arm it.
|
||||||
|
|
||||||
|
So if the stored events are worth keeping — and on a fault unit they usually
|
||||||
|
are, they're the evidence — drain them across however many call-ins it takes
|
||||||
|
*before* you silence it. Only then add `--disable-ach` (or use
|
||||||
|
`scripts/rescue_device.sh <host> <port> --no-erase`).
|
||||||
|
|
||||||
|
If the unit has gone quiet and you still need it, cycling the modem produces
|
||||||
|
a call-in, and a unit with a scheduled daily call will dial at its configured
|
||||||
|
time regardless.
|
||||||
|
|
||||||
|
### A5 — restore the Destination, and confirm you did
|
||||||
|
|
||||||
|
Put `Destination Address` back to `0.0.0.0` (or the office Instantel ACH
|
||||||
|
server) once you are finished, and only stop the listener after that is done.
|
||||||
|
|
||||||
|
### A6 — do NOT re-enable ACH until the hardware fault is repaired
|
||||||
|
|
||||||
|
Otherwise the loop restarts the moment monitoring resumes and you run this
|
||||||
|
runbook again.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Method B (fallback) — catch it between calls
|
||||||
|
|
||||||
|
The original 2026-05 procedure. Use when you cannot stand up a listener the
|
||||||
|
modem can reach. You need **ACEmanager access** to the unit's modem.
|
||||||
|
|
||||||
### Step 1: stop the modem's mode-flipping
|
### Step 1: stop the modem's mode-flipping
|
||||||
|
|
||||||
@@ -253,3 +357,223 @@ service).
|
|||||||
|
|
||||||
Total time from "i was wondering if its possible to" first attempt to
|
Total time from "i was wondering if its possible to" first attempt to
|
||||||
recovery: ~7 hours of intermittent debugging across one evening.
|
recovery: ~7 hours of intermittent debugging across one evening.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Second incident — BE12599, 2026-09-16/17
|
||||||
|
|
||||||
|
**Unit:** BE12599 at `166.246.64.226:9034`, RV50, job *I-80 North Fork Bridge
|
||||||
|
— Abut 1 West* (Fay Company). Same job as BE9558H, which is a coincidence.
|
||||||
|
|
||||||
|
**Fault:** the connector fault documented in `docs/offset_investigation.md`
|
||||||
|
§8e progressed until the Tran pedestal reached **0.400 in/s** — its trigger
|
||||||
|
level. Constant triggering → constant recording → ACH "after event recorded"
|
||||||
|
→ continuous dialing. Same disease as BE9558H.
|
||||||
|
|
||||||
|
**Same disease, inverted cure.** Method B's Step 1 *did* work — clearing the
|
||||||
|
Destination stopped the dial-outs, confirmed in the ALEOS log. It was Step 2
|
||||||
|
that didn't land, and rather than keep racing we turned the rescue around:
|
||||||
|
gave the unit a different server to call, and answered it.
|
||||||
|
|
||||||
|
Total time ≈ 5 h, of which ~90 min went to two red herrings documented below.
|
||||||
|
Much of the rest was rediscovering the May procedure, which is why the
|
||||||
|
"two cures" table now sits at the top of this file.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Turn on ALEOS_SERIAL debug FIRST
|
||||||
|
|
||||||
|
This is the single highest-value diagnostic and it should be step zero on any
|
||||||
|
future incident. ACEmanager → **Admin → Log → ALEOS_SERIAL log level →
|
||||||
|
DEBUG**, then view the serial log.
|
||||||
|
|
||||||
|
It is the only thing that tells you what the *device* is actually saying.
|
||||||
|
Everything before we did this was guesswork.
|
||||||
|
|
||||||
|
## What the log showed — the unit is on the phone
|
||||||
|
|
||||||
|
Every ~75 seconds, verbatim:
|
||||||
|
|
||||||
|
```
|
||||||
|
ALEOS_SERIAL_HIF: 29 byte(s) in buffer: 'ATQ1^MATE0^MATS0=2^M^MRADIO RING^M'
|
||||||
|
ALEOS_SERIAL_HMC: TCP recvhost fd 65535 len 29 state TCPMode::kClosed
|
||||||
|
ALEOS_SERIAL_HMC: tcpmode trying to send to invalid socket
|
||||||
|
ALEOS_SERIAL_HMC: Connect to IP: 0.0.0.0 Port 0
|
||||||
|
ALEOS_SERIAL_HMC: Initialize Auto answer on port 9034
|
||||||
|
ALEOS_SERIAL_HMC: Cannot connect to 0.0.0.0
|
||||||
|
```
|
||||||
|
|
||||||
|
Read that carefully:
|
||||||
|
|
||||||
|
- `ATQ1` (quiet) / `ATE0` (echo off) / `ATS0=2` (auto-answer after 2 rings).
|
||||||
|
**There is no `ATD`.** The device is not dialing — it is trying to
|
||||||
|
*configure* its modem.
|
||||||
|
- The modem's serial port is in TCP data mode, so it never interprets these
|
||||||
|
as AT commands. It treats them as payload and tries to ship them to a TCP
|
||||||
|
socket that does not exist.
|
||||||
|
- The device therefore never receives `OK`, never progresses, and **retries
|
||||||
|
the identical 29 bytes forever**.
|
||||||
|
|
||||||
|
**While it is in this state it is busy placing a call, not listening for
|
||||||
|
us.** This is almost certainly what BE9558H was doing too — we simply never
|
||||||
|
turned on ALEOS_SERIAL debug in May to look. It is not a different disease;
|
||||||
|
it is the same one, seen properly for the first time.
|
||||||
|
|
||||||
|
It is also the argument for Method A in one picture: the unit is mid-dial
|
||||||
|
every ~75 s, and our inbound Stop has to thread the gaps between those
|
||||||
|
attempts. Give it somewhere to dial and the problem inverts into a
|
||||||
|
deterministic one.
|
||||||
|
|
||||||
|
### Why `slow_drip` lied
|
||||||
|
|
||||||
|
`slow_drip` returned the *success* signature except for the one field that
|
||||||
|
mattered:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"duration_s":120.0,"drips_sent":38,"bytes_sent":920,
|
||||||
|
"bytes_received":0,"send_error":null}
|
||||||
|
```
|
||||||
|
|
||||||
|
Full duration, no broken pipe — but zero bytes back. Cause is in the log
|
||||||
|
above: each 75 s cycle re-runs `Initialize Auto answer on port 9034`, which
|
||||||
|
orphans the held session (`data in for unknown reason 3 removing from
|
||||||
|
select`, `OnMsg recv error: 107 - Transport endpoint is not connected`). Our
|
||||||
|
local TCP stayed open so `sendall` never raised — but the modem stopped
|
||||||
|
bridging after the first re-init, so every drip after that went into a socket
|
||||||
|
nobody was reading.
|
||||||
|
|
||||||
|
⚠ **`send_error: null` + full duration is NOT success. Only
|
||||||
|
`bytes_received > 0` is success.**
|
||||||
|
|
||||||
|
⚠ **In fairness to slow_drip: it got exactly one attempt here**, run ~90 s
|
||||||
|
after a modem reboot, with a dead session visible in the log at 20:19:17 in
|
||||||
|
that same window. BE9558H took hours of attempts before one landed. Method B
|
||||||
|
was not ruled out on BE12599 so much as abandoned in favour of something that
|
||||||
|
doesn't need luck.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚠ Two red herrings that cost ~90 minutes
|
||||||
|
|
||||||
|
### 1. The trusted-IP whitelist (this was the real reason inbound never worked)
|
||||||
|
|
||||||
|
The RV50s run with **Security → Trusted IPs (Friends List) enabled**. A
|
||||||
|
source IP that is not on the list is dropped **silently** — inbound presents
|
||||||
|
as `Connection error: timed out`, never a refusal.
|
||||||
|
|
||||||
|
Brian's dev-box public IP is **dynamic** and had changed, so `tmi-dev` was no
|
||||||
|
longer whitelisted. Every inbound attempt failed identically across four
|
||||||
|
different modem and device states, which looked exactly like the BE9558H
|
||||||
|
mode-flipping symptom and sent us chasing modem configuration for over an
|
||||||
|
hour.
|
||||||
|
|
||||||
|
**Check this before diagnosing anything else.** Note that SFM in Docker
|
||||||
|
egresses via the *host's public IP*, not its LAN IP.
|
||||||
|
|
||||||
|
### 2. A 502 from SFM does not mean TCP connected
|
||||||
|
|
||||||
|
`sfm/server.py` raises **502 for both** failure classes:
|
||||||
|
|
||||||
|
```python
|
||||||
|
raise HTTPException(status_code=502, detail=f"Protocol error: {exc}")
|
||||||
|
raise HTTPException(status_code=502, detail=f"Connection error: {exc}")
|
||||||
|
```
|
||||||
|
|
||||||
|
We read an early 502 as "TCP connected, modem bridged, device mute" and built
|
||||||
|
a whole theory on it. It was almost certainly a connect timeout.
|
||||||
|
**Always read the `detail` string** — "connect failed" and "device didn't
|
||||||
|
answer" are completely different problems and the status code will not
|
||||||
|
separate them.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What actually worked — invert the direction
|
||||||
|
|
||||||
|
The key observation is in the log above:
|
||||||
|
|
||||||
|
> `TCP recvhost ... state TCPMode::kClosed` → `Connect to IP: 0.0.0.0 Port 0`
|
||||||
|
|
||||||
|
**The modem auto-dials its Destination whenever serial data arrives while
|
||||||
|
closed.** So instead of fighting for inbound, give it somewhere to dial:
|
||||||
|
point `Destination Address` at our own `ach_server` and the device's own
|
||||||
|
75-second attempts become **device-initiated sessions the modem bridges
|
||||||
|
correctly**. No race, no contention, worst case a 75-second wait.
|
||||||
|
|
||||||
|
### Procedure
|
||||||
|
|
||||||
|
1. **Run the rescue server** on a host the modem can reach (public IP +
|
||||||
|
forwarded port):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /home/serversdown/seismo-relay
|
||||||
|
.venv/bin/python -u bridges/ach_server.py --port 12345 \
|
||||||
|
-o bridges/captures/<unit>-diag --stop-monitoring -v
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Point the modem at it** — ACEmanager → Serial → Port Configuration →
|
||||||
|
`Destination Address` = your public IP, `Destination Port` = 12345.
|
||||||
|
|
||||||
|
3. **Wait for the call-in.** `--stop-monitoring` fires SUB 0x97 at step 1.5,
|
||||||
|
after the handshake and *before* the event walk. Confirm via
|
||||||
|
`rescue.json` in the session directory:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"peer": "166.246.64.226:60921", "stop_monitoring": "ok"}
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **Restore the modem's Destination** once you are done, then finish the
|
||||||
|
device side (disable ACH, erase) through whichever channel works.
|
||||||
|
|
||||||
|
On BE12599 the first call-in landed at 20:58:11 and reported
|
||||||
|
`stop_monitoring: ok`; a second at 20:58:20 confirmed it. `is_monitoring:
|
||||||
|
false` was still true **6½ hours later** — the fix is durable.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hard-won gotchas (do not re-derive)
|
||||||
|
|
||||||
|
- **Never leave the Destination pointed at a host with nothing listening.**
|
||||||
|
That is the worst state available: the device still dials, the modem still
|
||||||
|
flips, inbound stays blocked, and nothing is delivered. An 8-minute gap
|
||||||
|
with the listener down produced a spurious inbound timeout that cost
|
||||||
|
another round of misdiagnosis.
|
||||||
|
|
||||||
|
- **Stopping monitoring removes your call-in channel.** ACH is "after event
|
||||||
|
recorded"; no new events means no new dials. The backlog sitting in memory
|
||||||
|
does *not* re-arm it. After a successful stop the unit goes quiet and you
|
||||||
|
need the modem cycled (works — produced a call-in), the scheduled daily call
|
||||||
|
(BE12599 calls at **05:00:14 device-local**, per §8e), or working inbound.
|
||||||
|
**Plan the order before you fire the stop.**
|
||||||
|
|
||||||
|
- **`--events-only` silently breaks dedup.** It skips the device-info step,
|
||||||
|
so the serial is never read; `ach_state.json` then keys on
|
||||||
|
`peer:ephemeral_port`, which is unique per connection. Every session looks
|
||||||
|
like a new unit, starts from key 0, and re-downloads the same event. Four
|
||||||
|
sessions on BE12599 downloaded the identical event four times and made zero
|
||||||
|
progress on the backlog. Events also file as `serial=UNKNOWN` with a
|
||||||
|
`M000…` BW filename (serial_numeric 0) instead of `N599…`.
|
||||||
|
**Do not use `--events-only` when you intend to download anything.**
|
||||||
|
|
||||||
|
- **`/device/events/index` reported `lifetime_count: 0`** on a unit with years
|
||||||
|
of history. Suspected decode bug in the SUB 0x08 field offset — do not
|
||||||
|
trust that number. The 88-byte payload is preserved in the `raw_hex` field
|
||||||
|
if someone wants to chase it.
|
||||||
|
|
||||||
|
- **Memory used cross-checks the event keys exactly:**
|
||||||
|
`last_key − buffer_start = memory_total − memory_free`. On BE12599:
|
||||||
|
`0x011230ec − 0x01110000 = 78,060` and `983,028 − 904,968 = 78,060`.
|
||||||
|
Useful sanity check that you are reading the keys right.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Final state (2026-09-17 ~01:30 local)
|
||||||
|
|
||||||
|
- `is_monitoring: false`, held 6½ hours
|
||||||
|
- Battery 6.76 V
|
||||||
|
- Memory 78,060 / 983,028 bytes used (8%)
|
||||||
|
- `first_key 01121728`, `last_key 011230ec` — ~6.6 KB of addressable event
|
||||||
|
chain, roughly 3 events
|
||||||
|
- ACH still **enabled** — to be disabled after the backlog is preserved
|
||||||
|
- Modem Destination still pointed at tmi-dev — to be restored
|
||||||
|
- ⚠ **Do not re-enable ACH until the connector is serviced.** Tran is still
|
||||||
|
sitting at 0.400 and the loop restarts the moment monitoring resumes.
|
||||||
|
|||||||
@@ -0,0 +1,150 @@
|
|||||||
|
# SFM — where it actually stands as a tool
|
||||||
|
|
||||||
|
**Status as of 2026-09-20 (v0.31.0).** This is the honest assessment, not the
|
||||||
|
roadmap — `README.md § Roadmap` covers where it is *going*. Expect this file to
|
||||||
|
go stale; re-date it when you revise it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## The framing
|
||||||
|
|
||||||
|
SFM is **three different things wearing one name**, at three very different
|
||||||
|
levels of maturity:
|
||||||
|
|
||||||
|
| | what it is | maturity |
|
||||||
|
|---|---|---|
|
||||||
|
| **The codec library** | `minimateplus/`, `micromate/` — bytes in, `Event` out | **Production.** Verified per-sample at scale. |
|
||||||
|
| **SDM — the data side** | the DB, waveform store, `/db/*`, ingest | **Production.** Terra-View depends on it daily. |
|
||||||
|
| **SFM — the device side** | `/device/*`, live connections to units | **Emergency-grade.** Works, but manual, unauthenticated, and thinly tested. |
|
||||||
|
| **The lab** | `seismo_lab.py`, `scratch/`, the Inspector | **Research artifacts.** Useful, not products. |
|
||||||
|
|
||||||
|
Brian's own description — *"right now it's an emergency tool and a research
|
||||||
|
project"* — is accurate, and it applies specifically to the **device side**.
|
||||||
|
The data side is not an emergency tool; it has been carrying production for
|
||||||
|
months.
|
||||||
|
|
||||||
|
Most confusion about "is SFM reliable?" comes from answering for the wrong
|
||||||
|
tier.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. What you can rely on
|
||||||
|
|
||||||
|
### Production-grade — trust it
|
||||||
|
|
||||||
|
- **Series-3 decode.** 14,338 / 14,338 files decode per-sample exact against
|
||||||
|
preserved Blastware ASCII exports, 45 units, files back to 2018.
|
||||||
|
- **Series-4 (Thor) decode.** 1,057,536 / 1,057,536 geo samples exact against
|
||||||
|
Thor's own CSV exports; production IDFW 575/575 with zero truncations.
|
||||||
|
- **Histogram decode.** 1,211 / 1,211 production histograms exact, including
|
||||||
|
842,442 per-interval frequency comparisons with zero mismatches.
|
||||||
|
- **The ingest path.** `/db/import/blastware_file` and `/db/import/idf_file`
|
||||||
|
fed by the watchers — this is how prod actually gets its data, and it has
|
||||||
|
been running unattended for months.
|
||||||
|
- **`/db/*` read API.** Always-on, consumed by Terra-View for every fleet
|
||||||
|
listing, event detail and report.
|
||||||
|
- **The waveform store** — `.h5` + `.sfm.json` sidecars + retained raw
|
||||||
|
binaries, with operator review state preserved across regeneration.
|
||||||
|
- **`bridges/ach_server.py`** — speaks the full BW protocol to calling units.
|
||||||
|
Proven in the field, including as a rescue tool (see the runbook).
|
||||||
|
|
||||||
|
### Emergency-grade — works, but you are the error handling
|
||||||
|
|
||||||
|
- **`/device/*` live endpoints.** They do what they say. But they are
|
||||||
|
synchronous, unauthenticated, and a single cellular download can exceed the
|
||||||
|
60 s timeouts that sit in front of them.
|
||||||
|
- **The rescue ladder** (`rescue`, `stop_monitoring_*`, `events/erase`).
|
||||||
|
Each has worked in a real incident — but each has been used a handful of
|
||||||
|
times, by one person, with the runbook open.
|
||||||
|
- **The standalone webapp.** Perfectly usable, and as of v0.31.0 the cheap
|
||||||
|
probes and rescue actions are reachable without curl. No auth of any kind.
|
||||||
|
|
||||||
|
### Research artifacts — useful, not products
|
||||||
|
|
||||||
|
- **`seismo_lab.py`** — 2,789 lines of Tkinter (Bridge / Analyzer / Query DB /
|
||||||
|
Inspector). Desktop-only, single-user, no tests.
|
||||||
|
- **`scratch/`** — the verification harnesses (`verify_against_ascii.py`,
|
||||||
|
`verify_thor_against_csv.py`) and the offset detector (`offset_scan3.py`).
|
||||||
|
These produced the numbers the production claims rest on, so they matter —
|
||||||
|
but they are analysis scripts, not maintained code.
|
||||||
|
- **`docs/offset_investigation.md`** — an open investigation, not a feature.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. What to use when
|
||||||
|
|
||||||
|
| you want to… | use | notes |
|
||||||
|
|---|---|---|
|
||||||
|
| Know if a unit is monitoring / its battery / memory | `GET /device/monitor/status?force=true` | ~2 s |
|
||||||
|
| Know whether ACH is on | `GET /device/call_home` | ~2 s. **Not** `/device/events`. |
|
||||||
|
| See how full a unit's buffer is | `GET /device/events/storage_range` | ~2 s, no chain walk |
|
||||||
|
| Stop a runaway unit | Diagnostics tab → Stop Monitoring | see the runbook first |
|
||||||
|
| Reach a unit that will not answer | **point its modem at an `ach_server` and answer its call** | runbook Method A — do not race it |
|
||||||
|
| List a unit's stored events | Events tab → Load events | **slow**, and broken past 64 KB (below) |
|
||||||
|
| Get event data into the DB | the watcher → `/db/import/*` path | not the live walk |
|
||||||
|
|
||||||
|
The single most useful habit: **the cheap probes are cheap and the event walk
|
||||||
|
is not.** Reaching for `/device/events` to answer a yes/no question about a
|
||||||
|
unit is the mistake that motivated the v0.31.0 webapp changes.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Known issues
|
||||||
|
|
||||||
|
| issue | impact | status |
|
||||||
|
|---|---|---|
|
||||||
|
| **5A walk dies once a unit's buffer crosses 64 KB** | `/device/events` 500s; event body never downloads | Known, documented in `CLAUDE.md`. Needs a BW capture of a spanning event to fix properly. |
|
||||||
|
| **No auth on SFM at all** | 21 `/device/*` endpoints, including destructive ones, open to anything that reaches the port | Design agreed (Terra-View as authenticated jump host); not built. |
|
||||||
|
| **Swagger try-it-out is live on destructive endpoints** | `POST /device/events/erase` is one click away at `:8200/docs` | Partially mitigated: the webapp's erase now requires typing the serial. `/docs` itself is unguarded. |
|
||||||
|
| **`SUB 0x08` lifetime counter reads 0** | `/device/events/index` returns a meaningless number | Suspected field-offset bug. Surfaced in the UI as "unreliable". |
|
||||||
|
| **Long device operations are synchronous** | 60 s timeouts in `routers/sfm.py` and the reverse proxy; a full download exceeds both | Known design constraint. Must be POST-starts-job / GET-polls before any remote lab. |
|
||||||
|
| **`backfill_sidecars.py --force` silently inserts DB rows** | store files with no DB row get one; the dry-run does not report the count | Known. Avoid `--force` — `TOOL_VERSION` gates regeneration anyway. |
|
||||||
|
| **14 sensitive-range files show an exact 8× discrepancy** | 10.0 / 1.25 — a units problem, not a decode problem | Open, not blocking. |
|
||||||
|
| **16 failing tests on `dev`** | 15 need gitignored fixture bundles; 1 is real (`sc["peak_values"]["transverse"]` returns `None` where `0.0` is expected) | The real one shipped in v0.31.0. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. What stands between this and a real tool
|
||||||
|
|
||||||
|
Roughly in dependency order — each unblocks the ones below it.
|
||||||
|
|
||||||
|
**1. Authentication.** Everything else is gated on this. SFM has none, and
|
||||||
|
the modem IP whitelist gives zero protection because SFM *is* the whitelisted
|
||||||
|
origin. The agreed design delegates rather than builds: Terra-View becomes the
|
||||||
|
authenticated jump host (`/api/sfm/*` already inherits deny-by-default operator
|
||||||
|
auth), and the `8200:8200` publish is dropped so Terra-View is the only door.
|
||||||
|
|
||||||
|
**2. Async long operations.** POST starts a job, GET polls. Retrofitting this
|
||||||
|
after building a remote lab on top of synchronous endpoints would be far worse
|
||||||
|
than designing for it now.
|
||||||
|
|
||||||
|
**3. Confirm-guards on the remaining destructive endpoints.** Auth answers
|
||||||
|
*who*, not *did you mean it*. The webapp's erase is guarded; the other seven
|
||||||
|
destructive POSTs and `/docs` are not.
|
||||||
|
|
||||||
|
**4. The 5A page-boundary fix.** Until this lands, live event download is
|
||||||
|
unreliable on exactly the units most likely to need attention — the ones that
|
||||||
|
have been recording heavily. Wants a Blastware capture of an event spanning a
|
||||||
|
page boundary before the chunk-addressing half is trustworthy.
|
||||||
|
|
||||||
|
**5. A live Thor / Micromate client.** The device side is MiniMate-only.
|
||||||
|
Series-4 units can only be read from forwarded files, so half the fleet has no
|
||||||
|
live path at all.
|
||||||
|
|
||||||
|
**6. Test coverage that runs from a clean checkout.** 15 of 16 current
|
||||||
|
failures are missing fixture bundles. A test suite that cannot go green on a
|
||||||
|
fresh clone cannot gate anything.
|
||||||
|
|
||||||
|
**7. The SDM rename.** Cosmetic relative to the above, but the longer `sfm/`
|
||||||
|
holds the data-side code the more the tiers blur. ~30–50 files here, ~10–15 in
|
||||||
|
Terra-View, plus a Docker volume migration. Do it when the codebase is quiet.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## The short version
|
||||||
|
|
||||||
|
The **data side is a real tool already**. The **device side is a set of sharp
|
||||||
|
instruments** that work in the hands of the person who wrote them, with the
|
||||||
|
runbook open. The gap between those two states is mostly **auth, async, and
|
||||||
|
guardrails** — not protocol work. The protocol is the part that is actually
|
||||||
|
finished.
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
# Plan — "Rescue Listener": a first-class tool for the inverted rescue
|
||||||
|
|
||||||
|
**Status:** proposal, not started. Written 2026-09-17 ~01:40 local, straight
|
||||||
|
off the BE12599 incident. Open questions at the bottom need Brian's answer
|
||||||
|
before anything is built.
|
||||||
|
|
||||||
|
**Background:** `docs/runbooks/wedged_unit_recovery.md`, "Second incident —
|
||||||
|
BE12599". The manual version of this worked; this plan is about making it a
|
||||||
|
tool instead of a sequence of remembered steps at 1 AM.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## The problem, stated plainly
|
||||||
|
|
||||||
|
When a unit is wedged in the BE12599 mode — geophone offset above trigger,
|
||||||
|
recording back-to-back, ACH dialing constantly, device stuck repeating an AT
|
||||||
|
modem-init string and therefore **deaf to S3 over inbound** — the only channel
|
||||||
|
that works is the one the *device* opens.
|
||||||
|
|
||||||
|
Recovering it currently means:
|
||||||
|
|
||||||
|
1. Remember that `bridges/ach_server.py` exists and takes the right flags
|
||||||
|
2. Start it by hand on a box the modem can reach, with a public port forwarded
|
||||||
|
3. Go into ACEmanager and repoint the modem's Destination
|
||||||
|
4. Watch a terminal for a call-in
|
||||||
|
5. Read `rescue.json` to find out whether it worked
|
||||||
|
6. Go back into ACEmanager and repoint the modem to where it belongs
|
||||||
|
7. **Not forget step 6**, because leaving the Destination pointed at a dead
|
||||||
|
listener is worse than never having started
|
||||||
|
|
||||||
|
That is six manual steps and one landmine, executed under pressure while a
|
||||||
|
unit floods the office server.
|
||||||
|
|
||||||
|
## What the tool should be
|
||||||
|
|
||||||
|
**A "rescue listener" an operator can start for one unit, which handles
|
||||||
|
whatever that unit says when it calls in, and refuses to go away until the
|
||||||
|
operator confirms the modem has been pointed back.**
|
||||||
|
|
||||||
|
Lifecycle:
|
||||||
|
|
||||||
|
1. **Start** — operator names the target unit and starts a rescue listener.
|
||||||
|
The tool reports the exact address/port to enter in ACEmanager, plus the
|
||||||
|
actions it will take.
|
||||||
|
2. **Operator repoints the modem** to that address.
|
||||||
|
3. **Wait** — listener sits there. Live status: "waiting for call-in",
|
||||||
|
elapsed, last-seen.
|
||||||
|
4. **Act** — on call-in, run the configured rescue actions automatically,
|
||||||
|
in a safe order, each independently guarded. Report per-action outcome.
|
||||||
|
5. **Hold** — the listener **stays up** and keeps reporting, because the
|
||||||
|
modem is still pointed at it.
|
||||||
|
6. **Confirm & stop** — the operator explicitly confirms the Destination has
|
||||||
|
been restored (to `0.0.0.0`, or to the office Instantel ACH server).
|
||||||
|
Only then does the listener shut down.
|
||||||
|
|
||||||
|
Step 6 is the whole point of making this a tool. It is the step that is
|
||||||
|
easiest to skip and most expensive to skip.
|
||||||
|
|
||||||
|
## Default action set
|
||||||
|
|
||||||
|
Ordered deliberately — see "order matters" below.
|
||||||
|
|
||||||
|
| # | Action | Default | Why |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 1 | **Stop monitoring** (SUB 0x97) | ✅ on | Halts recording; ends the trigger→record→dial loop at its source. Already implemented as `--stop-monitoring`. |
|
||||||
|
| 2 | **Drain events** to a diagnostics store | ⚙ configurable | The backlog is usually evidence, not garbage — see the BE12599 offset investigation. Must NOT land in the prod SFM DB. |
|
||||||
|
| 3 | **Disable ACH** (SUB 0x2C/0x7E/0x7F) | ❌ off by default | Stops the dialing — **and stops your only channel**. Opt-in, and ideally gated on step 1 having succeeded. |
|
||||||
|
| 4 | **Erase events** | ❌ off by default | Destructive. Only after a verified drain. |
|
||||||
|
|
||||||
|
### Order matters — the lesson from BE12599
|
||||||
|
|
||||||
|
Stopping monitoring *removes the call-in trigger*. ACH fires on "after event
|
||||||
|
recorded"; with recording stopped, the unit has no reason to dial again, even
|
||||||
|
though the backlog is still sitting in its memory. So a naive
|
||||||
|
"stop + disable + erase, all at once" rescue can silence the unit before
|
||||||
|
you've collected anything, leaving you with no channel and a device full of
|
||||||
|
evidence.
|
||||||
|
|
||||||
|
The tool should either sequence around this or warn loudly about it. My
|
||||||
|
instinct is: **stop monitoring immediately** (it's the bleeding), then drain
|
||||||
|
across however many call-ins it takes, and treat disable-ACH/erase as a
|
||||||
|
separate, explicit "finish" action once the operator is satisfied.
|
||||||
|
|
||||||
|
## Where it should live — open question, with a proposal
|
||||||
|
|
||||||
|
The natural tier is **SFM** (device-side, per the three-tier model in
|
||||||
|
CLAUDE.md). But the rescue listener must be reachable *from the cellular
|
||||||
|
network*, which is a deployment constraint SFM's usual profile doesn't have.
|
||||||
|
|
||||||
|
**Proposal worth considering:** run it at the office, beside the real Instantel
|
||||||
|
ACH server, on a **different port** (e.g. 12346 while Instantel holds 12345).
|
||||||
|
Then the ACEmanager change is a **port change, not an IP change** — smaller,
|
||||||
|
faster, less to get wrong, and trivially reversible. It also means the office
|
||||||
|
public IP (already stable and known) is the destination, rather than whatever
|
||||||
|
Brian's dynamic home IP happens to be that week.
|
||||||
|
|
||||||
|
The tmi-dev approach used on BE12599 worked, but required a router forward and
|
||||||
|
ran into the dynamic-IP problem in the same session.
|
||||||
|
|
||||||
|
## Open questions
|
||||||
|
|
||||||
|
1. **Where does it run?** Office beside Instantel ACH (port swap), SFM on the
|
||||||
|
NAS, or ad-hoc on tmi-dev? Affects everything else.
|
||||||
|
2. **What drives it?** Terra-View admin page (fits "operator UI"), an SFM
|
||||||
|
endpoint pair (`POST /device/rescue_listener/start` + `/stop` + `/status`),
|
||||||
|
or a CLI wrapper? A long-lived listener doesn't fit the request/response
|
||||||
|
endpoint shape well — probably needs a background task with a status poll.
|
||||||
|
3. **How does it identify the unit?** It can't know the serial until the
|
||||||
|
device calls in and the handshake reads it. Allowlist by modem IP? Accept
|
||||||
|
anything and report what showed up?
|
||||||
|
4. **Where do drained events go?** A per-incident diagnostics store
|
||||||
|
(`bridges/captures/<unit>-diag`) seems right — explicitly *not* the prod
|
||||||
|
SFM DB. Does that store need to be a first-class thing with its own
|
||||||
|
retention, or is a directory fine?
|
||||||
|
5. **How is "confirm the modem is repointed" verified?** Operator attestation
|
||||||
|
(a button), or can we actually probe it? If the listener stops seeing
|
||||||
|
call-ins that's weak evidence; if inbound to the unit starts working that's
|
||||||
|
stronger.
|
||||||
|
6. **Multi-unit?** One listener per incident, or one listener that handles any
|
||||||
|
unit that dials in? Probably the former for safety.
|
||||||
|
7. **Timeout / abandonment policy.** If nobody ever confirms, does it run
|
||||||
|
forever? Alert after N hours?
|
||||||
|
|
||||||
|
## What already exists
|
||||||
|
|
||||||
|
- `bridges/ach_server.py` — the listener itself, with `--stop-monitoring`,
|
||||||
|
`--disable-ach`, `--rescue` (added on `feat/ach-rescue-on-connect`, commit
|
||||||
|
`9f1050b`), `--clear-after-download`, `--max-events`, `--allow-ip`.
|
||||||
|
- Per-session `rescue.json` recording per-action outcomes.
|
||||||
|
- Isolated per-output-dir SQLite + waveform store, so a diagnostics capture is
|
||||||
|
already separate from prod by construction.
|
||||||
|
|
||||||
|
So the gap is not protocol work — it's lifecycle, operator surface, and the
|
||||||
|
confirmation gate. Most of the risk is in questions 1 and 2.
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
r"""Decode the Thor / Micromate (series-4) sensor self-check waveforms from an
|
||||||
|
IDFW event binary.
|
||||||
|
|
||||||
|
Reverse-engineered 2026-09-15 against 4 UM (Thor) oracle events. The IDFW
|
||||||
|
binary carries the sensor self-check in its fixed-header region (before the
|
||||||
|
waveform body), as up to four records tagged ``01 0e 3c/3d/3e/3f`` — the SAME
|
||||||
|
channel ids as the series-3 MiniMate Plus (Tran / Vert / Long / MicL), which is
|
||||||
|
the physical self-test:
|
||||||
|
|
||||||
|
* 3c / 3d / 3e = Tran / Vert / Long geophone ring-downs (a damped impulse
|
||||||
|
response — resonant frequency + damping).
|
||||||
|
* 3f = MicL pulse train (the mic's known-signal gain check). Absent
|
||||||
|
on three-channel (mic-disabled) units.
|
||||||
|
|
||||||
|
Record framing (per record)::
|
||||||
|
|
||||||
|
01 0e [id:1] [flags:3] [count:2 BE] [pad:10] [int16-BE samples × count]
|
||||||
|
\___ 18-byte header ___/
|
||||||
|
|
||||||
|
Unlike series-3's delta-coded trailing block, series-4 stores each trace as a
|
||||||
|
raw int16 big-endian array. ``count`` (the 2-byte field at header offset +8)
|
||||||
|
is the sample count; the record is padded to a fixed stride after that.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import struct
|
||||||
|
from typing import Dict, List
|
||||||
|
|
||||||
|
# Record id → channel. Same ids/order as series-3 (minimateplus.sensor_check).
|
||||||
|
_ID_TO_CHANNEL = {0x3C: "Tran", 0x3D: "Vert", 0x3E: "Long", 0x3F: "MicL"}
|
||||||
|
_CHAIN_IDS = (0x3C, 0x3D, 0x3E, 0x3F)
|
||||||
|
|
||||||
|
_MARKER = b"\x01\x0e" # precedes the 1-byte channel id
|
||||||
|
_HEADER_LEN = 18 # bytes from the marker start to the first sample
|
||||||
|
_COUNT_OFF = 8 # 2-byte BE sample count, from the marker start
|
||||||
|
_MAX_COUNT = 4000 # sanity cap (traces are ~70-200 samples)
|
||||||
|
|
||||||
|
|
||||||
|
def _find_chain(raw: bytes):
|
||||||
|
"""Locate the sensor-check record chain. Returns a list of
|
||||||
|
``(offset, id, count)`` for the first run of markers whose ids run
|
||||||
|
3c, 3d, 3e[, 3f] in order, or ``[]``.
|
||||||
|
|
||||||
|
Records are padded to a fixed stride, so the next marker is not at
|
||||||
|
``header + count*2``; instead collect every ``01 0e [id]`` marker with a
|
||||||
|
sane count and take the first id-ordered run. Validating the id sequence
|
||||||
|
(not a lone ``01 0e 3c``) keeps a stray marker in the waveform body from
|
||||||
|
matching — the real chain sits in the fixed header, ahead of the body.
|
||||||
|
"""
|
||||||
|
n = len(raw)
|
||||||
|
markers = []
|
||||||
|
for p in range(n - _HEADER_LEN):
|
||||||
|
if raw[p:p + 2] == _MARKER and raw[p + 2] in _ID_TO_CHANNEL:
|
||||||
|
count = int.from_bytes(raw[p + _COUNT_OFF:p + _COUNT_OFF + 2], "big")
|
||||||
|
if 0 < count <= _MAX_COUNT:
|
||||||
|
markers.append((p, raw[p + 2], count))
|
||||||
|
|
||||||
|
for i, (off, rid, _c) in enumerate(markers):
|
||||||
|
if rid != 0x3C:
|
||||||
|
continue
|
||||||
|
run = [markers[i]]
|
||||||
|
for m in markers[i + 1:]:
|
||||||
|
if len(run) < len(_CHAIN_IDS) and m[1] == _CHAIN_IDS[len(run)]:
|
||||||
|
run.append(m)
|
||||||
|
else:
|
||||||
|
break
|
||||||
|
if len(run) >= 3: # 3-channel (mic-disabled) units are valid
|
||||||
|
return run
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
def decode_idf_sensor_check(raw: bytes) -> Dict[str, List[int]]:
|
||||||
|
"""Decode the sensor self-check traces from a Thor/Micromate IDFW binary.
|
||||||
|
|
||||||
|
Returns ``{"Tran": [...], "Vert": [...], "Long": [...], "MicL": [...]}`` in
|
||||||
|
raw int16 ADC counts (MicL omitted on 3-channel units), or ``{}`` if the
|
||||||
|
binary carries no sensor-check chain (a non-IDF file, or an IDFH histogram).
|
||||||
|
"""
|
||||||
|
chain = _find_chain(raw)
|
||||||
|
if not chain:
|
||||||
|
return {}
|
||||||
|
out: Dict[str, List[int]] = {}
|
||||||
|
for off, rid, count in chain:
|
||||||
|
start = off + _HEADER_LEN
|
||||||
|
blob = raw[start:start + count * 2]
|
||||||
|
if len(blob) < count * 2:
|
||||||
|
continue
|
||||||
|
out[_ID_TO_CHANNEL[rid]] = list(struct.unpack(">%dh" % count, blob))
|
||||||
|
return out
|
||||||
@@ -50,7 +50,7 @@ SIDECAR_KIND = "sfm.event"
|
|||||||
# bumped without a `pip install` re-run — leading to confusing stale
|
# bumped without a `pip install` re-run — leading to confusing stale
|
||||||
# version stamps in sidecars. Bump this constant and CHANGELOG.md
|
# version stamps in sidecars. Bump this constant and CHANGELOG.md
|
||||||
# together at release time.
|
# together at release time.
|
||||||
TOOL_VERSION = "0.30.0"
|
TOOL_VERSION = "0.31.0" # +/sensor_check group (schema v2); gates the backfill regen
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Best-effort: prefer the installed metadata when it's NEWER than the
|
# Best-effort: prefer the installed metadata when it's NEWER than the
|
||||||
@@ -296,6 +296,16 @@ def apply_report_to_event(event: Event, report: BwAsciiReport) -> None:
|
|||||||
event.sample_rate = report.sample_rate_sps
|
event.sample_rate = report.sample_rate_sps
|
||||||
if report.record_time_s is not None:
|
if report.record_time_s is not None:
|
||||||
event.rectime_seconds = report.record_time_s
|
event.rectime_seconds = report.record_time_s
|
||||||
|
# The report's event_datetime is Blastware's exact trigger time (parsed
|
||||||
|
# from Event Time + Event Date). Prefer it over the binary footer's stop
|
||||||
|
# time so a report-paired import matches BW to the second.
|
||||||
|
edt = report.event_datetime
|
||||||
|
if edt is not None:
|
||||||
|
event.timestamp = Timestamp(
|
||||||
|
raw=b"", flag=0x10,
|
||||||
|
year=edt.year, unknown_byte=0, month=edt.month, day=edt.day,
|
||||||
|
hour=edt.hour, minute=edt.minute, second=edt.second,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def apply_bw_report_dict_to_event(event: Event, bw_report: dict) -> None:
|
def apply_bw_report_dict_to_event(event: Event, bw_report: dict) -> None:
|
||||||
@@ -808,6 +818,30 @@ def derive_record_type_from_filename(filename, default: str = "Waveform") -> str
|
|||||||
return _RECORD_TYPE_BY_EXT_SUFFIX.get(ext[-1].upper(), default)
|
return _RECORD_TYPE_BY_EXT_SUFFIX.get(ext[-1].upper(), default)
|
||||||
|
|
||||||
|
|
||||||
|
# Marker for the recording-setup config block, and the offset of the record-time
|
||||||
|
# float32 within it. The configured post-trigger record time (seconds) is a
|
||||||
|
# big-endian float32 exactly 30 bytes before the "Standard Recording Setup"
|
||||||
|
# label. Verified across the corpus reading 1.0 / 2.0 / 3.0 s on different
|
||||||
|
# setups — and ts2 - record_time reproduces Blastware's trigger to the second
|
||||||
|
# (N844LQHB: stop 10:33:32 - 3.0 = 10:33:29).
|
||||||
|
_RECSETUP_MARKER = b"Standard Recording Setup"
|
||||||
|
_RECTIME_OFFSET_BEFORE_MARKER = 30
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_record_time_seconds(raw: bytes) -> Optional[float]:
|
||||||
|
"""The configured post-trigger record time in seconds, from the recording-
|
||||||
|
setup config block, or None when absent / implausible."""
|
||||||
|
a = raw.find(_RECSETUP_MARKER)
|
||||||
|
if a < _RECTIME_OFFSET_BEFORE_MARKER:
|
||||||
|
return None
|
||||||
|
off = a - _RECTIME_OFFSET_BEFORE_MARKER
|
||||||
|
try:
|
||||||
|
rt = struct.unpack(">f", raw[off:off + 4])[0]
|
||||||
|
except struct.error:
|
||||||
|
return None
|
||||||
|
return rt if 0.05 <= rt <= 600.0 else None
|
||||||
|
|
||||||
|
|
||||||
def read_blastware_file(path: Union[str, Path]) -> Event:
|
def read_blastware_file(path: Union[str, Path]) -> Event:
|
||||||
"""
|
"""
|
||||||
Parse a Blastware waveform file into an Event.
|
Parse a Blastware waveform file into an Event.
|
||||||
@@ -917,6 +951,10 @@ def read_blastware_file(path: Union[str, Path]) -> Event:
|
|||||||
# rest of the event (timestamp, waveform_key, project strings) is
|
# rest of the event (timestamp, waveform_key, project strings) is
|
||||||
# still recoverable and useful.
|
# still recoverable and useful.
|
||||||
decoded = decode_waveform_v2(body)
|
decoded = decode_waveform_v2(body)
|
||||||
|
# Discriminator for the timestamp logic below: a waveform (trigger) event
|
||||||
|
# vs a histogram window. Keyed on the codec, not the filename — the
|
||||||
|
# save_imported_bw path passes a tmp ".bw" name whose extension lies.
|
||||||
|
is_waveform_body = decoded is not None
|
||||||
if decoded is None:
|
if decoded is None:
|
||||||
decoded = decode_histogram_body(body)
|
decoded = decode_histogram_body(body)
|
||||||
if decoded is None:
|
if decoded is None:
|
||||||
@@ -948,7 +986,31 @@ def read_blastware_file(path: Union[str, Path]) -> Event:
|
|||||||
ev.total_samples = strt_fields.get("total_samples")
|
ev.total_samples = strt_fields.get("total_samples")
|
||||||
ev.pretrig_samples = strt_fields.get("pretrig_samples")
|
ev.pretrig_samples = strt_fields.get("pretrig_samples")
|
||||||
|
|
||||||
if ts1 is not None:
|
# Event timestamp. The footer's two timestamps mean different things by
|
||||||
|
# record type:
|
||||||
|
# * Waveform: ts1 = the monitoring-SESSION start (shared across every
|
||||||
|
# event that day — a unit arming at 06:00 stamps 06:00 on all of them),
|
||||||
|
# ts2 = THIS event's recording STOP. Blastware's Date/Time is the
|
||||||
|
# TRIGGER = ts2 - record time, and the record time is a float32 in the
|
||||||
|
# recording-setup config block (see _parse_record_time_seconds), so the
|
||||||
|
# exact trigger is recoverable from the binary alone. Falls back to ts2
|
||||||
|
# (the stop, within the record duration) if the config block is absent.
|
||||||
|
# (Stamping ts1 showed the session start, hours off.)
|
||||||
|
# * Histogram / undecodable: ts1 = the window start, which IS the event
|
||||||
|
# time — keep it.
|
||||||
|
# Discriminate by ``is_waveform_body`` (the codec), not the filename.
|
||||||
|
if is_waveform_body and ts2 is not None:
|
||||||
|
_stop = datetime.datetime(ts2.year, ts2.month, ts2.day,
|
||||||
|
ts2.hour, ts2.minute, ts2.second)
|
||||||
|
_rt = _parse_record_time_seconds(raw)
|
||||||
|
_trig = _stop - datetime.timedelta(seconds=_rt) if _rt is not None else _stop
|
||||||
|
ev.timestamp = Timestamp(
|
||||||
|
raw=footer[10:18],
|
||||||
|
flag=0x10,
|
||||||
|
year=_trig.year, unknown_byte=0, month=_trig.month, day=_trig.day,
|
||||||
|
hour=_trig.hour, minute=_trig.minute, second=_trig.second,
|
||||||
|
)
|
||||||
|
elif ts1 is not None:
|
||||||
ev.timestamp = Timestamp(
|
ev.timestamp = Timestamp(
|
||||||
raw=footer[2:10],
|
raw=footer[2:10],
|
||||||
flag=0x10,
|
flag=0x10,
|
||||||
@@ -960,6 +1022,11 @@ def read_blastware_file(path: Union[str, Path]) -> Event:
|
|||||||
project=project, client=client, operator=user, sensor_location=seisloc,
|
project=project, client=client, operator=user, sensor_location=seisloc,
|
||||||
)
|
)
|
||||||
ev.raw_samples = samples
|
ev.raw_samples = samples
|
||||||
|
# Sensor self-check traces from the binary's trailing block (waveform
|
||||||
|
# events only; returns {} for histograms / when absent). Carried on the
|
||||||
|
# Event so the .h5 writer persists them device-agnostically.
|
||||||
|
from minimateplus.sensor_check import decode_sensor_check
|
||||||
|
ev.sensor_check = decode_sensor_check(raw) or None
|
||||||
# Only compute peaks from samples when we actually have samples.
|
# Only compute peaks from samples when we actually have samples.
|
||||||
# For events the codec couldn't decode (histogram-mode bodies, until
|
# For events the codec couldn't decode (histogram-mode bodies, until
|
||||||
# the §7.6.2 histogram codec is wired in), samples is an empty dict
|
# the §7.6.2 histogram codec is wired in), samples is an empty dict
|
||||||
|
|||||||
@@ -544,6 +544,15 @@ class Event:
|
|||||||
pretrig_samples: Optional[int] = None # from STRT record: pre-trigger sample count
|
pretrig_samples: Optional[int] = None # from STRT record: pre-trigger sample count
|
||||||
rectime_seconds: Optional[int] = None # from STRT record: record duration (seconds)
|
rectime_seconds: Optional[int] = None # from STRT record: record duration (seconds)
|
||||||
|
|
||||||
|
# Sensor self-check traces keyed by channel label — the short diagnostic
|
||||||
|
# waveforms the unit records when it pulses each sensor before monitoring
|
||||||
|
# (geophone ring-downs + a mic pulse train). Decoded from the binary by
|
||||||
|
# the per-series decoder (minimateplus.sensor_check / micromate.sensor_check)
|
||||||
|
# and carried here so the .h5 writer can persist them device-agnostically.
|
||||||
|
# Raw ADC counts; the source series' scale differs but the trace is a
|
||||||
|
# shape diagnostic (rendered fit-to-box). None when absent.
|
||||||
|
sensor_check: Optional[dict] = None # {"Tran": [...], ..., "MicL": [...]}
|
||||||
|
|
||||||
# ── Debug / introspection ─────────────────────────────────────────────────
|
# ── Debug / introspection ─────────────────────────────────────────────────
|
||||||
# Raw 210-byte waveform record bytes, set when debug mode is active.
|
# Raw 210-byte waveform record bytes, set when debug mode is active.
|
||||||
# Exposed by the SFM server via ?debug=true so field layouts can be verified.
|
# Exposed by the SFM server via ?debug=true so field layouts can be verified.
|
||||||
|
|||||||
@@ -0,0 +1,146 @@
|
|||||||
|
r"""Decode the Blastware sensor self-check waveforms from a series-3 event binary.
|
||||||
|
|
||||||
|
Reverse-engineered 2026-09-15 against 7 BE12844 (MiniMate Plus) oracle events.
|
||||||
|
After the main waveform record-chain and the trailing metadata / per-channel
|
||||||
|
calibration records, the binary carries four length-prefixed records tagged
|
||||||
|
0x3c-0x3f: the sensor self-check traces the unit records when it pulses each
|
||||||
|
sensor before monitoring. Blastware draws these as the little waveforms in the
|
||||||
|
"Sensor Check" strip on the right of the Event Report.
|
||||||
|
|
||||||
|
* 0x3c / 0x3d / 0x3e = Tran / Vert / Long geophone ring-downs (a damped
|
||||||
|
oscillation at the geophone's resonance, ~7-8 Hz at 1024 sps).
|
||||||
|
* 0x3f = MicL, a pulse train at the mic self-test frequency
|
||||||
|
(~20 Hz), whose zero-crossing frequency is BW's mic "Channel Test" freq.
|
||||||
|
|
||||||
|
Record framing (per record, all four chained by their length prefix)::
|
||||||
|
|
||||||
|
[len:2 BE][id:1][00 00][Nchan:1][12-byte header][delta stream][40 02][6B]
|
||||||
|
\_________________ payload (len bytes) _______________________________/
|
||||||
|
|
||||||
|
The delta stream is ``payload[20 : len-8]`` (the ``40 02`` terminator sits at
|
||||||
|
``len-8``, followed by 6 trailing bytes). It uses the exact same 10/20/30/00
|
||||||
|
delta-block tags as the main waveform codec
|
||||||
|
(:mod:`minimateplus.waveform_codec`), decoded here from an implicit anchor of 0
|
||||||
|
— so the traces come out in the same 16-count raw units as the main waveform
|
||||||
|
(LSB = 0.005 in/s at Normal range for the geophones).
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Dict, List
|
||||||
|
|
||||||
|
from minimateplus.waveform_codec import walk_body
|
||||||
|
|
||||||
|
# Record id → channel. Order mirrors the trailing per-channel calibration
|
||||||
|
# records (Tran / Vert / Long / MicL), confirmed against BW's sensor-check
|
||||||
|
# frequencies on all 7 oracle events.
|
||||||
|
_ID_TO_CHANNEL = {0x3C: "Tran", 0x3D: "Vert", 0x3E: "Long", 0x3F: "MicL"}
|
||||||
|
_CHAIN_IDS = (0x3C, 0x3D, 0x3E, 0x3F)
|
||||||
|
|
||||||
|
_HEADER_LEN = 20 # payload bytes before the delta stream
|
||||||
|
_TRAILER_LEN = 8 # 40 02 terminator + 6 trailing bytes after the stream
|
||||||
|
|
||||||
|
|
||||||
|
def _s4(nib: int) -> int:
|
||||||
|
"""Sign-extend a 4-bit nibble delta."""
|
||||||
|
return nib - 16 if nib >= 8 else nib
|
||||||
|
|
||||||
|
|
||||||
|
def _i8(byte: int) -> int:
|
||||||
|
"""Sign-extend an 8-bit int delta."""
|
||||||
|
return byte - 256 if byte >= 128 else byte
|
||||||
|
|
||||||
|
|
||||||
|
def _decode_delta_stream(buf: bytes) -> List[int]:
|
||||||
|
"""Accumulate a 10/20/30/00 delta-block stream from an anchor of 0,
|
||||||
|
stopping at the 0x40 terminator.
|
||||||
|
|
||||||
|
Mirrors the block semantics in
|
||||||
|
:func:`minimateplus.waveform_codec.decode_waveform_v2` (fully decoded &
|
||||||
|
byte-exact as of 2026-05-11); see that module for the format details.
|
||||||
|
"""
|
||||||
|
out: List[int] = []
|
||||||
|
cur = 0
|
||||||
|
for blk in walk_body(buf, 0):
|
||||||
|
fam = blk.tag_hi & 0xF0
|
||||||
|
if fam == 0x10:
|
||||||
|
# nibble deltas, high nibble first
|
||||||
|
for byte in blk.data:
|
||||||
|
for nib in ((byte >> 4) & 0xF, byte & 0xF):
|
||||||
|
cur += _s4(nib)
|
||||||
|
out.append(cur)
|
||||||
|
elif fam == 0x20:
|
||||||
|
# int8 deltas
|
||||||
|
for byte in blk.data:
|
||||||
|
cur += _i8(byte)
|
||||||
|
out.append(cur)
|
||||||
|
elif fam == 0x30:
|
||||||
|
# 12-bit signed deltas, packed as tag_lo/4 groups of 6 bytes
|
||||||
|
for g in range(blk.tag_lo // 4):
|
||||||
|
grp = blk.data[g * 6:(g + 1) * 6]
|
||||||
|
if len(grp) < 6:
|
||||||
|
break
|
||||||
|
high_word = (grp[0] << 8) | grp[1]
|
||||||
|
for k in range(4):
|
||||||
|
nib = (high_word >> (12 - 4 * k)) & 0xF
|
||||||
|
v = (nib << 8) | grp[2 + k]
|
||||||
|
if v >= 0x800:
|
||||||
|
v -= 0x1000
|
||||||
|
cur += v
|
||||||
|
out.append(cur)
|
||||||
|
elif fam == 0x00:
|
||||||
|
# RLE zero-delta run (wide form carries the high nibble in the tag)
|
||||||
|
run = ((blk.tag_hi & 0x0F) << 8) | blk.tag_lo
|
||||||
|
out.extend([cur] * run)
|
||||||
|
elif fam == 0x40:
|
||||||
|
# segment / record terminator
|
||||||
|
break
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _find_chain(body: bytes):
|
||||||
|
"""Locate the four length-prefixed sensor-check records.
|
||||||
|
|
||||||
|
Returns a list of ``(offset, id, length)`` or ``None``. The chain is
|
||||||
|
validated by walking the ids 0x3c → 0x3d → 0x3e → 0x3f via their own length
|
||||||
|
prefixes, so a stray 0x3c byte in the waveform data cannot match.
|
||||||
|
"""
|
||||||
|
for p in range(len(body) - 6):
|
||||||
|
if body[p + 2] == 0x3C and body[p + 3] == 0 and body[p + 4] == 0:
|
||||||
|
q = p
|
||||||
|
recs = []
|
||||||
|
ok = True
|
||||||
|
for expect in _CHAIN_IDS:
|
||||||
|
if q + 3 > len(body) or body[q + 2] != expect:
|
||||||
|
ok = False
|
||||||
|
break
|
||||||
|
length = int.from_bytes(body[q:q + 2], "big")
|
||||||
|
recs.append((q, expect, length))
|
||||||
|
q = q + 2 + length
|
||||||
|
if ok and len(recs) == 4:
|
||||||
|
return recs
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def decode_sensor_check(raw: bytes) -> Dict[str, List[int]]:
|
||||||
|
"""Decode the four sensor self-check traces from a series-3 event binary.
|
||||||
|
|
||||||
|
Returns ``{"Tran": [...], "Vert": [...], "Long": [...], "MicL": [...]}`` in
|
||||||
|
raw decode units (same 16-count LSB as the main waveform), or ``{}`` if the
|
||||||
|
binary carries no sensor-check block (a histogram event, a non-series-3
|
||||||
|
file, or a unit/firmware that doesn't store it).
|
||||||
|
"""
|
||||||
|
strt = raw.find(b"STRT")
|
||||||
|
if strt < 0 or len(raw) < strt + 21 + 26:
|
||||||
|
return {}
|
||||||
|
body = raw[strt + 21: len(raw) - 26]
|
||||||
|
chain = _find_chain(body)
|
||||||
|
if not chain:
|
||||||
|
return {}
|
||||||
|
out: Dict[str, List[int]] = {}
|
||||||
|
for off, rid, length in chain:
|
||||||
|
payload = body[off + 2: off + 2 + length]
|
||||||
|
if len(payload) < _HEADER_LEN + _TRAILER_LEN:
|
||||||
|
continue
|
||||||
|
stream = payload[_HEADER_LEN: length - _TRAILER_LEN]
|
||||||
|
out[_ID_TO_CHANNEL[rid]] = _decode_delta_stream(stream)
|
||||||
|
return out
|
||||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "seismo-relay"
|
name = "seismo-relay"
|
||||||
version = "0.30.0"
|
version = "0.31.0"
|
||||||
description = "Python client and REST server for MiniMate Plus seismographs"
|
description = "Python client and REST server for MiniMate Plus seismographs"
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
|||||||
@@ -0,0 +1,33 @@
|
|||||||
|
"""Pretend to be a Micromate on a serial port: log what arrives, reply to POLL.
|
||||||
|
|
||||||
|
Proves the modem's return path (serial -> TCP) independently of the real unit.
|
||||||
|
"""
|
||||||
|
import os, select, sys, termios, time
|
||||||
|
|
||||||
|
path, baud = sys.argv[1], int(sys.argv[2]) if len(sys.argv) > 2 else 115200
|
||||||
|
B = {9600: termios.B9600, 38400: termios.B38400, 115200: termios.B115200}[baud]
|
||||||
|
fd = os.open(path, os.O_RDWR | os.O_NOCTTY | os.O_NONBLOCK)
|
||||||
|
a = termios.tcgetattr(fd)
|
||||||
|
a[0] = a[1] = a[3] = 0
|
||||||
|
a[2] = termios.CS8 | termios.CREAD | termios.CLOCAL
|
||||||
|
a[4] = a[5] = B
|
||||||
|
a[6] = list(a[6]); a[6][termios.VMIN] = 0; a[6][termios.VTIME] = 0
|
||||||
|
termios.tcsetattr(fd, termios.TCSANOW, a)
|
||||||
|
termios.tcflush(fd, termios.TCIOFLUSH)
|
||||||
|
|
||||||
|
# A real POLL probe reply, captured from UM12947 on 2026-09-24.
|
||||||
|
REPLY = bytes.fromhex("0200c5a4000000000000300000000000000099") + b"\x03"
|
||||||
|
|
||||||
|
print(f"fake unit on {path} @ {baud}; will answer any inbound frame", flush=True)
|
||||||
|
while True:
|
||||||
|
r, _, _ = select.select([fd], [], [], 1.0)
|
||||||
|
if not r:
|
||||||
|
continue
|
||||||
|
data = os.read(fd, 4096)
|
||||||
|
if not data:
|
||||||
|
continue
|
||||||
|
ts = time.strftime("%H:%M:%S")
|
||||||
|
print(f"{ts} IN {len(data):3} B {data.hex(' ')}", flush=True)
|
||||||
|
time.sleep(0.02)
|
||||||
|
os.write(fd, REPLY)
|
||||||
|
print(f"{ts} OUT {len(REPLY):3} B {REPLY.hex(' ')} <- canned POLL reply", flush=True)
|
||||||
@@ -0,0 +1,202 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
mm_frame_parse.py — parse Micromate (Series IV) frames out of a seismo_lab
|
||||||
|
raw capture pair.
|
||||||
|
|
||||||
|
Why this exists
|
||||||
|
---------------
|
||||||
|
`minimateplus.framing.S3FrameParser` cannot see Micromate traffic. It locates
|
||||||
|
frames by scanning for `DLE STX`, and a Micromate response has **no leading
|
||||||
|
DLE** — it starts at a bare `STX`. It also expects `payload[1] == 0x10`, where
|
||||||
|
the Micromate sends `0xC5` (Blastware firmware) or `0x03` (Thor firmware).
|
||||||
|
|
||||||
|
The practical consequence, seen on the 9-24-26 setup-push capture: the
|
||||||
|
Blastware-side requests parse fine (Thor emits Series III request frames), but
|
||||||
|
**every device response is silently dropped or mis-framed** — so a capture that
|
||||||
|
actually contains 12 acked writes looks like 12 unanswered requests.
|
||||||
|
|
||||||
|
Destuffing
|
||||||
|
----------
|
||||||
|
One rule covers both directions: after the leading doubled `BW_CMD`, every
|
||||||
|
`10 XX` pair on the wire destuffs to `XX`. That includes `10 03` — Thor
|
||||||
|
escapes literal `0x03` bytes in write data so they are not mistaken for ETX,
|
||||||
|
exactly as Blastware does.
|
||||||
|
|
||||||
|
That rule was chosen by evidence, not assumption: of the four candidates tried
|
||||||
|
against the 9-24-26 capture's four data-carrying write frames, it is the only
|
||||||
|
one under which all four checksums validate. See
|
||||||
|
`docs/micromate_protocol_reference.md` → *The write path*.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
python scratch/mm_frame_parse.py <capture-dir>
|
||||||
|
python scratch/mm_frame_parse.py <raw_bw.bin> <raw_s3.bin>
|
||||||
|
python scratch/mm_frame_parse.py <capture-dir> --dump 0x71
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
DLE, STX, ETX, ACK = 0x10, 0x02, 0x03, 0x41
|
||||||
|
|
||||||
|
# Request SUB -> short name. Series III names where they carry over; the
|
||||||
|
# Series IV additions are marked.
|
||||||
|
SUBNAME = {
|
||||||
|
0x01: "DEVICE_INFO",
|
||||||
|
0x06: "STORAGE_RANGE",
|
||||||
|
0x08: "EVENT_INDEX",
|
||||||
|
0x0A: "WAVEFORM_HDR",
|
||||||
|
0x0C: "WAVEFORM_REC",
|
||||||
|
0x15: "SERIAL",
|
||||||
|
0x1A: "COMPLIANCE_CFG",
|
||||||
|
0x1C: "MONITOR_STATUS",
|
||||||
|
0x1E: "EVENT_HDR",
|
||||||
|
0x2C: "CALLHOME_CFG",
|
||||||
|
0x2E: "TRIGGER_CFG_READ", # Series IV
|
||||||
|
0x3E: "OPERATOR",
|
||||||
|
0x41: "SETUP_NAME_READ", # Series IV
|
||||||
|
0x5A: "BULK_DOWNLOAD",
|
||||||
|
0x5B: "POLL",
|
||||||
|
0x68: "EVENT_INDEX_WRITE",
|
||||||
|
0x69: "WAVEFORM_WRITE",
|
||||||
|
0x71: "COMPLIANCE_WRITE",
|
||||||
|
0x72: "CONFIRM_A",
|
||||||
|
0x73: "CONFIRM_B",
|
||||||
|
0x74: "CONFIRM_C",
|
||||||
|
0x82: "TRIGGER_WRITE",
|
||||||
|
0x83: "TRIGGER_CONFIRM",
|
||||||
|
0xDA: "SETUP_FILE_DECL", # Series IV — names the target .MMB
|
||||||
|
0xFE: "FULL_CFG",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def destuff(blob: bytes, start: int, *, is_request: bool) -> tuple[bytes, int, int]:
|
||||||
|
"""Destuff one frame starting at `start`.
|
||||||
|
|
||||||
|
Returns (payload, checksum, index_of_terminating_ETX). `payload` excludes
|
||||||
|
the trailing checksum byte. A request frame opens `ACK STX 10 10`; a
|
||||||
|
response opens with a bare `STX`.
|
||||||
|
"""
|
||||||
|
i = start + (2 if is_request else 1)
|
||||||
|
out = bytearray()
|
||||||
|
if is_request:
|
||||||
|
# The doubled BW_CMD is the one guaranteed stuffed byte.
|
||||||
|
if blob[i : i + 2] != bytes([DLE, DLE]):
|
||||||
|
raise ValueError(f"@0x{start:04x}: request does not open with 10 10")
|
||||||
|
out.append(DLE)
|
||||||
|
i += 2
|
||||||
|
while i < len(blob):
|
||||||
|
b = blob[i]
|
||||||
|
if b == DLE and i + 1 < len(blob):
|
||||||
|
out.append(blob[i + 1])
|
||||||
|
i += 2
|
||||||
|
continue
|
||||||
|
if b == ETX:
|
||||||
|
break
|
||||||
|
out.append(b)
|
||||||
|
i += 1
|
||||||
|
if len(out) < 2:
|
||||||
|
raise ValueError(f"@0x{start:04x}: frame too short")
|
||||||
|
return bytes(out[:-1]), out[-1], i
|
||||||
|
|
||||||
|
|
||||||
|
def frames(blob: bytes, *, is_request: bool):
|
||||||
|
"""Yield (offset, payload, chk, checksum_kind)."""
|
||||||
|
i, n = 0, len(blob)
|
||||||
|
while i < n:
|
||||||
|
if is_request:
|
||||||
|
if not (blob[i] == ACK and i + 1 < n and blob[i + 1] == STX):
|
||||||
|
i += 1
|
||||||
|
continue
|
||||||
|
elif blob[i] != STX:
|
||||||
|
i += 1
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
payload, chk, end = destuff(blob, i, is_request=is_request)
|
||||||
|
except ValueError:
|
||||||
|
i += 1
|
||||||
|
continue
|
||||||
|
sum8 = sum(payload) & 0xFF
|
||||||
|
dle_aware = (sum(b for b in payload if b != DLE) & 0xFF)
|
||||||
|
if sum8 == chk:
|
||||||
|
kind = "SUM8"
|
||||||
|
elif dle_aware == chk:
|
||||||
|
kind = "DLE-aware"
|
||||||
|
else:
|
||||||
|
kind = "BAD"
|
||||||
|
yield i, payload, chk, kind
|
||||||
|
i = end + 1
|
||||||
|
|
||||||
|
|
||||||
|
def describe(payload: bytes, is_request: bool) -> str:
|
||||||
|
if len(payload) < 3:
|
||||||
|
return "??"
|
||||||
|
sub = payload[2]
|
||||||
|
if is_request:
|
||||||
|
return SUBNAME.get(sub, f"SUB_{sub:02X}")
|
||||||
|
req = 0xFF - sub
|
||||||
|
return "rsp<-" + SUBNAME.get(req, f"SUB_{req:02X}")
|
||||||
|
|
||||||
|
|
||||||
|
def report(path: Path, *, is_request: bool, dump_sub: int | None) -> None:
|
||||||
|
blob = path.read_bytes()
|
||||||
|
side = "Thor" if is_request else "unit"
|
||||||
|
print(f"== {side:4} {path.name} ({len(blob)} bytes)")
|
||||||
|
n_bad = 0
|
||||||
|
for idx, (off, p, chk, kind) in enumerate(frames(blob, is_request=is_request)):
|
||||||
|
if kind == "BAD":
|
||||||
|
n_bad += 1
|
||||||
|
sub = p[2] if len(p) > 2 else -1
|
||||||
|
flags = p[1] if len(p) > 1 else -1
|
||||||
|
# Requests carry offset at payload[4:6]; responses page at [3:5].
|
||||||
|
word = int.from_bytes(p[4:6] if is_request else p[3:5], "big")
|
||||||
|
data = len(p) - 16 if is_request else max(len(p) - 5, 0)
|
||||||
|
print(
|
||||||
|
f" [{idx:2}] @0x{off:04x} payload={len(p):5} data={data:5} "
|
||||||
|
f"flags=0x{flags:02x} SUB=0x{sub:02x} {describe(p, is_request):18} "
|
||||||
|
f"{'offset' if is_request else 'page'}=0x{word:04x} chk={kind}"
|
||||||
|
)
|
||||||
|
if dump_sub is not None and sub == dump_sub:
|
||||||
|
body = p[16:] if is_request else p[5:]
|
||||||
|
print(f" ---- data ({len(body)} bytes) ----")
|
||||||
|
for o in range(0, len(body), 16):
|
||||||
|
chunk = body[o : o + 16]
|
||||||
|
txt = "".join(chr(c) if 32 <= c < 127 else "." for c in chunk)
|
||||||
|
print(f" {o:06x} {chunk.hex(' '):<47} |{txt}|")
|
||||||
|
print(f" -- {idx + 1} frames, {n_bad} bad checksum\n")
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
ap = argparse.ArgumentParser(description=__doc__,
|
||||||
|
formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||||
|
ap.add_argument("paths", nargs="+",
|
||||||
|
help="a capture directory, or raw_bw.bin and raw_s3.bin")
|
||||||
|
ap.add_argument("--dump", default=None,
|
||||||
|
help="hex-dump the data section of this SUB (e.g. 0x71)")
|
||||||
|
args = ap.parse_args()
|
||||||
|
|
||||||
|
dump_sub = int(args.dump, 0) if args.dump else None
|
||||||
|
|
||||||
|
if len(args.paths) == 1 and Path(args.paths[0]).is_dir():
|
||||||
|
d = Path(args.paths[0])
|
||||||
|
bw = sorted(d.glob("raw_bw_*.bin"))
|
||||||
|
s3 = sorted(d.glob("raw_s3_*.bin"))
|
||||||
|
if not bw or not s3:
|
||||||
|
print(f"{d}: need one raw_bw_*.bin and one raw_s3_*.bin", file=sys.stderr)
|
||||||
|
return 2
|
||||||
|
pairs = [(bw[0], True), (s3[0], False)]
|
||||||
|
elif len(args.paths) == 2:
|
||||||
|
pairs = [(Path(args.paths[0]), True), (Path(args.paths[1]), False)]
|
||||||
|
else:
|
||||||
|
ap.error("pass a capture directory, or exactly two .bin files")
|
||||||
|
|
||||||
|
for path, is_request in pairs:
|
||||||
|
report(path, is_request=is_request, dump_sub=dump_sub)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
sys.exit(main())
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
socat_log_split.py — recover a capture pair from a `socat -x` relay log.
|
||||||
|
|
||||||
|
Why this exists
|
||||||
|
---------------
|
||||||
|
The bench relay that puts Thor in front of a USB-attached Micromate is:
|
||||||
|
|
||||||
|
socat -d -d -x TCP-LISTEN:12345,reuseaddr,fork /dev/ttyACM0,raw,echo=0,b115200 \
|
||||||
|
> ~/mm-captures/socat_<ts>.log 2>&1
|
||||||
|
|
||||||
|
`-x` makes socat hex-dump every byte it forwards, in both directions, with
|
||||||
|
timestamps. That log is therefore a **complete second copy of every capture**
|
||||||
|
taken through the relay — independent of whether seismo_lab was recording.
|
||||||
|
|
||||||
|
On 2026-09-25 that mattered: a capture's `.bin` files never made it off the
|
||||||
|
Windows machine, and the session was rebuilt from this log instead. When the
|
||||||
|
real bins turned up later, the reconstruction was **byte-for-byte identical in
|
||||||
|
both directions** (3,595 and 4,004 bytes). So this is a validated fallback, not
|
||||||
|
a lossy approximation.
|
||||||
|
|
||||||
|
Log format
|
||||||
|
----------
|
||||||
|
```
|
||||||
|
> 2026/09/25 00:30:35.000276659 length=21 from=0 to=20
|
||||||
|
41 02 10 10 00 5b 00 00 30 00 ...
|
||||||
|
2026/09/25 00:30:35 socat[32190] N write(5, 0x..., 21) completed
|
||||||
|
< 2026/09/25 00:30:35.000384100 length=64 from=0 to=63
|
||||||
|
02 00 c5 a4 00 00 30 00 ...
|
||||||
|
```
|
||||||
|
|
||||||
|
`>` is data heading toward the serial device (Thor → unit). `<` is data coming
|
||||||
|
back (unit → Thor). Hex lines are space-separated and indented; socat's own
|
||||||
|
status lines start with a date and carry no payload.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
# whole log
|
||||||
|
python scratch/socat_log_split.py socat_20260924_181248.log --out-dir ./recovered
|
||||||
|
|
||||||
|
# one session — line numbers from the "accepting connection" markers
|
||||||
|
grep -n "accepting connection" socat_*.log
|
||||||
|
python scratch/socat_log_split.py socat_*.log --from-line 919 --out-dir ./recovered
|
||||||
|
|
||||||
|
Then parse the result as usual:
|
||||||
|
|
||||||
|
python scratch/mm_frame_parse.py recovered/raw_bw.bin recovered/raw_s3.bin
|
||||||
|
|
||||||
|
⚠ A log spanning several sessions concatenates them. Split by line number using
|
||||||
|
the `accepting connection` markers, or the frame walk will run sessions together.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import re
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
_HEX = re.compile(r"\A[0-9a-f]{2}\Z")
|
||||||
|
_SOCAT_STATUS = re.compile(r"\A\d{4}/\d{2}/\d{2}")
|
||||||
|
|
||||||
|
|
||||||
|
def split(lines) -> tuple[bytes, bytes]:
|
||||||
|
"""Return (to_device, from_device) byte streams."""
|
||||||
|
to_dev, from_dev = bytearray(), bytearray()
|
||||||
|
cur = None
|
||||||
|
for line in lines:
|
||||||
|
if line.startswith(">"):
|
||||||
|
cur = to_dev
|
||||||
|
continue
|
||||||
|
if line.startswith("<"):
|
||||||
|
cur = from_dev
|
||||||
|
continue
|
||||||
|
if _SOCAT_STATUS.match(line):
|
||||||
|
# socat's own status line ends the current dump block.
|
||||||
|
cur = None
|
||||||
|
continue
|
||||||
|
if cur is None or not line.startswith(" "):
|
||||||
|
continue
|
||||||
|
toks = line.split()
|
||||||
|
if toks and all(_HEX.match(t) for t in toks):
|
||||||
|
cur.extend(int(t, 16) for t in toks)
|
||||||
|
return bytes(to_dev), bytes(from_dev)
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
ap = argparse.ArgumentParser(
|
||||||
|
description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
|
||||||
|
)
|
||||||
|
ap.add_argument("log", help="a socat -x log file")
|
||||||
|
ap.add_argument("--out-dir", default=".", help="where to write the .bin pair")
|
||||||
|
ap.add_argument("--from-line", type=int, default=1,
|
||||||
|
help="first log line to read (1-based) — use the "
|
||||||
|
"'accepting connection' marker of the session you want")
|
||||||
|
ap.add_argument("--to-line", type=int, default=None,
|
||||||
|
help="last log line to read (1-based, inclusive)")
|
||||||
|
ap.add_argument("--prefix", default="raw", help="output basename prefix")
|
||||||
|
args = ap.parse_args()
|
||||||
|
|
||||||
|
lines = Path(args.log).read_text(errors="replace").splitlines()
|
||||||
|
lo = max(args.from_line - 1, 0)
|
||||||
|
hi = args.to_line if args.to_line is not None else len(lines)
|
||||||
|
to_dev, from_dev = split(lines[lo:hi])
|
||||||
|
|
||||||
|
out = Path(args.out_dir)
|
||||||
|
out.mkdir(parents=True, exist_ok=True)
|
||||||
|
bw = out / f"{args.prefix}_bw.bin"
|
||||||
|
s3 = out / f"{args.prefix}_s3.bin"
|
||||||
|
bw.write_bytes(to_dev)
|
||||||
|
s3.write_bytes(from_dev)
|
||||||
|
print(f"Thor -> unit {len(to_dev):>7} bytes {bw}")
|
||||||
|
print(f"unit -> Thor {len(from_dev):>7} bytes {s3}")
|
||||||
|
if not to_dev or not from_dev:
|
||||||
|
print("⚠ one direction is empty — check --from-line / --to-line")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
@@ -305,6 +305,11 @@ def main(argv=None) -> int:
|
|||||||
default=0,
|
default=0,
|
||||||
)
|
)
|
||||||
ev.total_samples = ev.total_samples or n_samp
|
ev.total_samples = ev.total_samples or n_samp
|
||||||
|
# Sensor self-check traces from the IDFW fixed
|
||||||
|
# header, so regenerated .h5 files gain the v2
|
||||||
|
# /sensor_check group (mirrors save_imported_idf).
|
||||||
|
from micromate.sensor_check import decode_idf_sensor_check
|
||||||
|
ev.sensor_check = decode_idf_sensor_check(binary_bytes) or None
|
||||||
|
|
||||||
event_hdf5.write_event_hdf5(
|
event_hdf5.write_event_hdf5(
|
||||||
hdf5_path, ev,
|
hdf5_path, ev,
|
||||||
|
|||||||
@@ -120,6 +120,7 @@ def draw_compliance_chart(ax, channels: Dict[str, Sequence[float]], sps: float)
|
|||||||
ax.set_yscale("log")
|
ax.set_yscale("log")
|
||||||
ax.set_xlim(1, 100)
|
ax.set_xlim(1, 100)
|
||||||
ax.set_ylim(0.0394, 10)
|
ax.set_ylim(0.0394, 10)
|
||||||
|
ax.set_box_aspect(1) # square plot box (log-log compliance charts are square)
|
||||||
xt = [1, 2, 5, 10, 20, 50, 100]
|
xt = [1, 2, 5, 10, 20, 50, 100]
|
||||||
yt = [0.0394, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10]
|
yt = [0.0394, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10]
|
||||||
ax.xaxis.set_major_locator(FixedLocator(xt)); ax.xaxis.set_minor_locator(NullLocator())
|
ax.xaxis.set_major_locator(FixedLocator(xt)); ax.xaxis.set_minor_locator(NullLocator())
|
||||||
|
|||||||
+44
-4
@@ -12,8 +12,11 @@ Layout written to `<filename>.h5`:
|
|||||||
├─ samples_int16/ (optional)
|
├─ samples_int16/ (optional)
|
||||||
│ ├─ Tran (int16, raw ADC counts) shape: (N,)
|
│ ├─ Tran (int16, raw ADC counts) shape: (N,)
|
||||||
│ └─ ... per channel (only when present in the source)
|
│ └─ ... per channel (only when present in the source)
|
||||||
|
├─ sensor_check/ (optional, schema v2+)
|
||||||
|
│ ├─ Tran (int32, raw counts) shape: (M,) M ≪ N
|
||||||
|
│ └─ ... per channel present in the source (MicL absent on 3-channel units)
|
||||||
└─ root attrs (event metadata):
|
└─ root attrs (event metadata):
|
||||||
schema_version int = 1
|
schema_version int = 2
|
||||||
kind str = "sfm.event.hdf5"
|
kind str = "sfm.event.hdf5"
|
||||||
serial str
|
serial str
|
||||||
waveform_key str (8-hex)
|
waveform_key str (8-hex)
|
||||||
@@ -64,7 +67,7 @@ from minimateplus.models import Event
|
|||||||
|
|
||||||
log = logging.getLogger(__name__)
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
SCHEMA_VERSION = 1
|
SCHEMA_VERSION = 2 # v2 adds the optional /sensor_check group
|
||||||
HDF5_KIND = "sfm.event.hdf5"
|
HDF5_KIND = "sfm.event.hdf5"
|
||||||
|
|
||||||
# Geophone full-scale velocity per range (in/s). Confirmed in CLAUDE.md
|
# Geophone full-scale velocity per range (in/s). Confirmed in CLAUDE.md
|
||||||
@@ -270,6 +273,22 @@ def write_event_hdf5(
|
|||||||
)
|
)
|
||||||
igrp.attrs["mic_psi_per_count"] = float(mic_factor)
|
igrp.attrs["mic_psi_per_count"] = float(mic_factor)
|
||||||
|
|
||||||
|
# /sensor_check — optional short diagnostic self-check traces (schema
|
||||||
|
# v2+). Raw ADC counts (a shape diagnostic; the per-series count scale
|
||||||
|
# differs, and the renderer fits each trace to its box). Only channels
|
||||||
|
# the decoder found are written — 3-channel units carry no MicL.
|
||||||
|
sc = event.sensor_check or {}
|
||||||
|
if sc:
|
||||||
|
scgrp = f.create_group("sensor_check")
|
||||||
|
for ch in ("Tran", "Vert", "Long", "MicL"):
|
||||||
|
vals = sc.get(ch)
|
||||||
|
if vals:
|
||||||
|
scgrp.create_dataset(
|
||||||
|
ch, data=np.asarray(vals, dtype=np.int32),
|
||||||
|
compression="gzip", compression_opts=4, shuffle=True,
|
||||||
|
)
|
||||||
|
scgrp.attrs["units"] = "raw_counts"
|
||||||
|
|
||||||
import os
|
import os
|
||||||
os.replace(tmp, path)
|
os.replace(tmp, path)
|
||||||
|
|
||||||
@@ -334,6 +353,16 @@ def read_event_hdf5(path: Union[str, Path]) -> dict:
|
|||||||
if mic_attr is not None:
|
if mic_attr is not None:
|
||||||
mic_psi = float(mic_attr)
|
mic_psi = float(mic_attr)
|
||||||
|
|
||||||
|
# /sensor_check — optional (schema v2+); absent on older files.
|
||||||
|
sensor_check = None
|
||||||
|
scgrp = f.get("sensor_check")
|
||||||
|
if scgrp is not None:
|
||||||
|
sensor_check = {}
|
||||||
|
for ch in ("Tran", "Vert", "Long", "MicL"):
|
||||||
|
ds = scgrp.get(ch)
|
||||||
|
if ds is not None:
|
||||||
|
sensor_check[ch] = np.asarray(ds[()])
|
||||||
|
|
||||||
return {
|
return {
|
||||||
"schema_version": sv,
|
"schema_version": sv,
|
||||||
"kind": attrs.get("kind"),
|
"kind": attrs.get("kind"),
|
||||||
@@ -341,6 +370,7 @@ def read_event_hdf5(path: Union[str, Path]) -> dict:
|
|||||||
"samples": samples,
|
"samples": samples,
|
||||||
"samples_int16": samples_int16,
|
"samples_int16": samples_int16,
|
||||||
"mic_psi_per_count": mic_psi,
|
"mic_psi_per_count": mic_psi,
|
||||||
|
"sensor_check": sensor_check,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -431,11 +461,16 @@ def plot_json_from_hdf5(
|
|||||||
event_id: Optional[str] = None,
|
event_id: Optional[str] = None,
|
||||||
index: Optional[int] = None,
|
index: Optional[int] = None,
|
||||||
) -> dict:
|
) -> dict:
|
||||||
"""Build a `sfm.plot.v1` JSON dict from a stored .h5 file."""
|
"""Build a `sfm.plot.v1` JSON dict from a stored .h5 file.
|
||||||
|
|
||||||
|
The dict also carries a top-level ``sensor_check`` key (the raw self-check
|
||||||
|
traces as ``{ch: [int]}``, or None) beyond the plot schema, so report
|
||||||
|
generation can read the traces from the same single .h5 load.
|
||||||
|
"""
|
||||||
data = read_event_hdf5(path)
|
data = read_event_hdf5(path)
|
||||||
a = data["attrs"]
|
a = data["attrs"]
|
||||||
s = data["samples"]
|
s = data["samples"]
|
||||||
return _build_plot_dict(
|
out = _build_plot_dict(
|
||||||
n_samples=len(s["Tran"]) if "Tran" in s else 0,
|
n_samples=len(s["Tran"]) if "Tran" in s else 0,
|
||||||
sample_rate=int(a.get("sample_rate", 1024) or 1024),
|
sample_rate=int(a.get("sample_rate", 1024) or 1024),
|
||||||
pretrig_samples=int(a.get("pretrig_samples", 0) or 0),
|
pretrig_samples=int(a.get("pretrig_samples", 0) or 0),
|
||||||
@@ -463,6 +498,11 @@ def plot_json_from_hdf5(
|
|||||||
event_id=event_id,
|
event_id=event_id,
|
||||||
index=index,
|
index=index,
|
||||||
)
|
)
|
||||||
|
scd = data.get("sensor_check")
|
||||||
|
out["sensor_check"] = (
|
||||||
|
{ch: v.tolist() for ch, v in scd.items()} if scd else None
|
||||||
|
)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
def _build_plot_dict(
|
def _build_plot_dict(
|
||||||
|
|||||||
+162
-36
@@ -121,6 +121,13 @@ class ReportData:
|
|||||||
t0_ms: Optional[float] = None
|
t0_ms: Optional[float] = None
|
||||||
dt_ms: Optional[float] = None
|
dt_ms: Optional[float] = None
|
||||||
|
|
||||||
|
# Sensor self-check traces — {ch: [samples]} in raw counts, read from the
|
||||||
|
# standardized .h5 (/sensor_check group, schema v2+) where the per-series
|
||||||
|
# decoder stored them at ingest. The little diagnostic waveforms BW draws
|
||||||
|
# in its "Sensor Check" strip. Empty when absent (pre-v2 .h5, histogram,
|
||||||
|
# or 3-channel unit's MicL).
|
||||||
|
sensor_check_waveforms: dict = field(default_factory=dict)
|
||||||
|
|
||||||
# Record-type discriminator
|
# Record-type discriminator
|
||||||
record_type: Optional[str] = None
|
record_type: Optional[str] = None
|
||||||
is_histogram: bool = False
|
is_histogram: bool = False
|
||||||
@@ -246,6 +253,8 @@ def gather_report_data(
|
|||||||
"peak_accel_g": ch.get("peak_accel_g"),
|
"peak_accel_g": ch.get("peak_accel_g"),
|
||||||
"peak_disp_in": ch.get("peak_disp_in"),
|
"peak_disp_in": ch.get("peak_disp_in"),
|
||||||
"sensor_check": sc_ch.get("result"),
|
"sensor_check": sc_ch.get("result"),
|
||||||
|
"sc_freq_hz": sc_ch.get("freq_hz"),
|
||||||
|
"sc_ratio": sc_ch.get("ratio"),
|
||||||
"peak_date": peak_date,
|
"peak_date": peak_date,
|
||||||
"peak_time": peak_time,
|
"peak_time": peak_time,
|
||||||
})
|
})
|
||||||
@@ -287,6 +296,12 @@ def gather_report_data(
|
|||||||
rd.pretrig_samples = ta.get("pretrig_samples")
|
rd.pretrig_samples = ta.get("pretrig_samples")
|
||||||
rd.t0_ms = ta.get("t0_ms")
|
rd.t0_ms = ta.get("t0_ms")
|
||||||
rd.dt_ms = ta.get("dt_ms")
|
rd.dt_ms = ta.get("dt_ms")
|
||||||
|
# Sensor self-check traces — read from the standardized .h5 (schema
|
||||||
|
# v2+). Device-agnostic: whichever decoder produced the event
|
||||||
|
# stored them at ingest, so SFM reads them here without knowing or
|
||||||
|
# caring about the source instrument series. Empty on pre-v2 files
|
||||||
|
# (until backfilled) and on 3-channel / histogram events.
|
||||||
|
rd.sensor_check_waveforms = wf.get("sensor_check") or {}
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
log.warning("gather_report_data: hdf5 read failed: %s", exc)
|
log.warning("gather_report_data: hdf5 read failed: %s", exc)
|
||||||
|
|
||||||
@@ -396,9 +411,34 @@ def _render_waveform_layout(fig, rd: ReportData) -> None:
|
|||||||
ax_stats = fig.add_subplot(gs[2]); ax_stats.axis("off")
|
ax_stats = fig.add_subplot(gs[2]); ax_stats.axis("off")
|
||||||
_draw_channel_stats_waveform(ax_stats, rd)
|
_draw_channel_stats_waveform(ax_stats, rd)
|
||||||
|
|
||||||
|
_draw_compliance_panel(fig, rd)
|
||||||
_draw_waveform_subplot(fig, gs[3], rd)
|
_draw_waveform_subplot(fig, gs[3], rd)
|
||||||
|
|
||||||
|
|
||||||
|
# Compliance-chart placement, in figure fractions. Measured directly off a
|
||||||
|
# Blastware Event Report PDF (ref-stuff/n844lqhbzt0w_bw_pdf.pdf) so the chart
|
||||||
|
# matches BW's size and position: it spans from just under the header down
|
||||||
|
# through the stats band, hard against the right page margin. The left edge
|
||||||
|
# leaves room for the y-axis tick labels + "Velocity (in/s)" title, which the
|
||||||
|
# compacted stats table (see _draw_channel_stats_waveform) is sized to clear.
|
||||||
|
_COMPLIANCE_BOX = (0.489, 0.502, 0.951, 0.867) # x0, y0, x1, y1
|
||||||
|
|
||||||
|
|
||||||
|
def _draw_compliance_panel(fig, rd: ReportData) -> None:
|
||||||
|
"""Large USBM RI8507 compliance chart in the upper-right, sized and
|
||||||
|
positioned to match Blastware's Event Report (see _COMPLIANCE_BOX)."""
|
||||||
|
x0, y0, x1, y1 = _COMPLIANCE_BOX
|
||||||
|
fig.text((x0 + x1) / 2, y1 + 0.006, "USBM RI8507 And OSMRE", fontsize=9,
|
||||||
|
weight="bold", color="#333", ha="center", va="bottom")
|
||||||
|
if rd.channels and rd.sample_rate_sps:
|
||||||
|
from sfm.compliance import draw_compliance_chart
|
||||||
|
ax = fig.add_axes([x0, y0, x1 - x0, y1 - y0])
|
||||||
|
draw_compliance_chart(ax, rd.channels, rd.sample_rate_sps)
|
||||||
|
else:
|
||||||
|
fig.text((x0 + x1) / 2, (y0 + y1) / 2, "(no waveform data)", fontsize=8,
|
||||||
|
color="#bbb", ha="center", va="center", style="italic")
|
||||||
|
|
||||||
|
|
||||||
def _render_histogram_layout(fig, rd: ReportData) -> None:
|
def _render_histogram_layout(fig, rd: ReportData) -> None:
|
||||||
"""Histogram layout: header / mic-only / per-channel stats / bar plot.
|
"""Histogram layout: header / mic-only / per-channel stats / bar plot.
|
||||||
|
|
||||||
@@ -477,11 +517,11 @@ def _split_iso_to_date_time(iso: Optional[str]) -> tuple[Optional[str], Optional
|
|||||||
return (None, None)
|
return (None, None)
|
||||||
|
|
||||||
|
|
||||||
def _kv(ax, x, y, label, value, *, label_w=0.18):
|
def _kv(ax, x, y, label, value, *, label_w=0.18, fontsize=8):
|
||||||
"""Render a 'Label Value' row at axes-coordinates (x, y)."""
|
"""Render a 'Label Value' row at axes-coordinates (x, y)."""
|
||||||
ax.text(x, y, label, fontsize=8, color="#555", ha="left", va="top",
|
ax.text(x, y, label, fontsize=fontsize, color="#555", ha="left", va="top",
|
||||||
transform=ax.transAxes)
|
transform=ax.transAxes)
|
||||||
ax.text(x + label_w, y, _fmt(value), fontsize=8, ha="left", va="top",
|
ax.text(x + label_w, y, _fmt(value), fontsize=fontsize, ha="left", va="top",
|
||||||
transform=ax.transAxes, family="monospace")
|
transform=ax.transAxes, family="monospace")
|
||||||
|
|
||||||
|
|
||||||
@@ -544,14 +584,17 @@ def _draw_header_columns(ax, rows_left, rd: ReportData) -> None:
|
|||||||
("File Name", rd.file_name),
|
("File Name", rd.file_name),
|
||||||
("Post Event Notes", rd.post_event_notes),
|
("Post Event Notes", rd.post_event_notes),
|
||||||
]
|
]
|
||||||
|
# fontsize 7.5 (BW's header is a touch smaller than our body text) + a
|
||||||
|
# tighter right-column value indent so the long serial+firmware line
|
||||||
|
# ("BE##### V ##.##-#.## MiniMate Plus") fits without running off the page.
|
||||||
y = 0.95
|
y = 0.95
|
||||||
dy = 0.095
|
dy = 0.095
|
||||||
for label, value in rows_left:
|
for label, value in rows_left:
|
||||||
_kv(ax, 0.0, y, label, value, label_w=0.18)
|
_kv(ax, 0.0, y, label, value, label_w=0.18, fontsize=7.5)
|
||||||
y -= dy
|
y -= dy
|
||||||
y = 0.95
|
y = 0.95
|
||||||
for label, value in rows_right:
|
for label, value in rows_right:
|
||||||
_kv(ax, 0.55, y, label, value, label_w=0.20)
|
_kv(ax, 0.55, y, label, value, label_w=0.14, fontsize=7.5)
|
||||||
y -= dy
|
y -= dy
|
||||||
|
|
||||||
|
|
||||||
@@ -574,20 +617,14 @@ def _draw_mic_and_usbm(ax, rd: ReportData) -> None:
|
|||||||
transform=ax.transAxes, va="top")
|
transform=ax.transAxes, va="top")
|
||||||
rows = _mic_rows(rd)
|
rows = _mic_rows(rd)
|
||||||
y = 0.80
|
y = 0.80
|
||||||
|
# Tighter label indent + slightly smaller font so the long "Channel Test
|
||||||
|
# Passed (Freq = … Amp = … mv)" line clears the enlarged compliance chart's
|
||||||
|
# left edge (_COMPLIANCE_BOX) instead of running behind it.
|
||||||
for label, value in rows:
|
for label, value in rows:
|
||||||
_kv(ax, 0.0, y, label, value, label_w=0.18)
|
_kv(ax, 0.0, y, label, value, label_w=0.13, fontsize=7)
|
||||||
y -= 0.15
|
y -= 0.15
|
||||||
|
# The USBM compliance chart is drawn as its own large square panel spanning
|
||||||
# USBM RI8507 compliance chart — inset axes in the right half of this band.
|
# the mic + stats rows on the right — see _draw_compliance_panel().
|
||||||
ax.text(0.74, 1.00, "USBM RI8507", fontsize=9, weight="bold", color="#333",
|
|
||||||
ha="center", va="top", transform=ax.transAxes)
|
|
||||||
if rd.channels and rd.sample_rate_sps:
|
|
||||||
from sfm.compliance import draw_compliance_chart
|
|
||||||
inset = ax.inset_axes([0.52, 0.02, 0.46, 0.82])
|
|
||||||
draw_compliance_chart(inset, rd.channels, rd.sample_rate_sps)
|
|
||||||
else:
|
|
||||||
ax.text(0.74, 0.48, "(no waveform data)", fontsize=8, color="#bbb",
|
|
||||||
ha="center", va="center", transform=ax.transAxes, style="italic")
|
|
||||||
|
|
||||||
|
|
||||||
def _mic_rows(rd: ReportData) -> list[tuple[str, Optional[str]]]:
|
def _mic_rows(rd: ReportData) -> list[tuple[str, Optional[str]]]:
|
||||||
@@ -637,8 +674,18 @@ def _draw_channel_stats_waveform(ax, rd: ReportData) -> None:
|
|||||||
("Peak Acceleration", "peak_accel_g", "g"),
|
("Peak Acceleration", "peak_accel_g", "g"),
|
||||||
("Peak Displacement", "peak_disp_in", "in"),
|
("Peak Displacement", "peak_disp_in", "in"),
|
||||||
("Sensor Check", "sensor_check", ""),
|
("Sensor Check", "sensor_check", ""),
|
||||||
|
# Sensor-check sub-rows (indented under "Sensor Check", like BW): the
|
||||||
|
# geophone ring-down frequency + overswing ratio from the self-check.
|
||||||
|
(" Frequency", "sc_freq_hz", "Hz"),
|
||||||
|
(" Overswing Ratio", "sc_ratio", ""),
|
||||||
]
|
]
|
||||||
_draw_stats_table(ax, rd, rows_spec)
|
# Compacted to the left half so the enlarged compliance chart (BW-sized,
|
||||||
|
# right against the page margin) has room — see _COMPLIANCE_BOX.
|
||||||
|
_draw_stats_table(
|
||||||
|
ax, rd, rows_spec,
|
||||||
|
bbox_width=0.42, fontsize=7.5,
|
||||||
|
col_widths=[0.185, 0.065, 0.065, 0.065, 0.040],
|
||||||
|
)
|
||||||
_draw_pvs_summary(ax, rd, n_data_rows=len(rows_spec))
|
_draw_pvs_summary(ax, rd, n_data_rows=len(rows_spec))
|
||||||
|
|
||||||
|
|
||||||
@@ -699,19 +746,39 @@ def _draw_pvs_summary(
|
|||||||
table_bottom_y = getattr(ax, "_stats_table_bottom", -0.10)
|
table_bottom_y = getattr(ax, "_stats_table_bottom", -0.10)
|
||||||
pvs_y = table_bottom_y - 0.04 # small gap below the table border
|
pvs_y = table_bottom_y - 0.04 # small gap below the table border
|
||||||
|
|
||||||
# Centered for visual balance — looks intentional rather than offset.
|
# Centered under the stats table for visual balance — looks intentional
|
||||||
# The original BW-replica had a "NA: Not Applicable" caption below
|
# rather than offset. When the table is compacted (waveform layout), it
|
||||||
# this line; dropped because we use "—" for missing values and the
|
# occupies only the left portion of the axes, so center on the table's
|
||||||
# legend was always squished against the PVS line.
|
# width rather than the full axes (which would push the line under the
|
||||||
ax.text(0.5, pvs_y, line, fontsize=9, weight="bold",
|
# compliance chart). The original BW-replica had a "NA: Not Applicable"
|
||||||
ha="center", va="top", transform=ax.transAxes)
|
# caption below this line; dropped because we use "—" for missing values.
|
||||||
|
table_w = getattr(ax, "_stats_table_width", 0.80)
|
||||||
|
if table_w < 0.79:
|
||||||
|
# Compacted (waveform) layout: left-align under the table, one point
|
||||||
|
# smaller, so the line clears the enlarged compliance chart's
|
||||||
|
# bottom-left tick labels on the right.
|
||||||
|
ax.text(0.0, pvs_y, line, fontsize=8, weight="bold",
|
||||||
|
ha="left", va="top", transform=ax.transAxes)
|
||||||
|
else:
|
||||||
|
ax.text(0.5, pvs_y, line, fontsize=9, weight="bold",
|
||||||
|
ha="center", va="top", transform=ax.transAxes)
|
||||||
|
|
||||||
|
|
||||||
def _draw_stats_table(ax, rd: ReportData, rows_spec: list[tuple[str, str, str]]) -> None:
|
def _draw_stats_table(
|
||||||
|
ax, rd: ReportData, rows_spec: list[tuple[str, str, str]],
|
||||||
|
*, bbox_width: float = 0.80, fontsize: float = 8,
|
||||||
|
col_widths: Optional[list[float]] = None,
|
||||||
|
) -> None:
|
||||||
"""Render a per-channel stats table (Tran/Vert/Long).
|
"""Render a per-channel stats table (Tran/Vert/Long).
|
||||||
|
|
||||||
rows_spec: list of (label, field_name_in_channel_stats, unit_string)
|
rows_spec: list of (label, field_name_in_channel_stats, unit_string)
|
||||||
|
|
||||||
|
``bbox_width`` / ``col_widths`` / ``fontsize`` let a caller compact the
|
||||||
|
table (the waveform layout packs it into the left half to clear the
|
||||||
|
compliance chart; the histogram layout keeps the wider defaults).
|
||||||
"""
|
"""
|
||||||
|
if col_widths is None:
|
||||||
|
col_widths = [0.28, 0.14, 0.14, 0.14, 0.10]
|
||||||
headers = ["", "Tran", "Vert", "Long", ""]
|
headers = ["", "Tran", "Vert", "Long", ""]
|
||||||
ch_lookup = {c["name"]: c for c in rd.channel_stats}
|
ch_lookup = {c["name"]: c for c in rd.channel_stats}
|
||||||
|
|
||||||
@@ -727,6 +794,8 @@ def _draw_stats_table(ax, rd: ReportData, rows_spec: list[tuple[str, str, str]])
|
|||||||
if field == "zc_freq_hz":
|
if field == "zc_freq_hz":
|
||||||
prefix = ">" if ch_rec.get("zc_freq_above_range") else ""
|
prefix = ">" if ch_rec.get("zc_freq_above_range") else ""
|
||||||
return f"{prefix}{val:.0f}"
|
return f"{prefix}{val:.0f}"
|
||||||
|
if field in ("sc_freq_hz", "sc_ratio"):
|
||||||
|
return f"{val:.1f}" # BW shows 1 decimal (7.5 Hz, 3.6)
|
||||||
return f"{val:.3f}"
|
return f"{val:.3f}"
|
||||||
return str(val)
|
return str(val)
|
||||||
|
|
||||||
@@ -751,16 +820,17 @@ def _draw_stats_table(ax, rd: ReportData, rows_spec: list[tuple[str, str, str]])
|
|||||||
table_bottom = 1.0 - table_height
|
table_bottom = 1.0 - table_height
|
||||||
tbl = ax.table(
|
tbl = ax.table(
|
||||||
cellText=table_data,
|
cellText=table_data,
|
||||||
colWidths=[0.28, 0.14, 0.14, 0.14, 0.10],
|
colWidths=col_widths,
|
||||||
cellLoc="left", edges="open",
|
cellLoc="left", edges="open",
|
||||||
bbox=[0.0, table_bottom, 0.80, table_height],
|
bbox=[0.0, table_bottom, bbox_width, table_height],
|
||||||
)
|
)
|
||||||
tbl.auto_set_font_size(False)
|
tbl.auto_set_font_size(False)
|
||||||
tbl.set_fontsize(8)
|
tbl.set_fontsize(fontsize)
|
||||||
for j in range(5):
|
for j in range(5):
|
||||||
tbl[(0, j)].set_text_props(weight="bold", color="#555")
|
tbl[(0, j)].set_text_props(weight="bold", color="#555")
|
||||||
# Stash the bottom Y so _draw_pvs_summary can position itself below.
|
# Stash the bottom Y + width so _draw_pvs_summary can position itself.
|
||||||
ax._stats_table_bottom = table_bottom
|
ax._stats_table_bottom = table_bottom
|
||||||
|
ax._stats_table_width = bbox_width
|
||||||
|
|
||||||
|
|
||||||
def _channel_axis_color(ch: str) -> str:
|
def _channel_axis_color(ch: str) -> str:
|
||||||
@@ -770,9 +840,25 @@ def _channel_axis_color(ch: str) -> str:
|
|||||||
def _draw_waveform_subplot(fig, gridspec_cell, rd: ReportData) -> None:
|
def _draw_waveform_subplot(fig, gridspec_cell, rd: ReportData) -> None:
|
||||||
"""4-channel stacked waveform plot — Instantel printout order
|
"""4-channel stacked waveform plot — Instantel printout order
|
||||||
(MicL on top, Tran on bottom), shared x-axis in SECONDS, trigger
|
(MicL on top, Tran on bottom), shared x-axis in SECONDS, trigger
|
||||||
triangle markers at t=0, '0.0' baseline label on right of each."""
|
triangle markers at t=0, '0.0' baseline label on right of each.
|
||||||
inner = gridspec_cell.subgridspec(4, 1, hspace=0.0)
|
|
||||||
|
When sensor self-check traces are present (rd.sensor_check_waveforms), a
|
||||||
|
narrow "Sensor Check" strip of per-channel mini-plots is drawn to the right,
|
||||||
|
aligned to the lanes — matching Blastware's Event Report.
|
||||||
|
"""
|
||||||
|
from matplotlib.ticker import MaxNLocator
|
||||||
|
|
||||||
order = ["MicL", "Long", "Vert", "Tran"]
|
order = ["MicL", "Long", "Vert", "Tran"]
|
||||||
|
has_sc = bool(rd.sensor_check_waveforms)
|
||||||
|
if has_sc:
|
||||||
|
# main lanes + a narrow sensor-check strip column, flush against the
|
||||||
|
# main panel (BW shares the border — no gap), with the "0.0" baseline
|
||||||
|
# labels moved to the right of the strip. Proportions match BW's
|
||||||
|
# Event Report (main ~0.75 / strip ~0.10 of the panel width).
|
||||||
|
inner = gridspec_cell.subgridspec(4, 2, width_ratios=[1.0, 0.13],
|
||||||
|
wspace=0.0, hspace=0.0)
|
||||||
|
else:
|
||||||
|
inner = gridspec_cell.subgridspec(4, 1, hspace=0.0)
|
||||||
sr = rd.sample_rate_sps or 1024
|
sr = rd.sample_rate_sps or 1024
|
||||||
# Convert ms-based time axis to seconds for the x-axis
|
# Convert ms-based time axis to seconds for the x-axis
|
||||||
dt_s = (rd.dt_ms or (1000.0 / sr)) / 1000.0
|
dt_s = (rd.dt_ms or (1000.0 / sr)) / 1000.0
|
||||||
@@ -791,9 +877,12 @@ def _draw_waveform_subplot(fig, gridspec_cell, rd: ReportData) -> None:
|
|||||||
_geo_amax = _a
|
_geo_amax = _a
|
||||||
geo_shared = max(_geo_amax * 1.10, GEO_FLOOR_INS)
|
geo_shared = max(_geo_amax * 1.10, GEO_FLOOR_INS)
|
||||||
|
|
||||||
|
main_axes = []
|
||||||
|
sc_axes = []
|
||||||
last_idx = len(order) - 1
|
last_idx = len(order) - 1
|
||||||
for i, ch in enumerate(order):
|
for i, ch in enumerate(order):
|
||||||
ax = fig.add_subplot(inner[i])
|
ax = fig.add_subplot(inner[i, 0] if has_sc else inner[i])
|
||||||
|
main_axes.append(ax)
|
||||||
values = rd.channels.get(ch) or []
|
values = rd.channels.get(ch) or []
|
||||||
times = [t0_s + j * dt_s for j in range(len(values))]
|
times = [t0_s + j * dt_s for j in range(len(values))]
|
||||||
|
|
||||||
@@ -811,9 +900,12 @@ def _draw_waveform_subplot(fig, gridspec_cell, rd: ReportData) -> None:
|
|||||||
# Channel label on the LEFT (matches BW)
|
# Channel label on the LEFT (matches BW)
|
||||||
ax.set_ylabel(ch, fontsize=8, rotation=0, ha="right", va="center",
|
ax.set_ylabel(ch, fontsize=8, rotation=0, ha="right", va="center",
|
||||||
color=_channel_axis_color(ch), weight="bold", labelpad=14)
|
color=_channel_axis_color(ch), weight="bold", labelpad=14)
|
||||||
# "0.0" on the RIGHT (BW convention)
|
# "0.0" baseline label on the RIGHT (BW convention). With the sensor-
|
||||||
ax.text(1.005, 0.5, "0.0", transform=ax.transAxes,
|
# check strip attached, it goes to the right of the STRIP (drawn below);
|
||||||
fontsize=7, color="#555", va="center", ha="left")
|
# otherwise just outside the main lane.
|
||||||
|
if not has_sc:
|
||||||
|
ax.text(1.005, 0.5, "0.0", transform=ax.transAxes,
|
||||||
|
fontsize=7, color="#555", va="center", ha="left")
|
||||||
|
|
||||||
ax.grid(True, linestyle="--", linewidth=0.3, color="#bbb", alpha=0.6)
|
ax.grid(True, linestyle="--", linewidth=0.3, color="#bbb", alpha=0.6)
|
||||||
# Vertical dashed trigger line at t=0
|
# Vertical dashed trigger line at t=0
|
||||||
@@ -828,12 +920,46 @@ def _draw_waveform_subplot(fig, gridspec_cell, rd: ReportData) -> None:
|
|||||||
else:
|
else:
|
||||||
ax.tick_params(axis="x", labelsize=7)
|
ax.tick_params(axis="x", labelsize=7)
|
||||||
ax.tick_params(axis="y", labelsize=6)
|
ax.tick_params(axis="y", labelsize=6)
|
||||||
|
# Stacked lanes touch, so the top/bottom y-tick labels of adjacent lanes
|
||||||
|
# would overprint at the shared boundary. Prune the extreme ticks so
|
||||||
|
# each boundary shows clean interior ticks (0.5 / 0.0 / -0.5) only.
|
||||||
|
ax.yaxis.set_major_locator(MaxNLocator(nbins=4, prune="both"))
|
||||||
|
|
||||||
|
# Sensor self-check mini-plot in the right strip (aligned to this lane).
|
||||||
|
if has_sc:
|
||||||
|
scx = fig.add_subplot(inner[i, 1])
|
||||||
|
sc_axes.append(scx)
|
||||||
|
sc_vals = rd.sensor_check_waveforms.get(ch) or []
|
||||||
|
if sc_vals:
|
||||||
|
_col = _channel_axis_color(ch)
|
||||||
|
# Faint zero baseline (BW draws the channel baseline through the
|
||||||
|
# strip) — reference for the one-sided geophone ring-downs.
|
||||||
|
scx.axhline(0.0, color=_col, linewidth=0.3, alpha=0.4)
|
||||||
|
scx.plot(range(len(sc_vals)), sc_vals, color=_col, linewidth=0.5)
|
||||||
|
# Fit the trace to the box (BW-style) rather than a symmetric
|
||||||
|
# scale: the geo self-checks are one-sided dips, so a symmetric
|
||||||
|
# scale would strand them in the bottom half with an empty top.
|
||||||
|
_lo, _hi = min(sc_vals), max(sc_vals)
|
||||||
|
_pad = 0.10 * ((_hi - _lo) or 1.0)
|
||||||
|
scx.set_ylim(_lo - _pad, _hi + _pad)
|
||||||
|
scx.set_xticks([]); scx.set_yticks([])
|
||||||
|
for _s in scx.spines.values():
|
||||||
|
_s.set_linewidth(0.4); _s.set_color("#999")
|
||||||
|
# "0.0" baseline label to the RIGHT of the strip (BW convention)
|
||||||
|
scx.text(1.10, 0.5, "0.0", transform=scx.transAxes,
|
||||||
|
fontsize=7, color="#555", va="center", ha="left")
|
||||||
|
|
||||||
# Trigger triangle marker ▼ above the top channel at t=0
|
# Trigger triangle marker ▼ above the top channel at t=0
|
||||||
top_ax = fig.axes[-4] # MicL is the first added in this gridspec
|
top_ax = main_axes[0] # MicL
|
||||||
top_ax.plot([0], [top_ax.get_ylim()[1]], marker="v", color="black",
|
top_ax.plot([0], [top_ax.get_ylim()[1]], marker="v", color="black",
|
||||||
markersize=8, clip_on=False, zorder=10)
|
markersize=8, clip_on=False, zorder=10)
|
||||||
|
|
||||||
|
# "Sensor Check" caption under the strip (BW convention)
|
||||||
|
if has_sc and sc_axes:
|
||||||
|
pos = sc_axes[-1].get_position()
|
||||||
|
fig.text((pos.x0 + pos.x1) / 2, pos.y0 - 0.012, "Sensor Check",
|
||||||
|
fontsize=7, color="#555", ha="center", va="top")
|
||||||
|
|
||||||
# Compute scale-per-division for the footer (10 divs across the chart)
|
# Compute scale-per-division for the footer (10 divs across the chart)
|
||||||
# and find peak geo amplitude for the geo amp/div setting.
|
# and find peak geo amplitude for the geo amp/div setting.
|
||||||
total_s = times[-1] - times[0] if values else 0
|
total_s = times[-1] - times[0] if values else 0
|
||||||
|
|||||||
+295
-20
@@ -108,6 +108,12 @@
|
|||||||
color: var(--text);
|
color: var(--text);
|
||||||
}
|
}
|
||||||
.btn-ghost:hover { border-color: var(--blue-lt); color: var(--blue-lt); }
|
.btn-ghost:hover { border-color: var(--blue-lt); color: var(--blue-lt); }
|
||||||
|
.btn-danger { background: var(--red); color: #fff; }
|
||||||
|
.btn-danger:hover:not(:disabled) { filter: brightness(1.15); }
|
||||||
|
.diag-result { display:block; margin-top:6px; font-size:12px; opacity:.85;
|
||||||
|
white-space:pre-wrap; word-break:break-word; }
|
||||||
|
.diag-result.ok { color: var(--green); }
|
||||||
|
.diag-result.error { color: var(--red); }
|
||||||
.btn:disabled { background: var(--surface2) !important; color: var(--text-mute) !important; cursor: not-allowed; border-color: var(--border2) !important; }
|
.btn:disabled { background: var(--surface2) !important; color: var(--text-mute) !important; cursor: not-allowed; border-color: var(--border2) !important; }
|
||||||
|
|
||||||
/* #connect-btn styles moved to #live-connect-bar block */
|
/* #connect-btn styles moved to #live-connect-bar block */
|
||||||
@@ -910,6 +916,7 @@
|
|||||||
<button class="tab-btn" data-tab="events" onclick="switchTab('events')">Events</button>
|
<button class="tab-btn" data-tab="events" onclick="switchTab('events')">Events</button>
|
||||||
<button class="tab-btn" data-tab="config" onclick="switchTab('config')">Config</button>
|
<button class="tab-btn" data-tab="config" onclick="switchTab('config')">Config</button>
|
||||||
<button class="tab-btn" data-tab="call-home" onclick="switchTab('call-home')">Call Home</button>
|
<button class="tab-btn" data-tab="call-home" onclick="switchTab('call-home')">Call Home</button>
|
||||||
|
<button class="tab-btn" data-tab="diagnostics" onclick="switchTab('diagnostics')">Diagnostics</button>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<!-- ════════════════════════════════════════════════════════════════
|
<!-- ════════════════════════════════════════════════════════════════
|
||||||
@@ -938,6 +945,10 @@
|
|||||||
<div id="tab-events" class="tab-pane" style="display:flex; flex-direction:column; overflow:hidden;">
|
<div id="tab-events" class="tab-pane" style="display:flex; flex-direction:column; overflow:hidden;">
|
||||||
|
|
||||||
<div class="event-toolbar">
|
<div class="event-toolbar">
|
||||||
|
<button class="btn btn-ghost" id="load-events-btn" onclick="loadEventList()" disabled
|
||||||
|
title="Walk the device's event chain and list its stored events. This is the slow one — it reads every event header over the cellular link.">
|
||||||
|
⟳ Load events
|
||||||
|
</button>
|
||||||
<button class="btn btn-ghost" id="load-btn" onclick="loadWaveform()" disabled>Load Waveform</button>
|
<button class="btn btn-ghost" id="load-btn" onclick="loadWaveform()" disabled>Load Waveform</button>
|
||||||
<button class="btn btn-ghost" id="save-btn" onclick="saveEventToDb()" disabled
|
<button class="btn btn-ghost" id="save-btn" onclick="saveEventToDb()" disabled
|
||||||
title="Download the full waveform from the device and save it to the SFM database + waveform store. Honors the Force refresh toggle.">
|
title="Download the full waveform from the device and save it to the SFM database + waveform store. Honors the Force refresh toggle.">
|
||||||
@@ -1205,6 +1216,77 @@
|
|||||||
|
|
||||||
</div><!-- end #tab-call-home -->
|
</div><!-- end #tab-call-home -->
|
||||||
|
|
||||||
|
<!-- ════════════════════════════════════════════════════════════════
|
||||||
|
TAB: Diagnostics
|
||||||
|
═══════════════════════════════════════════════════════════════════ -->
|
||||||
|
<div id="tab-diagnostics" class="tab-pane">
|
||||||
|
|
||||||
|
<div class="cfg-grid">
|
||||||
|
|
||||||
|
<div class="cfg-section">
|
||||||
|
<div class="cfg-section-title">Device State</div>
|
||||||
|
<div class="hint" style="margin-bottom:10px">
|
||||||
|
Fast probes — POLL plus one read each, about 2 s. None of these walk the event chain.
|
||||||
|
</div>
|
||||||
|
<div class="dev-table" id="diag-table"></div>
|
||||||
|
<div class="cfg-actions" style="margin-top:12px">
|
||||||
|
<button class="btn btn-ghost" id="diag-refresh-btn" onclick="refreshDiagnostics()" disabled>Refresh</button>
|
||||||
|
<span id="diag-status"></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="cfg-section">
|
||||||
|
<div class="cfg-section-title">Actions</div>
|
||||||
|
|
||||||
|
<div class="cfg-field">
|
||||||
|
<label>Stop Monitoring</label>
|
||||||
|
<button class="btn btn-ghost" id="diag-stop-btn" onclick="diagStopMonitoring()" disabled>Send Stop (SUB 0x97)</button>
|
||||||
|
<div class="hint">Halts recording. On a unit triggering continuously, this is what breaks the call-home loop.</div>
|
||||||
|
<span class="diag-result" id="diag-stop-result"></span>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="cfg-field">
|
||||||
|
<label>Disable Auto Call Home</label>
|
||||||
|
<button class="btn btn-ghost" id="diag-ach-btn" onclick="diagDisableAch()" disabled>Disable ACH</button>
|
||||||
|
<div class="hint">Stored events are left untouched (<code>rescue?erase=false</code>). The unit stops dialing out until ACH is re-enabled.</div>
|
||||||
|
<span class="diag-result" id="diag-ach-result"></span>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="cfg-field">
|
||||||
|
<label>Erase All Events</label>
|
||||||
|
<input type="text" id="diag-erase-confirm" placeholder="Type the serial to enable"
|
||||||
|
oninput="diagCheckEraseConfirm()" autocomplete="off" />
|
||||||
|
<button class="btn btn-danger" id="diag-erase-btn" onclick="diagEraseEvents()" disabled>Erase Events</button>
|
||||||
|
<div class="hint">⚠ Permanent, and resets the event chain to key <code>0x01110000</code>. Download anything worth keeping first.</div>
|
||||||
|
<span class="diag-result" id="diag-erase-result"></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="cfg-section">
|
||||||
|
<div class="cfg-section-title">Unresponsive Unit</div>
|
||||||
|
<div class="hint" style="margin-bottom:10px">
|
||||||
|
The escalation ladder from <code>docs/runbooks/wedged_unit_recovery.md</code>, for a unit too busy
|
||||||
|
to answer normal request/response. Prefer <b>Method A</b> — point the modem at an
|
||||||
|
<code>ach_server</code> and answer its call — before racing it with these.
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="cfg-field">
|
||||||
|
<label>Slow drip <span class="hint" style="display:inline">(one held session, a stop every 3 s)</span></label>
|
||||||
|
<button class="btn btn-ghost" id="diag-drip-btn" onclick="diagSlowDrip()" disabled>Run 120 s drip</button>
|
||||||
|
<div class="hint">Success is <code>bytes_received > 0</code>. A full duration with <code>send_error: null</code> is <b>not</b> success on its own.</div>
|
||||||
|
<span class="diag-result" id="diag-drip-result"></span>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="cfg-field">
|
||||||
|
<label>Blind stop <span class="hint" style="display:inline">(fire-and-forget, one attempt)</span></label>
|
||||||
|
<button class="btn btn-ghost" id="diag-blind-btn" onclick="diagBlindStop()" disabled>Send blind stop</button>
|
||||||
|
<span class="diag-result" id="diag-blind-result"></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><!-- end #tab-diagnostics -->
|
||||||
|
|
||||||
</div><!-- end #section-live -->
|
</div><!-- end #section-live -->
|
||||||
|
|
||||||
<!-- ════════════════════════════════════════════════════════════════
|
<!-- ════════════════════════════════════════════════════════════════
|
||||||
@@ -1361,6 +1443,8 @@
|
|||||||
// ── State ──────────────────────────────────────────────────────────────────────
|
// ── State ──────────────────────────────────────────────────────────────────────
|
||||||
let unitInfo = null;
|
let unitInfo = null;
|
||||||
let eventList = [];
|
let eventList = [];
|
||||||
|
let storageInfo = null; // /device/events/storage_range — cheap, read on connect
|
||||||
|
let eventsLoaded = false; // the event chain walk is opt-in; see loadEventList()
|
||||||
let currentEvent = 0;
|
let currentEvent = 0;
|
||||||
let charts = {};
|
let charts = {};
|
||||||
let geoAdcScale = 6.206;
|
let geoAdcScale = 6.206;
|
||||||
@@ -1458,6 +1542,7 @@ function switchTab(name) {
|
|||||||
if (name === 'units') { if (!unitsLoaded) loadUnits(); }
|
if (name === 'units') { if (!unitsLoaded) loadUnits(); }
|
||||||
if (name === 'monlog') { if (!monlogLoaded) loadMonitorLog(); }
|
if (name === 'monlog') { if (!monlogLoaded) loadMonitorLog(); }
|
||||||
if (name === 'sessions') { if (!sessLoaded) loadSessions(); }
|
if (name === 'sessions') { if (!sessLoaded) loadSessions(); }
|
||||||
|
if (name === 'diagnostics' && devHost() && unitInfo) refreshDiagnostics();
|
||||||
}
|
}
|
||||||
|
|
||||||
// ── Connect ────────────────────────────────────────────────────────────────────
|
// ── Connect ────────────────────────────────────────────────────────────────────
|
||||||
@@ -1478,18 +1563,13 @@ async function connectUnit() {
|
|||||||
btn.disabled = false; btn.textContent = 'Connect'; return;
|
btn.disabled = false; btn.textContent = 'Connect'; return;
|
||||||
}
|
}
|
||||||
|
|
||||||
setStatus('Fetching event list…', 'loading');
|
// Connecting deliberately does NOT walk the event chain. That walk reads
|
||||||
try {
|
// every event header over the cellular link and can take minutes — or fail
|
||||||
const r = await fetch(`${api()}/device/events?${deviceParams()}`);
|
// outright on a unit whose buffer has wrapped past 0xFFFF. Use the ~2 s
|
||||||
if (!r.ok) { const e = await r.json().catch(() => ({})); throw new Error(e.detail || r.statusText); }
|
// probes instead; the event list is opt-in via loadEventList().
|
||||||
const evData = await r.json();
|
eventList = []; eventsLoaded = false;
|
||||||
eventList = evData.events || [];
|
setStatus('Reading device state…', 'loading');
|
||||||
// Merge compliance from /device/events response (it re-reads it)
|
storageInfo = await fetchJson(`/device/events/storage_range`).catch(() => null);
|
||||||
if (evData.device) unitInfo = { ...unitInfo, ...evData.device };
|
|
||||||
} catch (e) {
|
|
||||||
setStatus(`Event fetch failed: ${e.message}`, 'error');
|
|
||||||
btn.disabled = false; btn.textContent = 'Reconnect'; return;
|
|
||||||
}
|
|
||||||
|
|
||||||
populateDeviceBar();
|
populateDeviceBar();
|
||||||
populateDeviceTab();
|
populateDeviceTab();
|
||||||
@@ -1498,11 +1578,9 @@ async function connectUnit() {
|
|||||||
|
|
||||||
document.getElementById('device-bar').style.display = 'flex';
|
document.getElementById('device-bar').style.display = 'flex';
|
||||||
document.getElementById('monitor-panel').style.display = 'flex';
|
document.getElementById('monitor-panel').style.display = 'flex';
|
||||||
document.getElementById('load-btn').disabled = eventList.length === 0;
|
setEventButtonsEnabled();
|
||||||
document.getElementById('save-btn').disabled = eventList.length === 0;
|
document.getElementById('load-events-btn').disabled = false;
|
||||||
document.getElementById('download-btn').disabled = eventList.length === 0;
|
setDiagButtonsEnabled(true);
|
||||||
document.getElementById('prev-btn').disabled = true;
|
|
||||||
document.getElementById('next-btn').disabled = eventList.length <= 1;
|
|
||||||
document.getElementById('cfg-read-btn').disabled = false;
|
document.getElementById('cfg-read-btn').disabled = false;
|
||||||
document.getElementById('cfg-write-btn').disabled = false;
|
document.getElementById('cfg-write-btn').disabled = false;
|
||||||
document.getElementById('ch-read-btn').disabled = false;
|
document.getElementById('ch-read-btn').disabled = false;
|
||||||
@@ -1510,7 +1588,9 @@ async function connectUnit() {
|
|||||||
|
|
||||||
btn.disabled = false; btn.textContent = 'Reconnect';
|
btn.disabled = false; btn.textContent = 'Reconnect';
|
||||||
|
|
||||||
setStatus(`Connected — ${eventList.length} event${eventList.length !== 1 ? 's' : ''} stored.`, 'ok');
|
setStatus(storageInfo && storageInfo.is_empty
|
||||||
|
? 'Connected — no events stored.'
|
||||||
|
: 'Connected. Event list not loaded (Events → Load events).', 'ok');
|
||||||
|
|
||||||
// Fetch monitor status in background (non-blocking)
|
// Fetch monitor status in background (non-blocking)
|
||||||
refreshMonitorStatus().catch(() => {});
|
refreshMonitorStatus().catch(() => {});
|
||||||
@@ -1522,6 +1602,48 @@ async function connectUnit() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ── Shared fetch helper ────────────────────────────────────────────────────────
|
||||||
|
async function fetchJson(path, opts) {
|
||||||
|
const sep = path.includes('?') ? '&' : '?';
|
||||||
|
const r = await fetch(`${api()}${path}${sep}${deviceParams()}`, opts);
|
||||||
|
const body = await r.json().catch(() => ({}));
|
||||||
|
if (!r.ok) throw new Error(body.detail || r.statusText);
|
||||||
|
return body;
|
||||||
|
}
|
||||||
|
|
||||||
|
function setEventButtonsEnabled() {
|
||||||
|
const n = eventList.length;
|
||||||
|
document.getElementById('load-btn').disabled = n === 0;
|
||||||
|
document.getElementById('save-btn').disabled = n === 0;
|
||||||
|
document.getElementById('download-btn').disabled = n === 0;
|
||||||
|
document.getElementById('prev-btn').disabled = true;
|
||||||
|
document.getElementById('next-btn').disabled = n <= 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Event list (opt-in — this is the slow chain walk) ──────────────────────────
|
||||||
|
async function loadEventList() {
|
||||||
|
if (!devHost()) { setStatus('Connect to a device first.', 'error'); return; }
|
||||||
|
const btn = document.getElementById('load-events-btn');
|
||||||
|
btn.disabled = true;
|
||||||
|
setStatus('Walking the event chain — this can take a while…', 'loading');
|
||||||
|
try {
|
||||||
|
const evData = await fetchJson('/device/events');
|
||||||
|
eventList = evData.events || [];
|
||||||
|
eventsLoaded = true;
|
||||||
|
// /device/events re-reads compliance; fold it in.
|
||||||
|
if (evData.device) unitInfo = { ...unitInfo, ...evData.device };
|
||||||
|
} catch (e) {
|
||||||
|
setStatus(`Event fetch failed: ${e.message}`, 'error');
|
||||||
|
btn.disabled = false; return;
|
||||||
|
}
|
||||||
|
populateDeviceBar();
|
||||||
|
populateDeviceTab();
|
||||||
|
populateEventChips();
|
||||||
|
setEventButtonsEnabled();
|
||||||
|
btn.disabled = false;
|
||||||
|
setStatus(`${eventList.length} event${eventList.length !== 1 ? 's' : ''} stored.`, 'ok');
|
||||||
|
}
|
||||||
|
|
||||||
// ── Device bar ─────────────────────────────────────────────────────────────────
|
// ── Device bar ─────────────────────────────────────────────────────────────────
|
||||||
function populateDeviceBar() {
|
function populateDeviceBar() {
|
||||||
qs('di-serial').textContent = unitInfo.serial || '—';
|
qs('di-serial').textContent = unitInfo.serial || '—';
|
||||||
@@ -1530,7 +1652,7 @@ function populateDeviceBar() {
|
|||||||
qs('di-sr').textContent = cc.sample_rate ? `${cc.sample_rate} sps` : '—';
|
qs('di-sr').textContent = cc.sample_rate ? `${cc.sample_rate} sps` : '—';
|
||||||
qs('di-rt').textContent = cc.record_time != null ? `${cc.record_time.toFixed(1)} s` : '—';
|
qs('di-rt').textContent = cc.record_time != null ? `${cc.record_time.toFixed(1)} s` : '—';
|
||||||
qs('di-trig').textContent = cc.trigger_level_geo != null ? `${cc.trigger_level_geo.toFixed(3)} in/s` : '—';
|
qs('di-trig').textContent = cc.trigger_level_geo != null ? `${cc.trigger_level_geo.toFixed(3)} in/s` : '—';
|
||||||
qs('di-count').textContent = eventList.length;
|
qs('di-count').textContent = eventsLoaded ? eventList.length : '—';
|
||||||
qs('di-project').textContent = cc.project || '—';
|
qs('di-project').textContent = cc.project || '—';
|
||||||
qs('di-client').textContent = cc.client || '—';
|
qs('di-client').textContent = cc.client || '—';
|
||||||
qs('di-operator').textContent = cc.operator || '—';
|
qs('di-operator').textContent = cc.operator || '—';
|
||||||
@@ -1660,7 +1782,8 @@ function populateDeviceTab() {
|
|||||||
{ label:'DSP', value: unitInfo.dsp_version || '—' },
|
{ label:'DSP', value: unitInfo.dsp_version || '—' },
|
||||||
{ label:'Model', value: unitInfo.model || '—' },
|
{ label:'Model', value: unitInfo.model || '—' },
|
||||||
{ label:'Manufacturer', value: unitInfo.manufacturer || '—' },
|
{ label:'Manufacturer', value: unitInfo.manufacturer || '—' },
|
||||||
{ label:'Stored Events', value: eventList.length },
|
{ label:'Stored Events', value: eventsLoaded ? eventList.length : 'not loaded' },
|
||||||
|
{ label:'Storage Used', value: storageUsedLabel() },
|
||||||
];
|
];
|
||||||
for (const {label, value} of cardData) {
|
for (const {label, value} of cardData) {
|
||||||
const c = document.createElement('div');
|
const c = document.createElement('div');
|
||||||
@@ -1707,6 +1830,158 @@ function renderTable(id, rows) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ── Diagnostics ────────────────────────────────────────────────────────────────
|
||||||
|
// Everything here is a cheap probe (POLL + one read) or a single write. None of
|
||||||
|
// it walks the event chain. See docs/runbooks/wedged_unit_recovery.md.
|
||||||
|
|
||||||
|
function storageUsedLabel() {
|
||||||
|
if (!storageInfo) return '—';
|
||||||
|
if (storageInfo.is_empty) return 'empty';
|
||||||
|
const f = storageInfo.first_key, l = storageInfo.last_key;
|
||||||
|
return (f && l) ? `${f} → ${l}` : '—';
|
||||||
|
}
|
||||||
|
|
||||||
|
function setDiagButtonsEnabled(on) {
|
||||||
|
for (const id of ['diag-refresh-btn','diag-stop-btn','diag-ach-btn',
|
||||||
|
'diag-drip-btn','diag-blind-btn']) {
|
||||||
|
const el = document.getElementById(id);
|
||||||
|
if (el) el.disabled = !on;
|
||||||
|
}
|
||||||
|
diagCheckEraseConfirm();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Erase is guarded by typing the serial — auth answers "who", not "did you mean it".
|
||||||
|
function diagCheckEraseConfirm() {
|
||||||
|
const box = document.getElementById('diag-erase-confirm');
|
||||||
|
const btn = document.getElementById('diag-erase-btn');
|
||||||
|
if (!box || !btn) return;
|
||||||
|
const serial = (unitInfo && unitInfo.serial) || '';
|
||||||
|
btn.disabled = !serial || box.value.trim().toUpperCase() !== serial.toUpperCase();
|
||||||
|
}
|
||||||
|
|
||||||
|
function diagResult(id, text, cls) {
|
||||||
|
const el = document.getElementById(id);
|
||||||
|
if (!el) return;
|
||||||
|
el.textContent = text;
|
||||||
|
el.className = 'diag-result' + (cls ? ' ' + cls : '');
|
||||||
|
}
|
||||||
|
|
||||||
|
async function refreshDiagnostics() {
|
||||||
|
if (!devHost()) return;
|
||||||
|
const st = document.getElementById('diag-status');
|
||||||
|
if (st) { st.textContent = 'Reading…'; st.className = 'loading'; }
|
||||||
|
|
||||||
|
const [mon, store, idx] = await Promise.all([
|
||||||
|
fetchJson('/device/monitor/status?force=true').catch(e => ({ _err: e.message })),
|
||||||
|
fetchJson('/device/events/storage_range').catch(e => ({ _err: e.message })),
|
||||||
|
fetchJson('/device/events/index').catch(e => ({ _err: e.message })),
|
||||||
|
]);
|
||||||
|
|
||||||
|
if (!store._err) storageInfo = store;
|
||||||
|
|
||||||
|
const err = v => `<span style="color:var(--red)">${v}</span>`;
|
||||||
|
const rows = [];
|
||||||
|
|
||||||
|
rows.push(['Monitoring', mon._err ? err(mon._err)
|
||||||
|
: (mon.is_monitoring ? '<b>MONITORING</b>' : 'idle')]);
|
||||||
|
if (!mon._err) {
|
||||||
|
rows.push(['Battery', mon.battery_v != null ? `${mon.battery_v.toFixed(2)} V` : '—']);
|
||||||
|
if (mon.memory_total_bytes) {
|
||||||
|
const used = mon.memory_total_bytes - (mon.memory_free_bytes ?? 0);
|
||||||
|
const pct = (used / mon.memory_total_bytes * 100).toFixed(1);
|
||||||
|
rows.push(['Memory used', `${used.toLocaleString()} / ${mon.memory_total_bytes.toLocaleString()} bytes (${pct}%)`]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
rows.push(['Event chain', store._err ? err(store._err) : storageUsedLabel()]);
|
||||||
|
if (!store._err) rows.push(['Chain empty', store.is_empty ? 'yes' : 'no']);
|
||||||
|
|
||||||
|
// SUB 0x08. Known to report 0 on units with years of history — suspected
|
||||||
|
// field-offset bug in the decode, so show it but do not trust it.
|
||||||
|
rows.push(['Lifetime events', idx._err ? err(idx._err)
|
||||||
|
: `${idx.lifetime_count} <span class="hint" style="display:inline">(unreliable — see CHANGELOG)</span>`]);
|
||||||
|
|
||||||
|
renderTable('diag-table', rows);
|
||||||
|
populateDeviceTab();
|
||||||
|
if (st) { st.textContent = ''; st.className = ''; }
|
||||||
|
}
|
||||||
|
|
||||||
|
async function diagStopMonitoring() {
|
||||||
|
const btn = document.getElementById('diag-stop-btn');
|
||||||
|
btn.disabled = true; diagResult('diag-stop-result', 'Sending…');
|
||||||
|
try {
|
||||||
|
await fetchJson('/device/monitor/stop', { method: 'POST' });
|
||||||
|
diagResult('diag-stop-result', 'Stop acknowledged — recording halted.', 'ok');
|
||||||
|
refreshDiagnostics();
|
||||||
|
} catch (e) {
|
||||||
|
diagResult('diag-stop-result', `Failed: ${e.message}`, 'error');
|
||||||
|
}
|
||||||
|
btn.disabled = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function diagDisableAch() {
|
||||||
|
const btn = document.getElementById('diag-ach-btn');
|
||||||
|
btn.disabled = true; diagResult('diag-ach-result', 'Writing call-home config…');
|
||||||
|
try {
|
||||||
|
const r = await fetchJson('/device/rescue?erase=false', { method: 'POST' });
|
||||||
|
const steps = (r.steps || []).map(s => s.step).join(' → ') || 'done';
|
||||||
|
diagResult('diag-ach-result', `ACH disabled (${steps}). Events untouched.`, 'ok');
|
||||||
|
} catch (e) {
|
||||||
|
diagResult('diag-ach-result', `Failed: ${e.message}`, 'error');
|
||||||
|
}
|
||||||
|
btn.disabled = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function diagEraseEvents() {
|
||||||
|
const serial = (unitInfo && unitInfo.serial) || 'this unit';
|
||||||
|
if (!confirm(`Permanently erase ALL events on ${serial}?\n\nThis cannot be undone.`)) return;
|
||||||
|
const btn = document.getElementById('diag-erase-btn');
|
||||||
|
btn.disabled = true; diagResult('diag-erase-result', 'Erasing…');
|
||||||
|
try {
|
||||||
|
await fetchJson('/device/events/erase', { method: 'POST' });
|
||||||
|
diagResult('diag-erase-result', 'Events erased — chain reset to 0x01110000.', 'ok');
|
||||||
|
document.getElementById('diag-erase-confirm').value = '';
|
||||||
|
eventList = []; eventsLoaded = false;
|
||||||
|
setEventButtonsEnabled(); populateEventChips();
|
||||||
|
refreshDiagnostics();
|
||||||
|
} catch (e) {
|
||||||
|
diagResult('diag-erase-result', `Failed: ${e.message}`, 'error');
|
||||||
|
}
|
||||||
|
diagCheckEraseConfirm();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function diagSlowDrip() {
|
||||||
|
const btn = document.getElementById('diag-drip-btn');
|
||||||
|
btn.disabled = true;
|
||||||
|
diagResult('diag-drip-result', 'Holding a session for 120 s…');
|
||||||
|
try {
|
||||||
|
const r = await fetchJson('/device/stop_monitoring_slow_drip?duration_s=120&interval_s=3',
|
||||||
|
{ method: 'POST' });
|
||||||
|
const good = (r.bytes_received || 0) > 0;
|
||||||
|
diagResult('diag-drip-result',
|
||||||
|
`drips ${r.drips_sent} · held ${r.duration_s}s · bytes back ${r.bytes_received}` +
|
||||||
|
(r.send_error ? ` · ${r.send_error}` : '') +
|
||||||
|
(good ? ' → device responded' : ' → no response; the modem may not be bridging'),
|
||||||
|
good ? 'ok' : 'error');
|
||||||
|
} catch (e) {
|
||||||
|
diagResult('diag-drip-result', `Failed: ${e.message}`, 'error');
|
||||||
|
}
|
||||||
|
btn.disabled = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function diagBlindStop() {
|
||||||
|
const btn = document.getElementById('diag-blind-btn');
|
||||||
|
btn.disabled = true; diagResult('diag-blind-result', 'Sending…');
|
||||||
|
try {
|
||||||
|
const r = await fetchJson('/device/stop_monitoring_blind', { method: 'POST' });
|
||||||
|
diagResult('diag-blind-result',
|
||||||
|
`Sent ${r.bytes_sent ?? '?'} bytes, no response read (fire-and-forget).`, 'ok');
|
||||||
|
} catch (e) {
|
||||||
|
diagResult('diag-blind-result', `Failed: ${e.message}`, 'error');
|
||||||
|
}
|
||||||
|
btn.disabled = false;
|
||||||
|
}
|
||||||
|
|
||||||
// ── Config form ────────────────────────────────────────────────────────────────
|
// ── Config form ────────────────────────────────────────────────────────────────
|
||||||
function populateConfigFromDeviceInfo() {
|
function populateConfigFromDeviceInfo() {
|
||||||
if (!unitInfo) return;
|
if (!unitInfo) return;
|
||||||
|
|||||||
@@ -662,6 +662,11 @@ class WaveformStore:
|
|||||||
ev.raw_samples = idf_samples
|
ev.raw_samples = idf_samples
|
||||||
n_samples = max((len(idf_samples.get(ch, [])) for ch in ("Tran", "Vert", "Long", "MicL")), default=0)
|
n_samples = max((len(idf_samples.get(ch, [])) for ch in ("Tran", "Vert", "Long", "MicL")), default=0)
|
||||||
ev.total_samples = ev.total_samples or n_samples
|
ev.total_samples = ev.total_samples or n_samples
|
||||||
|
# Sensor self-check traces from the IDFW fixed header (waveform
|
||||||
|
# events only; {} on histograms / when absent). Carried on the
|
||||||
|
# bridged Event so the .h5 writer persists them like series-3.
|
||||||
|
from micromate.sensor_check import decode_idf_sensor_check
|
||||||
|
ev.sensor_check = decode_idf_sensor_check(idf_bytes) or None
|
||||||
|
|
||||||
# For IDFH histograms there are no per-sample waveform arrays — the
|
# For IDFH histograms there are no per-sample waveform arrays — the
|
||||||
# device stores one peak ADC count per interval per channel. Synthesise
|
# device stores one peak ADC count per interval per channel. Synthesise
|
||||||
|
|||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Vendored
BIN
Binary file not shown.
@@ -0,0 +1,71 @@
|
|||||||
|
"""The event .h5 carries the sensor self-check traces (schema v2).
|
||||||
|
|
||||||
|
The sensor check is decoded by the per-series decoder and attached to the
|
||||||
|
standardized Event, so the .h5 writer persists it device-agnostically and SFM
|
||||||
|
reads it back without knowing which instrument produced it. Old v1 files (no
|
||||||
|
sensor_check group) must still read cleanly.
|
||||||
|
"""
|
||||||
|
import tempfile
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
from minimateplus.models import Event
|
||||||
|
from minimateplus.event_file_io import read_blastware_file
|
||||||
|
from sfm import event_hdf5
|
||||||
|
|
||||||
|
S3_FIX = Path(__file__).parent / "fixtures" / "fft-oracle-2026-09-14" / "N844LQHB.ZT0W"
|
||||||
|
|
||||||
|
|
||||||
|
def _write(ev, **kw):
|
||||||
|
d = Path(tempfile.mkdtemp())
|
||||||
|
p = d / "e.h5"
|
||||||
|
event_hdf5.write_event_hdf5(p, ev, serial="BE12844", **kw)
|
||||||
|
return p
|
||||||
|
|
||||||
|
|
||||||
|
def test_sensor_check_roundtrips_through_hdf5():
|
||||||
|
ev = Event(index=0)
|
||||||
|
ev.raw_samples = {"Tran": [1, 2, -3], "Vert": [0, 1], "Long": [2], "MicL": [5, -5]}
|
||||||
|
ev.sample_rate = 1024
|
||||||
|
sc = {"Tran": [0, -990, -500, -100], "Vert": [0, -980, -480],
|
||||||
|
"Long": [0, -986, -470], "MicL": [0, -1800, 1800, -1800]}
|
||||||
|
ev.sensor_check = sc
|
||||||
|
|
||||||
|
r = event_hdf5.read_event_hdf5(_write(ev))
|
||||||
|
assert r["schema_version"] == 2
|
||||||
|
assert set(r["sensor_check"]) == {"Tran", "Vert", "Long", "MicL"}
|
||||||
|
for ch, vals in sc.items():
|
||||||
|
assert r["sensor_check"][ch].tolist() == vals
|
||||||
|
|
||||||
|
|
||||||
|
def test_plot_json_carries_sensor_check():
|
||||||
|
ev = Event(index=0)
|
||||||
|
ev.raw_samples = {"Tran": [1, 2, 3]}
|
||||||
|
ev.sample_rate = 1024
|
||||||
|
ev.sensor_check = {"Tran": [0, -990, -500], "Vert": [0, -980],
|
||||||
|
"Long": [0, -986]} # 3-channel: no MicL
|
||||||
|
pj = event_hdf5.plot_json_from_hdf5(_write(ev))
|
||||||
|
assert pj["sensor_check"] is not None
|
||||||
|
assert "MicL" not in pj["sensor_check"]
|
||||||
|
assert pj["sensor_check"]["Tran"] == [0, -990, -500]
|
||||||
|
|
||||||
|
|
||||||
|
def test_event_without_sensor_check_still_reads_as_v2():
|
||||||
|
ev = Event(index=0)
|
||||||
|
ev.raw_samples = {"Tran": [1, 2, 3]}
|
||||||
|
ev.sample_rate = 1024
|
||||||
|
r = event_hdf5.read_event_hdf5(_write(ev))
|
||||||
|
assert r["schema_version"] == 2
|
||||||
|
assert r["sensor_check"] is None
|
||||||
|
assert event_hdf5.plot_json_from_hdf5(_write(ev))["sensor_check"] is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_series3_decode_populates_event_sensor_check():
|
||||||
|
# The real series-3 decoder attaches the traces to the Event, so the
|
||||||
|
# ingest/backfill .h5 write picks them up with no extra plumbing.
|
||||||
|
ev = read_blastware_file(S3_FIX)
|
||||||
|
assert ev.sensor_check is not None
|
||||||
|
assert set(ev.sensor_check) == {"Tran", "Vert", "Long", "MicL"}
|
||||||
|
tran = np.asarray(ev.sensor_check["Tran"], dtype=float)
|
||||||
|
assert tran.min() < -800 # the geophone ring-down deflection
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
"""Event timestamp decode — waveform trigger/stop vs histogram window start.
|
||||||
|
|
||||||
|
The Blastware footer holds two timestamps: ts1 = footer[2:10], ts2 = footer[10:18].
|
||||||
|
Their meaning depends on record type:
|
||||||
|
|
||||||
|
* Waveform: ts1 is the monitoring-SESSION start (e.g. 06:00 for a unit that
|
||||||
|
arms at 06:00 daily — shared across every event that day), and ts2 is THIS
|
||||||
|
event's recording STOP. read_blastware_file used to stamp events with ts1 →
|
||||||
|
every waveform showed the session start (~4.5 h off). Binary-only, the best
|
||||||
|
estimate is ts2 (the stop); the exact trigger BW displays (= ts2 - record
|
||||||
|
duration) comes from the paired report's event_datetime, since the binary
|
||||||
|
STRT record-time byte is a misparsed record-type marker.
|
||||||
|
* Histogram: ts1/ts2 are the ~24 h window [start, stop]; the event time is the
|
||||||
|
window start = ts1 (unchanged).
|
||||||
|
"""
|
||||||
|
import datetime
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from minimateplus.event_file_io import read_blastware_file, apply_report_to_event
|
||||||
|
from minimateplus.bw_ascii_report import BwAsciiReport
|
||||||
|
from minimateplus.models import Event
|
||||||
|
|
||||||
|
FIX = Path(__file__).parent / "fixtures"
|
||||||
|
WAVEFORM = FIX / "fft-oracle-2026-09-14" / "N844LQHB.ZT0W" # footer ts2 = 2026-08-25 10:33:32
|
||||||
|
HISTOGRAM = FIX / "ts-fix" / "K441LKZU.C30H" # window start 2026-05-10 19:04:50
|
||||||
|
|
||||||
|
|
||||||
|
def _tuple(ts):
|
||||||
|
return (ts.year, ts.month, ts.day, ts.hour, ts.minute, ts.second)
|
||||||
|
|
||||||
|
|
||||||
|
def test_waveform_timestamp_is_exact_trigger_from_binary():
|
||||||
|
ev = read_blastware_file(WAVEFORM)
|
||||||
|
# The EXACT Blastware trigger, from the binary alone: ts2 (stop 10:33:32)
|
||||||
|
# minus the config record time (3.0 s) = 10:33:29 — NOT the 06:00:13
|
||||||
|
# monitoring-session start the old decode used.
|
||||||
|
assert _tuple(ev.timestamp) == (2026, 8, 25, 10, 33, 29), _tuple(ev.timestamp)
|
||||||
|
|
||||||
|
|
||||||
|
def test_histogram_timestamp_is_window_start_unchanged():
|
||||||
|
ev = read_blastware_file(HISTOGRAM)
|
||||||
|
# Histogram event time = the window start (ts1); must NOT get the waveform
|
||||||
|
# ts2 treatment (that would land ~24 h off).
|
||||||
|
assert _tuple(ev.timestamp) == (2026, 5, 10, 19, 4, 50), _tuple(ev.timestamp)
|
||||||
|
|
||||||
|
|
||||||
|
def test_report_event_datetime_is_authoritative_over_binary():
|
||||||
|
# The binary already yields the exact trigger, but a paired report stays
|
||||||
|
# authoritative (e.g. if the unit clock had drifted) — applying it wins.
|
||||||
|
ev = read_blastware_file(WAVEFORM)
|
||||||
|
assert _tuple(ev.timestamp) == (2026, 8, 25, 10, 33, 29) # exact, from binary
|
||||||
|
apply_report_to_event(ev, BwAsciiReport(
|
||||||
|
event_datetime=datetime.datetime(2026, 8, 25, 10, 35, 0)))
|
||||||
|
assert _tuple(ev.timestamp) == (2026, 8, 25, 10, 35, 0) # report wins
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
"""Blastware sensor self-check waveform decode (minimateplus.sensor_check).
|
||||||
|
|
||||||
|
Reverse-engineered 2026-09-15 against 7 BE12844 (MiniMate Plus) oracle events.
|
||||||
|
After the main waveform record-chain and the trailing metadata / per-channel
|
||||||
|
calibration records, a series-3 binary carries four length-prefixed records
|
||||||
|
tagged 0x3c-0x3f: the sensor self-check traces the unit records when it pulses
|
||||||
|
each sensor before monitoring (Blastware draws these as the little waveforms in
|
||||||
|
the "Sensor Check" strip on the right of the Event Report).
|
||||||
|
|
||||||
|
* 0x3c / 0x3d / 0x3e = Tran / Vert / Long geophone ring-downs.
|
||||||
|
* 0x3f = MicL, a pulse train at the mic self-test frequency.
|
||||||
|
|
||||||
|
The self-check injects a fixed pulse, so the response is near-identical across
|
||||||
|
events — asserted here as an invariant shape (damped one-sided ring-down for
|
||||||
|
the geophones, a multi-pulse train for the mic).
|
||||||
|
"""
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
from minimateplus.sensor_check import decode_sensor_check
|
||||||
|
|
||||||
|
FIXDIR = Path(__file__).parent / "fixtures" / "fft-oracle-2026-09-14"
|
||||||
|
EVENTS = sorted(p.name for p in FIXDIR.iterdir()) # 7 BE12844 event binaries
|
||||||
|
|
||||||
|
|
||||||
|
def _decode(name):
|
||||||
|
return decode_sensor_check((FIXDIR / name).read_bytes())
|
||||||
|
|
||||||
|
|
||||||
|
def test_all_four_channels_present():
|
||||||
|
for name in EVENTS:
|
||||||
|
sc = _decode(name)
|
||||||
|
assert set(sc) == {"Tran", "Vert", "Long", "MicL"}, name
|
||||||
|
|
||||||
|
|
||||||
|
def test_geo_channels_are_damped_ringdowns():
|
||||||
|
# Each geophone self-check is a large one-sided deflection (~-990 raw) that
|
||||||
|
# rings back and damps toward a settled value well above the trough.
|
||||||
|
for name in EVENTS:
|
||||||
|
sc = _decode(name)
|
||||||
|
for ch in ("Tran", "Vert", "Long"):
|
||||||
|
tr = np.asarray(sc[ch], dtype=float)
|
||||||
|
assert 240 <= len(tr) <= 260, f"{name}:{ch} n={len(tr)}"
|
||||||
|
assert abs(tr[:3].mean()) < 50, f"{name}:{ch} starts off-baseline"
|
||||||
|
assert tr.min() < -800, f"{name}:{ch} min {tr.min()}"
|
||||||
|
assert tr.max() < 60, f"{name}:{ch} unexpected positive swing {tr.max()}"
|
||||||
|
# damped: settles between the trough and zero, well above the trough
|
||||||
|
assert tr.min() < tr[-1] < 0, f"{name}:{ch} end {tr[-1]} not between trough and 0"
|
||||||
|
assert abs(tr[-1]) < 0.6 * abs(tr.min()), f"{name}:{ch} not damped, end {tr[-1]}"
|
||||||
|
|
||||||
|
|
||||||
|
def test_mic_channel_is_a_pulse_train():
|
||||||
|
for name in EVENTS:
|
||||||
|
tr = np.asarray(_decode(name)["MicL"], dtype=float)
|
||||||
|
assert 235 <= len(tr) <= 255, f"{name} mic n={len(tr)}"
|
||||||
|
# larger dynamic range than the geo ring-down, and swings both ways
|
||||||
|
assert tr.min() < -1500, f"{name} mic min {tr.min()}"
|
||||||
|
assert tr.max() > 100, f"{name} mic max {tr.max()}"
|
||||||
|
# multiple pulses: several deep local minima
|
||||||
|
deep = (tr[1:-1] < tr[:-2]) & (tr[1:-1] < tr[2:]) & (tr[1:-1] < -800)
|
||||||
|
assert int(deep.sum()) >= 4, f"{name} mic pulses {int(deep.sum())}"
|
||||||
|
|
||||||
|
|
||||||
|
def test_returns_empty_when_no_sensor_check_block():
|
||||||
|
assert decode_sensor_check(b"not a blastware file") == {}
|
||||||
|
assert decode_sensor_check(b"") == {}
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
"""Series-4 (Thor / Micromate IDFW) sensor self-check waveform decode.
|
||||||
|
|
||||||
|
Reverse-engineered 2026-09-15 against 4 UM (Thor) oracle events. The IDFW
|
||||||
|
binary carries the sensor self-check in its fixed-header region (before the
|
||||||
|
waveform body) as up to four records tagged ``01 0e 3c/3d/3e/3f`` — the SAME
|
||||||
|
channel ids as series-3 (Tran/Vert/Long/MicL). Unlike series-3's delta-coded
|
||||||
|
trailing block, series-4 stores each trace as a raw int16-BE array after an
|
||||||
|
18-byte record header whose sample count is a 2-byte field at offset +8.
|
||||||
|
|
||||||
|
Three-channel (mic-disabled) Thor units carry only 3c/3d/3e — no MicL record.
|
||||||
|
|
||||||
|
Validated by shape (geophone ring-down / mic pulse train) and cross-event
|
||||||
|
consistency, since there's no Thor Event-Report strip to exact-match against.
|
||||||
|
"""
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
from micromate.sensor_check import decode_idf_sensor_check
|
||||||
|
|
||||||
|
FIXDIR = Path(__file__).parent / "fixtures" / "thor-idf-sc"
|
||||||
|
EVENTS = sorted(p.name for p in FIXDIR.glob("*.IDFW"))
|
||||||
|
|
||||||
|
|
||||||
|
def _decode(name):
|
||||||
|
return decode_idf_sensor_check((FIXDIR / name).read_bytes())
|
||||||
|
|
||||||
|
|
||||||
|
def test_geo_channels_present_and_ringdown_shaped():
|
||||||
|
# Every IDFW event has the three geophone self-checks; each is a large
|
||||||
|
# one-sided deflection (~15000 raw counts) that rings back — the geophone's
|
||||||
|
# damped impulse response.
|
||||||
|
for name in EVENTS:
|
||||||
|
sc = _decode(name)
|
||||||
|
for ch in ("Tran", "Vert", "Long"):
|
||||||
|
assert ch in sc, f"{name} missing {ch}"
|
||||||
|
tr = np.asarray(sc[ch], dtype=float)
|
||||||
|
tr = tr - tr[:4].mean() # reference to the pre-trigger baseline
|
||||||
|
assert 40 <= len(tr) <= 300, f"{name}:{ch} n={len(tr)}"
|
||||||
|
assert tr.min() < -8000, f"{name}:{ch} min {tr.min()}"
|
||||||
|
# deflects one way and rings back toward / past the baseline
|
||||||
|
assert tr.max() < abs(tr.min()), f"{name}:{ch} not one-sided"
|
||||||
|
|
||||||
|
|
||||||
|
def test_mic_present_only_on_four_channel_units():
|
||||||
|
# UM11719 / UM12947 record a mic; UM13981 / UM20147 are 3-channel
|
||||||
|
# (mic-disabled) units and carry no MicL self-check.
|
||||||
|
got = {name: ("MicL" in _decode(name)) for name in EVENTS}
|
||||||
|
assert any(got.values()), "expected at least one 4-channel unit"
|
||||||
|
assert not all(got.values()), "expected at least one 3-channel unit"
|
||||||
|
for name, has_mic in got.items():
|
||||||
|
if has_mic:
|
||||||
|
tr = np.asarray(_decode(name)["MicL"], dtype=float)
|
||||||
|
tr = tr - tr[:4].mean()
|
||||||
|
# mic self-check is a bipolar pulse train — swings both ways, wide range
|
||||||
|
assert tr.max() > 5000 and tr.min() < -5000, f"{name} mic not bipolar"
|
||||||
|
|
||||||
|
|
||||||
|
def test_channel_ids_and_order():
|
||||||
|
# ids decode to the canonical channel names, geo always in Tran/Vert/Long order
|
||||||
|
sc = _decode(EVENTS[0])
|
||||||
|
assert [c for c in ("Tran", "Vert", "Long") if c in sc] == ["Tran", "Vert", "Long"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_returns_empty_on_non_idf_input():
|
||||||
|
assert decode_idf_sensor_check(b"not an IDF file") == {}
|
||||||
|
assert decode_idf_sensor_check(b"") == {}
|
||||||
Reference in New Issue
Block a user