Merge pull request #194 from SolderedElectronics/dev

Dev to master

Author: BornaBiro

.github/workflows/compile.yml

@@ -35,17 +35,25 @@ jobs:
               fqbn: Inkplate_Boards:esp32:Inkplate6COLOR
             additional-sketch-paths: |
               - examples/Inkplate6COLOR
+          - board:
+              fqbn: Inkplate_Boards:esp32:Inkplate5
+            additional-sketch-paths: |
+              - examples/Inkplate5
+          - board:
+              fqbn: Inkplate_Boards:esp32:Inkplate2
+            additional-sketch-paths: |
+              - examples/Inkplate2
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install ESP32 platform dependencies
         run: pip3 install pyserial
       - name: Compile examples
         uses: arduino/compile-sketches@v1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           platforms: |
-            - source-url: https://github.com/e-radionicacom/Dasduino-Board-Definitions-for-Arduino-IDE/raw/master/package_Dasduino_Boards_index.json
+            - source-url: https://github.com/SolderedElectronics/Dasduino-Board-Definitions-for-Arduino-IDE/raw/dev/package_Dasduino_Boards_index.json
               name: Inkplate_Boards:esp32
 
           fqbn: ${{ matrix.board.fqbn }}

README.md

@@ -1,39 +1,47 @@
-# Inkplate Arduino library
+# Soldered Inkplate Arduino library
 
 [![Compile Sketches](https://github.com/e-radionicacom/Inkplate-Arduino-library/actions/workflows/compile.yml/badge.svg?branch=master)](https://github.com/e-radionicacom/Inkplate-Arduino-library/actions/workflows/compile.yml)
 
-![](https://www.crowdsupply.com/img/cf95/compare-peripheral_jpg_project-body.jpg)
+<p align="center">
+  <img src="https://raw.githubusercontent.com/SolderedElectronics/Inkplate-Arduino-library/dev/extras/InkplateImage.jpg">
+</p>
 
-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.
+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 and Bluetooth 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, Inkplate 6COLOR and Inkplate 2. 
+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) and [Inkplate 6COLOR](https://www.crowdsupply.com/soldered/inkplate-6color). Inkplate 2 was funded on [Kickstarter](https://www.kickstarter.com/projects/solderedelectronics/inkplate-2-a-easy-to-use-arduino-compatible-e-paper). All available to purchase from [soldered.com](https://soldered.com/categories/inkplate/). 
 
 ### 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/).
-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!
+1. [Install Inkplate board definition](https://github.com/SolderedElectronics/Dasduino-Board-Definitions-for-Arduino-IDE/blob/master/README.md) - add Inkplate 6/10/6PLUS/6COLOR/2 as a board into your Arduino IDE. Follow the instructions on the [link](https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/).
+2. Install CH340 drivers (if you don't have them yet) - instructions [here](https://soldered.com/learn/ch340-driver-installation-croduino-basic3-nova2/)
+3. Install Inkplate Arduino library - Install the library from the Arduino Library Manager (just type "Inkplate" and click "Install") or install it with this repo. If you don't know how, check our [tutorial](https://soldered.com/learn/arduino-library/#Kako%20instaliraty%20library?).
+4. You are ready to get started! Select Tools -> Board -> Inkplate Boards and then pick correct one, as well as correct COM port and upload!
 
 ### Code examples
 
-There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. Use Basic folder to get familiar with principles of using the Inkplate, such as modes (BW and Gray), how to write graphics and text or just basic capabilites such as touchscreen or front lighting (if your Inkplate supports it). In Advanced folder, you'll learn how to make HTTP/HTTPS requests, utilise low power, use touchpads or SD card. Finally, get easily started on some projects. More are added regularly, such as projects or community contributions.
+There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. Use Basic folder to get familiar with principles of using the Inkplate, such as modes (BW and Gray), how to write graphics and text or just basic capabilites such as touchscreen or front lighting (if your Inkplate supports it). In Advanced folder, you'll learn how to make HTTP/HTTPS requests, utilise low power, use touchpads or SD card, read RTC, etc. Finally, get easily started on some projects. Some of the projects are Google calendar, Weather Station, Image Frame, Crypto Currency Tracker and more. Examples and projects are added regularly by us or from community contributions. There is also a diagnostics folder with all tools for more advanced users (such as VCOM programming, waveform selection, etc).
 
 ### Documentation
 
 Find Inkplate documentation [here](https://inkplate.readthedocs.io/en/latest/arduino.html). 
 
 
-### Using Inkplate 6 with another microcontroller - Peripheral mode
+### Using Inkplate with another microcontroller - Peripheral mode
 
-As promised in an [early update](https://www.crowdsupply.com/e-radionica/inkplate-6/updates/successfully-funded-also-third-party-master-controllers-and-partial-updates), Inkplate 6's screen contents can be updated using 3rd controller (such as Raspberry Pi or another microcontroller). The Peripheral mode enables this. All brand new Inkplates come pre-programmed with slave mode and can be used right away.
+Inkplate screen contents can be updated using 3rd controller (such as Raspberry Pi or another microcontroller). The Peripheral mode enables this. All brand new Inkplates come pre-programmed with slave mode and can be used right away.
 
-It is based on UART (serial) communication - connect the Inkplate to "Controller" ("Master", if using old terminology) board either via USB cable or directly via ESP32 RX and TX pins. Using standard UART at 115200 baud, you can send commands to change screen contents. For example, send \*#H(000,000,"/img.bmp")\*\* to show image img.bmp from SD card on the screen. Find very documentation for using it [here](https://inkplate.readthedocs.io/en/latest/slave-mode.html).
+It is based on UART (serial) communication - connect the Inkplate to "Controller" ("Master", if using old terminology) board either via USB cable or directly via ESP32 RX and TX pins. Using standard UART at 115200 baud, you can send commands to change screen contents. For example, send \*#H(000,000,"/img.bmp")\*\* to show image img.bmp from SD card on the screen. Find very documentation for using it [here](https://inkplate.readthedocs.io/en/latest/peripheral-mode.html).
 
 ### Battery power
 
-Inkplate 6 has two options for powering it. First one is obvious - USB port at side of the board. Just plug any micro USB cable and you are good to go. Second option is battery. Supported batteries are standard Li-Ion/Li-Poly batteries with 3.7V nominal voltage. Connector for the battery is standard 2.00mm pitch JST connector. The onboard charger will charge the battery with 500mA when USB is plugged at the same time. You can use battery of any size or capacity if you don't have a enclosure. If you are using our enclosure, battery size shouldn't exceed 90mm x 40mm (3.5 x 1.57 inch) and 5mm (0.19 inch) in height. [This battery](https://e-radionica.com/en/li-ion-baterija-1200mah.html) is good fit for the Inkplate.
+Inkplate boards has two options for powering it. First one is obvious - USB port at side of the board. Just plug any micro USB cable and you are good to go. Second option is battery. Supported batteries are standard Li-Ion/Li-Poly batteries with 3.7V nominal voltage. Connector for the battery is standard 2.00mm pitch JST connector (except on Inkplate 2, it uses SMD solder pads for battery terminals). The onboard charger will charge the battery with 500mA when USB is plugged at the same time. You can use battery of any size or capacity if you don't have a enclosure. If you are using our enclosure, battery size shouldn't exceed 90mm x 40mm (3.5 x 1.57 inch) and 5mm (0.19 inch) in height (excluding Inkplate 2, it uses [this battery](https://soldered.com/product/li-ion-baterija-600mah-3-7v/). [This battery](https://soldered.com/product/li-ion-battery-1200mah-3-7v/) is good fit for the Inkplate. Also, Inkplate's hardware is specially optimized for low power consumption in deep sleep mode, making it extremely suitable for battery applications.
+
+#### ⚠️ WARNING
+Please check the polarity on the battery JST connector! Some batteries that can be purchased from the web have reversed polarity that can damage Inkplate board! You are safe if you are using the pouch battery from [soldered.com](https://soldered.com/categories/power-sources-batteries/batteries/lithium-batteries/) or Inkplate with the built-in battery . 
+
+#### ℹ NOTE
+CR2032 battery is only for RTC backup. Inkplate cannot be powered with it.
 
 ### Linux?
 
@@ -47,7 +55,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,19 +65,26 @@ 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)
-- OSHWA cerfiticate: [Inkplate 6](https://certification.oshwa.org/hr000003.html), [Inkplate 10](https://certification.oshwa.org/hr000006.html)
+- [Arduino library](https://github.com/SolderedElectronics/Inkplate-Arduino-library)
+- Hardware design:
+  - Soldered Inkplate 2 (comming soon!)
+  - Soldered Inkplate 6 (comming soon!)
+  - Soldered Inkplate 6PLUS (comming soon!)
+  - [Soldered Inkplate 10](https://github.com/SolderedElectronics/Soldered-Inkplate-10-hardware-design)
+  - Soldered Inkplate 6COLOR (comming soon!)
+  - [e-radionica.com Inkplate 6](https://github.com/SolderedElectronics/Inkplate-6-hardware)
+  - [e-radionica.com Inkplate 10](https://github.com/SolderedElectronics/Inkplate-10-hardware)
+  - [e-radionica.com Inkplate 6PLUS](https://github.com/SolderedElectronics/Inkplate-6PLUS-Hardware)
+  - e-radionica.com Inkplate 6COLOR (comming soon!)
+- [micropython Inkplate](https://github.com/SolderedElectronics/Inkplate-micropython)
+- [OSHWA cerfiticates](https://certification.oshwa.org/list.html?q=inkplate)
 
 ### Where to buy & other
 
-Inkplate 6 is available for purchase via:
+Inkplate boards are available for purchase via:
 
-- [e-radionica.com](https://e-radionica.com/en/inkplate.html)
-- [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6)
+- [soldered.com](https://soldered.com/categories/inkplate/)
+- [Crowd Supply](https://www.crowdsupply.com/soldered)
 - [Mouser](https://hr.mouser.com/Search/Refine?Keyword=inkplate)
-- [Pimoroni](https://shop.pimoroni.com/products/inkplate-6)
 
-For all questions and issues, please use our [forum](http://forum.e-radionica.com/en) to ask an question.
-For sales & collaboration, please reach us via [e-mail](mailto:[email protected]).
+For all questions and issues please reach us via [e-mail](mailto:[email protected]) or our [contact form](https://soldered.com/contact/).

examples/Inkplate10/Advanced/Communications/Inkplate10_Bluetooth_Peripheral_Mode/Inkplate10_Bluetooth_Peripheral_Mode.ino

@@ -6,59 +6,78 @@
    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
 
    This example shows how to use Inkplate as a peripheral device over Bluetooth.
-   Note: for this to work you need to use ESP32 Wroover Board definition, as ours currently has a bug :(
+   More about peripheral mode: https://inkplate.readthedocs.io/en/latest/peripheral-mode.html
+
+   Upload this example to the Inkplate and connect your phone to it via Bluetooth.
+   First, you have to pair the Inkplate with your phone in Bluetooth settings in your phone, then go to the
+   Serial Bluetooth Terminal app and you can find the Inkplate in the device list. You can use another similar app.
+   If Bluetooth starts successfully, you can send commands from your phone. Don't forget you need to send #L(1)* after
+   each command to show it on the display (equal to display->display()).
 
    Want to learn more about Inkplate? Visit www.inkplate.io
    Looking to get support? Write on our forums: https://forum.soldered.com/
-   15 July 2020 by Soldered
+   28 March 2023 by Soldered
 */
 
 // Next 3 lines are a precaution, you can ignore those, and the example would also work without them
 #if !defined(ARDUINO_INKPLATE10) && !defined(ARDUINO_INKPLATE10V2)
-#error "Wrong board selection for this example, please select e-radionica Inkplate10 or Soldered Inkplate10 in the boards menu."
+#error                                                                                                                 \
+    "Wrong board selection for this example, please select e-radionica Inkplate10 or Soldered Inkplate10 in the boards menu."
 #endif
 
-#include "Inkplate.h"
-
+// Include Inkplate and BluetoothSerial library to the sketch
 #include "BluetoothSerial.h"
+#include "Inkplate.h"
 
-#define BUFFER_SIZE 1000
-
+// Include peripheral functions
 #include "Peripheral.h"
 
-// Declare Inkplate and SerialBluetooth objects
+// Create an object on Inkplate library and also set library into 1-bit mode (BW)
 Inkplate display(INKPLATE_1BIT);
+
+// Create SerialBT object for Bluetooth communication
 BluetoothSerial SerialBT;
 
+// Size of buffer for receiving commands
+#define BUFFER_SIZE 1000
+
 // Temporary buffer to send to Peripheral mode code
 char commandBuffer[BUFFER_SIZE + 1];
 
 void setup() // Initialize everything
 {
+    // Init serial communication
     Serial.begin(115200);
 
-    if (!SerialBT.begin("ESP32"))
+    // Init Inkplate library (you should call this function ONLY ONCE)
+    display.begin();
+
+    // Init BT communication
+    if (!SerialBT.begin("Inkplate10"))
     {
         Serial.println("An error occurred initializing Bluetooth");
     }
-
-    display.begin();
+    else
+    {
+        Serial.println("The device started, now you can pair it with Bluetooth and send commands!");
+    }
 }
 
 void loop()
 {
-    while (SerialBT.available()) // When Bluetooth available save it and pass to Peripheral.h code
+    // When Bluetooth available save it and pass to Peripheral.h code
+    while (SerialBT.available())
     {
         for (int i = 0; i < (BUFFER_SIZE - 1); i++)
         {
             commandBuffer[i] = commandBuffer[i + 1];
         }
         commandBuffer[BUFFER_SIZE - 1] = SerialBT.read();
-        Serial.print(commandBuffer[BUFFER_SIZE - 1]);
     }
 
     // Function in peripheral.h
-    run(commandBuffer, BUFFER_SIZE);
+    run(commandBuffer, BUFFER_SIZE, &display, &SerialBT);
 
+    // Wait a bit
     delay(50);
 }