Skip to content

docs: separate device-specific implementation notes - #808

Draft
MaxRink wants to merge 9 commits into
decentespresso:mainfrom
MaxRink:docs/device-specific-notes
Draft

docs: separate device-specific implementation notes#808
MaxRink wants to merge 9 commits into
decentespresso:mainfrom
MaxRink:docs/device-specific-notes

Conversation

@MaxRink

@MaxRink MaxRink commented Sep 5, 2026

Copy link
Copy Markdown

Summary

  • Move named-device protocols, firmware quirks, simulator behavior, and hardware troubleshooting into doc/device-notes/.
  • Keep cross-device transport, connection, API, storage, testing, and controller architecture in the existing general docs.
  • Add an index and update repository guidance and all affected references.
  • Document the DE1 active-GHC restriction: remote starts only arm the white ready indication for UL compliance, while remote stops remain supported.
  • Add examples/plugins/AGENTS.md guidance for BLE create() versus sensor registration, per-instance ownership, session fencing, settings routing, and staged verification. Initial single-device drivers require zero/one-device, reconnect, and quota rejection checks; concurrent-device and dosing checks apply when those capabilities are introduced.
  • Archive the whole-series design rationale in doc/plans/archive/skale-grinder-feature-series/design-rationale.md.
  • Route implementation details to the independently reviewable concurrent BLE quota, scale metadata, guarded actions, Skale driver, SteamSequencer fix, E64 sensor, generic native settings, and sb-dev arguments drafts.

The archived rationale now explicitly delivers #846 first on #844 and brewing-only #845, then adds concurrent Skales with #843/#834 in a separate follow-up. Generic settings remain a later independent step.

Linked Issue

N/A - repository documentation maintenance.

Verification

  • git diff --check passed.
  • Relative Markdown link targets and anchors were validated.
  • The public API and internal API notes now state the inventory-only and connected-scale metadata boundaries.
  • The frozen example-plugin guidance and whole-series rationale archive were reviewed against the final feature routing.
  • Runtime, hardware, and end-to-end smoke testing were not run for this documentation-only change.

Impact

Documentation-only guidance and rationale archive. No runtime, API, compatibility, migration, or security impact.

Contributor Responsibility

AI-assisted development is allowed. The submitter remains responsible for the submitted work.

  • I have reviewed and understand all changes in this PR and take responsibility for their correctness, security, behavior, licensing, and provenance, including any AI-assisted or AI-generated work.

@MaxRink
MaxRink marked this pull request as ready for review September 5, 2026 22:34
@MaxRink
MaxRink marked this pull request as draft September 5, 2026 22:36
@MaxRink
MaxRink force-pushed the docs/device-specific-notes branch from 3678967 to 292643e Compare September 6, 2026 18:32
MaxRink and others added 4 commits September 13, 2026 13:34
Move named-device protocols, firmware quirks, simulator behavior, and hardware troubleshooting out of the general AI and device-management references. This keeps cross-device architecture concise while preserving hardware guidance under a discoverable doc/device-notes index and updates all affected pointers.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Active-GHC DE1 firmware requires dangerous operations to start at the group head for UL compliance. Remote start requests only arm the white ready indication, while remote stop remains supported.\n\nRecord the device-specific constraint and the required caller behavior in the DE1 agent notes so future control integrations do not attempt to bypass or misrepresent it.\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Document that remembered and discovered inventory entries do not carry connection-scoped scale metadata, which belongs to the connected-scale role-info endpoint.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Document inventory-only device surfaces and connected scale metadata responses.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@MaxRink
MaxRink force-pushed the docs/device-specific-notes branch from 0f3c6ec to ecd4ed6 Compare September 13, 2026 11:36
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