Skip to content
This repository has been archived by the owner on Jan 14, 2024. It is now read-only.

Commit

Permalink
Added notifications about move to new home
Browse files Browse the repository at this point in the history
  • Loading branch information
terjeio committed Jun 19, 2021
1 parent 9f405ba commit 7b98967
Show file tree
Hide file tree
Showing 14 changed files with 59 additions and 10 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
## grblHAL ##

__NEWS!__ grblHAL is moving to a [new home](https://github.com/grblHAL) where the project is split into separate repositories, one for the shared core, one for each plugin and one for for each driver. The driver dependencies to the core and plugins are set up as git submodules and drivers can thus be downloaded separately.
__NEWS!__ grblHAL has moved to a [new home](https://github.com/grblHAL) where the project is split into separate repositories, one for the shared core, one for each plugin and one for for each driver.
The driver dependencies to the core and plugins are set up as git submodules and drivers can thus be downloaded separately.

There are both upsides and downsides to this move, the most notable downside for users is that downloading the source code as a .zip-file no-longer get all dependencies resolved.
Each submodule a driver is dependent on has to be downloaded separately and copied to the corresponding folder in the driver
This is a bit more involved than the copying that was needed in previous releases where the dependent code can be found in the downloaded .zip-file.

An upside is that a driver download with [git](https://git-scm.com/downloads) or [GitHub desktop](https://desktop.github.com/) will fetch all dependencies automatically and the download is no longer "polluted" with unwanted drivers.

For the time beeing I will keep this repository intact and the source code in sync.
New issues should be raised, pull requests submitted and discussions started at the new home.
Use the [core repository](https://github.com/grblHAL/core) for raising new issues or starting discussions if it is not clear to you where they belong.

This repository will eventually be moved to the new home and kept as an reference.
This repository is only kept as an reference.

---

Expand Down Expand Up @@ -91,4 +91,4 @@ List of Supported G-Codes:
```

---
2021-02-25
2021-06-19
14 changes: 8 additions & 6 deletions drivers/ESP32/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
## ESP32GrblDriver

A GrblHAL driver for the ESP32 processor. *** Preview version ***
__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/ESP32), new issues should be opened there.

### How to build using ESP-IDF v4.3:
---

### How to build using ESP-IDF v3.3:

While this manual briefly describes basic build process on Linux OS, you can find more details
as well as differences for building on other OS at this webpage:

https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-2-get-esp-idf

First you have to prepare esp-idf v4.3:
First you have to prepare esp-idf v3.3:

```bash
#Create directory and clone esp-idf into it:
mkdir -p ~/esp
cd ~/esp
git clone -b release/v4.3 --recursive --shallow-submodules https://github.com/espressif/esp-idf.git
git clone -b release/v3.3 --recursive --shallow-submodules https://github.com/espressif/esp-idf.git

#Prepare build environment and toolchain:
cd ~/esp/esp-idf
Expand Down Expand Up @@ -46,8 +48,8 @@ Once flashing is complete, your CNC controller is ready to be configured and use
If you're familiar with [Docker](https://docker.io), you can use it to build grblHAL in a self-contained environment without installing the complete toolchain on your system:

- prepare and configure the codebase as described above
- build with `docker run -it --rm -v $(pwd):/grbl -w /grbl/drivers/ESP32 espressif/idf:release-v4.3 idf.py build`
- flash with `docker run -it --rm -v $(pwd):/grbl --privileged -v /dev:/dev -w /grbl/drivers/ESP32 espressif/idf:release-v4.3 idf.py -p /dev/ttyUSB0 flash`
- build with `docker run -it --rm -v $(pwd):/grbl -w /grbl/drivers/ESP32 espressif/idf:release-v3.3 idf.py build`
- flash with `docker run -it --rm -v $(pwd):/grbl --privileged -v /dev:/dev -w /grbl/drivers/ESP32 espressif/idf:release-v3.3 idf.py -p /dev/ttyUSB0 flash`

### Changelog/Notes:

Expand Down
4 changes: 4 additions & 0 deletions drivers/IMXRT1062/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## iMXRT1062 Driver

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/iMXRT1062), new issues should be opened there.

---

A GrblHAL driver for the NXP iMXRT1062 processor on a [Teensy 4.x board](https://www.pjrc.com/store/teensy40.html).

This driver compiles and uploads from the Arduino IDE and is partially dependent on the Arduino framework. [Teensyduino](https://www.pjrc.com/teensy/td_download.html) is required and must be added to the Arduino IDE.
Expand Down
4 changes: 4 additions & 0 deletions drivers/LPC1769/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## LPC176x grblHAL driver

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/LPC176x), new issues should be opened there.

---

A GrblHAL driver for NXP LPC1768 and LPC1769 processors.

Loosely based on the official [grbl-LPC port](https://github.com/gnea/grbl-LPC).
Expand Down
4 changes: 4 additions & 0 deletions drivers/MSP430F5529/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## MSP430F5529

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/MSP430F5529), new issues should be opened there.

---

A GrblHAL driver for the Texas Instruments MSP430F5529 LaunchPad.

I made this driver just to see if it could be done and for now I do not intend to use it myself... The only 16-bit grbl port available?
Expand Down
4 changes: 4 additions & 0 deletions drivers/MSP432/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## MSP432P401R

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/MSP432P401R), new issues should be opened there.

---

A GrblHAL driver for the MSP432P401R ARM processors.

See the Wiki-page for [compiling grblHAL](https://github.com/terjeio/grblHAL/wiki/Compiling-GrblHAL) for instructions for how to import the project, configure the driver and compile.
Expand Down
4 changes: 4 additions & 0 deletions drivers/MSP432E401Y/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## MSP432E401Y

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/MSP432E401Y), new issues should be opened there.

---

A GrblHAL driver for the Texas Instruments [MSP432E401Y LaunchPad](http://www.ti.com/tool/MSP-EXP432E401Y#).

See the Wiki-page for [compiling grblHAL](https://github.com/terjeio/grblHAL/wiki/Compiling-GrblHAL) for instructions for how to import the project, configure the driver and compile.
Expand Down
4 changes: 4 additions & 0 deletions drivers/PSoC5/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## PSoC5 Driver

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/PSoC5), new issues should be opened there.

---

A GrblHAL driver for Cypress PSoC 5 \(CY8CKIT-059\

** EXPERIMENTAL **
Expand Down
4 changes: 4 additions & 0 deletions drivers/SAM3X8E/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## SAM3X8E Driver

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/SAM3X8E), new issues should be opened there.

---

A GrblHAL driver for the Atmel SAM3X8E processor on a [Arduino Due board](https://store.arduino.cc/arduino-due).

See the Wiki-page for [compiling grblHAL](https://github.com/terjeio/grblHAL/wiki/Compiling-GrblHAL) for instructions for how to import the project, configure the driver and compile.
Expand Down
4 changes: 4 additions & 0 deletions drivers/SAMD21/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## SAMD21 Driver

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/SAMD21), new issues should be opened there.

---

__IMPORTANT:__ Arduino version 1.8.11 has breaking changes in the library code that causes compilation to fail. Use an earlier version or select another driver for your project.
See issue #224 for more information. Also note that I am __*not*__ going to make a workaround for this since the compilation error is in the shared grblHAL core code.

Expand Down
4 changes: 4 additions & 0 deletions drivers/STM32F1xx/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## grblHAL driver for STM32F1xx processors

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/STM32F1xx), new issues should be opened there.

---

__NOTE:__ [STM32F3xx Blackpill](../STM32F3xx/README.md) can often be used as a drop-in replacement of STM32F103 based *pills. It is likely that grblHAL support for F103 will be frozen at some point due to lack of memory.

Loosely based on code from robomechs [6-AXIS-USBCNC-GRBL](https://github.com/robomechs/6-AXIS-USBCNC-GRBL) port, updated for [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.htm) and the latest STM HAL drivers where appropriate.
Expand Down
3 changes: 3 additions & 0 deletions drivers/STM32F3xx/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## grblHAL driver for STM32F3xx processors

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/STM32F3xx), new issues should be opened there.

---
See the Wiki-page for [compiling grblHAL](https://github.com/terjeio/grblHAL/wiki/Compiling-GrblHAL) for instructions for how to import the project, configure the driver and compile.

__NOTE:__ This is an initial version, currently only bench tested with an oscillocope using a [F303 Blackpill board](https://robotdyn.com/stm32f303cct6-256-kb-flash-stm32-arm-cortexr-m4-mini-system-dev-board-3326a9dd-3c19-11e9-910a-901b0ebb3621.html).
Expand Down
4 changes: 4 additions & 0 deletions drivers/STM32F4xx/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## STM32F4xx grblHAL driver

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/STM32F4xx), new issues should be opened there.

---

A grblHAL driver for the STM32F401xC, STM32F407xx, STM32F411xE and STM32F446xx ARM processors.

Loosely based on code from robomechs [6-AXIS-USBCNC-GRBL](https://github.com/robomechs/6-AXIS-USBCNC-GRBL) port, updated for [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.htm) and the latest STM HAL drivers where appropriate.
Expand Down
4 changes: 4 additions & 0 deletions drivers/Simulator/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# GRBL SIM

__NOTE:__ This driver has been moved to the [new grblHAL repository](https://github.com/grblHAL/Simulator), new issues should be opened there.

---

: by Jens Geisler, Adam Shelly

Modified by Terje Io for grblHAL. Original implementation for Grbl can be found [here](https://github.com/grbl/grbl-sim).
Expand Down

0 comments on commit 7b98967

Please sign in to comment.