Add optional ANT Neuro EDX support

CMakeLists.txt

@@ -24,6 +24,7 @@ option (BUILD_OYMOTION_SDK "BUILD_OYMOTION_SDK" OFF)
 option (BUILD_SYNCHRONI_SDK "BUILD_SYNCHRONI_SDK" ON)
 option (BUILD_BLUETOOTH "BUILD_BLUETOOTH" OFF)
 option (BUILD_BLE "BUILD_BLE" OFF)
+option (BUILD_ANT_EDX "BUILD_ANT_EDX" OFF)
 option (BUILD_ONNX "BUILD_ONNX" OFF)
 option (BUILD_TESTS "BUILD_TESTS" OFF)
 option (BUILD_PERIPHERY "BUILD_PERIPHERY" OFF)
@@ -76,4 +77,4 @@ install (
     EXPORT ${TARGETS_EXPORT_NAME}
     NAMESPACE brainflow::
     DESTINATION ${CONFIG_INSTALL_DIR}
-)
+)

cpp_package/src/board_shim.cpp

@@ -602,4 +602,4 @@ std::string BoardShim::get_version ()
     std::string verion_str (version, string_len);
 
     return verion_str;
-}
+}

csharp_package/brainflow/brainflow/board_controller_library.cs

@@ -1,4 +1,4 @@
-using System.Runtime.InteropServices;
+using System.Runtime.InteropServices;
 
 
 namespace brainflow
@@ -18,7 +18,8 @@ public enum IpProtocolTypes
     {
         NO_IP_PROTOCOL = 0,
         UDP = 1,
-        TCP = 2
+        TCP = 2,
+        EDX = 3
     };
 
     public enum BrainFlowPresets
@@ -122,7 +123,21 @@ 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,
+        ANT_NEURO_EE_410_EDX_BOARD = 68,
+        ANT_NEURO_EE_411_EDX_BOARD = 69,
+        ANT_NEURO_EE_430_EDX_BOARD = 70,
+        ANT_NEURO_EE_211_EDX_BOARD = 71,
+        ANT_NEURO_EE_212_EDX_BOARD = 72,
+        ANT_NEURO_EE_213_EDX_BOARD = 73,
+        ANT_NEURO_EE_214_EDX_BOARD = 74,
+        ANT_NEURO_EE_215_EDX_BOARD = 75,
+        ANT_NEURO_EE_221_EDX_BOARD = 76,
+        ANT_NEURO_EE_222_EDX_BOARD = 77,
+        ANT_NEURO_EE_223_EDX_BOARD = 78,
+        ANT_NEURO_EE_224_EDX_BOARD = 79,
+        ANT_NEURO_EE_225_EDX_BOARD = 80,
+        ANT_NEURO_EE_511_EDX_BOARD = 81
     };
 
 
@@ -874,3 +889,4 @@ public static int release_all_sessions ()
         }
     }
 }
+

csharp_package/brainflow/brainflow/board_shim.cs

@@ -1,6 +1,5 @@
-using System;
+using System;
 using System.IO;
-using System.Runtime.Serialization.Json;
 using System.Text;
 
 namespace brainflow
@@ -229,7 +228,7 @@
             }
             string descr_str = System.Text.Encoding.UTF8.GetString (str, 0, len[0]);
             var ms = new MemoryStream (Encoding.UTF8.GetBytes (descr_str));
             var serializer = new DataContractJsonSerializer (typeof (T));
             var obj = serializer.ReadObject (ms) as T;
             ms.Close ();
             return obj;
@@ -987,3 +986,4 @@
         }
     }
 }
+

docs/BuildBrainFlow.rst

@@ -193,8 +193,8 @@ Windows
 ~~~~~~~~
 
 - Install CMake>=3.16 you can install it from PYPI via pip or from `CMake website <https://cmake.org/>`_
-- Install Visual Studio 2019(preferred) or Visual Studio 2017. Other versions may work but not tested
-- In VS installer make sure you selected "Visual C++ ATL support"
+- Install Visual Studio with C++ build tools
+- In Visual Studio installer make sure you selected "Visual C++ ATL support"
 - Build it as a standard CMake project, you don't need to set any options
 
 .. compound::
@@ -208,6 +208,18 @@ Windows
         # to get info about args and configure your build you can run
         python build.py --help
 
+.. compound::
+
+    EDX profile on Windows (gRPC transport) example: ::
+
+        # make sure gRPC and protobuf are available in your CMake toolchain,
+        # for example via vcpkg or another preinstalled toolchain package
+
+        mkdir build-edx
+        cd build-edx
+        cmake -G "Visual Studio 17 2022" -A x64 -DBUILD_ANT_EDX=ON -DMSVC_RUNTIME=dynamic -DCMAKE_INSTALL_PREFIX=../installed-edx ..
+        cmake --build . --target install --config Release -j 2 --parallel 2
+
 
 Linux
 ~~~~~~
