Change comment:
Uploaded new attachment "image-20230105135055-2.png", version {1}
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 3 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,37 +1,25 @@ 1 1 **Table of Contents:** 2 2 3 -{{toc/}} 4 4 5 5 6 6 7 -= 1. Introduction = 8 8 7 += 1. Deployment Guide = 9 9 10 -Azure IoT Hub is designed around standalone end devices communicating directly with the hub. Each end device must connect to the hub via one of the supported communication protocols ([[MQTT>>url:https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-mqtt-support]] / [[AMQP>>url:https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-amqp-support]]). These protocols are inherently stateful - each individual end device must have one connection always open in order to send and receive messages from the Azure IoT Hub. 11 11 12 -The Azure IoT Hub integration prefers to use an asynchronous, stateless communication style. When uplink messages are received from an end device, the integration connects on demand to the Azure IoT Hub and submits the message, and also updates the Device Twin. The data plane protocol used between The Things Stack and Azure IoT Hub is [[MQTT>>url:https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-mqtt-support]], and the connections are always secure using [[TLS 1.2>>url:https://datatracker.ietf.org/doc/html/rfc5246]]. 13 - 14 -(% class="wikigeneratedid" %) 15 -[[image:image-20230511145209-1.png||height="600" width="813"]] 16 - 17 - 18 -= 2. Deployment Guide = 19 - 20 - 21 21 Learn how to deploy the Azure IoT Hub integration for The Things Stack. 22 22 23 23 24 -== 2.1 Prerequisites ==13 +== 1.1 Prerequisites == 25 25 26 26 27 -1. 16 +1. Access to an Azure account. [[Create a new account>>url:https://signup.azure.com/]] 28 28 29 - 2.18 +1. An application in The Things Stack. [[See instructions>>url:https://www.thethingsindustries.com/docs/integrations/adding-applications/]] 30 30 20 +== 1.2 Create API Key == 31 31 32 -== 2.2 Create API Key == 33 33 34 - 35 35 Go to your application in The Things Stack Console, navigate to (% style="color:blue" %)**Integrations → Azure IoT**(%%) on the left hand menu and click on (% style="color:blue" %)**Expand** (%%)next to (% style="color:blue" %)**Azure IoT Hub**(%%). Now click on (% style="color:blue" %)**Generate API Key**. 36 36 37 37 ... ... @@ -43,7 +43,7 @@ 43 43 Leave the integration page open, as you will need to copy in your (% style="color:blue" %)**Azure IoT Hub hostname** (%%)and (% style="color:blue" %)**Azure IoT Hub access key**(%%) before saving the integration. 44 44 45 45 46 -== 2.3 Deploy Azure Resource Manager Template ==34 +== 1.3 Deploy Azure Resource Manager Template == 47 47 48 48 49 49 [[Deploy template>>url:https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fttsiothubintegration.blob.core.windows.net%2Fintegration-releases%2Flatest%2Fmain.json]] ... ... @@ -51,7 +51,7 @@ 51 51 View template as [[JSON>>url:https://ttsiothubintegration.blob.core.windows.net/integration-releases/latest/main.json]] or [[Bicep>>url:https://ttsiothubintegration.blob.core.windows.net/integration-releases/latest/main.bicep]] 52 52 53 53 54 -== 2.4 Settings ==42 +== 1.4 Settings == 55 55 56 56 57 57 The following parameters configure the integration: ... ... @@ -70,7 +70,7 @@ 70 70 71 71 [[image:image-20230105112836-2.png]] 72 72 73 -Click (% style="color:blue" %)**Review + Create**(%%), then (% style="color: blue" %)**Create**.61 +Click (% style="color:blue" %)**Review + Create**(%%), then (% style="color:#037691" %)**Create**. 74 74 75 75 76 76 (% style="color:red" %)**Note:** ... ... @@ -77,27 +77,26 @@ 77 77 78 78 Creating all resources can take up to five minutes. ☕ 79 79 80 -When the deployment is done, you’ll see the status .Your deployment is complete .68 +When the deployment is done, you’ll see the status .Your deployment is complete 81 81 82 - 83 83 [[image:image-20230105112836-3.png]] 84 84 85 85 86 86 After the deployment has finished, click (% style="color:blue" %)**Outputs**. 87 87 88 -[[image:image-2023010513 5055-2.png]]75 +[[image:image-20230105112836-4.png]] 89 89 77 +The two outputs can now be copied into your integration settings as (% style="color:blue" %)**Azure IoT Hub hostname**(%%) and (% style="color:#037691" %)**Azure IoT Hub access key**(%%). Click on (% style="color:blue" %)**Enable/Update Azure IoT Hub integration**. 90 90 91 -The two outputs can now be copied into your integration settings as (% style="color:blue" %)**Azure IoT Hub hostname**(%%) and (% style="color:blue" %)**Azure IoT Hub access key**(%%). Click on (% style="color:blue" %)**Enable/Update Azure IoT Hub integration**. 92 - 93 93 [[image:image-20230105112836-5.png]] 94 94 95 95 96 -= 3. Managing Devices =82 += 2. Managing Devices = 97 97 98 98 99 99 The Azure IoT Hub integration for The Things Stack synchronizes the device registry: you can create devices in Azure IoT Hub which trigger an Azure Function that creates the device in The Things Stack. 100 100 87 + 101 101 (% style="color:red" %)**Note:** 102 102 103 103 Devices that you create in The Things Stack are automatically created as Azure IoT Hub devices as soon as they activate or send their first uplink message. ... ... @@ -110,9 +110,8 @@ 110 110 Devices are created automatically as they join the network or send an uplink message. For the name of new devices, the end device ID in The Things Stack is used as the device ID in Azure IoT Hub. 111 111 112 112 113 -= =3.1Creating Devices==100 +(% style="color:blue" %)**Creating Devices:** 114 114 115 - 116 116 You can use Azure IoT Hub to create and claim devices in The Things Stack. This is useful to manage all your devices in one place, without having to use The Things Stack Console, CLI or API. 117 117 118 118 (% style="color:blue" %)**Creating**(%%) a device allows you to add any LoRaWAN device by manually entering its information and security keys. ... ... @@ -123,10 +123,8 @@ 123 123 124 124 [[image:image-20230105112836-6.png]] 125 125 126 - 127 127 As (% style="color:blue" %)**Device ID**(%%), enter any device ID you like. Hit (% style="color:blue" %)**Save**. 128 128 129 - 130 130 (% style="color:red" %)**Note:** 131 131 132 132 See [[ID and EUI constraints>>url:https://www.thethingsindustries.com/docs/reference/id-eui-constraints/]] for guidelines about choosing a unique ID. ... ... @@ -133,39 +133,37 @@ 133 133 134 134 [[image:image-20230105112836-7.png]] 135 135 136 - 137 137 You will now have to setup the LoRaWAN specific settings of the device. Click on (% style="color:blue" %)**Device Twin**. 138 138 139 -[[image:image-202301051 34348-1.png]]122 +[[image:image-20230105112836-8.png]] 140 140 141 - 142 142 You will now be presented with a JSON document containing the Device Twin. You now have to add a new object called tags, which will contain an object called lorawan with the LoRaWAN specific tags. You will have to specify the following tags: 143 143 144 -* (% style="color:#037691" %) **devEui:**(%%) the hexadecimal LoRaWAN DevEUI.126 +* (% style="color:#037691" %)devEui:(%%) the hexadecimal LoRaWAN DevEUI. 145 145 146 -* (% style="color:#037691" %) **joinEui:**(%%)****the hexadecimal LoRaWAN JoinEUI (or AppEUI).128 +* (% style="color:#037691" %)joinEui:(%%) the hexadecimal LoRaWAN JoinEUI (or AppEUI). 147 147 148 -* (% style="color:#037691" %) **lorawanVersion:**(%%) either 1.0, 1.0.1, 1.0.2, 1.0.3 or 1.1.130 +* (% style="color:#037691" %)lorawanVersion:(%%) either 1.0, 1.0.1, 1.0.2, 1.0.3 or 1.1. 149 149 150 -* (% style="color:#037691" %) **regionalParametersVersion:**(%%) either 1.0, 1.0.1, 1.0.2 (or 1.0.2-a), 1.0.2-b, 1.0.3-a, 1.1-a or 1.1-b.132 +* (% style="color:#037691" %)regionalParametersVersion:(%%) either 1.0, 1.0.1, 1.0.2 (or 1.0.2-a), 1.0.2-b, 1.0.3-a, 1.1-a or 1.1-b. 151 151 152 -* (% style="color:#037691" %) **appKey:**(%%) the hexadecimal LoRaWAN AppKey.134 +* (% style="color:#037691" %)appKey:(%%) the hexadecimal LoRaWAN AppKey. 153 153 154 -* (% style="color:#037691" %) **nwkKey:**(%%) the hexadecimal LoRaWAN NwkKey (only when using LoRaWAN 1.1 or higher).136 +* (% style="color:#037691" %)nwkKey:(%%) the hexadecimal LoRaWAN NwkKey (only when using LoRaWAN 1.1 or higher). 155 155 156 -* (% style="color:#037691" %) **frequencyPlanId:**(%%) the frequency plan ID. See [[Frequency Plans>>url:https://www.thethingsindustries.com/docs/reference/frequency-plans/]] for the supported values.138 +* (% style="color:#037691" %)frequencyPlanId:(%%) the frequency plan ID. See [[Frequency Plans>>url:https://www.thethingsindustries.com/docs/reference/frequency-plans/]] for the supported values. 157 157 158 158 If your end device is a part of the [[LoRaWAN Device Repository>>url:https://www.thethingsindustries.com/docs/integrations/payload-formatters/device-repo/]], you may provide the identifiers of the device as part of an optional versionIdentifiers object. You can specify the following information as part of the identifiers: 159 159 160 -* (% style="color:#037691" %) **bandId:**(%%) the band ID.142 +* (% style="color:#037691" %)bandId:(%%) the band ID. 161 161 162 -* (% style="color:#037691" %) **brandId:**(%%) the brand ID.144 +* (% style="color:#037691" %)brandId:(%%) the brand ID. 163 163 164 -* (% style="color:#037691" %) **firmwareVersion:**(%%) the firmware version.146 +* (% style="color:#037691" %)firmwareVersion:(%%) the firmware version. 165 165 166 -* (% style="color:#037691" %) **hardwareVersion:**(%%) the hardware version.148 +* (% style="color:#037691" %)hardwareVersion:(%%) the hardware version. 167 167 168 -* (% style="color:#037691" %) **modelId:**(%%) the model ID.150 +* (% style="color:#037691" %)modelId:(%%) the model ID. 169 169 170 170 (% style="color:red" %)**Note:** 171 171 ... ... @@ -207,15 +207,12 @@ 207 207 208 208 } 209 209 210 - 211 211 [[image:image-20230105112836-9.png]] 212 212 213 213 Click on (% style="color:blue" %)**Save**(%%) in the top-left corner. The end device will now be created in The Things Stack. 214 214 196 +(% style="color:blue" %)**Deleting Devices:** 215 215 216 -== 3.2 Deleting Devices == 217 - 218 - 219 219 In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)**IoT Devices**. 220 220 221 221 Click on the checkbox in front of the device you want to delete, then click (% style="color:blue" %)**Delete**. ... ... @@ -224,18 +224,15 @@ 224 224 225 225 The end device will be deleted from Azure IoT Hub and The Things Stack. 226 226 206 +(% style="color:blue" %)Example(TrackerD): 227 227 228 -(% style="color:blue" %)**Example(TrackerD):** 229 - 230 230 [[image:image-20230105112836-11.png]] 231 231 232 - 233 233 [[image:image-20230105112836-12.png]] 234 234 235 235 236 -(% style="color:blue" %) **Example(LHT65N):**213 +(% style="color:blue" %)Example(LHT65N): 237 237 238 -[[image:image-202301051 35558-2.png||height="495" width="1360"]]215 +[[image:image-20230105112836-13.png]] 239 239 240 - 241 241 [[image:image-20230105112836-14.png]]
- image-20230105135507-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Xiaoling - Size
-
... ... @@ -1,1 +1,0 @@ 1 -79.1 KB - Content
- image-20230105135558-2.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Xiaoling - Size
-
... ... @@ -1,1 +1,0 @@ 1 -106.1 KB - Content
- image-20230511145209-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Kilight - Size
-
... ... @@ -1,1 +1,0 @@ 1 -131.5 KB - Content