Skip to content
grbl controller for esp32
Branch: master
Clone or download

README.md

grbl_controller_esp32

This Grbl controller runs on a ESP32

This project allows to control a CNC running GRBL without having to use a pc.

This is an alternative to Marlin or Repetier for CNC.

Note: GRBL has to run on a separate micro computer (e.g. an Arduino Uno, Mega or a STM32 blue pill).
This project only intends to replace the PC by an ESP32 board, not to replace GRBL.

This application allows to:

  • select a file on the SD card (with Gcode) and send it to GRBL for execution
  • pause/resume/cancel sending the Gcode
  • send predefined set of GRBL commands (= macros)
  • unlock grbl alarm
  • ask grbl for homing the CNC
  • move X,Y, Z axis by 0.01, 0.1, 1, 10 mm steps
  • set X, Y, Z Work position to 0 (based on the current position)
  • forward GRBL commands from the PC (so you can still control your CNC using your pc with e.g. Universal Gcode sender).
    This is e.g. useful to configure GRBL from the PC with GRBL "$" commands.
    The Gcode/commands can be sent using or
    • the USB (serial) interface that exist on the ESP32 developement board.
    • a telnet protocol over Wifi (in this case, best is to use BCNC software on pc side because it support telnet connection)
  • let a browser session running on pc connect to the ESP32 over Wifi in order to upload/download files between the pc and the SD card. So you can avoid physical manipulation of SD card. This works currently only with the root directory on the SD card (not with subdirectory)

This application displays some useful GRBL informations like

  • the source of the Gcode being sent to GRBL (e.g. SD card, USB, Telnet)
  • the GRBL status (Idle, Run, Alarm,...)
  • the work position (Wpos) and the machine position (Mpos)
  • the last error and alert message.

Optionnally you can connect a Nunchuk (kind of joystick) in order to move the X, Y, Z, axis.
To move the axis, you have to move the joystick (up/down/left/right) and simultaneously

  • press the C button to move X/Y axis,
  • press the Z button to move Z axis Nunchuk is automatically disconnected when the source of Gcode USB or Telnet.

Hardware

To implement this project you need:

  • an ESP32 development board and
  • a display module combining 3 components:
    • a touch screen 320 X 240 a ILI9341 (display controller),
    • a XPT2046 (control the touch panel) and
    • a SD card support.

It should also be possible to use a separate SD card support.
Note: this configuration uses the ILI9341 with 4 wires (CLK, MOSI, MISO and CD).
Currently, this project works only with a TFT having a ILI9341 chip, a resolution of 320X240 and XPT2046 chip for the touch screen. If you are using another display, you should change the code yourself.

Software

This project compiles in Arduino IDE but it requires:

  • to add in Arduino IDE the software that support ESP32. The process is explained e.g. in this link https://randomnerdtutorials.com/installing-the-esp32-board-in-arduino-ide-windows-instructions/
  • to edit the file config.h from this project in order to specify if you plan to use the WiFi and if so if you are using the ESP32 in station mode or in access point mode. When using the WiFi, you must also specify the SSID (= name of the access point) and the password (in access point mode, it must contain at least 8 char)

Take care that if you do not use my configuration, you can have:

  • to edit the file User_setup.h included in the TFT_eSPI_ms folder.
    This file specify the type of display controller and the pins being used by the SPI, the display and the touch screen chip select.
  • to edit the file config.h from this project in order to specify some pins being used (e.g. the chip select for the SD card reader)

Note: the pins used for the SPI signals (MOSI, MISO, SCLK) are currently hardcoded.
Please note that many ESP32 pins are reserved and can't ne used (reserved for bootup, for internal flash, input only,...). See doc on ESP for more details.

Note: the first time you let ESP32 run this program, the program should execute a calibration of the touch panel.
The screen should first display an arrow in a corner. You have to click on the corner.
When done, an arrow should also be displayed sucessively in the 3 others corners. Click each time on the arrow.
This should normally be done only once. The calibration data are stored automatically in the ESP32.

