Stand with Ukraine flag
Try it now Pricing
Community Edition
How to connect Indoor Bluetooth Gateway to ThingsBoard?
Getting Started Documentation Devices Library Guides Installation Architecture API FAQ
On this page

How to connect Indoor Bluetooth Gateway to ThingsBoard?

Indoor Bluetooth Gateway Indoor Bluetooth Gateway is based on Bluetooth 5.0 technology and LoRaWAN.
It receives nearby Bluetooth beacon messages and transmits them to the server through LoRaWAN. With LoRaWAN technology, there is no network usage fee for long-distance transmission.

Prerequisites

To continue with this guide we will need the following:

Configuration

Only ThingsBoard Cloud works when using direct communication from this device to ThingsBoard via MQTT.

You may use ThingsBoard PE on-premises or ThingsBoard Cloud when using ThingsBoard Integrations.

To create an integration with a network server please choose first one of the supported network servers:

Add a gateway on the Chirpstack

We need to add a gateway on the Chirpstack.

To add a gateway, follow next steps:

  • Login to Chirpstack server. Go to the “Gateways” page and click on the “Add gateway” button.

  • Fill name, Gateway ID (It will be different, you can find it on the gateway control panel) with your data, scroll down and click on the “Submit” button.

  • The gateway is added. In gateways tab you can see its status.

Add device profile on the Chirpstack

  • Login to Chirpstack server. Go to the “Device profiles” page and click on Add device profile button.

  • Fill in the required fields.

  • Go to the Codec tab, select JavaScript functions from the Payload codec dropdown menu, and paste the decoder function. Then click the Submit button.

Decode function:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
// Decode uplink function.
//
// Input is an object with the following fields:
// - bytes = Byte array containing the uplink payload, e.g. [255, 230, 255, 0]
// - fPort = Uplink fPort.
// - variables = Object containing the configured device variables.
//
// Output must be an object with the following fields:
// - data = Object representing the decoded payload.
// Indoor Bluetooth Gateway decoder
function decodeUplink(input) {
// bytes
    var bytes = input.bytes;
// type
    var uplinkType = (bytes[0] >> 4) & 0x0f;
    switch (uplinkType) {
        case 0x01:
            return {data: decodeRegistration(bytes)};
        case 0x02:
            return {data: decodeHeartbeat(bytes)};
        case 0x03:
            return {data: decodeDeviceReportRule(bytes)};
        case 0x05:
            return {data: decodeWaterLevelDetection(bytes)};
        case 0x08:
            return {data: decodeDeviceType1(bytes)};
        case 0x09:
            return {data: decodeDeviceType2(bytes)};
        case 0x0a:
            return {data: decodeDeviceType3(bytes)};
        case 0x0e:
            return {data: decodeMultiDeviceTypeMessage(bytes)};
        case 0x0f:
            return {data: decodeAcknowledgment(bytes)};
        default:
            return null;
    }
}

// type: 0x1 Registration
function decodeRegistration(bytes) {
    var data = {};
    data.type = "Registration";
// adr
    data.adr = ((bytes[0] >> 3) & 0x1) == 0 ? "OFF" : "ON";
// mode
    data.mode = bytes[0] & 0x07;
// loRaWANBand
    var loRaWANBandValue = bytes[1];
    if (loRaWANBandValue == 0x00) {
        data.loRaWANBand = "KR920";
    } else if (loRaWANBandValue == 0x01) {
        data.loRaWANBand = "AU915";
    } else if (loRaWANBandValue == 0x04) {
        data.loRaWANBand = "CN470";
    } else if (loRaWANBandValue == 0x08) {
        data.loRaWANBand = "AS923";
    } else if (loRaWANBandValue == 0x10) {
        data.loRaWANBand = "EU433";
    } else if (loRaWANBandValue == 0x20) {
        data.loRaWANBand = "EU868";
    } else if (loRaWANBandValue == 0x40) {
        data.loRaWANBand = "US915";
    }// power
    data.power = ((bytes[2] >> 3) & 0x1f) + "dBm";
// continuousBleReceiveEnable
    data.continuousBleReceiveEnable =
        ((bytes[2] >> 1) & 0x1) == 0 ? "Disable" : "Enable";
// dr
    data.dr = (bytes[3] >> 4) & 0x0f;
// positionReportInterval
    data.positionReportInterval =
        (((bytes[4] << 8) & 0xff00) | (bytes[5] & 0xff)) * 5 + "s";
// heartbeatInterval
    data.heartbeatInterval = bytes[6] * 30 + "s";
// bleReceivingDuration
    data.bleReceivingDuration = bytes[7] + "s";
// networkReconnectionInterval
    data.networkReconnectionInterval = bytes[8] * 5 + "min";
    return data;
}

