Skip to content

Commit 251f1f0

Browse files
committed
update readme
1 parent 3dc4031 commit 251f1f0

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,26 @@
44

55
An ESP32 based LED cube, inspired by [this project](https://github.com/Staacks/there.oughta.be/tree/master/led-cube).
66

7-
# Development
7+
## Table of Contents
8+
- [LED Cube](#led-cube)
9+
- [Table of Contents](#table-of-contents)
10+
- [Development](#development)
11+
- [Setting up Dev Environment](#setting-up-dev-environment)
12+
- [Building](#building)
13+
- [Uploading](#uploading)
814

9-
## Setting up Dev Environment
15+
## Development
16+
17+
### Setting up Dev Environment
1018
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](https://docs.platformio.org/en/latest/integration/ide/vscode.html#quick-start) for more details on setting up PlatformIO in VSCode.
1119

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

14-
## Building
22+
### Building
1523
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](https://docs.platformio.org/en/latest/core/userguide/cmd_build.html) for more details.
1624

17-
## Uploading
18-
Currently, the cubes support 3 different methods of getting new firmware.
19-
20-
### Github
21-
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.
22-
23-
### OTA
24-
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:
25+
### Uploading
26+
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:
2527

2628
```ini
2729
upload_protocol = espota
@@ -30,7 +32,6 @@ upload_port = cube.local
3032

3133
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.
3234

33-
### Serial
3435
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. Like a fool, I didn't add silkscreen labels for RX and TX, so here is a labeled image:
3536

3637
![Screenshot 2022-12-29 at 4 50 48 PM](https://user-images.githubusercontent.com/1711604/210018862-ec6aab7d-4b61-4290-a931-6ad4d5c13356.png)

0 commit comments

Comments
 (0)