solderedelectronics/inkplate

1.1.0

Latest

uploaded 1 week ago

ESP-IDF driver library for the Inkplate family of e-paper boards (Inkplate2, 4, 5, 6, 6Color, 6Flick, 10, 13)

Readme Dependencies 1 Dependents 0 Examples 243 Versions 5

243 examples

inkplate10 33
- advanced 23
  - communications 1
    - qwiic
      Demonstrates how to use the Qwiic connector on Inkplate 10 to interface with I2C peripherals.
      
      2.79 KB
  - deepsleep 4
    - partial_update
      Demonstrates how to combine partial display updates with deep sleep on an Inkplate 10, performing full refresh initially and partial updates subsequently.
      
      3.45 KB
    - rtc_alarm
      Sets a PCF85063A RTC alarm to wake the ESP32 from deep sleep at a configured interval, refreshing the display with the current time.
      
      3.07 KB
    - simple
      Displays grayscale images in a slideshow on Inkplate 10, using deep sleep for 20 seconds between images.
      
      791.05 KB
    - wake_up_button
      Demonstrates two deep sleep wake-up sources: the WakeUp button and a timer on the Soldered Inkplate 10.
      
      2.92 KB
  - io 1
    - expanders
      Demonstrates how to use both IO expanders on Inkplate 10 by alternating blinking LEDs connected to each.
      
      2.98 KB
  - microsd 3
    - pictures
      Reads BMP or JPG images from a FAT-formatted microSD card and displays them on the Inkplate 10 e-paper screen.
      
      159.98 KB
    - read
      Demonstrates how to open and read a text file from a FAT-formatted microSD card and display its contents on the Inkplate 10 e-paper screen.
      
      8.50 KB
    - write
      Demonstrates how to create and write a text file to a FAT-formatted microSD card inserted into Inkplate 10.
      
      2.53 KB
  - other 5
    - eeprom_usage
      Demonstrates how to use the built-in EEPROM on Inkplate 10 to store data that persists across resets and power cycles.
      
      3.16 KB
    - fastest_display_refreshes
      Demonstrates how to reduce latency between partial updates by keeping the e-paper panel power enabled during refreshes.
      
      3.06 KB
    - png_from_buffer
      Demonstrates how to read a PNG file from a microSD card into a RAM buffer and display it using drawPngFromBuffer.
      
      35.10 KB
    - read_battery_voltage
      Demonstrates how to read the connected battery voltage using Inkplate's built-in battery measurement circuitry.
      
      3.29 KB
    - read_temperature
      Demonstrates how to read temperature data from the on-board temperature sensor integrated inside the TPS65186 e-paper PMIC.
      
      3.21 KB
  - rtc 4
    - alarm
      Demonstrates how to configure an alarm on the PCF85063A RTC, triggering an action on the Inkplate 10 display.
      
      3.43 KB
    - interrupt_alarm
      Demonstrates using the PCF85063A RTC alarm interrupt to trigger a hardware interrupt on Inkplate 10.
      
      3.39 KB
    - simple
      Demonstrates how to set the time and date on the PCF85063A real-time clock and read it back.
      
      3.08 KB
    - timer
      Demonstrates how to configure and use the countdown timer feature of the PCF85063A RTC with the Inkplate 10.
      
      3.41 KB
  - wifi 5
    - http_post_request
      Connects Inkplate 10 to WiFi and sends HTTP POST requests to webhook.site every 20 seconds.
      
      3.41 KB
    - http_request
      Connects Inkplate 10 to WiFi and fetches raw content from a remote web server using HTTP, displaying it on the e-paper.
      
      2.88 KB
    - http_web_server
      Starts an HTTP web server on Inkplate 10 to display text from a browser. Enter text in a web page, and it appears on the e-paper screen.
      
      4.11 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download with certificate validation, including handling success and errors.
      
      5.06 KB
    - show_picture_from_web
      Connects Inkplate 10 to WiFi, downloads a BMP image from a configured URL, and renders it on the e-paper display.
      
      2.62 KB
- basic 6
  - black_and_white
    Demonstrates basic drawing and text rendering in 1-bit (black & white) mode using Adafruit GFX-compatible functions.
    
    12.40 KB
  - grayscale
    Demonstrates 3-bit grayscale (8 shades) drawing using Adafruit GFX-compatible functions on Soldered Inkplate 10.
    
    64.34 KB
  - hello_world
    Initializes Inkplate 10 and prints "Hello World!" on the e-paper screen using built-in text rendering functions.
    
    2.36 KB
  - image_converter
    Demonstrates how to display a bitmap image converted using the Soldered image converter tool on Soldered Inkplate 10.
    
    147.96 KB
  - partial_update
    Demonstrates partial display updates, which refresh only a defined region of the e-paper panel instead of the full screen.
    
    3.22 KB
  - textbox
    Demonstrates how to render long text with automatic line wrapping inside a defined bounding box on the Inkplate 10 display.
    
    8.84 KB
