Skip to content

Commit f7ff0cf

Browse files
Update README.md (#11)
Grammar corrections.
1 parent 5c002a2 commit f7ff0cf

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ You can watch this video from the Microsoft [IoT Show](https://aka.ms/iotshow) f
2323

2424
**Important**: You **must** be connected to a network with a valid IP address **and** a valid date. Please check the examples with the Network Helpers on how to help you making sure you have both.
2525

26-
This Azure IoT Hub SDK is using MQTT. So you need to ensure you can connect to port 8883 using TLS protocol. If you are in an enterprise network, this may be blocked. In most cases, this is not an issue.
26+
This Azure IoT Hub SDK is using MQTT. So you need to ensure you can connect to port 8883 using TLS protocol. If you are connected to an enterprise network, this may be blocked. In most cases, this is not an issue.
2727

28-
The namespaces, the name of the classes and the methods try to get close to the .NET C# Azure IoT SDK. This should allow an easier portability of the code between both environment.
28+
The namespaces, the name of the classes and the methods try to get close to the .NET C# Azure IoT SDK. This should allow easier portability of the code between the full .Net framework and nanoFramwork environments.
2929

3030
### Certificate
3131

3232
You have 2 options to provide the right Azure IoT TLS certificate:
3333

34-
- Pass it in the constructor
34+
- Parse it into the constructor
3535
- Store it into the device
3636

37-
The [AzureCertificates](AzureCertificates) contains, for your convenience, the root certificated used to connect to Azure IoT. The current one, Baltimore Root CA is the one to use up to June 2022. Starting in June 2022, the Digicert Global Root 2 is the one to use. For more information, please read the following [blog](https://techcommunity.microsoft.com/t5/internet-of-things/azure-iot-tls-critical-changes-are-almost-here-and-why-you/ba-p/2393169).
37+
The [AzureCertificates](AzureCertificates) contains, for your convenience, the root certificate used to connect to Azure IoT. The current one, a Baltimore Root CA is the one to use up to June 2022. Starting from June 2022, the Digicert Global Root 2 is the one to use. For more information, please read the following [blog](https://techcommunity.microsoft.com/t5/internet-of-things/azure-iot-tls-critical-changes-are-almost-here-and-why-you/ba-p/2393169).
3838

39-
#### Thru the constructor
39+
#### Through the constructor
4040

4141
You will have to embed the certificate into your code:
4242

@@ -66,18 +66,18 @@ R9I4LtD+gdwyah617jzV/OeBHRnDJELqYzmp
6666
DeviceClient azureIoT = new DeviceClient(IotBrokerAddress, DeviceID, SasKey, azureCert: new X509Certificate(AzureRootCA));
6767
```
6868

69-
You can place your binary certificate in the resources as well and just get the certificate from it:
69+
You can place your binary certificate in the program resources as well and just get the certificate from it:
7070

7171
```csharp
7272
X509Certificate azureRootCACert = new X509Certificate(Resources.GetBytes(Resources.BinaryResources.AzureCAcertificate));
7373
DeviceClient azureIoT = new DeviceClient(IotBrokerAddress, DeviceID, SasKey, azureCert: azureRootCACert);
7474
```
7575

76-
Note: when the certificate will expire, you will have to reflash fully the device with the new certificate.
76+
Note: when the certificate expires, you will have to fully reflash the device with the new certificate.
7777

78-
#### Storing the certificate into the device
78+
#### Storing the certificate on the device
7979

80-
You can store the certificate into the device and not in the code, so if you have to change, the certificate, you'll just have to clean the current store and upload the new one. Edit the network properties:
80+
You can store the certificate on the device flash and not in the code, so if you have to change the certificate, you'll just have to clean the current store and upload the new one. Edit the network properties:
8181

8282
![edit device network](device-network.jpg)
8383

@@ -89,7 +89,7 @@ Browse to choose your certificate, it can be in a binary (crt, der) or string fo
8989

9090
### Creating a DeviceClient
9191

92-
You can connect to Azure IoT Hub using either a symmetric Key, either a certificate. The following example shows how to use a symmetric key:
92+
You can connect to Azure IoT Hub using either a symmetric Key or a certificate. The following example shows how to use a symmetric key:
9393

9494
```csharp
9595
const string DeviceID = "nanoEdgeTwin";
@@ -98,7 +98,7 @@ const string SasKey = "yoursaskey";
9898
DeviceClient azureIoT = new DeviceClient(IotBrokerAddress, DeviceID, SasKey);
9999
```
100100

101-
Note: please see the previous section to understand how to better pass the certificate for your usage. The example shows the certificate uploaded into the device and not in the code.
101+
Note: please see the previous section to understand how to better parse the certificate for your usage. The example shows the certificate uploaded into the device and not in the code.
102102

103103
### Getting and updating Twin
104104

@@ -116,7 +116,7 @@ if (twin == null)
116116
Debug.WriteLine($"Twin DeviceID: {twin.DeviceId}, #desired: {twin.Properties.Desired.Count}, #reported: {twin.Properties.Reported.Count}");
117117
```
118118

119-
Note: it's important to use a `CancellationToken` that be cancelled after a certain amount of time. Otherwise, this will be blocking the thread up to the point the twin will be received.
119+
Note: it's important to use a `CancellationToken` that will be cancelled after a certain amount of time. Otherwise, this will be blocking the thread up to the point the twin is received.
120120

121121
Twins have properties, reported and desired. They are collection and you can get or try to get any element.
122122

@@ -129,11 +129,11 @@ reported.Add("sdk", 0.2);
129129
azureIoT.UpdateReportedProperties(reported);
130130
```
131131

132-
You have as well the option to wait for the twin update confirmation, in this case use a `CancellationToken` that can be cancelled. Otherwise the check will be ignored.
132+
You also have the option to wait for the twin update confirmation, in this case use a `CancellationToken` that can be cancelled. Otherwise the check will be ignored.
133133

134134
Note: the function will return false if the twin reception confirmation is not checked or if it did not arrive on time.
135135

136-
You can register as well for any twin update:
136+
You can also register for any twin update:
137137

138138
```csharp
139139
azureIoT.TwinUpated += TwinUpdatedEvent;
@@ -153,7 +153,7 @@ var isReceived = azureIoT.SendMessage($"{{\"Temperature\":42,\"Pressure\":1024}}
153153
Debug.WriteLine($"Message received by IoT Hub: {isReceived}");
154154
```
155155

156-
Note: The message will be send with the default service quality you created the device. You won't get any answer for the quality 0. In this case, you can simplify it to:
156+
Note: The message will be sent with the default service quality of service you created the device with. You won't get any answer for the quality `0`. In this case, you can simplify it to:
157157

158158
```csharp
159159
azureIoT.SendMessage($"{{\"Temperature\":42,\"Pressure\":1024}}");
@@ -223,7 +223,7 @@ string RaiseExceptionCallbackTest(int rid, string payload)
223223
}
224224
```
225225

226-
**Important**: method names are case sensitive. So make sure you name your functions in C# the same way.
226+
**Important**: method names are case sensitive. So make sure you name your functions in C# use the same case.
227227

228228
### Status update event
229229

@@ -247,7 +247,7 @@ Note that those are status change based, so once the connect or disconnect event
247247

248248
## Azure IoT Device Provisioning Service (DPS) support
249249

250-
This SDK supports as well Azure IoT Device Provisioning Service. Group and individual provisioning scenarios are supported either with a symmetric key either with certificates. To understand the mechanism behind DPS, it is recommended to read the [documentation](https://docs.microsoft.com/azure/iot-dps/).
250+
This SDK also supports the Azure IoT Device Provisioning Service. Group and individual provisioning scenarios are supported either with a symmetric key either with certificates. To understand the mechanism behind DPS, it is recommended to read the [documentation](https://docs.microsoft.com/azure/iot-dps/).
251251

252252
### Provisioning using symmetric key
253253

0 commit comments

Comments
 (0)