Skip to content

Commit

Permalink
README file update
Browse files Browse the repository at this point in the history
  • Loading branch information
dresco committed May 22, 2024
1 parent 35c7491 commit c299d81
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,29 @@
## grblHAL driver for STM32H7xx processors
# grblHAL driver for STM32H7xx processors

This is a port of [grblHAL](https://www.github.com/grblhAL) for the STM32H7xx series of processors, originally based on the F7 driver from the official repository.

__NOTE:__ This is an initial version, currently only lightly tested with [BTT SKR 3 (EZ)](https://www.biqu.equipment/products/bigtreetech-btt-skr-3-ez-control-board-mainboard-for-3d-printer), [Nucleo-H743ZI2](https://www.st.com/en/evaluation-tools/nucleo-h743zi.html), and [WeAct MiniSTM32H743](https://github.com/WeActTC/MiniSTM32H7xx) boards.
## Supported boards
- [Nucleo-H743ZI](https://www.st.com/en/evaluation-tools/nucleo-h743zi.html)
- [Nucleo-H723ZG](https://www.st.com/en/evaluation-tools/nucleo-h723zg.html)
- [WeAct MiniSTM32H7xx (H743 & H723)](https://github.com/WeActTC/MiniSTM32H7xx)
- [BTT SKR 3 EZ (H743 & H723)](https://www.biqu.equipment/products/bigtreetech-btt-skr-3-ez-control-board-mainboard-for-3d-printer)
- [BTT Octopus Max EZ](https://biqu.equipment/products/bigtreetech-btt-octopusmax-ez-for-3d-printer)

Builds should be supported from both STMCubeIDE and PlatformIO. Board specific settings have been included in the IDE configurations where possible - to avoid the need for code changes when building for different boards. (Please see the upstream Wiki-page [compiling grblHAL](https://github.com/grblHAL/core/wiki/Compiling-GrblHAL) for further instructions for how to import the project, configure the driver and compile).
## Building

PlatformIO firmware builds are run automatically as a GitHub Action on each push to the master branch. For convenience, the resulting firmwares are archived in the artifacts for each run, and can be found under the Actions tab on the GitHub repo (these files remain available for 90 days).
### Web App

The current build configurations include;
- WeAct MiniSTM32H743 with SDCard and USB serial support.
- BTT SKR 3 (including EZ) with SDCard, USB serial, and TMC 2209/5160 driver support. (Note that settings are currently stored in FLASH, as the onboard EEPROM will need a software I2C implementation).
- Nucleo H743ZI with Ethernet support. (WebUI support has also been added to the Nucleo build, however this requires an SDCard breakout).
Builds for the above boards are supported through the upstream [web app](http://svn.io-engineering.com:8080/).

Note that the PlatformIO builds are currently using a custom download url for the latest (v1.10) **framework-stm32cubeh7** files. This will be removed once these updates are available in the upstream PlatformIO package registry.
### Local builds

Available driver options can be found [here](Inc/my_machine.h).
Local builds are supported from both STMCubeIDE and PlatformIO. Board specific settings have been included in the IDE configurations where possible - to avoid the need for code changes when building for different boards. (Please see the upstream Wiki-page [compiling grblHAL](https://github.com/grblHAL/core/wiki/Compiling-GrblHAL) for further instructions for how to import the project, configure the driver and compile).

Note that the PlatformIO builds are currently using a custom download url for the **framework-stm32cubeh7** library files. This will be removed once v1.10 is available in the upstream PlatformIO package registry.

### GitHub CI builds

PlatformIO builds for a number of configurations are run automatically as a GitHub Action on each push to the master branch. For convenience, the resulting firmwares are archived in the artifacts for each run, and can be found under the Actions tab on the GitHub repo (these files remain available for 90 days).

---
2022-08-12
2024-05-22

0 comments on commit c299d81

Please sign in to comment.