Merge branch 'dev' of https://github.com/SolderedElectronics/Inkplate-Arduino-library into PCAL-Support

Author: BornaBiro

README.md

@@ -4,14 +4,14 @@
 
 ![](https://www.crowdsupply.com/img/cf95/compare-peripheral_jpg_project-body.jpg)
 
-Arduino library for all-in-one e-paper display family named Inkplate can be found in this repo. Inkplate is a series of powerful, Wi-Fi enabled ESP32-based e-paper display products. Its main feature is simplicity. Just plug in a USB cable, open Arduino IDE, and change the contents of the screen with few lines of code. Inkplate family currently includes Inkplate 10, Inkplate 6 and Inkplate 6PLUS - learn more about Inkplates on [official website](https://inkplate.io/). 
+Arduino library for all-in-one e-paper display family named Inkplate can be found in this repo. Inkplate is a series of powerful, Wi-Fi enabled ESP32-based e-paper display products. Its main feature is simplicity. Just plug in a USB cable, open Arduino IDE, and change the contents of the screen with few lines of code. Inkplate family currently includes Inkplate 10, Inkplate 6 and Inkplate 6PLUS - learn more about Inkplates on [official website](https://inkplate.io/).
 Inkplate 6 was crowdfunded on [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6), as well as [Inkplate 10]([https://www.crowdsupply.com/e-radionica/inkplate-10). [Inkplate 6PLUS](https://www.crowdsupply.com/e-radionica/inkplate-6plus) is funding now.
 
 ### Setting up Inkplate in Arduino IDE
 
 In order to get a head start with Inkplate (any), follow these steps:
 
-1. [Install Inkplate board definition](https://github.com/e-radionicacom/Croduino-Board-Definitions-for-Arduino-IDE/blob/master/README.md) - add Inkplate 6/10/6PLUS as a board into your Arduino IDE. Follow the instructions on the [link](https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/).
+1. [Install Inkplate board definition](https://github.com/SolderedElectronics/Croduino-Board-Definitions-for-Arduino-IDE/blob/master/README.md) - add Inkplate 6/10/6PLUS as a board into your Arduino IDE. Follow the instructions on the [link](https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/).
 2. Install CH340 drivers (if you don't have them yet) - instructions [here](https://e-radionica.com/en/blog/ch340-driver-installation-croduino-basic3-nova2/)
 3. Install Inkplate Arduino library - install the library from this repo into your Arduino IDE. If you don't know how, check our [tutorial](https://e-radionica.com/en/blog/arduino-library/#Kako%20instaliraty%20library?).
 4. You are ready to get started! Select Tools -> Board -> Inkplate (pick correct one), as well as correct COM port and upload!
@@ -22,8 +22,7 @@ There are many examples in the library that you demonstrate how to use any of th
 
 ### Documentation
 
-Find Inkplate documentation [here](https://inkplate.readthedocs.io/en/latest/arduino.html). 
-
+Find Inkplate documentation [here](https://inkplate.readthedocs.io/en/latest/arduino.html).
 
 ### Using Inkplate 6 with another microcontroller - Peripheral mode
 
@@ -47,7 +46,7 @@ apt install python-is-python3
 
 ### Micropython
 
-If you are looking for micropython support, please find all details [here](https://github.com/e-radionicacom/Inkplate-micropython).
+If you are looking for micropython support, please find all details [here](https://github.com/SolderedElectronics/Inkplate-micropython).
 
 ### License
 
@@ -57,9 +56,9 @@ This repo uses the source code from another repositories. All their license file
 
 All of Inkplate-related development is open-sourced:
 
-- [Arduino library](https://github.com/e-radionicacom/Inkplate-6-Arduino-library)
-- Hardware design: [Inkplate 6](https://github.com/e-radionicacom/Inkplate-6-hardware), [Inkplate 10](https://github.com/e-radionicacom/Inkplate-10-hardware)
-- [micropython Inkplate](https://github.com/e-radionicacom/Inkplate-6-micropython)
+- [Arduino library](https://github.com/SolderedElectronics/Inkplate-6-Arduino-library)
+- Hardware design: [Inkplate 6](https://github.com/SolderedElectronics/Inkplate-6-hardware), [Inkplate 10](https://github.com/SolderedElectronics/Inkplate-10-hardware)
+- [micropython Inkplate](https://github.com/SolderedElectronics/Inkplate-6-micropython)
 - OSHWA cerfiticate: [Inkplate 6](https://certification.oshwa.org/hr000003.html), [Inkplate 10](https://certification.oshwa.org/hr000006.html)
 
 ### Where to buy & other

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_Picture_From_RAM/Inkplate_Picture_From_RAM.ino

@@ -0,0 +1,76 @@
+/*
+   Inkplate_Picture_From_RAM example for soldered.com Inkplate 10
+   For this example you will need USB cable and Inkplate 10.
+   Select "Inkplate 10(ESP32)" from Tools -> Board menu.
+   Don't have "Inkplate 10(ESP32)" option? Follow our tutorial and add it:
+   https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/
+
+   This example will show you how you can show picture loaded in RAM. 
+   Inkplate can show picture in 1-bit or 3-bit mode.
+   Inkplate will wake every 20 seconds change content on screen.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Looking to get support? Write on our forums: http://forum.e-radionica.com/en/
+   13 June 2022 by soldered.com
+*/
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATE10
+#error "Wrong board selection for this example, please select Inkplate 10 in the boards menu."
+#endif
+
+#include "Inkplate.h"       // Include Inkplate library to the sketch
+#include "picture1.h"       // Include .h files of 3 pictures. All three pictures were converted using Inkplate Image Converter
+#include "picture2.h"
+#include "picture3.h"       // This are headers in which are saved pictures that needs to be stored in RAM for showing.
+                            // Any picture (in any format) can be converted in this type of header on this link:
+                            // https://inkplate.io/home/image-converter/ just choose settings for your Inkplate
+                            // and additional settings like dither and bit mode.
+
+Inkplate display(INKPLATE_3BIT); // Create an object on Inkplate library and also set library into 3 Bit mode (gray)
+
+void setup()
+{   
+    Serial.begin(115200);
+    display.begin();        // Init Inkplate library (you should call this function ONLY ONCE)
+    display.clearDisplay(); // Clear frame buffer of display
+    
+    display.drawImage(
+        picture1, 50, 0, 1100,
+        825); // Display picture from RAM  at location X=50, Y=0. It is also needed to specify width and height
+              // of picture (1100x825 in this case). drawImage function iis overloaded function and this parameters
+              // specify to use function which draws image on screen from internal RAM and this function calls other
+              // functions (drawBitmap or drawBitmap3Bit depends in which mode is Inkplate (INKPLATE_3BIT or INKPLATE_1BIT))
+              // which draws content from buffer in RAM.
+    display.display(); // Refresh the screen with new picture
+    
+    delay(10000); // Wait a bit
+    
+    display.clearDisplay(); // Clear frame buffer of display
+    
+    display.drawBitmap3Bit(
+       50, 0, picture2, 1100,
+        825);  // This function is called automatically from drawImage if first parameter is
+               // pointer to buffer in which picture is stored and Inkplate is in 3-bit mode.
+               // In this example we are using this function only to show it's functionality 
+               // and to show that this function can be used if you have problems with showing
+               // 3-bit pictures on Inkplate.
+    
+    display.display(); // Refresh the screen with new picture
+    
+    delay(10000); // Wait a bit
+    
+    display.clearDisplay(); // Clear frame buffer of display
+    
+    display.drawBitmap3Bit(
+        50, 0, picture3, 1100,
+        825);  // Display selected picture at location X=0, Y=0. All three pictures have resolution of 1100x825 pixels
+
+    display.display(); // Refresh the screen with new picture
+}
+
+void loop()
+{
+    // Nothing! If you use deep sleep, whole program should be in setup() because each time the board restarts, not in a
+    // loop()! loop() must be empty!
+}