If you want to recalibrate your screen, you should change the "config.h" file (parameter

Wiring the ESP32

Here the connections being used in my own setup.

Between ESP32 and TFT.

  • 5V - - - - - -> Vcc (on my TFT, it provides internally voltage to SD card)
  • Gpio13 - - -> CS(chip select)
  • Grnd - - - -> Grnd (on my TFT, it provides internally grnd to SD card)
  • Gpio12 - - -> Reset
  • Gpio14 - - -> DC (data/command)
  • Gpio25 - - -> CD
  • Gpio18 - - -> CLK
  • Gpio19 - - -> MISO
  • Gpio23 - - -> MOSI

Between ESP32 and touch screen

  • Gpio27 - - -> CS (chip select)
  • Gpio18 - - -> CLK
  • Gpio19 - - -> MISO(T_DO)
  • Gpio23 - - -> MOSI(T_DIN)

Between ESP32 and SD card

  • Gpio26 - - -> CS (chip select)
  • Gpio18 - - -> CLK
  • Gpio19 - - -> MISO
  • Gpio23 - - -> MOSI

Between ESP32 and GRBL computer

  • Gpio16 is the Serial port Rx from ESP32; It has to be connected to TX pin from GRBL
  • Gpio17 is the Serial port Tx from ESP32; It has to be connected to RX pin from GRBL Note : Grnd has to be common between ESP32 and GRBL computer.

Between ESP32 and Nunchuk

  • 3.3V => Vcc
  • Grnd => Grnd
  • Gpio21 => SDA
  • Gpio22 => SCL

Control of GRBL from the PC

In order to control GRBL from a PC, you can use the software bCNC on the PC.
It allows you to connect ESP32 using a com port (USB) or using wifi.
To install bCNC, follow the instructions from this site: https://github.com/vlachoudis/bCNC/wiki/Installation
For Windows, do not use the exe file (at march 2019 it did not work) but start intalling python2.7 and then install bCNC using pip.
At march 2019, this does not install the latest version of pyserial software.
So, you have to enter also (in the command windows): pip install --upgrade pyserial
Then, you can launch bCNC with the command: python.exe -m bCNC.
Note: if you already have a version 3 of python running on your PC, it could be that you have to type: python2.exe -m bCNC.\

In bCNC, select the "File" tab, and in the Serial part, in field Port, enter:\

  • for a USB connection : comX (where X is the com port assigned to ESP32 e.g. with Arduino)
  • for a Wifi (telnet) connection : socket://192.168.1.5:23 (where 192.168.1.5 has to be replaced by the IP adress assign to your ESP32)

In bCNC, in the serial part, in field Controller, enter the type of GRBL you are using, so probably it will be GRBL1.\

Then click on the "Open" button in bCNC.
And finally, on ESP32, select the Print button and then "USB" or "Telnet".
Once USB or Telnet is activated, you can't anymore use the ESP32 options (Setup, ...).
The only thing you can do on ESP32 side is to select the button "Stop PC" which will stop the flow of data exchanged with the PC.\

Control of SD card content from the PC

In order to manage the files on the SD card from the PC, you have to:

  • open a browser session (chrome, ...)
  • fill in the URL of your ESP32 e.g. //192.168.1.5 (the value is displayed on the setup screen on ESP32)
  • then click on the buttons Download, Upload , Delete, Directory Note: you can only interact with the root of the SD card (not the sub directories).

Informations on the TFT layout and functions

Info screen:

This is the first and main screen of the application. It displays:

  • line 1 left: a status saying if you are printing from SD card (and % of printing), in Pause or if GRBL is controlled via PC+USB or via PC+wifi
  • line 1 right: the GRBL status (Idle, Run, Alarm , Hold, Jog, ...) or "??" when GRBL is not responding (e.g. GRBL in alarm:1)
  • line 2: the last message (error or alarm) sent by GRBL. This message is automatically cleared when you go back from Setup screen to Info screen.
  • line 3: a wifi icon; it is red when there are no PC connected with telnet, green when a pc is connected with telnet
  • next lines: the X, Y, Z positions in Work coordinate and in Machine coordinate
  • last line: the current feed rate and spindle rpm.
  • there are also 2 buttons that depends on the current state (e.g. Setup, Print, Pause, Resume, Cancel)

Setup screen

It displays:

  • The IP address to be used if you want to
    • upload/download/delete/list files from the root directory on the SD. This IP has to be entered in a PC browsing session
    • use a telnet (=wifi) connection to control GRBL
    • The GRBL status
  • The last message from GRBL
  • some buttons to request from GRBL a Homing, an unlock or a soft reset
  • some buttons to access other screens

Print screen

It displays some buttons to select between

  • printing a file from the SD card; you will then get a screen with a list of files/directories on the SD card
  • printing/controlling GRBL from the PC using the USB connection.
  • printing/controlling GRBL from the PC using a telnet connection.
  • direct links to other screens (Setup, Cmd, Info) Note: with USB and Telnet, the ESP32 works in "passthrough". It means that it works just like the PC was directly connected to GRBL. So, Once USB or Telnet is activated, you can't anymore use the ESP32 options (Setup, ...).
    The only thing you can do on ESP32 side is to view the current position and status and to select the button "Stop PC" which will stop the flow of data exchanged with the PC.\

File list screen

It allows to select a file in a directory from the Sd card

  • line 1 left: index of the first file name being displayed followed by "/" and the total number of files in the current directory
  • line 2 right: name of the current directory (/ for the root)
  • up to 4 buttons with file/directory names; text is blue on white background for a directory and the opposite for a file. Pressing one of those buttons goes into the directory (one level down) or start printing the file (= sending the Gcode to GRBL). Still printing does not start immediately because the controller is first set in Pause mode in order to let you eventually cancel the job. So, in order to really start printing you have to confirm pressing the Resume button on Info screen
  • button UP to move one level up in the directory hierarchy
  • button <- and -> to scroll in the list

Move screen

It allows to move the motors in the X, Y and Z axis.

  • It displays the current work positions and the distances moved since this screen has been entered.
  • there are 2 kinds of moves
    • when the button "Auto" is displayed, it means that the distances to move depends on the duration of pressing a X,Y,R button. When you keep pressing, the speed increases. When you releases, the motor stops)
    • If you press the "Auto" button, the button will be renamed "0.01". It means that each press on X, Y,Z will move by 0.01 mm (or inch depending on the GRBL setting). Button X,Y,Z has to be released and pressed again to move a new step. Pressing 0.01 button changes it to 0.1. Pressing again, it becomes 1, 10 and finally back to Auto.

