diff options
| author | lonkaars <loek@pipeframe.xyz> | 2022-05-22 22:27:42 +0200 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2022-05-22 22:27:42 +0200 |
| commit | b6369de444a15d6c8fe9fe23e6f872a3b26cbc17 (patch) | |
| tree | ab5035cc59bf57d87487e3c09572db60ee559459 /robot | |
| parent | 366afee53255d85a3b2a54fba2815dc3bfa36c32 (diff) | |
update robot readme table source
Diffstat (limited to 'robot')
| -rw-r--r-- | robot/readme.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/robot/readme.md b/robot/readme.md index 82ef3a6..08788ff 100644 --- a/robot/readme.md +++ b/robot/readme.md @@ -52,21 +52,21 @@ handling module, which then both handles the error and forwards it to pc communication for logging purposes). here's a quick run-down of all modules and 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 `|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 `|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 `|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| -|line finding |`mode_calb `|Fiona| find line by turning on own axis if lost| -|charge station |`mode_chrg `|TBD| go to the charging station transition in the grid, and continue until a black circle is found| -|direct control |`mode_dirc `|TBD| respond to [DIRC](../protocol.md#DIRC) commands| -|wet floor |`mode_spin `|TBD| spin uncontrollably (simulating wet floor??)| -|sensor calibration|`mode_scal `|TBD| calibrate underside uv sensors| +|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 `|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 `|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 `|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| +|line finding |`mode_calb `|Fiona| find line by turning on own axis if lost| +|charge station |`mode_chrg `|TBD| go to the charging station transition in the grid, and continue until a black circle is found| +|direct control |`mode_dirc `|TBD| respond to [DIRC](../protocol.md#DIRC) commands| +|wet floor |`mode_spin `|TBD| spin uncontrollably (simulating wet floor??)| +|sensor calibration|`mode_scal `|TBD| calibrate underside uv sensors| ## some standards |