// type: 0x2 Heartbeat
function decodeHeartbeat(bytes) {
    var data = {};
// type
    data.type = "Heartbeat";
// battery
    var batteryValue = bytes[1];
    if (batteryValue > 100) {
        data.battery = bytes[1] / 100 + 1.5 + "V";
    } else {
        data.battery = bytes[1] + "%";
    }
// rssi
    data.rssi = bytes[2] * -1 + "dBm";
// snr
    data.snr = (((bytes[3] << 8) & 0xff00) | (bytes[4] & 0xff)) / 100 + "dB";
// version
    data.version = ((bytes[5] << 8) & 0xff00) | (bytes[6] & 0xff);
// chargeState
    var chargeStateValue = bytes[7] & 0xff;
    if (chargeStateValue == 0x00) {
        data.chargeState = "Not charging";
    } else if (chargeStateValue == 0x50) {
        data.chargeState = "Charging";
    } else if (chargeStateValue == 0x60) {
        data.chargeState = "Charging completed";
    }
    return data;
}

// type: 0x3 DeviceReportRule
function decodeDeviceReportRule(bytes) {
    var data = {};
    data.type = "DeviceReportRule";
    data.deviceTypeQuantity = bytes[1] & 0xff;
    data.deviceTypeId = (bytes[2] >> 4) & 0x0f;
    data.filterAndDataBlockQuantity = bytes[2] & 0x0f;
    var filterBlock = [];
    var dataBlock = [];
    var macBlock = [];
    var index = 3;
    for (let i = 0; i < data.filterAndDataBlockQuantity; i++) {
        var ruleType = bytes[index++] & 0xff;
        var startAddress = bytes[index++] & 0xff;
        var endAddress = bytes[index++] & 0xff;
        var filter = {};
        if (ruleType == 1) {
            filter.ruleType = "FilterBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            var len = endAddress - startAddress;
            var filterValue = "";
            for (let j = 0; j < len + 1; j++) {
                filterValue += byteToHex(bytes[index + j]);
            }
            filter.value = filterValue;
            index = index + (endAddress - startAddress + 1);
            filterBlock.push(filter);
        } else if (ruleType == 2) {
            filter.ruleType = "DataBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            dataBlock.push(filter);
        } else if (ruleType == 3) {
            filter.ruleType = "MACBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            macBlock.push(filter);
        }
    }
    data.filterBlock = filterBlock;
    data.dataBlock = dataBlock;
    data.macBlock = macBlock;
    return data;
}

// type: 0x5 WaterLevelDetection
function decodeWaterLevelDetection(bytes) {
    var data = {};
// type
    data.type = "WaterLevelDetection";
    data.waterLevel = (((bytes[1] << 8) & 0xff00) | (bytes[2] & 0xff)) +
        "mm";
    return data;
}

// type: 0x8 DeviceType1
function decodeDeviceType1(bytes) {
    var data = {
        type: "DeviceType1",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0x9 DeviceType2
function decodeDeviceType2(bytes) {
    var data = {
        type: "DeviceType2",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0xa DeviceType3
function decodeDeviceType3(bytes) {
    var data = {
        type: "DeviceType3",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1]).toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0xe MultiDeviceTypeMessage
function decodeMultiDeviceTypeMessage(bytes) {
    var data = {
        type: "MultiDeviceTypeMessage",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var index = 1 + 6 * i;
        var deviceTypeId = bytes[index];
        var major = ((bytes[index + 1] << 8) | bytes[index + 2])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 3] << 8) | bytes[index + 4])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 5] - 256 + "dBm";
        data["deviceTypeId" + (i + 1)] = deviceTypeId;
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 6;
    }
    return data;
}

