feat(st7789): Updated documentation. Added code example and step-by-step guide for STM32 #5511

zjanosy · 2024-01-27T13:32:31Z

Description of the feature or fix

A clear and concise description of what the bug or new feature is.

Notes

Update the Documentation if needed.
Add Examples if relevant.
Add Tests if applicable.
If you added new options to lv_conf_template.h run lv_conf_internal_gen.py and update Kconfig.
Run scripts/code-format.py (astyle needs to be installed) and follow the Code Conventions
Mark the Pull request as Draft while you are working on the first version, and mark is as Ready when it's ready for review.
When changes were requested, re-request review to notify the maintainers.
Help us to review this Pull Request! Anyone can approve or request changes.

…tep guide for STM32.

examples/porting/lv_port_lcd_stm32_template.c

…e parameter list of lv_lcd_st7789_create().

PGNetHun

Looks good, found only 1 copy-paste issue

examples/porting/lv_port_lcd_stm32_template.c

kisvegabor · 2024-01-29T07:44:06Z

examples/porting/lv_port_lcd_stm32_template.c

+/* Include STM32Cube files here, e.g.:
+#include "stm32f7xx_hal.h"
+*/


Suggested change

/* Include STM32Cube files here, e.g.:

#include "stm32f7xx_hal.h"

*/

#if defined STM32F3

#include "stm32f3xx_hal.h"

#elif defined STM32F4

#include "stm32f4xx_hal.h"

#elif defined STM32F7

#include "stm32f7xx_hal.h"

#elif defined STM32H7

#include "stm32xxx_hal.h" /*Include your hal header */

#endif

Please note that this code has not been tested on other platforms than the STM32F746. We can add these headers, but what if there are subtle differences between those? Since this is an example, I think it is reasonable to expect that the users will adapt it to their platform.

In this case can we add it as an example to one of our lv_port_stm32* repos and link it in the docs?

kisvegabor · 2024-01-29T07:45:38Z

examples/porting/lv_port_lcd_stm32_template.h

+ * GLOBAL PROTOTYPES
+ **********************/
+/* Initialize low level display driver */
+void lv_port_disp_init(void);


As we can have other STM port files too (e.g. LTDC) let name it

Suggested change

void lv_port_disp_init(void);

void lv_port_lcd_stm32_init(void);

This has been copied from lv_port_disp_template.c. Since 99% of the users will only use a single display, it does not really matter if the templates use the same function name (actually, it makes sense). But since this is just a template, the users can change it if there is any conflict.

kisvegabor · 2024-01-29T07:48:37Z

docs/integration/driver/display/lcd_stm32_guide.rst

+PB10 GPIO_Output   DC      LCD_DCX
+==== ============= ======= ==========
+
+Step-by-step instructions


Do we really need such a detailed guide here?

I think we should explain only the LVGL related things and not general topic (such as clock config). For such a detailed and specific configuration we should have a blog post or YouTube video instead that we can link from here.

I suggest updating this file instead where we explain:

How to integrate LVGL

clone LVGL

lv_tick

STM devices can be used with

LVGL's built in display controller drivers

1-2 paragraph of description about what to configure in Cube IDE (note that STm devices can be used with outher IDEs as well)

link to lv_port_stm32_lcd

X-CUBE-DISPLAY (just one paragraph)

LTDC: 1-2 paragraphs.

I hope we can have an official collaboration with ST in the future. However, until that I would like focus on our Official partners.

For example it would be nice to have the same description for ESP as well.

I think it is very useful to provide a step-by-step guide like this, because the difficult part is not how to integrate LVGL, but how to configure the hardware. While this could be a blog post or YouTube video, including it in the LVGL documentation will immediately help novice users with their LVGL project, saving the hassle of searching the Internet for solutions (which may be outdated and may not be correct). Having this guide would have saved me days of work... :-)

The reason for making the guide so detailed is that leaving out any of these steps (e.g., clock or DMA configuration) will make LVGL perform sub-optimally. And that would cause user complaints of LVGL in general or discarding LVGL alltogether.

Okay let's leave it as it is but please add link to it here

lvgl-bot · 2024-02-23T01:45:54Z

We need some feedback on this pull request.

Now we mark this as "stale" because there was no activity here for 14 days.

Remove the "stale" label or comment else this will be closed in 7 days.

kisvegabor · 2024-02-24T13:26:28Z

Not stale.

lvgl-bot · 2024-03-12T01:45:57Z

We need some feedback on this pull request.

Now we mark this as "stale" because there was no activity here for 14 days.

Remove the "stale" label or comment else this will be closed in 7 days.

kisvegabor

