Merge pull request #25 from DCC-EX:devel

Production release v1.0.0

.github/workflows/arduino-lint.yml

@@ -5,7 +5,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4.1.1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
       - uses: arduino/arduino-lint-action@v1

.github/workflows/docs.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.1
       - name: Requirements
         run: |
           pip3 install -r requirements.txt

.github/workflows/tests.yml

@@ -1,18 +1,18 @@
-name: tests
+name: Run GoogleTest
 
 on:
   push:
-    branches: [main]
+    branches: [main, devel]
   pull_request:
-    branches: [main]
+    branches: [main, devel]
 
 jobs:
-  x86_64-linux-gnu-gcc:
+  build_run_tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 0
       - run: cmake -Bbuild
       - run: cmake --build build --parallel --target DCCEXProtocolTests
-      - run: ./build/tests/DCCEXProtocolTests --gtest_shuffle
+      - run: ./build/tests/DCCEXProtocolTests --gtest_shuffle --gtest_repeat=5 --gtest_recreate_environments_when_repeating

docs/usage.rst

@@ -87,6 +87,16 @@ Retrieving and referring to object lists
 
 To retrieve the various objects lists from |EX-CS|, use the `getLists(bool rosterRequired, bool turnoutListRequired, bool routeListRequired, bool turntableListRequired)` method within your `loop()` function to ensure these are retrieved successfully.
 
+If you have a lot of defined objects in your |EX-CS| (eg. 50+ turnouts or 50+ roster entries), you will likely need to increase the maximum number of parameters allowed when defining the DCCEXProtocol instance which is now a configurable parameter as of version 1.0.0 of the library.
+
+You can set the command buffer size and parameter count:
+
+.. code-block:: cpp
+
+  // dccexProtocol(maxCmdBuffer, maxCommandParams);
+  DCCEXProtocol dccexProtocol; // Use default 500 byte buffer, 50 parameters
+  DCCEXProtocol dccexProtocol(500, 100); // Use default 500 byte buffer, 100 parameters
+
 All objects are contained within linked lists and can be access via for loops:
 
 .. code-block:: cpp

library.properties

@@ -1,5 +1,5 @@
 name=DCCEXProtocol
-version=0.0.17
+version=1.0.0
 author=Peter Cole, Peter Akers <akersp62@gmail.com>
 maintainer=Peter Cole, Peter Akers <akersp62@gmail.com>
 sentence=DCC-EX Native Protocol implementation