// type: 0xf Acknowledgment
function decodeAcknowledgment(bytes) {
    var data = {};
    data.type = "Acknowledgment";
    data.result = (bytes[0] & 0x0f) == 0 ? "Success" : "Failure";
    data.msgId = (bytes[1] & 0xff).toString(16).toUpperCase();
    return data;
}

function byteToHex(str) {
    return str.toString(16).toUpperCase().padStart(2, "0");
}

Add a device on the Chirpstack

  • Go to the Applications page and click on Add application button.

  • Enter name and click Submit button.

  • Click Add device.

  • Fill in the required fields with your device information and specify the previously created device profile.

  • Go to the Variables tab, enter the value for ThingsBoardAccessToken, and click the Submit button.

  • Put your Application key to the field and click on Submit button to save the device.

Configure application integration with ThingsBoard

  • Go to the Integrations page, find and select the ThingsBoard.

  • Enter the URL of your ThingsBoard server and click Submit button.

Create device on ThingsBoard

  • Go to the Devices page.

  • Click on Add device button.

  • Fill in the device name and click the Next: Credentials button.

  • Enter the device Access token (previously copied Device EUI value) and click the Add button.

  • Click on the device to open device information window.

  • Go to the Latest telemetry tab to view device reported data.

Add a gateway on The Things Stack Community Edition

We need to add a gateway on The Things Stack Community Edition.

To add a gateway, you can follow next steps:

  • Login to the cloud and open your console.

  • Go to the Home page press the “Register gateway” button.

  • Put information about the gateway (gateway EUI) and click the “Register gateway“button.

  • The gateway is added. You can see its status - disconnected.

Add a device on The Things Stack Community Edition

We need to add a device on The Things Stack Community Edition.

To add a device, you can follow next steps:

  • Go to the Applications page. Then select your application and click on its name.

  • Click on the Register end device button.

  • Put the APP EUI value to the JoinEUI field. Then, press the Confirm button.

  • Fill the rest parameters and press Register end device button.

Configure Payload Formatter

Go to the Payload formatters page and select Custom Javascript formatter for Formatter type. Paste the decode function and click Save changes button.

Decode function:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
// Decode uplink function.
//
// Input is an object with the following fields:
// - bytes = Byte array containing the uplink payload, e.g. [255, 230, 255, 0]
// - fPort = Uplink fPort.
// - variables = Object containing the configured device variables.
//
// Output must be an object with the following fields:
// - data = Object representing the decoded payload.
// Indoor Bluetooth Gateway decoder
function decodeUplink(input) {
// bytes
    var bytes = input.bytes;
// type
    var uplinkType = (bytes[0] >> 4) & 0x0f;
    switch (uplinkType) {
        case 0x01:
            return {data: decodeRegistration(bytes)};
        case 0x02:
            return {data: decodeHeartbeat(bytes)};
        case 0x03:
            return {data: decodeDeviceReportRule(bytes)};
        case 0x05:
            return {data: decodeWaterLevelDetection(bytes)};
        case 0x08:
            return {data: decodeDeviceType1(bytes)};
        case 0x09:
            return {data: decodeDeviceType2(bytes)};
        case 0x0a:
            return {data: decodeDeviceType3(bytes)};
        case 0x0e:
            return {data: decodeMultiDeviceTypeMessage(bytes)};
        case 0x0f:
            return {data: decodeAcknowledgment(bytes)};
        default:
            return null;
    }
}

