Skip to content
ESP3D Logo ESP3D Ecosystem

Installation

Prerequisites

Section titled “Prerequisites”
  • ESP-IDF 5.4.x installed and configured
  • Python 3.8+
  • USB cable connected to your ESP32 board

Clone the repository

Section titled “Clone the repository”
Terminal window
git clone https://github.com/luc-github/ESP3D-X.git
cd ESP3D-X

Build

Section titled “Build”

The project uses a central build launcher build_all.py.

List available targets

Section titled “List available targets”
Terminal window
python build_all.py --list

Build a specific variant

Section titled “Build a specific variant”

For example, the PiBot V1 8MB WiFi FluidNC variant:

Terminal window
python build_all.py 8mb_wifi_fluidnc

Build all variants

Section titled “Build all variants”
Terminal window
python build_all.py

Clean build

Section titled “Clean build”
Terminal window
python build_all.py --clean 8mb_wifi_fluidnc

Flash

Section titled “Flash”

After building, flash the firmware to your board:

Terminal window
cd build_8mb_wifi_fluidnc
idf.py flash

Or use the pre-built installers in the installer/ directory if available for your board.

First boot

Section titled “First boot”

On first boot, the pendant will create a WiFi access point (if WiFi is enabled) or wait for a Bluetooth/Serial connection. Use the User Guide to learn how to navigate the interface and configure your machine connection.

Configuration

Section titled “Configuration”

The pendant can be configured via:

  • On-screen settings menus
  • esp3dcnf.ini file on the SD card
  • Embedded WebUI (when WiFi is enabled)