Welcome to the etee Python API Documentation

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.

For the Python API code and installation, visit our Github repository here.

---

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

• 1. Overview
  • 1.1. Hardware
  • 1.2. Sensor Data
    • 1.2.1. Tactile Data
    • 1.2.2. Inertial Measuring Units (IMU) Data
    • 1.2.3. Device and Battery State Data
• 2. Setup
  • 2.1. Hardware Setup
    • 2.1.1. Controllers and eteeDongle Connection
    • 2.1.2. Firmware Versions
  • 2.2. Python Package Setup
    • 2.2.1. Install from Github
• 3. Using etee Python API
  • 3.1. Quickstart
  • 3.2. Methods and Class Constructors
• 4. About the API Functionalities
  • 4.1. Creating Connections and Streaming Data
  • 4.2. Retrieving Device Inputs
    • 4.2.1. Data Getters Functions
    • 4.2.2. Event-Based Methods
  • 4.3. How IMU Data Is Processed
  • 4.4. Event-Based Programming
  • 4.6. Resetting Sensor Baselines
• 5. About the eteeDongle Serial Communication
  • 5.1. etee Packet Elements
    • 5.1.1. Tactile Data
    • 5.1.2. Gestures
    • 5.1.3. Inertial Measuring Units (IMU)
    • 5.1.4. Device State
    • 5.1.5. Battery State
  • 5.2. Data Packet Structure
  • 5.3. Commands
  • 5.4. Event Prints
• 6. API Reference
  • EteeController Class
    • EteeController
    • Connections
      • EteeController.connect()
      • EteeController.connect_port()
      • EteeController.disconnect()
      • EteeController.run()
      • EteeController.stop()
      • EteeController.start_data()
      • EteeController.stop_data()
      • EteeController.get_available_etee_ports()
    • Events
      • EteeController.left_hand_received
      • EteeController.right_hand_received
      • EteeController.hand_received
      • EteeController.left_hand_lost
      • EteeController.right_hand_lost
      • EteeController.data_lost
      • EteeController.left_connected
      • EteeController.right_connected
      • EteeController.left_disconnected
      • EteeController.right_disconnected
      • EteeController.dongle_disconnected
    • IMU Processing
      • Enable Absolute / Relative Orientation
      • Set Offsets
    • Data getters
      • General-Use Data Getters
      • Specific-Use Data Getters
  • Event Class
    • EteeControllerEvent
      • EteeControllerEvent.connect()
      • EteeControllerEvent.disconnect()
      • EteeControllerEvent.emit()
• 🖳 Go to: Github Repository