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

Remove warning, blocking issues were resolved

Browse source
This commit is contained in:
Filip Ayazi 2023-03-26 01:23:56 +00:00
parent 144093e252
commit 767f86b683
1 changed files with 6 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,11 +1,5 @@
# Firmware for the Sangaboard and similar motor controllers # Firmware for the Sangaboard and similar motor controllers
## This firmware is a Work in Progress, do NOT use for production builds
Many features of this firmware are untested and it changes behaviour of the pysangaboard module, breaking fast autofocus in OFM software (see #1, !1). If you want a reliable device use [the original firmware](https://gitlab.com/bath_open_instrumentation_group/sangaboard/-/blob/master/arduino_code).
If you like living on the edge and decide to use this firmware, please report any issues you run into to this repo.
## About ## About
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) 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) with some improvements to the infrastructure and features.
@ -39,17 +33,18 @@ for sangaboard v0.3 replace `nano` with `leonardo` in the above commands (untest
- [x] Handle Sangaboardv3 - [x] Handle Sangaboardv3
### Testing ### Testing
- [ ] Ensure responses to commands match the original version - [x] Ensure responses to commands match the original version
- [ ] Test endstop modules - [x] Test endstop modules
- [ ] Test Light sensor module - [ ] Test Light sensor module
- [ ] Test on different platforms - [x] Test on different platforms
### Improvements and fixes ### Improvements and fixes
- [ ] Add a CI script - [x] Add a CI script
- [x] Add test for argument parsing - [x] Add test for argument parsing
- [ ] Add more unit tests - [ ] Add more unit tests
- [x] Test automatic building and upload - [x] Test automatic building and upload
- [x] Support other platforms - [x] Support other platforms
- [ ] Clean up - [x] Clean up
- [ ] Improve handling of unused modules/libraries - [ ] Improve handling of unused modules/libraries
- [x] Lower RAM use - [x] Lower RAM use
- [ ] Implement functional tests