I'm not sure we take the best possible approach, but we can update the examples at any time later. It will be quite valuable for the users as it is so I suggest merging this PR.

…guide for STM32 (lvgl#5511) Co-authored-by: Zoltan Janosy <zjanosy@fishman.com>

feat(st7789): Updated documentation. Added code example and step-by-s…

5ce3634

…tep guide for STM32.

LeCyberDucky reviewed Jan 27, 2024

View reviewed changes

examples/porting/lv_port_lcd_stm32_template.c Outdated Show resolved Hide resolved

Zoltan Janosy and others added 2 commits January 28, 2024 15:30

feat(st7789): In the examples use LV_LCD_FLAG_NONE instead of 0 in th…

8034550

…e parameter list of lv_lcd_st7789_create().

Merge branch 'lvgl:master' into st7789

465c8d0

PGNetHun approved these changes Jan 28, 2024

View reviewed changes

examples/porting/lv_port_lcd_stm32_template.c Outdated Show resolved Hide resolved

feat(7789): Fix copy&paste error.

876919e

PGNetHun approved these changes Jan 29, 2024

View reviewed changes

kisvegabor reviewed Jan 29, 2024

View reviewed changes

PGNetHun changed the title ~~feat(st7789): Updated documentation. Added code example and step-by-s…~~ feat(st7789): Updated documentation. Added code example and step-by-step guide for STM32 Feb 7, 2024

lvgl-bot added the stale label Feb 23, 2024

lvgl-bot removed the stale label Feb 25, 2024

lvgl-bot added the stale label Mar 12, 2024

kisvegabor approved these changes Mar 12, 2024

View reviewed changes

kisvegabor merged commit 63842f8 into lvgl:master Mar 12, 2024

HongChao6 pushed a commit to HongChao6/lvgl that referenced this pull request Oct 18, 2024

docs(st7789): updated the docs + added code example and step-by-step …

61366c0

…guide for STM32 (lvgl#5511) Co-authored-by: Zoltan Janosy <zjanosy@fishman.com>

HongChao6 pushed a commit to HongChao6/lvgl that referenced this pull request Oct 18, 2024

docs(st7789): updated the docs + added code example and step-by-step …

a2dbb13

…guide for STM32 (lvgl#5511) Co-authored-by: Zoltan Janosy <zjanosy@fishman.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(st7789): Updated documentation. Added code example and step-by-step guide for STM32 #5511

feat(st7789): Updated documentation. Added code example and step-by-step guide for STM32 #5511

Uh oh!

zjanosy commented Jan 27, 2024 •

edited by PGNetHun

Loading

Uh oh!

Uh oh!

PGNetHun left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

kisvegabor Jan 29, 2024

Uh oh!

zjanosy Jan 29, 2024

Uh oh!

kisvegabor Jan 29, 2024

Uh oh!

kisvegabor Jan 29, 2024

Uh oh!

zjanosy Jan 29, 2024

Uh oh!

kisvegabor Jan 29, 2024

Uh oh!

zjanosy Jan 29, 2024

Uh oh!

kisvegabor Jan 29, 2024

Uh oh!

lvgl-bot commented Feb 23, 2024

Uh oh!

kisvegabor commented Feb 24, 2024

Uh oh!

lvgl-bot commented Mar 12, 2024

Uh oh!

kisvegabor left a comment

Uh oh!

Uh oh!

-/* Include STM32Cube files here, e.g.:
-#include "stm32f7xx_hal.h"
-*/
+#if defined STM32F3
+#include "stm32f3xx_hal.h"
+#elif defined STM32F4
+#include "stm32f4xx_hal.h"
+#elif defined STM32F7
+#include "stm32f7xx_hal.h"
+#elif defined STM32H7
+#include "stm32xxx_hal.h" /*Include your hal header */
+#endif

	void lv_port_disp_init(void);
	void lv_port_lcd_stm32_init(void);

Uh oh!

feat(st7789): Updated documentation. Added code example and step-by-step guide for STM32 #5511

feat(st7789): Updated documentation. Added code example and step-by-step guide for STM32 #5511

Uh oh!

Conversation

zjanosy commented Jan 27, 2024 • edited by PGNetHun Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the feature or fix

Notes

Uh oh!

Uh oh!

PGNetHun left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lvgl-bot commented Feb 23, 2024

Uh oh!

kisvegabor commented Feb 24, 2024

Uh oh!

lvgl-bot commented Mar 12, 2024

Uh oh!

kisvegabor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zjanosy commented Jan 27, 2024 •

edited by PGNetHun

Loading

PGNetHun left a comment •

edited

Loading