jun imamura / epd1in54

WaveShare e-paper module (epd1in54). Monochrome version

e-Paper Module

Description

Waveshare 1.54 e-paper module imported from offiicial code https://www.waveshare.com/wiki/1.54inch_e-Paper_Module Codes are referenced from official Arduino code and Raspberry pi code.

SPI is used for communication between ePaper module and mbed.

Following shapes can be used:

  • primitive shape (square, circle, line)
  • font (variable sizes)

Pull request are appreciated (Note that the original code is copyrighted by (C) Waveshare )

Example Output

Display output with example code will be like following image:

/media/uploads/imachooon/img_20180216_223238.jpg

Example Code

include the mbed library with this snippet

#include "mbed.h"
#include "epd1in54.h"
#include "m41t62_rtc.h"
// Control
PinName rst;
PinName dc;
PinName busy;
// SPI communication
PinName mosi;
PinName miso;
PinName sclk;
PinName cs;

DigitalOut myled(LED1);

unsigned char frame_black[EPD_HEIGHT*EPD_WIDTH/8];


int main() {
    mosi = p5;
    miso = p6;
    sclk = p7;
    cs = p8;
    rst = p9;
    dc = p10;
    busy = p11;
    
    memset(frame_black, 0xFF, sizeof(unsigned char)*EPD_HEIGHT*EPD_WIDTH/8);

    Epd epd = Epd(mosi, miso, sclk, cs, dc, rst, busy);
    if (epd.Init(lut_full_update) != 0){
        return -1;
    }

    /* Draw something to the frame buffer */
    // For simplicity, the arguments are explicit numerical coordinates
    epd.DrawRectangle(frame_black, 10, 60, 50, 110, COLORED);
    epd.DrawLine(frame_black, 10, 60, 50, 110, COLORED);
    epd.DrawLine(frame_black, 50, 60, 10, 110, COLORED);
    epd.DrawCircle(frame_black, 120, 80, 30, COLORED);
    epd.DrawFilledRectangle(frame_black, 10, 130, 50, 180, COLORED);
    epd.DrawFilledRectangle(frame_black, 0, 6, 200, 26, COLORED);
    epd.DrawFilledCircle(frame_black, 120, 150, 30, COLORED);

    /*Write strings to the buffer */
    epd.DrawStringAt(frame_black, 30, 30, "e-Paper Demo", &Font16, COLORED);
    epd.DrawStringAt(frame_black, 28, 10, "Hello world!", &Font16, UNCOLORED);


    
    /* Display the frame_buffer */
    epd.SetFrameMemory(frame_black, 0, 0, epd.width, epd.height);
    epd.DisplayFrame();
    epd.Sleep();

    
    while(1) {
        myled = 1;
        wait(0.5);
        myled = 0;
        wait(0.5);
    }
}

epd1in54.h

Committer:
imachooon
Date:
2018-02-16
Revision:
0:ac97d71fe296

File content as of revision 0:ac97d71fe296:

/**
 *  @filename   :   epd1in54.h
 *  @brief      :   Header file for e-paper display library epd1in54b.cpp
 *  @author     :   Yehui from Waveshare
 *  
 *  Copyright (C) Waveshare     August 10 2017
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documnetation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to  whom the Software is
 * furished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef EPD1IN54_H
#define EPD1IN54_H

#include "epdif.h"
#include "fonts.h"

#define LOW  0
#define HIGH 1

// Display resolution
#define EPD_WIDTH       200
#define EPD_HEIGHT      200

#define  COLORED        1
#define  UNCOLORED      0

// EPD1IN54 commands
#define DRIVER_OUTPUT_CONTROL                       0x01
#define BOOSTER_SOFT_START_CONTROL                  0x0C
#define GATE_SCAN_START_POSITION                    0x0F
#define DEEP_SLEEP_MODE                             0x10
#define DATA_ENTRY_MODE_SETTING                     0x11
#define SW_RESET                                    0x12
#define TEMPERATURE_SENSOR_CONTROL                  0x1A
#define MASTER_ACTIVATION                           0x20
#define DISPLAY_UPDATE_CONTROL_1                    0x21
#define DISPLAY_UPDATE_CONTROL_2                    0x22
#define WRITE_RAM                                   0x24
#define WRITE_VCOM_REGISTER                         0x2C
#define WRITE_LUT_REGISTER                          0x32
#define SET_DUMMY_LINE_PERIOD                       0x3A
#define SET_GATE_TIME                               0x3B
#define BORDER_WAVEFORM_CONTROL                     0x3C
#define SET_RAM_X_ADDRESS_START_END_POSITION        0x44
#define SET_RAM_Y_ADDRESS_START_END_POSITION        0x45
#define SET_RAM_X_ADDRESS_COUNTER                   0x4E
#define SET_RAM_Y_ADDRESS_COUNTER                   0x4F
#define TERMINATE_FRAME_READ_WRITE                  0xFF

// Display orientation
#define ROTATE_0                                     0
#define ROTATE_90                                    1
#define ROTATE_180                                   2
#define ROTATE_270                                   3

extern const unsigned char lut_full_update[];
extern const unsigned char lut_partial_update[];

class Epd : EpdIf {
public:
    unsigned long width;
    unsigned long height;
    unsigned int rotate;


    Epd(PinName mosi,
        PinName miso,
        PinName sclk, 
        PinName cs, 
        PinName dc, 
        PinName rst, 
        PinName busy
        );
    ~Epd();
    int  Init(const unsigned char* lut);
    void SendCommand(unsigned char command);
    void SendData(unsigned char data);
    void WaitUntilIdle(void);
    void Reset(void);

    void SetLut(const unsigned char* lut);
    void SetMemoryArea(int x_start, int y_start, int x_end, int y_end);
    void SetMemoryPointer(int x, int y);
    void SetFrameMemory(const unsigned char* image_buffer, int x, int y, int image_width, int image_height);
    void ClearFrameMemory(unsigned char color);
    void DisplayFrame(void);
    
    void Sleep(void);
    void SetRotate(int rotate);
    void SetPixel(unsigned char *frame_buffer, int x, int y, int colored);
    void SetAbsolutePixel(unsigned char *frame_buffer, int x, int y, int colored); 
    void DrawLine(unsigned char *frame_buffer, int x0, int y0, int x1, int y1, int colored);
    void DrawHorizontalLine(unsigned char *frame_buffer, int x, int y, int width, int colored);
    void DrawVerticalLine(unsigned char *frame_buffer, int x, int y, int height, int colored);
    void DrawRectangle(unsigned char *frame_buffer, int x0, int y0, int x1, int y1, int colored);
    void DrawFilledRectangle(unsigned char *frame_buffer, int x0, int y0, int x1, int y1, int colored);
    void DrawCircle(unsigned char *frame_buffer, int x, int y, int radius, int colored);
    void DrawFilledCircle(unsigned char *frame_buffer, int x, int y, int radius, int colored);
    void DrawCharAt(unsigned char *frame_buffer, int x, int y, char ascii_char, sFONT* font, int colored);
    void DrawStringAt(unsigned char *frame_buffer, int x, int y, const char* text, sFONT* font, int colored);


};

#endif /* EPD1IN54_H */

/* END OF FILE */