Add Shimmer3 board support

csharp_package/brainflow/brainflow/board_controller_library.cs

@@ -123,7 +123,8 @@ public enum BoardIds
         BIOLISTENER_BOARD = 64,
         IRONBCI_32_BOARD = 65,
         NEUROPAWN_KNIGHT_BOARD_IMU = 66,
-        MUSE_S_ATHENA_BOARD = 67
+        MUSE_S_ATHENA_BOARD = 67,
+        SHIMMER3_BOARD = 68
     };
 
 

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

@@ -73,7 +73,8 @@ public enum BoardIds
     BIOLISTENER_BOARD(64),
     IRONBCI_32_BOARD(65),
     NEUROPAWN_KNIGHT_BOARD_IMU(66),
-    MUSE_S_ATHENA_BOARD(67);
+    MUSE_S_ATHENA_BOARD(67),
+    SHIMMER3_BOARD(68);
 
     private final int board_id;
     private static final Map<Integer, BoardIds> bi_map = new HashMap<Integer, BoardIds> ();

julia_package/brainflow/src/board_shim.jl

@@ -69,6 +69,7 @@ export BrainFlowInputParams
     IRONBCI_32_BOARD = 65
     NEUROPAWN_KNIGHT_BOARD_IMU = 66
     MUSE_S_ATHENA_BOARD = 67
+    SHIMMER3_BOARD = 68
 
 end
 

matlab_package/brainflow/BoardIds.m

@@ -67,5 +67,6 @@
         IRONBCI_32_BOARD(65)
         NEUROPAWN_KNIGHT_BOARD_IMU(66)
         MUSE_S_ATHENA_BOARD(67)
+        SHIMMER3_BOARD(68)
     end
 end

nodejs_package/brainflow/brainflow.types.ts

@@ -76,7 +76,8 @@ export enum BoardIds {
     BIOLISTENER_BOARD = 64,
     IRONBCI_32_BOARD = 65,
     NEUROPAWN_KNIGHT_BOARD_IMU = 66,
-    MUSE_S_ATHENA_BOARD = 67
+    MUSE_S_ATHENA_BOARD = 67,
+    SHIMMER3_BOARD = 68
 }
 
 export enum IpProtocolTypes {

python_package/brainflow/board_shim.py

@@ -82,6 +82,7 @@ class BoardIds(enum.IntEnum):
     IRONBCI_32_BOARD = 65  #:
     NEUROPAWN_KNIGHT_BOARD_IMU = 66  #:
     MUSE_S_ATHENA_BOARD = 67  #:
+    SHIMMER3_BOARD = 68  #:
 
 
 class IpProtocolTypes(enum.IntEnum):

rust_package/brainflow/src/ffi/constants.rs

@@ -103,6 +103,7 @@ pub enum BoardIds {
     Ironbci32Board = 65,
     NeuropawnKnightBoardImu = 66,
     MuseSAthenaBoard = 67,
+    Shimmer3Board = 68,
 }
 #[repr(i32)]
 #[derive(FromPrimitive, ToPrimitive, Debug, Copy, Clone, Hash, PartialEq, Eq)]

src/board_controller/board_controller.cpp

@@ -53,6 +53,7 @@
 #include "ntl_wifi.h"
 #include "pieeg_board.h"
 #include "playback_file_board.h"
+#include "shimmer3.h"
 #include "streaming_board.h"
 #include "synchroni_board.h"
 #include "synthetic_board.h"
@@ -314,6 +315,9 @@ int prepare_session (int board_id, const char *json_brainflow_input_params)
             board = std::shared_ptr<Board> (
                 new KnightIMU ((int)BoardIds::NEUROPAWN_KNIGHT_BOARD_IMU, params));
             break;
+        case BoardIds::SHIMMER3_BOARD:
+            board = std::shared_ptr<Board> (new Shimmer3 (params));
+            break;
         default:
             return (int)BrainFlowExitCodes::UNSUPPORTED_BOARD_ERROR;
     }

src/board_controller/brainflow_boards.cpp

@@ -85,7 +85,8 @@ BrainFlowBoards::BrainFlowBoards()
             {"64", json::object()},
             {"65", json::object()},
             {"66", json::object()},
-            {"67", json::object()}
+            {"67", json::object()},
+            {"68", json::object()}
         }
     }};
 
