Add support for Muse S Anthena device (#779)

* Add support for Muse S Anthena device

---------

Signed-off-by: Andrey Parfenov <a1994ndrey@gmail.com>

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

@@ -508,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

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
     };
 
 
@@ -183,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);
@@ -275,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);
@@ -773,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>

docs/SupportedBoards.rst

@@ -1435,7 +1435,7 @@ Initialization Example:
     params = BrainFlowInputParams()
     params.serial_port = "COM3"
     params.other_info = '{"gain": 6}' # optional: set gain to allowed values: 1, 2, 3, 4, 6, 8, 12 (default)
-    
+
     board = BoardShim(BoardIds.NEUROPAWN_KNIGHT_BOARD, params)
 
 **On Unix-like systems you may need to configure permissions for serial port or run with sudo.**
@@ -1470,7 +1470,7 @@ Initialization Example:
     params = BrainFlowInputParams()
     params.serial_port = "COM3"
     params.other_info = '{"gain": 6}' # optional: set gain to allowed values: 1, 2, 3, 4, 6, 8, 12 (default)
-    
+
     board = BoardShim(BoardIds.NEUROPAWN_KNIGHT_BOARD_IMU, params)
 
 **On Unix-like systems you may need to configure permissions for serial port or run with sudo.**
@@ -1560,4 +1560,4 @@ Supported platforms:
 - Windows
 - Linux
 - MacOS
-- Devices like Raspberry Pi
+- Devices like Raspberry Pi

emulator/brainflow_emulator/galea_manual.py

@@ -35,7 +35,7 @@ def __init__(self):
         self.channel_on_off = [1] * 24
         self.channel_identifiers = [
             '1', '2', '3', '4', '5', '6', '7', '8',
-            'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 
+            'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I',
             'A', 'S', 'D', 'G', 'H', 'J', 'K', 'L'
         ]
 
@@ -147,4 +147,4 @@ def main():
 
 if __name__ == '__main__':
     logging.basicConfig(format='%(asctime)s %(levelname)-8s %(message)s', level=logging.INFO)
-    main()
+    main()

java_package/brainflow/src/main/java/brainflow/BoardDescr.java

@@ -10,6 +10,7 @@ public class BoardDescr
     public List<Integer> exg_channels;
     public List<Integer> emg_channels;
     public List<Integer> ppg_channels;
+    public List<Integer> optical_channels;
     public List<Integer> eda_channels;
     public List<Integer> accel_channels;
     public List<Integer> rotation_channels;
@@ -33,6 +34,7 @@ public BoardDescr ()
         exg_channels = null;
         emg_channels = null;
         ppg_channels = null;
+        optical_channels = null;
         eda_channels = null;
         accel_channels = null;
         rotation_channels = null;