q3k/sangaboard-firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix README markdown

Browse source
This commit is contained in:
Filip Ayazi 2021-05-21 03:36:14 +00:00
parent 2f78522064
commit 8f66bb7da9
1 changed files with 12 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -2,12 +2,12 @@
*This firmware is Work in Progress and has not reached feature parity with the original yet (see below for more details)* *This firmware is Work in Progress and has not reached feature parity with the original yet (see below for more details)*
Firmware for the control board of OpenFlexure Microscope. This is a refactor of the (original arduino code](https://gitlab.com/bath_open_instrumentation_group/sangaboard/-/blob/master/arduino_code/README.md) with some improvements to the infrastructure and features. Firmware for the control board of OpenFlexure Microscope. This is a refactor of the [original arduino code](https://gitlab.com/bath_open_instrumentation_group/sangaboard/-/blob/master/arduino_code/README.md) with some improvements to the infrastructure and features.
## Notable changes ## Notable changes
This version of the firmware uses PlatformIO rather than Arduino IDE. This version of the firmware uses PlatformIO rather than Arduino IDE.
The code is split into the main part which mostly handles command parsing and modules which execute actual commands, allowing the firmware to be easily extensible with new features (add a module based on one of the existing ones and add a line to setup() to register it's commands and loop function). The code is split into the main part which mostly handles command parsing and modules which execute actual commands, allowing the firmware to be easily extensible with new features (add a module based on one of the existing ones and add a line to setup to register its commands and loop function).
Motor moves now do not block command processing and a new command `stop` was added which aborts any move in progress. Motor moves now do not block command processing and a new command `stop` was added which aborts any move in progress.
@ -16,15 +16,16 @@ Motor moves now do not block command processing and a new command `stop` was add
Currently works on Arduino Nano + Sangaboard v0.2. Other platforms might work with appropriate `platform.ini` and `config.h` changes and will be supported in due course. Currently works on Arduino Nano + Sangaboard v0.2. Other platforms might work with appropriate `platform.ini` and `config.h` changes and will be supported in due course.
## TODO list ## TODO list
### Original firmware feature parity ### Original firmware feature parity
- [] Implement Endstops module - [ ] Implement Endstops module
- [] Implement Light sensor modules - [ ] Implement Light sensor modules
- [] Handle Sangaboardv3 - [ ] Handle Sangaboardv3
- [] Ensure responses to commands match the original version - [ ] Ensure responses to commands match the original version
### Improvements and fixes ### Improvements and fixes
- [] Add a CI script - [ ] Add a CI script
- [] Add tests (argument parsing) - [ ] Add tests (argument parsing)
- [] Test automatic building and upload - [ ] Test automatic building and upload
- [] Support other platforms - [ ] Support other platforms
- [] Clean up some of the messier bits - [ ] Clean up some of the messier bits