dtu_datalogger_dtp_util.js script
The following is a DTP (binary) utility file, which is used by the DTP (binary) codec script.
var utils = Java.type('com.nokia.transformation.script.model.TransformUtil');
// utility functions
//
function buf2hex(buffer) { // buffer is an ArrayBuffer
return Array.prototype.map.call(new Uint8Array(buffer), x => ('00' + x.toString(16)).slice(-2)).join('');
}
function bytes2String(bytes, offset=0) {
if (offset < 0) { offset=0; }
var result = "";
for (var i = offset; i < bytes.length; i++) {
result += String.fromCharCode(bytes[i]);
}
return result;
}
function string2Bytes(str, offset=0) {
if (offset < 0) { offset=0; }
var bytes;
const strLen = str? str.length : 0;
bytes = new Array(strLen + offset);
for (var i = 0; i < strLen; i++) {
bytes[offset+i] = str.charCodeAt(i);
}
return bytes;
}
function isBitSet(byte, bitNum) {
return ((byte >> bitNum) & 0xFF) == 0x01;
}
function getImpactRequestAsJson(impactRequest) {
console.log("input to encoder", impactRequest);
var request = {};
request.type = utils.getRequestType(impactRequest);
request.url = impactRequest.getResource();
request.serialNumber = impactRequest.getSerialNumber();
if (!request.type || !request.url) {
throw new Error(`request type and resource URL are required in the input`);
}
var resourceItems = request.url.split("/");
request.resource = resourceItems[resourceItems.length - 1];
if (impactRequest.getValue) {
request.resourceValue = impactRequest.getValue();
}
console.log("request to encoder", JSON.stringify(request));
return request;
}
function formImpactResponseOrNotifyFromJson(decodeCtx, resources, success=true, resourceBaseurl="") {
if(decodeCtx.getRequest() != null) {
formImpactResponseFromJson(decodeCtx, resources, success, resourceBaseurl);
} else {
formImpactNotifyFromJson(decodeCtx, resources, resourceBaseurl);
}
}
function formImpactResponseFromJson(decodeCtx, resources, success=true, resourceBaseurl="") {
if(decodeCtx.getRequest() != null) {
var correlatorId = decodeCtx.getRequest().getCorrelatorId();
var reqType = utils.getRequestType(decodeCtx.getRequest());
var responseCode = success? 0: 1;
var resp = { responseCode, requestStatus: 0, correlatorId };
var response = [];
var resourceObj = {"device/0/endPointClientName":client.getEndpoint()};
resources.forEach(resource => {
resourceObj[resourceBaseurl + resource.name] = resource.value;
});
response.push(resourceObj);
if (reqType == "READ") {
resp.response = response;
} else if (reqType == "WRITE") {
resp.writeResponse = { "device/0/endPointClientName": client.getEndpoint() };
} else if (reqType == "EXECUTE") {
resp.executeResponse = { "device/0/endPointClientName": client.getEndpoint() };
} else if (reqType == "DELETE") {
resp.deleteResponse = { "device/0/endPointClientName": client.getEndpoint() };
}else {
throw new Error (`invalid req type ${reqType}`);
}
console.log(`sending ${reqType} response ` + JSON.stringify(resp));
return utils.createJsonResponse(JSON.stringify(resp));
} else {
throw new Error (`no corresponding request found`);
}
}
function formImpactNotifyFromJson(decodeCtx, resources, resourceBaseurl="") {
var resp = {details: {"device/0/endPointClientName": client.getEndpoint()}};
resources.forEach(resource => {
resp.details[resourceBaseurl + resource.name] = resource.value;
});
console.log('sending notify response ' + JSON.stringify(resp));
return utils.createJsonResponse(JSON.stringify(resp));
}
/*
* from http://automationwiki.com/index.php?title=CRC-16-CCITT
*/
var crc_table = [
0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5,
0x60c6, 0x70e7, 0x8108, 0x9129, 0xa14a, 0xb16b,
0xc18c, 0xd1ad, 0xe1ce, 0xf1ef, 0x1231, 0x0210,
0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c,
0xf3ff, 0xe3de, 0x2462, 0x3443, 0x0420, 0x1401,
0x64e6, 0x74c7, 0x44a4, 0x5485, 0xa56a, 0xb54b,
0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6,
0x5695, 0x46b4, 0xb75b, 0xa77a, 0x9719, 0x8738,
0xf7df, 0xe7fe, 0xd79d, 0xc7bc, 0x48c4, 0x58e5,
0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969,
0xa90a, 0xb92b, 0x5af5, 0x4ad4, 0x7ab7, 0x6a96,
0x1a71, 0x0a50, 0x3a33, 0x2a12, 0xdbfd, 0xcbdc,
0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03,
0x0c60, 0x1c41, 0xedae, 0xfd8f, 0xcdec, 0xddcd,
0xad2a, 0xbd0b, 0x8d68, 0x9d49, 0x7e97, 0x6eb6,
0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a,
0x9f59, 0x8f78, 0x9188, 0x81a9, 0xb1ca, 0xa1eb,
0xd10c, 0xc12d, 0xf14e, 0xe16f, 0x1080, 0x00a1,
0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c,
0xe37f, 0xf35e, 0x02b1, 0x1290, 0x22f3, 0x32d2,
0x4235, 0x5214, 0x6277, 0x7256, 0xb5ea, 0xa5cb,
0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447,
0x5424, 0x4405, 0xa7db, 0xb7fa, 0x8799, 0x97b8,
0xe75f, 0xf77e, 0xc71d, 0xd73c, 0x26d3, 0x36f2,
0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9,
0xb98a, 0xa9ab, 0x5844, 0x4865, 0x7806, 0x6827,
0x18c0, 0x08e1, 0x3882, 0x28a3, 0xcb7d, 0xdb5c,
0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0,
0x2ab3, 0x3a92, 0xfd2e, 0xed0f, 0xdd6c, 0xcd4d,
0xbdaa, 0xad8b, 0x9de8, 0x8dc9, 0x7c26, 0x6c07,
0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba,
0x8fd9, 0x9ff8, 0x6e17, 0x7e36, 0x4e55, 0x5e74,
0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
];
/**
* Compute CRC-CCITT
*
* @param {Uint8Array} input The input byte array for calculating the CRC
* @param {int} inputLen (optional) The len of the input byte array. Default: input.length will be considered
* @param {short int} seed The initial value. 0xFFFF for CCITT-FALSE and 0x1D0F for AUG-CCITT
* @returns {short int}
*/
function crcCCITT (input, seed=0xFFFF, inputLen=0) {
var result = seed;
var temp;
var len = (inputLen > 0)? inputLen : input.length;
for (var i = 0, len = len; i < len; ++i) {
temp = (input[i] ^ (result >> 8)) & 0xFF;
result = crc_table[temp] ^ (result << 8);
}
return result & 0xFFFF;
}
/**
* check 0x29B1 for "123456789"
*/
/*
var input = new Uint8Array( [ 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39 ] );
output = crcCCITT(input, 0xFFFF);
console.log('output:', output);
console.log("(correct is)", 0x29B1);
input = new Uint8Array( [ 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x29, 0xB1 ] );
output = crcCCITT(input, 0xFFFF);
console.log('crc ok:', output == 0);
input = new Uint8Array( [0x03, 0x13, 0x01, 0xd0, 0x49, 0xf8, 0x56, 0x14, 0x00, 0x23, 0x11, 0x00,
0x00, 0x01, 0x32, 0x11, 0x00, 0x00, 0x02, 0xa7, 0x13, 0x00, 0x00, 0x03,
0x37, 0x0f, 0x00, 0x00, 0x00, 0x00] );
output = crcCCITT(input, 0xFFFF);
console.log('output:', output);
*/
var ROUNDS = 32;
var DELTA = 0x9E3779B9;
/** @private */
function encipher( v, k ) {
var y = v[0];
var z = v[1];
var sum = 0;
var limit = (DELTA * ROUNDS) >>> 0;
while ( sum !== limit ) {
y += (((z << 4) >>> 0 ^ (z >>> 5)) + z) ^ (sum + k[sum & 3]);
y = y >>> 0;
sum = (sum + DELTA) >>> 0;
z += (((y << 4) >>> 0 ^ (y >>> 5)) + y) ^ (sum + k[(sum >> 11) & 3]);
z = z >>> 0;
}
v[0] = y;
v[1] = z;
}
/** @private */
function decipher( v, k ) {
var y = v[0];
var z = v[1];
var sum = (DELTA * ROUNDS) >>> 0;
while (sum) {
z -= (((y << 4) >>> 0 ^ (y >>> 5)) + y) ^ (sum + k[(sum >> 11) & 3]);
z = z >>> 0;
sum = (sum - DELTA) >>> 0;
y -= (((z << 4) >>> 0 ^ (z >>> 5)) + z) ^ (sum + k[sum & 3]);
y = y >>> 0;
}
v[0] = y;
v[1] = z;
}
/** @private */
function doBlocks( encryption, msg, key ) {
var method = encryption? encipher : decipher;
var length = msg.byteLength;
var pad = 8 - (length & 7);
if (pad !== 8) {
throw new Error("Data not aligned to 8 bytes block boundary");
}
if (key.byteLength !== 16) {
throw new Error("Key should be 16 bytes");
}
var out = new ArrayBuffer(length);
var o = new Uint32Array(out);
var m = new Uint32Array(msg);
var k = new Uint32Array(key);
var v = new Uint32Array(2);
for (i=0; i < m.length; i+=2) {
v[0] = m[i];
v[1] = m[i+1];
method( v, k );
o[i] = v[0];
o[i+1] = v[1];
}
return out;
}
/**
* Encrypts data using XTEA cipher using ECB
*
* @param {ArrayBuffer} msg Message to encrypt
* @param {ArrayBuffer} key 128-bit encryption key (16 bytes)
* @returns {ArrayBuffer}
*/
function encrypt( msg, key ) {
return doBlocks( true, msg, key );
}
/**
* Decrypts data using XTEA cipher using ECB
*
* @param {ArrayBuffer} msg Ciphertext to decrypt
* @param {ArrayBuffer} key 128-bit encryption key (16 bytes)
* @returns {ArrayBuffer}
*/
function decrypt( msg, key ) {
return doBlocks( false, msg, key );
}
const xtea = { encrypt, decrypt };
/**
* test
*/
/*
var dec = xtea.decrypt(new Uint8Array([0x60, 0x61, 0x4e, 0x68, 0x0e, 0x70, 0x5d, 0x0f]).buffer, new Uint8Array([0x79, 0x75, 0x79, 0x75, 0x79, 0x75, 0x79, 0x75, 0x6F, 0x70, 0x6F, 0x70, 0x6F, 0x70, 0x6F, 0x70]).buffer);
var expected = new Uint8Array([0x09, 0x30, 0x00, 0x04, 0x10, 0x0e, 0x00, 0x00]);
var actual = new Uint8Array(dec);
console.log("Actual: ", actual);
console.log("Expected: ", expected);
var enc = xtea.encrypt(new Uint8Array([ 0x09, 0x30, 0x00, 0x04, 0x10, 0x0e, 0x00, 0x00, 0x01, 0x04, 0xf4, 0x77,
0x95, 0x59, 0x02, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x61, 0x61, 0x61, 0x61, 0x5d, 0x5d, 0x5d, 0x5d, 0x09, 0x15, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0d, 0x10, 0x52, 0x54, 0x55,
0x30, 0x32, 0x2e, 0x30, 0x31, 0x2e, 0x30, 0x30, 0x30, 0x32, 0x00, 0x00,
0x00, 0x12, 0x04, 0x00, 0x00, 0x00, 0x00, 0x13, 0x04, 0x00, 0x00, 0x00,
0x00, 0x14, 0x04, 0x61, 0x61, 0x61, 0x61, 0x15, 0x04, 0x5d, 0x5d, 0x5d,
0x5d, 0x16, 0x04, 0x01, 0x0e, 0x00, 0x00, 0x17, 0x04, 0x01, 0x0e, 0x00,
0x00, 0x18, 0x04, 0x01, 0x0e, 0x00, 0x00, 0x19, 0x04, 0x01, 0x0e, 0x00,
0x00, 0x1a, 0x04, 0x01, 0x0e, 0x00, 0x00, 0x1b, 0x04, 0x01, 0x0e, 0x00,
0x00, 0x1c, 0x04, 0x01, 0x0e, 0x00, 0x00, 0x1d, 0x04, 0x01, 0x0e, 0x00,
0x00, 0x1e, 0x01, 0x00, 0x1f, 0x01, 0x00, 0x20, 0x01, 0x00, 0x21, 0x01,
0x00, 0x24, 0x01, 0x00, 0x25, 0x11, 0x32, 0x35, 0x30, 0x30, 0x32, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x26,
0x04, 0xef, 0x14, 0x00, 0x00, 0x27, 0x04, 0x93, 0x0d, 0x00, 0x00, 0x2d,
0x01, 0x02, 0x2e, 0x02, 0xe0, 0x01, 0x2f, 0x05, 0xff, 0xff, 0xff, 0xff,
0x00, 0x30, 0x01, 0x03, 0x31, 0x01, 0x00, 0x33, 0x01, 0x00, 0x34, 0x04,
0x05, 0x01, 0x00, 0x00, 0x3d, 0x20, 0x34, 0x2e, 0x31, 0x32, 0x38, 0x2e,
0x32, 0x34, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x44, 0x01, 0x18, 0x4f, 0x04, 0x96, 0x0d, 0x00, 0x00, 0x50,
0x04, 0x00, 0x00, 0x00, 0x00, 0x57, 0x04, 0x60, 0xea, 0x00, 0x00, 0x58,
0x04, 0x22, 0x06, 0x00, 0x00, 0x59, 0x04, 0x60, 0xea, 0x00, 0x00, 0x5a,
0x04, 0xe0, 0x15, 0x00, 0x00, 0x5b, 0x01, 0x00, 0x5c, 0x01, 0x02, 0x5d,
0x01, 0x00, 0x5e, 0x01, 0x00, 0x5f, 0x01, 0x03, 0x60, 0x01, 0x03, 0x61,
0x01, 0x02, 0x62, 0x01, 0x04, 0x00, 0x01, 0x1b ]).buffer, new Uint8Array([0x79, 0x75, 0x79, 0x75, 0x79, 0x75, 0x79, 0x75, 0x6F, 0x70, 0x6F, 0x70, 0x6F, 0x70, 0x6F, 0x70]).buffer);
console.log("enc: ", Array.prototype.map.call(new Uint8Array(enc), x => ('00' + x.toString(16)).slice(-2)).join(''));
*/
For more information on sample payload, refer to page 29 of https://adgt.cz/wp-content/uploads/2020/12/DTU-Remote-Data-Logger-series_Data-transmission-protocol-r.1.7-2020-11-27.pdf.