s3lph/spaceapi-led-map
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update esp32 wifi settings docs

Browse source
This commit is contained in:
s3lph 2024-09-20 01:59:04 +02:00
parent 08e5d20ef2
commit 9636b6e53c
Signed by: s3lph
GPG key ID: 0AA29A52FB33CFB5
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -36,23 +36,23 @@ form a single WS2812 chain. There are 83 LEDs in the current version, so a tota
The ESP32-C3 needs to be soldered to the first PCB. The ESP32-C3 needs to be soldered to the first PCB.
> :warning: **There is a small issue with V1.0 of the PCB!** (Please check the version number on the silk screen!): > :warning: **There is a small issue with V1.0 of the PCB!** (Please check the version number on the silk screen!):
>
> Pins 1 and 4 of the OUT pin header are swapped - this can be easily worked around by swapping wires number 1 and 4 in the JST connector plugged into this header. > Pins 1 and 4 of the OUT pin header are swapped - this can be easily worked around by swapping wires number 1 and 4 in the JST connector plugged into this header.
### esp32/ ### esp32/
The PlatformIO Arduino project for the ESP32. It perfoms the following tasks: The PlatformIO Arduino project for the ESP32. It perfoms the following tasks:
- Connect to the WiFi network defined at compile time
- If no WiFi AP has been configured yet, it starts an AP on its own
- Connect to the AP (SSID: `spaceapimap`, PSK: `12345678`)
- Configure the WiFi network the ESP32 should connect to
- Connect to the WiFi network defined previously
- Obtain the current time through NTP - Obtain the current time through NTP
- Fetch the aggregated SpaceAPI responses from api.spaceapi.io and parse the JSON response - Fetch the aggregated SpaceAPI responses from `api.spaceapi.io` and parse the JSON response
- Update the WS2812 LEDs - Update the WS2812 LEDs
Compile and upload to the ESP32 using PlatformIO: The list of SpaceAPI endpoints to display is defined in `esp32/src/spacemap.h`.
The position of an endpoint in the `spaces` array corresponds to the index of the WS2812 LED it controls.
```bash
export ESP32_WPA2_SSID=the-wifi-ssid
export ESP32_WPA2_PSK=the-wifi-psk
pio run -t upload
```
### led_plugging_tool/ ### led_plugging_tool/