- diagnostics 4
  - burn_in_clean
    Runs the built-in burn-in cleaning sequence to remove ghosting from the Inkplate 10 e-paper panel.
    
    3.00 KB
  - rtc_calibration
    Provides a step-by-step procedure for calibrating the PCF85063A RTC crystal oscillator on Inkplate 10.
    
    5.63 KB
  - set_vcom
    Programs the e-paper panel VCOM voltage and displays a grayscale test image for visual verification.
    
    2.82 KB
  - set_waveform
    Iterates through e-paper waveforms 1-5 to evaluate contrast, banding, and ghosting for optimal selection.
    
    296.67 KB
inkplate13 27
- advanced 20
  - communications 1
    - qwiic
      Demonstrates communication with Qwiic-compatible I2C sensors connected to the Inkplate 13SPECTRA, scanning the I2C bus.
      
      2.74 KB
  - deepsleep 2
    - rtc_alarm
      Sets an alarm on the PCF85063A RTC to wake Inkplate 13SPECTRA from deep sleep and display the time.
      
      2.94 KB
    - wake_up_button
      Puts Inkplate 13SPECTRA into deep sleep and uses the WakeUp button (GPIO36) to wake it and update a wake counter.
      
      2.63 KB
  - io 1
    - external_io_expander
      Demonstrates controlling an external GPIO through the on-board PCAL IO expander, toggling an LED connected to pin P1-7.
      
      2.63 KB
  - other 3
    - eeprom_usage
      Demonstrates how to use ESP32 Non-Volatile Storage (NVS) as an EEPROM equivalent to store and retrieve data.
      
      2.96 KB
    - png_from_buffer
      Demonstrates decoding a PNG image stored as a byte array in flash memory and rendering it on the Inkplate 13SPECTRA e-paper display.
      
      3.03 KB
    - text_box
      Demonstrates the Inkplate textbox functionality, which automatically wraps text within a defined rectangular area.
      
      7.95 KB
  - rtc 4
    - alarm
      Sets a one-shot alarm on the PCF85063A RTC, displaying a message on the Inkplate 13SPECTRA when triggered.
      
      3.08 KB
    - interrupt_alarm
      Configures the PCF85063A RTC to generate an interrupt signal to wake Inkplate 13SPECTRA from deep sleep.
      
      3.22 KB
    - simple
      Sets the on-board PCF85063A real-time clock to a defined date and time, then reads and displays it every second.
      
      2.95 KB
    - timer
      Configures the PCF85063A RTC countdown timer to fire at regular intervals, incrementing and displaying a counter on the Inkplate 13SPECTRA.
      
      3.23 KB
  - sd 3
    - sd_pictures
      Reads image files from a FAT-formatted microSD card and displays them on the Inkplate 13SPECTRA e-paper display.
      
      2.68 KB
    - sd_txt_read
      Mounts a FAT-formatted microSD card and reads the contents of a text file, displaying the data on the Inkplate 13SPECTRA.
      
      2.70 KB
    - sd_txt_write
      Mounts a FAT-formatted microSD card and writes a text string to a file, demonstrating basic file write operations.
      
      2.53 KB
  - web_wifi 6
    - http_request
      Connects Inkplate 13SPECTRA to WiFi, sends an HTTP GET request, and displays the response on the e-paper screen.
      
      2.68 KB
    - http_web_server
      Connects Inkplate 13SPECTRA to WiFi and starts a lightweight HTTP server for displaying content on its e-paper screen.
      
      3.86 KB
    - https_post_request
      Connects Inkplate 13SPECTRA to WiFi and sends periodic HTTPS POST requests to webhook.site for IoT data testing.
      
      3.35 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download by providing a trusted PEM certificate for server validation.
      
      4.82 KB
    - show_jpg_with_httpclient
      Demonstrates downloading a JPG or PNG image into a PSRAM buffer using WiFi, then drawing it on the e-paper display.
      
      3.05 KB
    - show_pictures_from_web
      Connects Inkplate 13SPECTRA to WiFi, downloads an image from a configured URL, and renders it on the display.
      
      2.81 KB
- basic 5
  - full_screen_colors
    Fills the entire Inkplate 13SPECTRA screen with six vertical color bars, useful for verifying color rendering.
    
    2.40 KB
  - hello_world
    Initializes Inkplate 13SPECTRA and draws "Hello World!" text on the e-paper display in 1-bit black and white mode.
    
    2.34 KB
  - image_converter
    Shows how to display an image that has been pre-converted to a C array using the Soldered image converter tool.
    
    686.00 KB
  - partial_update
    Demonstrates partial display updates on the Soldered Inkplate 13SPECTRA by updating random squares without refreshing the entire screen.
    
    3.11 KB
  - simple
    Demonstrates drawing filled and outline shapes in six colors on the Inkplate 13SPECTRA display.
    
    3.65 KB
- diagnostics 2
  - gallery
    Initializes the microSD card, displays a random image on an e-paper screen, and enters deep sleep mode.
    
    3.23 KB
  - mapbox_api
    Connects to WiFi, fetches a map tile from the Mapbox Static Images API, and displays it on the e-paper screen.
    
    3.03 KB
