il3820.h

Go to the documentation of this file.

/*
 * @file il3820.h
 *
 * @author Matthew Matz & Roy Eltham
 *
 * @version 0.5
 *
 * @copyright Copyright (C) Parallax, Inc. 2018.  See end of file for
 * terms of use (MIT License).
 *
 * @brief This is a driver that allows the Propeller Multicore Microcontroller to
 * draw text, shapes, and bitmap files on the Waveshare ePaper display.
 *
 * @detail This driver must be used with simplegfx.h.  When used with the simplegfx
 * library, it allows the Propeller Multicore Microcontroller tondraw pixels, 
 * lines, circles, recatngles, rounded rectagles, triangles, formatted text in
 * multiple fonts, and bitmap images stored on an SD card on a WaveShare ePaper
 * screen.  Please submit bug reports, suggestions, and improvements to this code 
 * to editor@parallax.com.
 */

#ifndef IL3820_H                              // Prevents duplicate
#define IL3820_H                              // declarations

#if defined(__cplusplus)                      // If compiling for C++
extern "C" {                                  // Compile for C
#endif


#include "simpletools.h"
#include "simplegfx.h"


// il3820 ePaper colors
#ifndef BLACK
  #define BLACK           0
#endif

#ifndef WHITE
  #define WHITE           1
#endif

#ifndef INVERSE
  #define INVERSE         2
#endif


// il3820 commands
#ifndef IL3820_DRIVER_OUTPUT
  #define IL3820_DRIVER_OUTPUT                               0x01
#endif

#ifndef IL3820_BOOSTER_SOFT_START
  #define IL3820_BOOSTER_SOFT_START                          0x0C
#endif

#ifndef IL3820_GATE_SCAN_START
  #define IL3820_GATE_SCAN_START                             0x0F
#endif

#ifndef IL3820_DEEP_SLEEP_MODE
  #define IL3820_DEEP_SLEEP_MODE                             0x10
#endif

#ifndef IL3820_DATA_ENTRY_MODE
  #define IL3820_DATA_ENTRY_MODE                             0x11
#endif

#ifndef IL3820_SW_RESET
  #define IL3820_SW_RESET                                    0x12
#endif

#ifndef IL3820_TEMPERATURE_SENSOR
  #define IL3820_TEMPERATURE_SENSOR                          0x1A
#endif

#ifndef IL3820_MASTER_ACTIVATION
  #define IL3820_MASTER_ACTIVATION                           0x20
#endif

#ifndef IL3820_DISPLAY_UPDATE_1
  #define IL3820_DISPLAY_UPDATE_1                            0x21
#endif

#ifndef IL3820_DISPLAY_UPDATE_2
  #define IL3820_DISPLAY_UPDATE_2                            0x22
#endif

#ifndef IL3820_WRITE_RAM
  #define IL3820_WRITE_RAM                                   0x24
#endif

#ifndef IL3820_WRITE_VCOM_REGISTER
  #define IL3820_WRITE_VCOM_REGISTER                         0x2C
#endif

#ifndef IL3820_WRITE_LUT_REGISTER
  #define IL3820_WRITE_LUT_REGISTER                          0x32
#endif

#ifndef IL3820_SET_DUMMY_LINE_PERIOD
  #define IL3820_SET_DUMMY_LINE_PERIOD                       0x3A
#endif

#ifndef IL3820_SET_GATE_TIME
  #define IL3820_SET_GATE_TIME                               0x3B
#endif

#ifndef IL3820_BORDER_WAVEFORM_CONTROL
  #define IL3820_BORDER_WAVEFORM_CONTROL                     0x3C
#endif

#ifndef IL3820_SET_RAM_X_ADDRESS_POSITION
  #define IL3820_SET_RAM_X_ADDRESS_POSITION                  0x44
#endif

#ifndef IL3820_SET_RAM_Y_ADDRESS_POSITION
  #define IL3820_SET_RAM_Y_ADDRESS_POSITION                  0x45
#endif

#ifndef IL3820_SET_RAM_X_ADDRESS_COUNTER
  #define IL3820_SET_RAM_X_ADDRESS_COUNTER                   0x4E
#endif

#ifndef IL3820_SET_RAM_Y_ADDRESS_COUNTER
  #define IL3820_SET_RAM_Y_ADDRESS_COUNTER                   0x4F
#endif

#ifndef IL3820_TERMINATE_FRAME_READ_WRITE
  #define IL3820_TERMINATE_FRAME_READ_WRITE                  0xFF
#endif



screen_t *il3820_init(char sid, char sclk, char cs, char rs, char rst, char busy, int width, int height);

void il3820_sleepDisplay(screen_t *dev);

void il3820_wakeDisplay(screen_t *dev);



void il3820_spiWrite(int mask_cs, int mask_sdi, int mask_clk, int mask_dc, char c, char dc);

void il3820_spiWriteBytes(int mask_cs, int mask_sdi, int mask_clk, const unsigned char* data, int numBytes);


char il3820_writeLock();

void il3820_writeLockSet(char devId);

void il3820_writeLockClear(char devId);


void il3820_drawPixel(screen_t *dev, int x, int y, int color);

void il3820_drawFastHLine(screen_t *dev, int x0, int x1, int y, int color);

void il3820_drawFastVLine(screen_t *dev, int y0, int y1, int x, int color);


void il3820_clearDisplay(screen_t *dev);


void il3820_updateDisplay(screen_t *dev);

void il3820_resetDisplay(screen_t *dev);



#if defined(__cplusplus)
}                                             // End compile for C block
#endif
/* __cplusplus */

#endif                                        // End prevent duplicate forward
/* IL3820_H */                                   // declarations block