@@ -227,6 +239,23 @@ Linux
         # to get info about args and configure your build you can run
         python3 build.py --help
 
+.. compound::
+
+    EDX profile on Linux example: ::
+
+        # install grpc/protobuf development dependencies first
+        # protobuf-compiler-grpc provides grpc_cpp_plugin used by CMake
+        sudo apt-get update
+        sudo apt-get install -y libprotobuf-dev protobuf-compiler libgrpc++-dev protobuf-compiler-grpc
+
+        mkdir build-edx
+        cd build-edx
+        cmake -DBUILD_ANT_EDX=ON -DBUILD_SYNCHRONI_SDK=OFF -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../installed-edx ..
+        make
+        make install
+
+For EDX board configuration details, see :ref:`ant-neuro-edx-label`.
+
 MacOS
 ~~~~~~~
 

docs/SupportedBoards.rst

@@ -1148,6 +1148,136 @@ Available commands:
 
 For more information about Ant Neuro boards please refer to their User Manual.
 
+Ant Neuro EDX
+~~~~~~~~~~~~~~
+
+EDX is a transport board that exposes ANT Neuro amplifiers through an external gRPC service.
+
+Use board id:
+
+- explicit self-describing EDX ids for known amplifiers:
+
+  - :code:`BoardIds.ANT_NEURO_EE_410_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_411_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_430_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_211_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_212_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_213_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_214_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_215_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_221_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_222_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_223_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_224_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_225_EDX_BOARD`
+  - :code:`BoardIds.ANT_NEURO_EE_511_EDX_BOARD`
+
+Use one of the explicit EDX ids when you know the amplifier model.
+
+Required BrainFlowInputParams fields:
+
+- :code:`ip_address`, EDX service host (for example :code:`localhost`)
+- :code:`ip_port`, EDX service port (for example :code:`3390`)
+
+Optional fields:
+
+- :code:`ip_protocol`, optional; :code:`IpProtocolTypes.EDX` is accepted for clarity
+- :code:`timeout`, timeout for discovery and session operations, default is 15 sec
+
+Important notes:
+
+- Explicit EDX ids are self-describing and do not require :code:`master_board`.
+- Available sampling rates and signal ranges are discovered from the amplifier at runtime via :code:`board.config_board("edx:get_capabilities")`.
+
+Available commands:
+
+- Get runtime capabilities: :code:`board.config_board("edx:get_capabilities")`
+- Set sampling rate: :code:`board.config_board("sampling_rate:500")`
+- Set reference range: :code:`board.config_board("reference_range:0.15")`
+- Set bipolar range: :code:`board.config_board("bipolar_range:2.5")`
+- Set impedance mode: :code:`board.config_board("impedance_mode:1")`, mode 0 or 1
+
+Initialization example (Python):
+
+.. code-block:: python
+
+    params = BrainFlowInputParams()
+    params.ip_address = "localhost"
+    params.ip_port = 3390
+    params.ip_protocol = IpProtocolTypes.EDX
+    board = BoardShim(BoardIds.ANT_NEURO_EE_511_EDX_BOARD, params)
+
+Configuration example (Python):
+
+.. code-block:: python
+
+    params = BrainFlowInputParams()
+    params.ip_address = "localhost"
+    params.ip_port = 3390
+    params.ip_protocol = IpProtocolTypes.EDX
+    board = BoardShim(BoardIds.ANT_NEURO_EE_511_EDX_BOARD, params)
+    board.prepare_session()
+    print(board.config_board("edx:get_capabilities"))
+    board.config_board("sampling_rate:500")
+    board.config_board("reference_range:0.15")
+    board.config_board("bipolar_range:2.5")
+    board.start_stream()
+
+Initialization example (C++):
+
+.. code-block:: cpp
+
+    BrainFlowInputParams params;
+    params.ip_address = "localhost";
+    params.ip_port = 3390;
+    params.ip_protocol = (int)IpProtocolTypes::EDX;
+    BoardShim board ((int)BoardIds::ANT_NEURO_EE_511_EDX_BOARD, params);
+
+Configuration example (C++):
+
+.. code-block:: cpp
+
+    BrainFlowInputParams params;
+    params.ip_address = "localhost";
+    params.ip_port = 3390;
+    params.ip_protocol = (int)IpProtocolTypes::EDX;
+
+    BoardShim board ((int)BoardIds::ANT_NEURO_EE_511_EDX_BOARD, params);
+    board.prepare_session ();
+    std::string caps = board.config_board ("edx:get_capabilities");
+    board.config_board ("sampling_rate:500");
+    board.config_board ("reference_range:0.15");
+    board.config_board ("bipolar_range:2.5");
+    board.start_stream ();
+
+Initialization example (Rust):
+
+.. code-block:: rust
+
+    let params = BrainFlowInputParamsBuilder::default()
+        .ip_address("localhost")
+        .ip_port(3390)
+        .ip_protocol(IpProtocolTypes::Edx)
+        .build();
+    let board = BoardShim::new(BoardIds::AntNeuroEe511EdxBoard, params)?;
+
+Configuration example (Rust):
+
+.. code-block:: rust
+
+    let params = BrainFlowInputParamsBuilder::default()
+        .ip_address("localhost")
+        .ip_port(3390)
+        .ip_protocol(IpProtocolTypes::Edx)
+        .build();
+    let board = BoardShim::new(BoardIds::AntNeuroEe511EdxBoard, params)?;
+    board.prepare_session()?;
+    let caps = board.config_board("edx:get_capabilities")?;
+    board.config_board("sampling_rate:500")?;
+    board.config_board("reference_range:0.15")?;
+    board.config_board("bipolar_range:2.5")?;
+    board.start_stream(45000, "")?;
+
 Enophone
 ---------
 
