Merge branch 'master' of https://github.com/brainflow-dev/brainflow

Author: Andrey1994

.github/workflows/deploy_cpp_libs.yml

@@ -70,9 +70,11 @@ jobs:
         cmake-version: '3.21.x'
     - name: Install Ninja
       if: (matrix.os == 'macos-14')
-      uses: seanmiddleditch/gha-setup-ninja@master
-      with:
-        version: 1.10.2
+      run: |
+        if ! command -v ninja; then
+          brew install ninja
+        fi
+        ninja --version
     # build simpleble outside from brainflow because of different deployment targets
     - name: Compile SimpleBLE MacOS
       if: (matrix.os == 'macos-14')

.github/workflows/run_unix.yml

@@ -45,9 +45,11 @@ jobs:
         npm install -g ts-node
     - name: Install Ninja
       if: (matrix.os == 'macos-14')
-      uses: seanmiddleditch/gha-setup-ninja@master
-      with:
-        version: 1.10.2
+      run: |
+        if ! command -v ninja; then
+          brew install ninja
+        fi
+        ninja --version
     - name: Install Julia
       uses: julia-actions/setup-julia@v2
       with:

cpp_package/src/board_shim.cpp

@@ -282,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 //////////
 //////////////////////////////////////////
@@ -496,6 +508,18 @@ std::vector<int> BoardShim::get_ppg_channels (int board_id, int preset)
     return std::vector<int> (channels, channels + len);
 }
 