inkplate2 16
- advanced 10
  - rtc 2
    - alarm
      Connects to WiFi, syncs time via NTP, and displays current time and date on the e-paper panel.
      
      3.21 KB
    - alarm_periodic
      Implements a simple NTP-synced alarm clock using ESP32 deep sleep, checking alarm time during wake cycles.
      
      3.92 KB
  - wifi 5
    - http_post_request
      Connects Inkplate 2 to WiFi and sends periodic HTTP POST requests to webhook.site for IoT data testing.
      
      3.48 KB
    - http_request
      Connects to WiFi, performs a basic HTTP GET request to retrieve data from the Internet, and prints the raw response body on the e-paper display.
      
      2.92 KB
    - http_web_server
      Inkplate 2 creates a WiFi access point and web server for sending text to its e-paper display from any browser.
      
      4.21 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download by providing a trusted PEM certificate for server validation.
      
      5.08 KB
    - show_picture_from_web
      Connects Inkplate 2 to WiFi, downloads a BMP image from a URL, and renders it on the e-paper display.
      
      2.60 KB
  - deep_sleep
    Demonstrates low-power operation by cycling through images using ESP32 timer-based deep sleep. The slideshow loops through 3 images.
    
    13.82 KB
  - gpio
    Demonstrates how to use GPIO pins on the Inkplate 2 header to blink an external LED every second.
    
    2.89 KB
  - qwiic
    Scans the I2C bus and shows detected device addresses on the e-paper display and Serial Monitor, repeating every 5 seconds.
    
    2.83 KB
- basic 5
  - black_white_red
    A drawing showcase for Inkplate 2 that cycles through Adafruit GFX-compatible drawing primitives using a tri-color palette.
    
    5.40 KB
  - hello_world
    Initializes the display and prints "Hello World!" using built-in text rendering compatible with the Adafruit GFX library.
    
    2.41 KB
  - image_converter
    Demonstrates how to convert any image into a C byte array using the Soldered Image Converter, then display it on Inkplate 2.
    
    8.16 KB
  - text_with_shadow
    Demonstrates basic text rendering and the drawTextWithShadow() function on Inkplate 2, entering deep sleep after display.
    
    3.26 KB
  - textbox
    Demonstrates the drawTextBox() function for rendering multi-line text inside a defined rectangular area on Inkplate 2.
    
    2.72 KB
- diagnostics 1
  - burn_in_clean
    Calls Inkplate's `burnInClean()` routine to perform a repeated full-refresh cleaning sequence designed to reduce heavy ghosting on the e-paper panel.
    
    3.18 KB
inkplate4 40
- advanced 26
  - deepsleep 5
    - partial_update
      Demonstrates the correct way to use partial screen updates with deep sleep on Inkplate 4TEMPERA and rebuilds the screen buffer after wake-up.
      
      3.08 KB
    - rtc_alarm
      Demonstrates using the onboard PCF85063A RTC alarm interrupt to wake the board from deep sleep every 10 seconds.
      
      3.01 KB
    - simple
      Demonstrates low-power operation by cycling through images using ESP32 timer-based deep sleep. The slideshow loops through 3 images.
      
      209.09 KB
    - wake_up_button
      Demonstrates wake-up from ESP32 deep sleep using an external interrupt and a fallback 30-second timer.
      
      2.91 KB
    - wake_up_on_touchscreen
      Demonstrates low-power wake-up with the touchscreen initialized before sleep using WakeUp button or timer.
      
      2.97 KB
  - microsd 3
    - pictures
      Demonstrates how to load image files from a FAT-formatted microSD card and display them on the e-paper panel using the Inkplate graphics library.
      
      2.60 KB
    - read
      Demonstrates how to open a .txt file from a FAT-formatted microSD card and display its contents on the e-paper display.
      
      2.55 KB
    - write
      Demonstrates how to initialize the SD card, create a .txt file, write data into it, and properly close the file.
      
      2.62 KB
  - other 3
    - eeprom_usage
      Demonstrates how to use the ESP32 Non-Volatile Storage (NVS) to store data that persists across resets and power cycles.
      
      3.05 KB
    - fastest_display_refreshes
      This example demonstrates faster partial updates by keeping the e-paper panel powered, allowing quicker successive partial refreshes.
      
      2.98 KB
    - png_from_buffer
      Demonstrates how to read a PNG file from an SD card into a RAM buffer and then display it using drawPngFromBuffer.
      
      3.10 KB
  - rtc 4
    - alarm
      Demonstrates how to use the PCF85063A RTC on Inkplate 4TEMPERA to set time, configure an alarm, and display the current time.
      
      3.24 KB
    - interrupt_alarm
      Demonstrates how to use the PCF85063A RTC alarm functionality with its interrupt output on Inkplate 4TEMPERA.
      
      3.41 KB
    - simple
      Demonstrates basic usage of the PCF85063A real-time clock (RTC) on Inkplate 4TEMPERA to display time and date.
      
      3.15 KB
    - timer
      Demonstrates how to use the PCF85063A RTC countdown timer on Inkplate 4TEMPERA, showing current time and displaying 'Timer!' when the countdown ends.
      
      3.33 KB
  - sensors 5
    - accelerometer_gyroscope
      Demonstrates the use of the LSM6DS3 accelerometer and gyroscope to visualize motion with a rotating 3D cube on Inkplate 4TEMPERA.
      
      3.87 KB
    - apds9960
      Demonstrates how to use the built-in APDS9960 sensor on Inkplate 4TEMPERA for various sensing functions.
      
      7.52 KB
    - bme688
      Demonstrates how to use the built-in Bosch BME688 sensor on Inkplate 4TEMPERA to read environmental measurements.
      
      5.62 KB
    - buzzer
      Shows basic usage of the Inkplate 4TEMPERA buzzer API with several demo sequences including fixed-duration beeps and a repeating melody.
      
      2.94 KB
    - fuel_gauge
      Demonstrates how to use the built-in BQ27441-G1A fuel gauge on Inkplate 4TEMPERA to read battery statistics.
      
      4.62 KB
  - web 6
    - http_post_request
      Connects Inkplate 4TEMPERA to WiFi and sends periodic HTTP POST requests to webhook.site for testing IoT data transmission.
      
      3.36 KB
    - http_request
      Connects to WiFi, performs a basic HTTP GET request, and displays the raw response on the Inkplate 4TEMPERA.
      
      2.79 KB
    - http_web_server
      Inkplate 4TEMPERA creates its own WiFi access point and runs an HTTP web server to send text to an e-paper display.
      
      3.98 KB
    - https_port_request
      Demonstrates how to connect Inkplate 4TEMPERA to WiFi and send periodic HTTPS POST requests with a JSON payload.
      
      3.66 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download with certificate pinning on Inkplate 4TEMPERA for trusted server validation.
      
      5.08 KB
    - show_pictures_from_web
      Connects Inkplate 4TEMPERA to WiFi, downloads a BMP image from a URL, and displays it on the e-paper screen.
      
      2.74 KB
