Click or drag to resize
BioRadio API

Welcome to the BioRadio API from Great Lakes NeuroTechnologies. This guide is intended for developers seeking to incorporate the BioRadio into their own applications. The API provides methods to scan, connect, configure, and stream data from the device.

Getting Started

The first task when working with a BioRadio is to identify its MAC address in order to establish a connection. If you already know your MAC ID, you can get a reference to a BioRadioDevice by instantiating a BioRadioDeviceManager and calling GetBluetoothDevice(Int64).

If you do not know the MAC ID of your device, you can initiate a scan using the DiscoverBluetoothDevices method. This method will return a list of discovered devices by their device ID and MAC ID.

Configuring the Device

The BioRadio can be configured in various ways depending on the intended application. The BioRadioConfiguration class is used to define the configuration of a device. The device's current configuration can be retrieved by calling GetConfiguration and it can be programmed using SetConfiguration

Acquiring Data

Once your device has been located and configured, you may start acquisition by calling StartAcquisition. The device will then begin streaming signal data to your application. The BioRadio API receives the data from the BioRadio and makes it available to applications using the various Signal groups. Signal groups are collections of signals that share certain properties, such as sample rate or physical location on the device. Each signal group contains zero or more signals, based on the configuration of the device. There are various ways to retrieve the data from the signals, based on your application requirements. A common method that can be used for this purpose is GetScaledValueArray.

Memory Mode

Data recorded to the BioRadio internal memory can be consumed using this API. To get started, create a VirtualDeviceAdapter using CreateVirtualDevice(String). The VirtualDeviceAdapter serves as a wrapper around a device object from which data can be read.