eink154inch.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * 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 furnished 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 FOR 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 EINK154INCH_H
#define EINK154INCH_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define EINK154INCH_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.dc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.bsy = MIKROBUS( mikrobus, MIKROBUS_INT )
#define EINK154INCH_OK                                              0
#define EINK154INCH_ERROR                                          -1
#define EINK154INCH_DISPLAY_WIDTH                                   200
#define EINK154INCH_DISPLAY_HEIGHT                                  200
#define EINK154INCH_DISPLAY_RESOLUTIONS                             5000
#define EINK154INCH_COMMUNICATION_SPI                               0
#define EINK154INCH_COMMUNICATION_I2C                               1
#define EINK154INCH_SCREEN_COLOR_WHITE                              0xFF
#define EINK154INCH_SCREEN_COLOR_BLACK                              0x00
#define EINK154INCH_SCREEN_COLOR_LIGHT_GREY                         0xAA
#define EINK154INCH_SCREEN_COLOR_DARK_GREY                          0x55
 
#define EINK154INCH_FO_HORIZONTAL                                   0x00
#define EINK154INCH_FO_VERTICAL                                     0x01
#define EINK154INCH_FO_VERTICAL_COLUMN                              0x02
#define EINK154INCH_CMD_DRIVER_OUTPUT_CONTROL                       0x01
#define EINK154INCH_CMD_BOOSTER_SOFT_START_CONTROL                  0x0C
#define EINK154INCH_CMD_GATE_SCAN_START_POSITION                    0x0F
#define EINK154INCH_CMD_DEEP_SLEEP_MODE                             0x10
#define EINK154INCH_CMD_DATA_ENTRY_MODE_SETTING                     0x11
#define EINK154INCH_CMD_SW_RESET                                    0x12
#define EINK154INCH_CMD_TEMPERATURE_SENSOR_CONTROL                  0x1A
#define EINK154INCH_CMD_MASTER_ACTIVATION                           0x20
#define EINK154INCH_CMD_DISPLAY_UPDATE_CONTROL_1                    0x21
#define EINK154INCH_CMD_DISPLAY_UPDATE_CONTROL_2                    0x22
#define EINK154INCH_CMD_WRITE_RAM                                   0x24
#define EINK154INCH_CMD_WRITE_VCOM_REGISTER                         0x2C
#define EINK154INCH_CMD_WRITE_LUT_REGISTER                          0x32
#define EINK154INCH_CMD_SET_DUMMY_LINE_PERIOD                       0x3A
#define EINK154INCH_CMD_SET_GATE_TIME                               0x3B
#define EINK154INCH_CMD_BORDER_WAVEFORM_CONTROL                     0x3C
#define EINK154INCH_CMD_SET_RAM_X_ADDRESS_START_END_POSITION        0x44
#define EINK154INCH_CMD_SET_RAM_Y_ADDRESS_START_END_POSITION        0x45
#define EINK154INCH_CMD_SET_RAM_X_ADDRESS_COUNTER                   0x4E
#define EINK154INCH_CMD_SET_RAM_Y_ADDRESS_COUNTER                   0x4F
#define EINK154INCH_CMD_TERMINATE_FRAME_READ_WRITE                  0xFF
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_000                        0x28
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_001                        0x29
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_010                        0x2A
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_011                        0x2B
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_100                        0x2C
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_101                        0x2D 
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_110                        0x2E
#define EINK154INCH_DEVICE_SLAVE_ADDRESS_111                        0x2F
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    const uint8_t *p_font;
    uint16_t      color;
    uint8_t       orientation;
    uint16_t      first_char;
    uint16_t      last_char;
    uint16_t      height;
 
} eink154inch_font_t;
 
typedef struct
{
  uint16_t x;
  uint16_t y;
 
} eink154inch_cordinate_t;
 
typedef struct 
{
    uint8_t x_start;
    uint8_t y_start; 
    uint8_t x_end;
    uint8_t y_end;
    
} eink154inch_xy_t;
 
typedef struct 
{
    uint8_t text_x;
    uint8_t text_y;
    uint8_t n_char;
 
} eink154inch_text_set_t;
 
typedef struct
{
    // Output pins 
    digital_out_t cs;
    digital_out_t rst;
    digital_out_t dc;
 
    // Input pins 
    digital_in_t bsy;
    
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
    
    eink154inch_font_t dev_font;
    eink154inch_cordinate_t dev_cord;
#ifndef IMAGE_MODE_ONLY
    uint8_t p_frame[5000];
#endif
} eink154inch_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
    pin_name_t rst;
    pin_name_t dc;
    pin_name_t bsy;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
    
    eink154inch_font_t font_cfg;
 
} eink154inch_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void eink154inch_cfg_setup ( eink154inch_cfg_t *cfg );
 
err_t eink154inch_init ( eink154inch_t *ctx, eink154inch_cfg_t *cfg );
 
void eink154inch_send_cmd ( eink154inch_t *ctx, uint8_t command );
 
void eink154inch_send_data ( eink154inch_t *ctx, uint8_t c_data );
 
void eink154inch_reset( eink154inch_t *ctx );
 
void eink154inch_sleep_mode ( eink154inch_t *ctx );
 
void eink154inch_start_config ( eink154inch_t *ctx );
 
void eink154inch_set_lut ( eink154inch_t *ctx, const uint8_t *lut, uint8_t n_bytes );
 
void eink154inch_set_mem_pointer ( eink154inch_t *ctx, uint8_t x, uint8_t y );
 
void eink154inch_set_mem_area ( eink154inch_t *ctx, eink154inch_xy_t *xy );
 
void eink154inch_update_display ( eink154inch_t *ctx );
 
void eink154inch_fill_screen ( eink154inch_t *ctx, uint8_t color );
 
void eink154inch_image ( eink154inch_t *ctx, const uint8_t* image_buffer );
 
void eink154inch_text ( eink154inch_t *ctx, char *text, eink154inch_text_set_t *text_set );
 
void eink154inch_set_font ( eink154inch_t *ctx, eink154inch_font_t *cfg_font );
 
#ifdef __cplusplus
}
#endif
#endif  // _EINK154INCH_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END