diff options
| author | lonkaars <loek@pipeframe.xyz> | 2022-05-11 13:22:59 +0200 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2022-05-11 13:22:59 +0200 |
| commit | 74c9202e2a2347620cfe0459a2de060eebd7051b (patch) | |
| tree | b5d5092b392f1ad4f4a1683b3932a3ed528cf170 /robot/readme.md | |
| parent | 92f8dc33ab4517393f3b3db75715774d619585a8 (diff) | |
[wip] error handling module
Diffstat (limited to 'robot/readme.md')
| -rw-r--r-- | robot/readme.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/robot/readme.md b/robot/readme.md index bb88e80..1ffdb65 100644 --- a/robot/readme.md +++ b/robot/readme.md @@ -48,12 +48,12 @@ what they're supposed to do: |module |internal name|author|purpose| |----------------|-------------|-|-| |hypervisor |`hypervisor `|N/a| backbone of all other modules; stores global variables; controls when other modules run| -|pc communication|`sercomm `|Jorn & Abdullaahi| reads and parses incoming serial data; sends all data in the message buffer| +|pc communication|`sercomm `|Fiona| reads and parses incoming serial data; sends all data in the message buffer| |error handling |`errcatch `|Loek| receives error codes; controls how errors are handled| -|i/o read & write|`io `|Fiona| reads all inputs to global state; writes all outputs| +|i/o read & write|`io `|Jorn & Abdullaahi| reads all inputs to global state; writes all outputs| |mode logic |`modes `|N/a| executes the appropriate module for current mode| -|maze |`mode_maze `|TBD| controls robot during maze portion of map; hands off control to warehouse module| -|warehouse |`mode_grid `|TDB| controls robot during warehouse portion of map; hands off control to maze module| +|maze |`mode_maze `|Jorn & Abdullaahi| controls robot during maze portion of map; hands off control to warehouse module| +|warehouse |`mode_grid `|Loek| controls robot during warehouse portion of map; hands off control to maze module| |emergency stop |`mode_halt `|Fiona| stops all execution until emergency mode is reset by software or user| |calibration |`mode_calb `|Fiona| find line by turning on own axis if lost| @@ -120,10 +120,10 @@ to act on accordingly. the error handling module (a) provides functions for other modules to report errors, and (b) handles errors accordingly. -- [ ] create an error `struct` that holds: - - [ ] error code - - [ ] message length - - [ ] message contents +- [x] create an error `struct` that holds: + - [x] error code + - [x] message length + - [x] message contents - [ ] create a global error ring buffer with an appropriate size that holds error messages - [ ] handle errors in the error buffer, referencing the functional |