- basic 11
  - black_white
    Cycles through various Adafruit GFX drawing primitives in black & white mode, showcasing shapes and text.
    
    4.42 KB
  - grayscale
    Cycles through a variety of Adafruit GFX drawing primitives in 3-bit grayscale mode (8 shades). The demo features different shapes and texts displayed for 5 seconds each.
    
    54.85 KB
  - hello_world
    Initializes the display and prints "Hello World!" using built-in text rendering compatible with the Adafruit GFX library.
    
    2.45 KB
  - image_converter
    Shows how to display a converted image on the Soldered Inkplate 4TEMPERA using a C header file.
    
    62.49 KB
  - partial_update
    Demonstrates partial display updates by scrolling a text string from right to left on Inkplate 4TEMPERA.
    
    3.16 KB
  - simple_frontlight
    Demonstrates control of the built-in frontlight by gradually fading brightness up from 0 to 63 and back down to 0.
    
    2.39 KB
  - textbox
    Demonstrates the `drawTextBox()` function which renders long text within a defined rectangular region with automatic word wrapping.
    
    8.88 KB
  - touch_in_area
    Demonstrates the `touchInArea()` function by drawing a filled black rectangle on screen that moves diagonally each time it is touched.
    
    2.62 KB
  - touch_registers
    Reads the 8 raw touchscreen controller registers on touch detection, aiding debugging and displaying coordinates.
    
    2.71 KB
  - touchscreen_draw
    Uses the touchscreen to draw on the e-paper display with two modes: continuous lines or filled circles.
    
    2.73 KB
  - touchsreen_serial
    Reads touch events and prints the number of fingers and their coordinates to serial output.
    
    2.75 KB
- diagnostics 3
  - burn_in_clean
    Runs the built-in burn-in cleaning sequence to remove ghosting from the e-paper panel by cycling through cleaning refresh cycles.
    
    2.67 KB
  - rtc_calibration
    Provides a step-by-step procedure for calibrating the PCF85063A RTC crystal oscillator on Inkplate 4TEMPERA.
    
    5.07 KB
  - set_vcom
    Programs the e-paper panel VCOM voltage to the value defined by `VCOM_VALUE` and displays a grayscale test image for visual verification.
    
    2.66 KB