// type: 0x1 Registration
function decodeRegistration(bytes) {
    var data = {};
    data.type = "Registration";
// adr
    data.adr = ((bytes[0] >> 3) & 0x1) == 0 ? "OFF" : "ON";
// mode
    data.mode = bytes[0] & 0x07;
// loRaWANBand
    var loRaWANBandValue = bytes[1];
    if (loRaWANBandValue == 0x00) {
        data.loRaWANBand = "KR920";
    } else if (loRaWANBandValue == 0x01) {
        data.loRaWANBand = "AU915";
    } else if (loRaWANBandValue == 0x04) {
        data.loRaWANBand = "CN470";
    } else if (loRaWANBandValue == 0x08) {
        data.loRaWANBand = "AS923";
    } else if (loRaWANBandValue == 0x10) {
        data.loRaWANBand = "EU433";
    } else if (loRaWANBandValue == 0x20) {
        data.loRaWANBand = "EU868";
    } else if (loRaWANBandValue == 0x40) {
        data.loRaWANBand = "US915";
    }
// power
    data.power = ((bytes[2] >> 3) & 0x1f) + "dBm";
// continuousBleReceiveEnable
    data.continuousBleReceiveEnable =
        ((bytes[2] >> 1) & 0x1) == 0 ? "Disable" : "Enable";
// dr
    data.dr = (bytes[3] >> 4) & 0x0f;
// positionReportInterval
    data.positionReportInterval =
        (((bytes[4] << 8) & 0xff00) | (bytes[5] & 0xff)) * 5 + "s";
// heartbeatInterval
    data.heartbeatInterval = bytes[6] * 30 + "s";
// bleReceivingDuration
    data.bleReceivingDuration = bytes[7] + "s";// networkReconnectionInterval
    data.networkReconnectionInterval = bytes[8] * 5 + "min";
    return data;
}

// type: 0x2 Heartbeat
function decodeHeartbeat(bytes) {
    var data = {};
// type
    data.type = "Heartbeat";
// battery
    var batteryValue = bytes[1];
    if (batteryValue > 100) {
        data.battery = bytes[1] / 100 + 1.5 + "V";
    } else {
        data.battery = bytes[1] + "%";
    }
// rssi
    data.rssi = bytes[2] * -1 + "dBm";
// snr
    data.snr = (((bytes[3] << 8) & 0xff00) | (bytes[4] & 0xff)) / 100 + "dB";
// version
    data.version = ((bytes[5] << 8) & 0xff00) | (bytes[6] & 0xff);
// chargeState
    var chargeStateValue = bytes[7] & 0xff;
    if (chargeStateValue == 0x00) {
        data.chargeState = "Not charging";
    } else if (chargeStateValue == 0x50) {
        data.chargeState = "Charging";
    } else if (chargeStateValue == 0x60) {
        data.chargeState = "Charging completed";
    }
    return data;
}

// type: 0x3 DeviceReportRule
function decodeDeviceReportRule(bytes) {
    var data = {};
    data.type = "DeviceReportRule";
    data.deviceTypeQuantity = bytes[1] & 0xff;
    data.deviceTypeId = (bytes[2] >> 4) & 0x0f;
    data.filterAndDataBlockQuantity = bytes[2] & 0x0f;
    var filterBlock = [];
    var dataBlock = [];
    var macBlock = [];
    var index = 3;
    for (let i = 0; i < data.filterAndDataBlockQuantity; i++) {
        var ruleType = bytes[index++] & 0xff;
        var startAddress = bytes[index++] & 0xff;
        var endAddress = bytes[index++] & 0xff;
        var filter = {};
        if (ruleType == 1) {
            filter.ruleType = "FilterBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            var len = endAddress - startAddress;
            var filterValue = "";
            for (let j = 0; j < len + 1; j++) {
                filterValue += byteToHex(bytes[index + j]);
            }
            filter.value = filterValue;
            index = index + (endAddress - startAddress + 1);
            filterBlock.push(filter);
        } else if (ruleType == 2) {
            filter.ruleType = "DataBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            dataBlock.push(filter);
        } else if (ruleType == 3) {
            filter.ruleType = "MACBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            macBlock.push(filter);
        }
    }
    data.filterBlock = filterBlock;
    data.dataBlock = dataBlock;
    data.macBlock = macBlock;
    return data;
}

