update GitHub actions

Author: RobTillaart

.github/workflows/arduino-lint.yml

@@ -6,8 +6,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
-      - uses: arduino/arduino-lint-action@v1
+      - uses: actions/checkout@v5
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
           compliance: strict

.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

.github/workflows/jsoncheck.yml

@@ -5,13 +5,15 @@ on:
     paths:
       - '**.json'
   pull_request:
+    paths:
+      - '**.json'
 
 jobs:
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:

CHANGELOG.md

@@ -6,10 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.2.7] - 2025-09-09
+- update GitHub actions
+- minor edits
+
 ## [0.2.6] - 2023-11-14
 - update readme.md
 
-
 ## [0.2.5] - 2023-02-08
 - update readme.md
 - fix keywords.txt

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2024 Rob Tillaart
+Copyright (c) 2017-2025 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

@@ -23,13 +23,13 @@ The nibbleArray is an array that stores 2 nibbles in a byte therefore it is
 twice as small as a normal array.
 
 The current implementation can hold 510 elements. This is due a limitation of
-the UNO which can **allocate** max 255 bytes in one **malloc()** call.
+the UNO R3 which can **allocate** max 255 bytes in one **malloc()** call.
 
 This **NIBBLEARRAY_MAXSIZE** can be defined compile time "-D NIBBLEARRAY_MAXSIZE" 
 or one can adjust it in the library if other platforms can allocate more memory.
 
 
-#### Related
+### Related
 
 The BitArray library is one from a set of three:
 
@@ -44,14 +44,14 @@ The BitArray library is one from a set of three:
 #include "nibbleArray.h"
 ```
 
-#### Constructor
+### Constructor
 
 - **nibbleArray(uint16_t size)** constructor
 - **uint16_t size()** returns the size of the array.
 - **uint16_t memory()** returns the memory used in bytes.
 
 
-#### Base
+### Base
 
 - **uint8_t set(uint16_t index, uint8_t value)** set a value in the nibbleArray.
 Index must be in range otherwise 0xFF = NIBBLEARRAY_ERROR_INDEX will be returned.

examples/nibbleArray_demo/nibbleArray_demo.ino

@@ -2,7 +2,6 @@
 //    FILE: nibbleArray_demo.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo nibble array
-//    DATE: 2020-06-21
 //     URL: https://github.com/RobTillaart/nibbleArray
 
 
@@ -14,9 +13,11 @@ nibbleArray na(500);
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("NIBBLEARRAY_LIB_VERSION: ");
   Serial.println(NIBBLEARRAY_LIB_VERSION);
+  Serial.println();
 
   test_1();
 
@@ -31,13 +32,13 @@ void test_1()
 
   na.clear();
 
-  // 500 throws with 3 dices (3..18 ==> 0..15)
+  //  500 throws with 3 dices (3..18 ==> 0..15)
   for (int i = 0; i < 500; i++)
   {
-    uint8_t sum = random(6);  // 0..5
+    uint8_t sum = random(6);  //  0..5
     sum += random(6);
     sum += random(6);
-    na.set(i, sum);       // diff from na.set(i, random(16));
+    na.set(i, sum);           //  diff from na.set(i, random(16));
   }
 
   for (int i = 0; i < 500; i++)
@@ -54,7 +55,7 @@ void test_1()
   {
     Serial.print(i);
     Serial.print("\t");
-    // for (int p = 0; p < ar[i]; p++) Serial.print(">");
+    //  for (int p = 0; p < ar[i]; p++) Serial.print(">");
     Serial.print(ar[i]);
     Serial.println();
   }
@@ -73,17 +74,17 @@ void test_1()
   {
     uint8_t octave   = na.get(i++);
     uint8_t note     = na.get(i++);
-    uint8_t duration = na.get(i++); // in 1/16th
+    uint8_t duration = na.get(i++);  //  in 1/16th
     play(octave, note, duration);
-    // sendMIDI(note, duration);
+    //  sendMIDI(note, duration);
   }
 }
 
 
 void play(uint8_t octave, uint8_t note, uint8_t duration)
 {
   Serial.print("Play: ");
-  // Serial.print(octave);
+  //  Serial.print(octave);
   Serial.print(" ");
   switch (note)
   {
@@ -146,5 +147,5 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

examples/nibbleArray_performance/nibbleArray_performance.ino

@@ -2,15 +2,15 @@
 //    FILE: nibbleArray_performance.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo performance nibble array
-//    DATE: 2020-06-21
 //     URL: https://github.com/RobTillaart/nibbleArray
 
 
 #include "nibbleArray.h"
 
 
-// AVR UNO can handle only 510
-// ESP32 can do more but depends on RTOS limits
+//  AVR UNO can handle only 510
+//  ESP32 can do more but depends on RTOS limits
+
 
 #define NA_SIZE     500
 
@@ -23,13 +23,16 @@ volatile long x = 0;
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("NIBBLEARRAY_LIB_VERSION: ");
   Serial.println(NIBBLEARRAY_LIB_VERSION);
+  Serial.println();
+  delay(100);
 
-  // performance tests are run first once in a loop
-  // then twice in a loop, so the difference is without
-  // the loop overhead.
+  //  performance tests are run first once in a loop
+  //  then twice in a loop, so the difference is without
+  //  the loop overhead.
   test_size();
   test_get();
   test_set();
@@ -42,6 +45,10 @@ void setup()
 
 void test_size()
 {
+  Serial.println();
+  Serial.println(__FUNCTION__);
+  delay(10);
+
   Serial.print("Nibble array size:\t");
   Serial.println(na.size());
   Serial.print("Nibble array mem:\t");
@@ -52,8 +59,10 @@ void test_size()
 
 void test_get()
 {
-  Serial.println("\nget");
+  Serial.println();
+  Serial.println(__FUNCTION__);
   delay(10);
+
   start = micros();
   for (uint16_t i = 0; i < na.size(); i++)
   {
@@ -85,8 +94,10 @@ void test_get()
 
 void test_set()
 {
-  Serial.println("\nset");
+  Serial.println();
+  Serial.println(__FUNCTION__);
   delay(10);
+
   start = micros();
   for (uint16_t i = 0; i < na.size(); i++)
   {
@@ -116,8 +127,10 @@ void test_set()
 
 void test_clear()
 {
-  Serial.println("\nclear");
+  Serial.println();
+  Serial.println(__FUNCTION__);
   delay(10);
+
   start = micros();
   na.clear();
   stop = micros();
@@ -136,6 +149,7 @@ void test_clear()
   Serial.print("DELTA:\t\t");
   Serial.println(d2 - d1);
   delay(100);
+
   for (uint16_t i = 0; i < na.size(); i++)
   {
     if (na.get(i) != 0)
@@ -149,15 +163,18 @@ void test_clear()
 
 void test_setAll()
 {
-  Serial.println("\nsetAll");
+  Serial.println();
+  Serial.println(__FUNCTION__);
   delay(10);
+
   start = micros();
   na.setAll(1);
   stop = micros();
   Serial.print("DURATION:\t");
   d1 = stop - start;
   Serial.println(d1);
   delay(100);
+
   for (uint16_t i = 0; i < na.size(); i++)
   {
     if (na.get(i) != 1)

library.json

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

library.properties

@@ -1,5 +1,5 @@
 name=NibbleArray
-version=0.2.6
+version=0.2.7
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Library to implement a compact array of nibbles (4 bit).