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

some compatibility fixes and upload instructions

Browse source
This commit is contained in:
Filip Ayazi 2021-06-02 00:56:23 +01:00
parent 35d969aadd
commit edd0246cc5
6 changed files with 43 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -11,11 +11,20 @@ The code is split into the main part which mostly handles command parsing and mo
Motor moves now do not block command processing and a new command `stop` was added which aborts any move in progress.
The firware can be build against different platforms (pi pico, stm32). `boards.h` contains wiring configuration which will need to be adjusted when used with a custom board.
## Hardware
This is mainly intended for Sangaboard control boards and all configuration for these is already in `boards.h`, but it can also be used on different platforms (pi pico, stm32 (bluepill)). To use a custom board based on any of these platforms adjust `boards.h` to match your wiring.
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.
If you have additional hardware connected to the board (Endstops, Light sensor) support for these can be enabled in `config.h`.
## Building and uploading
The easiest way to build and upload this firmware is to install `pio core` via pip. For arduino nano with sangaboard v0.2 run
```
pip3 install platformio
pio lib install
pio run -e nano
pio run -e nano -t upload
```
for sangaboard v0.3 replace `nano` with `leonardo` in the above commands (untested).
## TODO list