SDKPython SDK

Example index

Find the runnable Python example for a given goal.

Current version · 1.4.0

Example index

examples/glove/python/src/ provides examples that can be run independently:

GoalExampleMain API
Discover currently connected glovesdiscover_gloves.pydiscover_gloves(), GloveConfig, SerialConnection
Read dynamic OpenXR hand skeletonskeleton.pyskeleton(), joint_angles(), pose()
Read a single glove's pose with no argumentsquick_start.pyGloveConfig, pose(), run_forever()
Read IMU raw countsimu.pyimu(), subscribe(), run_forever()
Synchronize with external Unix-millisecond time and resynchronize while runningtime_sync.pysync_time(), run_background()
Receive external frames in the background and subscribe to output (recommended)external_input_run_background.pyExternalConnection, push_frame(), run_background(), subscribe()
Receive external frames in the host loop (advanced)external_input_manual_update.pyExternalConnection, push_frame(), update()
Record debug logs of input and SDK-processed datadebug_trace.pyDebugConfig, TargetAlgorithm, output(), run_forever()
Embed into an existing main loopmanual_runtime.pyupdate(), UpdateResult.sleep()
Run on the current threadforeground_runtime.pyrun_forever(), health()
Run on a background threadbackground_runtime.pyrun_background(), join()
Read SDK-processed data asynchronously with asyncioasync_runtime.pyawait next(), async for
Control glove fingertip vibrationhaptics.pyhaptics(), set(), clear()
One glove drives multiple targetsmultiple_outputs.pyTargetAlgorithm, output(name), subscribe(), run_forever()
Control one device among multiple gloves individuallydevice_lifecycle.pydevice(name), device(side)
Capture raw frames of the left and right hands and compute calibration using the algorithm package selected this timehost_capture_calibration.pystart_capture(), start_calibration(), retry()

Every Python file in the examples directory is an independent example and does not depend on a shared _common.py. To work through a scenario step by step, see Quick start.