Skip to content

Commit 411dfac

Browse files
committed
docs: Document --force-export flag and clarify filtering thresholds
UPDATES: 1. README.md - Smart export filtering section - Added note about gyro range detection (<500 = ground test) - Documented MIN_GYRO_RANGE = 500.0 threshold - Clarified --force-export behavior - Added explanation of filtering rationale 2. OVERVIEW.md - Smart Export Filtering section - Updated with accurate threshold values: * FALLBACK_MIN_FRAMES = 7_500 (not 15,000) * MIN_GYRO_RANGE = 500.0 (not 1500.0) - Documented conservative filtering philosophy - Clarified --force-export as override for all filtering RATIONALE: The PR description feedback (CodeRabbit analysis) noted that thresholds were lowered in later commits but PR description still referenced original values. This update ensures: - Documentation reflects actual implementation - Users understand filtering behavior and thresholds - --force-export is prominently documented as escape hatch - Conservative approach (prefer false negatives) is explained THRESHOLDS EXPLAINED: ✅ FALLBACK_MIN_FRAMES = 7_500 - Allows short flights (~5 seconds) to be captured - Conservative: balances noise reduction with data preservation - Catches very short test arming but not legitimate flights ✅ MIN_GYRO_RANGE = 500.0 - Ground tests: <500 (sensor noise only) - Gentle/beginner flights: >500 (actual movement) - Conservative: some 500-1000 range marginal logs export - Trade-off: safer to export marginal than skip real data
1 parent 8ab34e7 commit 411dfac

2 files changed

Lines changed: 9 additions & 3 deletions

File tree

OVERVIEW.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,12 @@ src/
118118

119119
### **Smart Export Filtering**
120120
- **Duration-based:** < 5s skipped, 5–15s exported only if data density > 1500 fps, > 15s exported
121-
- **Gyro activity detection:** Minimal gyro variance indicates ground test vs. actual flight
121+
- **Gyro activity detection:** Minimal gyro range (< 500) indicates ground test vs. actual flight
122+
- **Thresholds:**
123+
- `FALLBACK_MIN_FRAMES = 7_500` (~5 seconds at 1500fps)
124+
- `MIN_GYRO_RANGE = 500.0` (actual flights >500, ground tests <500)
122125
- **Configurable:** Available via library API `should_skip_export()` and `has_minimal_gyro_activity()` for programmatic control
123-
- **Override:** `--force-export` flag or `force_export` option bypasses filtering heuristics
126+
- **Override:** `--force-export` flag (CLI) or `force_export` option (library) bypasses all filtering heuristics
124127

125128
### **Library API**
126129
- **Complete Data Access:** Programmatic access to all BBL data structures

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,11 @@ To reduce noise from test arm/disarm logs:
6464
- < 5s: skipped
6565
- 5–15s: exported only if data density > 1500 fps
6666
- > 15s: exported
67+
- Minimal gyro activity: skipped (ground test detection)
6768

68-
Use `--force-export` to export everything.
69+
Gyro range threshold: 500 (below = likely ground test, above = potential flight)
70+
71+
Use `--force-export` to export all logs regardless of filtering criteria.
6972

7073
## Documentation
7174

0 commit comments

Comments
 (0)