EInkShield_HelloWorld

Dependencies:   libEinkShield_mbedcli_ARM_KL25Z

Fork of EInkShield_HelloWorld by E Ink

The actual display component with e-paper and Mbed board

/media/uploads/jauming/imag1222_1k_2.png

Key Features

  • SPI interface to EPD display
  • Gray level support(Black, White and Red)
  • Flash memory - 128MB
  • One GPIO connected to LED
  • Four push buttons for user feedback

Peripherals/IOs

/media/uploads/jauming/2a_peripherals_ios_mbed-driving-board-function-500_switches.jpg

Pinout

/media/uploads/jauming/mbed_pinout_v05.png

Typical connection

  • Compatible with Arduino Headers /media/uploads/jauming/3_simple_procedures_how_to_connect_the_component_to_the_main_board_compatible_with_arduino_headers_typical_connection.jpg

Datasheet

Program and Library

Import programEinkShield_HelloWorld_ARM_KL25Z

EInkShield_HelloWorld

Import librarylibEinkShield_mbedcli_ARM_KL25Z

libEinkShield_mbedcli_ARM_KL25Z

Import librarylibEinkShield_mbedcli_ARM_K22F

libEinkShield_mbedcli_ARM_K22F

Import librarylibEinkShield_mbedcli_ARM_NUCLEO_F446RE

libEinkShield_mbedcli_ARM_NUCLEO_F446RE

Import library

Public Member Functions

EinkShield (EPD_driver driver, PinName bsi_pin, PinName rstn_pin, PinName busyn_pin, PinName csb_pin, PinName dc_pin, PinName scl_pin, PinName sda_pin)
Constructor to set pin assignment and driver.
void EPD_Init (void)
Driver initial.
void EPD_Display_KWR (unsigned char const *img_kw, unsigned char const *img_r)
Display image with color: black, white and red.
void EPD_Display_Red (void)
Display full screen red.
Committer:
jauming
Date:
Tue Aug 21 02:48:57 2018 +0000
Revision:
3:6c5c029a7812
Parent:
1:9b126a535f52
EinkShield_HelloWorld_ARM_KL25Z

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jauming 1:9b126a535f52 1 # Getting started with EinkShield_HelloWorld on mbed OS
jauming 0:6f162728dcca 2
jauming 1:9b126a535f52 3 This guide reviews the steps required to get EinkShield_HelloWorld working on an mbed OS platform.
jauming 0:6f162728dcca 4
jauming 0:6f162728dcca 5 Please install [mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
jauming 0:6f162728dcca 6
jauming 0:6f162728dcca 7 ## Import the example application
jauming 0:6f162728dcca 8
jauming 0:6f162728dcca 9 From the command-line, import the example:
jauming 0:6f162728dcca 10
jauming 0:6f162728dcca 11 ```
jauming 1:9b126a535f52 12 mbed import EinkShield_HelloWorld
jauming 1:9b126a535f52 13 cd EinkShield_HelloWorld
jauming 0:6f162728dcca 14 ```
jauming 0:6f162728dcca 15
jauming 0:6f162728dcca 16 ### Now compile
jauming 0:6f162728dcca 17
jauming 0:6f162728dcca 18 Invoke `mbed compile`, and specify the name of your platform and your favorite toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
jauming 0:6f162728dcca 19
jauming 0:6f162728dcca 20 ```
jauming 0:6f162728dcca 21 mbed compile -m KL25Z -t ARM
jauming 0:6f162728dcca 22 ```
jauming 0:6f162728dcca 23
jauming 0:6f162728dcca 24 Your PC may take a few minutes to compile your code. At the end, you see the following result:
jauming 0:6f162728dcca 25
jauming 0:6f162728dcca 26 ```
jauming 0:6f162728dcca 27 [snip]
jauming 0:6f162728dcca 28 +----------------------------+-------+-------+------+
jauming 0:6f162728dcca 29 | Module | .text | .data | .bss |
jauming 0:6f162728dcca 30 +----------------------------+-------+-------+------+
jauming 0:6f162728dcca 31 | Misc | 13939 | 24 | 1372 |
jauming 0:6f162728dcca 32 | core/hal | 16993 | 96 | 296 |
jauming 0:6f162728dcca 33 | core/rtos | 7384 | 92 | 4204 |
jauming 0:6f162728dcca 34 | features/FEATURE_IPV4 | 80 | 0 | 176 |
jauming 0:6f162728dcca 35 | frameworks/greentea-client | 1830 | 60 | 44 |
jauming 0:6f162728dcca 36 | frameworks/utest | 2392 | 512 | 292 |
jauming 0:6f162728dcca 37 | Subtotals | 42618 | 784 | 6384 |
jauming 0:6f162728dcca 38 +----------------------------+-------+-------+------+
jauming 0:6f162728dcca 39 Allocated Heap: unknown
jauming 0:6f162728dcca 40 Allocated Stack: unknown
jauming 0:6f162728dcca 41 Total Static RAM memory (data + bss): 7168 bytes
jauming 0:6f162728dcca 42 Total RAM memory (data + bss + heap + stack): 7168 bytes
jauming 0:6f162728dcca 43 Total Flash memory (text + data + misc): 43402 bytes
jauming 1:9b126a535f52 44 Image: .\.build\KL25Z\ARM\EinkShield_HelloWorld.bin
jauming 0:6f162728dcca 45 ```
jauming 0:6f162728dcca 46
jauming 0:6f162728dcca 47 ### Program your board
jauming 0:6f162728dcca 48
jauming 0:6f162728dcca 49 1. Connect your mbed device to the computer over USB.
jauming 0:6f162728dcca 50 1. Copy the binary file to the mbed device.
jauming 0:6f162728dcca 51 1. Press the reset button to start the program.
jauming 0:6f162728dcca 52
jauming 0:6f162728dcca 53 The EinkShield on your platform will show image
jauming 0:6f162728dcca 54
jauming 0:6f162728dcca 55 ## Troubleshooting
jauming 0:6f162728dcca 56
jauming 0:6f162728dcca 57 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.