Platforms and transports

SDK surfaces

Surface	Installation	Deployment requirements
React Native	`@offline-protocol/mesh-sdk@0.27.0`	Native iOS or Android app; not Expo Go or a browser.
Python	Build the v0.27.0 native library and install the Python binding	Python 3.10+, matching native library and persistent storage.
Rust	`offline-protocol@=0.27.0` from crates.io	Supply transport I/O and storage for the target.
Constrained leaf	`offline-protocol-leaf` source	Firmware integration, entropy, storage and radio I/O; a full peer participates in session setup.

Transport compatibility

Path	React Native	Python / embedded considerations
Bluetooth LE	iOS and Android native bridges	Central via `bleak`, peripheral via `bless` (installed by default except on Windows). The SDK starts a peripheral when BLE is enabled; qualify host support and permissions.
Wi-Fi / peer streams	Not a working data path in v0.27.0. The bundled Android Wi-Fi Direct and iOS MultipeerConnectivity managers do not speak peer-stream framing, so the slot announces no peer and refuses sends. Use BLE or a provisioned relay.	Python’s `wifi_direct` slot carries authenticated TCP peer streams over an existing IP network. It does not create a Wi-Fi Direct group.
Internet relay	WebSocket connection to a configured relay	Python includes a client. A constrained MCU requires its own relay client or a companion full peer.
Reticulum	Requires a configured daemon/gateway that the SDK package does not ship	Python integrations must provide the working transport callback; enabling a flag alone does not supply the bridge.
Nostr	Requires reachable relays	Python integrations must provide the working transport callback. Nostr relay access requires a network path.

A shared transport name does not establish cross-platform interoperability. In particular, iOS MultipeerConnectivity is not Android Wi-Fi Direct. Qualify the exact device pair and path; use BLE for the phone quickstart.

Before you deploy

Confirm radio roles, permissions, background execution, payload size, battery use, storage capacity and restart behaviour on the actual hardware. Test internet loss separately from peer-link loss. A simulator build checks application integration, not radio delivery. See React Native installation, Python and embedded integration.

Obtain relay access

Turn on Hosted relay in the application’s Mesh SDK tab in the developer portal. Every plan includes relay deliveries (10,000 a month on Free), and usage beyond the quota is billed at the published rate; see hosted plans and usage. Each device authenticates to the relay with its signed-in user’s OfflineID session token as authToken. Guest sessions, portal API keys, and developer or admin tokens are not accepted. Then set the relay WebSocket serverAddress to wss://relay.offlineprotocol.com. Local peer-to-peer traffic is never metered on any plan.

Start here

Workflows

Examples and integrations

Operate and ship

Developer portal

Support

SDK surfaces

Transport compatibility

Before you deploy

Obtain relay access

​SDK surfaces

​Transport compatibility

​Before you deploy

​Obtain relay access

SDK surfaces

Transport compatibility

Before you deploy

Obtain relay access