EmbeddedArtists AB / EM027BS013

Library to control the EM027BS013 ePaper display from Pervasive Display.

Dependencies:   LM75B

Dependents:   app_epaper_EM027BS013_LPC1549 lpc4088_ebb_epaper EaEpaper_EM027BS013 app_epaper_EM027BS013 ... more

Embed: (wiki syntax)

« Back to documentation index

EPD_COG_process.h File Reference
Data Structures | Enumerations | Functions

EPD_COG_process.h File Reference

The definition of COG driving data and process. More...

Go to the source code of this file.

Data Structures

struct  COG_144_line_data_t
 Line data structure of 1.44 inch EPD. More...
struct  COG_200_line_data_t
 Line data structure of 2 inch EPD. More...
struct  COG_270_line_data_t
 Line data structure of 2.7 inch EPD. More...
struct  COG_144_line_data_t
 Line data structure of 1.44 inch EPD. More...
struct  COG_200_line_data_t
 Line data structure of 2 inch EPD. More...
struct  COG_270_line_data_t
 Line data structure of 2.7 inch EPD. More...
struct  EPD_WaveformTable_Struct
 Define waveform stages for V230 EPD with G2 COG. More...
struct  EPD_V230_G2_Struct
 Define the Block type waveform structure. More...
union  COG_line_data_packet_type
 Packet structure of a line data. More...
struct  COG_parameters_t
 Define the COG driver's parameters. More...

Enumerations

enum  Stage { Stage1, Stage2, Stage3, Stage4 }
 

Four driving stages.

More...

Functions

void EPD_init (void)
 Initialize the EPD hardware setting.
void EPD_power_on (void)
 Power on COG Driver.
uint8_t EPD_initialize_driver (uint8_t EPD_type_index)
 Initialize COG Driver.
void EPD_display_from_array_prt (uint8_t EPD_type_index, uint8_t *previous_image_ptr, uint8_t *new_image_ptr)
 Write image data from memory array (image_data.h) to the EPD.
void EPD_display_from_flash_prt (uint8_t EPD_type_index, long previous_image_flash_address, long new_image_flash_address, EPD_read_flash_handler On_EPD_read_flash)
 Write image data from Flash memory to the EPD.
uint8_t EPD_power_off (uint8_t EPD_type_index)
 Power Off COG Driver.
void COG_driver_EPDtype_select (uint8_t EPD_type_index)
 Select the EPD size to get line data array for driving COG.

Detailed Description

The definition of COG driving data and process.

Copyright (c) 2012-2014 Pervasive Displays Inc. All rights reserved.

Authors: Pervasive Displays Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file EPD_COG_process.h.

Enumeration Type Documentation

enum Stage

Four driving stages.

Enumerator:
Stage1 

Inverse previous image.

Stage2 

White.

Stage3 

Inverse new image.

Stage4 

New image.

Definition at line 77 of file EPD_COG_process.h.

Function Documentation

void COG_driver_EPDtype_select ( uint8_t  EPD_type_index )

Select the EPD size to get line data array for driving COG.

Parameters:
EPD_type_indexThe defined EPD size

Definition at line 240 of file EPD_COG_process_v230_G2.cpp.

void EPD_display_from_array_prt ( uint8_t  EPD_type_index,
uint8_t *  previous_image_ptr,
uint8_t *  new_image_ptr 
)

Write image data from memory array (image_data.h) to the EPD.

Parameters:
EPD_type_indexThe defined EPD size
previous_image_ptrThe pointer of memory that stores previous image
new_image_ptrThe pointer of memory that stores new image

Definition at line 690 of file EPD_COG_process_v230_G2.cpp.

void EPD_display_from_flash_prt ( uint8_t  EPD_type_index,
long  previous_image_flash_address,
long  new_image_flash_address,
EPD_read_flash_handler  On_EPD_read_flash 
)

Write image data from Flash memory to the EPD.

Note:
This function is additional added here for developer if the image data is stored in Flash.
Parameters:
EPD_type_indexThe defined EPD size
previous_image_flash_addressThe start address of memory that stores previous image
new_image_flash_addressThe start address of memory that stores new image
On_EPD_read_flashDeveloper needs to create an external function to read flash

Definition at line 708 of file EPD_COG_process_v230_G2.cpp.

void EPD_init ( void   )

Initialize the EPD hardware setting.

Definition at line 227 of file EPD_COG_process_v230_G2.cpp.

uint8_t EPD_initialize_driver ( uint8_t  EPD_type_index )

Initialize COG Driver.

Note:
For detailed flow and description, please refer to the COG G2 document Section 4.
Parameters:
EPD_type_indexThe defined EPD size

Definition at line 287 of file EPD_COG_process_v230_G2.cpp.

uint8_t EPD_power_off ( uint8_t  EPD_type_index )

Power Off COG Driver.

Note:
For detailed flow and description, please refer to the COG G2 document Section 6.
Parameters:
EPD_type_indexThe defined EPD size

Definition at line 794 of file EPD_COG_process_v230_G2.cpp.

void EPD_power_on ( void   )

Power on COG Driver.

Note:
For detailed flow and description, please refer to the COG G2 document Section 3.

Definition at line 267 of file EPD_COG_process_v230_G2.cpp.

Generated on Thu Jul 14 2022 17:10:35 by  doxygen 1.7.2