diff --git a/README.md b/README.md index 32a3ec7..0619db1 100644 --- a/README.md +++ b/README.md @@ -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. > :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. ### esp32/ 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 -- 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 -Compile and upload to the ESP32 using PlatformIO: - -```bash -export ESP32_WPA2_SSID=the-wifi-ssid -export ESP32_WPA2_PSK=the-wifi-psk -pio run -t upload -``` +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. ### led_plugging_tool/