############################################
Welcome to the etee Python API Documentation
############################################

.. image:: /images/api_logo_transp-black.png
   :width: 30%
   :alt: eteeController tactile sensors
   :align: center

etee is the first-of-its-kind finger, gesture and pressure sensing controller. The etee Python API library allows developers to work with eteeControllers.
Currently, Python programming language is supported.

|GithubLink|_ For the Python API code and installation, visit our Github repository `here <https://github.com/eteeXR/etee-Python-API>`__.

|PlatformLink|_ |LicenseLink|_ |WebsiteLink|_ |ContactLink|_ |TwitterLink|_

.. |GithubLink| image:: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png
   :width: 5%
   :alt: Github repository
.. _GithubLink: https://github.com/eteeXR/etee-Python-API

.. |PlatformLink| image:: https://img.shields.io/badge/platform-win--32%20%7C%20win--64-green
.. _PlatformLink: https://github.com/eteeXR/etee-Python-API/releases

.. |LicenseLink| image:: https://img.shields.io/badge/license-Apache 2.0-red
.. _LicenseLink: https://www.apache.org/licenses/LICENSE-2.0

.. |WebsiteLink| image:: https://img.shields.io/badge/website-eteexr.com-blue
.. _WebsiteLink: https://eteexr.com

.. |ContactLink| image:: https://img.shields.io/badge/contact-customer%40eteexr.com-lightgrey
.. _ContactLink: customer@eteexr.com

.. |TwitterLink| image:: https://img.shields.io/twitter/follow/etee_tg0?style=social
.. _TwitterLink: https://twitter.com/etee_tg0

----

This documentation describes how to wirelessly interface with the eteeControllers via an eteeDongle.

Some features include:

* Connecting or disconnecting devices

* Starting or stopping the streaming of sensor data

* Retrieving tactile, IMU and device state data


----

List of Content
===============

.. toctree::
   :maxdepth: 4

   overview
   setup
   quickstart
   guide
   serial
   reference
   githublink