Correct the "in the in" and "trafficing" typos
This commit is contained in:
Dan Kline
Родитель
2c3425621f
Коммит
d30b84faa3
|
|
@ -9,6 +9,7 @@ variable:
|
|||
name: macOS
|
||||
last_modified_at: 2019-01-03
|
||||
---
|
||||
# Getting-started
|
||||
|
||||
For first-time users of the MXChip IoT DevKit (a.k.a. DevKit), follow these quick steps to:
|
||||
|
||||
|
|
@ -29,11 +30,11 @@ If you have already done this, you can try more samples from the [Projects Catal
|
|||
|
||||
## What you need
|
||||
|
||||
* An MXChip IoT DevKit. [Get it now](https://aka.ms/iot-devkit-purchase){:target="_blank"}.
|
||||
* An MXChip IoT DevKit. [Get it now](https://aka.ms/iot-devkit-purchase ).
|
||||
* A computer running Windows 10 or macOS 10.10+.
|
||||
* An active Azure subscription. [Activate a free 30-day trial Microsoft Azure account](https://azure.microsoft.com/en-us/free/).
|
||||
|
||||
![Required hardware]({{"/assets/images/getting-started/hardware.jpg" | absolute_url }})
|
||||
* Required Hardware
|
||||
|
||||
|
||||
## Prepare your hardware
|
||||
|
||||
|
|
@ -43,48 +44,53 @@ To connect the IoT DevKit to your computer:
|
|||
2. Connect the USB end to your computer.
|
||||
3. The green LED for power confirms the connection.
|
||||
|
||||
![Hardware connections]({{"/assets/images/getting-started/connect.jpg" | absolute_url }})
|
||||
|
||||
|
||||
## Configure Wi-Fi
|
||||
|
||||
IoT projects rely on internet connectivity. Use the following instructions to configure the DevKit to connect to Wi-Fi.
|
||||
|
||||
1. Hold down button B, push and release the reset button, and then release button B. Your IoT DevKit enters AP mode for configuring the Wi-Fi connection. The screen displays the service set identifier (SSID) of the IoT DevKit and the configuration portal IP address:
|
||||
![Reset button, button B, and SSID]({{"/assets/images/getting-started/wifi-ap.jpg" | absolute_url }})
|
||||
![Enter AP mode]({{"/assets/images/getting-started/set-ap-mode.gif" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Use a Web browser on a different Wi-Fi enabled device (computer or mobile phone) to connect to the IoT DevKit SSID displayed in the previous step. If it asks for a password, leave it empty.
|
||||
![Network info and Connect button]({{"/assets/images/getting-started/connect-ssid.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
3. Open **192.168.0.1** in the browser. Select the Wi-Fi network that you want the IoT DevKit to connect to, type the password for the Wi-Fi conection, and then click **Connect**.
|
||||
![Password box and Connect button]({{"/assets/images/getting-started/wifi-portal.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
4. The IoT DevKit reboots in a few seconds. You then see the Wi-Fi name and assigned IP address on the screen of the IoT DevKit:
|
||||
|
||||
![Wi-Fi name and IP address]({{"/assets/images/getting-started/wifi-ip.jpg" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
## Start using the DevKit
|
||||
|
||||
### Upgrade to the latest firmware
|
||||
|
||||
The default app running on the DevKit checks the latest version of the firmware and displays some sensor diagnosis data for you. The currently-installed and latest available version of the IoT DevKit's firmware is displayed on the IoT DevKit screen. If the IoT DevKit is not running on the latest available version, follow the [firmware upgrading guide]({{"/docs/firmware-upgrading/" | absolute_url }}) to install the latest version.
|
||||
The default app running on the DevKit checks the latest version of the firmware and displays some sensor diagnosis data for you. The currently-installed and latest available version of the IoT DevKit's firmware is displayed on the IoT DevKit screen. If the IoT DevKit is not running on the latest available version, follow the [firmware upgrading guide](https://microsoft.github.io/azure-iot-developer-kit/docs/firmware-upgrading/) to install the latest version.
|
||||
|
||||
![Current firmware version]({{"/assets/images/getting-started/firmware.jpg" | absolute_url }})
|
||||
|
||||
|
||||
**Note:** Since v1.1, DevKit enables ST-SAFE in bootloader. You need to upgrade the firmware if you are running a version prior to v1.1.
|
||||
{: .notice--info}
|
||||
**Note:** Since v1.1, DevKit enables ST-SAFE in the bootloader.
|
||||
You must upgrade the firmware if you are running a version prior to v1.1.
|
||||
|
||||
### Test various sensors
|
||||
|
||||
Press button B to test the sensors. Continue pressing and releasing the button B to cycle through each sensor.
|
||||
|
||||
![Test sensors]({{"/assets/images/getting-started/sensors.jpg" | absolute_url }})
|
||||
|
||||
|
||||
## Prepare the development environment
|
||||
|
||||
We recommend [Azure IoT Tools](https://aka.ms/azure-iot-tools) extension pack for Visual Studio Code to develop on the DevKit. The Azure IoT Tools contains [Azure IoT Device Workbench](https://aka.ms/iot-workbench) to develop and debug on various IoT devkit devices and [Azure IoT Hub Toolkit](https://aka.ms/iot-toolkit) to manage and interact with Azure IoT Hub.
|
||||
|
||||
You can watch these [Channel 9](https://channel9.msdn.com/) videos to have overview about what they do:
|
||||
|
||||
* [Introduction to the new IoT Workbench extension for VS Code](https://channel9.msdn.com/Shows/Internet-of-Things-Show/IoT-Workbench-extension-for-VS-Code)
|
||||
* [What's new in the IoT Toolkit extension for VS Code](https://channel9.msdn.com/Shows/Internet-of-Things-Show/Whats-new-in-the-IoT-Toolkit-extension-for-VS-Code)
|
||||
|
||||
|
|
@ -98,21 +104,24 @@ Follow these steps to prepare the development environment for DevKit:
|
|||
2. Install [Visual Studio Code](https://code.visualstudio.com/), a cross platform source code editor with powerful developer tooling, like IntelliSense code completion and debugging.
|
||||
|
||||
3. Launch VS Code, look for **Arduino** in the extension marketplace and install it. This extension provides enhanced experiences for developing on Arduino platform.
|
||||
![Install Arduino]({{"/assets/images/getting-started/install-arduino.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
4. Look for **Azure IoT Tools** in the extension marketplace and install it.
|
||||
![Install Azure IoT Tools]({{"/assets/images/getting-started/install-azure-iot-tools.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
5. Configure VS Code with Arduino settings.
|
||||
|
||||
In Visual Studio Code, click **File > Preference > Settings**.
|
||||
In Visual Studio Code, click **File > Preference > Settings**.
|
||||
|
||||
![Open settings]({{"/assets/images/getting-started/setting-1.png" | absolute_url }})
|
||||
|
||||
|
||||
Type "Arduino" in the search textbox, the **Arduino:Additional Urls** is showed up, then click the hyperlink '**Edit in settings.json**'.
|
||||
![Find settings]({{"/assets/images/getting-started/setting-2.png" | absolute_url }})
|
||||
|
||||
Make sure the ```"arduino.path"``` and ```"arduino.additionalUrls"``` have been set correctly, if not please add following lines to configure Arduino depending on your platform:
|
||||
|
||||
|
||||
Make sure the ```"arduino.path"``` and ```"arduino.additionalUrls"``` have been set correctly, if not please add following lines to configure Arduino depending on your platform:
|
||||
|
||||
* **Windows**:
|
||||
|
||||
|
|
@ -138,7 +147,8 @@ Follow these steps to prepare the development environment for DevKit:
|
|||
```
|
||||
|
||||
6. Click `F1` to open the command palette, type and select **Arduino: Board Manager**. Search for **AZ3166** and install the latest version.
|
||||
![Install DevKit SDK]({{"/assets/images/getting-started/install-az3166-sdk.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
### Install ST-Link drivers
|
||||
|
||||
|
|
@ -147,6 +157,7 @@ Follow these steps to prepare the development environment for DevKit:
|
|||
* **Windows**: Download and install USB driver from [STMicroelectronics website](http://www.st.com/en/development-tools/stsw-link009.html).
|
||||
* **macOS**: No driver is required for macOS.
|
||||
* **Ubuntu**: Run the following in terminal and log out and log in for the group change to take effect:
|
||||
|
||||
```bash
|
||||
# Copy the default rules. This grants permission to the group 'plugdev'
|
||||
sudo cp ~/.arduino15/packages/AZ3166/tools/openocd/0.10.0/linux/contrib/60-openocd.rules /etc/udev/rules.d/
|
||||
|
|
@ -166,65 +177,77 @@ Now you are all set with preparing and configuring your development environment.
|
|||
1. Click `F1` to open the command palette, type and select **Azure IoT Device Workbench: Open Examples...**. Then select **IoT DevKit** as board.
|
||||
|
||||
1. In the IoT Workbench Examples page, find **Get Started** and click **Open Sample**. Then selects the default path to download the sample code.
|
||||
![Open sample]({{"/assets/images/getting-started/open-sample.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. In the new opened project window, click `F1` to open the command palette, type and select **Azure IoT Device Workbench: Provision Azure Services...**. Follow the step by step guide to finish provisioning your Azure IoT Hub and creating the IoT Hub device.
|
||||
![Cloud provision]({{"/assets/images/getting-started/cloud-provision.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. In the bottom-right status bar, check the **MXCHIP AZ3166** is shown as selected board and serial port with **STMicroelectronics** is used.
|
||||
![Select board and COM]({{"/assets/images/getting-started/select-com.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. Click `F1` to open the command palette, type and select **Azure IoT Device Workbench: Configure Device Settings...**, then select **Config Device Connection String > Select IoT Hub Device Connection String**.
|
||||
|
||||
1. On DevKit, hold down **button A**, push and release the **reset** button, and then release **button A**. Your DevKit enters configuration mode and saves the connection string.
|
||||
![Connection string]({{"/assets/images/getting-started/connection-string.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. Click `F1` again, type and select **Azure IoT Device Workbench: Upload Device Code**. It starts compile and upload the code to DevKit.
|
||||
![Arduino upload]({{"/assets/images/getting-started/arduino-upload.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
The DevKit reboots and starts running the code.
|
||||
|
||||
**Note:** If there is errors or interruptions, you can always recover by running the command again.
|
||||
{: .notice--info}
|
||||
**Note:** If there is errors or interruptions, you can always recover by running the command again.
|
||||
|
||||
## Test the project
|
||||
|
||||
Click the power plug icon on the status bar to open the Serial Monitor:
|
||||
![Open serial monitor]({{"/assets/images/mini-solution/connect-iothub/serial-monitor.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
The sample application is running successfully when you see the following results:
|
||||
|
||||
* The Serial Monitor displays the message sent to the IoT Hub.
|
||||
* The LED on the MXChip IoT DevKit is blinking.
|
||||
|
||||
![Final output in VS Code]({{"/assets/images/mini-solution/connect-iothub/result-serial-output.png" | absolute_url }})
|
||||
|
||||
|
||||
You can use [Azure IoT Toolkit](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit) to monitor device-to-cloud (D2C) messages in IoT Hub.
|
||||
|
||||
1. Log in [Azure portal](https://portal.azure.com), find the IoT Hub you created.
|
||||
![azure-portal-iot-hub]({{"/assets/images/mini-solution/connect-iothub/azure-iot-hub-portal.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. In the **Shared access policies pane**, click the **iothubowner policy**, and write down the Connection string of your IoT hub.
|
||||
![azure-portal-iot-hub-conn-string]({{"/assets/images/mini-solution/connect-iothub/azure-portal-conn-string.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. Expand **AZURE IOT HUB DEVICES** on the bottom left corner.
|
||||
![azure-iot-toolkit-iot-hub-devices]({{"/assets/images/mini-solution/connect-iothub/azure-iot-toolkit-devices.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. Click **Set IoT Hub Connection String** in context menu.
|
||||
![azure-iot-toolkit-iot-hub-conn-string]({{"/assets/images/mini-solution/connect-iothub/azure-iot-toolkit-conn-string.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
1. Click **IoT: Start monitoring D2C message** in context menu.
|
||||
|
||||
1. In **OUTPUT** pane, you can see the incoming D2C messages to the IoT Hub.
|
||||
![azure-iot-toolkit-output-console]({{"/assets/images/mini-solution/connect-iothub/azure-iot-toolkit-console.png" | absolute_url }})
|
||||
|
||||
|
||||
|
||||
## Problems and feedback
|
||||
|
||||
If you encounter problems, you can refer to [FAQs]({{"/docs/faq/" | absolute_url }}) or reach out to us from [Gitter channel](https://gitter.im/Microsoft/azure-iot-developer-kit){:target="_blank"}.
|
||||
If you encounter problems, you can refer to [FAQs](https://microsoft.github.io/azure-iot-developer-kit/docs/faq/) or reach out to us from [Gitter channel](https://gitter.im/Microsoft/azure-iot-developer-kit).
|
||||
|
||||
{% include feedback.html tutorial="get-started" %}
|
||||
|
||||
## Next Steps
|
||||
|
||||
You have successfully connected an MXChip IoT DevKit to your IoT hub, and you have sent the captured sensor data to your IoT hub.
|
||||
Check our [Projects Catalog]({{"/docs/projects/" | absolute_url }}) for more samples you can build with the IoT DevKit and Azure multiple services.
|
||||
You have successfully connected an MXChip IoT DevKit to your IoT hub, and you have sent the captured sensor data to your IoT hub.
|
||||
Check our [Projects Catalog](https://microsoft.github.io/azure-iot-developer-kit/docs/projects/) for more samples you can build with the IoT DevKit and Azure multiple services.
|
||||
|
||||
[Back to top](#Getting-started)
|
||||
|
|
@ -13,7 +13,7 @@ last_modified_at: 2017-05-05T10:16:34-04:00
|
|||
|
||||
### GDPR and IoT DevKit
|
||||
|
||||
Microsoft collects data to operate effectively and provide you the best experiences.
|
||||
Microsoft collects data to operate effectively and provide you the best experiences
|
||||
Participation is voluntary and when you choose to participate, your device automatically sends data to Microsoft about how you use the IoT DevKit.
|
||||
|
||||
If you choose to participate, you can stop at any time as described [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting).
|
||||
|
|
@ -42,7 +42,7 @@ You can purchase the kit from our hardware partner's product page: [https://aka.
|
|||
|
||||
### Failed to install Arduino Package for IoT DevKit
|
||||
|
||||
Sometimes, whether in the in Arduino IDE or VS Code, developers experience a failure to install the MXChip IoT DevKit package with the following error:
|
||||
Sometimes, whether in the Arduino IDE or VS Code, developers experience a failure to install the MXChip IoT DevKit package with the following error:
|
||||
|
||||
![Smartscreen]({{"/assets/images/faq/crc.png" | absolute_url }})
|
||||
|
||||
|
|
@ -116,7 +116,7 @@ To resolvethis issue, please install the latest version of Arduino IDE [here](ht
|
|||
"arduino.additionalUrls": "https://raw.githubusercontent.com/VSChina/azureiotdevkit_tools/master/package_azureboard_index.json"
|
||||
```
|
||||
|
||||
### Additional warnings during compilation.
|
||||
### Additional warnings during compilation
|
||||
|
||||
In certain environments, lots of warnings message pops up in the VS Code OUTPUT windows when you invoke `Arduino Verify`, `Arduino Upload` or `task device-upload` to compile the project.
|
||||
|
||||
|
|
@ -153,7 +153,7 @@ Unable to get the NTP host asia.pool.ntp.org
|
|||
Unable to get the NTP host oceania.pool.ntp.org
|
||||
```
|
||||
|
||||
This may caused by NTP trafficing at firewall in the Gateway. To solve this problem, make sure that UDP port 123 is open on all firewalls between IoT DevKit and the remote time servers.
|
||||
This may caused by NTP traffic blocking at the firewall in the Gateway. To solve this problem, make sure that UDP port 123 is open on all firewalls between IoT DevKit and the remote time servers.
|
||||
|
||||
| Time Server | port |
|
||||
| --- | --- |
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче