docs: ship usage-rules.md for AI coding assistants (#61) - #62
Merged
Conversation
Add a satellite-specific usage-rules.md covering how BB.PID.Controller is wired into the controllers DSL block, its options, and the PID-specific gotchas (simulation :omit default, unique setpoint/measurement sources, and that it does not disarm). Package it in the hex tarball and add a test. Implements proposal 0007 for bb_pid_controller.
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.
Closes #61. Implements proposal 0007 for
bb_pid_controller.Adds a single
usage-rules.mdat the repo root, matching the house style set bybbcore and thebb_ik_dlsexemplar. It points at core's rules (mix usage_rules.sync <file> bb:all) for framework basics and covers only what is PID-specific:{BB.PID.Controller, opts}into thecontrollersDSL block (verified against source).kp/ki/kd/tau), output clamps, the setpoint/measurement/output topic+message+path triples, andrate; plus runtime-tunable gains viaparam([...]).simulation: :omitdefault (declared controllers do not start under simulation unless set to:mock/:start); the unique-source / non-empty-path / numeric-output-field init validations; and that this controller does not implementdisarm/1and keeps ticking regardless of safety state.Packaging:
{:usage_rules, "~> 1.2", only: [:dev], runtime: false}.files:list (the package had none) sousage-rules.mdships in the hex tarball while preserving the previous default contents.test/usage_rules_test.exsmirroring the exemplar.mix.lockchanges are limited to the singleusage_rulesentry.