Skip to content

Commit 5c46431

Browse files
committed
add docs for ganglio fw override
Signed-off-by: Andrey Parfenov <a1994ndrey@gmail.com>
1 parent d24d05e commit 5c46431

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/SupportedBoards.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,11 +264,14 @@ Ganglion
264264

265265
**On Unix-like systems you may need to configure permissions for serial port or run with sudo.**
266266

267+
**Breaking change in 5.21.x, by default Ganglion board will use `FW version 3 <https://openbci.com/forum/index.php?p=/discussion/3721/ganglion-firmware-upgrade>`_, if you have FW version 2, you can force it using BrainFlowInputParams.**
268+
267269
To create such board you need to specify the following board ID and fields of BrainFlowInputParams object:
268270

269271
- :code:`BoardIds.GANGLION_BOARD`
270272
- :code:`serial_port`, e.g. COM4, /dev/ttyACM0, etc
271273
- *optoinal:* :code:`mac_address`, if not provided BrainFlow will try to autodiscover the device
274+
- *optoinal:* :code:`other_info`, if not provided BrainFlow will use fw version 3, available options are: fw:auto, fw:2, fw:3
272275
- *optional:* :code:`timeout`, timeout for device discovery, default is 15sec
273276

274277
Initialization Example:
@@ -277,6 +280,8 @@ Initialization Example:
277280
278281
params = BrainFlowInputParams()
279282
params.serial_port = "COM4"
283+
# Use it only to override default fw version(3)
284+
# params.other_info = "fw:2"
280285
board = BoardShim(BoardIds.GANGLION_BOARD, params)
281286
282287
To get Ganglion's MAC address you can use:
@@ -310,6 +315,8 @@ Ganglion Native
310315

311316
Unlike Ganglion board this BrainFlow board does not use BLED112 dongle, so you need to have BLE support on your device in order to use it.
312317

318+
**Breaking change in 5.21.x, by default Ganglion board will use `FW version 3 <https://openbci.com/forum/index.php?p=/discussion/3721/ganglion-firmware-upgrade>`_, if you have FW version 2, you can force it using BrainFlowInputParams.**
319+
313320
To create such board you need to specify the following board ID and fields of BrainFlowInputParams object:
314321

315322
- :code:`BoardIds.GANGLION_NATIVE_BOARD`
@@ -321,6 +328,8 @@ Initialization Example:
321328
.. code-block:: python
322329
323330
params = BrainFlowInputParams()
331+
# Use it only if you have an old device with fw version 2
332+
# params.other_info = "fw:2"
324333
board = BoardShim(BoardIds.GANGLION_NATIVE_BOARD, params)
325334
326335
To get Ganglion's MAC address or device name you can use:

0 commit comments

Comments
 (0)