inkplate5 32
- advanced 23
  - communications 1
    - qwiic
      Scans the I2C bus and shows detected device addresses on the e-paper display and ESP log output.
      
      2.73 KB
  - deepsleep 4
    - partial_update
      Demonstrates the correct way to use partial screen updates with ESP32 deep sleep by recreating the screen after each wake-up.
      
      3.06 KB
    - rtc_alarm
      Demonstrates how to use the onboard RTC alarm interrupt to wake the board from deep sleep every 10 seconds.
      
      3.00 KB
    - simple
      Demonstrates low-power operation by cycling through images using ESP32 timer-based deep sleep. The slideshow loops through 3 images.
      
      452.03 KB
    - wake_up_button
      Demonstrates wake-up from ESP32 deep sleep using an external interrupt and a 30-second timer.
      
      2.89 KB
  - io 1
    - expanders
      Demonstrates how to use the internal IO expander (PCAL) on Inkplate 5 to blink an LED connected to pin P1-7.
      
      2.51 KB
  - microsd 3
    - pictures
      Demonstrates how to load image files from a FAT-formatted microSD card and display them on the e-paper panel using the Inkplate graphics library.
      
      2.62 KB
    - read
      Demonstrates how to open a .txt file from a FAT-formatted microSD card and display its contents on the e-paper display.
      
      2.54 KB
    - write
      Demonstrates how to initialize the SD card, create a .txt file, write data into it, and properly close the file.
      
      2.59 KB
  - other 5
    - eeprom_usage
      Demonstrates how to use the ESP32 Non-Volatile Storage (NVS) to store data that persists across resets and power cycles.
      
      3.24 KB
    - fastest_display_refreshes
      Demonstrates faster partial updates by keeping the e-paper panel power enabled during refreshes using einkOn().
      
      2.98 KB
    - png_from_buffer
      Demonstrates how to read a PNG file from an SD card into a RAM buffer and then display it.
      
      3.13 KB
    - read_battery_voltage
      Demonstrates how to read the connected battery voltage using Inkplate's built-in battery measurement circuitry.
      
      3.07 KB
    - read_temperature
      Demonstrates how to read temperature data from the on-board sensor inside the TPS65186 e-paper PMIC, updating every 10 seconds.
      
      3.02 KB
  - rtc 4
    - alarm
      Demonstrates how to use the PCF85063 RTC on Inkplate 5 to set time and date, configure an alarm, and display the current time.
      
      3.24 KB
    - interrupt_alarm
      Demonstrates how to use the PCF85063A RTC alarm functionality with its interrupt output on Inkplate 5.
      
      3.41 KB
    - simple
      Demonstrates basic usage of the PCF85063A RTC integrated on Inkplate 5 for setting time and date.
      
      3.12 KB
    - timer
      Demonstrates how to use the PCF85063A RTC countdown timer on Inkplate 5, including setting time, configuring the timer, and handling events.
      
      3.31 KB
  - wifi 5
    - http_post_request
      Connects Inkplate 5 to a WiFi network and sends periodic HTTP POST requests to webhook.site for real-time inspection.
      
      3.37 KB
    - http_request
      Connects to WiFi, performs a basic HTTP GET request, and displays the raw response body on the Inkplate 5.
      
      2.80 KB
    - http_web_server
      Inkplate 5 creates its own WiFi access point and runs an HTTP web server to send text to the e-paper display.
      
      3.96 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download using a trusted PEM certificate for server validation on Inkplate 5.
      
      4.94 KB
    - show_picture_from_web
      Connects Inkplate 5 to WiFi, downloads a BMP image from a URL, and displays it on the e-paper screen.
      
      2.52 KB
- basic 6
  - black_white
    Cycles through Adafruit GFX drawing primitives in 1-bit mode, showing shapes for 5 seconds each.
    
    7.25 KB
  - grayscale
    Cycles through Adafruit GFX drawing primitives in 3-bit grayscale mode, showcasing various shapes and text.
    
    52.75 KB
  - hello_world
    Initializes the display and prints "Hello World!" using built-in text rendering compatible with the Adafruit GFX library.
    
    2.41 KB
  - image_converter
    Shows how to display an image converted to a C header file using the Soldered online image converter tool.
    
    148.06 KB
  - partial_update
    Demonstrates partial display updates by scrolling a text string, refreshing only the changed region for speed.
    
    2.86 KB
  - textbox
    Demonstrates the `drawTextBox()` function which renders long text with automatic word wrapping in defined regions.
    
    8.14 KB
- diagnostics 3
  - burn_in_clean
    Runs the burn-in cleaning sequence to remove ghosting and image retention from the e-paper panel.
    
    2.95 KB
  - rtc_calibration
    Provides a step-by-step procedure for calibrating the PCF85063A RTC crystal oscillator on Inkplate 5.
    
    4.14 KB
  - set_vcom
    Programs the e-paper panel VCOM voltage for optimal image contrast and displays a grayscale test image for verification.
    
    2.77 KB
