Skip to content
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

fix-outdated-info-on-networking-widget #217

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix-outdated-info-on-networking-widget #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion website/docs/ForDevelopers/01-SoftwareDevelopment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ BrainFlow is written in C++ and then exported to a handful of languages. This cu

GUI v5.0+ uses the BrainFlow-Java package. When starting a new project with OpenBCI hardware for the first time, it is important to check that you can connect the hardware properly, [depending on your biosensing setup](ForDevelopers/00-ForDevelopersLanding.md#biosensing-setups).

We recommend using the GUI to start your project and check signals before moving towards full integration. Furthermore, we recommend using the GUI's Networking Widget to stream data for proof-of-concept via UDP, LSL, OSC, or Serial. This allows you to visualize real-time and playback data in the GUI while modifying your application in a separate IDE.
We recommend using the GUI to start your project and check signals before moving towards full integration. Furthermore, we recommend using the [Brainflow Streamer](https://docs.openbci.com/Software/OpenBCISoftware/GUIDocs/#gui-to-external-process) in the GUI to stream data for proof-of-concept. This allows you to visualize real-time and playback data in the GUI while modifying your application in a separate IDE.

Once proof-of-concept is achieved, it's appopriate to consider integrating the OpenBCI board directly into your project using one of the BrainFlow bindings, found below. The GUI can still be used at any time to check signals, make recordings, and stream live data.

Expand Down
3 changes: 0 additions & 3 deletions website/docs/Software/OpenBCISoftware/01-OpenBCI_GUI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,6 @@ This feature allows more advanced users to connect to OpenBCI boards using an ex

Similarly, you can reverse this process by using the BrainFlow Streamer set to "Network" and specifying the IP address and port there. The data sent out from the GUI is unfiltered. Here is the [official BrainFlow Documentation for Streaming Board](https://brainflow.readthedocs.io/en/stable/SupportedBoards.html?highlight=streaming%20board#streaming-board).

:::tip Recommendation
This method can be more reliable and quicker to implement than sending Time Series data out from the Networking Widget over UDP, LSL, or OSC!
:::

![BrainFlow Streamer over Network Option](../../assets/SoftwareImages/OpenBCISoftware/OpenBCI_GUI-BrainFlowStreamerNetworkSetting_Screenshot.png)

Expand Down