Skip to content

Commit 7befc24

Browse files
committed
Documentation updates from Promptless
1 parent ff70f5b commit 7befc24

File tree

5 files changed

+215
-103
lines changed

5 files changed

+215
-103
lines changed

docs/dev/reference/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ date: "2024-09-18"
4242
# updated: "" # When the content was last entirely checked
4343
---
4444

45+
{{% changelog color="added" title="Bluetooth provisioning" date="2025-06-02" %}}
46+
Added support for Bluetooth Low Energy (BLE) provisioning, allowing devices to be set up over Bluetooth connection.
47+
For an example implementation, see the [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/).
48+
{{% /changelog %}}
49+
4550
{{% changelog color="removed" title="Frame tab removed, use Add Frame button" date="2025-05-15" %}}
4651

4752
The frame tab no longer exists in the Viam app.

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

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,18 @@ If you have already created a machine, select it.
5555
If you have not yet created a machine, click on **Add new smart machine** and give your machine a name.
5656
{{% /tablestep %}}
5757
{{% tablestep number=3 %}}
58-
**Follow the instructions in the app**
58+
**Turn on your machine and follow the app instructions**
5959

6060
Turn on the smart machine you are attempting to connect to.
6161
Then leave the app and navigate to your mobile device's WiFi settings and connect to the WiFi hotspot your machine has created.
6262
You may need to wait a short time for your machine to boot and create its WiFi hotspot.
63+
6364
Your machine's WiFi hotspot name will begin with `viam-setup-`.
6465
Unless you have been given other instructions, the WiFi password for this hotspot network is `viamsetup`.
6566

66-
Once you are connected to your machine's WiFi hotspot return to the Viam mobile app.
67+
Return to the Viam mobile app once connected
68+
69+
You may need to wait a short time for your machine to boot and start its provisioning services.
6770
{{% /tablestep %}}
6871
{{% tablestep number=4 %}}
6972
**Provide the network information for the machine**
@@ -72,6 +75,7 @@ In the mobile app, you will be prompted to provide the network information for t
7275

7376
The machine will now disable the hotspot network and attempt to connect using the provided network information.
7477
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.
78+
7579
{{% /tablestep %}}
7680
{{% tablestep number=5 %}}
7781
**Wait for machine to complete setup**
@@ -135,6 +139,59 @@ Note that any features that require internet access will not function if the con
135139
{{% /tablestep %}}
136140
{{< /table >}}
137141

142+
## Set up your machine using a custom Flutter app
143+
144+
The [Flutter Provisioning package](https://github.com/viamrobotics/viam_flutter_provisioning/) shows an example for Bluetooth provisioning.
145+
146+
When developing your own application, if you support both Bluetooth and WiFi Hotspot provisioning, make the app choose the best available method.
147+
We recommend using Bluetooth by default for a smoother setup experience.
148+
149+
### App Development Considerations
150+
151+
When developing mobile apps with Bluetooth provisioning, ensure your app requests appropriate Bluetooth permissions.
152+
153+
## Troubleshooting
154+
155+
### Bluetooth connection issues
156+
157+
If you're having trouble with Bluetooth provisioning:
158+
159+
1. Verify the device supports Bluetooth Low Energy (BLE)
160+
161+
1. **Check Bluetooth permissions**: Ensure the Viam mobile app has Bluetooth permissions enabled on your device.
162+
163+
1. **Verify Bluetooth is enabled**: Make sure Bluetooth is turned on in your mobile device settings.
164+
165+
1. **Check device compatibility**: Ensure your mobile device supports Bluetooth Low Energy (BLE).
166+
167+
1. **Restart Bluetooth**: Try turning Bluetooth off and on again on your mobile device.
168+
169+
If you can open a terminal on the machine:
170+
171+
1. Check if Bluetooth is available:
172+
173+
```sh {class="command-line" data-prompt="$"}
174+
bluetoothctl list
175+
```
176+
177+
1. Verify Bluetooth service status:
178+
179+
```sh {class="command-line" data-prompt="$"}
180+
sudo systemctl status bluetooth
181+
```
182+
183+
### WiFi connection issues
184+
185+
If your machine cannot connect to your WiFi network:
186+
187+
1. **Check network credentials**: Verify that the WiFi network name (SSID) and password are correct.
188+
189+
1. **Check network compatibility**: Ensure your WiFi network is compatible with your machine's WiFi adapter.
190+
191+
1. **Check signal strength**: Make sure your machine is within range of your WiFi router.
192+
193+
1. **Try a different network**: If possible, try connecting to a different WiFi network to isolate the issue.
194+
138195
## Next Steps
139196

140197
You can now use your machine.

0 commit comments

Comments
 (0)