API and example library

Use the website for tasks and the canonical references for exact methods, parameters, types and feature gates. Choose the revision first; development APIs may differ even while their package version still reads 0.11.0.

Current development

Start with the development overview and engineering documentation map.

Reference	Use it for
Rust API	Crate APIs, feature gates, shared endpoint contracts, transport ownership and migration details
Python API	Constructors, native Awaitable results, endpoint lifecycle and binding-specific limits
Python type stub	Editor-facing signatures for the matching native build
CLI reference	Current flags and transport prerequisites
Architecture	Crate composition, packet paths and lifecycle ownership

For source checkout rustdoc, select the features used by your application. Do not assume every workspace crate is published or that a published documentation page matches the current checkout. Use the shared endpoint guide to compare requester, responder and source Audit scope before choosing that owner.

Release v0.11.0

The preserved Rust API guide, Python API guide and distributed type stub describe the release. Its workspace manifest defines the release version and Rust minimum.

The release Python transport summary omits MS/TP; use the versioned mini-device example and implementation for that path. A type constant alone does not prove that a bundled server implements an object family.

Examples by task

Example	Read it for	Review before running
bip_client_server.py	Client/server lifecycle, reads and RPM	Socket exposure and demonstration writes
cov_subscriptions.py	Subscriptions and consumption	Remote subscription state and cleanup
sc_secure_connect.py	Hub and node configuration	Credentials and identity rules at the chosen revision
mstp_mini_device.py	Standalone serial device	Adapter, MAC, baud and token participation
device_management.py	Management services and errors	Control-changing operations

Browse current examples or v0.11 examples. The site’s local lab keeps its tested release source and download together.