Skip to content

Commit bb002c5

Browse files
committed
added missing documentation in the client directory
1 parent 1e7d936 commit bb002c5

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

software/source/clients/esp32/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,20 @@ To set up audio recording + playback on the ESP32 (M5 Atom), do the following:
1010
- ESPAsyncWebServer by lacamera
1111
4. The board needs to connect to WiFi. Once you flash, connect to ESP32 wifi "captive" which will get wifi details. Once it connects, it will ask you to enter 01OS server address in the format "domain.com:port" or "ip:port". Once its able to connect you can use the device.
1212
5. To flash the .ino to the board, connect the board to the USB port, select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that). Click on upload to flash the board.
13+
14+
### Alternative - PlatformIO
15+
16+
You don't need anything, PlatformIO will install everything for you, dependencies, tool chains, etc.
17+
18+
Please install first [PlatformIO](http://platformio.org/) open source ecosystem for IoT development compatible with **Arduino** IDE and its command line tools (Windows, MacOs and Linux), and then enter to the firmware directory:
19+
20+
```bash
21+
cd client/
22+
```
23+
24+
And build and upload the firmware with a simple command:
25+
26+
```bash
27+
pio run --target upload
28+
```
29+

0 commit comments

Comments
 (0)