Add calibration guide and settings overview to documentation

[DTTerastar]

Summary by CodeRabbit

• Documentation
  • Added a comprehensive calibration guide for ESPresense nodes with step-by-step procedures, RSSI-at-1m guidance, environmental factor explanations, receiver-side RSSI adjustment, timeout/idle-beacon retention tips, and normalization advice.
  • Refined calibration/settings documentation to describe per-node RSSI offsets, balancing across hardware/antennas, and consolidated guidance for obstacles and retention.
  • Updated the initial settings screenshot referenced in the docs.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds a new calibration documentation page and updates existing configuration docs to describe RSSI calibration, receiver-side RSSI adjustment (rxAdj), environmental factors, beacon forgetting/idle retention, and an image change in initial settings.

Changes

Cohort / File(s)	Change Summary
Documentation — Calibration guide configuration/calibration.md	New file: detailed calibration procedure (quick steps), guidance on measuring RSSI at 1m, environmental absorption/reflection factor, receiver-side RSSI adjustment (rxAdj), forget/idle-beacon timeout guidance, and multi-node normalization tips
Documentation — Settings & initial image configuration/settings.md, configuration/initial-settings.md	configuration/settings.md: Revised Calibration section wording and bullets; added rxAdj/receiver-adjustment guidance; clarified wall/obstacle and idle-device retention bullets. configuration/initial-settings.md: swapped referenced image from /images/settings_screenshot.png to /images/network_screen.png (alt text unchanged).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify calibration terminology and numeric guidance for technical accuracy
• Confirm rxAdj description matches implementation and is consistently named across docs
• Check the new image path renders correctly in initial-settings.md

Possibly related PRs

• Split settings #187 — Overlaps edits to configuration/settings.md and related documentation changes.

Poem

🐰
I hopped through signals, soft and keen,
Measured whispers where they'd been,
Tuned each node with careful art,
Adjusted RSSI, a tiny part,
Now maps and beacons hum—rejoice! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: it adds a new calibration guide documentation page and updates settings overview documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch calibration

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eeb3130 and 78ead16.

⛔ Files ignored due to path filters (4)

• images/calibration_screen.png is excluded by !**/*.png
• images/network_screen.png is excluded by !**/*.png
• images/settings_screen.png is excluded by !**/*.png
• images/settings_screenshot.png is excluded by !**/*.png

📒 Files selected for processing (3)

• configuration/calibration.md (1 hunks)
• configuration/initial-settings.md (1 hunks)
• configuration/settings.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• configuration/initial-settings.md

🚧 Files skipped from review as they are similar to previous changes (1)

• configuration/calibration.md

---

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 144f0a0 and eeb3130.

⛔ Files ignored due to path filters (1)

• images/calibration_settings.png is excluded by !**/*.png

📒 Files selected for processing (2)

• configuration/calibration.md (1 hunks)
• configuration/settings.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

configuration/calibration.md

[grammar] ~19-~19: Ensure spelling is correct
Context: ...er that value in Rssi expected from a 0dBm transmitter at 1 meter on every node ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

---

[grammar] ~24-~24: Ensure spelling is correct
Context: ...ur deployment. ## Rssi expected from a 0dBm transmitter at 1 meter This value esta...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

configuration/settings.md

[grammar] ~42-~42: Ensure spelling is correct
Context: ... or dev boards. * Rssi expected from a 0dBm transmitter at 1 meter - Reference RSSI...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (3)

configuration/settings.md (1)

40-45: Calibration section is well-structured and clearly references the new guide.

The restructuring appropriately introduces the new calibration.md guide and organizes the four key parameters (RSSI, Factor, rxAdj, Forget beacon) with concise descriptions. The link to the detailed guide and the brief parameter summaries work well together.

configuration/calibration.md (2)

13-13: Verify the calibration settings image is available.

Line 13 references /images/calibration_settings.png. Please confirm this image has been added to the repository at that path, as the documentation depends on it rendering correctly.

---

15-65: Excellent documentation structure and practical guidance.

The calibration guide is well-organized, actionable, and comprehensive. The quick procedure (lines 15–22) provides clear step-by-step instructions, the parameter sections (lines 24–59) explain each setting with practical context, and the tips section (lines 61–65) adds real-world value. The explanations of rxAdj hardware normalization (lines 39–55) are particularly thorough and should help users with mixed hardware deployments. Cross-references to settings.md terminology are consistent, and the overall flow supports both new and experienced users.