inkplate6 32
- advanced 23
  - communications 1
    - qwiic
      Demonstrates how to communicate with a Qwiic-compatible I2C sensor connected to the Inkplate 6 Qwiic port.
      
      2.77 KB
  - deepsleep 4
    - partial_update
      Combines deep sleep with partial e-paper updates, refreshing only the changed display portions to reduce wear.
      
      3.39 KB
    - rtc_alarm
      Sets an alarm on the PCF85063A RTC to wake Inkplate 6 from deep sleep at a precise time.
      
      3.05 KB
    - simple
      Demonstrates basic ESP32 deep sleep with timed wakeup, updating a wake counter on the Inkplate 6 display.
      
      428.88 KB
    - wake_up_button
      Puts Inkplate 6 into deep sleep and configures the WakeUp button (GPIO36) as an external wakeup source.
      
      2.87 KB
  - io 1
    - expanders
      Demonstrates how to use GPIO pins on both internal and external IO expanders on Inkplate 6.
      
      2.92 KB
  - microsd 3
    - pictures
      Reads BMP image files from a FAT-formatted microSD card and displays them on the Inkplate 6 e-paper display.
      
      160.06 KB
    - read
      Mounts a FAT-formatted microSD card and reads the contents of a text file, displaying the data on the Inkplate 6.
      
      8.57 KB
    - write
      Mounts a FAT-formatted microSD card and writes a text string to a file, demonstrating file write operations with ESP-IDF.
      
      2.61 KB
  - other 5
    - eeprom_usage
      Demonstrates how to use ESP32 Non-Volatile Storage (NVS) as an EEPROM equivalent for persistent data storage.
      
      3.15 KB
    - fastest_display_refreshes
      Measures and displays the time taken for a full display refresh at maximum speed, reporting the refresh duration in milliseconds.
      
      3.00 KB
    - png_from_buffer
      Demonstrates decoding a PNG image stored as a byte array in flash memory and rendering it directly on the Inkplate 6 e-paper display.
      
      35.07 KB
    - read_battery_voltage
      Reads the LiPo battery voltage using the Inkplate built-in ADC and displays the result on the e-paper screen.
      
      3.32 KB
    - read_temperature
      Reads the temperature from the TPS65186 e-paper PMIC's built-in temperature sensor and displays the result in degrees Celsius on the Inkplate 6 e-paper screen.
      
      3.17 KB
  - rtc 4
    - alarm
      Sets a one-shot alarm on the PCF85063A RTC that displays a message on the Inkplate 6 when triggered.
      
      3.48 KB
    - interrupt_alarm
      Configures the PCF85063A RTC to generate an interrupt signal for waking the Inkplate 6 from deep sleep with minimal power consumption.
      
      3.47 KB
    - simple
      Sets the on-board PCF85063A real-time clock to a defined date and time, then displays the current time on the Inkplate 6.
      
      3.10 KB
    - timer
      Configures the PCF85063A RTC countdown timer to fire at regular intervals, incrementing a counter displayed on the Inkplate 6.
      
      3.46 KB
  - wifi 5
    - http_post_request
      Connects Inkplate 6 to WiFi and sends an HTTP POST request with a JSON or form-encoded body to a configured endpoint.
      
      3.30 KB
    - http_request
      Connects Inkplate 6 to WiFi, sends an HTTP GET request to a URL, and displays the response on the e-paper screen.
      
      2.92 KB
    - http_web_server
      Connects Inkplate 6 to WiFi and starts a lightweight HTTP server for displaying content on its e-paper screen.
      
      4.12 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download by providing a trusted PEM certificate for server validation.
      
      5.10 KB
    - show_picture_from_web
      Connects Inkplate 6 to WiFi, downloads a BMP image from a URL, and displays it on the e-paper screen.
      
      2.58 KB
- basic 6
  - black_and_white
    Sets Inkplate 6 to 1-bit (BW) display mode and demonstrates drawing primitives in pure black and white.
    
    8.13 KB
  - grayscale
    Sets Inkplate 6 to 4-bit grayscale mode (16 shades) and demonstrates drawing primitives including filled rectangles, circles, and text in varying gray levels.
    
    54.76 KB
  - hello_world
    Initializes Inkplate 6 and draws "Hello World!" text on the e-paper display.
    
    2.25 KB
  - image_converter
    Shows how to display an image that has been pre-converted to a C array using the Soldered image converter tool.
    
    80.00 KB
  - partial_update
    Shows how to use `partialUpdate()` to refresh only a portion of the Inkplate 6 e-paper display.
    
    3.25 KB
  - textbox
    Demonstrates the Inkplate textbox functionality, which automatically wraps text within a defined rectangular area.
    
    8.83 KB
- diagnostics 3
  - burn_in_clean
    Runs the built-in burn-in cleaning sequence to remove ghosting and image retention from the e-paper panel.
    
    2.66 KB
  - rtc_calibration
    Provides a step-by-step procedure for calibrating the PCF85063A RTC crystal oscillator on Inkplate 6.
    
    5.01 KB
  - set_vcom
    Programs the e-paper panel VCOM voltage to the value defined by `VCOM_VALUE` and displays a grayscale test image for visual verification.
    
    2.64 KB
