DOCS-3498: Add Bluetooth provisioning docs for viam-agent #4372

promptless · 2025-06-02T11:53:10Z

See:

Note: these do not go in detail through the flutter provisioning widget. I think currently providing that is enough but if you think differently let me know.

netlify · 2025-06-02T11:53:14Z

✅ Deploy Preview for viam-docs ready!

Name	Link
🔨 Latest commit	`2cb36bb`
🔍 Latest deploy log	https://app.netlify.com/projects/viam-docs/deploys/68a740bbc2dfb60008876905
😎 Deploy Preview	https://deploy-preview-4372--viam-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 41 (🔴 down 8 from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: 70 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

viambot · 2025-06-02T11:53:21Z

👋 Thanks for contributing! A reviewer will look at it on the next working day!

promptless · 2025-06-02T11:53:25Z

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

npentrel · 2025-06-02T15:56:19Z

docs/manage/fleet/provision/setup.md

@@ -74,100 +77,10 @@ If you do not yet have a fragment, follow the steps to [Create a configuration f
 If you are not using Flutter or TypeScript and would like to use provisioning, please [contact us](mailto:[email protected]).
 {{< /alert >}}

-If you choose to use the captive web portal, you can optionally create a machine in advance and provide its machine cloud credentials file at <FILE>/etc/viam.json</FILE>.


moved further below

viambot · 2025-07-28T12:26:32Z

It looks like the following files may have been renamed. Please ensure you set all needed aliases:
rename docs/data-ai/{train => ai/advanced}/_index.md (37%) rename docs/data-ai/{train => ai/advanced}/upload-external-data.md (91%) rename docs/data-ai/{train => ai}/train-tflite.md (84%) rename docs/data-ai/{train => ai}/train.md (97%) rename docs/operate/get-started/other-hardware/{create-module => }/dependencies.md (82%) rename docs/operate/get-started/other-hardware/{create-module => }/hello-world-module.md (96%) rename docs/operate/{get-started/other-hardware => reference}/module-configuration.md (74%) rename docs/operate/{get-started/other-hardware => reference}/naming-modules.md (69%) rename docs/operate/{mobility => reference}/orientation-vector.md (97%)

npentrel · 2025-07-28T13:33:46Z

docs/manage/reference/viam-agent/_index.md

 | `disable_captive_portal_redirect` | boolean | Optional | By default, ALL DNS lookups using the provisioning hotspot will redirect to the device. This causes most phones/mobile devices to automatically redirect the user to the captive portal as a "sign in" screen. When disabled, only domains ending in .setup (ex: viam.setup) will be redirected. This generally avoids displaying the portal to users and is mainly used in conjunction with a mobile provisioning application workflow. Default: `false`. |
-| `fragment_id` | string | Optional | The `fragment_id` of the fragment to configure machines with. Required when using the Viam mobile app for provisioning. The Viam mobile app uses the fragment to configure the machine. |
+| `disable_wifi_provisioning` | boolean | Optional | When set to true, disables WiFi hotspot provisioning. The machine will not create a WiFi hotspot for provisioning. Both WiFi hotspot and Bluetooth provisioning can be enabled simultaneously. Default: `false`. |
+| `bluetooth_trust_all` | boolean | Optional | When true, the machine accepts all Bluetooth pairing requests for sharing the internet from a mobile device (tethering) without requiring devices to be added during provisioning first. Default: `false`. |


@Otterverse Is this an accurate description? Is there a succinct reason why someone would want to do this? Aside from not having to go through the trust dialogue once? I suppose rather - is this because the trust dialogue would happen on the machine that is being provisioned which may have no screen so adding this here means headless provisioning will work?

may have no screen so adding this here means headless provisioning will work?

i believe this is accurate

Suggested change

| `bluetooth_trust_all` | boolean | Optional | When true, the machine accepts all Bluetooth pairing requests for sharing the internet from a mobile device (tethering) without requiring devices to be added during provisioning first. Default: `false`. |

| `bluetooth_trust_all` | boolean | Optional | Set to true to accept all Bluetooth pairing requests (which is only needed for bluetooth tethering) without requiring an unlock command from a mobile app. Default: `false`. |

Suggestion is the same as comment in the json template earlier in this file.

ale7714 · 2025-07-28T19:52:49Z

docs/manage/fleet/provision/end-user-setup.md

+
+The [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/) shows an example for Bluetooth provisioning.
+
+When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning, make the app choose the best available method.


This makes it sounds like the app should automatically figure out which method to use which this should be a decision made by the developer

ale7714 · 2025-07-28T19:54:47Z

docs/manage/fleet/provision/end-user-setup.md

+
+1. Verify the device supports Bluetooth Low Energy (BLE)
+
+1. **Check Bluetooth permissions**: Ensure the Viam mobile app has Bluetooth permissions enabled on your device.


are the specific permissions document it in the flutter package?

Not really. https://github.com/viamrobotics/viam_flutter_provisioning/?tab=readme-ov-file#usage
How to check and which permissions are needed will vary I expect. I also expect an app developer to know/google to do that. @kevin49999 would you be able to tell us more here?

Yep in that package^ it's more rudimentary and the example project ends up handling permissions.

In this package: https://github.com/viamrobotics/viam_flutter_bluetooth_provisioning_widget with the end-to-end provisioning flow setup for anyone who adds it to the app, permission asking is all handled by the package (and there are a few location permissions we require on android, so we can get the name of your machine).

I have really been putting off the README for that "widget" package way too long^ but I think it's definitely a better repo to direct people who are interested in using bluetooth provisioning with Viam. The viam_flutter_provisioning example would be much much harder to get a device online with (though still possible).

I will do this today or tomorrow: https://viam.atlassian.net/browse/APP-8457. It will explain the "usage description" plist strings you need on iOS to ask for permission, and the updates to the Android manifest files you need / permissions you need related to location and bluetooth in your app.

this will be a lot easier to write with my README done in the much more expansive and user friendly bluetooth provisioning widget/flow package so my apologies for not finishing writing that sooner @npentrel

To be super clear this widget/package has this entire user-friendly flow contained in it that handles the scanning, picking you wifi, writing machine creds, passing wifi/ssid and coming online (and a separate flow for tethering)

Updated: https://github.com/viamrobotics/viam_flutter_bluetooth_provisioning_widget @npentrel

ale7714 · 2025-07-28T19:57:44Z

docs/manage/reference/viam-agent/_index.md

 | `disable_captive_portal_redirect` | boolean | Optional | By default, ALL DNS lookups using the provisioning hotspot will redirect to the device. This causes most phones/mobile devices to automatically redirect the user to the captive portal as a "sign in" screen. When disabled, only domains ending in .setup (ex: viam.setup) will be redirected. This generally avoids displaying the portal to users and is mainly used in conjunction with a mobile provisioning application workflow. Default: `false`. |
-| `fragment_id` | string | Optional | The `fragment_id` of the fragment to configure machines with. Required when using the Viam mobile app for provisioning. The Viam mobile app uses the fragment to configure the machine. |
+| `disable_wifi_provisioning` | boolean | Optional | When set to true, disables WiFi hotspot provisioning. The machine will not create a WiFi hotspot for provisioning. Both WiFi hotspot and Bluetooth provisioning can be enabled simultaneously. Default: `false`. |
+| `bluetooth_trust_all` | boolean | Optional | When true, the machine accepts all Bluetooth pairing requests for sharing the internet from a mobile device (tethering) without requiring devices to be added during provisioning first. Default: `false`. |


may have no screen so adding this here means headless provisioning will work?

i believe this is accurate

ale7714 · 2025-07-28T19:59:36Z

docs/manage/fleet/provision/end-user-setup.md

+We recommend using Bluetooth by default for a smoother setup experience.
+
+The Flutter Provisioning package supports bluetooth tethering, that is sharing your mobile devices's internet connection with the machine that will be provisioned.
+Bluetooth tethering is slow and we recommend you use WiFi where possible.


I'm not sure why we mention BT tethering here. It's not intricately related to provisioning. Is so the user discovers BT tethering? I guess my concern would be that if someone is confused about provisoning maybe this will add more confusion

I think what I should probably do is list the permissions of the provisioning package. I'll make that change

docs/manage/fleet/provision/end-user-setup.md

npentrel · 2025-07-29T09:03:47Z

docs/manage/fleet/provision/end-user-setup.md

+## Set up your machine using a custom Flutter app
+
+The [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/) shows an example for Bluetooth provisioning.
+
+When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning and both are available, we recommend using Bluetooth by default for a smoother setup experience.
+We recommend using Bluetooth by default for a smoother setup experience.
+
+The Flutter Provisioning package supports bluetooth tethering, that is sharing your mobile devices's internet connection with the machine that will be provisioned.
+Bluetooth tethering is slow and we recommend you use WiFi where possible.


Suggested change

## Set up your machine using a custom Flutter app

The [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/) shows an example for Bluetooth provisioning.

When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning and both are available, we recommend using Bluetooth by default for a smoother setup experience.

We recommend using Bluetooth by default for a smoother setup experience.

The Flutter Provisioning package supports bluetooth tethering, that is sharing your mobile devices's internet connection with the machine that will be provisioned.

Bluetooth tethering is slow and we recommend you use WiFi where possible.

## Set up your machine using a custom Flutter app

The [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/) shows an example for Bluetooth provisioning.

Features:

- **Bluetooth provisioning**: We recommend using Bluetooth over WiFi hotspot provisioning for a smoother setup experience.

- **WiFi Hotspot provisioning**

- **Bluetooth tethering**: Bluetooth tethering (sharing your mobile devices's internet connection with the machine that will be provisioned) is slow and we recommend you use WiFi where possible.

Otterverse

Sorry there are so many notes, also apologies in advance if any sound too terse. Feel free to poke me with follow-up questions.

docs/manage/fleet/provision/end-user-setup.md

Otterverse · 2025-07-29T18:04:39Z

docs/manage/fleet/provision/end-user-setup.md

+When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning and both are available, we recommend using Bluetooth by default for a smoother setup experience.
+We recommend using Bluetooth by default for a smoother setup experience.


Duplicated text on the second line.

Otterverse · 2025-07-29T18:08:03Z

docs/manage/fleet/provision/end-user-setup.md

+
+### App Development Considerations
+
+When developing mobile apps with Bluetooth provisioning, ensure your app requests appropriate Bluetooth permissions.


Should explicitly say what permissions these are or maybe link to that elsewhere (is it mentioned in the readme/docs for the flutter repo?)

yes - in face I will jsut remove this here

Otterverse · 2025-07-29T18:11:40Z

docs/manage/fleet/provision/end-user-setup.md

+
+If you're having trouble with Bluetooth provisioning:
+
+1. Verify the device supports Bluetooth Low Energy (BLE)


What's the actual action a user should take here?

I'm not asking that rhetorically... I don't have a full answer to this myself, as it's complicated, and we've really only tested on a few devices. But it feels wrong to tell people "verify this is supported" when we're the ones that should be saying what is or is not supported.

data sheet? I'll point there - really not much I can say beyond that I think

Otterverse · 2025-07-29T18:16:42Z

docs/manage/fleet/provision/end-user-setup.md

+
+1. **Verify Bluetooth is enabled**: Make sure Bluetooth is turned on in your mobile device settings.
+
+1. **Check device compatibility**: Ensure your mobile device supports Bluetooth Low Energy (BLE).


Similar to above comment. Exactly how/what is a user supposed to check here?

Two other issues.

First, this says "check device compatibility" but a couple lines up we have "verify the device supports BLE". That feels very confusing to me. I think terminology needs to much more clearly separate "mobile phone (device)" and "smart machine (device)"

Lastly, this COULD probably just be removed entirely. The installation of the mobile app itself should be able to report when it cannot work because of missing hardware... and I don't think there's any phone from the past 10 years that doesn't have BLE, so this would only apply to some weird, one-off android devices (like a kiosk or something) at best.

sounds good will do

Otterverse · 2025-07-29T20:27:24Z

docs/manage/fleet/provision/setup.md

 | `priority` | int    | Priority to choose the network with. Values between -999 and 999. Default: `0`. |

 {{% /tablestep %}}
 {{< /table >}}

+## (Optional) Create a machine in advance
+
+If you provision devices using a captive web portal, you can optionally create a machine in advance and provide its machine cloud credentials file at <FILE>/etc/viam.json</FILE>.


Suggested change

If you provision devices using a captive web portal, you can optionally create a machine in advance and provide its machine cloud credentials file at <FILE>/etc/viam.json</FILE>.

If you provision devices using a captive web portal (instead of a mobile app), you'll need to create a machine in advance and provide its machine cloud credentials in the portal. Alternately, you may directly write them to the file <FILE>/etc/viam.json</FILE>.

Otterverse · 2025-07-29T20:28:30Z

docs/manage/fleet/provision/setup.md

+WiFi provisioning may be less reliable in environments with many WiFi networks.
+If possible, use Bluetooth provisioning or move to an area with fewer WiFi networks in range.


Bluetooth is just as likely to have interference from nearby sources as wifi is, so I don't think this suggestion is useful. Have we actually seen cases of this? If not, I'm wondering where this advice came from.

I think we had something like this elsewhere as a recommendation but I don't know that it is based on something. will remove

Otterverse · 2025-07-29T20:30:17Z

docs/manage/fleet/provision/setup.md

+
+### Bluetooth provisioning not working
+
+If Bluetooth provisioning is not working, check the following:


Isn't this section duplicating the same info that is in end-user-setup.md? Feels like one of these troubleshooting sections should just link to the other, rather than be duplicated.

Also, the same comments I had on the other apply here is well.

Otterverse · 2025-07-29T20:34:46Z

docs/manage/reference/viam-agent/_index.md

 | `disable_captive_portal_redirect` | boolean | Optional | By default, ALL DNS lookups using the provisioning hotspot will redirect to the device. This causes most phones/mobile devices to automatically redirect the user to the captive portal as a "sign in" screen. When disabled, only domains ending in .setup (ex: viam.setup) will be redirected. This generally avoids displaying the portal to users and is mainly used in conjunction with a mobile provisioning application workflow. Default: `false`. |
-| `fragment_id` | string | Optional | The `fragment_id` of the fragment to configure machines with. Required when using the Viam mobile app for provisioning. The Viam mobile app uses the fragment to configure the machine. |
+| `disable_wifi_provisioning` | boolean | Optional | When set to true, disables WiFi hotspot provisioning. The machine will not create a WiFi hotspot for provisioning. Both WiFi hotspot and Bluetooth provisioning can be enabled simultaneously. Default: `false`. |
+| `bluetooth_trust_all` | boolean | Optional | When true, the machine accepts all Bluetooth pairing requests for sharing the internet from a mobile device (tethering) without requiring devices to be added during provisioning first. Default: `false`. |


Suggested change

| `bluetooth_trust_all` | boolean | Optional | When true, the machine accepts all Bluetooth pairing requests for sharing the internet from a mobile device (tethering) without requiring devices to be added during provisioning first. Default: `false`. |

| `bluetooth_trust_all` | boolean | Optional | Set to true to accept all Bluetooth pairing requests (which is only needed for bluetooth tethering) without requiring an unlock command from a mobile app. Default: `false`. |

Suggestion is the same as comment in the json template earlier in this file.

docs/manage/reference/viam-agent/_index.md

docs/manage/fleet/provision/end-user-setup.md

npentrel · 2025-08-14T17:10:00Z

docs/manage/fleet/provision/end-user-setup.md

@@ -135,6 +138,53 @@ Note that any features that require internet access will not function if the con
 {{% /tablestep %}}
 {{< /table >}}

+## Set up your machine using a custom Flutter app
+
+When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning and both are available, we recommend using Bluetooth by default for a smoother setup experience.


I am correct in assuming that you can use bluetooth without bluetooth tethering... right? So Bluetooth with the machine having a wifi connection is preferred, then wifi, then bluetooth tethering?

@Otterverse

I did just run the app and it looks like the options are to write network config or to write robot part config, so I assume the latter is the tethering option?

Sorry for confusion, this package has the tethering support but no readme yet: https://github.com/viamrobotics/viam_flutter_bluetooth_provisioning_widget/blob/main/lib/src/flow/bluetooth_tethering_flow.dart

And to answer the original question: You can use bluetooth for provisioning (without tethering), and still use wifi for connectivity. But if you want to use BT tethering, you must do the provisioning via BT as well.

docs/manage/fleet/provision/end-user-setup.md

npentrel · 2025-08-21T15:38:27Z

docs/manage/fleet/provision/end-user-setup.md

+| Provisioning method | Description | Notes | Package |
+| ------------------- | ----------- | ----- | ------- |
+| **Bluetooth with WiFi** | Ask the user to connect to the machine over Bluetooth. The user then provides network credentials for an internet-connected WiFi network, through which machine setup can then occur. | Recommended, if available. | [Example](https://github.com/viamrobotics/viam_flutter_provisioning/) |
+| **WiFi** | Ask the user to connect to the machine's temporary WiFi network. The user then provides network credentials for an internet-connected WiFi network, through which machine setup can then occur. | Slower than Bluetooth with WiFi but faster than Bluetooth tethering. | TODO |


@kevin49999 do you mind taking another look here:

Is this table covering this correctly?

Do we have an example for WiFi?

Table is easier to look at here: https://deploy-preview-4372--viam-docs.netlify.app/manage/fleet/provision/end-user-setup/#set-up-your-machine-using-a-custom-flutter-app

looks good to me! Tethering is definitely still in development right now, it works on iOS but working through issues on Android - I should make that clear in my README I will go update

Here is the hotspot example: https://github.com/viamrobotics/viam_flutter_hotspot_provisioning_widget/tree/main/example/hotspot_provisioning

docs/manage/fleet/provision/end-user-setup.md

npentrel · 2025-08-21T15:39:57Z

docs/manage/fleet/provision/end-user-setup.md

@@ -135,6 +138,59 @@ Note that any features that require internet access will not function if the con
 {{% /tablestep %}}
 {{< /table >}}

+## Set up your machine using a custom Flutter app
+
+If you are building your own app to provide provisioning functionality you have three options for provisioning:


@kevin49999 do you mind taking another look here:

Is this table covering this correctly?

Table is easier to look at here: https://deploy-preview-4372--viam-docs.netlify.app/manage/fleet/provision/end-user-setup/#set-up-your-machine-using-a-custom-flutter-app

docs/manage/fleet/provision/end-user-setup.md

npentrel · 2025-08-22T09:46:33Z

Going to merge this for now so I can start on more provisioning work. @Otterverse once you're back have another look and ping me if we need to make more changes

github-actions · 2025-08-22T09:53:26Z

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

npentrel force-pushed the docs-update-e68716ac-6be7-45c4-a6cf-67c928da318a-20250602-115258 branch 2 times, most recently from 92d5028 to d7c4135 Compare June 2, 2025 15:54

npentrel changed the title ~~docs: Add comprehensive Bluetooth provisioning documentation for viam-agent~~ DOCS-3498: Add comprehensive Bluetooth provisioning documentation for viam-agent Jun 2, 2025

npentrel changed the title ~~DOCS-3498: Add comprehensive Bluetooth provisioning documentation for viam-agent~~ DOCS-3498: Add Bluetooth provisioning docs for viam-agent Jun 2, 2025

npentrel reviewed Jun 2, 2025

View reviewed changes

npentrel force-pushed the docs-update-e68716ac-6be7-45c4-a6cf-67c928da318a-20250602-115258 branch 2 times, most recently from ed4f6a1 to 70564c6 Compare June 2, 2025 16:19

npentrel marked this pull request as draft June 12, 2025 20:01

npentrel force-pushed the docs-update-e68716ac-6be7-45c4-a6cf-67c928da318a-20250602-115258 branch from 70564c6 to 7befc24 Compare July 28, 2025 12:25

npentrel force-pushed the docs-update-e68716ac-6be7-45c4-a6cf-67c928da318a-20250602-115258 branch from 7befc24 to 61b7005 Compare July 28, 2025 12:38

Documentation updates from Promptless

44c5986

npentrel force-pushed the docs-update-e68716ac-6be7-45c4-a6cf-67c928da318a-20250602-115258 branch from 61b7005 to 44c5986 Compare July 28, 2025 12:50

Bluetooth tethering

4f656b9

npentrel marked this pull request as ready for review July 28, 2025 13:31

npentrel reviewed Jul 28, 2025

View reviewed changes

ale7714 reviewed Jul 28, 2025

View reviewed changes

npentrel reviewed Jul 29, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

579f7fa

npentrel reviewed Jul 29, 2025

View reviewed changes

Otterverse requested changes Jul 29, 2025

View reviewed changes

npentrel reviewed Aug 4, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Apply suggestions from code review

a27c43d

npentrel reviewed Aug 4, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

9db2480

npentrel reviewed Aug 14, 2025

View reviewed changes

npentrel force-pushed the docs-update-e68716ac-6be7-45c4-a6cf-67c928da318a-20250602-115258 branch from b5eae3f to 3a649fd Compare August 14, 2025 17:20

Update docs/manage/fleet/provision/end-user-setup.md

210ea7d

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

0c55be3

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

264ae50

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

7845125

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

b7088f3

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

427e0da

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Apply suggestions from code review

4045187

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

9ff75d8

npentrel requested a review from Otterverse August 21, 2025 15:45

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

c7d4212

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

2cb36bb

npentrel reviewed Aug 21, 2025

View reviewed changes

docs/manage/fleet/provision/end-user-setup.md Outdated Show resolved Hide resolved

Update docs/manage/fleet/provision/end-user-setup.md

ac6c8c0

npentrel requested a review from ale7714 August 21, 2025 15:53

ale7714 approved these changes Aug 21, 2025

View reviewed changes

npentrel merged commit 01696b2 into main Aug 22, 2025
13 checks passed

npentrel deleted the docs-update-e68716ac-6be7-45c4-a6cf-67c928da318a-20250602-115258 branch August 22, 2025 09:52

	\| `bluetooth_trust_all` \| boolean \| Optional \| When true, the machine accepts all Bluetooth pairing requests for sharing the internet from a mobile device (tethering) without requiring devices to be added during provisioning first. Default: `false`. \|
	\| `bluetooth_trust_all` \| boolean \| Optional \| Set to true to accept all Bluetooth pairing requests (which is only needed for bluetooth tethering) without requiring an unlock command from a mobile app. Default: `false`. \|


		The [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/) shows an example for Bluetooth provisioning.

		When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning, make the app choose the best available method.


		1. Verify the device supports Bluetooth Low Energy (BLE)

		1. Check Bluetooth permissions: Ensure the Viam mobile app has Bluetooth permissions enabled on your device.

		When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning and both are available, we recommend using Bluetooth by default for a smoother setup experience.
		We recommend using Bluetooth by default for a smoother setup experience.


		### App Development Considerations

		When developing mobile apps with Bluetooth provisioning, ensure your app requests appropriate Bluetooth permissions.


		If you're having trouble with Bluetooth provisioning:

		1. Verify the device supports Bluetooth Low Energy (BLE)


		1. Verify Bluetooth is enabled: Make sure Bluetooth is turned on in your mobile device settings.

		1. Check device compatibility: Ensure your mobile device supports Bluetooth Low Energy (BLE).

	If you provision devices using a captive web portal, you can optionally create a machine in advance and provide its machine cloud credentials file at <FILE>/etc/viam.json</FILE>.
	If you provision devices using a captive web portal (instead of a mobile app), you'll need to create a machine in advance and provide its machine cloud credentials in the portal. Alternately, you may directly write them to the file <FILE>/etc/viam.json</FILE>.

		WiFi provisioning may be less reliable in environments with many WiFi networks.
		If possible, use Bluetooth provisioning or move to an area with fewer WiFi networks in range.


		### Bluetooth provisioning not working

		If Bluetooth provisioning is not working, check the following:

DOCS-3498: Add Bluetooth provisioning docs for viam-agent #4372

DOCS-3498: Add Bluetooth provisioning docs for viam-agent #4372

Uh oh!

Conversation

promptless bot commented Jun 2, 2025 • edited by npentrel Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for viam-docs ready!

Uh oh!

viambot commented Jun 2, 2025

Uh oh!

promptless bot commented Jun 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

viambot commented Jul 28, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ale7714 Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevin49999 Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevin49999 Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ale7714 Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Otterverse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

promptless bot commented Jun 2, 2025 •

edited by npentrel

Loading

netlify bot commented Jun 2, 2025 •

edited

Loading

ale7714 Jul 28, 2025 •

edited

Loading

kevin49999 Aug 14, 2025 •

edited

Loading

kevin49999 Aug 14, 2025 •

edited

Loading

ale7714 Jul 28, 2025 •

edited

Loading