Skip to content

Commit 53af1ba

Browse files
michaellassfabiobaltieri
authored andcommitted
boards: heltec_wifi_lora32_v2: improve documentation
* Document use of OLED display. * Fix indentation in list of features. * References are only rendered if they are used and currently most of them are not. Introduce a list of links in addition to the actual references to make them show up. Signed-off-by: Michael Laß <[email protected]>
1 parent fec126f commit 53af1ba

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

boards/xtensa/heltec_wifi_lora32_v2/doc/index.rst

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The features include the following:
1818
RF shielding, and other protection measures
1919
- Onboard SH1.25-2 battery interface, integrated lithium battery management system
2020
- Integrated WiFi, LoRa, Bluetooth three network connections, onboard Wi-Fi, Bluetooth dedicated 2.4GHz
21-
metal 3D antenna, reserved IPEX (U.FL) interface for LoRa use
21+
metal 3D antenna, reserved IPEX (U.FL) interface for LoRa use
2222
- Onboard 0.96-inch 128*64 dot matrix OLED display
2323
- Integrated CP2102 USB to serial port chip
2424

@@ -108,11 +108,28 @@ You can debug an application in the usual way. Here is an example for the :ref:`
108108
:board: heltec_wifi_lora32_v2
109109
:goals: debug
110110

111+
Utilizing Hardware Features
112+
***************************
113+
114+
Onboard OLED display
115+
--------------------
116+
117+
The onboard OLED display is of type ``ssd1306``, has 128*64 pixels and is
118+
connected via I2C. It can therefore be used by enabling the
119+
:ref:`ssd1306_128_shield` as shown in the following for the :ref:`lvgl-sample`:
120+
121+
.. zephyr-app-commands::
122+
:zephyr-app: samples/subsys/display/lvgl
123+
:board: heltec_wifi_lora32_v2
124+
:shield: ssd1306_128x64
125+
:goals: flash
126+
111127
References
112128
**********
113129

130+
- `Heltec WiFi LoRa (v2) Pinout Diagram <https://resource.heltec.cn/download/WiFi_LoRa_32/WIFI_LoRa_32_V2.pdf>`_
131+
- `Heltec WiFi LoRa (v2) Schematic Diagrams <https://resource.heltec.cn/download/WiFi_LoRa_32/V2>`_
132+
- `ESP32 Toolchain <https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf>`_
133+
- `esptool documentation <https://github.com/espressif/esptool/blob/master/README.md>`_
134+
114135
.. [1] https://heltec.org/project/wifi-lora-32/
115-
.. _`Heltec WiFi LoRa (v2) Pinout Diagram`: https://resource.heltec.cn/download/WiFi_LoRa_32/WIFI_LoRa_32_V2.pdf
116-
.. _`Heltec WiFi LoRa (v2) Schematic Diagrams`: https://resource.heltec.cn/download/WiFi_LoRa_32/V2
117-
.. _`ESP32 Toolchain`: https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf
118-
.. _`esptool documentation`: https://github.com/espressif/esptool/blob/master/README.md

boards/xtensa/heltec_wifi_lora32_v2/heltec_wifi_lora32_v2.dts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,5 +128,5 @@
128128
};
129129
};
130130

131-
/* Required by OLED samples */
131+
/* Required by the ssd1306_128x64 shield which enables the OLED display */
132132
arduino_i2c: &i2c0 {};

0 commit comments

Comments
 (0)