Difference between revisions of "Projets:Perso:2013:RaspEink"

Revision as of 21:32, 26 March 2015

Introduction

The aim of the RaspEink project is to drive a small e-Paper display with a Raspberry Pi. Such a display can be used for many purposes, for example to display home automation data as described here: RaspEink FHEM

Hardware

Raspberry Pi Model B or Raspberry Pi 2 Model B
2.7 inch E-Paper display from Embedded Artists

Software Overview

Raspian linux from official source
Modified version of the demo driver to send bitmap to display.

Step 1: Setup the Hardware and test it

Follow the excellent guide "Epaper_RaspberryPi.pdf" from Embedded Artists which can be downloaded from their website: http://www.embeddedartists.com/products/displays/lcd_27_epaper.php

The demo driver used at the time of writing is called epaper_pi_130307.tar.gz

The document describes how to connect the display to the Raspberry, download, compile and run the demo software and driver. The demo software simply loops between two static logos. Once this works, we are ready to...

Step 2: Modify the driver to accept external bitmaps

With the demo software working, it is time to modify the source code to make it load a BMP instead of the static logos. Please note that the modifications described below are only for educational purposes. Try them at your own risk. I assume no responsibility for any damage done by using these modifications nor do I guarantee that the modifications work.

The only modifications to the code were done in main.c.

You can download the modified source file here: raspeink_main.c. Rename it to main.c and replace the original file from Step 1.

Step 3: Compile the modified source code

With the main.c file replaced, we have to compile again as described in the PDF guide from Step 1. Make sure you are in the same directory as main.c and type:

make

Step 4: Use it

Test the new driver by running it without any parameter:

sudo ./epaper

It should display lorem ipsum text on the display, with a thin black border around it.

You can now pass your own BMP as a parameter. The BMP needs to have a width of 264 pixel, a height of 176 pixels and it needs to be monochrome (1 bit per pixel)

sudo ./epaper yourimage.bmp

main.c changes explained

Here is a quick explanation on what the main.c does: First, the following variables are declared:

uint8_t filebuffer[176][36] = {};
uint8_t buffer[176][33] = {};

filebuffer will hold the BMP after it is loaded. buffer will hold the final image.

