Hello World examples (first attempt)

Author: luxzap7

examples/Inkplate10/Basic/Inkplate10_Hello_World/Inkplate10_Hello_World.ino

@@ -0,0 +1,41 @@
+/*
+   Inkplate10_Hello_World example for Soldered Inkplate 10
+
+   For this example, you only need a USB cable and your Inkplate 10.
+   Select "e-radionica Inkplate10" or "Soldered Inkplate10" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "e-radionica Inkplate10" or "Soldered Inkplate10" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+   It uses the Inkplate library's built-in text drawing functions, fully compatible with Adafruit GFX.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 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
+#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."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display(INKPLATE_1BIT); // Create an Inkplate object for Inkplate6 FLICK
+
+void setup() {
+    display.begin();             // Initialize the display hardware
+    display.clearDisplay();      // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);   // Set the text position to (10, 10) pixels
+    display.setTextSize(6);      // Set text size to 6 (default is 1)
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();           // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}

examples/Inkplate2/Basic/Inkplate2_Hello_World/Inkplate2_Hello_World.ino

@@ -0,0 +1,38 @@
+/*
+    Inkplate2_Hello_World example for Soldered Inkplate 2
+
+    For this example, you only need a USB cable and your Inkplate 2.
+    Select "Soldered Inkplate2" from the Tools -> Board menu in Arduino IDE.
+    Don't see the "Soldered Inkplate2" option? Follow this tutorial to add it:
+    https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+    This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+    It uses the Inkplate library's built-in text drawing function for Inkplate2.
+
+    Want to learn more about Inkplate? Visit www.inkplate.io
+    Need support? Visit our forums: https://forum.soldered.com/
+    24 April 2025 by Soldered
+*/
+
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATE2
+#error "Wrong board selection for this example, please select Soldered Inkplate2 in the boards menu."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display;     // Create an Inkplate object in monochrome mode
+
+void setup() {
+    display.begin();           // Initialize the display hardware
+    display.clearDisplay();    // Clear the software frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10); // Set the text position to (10, 10) pixels
+    display.setTextSize(2);    // Set text size to 2 (default is 1)
+    display.setTextColor(1);   // Set text color to black (1 = black, 0 = white)
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();         // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}

examples/Inkplate4TEMPERA/Basic/Inkplate4TEMPERA_Hello_World/Inkplate4TEMPERA_Hello_World.ino

@@ -0,0 +1,37 @@
+/*
+   Inkplate2_Hello_World.ino example for Soldered Inkplate 2
+
+   For this example, you only need a USB cable and your Inkplate 2.
+   Select "Soldered Inkplate2" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "Soldered Inkplate2" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+   It uses the Inkplate library's built-in text drawing function for Inkplate2.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 by Soldered
+*/
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATE4TEMPERA
+#error "Wrong board selection for this example, please select Inkplate 4 TEMPERA in the boards menu."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display(INKPLATE_3BIT); // Create an Inkplate object for Inkplate6 FLICK
+
+void setup() {
+    display.begin();             // Initialize the display hardware
+    display.clearDisplay();      // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);   // Set the text position to (10, 10) pixels
+    display.setTextSize(3);      // Set text size to 3 (default is 1)
+    display.setTextColor(BLACK); // Set text color to black (default is white)
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();           // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}

examples/Inkplate5/Basic/Inkplate5_Hello_World/Inkplate5_Hello_World.ino

@@ -0,0 +1,38 @@
+/*
+   Inkplate2_Hello_World example for Soldered Inkplate 2
+
+   For this example, you only need a USB cable and your Inkplate 2.
+   Select "Soldered Inkplate2" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "Soldered Inkplate2" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+   It uses the Inkplate library's built-in text drawing function for Inkplate2.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 by Soldered
+*/
+
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATE5
+#error "Wrong board selection for this example, please select Soldered Inkplate5 in the boards menu."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display(INKPLATE_3BIT); // Create an Inkplate object for Inkplate5V2
+
+void setup() {
+    display.begin();            // Initialize the display hardware
+    display.clearDisplay();     // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);  // Set the text position to (10, 10) pixels
+    display.setTextSize(8);     // Set text size to 8 (default is 1)
+    display.setTextColor(BLACK); // Set text color to black
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();          // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}

examples/Inkplate5V2/Basic/Inkplate5V2_Hello_World/Inkplate5V2_Hello_World.ino

@@ -0,0 +1,38 @@
+/*
+   Inkplate5V2_Hello_World example for Soldered Inkplate 5 V2
+
+   For this example, you only need a USB-C cable and your Inkplate 5 V2.
+   Select "Soldered Inkplate5 V2" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "Soldered Inkplate5 V2" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+   It uses the Inkplate library's built-in text drawing functions, fully compatible with Adafruit GFX.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 by Soldered
+*/
+
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATE5V2
+#error "Wrong board selection for this example, please select Soldered Inkplate5V2 in the boards menu."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display(INKPLATE_1BIT); // Create an Inkplate object for Inkplate5V2
+
+void setup() {
+    display.begin();            // Initialize the display hardware
+    display.clearDisplay();     // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);  // Set the text position to (10, 10) pixels
+    display.setTextSize(8);     // Set text size to 8 (default is 1)
+    display.setTextColor(BLACK); // Set text color to black
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();          // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}

examples/Inkplate6/Basic/Inkplate6_Hello_World/Inkplate6_Hello_World.ino

@@ -0,0 +1,37 @@
+/*
+   Inkplate6_Hello_World example for Soldered Inkplate 6
+
+   For this example, you only need a USB cable and your Inkplate 6.
+   Select "e-radionica Inkplate6" or "Soldered Inkplate6" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "e-radionica Inkplate6" or "Soldered Inkplate6" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+   It uses the Inkplate library's built-in text drawing functions, fully compatible with Adafruit GFX.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 by Soldered
+*/
+
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#if !defined(ARDUINO_ESP32_DEV) && !defined(ARDUINO_INKPLATE6V2)
+#error "Wrong board selection for this example, please select e-radionica Inkplate6 or Soldered Inkplate6 in the boards menu."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display(INKPLATE_1BIT); // Create an Inkplate object for Inkplate6 FLICK
+
+void setup() {
+    display.begin();             // Initialize the display hardware
+    display.clearDisplay();      // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);   // Set the text position to (10, 10) pixels
+    display.setTextSize(4);      // Set text size to 4 (default is 1)
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();           // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}

examples/Inkplate6COLOR/Basic/Inkplate6COLOR_Hello_Wold/Inkplate6COLOR_Hello_Wold.ino

@@ -0,0 +1,36 @@
+/*
+   Inkplate6COLOR_Hello_World example for Soldered Inkplate 6COLOR
+
+   Select "Soldered Inkplate 6COLOR" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "Soldered Inkplate 6COLOR" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen using the Inkplate 6COLOR library.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 by Soldered
+*/
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATECOLOR
+#error "Wrong board selection for this example, please select Soldered Inkplate 6COLOR in the boards menu."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display; // Create an Inkplate object for Inkplate 6COLOR
+
+void setup() {
+    display.begin();             // Initialize the display hardware
+    display.clearDisplay();      // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);   // Set the text position to (10, 10) pixels
+    display.setTextSize(4);      // Set text size to 4 (default is 1)
+    display.setTextColor(INKPLATE_BLACK); // Set text color to black
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();           // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}
+

examples/Inkplate6FLICK/Basic/Inkplate6FLICK_Hello_World/Inkplate6FLICK_Hello_World.ino

@@ -0,0 +1,37 @@
+/*
+   Inkplate6FLICK_Hello_World example for Soldered Inkplate 6FLICK
+
+   For this example, you only need a USB cable and your Inkplate 6FLICK.
+   Select "Soldered Inkplate 6FLICK" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "e-radionica Inkplate 6FLICK" or "Soldered Inkplate 6FLICK" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+   It uses the Inkplate library's built-in text drawing functions, fully compatible with Adafruit GFX.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 by Soldered
+*/
+
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#ifndef ARDUINO_INKPLATE6FLICK
+#error "Wrong board selection for this example, please select Soldered Inkplate 6 FLICK"
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display(INKPLATE_1BIT); // Create an Inkplate object for Inkplate6 FLICK
+
+void setup() {
+    display.begin();             // Initialize the display hardware
+    display.clearDisplay();      // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);   // Set the text position to (10, 10) pixels
+    display.setTextSize(4);      // Set text size to 4 (default is 1)
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();           // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}

examples/Inkplate6PLUS/Basic/Inkplate6PLUS_Hello_World/Inkplate6PLUS_Hello_World.ino

@@ -0,0 +1,37 @@
+/*
+   Inkplate6PLUS_Hello_World example for Soldered Inkplate 6PLUS
+
+   For this example, you only need a USB cable and your Inkplate 6PLUS.
+   Select "e-radionica Inkplate 6Plus" or "Soldered Inkplate 6Plus" from the Tools -> Board menu in Arduino IDE.
+   Don't see the "e-radionica Inkplate 6Plus" or "Soldered Inkplate 6Plus" option? Follow this tutorial to add it:
+   https://soldered.com/learn/add-inkplate-6-board-definition-to-arduino-ide/
+
+   This example demonstrates the most basic usage: displaying "Hello World!" on the screen.
+   It uses the Inkplate library's built-in text drawing functions, fully compatible with Adafruit GFX.
+
+   Want to learn more about Inkplate? Visit www.inkplate.io
+   Need support? Visit our forums: https://forum.soldered.com/
+   24 April 2025 by Soldered
+*/
+
+
+// Next 3 lines are a precaution, you can ignore those, and the example would also work without them
+#if !defined(ARDUINO_INKPLATE6PLUS) && !defined(ARDUINO_INKPLATE6PLUSV2)
+#error "Wrong board selection for this example, please select e-radionica Inkplate 6Plus or Soldered Inkplate 6Plus in the boards menu."
+#endif
+
+#include "Inkplate.h" // Include the Inkplate library
+Inkplate display(INKPLATE_1BIT); // Create an Inkplate object for Inkplate 6PLUS
+
+void setup() {
+    display.begin();             // Initialize the display hardware
+    display.clearDisplay();      // Clear the frame buffer (does NOT clear the physical screen)
+    display.setCursor(10, 10);   // Set the text position to (10, 10) pixels
+    display.setTextSize(4);      // Set text size to 4 (default is 1)
+    display.print("Hello World!"); // Print "Hello World!" at the set position
+    display.display();           // Refresh the e-paper display to show changes
+}
+
+void loop() {
+    // No code needed here for this example
+}