Skip to content

RealTimeLogic/Xedge32

Repository files navigation

Xedge32

(Xedge Lua IDE and REPL for ESP32)

Looking to turn your ESP32 into a powerful Edge Controller or IoT Gateway? Look no further than Xedge32! This incredible development tool empowers users of all levels to program their ESP32 using the simple and intuitive Lua Scripting language. With Xedge32, you can easily unlock the full potential of your ESP32 and create advanced IoT solutions that will impress even the most tech-savvy enthusiasts.

ESP32 Edge Controller

Getting Started

You do not need to compile Xedge32. Compiling Xedge32 is for C code experts.

Compiling The C Code (for experts)

To compile the source code, you must use the latest ESP-IDF, which can be found on GitHub.

The following Linux commands show all steps required for installing the development tools, downloading the required source code, and compiling the code:

   sudo apt -y update
   sudo apt -y install git wget zip flex bison gperf python3 python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0

   cd
   # remove old installation, if any
   rm -rf .espressif esp/esp-idf

   # Install the latest esp-idf
   mkdir esp
   cd esp
   git clone --recursive https://github.com/espressif/esp-idf.git
   # Execute the 3 following lines if you plan on using the CAM plugin.
   cd esp-idf/components
   git clone https://github.com/espressif/esp32-camera.git
   cd ..
   ./install.sh
   cd ..
   source esp-idf/export.sh

   # Download and update Xedge32
   git clone --recursive --recurse-submodules https://github.com/RealTimeLogic/xedge32.git xedge
   cd xedge
   git submodule update --init --remote

   # Build the Xedge resource file Xedge.zip, convert to C, and copy C file to Xedge directory
   chmod +x BuildESP32ResourceFile.sh
   ./BuildESP32ResourceFile.sh

   #set target to one of:
   #idf.py set-target esp32
   #idf.py set-target esp32s3

   # Configure Xedge32 options such as enabling CAM and mDNS. Note, You must
   # enable OPC UA using menuconfig if you included OPC-UA when running
   # BuildESP32ResourceFile.sh.
   #idf.py menuconfig

   # Build the code
   idf.py build

Windows: The code can be compiled in a Linux console, including the Windows Subsystem for Linux (WSL). If you use WSL, it's recommended to use generation one (WSL1), as it can be difficult to get the USB serial working in WSL2. For more information, see the WSL documentation.

To upload the firmware to your ESP32, follow these steps:

  1. Wait for the build process to complete.
  2. Upload the code using:
    • Linux: idf.py flash monitor
    • WSL: idf.py -p /dev/ttyS4 -b 115200 flash monitor

Embedding Lua Apps and configuring NVS

Lua apps and the Xedge configuration file can be embedded in the firmware binary using fatfsgen.py and nvs_partition_gen.py. See the Partitions Generator Utility readme file for details.