Create explicit boards for Ganglion v2 and v3 firmwares

Author: philippitts

src/board_controller/board_controller.cpp

@@ -38,8 +38,10 @@
 #include "explore.h"
 #include "freeeeg.h"
 #include "galea.h"
-#include "ganglion.h"
-#include "ganglion_native.h"
+#include "ganglion_native_v2.h"
+#include "ganglion_native_v3.h"
+#include "ganglion_v2.h"
+#include "ganglion_v3.h"
 #include "ganglion_wifi.h"
 #include "gforce_dual.h"
 #include "gforce_pro.h"
@@ -106,7 +108,7 @@ int prepare_session (int board_id, const char *json_brainflow_input_params)
             board = std::shared_ptr<Board> (new Cyton (params));
             break;
         case BoardIds::GANGLION_BOARD:
-            board = std::shared_ptr<Board> (new Ganglion (params));
+            board = std::shared_ptr<Board> (new GanglionV3 (params));
             break;
         case BoardIds::CYTON_DAISY_BOARD:
             board = std::shared_ptr<Board> (new CytonDaisy (params));
@@ -250,7 +252,7 @@ int prepare_session (int board_id, const char *json_brainflow_input_params)
             board = std::shared_ptr<Board> (new Explore (board_id, params));
             break;
         case BoardIds::GANGLION_NATIVE_BOARD:
-            board = std::shared_ptr<Board> (new GanglionNative (params));
+            board = std::shared_ptr<Board> (new GanglionNativeV3 (params));
             break;
         case BoardIds::EMOTIBIT_BOARD:
             board = std::shared_ptr<Board> (new Emotibit (params));
@@ -299,6 +301,12 @@ int prepare_session (int board_id, const char *json_brainflow_input_params)
         case BoardIds::BIOLISTENER_BOARD:
             board = std::shared_ptr<Board> (new BioListener<8> (board_id, params));
             break;
+        case BoardIds::GANGLION_V2_BOARD:
+            board = std::shared_ptr<Board> (new GanglionV2 (params));
+            break;
+        case BoardIds::GANGLION_V2_NATIVE_BOARD:
+            board = std::shared_ptr<Board> (new GanglionNativeV2 (params));
+            break;
         default:
             return (int)BrainFlowExitCodes::UNSUPPORTED_BOARD_ERROR;
     }

src/board_controller/openbci/ganglion.cpp

@@ -17,8 +17,8 @@
 int Ganglion::num_objects = 0;
 
 
-Ganglion::Ganglion (struct BrainFlowInputParams params)
-    : Board ((int)BoardIds::GANGLION_BOARD, params)
+Ganglion::Ganglion (BoardIds board_id, struct BrainFlowInputParams params)
+    : Board ((int)board_id, params)
 {
     Ganglion::num_objects++;
     if (Ganglion::num_objects > 1)
@@ -30,7 +30,6 @@ Ganglion::Ganglion (struct BrainFlowInputParams params)
         is_valid = true;
     }
     use_mac_addr = (params.mac_address.empty ()) ? false : true;
-    firmware = 0;
     is_streaming = false;
     keep_alive = false;
     initialized = false;
@@ -268,14 +267,7 @@ void Ganglion::read_thread ()
 
             if (data.data[0] <= 200)
             {
-                if (firmware == 3)
-                {
-                    decompress_firmware_3 (&data, last_data, acceleration, package);
-                }
-                else if (firmware == 2)
-                {
-                    decompress_firmware_2 (&data, last_data, acceleration, package);
-                }
+                decompress (&data, last_data, acceleration, package);
             }
             else if ((data.data[0] > 200) && (data.data[0] < 206))
             {
@@ -371,195 +363,8 @@ void Ganglion::read_thread ()
     delete[] package;
 }
 
