.. include:: /substitutions.rst
.. _index:

HackEEG Python client library
=================================================

Release v\ |version|. (:ref:`Installation <install>`)

.. toctree::
   :maxdepth: 2
   :caption: Contents:

**HackEEG** allows you to communicate with the `HackEEG shield <Python clien://github.com/starcat-io/hackeeg-shield>`_
for the `TI ADS1299 EEG system-on-a-chip <http://www.ti.com/product/ADS1299>`_,
configure the board, and read and stream data. Sample programs are provided that can stream data to other software
via `Lab Streaming Layer <://github.com/sccn/labstreaminglayer>`_.

User Guide
----------

This part of the documentation focuses on how to install hackeeg and use it to stream data to OpenBCI
or other programs.

.. toctree::
   :maxdepth: 2

   user/intro
   user/install
   user/quickstart
   user/openbci
   user/local-streaming
   user/wifi-streaming
   user/python-api



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`