Changes for page Azure IoT

Last modified by Kilight Cao on 2023/05/11 14:57
<
From version < 14.2 >
edited by Xiaoling
on 2023/01/05 11:32
To version < 14.3 >
edited by Xiaoling
on 2023/01/05 12:26
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,45 +1,68 @@
1 -**Deployment Guide**
1 +**Table of Contents：**
2 2  
3 +
4 +
5 +
6 +
7 += 1. Deployment Guide =
8 +
9 +
3 3  Learn how to deploy the Azure IoT Hub integration for The Things Stack.
4 4  
5 -**Prerequisites**
6 6  
13 +== 1.1 Prerequisites ==
14 +
15 +
7 7  1. Access to an Azure account. [[Create a new account>>url:https://signup.azure.com/]]
17 +
8 8  1. An application in The Things Stack. [[See instructions>>url:https://www.thethingsindustries.com/docs/integrations/adding-applications/]]
9 9  
10 -**Create API Key**
20 +== 1.2 Create API Key ==
11 11  
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**.
13 13  
23 +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**.
24 +
25 +
14 14  [[image:image-20230105112836-1.png]]
15 15  
28 +
16 16  Copy the generated API key and store it in a safe place, because you will need it in the next section.
17 17  
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.
31 +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.
19 19  
20 -**Deploy Azure Resource Manager Template**
21 21  
34 +== 1.3 Deploy Azure Resource Manager Template ==
35 +
36 +
22 22  [[Deploy template>>url:https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fttsiothubintegration.blob.core.windows.net%2Fintegration-releases%2Flatest%2Fmain.json]]
23 23  
24 24  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]]
25 25  
26 -**Settings**
27 27  
42 +== 1.4 Settings ==
43 +
44 +
28 28  The following parameters configure the integration:
29 29  
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
47 +* (% style="color:#037691" %)**Location**(%%): The region in which the Azure resources will be deployed. Defaults to the region used by the selected Resource Group.
36 36  
49 +* (% style="color:#037691" %)**Name Suffix**(%%): The suffix added to the Azure Resources. Defaults to a random string.
50 +
51 +* (% 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).
52 +
53 +* (% 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).
54 +
55 +* (% style="color:#037691" %)**Stack API Key**(%%): The application API key that you generated in the previous step.
56 +
57 +* (% 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
58 +
37 37  [[image:image-20230105112836-2.png]]
38 38  
39 -Click **Review + Create**, then **Create**.
61 +Click (% style="color:blue" %)**Review + Create**(%%), then (% style="color:#037691" %)**Create**.
40 40  
41 -**Note:**
42 42  
64 +(% style="color:red" %)**Note:**
65 +
43 43  Creating all resources can take up to five minutes. ☕
44 44  
45 45  When the deployment is done, you’ll see the status .Your deployment is complete
... ... @@ -46,72 +46,88 @@
46 46  
47 47  [[image:image-20230105112836-3.png]]
48 48  
49 -After the deployment has finished, click **Outputs**.
50 50  
73 +After the deployment has finished, click (% style="color:blue" %)**Outputs**.
74 +
51 51  [[image:image-20230105112836-4.png]]
52 52  
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**.
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**.
54 54  
55 55  [[image:image-20230105112836-5.png]]
56 56  
57 -**Managing Devices**
58 58  
82 += 2. Managing Devices =
83 +
84 +
59 59  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.
60 60  
61 -**Note:**
62 62  
88 +(% style="color:red" %)**Note:**
89 +
63 63  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.
64 64  
65 65  In Azure IoT Hub, create only devices that are not yet in your The Things Stack application.
66 66  
67 -**Device Names**
68 68  
95 +(% style="color:blue" %)**Device Names:**
96 +
69 69  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.
70 70  
71 -**Creating Devices**
72 72  
100 +(% style="color:blue" %)**Creating Devices:**
101 +
73 73  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.
74 74  
75 -**Creating** a device allows you to add any LoRaWAN device by manually entering its information and security keys.
104 +(% style="color:blue" %)**Creating**(%%) a device allows you to add any LoRaWAN device by manually entering its information and security keys.
76 76  
77 -In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click **IoT Devices**.
106 +In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)**IoT Devices**.
78 78  
79 -Click **Add Device**.
108 +Click (% style="color:blue" %)**Add Device**.
80 80  
81 81  [[image:image-20230105112836-6.png]]
82 82  
83 -As **Device ID**, enter any device ID you like. Hit **Save**.
112 +As (% style="color:blue" %)**Device ID**(%%), enter any device ID you like. Hit (% style="color:blue" %)**Save**.
84 84  
85 -**Note:**
114 +(% style="color:red" %)**Note:**
86 86  
87 87  See [[ID and EUI constraints>>url:https://www.thethingsindustries.com/docs/reference/id-eui-constraints/]] for guidelines about choosing a unique ID.
88 88  
89 89  [[image:image-20230105112836-7.png]]
90 90  
91 -You will now have to setup the LoRaWAN specific settings of the device. Click on **Device Twin**.
120 +You will now have to setup the LoRaWAN specific settings of the device. Click on (% style="color:blue" %)**Device Twin**.
92 92  
93 93  [[image:image-20230105112836-8.png]]
94 94  
95 95  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:
96 96  
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.
126 +* (% style="color:#037691" %)devEui:(%%) the hexadecimal LoRaWAN DevEUI.
104 104  
128 +* (% style="color:#037691" %)joinEui:(%%) the hexadecimal LoRaWAN JoinEUI (or AppEUI).
129 +
130 +* (% style="color:#037691" %)lorawanVersion:(%%) either 1.0, 1.0.1, 1.0.2, 1.0.3 or 1.1.
131 +
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.
133 +
134 +* (% style="color:#037691" %)appKey:(%%) the hexadecimal LoRaWAN AppKey.
135 +
136 +* (% style="color:#037691" %)nwkKey:(%%) the hexadecimal LoRaWAN NwkKey (only when using LoRaWAN 1.1 or higher).
137 +
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.
139 +
105 105  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:
106 106  
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.
142 +* (% style="color:#037691" %)bandId:(%%) the band ID.
112 112  
113 -**Note:**
144 +* (% style="color:#037691" %)brandId:(%%) the brand ID.
114 114  
146 +* (% style="color:#037691" %)firmwareVersion:(%%) the firmware version.
147 +
148 +* (% style="color:#037691" %)hardwareVersion:(%%) the hardware version.
149 +
150 +* (% style="color:#037691" %)modelId:(%%) the model ID.
151 +
152 +(% style="color:red" %)**Note:**
153 +
115 115  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/]].
116 116  
117 117  The final JSON tags object should look as follows:
... ... @@ -152,19 +152,19 @@
152 152  
153 153  [[image:image-20230105112836-9.png]]
154 154  
155 -Click on **Save** in the top-left corner. The end device will now be created in The Things Stack.
194 +Click on (% style="color:blue" %)**Save**(%%) in the top-left corner. The end device will now be created in The Things Stack.
156 156  
157 -**Deleting Devices**
196 +(% style="color:blue" %)**Deleting Devices:**
158 158  
159 -In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click **IoT Devices**.
198 +In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)**IoT Devices**.
160 160  
161 -Click on the checkbox in front of the device you want to delete, then click **Delete**.
200 +Click on the checkbox in front of the device you want to delete, then click (% style="color:blue" %)**Delete**.
162 162  
163 163  [[image:image-20230105112836-10.png]]
164 164  
165 165  The end device will be deleted from Azure IoT Hub and The Things Stack.
166 166  
167 -Example(TrackerD):
206 +(% style="color:blue" %)Example(TrackerD):
168 168  
169 169  [[image:image-20230105112836-11.png]]
170 170  
... ... @@ -171,7 +171,7 @@
171 171  [[image:image-20230105112836-12.png]]
172 172  
173 173  
174 -Example(LHT65N):
213 +(% style="color:blue" %)Example(LHT65N):
175 175  
176 176  [[image:image-20230105112836-13.png]]
177 177  

Applications

Navigation

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