-void Ganglion::decompress_firmware_3 (
-    struct GanglionLib::GanglionData *data, float *last_data, double *acceleration, double *package)
-{
-    int bits_per_num = 0;
-    unsigned char package_bits[160] = {0}; // 20 * 8
-    for (int i = 0; i < 20; i++)
-    {
-        uchar_to_bits (data->data[i], package_bits + i * 8);
-    }
-
-    // 18 bit compression, sends 17 MSBs + sign bit of 24-bit sample
-    if (data->data[0] >= 0 && data->data[0] < 100)
-    {
-        int last_digit = data->data[0] % 10;
-        switch (last_digit)
-        {
-            // accel data is signed, so we must cast it to signed char
-            // swap x and z, and invert z to convert to standard coordinate space.
-            case 0:
-                acceleration[2] = -accel_scale * (char)data->data[19];
-                break;
-            case 1:
-                acceleration[1] = accel_scale * (char)data->data[19];
-                break;
-            case 2:
-                acceleration[0] = accel_scale * (char)data->data[19];
-                break;
-            default:
-                break;
-        }
-        bits_per_num = 18;
-    }
-    else if (data->data[0] >= 100 && data->data[0] < 200)
-    {
-        bits_per_num = 19;
-    }
-
-    // handle compressed data for 18 or 19 bits
-    for (int i = 8, counter = 0; i < bits_per_num * 8; i += bits_per_num, counter++)
-    {
-        if (bits_per_num == 18)
-        {
-            last_data[counter] = (float)(cast_ganglion_bits_to_int32<18> (package_bits + i) << 6);
-        }
-        else
-        {
-            last_data[counter] = (float)(cast_ganglion_bits_to_int32<19> (package_bits + i) << 5);
-        }
-    }
-
-    // add first encoded package
-    package[board_descr["default"]["package_num_channel"].get<int> ()] = data->data[0];
-    package[board_descr["default"]["eeg_channels"][0].get<int> ()] = eeg_scale * last_data[0];
-    package[board_descr["default"]["eeg_channels"][1].get<int> ()] = eeg_scale * last_data[1];
-    package[board_descr["default"]["eeg_channels"][2].get<int> ()] = eeg_scale * last_data[2];
-    package[board_descr["default"]["eeg_channels"][3].get<int> ()] = eeg_scale * last_data[3];
-    package[board_descr["default"]["accel_channels"][0].get<int> ()] = acceleration[0];
-    package[board_descr["default"]["accel_channels"][1].get<int> ()] = acceleration[1];
-    package[board_descr["default"]["accel_channels"][2].get<int> ()] = acceleration[2];
-    package[board_descr["default"]["timestamp_channel"].get<int> ()] = data->timestamp;
-    push_package (package);
-    // add second package
-    package[board_descr["default"]["eeg_channels"][0].get<int> ()] = eeg_scale * last_data[4];
-    package[board_descr["default"]["eeg_channels"][1].get<int> ()] = eeg_scale * last_data[5];
-    package[board_descr["default"]["eeg_channels"][2].get<int> ()] = eeg_scale * last_data[6];
-    package[board_descr["default"]["eeg_channels"][3].get<int> ()] = eeg_scale * last_data[7];
-    package[board_descr["default"]["timestamp_channel"].get<int> ()] = data->timestamp;
-    push_package (package);
-}
-
-void Ganglion::decompress_firmware_2 (
-    struct GanglionLib::GanglionData *data, float *last_data, double *acceleration, double *package)
-{
-    int bits_per_num = 0;
-    unsigned char package_bits[160] = {0}; // 20 * 8
-    for (int i = 0; i < 20; i++)
-    {
-        uchar_to_bits (data->data[i], package_bits + i * 8);
-    }
-
-    float delta[8] = {0.f}; // delta holds 8 nums (4 by each package)
-
-    // no compression, used to init variable
-    if (data->data[0] == 0)
-    {
-        // shift the last data packet to make room for a newer one
-        last_data[0] = last_data[4];
-        last_data[1] = last_data[5];
-        last_data[2] = last_data[6];
-        last_data[3] = last_data[7];
-
-        // add new packet
-        last_data[4] = (float)cast_24bit_to_int32 (data->data + 1);
-        last_data[5] = (float)cast_24bit_to_int32 (data->data + 4);
-        last_data[6] = (float)cast_24bit_to_int32 (data->data + 7);
-        last_data[7] = (float)cast_24bit_to_int32 (data->data + 10);
-
-        // scale new packet and insert into result
-        package[board_descr["default"]["package_num_channel"].get<int> ()] = 0.;
-        package[board_descr["default"]["eeg_channels"][0].get<int> ()] = eeg_scale * last_data[4];
-        package[board_descr["default"]["eeg_channels"][1].get<int> ()] = eeg_scale * last_data[5];
-        package[board_descr["default"]["eeg_channels"][2].get<int> ()] = eeg_scale * last_data[6];
-        package[board_descr["default"]["eeg_channels"][3].get<int> ()] = eeg_scale * last_data[7];
-        package[board_descr["default"]["accel_channels"][0].get<int> ()] = acceleration[0];
-        package[board_descr["default"]["accel_channels"][1].get<int> ()] = acceleration[1];
-        package[board_descr["default"]["accel_channels"][2].get<int> ()] = acceleration[2];
-        package[board_descr["default"]["timestamp_channel"].get<int> ()] = data->timestamp;
-        push_package (package);
-        return;
-    }
-    // 18 bit compression, sends delta from previous value instead of real value!
-    else if (data->data[0] >= 1 && data->data[0] <= 100)
-    {
-        int last_digit = data->data[0] % 10;
-        switch (last_digit)
-        {
-            // accel data is signed, so we must cast it to signed char
-            // swap x and z, and invert z to convert to standard coordinate space.
-            case 0:
-                acceleration[2] = -accel_scale * (char)data->data[19];
-                break;
-            case 1:
-                acceleration[1] = accel_scale * (char)data->data[19];
-                break;
-            case 2:
-                acceleration[0] = accel_scale * (char)data->data[19];
-                break;
-            default:
-                break;
-        }
-        bits_per_num = 18;
-    }
-    else if (data->data[0] >= 101 && data->data[0] <= 200)
-    {
-        bits_per_num = 19;
-    }
-
-    // handle compressed data for 18 or 19 bits
-    for (int i = 8, counter = 0; i < bits_per_num * 8; i += bits_per_num, counter++)
-    {
-        if (bits_per_num == 18)
-        {
-            delta[counter] = (float)cast_ganglion_bits_to_int32<18> (package_bits + i);
-        }
-        else
-        {
-            delta[counter] = (float)cast_ganglion_bits_to_int32<19> (package_bits + i);
-        }
-    }
-
-    // apply the first delta to the last data we got in the previous iteration
-    for (int i = 0; i < 4; i++)
-    {
-        last_data[i] = last_data[i + 4] - delta[i];
-    }
-
-    // apply the second delta to the previous packet which we just decompressed above
-    for (int i = 4; i < 8; i++)
-    {
-        last_data[i] = last_data[i - 4] - delta[i];
-    }
-
-    // add first encoded package
-    package[board_descr["default"]["package_num_channel"].get<int> ()] = data->data[0];
-    package[board_descr["default"]["eeg_channels"][0].get<int> ()] = eeg_scale * last_data[0];
-    package[board_descr["default"]["eeg_channels"][1].get<int> ()] = eeg_scale * last_data[1];
-    package[board_descr["default"]["eeg_channels"][2].get<int> ()] = eeg_scale * last_data[2];
-    package[board_descr["default"]["eeg_channels"][3].get<int> ()] = eeg_scale * last_data[3];
-    package[board_descr["default"]["accel_channels"][0].get<int> ()] = acceleration[0];
-    package[board_descr["default"]["accel_channels"][1].get<int> ()] = acceleration[1];
-    package[board_descr["default"]["accel_channels"][2].get<int> ()] = acceleration[2];
-    package[board_descr["default"]["timestamp_channel"].get<int> ()] = data->timestamp;
-    push_package (package);
-    // add second package
-    package[board_descr["default"]["eeg_channels"][0].get<int> ()] = eeg_scale * last_data[4];
-    package[board_descr["default"]["eeg_channels"][1].get<int> ()] = eeg_scale * last_data[5];
-    package[board_descr["default"]["eeg_channels"][2].get<int> ()] = eeg_scale * last_data[6];
-    package[board_descr["default"]["eeg_channels"][3].get<int> ()] = eeg_scale * last_data[7];
-    package[board_descr["default"]["timestamp_channel"].get<int> ()] = data->timestamp;
-    push_package (package);
-}
-
 int Ganglion::config_board (std::string config, std::string &response)
 {
-    if (config == "get_firmware_version")
-    {
-        response = std::to_string (firmware);
-        return (int)BrainFlowExitCodes::STATUS_OK;
-    }
     const char *conf = config.c_str ();
     safe_logger (spdlog::level::debug, "Trying to config Ganglion with {}", conf);
     // need to pause, config and restart. I have no idea why it doesnt work if I restart it inside
@@ -674,17 +479,12 @@ int Ganglion::call_open ()
 
         GanglionLib::ConnectionParameters connection_params;
         connection_params.mac_address = const_cast<char *> (params.mac_address.c_str ());
-        connection_params.firmware = 2;
 
         res = func ((void *)&connection_params);
-
-        safe_logger (
-            spdlog::level::info, "detected firmware version {}", connection_params.firmware);
-        firmware = connection_params.firmware;
     }
     else
     {
-        int (*func) (void *) = (int (*) (void *))dll_loader->get_address ("open_ganglion");
+        int (*func) () = (int (*) ())dll_loader->get_address ("open_ganglion");
         if (func == NULL)
         {
             safe_logger (spdlog::level::err, "failed to get function address for open_ganglion");
@@ -694,9 +494,7 @@ int Ganglion::call_open ()
         safe_logger (
             spdlog::level::info, "mac address is not specified, try to find ganglion without it");
 
-        res = func ((void *)&firmware);
-
-        safe_logger (spdlog::level::info, "detected firmware version {}", firmware);
+        res = func ();
     }
     if (res != GanglionLib::CustomExitCodes::STATUS_OK)
     {

src/board_controller/openbci/ganglion_bglib/inc/ganglion_types.h

@@ -91,6 +91,5 @@ namespace GanglionLib
     struct ConnectionParameters
     {
         char *mac_address;
-        uint8_t firmware;
     };
 }

src/board_controller/openbci/ganglion_bglib/main.cpp

@@ -24,7 +24,6 @@ namespace GanglionLib
     std::deque<struct GanglionLib::GanglionData> data_queue;
     SpinLock lock;
     volatile bd_addr connect_addr;
-    volatile uint8 firmware = 0;
     volatile uint8 connection = -1;
     volatile uint16 ganglion_handle_start = 0;
     volatile uint16 ganglion_handle_end = 0;
@@ -64,7 +63,7 @@ namespace GanglionLib
         return (int)CustomExitCodes::STATUS_OK;
     }
 
-    int open_ganglion (void *param)
+    int open_ganglion ()
     {
         if (uart_open (uart_port))
         {
@@ -88,9 +87,6 @@ namespace GanglionLib
 
         int result = open_ble_dev ();
 
-        uint8_t *firmware_ptr = (uint8_t *)param;
-        *firmware_ptr = firmware;
-
         return result;
     }
 
@@ -140,7 +136,6 @@ namespace GanglionLib
         ble_cmd_gap_end_procedure ();
 
         int result = open_ble_dev ();
-        connection_parameters->firmware = firmware;
         return result;
     }