Skip to content

Commit 6e21f55

Browse files
committed
fix instructions in quickstart
1 parent 0d47a30 commit 6e21f55

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

articles/iot-hub/quickstart-control-device-python.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ The quickstart uses two pre-written Python applications:
2525

2626
* A back-end application that calls the direct methods on the simulated device. To call a direct method on a device, this application connects to service-side endpoint on your IoT hub.
2727

28+
> [!IMPORTANT]
29+
> In this article, the back-end application uses the Python V1 service client (the device application uses the Python V2 device client). The V1 service client has platform-specific requirements for the version of Python installed on your development machine. These are noted in the prerequisites section.
30+
>
31+
> **Additionally, pip installation of the V1 service client is only supported for Windows.**
32+
>
33+
>For this reason, on non-Windows platforms, you need to build the SDK to use the V1 service client. Code for the V1 service client is in the [v1-deprecated branch](https://github.com/Azure/azure-iot-sdk-python/tree/v1-deprecated) of the Azure IoT Python SDK. Follow the [devbox setup instructions](https://github.com/Azure/azure-iot-sdk-python/blob/v1-deprecated/doc/python-devbox-setup.md) for your platform to build the V1 service client. We recommend building for the Python 3.x version specified for your platform in the instructions.
34+
2835
[!INCLUDE [cloud-shell-try-it.md](../../includes/cloud-shell-try-it.md)]
2936

3037
If you don’t have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
@@ -39,6 +46,12 @@ az extension add --name azure-cli-iot-ext
3946

4047
If you haven't already done so, download the sample Python project from https://github.com/Azure-Samples/azure-iot-samples-python/archive/master.zip and extract the ZIP archive.
4148

49+
The following prerequisites are required for the V1 IoT Hub service client on Windows. For other platforms, see the **Important** note at the beginning of this article.
50+
51+
* Make sure you have [Python version **3.6.x**](https://www.python.org/downloads/) installed. **This specific version is required for the V1 IoT Hub service client on Windows.**
52+
53+
* Make sure you have the [Microsoft Visual C++ Redistributable for Visual Studio](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) installed.
54+
4255
## Create an IoT hub
4356

4457
If you completed the previous [Quickstart: Send telemetry from a device to an IoT hub](quickstart-send-telemetry-python.md), you can skip this step.
@@ -105,7 +118,7 @@ The simulated device application connects to a device-specific endpoint on your
105118
1. In the local terminal window, run the following commands to install the required libraries for the simulated device application:
106119
107120
```cmd/sh
108-
pip install azure-iothub-device-client
121+
pip install azure-iot-device
109122
```
110123
111124
1. In the local terminal window, run the following commands to run the simulated device application:
@@ -122,6 +135,9 @@ The simulated device application connects to a device-specific endpoint on your
122135
123136
The back-end application connects to a service-side endpoint on your IoT Hub. The application makes direct method calls to a device through your IoT hub and listens for acknowledgments. An IoT Hub back-end application typically runs in the cloud.
124137
138+
> [!NOTE]
139+
> **Pip installation of the V1 service client is only supported for Windows.** For other platforms, you need to build the SDK to use the V1 service client. For more information, see the **Important** note at the beginning of this article.
140+
125141
1. In another local terminal window, navigate to the root folder of the sample Python project. Then navigate to the **iot-hub\Quickstarts\back-end-application** folder.
126142
127143
1. Open the **BackEndApplication.py** file in a text editor of your choice.

articles/iot-hub/quickstart-send-telemetry-python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ az extension add --name azure-cli-iot-ext
3333

3434
Download the sample Python project from https://github.com/Azure-Samples/azure-iot-samples-python/archive/master.zip and extract the ZIP archive.
3535

36-
Have Python version 3.5.3+ installed on your development machine.
36+
Have [Python version 3.7 or later](https://www.python.org/downloads/) installed on your development machine. For other versions of Python supported, see [Azure IoT Device Features](https://github.com/Azure/azure-iot-sdk-python/tree/master/azure-iot-device#azure-iot-device-features) in the SDK documentation.
3737

3838
## Create an IoT hub
3939

0 commit comments

Comments
 (0)