mirror of
https://github.com/bdring/Grbl_Esp32.git
synced 2025-08-26 15:54:29 +02:00
Updates to limit switches
- You can now comment out limit switch pins to free up the I/O - Cleaned up cpu_map.h to move the "don't change" items to a section at the end - updates on project status to readme file
This commit is contained in:
15
README.md
15
README.md
@@ -2,11 +2,7 @@
|
||||
|
||||
# Grbl (CNC Controller) For ESP32
|
||||
|
||||

|
||||
|
||||
### Status: Functional Beta (See minor issues below)
|
||||
|
||||
|
||||

|
||||
|
||||
### Project Overview
|
||||
|
||||
@@ -33,7 +29,7 @@ This is a port of [Grbl](https://github.com/gnea/grbl) for the ESP32. The ESP32
|
||||
|
||||
The code should be compiled using the latest Arduino IDE. [Follow instructions here](https://github.com/espressif/arduino-esp32) on how to setup ESP32 in the IDE. The choice was made to use the Arduino IDE over the ESP-IDF to make the code a little more accessible to novices trying to compile the code.
|
||||
|
||||
I use the NodeMCU 32S version of the ESP32. I suggest starting with that if you don't have hardware yet.
|
||||
I use the ESP32 Dev Module version of the ESP32. I suggest starting with that if you don't have hardware yet.
|
||||
|
||||
For basic instructions on using Grbl use the [gnea/grbl wiki](https://github.com/gnea/grbl/wiki). That is the Arduino version of Grbl, so keep that in mind regarding hardware setup. If you have questions ask via the GitHub issue system for this project.
|
||||
|
||||
@@ -49,15 +45,16 @@ Using SD Card
|
||||
|
||||
### Roadmap
|
||||
|
||||
- Add Wifi support and a web page interface
|
||||
- [Wifi Support](https://github.com/bdring/Grbl_Esp32/wiki/ESP3D-Web-UI-for-Grbl_ESP32) is currently in development. Use the [WebUI branch](https://github.com/bdring/Grbl_Esp32/tree/WebUI) if you want to check it out.
|
||||
- Add support for additional axes
|
||||
|
||||
### Credits
|
||||
|
||||
The original [Grbl](https://github.com/gnea/grbl) is an awesome project by Sungeon (Sonny) Jeon. I have known him for many years and he is always very helpful. I have used Grbl on many projects. I only ported because of the limitation of the processors it was designed for. The core engine design is virtually unchanged.
|
||||
|
||||
### Contribute
|
||||
The Wifi and WebUI is based on [this project.](https://github.com/luc-github/ESP3D-WEBUI)
|
||||
|
||||
I would love to have help with this project. There are many things that need to be improved and added, especially BlueTooth and/or WiFi. If you need hardware to test with, I might be able to help with a test PCB.
|
||||
### Contribute
|
||||
|
||||
 There is a slack channel for the development this project. Ask for an Invite
|
||||
|
||||
|
Reference in New Issue
Block a user