example: add ssd1681 e-paper examples

Co-Authored-By: Tomas Rezucha <[email protected]>

.github/workflows/upload_component.yml

@@ -18,7 +18,7 @@ jobs:
  esp32_azure_iot_kit;esp32_s2_kaluga_kit;esp_wrover_kit;esp-box;esp32_s3_usb_otg;esp32_s3_eye;esp32_s3_lcd_ev_board;esp32_s3_korvo_2;esp-box-lite;esp32_lyrat;esp32_c3_lcdkit;esp-box-3;
  components/bh1750;components/ds18b20;components/es8311;components/es7210;components/fbm320;components/hts221;components/mag3110;components/mpu6050;components/ssd1306;components/esp_lvgl_port;
  components/lcd_touch/esp_lcd_touch;components/lcd_touch/esp_lcd_touch_ft5x06;components/lcd_touch/esp_lcd_touch_gt911;components/lcd_touch/esp_lcd_touch_tt21100;components/lcd_touch/esp_lcd_touch_gt1151;components/lcd_touch/esp_lcd_touch_cst816s;
- components/lcd/esp_lcd_gc9a01;components/lcd/esp_lcd_ili9341;components/lcd/esp_lcd_ra8875;components/lcd_touch/esp_lcd_touch_stmpe610;components/lcd/esp_lcd_sh1107;components/lcd/esp_lcd_st7796;components/lcd/esp_lcd_gc9503;
+ components/lcd/esp_lcd_gc9a01;components/lcd/esp_lcd_ili9341;components/lcd/esp_lcd_ra8875;components/lcd_touch/esp_lcd_touch_stmpe610;components/lcd/esp_lcd_sh1107;components/lcd/esp_lcd_st7796;components/lcd/esp_lcd_gc9503;components/lcd/esp_lcd_ssd1681;
  components/io_expander/esp_io_expander;components/io_expander/esp_io_expander_tca9554;components/io_expander/esp_io_expander_tca95xx_16bit;components/io_expander/esp_io_expander_ht8574;
  namespace: "espressif"
  api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

components/lcd/esp_lcd_ssd1681/README.md

@@ -2,6 +2,12 @@
 
 [![Component Registry](https://components.espressif.com/components/espressif/esp_lcd_ssd1681/badge.svg)](https://components.espressif.com/components/espressif/esp_lcd_ssd1681)
 
+Implementation of the SSD1681 e-Paper controller with esp_lcd component.
+
+| LCD controller | Communication interface | Component name | Link to datasheet |
+| :------------: | :---------------------: | :------------: | :---------------: |
+| SSD1681 | SPI | esp_lcd_ssd1681| [Specification](https://cdn-learn.adafruit.com/assets/assets/000/099/573/original/SSD1681.pdf) |
+
 ## Add to project
 
 Packages from this repository are uploaded to [Espressif's component service](https://components.espressif.com/).
@@ -35,7 +41,7 @@ Original function prototype:
  */
 esp_err_t esp_lcd_panel_mirror(esp_lcd_panel_handle_t panel, bool mirror_x, bool mirror_y);
 ```
-Please note that `y_axis` has to be false if you enabled the `non_copy_mode` when constructing the panel, otherwise the function will return `ESP_ERR_INVALID_ARG`.
+Please note that `mirror_y` has to be false if you enabled the `non_copy_mode` when constructing the panel, otherwise the function will return `ESP_ERR_INVALID_ARG`.
 
 ### `esp_lcd_panel_swap_xy`
 
@@ -82,19 +88,19 @@ Please note that this function will draw the bitmap but do not refresh the panel
 Original function prototype:
 ```c
 /**
- * @brief Turn off the display
+ * @brief Turn on or off the display
  *
  * @param[in] panel LCD panel handle, which is created by other factory API like `esp_lcd_new_panel_st7789()`
- * @param[in] off Whether to turn off the screen
+ * @param[in] on_off True to turns on display, False to turns off display
  * @return
  * - ESP_OK on success
  * - ESP_ERR_NOT_SUPPORTED if this function is not supported by the panel
  */
-esp_err_t esp_lcd_panel_disp_off(esp_lcd_panel_handle_t panel, bool off)
+esp_err_t esp_lcd_panel_disp_on_off(esp_lcd_panel_handle_t panel, bool on_off);
 ```
-Call with parameter `off` set to false will have the e-paper panel enter sleep mode. BUSY pin will stay HIGH in sleep mode and a `esp_lcd_panel_init()` call is needed to resume the panel. Call with parameter `off` set to true will load the panel built-in waveform LUT, it is useful if you had set a custom waveform LUT.
+Call with parameter `on_off` set to false will have the e-paper panel enter sleep mode. BUSY pin will stay HIGH in sleep mode and a `esp_lcd_panel_init()` call is needed to resume the panel. Call with parameter `on_off` set to true will load the panel built-in waveform LUT, it is useful if you had set a custom waveform LUT.
 
 ## Service Life Optimization
 
 - The screen should not be powered on for extended periods of time. Please use the `disp_on_off` API to put the screen into sleep mode or cut down the power when the screen is not refreshing.
-- Do not refresh the screen at maximum speed for a long time. E-Paper panels are not made to show dynamic contents. The refresh interval should be at least 3 minutes if you want to refresh the screen continuously.
+- Do not refresh the screen at maximum speed for a long time. E-Paper panels are not made to show dynamic contents quickly. The refresh interval should be at least 3 minutes if you want to refresh the screen continuously.