Python helpers for the EDC Dropmate.
Install by cloning this repository and installing into a virtual environment:
$ pip install .You can confirm proper installation via the dropmate CLI:
$ dropmate --help
Usage: dropmate [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
audit Audit a consolidated Dropmate log.
audit-bulk Audit a directory of consolidated Dropmate logs.
consolidate Merge a directory of logs into a simplified drop record.NOTE: All functionality assumes that log records have been provided by Dropmate app version 1.5.16 or newer. Prior versions may not contain all the necessary data columns to conduct the data audit, and there may also be column naming discrepancies between the iOS and Android apps.
The following audits are supported:
- Empty Drop Record
- Minimum Altitude Loss
- Minimum Time Between Drop Records
- Time delta between the end of the previous drop record and the beginning of the next.
- Short deltas may indicate that the previous drop record ended prematurely & restarted mid-air
- Minimum Dropmate Firmware Version
- Dropmate Internal Clock Drift
- Measured as the delta between the scanning device's clock at scan time and the Dropmate's internal clock
- Battery health
- Device health
The following environment variables are provided to help customize pipeline behaviors.
| Variable Name | Description | Default |
|---|---|---|
PROMPT_START_DIR |
Start path for UI file/dir prompt | '.' |
Process a consolidated Dropmate log CSV.
| Parameter | Description | Type | Default |
|---|---|---|---|
--log-filepath |
Path to Dropmate log CSV to parse. | Path|None |
GUI Prompt |
--min-alt-loss-ft |
Threshold altitude delta, feet. | int |
200 |
--min-firmware |
Threshold firmware version. | int|float |
5 |
--internal-time-delta-minutes |
Dropmate internal clock delta from real-time. | int |
60 |
--time-between-delta-minutes |
Delta between the start of a drop record and end of the previous | int |
10 |
Batch process a directory of consolidated Dropmate log CSVs.
| Parameter | Description | Type | Default |
|---|---|---|---|
--log-dir |
Path to Dropmate log directory to parse. | Path|None |
GUI Prompt |
--log-pattern |
Dropmate log file glob pattern.1,2 | str |
"*.csv" |
--min-alt-loss-ft |
Threshold altitude delta, feet. | int |
200 |
--min-firmware |
Threshold firmware version. | int|float |
5 |
--internal-time-delta-minutes |
Dropmate internal clock delta from real-time. | int |
60 |
--time-between-delta-minutes |
Delta between the start of a drop record and end of the previous | int |
10 |
- Case sensitivity is deferred to the host OS
- Recursive globbing requires manual specification (e.g.
**/*.csv)
Merge a directory of Dropmate app outputs into a deduplicated, simplified drop record.
| Parameter | Description | Type | Default |
|---|---|---|---|
--log-dir |
Path to Dropmate log directory to parse. | Path|None |
GUI Prompt |
--log-pattern |
Dropmate log file glob pattern.1,2 | str |
"dropmate_records_*" |
--out-filename |
Consolidated log filename.3 | str |
consolidated_dropmate_records.csv |
- Case sensitivity is deferred to the host OS
- Recursive globbing requires manual specification (e.g.
**/dropmate_records_*) - Consolidate log will be written into the specified log directory; any existing file of the same name will be overwritten
NOTE: Due to deployment environment restrictions preventing the use of compiled libraries (e.g. Polars, Pandas/Numpy), tooling is intentionally limited to pure-Python implementations.
This project uses Poetry to manage dependencies. With your fork cloned to your local machine, you can install the project and its dependencies to create a development environment using:
$ poetry installA pre-commit configuration is also provided to create a pre-commit hook so linting errors aren't committed:
$ pre-commit installA pytest suite is provided, with coverage reporting from pytest-cov. A tox configuration is provided to test across all supported versions of Python. Testing will be skipped for Python versions that cannot be found.
$ toxDetails on missing coverage, including in the test suite, is provided in the report to allow the user to generate additional tests for full coverage.