docs: correct safety contract and document which component disarms#125
Merged
Conversation
- `BB.Safety` is the arm/disarm API, not a behaviour; `disarm/1` is a callback on the `BB.Actuator`/`BB.Controller`/`BB.Sensor` behaviours - add a "Which Component Registers and Disarms?" section stating the contract (whoever owns the hardware connection registers and disarms) - clarify the serial-bus disarm pattern in the safety-callbacks how-to - fix stale `topics/safety.md` path to `understanding-safety.md`
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs described
BB.Safetyas a behaviour that actuators "must implement". It isn't one —BB.Safetyis the arm/disarm API, and thedisarm/1callback is defined on theBB.Actuator(required),BB.Controller, andBB.Sensorbehaviours.Changes
AGENTS.md— corrected the Safety System key points and bottom-of-file summary; fixed the staledocumentation/topics/safety.mdpath tounderstanding-safety.md.documentation/topics/understanding-safety.md— added a "Which Component Registers and Disarms?" section stating the contract: whoever owns the hardware connection registers viaBB.Safety.register/2and implementsdisarm/1. Covers both driver shapes (standalone actuator vs controller + shared bus).documentation/how-to/implement-safety-callbacks.md— the serial example showed actuator-side disarm with no caveat; clarified that this applies when the actuator owns the port, and that shared-bus drivers disarm at the controller.Docs only; no code changes.