Atos-Research-and-Innovation · chicco785 · Nov 18, 2022 · Nov 18, 2022 · Nov 18, 2022 · Nov 18, 2022
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 -   Fix wrong docker hub link (#164)
 -   Fix example dummy-sensor script
 -   Fix issue removing a device (#165)
+-   Fix CayenneLpp message support for TTN v3 (#170)
 
 ### Documentation
 

diff --git a/docs/users_manual.md b/docs/users_manual.md
@@ -440,19 +440,48 @@ This script will send a JSON message to the mqtt broker as defined by TTN api, e
 
 ```json
 {
-  "app_id": "demoTTN",
-  "dev_id": "myDevice",
-  "hardware_serial": "0102030405060708",
-  "port": 1,
-  "counter": 2,
-  "is_retry": false,
-  "confirmed": false,
-  "payload_raw": "AHMnSwFnARYCaFADAGQEAQAFAdc=",
+  "end_device_ids": {
+    "device_id": "myDevice",
+    "application_ids": {
+      "application_id": "demoTTN"
+    },
+    "dev_eui": "70B3D57ED00561EC",
+    "join_eui": "8CF957200005727C",
+    "dev_addr": "0102030405060708"
+  },
   ...
+  "received_at": "2022-11-18T10:33:42.184221407Z",
+  "uplink_message": {
+    "session_key_id": "AYSKRe0U59x4b0lMtYqubw==",
+    "f_port": 8,
+    "f_cnt": 46,
+    "frm_payload": "AHMnSwFnARYCaFADAGQEAQAFAdc=",
+    ...
+    "settings": {
+      "data_rate": {
+        "lora": {
+          "bandwidth": 125000,
+          "spreading_factor": 7,
+          "coding_rate": "4/5"
+        }
+      },
+      "frequency": "867900000",
+      "timestamp": 915329612
+    },
+    "received_at": "2022-11-18T10:33:41.976442498Z",
+    "confirmed": true,
+    "consumed_airtime": "0.087296s",
+    "network_ids": {
+      "net_id": "000013",
+      "tenant_id": "ttn",
+      "cluster_id": "eu1",
+      "cluster_address": "eu1.cloud.thethings.network"
+    }
+  }
 }
 ```
 
-The `payload_raw` field contains a base64 encoded version of the binary encoding of the CayenneLPP payload.
+The `frm_payload` field contains a base64 encoded version of the binary encoding of the CayenneLPP payload.
 
 The topic used by TTN v3 API has the following format: `v3/{application_id}/devices/{device_id}/up`.
 

diff --git a/examples/dummy-devices/test-data.sh b/examples/dummy-devices/test-data.sh
@@ -9,7 +9,9 @@ docker exec -ti dummy-devices-mqtt-1 mosquitto_pub -h mqtt -u admin -P password
   "counter": 2,
   "is_retry": false,
   "confirmed": false,
-  "payload_raw": "AHMnSwFnARYCaFADAGQEAQAFAdc="
+  "uplink_message": {
+    "frm_payload": "AHMnSwFnARYCaFADAGQEAQAFAdc="
+  }
 }'
 
 sleep 5

diff --git a/lib/applicationServers/ttnAppService.js b/lib/applicationServers/ttnAppService.js
@@ -129,10 +129,24 @@ class TtnAppService extends appService.AbstractAppService {
 					deviceEui = message.hardware_serial;
 				}
 
-				if (dataModel === 'application_server' && message.payload_fields) {
-					intoTrans(localContext, this.messageHandler)(this, deviceId, deviceEui, message.payload_fields);
-				} else if (message.payload_raw) {
-					intoTrans(localContext, this.messageHandler)(this, deviceId, deviceEui, message.payload_raw);
+				if (
+					dataModel === 'application_server' &&
+					message.uplink_message &&
+					message.uplink_message.decoded_payload
+				) {
+					intoTrans(localContext, this.messageHandler)(
+						this,
+						deviceId,
+						deviceEui,
+						message.uplink_message.decoded_payload
+					);
+				} else if (message.uplink_message && message.uplink_message.frm_payload) {
+					intoTrans(localContext, this.messageHandler)(
+						this,
+						deviceId,
+						deviceEui,
+						message.uplink_message.frm_payload
+					);
 				} else if (message.uplink_message && message.uplink_message.decoded_payload) {
 					intoTrans(localContext, this.messageHandler)(
 						this,

diff --git a/test/activeAttributes/cayenneLpp.json b/test/activeAttributes/cayenneLpp.json
@@ -1 +1,33 @@
-{"app_id":"ari_ioe_app_demo1","dev_id":"lora_n_003","hardware_serial":"3339343771356214","port":99,"counter":243,"payload_raw":"AHMAAAFnARACaAADAGQEAQA=","payload_fields":{"barometric_pressure_0":0,"digital_in_3":100,"digital_out_4":0,"relative_humidity_2":0,"temperature_1":27.2},"metadata":{"time":"2018-04-01T13:43:31.591541572Z","frequency":868.5,"modulation":"LORA","data_rate":"SF12BW125","airtime":1646592000,"coding_rate":"4/5","gateways":[{"gtw_id":"ari_ioe_lab_gateway_3","gtw_trusted":true,"timestamp":2577141228,"time":"2018-04-01T13:48:46Z","channel":2,"rssi":-5,"snr":6.75,"rf_chain":1,"latitude":43.44151,"longitude":-3.859349,"location_source":"registry"}]}}
+{
+  "app_id": "ari_ioe_app_demo1",
+  "dev_id": "lora_n_003",
+  "hardware_serial": "3339343771356214",
+  "port": 99,
+  "counter": 243,
+  "uplink_message": {
+    "frm_payload": "AHMAAAFnARACaAADAGQEAQA="
+  },
+  "metadata": {
+    "time": "2018-04-01T13:43:31.591541572Z",
+    "frequency": 868.5,
+    "modulation": "LORA",
+    "data_rate": "SF12BW125",
+    "airtime": 1646592000,
+    "coding_rate": "4/5",
+    "gateways": [
+      {
+        "gtw_id": "ari_ioe_lab_gateway_3",
+        "gtw_trusted": true,
+        "timestamp": 2577141228,
+        "time": "2018-04-01T13:48:46Z",
+        "channel": 2,
+        "rssi": -5,
+        "snr": 6.75,
+        "rf_chain": 1,
+        "latitude": 43.44151,
+        "longitude": -3.859349,
+        "location_source": "registry"
+      }
+    ]
+  }
+}
diff --git a/test/activeAttributes/cayenneLpp2.json b/test/activeAttributes/cayenneLpp2.json
@@ -1 +1,33 @@
-{"app_id":"ari_ioe_app_demo1","dev_id":"lora_n_001","hardware_serial":"3339344771356214","port":99,"counter":243,"payload_raw":"AWcA1AMAZA==","payload_fields":{"barometric_pressure_0":0,"digital_in_3":100,"digital_out_4":0,"relative_humidity_2":0,"temperature_1":21.2},"metadata":{"time":"2018-04-01T13:43:31.591541572Z","frequency":868.5,"modulation":"LORA","data_rate":"SF12BW125","airtime":1646592000,"coding_rate":"4/5","gateways":[{"gtw_id":"ari_ioe_lab_gateway_3","gtw_trusted":true,"timestamp":2577141228,"time":"2018-04-01T13:48:46Z","channel":2,"rssi":-5,"snr":6.75,"rf_chain":1,"latitude":43.44151,"longitude":-3.859349,"location_source":"registry"}]}}
+{
+  "app_id": "ari_ioe_app_demo1",
+  "dev_id": "lora_n_001",
+  "hardware_serial": "3339344771356214",
+  "port": 99,
+  "counter": 243,
+  "uplink_message": {
+    "frm_payload": "AWcA1AMAZA=="
+  },
+  "metadata": {
+    "time": "2018-04-01T13:43:31.591541572Z",
+    "frequency": 868.5,
+    "modulation": "LORA",
+    "data_rate": "SF12BW125",
+    "airtime": 1646592000,
+    "coding_rate": "4/5",
+    "gateways": [
+      {
+        "gtw_id": "ari_ioe_lab_gateway_3",
+        "gtw_trusted": true,
+        "timestamp": 2577141228,
+        "time": "2018-04-01T13:48:46Z",
+        "channel": 2,
+        "rssi": -5,
+        "snr": 6.75,
+        "rf_chain": 1,
+        "latitude": 43.44151,
+        "longitude": -3.859349,
+        "location_source": "registry"
+      }
+    ]
+  }
+}
diff --git a/test/activeAttributes/cayenneLpp3.json b/test/activeAttributes/cayenneLpp3.json
@@ -1 +1,33 @@
-{"app_id":"ari_ioe_app_demo1","dev_id":"lora_n_001","hardware_serial":"3339344771356214","port":99,"counter":243,"payload_raw":"AWcBGA==","payload_fields":{"barometric_pressure_0":0,"digital_in_3":100,"digital_out_4":0,"relative_humidity_2":0,"temperature_1":21.2},"metadata":{"time":"2018-04-01T13:43:31.591541572Z","frequency":868.5,"modulation":"LORA","data_rate":"SF12BW125","airtime":1646592000,"coding_rate":"4/5","gateways":[{"gtw_id":"ari_ioe_lab_gateway_3","gtw_trusted":true,"timestamp":2577141228,"time":"2018-04-01T13:48:46Z","channel":2,"rssi":-5,"snr":6.75,"rf_chain":1,"latitude":43.44151,"longitude":-3.859349,"location_source":"registry"}]}}
+{
+  "app_id": "ari_ioe_app_demo1",
+  "dev_id": "lora_n_001",
+  "hardware_serial": "3339344771356214",
+  "port": 99,
+  "counter": 243,
+  "uplink_message": {
+    "frm_payload": "AWcBGA=="
+  },
+  "metadata": {
+    "time": "2018-04-01T13:43:31.591541572Z",
+    "frequency": 868.5,
+    "modulation": "LORA",
+    "data_rate": "SF12BW125",
+    "airtime": 1646592000,
+    "coding_rate": "4/5",
+    "gateways": [
+      {
+        "gtw_id": "ari_ioe_lab_gateway_3",
+        "gtw_trusted": true,
+        "timestamp": 2577141228,
+        "time": "2018-04-01T13:48:46Z",
+        "channel": 2,
+        "rssi": -5,
+        "snr": 6.75,
+        "rf_chain": 1,
+        "latitude": 43.44151,
+        "longitude": -3.859349,
+        "location_source": "registry"
+      }
+    ]
+  }
+}
diff --git a/test/activeAttributes/cayenneLpp_bad_raw.json b/test/activeAttributes/cayenneLpp_bad_raw.json
@@ -1 +1,33 @@
-{"app_id":"ari_ioe_app_demo1","dev_id":"lora_n_001","hardware_serial":"3339344771356214","port":99,"counter":243,"payload_raw":"1234","payload_fields":{"barometric_pressure_0":0,"digital_in_3":100,"digital_out_4":0,"relative_humidity_2":0,"temperature_1":21.2},"metadata":{"time":"2018-04-01T13:43:31.591541572Z","frequency":868.5,"modulation":"LORA","data_rate":"SF12BW125","airtime":1646592000,"coding_rate":"4/5","gateways":[{"gtw_id":"ari_ioe_lab_gateway_3","gtw_trusted":true,"timestamp":2577141228,"time":"2018-04-01T13:48:46Z","channel":2,"rssi":-5,"snr":6.75,"rf_chain":1,"latitude":43.44151,"longitude":-3.859349,"location_source":"registry"}]}}
+{
+  "app_id": "ari_ioe_app_demo1",
+  "dev_id": "lora_n_001",
+  "hardware_serial": "3339344771356214",
+  "port": 99,
+  "counter": 243,
+  "uplink_message": {
+    "frm_payload": "1234"
+  },
+  "metadata": {
+    "time": "2018-04-01T13:43:31.591541572Z",
+    "frequency": 868.5,
+    "modulation": "LORA",
+    "data_rate": "SF12BW125",
+    "airtime": 1646592000,
+    "coding_rate": "4/5",
+    "gateways": [
+      {
+        "gtw_id": "ari_ioe_lab_gateway_3",
+        "gtw_trusted": true,
+        "timestamp": 2577141228,
+        "time": "2018-04-01T13:48:46Z",
+        "channel": 2,
+        "rssi": -5,
+        "snr": 6.75,
+        "rf_chain": 1,
+        "latitude": 43.44151,
+        "longitude": -3.859349,
+        "location_source": "registry"
+      }
+    ]
+  }
+}
diff --git a/test/activeAttributes/emptyCbor.json b/test/activeAttributes/emptyCbor.json
@@ -1 +1,34 @@
-{"app_id":"ari_ioe_app_demo1","dev_id":"lora_n_003","hardware_serial":"3339343771356214","port":99,"counter":243,"payload_raw":"","metadata":{"time":"2018-04-01T13:43:31.591541572Z","frequency":868.5,"modulation":"LORA","data_rate":"SF12BW125","airtime":1646592000,"coding_rate":"4/5","gateways":[{"gtw_id":"ari_ioe_lab_gateway_3","gtw_trusted":true,"timestamp":2577141228,"time":"2018-04-01T13:48:46Z","channel":2,"rssi":-5,"snr":6.75,"rf_chain":1,"latitude":43.44151,"longitude":-3.859349,"location_source":"registry"}]}}
+{
+  "app_id": "ari_ioe_app_demo1",
+  "dev_id": "lora_n_003",
+  "hardware_serial": "3339343771356214",
+  "port": 99,
+  "counter": 243,
+  "uplink_message": {
+    "frm_payload": "",
+    "decoded_payload": ""
+  },
+  "metadata": {
+    "time": "2018-04-01T13:43:31.591541572Z",
+    "frequency": 868.5,
+    "modulation": "LORA",
+    "data_rate": "SF12BW125",
+    "airtime": 1646592000,
+    "coding_rate": "4/5",
+    "gateways": [
+      {
+        "gtw_id": "ari_ioe_lab_gateway_3",
+        "gtw_trusted": true,
+        "timestamp": 2577141228,
+        "time": "2018-04-01T13:48:46Z",
+        "channel": 2,
+        "rssi": -5,
+        "snr": 6.75,
+        "rf_chain": 1,
+        "latitude": 43.44151,
+        "longitude": -3.859349,
+        "location_source": "registry"
+      }
+    ]
+  }
+}
diff --git a/test/unit/applicationServerDecoding.js b/test/unit/applicationServerDecoding.js
@@ -165,8 +165,8 @@ describe('CBOR Attributes', function () {
 			};
 
 			const attributesExample = utils.readExampleFile('./test/activeAttributes/emptyCbor.json');
-			attributesExample.payload_raw = null;
-			attributesExample.payload_fields = rawJSONPayload;
+			attributesExample.uplink_message.frm_payload = null;
+			attributesExample.uplink_message.decoded_payload = rawJSONPayload;
 			const client = mqtt.connect('mqtt://' + testMosquittoHost);
 			client.on('connect', function () {
 				client.publish(
@@ -213,7 +213,7 @@ describe('CBOR Attributes', function () {
 			};
 
 			const attributesExample = utils.readExampleFile('./test/activeAttributes/emptyCbor.json');
-			attributesExample.payload_fields = rawJSONPayload;
+			attributesExample.uplink_message.decoded_payload = rawJSONPayload;
 			const client = mqtt.connect('mqtt://' + testMosquittoHost);
 			client.on('connect', function () {
 				client.publish('v3/ari_ioe_app_demo1/devices/lora_n_003/up', JSON.stringify(attributesExample));

diff --git a/test/unit/cborAttributes.js b/test/unit/cborAttributes.js
@@ -167,7 +167,7 @@ describe('CBOR Attributes', function () {
 
 			const encodedBuffer = CBOR.encode(rawJSONPayload);
 			const attributesExample = utils.readExampleFile('./test/activeAttributes/emptyCbor.json');
-			attributesExample.payload_raw = encodedBuffer.toString('base64');
+			attributesExample.uplink_message.frm_payload = encodedBuffer.toString('base64');
 			const client = mqtt.connect('mqtt://' + testMosquittoHost);
 			client.on('connect', function () {
 				client.publish(
@@ -215,7 +215,7 @@ describe('CBOR Attributes', function () {
 
 			const encodedBuffer = CBOR.encode(rawJSONPayload);
 			const attributesExample = utils.readExampleFile('./test/activeAttributes/emptyCbor.json');
-			attributesExample.payload_raw = encodedBuffer.toString('base64');
+			attributesExample.uplink_message.frm_payload = encodedBuffer.toString('base64');
 			const client = mqtt.connect('mqtt://' + testMosquittoHost);
 			client.on('connect', function () {
 				client.publish('v3/ari_ioe_app_demo1/devices/lora_n_003/up', JSON.stringify(attributesExample));
@@ -238,7 +238,7 @@ describe('CBOR Attributes', function () {
 	describe('Active attributes are reported with incorrect format', function () {
 		it('Should process correctly active attributes', function (done) {
 			const attributesExample = utils.readExampleFile('./test/activeAttributes/emptyCbor.json');
-			attributesExample.payload_raw = 'no_cbor_payload';
+			attributesExample.uplink_message.frm_payload = 'no_cbor_payload';
 			const client = mqtt.connect('mqtt://' + testMosquittoHost);
 			client.on('connect', function () {
 				client.publish('v3/ari_ioe_app_demo1/devices/lora_n_003/up', JSON.stringify(attributesExample));

diff --git a/test/unit/groupProvisioningTTN.js b/test/unit/groupProvisioningTTN.js
@@ -468,7 +468,7 @@ describe('Configuration provisioning API: Provision groups (TTN)', function () {
 
 			const encodedBuffer = CBOR.encode(rawJSONPayload);
 			const attributesExample = utils.readExampleFile('./test/activeAttributes/emptyCbor.json');
-			attributesExample.payload_raw = encodedBuffer.toString('base64');
+			attributesExample.uplink_message.frm_payload = encodedBuffer.toString('base64');
 			attributesExample.dev_id = devId;
 			const client = mqtt.connect('mqtt://' + testMosquittoHost);
 			client.on('connect', function () {

diff --git a/test/unit/multientityPlugin.js b/test/unit/multientityPlugin.js
@@ -205,7 +205,7 @@ describe('Multientity plugin', function () {
 
 			const encodedBuffer = CBOR.encode(rawJSONPayload);
 			const attributesExample = utils.readExampleFile('./test/activeAttributes/emptyCbor.json');
-			attributesExample.payload_raw = encodedBuffer.toString('base64');
+			attributesExample.uplink_message.frm_payload = encodedBuffer.toString('base64');
 			const client = mqtt.connect('mqtt://' + testMosquittoHost);
 			client.on('connect', function () {
 				client.publish(