Quickstart: Configure networking and update the device OS
After you claim your Azure Sphere device, configure it for networking so that it can receive cloud updates from the Azure Sphere Security Service and communicate with services such as an Azure IoT Hub. When you've configured and enabled networking, your device can receive an OS update from the cloud.
This topic describes how to connect your Azure Sphere device to a Wi-Fi network. If your device supports a different networking mechanism and does not support Wi-Fi, connect it to the internet using that mechanism and proceed to Receive device update.
- Quickstart: Install the Azure Sphere SDK for Windows or for Linux
- Quickstart: Choose a tenant and claim your device
Set up Wi-Fi on your Azure Sphere device
Follow these steps to configure Wi-Fi on your Azure Sphere device:
Connect your Azure Sphere device to your computer.
If you're working on Windows, open an Azure Sphere Developer Command Prompt.
Register the device's MAC address if your network environment requires it. Use the following command to get the MAC address, and then register it according to the procedure for your environment:
azsphere device wifi show-status
Add your Wi-Fi network to the device by using the azsphere device wifi add command as follows:
azsphere device wifi add --ssid <yourSSID> --psk <yourNetworkKey>
Replace <yourSSID> with the name of your network. Network SSIDs are case-sensitive. If the SSID is hidden, add --targeted-scan to try to connect to it anyway. You can use azsphere device wifi scan to get a list of available Wi-Fi networks.
Replace <yourNetworkKey> with your WPA/WPA2 key. Azure Sphere devices do not support WEP. To add an open network, omit --psk.
If your network SSID or key has embedded spaces, enclose the SSID or key in quotation marks. If the SSID or key includes a quotation mark, use a backslash to escape the quotation mark. Backslashes do not require escape if they are part of a value. For example:
azsphere device wifi add --ssid "New SSID" --psk "key \"value\" with quotes"
It typically takes several seconds for networking to be ready on the board, but might take longer, depending on your network environment.
Use the azsphere device wifi show-status command to check the status of the connection. During update, the azsphere device wifi show-status command may temporarily show an unknown configuration state. The following example shows successful results for a secure WPA2 connection:
azsphere device wifi show-status SSID : NETGEAR21 Configuration state : enabled Connection state : connected Security state : psk Frequency : 2442 Mode : station Key management : WPA2-PSK WPA State : COMPLETED IP Address : 192.168.1.15 MAC Address : 52:cf:ff:3a:76:1b Command completed successfully in 00:00:01.3976308.
Receive device update
The Azure Sphere device checks for Azure Sphere OS and application updates each time it boots, when it initially connects to the internet, and at 24-hour intervals thereafter. If updates are available, download and installation could take as much as 15-20 minutes and might cause the device to restart.
To check on update status, type the following command:
azsphere device show-deployment-status
The azsphere device wifi command supports several additional options. Type azsphere device wifi for a complete list, or azsphere device wifi option --help for help on an individual option.
If you have an older Seeed MT3620 Development Kit, you may have to update it manually, as described in Update the OS on an early dev kit.
If you have not already migrated your tenant to the new device model, which was introduced in the 19.10 release, see About migration.
If you encounter Wi-Fi problems, first ensure that your Wi-Fi network uses 802.11b/g/n; Azure Sphere devices do not support 802.11a.
Azure Sphere OS update is a staged process over a period that may be less than 15 minutes but can be longer depending on the internet connectivity. Between stages, the board will appear functional while the next group of updates is downloaded, but during the update you should expect the board to be unresponsive for several minutes at a time.