Skip to content

Commit 57a47db

Browse files
committed
Update
1 parent 507295c commit 57a47db

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/manage/fleet/provision/setup.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Create a file called <FILE>viam-provisioning.json</FILE> with the following form
207207
"turn_on_hotspot_if_wifi_has_no_internet": false,
208208
"offline_before_starting_hotspot_minutes": "3m30s",
209209
"user_idle_minutes": "2m30s",
210-
"fallback_timeout": "15m"
210+
"retry_connection_timeout_minutes": "15m"
211211
}
212212
```
213213

@@ -232,7 +232,7 @@ It also configures timeouts to control how long `viam-agent` waits for a valid l
232232
| `turn_on_hotspot_if_wifi_has_no_internet` | boolean | Optional | By default, the device will only attempt to connect to a single wifi network (the one with the highest priority), provided during initial provisioning/setup using the provisioning mobile app or captive web portal. Wifi connection alone is enough to consider the device as "online" even if the global internet is not reachable. If the primary network configured during provisioning cannot be connected to and roaming mode is enabled, the device will attempt connections to all configured networks in `networks`, and only consider the device online if the internet is reachable. Default: `false`. |
233233
| `offline_before_starting_hotspot_minutes` | integer | Optional | Will only enter provisioning mode (hotspot) after being disconnected longer than this time. Useful on flaky connections, or when part of a system where the device may start quickly, but the wifi/router may take longer to be available. Default: `2` (2 minutes). |
234234
| `user_idle_minutes` | integer | Optional | Amount of time before considering a user (using the captive web portal or provisioning app) idle, and resuming normal behavior. Used to avoid interrupting provisioning mode (for example for network tests/retries) when a user might be busy entering details. Default: `5` (5 minutes). |
235-
| `fallback_timeout` | boolean | Optional | Provisioning mode will exit after this time, to allow other unmanaged (for example wired) or manually configured connections to be tried. Provisioning mode will restart if the connection/online status doesn't change. Default: `"10m"` (10 minutes). |
235+
| `retry_connection_timeout_minutes` | integer | Optional | Provisioning mode will exit after this time, to allow other unmanaged (for example wired) or manually configured connections to be tried. Provisioning mode will restart if the connection/online status doesn't change. Default: `10` (10 minutes). |
236236
| `networks` | array | Optional | Add additional networks the machine can connect to for provisioning. We recommend that you add WiFi settings in the operating system (for example, directly in NetworkManager) rather than in this file, or in the corresponding machine config in the Viam app, if networks aren't needed until after initial provisioning. See [Networks](/manage/reference/viam-agent/#networks). Default: `[]`. |
237237
| `wifi_power_save` | boolean | Optional | If set, will explicitly enable or disable power save for all WiFi connections managed by NetworkManager. |
238238
| `device_reboot_after_offline_minutes` | integer | Optional | If set, `viam-agent` will reboot the device after it has been offline for the specified duration. Default: `0` (disabled). |
@@ -277,7 +277,7 @@ The following configuration defines the connection information and credentials f
277277
"turn_on_hotspot_if_wifi_has_no_internet": false,
278278
"offline_before_starting_hotspot_minutes": "3m30s",
279279
"user_idle_minutes": "2m30s",
280-
"fallback_timeout": "15m",
280+
"retry_connection_timeout_minutes": "15m",
281281
"turn_on_hotspot_if_wifi_has_no_internet": true,
282282
"networks": [
283283
{
@@ -449,9 +449,9 @@ sudo ./preinstall.sh /path/to/rootfs
449449

450450
### Device not detecting networks
451451

452-
Some systems can't scan for WiFi networks while in hotspot mode, meaning they won't automatically detect networks coming online or into range until the `fallback_timeout` expires.
453-
The `fallback_timeout` causes your device to exit hotspot mode, at which point your device will be able to detect newly available networks.
454-
If your device does not connect to your network, adjust the `fallback_timeout` value in the [`agent-provisioning` configuration](/manage/fleet/provision/setup/#configure-agent-provisioning).
452+
Some systems can't scan for WiFi networks while in hotspot mode, meaning they won't automatically detect networks coming online or into range until the `retry_connection_timeout_minutes` expires.
453+
The `retry_connection_timeout_minutes` causes your device to exit hotspot mode, at which point your device will be able to detect newly available networks.
454+
If your device does not connect to your network, adjust the `retry_connection_timeout_minutes` value in the [`agent-provisioning` configuration](/manage/fleet/provision/setup/#configure-agent-provisioning).
455455

456456
### Test GRPC components of the provisioning service
457457

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ You can also start `viam-agent` in fast start mode by setting `VIAM_AGENT_FAST_S
276276
| `manufacturer` | string | false | Purely informative. May be displayed on captive portal or provisioning app. Default: `"viam"`. |
277277
| `model` | string | false | Purely informative. May be displayed on captive portal or provisioning app. Default: `"custom"`. |
278278
| `offline_before_starting_hotspot_minutes` | integer | false | Will only enter provisioning mode (hotspot) after being disconnected longer than this time. Useful on flaky connections, or when part of a system where the device may start quickly, but the wifi/router may take longer to be available. Default: `2` (2 minutes). |
279-
| `retry_connection_timeout_minutes` | TODO | TODO | TODO |
279+
| `retry_connection_timeout_minutes` | integer | Optional | Provisioning mode will exit after this time, to allow other unmanaged (for example wired) or manually configured connections to be tried. Provisioning mode will restart if the connection/online status doesn't change. Default: `10` (10 minutes). |
280280
| `turn_on_hotspot_if_wifi_has_no_internet` | boolean | false | By default, the device will only attempt to connect to a single wifi network (the one with the highest priority), provided during initial provisioning/setup using the provisioning mobile app or captive web portal. Wifi connection alone is enough to consider the device as "online" even if the global internet is not reachable. If the primary network configured during provisioning cannot be connected to and roaming mode is enabled, the device will attempt connections to all configured networks in `networks`, and only consider the device online if the internet is reachable. Default: `false`. |
281281
| `user_idle_minutes` | integer | false | Amount of time before considering a user (using the captive web portal or provisioning app) idle, and resuming normal behavior. Used to avoid interrupting provisioning mode (for example for network tests/retries) when a user might be busy entering details. Default: `5` (5 minutes). |
282282
| `wifi_power_save` | boolean | false | If set, will explicitly enable or disable power save for all WiFi connections managed by NetworkManager. If not set, the system default applies. Default: `false`. |

0 commit comments

Comments
 (0)