0.2.9 BitArray

Author: RobTillaart

libraries/BitArray/.arduino-ci.yml

@@ -20,9 +20,9 @@ compile:
     # - due
     # - zero
     # - leonardo
-    - m4
+    # - m4
     - esp32
-    - esp8266
+    # - esp8266
     # - mega2560
     - rpipico
   libraries:

libraries/BitArray/.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

libraries/BitArray/.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

libraries/BitArray/.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:

libraries/BitArray/BitArray.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: BitArray.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.8
+// VERSION: 0.2.9
 // PURPOSE: BitArray library for Arduino
 //     URL: https://github.com/RobTillaart/BitArray
 //          http://forum.arduino.cc/index.php?topic=361167

libraries/BitArray/BitArray.h

@@ -2,7 +2,7 @@
 //
 //    FILE: bitArray.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.8
+// VERSION: 0.2.9
 // PURPOSE: BitArray library for Arduino
 //     URL: https://github.com/RobTillaart/BitArray
 
@@ -20,7 +20,7 @@
 
 #include "Arduino.h"
 
-#define BITARRAY_LIB_VERSION              (F("0.2.8"))
+#define BITARRAY_LIB_VERSION              (F("0.2.9"))
 
 
 #define BA_SEGMENT_SIZE                   200

libraries/BitArray/CHANGELOG.md

@@ -6,10 +6,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
-## [0.2.8] - 2024-04-09
+## [0.2.9] - 2025-11-22
 - update GitHub actions
+- update examples + rename
+- update readme.md
 - minor edits
 
+## [0.2.8] - 2024-04-09
+- update GitHub actions
+- minor edits
 
 ## [0.2.7] - 2023-10-18
 - update readme.md

libraries/BitArray/LICENSE

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

libraries/BitArray/README.md

@@ -26,7 +26,7 @@ into multiple bytes, and byte borders. Depending where an element is located wri
 can take more time. You need to check if your application needs more performance than
 this library can deliver. 
 
-#### Related
+### Related
 
 The BitArray library is one from a set of three:
 
@@ -35,14 +35,15 @@ The BitArray library is one from a set of three:
 - https://github.com/RobTillaart/nibbleArray for elements of 4 bits or smaller (values 0 .. 15).
 
 
-#### Notes
+### Notes
 
 The BitArray class allocates dynamic memory, so called BA_SEGMENTS, 
 each of 200 bytes.
 As the memory size of different processors differ the maximum amount of SEGMENTS 
 depends on architecture.
 
-The library is tested on AVR architecture only.
+The library is tested on AVR architecture only. On other processors e.g. ESP32 and RPI pico
+one might use a different implementation as continuous memory is possible.
 
 
 ## Interface
@@ -52,27 +53,41 @@ The library is tested on AVR architecture only.
 
 ```
 
-#### Constructor
+### Constructor
 
-- **BitArray()** Constructor
-- **~BitArray()** Destructor, frees dynamic memory
-- **uint8_t begin(const uint8_t bits, const uint16_t size)** Frees memory used and allocates the memory requested. 
+- **BitArray()** Constructor.
+- **~BitArray()** Destructor, frees dynamic memory.
+- **uint8_t begin(const uint8_t bits, const uint16_t size)**
+Frees memory used and allocates the memory requested. 
 The maximum number of elements is 65535 if memory allows, 
 the maximum element size is 32.
+Returns an error-code or **BA_OK**.
 
-Better names could be **bits == elementSize** and **size == elementCount**.
+Better names could be **bits ==> elementSize** and **size ==> elementCount**.
 
 
-#### Admin
+### Administrative
 
 - **uint16_t capacity()** idem.
 - **uint16_t memory()** idem.
 - **uint16_t bits()** idem.
 - **uint16_t segments()** idem.
+
+### Error
+
 - **uint8_t  getError()** idem.
 
+|  Error                |  value       |  Notes  |
+|:----------------------|:------------:|:--------|
+|  BA_ERR               |  0xFFFFFFFF  |
+|  BA_OK                |  0x00        |
+|  BA_NO_MEMORY_ERR     |  0x01        |
+|  BA_IDX_RANGE_ERR     |  0x02        |
+|  BA_ELEMENT_SIZE_ERR  |  0x03        |
+|  BA_SIZE_ERR          |  0x04        |
 
-#### base functions
+
+### base functions
 
 - **void clear()** sets all elements to 0.
 - **uint32_t get(const uint16_t index)** gets the value of the element at index.
@@ -97,13 +112,13 @@ Return value is maxValue (debug info).
 - return value **toggle()** could be new value? (0.3.0)
   - code prep is working (commented for now)
 - naming parameters ** begin()** (0.3.0)
-
+  - elementSize, elementCount
 
 #### Could
 
 - functional examples.
 - investigate element size of 64 (for doubles) and beyond.
-- move code to .cpp (0.3.0)
+- move code to .cpp (0.3.0), needed?
 
 
 #### Wont