Skip to content

Commit 0b6d549

Browse files
committed
docs: add ADCP to README
1 parent 5ee485f commit 0b6d549

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# iotedge-sensorstream
22

3-
Azure IoT Edge module for ingesting and processing oceanographic sensor data (CTD, GNSS) from USV and ship-based platforms. Outputs GeoParquet files with per-record metadata JSON. Runs on edge devices (Jetson Orin, x86 Ubuntu) and locally in standalone mode.
3+
Azure IoT Edge module for ingesting and processing oceanographic sensor data (CTD, GNSS, ADCP) from USV and ship-based platforms. Outputs GeoParquet files with per-record metadata JSON. Runs on edge devices (Jetson Orin, x86 Ubuntu) and locally in standalone mode.
44

55
## Data Flow
66

77
```
88
Sensor data (TCP/UDP stream, file drop, IoT Edge message)
9-
→ ingest/ (parse NMEA, CSV, .hex, .cnv)
9+
→ ingest/ (parse NMEA, CSV, .hex, .cnv, .raw)
1010
→ process/pipeline.py (DataFrame → enrich → validate)
1111
→ exports/ (GeoParquet + metadata JSON → storage, telemetry → IoT Hub)
1212
```
@@ -19,6 +19,7 @@ Sensor data (TCP/UDP stream, file drop, IoT Edge message)
1919
| CSV | `.csv` | pandas | Auto-detect columns; EMSO, R2R, generic |
2020
| Sea-Bird CNV | `.cnv` | pandas | Processed CTD with header metadata |
2121
| Sea-Bird HEX | `.hex` + `.hdr` + `.XMLCON` | seabirdscientific + gsw | Raw CTD frequency → T/C/P/S/depth |
22+
| RDI ADCP | `.raw` | dolfyn | Beam→earth transform, ensemble averaging, u/v/w velocities |
2223
| tar.gz | `.tar.gz`, `.tgz` | tarfile | Extracts and processes contained files |
2324

2425
## Quick Start
@@ -62,7 +63,7 @@ Configuration is driven by IoT Hub module twin desired properties. All `EdgeConf
6263
| Module | Purpose |
6364
|--------|---------|
6465
| `azure_handler/` | IoT Hub client, message sending, twin sync, storage abstraction |
65-
| `ingest/` | TCP/UDP stream listener, file watcher, IoT Edge triggers, hex/NMEA/CSV parsing |
66+
| `ingest/` | TCP/UDP stream listener, file watcher, IoT Edge triggers, hex/NMEA/CSV/ADCP parsing |
6667
| `process/` | Processing pipeline: file → DataFrame → GeoParquet + metadata JSON |
6768
| `exports/` | D2C telemetry, metadata JSON generation, telemetry throttle/downsampling |
6869
| `simulate/` | Built-in simulators: file dropper, NMEA stream replayer, CTD hex stream |
@@ -182,7 +183,7 @@ Use the built-in simulators:
182183

183184
Test data is stored in Azure Blob Storage (`sensorstream-test` container) and downloaded automatically on first run. Set `AZURE_CONNECTION_STRING` in `.env` or environment. Tests fall back to local `test_data/` if no connection is available.
184185

185-
**90 tests** across 8 files: config, stream parsing, pipeline, file watcher, simulators, hex parsing, CTD stream, and telemetry throttling.
186+
**118 tests** across 9 files: config, stream parsing, pipeline, file watcher, simulators, hex parsing, ADCP parsing, CTD stream, and telemetry throttling.
186187

187188
## IoT Edge Integration
188189

0 commit comments

Comments
 (0)