Skip to content

Updating documentation for OpenAMS#21

Merged
jimmyjon711 merged 4 commits into
DEVfrom
openams_updates
Jul 24, 2026
Merged

Updating documentation for OpenAMS#21
jimmyjon711 merged 4 commits into
DEVfrom
openams_updates

Conversation

@jimmyjon711

@jimmyjon711 jimmyjon711 commented Jul 22, 2026

Copy link
Copy Markdown
Member
  • Added configuration variables
  • Added macros
  • Updated snapmakers page to include side feeders working in AFC

Summary by CodeRabbit

  • Documentation
    • Added comprehensive OpenAMS (OAMS) configuration guidance, including controller settings, sensor calibration thresholds, PID tuning targets, and retry/stall timing behavior.
    • Added temperature sensor setup documentation for HDC1080-based sensors, including optional simulation for GUI compatibility.
    • Documented OpenAMS-related Klipper commands for calibration, follower control, spool load/unload, PID operations, abort/retry management, and related diagnostics.
    • Updated Snapmaker U1 AFC compatibility notes to clarify side-feeder loading support and improved formatting.

- Added configuration variables
- Added macros
- Updated snapmakers page to include side feeders working in AFC
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@jimmyjon711, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 22 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: b1e24716-5f9b-45b6-9f19-2d5a8946599c

📥 Commits

Reviewing files that changed from the base of the PR and between f720a95 and d66e08e.

📒 Files selected for processing (2)
  • AFC-Klipper-Add-On
  • docs/toolchanger/snapmaker.md
📝 Walkthrough

Walkthrough

OpenAMS configuration, sensor, and command documentation is added to the site, with new navigation wiring. FPS/PSF multiplier hysteresis documentation and Snapmaker U1 compatibility notes are also updated.

Changes

OpenAMS documentation

Layer / File(s) Summary
OpenAMS configuration reference
docs/configuration/AFC_UnitType_1.cfg.md
Documents AFC_OAMS, AFC_OpenAMS, and OpenAMS temperature sensor configuration options.
OpenAMS command reference
docs/klipper/internal/openams.md, mkdocs.yml
Adds AFC_OpenAMS and AFC_OAMS command references and exposes the page in the Klipper Commands navigation.

Buffer configuration documentation

Layer / File(s) Summary
Multiplier hysteresis reference
docs/configuration/AFC_Hardware.cfg.md
Documents the FPS/PSF multiplier_hysteresis option, default, filtering threshold, and zero-value behavior.

Snapmaker U1 compatibility

Layer / File(s) Summary
Snapmaker support notes
docs/toolchanger/snapmaker.md
Documents standalone lane loading with side feeders and separates the remaining unsupported features.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: ejsears


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

Comment @coderabbitai help to get the list of available commands.

Comment thread mkdocs.yml
@jimmyjon711
jimmyjon711 requested a review from ejsears July 22, 2026 23:46

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/configuration/AFC_UnitType_1.cfg.md (1)

1106-1106: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Resolve the new MD046 code-block-style warnings.

markdownlint-cli2 reports these fenced blocks while the configured style expects indented blocks. Convert them to the expected style, or explicitly update the lint configuration if fenced cfg blocks are intentional.

Also applies to: 1215-1215, 1287-1287

🤖 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 `@docs/configuration/AFC_UnitType_1.cfg.md` at line 1106, Resolve the MD046
warnings for the `cfg` code blocks in `AFC_UnitType_1.cfg.md` at all referenced
locations by converting them to the configured indented-block style, unless
fenced `cfg` blocks are intentionally supported; in that case, update the
markdownlint configuration accordingly.

Source: Linters/SAST tools

🤖 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 `@docs/toolchanger/snapmaker.md`:
- Line 19: Restore the Markdown bullet break between “Automatic Flow
Calibration…” and “Automatic color mapping…”, ensuring both limitations render
as separate list items while preserving their existing text.

---

Nitpick comments:
In `@docs/configuration/AFC_UnitType_1.cfg.md`:
- Line 1106: Resolve the MD046 warnings for the `cfg` code blocks in
`AFC_UnitType_1.cfg.md` at all referenced locations by converting them to the
configured indented-block style, unless fenced `cfg` blocks are intentionally
supported; in that case, update the markdownlint configuration accordingly.
🪄 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: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: efe8231b-2786-4d0e-b5b2-5d64eeaf0106

📥 Commits

Reviewing files that changed from the base of the PR and between 96c0ef4 and f0bb731.

📒 Files selected for processing (4)
  • docs/configuration/AFC_UnitType_1.cfg.md
  • docs/klipper/internal/openams.md
  • docs/toolchanger/snapmaker.md
  • mkdocs.yml

Comment thread docs/toolchanger/snapmaker.md Outdated
Comment thread docs/configuration/AFC_UnitType_1.cfg.md
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Comment thread docs/toolchanger/snapmaker.md
@jimmyjon711
jimmyjon711 merged commit 6d9f620 into DEV Jul 24, 2026
1 check passed
@jimmyjon711
jimmyjon711 deleted the openams_updates branch July 24, 2026 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants