MeshLink is an offline-first BLE mesh SDK for Android and iOS.
This repository contains:
- the shared
meshlinkKotlin Multiplatform SDK - the shared
meshlink-referenceapp for guided evaluation, diagnostics, retained session history, and exports - runnable Android and iOS proof apps for physical validation
- retained benchmark and release-decision evidence
- tutorials, how-to guides, reference docs, and explanation docs
MeshLink has not cut a public stable release yet.
Today, the repository is still source-distributed from a local checkout. The
intended first public release shape is a published :meshlink artifact for
Gradle consumers while iOS continues to use the generated Apple framework path.
Swift Package Manager and CocoaPods are not part of that first-release target.
For the current distribution shape and remaining release blockers, use the release status reference.
Release-facing entry points:
Audience: engineers integrating MeshLink into a host application.
After reading these docs, you should be able to: add MeshLink to an app, bootstrap the runtime, react to peers and messages, send payloads correctly, and find the right supporting document when you need more detail.
The documentation follows the Diataxis model. Start with the full documentation map, which also includes recommended reading orders for new integrators, production integrations, debugging, technical evaluation, and a small architecture index for diagram-first reading.
Quick entry points:
- How to add MeshLink to your app
- Your first MeshLink exchange
- How to integrate MeshLink into a host app
- How to structure a robust MeshLink integration
- How to unblock MeshLink permissions on Android and iOS
- How to use MeshLink from Swift
- MeshLink SDK API reference
- MeshLink runtime behavior reference
- Glossary and acronym reference
- Release status reference
- Repository layout reference
- About how MeshLink works
- About the repository architecture
- About integrating MeshLink well
Maintainers can run ./gradlew verifyDocs to check markdown links and the
rendered API appendix, and ./gradlew checkAgp9Invariants to confirm the
post-migration AGP 9 module shape stays intact.
- How to contribute to MeshLink
- Contributor build, test, and verification reference
- Release runbook
- Repository layout reference
- About the repository architecture
- How to evaluate MeshLink with the reference app
- How to run the Android proof app
- How to build and run the iOS proof app
- Benchmarks and retained evidence
- Feature specification and release decision
- Spec alignment audit
For day-to-day use, prefer these documents in order:
- the public API and integration docs for developer-facing behavior
- the specification and release-decision docs for product requirements
- the benchmark evidence for retained performance and physical validation