// type: 0x5 WaterLevelDetection
function decodeWaterLevelDetection(bytes) {
    var data = {};
// type
    data.type = "WaterLevelDetection";
    data.waterLevel = (((bytes[1] << 8) & 0xff00) | (bytes[2] & 0xff)) + "mm";
    return data;
}

// type: 0x8 DeviceType1
function decodeDeviceType1(bytes) {
    var data = {
        type: "DeviceType1",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0x9 DeviceType2
function decodeDeviceType2(bytes) {
    var data = {
        type: "DeviceType2",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0xa DeviceType3
function decodeDeviceType3(bytes) {
    var data = {
        type: "DeviceType3",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0xe MultiDeviceTypeMessage
function decodeMultiDeviceTypeMessage(bytes) {
    var data = {
        type: "MultiDeviceTypeMessage",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var index = 1 + 6 * i;
        var deviceTypeId = bytes[index];
        var major = ((bytes[index + 1] << 8) | bytes[index + 2])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 3] << 8) | bytes[index + 4])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 5] - 256 + "dBm";
        data["deviceTypeId" + (i + 1)] = deviceTypeId;
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 6;
    }
    return data;
}

// type: 0xf Acknowledgment
function decodeAcknowledgment(bytes) {
    var data = {};
    data.type = "Acknowledgment";
    data.result = (bytes[0] & 0x0f) == 0 ? "Success" : "Failure";
    data.msgId = (bytes[1] & 0xff).toString(16).toUpperCase();
    return data;
}

function byteToHex(str) {
    return str.toString(16).toUpperCase().padStart(2, "0");
}

Create integration in ThingsBoard

Next we will create “The Things Stack” (TTS) integration inside the ThingsBoard.

At first, copy the code, we will need it to create the uplink converter:

1
2
3
4
5
6
7
8
9
10
11
var data = decodeToJson(payload);
var deviceName = data.end_device_ids.device_id;
var deviceType = data.end_device_ids.application_ids.application_id;

var result = {
  deviceName: deviceName,
  deviceType: deviceType,
  telemetry: data.uplink_message.decoded_payload
};

return result;

In the “Connect“step, you will need the following parameters:

  • Region: eu1 (region where your application was registered inside The Things Stack Community)
  • Username: thingsboard-application-2025-06@ttn (use Username from integration on TTS)
  • Password: use Password from integration on The Things Stack Community

Now, navigate to the “Integrations” page under the “Integrations center” section and follow this steps:

  • Click “plus” icon in the upper right corner to add new integration. Select type “The Things Stack Community”. Then, click “Next” button.

  • Paste the previously copied script to the Decoder function section. Click “Next” button.

  • Leave the “Downlink data converter” field empty. Click on “Skip” button.

  • Next, fill in the fields with your parameters. After, press “Add” button.

Add a gateway on The Things Industries

We need to add a gateway on The Things Industries cloud.

To add a gateway, you can follow next steps:

  • Login to the cloud and open your console.

  • Go to the Home page press the “Register gateway” button.

  • Put information about the gateway (gateway EUI) and click the “Register gateway“button.

  • The gateway is added. You can see its status - disconnected.

Add a device on The Things Industries

We need to add a device on The Things Industries cloud.

To add a device, you can follow next steps:

  • Go to the Applications page. Then select your application and click on its name.

  • Click on the Register end device button.

  • Put the APP EUI value to the JoinEUI field. Then, press the Confirm button.

  • Fill the rest parameters and press Register end device button.

Configure Payload Formatter

Go to the Payload formatters page and select Custom JavaScript formatter as the Formatter type. Paste the decode function into the editor and click the Save changes button.

Decode function:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
// Decode uplink function.
//
// Input is an object with the following fields:
// - bytes = Byte array containing the uplink payload, e.g. [255, 230, 255, 0]
// - fPort = Uplink fPort.
// - variables = Object containing the configured device variables.
//
// Output must be an object with the following fields:
// - data = Object representing the decoded payload.
// Indoor Bluetooth Gateway decoder
function decodeUplink(input) {
// bytes
    var bytes = input.bytes;
// type
    var uplinkType = (bytes[0] >> 4) & 0x0f;
    switch (uplinkType) {
        case 0x01:
            return {data: decodeRegistration(bytes)};
        case 0x02:
            return {data: decodeHeartbeat(bytes)};
        case 0x03:
            return {data: decodeDeviceReportRule(bytes)};
        case 0x05:
            return {data: decodeWaterLevelDetection(bytes)};
        case 0x08:
            return {data: decodeDeviceType1(bytes)};
        case 0x09:
            return {data: decodeDeviceType2(bytes)};
        case 0x0a:
            return {data: decodeDeviceType3(bytes)};
        case 0x0e:
            return {data: decodeMultiDeviceTypeMessage(bytes)};
        case 0x0f:
            return {data: decodeAcknowledgment(bytes)};
        default:
            return null;
    }
}

// type: 0x1 Registration
function decodeRegistration(bytes) {
    var data = {};
    data.type = "Registration";
// adr
    data.adr = ((bytes[0] >> 3) & 0x1) == 0 ? "OFF" : "ON";
// mode
    data.mode = bytes[0] & 0x07;
// loRaWANBand
    var loRaWANBandValue = bytes[1];
    if (loRaWANBandValue == 0x00) {
        data.loRaWANBand = "KR920";
    } else if (loRaWANBandValue == 0x01) {
        data.loRaWANBand = "AU915";
    } else if (loRaWANBandValue == 0x04) {
        data.loRaWANBand = "CN470";
    } else if (loRaWANBandValue == 0x08) {
        data.loRaWANBand = "AS923";
    } else if (loRaWANBandValue == 0x10) {
        data.loRaWANBand = "EU433";
    } else if (loRaWANBandValue == 0x20) {
        data.loRaWANBand = "EU868";
    } else if (loRaWANBandValue == 0x40) {
        data.loRaWANBand = "US915";
    }
// power
    data.power = ((bytes[2] >> 3) & 0x1f) + "dBm";
// continuousBleReceiveEnable
    data.continuousBleReceiveEnable =
        ((bytes[2] >> 1) & 0x1) == 0 ? "Disable" : "Enable";
// dr
    data.dr = (bytes[3] >> 4) & 0x0f;
// positionReportInterval
    data.positionReportInterval =
        (((bytes[4] << 8) & 0xff00) | (bytes[5] & 0xff)) * 5 + "s";
// heartbeatInterval
    data.heartbeatInterval = bytes[6] * 30 + "s";
// bleReceivingDuration
    data.bleReceivingDuration = bytes[7] + "s";
// networkReconnectionIntervaldata.networkReconnectionInterval = bytes[8] * 5 + "min";
    return data;
}

// type: 0x2 Heartbeat
function decodeHeartbeat(bytes) {
    var data = {};
// type
    data.type = "Heartbeat";
// battery
    var batteryValue = bytes[1];
    if (batteryValue > 100) {
        data.battery = bytes[1] / 100 + 1.5 + "V";
    } else {
        data.battery = bytes[1] + "%";
    }
// rssi
    data.rssi = bytes[2] * -1 + "dBm";
// snr
    data.snr = (((bytes[3] << 8) & 0xff00) | (bytes[4] & 0xff)) / 100 + "dB";
// version
    data.version = ((bytes[5] << 8) & 0xff00) | (bytes[6] & 0xff);
// chargeState
    var chargeStateValue = bytes[7] & 0xff;
    if (chargeStateValue == 0x00) {
        data.chargeState = "Not charging";
    } else if (chargeStateValue == 0x50) {
        data.chargeState = "Charging";
    } else if (chargeStateValue == 0x60) {
        data.chargeState = "Charging completed";
    }
    return data;
}

// type: 0x3 DeviceReportRule
function decodeDeviceReportRule(bytes) {
    var data = {};
    data.type = "DeviceReportRule";
    data.deviceTypeQuantity = bytes[1] & 0xff;
    data.deviceTypeId = (bytes[2] >> 4) & 0x0f;
    data.filterAndDataBlockQuantity = bytes[2] & 0x0f;
    var filterBlock = [];
    var dataBlock = [];
    var macBlock = [];
    var index = 3;
    for (let i = 0; i < data.filterAndDataBlockQuantity; i++) {
        var ruleType = bytes[index++] & 0xff;
        var startAddress = bytes[index++] & 0xff;
        var endAddress = bytes[index++] & 0xff;
        var filter = {};
        if (ruleType == 1) {
            filter.ruleType = "FilterBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            var len = endAddress - startAddress;
            var filterValue = "";
            for (let j = 0; j < len + 1; j++) {
                filterValue += byteToHex(bytes[index + j]);
            }
            filter.value = filterValue;
            index = index + (endAddress - startAddress + 1);
            filterBlock.push(filter);
        } else if (ruleType == 2) {
            filter.ruleType = "DataBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            dataBlock.push(filter);
        } else if (ruleType == 3) {
            filter.ruleType = "MACBlock";
            filter.startAddress = byteToHex(startAddress);
            filter.endAddress = byteToHex(endAddress);
            macBlock.push(filter);
        }
    }
    data.filterBlock = filterBlock;
    data.dataBlock = dataBlock;
    data.macBlock = macBlock;
    return data;
}

// type: 0x5 WaterLevelDetection
function decodeWaterLevelDetection(bytes) {
    var data = {};
// type
    data.type = "WaterLevelDetection";
    data.waterLevel = (((bytes[1] << 8) & 0xff00) | (bytes[2] & 0xff)) + "mm";
    return data;
}

// type: 0x8 DeviceType1
function decodeDeviceType1(bytes) {
    var data = {
        type: "DeviceType1",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0x9 DeviceType2
function decodeDeviceType2(bytes) {
    var data = {
        type: "DeviceType2",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0xa DeviceType3
function decodeDeviceType3(bytes) {
    var data = {
        type: "DeviceType3",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var major = ((bytes[index] << 8) | bytes[index + 1])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 2] << 8) | bytes[index + 3])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 4] - 256 + "dBm";
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 5;
    }
    return data;
}

// type: 0xe MultiDeviceTypeMessage
function decodeMultiDeviceTypeMessage(bytes) {
    var data = {
        type: "MultiDeviceTypeMessage",
        number: bytes[0] & 0x0f,
    };
    var index = 1;
    for (let i = 0; i < data.number; i++) {
        var index = 1 + 6 * i;
        var deviceTypeId = bytes[index];
        var major = ((bytes[index + 1] << 8) | bytes[index + 2])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var minor = ((bytes[index + 3] << 8) | bytes[index + 4])
            .toString(16)
            .toUpperCase()
            .padStart(4, "0");
        var rssi = bytes[index + 5] - 256 + "dBm";
        data["deviceTypeId" + (i + 1)] = deviceTypeId;
        data["beacon" + (i + 1)] = major + minor;
        data["rssi" + (i + 1)] = rssi;
        index = index + 6;
    }
    return data;
}

// type: 0xf Acknowledgment
function decodeAcknowledgment(bytes) {
    var data = {};
    data.type = "Acknowledgment";
    data.result = (bytes[0] & 0x0f) == 0 ? "Success" : "Failure";
    data.msgId = (bytes[1] & 0xff).toString(16).toUpperCase();
    return data;
}

function byteToHex(str) {
    return str.toString(16).toUpperCase().padStart(2, "0");
}

Create integration in ThingsBoard

Next, we will create the “TheThingsIndustries” integration inside the ThingsBoard.

At first, copy the code, we will need it to create the uplink converter:

1
2
3
4
5
6
7
8
9
10
11
var data = decodeToJson(payload);
var deviceName = data.end_device_ids.device_id;
var deviceType = data.end_device_ids.application_ids.application_id;

var result = {
  deviceName: deviceName,
  deviceType: deviceType,
  telemetry: data.uplink_message.decoded_payload
};

return result;

In the “Connect“step, you will need the following parameters:

  • Region: eu1 (region where your application was registered inside The Things Industries Console);
  • Username: thingsboard-application-2025-05@lansitec-testplan (use Username from integration on The Things Stack Industries);
  • Password: use Password from integration on The Things Industries.

Now, navigate to the “Integrations” page under the “Integrations center” section and follow this steps:

  • Click “plus“icon in the upper right corner to add new integration. Select type “The Things Industries Integration”. Then, click “Next” button.

  • Paste the previously copied script to the Decoder function section. Click “Next” button.

  • Leave the “Downlink data converter“field empty. Click on “Skip“button.

  • Next, fill in the fields with your parameters. After, press “Add” button.

Add a gateway on the Loriot

We need to add a gateway on the Loriot.

To add a gateway, you can follow next steps:

  • Login to Loriot server. Open the “Sample network” or create a new one in the “Networks” section.

  • Click on the “Add Gateway” button.

  • Scroll down and select “MultiTech Conduit AEP”.

  • Scroll up and put information about the gateway MAC Address (Just remove FFFF or FFFE in the middle of gateway EUI) into eth0 MAC address and gateway EUI to Custom EUI field.

  • The gateway is added. You can see its status - disconnected.

Add a device on the Loriot

We need to add a device on the Loriot.

To add a device, you can follow next steps:

  • Login to Loriot server. We use eu2.loriot.io, but it depends on chosen region during registration.

  • Go to the “Applications” page in left menu.

  • Open your application, in our case it is “SampleApp”.

  • Go to the “Enroll Device” page. Fill in the fields, with a configuration from your device. Then click the “Enroll” button.

Create integration in ThingsBoard

Next we will create an integration with Loriot inside the ThingsBoard.

At first, copy the code, we will need it to create the uplink converter:

1
2
3
4
5
6
7
8
9
10
11
var data = decodeToJson(payload);
var deviceName = data.end_device_ids.device_id;
var deviceType = data.end_device_ids.application_ids.application_id;

var result = {
  deviceName: deviceName,
  deviceType: deviceType,
  telemetry: data.uplink_message.decoded_payload
};

return result;

Now, navigate to the “Integrations” page under the “Integrations center” section and follow this steps:

  • Click “plus” icon button in the upper right corner to add new integration. Select type “Loriot”. Then, click “Next” button.

  • Paste the previously copied script to the Decoder function section. Click “Next” button.

  • Leave the “Downlink data converter” field empty. Click on “Skip“button.

  • Next, fill in the fields with your parameters. After, press “Add” button.

Check data on ThingsBoard

So, the device was added and if it sends any data - it should appear in the devices. To check it you may open Devices page in Entities section. The device should be in devices list. You can check the data by click on it and open tab Attributes or Latest telemetry.

In order to get more user-friendly view - you can use dashboards. You can download a simple dashboard for this device, it is configured to display a data from “latitude” and “longitude” telemetry keys for device with name “Devices”.

ThingsBoard provides the ability to create and customize interactive visualizations (dashboards) for monitoring and managing data and devices. Through ThingsBoard dashboards, you can efficiently manage and monitor your IoT devices and data. So, we will create the dashboard, for our device.

To add the dashboard to ThingsBoard, we need to import it. To import a dashboard, follow these steps:

  • Navigate to the “Dashboards” page. By default, you navigate to the dashboard group “All”. Click on the “plus” icon in the top right corner. Select “Import dashboard”.

  • In the dashboard import window, upload the JSON file and click “Import” button.

  • Dashboard has been imported.

To open the imported dashboard, click on it. Then you should specify your device in entity alias of the dashboard.

To do this, follow these steps:

  • Open the dashboard and enter edit mode. Click the “Entity aliases” icon, then in the pop-up window click the “Edit alias” icon next to the alias.

  • In edit alias window select your device from dropdown list and save entity alias.

  • Apply all changes.

You should now see data from the device.

Example of the dashboard with data:

Conclusion

With the knowledge outlined in this guide, you can easily connect your Asset Management Tracker and send data to ThingsBoard.

Explore the platform documentation to learn more about key concepts and features. For example, configure alarm rules or dashboards.