Skip to content

Create explicit boards for Ganglion v2 and v3 firmwares #791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philippitts wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Create explicit boards for Ganglion v2 and v3 firmwares #791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
33dd321
Create explicit boards for Ganglion v2 and v3 firmwares
philippitts Jan 22, 2026
6992872
Remove instructions for setting firmware version from Ganglion BLE GA…
philippitts Jan 22, 2026
6690733
Update CMakeLists with new Ganglion board sources
philippitts Jan 22, 2026
40123da
Fix config_board interface in GanglionNative
philippitts Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions src/board_controller/board_controller.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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));
Expand Down Expand Up @@ -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));
Expand Down Expand Up @@ -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;
}
Expand Down
4 changes: 4 additions & 0 deletions src/board_controller/build.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ SET (BOARD_CONTROLLER_SRC
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/cyton_daisy_wifi.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/ganglion.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/ganglion_native.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/ganglion_v2.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/ganglion_native_v2.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/ganglion_v3.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/ganglion_native_v3.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/cyton.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/openbci/cyton_daisy.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/board_controller/board_controller.cpp
Expand Down
212 changes: 5 additions & 207 deletions src/board_controller/openbci/ganglion.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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;
Expand Down Expand Up @@ -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))
{
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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");
Expand All @@ -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)
{
Expand Down
2 changes: 0 additions & 2 deletions src/board_controller/openbci/ganglion_bglib/callbacks.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,11 @@ void ble_evt_gap_scan_response (const struct ble_msg_gap_scan_response_evt_t *ms
if (memcmp (msg->sender.addr, (uint8 *)GanglionLib::connect_addr.addr, sizeof (bd_addr)) ==
0)
{
GanglionLib::firmware = msg->data.data[0] == 20 && msg->data.data[13] == '3' ? 3 : 2;
GanglionLib::exit_code = (int)GanglionLib::STATUS_OK;
}
else if (strstr (name, "anglion") != NULL) // strcasestr is unavailable for windows
{
memcpy ((void *)GanglionLib::connect_addr.addr, msg->sender.addr, sizeof (bd_addr));
GanglionLib::firmware = msg->data.data[0] == 20 && msg->data.data[13] == '3' ? 3 : 2;
GanglionLib::exit_code = (int)GanglionLib::STATUS_OK;
}
}
Expand Down
1 change: 0 additions & 1 deletion src/board_controller/openbci/ganglion_bglib/inc/ganglion_types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,5 @@ namespace GanglionLib
struct ConnectionParameters
{
char *mac_address;
uint8_t firmware;
};
}
7 changes: 1 addition & 6 deletions src/board_controller/openbci/ganglion_bglib/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -64,7 +63,7 @@ namespace GanglionLib
return (int)CustomExitCodes::STATUS_OK;
}

int open_ganglion (void *param)
int open_ganglion ()
{
if (uart_open (uart_port))
{
Expand All @@ -88,9 +87,6 @@ namespace GanglionLib

int result = open_ble_dev ();

uint8_t *firmware_ptr = (uint8_t *)param;
*firmware_ptr = firmware;

return result;
}

Expand Down Expand Up @@ -140,7 +136,6 @@ namespace GanglionLib
ble_cmd_gap_end_procedure ();

int result = open_ble_dev ();
connection_parameters->firmware = firmware;
return result;
}

Expand Down
Loading
Loading