Merge pull request #156 from e-radionicacom/dev

Added Inkplate 6 Color Factory Programming Example

Author: BornaBiro

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_Battery_Voltage_And_Temperature/Inkplate_Battery_Voltage_And_Temperature.ino

@@ -25,6 +25,12 @@
 // It is in same folder as this sketch. You can even open it (read it) by clicking on symbols.h tab in Arduino IDE
 Inkplate display(INKPLATE_1BIT); // Create an object on Inkplate library and also set library into 1-bit mode (BW)
 
+// If your Inkplate doesn't have external (or second) MCP I/O expander, you should uncomment next line,
+// otherwise your code could hang out when you send code to your Inkplate.
+// You can easily check if your Inkplate has second MCP by turning it over and 
+// if there is missing chip near place where "MCP23017-2" is written, but if there is
+// chip soldered, you don't have to uncomment line and use external MCP I/O expander
+
 void setup()
 {
     display.begin();                    // Init Inkplate library (you should call this function ONLY ONCE)

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_Bluetooth_Peripheral_Mode_Example/Inkplate_Bluetooth_Peripheral_Mode_Example.ino

@@ -27,6 +27,12 @@ BluetoothSerial SerialBT;
 // Temporary buffer to send to Peripheral mode code
 char commandBuffer[BUFFER_SIZE + 1];
 
+// If your Inkplate doesn't have external (or second) MCP I/O expander, you should uncomment next line,
+// otherwise your code could hang out when you send code to your Inkplate.
+// You can easily check if your Inkplate has second MCP by turning it over and 
+// if there is missing chip near place where "MCP23017-2" is written, but if there is
+// chip soldered, you don't have to uncomment line and use external MCP I/O expander
+
 void setup() // Initialize everything
 {
     Serial.begin(115200);

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_EEPROM_Usage/Inkplate_EEPROM_Usage.ino

@@ -28,6 +28,12 @@
 
 Inkplate display(INKPLATE_1BIT); // Create object on Inkplate library and set library to work in monochrome mode
 
+// If your Inkplate doesn't have external (or second) MCP I/O expander, you should uncomment next line,
+// otherwise your code could hang out when you send code to your Inkplate.
+// You can easily check if your Inkplate has second MCP by turning it over and 
+// if there is missing chip near place where "MCP23017-2" is written, but if there is
+// chip soldered, you don't have to uncomment line and use external MCP I/O expander
+
 void setup()
 {
     display.begin(); // Init library (you should call this function ONLY ONCE)

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_EasyC/Inkplate_EasyC.ino

@@ -33,6 +33,12 @@ Adafruit_BME680
          //(with no arguments sent to constructor, that means we are using I2C communication for BME680 sensor)
 
 int n = 0; // Variable that keep track on how many times screen has been partially updated
+// If your Inkplate doesn't have external (or second) MCP I/O expander, you should uncomment next line,
+// otherwise your code could hang out when you send code to your Inkplate.
+// You can easily check if your Inkplate has second MCP by turning it over and 
+// if there is missing chip near place where "MCP23017-2" is written, but if there is
+// chip soldered, you don't have to uncomment line and use external MCP I/O expander
+
 void setup()
 {
     display.begin();        // Init Inkplate library (you should call this function ONLY ONCE)

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_Faster_Display/Inkplate_Faster_Display.ino

@@ -19,6 +19,12 @@
 // beware it doesn't support partialUpdate yet
 Inkplate display(INKPLATE_1BIT);
 
+// If your Inkplate doesn't have external (or second) MCP I/O expander, you should uncomment next line,
+// otherwise your code could hang out when you send code to your Inkplate.
+// You can easily check if your Inkplate has second MCP by turning it over and 
+// if there is missing chip near place where "MCP23017-2" is written, but if there is
+// chip soldered, you don't have to uncomment line and use external MCP I/O expander
+
 void setup()
 {
     // Initialize the display and serial

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_Low_Power/Inkplate_Low_Power.ino

@@ -37,6 +37,12 @@ RTC_DATA_ATTR int slide = 0;
 
 Inkplate display(INKPLATE_3BIT); // Create an object on Inkplate library and also set library into 3 Bit mode (gray)
 
+// If your Inkplate doesn't have external (or second) MCP I/O expander, you should uncomment next line,
+// otherwise your code could hang out when you send code to your Inkplate.
+// You can easily check if your Inkplate has second MCP by turning it over and 
+// if there is missing chip near place where "MCP23017-2" is written, but if there is
+// chip soldered, you don't have to uncomment line and use external MCP I/O expander
+
 void setup()
 {
     display.begin();        // Init Inkplate library (you should call this function ONLY ONCE)

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_MCP23017_Expander/Inkplate_MCP23017_Expander.ino

@@ -9,15 +9,8 @@
    You will have to connect one side of 330 Ohm resistor to GPB7, than other side to anode of LED and finally, cathode
    pin of LED to GND.
 
-   This example will show you how you can manipulate with I/Os of MCP23017 Expander.
-   You can only manipulate with Port B of MCP23017 (GPB1-GPB7). Port A is used for epaper panel and TPS65186 PMIC.
-   GPB0 is used for ESP32 GPIO0 so you can't use it either.
-   GPB1 is used for enabling battery reading (if Batt solder bridge is bridged between second and third pad)
-   GPB2, GPB3 and GPB4 are used for reading touchpad (if Touchpad solder bridges are bridged between second pad and
-   third pad). If every thing is connected ok, after you upload code, LED should blink.
-
-   DANGER: DO NOT USE GPA0-GPA7 and GPB0. In code those are pins from 0-8!!! Using those, you might permanently damage
-   the screen. You should only use pins from 9-15.
+   This example will show you how you can manipulate with I/Os of external MCP23017 Expander.
+   On this expander all pins are free to use, nothing is connected by the default.
 
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: http://forum.e-radionica.com/en/
@@ -41,7 +34,9 @@ void setup()
     display.begin(); // Init Inkplate library (you should call this function ONLY ONCE)
     display.pinModeMCP(
         LED_PIN,
-        OUTPUT); // Set pin 15 (or GPB7) to output. On that pin, we sholud connect LED with current limiting resistor
+        OUTPUT);  // Set pin 15 (or GPB7) to output. On that pin, we sholud connect LED with current limiting resistor
+                 // If we do not specify which MCP we want to use, by the default external MCP will be used of the one
+                 // with header named MCP23017-2
 }
 
 void loop()

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_MCP23017_Internal_Expander/Inkplate_MCP23017_Internal_Expander.ino

@@ -0,0 +1,54 @@
+/*
+   Inkplate_MCP23017 example for e-radionica.com Inkplate 10
+   For this example you will need only a micro USB cable, Inkplate10, 330 Ohm resistor and LED diode.
+   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/
+
+   Connect resistor to GPB7 pin on MCP23017 header at bottom right corner on the backside (component side) of Inkplate.
+   You will have to connect one side of 330 Ohm resistor to GPB7, than other side to anode of LED and finally, cathode
+   pin of LED to GND.
+
+   This example will show you how you can manipulate with I/Os of internal MCP23017 Expander.
+   You can only manipulate with Port B of MCP23017 (GPB1-GPB7). Port A is used for epaper panel and TPS65186 PMIC.
+   GPB0 is used for ESP32 GPIO0 so you can't use it either.
+   GPB1 is used for enabling battery reading (if Batt solder bridge is bridged between second and third pad)
+   GPB2, GPB3 and GPB4 are used for reading touchpad (if Touchpad solder bridges are bridged between second pad and
+   third pad). If every thing is connected ok, after you upload code, LED should blink.
+
+   DANGER: DO NOT USE GPA0-GPA7 and GPB0. In code those are pins from 0-8!!! Using those, you might permanently damage
+   the screen. You should only use pins from 9-15.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Looking to get support? Write on our forums: http://forum.e-radionica.com/en/
+   19 May 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
+
+#define LED_PIN MCP23017_PIN_B7 // We are going to use pin GPB7 (remember! GPA0 = 0, GPA1 = 1, ..., GPA7 = 7, GPB0 = 8, GBP1 = 9, ..., GPB7 =
+       // 15)
+
+Inkplate display(INKPLATE_1BIT); // Create an object on Inkplate library and also set library into 1-bit mode (BW)
+
+void setup()
+{
+    display.begin(); // Init Inkplate library (you should call this function ONLY ONCE)
+    display.pinModeMCP(
+        LED_PIN,
+        OUTPUT, MCP23017_INT_ADDR); // Set pin 15 (or GPB7) to output. On that pin, we sholud connect LED with current limiting resistor
+                                    // and specify that we want use internal MCP or MCP with header named MCP23017-1
+}
+
+void loop()
+{
+    display.digitalWriteMCP(LED_PIN, LOW, MCP23017_INT_ADDR);  // Set output to low (LED does not light up)
+    delay(1000);                            // Wait for one second
+    display.digitalWriteMCP(LED_PIN, HIGH, MCP23017_INT_ADDR); // Set output to high (LED lights up)
+    delay(1000);                            // Wait for one second
+}

examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_Partial_Update_With_Deep_Sleep/Inkplate_Partial_Update_With_Deep_Sleep.ino

@@ -40,6 +40,12 @@ Inkplate display(INKPLATE_1BIT); // Create an object on Inkplate library and als
 RTC_DATA_ATTR int counter = 0;
 RTC_DATA_ATTR float decimal = PI;
 
+// If your Inkplate doesn't have external (or second) MCP I/O expander, you should uncomment next line,
+// otherwise your code could hang out when you send code to your Inkplate.
+// You can easily check if your Inkplate has second MCP by turning it over and 
+// if there is missing chip near place where "MCP23017-2" is written, but if there is
+// chip soldered, you don't have to uncomment line and use external MCP I/O expander
+
 void setup()
 {
     Serial.begin(115200);

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!
+}