Skip to content

Commit 39c3563

Browse files
authored
Merge pull request #97362 from JimacoMS3/fix-gh-issue-42894
fix instructions in python IoT Hub quickstarts
2 parents 88f985a + b24f5cf commit 39c3563

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,10 @@ 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 and the device application uses the Python V2 device client. The V1 service client is located in the [v1-deprecated branch](https://github.com/Azure/azure-iot-sdk-python/tree/v1-deprecated) of the Azure IoT Python SDK GitHub repository. The Pip package for the V1 service client, *azure-iothub-service-client*, has strict, platform-specific requirements -- including the version of Python installed on your development machine. These requirements are noted in the **Prerequisites** section.
30+
>
31+
2832
[!INCLUDE [cloud-shell-try-it.md](../../includes/cloud-shell-try-it.md)]
2933

3034
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 +43,14 @@ az extension add --name azure-cli-iot-ext
3943

4044
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.
4145

46+
**For Windows**, the following prerequisites are required to install the V1 IoT Hub service client Pip package:
47+
48+
* Make sure you have [Python version **3.6.x**](https://www.python.org/downloads/) installed.
49+
50+
* 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.
51+
52+
**For non-Windows platforms**, see the [Python Pip package distribution table](https://github.com/Azure/azure-iot-sdk-python/blob/v1-deprecated/doc/python-devbox-setup.md#python-pip-package-distribution-table) in the V1 SDK documentation. Make sure the Python 3.x version specified for your platform and any associated requirements are installed on your development machine. Installing Python 3.x rather than 2.7 enables async operations in the V2 device client, which is also used in this quickstart.
53+
4254
## Create an IoT hub
4355

4456
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 +117,7 @@ The simulated device application connects to a device-specific endpoint on your
105117
1. In the local terminal window, run the following commands to install the required libraries for the simulated device application:
106118
107119
```cmd/sh
108-
pip install azure-iothub-device-client
120+
pip install azure-iot-device
109121
```
110122
111123
1. In the local terminal window, run the following commands to run the simulated device application:
@@ -148,6 +160,10 @@ The back-end application connects to a service-side endpoint on your IoT Hub. Th
148160
149161
![Change in simulated client](./media/quickstart-control-device-python/SimulatedDevice-2.png)
150162
163+
> [!NOTE]
164+
> If you get an error on the import of *iothub_service_client*, make sure you've installed the exact version of Python and any other associated artifacts specified for your platform in [Prerequisites](#prerequisites). If, after verifying the prerequisites, you still get an error, you may need to build the service client for your platform. To learn how to build the SDK for your platform, see the [devbox setup instructions](https://github.com/Azure/azure-iot-sdk-python/blob/v1-deprecated/doc/python-devbox-setup.md) in the V1 SDK documentation.
165+
>
166+
151167
## Clean up resources
152168
153169
[!INCLUDE [iot-hub-quickstarts-clean-up-resources](../../includes/iot-hub-quickstarts-clean-up-resources.md)]

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)