first commit

e-Paper/Arduino/epd5in83_V2/epd5in83_V2.cpp

@@ -0,0 +1,189 @@
+/**
+ *  @filename   :   epd5in83_V2.h
+ *  @brief      :   Header file for e-paper library epd5in83_V2.cpp
+ *  @author     :   MyMX from Waveshare
+ *  
+ *  Copyright (C) Waveshare     Nov 09 2020
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documnetation 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
+ * furished 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 OR 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.
+ */
+
+#include <stdlib.h>
+#include "epd5in83_V2.h"
+
+Epd::~Epd() {
+};
+
+Epd::Epd() {
+    reset_pin = RST_PIN;
+    dc_pin = DC_PIN;
+    cs_pin = CS_PIN;
+    busy_pin = BUSY_PIN;
+    width = EPD_WIDTH;
+    height = EPD_HEIGHT;
+};
+
+int Epd::Init(void) {
+    if (IfInit() != 0) {
+        return -1;
+    }
+    Reset();
+
+	SendCommand(0x01);			//POWER SETTING
+	SendData (0x07);
+	SendData (0x07);    //VGH=20V,VGL=-20V
+	SendData (0x3f);		//VDH=15V
+	SendData (0x3f);		//VDL=-15V
+
+	SendCommand(0x04); //POWER ON
+	DelayMs(100);  
+	WaitUntilIdle();        //waiting for the electronic paper IC to release the idle signal
+
+	SendCommand(0X00);			//PANNEL SETTING
+	SendData(0x1F);   //KW-3f   KWR-2F	BWROTP 0f	BWOTP 1f
+
+	SendCommand(0x61);        	//tres			
+	SendData (0x02);		//source 648
+	SendData (0x88);
+	SendData (0x01);		//gate 480
+	SendData (0xE0);
+
+	SendCommand(0X15);		
+	SendData(0x00);		
+
+	SendCommand(0X50);			//VCOM AND DATA INTERVAL SETTING
+	SendData(0x10);
+	SendData(0x07);
+
+	SendCommand(0X60);			//TCON SETTING
+	SendData(0x22);
+
+    return 0;
+}
+
+/**
+ *  @brief: basic function for sending commands
+ */
+void Epd::SendCommand(unsigned char command) {
+    DigitalWrite(dc_pin, LOW);
+    SpiTransfer(command);
+}
+
+/**
+ *  @brief: basic function for sending data
+ */
+void Epd::SendData(unsigned char data) {
+    DigitalWrite(dc_pin, HIGH);
+    SpiTransfer(data);
+}
+
+/**
+ *  @brief: Wait until the busy_pin goes HIGH
+ */
+void Epd::WaitUntilIdle(void) {
+	do {
+		SendCommand(0x71);
+		DelayMs(50);    
+	}
+	while(!DigitalRead(busy_pin));   
+	DelayMs(50);    
+}
+
+/**
+ *  @brief: module reset.
+ *          often used to awaken the module in deep sleep,
+ *          see Epd::Sleep();
+ */
+void Epd::Reset(void) {
+    DigitalWrite(reset_pin, HIGH);
+    DelayMs(200);   
+    DigitalWrite(reset_pin, LOW);                //module reset    
+    DelayMs(5);
+    DigitalWrite(reset_pin, HIGH);
+    DelayMs(200);    
+}
+
+void Epd::DisplayFrame(const unsigned char* frame_buffer, char part) {
+    /**  
+    * Size of a single array cannot be larger than 32K in AVR GCC, therefore 
+    * you have to split the image data () into 2 parts 
+    */
+    unsigned int Width, Height, i, j;
+    Width = (width % 8 == 0)? (width / 8 ): (width / 8 + 1);
+    Height = height;
+
+	if(part == 1) {
+		SendCommand(0x10);
+		for(i=0;i<Height;i++) {
+			for(j=0; j<Width; j++) {
+				SendData(0x00);  
+			}
+		}
+		SendCommand(0x13);
+	}
+	for(i=0;i<Height/2;i++) {
+		for(j=0; j<Width; j++) {
+			SendData(~pgm_read_byte(&frame_buffer[i*Width + j]));  
+		}
+	}
+	if(part == 2)
+		TurnOnDisplay();
+}
+
+void Epd::Clear(void)
+{
+    unsigned int Width, Height, i;
+    Width = (width % 8 == 0)? (width / 8 ): (width / 8 + 1);
+    Height = height;
+
+	SendCommand(0x10);
+	for(i=0; i<Width*Height; i++) {
+		SendData(0x00);  
+	}
+	SendCommand(0x13);
+	for(i=0; i<Width*Height; i++) {
+		SendData(0x00);  
+	}
+	TurnOnDisplay();
+}
+
+void Epd::TurnOnDisplay(void)
+{
+	SendCommand(0x12);
+	DelayMs(100);
+	WaitUntilIdle();
+}
+/**
+ *  @brief: After this command is transmitted, the chip would enter the 
+ *          deep-sleep mode to save power. 
+ *          The deep sleep mode would return to standby by hardware reset. 
+ *          The only one parameter is a check code, the command would be
+ *          executed if check code = 0xA5. 
+ *          You can use EPD_Reset() to awaken
+ */
+void Epd::Sleep(void) {
+    SendCommand(0X02);
+    WaitUntilIdle();
+    SendCommand(0X07);
+    SendData(0xa5);
+}
+
+/* END OF FILE */
+
+

e-Paper/Arduino/epd5in83_V2/epd5in83_V2.h

