mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-30 07:59:54 -08:00
134 lines
4 KiB
Plaintext
134 lines
4 KiB
Plaintext
---
|
|
id: bluetooth
|
|
title: Bluetooth Settings
|
|
sidebar_label: Bluetooth
|
|
description: Configure Bluetooth settings on your Meshtastic device for connectivity with smartphones and other devices.
|
|
---
|
|
|
|
import Tabs from "@theme/Tabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
The Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN Value. Bluetooth config uses an admin message sending a `Config.Bluetooth` protobuf.
|
|
|
|
:::info
|
|
ESP32 Devices: Bluetooth will be disabled if WiFi is enabled. The WiFi setting takes precedence.
|
|
:::
|
|
|
|
## Bluetooth Config Values
|
|
|
|
### Enabled
|
|
|
|
Enables Bluetooth.
|
|
|
|
### Pairing Mode
|
|
|
|
Specify pairing mode.
|
|
|
|
`RANDOM_PIN` generates a random PIN during runtime.
|
|
`FIXED_PIN` uses the fixed PIN that should then be additionally specified.
|
|
Finally, `NO_PIN` disables PIN authentication.
|
|
|
|
### Default Pairing Mode
|
|
|
|
The default pairing mode will be determined based on whether the device has or does not have a screen attached to it during the first boot (or with a stale device state) unless manually configured via the Bluetooth config options.
|
|
|
|
- **Screen Attached:** If your device boots up for the first time (or with a stale device state), and a screen is detected, the default pairing mode will be set to `RANDOM_PIN`. Should the attached screen be removed after the device has already been booted, the default pairing mode of `RANDOM_PIN` will remain unless manually changed to `FIXED_PIN` or `NO_PIN`. It is recommended the pairing mode be updated prior to removing the attached screen.
|
|
- **No Screen Attached:** If your device boots up for the first time (or with a stale device state), and no screen is detected, the default paring mode will be set to `FIXED_PIN` with the default value listed below unless manually configured to a custom value.
|
|
|
|
### Fixed PIN
|
|
|
|
If your pairing mode is set to `FIXED_PIN`, the default value is **123456**. For all other pairing modes, this number is ignored. A custom integer (6 digits) can be set via the Bluetooth config options.
|
|
|
|
:::danger Warning
|
|
It is strongly recommended that you change the default `FIXED_PIN` code on your device. Leaving the default code in place can pose a significant security risk.
|
|
:::
|
|
|
|
## Bluetooth Config Client Availability
|
|
|
|
<Tabs
|
|
groupId="settings"
|
|
defaultValue="cli"
|
|
values={[
|
|
{label: 'Android', value: 'android'},
|
|
{label: 'Apple', value: 'apple'},
|
|
{label: 'CLI', value: 'cli'},
|
|
{label: 'Web', value: 'web'},
|
|
]}>
|
|
<TabItem value="android">
|
|
|
|
#### Android
|
|
|
|
:::info
|
|
|
|
All Bluetooth config options are available for Android.
|
|
|
|
1. Open the Meshtastic App
|
|
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Bluetooth**
|
|
|
|
:::
|
|
|
|
</TabItem>
|
|
<TabItem value="apple">
|
|
|
|
#### Apple
|
|
|
|
:::info
|
|
|
|
All bluetooth config options are available on iOS, iPadOS and macOS at Settings > Device Configuration > Bluetooth.
|
|
|
|
:::
|
|
|
|
</TabItem>
|
|
<TabItem value="cli">
|
|
|
|
#### CLI
|
|
|
|
:::info
|
|
|
|
All Bluetooth config options are available in the python CLI. Example commands are below:
|
|
|
|
:::
|
|
|
|
| Setting | Acceptable Values | Default |
|
|
| :------------------: | :---------------------------------: | :----------: |
|
|
| `bluetooth.enabled` | `true`, `false` | `true` |
|
|
| `bluetooth.mode` | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` |
|
|
| `bluetooth.fixedPin` | `integer` (6 digits) | `123456` |
|
|
|
|
:::tip
|
|
|
|
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
|
|
|
|
```shell title="Example:"
|
|
meshtastic --set bluetooth.enabled true --set bluetooth.fixed_pin 111111
|
|
```
|
|
|
|
:::
|
|
|
|
```shell title="Enable/Disable Bluetooth Module"
|
|
meshtastic --set bluetooth.enabled true
|
|
meshtastic --set bluetooth.enabled false
|
|
```
|
|
|
|
```shell title="Set a fixed pin"
|
|
meshtastic --set bluetooth.mode FIXED_PIN
|
|
meshtastic --set bluetooth.fixed_pin 111111
|
|
```
|
|
|
|
</TabItem>
|
|
<TabItem value="web">
|
|
|
|
#### Web
|
|
|
|
:::info
|
|
|
|
All Bluetooth module config options are available for the Web UI.
|
|
|
|
1. Open the Meshtastic Web UI.
|
|
2. Navigate to: **Radio Config > Bluetooth**
|
|
|
|
:::
|
|
|
|
</TabItem>
|
|
</Tabs>
|