Wiki source code of Azure IoT

Last modified by Xiaoling on 2024/05/30 16:46

version	line-number	content
14.3	1	Table of Contents：
14.2	2
16.2	3	{{toc/}}
14.3	4
	5
	6
20.1	7	= 1. Introduction =
14.3	8
20.2	9
20.1	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.
16.2	11
20.1	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]].
14.3	13
20.1	14	(% class="wikigeneratedid" %)
	15	[[image:image-20230511145209-1.png\|\|height="600" width="813"]]
14.3	16
20.1	17
	18	= 2. Deployment Guide =
	19
	20
14.2	21	Learn how to deploy the Azure IoT Hub integration for The Things Stack.
	22
	23
20.1	24	== 2.1 Prerequisites ==
14.3	25
20.1	26
16.2	27	1. Access to an Azure account. [[Create a new account>>url:https://signup.azure.com/]]
14.3	28
16.2	29	2. An application in The Things Stack. [[See instructions>>url:https://www.thethingsindustries.com/docs/integrations/adding-applications/]]
14.2	30
16.2	31
20.1	32	== 2.2 Create API Key ==
14.2	33
	34
14.3	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
	37
14.2	38	[[image:image-20230105112836-1.png]]
	39
14.3	40
14.2	41	Copy the generated API key and store it in a safe place, because you will need it in the next section.
	42
14.3	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.
14.2	44
	45
20.1	46	== 2.3 Deploy Azure Resource Manager Template ==
14.3	47
	48
14.2	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]]
	50
	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
	53
20.1	54	== 2.4 Settings ==
14.3	55
	56
14.2	57	The following parameters configure the integration:
	58
14.3	59	* (% 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	60
14.3	61	* (% style="color:#037691" %)Name Suffix(%%): The suffix added to the Azure Resources. Defaults to a random string.
	62
	63	* (% 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).
	64
	65	* (% 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).
	66
	67	* (% style="color:#037691" %)Stack API Key(%%): The application API key that you generated in the previous step.
	68
	69	* (% 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
	70
14.2	71	[[image:image-20230105112836-2.png]]
	72
16.2	73	Click (% style="color:blue" %)Review + Create(%%), then (% style="color:blue" %)Create.
14.2	74
	75
14.3	76	(% style="color:red" %)Note:
	77
14.2	78	Creating all resources can take up to five minutes. ☕
	79
16.2	80	When the deployment is done, you’ll see the status .Your deployment is complete.
14.2	81
16.2	82
14.2	83	[[image:image-20230105112836-3.png]]
	84
	85
14.3	86	After the deployment has finished, click (% style="color:blue" %)Outputs.
	87
16.2	88	[[image:image-20230105135055-2.png]]
14.2	89
	90
16.2	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
14.2	93	[[image:image-20230105112836-5.png]]
	94
	95
20.1	96	= 3. Managing Devices =
14.3	97
	98
14.2	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
14.3	101	(% style="color:red" %)Note:
	102
14.2	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.
	104
	105	In Azure IoT Hub, create only devices that are not yet in your The Things Stack application.
	106
	107
14.3	108	(% style="color:blue" %)Device Names:
	109
14.2	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
	112
20.1	113	== 3.1 Creating Devices ==
14.3	114
16.2	115
14.2	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
14.3	118	(% style="color:blue" %)Creating(%%) a device allows you to add any LoRaWAN device by manually entering its information and security keys.
14.2	119
14.3	120	In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)IoT Devices.
14.2	121
14.3	122	Click (% style="color:blue" %)Add Device.
14.2	123
	124	[[image:image-20230105112836-6.png]]
	125
16.2	126
14.3	127	As (% style="color:blue" %)Device ID(%%), enter any device ID you like. Hit (% style="color:blue" %)Save.
14.2	128
16.2	129
14.3	130	(% style="color:red" %)Note:
14.2	131
	132	See [[ID and EUI constraints>>url:https://www.thethingsindustries.com/docs/reference/id-eui-constraints/]] for guidelines about choosing a unique ID.
	133
	134	[[image:image-20230105112836-7.png]]
	135
16.2	136
14.3	137	You will now have to setup the LoRaWAN specific settings of the device. Click on (% style="color:blue" %)Device Twin.
14.2	138
16.2	139	[[image:image-20230105134348-1.png]]
14.2	140
16.2	141
14.2	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
16.2	144	* (% style="color:#037691" %)devEui:(%%) the hexadecimal LoRaWAN DevEUI.
14.2	145
16.2	146	* (% style="color:#037691" %)joinEui:(%%) the hexadecimal LoRaWAN JoinEUI (or AppEUI).
14.3	147
16.2	148	* (% style="color:#037691" %)lorawanVersion:(%%) either 1.0, 1.0.1, 1.0.2, 1.0.3 or 1.1.
14.3	149
16.2	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.
14.3	151
16.2	152	* (% style="color:#037691" %)appKey:(%%) the hexadecimal LoRaWAN AppKey.
14.3	153
16.2	154	* (% style="color:#037691" %)nwkKey:(%%) the hexadecimal LoRaWAN NwkKey (only when using LoRaWAN 1.1 or higher).
14.3	155
16.2	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.
14.3	157
14.2	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
16.2	160	* (% style="color:#037691" %)bandId:(%%) the band ID.
14.2	161
16.2	162	* (% style="color:#037691" %)brandId:(%%) the brand ID.
14.2	163
16.2	164	* (% style="color:#037691" %)firmwareVersion:(%%) the firmware version.
14.3	165
16.2	166	* (% style="color:#037691" %)hardwareVersion:(%%) the hardware version.
14.3	167
16.2	168	* (% style="color:#037691" %)modelId:(%%) the model ID.
14.3	169
	170	(% style="color:red" %)Note:
	171
14.2	172	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/]].
	173
	174	The final JSON tags object should look as follows:
	175
	176	{
	177
	178	"lorawan":{
	179
	180	"devEui":"0004A30B001C5838",
	181
	182	"joinEui":"800000000000000C",
	183
	184	"lorawanVersion":"1.0.2",
	185
	186	"regionalParametersVersion":"1.0.2-b",
	187
	188	"frequencyPlanId":"EU_863_870_TTN",
	189
	190	"appKey":"459B77D46A08C427254822A33F6FA1A3",
	191
	192	"versionIdentifiers":{
	193
	194	"bandId":"EU_863_870",
	195
	196	"brandId":"the-things-products",
	197
	198	"firmwareVersion":"1.0",
	199
	200	"hardwareVersion":"1.0",
	201
	202	"modelId":"the-things-node"
	203
	204	}
	205
	206	}
	207
	208	}
	209
16.2	210
14.2	211	[[image:image-20230105112836-9.png]]
	212
14.3	213	Click on (% style="color:blue" %)Save(%%) in the top-left corner. The end device will now be created in The Things Stack.
14.2	214
	215
20.1	216	== 3.2 Deleting Devices ==
16.2	217
	218
14.3	219	In the Azure Console, open your Azure IoT Hub resource. In the menu on the left, click (% style="color:blue" %)IoT Devices.
14.2	220
14.3	221	Click on the checkbox in front of the device you want to delete, then click (% style="color:blue" %)Delete.
14.2	222
	223	[[image:image-20230105112836-10.png]]
	224
	225	The end device will be deleted from Azure IoT Hub and The Things Stack.
	226
	227
16.2	228	(% style="color:blue" %)Example(TrackerD):
	229
14.2	230	[[image:image-20230105112836-11.png]]
	231
16.2	232
14.2	233	[[image:image-20230105112836-12.png]]
	234
	235
16.2	236	(% style="color:blue" %)Example(LHT65N):
14.2	237
18.2	238	[[image:image-20230105135558-2.png\|\|height="495" width="1360"]]
14.2	239
16.2	240
14.2	241	[[image:image-20230105112836-14.png]]

Wiki source code of Azure IoT

Applications

Navigation