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

Make current status more clear in README

Browse source
This commit is contained in:
Filip Ayazi 2021-07-01 21:37:42 +00:00
parent edd0246cc5
commit fdf7afd9d9
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,7 +1,12 @@
# Firmware code for the sangaboard
# Firmware for the Sangaboard and similar motor controllers
*This firmware is Work in Progress and while it should now support all features of the original, many features are untested.*
## 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
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.
## Notable changes