Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 0 added, 2 removed)
  • image-20230105134348-1.png
  • image-20230105135055-2.png

Details

Page properties

Content

...	...	@@ -1,68 +1,45 @@
1		-**Table of Contents：**
	1	+**Deployment Guide**
2	2
3		-
4		-
5		-
6		-
7		-= 1. Deployment Guide =
8		-
9		-
10	10	Learn how to deploy the Azure IoT Hub integration for The Things Stack.
11	11
	5	+**Prerequisites**
12	12
13		-== 1.1 Prerequisites ==
14		-
15		-
16	16	1. Access to an Azure account. [[Create a new account>>url:https://signup.azure.com/]]
17		-
18	18	1. An application in The Things Stack. [[See instructions>>url:https://www.thethingsindustries.com/docs/integrations/adding-applications/]]
19	19
20		-== 1.2 Create API Key ==
	10	+**Create API Key**
21	21
	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**.
22	22
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		-
26	26	[[image:image-20230105112836-1.png]]
27	27
28		-
29	29	Copy the generated API key and store it in a safe place, because you will need it in the next section.
30	30
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.
	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.
32	32
	20	+**Deploy Azure Resource Manager Template**
33	33
34		-== 1.3 Deploy Azure Resource Manager Template ==
35		-
36		-
37	37	[[Deploy template>>url:https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fttsiothubintegration.blob.core.windows.net%2Fintegration-releases%2Flatest%2Fmain.json]]
38	38
39	39	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]]
40	40
	26	+**Settings**
41	41
42		-== 1.4 Settings ==
43		-
44		-
45	45	The following parameters configure the integration:
46	46
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.
	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
48	48
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		-
59	59	[[image:image-20230105112836-2.png]]
60	60
61		-Click (% style="color:blue" %)**Review + Create**(%%), then (% style="color:#037691" %)**Create**.
	39	+Click **Review + Create**, then **Create**.
62	62
	41	+**Note:**
63	63
64		-(% style="color:red" %)**Note:**
65		-
66	66	Creating all resources can take up to five minutes. ☕
67	67
68	68	When the deployment is done, you’ll see the status .Your deployment is complete
...	...	@@ -69,88 +69,72 @@
69	69
70	70	[[image:image-20230105112836-3.png]]
71	71
	49	+After the deployment has finished, click **Outputs**.
72	72
73		-After the deployment has finished, click (% style="color:blue" %)**Outputs**.
74		-
75	75	[[image:image-20230105112836-4.png]]
76	76
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**.
	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**.
78	78
79	79	[[image:image-20230105112836-5.png]]
80	80
	57	+**Managing Devices**
81	81
82		-= 2. Managing Devices =
83		-
84		-
85	85	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.
86	86
	61	+**Note:**
87	87
88		-(% style="color:red" %)**Note:**
89		-
90	90	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.
91	91
92	92	In Azure IoT Hub, create only devices that are not yet in your The Things Stack application.
93	93
	67	+**Device Names**
94	94
95		-(% style="color:blue" %)**Device Names:**
96		-
97	97	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.
98	98
	71	+**Creating Devices**
99	99
100		-(% style="color:blue" %)**Creating Devices:**
101		-
102	102	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.
103	103
104		-(% 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.
105	105
106		-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**.
107	107
108		-Click (% style="color:blue" %)**Add Device**.
	79	+Click **Add Device**.
109	109
110	110	[[image:image-20230105112836-6.png]]
111	111
112		-As (% style="color:blue" %)**Device ID**(%%), enter any device ID you like. Hit (% style="color:blue" %)**Save**.
	83	+As **Device ID**, enter any device ID you like. Hit **Save**.
113	113
114		-(% style="color:red" %)**Note:**
	85	+**Note:**
115	115
116	116	See [[ID and EUI constraints>>url:https://www.thethingsindustries.com/docs/reference/id-eui-constraints/]] for guidelines about choosing a unique ID.
117	117
118	118	[[image:image-20230105112836-7.png]]
119	119
120		-You will now have to setup the LoRaWAN specific settings of the device. Click on (% style="color:blue" %)**Device Twin**.
	91	+You will now have to setup the LoRaWAN specific settings of the device. Click on **Device Twin**.
121	121
122	122	[[image:image-20230105112836-8.png]]
123	123
124	124	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:
125	125
126		-* (% 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.
127	127
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		-
140	140	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:
141	141
142		-* (% 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.
143	143
144		-* (% style="color:#037691" %)brandId:(%%) the brand ID.
	113	+**Note:**
145	145
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		-
154	154	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/]].
155	155
156	156	The final JSON tags object should look as follows:
...	...	@@ -191,19 +191,19 @@
191	191
192	192	[[image:image-20230105112836-9.png]]
193	193
194		-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.
195	195
196		-(% style="color:blue" %)**Deleting Devices:**
	157	+**Deleting Devices**
197	197
198		-In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)**IoT Devices**.
	159	+In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click **IoT Devices**.
199	199
200		-Click on the checkbox in front of the device you want to delete, then click (% style="color:blue" %)**Delete**.
	161	+Click on the checkbox in front of the device you want to delete, then click **Delete**.
201	201
202	202	[[image:image-20230105112836-10.png]]
203	203
204	204	The end device will be deleted from Azure IoT Hub and The Things Stack.
205	205
206		-(% style="color:blue" %)Example(TrackerD):
	167	+Example(TrackerD):
207	207
208	208	[[image:image-20230105112836-11.png]]
209	209
...	...	@@ -210,7 +210,7 @@
210	210	[[image:image-20230105112836-12.png]]
211	211
212	212
213		-(% style="color:blue" %)Example(LHT65N):
	174	+Example(LHT65N):
214	214
215	215	[[image:image-20230105112836-13.png]]
216	216

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