+std::vector<int> BoardShim::get_optical_channels (int board_id, int preset)
+{
+    int channels[MAX_CHANNELS];
+    int len = 0;
+    int res = ::get_optical_channels (board_id, preset, channels, &len);
+    if (res != (int)BrainFlowExitCodes::STATUS_OK)
+    {
+        throw BrainFlowException ("failed to get board info", res);
+    }
+    return std::vector<int> (channels, channels + len);
+}
+
 std::vector<int> BoardShim::get_accel_channels (int board_id, int preset)
 {
     int channels[MAX_CHANNELS];

cpp_package/src/inc/board_shim.h

@@ -138,6 +138,13 @@ class BoardShim
      */
     static std::vector<int> get_ppg_channels (
         int board_id, int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
+    /**
+     * get row indices which hold optical data
+     * @param board_id board id of your device
+     * @throw BrainFlowException If this board has no such data exit code is UNSUPPORTED_BOARD_ERROR
+     */
+    static std::vector<int> get_optical_channels (
+        int board_id, int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
     /**
      * get row indices which hold EDA data
      * @param board_id board id of your device
@@ -255,6 +262,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

csharp_package/brainflow/brainflow/board_controller_library.cs

@@ -122,7 +122,8 @@ public enum BoardIds
         OB3000_24_CHANNELS_BOARD = 63,
         BIOLISTENER_BOARD = 64,
         IRONBCI_32_BOARD = 65,
-        NEUROPAWN_KNIGHT_BOARD_IMU = 66
+        NEUROPAWN_KNIGHT_BOARD_IMU = 66,
+        MUSE_S_ANTHENA_BOARD = 67
     };
 
 
@@ -159,6 +160,8 @@ public static class BoardControllerLibrary64
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_sampling_rate (int board_id, int preset, int[] sampling_rate);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
+        public static extern int get_board_sampling_rate (int preset, int[] sampling_rate, int board_id, string input_json);
+        [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_timestamp_channel (int board_id, int preset, int[] timestamp_channel);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_marker_channel (int board_id, int preset, int[] marker_channel);
@@ -181,6 +184,8 @@ public static class BoardControllerLibrary64
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_ppg_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
+        public static extern int get_optical_channels (int board_id, int preset, int[] channels, int[] len);
+        [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_accel_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_rotation_channels (int board_id, int preset, int[] channels, int[] len);
@@ -249,6 +254,8 @@ public static class BoardControllerLibrary32
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_sampling_rate (int board_id, int preset, int[] sampling_rate);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
+        public static extern int get_board_sampling_rate (int preset, int[] sampling_rate, int board_id, string input_json);
+        [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_timestamp_channel (int board_id, int preset, int[] timestamp_channel);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_marker_channel (int board_id, int preset, int[] marker_channel);
@@ -271,6 +278,8 @@ public static class BoardControllerLibrary32
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_ppg_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
+        public static extern int get_optical_channels (int board_id, int preset, int[] channels, int[] len);
+        [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_accel_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_rotation_channels (int board_id, int preset, int[] channels, int[] len);
@@ -535,6 +544,19 @@ public static int get_sampling_rate (int board_id, int preset, int[] sampling_ra
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
         }
 
+        public static int get_board_sampling_rate (int preset, int[] sampling_rate, int board_id, string input_json)
+        {
+            switch (PlatformHelper.get_library_environment ())
+            {
+                case LibraryEnvironment.x64:
+                    return BoardControllerLibrary64.get_board_sampling_rate (preset, sampling_rate, board_id, input_json);
+                case LibraryEnvironment.x86:
+                    return BoardControllerLibrary32.get_board_sampling_rate (preset, sampling_rate, board_id, input_json);
+            }
+
+            return (int)BrainFlowExitCodes.GENERAL_ERROR;
+        }
+
         public static int get_package_num_channel (int board_id, int preset, int[] package_num)
         {
             switch (PlatformHelper.get_library_environment ())
@@ -756,6 +778,19 @@ public static int get_ppg_channels (int board_id, int preset, int[] channels, in
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
         }
 
+        public static int get_optical_channels (int board_id, int preset, int[] channels, int[] len)
+        {
+            switch (PlatformHelper.get_library_environment ())
+            {
+                case LibraryEnvironment.x64:
+                    return BoardControllerLibrary64.get_optical_channels (board_id, preset, channels, len);
+                case LibraryEnvironment.x86:
+                    return BoardControllerLibrary32.get_optical_channels (board_id, preset, channels, len);
+            }
+
+            return (int)BrainFlowExitCodes.GENERAL_ERROR;
+        }
+
         public static int get_accel_channels (int board_id, int preset, int[] channels, int[] len)
         {
             switch (PlatformHelper.get_library_environment ())

csharp_package/brainflow/brainflow/board_descr.cs

@@ -18,6 +18,8 @@ public class BoardDescr
         [DataMember]
         public int[] ppg_channels;
         [DataMember]
+        public int[] optical_channels;
+        [DataMember]
         public int[] eda_channels;
         [DataMember]
         public int[] accel_channels;
@@ -54,6 +56,7 @@ public BoardDescr ()
             exg_channels = null;
             emg_channels = null;
             ppg_channels = null;
+            optical_channels = null;
             eda_channels = null;
             accel_channels = null;
             rotation_channels = null;

csharp_package/brainflow/brainflow/board_shim.cs

@@ -441,6 +441,30 @@ public static int[] get_ppg_channels (int board_id, int preset = (int)BrainFlowP
             return result;
         }
 
+        /// <summary>
+        /// get row indices which hold optical data
+        /// </summary>
+        /// <param name="board_id"></param>
+        /// <param name="preset">preset for device</param>
+        /// <returns>array of row nums</returns>
+        /// <exception cref="BrainFlowException">If this board has no such data exit code is UNSUPPORTED_BOARD_ERROR</exception>
+        public static int[] get_optical_channels (int board_id, int preset = (int)BrainFlowPresets.DEFAULT_PRESET)
+        {
+            int[] len = new int[1];
+            int[] channels = new int[512];
+            int res = BoardControllerLibrary.get_optical_channels (board_id, preset, channels, len);
+            if (res != (int)BrainFlowExitCodes.STATUS_OK)
+            {
+                throw new BrainFlowError (res);
+            }
+            int[] result = new int[len[0]];
+            for (int i = 0; i < len[0]; i++)
+            {
+                result[i] = channels[i];
+            }
+            return result;
+        }
+
         /// <summary>
         /// get row indices which hold accel data
         /// </summary>
@@ -839,6 +863,22 @@ public int get_board_id ()
             return master_board;
         }
 
+        /// <summary>
+        /// get actual sampling rate for this prepared board session
+        /// </summary>
+        /// <param name="preset">preset for device</param>
+        /// <returns>sampling rate</returns>
+        public int get_board_sampling_rate (int preset = (int)BrainFlowPresets.DEFAULT_PRESET)
+        {
+            int[] val = new int[1];
+            int res = BoardControllerLibrary.get_board_sampling_rate (preset, val, board_id, input_json);
+            if (res != (int)BrainFlowExitCodes.STATUS_OK)
+            {
+                throw new BrainFlowError (res);
+            }
+            return val[0];
+        }
+
         ///<summary>
         /// Get input params
         ///</summary>

docs/BrainFlowDev.rst

@@ -65,7 +65,6 @@ Instructions to build docs locally
 
 Don't push changes to Docs without local verification.
 
-- install `pandoc <https://pandoc.org/installing.html>`_
 - optional: install Doxygen, skip it if you dont understand what it is or don't need to publish your local build
 
 Install requirements::

docs/Doxyfile.in

@@ -778,7 +778,7 @@ WARNINGS               = YES
 # will automatically be disabled.
 # The default value is: YES.
 
-WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_UNDOCUMENTED   = NO
 
 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
 # potential errors in the documentation, such as not documenting some parameters

docs/Examples.rst

@@ -664,11 +664,3 @@ Swift ICA
 
 .. literalinclude:: ../swift_package/examples/tests/ica/ica.swift
    :language: swift
-
-Notebooks
-------------
-.. toctree::
-
-   ./notebooks/brainflow_mne
-   ./notebooks/denoising
-   ./notebooks/band_power