@@ -1560,4 +1690,4 @@ Supported platforms:
 - Windows
 - Linux
 - MacOS
-- Devices like Raspberry Pi
+- Devices like Raspberry Pi

java_package/brainflow/src/main/java/brainflow/BoardIds.java

@@ -72,7 +72,21 @@ 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),
+    ANT_NEURO_EE_410_EDX_BOARD(68),
+    ANT_NEURO_EE_411_EDX_BOARD(69),
+    ANT_NEURO_EE_430_EDX_BOARD(70),
+    ANT_NEURO_EE_211_EDX_BOARD(71),
+    ANT_NEURO_EE_212_EDX_BOARD(72),
+    ANT_NEURO_EE_213_EDX_BOARD(73),
+    ANT_NEURO_EE_214_EDX_BOARD(74),
+    ANT_NEURO_EE_215_EDX_BOARD(75),
+    ANT_NEURO_EE_221_EDX_BOARD(76),
+    ANT_NEURO_EE_222_EDX_BOARD(77),
+    ANT_NEURO_EE_223_EDX_BOARD(78),
+    ANT_NEURO_EE_224_EDX_BOARD(79),
+    ANT_NEURO_EE_225_EDX_BOARD(80),
+    ANT_NEURO_EE_511_EDX_BOARD(81);
 
     private final int board_id;
     private static final Map<Integer, BoardIds> bi_map = new HashMap<Integer, BoardIds> ();
@@ -106,3 +120,4 @@ public static BoardIds from_code (final int code)
         }
     }
 }
+

java_package/brainflow/src/main/java/brainflow/BoardShim.java

@@ -8,6 +8,7 @@
 import org.apache.commons.lang3.SystemUtils;
 
 import com.google.gson.Gson;
+import com.google.gson.JsonObject;
 import com.sun.jna.JNIEnv;
 import com.sun.jna.Library;
 import com.sun.jna.Native;
@@ -18,7 +19,6 @@
 @SuppressWarnings ("deprecation")
 public class BoardShim
 {
-
     private interface DllInterface extends Library
     {
         int prepare_session (int board_id, String params);
@@ -1303,7 +1303,8 @@ public BoardShim (int board_id, BrainFlowInputParams params)
         {
             if (params.get_master_board () == BoardIds.NO_BOARD.get_code ())
             {
-                throw new BrainFlowError ("need to set master board attribute in BrainFlowInputParams",
+                throw new BrainFlowError (
+                        "need to set master board attribute in BrainFlowInputParams",
                         BrainFlowExitCode.INVALID_ARGUMENTS_ERROR.get_code ());
             } else
             {
@@ -1328,7 +1329,8 @@ public BoardShim (BoardIds board_id, BrainFlowInputParams params)
         {
             if (params.get_master_board () == BoardIds.NO_BOARD.get_code ())
             {
-                throw new BrainFlowError ("need to set master board attribute in BrainFlowInputParams",
+                throw new BrainFlowError (
+                        "need to set master board attribute in BrainFlowInputParams",
                         BrainFlowExitCode.INVALID_ARGUMENTS_ERROR.get_code ());
             } else
             {
@@ -1640,3 +1642,4 @@ public double[][] get_board_data (int num_datapoints) throws BrainFlowError
         return get_board_data (num_datapoints, BrainFlowPresets.DEFAULT_PRESET);
     }
 }
+

java_package/brainflow/src/main/java/brainflow/IpProtocolTypes.java

@@ -8,7 +8,8 @@ public enum IpProtocolTypes
 
     NO_IP_PROTOCOL (0),
     UDP (1),
-    TCP (2);
+    TCP (2),
+    EDX (3);
 
     private final int protocol;
     private static final Map<Integer, IpProtocolTypes> ip_map = new HashMap<Integer, IpProtocolTypes> ();