@@ -0,0 +1,62 @@
+/**
+ *  @filename   :   epd5in83_V2.h
+ *  @brief      :   Header file for e-paper library epd5in83_V2.cpp
+ *  @author     :   MyMX from Waveshare
+ *  
+ *  Copyright (C) Waveshare     Nov 09 2020
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documnetation 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
+ * furished 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 OR 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 EPD5IN83_V2_H
+#define EPD5IN83_V2_H
+
+#include "epdif.h"
+
+// Display resolution
+#define EPD_WIDTH       648
+#define EPD_HEIGHT      480
+
+
+class Epd : EpdIf {
+public:
+    Epd();
+    ~Epd();
+    int  Init(void);
+    void DisplayFrame(const unsigned char* frame_buffer, char part);
+	void Clear(void);
+    void Sleep(void);
+private:
+    unsigned int reset_pin;
+    unsigned int dc_pin;
+    unsigned int cs_pin;
+    unsigned int busy_pin;
+    unsigned long width;
+    unsigned long height;
+	
+    void WaitUntilIdle(void);
+    void Reset(void);
+    void SendCommand(unsigned char command);
+    void SendData(unsigned char data);
+	void TurnOnDisplay(void);
+};
+
+#endif /* EPD5IN83_H */
+
+/* END OF FILE */

e-Paper/Arduino/epd5in83_V2/epd5in83_V2.ino

@@ -0,0 +1,48 @@
+/**
+ *  @filename   :   epd5in83_V2-demo.ino
+ *  @brief      :   5.83inch V2 e-paper display demo
+ *  @author     :   MyMX from Waveshare
+ *
+ *  Copyright (C) Waveshare     Nov 09 2020
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documnetation 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
+ * furished 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 OR 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.
+ */
+
+#include <SPI.h>
+#include "epd5in83_V2.h"
+#include "imagedata.h"
+
+void setup() {
+  // put your setup code here, to run once:
+    Serial.begin(115200);
+    Epd epd;
+    if (epd.Init() != 0) {
+        Serial.println("e-Paper init failed");
+        return;
+    }
+    epd.DisplayFrame(gImage_5in83_V2_p1, 1);	//no enough flash rom
+	epd.DisplayFrame(gImage_5in83_V2_p1, 2);
+	delay(5000);
+	epd.Clear();
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+}

e-Paper/Arduino/epd5in83_V2/epdif.cpp

@@ -0,0 +1,68 @@
+/**
+ *  @filename   :   epdif.cpp
+ *  @brief      :   Implements EPD interface functions
+ *                  Users have to implement all the functions in epdif.cpp
+ *  @author     :   Yehui from Waveshare
+ *
+ *  Copyright (C) Waveshare     August 10 2017
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documnetation 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
+ * furished 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 OR 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.
+ */
+
+#include "epdif.h"
+#include <SPI.h>
+
+EpdIf::EpdIf() {
+};
+
+EpdIf::~EpdIf() {
+};
+
+void EpdIf::DigitalWrite(int pin, int value) {
+    digitalWrite(pin, value);
+}
+
+int EpdIf::DigitalRead(int pin) {
+    return digitalRead(pin);
+}
+
+void EpdIf::DelayMs(unsigned int delaytime) {
+    delay(delaytime);
+}
+
+void EpdIf::SpiTransfer(unsigned char data) {
+    digitalWrite(CS_PIN, LOW);
+    SPI.transfer(data);
+    digitalWrite(CS_PIN, HIGH);
+}
+
+int EpdIf::IfInit(void) {
+    pinMode(CS_PIN, OUTPUT);
+    pinMode(RST_PIN, OUTPUT);
+    pinMode(DC_PIN, OUTPUT);
+    pinMode(BUSY_PIN, INPUT); 
+
+    pinMode(PWR_PIN, OUTPUT);
+    DigitalWrite(PWR_PIN, 1);
+
+    SPI.begin();
+    SPI.beginTransaction(SPISettings(2000000, MSBFIRST, SPI_MODE0));
+    return 0;
+}
+

e-Paper/Arduino/epd5in83_V2/epdif.h

@@ -0,0 +1,52 @@
+/**
+ *  @filename   :   epdif.h
+ *  @brief      :   Header file of epdif.cpp providing EPD interface functions
+ *                  Users have to implement all the functions in epdif.cpp
+ *  @author     :   Yehui from Waveshare
+ *
+ *  Copyright (C) Waveshare     August 10 2017
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documnetation 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
+ * furished 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 OR 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 EPDIF_H
+#define EPDIF_H
+
+#include <Arduino.h>
+
+// Pin definition
+#define RST_PIN         8
+#define DC_PIN          9
+#define CS_PIN          10
+#define BUSY_PIN        7
+#define PWR_PIN         6
+
+class EpdIf {
+public:
+    EpdIf(void);
+    ~EpdIf(void);
+
+    static int  IfInit(void);
+    static void DigitalWrite(int pin, int value); 
+    static int  DigitalRead(int pin);
+    static void DelayMs(unsigned int delaytime);
+    static void SpiTransfer(unsigned char data);
+};
+
+#endif

e-Paper/Arduino/epd5in83_V2/imagedata.h

@@ -0,0 +1,29 @@
+/**
+ *  @filename   :   imagedata.h
+ *  @brief      :   head file for imagedata.cpp
+ *
+ *  Copyright (C) Waveshare     Nov 09 2020
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documnetation 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
+ * furished 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 OR 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.
+ */
+
+extern const unsigned char gImage_5in83_V2_p1[];	//one half image data
+// extern const unsigned char gImage_5in83_V2_p2[];
+
+/* FILE END */