diff options
| author | lonkaars <loek@pipeframe.xyz> | 2022-05-14 00:56:22 +0200 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2022-05-14 00:56:22 +0200 |
| commit | 8f355e91cbe48626c84d5e8e8455c47395076999 (patch) | |
| tree | d26f154aea94115004b9db736a4b1a1b21486ae4 /robot/readme.md | |
| parent | d9df6e65017e9f4409b33a13e4aa62f37e685946 (diff) | |
update robot readme
Diffstat (limited to 'robot/readme.md')
| -rw-r--r-- | robot/readme.md | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/robot/readme.md b/robot/readme.md index 5e9990e..6be2f81 100644 --- a/robot/readme.md +++ b/robot/readme.md @@ -17,6 +17,13 @@ device manager on windows, or by running `ls /dev/ttyACM*` on linux. once the com port is configured, run `make flash` to upload the executable and automatically reboot the robot. +another fun option in the makefile is the SIM mode. by uncommenting the line `# +SIM = true`, the robot code can be compiled for desktop debugging instead. all +used pololu functions must be manually implemented in sim.c for this to work, +but it allows easier debugging. *it's important that the `orangutan_shim.h` +header is used instead of including `<pololu/orangutan.h>` directly for this to +keep working!* + ## module hierarchy the software is divided into seperate 'modules' for organizational, @@ -131,8 +138,14 @@ errors, and (b) handles errors accordingly. error - [ ] forward error codes to the pc-communication module -empty function declarations are in place for providing other modules an error -reporting function. +~empty function declarations are in place for providing other modules an error +reporting function.~ + +this module is as good as finished but full functionality is currently +dependent on: + +- [ ] pc communication +- [ ] other mode implementations ### i/o read & write |