Octopus Sensing PLUX

PLUX devices (biosignalsplux, BITalino, ...) support for Octopus Sensing.

Installation

pip install octopus-sensing-plux

It installs Octopus Sensing as well.

Usage

from octopus_sensing.device_coordinator import DeviceCoordinator
from octopus_sensing_plux import PluxStreaming

my_plux = PluxStreaming("BTH00:07:80:4D:2E:76",
                        sampling_rate=1000,
                        active_ports=[1, 2, 3],
                        name="plux",
                        output_path="./output")

device_coordinator = DeviceCoordinator()
device_coordinator.add_devices([my_plux])

The device should be paired via Bluetooth before running the code. The address is the device's MAC address prefixed with BTH (Bluetooth) or BLE (Bluetooth Low Energy).

Data is recorded in {output_path}/{name} as CSV files with the following columns: nSeq, port_1, ..., port_n, timestamp, trigger.

See examples/plux_example.py for a complete example:

python examples/plux_example.py BTH00:07:80:4D:2E:76 --ports 1 2 --trials 2 --duration 5

Supported platforms

PLUX API is not available on PyPI. Its binaries from PLUX python-samples are bundled in octopus_sensing_plux/plux_api (Apache-2.0, see octopus_sensing_plux/plux_api/LICENSE) for:

On other platforms, download the PLUX API for your platform and Python version and pass its directory to PluxStreaming as plux_api_path.

On MacOS, if you see The communication port could not be initialized, follow the "macOS Setup" section of the PLUX python-samples README for the files in octopus_sensing_plux/plux_api/M1_3xx.

Development

poetry install
poetry run pytest tests
poetry run mypy octopus_sensing_plux

License

GPL-3.0-or-later. The bundled PLUX API binaries are licensed under Apache-2.0.