diff options
| author | lonkaars <loek@pipeframe.xyz> | 2022-05-09 12:44:08 +0200 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2022-05-09 12:44:08 +0200 |
| commit | c30c9250c18513899cee2ddc35071d98d36a7470 (patch) | |
| tree | c1cb67364e091bcd585f86b3d838b7c2c332c3f3 | |
| parent | 0057f1de52bc97c39b78f3c86e1674c692508fca (diff) | |
small update to robot/readme.md
| -rw-r--r-- | robot/readme.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/robot/readme.md b/robot/readme.md index b025f7d..03c842b 100644 --- a/robot/readme.md +++ b/robot/readme.md @@ -50,7 +50,7 @@ supposed to do: |pc communication|`sercomm `|reads and parses incoming serial data; sends all data in the message buffer| |error handling |`errcatch `|receives error codes; controls how errors are handled| |i/o read & write|`io `|reads all inputs to global state; writes all outputs| -|mode logic |`model `|executes the appropriate module for current mode| +|mode logic |`modes `|executes the appropriate module for current mode| |maze |`mode_maze `|controls robot during maze portion of map; hands off control to warehouse module| |warehouse |`mode_grid `|controls robot during warehouse portion of map; hands off control to maze module| |emergency stop |`mode_halt `|stops all execution until emergency mode is reset by software or user| @@ -85,4 +85,5 @@ this list will probably get updated from time to time: - arbitrary numbers should be aliased to `#define` statements or `enum`s if part of a series. - constants should be placed in `consts.h` +- run `make format` as a seperate commit in case of breaking changes |