inkplate6color 26
- advanced 21
  - communication 1
    - qwiic
      Demonstrates how to use the Qwiic connector on Inkplate 6Color to interface with I2C peripherals.
      
      2.80 KB
  - deepsleep 3
    - rtc_alarm
      Sets a PCF85063A RTC alarm to wake the ESP32 from deep sleep every 10 seconds, refreshing the display with the current date and time.
      
      2.98 KB
    - simple
      Displays a sequence of three embedded color images as a slideshow, entering deep sleep between each image.
      
      236.13 KB
    - wake_up_button
      Demonstrates two deep sleep wake-up sources: the WakeUp button and a 30-second timer, updating the display with boot count.
      
      2.85 KB
  - microsd 3
    - pictures
      Reads BMP or JPG images from a FAT-formatted microSD card and displays them on the Inkplate 6Color e-paper screen.
      
      303.95 KB
    - read
      Demonstrates how to open and read a text file from a FAT-formatted microSD card and display its contents on the Inkplate 6Color e-paper screen.
      
      2.55 KB
    - write
      Demonstrates how to create and write a text file to a FAT-formatted microSD card inserted into Inkplate 6Color.
      
      2.41 KB
  - other 4
    - eeprom_usage
      Demonstrates how to use the built-in EEPROM on Inkplate 6Color to store data that persists across resets and power cycles.
      
      3.14 KB
    - png_from_buffer
      Demonstrates how to read a PNG file from a microSD card into a heap buffer and display it using `drawPngFromBuffer()`.
      
      3.17 KB
    - read_battery_voltage
      Demonstrates how to read the connected battery voltage using Inkplate's built-in battery measurement circuitry.
      
      3.13 KB
    - textbox
      Demonstrates how to render long text with automatic line wrapping and truncation inside a defined bounding box.
      
      8.84 KB
  - rtc 4
    - alarm
      Demonstrates how to configure an alarm on the PCF85063A RTC, updating the Inkplate 6Color display when the alarm fires.
      
      3.35 KB
    - interrupt_alarm
      Demonstrates using the PCF85063A RTC alarm interrupt to trigger a hardware interrupt on Inkplate 6Color, updating the display without polling.
      
      3.26 KB
    - simple
      Demonstrates how to set the time and date on the PCF85063A real-time clock and read it back.
      
      3.00 KB
    - timer
      Demonstrates how to configure and use the countdown timer feature of the PCF85063A RTC, updating the Inkplate 6Color display on timer expiration.
      
      3.33 KB
  - web 5
    - http_post_request
      Connects Inkplate 6Color to WiFi and sends HTTP POST requests to webhook.site at a configurable interval.
      
      3.36 KB
    - http_request
      Connects Inkplate 6Color to WiFi and fetches raw content from a remote web server using HTTP.
      
      2.76 KB
    - http_web_server
      Starts an HTTP web server on Inkplate 6Color, allowing text input from a browser to display on the e-paper screen.
      
      4.02 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download with certificate validation on Soldered Inkplate 6Color.
      
      5.07 KB
    - show_pictures_from_web
      Connects Inkplate 6Color to WiFi, downloads a BMP image from a configured URL, and renders it on the e-paper display.
      
      2.62 KB
  - io_expander
    Demonstrates controlling a GPIO through the on-board PCAL IO expander on the Soldered Inkplate 6Color.
    
    2.60 KB
- basic 4
  - full_screen_colors
    Fills the entire Inkplate 6Color screen with seven vertical color bars — one for each supported color.
    
    2.42 KB
  - hello_world
    Initializes Inkplate 6Color and prints "Hello World!" on the e-paper screen using built-in text rendering functions.
    
    2.45 KB
  - image_converter
    Demonstrates how to display an image converted using the Soldered image converter tool on Inkplate 6Color.
    
    131.49 KB
  - simple
    Demonstrates drawing basic shapes and text in all seven colors on the Soldered Inkplate 6Color.
    
    3.84 KB
- diagnostics 1
  - rtc_calibration
    Provides a step-by-step procedure for calibrating the PCF85063A RTC crystal oscillator on Inkplate 6.
    
    5.44 KB