int readfile(FILE *f) {
	int x,y, width, height, bpp, offset;
	int valid_picture = 1;
	uint8_t header[54];

	fread(&header, 1, 54, f);
	
	width = header[18] | header[19] << 8 | header[20] << 16 | header[21] << 24;
	height =  header[22] | header[23] << 8| header[24] << 16 | header[25] << 24;
	bpp =  header[28]| header[29] << 8;
	offset = header[10] | header[11] << 8 | header[12] << 16 | header[13] << 24;

The readfile function analyzes and reads the bitmap file passed to it. First we read the BMP header to find out the parameters of the BMP. There are several BMP versions and which one is used largely depends on the image manipulation software. The Wikipedia article about the BMP file format gives a nice overview.

We then extract the width, height and bit depth (bpp) using left-shifts since the integer values are stored in little endian format.

The offset is very important. It tells us where in the file the actual pixel data starts. This offset again depends on the specific BMP version used.

	printf("Width: %d\n", width);
	if (width != 264) {
		printf("ERROR: Wrong width of BMP. Needs to be 264 pixels.\n");
		valid_picture = 0;
	}
	printf("Height: %d\n", height);
	if (height != 176) {
		printf("ERROR: Wrong height of BMP. Needs to be 176 pixels.\n");
		valid_picture = 0;
	}
	printf("Bits per pixel: %d\n", bpp);
	if (bpp != 1) {
		printf("ERROR: Wrong bit depth of BMP. Needs to be monochrome (1 bit per pixel).\n");
		valid_picture = 0;
	}
        printf("Data offset of pixel array: %d\n", offset);

This block of code test that the dimensions and bit depth are correct.

       if ( valid_picture == 1) {
        	fseek(f, offset, SEEK_SET);
        	fread(filebuffer, 1, 176*36, f);
        	fclose(f);

        	for(x=0; x<=176; ++x) {
        		for(y=0; y<=33; ++y) {
        			buffer[x][y] = ~filebuffer[175-x][y];
        		}	
        	}
        return 1;
        }
        else return 0;

If the picture is valid, we can start reading it into memory.

With fseek we go to the specific postion in the file where the pixel data starts (offset).

The for loops then simply flip and invert the pixel data and save it into the final buffer.

Difference between revisions of "Projets:Perso:2013:RaspEink"

Revision as of 21:32, 26 March 2015

Contents

Introduction

Hardware

Software Overview

Step 1: Setup the Hardware and test it

Step 2: Modify the driver to accept external bitmaps

Step 3: Compile the modified source code

Step 4: Use it

main.c changes explained

piper.py: Generating BMP

Navigation menu

Views

Personal tools

Menu

Wiki

Search

Tools

@@ Line 59: / Line 59: @@
 Here is a quick explanation on what the main.c does:
-First, the following variables and local function were introduced:
+First, the following variables are declared:
 <pre>
-/******************************************************************************
- * Local Functions
- *****************************************************************************/
 uint8_t filebuffer[176][36] = {};
 uint8_t buffer[176][33] = {};
+</pre>
-void readfile(FILE *f) {
+''filebuffer'' will hold the BMP after it is loaded. ''buffer'' will hold the final image.
-	int x,y;
-    fseek(f, 62, SEEK_SET);
-    fread(filebuffer, 1, 176*36, f);
-    fclose(f);
-	for(x=0; x<=176; ++x) {
+<pre>
-		for(y=0; y<=33; ++y) {
+int readfile(FILE *f) {
-			buffer[x][y] = ~filebuffer[175-x][y];
+	int x,y, width, height, bpp, offset;
-		}
+	int valid_picture = 1;
-	}
+	uint8_t header[54];
-}
+	fread(&header, 1, 54, f);
+	width = header[18] | header[19] << 8 | header[20] << 16 | header[21] << 24;
+	height =  header[22] | header[23] << 8| header[24] << 16 | header[25] << 24;
+	bpp =  header[28]| header[29] << 8;
+	offset = header[10] | header[11] << 8 | header[12] << 16 | header[13] << 24;
 </pre>
-''filebuffer'' will hold the BMP after it is loaded. ''buffer'' will hold the final image. With ''fseek'' we go to a specific postion in the file, more precisely to the start of the actual pixel data. This postion (62 in our case) depends on the version of BMP used. There are several versions and which one is used largely depends on the image manipulation software. The Wikipedia article about the [http://en.wikipedia.org/wiki/BMP_file_format BMP file format] gives a nice overview.
+The ''readfile'' function analyzes and reads the bitmap file passed to it. First we read the BMP header to find out the parameters of the BMP. There are several BMP versions and which one is used largely depends on the image manipulation software. The Wikipedia article about the [http://en.wikipedia.org/wiki/BMP_file_format BMP file format] gives a nice overview.
-For the purpose of this software we are using monochrome BMP (i.e. with 1 bit per pixel). A test bitmap can be downloaded [http://pozor.ch/testimage.bmp here]. Such BMP can be created in GIMP for example by reducing the number of indexed colors to 2. After saving the bitmap, it is a good idea to open it in a Hex editor and verify the offset of the pixel data. This value is stored in position 0x0Ah. If it is not 62 (0x3Eh), you need to adjust this value above. If you don't, the image might show a shift.
+We then extract the ''width'', ''height'' and bit depth (''bpp'') using left-shifts since the integer values are stored in little endian format.
-The software currently does not check whether the BMP format is OK.
+The ''offset'' is very important. It tells us where in the file the actual pixel data starts. This ''offset'' again depends on the specific BMP version used.
-The ''for'' loops then simply flip and invert the pixel data.
-The main method can then be replaced completely by this one:
 <pre>
-/******************************************************************************
+	printf("Width: %d\n", width);
- * Main method
+	if (width != 264) {
- *****************************************************************************/
+		printf("ERROR: Wrong width of BMP. Needs to be 264 pixels.\n");
-int main(int argc, char *argv[])
+		valid_picture = 0;
-{
-  uint8_t* pOldImg;
-  char* path = "";
-  FILE *f = NULL;
-  if(argc == 1) {
-	path = "testimage.bmp";
-	printf("No file specified, loading testimage.bmp\n");
-	f = fopen(path, "rb");
-  }
-  if(argc == 2) {
-	path = argv[1];
-	printf("Loading %s\n", path);
-	f = fopen(path, "rb");
-	if(f == NULL) {
-	  printf("File not found, loading testimage.bmp\n");
-	  path = "testimage.bmp";
-	  f = fopen(path, "rb");
 	}
+	printf("Height: %d\n", height);
-  }
+	if (height != 176) {
+		printf("ERROR: Wrong height of BMP. Needs to be 176 pixels.\n");
+		valid_picture = 0;
+	}
+	printf("Bits per pixel: %d\n", bpp);
+	if (bpp != 1) {
+		printf("ERROR: Wrong bit depth of BMP. Needs to be monochrome (1 bit per pixel).\n");
+		valid_picture = 0;
+	}
+        printf("Data offset of pixel array: %d\n", offset);
+</pre>
+This block of code test that the dimensions and bit depth are correct.
-  bsp_init();
-  readfile(f);
-  memset((uint8_t*)&PreloadImage[0][0], 0xff, 176*33);
+<pre>
-  pOldImg = (uint8_t*)&PreloadImage[0][0];
+       if ( valid_picture == 1) {
+        	fseek(f, offset, SEEK_SET);
+        	fread(filebuffer, 1, 176*36, f);
+        	fclose(f);
+        	for(x=0; x<=176; ++x) {
-    printf("Sending Image...\n");
+        		for(y=0; y<=33; ++y) {
-    epd_DisplayImg(DISPLAY_IN_USE, (uint8_t*)&buffer[0][0], pOldImg);
+        			buffer[x][y] = ~filebuffer[175-x][y];
-    pOldImg = (uint8_t*)&buffer[0][0];
+        		}
+        	}
+        return 1;
-  printf("Done.\n");
+        }
-  return 1;
+        else return 0;
-}
 </pre>
-== Step 3:
+If the picture is valid, we can start reading it into memory.
-The functions above simply load the file after doing some basic error checks. If no file is mentioned as a parameter or the file is not found, a test bitmap is loaded (the bitmap can be downloaded [http://pozor.ch/raspeink/testimage.bmp here]).
-If all compiles well, you can use the software now to load your own bitmap:
+With ''fseek'' we go to the specific postion in the file where the pixel data starts (''offset'').
-<pre>sudo ./epaper yourbitmap.bmp</pre>
+The ''for'' loops then simply flip and invert the pixel data and save it into the final ''buffer''.
 == piper.py: Generating BMP ==