@@ -1199,6 +1200,23 @@ BrainFlowBoards::BrainFlowBoards()
         {"optical_channels", {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16}},
         {"battery_channel", 17}
     };
+    brainflow_boards_json["boards"]["68"]["default"] =
+    {
+        {"name", "Shimmer3"},
+        {"sampling_rate", 512}, // configurable via config_board("sampling_rate:<Hz>")
+        {"package_num_channel", 0},
+        {"timestamp_channel", 18},
+        {"marker_channel", 19},
+        {"num_rows", 20},
+        {"accel_channels", {1, 2, 3}},
+        {"gyro_channels", {4, 5, 6}},
+        {"magnetometer_channels", {7, 8, 9}},
+        {"ecg_channels", {10, 11, 12, 13}},
+        {"eda_channels", {14}},
+        {"temperature_channels", {15}},
+        {"battery_channel", 16},
+        {"other_channels", {17}}
+    };
 }
 
 BrainFlowBoards boards_struct;

src/board_controller/build.cmake

@@ -88,6 +88,7 @@ SET (BOARD_CONTROLLER_SRC
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/neuropawn/knight_base.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/neuropawn/knight_imu.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/biolistener/biolistener.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/shimmer/shimmer3.cpp
 )
 
 include (${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/ant_neuro/build.cmake)
@@ -156,6 +157,7 @@ target_include_directories (
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/synchroni/inc
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/neuropawn/inc
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/biolistener/inc
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/shimmer/inc
 )
 
 target_compile_definitions(${BOARD_CONTROLLER_NAME} PRIVATE NOMINMAX BRAINFLOW_VERSION=${BRAINFLOW_VERSION})

src/board_controller/shimmer/inc/shimmer3.h

@@ -0,0 +1,79 @@
+#pragma once
+
+#include <atomic>
+#include <condition_variable>
+#include <cstdint>
+#include <mutex>
+#include <string>
+#include <thread>
+#include <vector>
+
+#include "board.h"
+#include "board_controller.h"
+#include "serial.h"
+
+#include "shimmer3_defines.h"
+
+class Shimmer3 : public Board
+{
+public:
+    Shimmer3 (struct BrainFlowInputParams params);
+    ~Shimmer3 () override;
+
+    int prepare_session () override;
+    int start_stream (int buffer_size, const char *streamer_params) override;
+    int stop_stream () override;
+    int release_session () override;
+    int config_board (std::string config, std::string &response) override;
+    int get_board_sampling_rate (int preset) override;
+
+private:
+    // Describes one field inside one streamed sample, in transmit order.
+    struct PacketField
+    {
+        shimmer3::Signal signal;
+        shimmer3::FieldFormat format;
+    };
+
+    std::atomic<bool> keep_alive;
+    bool initialized;
+
+    Serial *serial_port;
+    std::string port_name;
+
+    std::thread streaming_thread;
+
+    // First-data handshake between start_stream and read_thread.
+    std::mutex sync_mutex;
+    std::condition_variable sync_cv;
+    bool first_data_received;
+
+    double sampling_rate;
+    double package_num;
+    std::vector<PacketField> packet_layout;
+    int packet_data_size;
+    uint8_t samples_per_packet;
+    uint8_t configured_gsr_range;
+
+    // -- low-level serial helpers --
+    int write_bytes (const uint8_t *data, int len);
+    int read_exact (uint8_t *buf, int len, bool cancellable = false);
+    int read_byte (uint8_t &out, bool cancellable = false);
+    int wait_for_ack ();
+
+    // -- device commands --
+    int cmd_get_fw_version ();
+    int cmd_get_hw_version (uint8_t &hw_version);
+    int cmd_disable_instream_ack_prefix ();
+    int cmd_set_sensors (uint32_t bitfield);
+    int cmd_set_sampling_rate (double hz);
+    int cmd_inquiry ();
+    int cmd_start_streaming ();
+    int cmd_stop_streaming ();
+
+    // -- helpers --
+    bool build_packet_layout (const std::vector<shimmer3::Signal> &signals);
+    bool convert_gsr_to_microsiemens (int32_t raw, double &eda_us) const;
+    void route_field (shimmer3::Signal s, int32_t raw, double *package, int &other_idx);
+    void read_thread ();
+};