TeslasuitDocumentation
APIs

Overview

The Teslasuit API provides a comprehensive set of tools for interacting with Teslasuit devices. This documentation covers the core components of the API, including:

  • device management
  • mapping
  • asset handling
  • subsystem access.

Prerequisites#

  1. Teslasuit API Library
    Ensure the Teslasuit API library (teslasuit_api.dll) is available and correctly loaded.
  2. Teslasuit API Library Path
    Ensure the Teslasuit API library path is correctly set in the environment variable TESLASUIT_API_LIB_PATH, or provided explicitly.
  3. Connected Teslasuit Device
    A Teslasuit device must be connected to access its features.
  4. Python Environment
    Python 3.8+ is required to use the Teslasuit SDK.

Core components#

Python TS API#

The central interface for initializing and managing the Teslasuit API. It provides access to core functionalities such as device management, asset management, and mapping subsystems.

Device manager#

Handles the connection and disconnection of Teslasuit devices. It provides access to connected devices and their properties, enabling seamless interaction with the Teslasuit ecosystem.

Device#

Represents a Teslasuit device and provides access to its subsystems, such as motion capture, haptics, and biometry. It also allows retrieval of device-specific information.

Mapper#

Provides functionality for handling 2D mapping of device elements, including layouts, bones, and associated data. It supports operations like retrieving mappings and layouts.

Loader#

Handles the dynamic loading of the Teslasuit C API library. It ensures the library is correctly loaded and accessible for API operations.

Asset manager#

Manages Teslasuit assets, including loading, retrieving, and unloading assets. It supports operations with assets such as haptic effects and animations.

Data structures#

Defines the data structures and enumerations used across the Teslasuit SDK, including mappings, layouts, bones, and subsystem-specific configurations.

Inheritance scheme#

Loading diagram…

Notes#

  • Ensure the Teslasuit API is initialized before accessing any of its components.
  • Refer to the respective component pages for detailed usage and examples.