Patch/pr 795 refactor (#7)

Author: neuropawn-admin

README.md

@@ -31,107 +31,6 @@ It provides a uniform SDK to work with biosensors with a primary focus on neuroi
     * Powerful CI/CD system which runs integrations tests for each commit automatically using BrainFlow's Emulator
     * Simplified process to add new boards and methods
 
-## NeuroPawn Knight Board Docs
-
-### [Python] Brainflow Simple Setup
-```
-import brainflow as bf
-import time
-
-from brainflow.board_shim import BoardShim, BrainFlowInputParams, BoardIds
-
-class KnightBoard:
-    def __init__(self, serial_port: str, num_channels: int):
-        """Initialize and configure the Knight Board."""
-        self.params = BrainFlowInputParams()
-        self.params.serial_port = serial_port
-        self.num_channels = num_channels
-        
-        # Initialize board
-        self.board_shim = BoardShim(BoardIds.NEUROPAWN_KNIGHT_BOARD.value, self.params)
-        self.board_id = self.board_shim.get_board_id()
-        self.eeg_channels = self.board_shim.get_exg_channels(self.board_id)
-        self.sampling_rate = self.board_shim.get_sampling_rate(self.board_id)
-
-    def start_stream(self, buffer_size: int = 450000):
-        """Start the data stream from the board."""
-        self.board_shim.prepare_session()
-        self.board_shim.start_stream(buffer_size)
-        print("Stream started.")
-        time.sleep(2)
-        for x in range(1, self.num_channels + 1):
-            time.sleep(0.5)
-            cmd = f"chon_{x}_12"
-            self.board_shim.config_board(cmd)
-            print(f"sending {cmd}")
-            time.sleep(1)
-            rld = f"rldadd_{x}"
-            self.board_shim.config_board(rld)
-            print(f"sending {rld}")
-            time.sleep(0.5)
-
-    def stop_stream(self):
-        """Stop the data stream and release resources."""
-        self.board_shim.stop_stream()
-        self.board_shim.release_session()
-        print("Stream stopped and session released.")
-
-Knight_board = KnightBoard("COM3", 8)
-Knight_board.start_stream()
-
-while True:
-    data = Knight_board.board_shim.get_board_data()
-    # do stuff with data
-
-    if keyboard.is_pressed('q'):
-        Knight_board.stop_stream()
-        break
-```
-### BrainFlow Configuration Commands
-
-To configure the NeuroPawn Knight board with BrainFlow, pass the commands as strings into:
-    
-    board_shim.config_board(<command>)
-
-#### Command 1: Enable EEG Channel / Set Gain
-**Purpose**: Enables a specified channel with a specified gain, starting data acquisition on that channel. If the channel is already enabled, it will remain enabled, but will still update its gain.
-
-    f"chon_{channel}_{gain_value}"
-
-##### Parameters:
-
-- channel: The channel number to start the data acquisition. Replace this with the actual number of the channel you want to configure. One-indexed.
-
-- gain: Specifies the gain value for the channel to be enabled. Allowable gain values are: [1, 2, 3, 4, 6, 8, 12 (recommended)]. The gain value controls the amplification level of the EEG signal on the specified channel.
-
-#### Command 2: Disable EEG Channel
-**Purpose**: Disables a specified channel, stopping data acquisition on that channel.
-
-    f"choff_{channel_number}"
-
-##### Parameters:
-
-- channel_number: The channel number to **stop** the data acquisition. This is appended to *'choff'* to construct the configuration command. One-indexed.
-  
-#### Command 3: Toggle on RLD
-**Purpose**: Toogle **on** right leg drive for the specified channel.
-
-    f"rldadd_{channel_number}"
-
-##### Parameters:
-
-- channel_number: The channel number to toggle **on** the right leg drive. This number is converted to a string and appended to *'rldadd'* to create the configuration command. One-indexed.
-
-
-### Command 4: Toggle off RLD
-**Purpose**: Toogle **off** right leg drive for the specified channel.
-
-    f"rldremove_{channel}"
-
-#### Parameters:
-
-- channel_number: The channel number to toggle **off** the right leg drive. This number is converted to a string and appended to *'rldremove'* to create the configuration command. One-indexed.
-
 ## Resources
 
 * [***BrainFlow Docs, Dev and User guides and other information***](https://brainflow.readthedocs.io)

docs/SupportedBoards.rst

@@ -1425,7 +1425,7 @@ Knight Board
 
 To create such board you need to specify the following board ID and fields of BrainFlowInputParams object:
 
-- :code:`BoardIds.NEUROPAWN_KNIGHT_BOARD` or :code:`BoardIds.NEUROPAWN_KNIGHT_BOARD_IMU`
+- :code:`BoardIds.NEUROPAWN_KNIGHT_BOARD`
 - :code:`serial_port`, e.g. COM3, /dev/tty.*
 
 Initialization Example:
@@ -1436,8 +1436,42 @@ Initialization Example:
     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) # standard Knight Board
-    board = BoardShim(BoardIds.NEUROPAWN_KNIGHT_BOARD_IMU, params) # Knight Board IMU
+    board = BoardShim(BoardIds.NEUROPAWN_KNIGHT_BOARD, params)
+
+**On Unix-like systems you may need to configure permissions for serial port or run with sudo.**
+
+**On MacOS there are two serial ports for each device: /dev/tty..... and /dev/cu..... You HAVE to specify /dev/cu.....**
+
+Supported platforms:
+
+- Windows
+- Linux
+- MacOS
+- Devices like Raspberry Pi
+
+Knight IMU Board
+~~~~~~~~~~~~~~~~~
+
+.. image:: https://live.staticflickr.com/65535/54061606098_e223ab04a6_w.jpg
+    :width: 400px
+    :height: 274px
+
+`NeuroPawn website <https://www.neuropawn.tech/>`_
+
+To create such board you need to specify the following board ID and fields of BrainFlowInputParams object:
+
+- :code:`BoardIds.NEUROPAWN_KNIGHT_BOARD_IMU`
+- :code:`serial_port`, e.g. COM3, /dev/tty.*
+
+Initialization Example:
+
+.. code-block:: python
+
+    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.**
 

src/board_controller/build.cmake

@@ -84,6 +84,7 @@ SET (BOARD_CONTROLLER_SRC
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/pieeg/pieeg_board.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/synchroni/synchroni_board.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/neuropawn/knight.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/neuropawn/knight_base.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/neuropawn/knightimu.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/biolistener/biolistener.cpp
 )

src/board_controller/neuropawn/inc/knight.h

@@ -1,45 +1,13 @@
 #pragma once
 
-#include <set>
-#include <thread>
+#include "knight_base.h"
 
-#include "board.h"
-#include "board_controller.h"
-#include "serial.h"
-
-class Knight : public Board
+class Knight : public KnightBase
 {
 
 protected:
-    volatile bool keep_alive;
-    bool initialized;
-    bool is_streaming;
-    std::thread streaming_thread;
-    Serial *serial;
-
-    int min_package_size;
-    int gain;
-
-    virtual int send_to_board (const char *msg);
-    virtual int send_to_board (const char *msg, std::string &response);
-    virtual std::string read_serial_response ();
-    int open_port ();
-    int set_port_settings ();
     void read_thread ();
 
-private:
-    static const std::set<int> allowed_gains;
-
 public:
     Knight (int board_id, struct BrainFlowInputParams params);
-    ~Knight ();
-
-    int prepare_session ();
-    int start_stream (int buffer_size, const char *streamer_params);
-    int stop_stream ();
-    int release_session ();
-    int config_board (std::string config, std::string &response);
-
-    static constexpr int start_byte = 0xA0;
-    static constexpr int end_byte = 0xC0;
 };

src/board_controller/neuropawn/inc/knight_base.h

@@ -0,0 +1,45 @@
+#pragma once
+
+#include <set>
+#include <thread>
+
+#include "board.h"
+#include "board_controller.h"
+#include "serial.h"
+
+class KnightBase : public Board
+{
+
+protected:
+    volatile bool keep_alive;
+    bool initialized;
+    bool is_streaming;
+    std::thread streaming_thread;
+    Serial *serial;
+
+    int min_package_size;
+    int gain;
+
+    virtual int send_to_board (const char *msg);
+    virtual int send_to_board (const char *msg, std::string &response);
+    virtual std::string read_serial_response ();
+    virtual int open_port ();
+    virtual int set_port_settings ();
+    virtual void read_thread () = 0;
+
+private:
+    static const std::set<int> allowed_gains;
+
+public:
+    KnightBase (int board_id, struct BrainFlowInputParams params);
+    virtual ~KnightBase ();
+
+    virtual int prepare_session ();
+    virtual int start_stream (int buffer_size, const char *streamer_params);
+    virtual int stop_stream ();
+    virtual int release_session ();
+    virtual int config_board (std::string config, std::string &response);
+
+    static constexpr int start_byte = 0xA0;
+    static constexpr int end_byte = 0xC0;
+};

src/board_controller/neuropawn/inc/knightimu.h

@@ -1,45 +1,13 @@
 #pragma once
 
-#include <set>
-#include <thread>
+#include "knight_base.h"
 
-#include "board.h"
-#include "board_controller.h"
-#include "serial.h"
-
-class KnightIMU : public Board
+class KnightIMU : public KnightBase
 {
 
 protected:
-    volatile bool keep_alive;
-    bool initialized;
-    bool is_streaming;
-    std::thread streaming_thread;
-    Serial *serial;
-
-    int min_package_size;
-    int gain;
-
-    virtual int send_to_board (const char *msg);
-    virtual int send_to_board (const char *msg, std::string &response);
-    virtual std::string read_serial_response ();
-    int open_port ();
-    int set_port_settings ();
     void read_thread ();
 
-private:
-    static const std::set<int> allowed_gains;
-
 public:
     KnightIMU (int board_id, struct BrainFlowInputParams params);
-    ~KnightIMU ();
-
-    int prepare_session ();
-    int start_stream (int buffer_size, const char *streamer_params);
-    int stop_stream ();
-    int release_session ();
-    int config_board (std::string config, std::string &response);
-
-    static constexpr int start_byte = 0xA0;
-    static constexpr int end_byte = 0xC0;
 };