Merge pull request #526 from rcarteraz/update-bluetooth-page

updates to bluetooth.mdx
This commit is contained in:
Thomas Göttgens 2022-12-02 00:32:07 +01:00 committed by GitHub
commit 442b60d5ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 962 additions and 1048 deletions

View file

@ -11,7 +11,7 @@ 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. The Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN Value. Bluetooth config uses an admin message sending a `Config.Bluetooth` protobuf.
:::info :::info
On ESP32 Bluetooth will be disabled if WiFi is enabled. The WiFi setting takes precedence. ESP32 Devices: Bluetooth will be disabled if WiFi is enabled. The WiFi setting takes precedence.
::: :::
## Bluetooth Config Values ## Bluetooth Config Values
@ -30,7 +30,14 @@ Finally, `NO_PIN` disables PIN authentication.
### Fixed PIN ### Fixed PIN
If your pairing mode is set to fixed PIN this is the value of that fixed 6 digit pin. Default value is 123456. For all other pairing modes, this number is ignored. 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.
### 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 aforementioned default value unless manually configured to a custom value.
## Configure Bluetooth Config ## Configure Bluetooth Config
@ -46,22 +53,35 @@ values={[
<TabItem value="android"> <TabItem value="android">
:::info :::info
Bluetooth config is not available for Android.
All Bluetooth config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Advanced Settings > Bluetooth Config**
::: :::
</TabItem> </TabItem>
<TabItem value="apple"> <TabItem value="apple">
:::info
All Bluetooth config values are available on iOS, iPadOS and macOS. All Bluetooth config values are available on iOS, iPadOS and macOS.
1. Open the Meshtastic App 1. Open the Meshtastic App
2. Navigate to: **Settings > Radio Configuration > Position** 2. Navigate to: **Settings > Radio Configuration > Bluetooth (BLE)**
:::
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
:::info
All Bluetooth module config options are available in the python CLI. Example commands are below: All Bluetooth module config options are available in the python CLI. Example commands are below:
:::
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :-----------------------: | :-----------------: | :-----: | | :-----------------------: | :-----------------: | :-----: |
| `bluetooth.enabled` | `true`, `false` | `true` | | `bluetooth.enabled` | `true`, `false` | `true` |
@ -81,7 +101,12 @@ meshtastic --set bluetooth.fixed_pin 111111
<TabItem value="web"> <TabItem value="web">
:::info :::info
All Bluetooth module config options are available for the Web UI. All Bluetooth module config options are available for the Web UI.
1. Open the Meshtastic Web UI.
2. Navigate to: **Device Config > Bluetooth**
::: :::
</TabItem> </TabItem>

View file

@ -21,20 +21,20 @@
"@heroicons/react": "^2.0.13", "@heroicons/react": "^2.0.13",
"@leenguyen/react-flip-clock-countdown": "^1.3.1", "@leenguyen/react-flip-clock-countdown": "^1.3.1",
"@mdx-js/react": "^1.6.22", "@mdx-js/react": "^1.6.22",
"@meshtastic/meshtasticjs": "^0.6.113", "@meshtastic/meshtasticjs": "^0.6.115",
"autoprefixer": "^10.4.13", "autoprefixer": "^10.4.13",
"base64-js": "^1.5.1", "base64-js": "^1.5.1",
"dotenv": "^16.0.3", "dotenv": "^16.0.3",
"framer-motion": "^6.5.1", "framer-motion": "^6.5.1",
"postcss": "^8.4.18", "postcss": "^8.4.19",
"react": "^17.0.2", "react": "^17.0.2",
"react-dom": "^17.0.2", "react-dom": "^17.0.2",
"react-icons": "^4.6.0", "react-icons": "^4.7.1",
"react-responsive-carousel": "^3.2.23", "react-responsive-carousel": "^3.2.23",
"swr": "^1.3.0", "swr": "^1.3.0",
"tailwindcss": "^3.2.3", "tailwindcss": "^3.2.4",
"url-search-params-polyfill": "^8.1.1", "url-search-params-polyfill": "^8.1.1",
"use-breakpoint": "^3.0.3" "use-breakpoint": "^3.0.4"
}, },
"devDependencies": { "devDependencies": {
"@docusaurus/module-type-aliases": "2.2.0", "@docusaurus/module-type-aliases": "2.2.0",
@ -43,8 +43,8 @@
"@tsconfig/docusaurus": "^1.0.6", "@tsconfig/docusaurus": "^1.0.6",
"@types/node": "^18.11.9", "@types/node": "^18.11.9",
"@types/react": "^18.0.25", "@types/react": "^18.0.25",
"@types/react-dom": "^18.0.8", "@types/react-dom": "^18.0.9",
"prettier": "^2.7.1", "prettier": "^2.8.0",
"typescript": "^4.8.4" "typescript": "^4.9.3"
} }
} }

File diff suppressed because it is too large Load diff