Merge origin/master into muse_anthena

Author: Andrey1994

.github/workflows/conan.yml

@@ -17,6 +17,10 @@ jobs:
       uses: actions/checkout@v2
     - name: Add msbuild to PATH
       uses: microsoft/setup-msbuild@v1.0.2
+    - name: install Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
     - name: Get Conan
       uses: turtlebrowser/get-conan@main
       with:

.github/workflows/deploy.yml

@@ -28,11 +28,14 @@ jobs:
     # Install Dependencies
     - name: Clone Repository
       uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
     - name: Install Python Deploy Tools
       run: |
-        python -m pip install wheel
-        python -m pip install twine
-        python -m pip install awscli
+        python -m pip install --upgrade pip
+        python -m pip install setuptools wheel twine awscli
       shell: cmd
     - name: Install Node
       uses: actions/setup-node@v3

.github/workflows/deploy_cpp_libs.yml

@@ -59,7 +59,7 @@ jobs:
       max-parallel: 16
       matrix:
         build_type: [Release, Debug]
-        os: [ubuntu-latest, macos-13]
+        os: [ubuntu-latest, macos-14]
 
     steps:
     - name: Clone Repository
@@ -69,13 +69,13 @@ jobs:
       with:
         cmake-version: '3.21.x'
     - name: Install Ninja
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       uses: seanmiddleditch/gha-setup-ninja@master
       with:
         version: 1.10.2
     # build simpleble outside from brainflow because of different deployment targets
     - name: Compile SimpleBLE MacOS
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       run: |
         mkdir $GITHUB_WORKSPACE/third_party/SimpleBLE/simpleble/build
         cd $GITHUB_WORKSPACE/third_party/SimpleBLE/simpleble/build
@@ -86,7 +86,7 @@ jobs:
       env:
         BUILD: ${{ matrix.build_type }}
     - name: Compile BrainFlow for MacOS
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       run: |
         mkdir $GITHUB_WORKSPACE/build
         cd $GITHUB_WORKSPACE/build

.github/workflows/run_unix.yml

@@ -10,7 +10,7 @@ jobs:
       fail-fast: false
       max-parallel: 4
       matrix:
-        os: [ubuntu-latest, macos-13]
+        os: [ubuntu-latest, macos-14]
 
     steps:
     # compile and prepare env
@@ -44,14 +44,15 @@ jobs:
       run: |
         npm install -g ts-node
     - name: Install Ninja
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       uses: seanmiddleditch/gha-setup-ninja@master
       with:
         version: 1.10.2
     - name: Install Julia
-      uses: julia-actions/setup-julia@v1
+      uses: julia-actions/setup-julia@v2
       with:
-        version: 1.3.1
+        version: '1'
+        arch: 'default'
     - name: Setup Cmake
       uses: jwlawson/actions-setup-cmake@v1.13
       with:
@@ -62,15 +63,15 @@ jobs:
         java-version: 11.0.3
     # build simpleble outside from brainflow because of different deployment targets
     - name: Compile SimpleBLE MacOS
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       run: |
         mkdir $GITHUB_WORKSPACE/third_party/SimpleBLE/simpleble/build
         cd $GITHUB_WORKSPACE/third_party/SimpleBLE/simpleble/build
         cmake -G Ninja -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" -DCMAKE_OSX_DEPLOYMENT_TARGET=10.15 -DCMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/installed -DCMAKE_BUILD_TYPE=Release ..
         ninja
         ninja install
     - name: Compile BrainFlow MacOS
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       run: |
         mkdir $GITHUB_WORKSPACE/build
         cd $GITHUB_WORKSPACE/build
@@ -153,7 +154,7 @@ jobs:
     - name: Run unit tests
       run: $GITHUB_WORKSPACE/build/tests/brainflow_tests
     - name: Synthetic C# Test MacOS
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       run: |
         cd $GITHUB_WORKSPACE/csharp_package/brainflow/examples/brainflow_get_data/bin/Release/net7.0
         cp $GITHUB_WORKSPACE/installed/lib/libBoardController.dylib $GITHUB_WORKSPACE/csharp_package/brainflow/examples/brainflow_get_data/bin/Release/net7.0/
@@ -163,7 +164,7 @@ jobs:
         LD_LIBRARY_PATH: ${{ github.workspace }}/installed/lib
         DYLD_LIBRARY_PATH: ${{ github.workspace }}/installed/lib
     - name: EEG Metrics C# Test MacOS
-      if: (matrix.os == 'macos-13')
+      if: (matrix.os == 'macos-14')
       run: |
         cd $GITHUB_WORKSPACE/csharp_package/brainflow/examples/eeg_metrics/bin/Release/net7.0
         cp $GITHUB_WORKSPACE/installed/lib/libBoardController.dylib $GITHUB_WORKSPACE/csharp_package/brainflow/examples/eeg_metrics/bin/Release/net7.0/
@@ -412,7 +413,7 @@ jobs:
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
     - name: Push Libraries MacOS Dev
-      if: ${{ github.event_name == 'push' && matrix.os == 'macos-13' && github.repository == 'brainflow-dev/brainflow' }}
+      if: ${{ github.event_name == 'push' && matrix.os == 'macos-14' && github.repository == 'brainflow-dev/brainflow' }}
       run: |
         aws s3 cp $GITHUB_WORKSPACE/installed/lib/ s3://brainflow/$GITHUB_SHA/macos_release --recursive
       env:

.github/workflows/run_windows.yml

@@ -21,6 +21,10 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '7.0.x'
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
     - name: Set Version
       id: version
       run: if ("tag" -eq $Env:GITHUB_REF_TYPE) { echo "::set-output name=version::$Env:GITHUB_REF_NAME" } else { echo "::set-output name=version::$Env:GITHUB_SHA" }
