DOCS-3877: Add hotspot_interface configuration option (#4282)

Author: npentrel

docs/manage/fleet/provision/setup.md

@@ -187,6 +187,7 @@ Create a defaults file called <FILE>viam-defaults.json</FILE> with the following
     "manufacturer": "<NAME>", # your company name
     "model": "<NAME>", # the machine's model
     "fragment_id": "<ID>", # the fragment id, required for mobile app
+    "hotspot_interface": "<INTERFACE>", # the interface to use for hotspot/provisioning/wifi management
     "hotspot_prefix": "<PREFIX>", # machine creates a hotspot during setup
     "disable_captive_portal_redirect": false, # set to true if using a mobile app
     "hotspot_password": "<PASSWORD>", # password for the hotspot
@@ -207,6 +208,7 @@ Create a defaults file called <FILE>viam-defaults.json</FILE> with the following
     "manufacturer": "Skywalker",
     "model": "C-3PO",
     "fragment_id": "2567c87d-7aef-41bc-b82c-d363f9874663",
+    "hotspot_interface": "wlan0",
     "hotspot_prefix": "skywalker-setup",
     "disable_captive_portal_redirect": false,
     "hotspot_password": "skywalker123",
@@ -232,7 +234,7 @@ It also configures timeouts to control how long `viam-agent` waits for a valid l
 | `manufacturer` | string | Optional | Purely informative. May be displayed on captive portal or provisioning app. Default: `"viam"`. |
 | `model` | string | Optional | Purely informative. May be displayed on captive portal or provisioning app. Default: `"custom"`. |
 | `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. |
-| `hotspot_interface` | string | Optional | The interface to use for hotspot/provisioning/wifi management. Default: first discovered 802.11 device. |
+| `hotspot_interface` | string | Optional | The interface to use for hotspot/provisioning/wifi management. Example: `"wlan0"`. Default: first discovered 802.11 device. |
 | `hotspot_prefix` | string | Optional | `viam-agent` will prepend this to the hostname of the device and use the resulting string for the provisioning hotspot SSID. Default: `"viam-setup"`. |
 | `hotspot_password` | string | Optional | The Wifi password for the provisioning hotspot. Default: `"viamsetup"`. |
 | `disable_captive_portal_redirect` | boolean | Optional | By default, all DNS lookups are redirected to the "sign in" portal, which can cause mobile devices to automatically display the portal. When set to true, only DNS requests for domains ending in .setup, like `viam.setup` are redirected, preventing the portal from appearing unexpectedly, especially convenient when using a mobile app for provisioning. Default: `false`. |
@@ -264,6 +266,7 @@ The following configuration defines the connection information and credentials f
     "manufacturer": "Skywalker",
     "model": "C-3PO",
     "fragment_id": "2567c87d-7aef-41bc-b82c-d363f9874663",
+    "hotspot_interface": "wlan0",
     "hotspot_prefix": "skywalker-setup",
     "disable_captive_portal_redirect": false,
     "hotspot_password": "skywalker123",

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

@@ -108,6 +108,7 @@ For information on managing the service, see [Manage `viam-agent`](/manage/refer
       "manufacturer": "viam",
       "model": "custom",
       "fragment_id": "",
+      "hotspot_interface": "wlan0",
       "hotspot_prefix": "viam-setup",
       "hotspot_password": "viamsetup",
       "disable_captive_portal_redirect": false,
@@ -231,7 +232,7 @@ You can also start `viam-agent` in fast start mode by setting `VIAM_AGENT_FAST_S
 | `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). |
 | `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. |
-| `hotspot_interface` | string | Optional | The interface to use for hotspot/provisioning/wifi management. Default: first discovered 802.11 device. |
+| `hotspot_interface` | string | Optional | The interface to use for hotspot/provisioning/wifi management. Example: `"wlan0"`. Default: first discovered 802.11 device. |
 | `hotspot_password` | string | Optional | The Wifi password for the provisioning hotspot. Default: `"viamsetup"`. |
 | `hotspot_prefix` | string | Optional | `viam-agent` will prepend this to the hostname of the device and use the resulting string for the provisioning hotspot SSID. Default: `"viam-setup"`. |
 | `manufacturer` | string | Optional | Purely informative. May be displayed on captive portal or provisioning app. Default: `"viam"`. |