update GitHub action (#24)

- update GitHub actions
- minor edits

.github/FUNDING.yml

@@ -1,4 +1,5 @@
 # These are supported funding model platforms
 
-github: RobTillaart
+github: RobTillaart  
+custom: "https://www.paypal.me/robtillaart"
 

.github/workflows/arduino-lint.yml

@@ -1,12 +1,12 @@
-
 name: Arduino-lint
 
 on: [push, pull_request]
 jobs:
   lint:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: arduino/arduino-lint-action@v1
         with:
           library-manager: update

.github/workflows/arduino_test_runner.yml

@@ -1,14 +1,14 @@
----
 name: Arduino CI
 
 on: [push, pull_request]
 
 jobs:
   runTest:
     runs-on: ubuntu-latest
+    timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

.github/workflows/jsoncheck.yml

@@ -9,10 +9,11 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: json-syntax-check
-        uses: limitusus/json-syntax-check@v1
+        uses: limitusus/json-syntax-check@v2
         with:
           pattern: "\\.json$"
 

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.2] - 2024-04-06
+- update GitHub actions
+- minor edits
+
+
 ## [0.3.1] - 2023-11-13
 - added experimental functions (to get feedback)
   - if these work depends on terminal (app) used.
@@ -14,7 +19,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - add initial version of **supportMatrix.md**
 - updated keywords.txt
 
