Skip to content

CLAUDE.md: document the APFPV link mode and the device-lock rule - #137

Merged
josephnef merged 1 commit into
masterfrom
docs-claude-md-apfpv
Oct 22, 2026
Merged

josephnef merged 1 commit into
masterfrom
docs-claude-md-apfpv

Conversation

@josephnef

Copy link
Copy Markdown
Collaborator

Follow-up to #129. CLAUDE.md only described the WFB-NG data path. This adds:

  • the two link modes in the intro and module table
  • an APFPV section: StaLink responsibilities, preference keys, the camera-side data path (static IP, UDP forwarding to the unchanged loopback consumers, air_man_ap TCP 12355 and the aalinkFPV HTTP API), the single-flight TCP client rules, and the agreed key-frame auth follow-up
  • the dev_mutex / withDevice() device-access rule and lock order that APFPV link mode: join the OpenIPC apfpv camera's open AP with devourer #129 introduced in WfbngLink
  • the pixelpilot-sta log tag and tools/apfpv-open-static-cam.sh

Docs only.

🤖 Generated with Claude Code

#129 added a second link mode (StaLink: 802.11 station over devourer with
ARP/ICMP/TCP, UDP forwarding to the unchanged loopback consumers, camera
control over air_man_ap and the aalinkFPV API) and a dev_mutex/withDevice()
rule around WfbngLink's device map. Describe both, the preference keys, the
cleartext key-frame follow-up, and the pixelpilot-sta log tag.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can ask Qodo to dismiss a finding you disagree with, with your reason on record

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document APFPV link mode and device-access rules in CLAUDE.md

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Explain how APFPV and WFB-NG use the same video and telemetry consumers.
• Document APFPV settings, camera control, TCP behavior, and the key-frame authentication follow-up.
• Record device-lock rules, the station log tag, and the camera setup tool.
Diagram

graph TD
  Settings["Link settings"] --> Link["WfbngLink"] --> WFB["WFB-NG mode"] --> UDP["Loopback UDP"] --> Consumers["Video and telemetry"]
  Link --> STA["APFPV StaLink"] --> UDP
  Camera["Camera AP"] --> STA
Loading
High-Level Assessment

Documenting these existing implementation rules in CLAUDE.md is appropriate for contributor and coding-agent guidance. The file points to the README for user-facing instructions rather than duplicating them.

Files changed (1) +41 / -5

Documentation (1) +41 / -5
CLAUDE.mdDocument APFPV architecture and device-access constraints +41/-5

Document APFPV architecture and device-access constraints

• Describes both link modes, APFPV preferences and data paths, camera-control behavior, and the unchanged loopback consumers. Records the single-flight TCP rules, key-frame authentication follow-up, device mutex and lock ordering, VPN behavior, camera setup tool, and station log tag.

CLAUDE.md

@josephnef
josephnef merged commit fb5b8c6 into master Oct 22, 2026
4 checks passed
@josephnef
josephnef deleted the docs-claude-md-apfpv branch October 22, 2026 05:01
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.

1 participant