Add Heltec WiFi LoRa 32 V3 board documentation#326
Conversation
- Add Heltec WiFi LoRa 32 V3 to compatible controllers list with specs and key features - Document FLD_PIN_RST and HELTEC_VEXT_PIN usage for display reset and power control - Add example build flags for platformio_override.ini configuration - Include troubleshooting guide for OLED display issues Addresses: wled/WLED#5633
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughA new entry for the Heltec WiFi LoRa 32 V3 board is added to the compatible controllers reference table, documenting its ESP32-S3 chip, memory specifications, display features, build environment identifier, and I2C display pin configuration. ChangesHeltec WiFi LoRa 32 V3 Board Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/basics/compatible-controllers.md`:
- Line 131: Replace the plain-text phrase "See compatible hardware section" with
a root-relative Markdown link to the compatible hardware doc (e.g. [compatible
hardware section](/docs/basics/compatible-hardware)) so it becomes clickable;
update the sentence in the Heltec WiFi LoRa 32 V3 description to use the link
(look for the exact text "See compatible hardware section" in
docs/basics/compatible-controllers.md) and ensure the link has no .md extension.
In `@docs/basics/compatible-hardware.md`:
- Line 93: Replace the plain-text phrase "the compatible controllers section" in
docs/basics/compatible-hardware.md with a root-relative internal markdown link
(no .md extension) pointing to the compatible controllers doc (e.g. use a link
target like /basics/compatible-controllers) so the reference is clickable and
follows the documentation guideline; ensure the link text remains descriptive
(e.g., "compatible controllers") and preserves surrounding sentence punctuation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ed6f42e3-849b-40a1-be8c-64be31cabd8f
📒 Files selected for processing (2)
docs/basics/compatible-controllers.mddocs/basics/compatible-hardware.md
- Convert 'See compatible hardware section' to link in compatible-controllers.md - Convert 'compatible controllers section' to link in compatible-hardware.md - Use root-relative links without .md extension per documentation guidelines
|
Fixed CodeRabbit feedback - added clickable cross-reference links in both files. Ready for review! |
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/basics/compatible-controllers.md (1)
131-131:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix the internal link path format in the Heltec row.
Line 131 uses
/docs/basics/compatible-hardware; in this docs repo, internal links should be root-relative to the docs site path, so use/basics/compatible-hardwareinstead.🔗 Proposed fix
-[Heltec WiFi LoRa 32 V3](https://heltec.org/project/wifi-lora-32-v3/) | ESP32-S3 | Compact board with ESP32-S3FN8, 8MB Flash, 320KB RAM (**NO PSRAM**), 0.96" SSD1306 OLED display, and LoRa 915MHz. **Must use `heltec_wifi_lora_32_v3` build environment.** Onboard I2C display (GPIO17 SDA, GPIO18 SCL, GPIO21 RST, GPIO36 Vext). Supports WiFi, Bluetooth, and display usermod. See [compatible hardware section](/docs/basics/compatible-hardware) for OLED setup with FLD_PIN_RST and HELTEC_VEXT_PIN. +[Heltec WiFi LoRa 32 V3](https://heltec.org/project/wifi-lora-32-v3/) | ESP32-S3 | Compact board with ESP32-S3FN8, 8MB Flash, 320KB RAM (**NO PSRAM**), 0.96" SSD1306 OLED display, and LoRa 915MHz. **Must use `heltec_wifi_lora_32_v3` build environment.** Onboard I2C display (GPIO17 SDA, GPIO18 SCL, GPIO21 RST, GPIO36 Vext). Supports WiFi, Bluetooth, and display usermod. See [compatible hardware section](/basics/compatible-hardware) for OLED setup with FLD_PIN_RST and HELTEC_VEXT_PIN.As per coding guidelines: Use root-relative paths without the
.mdextension for internal links (e.g.,[Segments](/features/segments)).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/basics/compatible-controllers.md` at line 131, The internal link in the "Heltec WiFi LoRa 32 V3" row uses /docs/basics/compatible-hardware which violates the repo's root-relative internal link convention; update that link to use the root-relative path /basics/compatible-hardware (no .md) so the line with "Heltec WiFi LoRa 32 V3" points to [compatible-hardware] using /basics/compatible-hardware.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@docs/basics/compatible-controllers.md`:
- Line 131: The internal link in the "Heltec WiFi LoRa 32 V3" row uses
/docs/basics/compatible-hardware which violates the repo's root-relative
internal link convention; update that link to use the root-relative path
/basics/compatible-hardware (no .md) so the line with "Heltec WiFi LoRa 32 V3"
points to [compatible-hardware] using /basics/compatible-hardware.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 616ef042-35b4-4a1a-9fd0-20d26e18cd30
📒 Files selected for processing (2)
docs/basics/compatible-controllers.mddocs/basics/compatible-hardware.md
✅ Files skipped from review due to trivial changes (1)
- docs/basics/compatible-hardware.md
| <br/> [ESP32 Mini Dev Board 16mb by SerKo (aka Serg)](https://www.tindie.com/products/28858/)| ESP32 | ESP32 Dev Board with latest WROOM-32E module, USB Type-C, PTC fused, over-voltage protection. D1 Mini32 form factor and compatible [pin out](https://github.com/srg74/WLED-wemos-shield/blob/master/resources/ESP32_mini/Resources/ESP32_mini_board_pinout.pdf) | ||
| [H803 WiFi](https://github.com/srg74/WLED/wiki/H803WiFi) | ESP8266 | ESP8266EX based controller with level shifter inside. Data pin GPIO1 Clock pin GPIO14. Tested with WS2813 strip and [Firmware fork is here](https://github.com/srg74/WLED/tree/H803WF). | ||
| [Heltec WiFi Kit 8](https://heltec.org/project/wifi-kit-8/) | ESP8266 | Another alternative of ESP8266 board. OLED display 128X32 pixel, battery charger on board. Almost the same functionality and price as the Wemos board. Plus it can be used in projects with external batteries. | ||
| [Heltec WiFi LoRa 32 V3](https://heltec.org/project/wifi-lora-32-v3/) | ESP32-S3 | Compact board with ESP32-S3FN8, 8MB Flash, 320KB RAM (**NO PSRAM**), 0.96" SSD1306 OLED display, and LoRa 915MHz. **Must use `heltec_wifi_lora_32_v3` build environment.** Onboard I2C display (GPIO17 SDA, GPIO18 SCL, GPIO21 RST, GPIO36 Vext). Supports WiFi, Bluetooth, and display usermod. See [compatible hardware section](/docs/basics/compatible-hardware) for OLED setup with FLD_PIN_RST and HELTEC_VEXT_PIN. |
There was a problem hiding this comment.
This buildenv is not in our platformio.ini.
There was a problem hiding this comment.
This documentation is for when WLED PR #5633 is merged - the heltec_wifi_lora_32_v3 build environment will be added to platformio.ini as part of that PR.
There was a problem hiding this comment.
sorry, but I can already say it won't be in platformio.ini. Special board examples should be added into platformio_override.sample.ini if you want to contribute to the WLED repo.
There was a problem hiding this comment.
Ah, I see. Should I move the build config to the platformio_override.sample.ini?
| [CH340](https://www.aliexpress.com/item/32761423124.html) | CH340 module instead of CP2102, PL2303 or FTDI/FTDT. The CH340 can deliver more current which is needed while the flash process depending on the board type. The timing is also much more stable. **For boards with an USB/TTL adapter onboard this is NOT needed** | ||
| [ESP uploader](https://github.com/srg74/ESP-uploader) | CP2102N module. Same USB to UART converter as many recent Dev boards using. Featuring latest USB-C connector. For use with many ESP32, ESP8266, ESP8255 and Tuya based modules. 3.3V logic and 5V power pass through for custom boards. | ||
|
|
||
| ## OLED Display Setup with FLD_PIN_RST and HELTEC_VEXT_PIN |
There was a problem hiding this comment.
instead of starting to "overflow" the hardware list with board specific build instructions, it might be better to move this section into another document (maybe inside "advanced/"). The Four-line-display usermod specific parts would be better suited for the usermod README.
- Moved OLED display configuration details to usermod README - Kept board specs in compatible-controllers.md - Removed duplicate reference links
|
@softhack007 Agreed! Removed the display setup section from compatible-hardware.md. The core implementation details (FLD_PIN_RST, HELTEC_VEXT_PIN) are already documented in WLED PR #5633. This PR now focuses on board specs in compatible-controllers.md, keeping the hardware docs clean. |
2 participants
Summary
Added documentation for the Heltec WiFi LoRa 32 V3 ESP32-S3 board, which was recently added to the main WLED repository (WLED PR #5633).
Changes
Board Listing - Added Heltec WiFi LoRa 32 V3 to compatible controllers list with key specs:
Note: Usermod-specific display configuration details (FLD_PIN_RST, HELTEC_VEXT_PIN) are documented in the Four Line Display usermod README rather than duplicated in hardware compatibility docs.
Related
wled/WLED#5633
Summary by CodeRabbit