Metadata-Version: 2.1
Name: timeflux-openbci
Version: 0.3.1
Summary: Timeflux OpenBCI plugin
Home-page: https://timeflux.io
Author: Pierre Clisson
Author-email: contact@timeflux.io
License: MIT
Project-URL: Documentation, http://doc.timeflux.io/projects/timeflux-openbci/
Project-URL: Source Code, https://github.com/timeflux/timeflux_openbci
Project-URL: Bug Tracker, https://github.com/timeflux/timeflux_openbci/issues
Keywords: timeflux,openbci
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Dist: timeflux-brainflow (>=0.4)
Requires-Dist: timeflux (>=0.5.3)
Provides-Extra: dev
Requires-Dist: pytest (>=5.3) ; extra == 'dev'
Requires-Dist: sphinx (>=2.2) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (>=0.4) ; extra == 'dev'
Requires-Dist: setuptools-scm ; extra == 'dev'
Requires-Dist: docinit ; extra == 'dev'

Timeflux OpenBCI plugin
=======================

This plugin provides a unified interface for all `OpenBCI <https://openbci.com>`__ boards.

Installation
------------

First, make sure that `Timeflux <https://github.com/timeflux/timeflux>`__ is installed.

You can then install this plugin in the `timeflux` environment:

::

    $ conda activate timeflux
    $ pip install timeflux_openbci

Troubleshooting
---------------

If the data looks choppy, it is very likely because of a latency issue with the FTDI driver. Hopefully, there is a fix both for `Windows <https://docs.openbci.com/docs/10Troubleshooting/OpenBCI_on_Windows>`__ and `MacOS <https://docs.openbci.com/docs/10Troubleshooting/FTDI_Fix_Mac>`__.

