Skip to content

Commit a51df25

Browse files
committed
docs: ✏️ update README.md to add support for Xiao ESP32S3
- Added spacing to fix some markdownlint warnings - Included `Xiao ESP32S3` in the supported boards section.
1 parent 2f38243 commit a51df25

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Turn your OBEGRÄNSAD LED Wall Lamp into a live drawing canvas
4242
<summary>Click to expand feature list</summary>
4343

4444
**General Features:**
45+
4546
- Persist your drawing
4647
- Rotate image
4748
- Live Drawing
@@ -53,6 +54,7 @@ Turn your OBEGRÄNSAD LED Wall Lamp into a live drawing canvas
5354
- Schedule Plugins to switch after "n" seconds
5455

5556
**Available Plugins:**
57+
5658
- Draw
5759
- Game of Life
5860
- Breakout
@@ -76,6 +78,7 @@ Turn your OBEGRÄNSAD LED Wall Lamp into a live drawing canvas
7678
https://github.com/user-attachments/assets/ddf91be1-2c95-4adc-b178-05b0781683cc
7779

7880
Control the lamp using the built-in web GUI. Find the device IP address via:
81+
7982
- Serial monitor output
8083
- Router admin panel
8184

@@ -86,6 +89,7 @@ Control the lamp using the built-in web GUI. Find the device IP address via:
8689
This software is designed for ESP32 Dev Boards but can work with other Arduino boards (WiFi, OTA, and web server features will need to be removed for non-ESP boards).
8790

8891
**Supported Boards:**
92+
8993
- ESP32 Dev Board (recommended)
9094
- TTGO LoRa32 V2.1 (T3_V1.6.1)
9195
- ESP8266 (with limitations: per-pixel brightness only works when storage and global brightness are disabled)
@@ -95,6 +99,7 @@ This software is designed for ESP32 Dev Boards but can work with other Arduino b
9599
### Opening the Lamp
96100

97101
IKEA uses rivets instead of regular screws. To open:
102+
98103
1. Insert a screwdriver between the rivets and back panel
99104
2. Carefully pry open with a second object
100105
3. Alternative: Drill out the rivets (cleaner but permanent)
@@ -104,6 +109,7 @@ IKEA uses rivets instead of regular screws. To open:
104109
<img src="https://user-images.githubusercontent.com/15351728/200183585-39c1668d-665b-4c12-bcbb-387aec1d3874.JPG" width="60%" />
105110

106111
Inside you'll find 4 identical plates with 64 LEDs each (in 4 fields). Focus on the lowest plate:
112+
107113
- 6 connectors at the bottom edge (connection points for your board)
108114
- Original microcontroller at the top (must be removed)
109115

@@ -113,16 +119,16 @@ Inside you'll find 4 identical plates with 64 LEDs each (in 4 fields). Focus on
113119

114120
Connect the pins as shown below. Remember to configure them in `include/constants.h` according to your board.
115121

116-
| LCD | ESP32 | TTGO LoRa32 | NodeMCUv2 | Lolin D32 (Pro) |
117-
| :--------------: | :----: | :---------: | :-------: | :-------------: |
118-
| GND | GND | GND | GND | GND |
119-
| VCC | 5V | 5V | VIN | USB |
120-
| EN (PIN_ENABLE) | GPIO26 | IO22 | GPIO16 D0 | GPIO26 |
121-
| IN (PIN_DATA) | GPIO27 | IO23 | GPIO13 D7 | GPIO27 |
122-
| CLK (PIN_CLOCK) | GPIO14 | IO02 | GPIO14 D5 | GPIO14 |
123-
| CLA (PIN_LATCH) | GPIO12 | IO15 | GPIO0 D3 | GPIO12 |
124-
| BUTTON one end | GPIO16 | IO21 | GPIO2 D4 | GPIO25 |
125-
| BUTTON other end | GND | GND | GND | GND |
122+
| LCD | ESP32 | TTGO LoRa32 | NodeMCUv2 | Lolin D32 (Pro) | Xiao ESP32S3 |
123+
| :--------------: | :----: | :---------: | :-------: | :-------------: | :----------: |
124+
| GND | GND | GND | GND | GND | GND |
125+
| VCC | 5V | 5V | VIN | USB | VUSB |
126+
| EN (PIN_ENABLE) | GPIO26 | IO22 | GPIO16 D0 | GPIO26 | D4 (GPIO5) |
127+
| IN (PIN_DATA) | GPIO27 | IO23 | GPIO13 D7 | GPIO27 | D10 (MOSI) |
128+
| CLK (PIN_CLOCK) | GPIO14 | IO02 | GPIO14 D5 | GPIO14 | D8 (SCK) |
129+
| CLA (PIN_LATCH) | GPIO12 | IO15 | GPIO0 D3 | GPIO12 | D5 (GPIO6) |
130+
| BUTTON one end | GPIO16 | IO21 | GPIO2 D4 | GPIO25 | D3 (GPIO4) |
131+
| BUTTON other end | GND | GND | GND | GND | GND |
126132

127133
<img src="https://user-images.githubusercontent.com/86414213/205999001-6213fc4f-be2f-4305-a17a-44fdc9349069.jpg" width="60%" />
128134

@@ -141,11 +147,13 @@ You can use the original button wiring without adding external connections. See
141147
- Install the PlatformIO IDE extension from VS Code Extensions Marketplace
142148

143149
2. **Clone the Project**
150+
144151
```bash
145152
git clone git@github.com:ph1p/ikea-led-obegraensad.git
146153
cd ikea-led-obegraensad
147154
code .
148155
```
156+
149157
PlatformIO will automatically load dependencies.
150158

151159
3. **Connect ESP32**

0 commit comments

Comments
 (0)