Changes for page Azure IoT

Last modified by Xiaoling on 2024/05/30 16:46
<
From version < 17.1 >
edited by Xiaoling
on 2023/01/05 13:55
To version < 14.2 >
edited by Xiaoling
on 2023/01/05 11:32
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,168 +1,117 @@
1 -**Table of Contents：**
1 +**Deployment Guide**
2 2  
3 -{{toc/}}
4 -
5 -
6 -
7 -
8 -
9 -= 1. Deployment Guide =
10 -
11 -
12 12  Learn how to deploy the Azure IoT Hub integration for The Things Stack.
13 13  
5 +**Prerequisites**
14 14  
15 -== 1.1 Prerequisites ==
7 +1. Access to an Azure account. [[Create a new account>>url:https://signup.azure.com/]]
8 +1. An application in The Things Stack. [[See instructions>>url:https://www.thethingsindustries.com/docs/integrations/adding-applications/]]
16 16  
10 +**Create API Key**
17 17  
18 -1.  Access to an Azure account. [[Create a new account>>url:https://signup.azure.com/]]
12 +Go to your application in The Things Stack Console, navigate to **Integrations → Azure IoT** on the left hand menu and click on **Expand** next to **Azure IoT Hub**. Now click on **Generate API Key**.
19 19  
20 -2. An application in The Things Stack. [[See instructions>>url:https://www.thethingsindustries.com/docs/integrations/adding-applications/]]
21 -
22 -
23 -== 1.2 Create API Key ==
24 -
25 -
26 -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**.
27 -
28 -
29 29  [[image:image-20230105112836-1.png]]
30 30  
31 -
32 32  Copy the generated API key and store it in a safe place, because you will need it in the next section.
33 33  
34 -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.
18 +Leave the integration page open, as you will need to copy in your **Azure IoT Hub hostname** and **Azure IoT Hub access key** before saving the integration.
35 35  
20 +**Deploy Azure Resource Manager Template**
36 36  
37 -== 1.3 Deploy Azure Resource Manager Template ==
38 -
39 -
40 40  [[Deploy template>>url:https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fttsiothubintegration.blob.core.windows.net%2Fintegration-releases%2Flatest%2Fmain.json]]
41 41  
42 42  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]]
43 43  
26 +**Settings**
44 44  
45 -== 1.4 Settings ==
46 -
47 -
48 48  The following parameters configure the integration:
49 49  
50 -* (% style="color:#037691" %)**Location**(%%): The region in which the Azure resources will be deployed. Defaults to the region used by the selected Resource Group.
30 +* **Location**: The region in which the Azure resources will be deployed. Defaults to the region used by the selected Resource Group.
31 +* **Name Suffix**: The suffix added to the Azure Resources. Defaults to a random string.
32 +* **Stack Cluster Address**: The address of your The Things Stack deployment. Can be retrieved from the **Azure IoT** integration page in The Things Stack (see image above).
33 +* **Stack Application ID**: The application ID of your application. Can be retrieved from the **Azure IoT** integration page in The Things Stack (see image above).
34 +* **Stack API Key**: The application API key that you generated in the previous step.
35 +* **Enable fallback route**: Defines if the Azure IoT Hub fallback route should be added. If enabled, uplink messages will be submitted to the default endpoint in your Azure IoT Hub.events
51 51  
52 -* (% style="color:#037691" %)**Name Suffix**(%%): The suffix added to the Azure Resources. Defaults to a random string.
53 -
54 -* (% style="color:#037691" %)**Stack Cluster Address**(%%): The address of your The Things Stack deployment. Can be retrieved from the (% style="color:blue" %)**Azure IoT**(%%) integration page in The Things Stack (see image above).
55 -
56 -* (% style="color:#037691" %)**Stack Application ID**(%%): The application ID of your application. Can be retrieved from the (% style="color:blue" %)**Azure IoT** (%%)integration page in The Things Stack (see image above).
57 -
58 -* (% style="color:#037691" %)**Stack API Key**(%%): The application API key that you generated in the previous step.
59 -
60 -* (% style="color:#037691" %)**Enable fallback route**(%%): Defines if the Azure IoT Hub fallback route should be added. If enabled, uplink messages will be submitted to the default endpoint in your Azure IoT Hub.events
61 -
62 62  [[image:image-20230105112836-2.png]]
63 63  
64 -Click (% style="color:blue" %)**Review + Create**(%%), then (% style="color:blue" %)**Create**.
39 +Click **Review + Create**, then **Create**.
65 65  
41 +**Note:**
66 66  
67 -(% style="color:red" %)**Note:**
68 -
69 69  Creating all resources can take up to five minutes. ☕
70 70  
71 -When the deployment is done, you’ll see the status .Your deployment is complete.
45 +When the deployment is done, you’ll see the status .Your deployment is complete
72 72  
73 -
74 74  [[image:image-20230105112836-3.png]]
75 75  
49 +After the deployment has finished, click **Outputs**.
76 76  
77 -After the deployment has finished, click (% style="color:blue" %)**Outputs**.
51 +[[image:image-20230105112836-4.png]]
78 78  
79 -[[image:image-20230105135055-2.png]]
53 +The two outputs can now be copied into your integration settings as **Azure IoT Hub hostname** and **Azure IoT Hub access key**. Click on **Enable/Update Azure IoT Hub integration**.
80 80  
81 -
82 -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**.
83 -
84 84  [[image:image-20230105112836-5.png]]
85 85  
57 +**Managing Devices**
86 86  
87 -= 2. Managing Devices =
88 -
89 -
90 90  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.
91 91  
61 +**Note:**
92 92  
93 -(% style="color:red" %)**Note:**
94 -
95 95  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.
96 96  
97 97  In Azure IoT Hub, create only devices that are not yet in your The Things Stack application.
98 98  
67 +**Device Names**
99 99  
100 -(% style="color:blue" %)**Device Names:**
101 -
102 102  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.
103 103  
71 +**Creating Devices**
104 104  
105 -== 2.1 Creating Devices ==
106 -
107 -
108 108  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.
109 109  
110 -(% style="color:blue" %)**Creating**(%%) a device allows you to add any LoRaWAN device by manually entering its information and security keys.
75 +**Creating** a device allows you to add any LoRaWAN device by manually entering its information and security keys.
111 111  
112 -In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)**IoT Devices**.
77 +In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click **IoT Devices**.
113 113  
114 -Click (% style="color:blue" %)**Add Device**.
79 +Click **Add Device**.
115 115  
116 116  [[image:image-20230105112836-6.png]]
117 117  
83 +As **Device ID**, enter any device ID you like. Hit **Save**.
118 118  
119 -As (% style="color:blue" %)**Device ID**(%%), enter any device ID you like. Hit (% style="color:blue" %)**Save**.
85 +**Note:**
120 120  
121 -
122 -(% style="color:red" %)**Note:**
123 -
124 124  See [[ID and EUI constraints>>url:https://www.thethingsindustries.com/docs/reference/id-eui-constraints/]] for guidelines about choosing a unique ID.
125 125  
126 126  [[image:image-20230105112836-7.png]]
127 127  
91 +You will now have to setup the LoRaWAN specific settings of the device. Click on **Device Twin**.
128 128  
129 -You will now have to setup the LoRaWAN specific settings of the device. Click on (% style="color:blue" %)**Device Twin**.
93 +[[image:image-20230105112836-8.png]]
130 130  
131 -[[image:image-20230105134348-1.png]]
132 -
133 -
134 134  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:
135 135  
136 -* (% style="color:#037691" %)**devEui:**(%%) the hexadecimal LoRaWAN DevEUI.
97 +* devEui: the hexadecimal LoRaWAN DevEUI.
98 +* joinEui: the hexadecimal LoRaWAN JoinEUI (or AppEUI).
99 +* lorawanVersion: either 1.0, 1.0.1, 1.0.2, 1.0.3 or 1.1.
100 +* 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.
101 +* appKey: the hexadecimal LoRaWAN AppKey.
102 +* nwkKey: the hexadecimal LoRaWAN NwkKey (only when using LoRaWAN 1.1 or higher).
103 +* frequencyPlanId: the frequency plan ID. See [[Frequency Plans>>url:https://www.thethingsindustries.com/docs/reference/frequency-plans/]] for the supported values.
137 137  
138 -* (% style="color:#037691" %)**joinEui:**(%%)** **the hexadecimal LoRaWAN JoinEUI (or AppEUI).
139 -
140 -* (% style="color:#037691" %)**lorawanVersion:**(%%) either 1.0, 1.0.1, 1.0.2, 1.0.3 or 1.1.
141 -
142 -* (% 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.
143 -
144 -* (% style="color:#037691" %)**appKey:**(%%) the hexadecimal LoRaWAN AppKey.
145 -
146 -* (% style="color:#037691" %)**nwkKey:**(%%) the hexadecimal LoRaWAN NwkKey (only when using LoRaWAN 1.1 or higher).
147 -
148 -* (% style="color:#037691" %)**frequencyPlanId:**(%%) the frequency plan ID. See [[Frequency Plans>>url:https://www.thethingsindustries.com/docs/reference/frequency-plans/]] for the supported values.
149 -
150 150  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:
151 151  
152 -* (% style="color:#037691" %)**bandId:**(%%) the band ID.
107 +* bandId: the band ID.
108 +* brandId: the brand ID.
109 +* firmwareVersion: the firmware version.
110 +* hardwareVersion: the hardware version.
111 +* modelId: the model ID.
153 153  
154 -* (% style="color:#037691" %)**brandId:**(%%) the brand ID.
113 +**Note:**
155 155  
156 -* (% style="color:#037691" %)**firmwareVersion:**(%%) the firmware version.
157 -
158 -* (% style="color:#037691" %)**hardwareVersion:**(%%) the hardware version.
159 -
160 -* (% style="color:#037691" %)**modelId:**(%%) the model ID.
161 -
162 -
163 -
164 -(% style="color:red" %)**Note:**
165 -
166 166  If the version identifiers are provided, the end device will automatically load the [[Payload Formatters>>url:https://www.thethingsindustries.com/docs/integrations/payload-formatters/]] from [[LoRaWAN Device Repository>>url:https://www.thethingsindustries.com/docs/integrations/payload-formatters/device-repo/]].
167 167  
168 168  The final JSON tags object should look as follows:
... ... @@ -201,37 +201,29 @@
201 201  
202 202  }
203 203  
204 -
205 205  [[image:image-20230105112836-9.png]]
206 206  
207 -Click on (% style="color:blue" %)**Save**(%%) in the top-left corner. The end device will now be created in The Things Stack.
155 +Click on **Save** in the top-left corner. The end device will now be created in The Things Stack.
208 208  
157 +**Deleting Devices**
209 209  
210 -== 2.2 Deleting Devices ==
159 +In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click **IoT Devices**.
211 211  
161 +Click on the checkbox in front of the device you want to delete, then click **Delete**.
212 212  
213 -In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)**IoT Devices**.
214 -
215 -Click on the checkbox in front of the device you want to delete, then click (% style="color:blue" %)**Delete**.
216 -
217 217  [[image:image-20230105112836-10.png]]
218 218  
219 219  The end device will be deleted from Azure IoT Hub and The Things Stack.
220 220  
167 +Example(TrackerD):
221 221  
222 -(% style="color:blue" %)**Example(TrackerD):**
223 -
224 224  [[image:image-20230105112836-11.png]]
225 225  
226 -
227 227  [[image:image-20230105112836-12.png]]
228 228  
229 229  
230 -(% style="color:blue" %)**Example(LHT65N):**
174 +Example(LHT65N):
231 231  
232 -[[image:image-20230105112836-13.png||height="698" width="1326"]]
176 +[[image:image-20230105112836-13.png]]
233 233  
234 -
235 235  [[image:image-20230105112836-14.png]]
236 -
237 -
image-20230105134348-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -78.2 KB
Content
image-20230105135055-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -48.7 KB
Content
image-20230105135507-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -79.1 KB
Content

Applications

Navigation

Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0