Device ID and Payload Mapping in Downlink

1. The MQTT device is pre-provisioned with Manufacturer and Model of the device.
2. Script files are uploaded that support the free format topic and mapping.
   Note: Script has encode and decode function. For more information, refer to Scripting examples.
3. The device SUBSCRIBE to topic devices/11223344/messages/devicebound/PackageSize

   The topic devices/11223344/messages/devicebound/PackageSize is mapped to Resource /topics/0/PkgSize.

4. The Application initiates the following downlink request:

   /m2m/endpoints/112223344/messages/devicebound/PackageSize

5. IMPACT performs PUBLISH:

   devices/112223344/messages/devicebound/PackageSize

6. The Device receives the PUBLISH request and respond back with the PackageSize:

   device/device01/response
   {"correlatorId":"f4e45596-a481-4b1b-8f45-57985c89b4e9","type":"read","topic":"messages/devicebound/PackageSize=1024v"}

7. The Application receives notification response:

   {"reports":[],
   "registrations":[],
   "deregistrations":[],
   "updates":[],
   "expirations":[],
   "responses":[{"serialNumber":"11223344",
   "timestamp":1644821094851,
   "requestId":"9f14586c-5027-4045-b162-ce52a92c9987",
   "protocol":"MQTT",
   "resources":[{"resourcePath":"messages/devicebound/PackageSize",
   "value":1024v{color}}],
   "result":{"code":0,"subCode":null,
   "reason":"Success"},
   "operationType":"read"}]}

1. In the Devices > View Device page, pre-provision the device with the Manufacturer as Generic and the Model as Sensor.
2. Configure the corresponding script files for the Make and Model in Settings > Protocol Setups page.
   Note: Script has encode and decode function. For more information refer to Scripting examples.
3. The read resource request is sent to the device using the action created in the View Device > Operations page.

   Example: In the action, Sensor/0/temperature is the topic that will be converted to the topic which is subscribed by the device. The topic subscribed is devices/mqttDevice11/sensor/0/temperature.

   On sending the action, the payload is received on the device.

4. The device initiates the PUBLISH.
5. If the job is successful, click on the Job Name in the View Device > Jobs page to view the request and the response sent by the device.

   In the example, request sent is "sensor/0/temperature" and the response received is "{"sensor/0/temperature" :"25"}"

1. In the Devices > View Device page, pre-provision the device with Manufacturer as Generic and Model as Sensor.
2. Configure the corresponding script for the Make and Model in Settings > Protocol Setups page.

   Script file supports the free format topic and mapping. The script has encode and decode functions. For more information on these functions, see Scripting examples.

3. Write resource request is sent to the device using the action created in the View Device > Operations page.

   Example: In the action, Sensor/0/temperature is the topic that will be converted to the topic which is subscribed by the device. The topic subscribed is devices/mqttDevice10/sensor/0/temperature.

   On sending the action, the payload is received on the device.

4. The device initiates the PUBLISH.
5. If the job is successful, click on the Job Name in the View Device > Jobs page to view the request and the response sent by the device.

   In the example, request sent is "sensor/0/temperature" and the response received is "{"sensor/0/temperature" :"25"}"

var utils = Java.type('com.nokia.adapter.transformation.utils.TranformerUtil');

function DownlinkRequestCodec() {
	
	const MANUFACTURER = 'device/0/manufacturer';
	const MODEL = 'device/0/model';
	const FIRMWARE_VERSION = 'device/0/firmwareVersion';
	const TEMPERATURE = 'sensor/0/temperature';
	const PACKAGE_SIZE = 'topics/0/PkgSize';
	
	this.encode = function (impactRequest) {
        console.log("input to DownlinkRequestCodec encoder", impactRequest, typeof(impactRequest), impactRequest.toString());
		var requestType = utils.getRequestType(impactRequest);
		console.log('request type is ' + requestType);
		var payload = {correlatorId: impactRequest.getCorrelatorId(), type: 'read'};
		var resources = {resource: 'devices/'+impactRequest.getSerialNumber()+'/messages/devicebound/PackageSize', payload: JSON.stringify(payload)};
		return constructImpactWriteRequest(resources);		
    }

	this.decode = function (decodeCtx) {
		var bytes = decodeCtx.getUplinkMessage();
        var request = bytes2String(bytes);
        console.log("input to DownlinkRequestCodec decoder", request);
		var requestData = JSON.parse(request);
		if(requestData.topic.includes("response")){
			var payload = JSON.parse(requestData.payload);
			var res = {};
			res[PACKAGE_SIZE] = payload.value;
			var readResponse = {type: 'READ_RESPONSE', resources: res, correlatorid: payload.correlatorId, status: 200};
			return formImpactNotifyFromJson(decodeCtx, readResponse);
		} else {
			var resources = constructResourceMapping(requestData);
			var notifyResponse = {type: 'NOTIFY', resources: resources};
			return formImpactNotifyFromJson(decodeCtx, notifyResponse);
		}
    }

	function constructResourceMapping(json) {

		var payload = JSON.parse(json.payload);
	
        var response = {};
        if (payload.manufacturer) {
            response[MANUFACTURER] = payload.manufacturer;
        }

        if (payload.model) {
            response[MODEL] = payload.model;
        }

        if (payload.firmwareVersion) {
            response[FIRMWARE_VERSION] = payload.firmwareVersion;
        }

        if (payload.temperature) {
            response[TEMPERATURE] = payload.temperature;
        }
        return response;
    }
}

var codec = new DownlinkRequestCodec();

(codec);