Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.71 KB

README.md

File metadata and controls

47 lines (31 loc) · 2.71 KB
Raw

LED Cube

build-release

cube

An ESP32 based LED cube, inspired by this project.

Table of Contents

Development

Setting up Dev Environment

To build firmware for this cube, all you need is an IDE and PlatformIO. I use VSCode, but you can use whatever you want. See here for more details on setting up PlatformIO in VSCode.

Clone this repo, and open it in your IDE. You should be able to move on to building.

Building

This project uses ESPIDF with Arduino as a component, and PlatformIO to build and upload firmware. To build, just click the build button in your IDE. To upload, click the upload button. You can also use the PlatformIO CLI to build and upload. See here for more details.

Uploading

Currently, the cubes support 3 different methods of getting new firmware. The first one, used exclusively in production, is downloading straight from Github releases. These builds are created with Github Actions and are not used for development. The second method is using OTA updates. This is the easiest method of uploading new firmware during development. To upload using OTA, you need to have the cube connected to your network. Ensure that these two lines are uncommented in platformio.ini, and that the cube is on the same network as your computer:

upload_protocol = espota
upload_port = cube.local

Then, click the upload button in your IDE. This will upload the firmware to the cube over the network. The cube will then reboot and start running the new firmware.

The third method is using a USB to serial adapter. This is mostly only useful if you have uploaded firmware that breaks OTA, bur can also be used for debugging. To upload using serial, you need to have the cube connected to your computer via USB.

Connect the Cube GND to the adaptor GND, the Cube TX to the adaptor RX, and the Cube RX to the adaptor TX, then comment out these two lines in platformio.ini:

;upload_protocol = espota
;upload_port = cube.local

Then, click the upload button in your IDE. This will upload the firmware to the cube over serial. The cube will then reboot and start running the new firmware.