Skip to content

Commit 9433087

Browse files
committed
Minor Acrolinx tweaks, to improve scores
1 parent 13c39eb commit 9433087

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

articles/iot-hub/iot-hub-create-use-iot-toolkit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This article shows you how to use the [Azure IoT Hub extension for Visual Studio
2323

2424
- [Azure IoT Hub extension](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit) installed for Visual Studio Code
2525

26-
- An Azure subscription: [create a free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
26+
- An Azure subscription: [create a free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin
2727

2828
- An Azure resource group: [create a resource group](../azure-resource-manager/management/manage-resource-groups-portal.md#create-resource-groups) in the Azure portal
2929

@@ -53,7 +53,7 @@ The following steps show how to create an IoT hub in Visual Studio Code (VS Code
5353

5454
9. Enter a globally unique name for your IoT hub, and then select the Enter key.
5555

56-
10. Wait a few minutes until the IoT hub is created. You'll see a confirmation in the **Output** panel.
56+
10. Wait a few minutes until the IoT hub is created and confirmation is displayed in the **Output** panel.
5757

5858
> [!TIP]
5959
> There is no option to delete your IoT hub in Visual Studio Code, however you can [delete your hub in the Azure portal](iot-hub-create-through-portal.md#delete-an-iot-hub).

articles/iot-hub/iot-hub-device-management-iot-toolkit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Azure IoT device management with the Azure IoT Hub extension for VSCode
2+
title: Azure IoT Hub device management with the Azure IoT Hub extension for Visual Studio Code
33
description: Use the Azure IoT Hub extension for Visual Studio Code for Azure IoT Hub device management, featuring the Direct methods and the Twin's desired properties management options.
44
author: formulahendry
55

@@ -22,7 +22,7 @@ In this article, you learn how to use the [Azure IoT Hub extension for Visual St
2222
| Direct methods | Make a device act such as starting or stopping sending messages or rebooting the device. |
2323
| Read device twin | Get the reported state of a device. For example, the device reports the LED is blinking now. |
2424
| Update device twin | Put a device into certain states, such as setting an LED to green or setting the telemetry send interval to 30 minutes. |
25-
| Cloud-to-device messages | Send notifications to a device. For example, "It is very likely to rain today. Don't forget to bring an umbrella." |
25+
| Cloud-to-device messages | Send notifications to a device. For example, "It's likely to rain today. Don't forget to bring an umbrella." |
2626

2727
For more detailed explanation on the differences and guidance on using these options, see [Device-to-cloud communication guidance](iot-hub-devguide-d2c-guidance.md) and [Cloud-to-device communication guidance](iot-hub-devguide-c2d-guidance.md).
2828

articles/iot-hub/iot-hub-distributed-tracing.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom: [amqp, mqtt, fasttrack-edit, iot]
1414

1515
Microsoft Azure IoT Hub currently supports distributed tracing as a [preview feature](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
1616

17-
IoT Hub is one of the first Azure services to support distributed tracing. As more Azure services support distributed tracing, you'll be able to trace Internet of Things (IoT) messages throughout the Azure services involved in your solution. For a background on the feature, see [What is distributed tracing?](../azure-monitor/app/distributed-tracing-telemetry-correlation.md).
17+
IoT Hub is one of the first Azure services to support distributed tracing. As more Azure services support distributed tracing, you're able to trace Internet of Things (IoT) messages throughout the Azure services involved in your solution. For a background on the feature, see [What is distributed tracing?](../azure-monitor/app/distributed-tracing-telemetry-correlation.md).
1818

1919
When you enable distributed tracing for IoT Hub, you can:
2020

@@ -53,7 +53,7 @@ In this section, you configure an IoT hub to log distributed tracing attributes
5353

5454
:::image type="content" source="media/iot-hub-distributed-tracing/diagnostic-setting-name.png" alt-text="Screenshot that shows where to add a name for your diagnostic settings." lightbox="media/iot-hub-distributed-tracing/diagnostic-setting-name.png":::
5555

56-
1. Choose one or more of the following options under **Destination details** to determine where the logging will be sent:
56+
1. Choose one or more of the following options under **Destination details** to determine where to send logging information:
5757

5858
- **Archive to a storage account**: Configure a storage account to contain the logging information.
5959
- **Stream to an event hub**: Configure an event hub to contain the logging information.
@@ -107,7 +107,7 @@ These instructions are for building the sample on Windows. For other environment
107107
cmake ..
108108
```
109109
110-
If CMake can't find your C++ compiler, you might get build errors while running the preceding command. If that happens, try running the command in the [Visual Studio command prompt](/dotnet/framework/tools/developer-command-prompt-for-vs).
110+
If CMake can't find your C++ compiler, you might encounter build errors while running the preceding command. If that happens, try running the command in the [Visual Studio command prompt](/dotnet/framework/tools/developer-command-prompt-for-vs).
111111
112112
After the build succeeds, the last few output lines will look similar to the following output:
113113
@@ -226,7 +226,7 @@ To change the percentage of messages to be traced from the cloud, you must updat
226226
227227
**Enable Distributed Tracing: Enabled** now appears under **Distributed Tracing Setting (Preview)** > **Desired**.
228228
229-
1. In the pop-up pane that appears for the sampling rate, type **100**, and then select the Enter key.
229+
1. In the pop-up pane that appears for the sampling rate, enter **100** and then select the Enter key.
230230
231231
![Screenshot that shows entering a sampling rate](./media/iot-hub-distributed-tracing/update-distributed-tracing-setting-3.png)
232232
@@ -282,11 +282,11 @@ To understand the types of logs, see [Azure IoT Hub distributed tracing logs](mo
282282

283283
Many IoT solutions, including the [Azure IoT reference architecture](/azure/architecture/reference-architectures/iot) (English only), generally follow a variant of the [microservice architecture](/azure/architecture/microservices/). As an IoT solution grows more complex, you end up using a dozen or more microservices. These microservices might or might not be from Azure.
284284

285-
Pinpointing where IoT messages are dropping or slowing down can be challenging. For example, imagine that you have an IoT solution that uses 5 different Azure services and 1,500 active devices. Each device sends 10 device-to-cloud messages per second, for a total of 15,000 messages per second. But you notice that your web app sees only 10,000 messages per second. How do you find the culprit?
285+
Pinpointing where IoT messages are dropping or slowing down can be challenging. For example, imagine that you have an IoT solution that uses five different Azure services and 1,500 active devices. Each device sends 10 device-to-cloud messages per second, for a total of 15,000 messages per second. But you notice that your web app sees only 10,000 messages per second. How do you find the culprit?
286286

287287
For you to reconstruct the flow of an IoT message across services, each service should propagate a *correlation ID* that uniquely identifies the message. After Azure Monitor collects correlation IDs in a centralized system, you can use those IDs to see message flow. This method is called the [distributed tracing pattern](/azure/architecture/microservices/logging-monitoring#distributed-tracing).
288288

289-
To support wider adoption for distributed tracing, Microsoft is contributing to [W3C standard proposal for distributed tracing](https://w3c.github.io/trace-context/). When distributed tracing support for IoT Hub is enabled, it will follow this flow:
289+
To support wider adoption for distributed tracing, Microsoft is contributing to [W3C standard proposal for distributed tracing](https://w3c.github.io/trace-context/). When distributed tracing support for IoT Hub is enabled, it follows this flow:
290290

291291
1. A message is generated on the IoT device.
292292
1. The IoT device decides (with help from the cloud) that this message should be assigned with a trace context.
@@ -302,8 +302,8 @@ To support wider adoption for distributed tracing, Microsoft is contributing to
302302

303303
- The proposal for the W3C Trace Context standard is currently a working draft.
304304
- The only development language that the client SDK currently supports is C.
305-
- Cloud-to-device twin capability isn't available for the [IoT Hub basic tier](iot-hub-scaling.md#basic-and-standard-tiers). However, IoT Hub will still log to Azure Monitor if it sees a properly composed trace context header.
306-
- To ensure efficient operation, IoT Hub will impose a throttle on the rate of logging that can occur as part of distributed tracing.
305+
- Cloud-to-device twin capability isn't available for the [IoT Hub basic tier](iot-hub-scaling.md#basic-and-standard-tiers). However, IoT Hub still logs to Azure Monitor if it sees a properly composed trace context header.
306+
- To ensure efficient operation, IoT Hub imposes a throttle on the rate of logging that can occur as part of distributed tracing.
307307

308308
## Next steps
309309

articles/iot-hub/iot-hub-mqtt-support.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ IoT Hub isn't a full-featured MQTT broker and doesn't support all the behaviors
2121

2222
[!INCLUDE [iot-hub-basic](../../includes/iot-hub-basic-partial.md)]
2323

24-
All device communication with IoT Hub must be secured using TLS/SSL. Therefore, IoT Hub doesn't support non-secure connections over TCP port 1883.
24+
All device communication with IoT Hub must be secured using TLS/SSL. Therefore, IoT Hub doesn't support nonsecure connections over TCP port 1883.
2525

2626
## Connecting to IoT Hub
2727

@@ -75,13 +75,13 @@ In order to ensure a client/IoT Hub connection stays alive, both the service and
7575
|C# | 300 seconds* | [Yes](/dotnet/api/microsoft.azure.devices.client.transport.mqtt.mqtttransportsettings.keepaliveinseconds) |
7676
|Python | 60 seconds | [Yes](https://github.com/Azure/azure-iot-sdk-python/blob/v2/azure-iot-device/azure/iot/device/iothub/abstract_clients.py#L343) |
7777

78-
*The C# SDK defines the default value of the MQTT KeepAliveInSeconds property as 300 seconds. In reality, the SDK sends a ping request four times per keep-alive duration set. This means the SDK sends a keep-alive ping every 75 seconds.
78+
*The C# SDK defines the default value of the MQTT KeepAliveInSeconds property as 300 seconds. In reality, the SDK sends a ping request four times per keep-alive duration set. In other words, the SDK sends a keep-alive ping once every 75 seconds.
7979

8080
Following the [MQTT v3.1.1 specification](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718081), IoT Hub's keep-alive ping interval is 1.5 times the client keep-alive value; however, IoT Hub limits the maximum server-side timeout to 29.45 minutes (1767 seconds). This limit exists because all Azure services are bound to the Azure load balancer TCP idle timeout, which is 29.45 minutes.
8181

8282
For example, a device using the Java SDK sends the keep-alive ping, then loses network connectivity. 230 seconds later, the device misses the keep-alive ping because it's offline. However, IoT Hub doesn't close the connection immediately - it waits another `(230 * 1.5) - 230 = 115` seconds before disconnecting the device with the error [404104 DeviceConnectionClosedRemotely](iot-hub-troubleshoot-error-404104-deviceconnectionclosedremotely.md).
8383

84-
The maximum client keep-alive value you can set is `1767 / 1.5 = 1177` seconds. Any traffic will reset the keep-alive. For example, a successful shared access signature (SAS) token refresh resets the keep-alive.
84+
The maximum client keep-alive value you can set is `1767 / 1.5 = 1177` seconds. Any traffic resets the keep-alive. For example, a successful shared access signature (SAS) token refresh resets the keep-alive.
8585

8686
### Migrating a device app from AMQP to MQTT
8787

@@ -275,7 +275,7 @@ The following list describes IoT Hub implementation-specific behaviors:
275275

276276
* IoT Hub doesn't persist Retain messages. If a device sends a message with the **RETAIN** flag set to 1, IoT Hub adds the **mqtt-retain** application property to the message. In this case, instead of persisting the retain message, IoT Hub passes it to the backend app.
277277

278-
* IoT Hub only supports one active MQTT connection per device. Any new MQTT connection on behalf of the same device ID causes IoT Hub to drop the existing connection and **400027 ConnectionForcefullyClosedOnNewConnection** will be logged into IoT Hub Logs
278+
* IoT Hub only supports one active MQTT connection per device. Any new MQTT connection on behalf of the same device ID causes IoT Hub to drop the existing connection and **400027 ConnectionForcefullyClosedOnNewConnection** is logged into IoT Hub Logs
279279

280280
* To route messages based on message body, you must first add property 'contentType' (`ct`) to the end of the MQTT topic and set its value to be `application/json;charset=utf-8` as shown in the following example. For more information about routing messages either based on message properties or message body, see the [IoT Hub message routing query syntax documentation](iot-hub-devguide-routing-query-syntax.md).
281281

@@ -297,7 +297,7 @@ In cloud-to-device messages, values in the property bag are represented as in th
297297
|----|----|----|
298298
| `null` | `key` | Only the key appears in the property bag |
299299
| empty string | `key=` | The key followed by an equal sign with no value |
300-
| non-null, non-empty value | `key=value` | The key followed by an equal sign and the value |
300+
| non-null, nonempty value | `key=value` | The key followed by an equal sign and the value |
301301

302302
The following example shows a property bag that contains three application properties: **prop1** with a value of `null`; **prop2**, an empty string (""); and **prop3** with a value of "a string".
303303

@@ -341,7 +341,7 @@ For more information, see [Understand and use device twins in IoT Hub](iot-hub-d
341341

342342
## Update device twin's reported properties
343343

344-
To update reported properties, the device issues a request to IoT Hub via a publication over a designated MQTT topic. After IoT Hub processes the request, it responds the success or failure status of the update operation via a publication to another topic. This topic can be subscribed by the device in order to notify it about the result of its twin update request. To implement this type of request/response interaction in MQTT, we use the notion of request ID (`$rid`) provided initially by the device in its update request. This request ID is also included in the response from IoT Hub to allow the device to correlate the response to its particular earlier request.
344+
To update reported properties, the device issues a request to IoT Hub via a publication over a designated MQTT topic. After IoT Hub processes the request, it responds the success or failure status of the update operation via a publication to another topic. The device can subscribe to this topic in order to notify it about the result of its twin update request. To implement this type of request/response interaction in MQTT, we use the notion of request ID (`$rid`) provided initially by the device in its update request. This request ID is also included in the response from IoT Hub to allow the device to correlate the response to its particular earlier request.
345345

346346
The following sequence describes how a device updates the reported properties in the device twin in IoT Hub:
347347

@@ -383,7 +383,7 @@ client.publish("$iothub/twin/PATCH/properties/reported/?$rid=" +
383383
rid, twin_reported_property_patch, qos=0)
384384
```
385385

386-
Upon success of the twin reported properties update process in the previous code snippet, the publication message from IoT Hub will have the following topic: `$iothub/twin/res/204/?$rid=1&$version=6`, where `204` is the status code indicating success, `$rid=1` corresponds to the request ID provided by the device in the code, and `$version` corresponds to the version of reported properties section of device twins after the update.
386+
Upon success of the twin reported properties update process in the previous code snippet, the publication message from IoT Hub has the following topic: `$iothub/twin/res/204/?$rid=1&$version=6`, where `204` is the status code indicating success, `$rid=1` corresponds to the request ID provided by the device in the code, and `$version` corresponds to the version of reported properties section of device twins after the update.
387387

388388
For more information, see [Understand and use device twins in IoT Hub](iot-hub-devguide-device-twins.md).
389389

0 commit comments

Comments
 (0)