fix: guard debug[0-2] gyroUnfilt fallback to GYRO_SCALED mode only

[nerdCopter]

AI Generated pull-request

Summary

• Fixes fix: guard debug[0-2] gyroUnfilt fallback against invalid debug mode #154: debug[0-2] was unconditionally used as a gyroUnfilt fallback whenever dedicated gyroUnfilt columns were absent, regardless of debug_mode.
• Now the fallback only proceeds when debug_mode == 6 (GYRO_SCALED), which is the only mode where debug[0-2] contains raw unfiltered gyro data.
• When debug_mode is known and != 6 (e.g. RC_SMOOTHING=7, ACCELEROMETER=4): skips fallback, emits a warning, and gyroUnfilt-dependent analysis degrades gracefully to N/A.
• When debug_mode is absent from headers (old embedded-only logs): allows fallback with an assumption warning.

Behavior change

Condition	Before	After
debug_mode=6 + no gyroUnfilt headers	fallback applied ✓	fallback applied ✓
debug_mode≠6 + no gyroUnfilt headers	fallback applied ✗ (wrong data)	fallback skipped, warning printed ✓
debug_mode unknown + no gyroUnfilt headers	fallback applied (assumption)	fallback applied, assumption warned ✓

Files changed

• src/data_input/log_parser.rs: guarded using_debug_fallback computation and per-row fallback assignment

Test plan

• Files with debug_mode=6 and no gyroUnfilt columns: fallback applied, "Using debug[0-2] as gyroUnfilt fallback (debug_mode=GYRO_SCALED)" printed
• Files with gyroUnfilt columns present: no fallback attempted (unchanged)
• Files with debug_mode≠6 and no gyroUnfilt: fallback skipped, warning printed, GyroVsUnfilt/delay analysis shows N/A

🤖 Generated with Claude Code

Summary by CodeRabbit

• New Features

  • Added optional ESO Gain Optimization workflow for flight controller analysis with new --eso and --eso-b0 CLI flags
  • Added statistical report generation via --report flag producing per-log markdown documentation
  • ESO output visualization showing measured/estimated gyro rates and disturbance estimates

• Bug Fixes

  • Improved gyro data fallback logic to respect debug mode settings

• Documentation

  • Updated documentation with ESO workflow details and new CLI options

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 314333a9-5e8a-42f5-8285-20845e4b34b2

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/154-debug-mode-guard

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (2)

OVERVIEW.md (2)

182-182: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Documentation claims report generation that is not wired in code.

Line 182 states "Results are also included in the markdown report if --report is also given," but src/main.rs neither implements the --report flag nor calls generate_markdown_report in the process_file function.

The report generation function exists in src/report.rs (context snippet 3) but is not integrated into the CLI workflow.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@OVERVIEW.md` at line 182, The docs claim a `--report` option and that
`process_file` writes results to a markdown report, but CLI and workflow don't
invoke report generation; add a boolean CLI flag (e.g., --report) in the
argument parsing code and pass it into process_file, then update process_file to
call the existing generate_markdown_report function (from report.rs) when that
flag is true, ensuring you pass the computed results and desired output path;
reference the process_file function and generate_markdown_report symbol to
locate where to wire the call and the CLI parsing code to add the flag.

---

31-32: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Documentation describes unimplemented CLI flags.

Lines 31-32 document --eso-axis <roll,pitch,yaw> and --report flags that are not implemented in src/main.rs. The code only implements --eso and --eso-b0.

This creates a user-facing documentation error where users will attempt to use flags that do not exist.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@OVERVIEW.md` around lines 31 - 32, The docs list CLI flags --eso-axis and
--report but src/main.rs only implements --eso and --eso-b0; either remove those
flags from OVERVIEW.md or implement them in the CLI parsing: add Arg definitions
for "--eso-axis" (accepting comma-separated values or multiple occurrences for
roll,pitch,yaw) and "--report" (boolean) in your CLI builder (the function that
constructs clap args used by main()/parse_args/ArgMatches), map the parsed
values into the program configuration (e.g., the Config/args struct you pass
through main logic), and ensure downstream code respects the new config fields
(enable axis selection in the ESO code path and enable writing the markdown
report where plots are generated); update/validate help text accordingly.

