shaunrd0/klips
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Clean up comments.

Browse Source
This commit is contained in:
Shaun Reed 2025-03-01 15:54:04 -05:00
parent 1a7da67bdb
commit fc0fd98426
11 changed files with 92 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
esp/cpp/07_lcd-panel-i2c/main/display.cpp
View File

@ -1,4 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#include <esp_timer.h> #include <esp_timer.h>
#include <lv_init.h> #include <lv_init.h>
@ -7,9 +13,6 @@
#include "display.h" #include "display.h"
// TODO: Remove this dependency by relocating SSD1306::oledb_buffer_
#include "ssd1306.h"
// Static TimeKeeper for managing ESP timers across all displays. // Static TimeKeeper for managing ESP timers across all displays.
TimeKeeper Display::timers_; TimeKeeper Display::timers_;

7
esp/cpp/07_lcd-panel-i2c/main/display.h
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#ifndef DISPLAY_H #ifndef DISPLAY_H
#define DISPLAY_H #define DISPLAY_H

7
esp/cpp/07_lcd-panel-i2c/main/i2c.h
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#ifndef I2C_H #ifndef I2C_H
#define I2C_H #define I2C_H

7
esp/cpp/07_lcd-panel-i2c/main/main.cpp
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#include "display.h" #include "display.h"
#include "ssd1306.h" #include "ssd1306.h"

7
esp/cpp/07_lcd-panel-i2c/main/panel.h
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#ifndef PANEL_H #ifndef PANEL_H
#define PANEL_H #define PANEL_H

8
esp/cpp/07_lcd-panel-i2c/main/panel_device.cpp
View File

@ -1,4 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#include "panel_device.h" #include "panel_device.h"
#include "display.h" #include "display.h"
#include "scoped_lock.h" #include "scoped_lock.h"

25
esp/cpp/07_lcd-panel-i2c/main/panel_device.h
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#ifndef PANEL_DEVICE_H #ifndef PANEL_DEVICE_H
#define PANEL_DEVICE_H #define PANEL_DEVICE_H
@ -336,9 +343,10 @@ private:
* Left Right * Left Right
* *
* The bytes from _LVGL_ are mapped to pixel rows of the display * The bytes from _LVGL_ are mapped to pixel rows of the display
* [0, 0, 0, 0] * 8 bits (pixels) per byte -
* [0, 0, 0, 0] * [0, 0, 0, 0, 0, 0, 0, 0]
* [0, 0, 0, 0] * [0, 0, 0, 0, 0, 0, 0, 0]
* [0, 0, 0, 0, 0, 0, 0, 0]
* *
* The order of bits expected by the _display driver_ is LSB first. * The order of bits expected by the _display driver_ is LSB first.
* We must preserve pairing of each bit and pixel when writing to the display. * We must preserve pairing of each bit and pixel when writing to the display.
@ -348,10 +356,21 @@ private:
* Left Right * Left Right
* *
* Bytes expected by the _display driver_ map to pixel columns of the display. * Bytes expected by the _display driver_ map to pixel columns of the display.
* 8 bits (pixels) per byte -
* [0, [0, [0, [0, * [0, [0, [0, [0,
* 0, 0, 0, 0, * 0, 0, 0, 0,
* 0, 0, 0, 0,
* 0, 0, 0, 0,
* 0, 0, 0, 0,
* 0, 0, 0, 0,
* 0, 0, 0, 0,
* 0] 0] 0] 0] * 0] 0] 0] 0]
* *
* These layouts in memory have no opinion on the shape of the image. The
* beginning and end of a row or a column for example is entirely dependent
* on how the data is accessed. The vertical and horitzontal resolution may
* vary between displays.
*
* For the LV_COLOR_FORMAT_I1 color format we are using, an additional buffer * For the LV_COLOR_FORMAT_I1 color format we are using, an additional buffer
* is needed for transposing the bits to the vertical arrangement required by * is needed for transposing the bits to the vertical arrangement required by
* the display driver that is outlined above. * the display driver that is outlined above.

7
esp/cpp/07_lcd-panel-i2c/main/scoped_lock.cpp
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#include "scoped_lock.h" #include "scoped_lock.h"
// LVGL library is not thread-safe, this example calls LVGL APIs from tasks. // LVGL library is not thread-safe, this example calls LVGL APIs from tasks.

7
esp/cpp/07_lcd-panel-i2c/main/scoped_lock.h
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#ifndef SCOPED_LOCK_H #ifndef SCOPED_LOCK_H
#define SCOPED_LOCK_H #define SCOPED_LOCK_H

19
esp/cpp/07_lcd-panel-i2c/main/ssd1306.h
View File

@ -1,16 +1,10 @@
/* /*#############################################################################
* https://docs.espressif.com/projects/esp-idf/en/v5.3.2/esp32/api-reference/peripherals/lcd/index.html#functional-overview ## Author: Shaun Reed ##
* ## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
* Implementing the interface draw to an LCD using various interface modes. ## ##
* I2C interface mode is SSD1306 ## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
* SPI interface mode is ST7789 ##############################################################################
* I80 interface mode is NT35510 or ST7789
*
* Actually, I think any driver can be used with any interface mode
* Along with additional third party drivers via the component manager
* https://github.com/espressif/esp-idf/tree/0d6099ec533c4b647fb7a7b0b8942bc7aeb82f90/examples/peripherals/lcd/spi_lcd_touch#spi-lcd-and-touch-panel-example
*/ */
#ifndef SSD1306_H #ifndef SSD1306_H
#define SSD1306_H #define SSD1306_H
@ -79,7 +73,6 @@ public:
// //
// PUBLIC METHODS // PUBLIC METHODS
/// SSD1306 configuration structure.
/** /**
* Provides the SSD1306 vendor configuration to IPanelDevice consumers. * Provides the SSD1306 vendor configuration to IPanelDevice consumers.
* *

7
esp/cpp/07_lcd-panel-i2c/main/time_keeper.h
View File

@ -1,3 +1,10 @@
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#ifndef TIME_KEEPER_H #ifndef TIME_KEEPER_H
#define TIME_KEEPER_H #define TIME_KEEPER_H