Overview
This page serves as your guide to the documentation: you'll find an overview of how everything is organized, recommended reading paths for newcomers, and direct links to every section you might need.
Reading flow#
If you're starting out, read the sections in this order. Each step links to a section overview, so this doubles as a guided tour.
- Getting started — install the SDK, connect a device, and reach your first subsystem.
- Main concepts — the mental model: what each subsystem senses or actuates, and the vocabulary the rest of the reference assumes.
- Examples — complete, runnable scripts. The fastest way to feel the API on real hardware.
- API · Core then API · Subsystems — the class-by-class reference, for when you know what you want to build.
Already have a device connected? The Getting started page ends with a deeper reading flow tailored to running real code.
The full map#
1 · Introduction#
Set up and get oriented.
| Page | What's there |
|---|---|
| Overview (this page) | How the docs are organized and where to start. |
| Getting started | Requirements, installing teslasuit_sdk, connecting a device, and accessing a subsystem. |
2 · Main concepts#
What the hardware does — the ideas the API assumes.
| Page | What's there |
|---|---|
| Overview | A map of the XR5 subsystems with a per-topic reading list. |
| Haptics & EMS | Programmable electrical stimulation, from light touch through to muscle contractions driven by electrical muscle stimulation (EMS) and functional electrical stimulation (FES). |
| Mocap | Full-body motion capture from the suit's inertial measurement units (IMUs): skeleton, raw IMU, and biomechanical angles. |
| PPG | Optical photoplethysmography (PPG) heart-rate sensing, with heart rate variability (HRV) and raw pulse signals. |
| Body & channel map | An interactive tool showing how the suit addresses channels by anatomical bone. It also provides a copy-pastable snippet for the selected bone. |
3 · API · Core#
The layer above subsystems — library lifecycle, device management, bone-channel mapping, and shared types.
| Page | What's there |
|---|---|
| Overview | How TsApi, the device manager and the mapper fit together, with the full inheritance diagram. |
| TsApi | The central entry point that loads the C library and owns the other managers. |
| Device manager | Discover, attach and select connected devices. |
| Device | A single Teslasuit device and the subsystems it exposes. |
| Mapper | Bone ↔ channel mapping and the 2D layout used by the body map. |
| Asset manager | Load, retrieve and unload haptic assets and animations. |
| Data structures | The shared types and enums used across every subsystem. |
4 · API · Subsystems#
One class per device capability.
| Page | What's there |
|---|---|
| Haptic | TsHapticPlayer — instant touches and looped playables. |
| Mocap | TsMocap — raw, skeleton and biomechanical data. |
| PPG | TsPpg — heart rate and HRV biometrics. |
5 · Examples#
Complete, runnable scripts grouped by subsystem.
| Page | What's there |
|---|---|
| Overview | Every runnable script, grouped by subsystem. |
| Play a haptic touch | Play your first touch on the suit. |
| Read heart rate | Read live heart rate from a PPG node. |
| Measure HRV | Read the Mean inter-beat interval from the PPG sensor. |
| Stream motion data | Stream skeleton data and biomechanical angles. |
Next: head to Getting started to connect a device and test out some of its functionality