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

HackEEG Setup Instructions
==========================
Release v\ |version|.

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

This is a guide to using the HackEEG hardware and software.

Support
-------

For support questions, join the `HackEEG mailing list <https://groups.google.com/forum/#!forum/hackeeg>`_
or email `support@starcat.io <mailto:support@starcat.io>`_.

.. index::
   single: overview

Overview
--------

A HackEEG system is made up of a HackEEG shield mated to an Arduino Due, the HackEEG driver running on the Arduino,
a client program to read data from the HackEEG/Arduino, and a fork of OpenBCI GUI that is modified to accept
Lab Streaming Layer input.

Info on these components can be found here:

* `HackEEG hardware design files and configuration information <https://github.com/starcat-io/hackeeg-shield>`_
   * `Connector Pinouts <https://github.com/starcat-io/hackeeg-shield/blob/master/docs/connectors.md>`_
   * `Configuration Jumper Reference <https://github.com/starcat-io/hackeeg-shield/blob/master/docs/configuration.md>`_
   * `Typical Configuration <https://github.com/starcat-io/hackeeg-shield/blob/master/docs/typical-configuration.md>`_
   * `Schematic (PDF) <https://github.com/starcat-io/hackeeg-shield/blob/master/hackeeg-shield.pdf>`_
* `HackEEG Arduino driver files <https://github.com/starcat-io/hackeeg-driver-arduino>`_
* `HackEEG Python client <https://github.com/starcat-io/hackeeg-client-python>`_
   * `HackEEG Python client documentation <https://hackeeg-client-python.readthedocs.io/en/latest/>`_
* `HackEEG Rust client <https://github.com/starcat-io/hackeeg-client-rust>`_

.. index::
   single: user guide

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

.. toctree::
   :maxdepth: 2

   Product Description <user/hackeeg>
   Kit Contents <user/kit-contents>
   Hardware Configuration <user/hardware>
   user/quickstart
   Software Installation <user/software-installation>
   user/raspberry-pi
   user/electrodes
   user/support

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

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