Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@ To use iroh on ESP32 in production, [contact us for support & licensing options]
| UDP / IP (internet) | Yes |
| WiFi / LAN | Yes |
| Ethernet | Yes |
| Bluetooth (BLE) | [In progress](/transports/bluetooth) |
| Bluetooth (BLE) | [Yes](/transports/bluetooth) |
| Tor | [Yes](/transports/tor) |
| Nym | [Yes](/transports/nym) |
23 changes: 17 additions & 6 deletions transports/bluetooth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,25 @@
title: "Bluetooth (BLE)"
---

Bluetooth Low Energy (BLE) transport support is not yet available. We plan to
work with the community to implement it. If you're interested in contributing,
reach out on [Discord](https://www.iroh.computer/discord).
Bluetooth support is powered by [blew](https://github.com/mcginty/blew), an open source BLE (Bluetooth Low Energy) Rust library focused on enabling peer-to-peer applications.

<Warning>
blew is in alpha state and is subject to change without backwards-compatibility until otherwise noted.
</Warning>

blew implements both Central and Peripheral modes, with support for macOS, iOS, Android, and Linux. It is async-only and requires a Tokio runtime.

blew is open source under the [AGPL license](https://www.gnu.org/licenses/agpl-3.0.en.html). Commercial licenses are available for use cases where the AGPL is not suitable. Contact the [number0 team](https://cal.com/team/number-0/iroh-services?overlayCalendar=true) or [me@jakebot.org](mailto:me@jakebot.org) for details.

## Custom transport API

The custom transport API lets anyone implement new transports by implementing a set of traits for low-level packet sending and receiving. Each transport defines its own address type and serialization format.
The custom transport API lets anyone implement new transports by implementing a
set of traits for low-level packet sending and receiving. Each transport defines
its own address type and serialization format.

## Usage

See [Tor](/transports/tor) and [Nym](/transports/nym) for examples of custom transport implementations today.

Custom transport support requires the `unstable-custom-transports` feature flag. The API is unstable and subject to change. See [PR #3845](https://github.com/n0-computer/iroh/pull/3845) for background.
Custom transport support requires the `unstable-custom-transports` feature flag.
The API is unstable and subject to change. See [PR
#3845](https://github.com/n0-computer/iroh/pull/3845) for background.
Loading