Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
44c5986
Documentation updates from Promptless
npentrel Jun 2, 2025
4f656b9
Bluetooth tethering
npentrel Jul 28, 2025
579f7fa
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Jul 29, 2025
a27c43d
Apply suggestions from code review
npentrel Aug 4, 2025
9db2480
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 4, 2025
649514b
First comments addressed
npentrel Aug 14, 2025
de41737
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 14, 2025
9de967b
readd
npentrel Aug 14, 2025
7253312
Update docs/manage/fleet/provision/setup.md
npentrel Aug 15, 2025
c95e368
Merge branch 'main' into docs-update-e68716ac-6be7-45c4-a6cf-67c928da…
npentrel Aug 15, 2025
3018b6e
Update end-user-setup.md
npentrel Aug 19, 2025
de0b868
Update setup.md
npentrel Aug 19, 2025
6ec74e9
Update docs/manage/fleet/provision/setup.md
npentrel Aug 21, 2025
210ea7d
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
0c55be3
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
264ae50
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
7845125
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
b7088f3
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
427e0da
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
4045187
Apply suggestions from code review
npentrel Aug 21, 2025
9ff75d8
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
c7d4212
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
2cb36bb
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
ac6c8c0
Update docs/manage/fleet/provision/end-user-setup.md
npentrel Aug 21, 2025
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
7 changes: 7 additions & 0 deletions docs/dev/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ You can now use folders on machines and in fragments to organize resources.

{{% /changelog %}}

{{% changelog color="added" title="Bluetooth provisioning" date="2025-07-28" %}}

Added support for Bluetooth Low Energy (BLE) provisioning, allowing devices to be set up over Bluetooth connection.
For an example implementation, see the [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/).

{{% /changelog %}}

{{% changelog color="added" title="Annual billing support for subscription billing model" date="2025-07-23" %}}

You can now configure annual billing alongside monthly billing options for your organizations.
Expand Down
63 changes: 61 additions & 2 deletions docs/manage/fleet/provision/end-user-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,17 @@ If you have already created a machine, select it.
If you have not yet created a machine, click on **Add new smart machine** and give your machine a name.
{{% /tablestep %}}
{{% tablestep number=3 %}}
**Follow the instructions in the app**
**Turn on your machine and follow the app instructions**

Turn on the smart machine you are attempting to connect to.
Then leave the app and navigate to your mobile device's WiFi settings and connect to the WiFi hotspot your machine has created.
You may need to wait a short time for your machine to boot and create its WiFi hotspot.

Your machine's WiFi hotspot name will begin with `viam-setup-`.
Unless you have been given other instructions, the WiFi password for this hotspot network is `viamsetup`.

Once you are connected to your machine's WiFi hotspot return to the Viam mobile app.
Return to the Viam mobile app once connected.

{{% /tablestep %}}
{{% tablestep number=4 %}}
**Provide the network information for the machine**
Expand All @@ -72,6 +74,7 @@ In the mobile app, you will be prompted to provide the network information for t

The machine will now disable the hotspot network and attempt to connect using the provided network information.
If the machine cannot establish a connection using the provided network information, the machine will create the hotspot again and prompt you to re-enter the network information until a connection is successfully established.

{{% /tablestep %}}
{{% tablestep number=5 %}}
**Wait for machine to complete setup**
Expand Down Expand Up @@ -135,6 +138,62 @@ 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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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


<!-- prettier-ignore -->
| 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. | [Example](https://github.com/viamrobotics/viam_flutter_hotspot_provisioning_widget) |
| **Bluetooth tethering** | Ask the user to connect to the machine over Bluetooth. The user shares their mobile device's internet with the machine over Bluetooth. | Slowest | [Example](https://github.com/viamrobotics/viam_flutter_bluetooth_provisioning_widget/) |

You can support any number of these options.

## Troubleshooting

### Bluetooth connection issues

If you're having trouble with Bluetooth provisioning:

1. **Check Bluetooth permissions**: Ensure the app used for provisioning has [Bluetooth permissions enabled](https://github.com/viamrobotics/viam_flutter_bluetooth_provisioning_widget?tab=readme-ov-file#platform-requirements) on your device.

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

1. **Restart Bluetooth**: Try turning Bluetooth off and on again on your mobile device.

1. **Remove and re-add**: If you've already connected to the machine over Bluetooth, remove or forget the device from your mobile device's settings, and re-add it.

If you can open a terminal on the machine:

1. Check if Bluetooth is available:

```sh {class="command-line" data-prompt="$"}
bluetoothctl list
```

1. Restart Bluetooth service:

```sh {class="command-line" data-prompt="$"}
sudo systemctl restart bluetooth
```

1. **Configuration check**: If you set up provisioning, verify that `disable_bt_provisioning` is set to `false` in your configuration.

### WiFi connection issues

If you cannot connect to your machine's temporary WiFi hotspot, confirm you are using the correct password.
The default password, unless changed by the manufacturer, is `viamsetup`,

If your machine cannot connect to your permanent office or home WiFi network:

1. **Check network credentials**: Verify that the WiFi network name (SSID) and password are correct.

1. **Check network compatibility**: Ensure your WiFi network is compatible with your machine's WiFi band frequency (2.4ghz vs 5ghz).

1. **Try a different network**: If possible, try connecting to a different WiFi network to isolate the issue.

## Next Steps

You can now use your machine.
Expand Down
Loading
Loading