Complete installation, then choose a tutorial or an integration guide to suit your task.
The installation guide covers source acquisition, dependencies, and environment verification.
| Guide | What you will learn |
|---|---|
| Introduction: your first device call | Run the mock heater and understand discovery, submission, and execution feedback |
| Advanced: OT-2 simulation | Generate pipetting code, run it in the official simulator, and inspect the resulting evidence |
| Guide | What you will learn |
|---|---|
| Application integration | Configure an MCP client, call capabilities, and handle execution outcomes |
| Device integration | Register instances and develop a reusable SDK adapter |
| Offline model definitions | Add capability schemas and validate calls through the shared backend |
| Reference | Contents |
|---|---|
| Design guide | Access levels, capability/state/execution objects, completion evidence, and MCP compatibility |
| Device catalog | Available instances, model interfaces, and execution modes |
| Protocol reference | Messages, units, defaults, state, lifecycle, and evidence |
| JSON Schemas | Public message and configuration schemas |
| Examples | Runnable clients and expected feedback |
| Model definitions | Capability definitions grouped by device class |
| Contributing | Development setup, checks, and generated files |
Each guide has an English and a Simplified Chinese version, linked at the top. Commands, API names, and data formats are the same in both versions.