-
 ## [0.3.0] - 2023-11-09
 - fix missing 0 in normal (#19, Kudos to d0m1n1qu3)
 - fix basic escape strings write length (normal, bold etc  eating one char).

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 Rob Tillaart
+Copyright (c) 2020-2024 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -24,6 +24,7 @@ The set of codes is large, however not all terminal types do support all codes.
 Sending these ANSI codes to a simple ASCII only terminal like the one in the Arduino
 IDE might result in garbage. So use with care.
 
+
 #### Breaking change 0.2.0
 
 The **gotoXY(x, y)** has changed as the X and Y coordinates were swapped.
@@ -34,7 +35,8 @@ The code has been updated to explicitly mention which is row and which is column
 
 #### Related
 
-https://en.wikipedia.org/wiki/ANSI_escape_code
+- https://en.wikipedia.org/wiki/ANSI_escape_code
+- https://github.com/RobTillaart/LineFormatter
 
 
 ## Terminals tested
@@ -229,10 +231,11 @@ Although it are small improvements these add up.
 - move code from .h to .cpp
 - more derived classes
 
+
 #### Wont
 
 - move static strings to PROGMEM? as defines?
-  roughly ~20 bytes progmem for 4 bytes RAM...
+  roughly ~20 bytes PROGMEM for 4 bytes RAM...
 
 
 ## Support

ansi.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: ansi.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.1
+// VERSION: 0.3.2
 // PURPOSE: Arduino library to send ANSI escape sequences
 //    DATE: 2020-04-28
 //     URL: https://github.com/RobTillaart/ANSI

ansi.h

@@ -2,15 +2,15 @@
 //
 //    FILE: ansi.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.1
+// VERSION: 0.3.2
 // PURPOSE: Arduino library to send ANSI escape sequences
 //    DATE: 2020-04-28
 //     URL: https://github.com/RobTillaart/ANSI
 
 
 #include "Arduino.h"
 
-#define ANSI_LIB_VERSION        (F("0.3.1"))
+#define ANSI_LIB_VERSION        (F("0.3.2"))
 
 
 class ANSI : public Stream
@@ -115,7 +115,7 @@ class ANSI : public Stream
   int deviceType(uint32_t timeout = 100);
 
 
-  //  SCREENSIZE 
+  //  SCREENSIZE
   //  - https://github.com/RobTillaart/ANSI/pull/16
   bool readCursorPosition(uint16_t &w, uint16_t &h, uint32_t timeout = 100);
   bool getScreenSize(uint16_t &w, uint16_t &h, uint32_t timeout = 100);

examples/ansiDemo01/ansiDemo01.ino

@@ -48,7 +48,7 @@ void setup()
   delay(1000);
 
   ansi.clearScreen();
-  // 4 bit color test
+  //  4 bit color test
   for (int color = 0; color < 16; ++color) {
     ansi.foreground(color);
     ansi.print("foreground");
@@ -70,7 +70,7 @@ void setup()
   delay(1000);
 
   ansi.clearScreen();
-  // 8 bit color test
+  //  8 bit color test
   ansi.foreground(ansi.rgb2color(180, 0, 158));
   ansi.print("foreground");
   ansi.normal();
@@ -100,8 +100,8 @@ void setup()
   ansi.strikeThrough();
   ansi.println("strikethrough");
   ansi.normal();
-    
-  // RGB color test
+
+  //  RGB color test
   ansi.println("Experimental");
   ansi.setRGBforeground(180, 0, 158);
   ansi.print("foreground");

examples/ansiDemo02/ansiDemo02.ino

@@ -17,7 +17,7 @@ void setup()
 {
   Serial.begin(115200);
 
-  // SPLASH SCREEN
+  //  SPLASH SCREEN
   ansi.clearScreen();
   ansi.gotoXY(10, 8);
   ansi.bold();
@@ -30,7 +30,7 @@ void setup()
 
 void loop()
 {
-  // DISPLAY TEMPERATURE (dummy)
+  //  DISPLAY TEMPERATURE (dummy)
   ansi.gotoXY(10, 6);
   ansi.print("TEMP:       ");
   ansi.gotoXY(16, 6);
@@ -39,7 +39,7 @@ void loop()
   ansi.print(t);
   ansi.foreground(ansi.white);
 
-  // DISPLAY HUMIDITY (dummy)
+  //  DISPLAY HUMIDITY (dummy)
   ansi.gotoXY(10, 7);
   ansi.print(" HUM:       ");
   ansi.gotoXY(16, 7);
@@ -48,7 +48,7 @@ void loop()
   ansi.print(t);
   ansi.foreground(ansi.white);
 
-  // DISPLAY UV (dummy)
+  //  DISPLAY UV (dummy)
   ansi.gotoXY(10, 8);
   ansi.print("  UV:       ");
   ansi.gotoXY(16, 8);
@@ -59,18 +59,18 @@ void loop()
   ansi.print(d, 2);
   ansi.foreground(ansi.white);
 
-  // DISPLAY bargraph (dummy)
+  //  DISPLAY bar graph (dummy)
   ansi.gotoXY(10, 10);
   ansi.print(" BAR:");
   ansi.gotoXY(16, 10);
   int x = random(10);
   for (int i = 0; i < 10; i++) ansi.print(i <= x ? ">" : " ");
 
-  // DISPLAY password (dummy)
+  //  DISPLAY password (dummy)
   ansi.gotoXY(10, 12);
   ansi.print("PASS:");
   char buffer[20];
-  for (int i = 0; i < 16; i++) 
+  for (int i = 0; i < 16; i++)
   {
     int x = random(62);
     if (x < 26) buffer[i] = 'A' + random(26);
@@ -81,7 +81,7 @@ void loop()
   ansi.gotoXY(16, 12);
   ansi.print(buffer);
 
-  // DISPLAY TIME (dummy)
+  //  DISPLAY TIME (dummy)
   ansi.gotoXY(10, 2);
   ansi.print("TIME:         ");
   ansi.gotoXY(16, 2);

examples/ansi_clock/ansi_clock.ino

@@ -3,7 +3,6 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo clock
 //     URL: https://github.com/RobTillaart/ANSI
-//    (c) : MIT
 //
 //  use Tera Term to view 'different' clocks.
 
@@ -19,7 +18,7 @@ void setup()
 {
   Serial.begin(115200);
 
-  // SPLASH SCREEN
+  //  SPLASH SCREEN
   ansi.clearScreen();
   ansi.gotoXY(8, 10);
   ansi.bold();

examples/ansi_deviceType/ansi_deviceType.ino

@@ -4,7 +4,7 @@
 //     URL: https://github.com/RobTillaart/ANSI/issues/9
 
 //  NOT TESTED
-//  - WITH REAL TERMINAL
+//  - with real terminal
 //  - with dummies
 
 #include "ansi.h"

examples/ansi_performance/ansi_performance.ino

@@ -18,6 +18,7 @@ void setup()
 {
   Serial.begin(115200);
   Serial.println(__FILE__);
+  Serial.print("ANSI_LIB_VERSION: ");
   Serial.println(ANSI_LIB_VERSION);
   Serial.println();
   delay(100);

examples/ansi_screenSize/ansi_screenSize.ino

@@ -4,14 +4,14 @@
 // PURPOSE: demo of screen size detection
 //     URL: https://github.com/RobTillaart/ANSI
 //
-// These terminal emulators can report screen size:
-// * Linux, minicom
-// * Windows, PuTTY
-// * Windows, TeraTerm
-// * Windows, MobaXterm
+//  These terminal emulators can report screen size:
+//  * Linux, minicom
+//  * Windows, PuTTY
+//  * Windows, TeraTerm
+//  * Windows, MobaXterm
 //
-// UTF-8: To draw boxes with other than ASCII characters
-// an extra font has to be added.
+//  UTF-8: To draw boxes with other than ASCII characters
+//  an extra font has to be added.
 
 #include "ansi.h"
 
@@ -29,7 +29,7 @@ uint16_t w, h;
 void setup() {
   Serial.begin(115200);
 
-  ansi.print(" ");  // some bug, first character written is missing
+  ansi.print(" ");  //  some bug, first character written is missing
 
   if (!ansi.getScreenSize(w, h, 100)) {
     ansi.println(F("\n\n### ANSI escape codes not detected ###\n"
@@ -53,7 +53,7 @@ void setup() {
   ansi.print("\nUTF-8 test. Your should see at least one emoji here?: 🐛 🖥 ☎ ❤ ❣ ✂ ✈");
   delay(1000);
 
-  // Draw border
+  //  Draw border
   ansi.color(ansi.yellow, ansi.blue);
   for (uint16_t y = 1; y <= ansi.screenHeight(); y++) {
     ansi.gotoXY(1, y);

library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/ANSI.git"
   },
-  "version": "0.3.1",
+  "version": "0.3.2",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

library.properties

@@ -1,5 +1,5 @@
 name=ANSI
-version=0.3.1
+version=0.3.2
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library to send ANSI escape sequences.