Compare commits
1 Commits
c168cdf0c4
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| f0a37828a4 |
28
AGENTS.md
28
AGENTS.md
@@ -11,7 +11,7 @@ This fork lives on **two long-lived branches**:
|
|||||||
bug-fixes. **No A-axis, ATC, hooks, or auxcnc/ESP content.** Aim for
|
bug-fixes. **No A-axis, ATC, hooks, or auxcnc/ESP content.** Aim for
|
||||||
changes that benefit any Onefinity owner.
|
changes that benefit any Onefinity owner.
|
||||||
|
|
||||||
- **`esp-a-axis`** — bespoke shop branch. Stacks on top of `master`
|
- **`private-mods`** — bespoke shop branch. Stacks on top of `master`
|
||||||
and adds everything specific to the auxcnc-ESP-driven A axis and
|
and adds everything specific to the auxcnc-ESP-driven A axis and
|
||||||
the ATC: `Hooks` (ATC IPC), `AuxAxis` (ESP serial driver),
|
the ATC: `Hooks` (ATC IPC), `AuxAxis` (ESP serial driver),
|
||||||
`ExternalAxis` (virtual A through gplan), `AuxPreprocessor` (M100-M103),
|
`ExternalAxis` (virtual A through gplan), `AuxPreprocessor` (M100-M103),
|
||||||
@@ -32,44 +32,44 @@ tip. Keep it indefinitely until further notice.
|
|||||||
| UI polish, theme, layout that any user benefits from | `master` |
|
| UI polish, theme, layout that any user benefits from | `master` |
|
||||||
| Build / install / boot performance | `master` |
|
| Build / install / boot performance | `master` |
|
||||||
| Diagnostics, logging, generic Python / Tornado fixes | `master` |
|
| Diagnostics, logging, generic Python / Tornado fixes | `master` |
|
||||||
| Anything that touches `AuxAxis`, `ExternalAxis`, `Hooks`, `AuxPreprocessor` | `esp-a-axis` |
|
| Anything that touches `AuxAxis`, `ExternalAxis`, `Hooks`, `AuxPreprocessor` | `private-mods` |
|
||||||
| Anything mentioning the auxcnc ESP, `/dev/ttyUSB0`, the M100-M103 ATC pneumatics, or motor index 4 | `esp-a-axis` |
|
| Anything mentioning the auxcnc ESP, `/dev/ttyUSB0`, the M100-M103 ATC pneumatics, or motor index 4 | `private-mods` |
|
||||||
| Z-A coupling interlock, ATC tool change sequencing | `esp-a-axis` |
|
| Z-A coupling interlock, ATC tool change sequencing | `private-mods` |
|
||||||
| A-axis UI (DRO row, jog tile, settings page, A-axis routes) | `esp-a-axis` |
|
| A-axis UI (DRO row, jog tile, settings page, A-axis routes) | `private-mods` |
|
||||||
| W → A renames or aux.json migrations | `esp-a-axis` |
|
| W → A renames or aux.json migrations | `private-mods` |
|
||||||
|
|
||||||
When in doubt: ask "would this be useful on a stock Onefinity with no
|
When in doubt: ask "would this be useful on a stock Onefinity with no
|
||||||
ESP attached?" If yes → `master`. If no → `esp-a-axis`.
|
ESP attached?" If yes → `master`. If no → `private-mods`.
|
||||||
|
|
||||||
## Workflow
|
## Workflow
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Day-to-day shop / hardware work (default)
|
# Day-to-day shop / hardware work (default)
|
||||||
git checkout esp-a-axis
|
git checkout private-mods
|
||||||
# … do work, commit …
|
# … do work, commit …
|
||||||
git push origin esp-a-axis
|
git push origin private-mods
|
||||||
|
|
||||||
# Generic improvement to master
|
# Generic improvement to master
|
||||||
git checkout master
|
git checkout master
|
||||||
# … do work, commit …
|
# … do work, commit …
|
||||||
git push origin master
|
git push origin master
|
||||||
|
|
||||||
# After landing on master, replay esp-a-axis on top
|
# After landing on master, replay private-mods on top
|
||||||
git checkout esp-a-axis
|
git checkout private-mods
|
||||||
git rebase master
|
git rebase master
|
||||||
git push --force-with-lease origin esp-a-axis
|
git push --force-with-lease origin private-mods
|
||||||
```
|
```
|
||||||
|
|
||||||
If a change accidentally lands on `master` but is bespoke (touches
|
If a change accidentally lands on `master` but is bespoke (touches
|
||||||
the file table above), move it: `git reset --hard <prev>` on master,
|
the file table above), move it: `git reset --hard <prev>` on master,
|
||||||
cherry-pick onto `esp-a-axis`, force-push master.
|
cherry-pick onto `private-mods`, force-push master.
|
||||||
|
|
||||||
## Deploy
|
## Deploy
|
||||||
|
|
||||||
- `./deploy.sh local` — UI bundle on `localhost:8770` (tmux session
|
- `./deploy.sh local` — UI bundle on `localhost:8770` (tmux session
|
||||||
`onefin-local`). No controller backend; A-axis row stays hidden.
|
`onefin-local`). No controller backend; A-axis row stays hidden.
|
||||||
- `./deploy.sh hardware` — rsync to the Pi over SSH, restart
|
- `./deploy.sh hardware` — rsync to the Pi over SSH, restart
|
||||||
`bbctrl.service`. Use the `esp-a-axis` branch on the shop Pi.
|
`bbctrl.service`. Use the `private-mods` branch on the shop Pi.
|
||||||
- `./deploy.sh prod` — bundle a release tarball.
|
- `./deploy.sh prod` — bundle a release tarball.
|
||||||
|
|
||||||
See `.pi/BUILD.md` for the full build / flash / cross-compile flow.
|
See `.pi/BUILD.md` for the full build / flash / cross-compile flow.
|
||||||
|
|||||||
Reference in New Issue
Block a user