Wiki source code of Azure IoT

Version 16.1 by Xiaoling on 2023/01/05 13:50

version	line-number	content
14.3	1	Table of Contents：
14.2	2
14.3	3
	4
	5
	6
	7	= 1. Deployment Guide =
	8
	9
14.2	10	Learn how to deploy the Azure IoT Hub integration for The Things Stack.
	11
	12
14.3	13	== 1.1 Prerequisites ==
	14
	15
14.2	16	1. Access to an Azure account. [[Create a new account>>url:https://signup.azure.com/]]
14.3	17
14.2	18	1. An application in The Things Stack. [[See instructions>>url:https://www.thethingsindustries.com/docs/integrations/adding-applications/]]
	19
14.3	20	== 1.2 Create API Key ==
14.2	21
	22
14.3	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.2	26	[[image:image-20230105112836-1.png]]
	27
14.3	28
14.2	29	Copy the generated API key and store it in a safe place, because you will need it in the next section.
	30
14.3	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.
14.2	32
	33
14.3	34	== 1.3 Deploy Azure Resource Manager Template ==
	35
	36
14.2	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
	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
	41
14.3	42	== 1.4 Settings ==
	43
	44
14.2	45	The following parameters configure the integration:
	46
14.3	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.
14.2	48
14.3	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
14.2	59	[[image:image-20230105112836-2.png]]
	60
14.3	61	Click (% style="color:blue" %)Review + Create(%%), then (% style="color:#037691" %)Create.
14.2	62
	63
14.3	64	(% style="color:red" %)Note:
	65
14.2	66	Creating all resources can take up to five minutes. ☕
	67
	68	When the deployment is done, you’ll see the status .Your deployment is complete
	69
	70	[[image:image-20230105112836-3.png]]
	71
	72
14.3	73	After the deployment has finished, click (% style="color:blue" %)Outputs.
	74
14.2	75	[[image:image-20230105112836-4.png]]
	76
14.3	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.
14.2	78
	79	[[image:image-20230105112836-5.png]]
	80
	81
14.3	82	= 2. Managing Devices =
	83
	84
14.2	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
	87
14.3	88	(% style="color:red" %)Note:
	89
14.2	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
	92	In Azure IoT Hub, create only devices that are not yet in your The Things Stack application.
	93
	94
14.3	95	(% style="color:blue" %)Device Names:
	96
14.2	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
	99
14.3	100	(% style="color:blue" %)Creating Devices:
	101
14.2	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
14.3	104	(% style="color:blue" %)Creating(%%) a device allows you to add any LoRaWAN device by manually entering its information and security keys.
14.2	105
14.3	106	In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)IoT Devices.
14.2	107
14.3	108	Click (% style="color:blue" %)Add Device.
14.2	109
	110	[[image:image-20230105112836-6.png]]
	111
14.3	112	As (% style="color:blue" %)Device ID(%%), enter any device ID you like. Hit (% style="color:blue" %)Save.
14.2	113
14.3	114	(% style="color:red" %)Note:
14.2	115
	116	See [[ID and EUI constraints>>url:https://www.thethingsindustries.com/docs/reference/id-eui-constraints/]] for guidelines about choosing a unique ID.
	117
	118	[[image:image-20230105112836-7.png]]
	119
14.3	120	You will now have to setup the LoRaWAN specific settings of the device. Click on (% style="color:blue" %)Device Twin.
14.2	121
	122	[[image:image-20230105112836-8.png]]
	123
	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
14.3	126	* (% style="color:#037691" %)devEui:(%%) the hexadecimal LoRaWAN DevEUI.
14.2	127
14.3	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
14.2	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
14.3	142	* (% style="color:#037691" %)bandId:(%%) the band ID.
14.2	143
14.3	144	* (% style="color:#037691" %)brandId:(%%) the brand ID.
14.2	145
14.3	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
14.2	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
	156	The final JSON tags object should look as follows:
	157
	158	{
	159
	160	"lorawan":{
	161
	162	"devEui":"0004A30B001C5838",
	163
	164	"joinEui":"800000000000000C",
	165
	166	"lorawanVersion":"1.0.2",
	167
	168	"regionalParametersVersion":"1.0.2-b",
	169
	170	"frequencyPlanId":"EU_863_870_TTN",
	171
	172	"appKey":"459B77D46A08C427254822A33F6FA1A3",
	173
	174	"versionIdentifiers":{
	175
	176	"bandId":"EU_863_870",
	177
	178	"brandId":"the-things-products",
	179
	180	"firmwareVersion":"1.0",
	181
	182	"hardwareVersion":"1.0",
	183
	184	"modelId":"the-things-node"
	185
	186	}
	187
	188	}
	189
	190	}
	191
	192	[[image:image-20230105112836-9.png]]
	193
14.3	194	Click on (% style="color:blue" %)Save(%%) in the top-left corner. The end device will now be created in The Things Stack.
14.2	195
14.3	196	(% style="color:blue" %)Deleting Devices:
14.2	197
14.3	198	In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)IoT Devices.
14.2	199
14.3	200	Click on the checkbox in front of the device you want to delete, then click (% style="color:blue" %)Delete.
14.2	201
	202	[[image:image-20230105112836-10.png]]
	203
	204	The end device will be deleted from Azure IoT Hub and The Things Stack.
	205
14.3	206	(% style="color:blue" %)Example(TrackerD):
14.2	207
	208	[[image:image-20230105112836-11.png]]
	209
	210	[[image:image-20230105112836-12.png]]
	211
	212
14.3	213	(% style="color:blue" %)Example(LHT65N):
14.2	214
	215	[[image:image-20230105112836-13.png]]
	216
	217	[[image:image-20230105112836-14.png]]

Wiki source code of Azure IoT

Applications

Navigation