Merge branch 'SolderedElectronics:master' into draw-from-png-buf

Author: chrisjtwomey

.github/workflows/compile.yml

@@ -7,6 +7,14 @@ jobs:
     strategy:
       matrix:
         include:
+          - board:
+              fqbn: Inkplate_Boards:esp32:Inkplate5
+            additional-sketch-paths: |
+              - examples/Inkplate5
+          - board:
+              fqbn: Inkplate_Boards:esp32:Inkplate5V2
+            additional-sketch-paths: |
+              - examples/Inkplate5V2
           - board:
               fqbn: Inkplate_Boards:esp32:Inkplate6
             additional-sketch-paths: |
@@ -31,6 +39,10 @@ jobs:
               fqbn: Inkplate_Boards:esp32:Inkplate6plusV2
             additional-sketch-paths: |
               - examples/Inkplate6PLUS
+          - board:
+              fqbn: Inkplate_Boards:esp32:Inkplate6Flick
+            additional-sketch-paths: |
+              - examples/Inkplate6FLICK
           - board:
               fqbn: Inkplate_Boards:esp32:Inkplate6COLOR
             additional-sketch-paths: |
@@ -55,7 +67,6 @@ jobs:
           fqbn: ${{ matrix.board.fqbn }}
           libraries: |
             - source-path: ./
-            - name: "Adafruit BME680 Library"
             - name: ArduinoJson
             - name: Time
             - source-url: https://github.com/SolderedElectronics/Soldered-MFRC522-RFID-Reader-Arduino-Library.git

.github/workflows/format.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: DoozyX/clang-format-lint-action@v0.12
+      - uses: DoozyX/clang-format-lint-action@v0.18.2
         with:
           source: "./src"
           exclude: "./src/libs"

README.md

@@ -26,6 +26,9 @@ There are many examples in the library that you demonstrate how to use any of th
 
 Find Inkplate documentation [here](https://inkplate.readthedocs.io/en/latest/arduino.html). 
 
+### Soldered Image Converter
+
+In order to display an Image on Inkplate, you can use the Soldered Image Converter to convert from .png, .jpg, .bmp to .h files which can be easily added to your project. Download the latest release [here](https://github.com/SolderedElectronics/Soldered-Image-Converter/releases).
 
 ### Using Inkplate with another microcontroller - Peripheral mode
 
@@ -53,6 +56,12 @@ pip3 install pyserial
 apt install python-is-python3
 ```
 
+In case you're getting an [error](https://github.com/SolderedElectronics/Inkplate-Arduino-library/issues/212) while trying to install pyserial, run the following command:
+
+```
+apt install python3-serial
+```
+
 ### Micropython
 
 If you are looking for micropython support, please find all details [here](https://github.com/SolderedElectronics/Inkplate-micropython).

examples/Inkplate10/Advanced/Communications/Inkplate10_EasyC/Inkplate10_EasyC.ino

@@ -22,7 +22,7 @@
 #error "Wrong board selection for this example, please select e-radionica Inkplate10 or Soldered Inkplate10 in the boards menu."
 #endif
 
-#include "BME680-SOLDERED.h" // Soldered library for BME680 Sensor
+#include <BME680-SOLDERED.h> // Soldered library for BME680 Sensor
 #include "Inkplate.h"        // Include Inkplate library to the sketch
 #include "icons.h"           
 
@@ -32,6 +32,9 @@ BME680 bme680; // Create an object on Soldered BME680 library (with no arguments
 
 int n = 0; // Variable that keep track on how many times screen has been partially updated
 
+// Add temperature offset to calibrate the sensor
+const float temperatureOffset = 0.0;
+
 void setup()
 {
     display.begin();        // Init Inkplate library (you should call this function ONLY ONCE)
@@ -59,7 +62,7 @@ void loop()
 
     // Display the temperature icon and measured value
     display.setCursor(493, 65);
-    display.print(bme680.readTemperature());
+    display.print(bme680.readTemperature() + temperatureOffset);
     display.print(" *C");
     display.drawImage(temperature_icon, 220, 40, temperature_icon_w, temperature_icon_h,
                       BLACK); // Arguments are: array variable name, start X, start Y, size X, size Y, color
@@ -99,4 +102,7 @@ void loop()
 
     // Wait a little bit between readings
     delay(10000);
+
+    // If you want to save energy, instead of the delay function, you can use deep sleep as we used in DeepSleep
+    // examples
 }

examples/Inkplate10/Advanced/DeepSleep/Inkplate10_Simple_Deep_Sleep/Inkplate10_Simple_Deep_Sleep.ino

@@ -15,6 +15,10 @@
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
    11 February 2021 by Soldered
+
+   In order to convert your images into a format compatible with Inkplate
+   use the Soldered Image Converter available at:
+   https://github.com/SolderedElectronics/Soldered-Image-Converter/releases
 */
 
 // Next 3 lines are a precaution, you can ignore those, and the example would also work without them

examples/Inkplate10/Advanced/Other/Inkplate10_Read_Battery_Voltage/Inkplate10_Read_Battery_Voltage.ino

@@ -10,6 +10,10 @@
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
    23 January 2023 by Soldered
+
+   In order to convert your images into a format compatible with Inkplate
+   use the Soldered Image Converter available at:
+   https://github.com/SolderedElectronics/Soldered-Image-Converter/releases
 */
 
 // Next 3 lines are a precaution, you can ignore those, and the example would also work without them

examples/Inkplate10/Advanced/Other/Inkplate10_Read_Temperature/Inkplate10_Read_Temperature.ino

@@ -11,6 +11,10 @@
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
    23 January 2023 by Soldered
+
+   In order to convert your images into a format compatible with Inkplate
+   use the Soldered Image Converter available at:
+   https://github.com/SolderedElectronics/Soldered-Image-Converter/releases
 */
 
 // Next 3 lines are a precaution, you can ignore those, and the example would also work without them

examples/Inkplate10/Advanced/RTC/Inkplate10_RTC_Timer/Inkplate10_RTC_Timer.ino

@@ -62,7 +62,7 @@ void setup()
      *   int_pulse
      *       true = interrupt generate a pulse; false = interrupt follows timer flag
      */
-    display.rtcTimerSet(Inkplate::TIMER_CLOCK_1HZ, countdown_time, false, false);
+    display.rtcTimerSet(Inkplate::TIMER_CLOCK_1HZ, countdown_time, true, false);
 }
 
 // Variable that keeps count on how much screen has been partially updated

examples/Inkplate10/Advanced/WEB_WiFi/Inkplate10_Show_JPG_With_HTTPClient/Inkplate10_Show_JPG_With_HTTPClient.ino

@@ -33,7 +33,7 @@ char *ssid = ""; // Your WiFi SSID
 char *pass = ""; // Your WiFi password
 
 // Add the URL of the image you want to show on Inkplate
-String url = "https://raw.githubusercontent.com/SolderedElectronics/Inkplate-Arduino-library/dev/examples/Inkplate10/Advanced/WEB_WiFi/Inkplate10_Show_JPG_With_HTTPClient/image.jpg";
+String url = "https://raw.githubusercontent.com/SolderedElectronics/Inkplate-Arduino-library/master/examples/Inkplate10/Advanced/WEB_WiFi/Inkplate10_Show_JPG_With_HTTPClient/image.jpg";
 
 /***********************************************/