├── converter ├── x86 │ ├── convert_all_gif.cmd │ ├── sample1.gif │ ├── sample2.gif │ └── converter.exe └── converter.cpp ├── ssop16.jpg ├── eframe1.jpg ├── eframe2.jpg ├── insides.jpg ├── circuit_pwr.jpg ├── ssop16_and_chip.jpg ├── ssop16_assembled.jpg ├── enclosure ├── e-Frame v12.f3d ├── eframe_back.stl ├── eframe_misc.stl ├── eframe_front.stl └── eframe_stand.stl ├── epaper7c ├── epdif.h ├── epdif.cpp ├── epd5in65f.h ├── epaper7c.ino └── epd5in65f.cpp ├── README.md └── LICENSE /converter/x86/convert_all_gif.cmd: -------------------------------------------------------------------------------- 1 | for %%i in (*.gif) do converter.exe %%i %%i.bim -------------------------------------------------------------------------------- /ssop16.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/ssop16.jpg -------------------------------------------------------------------------------- /eframe1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/eframe1.jpg -------------------------------------------------------------------------------- /eframe2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/eframe2.jpg -------------------------------------------------------------------------------- /insides.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/insides.jpg -------------------------------------------------------------------------------- /circuit_pwr.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/circuit_pwr.jpg -------------------------------------------------------------------------------- /ssop16_and_chip.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/ssop16_and_chip.jpg -------------------------------------------------------------------------------- /ssop16_assembled.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/ssop16_assembled.jpg -------------------------------------------------------------------------------- /converter/x86/sample1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/converter/x86/sample1.gif -------------------------------------------------------------------------------- /converter/x86/sample2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/converter/x86/sample2.gif -------------------------------------------------------------------------------- /enclosure/e-Frame v12.f3d: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/enclosure/e-Frame v12.f3d -------------------------------------------------------------------------------- /enclosure/eframe_back.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/enclosure/eframe_back.stl -------------------------------------------------------------------------------- /enclosure/eframe_misc.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/enclosure/eframe_misc.stl -------------------------------------------------------------------------------- /converter/x86/converter.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/converter/x86/converter.exe -------------------------------------------------------------------------------- /enclosure/eframe_front.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/enclosure/eframe_front.stl -------------------------------------------------------------------------------- /enclosure/eframe_stand.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geoavia/E-Paper-Photo-Frame/HEAD/enclosure/eframe_stand.stl -------------------------------------------------------------------------------- /epaper7c/epdif.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @filename : epdif.h 3 | * @brief : Header file of epdif.cpp providing EPD interface functions 4 | * Users have to implement all the functions in epdif.cpp 5 | * @author : Yehui from Waveshare 6 | * 7 | * Copyright (C) Waveshare August 10 2017 8 | * 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy 10 | * of this software and associated documnetation files (the "Software"), to deal 11 | * in the Software without restriction, including without limitation the rights 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 13 | * copies of the Software, and to permit persons to whom the Software is 14 | * furished to do so, subject to the following conditions: 15 | * 16 | * The above copyright notice and this permission notice shall be included in 17 | * all copies or substantial portions of the Software. 18 | * 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 | * FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 23 | * LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 25 | * THE SOFTWARE. 26 | */ 27 | 28 | #ifndef EPDIF_H 29 | #define EPDIF_H 30 | 31 | #include 32 | 33 | // Pin definition 34 | #define RST_PIN 8 35 | #define DC_PIN 9 36 | #define CS_PIN 10 37 | #define BUSY_PIN 7 38 | 39 | class EpdIf { 40 | public: 41 | EpdIf(void); 42 | ~EpdIf(void); 43 | 44 | static int IfInit(void); 45 | static void DigitalWrite(int pin, int value); 46 | static int DigitalRead(int pin); 47 | static void DelayMs(unsigned int delaytime); 48 | static void SpiTransfer(unsigned char data); 49 | }; 50 | 51 | #endif 52 | -------------------------------------------------------------------------------- /converter/converter.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | #define STB_IMAGE_IMPLEMENTATION 6 | #include "stb_image.h" 7 | 8 | uint8_t palette[8 * 3] = { 9 | 0, 0, 0, 10 | 255, 255, 255, 11 | 67, 138, 28, 12 | 100, 64, 255, 13 | 191, 0, 0, 14 | 255, 243, 56, 15 | 232, 126, 0, 16 | 194 ,164 , 244 17 | }; 18 | 19 | int depalette(uint8_t* color) 20 | { 21 | int p; 22 | int mindiff = 100000000; 23 | int bestc = 0; 24 | for (p = 0; p < sizeof(palette) / 3; p++) 25 | { 26 | int diffr = ((int)color[0]) - ((int)palette[p * 3 + 0]); 27 | int diffg = ((int)color[1]) - ((int)palette[p * 3 + 1]); 28 | int diffb = ((int)color[2]) - ((int)palette[p * 3 + 2]); 29 | int diff = (diffr * diffr) + (diffg * diffg) + (diffb * diffb); 30 | if (diff < mindiff) 31 | { 32 | mindiff = diff; 33 | bestc = p; 34 | } 35 | } 36 | return bestc; 37 | } 38 | 39 | 40 | int main(int argc, char** argv) 41 | { 42 | if (argc < 3) 43 | { 44 | fprintf(stderr, "Usage: converter [image file] [out file]\n"); 45 | return -1; 46 | } 47 | 48 | int x, y, n; 49 | unsigned char* data = stbi_load(argv[1], &x, &y, &n, 0); 50 | if (!data) 51 | { 52 | fprintf(stderr, "Error: Can't open image.\n"); 53 | return -6; 54 | } 55 | if (x != 600) 56 | { 57 | fprintf(stderr, "Error: Image dimensions must be 600 x ??.\n"); 58 | return -2; 59 | } 60 | if (y > 448) 61 | { 62 | y = 448; 63 | } 64 | 65 | int i, j; 66 | FILE* fout = fopen(argv[2], "wb"); 67 | 68 | //fprintf(fout, "const unsigned char gImage[%d] PROGMEM = { ", x*y/2); 69 | 70 | for (j = 0; j < y; j++) 71 | { 72 | for (i = 0; i < x / 2; i++) 73 | { 74 | int c1 = depalette(data + n * (i * 2 + x * j)); 75 | int c2 = depalette(data + n * (i * 2 + x * j + 1)); 76 | uint8_t uc = c2 | (c1 << 4); 77 | 78 | //fprintf(fout, "%s%s0x%02x", (j|i ? "," : ""), (i ? " " : "\n"), uc); 79 | fputc(uc, fout); 80 | 81 | } 82 | } 83 | 84 | //fprintf(fout, " };\n"); 85 | 86 | fclose(fout); 87 | 88 | stbi_image_free(data); 89 | } 90 | 91 | 92 | 93 | -------------------------------------------------------------------------------- /epaper7c/epdif.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @filename : epdif.cpp 3 | * @brief : Implements EPD interface functions 4 | * Users have to implement all the functions in epdif.cpp 5 | * @author : Yehui from Waveshare 6 | * 7 | * Copyright (C) Waveshare August 10 2017 8 | * 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy 10 | * of this software and associated documnetation files (the "Software"), to deal 11 | * in the Software without restriction, including without limitation the rights 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 13 | * copies of the Software, and to permit persons to whom the Software is 14 | * furished to do so, subject to the following conditions: 15 | * 16 | * The above copyright notice and this permission notice shall be included in 17 | * all copies or substantial portions of the Software. 18 | * 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 | * FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 23 | * LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 25 | * THE SOFTWARE. 26 | */ 27 | 28 | #include "epdif.h" 29 | #include 30 | 31 | EpdIf::EpdIf() { 32 | }; 33 | 34 | EpdIf::~EpdIf() { 35 | }; 36 | 37 | void EpdIf::DigitalWrite(int pin, int value) { 38 | digitalWrite(pin, value); 39 | } 40 | 41 | int EpdIf::DigitalRead(int pin) { 42 | return digitalRead(pin); 43 | } 44 | 45 | void EpdIf::DelayMs(unsigned int delaytime) { 46 | delay(delaytime); 47 | } 48 | 49 | void EpdIf::SpiTransfer(unsigned char data) { 50 | digitalWrite(CS_PIN, LOW); 51 | SPI.transfer(data); 52 | digitalWrite(CS_PIN, HIGH); 53 | } 54 | 55 | int EpdIf::IfInit(void) { 56 | pinMode(CS_PIN, OUTPUT); 57 | pinMode(RST_PIN, OUTPUT); 58 | pinMode(DC_PIN, OUTPUT); 59 | pinMode(BUSY_PIN, INPUT); 60 | SPI.begin(); 61 | SPI.beginTransaction(SPISettings(2000000, MSBFIRST, SPI_MODE0)); 62 | 63 | return 0; 64 | } 65 | 66 | -------------------------------------------------------------------------------- /epaper7c/epd5in65f.h: -------------------------------------------------------------------------------- 1 | /***************************************************************************** 2 | * | File : EPD_5in65f.h 3 | * | Author : Waveshare team 4 | * | Function : 5.65inch e-paper 5 | * | Info : 6 | *---------------- 7 | * | This version: V1.0 8 | * | Date : 2020-07-08 9 | * | Info : 10 | * ----------------------------------------------------------------------------- 11 | # 12 | # Permission is hereby granted, free of charge, to any person obtaining a copy 13 | # of this software and associated documnetation files (the "Software"), to deal 14 | # in the Software without restriction, including without limitation the rights 15 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 16 | # copies of the Software, and to permit persons to whom the Software is 17 | # furished to do so, subject to the following conditions: 18 | # 19 | # The above copyright notice and this permission notice shall be included in 20 | # all copies or substantial portions of the Software. 21 | # 22 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 23 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 24 | # FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 25 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 26 | # LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 27 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 28 | # THE SOFTWARE. 29 | # 30 | ******************************************************************************/ 31 | 32 | #ifndef __EPD_5IN65F_H__ 33 | #define __EPD_5IN65F_H__ 34 | 35 | #include "epdif.h" 36 | 37 | // Display resolution 38 | #define EPD_WIDTH 600 39 | #define EPD_HEIGHT 448 40 | 41 | #define UWORD unsigned int 42 | #define UBYTE unsigned char 43 | #define UDOUBLE unsigned long 44 | 45 | /********************************** 46 | Color Index 47 | **********************************/ 48 | #define EPD_5IN65F_BLACK 0x0 /// 000 49 | #define EPD_5IN65F_WHITE 0x1 /// 001 50 | #define EPD_5IN65F_GREEN 0x2 /// 010 51 | #define EPD_5IN65F_BLUE 0x3 /// 011 52 | #define EPD_5IN65F_RED 0x4 /// 100 53 | #define EPD_5IN65F_YELLOW 0x5 /// 101 54 | #define EPD_5IN65F_ORANGE 0x6 /// 110 55 | #define EPD_5IN65F_CLEAN 0x7 /// 111 unavailable Afterimage 56 | 57 | class Epd : EpdIf { 58 | public: 59 | Epd(); 60 | ~Epd(); 61 | int Init(void); 62 | void EPD_5IN65F_BusyHigh(void); 63 | void EPD_5IN65F_BusyLow(void); 64 | void Reset(void); 65 | void EPD_5IN65F_Display(const UBYTE *image); 66 | void EPD_5IN65F_Display_part(const UBYTE *image, UWORD xstart, UWORD ystart, 67 | UWORD image_width, UWORD image_heigh); 68 | void SendCommand(unsigned char command); 69 | void SendData(unsigned char data); 70 | void Sleep(void); 71 | void Clear(UBYTE color); 72 | 73 | private: 74 | unsigned int reset_pin; 75 | unsigned int dc_pin; 76 | unsigned int cs_pin; 77 | unsigned int busy_pin; 78 | unsigned long width; 79 | unsigned long height; 80 | }; 81 | 82 | #endif /* EPD5IN83B_HD_H */ 83 | 84 | /* END OF FILE */ 85 | -------------------------------------------------------------------------------- /epaper7c/epaper7c.ino: -------------------------------------------------------------------------------- 1 | /** 2 | @filename : EPD_5in65f.ino 3 | @brief : EPD_5in65 e-paper Photo Viewer 4 | @author : George Gochaleishvili 5 | */ 6 | 7 | #include 8 | #include 9 | #include "epd5in65f.h" 10 | 11 | #define LOG_NAME "/log.inc" 12 | #define MAX_NAME 32 13 | 14 | // Shut down activate pin 15 | const int shutDownPin = 2; 16 | 17 | void setup() { 18 | 19 | pinMode(shutDownPin, OUTPUT); 20 | digitalWrite(shutDownPin, HIGH); // prevent power off timer 21 | 22 | // put your setup code here, to run once: 23 | Serial.begin(9600); 24 | 25 | Serial.print("Initializing SD card..."); 26 | if (!SD.begin(4)) { 27 | Serial.println("failed!"); 28 | return; 29 | } 30 | Serial.println("done."); 31 | 32 | char imgFileName[MAX_NAME]; 33 | int imgFileCount = 0; 34 | unsigned long logSize = 0; 35 | int curIndex = 0; 36 | 37 | memset(imgFileName, 0, MAX_NAME); 38 | 39 | File logFile = SD.open(LOG_NAME, FILE_WRITE); 40 | if (logFile) { 41 | logSize = logFile.size(); 42 | Serial.print("Log size: "); 43 | Serial.println(logSize); 44 | logFile.write('.'); 45 | logFile.close(); 46 | } 47 | 48 | NextFileName(logSize, imgFileName); 49 | 50 | File imgFile = SD.open(imgFileName, FILE_READ); 51 | if (imgFile) { 52 | unsigned long fs = imgFile.size(); 53 | Serial.print("Show image: "); 54 | Serial.print(imgFileName); 55 | Serial.print(" ("); 56 | Serial.print(fs); 57 | Serial.println(" bytes)..."); 58 | 59 | int x = 0; 60 | int y = 0; 61 | UBYTE bp; 62 | 63 | ///////////////////////////////////////////// 64 | // start e-Paper code 65 | 66 | Epd epd; 67 | if (epd.Init() == 0) { 68 | Serial.println("e-Paper: init ok"); 69 | 70 | epd.Clear(EPD_5IN65F_WHITE); 71 | Serial.println("e-Paper: clear"); 72 | 73 | epd.SendCommand(0x61);//Set Resolution setting 74 | epd.SendData(0x02); 75 | epd.SendData(0x58); 76 | epd.SendData(0x01); 77 | epd.SendData(0xC0); 78 | epd.SendCommand(0x10); 79 | 80 | while (imgFile.available()) { 81 | bp = imgFile.read(); 82 | epd.SendData(bp); 83 | x++; 84 | if (x == 300) { 85 | y++; 86 | x = 0; 87 | } 88 | } 89 | 90 | epd.SendCommand(0x04);//0x04 91 | epd.EPD_5IN65F_BusyHigh(); 92 | epd.SendCommand(0x12);//0x12 93 | epd.EPD_5IN65F_BusyHigh(); 94 | epd.SendCommand(0x02); //0x02 95 | epd.EPD_5IN65F_BusyLow(); 96 | 97 | Serial.println("e-Paper: image sent"); 98 | 99 | epd.Sleep(); 100 | Serial.println("e-Paper: sleep"); 101 | 102 | // end e-Paper code 103 | ///////////////////////////////////////////// 104 | } else { 105 | Serial.println("e-Paper: init failed!"); 106 | } 107 | 108 | imgFile.close(); 109 | } else { 110 | Serial.print("error opening image file: "); 111 | Serial.println(imgFileName); 112 | return; 113 | } 114 | 115 | Serial.println("Complete"); 116 | delay(2000); 117 | } 118 | 119 | void loop() { 120 | delay(5000); 121 | digitalWrite(shutDownPin, LOW); // power off circuit 122 | } 123 | 124 | void NextFileName(unsigned long logSize, char *fname) { 125 | int count = 0; 126 | File dir = SD.open("/"); 127 | File file; 128 | while (file = dir.openNextFile()) { 129 | if (file.isDirectory() || file.size() != 134400) { 130 | file.close(); 131 | continue; 132 | } 133 | Serial.println(file.name()); 134 | file.close(); 135 | count++; 136 | } 137 | Serial.print("Total images: "); 138 | Serial.println(count); 139 | dir.rewindDirectory(); 140 | logSize = logSize % count; 141 | count = 0; 142 | while (file = dir.openNextFile()) { 143 | if (file.isDirectory() || file.size() != 134400) { 144 | file.close(); 145 | continue; 146 | } 147 | if (logSize == count) { 148 | strcpy(fname, file.name()); 149 | } 150 | file.close(); 151 | count++; 152 | } 153 | Serial.print("Current index: "); 154 | Serial.println(logSize); 155 | dir.close(); 156 | } 157 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 7 color e-Paper Photo Frame 2 | 3 | ![eFrame](https://github.com/geoavia/E-Paper-Photo-Frame/blob/main/eframe2.jpg) 4 | 5 | Video of finished device: https://youtu.be/H_CAdMDsyxA 6 | 7 | ### Components used 8 | 9 | * [Arduino Nano compatible board](https://www.amazon.com/dp/B07G99NNXL) 10 | * [7 colour e-paper display panel](https://www.waveshare.com/product/displays/e-paper/epaper-1/5.65inch-e-paper-module-f.htm) 11 | * [Micro SD card board](https://www.amazon.com/gp/product/B07BJ2P6X6) 12 | * Resistors (100k x 2, 100 ohm, 1k) 13 | * Integral circuit SI4542DY or similar (two mosfets in package). 14 | * One LED, color of your preferance :) 15 | * Single push button momentary switch 16 | * 7v-12v battery pack 17 | 18 | ### e-Paper display connection 19 | According to [waveshare wiki](https://www.waveshare.com/wiki/5.65inch_e-Paper_Module_(F)):
20 | e-Paper display | Arduino 21 | ------------ | ------------- 22 | Vcc | 5V 23 | GND | GND 24 | DIN | D11 25 | CLK | D13 26 | CS | D10 27 | DC | D9 28 | RST | D8 29 | BUSY | D7 30 | 31 | ### SD Card board connection 32 | SD card reader | Arduino 33 | ------------ | ------------- 34 | GND | GND 35 | Vcc | 5V 36 | MISO | D12 37 | MOSI | D11 38 | SCK | D13 39 | CS | D4 40 | 41 | ### Power off circuit 42 | Power off circuit based on [Indrek Luuk's article](https://circuitjournal.com/arduino-auto-power-off), but using single [SI4542DY IC](https://www.onsemi.com/pdf/datasheet/si4542dy-d.pdf) containing two (N and P channel) mosfets.
43 | ![Power off](https://github.com/geoavia/E-Paper-Photo-Frame/blob/main/circuit_pwr.jpg)

44 | I have utilized the [TSSOP16](https://www.amazon.com/dp/B00O9W6RLQ) adapter board (although any similar board will do).
45 | * [Adapter board and SI4542DY](https://github.com/geoavia/E-Paper-Photo-Frame/blob/main/ssop16_and_chip.jpg) 46 | * [Circuit sheme on adapter board](https://github.com/geoavia/E-Paper-Photo-Frame/blob/main/ssop16.jpg) 47 | * [Assembled power off circuit board](https://github.com/geoavia/E-Paper-Photo-Frame/blob/main/ssop16_assembled.jpg) 48 | 49 | ### Inside alignment 50 | ![Inside](https://github.com/geoavia/E-Paper-Photo-Frame/blob/main/insides.jpg)

51 | 52 | Enclosure case 3d model (Fusion 360) and stl files for print [are also provided](https://github.com/geoavia/E-Paper-Photo-Frame/tree/main/enclosure)
53 | You may also need some [brass threaded inserts](https://www.amazon.com/dp/B01IYWTCWW) for screen mounting (holes already cut in 3d model) 54 | 55 | ### Arduino sketch 56 | 57 | [Complete Sketch folder](https://github.com/geoavia/E-Paper-Photo-Frame/tree/main/epaper7c)
58 | 59 |
60 | 61 | Main sketch code here 62 | 63 | 64 | ```C++ 65 | #include 66 | #include 67 | #include "epd5in65f.h" 68 | 69 | #define LOG_NAME "/log.inc" 70 | #define MAX_NAME 32 71 | 72 | // Shut down activate pin 73 | const int shutDownPin = 2; 74 | 75 | void setup() { 76 | 77 | pinMode(shutDownPin, OUTPUT); 78 | digitalWrite(shutDownPin, HIGH); // power on 79 | 80 | // put your setup code here, to run once: 81 | Serial.begin(9600); 82 | 83 | Serial.print("Initializing SD card..."); 84 | if (!SD.begin(4)) { 85 | Serial.println("failed!"); 86 | delay(5000); 87 | exit(1); 88 | } 89 | Serial.println("done."); 90 | 91 | char imgFileName[MAX_NAME]; 92 | unsigned long logSize = 0; 93 | 94 | memset(imgFileName, 0, MAX_NAME); 95 | 96 | File logFile = SD.open(LOG_NAME, FILE_WRITE); 97 | if (logFile) { 98 | logSize = logFile.size(); 99 | Serial.print("Log size: "); 100 | Serial.println(logSize); 101 | logFile.write('.'); 102 | logFile.close(); 103 | } 104 | 105 | NextFileName(logSize, imgFileName); 106 | 107 | File imgFile = SD.open(imgFileName, FILE_READ); 108 | if (imgFile) { 109 | unsigned long fs = imgFile.size(); 110 | Serial.print("Show image: "); 111 | Serial.print(imgFileName); 112 | Serial.print(" ("); 113 | Serial.print(fs); 114 | Serial.println(" bytes)..."); 115 | 116 | int x = 0; 117 | int y = 0; 118 | UBYTE bp; 119 | 120 | ///////////////////////////////////////////// 121 | // start e-Paper code 122 | 123 | Epd epd; 124 | if (epd.Init() == 0) { 125 | Serial.println("e-Paper: init ok"); 126 | 127 | epd.Clear(EPD_5IN65F_WHITE); 128 | Serial.println("e-Paper: clear"); 129 | 130 | epd.SendCommand(0x61);//Set Resolution setting 131 | epd.SendData(0x02); 132 | epd.SendData(0x58); 133 | epd.SendData(0x01); 134 | epd.SendData(0xC0); 135 | epd.SendCommand(0x10); 136 | 137 | while (imgFile.available()) { 138 | bp = imgFile.read(); 139 | epd.SendData(bp); 140 | x++; 141 | if (x == 300) { 142 | y++; 143 | x = 0; 144 | } 145 | } 146 | 147 | epd.SendCommand(0x04);//0x04 148 | epd.EPD_5IN65F_BusyHigh(); 149 | epd.SendCommand(0x12);//0x12 150 | epd.EPD_5IN65F_BusyHigh(); 151 | epd.SendCommand(0x02); //0x02 152 | epd.EPD_5IN65F_BusyLow(); 153 | 154 | Serial.println("e-Paper: image sent"); 155 | 156 | epd.Sleep(); 157 | Serial.println("e-Paper: sleep"); 158 | 159 | // end e-Paper code 160 | ///////////////////////////////////////////// 161 | } else { 162 | Serial.println("e-Paper: init failed!"); 163 | } 164 | 165 | imgFile.close(); 166 | } else { 167 | Serial.print("error opening image file: "); 168 | Serial.println(imgFileName); 169 | exit(1); 170 | } 171 | 172 | Serial.println("Complete"); 173 | delay(2000); 174 | } 175 | 176 | void loop() { 177 | delay(5000); 178 | digitalWrite(shutDownPin, LOW); // power off 179 | } 180 | 181 | void NextFileName(unsigned long logSize, char *fname) { 182 | int count = 0; 183 | File dir = SD.open("/"); 184 | File file; 185 | // first loop for counting files... 186 | while (file = dir.openNextFile()) { 187 | if (file.isDirectory() || file.size() != 134400) { 188 | file.close(); 189 | continue; 190 | } 191 | Serial.println(file.name()); 192 | file.close(); 193 | count++; 194 | } 195 | Serial.print("Total images: "); 196 | Serial.println(count); 197 | dir.rewindDirectory(); 198 | logSize = logSize % count; 199 | count = 0; 200 | // ... and second loop for finding next file. I know its's wierd but it works :) 201 | while (file = dir.openNextFile()) { 202 | if (file.isDirectory() || file.size() != 134400) { 203 | file.close(); 204 | continue; 205 | } 206 | if (logSize == count) { 207 | strcpy(fname, file.name()); 208 | } 209 | file.close(); 210 | count++; 211 | } 212 | Serial.print("Current index: "); 213 | Serial.println(logSize); 214 | dir.close(); 215 | } 216 | ``` 217 |
218 | 219 | 220 | ### Preparing image files 221 | 222 | 1. Resize images to resolution of 600x448 pixels 223 | 2. Save them according to [this manual](https://www.waveshare.com/wiki/E-Paper_Floyd-Steinberg) (use 7 color version) 224 | 3. Convert each file with [converter](https://github.com/geoavia/E-Paper-Photo-Frame/tree/main/converter) utility (compile first) 225 | 4. Save resulting BIM files to SD card, obviousely :) 226 | -------------------------------------------------------------------------------- /epaper7c/epd5in65f.cpp: -------------------------------------------------------------------------------- 1 | /***************************************************************************** 2 | * | File : EPD_5in65f.c 3 | * | Author : Waveshare team 4 | * | Function : 5.65inch e-paper 5 | * | Info : 6 | *---------------- 7 | * | This version: V1.0 8 | * | Date : 2020-07-08 9 | * | Info : 10 | * ----------------------------------------------------------------------------- 11 | # 12 | # Permission is hereby granted, free of charge, to any person obtaining a copy 13 | # of this software and associated documnetation files (the "Software"), to deal 14 | # in the Software without restriction, including without limitation the rights 15 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 16 | # copies of the Software, and to permit persons to whom the Software is 17 | # furished to do so, subject to the following conditions: 18 | # 19 | # The above copyright notice and this permission notice shall be included in 20 | # all copies or substantial portions of the Software. 21 | # 22 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 23 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 24 | # FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 25 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 26 | # LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 27 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 28 | # THE SOFTWARE. 29 | # 30 | ******************************************************************************/ 31 | 32 | #include 33 | #include "epd5in65f.h" 34 | 35 | Epd::~Epd() { 36 | }; 37 | 38 | Epd::Epd() { 39 | reset_pin = RST_PIN; 40 | dc_pin = DC_PIN; 41 | cs_pin = CS_PIN; 42 | busy_pin = BUSY_PIN; 43 | width = EPD_WIDTH; 44 | height = EPD_HEIGHT; 45 | }; 46 | 47 | /****************************************************************************** 48 | function : Initialize the e-Paper register 49 | parameter: 50 | ******************************************************************************/ 51 | int Epd::Init(void) { 52 | if (IfInit() != 0) { 53 | return -1; 54 | } 55 | Reset(); 56 | EPD_5IN65F_BusyHigh(); 57 | SendCommand(0x00); 58 | SendData(0xEF); 59 | SendData(0x08); 60 | SendCommand(0x01); 61 | SendData(0x37); 62 | SendData(0x00); 63 | SendData(0x23); 64 | SendData(0x23); 65 | SendCommand(0x03); 66 | SendData(0x00); 67 | SendCommand(0x06); 68 | SendData(0xC7); 69 | SendData(0xC7); 70 | SendData(0x1D); 71 | SendCommand(0x30); 72 | SendData(0x3C); 73 | SendCommand(0x41); 74 | SendData(0x00); 75 | SendCommand(0x50); 76 | SendData(0x37); 77 | SendCommand(0x60); 78 | SendData(0x22); 79 | SendCommand(0x61); 80 | SendData(0x02); 81 | SendData(0x58); 82 | SendData(0x01); 83 | SendData(0xC0); 84 | SendCommand(0xE3); 85 | SendData(0xAA); 86 | 87 | DelayMs(100); 88 | SendCommand(0x50); 89 | SendData(0x37); 90 | } 91 | 92 | /** 93 | * @brief: basic function for sending commands 94 | */ 95 | void Epd::SendCommand(unsigned char command) { 96 | DigitalWrite(dc_pin, LOW); 97 | SpiTransfer(command); 98 | } 99 | 100 | /** 101 | * @brief: basic function for sending data 102 | */ 103 | void Epd::SendData(unsigned char data) { 104 | DigitalWrite(dc_pin, HIGH); 105 | SpiTransfer(data); 106 | } 107 | 108 | void Epd::EPD_5IN65F_BusyHigh(void)// If BUSYN=0 then waiting 109 | { 110 | while(!(DigitalRead(BUSY_PIN))); 111 | } 112 | 113 | void Epd::EPD_5IN65F_BusyLow(void)// If BUSYN=1 then waiting 114 | { 115 | while(DigitalRead(BUSY_PIN)); 116 | } 117 | 118 | /** 119 | * @brief: module reset. 120 | * often used to awaken the module in deep sleep, 121 | * see Epd::Sleep(); 122 | */ 123 | void Epd::Reset(void) { 124 | DigitalWrite(reset_pin, LOW); //module reset 125 | DelayMs(1); 126 | DigitalWrite(reset_pin, HIGH); 127 | DelayMs(200); 128 | } 129 | 130 | /****************************************************************************** 131 | function : Sends the image buffer in RAM to e-Paper and displays 132 | parameter: 133 | ******************************************************************************/ 134 | void Epd::EPD_5IN65F_Display(const UBYTE *image) { 135 | unsigned long i,j; 136 | SendCommand(0x61);//Set Resolution setting 137 | SendData(0x02); 138 | SendData(0x58); 139 | SendData(0x01); 140 | SendData(0xC0); 141 | SendCommand(0x10); 142 | for(i=0; i=ystart && j<(image_width+xstart)/2 && j>=xstart/2) { 173 | SendData(pgm_read_byte(&image[(j-xstart/2) + (image_width/2*(i-ystart))])); 174 | } 175 | else { 176 | SendData(0x11); 177 | } 178 | } 179 | } 180 | SendCommand(0x04);//0x04 181 | EPD_5IN65F_BusyHigh(); 182 | SendCommand(0x12);//0x12 183 | EPD_5IN65F_BusyHigh(); 184 | SendCommand(0x02); //0x02 185 | EPD_5IN65F_BusyLow(); 186 | DelayMs(200); 187 | } 188 | 189 | /****************************************************************************** 190 | function : 191 | Clear screen 192 | ******************************************************************************/ 193 | void Epd::Clear(UBYTE color) { 194 | SendCommand(0x61);//Set Resolution setting 195 | SendData(0x02); 196 | SendData(0x58); 197 | SendData(0x01); 198 | SendData(0xC0); 199 | SendCommand(0x10); 200 | for(int i=0; i 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------