@@ -67,6 +71,7 @@ jobs:
       shell: cmd
     - name: Install Emulator
       run: |
+        pip install setuptools
         pip install %GITHUB_WORKSPACE%\emulator\
         cd %GITHUB_WORKSPACE%
         .\emulator\brainflow_emulator\com0com\certmgr.exe  /add %GITHUB_WORKSPACE%\emulator\brainflow_emulator\com0com\com0com.cer /s /r localMachine root

.gitignore

@@ -20,6 +20,7 @@
 x64/
 x86/
 bld/
+build/
 [Bb]in/
 [Oo]bj/
 [Ll]og/

.readthedocs.yml

@@ -8,7 +8,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.9"
     # You can also specify other tool versions:
     # nodejs: "20"
     # rust: "1.70"
@@ -32,4 +32,4 @@ formats:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
-  - requirements: docs/requirements.txt
+  - requirements: docs/requirements.txt

README.md

@@ -49,7 +49,7 @@ The BrainFlow project strives to abide by generally accepted best practices in o
 |          Build Type         	|                                                                                Status                                                                               	|
 |:---------------------------:	|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:	|
 |        Windows Tests        	|   [![Run Windows](https://github.com/brainflow-dev/brainflow/actions/workflows/run_windows.yml/badge.svg?branch=master)](https://github.com/brainflow-dev/brainflow/actions/workflows/run_windows.yml)  	|
-| Unix(Linix and MacOS) Tests 	| [![Run Unix](https://github.com/brainflow-dev/brainflow/actions/workflows/run_unix.yml/badge.svg?branch=master)](https://github.com/brainflow-dev/brainflow/actions/workflows/run_unix.yml) 	|
+| Unix(Linux and MacOS) Tests 	| [![Run Unix](https://github.com/brainflow-dev/brainflow/actions/workflows/run_unix.yml/badge.svg?branch=master)](https://github.com/brainflow-dev/brainflow/actions/workflows/run_unix.yml) 	|
 |        Android Tests        	|   [![Run Android NDK](https://github.com/brainflow-dev/brainflow/actions/workflows/run_android.yml/badge.svg?branch=master)](https://github.com/brainflow-dev/brainflow/actions/workflows/run_android.yml)   	|
 |         Alpine Tests        	|       [![Run Alpine](https://github.com/brainflow-dev/brainflow/actions/workflows/run_alpine.yml/badge.svg?branch=master)](https://github.com/brainflow-dev/brainflow/actions/workflows/run_alpine.yml)       	|
 |        Valgrind Tests       	|     [![Run Valgrind](https://github.com/brainflow-dev/brainflow/actions/workflows/valgrind.yml/badge.svg?branch=master)](https://github.com/brainflow-dev/brainflow/actions/workflows/valgrind.yml)      	|

cpp_package/src/board_shim.cpp

@@ -235,7 +235,8 @@ std::string BoardShim::config_board (std::string config)
     int response_len = 0;
     char response[8192];
     int res = ::config_board (
-        config.c_str (), response, &response_len, board_id, serialized_params.c_str ());
+        config.c_str (), response, &response_len, sizeof (response), board_id,
+        serialized_params.c_str ());
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to config board", res);
@@ -281,6 +282,18 @@ int BoardShim::get_board_id ()
     return master_board_id;
 }
 
+int BoardShim::get_board_sampling_rate (int preset)
+{
+    int sampling_rate = -1;
+    int res =
+        ::get_board_sampling_rate (preset, &sampling_rate, board_id, serialized_params.c_str ());
+    if (res != (int)BrainFlowExitCodes::STATUS_OK)
+    {
+        throw BrainFlowException ("failed to get board sampling rate", res);
+    }
+    return sampling_rate;
+}
+
 //////////////////////////////////////////
 ///////////// data desc methods //////////
 //////////////////////////////////////////
@@ -289,7 +302,8 @@ json BoardShim::get_board_descr (int board_id, int preset)
 {
     char board_descr_str[16000];
     int string_len = 0;
-    int res = ::get_board_descr (board_id, preset, board_descr_str, &string_len);
+    int res =
+        ::get_board_descr (board_id, preset, board_descr_str, &string_len, sizeof (board_descr_str));
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to get board info", res);
@@ -368,7 +382,7 @@ std::vector<std::string> BoardShim::get_eeg_names (int board_id, int preset)
 {
     char eeg_names[4096];
     int string_len = 0;
-    int res = ::get_eeg_names (board_id, preset, eeg_names, &string_len);
+    int res = ::get_eeg_names (board_id, preset, eeg_names, &string_len, sizeof (eeg_names));
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to get board info", res);
@@ -401,7 +415,7 @@ std::string BoardShim::get_device_name (int board_id, int preset)
 {
     char name[4096];
     int string_len = 0;
-    int res = ::get_device_name (board_id, preset, name, &string_len);
+    int res = ::get_device_name (board_id, preset, name, &string_len, sizeof (name));
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to get board info", res);
@@ -602,4 +616,4 @@ std::string BoardShim::get_version ()
     std::string verion_str (version, string_len);
 
     return verion_str;
-}
+}

cpp_package/src/inc/board_shim.h

@@ -255,6 +255,8 @@ class BoardShim
         int num_samples, int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
     /// Get board id, for some boards can be different than provided (playback, streaming)
     int get_board_id ();
+    /// get actual sampling rate for prepared board session
+    int get_board_sampling_rate (int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
     /// get number of packages in ringbuffer
     int get_board_data_count (int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
     /// get all collected data and flush it from internal buffer