advlib-esp/test/unit/advlibesp.test.js

Wireless advertising packet decoding library for EnOcean Alliance devices via the EnOcean Serial Protocol (ESP). We believe in an open Internet of Things.

/**
 * Copyright reelyActive 2022-2024
 * We believe in an open Internet of Things
 */


const advlib = require('../../lib/advlibesp.js');
const assert = require ('assert');


// Input data for the scenario
const INPUT_DATA_INVALID_HEX_STRING = 'xyz';
const INPUT_DATA_TOO_SHORT_BUFFER = Buffer.from('5500', 'hex');
const INPUT_DATA_4BS = '55000a0701eba55602460905174fc48001ffffffff4100a9';
const INPUT_DATA_1BS = '55000707017ad5090591ee968001ffffffff47003c';
const INPUT_DATA_MSC =
                   '55000f07012bd104700324456ca3729804274f798003ffffffff2a002f';
const INPUT_DATA_VLD =
                   '55000f07012bd29fde40012be0f4d820041415598001ffffffff340087';
const INPUT_DATA_RPS = '55000707017af600002eea1fa001ffffffff44008a';
const INPUT_DATA_UTE = '55000d0701fdd440ff0b004114d2041415598001ffffffff27002d';
const INPUT_DATA_ERP1_PAYLOAD_ONLY = 'd29fdc0000c3e8f7d82005174f0080';
const INPUT_DATA_OPTIONS_IGNORE_PROTOCOL_OVERHEAD = {
    ignoreProtocolOverhead: true
};
const INPUT_DATA_OPTIONS_ERP1_PAYLOAD_ONLY = {
    isERP1PayloadOnly: true
};


// Expected outputs for the scenario
const EXPECTED_DATA_INVALID_INPUT = null;
const EXPECTED_DATA_4BS = {
    type: "RADIO_ERP1",
    dataLength: 10,
    optionalLength: 7,
    telegramType: "4BS",
    telegramPayload: "56024609",
    deviceIds: [ "05174fc4/7" ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};
const EXPECTED_DATA_1BS = {
    type: "RADIO_ERP1",
    dataLength: 7,
    optionalLength: 7,
    telegramType: "1BS",
    deviceIds: [ "0591ee96/7" ],
    isContactDetected: [ true ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};
const EXPECTED_DATA_MSC = {
    type: "RADIO_ERP1",
    dataLength: 15,
    optionalLength: 7,
    telegramType: "MSC",
    telegramPayload: "04700324456ca37298",
    deviceIds: [ "04274f79/7" ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};
const EXPECTED_DATA_VLD = {
    type: "RADIO_ERP1",
    dataLength: 15,
    optionalLength: 7,
    telegramType: "VLD",
    telegramPayload: "9fde40012be0f4d820",
    deviceIds: [ "04141559/7" ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};
const EXPECTED_DATA_RPS = {
    type: "RADIO_ERP1",
    dataLength: 7,
    optionalLength: 7,
    telegramType: "RPS",
    telegramPayload: "00",
    deviceIds: [ "002eea1f/7" ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};
const EXPECTED_DATA_UTE = {
    type: "RADIO_ERP1",
    dataLength: 13,
    optionalLength: 7,
    telegramType: "UTE",
    telegramPayload: "40ff0b004114d2",
    eepType: "D2-14-41",
    deviceIds: [ "04141559/7" ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};
const EXPECTED_DATA_NO_PROTOCOL_OVERHEAD = {
    telegramPayload: "56024609",
    deviceIds: [ "05174fc4/7" ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};
const EXPECTED_DATA_ERP1_PAYLOAD_ONLY = {
    telegramType: "VLD",
    telegramPayload: "9fdc0000c3e8f7d820",
    deviceIds: [ "05174f00/7" ],
    uri: "https://sniffypedia.org/Organization/EnOcean_Alliance/"
};


// Describe the scenario
describe('advlib-esp', function() {

  // Test the process function with no input data
  it('should handle no input data', function() {
    assert.deepEqual(advlib.process(), EXPECTED_DATA_INVALID_INPUT);
  });

  // Test the process function with an invalid hex string
  it('should handle an invalid hex string as input', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_INVALID_HEX_STRING),
                     EXPECTED_DATA_INVALID_INPUT);
  });

  // Test the process function with a buffer that is too short
  it('should handle a too short buffer as input', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_TOO_SHORT_BUFFER),
                     EXPECTED_DATA_INVALID_INPUT);
  });

  // Test the process function with a 4BS RADIO_ERP1 packet
  it('should handle a 4BS RADIO_ERP1 packet', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_4BS), EXPECTED_DATA_4BS);
  });

  // Test the process function with a 1BS RADIO_ERP1 packet
  it('should handle a 1BS RADIO_ERP1 packet', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_1BS), EXPECTED_DATA_1BS);
  });

  // Test the process function with a MSC RADIO_ERP1 packet
  it('should handle a MSC RADIO_ERP1 packet', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_MSC), EXPECTED_DATA_MSC);
  });

  // Test the process function with a VLD RADIO_ERP1 packet
  it('should handle a VLD RADIO_ERP1 packet', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_VLD), EXPECTED_DATA_VLD);
  });

  // Test the process function with a RPS RADIO_ERP1 packet
  it('should handle a RPS RADIO_ERP1 packet', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_RPS), EXPECTED_DATA_RPS);
  });

  // Test the process function with a UTE RADIO_ERP1 packet
  it('should handle a UTE RADIO_ERP1 packet', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_UTE), EXPECTED_DATA_UTE);
  });

  // Test the process function with no protocol overhead
  it('should handle the ignore protocol overhead option', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_4BS, null,
                                  INPUT_DATA_OPTIONS_IGNORE_PROTOCOL_OVERHEAD),
                     EXPECTED_DATA_NO_PROTOCOL_OVERHEAD);
  });

  // Test the process function with ERP1 payload only
  it('should handle the ERP1 payload only option', function() {
    assert.deepEqual(advlib.process(INPUT_DATA_ERP1_PAYLOAD_ONLY, null,
                                    INPUT_DATA_OPTIONS_ERP1_PAYLOAD_ONLY),
                     EXPECTED_DATA_ERP1_PAYLOAD_ONLY);
  });

});