Set XYZ screen

It allows to set the work coordinates X, Y, Z (or all 3) to zero at the current machine position.

Cmd screen

It allows you to execute some set of predefined Gcode commands. It is a kind of macros that you can define yourself (e.g. for probing, changing coordinates system, ...)

  • you can define up to 7 commands (the name and the Gcode commands)
  • to define/update a Cmd button, you have to fill in a file on your pc with one set of Gcode commands and save it under a name like Cmd5_name.xxx where
    • Cmd and _ are fixed
    • 5 is replaced by the digit of the Cmd (must be between 1 and 7)
    • name is replaced by the name given to the button (must be less than 16 char and begin with a letter a...z or A...Z)
    • xxx is the file extension and is discarded
  • this file has to be copied/uploaded on the SD card
  • you have to select this file with the Print from SD Card option. The file (due to the structure of the name) will not be printed but the Cmd button will be created and the Gcode commands will be saved in the ESP32.
  • So, later on, you can use the Cmd buttons even if the SD card is not present. Notes:
  • A button being added will be displayed only after the next reset of ESP32.
  • "Printing" a file having the same Cmd digit as an existing Cmd button will replace as well the name as the Gcode of the button
  • to delete a Cmd button, "Print" a file having a name equal to "delete" So, e.g. "Cmd2_delete.xxx" will delete the second button.
You can’t perform that action at this time.