inkplate6flick 37
- advanced 25
  - communications 1
    - qwiic
      Demonstrates how to communicate with a Qwiic-compatible I2C sensor or module connected to the Inkplate 6 Flick Qwiic port.
      
      2.69 KB
  - deepsleep 4
    - partial_update_with_deep_sleep
      Demonstrates how to correctly combine partial screen updates with ESP32 deep sleep on Inkplate 6 Flick.
      
      3.61 KB
    - rtc_alarm_with_deep_sleep
      Sets an alarm on the PCF85063A RTC to wake Inkplate 6 Flick from deep sleep at a precise time.
      
      3.34 KB
    - simple
      Demonstrates basic ESP32 deep sleep with timed wakeup, updating a counter on each cycle before sleeping again.
      
      3.22 KB
    - wake_up_button
      Puts Inkplate 6 Flick into deep sleep and configures the WakeUp button (GPIO36) to wake the board on button press.
      
      2.95 KB
  - io 1
    - io_expanders
      Demonstrates how to use GPIO pins on internal and external IO expanders on Inkplate 6 Flick, blinking LEDs alternately.
      
      2.84 KB
  - microsd 3
    - pictures
      Reads BMP image files from a FAT-formatted microSD card and displays them on the Inkplate 6 Flick e-paper display.
      
      2.72 KB
    - txt_read
      Mounts a FAT-formatted microSD card and reads the contents of a text file, displaying the data on the Inkplate 6 Flick e-paper screen.
      
      2.62 KB
    - txt_write
      Mounts a FAT-formatted microSD card and writes a text string to a file, demonstrating basic file write operations.
      
      2.62 KB
  - other 6
    - eeprom_usage
      Demonstrates how to use ESP32 Non-Volatile Storage (NVS) as an EEPROM equivalent for persistent data storage.
      
      3.15 KB
    - fastest_display_refreshes
      Measures and displays the time taken for a full display refresh at maximum speed for latency-sensitive applications.
      
      2.88 KB
    - png_from_buffer
      Demonstrates decoding a PNG image stored as a byte array in flash memory and rendering it directly on the Inkplate 6 Flick e-paper display.
      
      3.04 KB
    - read_battery_voltage
      Reads the LiPo battery voltage using the Inkplate built-in ADC and displays the result on the e-paper screen.
      
      3.08 KB
    - read_temperature
      Reads the temperature from the TPS65186 e-paper PMIC's built-in temperature sensor and displays the result in degrees Celsius on the Inkplate 6 Flick e-paper screen.
      
      2.92 KB
    - textbox
      Demonstrates the Inkplate textbox functionality, which automatically wraps text within a defined rectangular area.
      
      7.98 KB
  - rtc 4
    - alarm
      Sets a one-shot alarm on the PCF85063A RTC, displaying a message on the Inkplate 6 Flick e-paper screen when triggered.
      
      3.62 KB
    - interrupt_alarm
      Configures the PCF85063A RTC to wake the Inkplate 6 Flick from deep sleep using an interrupt alarm signal.
      
      3.98 KB
    - simple
      Sets the on-board PCF85063A real-time clock to a defined date and time, then reads it back every second and displays the current time on the Inkplate 6 Flick e-paper screen.
      
      3.36 KB
    - timer
      Configures the PCF85063A RTC countdown timer to fire at regular intervals, incrementing a counter displayed on the Inkplate 6 Flick.
      
      3.90 KB
  - web 6
    - http_post_request
      Connects Inkplate 6 Flick to WiFi and sends an HTTP POST request with a JSON or form-encoded body to a configured endpoint.
      
      3.20 KB
    - http_request
      Connects Inkplate 6 Flick to WiFi, sends an HTTP GET request, and displays the response on the e-paper screen.
      
      2.77 KB
    - http_web_server
      Connects Inkplate 6 Flick to WiFi and starts a lightweight HTTP server for displaying commands on the e-paper screen.
      
      3.96 KB
    - https_post_request
      Connects Inkplate 6 Flick to WiFi and sends HTTPS POST requests with JSON data to a test API every 10 seconds.
      
      3.50 KB
    - https_with_certificate
      Demonstrates secure HTTPS image download by providing a trusted PEM certificate for server validation.
      
      4.93 KB
    - show_pictures_from_web
      Connects Inkplate 6 Flick to WiFi, downloads a BMP image from a URL, and displays it on the e-paper screen.
      
      2.66 KB
- basic 9
  - black_white
    Cycles through Adafruit GFX drawing primitives in 1-bit (black & white) mode, showing each shape for 5 seconds.
    
    7.67 KB
  - grayscale
    Sets Inkplate 6 Flick to 4-bit grayscale mode (16 shades) and demonstrates drawing primitives including filled rectangles, circles, and text in varying gray levels.
    
    53.03 KB
  - hello_world
    Initializes Inkplate 6 Flick and draws "Hello World!" text on the e-paper display in 1-bit black and white mode.
    
    2.29 KB
  - image_converter
    Shows how to display an image converted to a C array on the Soldered Inkplate 6 Flick e-paper display.
    
    113.62 KB
  - partial_update
    Shows how to use partialUpdate() to refresh only a portion of the Inkplate 6 Flick e-paper display.
    
    2.83 KB
  - simple_frontlight
    Demonstrates how to enable and control the frontlight on the Inkplate 6 Flick.
    
    2.75 KB
  - touch_in_area
    Demonstrates touch detection within a rectangular area on the Inkplate 6 Flick touchscreen, allowing dynamic movement of a rectangle.
    
    2.66 KB
  - touchscreen_draw
    Demonstrates using the Inkplate 6 Flick touchscreen to draw directly on the e-paper display with different modes.
    
    2.75 KB
  - touchscreen_serial
    Reads touch events from the Inkplate 6 Flick touchscreen and prints detected touch coordinates to the serial monitor.
    
    2.77 KB
- diagnostics 3
  - burn_in_clean
    Runs the built-in burn-in cleaning sequence to remove ghosting and image retention from the e-paper panel.
    
    2.86 KB
  - rtc_calibration
    Provides a step-by-step procedure for calibrating the PCF85063A RTC crystal oscillator on Inkplate 6 Flick.
    
    4.54 KB
  - set_vcom
    Programs the e-paper panel VCOM voltage for image contrast and displays a grayscale test image for verification.
    
    2.86 KB