🧹 Nitpick comments (1)

src/plot_functions/plot_eso.rs (1)

25-25: ⚡ Quick win

Centralize axis cardinality and numeric thresholds into shared constants.

3 and 1e-12 are hardcoded in function code here. Please switch to shared constants so this module stays aligned with cross-file axis contracts and repo conventions.

♻️ Proposed patch

-use crate::axis_names::AXIS_NAMES;
+use crate::axis_names::{AXIS_COUNT, AXIS_NAMES};
 use crate::constants::{
-    COLOR_ESO_FHAT, COLOR_ESO_HAT, COLOR_ESO_MEAS, ESO_FHAT_Y_FRACTION, LINE_WIDTH_PLOT,
+    COLOR_ESO_FHAT, COLOR_ESO_HAT, COLOR_ESO_MEAS, ESO_FHAT_Y_FRACTION, ESO_FHAT_EPS,
+    LINE_WIDTH_PLOT,
     UNIFIED_Y_AXIS_HEADROOM_SCALE, UNIFIED_Y_AXIS_MIN_SCALE, UNIFIED_Y_AXIS_PERCENTILE,
 };

 pub fn plot_eso_output(
-    eso_results: &[Option<EsoResult>; 3],
+    eso_results: &[Option<EsoResult>; AXIS_COUNT],
     root_name: &str,
 ) -> Result<(), Box<dyn Error>> {
@@
-    let mut axis_data: [Option<AxisEsoData>; 3] = [None, None, None];
+    let mut axis_data: [Option<AxisEsoData>; AXIS_COUNT] = std::array::from_fn(|_| None);
@@
-        if data.fhat_max_abs > 1e-12 {
+        if data.fhat_max_abs > ESO_FHAT_EPS {

// src/constants.rs
pub const ESO_FHAT_EPS: f64 = 1.0e-12;

As per coding guidelines, src/**/*.rs: “All constants go in src/constants.rs — no hardcoded magic numbers in function code” and “Axis indices … must use the src/axis_names.rs module with AXIS_COUNT, AXIS_NAMES, and axis_name() function instead of creating redundant axis index constants.”

Also applies to: 37-37, 102-103

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/plot_functions/plot_eso.rs` at line 25, Replace hardcoded axis
cardinality and numeric threshold in plot_eso.rs: change the fixed array type
signature eso_results: &[Option<EsoResult>; 3] to use the shared axis
cardinality constant (AXIS_COUNT) from src/axis_names.rs, and replace any
literal 1e-12 with the shared ESO_FHAT_EPS constant from src/constants.rs;
update all references in the function(s) in plot_eso.rs that rely on the
length/indexing or epsilon comparison so they import and use AXIS_COUNT and
ESO_FHAT_EPS (refer to the eso_results parameter and any local uses of
1e-12/EsoResult comparisons) to conform to the repo conventions.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/data_input/log_parser.rs`:
- Around line 456-457: Replace the hardcoded magic number Some(6) in the
debug-mode match inside src/data_input/log_parser.rs with a named constant: add
a public constant DEBUG_MODE_GYRO_SCALED = 6 (or suitable type) to
src/constants.rs and then import and use that constant in the match arm (e.g.,
change Some(6) -> Some(DEBUG_MODE_GYRO_SCALED)); update any related pattern
matches/comments in the same function to reference DEBUG_MODE_GYRO_SCALED so
there are no raw numeric literals left in the match logic.

In `@src/main.rs`:
- Around line 1670-1696: The docs mention CLI flags --eso-axis and --report and
a generate_markdown_report function but main.rs only parses --eso and --eso-b0;
fix by adding parsing for --eso-axis and --report (introduce variables like
eso_axis_selection and report_requested alongside eso_requested, eso_b0_value,
eso_b0_user_override) in the args loop, validate --eso-axis accepts
roll/pitch/yaw (or comma list) and set a clear data structure to carry selected
axes; wire those values into process_file (or whichever function computes ESO
results) so ESO computation respects eso_axis_selection and uses eso_b0_value
when eso_b0_user_override is true; finally, when report_requested is set call
generate_markdown_report after processing a file (or after batch processing) and
pass the computed ESO results so the markdown includes ESO output;
alternatively, if you prefer removing features, update OVERVIEW.md to remove
--eso-axis/--report and delete or mark generate_markdown_report unused.

---

Duplicate comments:
In `@OVERVIEW.md`:
- Line 182: The docs claim a `--report` option and that `process_file` writes
results to a markdown report, but CLI and workflow don't invoke report
generation; add a boolean CLI flag (e.g., --report) in the argument parsing code
and pass it into process_file, then update process_file to call the existing
generate_markdown_report function (from report.rs) when that flag is true,
ensuring you pass the computed results and desired output path; reference the
process_file function and generate_markdown_report symbol to locate where to
wire the call and the CLI parsing code to add the flag.
- Around line 31-32: The docs list CLI flags --eso-axis and --report but
src/main.rs only implements --eso and --eso-b0; either remove those flags from
OVERVIEW.md or implement them in the CLI parsing: add Arg definitions for
"--eso-axis" (accepting comma-separated values or multiple occurrences for
roll,pitch,yaw) and "--report" (boolean) in your CLI builder (the function that
constructs clap args used by main()/parse_args/ArgMatches), map the parsed
values into the program configuration (e.g., the Config/args struct you pass
through main logic), and ensure downstream code respects the new config fields
(enable axis selection in the ESO code path and enable writing the markdown
report where plots are generated); update/validate help text accordingly.

---

Nitpick comments:
In `@src/plot_functions/plot_eso.rs`:
- Line 25: Replace hardcoded axis cardinality and numeric threshold in
plot_eso.rs: change the fixed array type signature eso_results:
&[Option<EsoResult>; 3] to use the shared axis cardinality constant (AXIS_COUNT)
from src/axis_names.rs, and replace any literal 1e-12 with the shared
ESO_FHAT_EPS constant from src/constants.rs; update all references in the
function(s) in plot_eso.rs that rely on the length/indexing or epsilon
comparison so they import and use AXIS_COUNT and ESO_FHAT_EPS (refer to the
eso_results parameter and any local uses of 1e-12/EsoResult comparisons) to
conform to the repo conventions.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5ea0864c-d7f5-461d-8b6f-b2ca3fbfeaac

📥 Commits

Reviewing files that changed from the base of the PR and between 3e54f4f and d593675.

⛔ Files ignored due to path filters (1)

• Cargo.lock is excluded by !**/*.lock

📒 Files selected for processing (10)

• Cargo.toml
• OVERVIEW.md
• src/constants.rs
• src/data_input/log_parser.rs
• src/eso.rs
• src/lib.rs
• src/main.rs
• src/plot_functions/mod.rs
• src/plot_functions/plot_eso.rs
• src/report.rs

[coderabbitai]

🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win

Extract GYRO_SCALED mode id into shared constants

Some(6) is a hardcoded magic number in function logic. Please move this to src/constants.rs (e.g., DEBUG_MODE_GYRO_SCALED) and reference it here.

As per coding guidelines, src/**/*.rs: “All constants go in src/constants.rs — no hardcoded magic numbers in function code”.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/data_input/log_parser.rs` around lines 456 - 457, Replace the hardcoded
magic number Some(6) in the debug-mode match inside src/data_input/log_parser.rs
with a named constant: add a public constant DEBUG_MODE_GYRO_SCALED = 6 (or
suitable type) to src/constants.rs and then import and use that constant in the
match arm (e.g., change Some(6) -> Some(DEBUG_MODE_GYRO_SCALED)); update any
related pattern matches/comments in the same function to reference
DEBUG_MODE_GYRO_SCALED so there are no raw numeric literals left in the match
logic.

Source: Coding guidelines

[coderabbitai]

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Search for --eso-axis and --report flag parsing across the codebase

echo "=== Searching for --eso-axis flag parsing ==="
rg -n '\-\-eso-axis' src/

echo "=== Searching for --report flag parsing ==="
rg -n '\-\-report' src/

echo "=== Searching for generate_markdown_report calls ==="
rg -n 'generate_markdown_report' src/

Repository: nerdCopter/BlackBox_CSV_Render

Length of output: 268

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "=== Search for flags across entire repo ==="
rg -n '\-\-eso-axis' .
rg -n '\-\-report' .
echo

echo "=== Search for generate_markdown_report calls across entire repo ==="
rg -n 'generate_markdown_report' .

echo
echo "=== Read OVERVIEW.md around mentioned sections ==="
if [ -f OVERVIEW.md ]; then
  sed -n '1,220p' OVERVIEW.md | nl -ba | sed -n '25,60p;170,210p'
else
  echo "OVERVIEW.md not found"
fi

Repository: nerdCopter/BlackBox_CSV_Render

Length of output: 118

---

🏁 Script executed:

#!/bin/bash
# Re-run searches without failing when no matches are found; capture stderr too.

set -u

echo "=== Search for --eso-axis across entire repo (ignore no matches) ==="
rg -n '\-\-eso-axis' . 2>&1 || true

echo
echo "=== Search for --report across entire repo (ignore no matches) ==="
rg -n '\-\-report' . 2>&1 || true

echo
echo "=== Search for generate_markdown_report across entire repo ==="
rg -n 'generate_markdown_report' . 2>&1 || true

echo
echo "=== Search for likely report wiring (process/report keywords) ==="
rg -n 'markdown report|markdown_report|process_file|report::|src/report\.rs|generate_.*report' . 2>&1 || true

echo
echo "=== Read OVERVIEW.md around mentioned line ranges ==="
if [ -f OVERVIEW.md ]; then
  nl -ba OVERVIEW.md | sed -n '20,60p'
  nl -ba OVERVIEW.md | sed -n '160,210p'
else
  echo "OVERVIEW.md not found"
fi

Repository: nerdCopter/BlackBox_CSV_Render

Length of output: 736

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "=== CLI arg parsing / ESO / report keywords in src/main.rs ==="
rg -n "eso-axis|eso_b0|--eso|--eso-b0|--report|report|markdown" src/main.rs

echo
echo "=== process_file implementation around src/main.rs:561 ==="
sed -n '520,720p' src/main.rs

echo
echo "=== main() / flag handling around src/main.rs:1600-1900 ==="
sed -n '1600,1900p' src/main.rs

echo
echo "=== generate_markdown_report signature/body around src/report.rs:110-200 ==="
sed -n '90,220p' src/report.rs

echo
echo "=== OVERVIEW.md lines ~31-40 and ~175-195 (with line numbers) ==="
if [ -f OVERVIEW.md ]; then
  cat -n OVERVIEW.md | sed -n '25,45p;175,195p;180,190p'
else
  echo "OVERVIEW.md not found"
fi

Repository: nerdCopter/BlackBox_CSV_Render

Length of output: 29086

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "=== Repo-wide: any report/markdown-report mentions ==="
rg -n "(_report|report\.md|markdown report|markdown_report|generate_.*report|report )" src .

echo
echo "=== Repo-wide: any ESO-axis mention (with or without --) ==="
rg -n "eso-axis|eso_axis|ESO[-_ ]axis" src .

echo
echo "=== Call sites for generate_markdown_report( ==="
rg -n "generate_markdown_report\s*\(" src .

echo
echo "=== Search for eso_results usage in main.rs ==="
rg -n "eso_results|EsoResult" src/main.rs src/report.rs .

Repository: nerdCopter/BlackBox_CSV_Render

Length of output: 845

---

🏁 Script executed:

#!/bin/bash
set -u

echo "=== --report parsing in repo (ignore no matches) ==="
rg -n '\-\-report\b' . 2>&1 || true

echo
echo "=== _report.md / report output strings in repo (ignore no matches) ==="
rg -n '(_report\.md|report\.md|markdown statistical report|markdown_report|markdown report)' . 2>&1 || true

echo
echo "=== ESO-axis parsing strings in repo (ignore no matches) ==="
rg -n 'eso-axis|eso_axis|ESO[-_ ]axis' . 2>&1 || true

echo
echo "=== generate_markdown_report call sites (ignore no matches) ==="
rg -n 'generate_markdown_report\s*\(' . 2>&1 || true

Repository: nerdCopter/BlackBox_CSV_Render

Length of output: 526

---

Documentation-code mismatch: --eso-axis / --report are documented but not implemented or wired

OVERVIEW.md documents --eso-axis <roll,pitch,yaw> and --report, and states ESO results are included in the markdown report when --report is also given. Code in src/main.rs parses only --eso and --eso-b0, and repo-wide there are no matches for --eso-axis or --report flag parsing; additionally, generate_markdown_report exists in src/report.rs but has no call sites.

Either remove/update the docs for these flags, or implement the missing CLI flags and connect generate_markdown_report into process_file with proper axis selection/ESO plumbing.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/main.rs` around lines 1670 - 1696, The docs mention CLI flags --eso-axis
and --report and a generate_markdown_report function but main.rs only parses
--eso and --eso-b0; fix by adding parsing for --eso-axis and --report (introduce
variables like eso_axis_selection and report_requested alongside eso_requested,
eso_b0_value, eso_b0_user_override) in the args loop, validate --eso-axis
accepts roll/pitch/yaw (or comma list) and set a clear data structure to carry
selected axes; wire those values into process_file (or whichever function
computes ESO results) so ESO computation respects eso_axis_selection and uses
eso_b0_value when eso_b0_user_override is true; finally, when report_requested
is set call generate_markdown_report after processing a file (or after batch
processing) and pass the computed ESO results so the markdown includes ESO
output; alternatively, if you prefer removing features, update OVERVIEW.md to
remove --eso-axis/--report and delete or mark generate_markdown_report unused.

[nerdCopter]

@coderabbitai, AI generated comment — addressed both actionable items from review 4471229108:

1. Magic number → named constant: Added DEBUG_MODE_GYRO_SCALED: u32 = 6 to src/constants.rs and replaced the hardcoded Some(6) match arm in log_parser.rs with Some(DEBUG_MODE_GYRO_SCALED).

2. OVERVIEW.md stale docs: Removed all references to --eso-axis and --report flags (lines 31–32, 172, 181–192, 214) and the entire "Statistical Report Output (Optional)" section — these flags were removed from the CLI previously but docs were not updated.

Please re-review commit e88abeb.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch the commit diff
gh api repos/nerdCopter/BlackBox_CSV_Render/commits/e88abeb --jq '.files[] | {filename: .filename, patch: .patch}'

Length of output: 6356

---

---

@nerdCopter Both items are confirmed addressed in commit e88abeb:

1. Magic number → named constant ✅

   • pub const DEBUG_MODE_GYRO_SCALED: u32 = 6; added to src/constants.rs with a clear doc comment explaining why only mode 6 is valid.
   • Some(6) in the match arm replaced with Some(DEBUG_MODE_GYRO_SCALED).
   • Bonus fix: the hardcoded (6) in the non-GYRO_SCALED warning format string was also replaced with ({}) + DEBUG_MODE_GYRO_SCALED, keeping constant usage fully consistent throughout.

2. OVERVIEW.md stale docs ✅

   • --eso-axis removed from the ESO flags summary line and the ESO Activation line.
   • --report flag reference removed from the CLI summary.
   • "Results are also included in the markdown report if --report is also given." removed from ESO Output.
   • Entire "Statistical Report Output (Optional)" section removed.
   • *_report.md entry removed from "Generated Reports".

Everything looks clean and complete. 🐇✨

---

If you found this review helpful, would you consider giving us a shout-out on X?

Thank you for using CodeRabbit!