espressif / esp-iot-solution

Espressif IoT Library. IoT Device Drivers, Documentations And Solutions.
Apache License 2.0
1.84k stars 749 forks source link

Missing documentation (IDFGH-13201) (AEGHB-724) #381

Closed dannybackx closed 1 month ago

dannybackx commented 1 month ago

Answers checklist.

IDF version.

latest

Operating System used.

Linux

How did you build your project?

Command line with idf.py

If you are using Windows, please specify command line type.

None

What is the expected behavior?

https://docs.espressif.com/projects/esp-iot-solution/en/latest/display/lcd/rgb_lcd.html contains a paragraph that indicates an example will follow, but then there's just the next paragraph. The piece below is just before the "Porting Driver Components" header :

The following is an example code using the [esp_lcd_panel_io_additions](https://components.espressif.com/components/espressif/esp_lcd_panel_io_additions) component to create a 3-wire SPI interface device:

Creating the interface device provides a handle of data type esp_lcd_panel_io_handle_t. Subsequently, you can use esp_lcd_panel_io_tx_param() to send commands to the LCD driver IC.
[Porting Driver Components](https://docs.espressif.com/projects/esp-iot-solution/en/latest/display/lcd/rgb_lcd.html#id27)

The example I need is missing :-(

What is the actual behavior?

just another piece of text

Steps to reproduce.

read

Build or installation Logs.

N/A

More Information.

No response

Horion0415 commented 1 month ago

Thank you for your feedback. We will correct this error in the future. In fact, the example refers to the code mentioned above (https://docs.espressif.com/projects/esp-iot-solution/en/latest/display/lcd/rgb_lcd.html#initialization-of-interface-devices). You can refer to that section to fulfill your needs.