aes70 1.5.0 → 1.5.2

package/src/controller/remote_device.js

@@ -16,6 +16,7 @@ import { OcaTaskManager } from './ControlClasses/OcaTaskManager.js';
 import { OcaCodingManager } from './ControlClasses/OcaCodingManager.js';
 import { OcaDiagnosticManager } from './ControlClasses/OcaDiagnosticManager.js';
 import { OcaBlock } from './ControlClasses/OcaBlock.js';
+import tree_to_rolemap from './tree_to_rolemap.js';
 
 import * as RemoteControlClasses from './ControlClasses.js';
 
@@ -29,82 +30,6 @@ function eventToKey(event) {
   return [ono, id.DefLevel, id.EventIndex].join(',');
 }
 
-function tree_to_rolemap(tree, s) {
-  const roles = new Map();
-  if (!s) s = '/';
-
-  const tasks = [];
-
-  const fetch_role = (o) => {
-    if (Array.isArray(o)) {
-      o.forEach(fetch_role);
-    } else {
-      tasks.push(
-        o.GetRole().then((role) => {
-          roles.set(o, role);
-        })
-      );
-    }
-  };
-
-  tree.forEach(fetch_role);
-
-  return Promise.all(tasks).then(function () {
-    const rolemap = new Map();
-
-    const build_paths = (a, prefix) => {
-      const p = prefix != null ? prefix + s : '';
-      const local_roles = new Map();
-
-      a.forEach(function (o, i) {
-        if (Array.isArray(o)) return;
-
-        const role = roles.get(o);
-
-        if (local_roles.has(role)) {
-          const tmp = local_roles.get(role);
-
-          if (Array.isArray(tmp)) tmp.push(o);
-          else local_roles.set(role, [tmp, o]);
-        } else {
-          local_roles.set(role, o);
-        }
-      });
-
-      local_roles.forEach(function (o, role) {
-        if (Array.isArray(o)) {
-          let n = 1;
-          for (let i = 0; i < o.length; i++) {
-            const nrole = role + n;
-            while (local_roles.has(nrole)) {
-              n++;
-            }
-            local_roles.set(nrole, o[i]);
-            local_roles.set(o[i], nrole);
-          }
-
-          local_roles.delete(role);
-        } else {
-          local_roles.set(o, role);
-        }
-      });
-
-      a.forEach((o, i) => {
-        if (Array.isArray(o)) {
-          build_paths(o, p + local_roles.get(a[i - 1]));
-        } else {
-          const path = p + local_roles.get(o);
-          rolemap.set(path, o);
-        }
-      });
-    };
-
-    build_paths(tree, null);
-
-    return rolemap;
-  });
-}
-
 const subscriberMethod = {
   ONo: 1055,
   MethodID: {

package/src/controller/tree_to_rolemap.js

@@ -0,0 +1,77 @@
+function tree_to_rolemap(tree, s) {
+  const roles = new Map();
+  if (!s) s = '/';
+
+  const tasks = [];
+
+  const fetch_role = (o) => {
+    if (Array.isArray(o)) {
+      o.forEach(fetch_role);
+    } else {
+      tasks.push(
+        o.GetRole().then((role) => {
+          roles.set(o, role);
+        })
+      );
+    }
+  };
+
+  tree.forEach(fetch_role);
+
+  return Promise.all(tasks).then(function () {
+    const rolemap = new Map();
+
+    const build_paths = (a, prefix) => {
+      const p = prefix != null ? prefix + s : '';
+      const local_roles = new Map();
+
+      a.forEach(function (o, i) {
+        if (Array.isArray(o)) return;
+
+        const role = roles.get(o);
+
+        if (local_roles.has(role)) {
+          const tmp = local_roles.get(role);
+
+          if (Array.isArray(tmp)) tmp.push(o);
+          else local_roles.set(role, [tmp, o]);
+        } else {
+          local_roles.set(role, o);
+        }
+      });
+
+      local_roles.forEach(function (o, role) {
+        if (Array.isArray(o)) {
+          let n = 1;
+          for (let i = 0; i < o.length; i++) {
+            let nrole;
+            while (local_roles.has((nrole = role + n))) {
+              n++;
+            }
+            local_roles.set(nrole, o[i]);
+            local_roles.set(o[i], nrole);
+          }
+
+          local_roles.delete(role);
+        } else {
+          local_roles.set(o, role);
+        }
+      });
+
+      a.forEach((o, i) => {
+        if (Array.isArray(o)) {
+          build_paths(o, p + local_roles.get(a[i - 1]));
+        } else {
+          const path = p + local_roles.get(o);
+          rolemap.set(path, o);
+        }
+      });
+    };
+
+    build_paths(tree, null);
+
+    return rolemap;
+  });
+}
+
+export default tree_to_rolemap;

package/src/index.default.d.ts

@@ -14,5 +14,7 @@ export * from './controller/remote_device';
 export * from './controller/define_custom_class';
 export * from './controller/abstract_udp_connection';
 
-export * as RemoteControlClasses from './controller/ControlClasses';
-export * as Types from './types';
+import * as RemoteControlClasses from './controller/ControlClasses';
+import * as Types from './types';
+
+export { RemoteControlClasses, Types };

package/tests/connect.js

@@ -1,93 +0,0 @@
-const process = require('process');
-const RemoteDevice = require('../lib/Controller').RemoteDevice;
-const TCPConnection = require('../lib/controller/TCP').TCPConnection;
-const OCC = require('../lib/controller/ControlClasses');
-
-if (process.argv.length < 4)
-{
-  console.log('Usage: node connect.js <ip> <port>');
-  return;
-}
-
-const host = process.argv[2];
-const port = parseInt(process.argv[3]);
-
-TCPConnection.connect({
-    host: host,
-    port: port,
-  })
-  .then(function(connection) {
-    return new RemoteDevice(connection);
-  })
-  .then(printDeviceTree);
-
-function delay(n)
-{
-  return new Promise(function(resolve, reject) {
-    setTimeout(resolve, n);
-  });
-}
-
-async function microblink(objects)
-{
-  let found = false;
-
-  do
-  {
-    for (let i = 0; i < objects.length; i++)
-    {
-      const o = objects[i];
-
-      if (o instanceof OCC.OcaBitstringActuator)
-      {
-        const N = await o.GetNrBits();
-
-        const n = 0 | (Math.random() * N);
-        const v = Math.random() > 0.5;
-
-        await o.SetBit(n, v);
-        await delay(10);
-
-        found = true;
-      }
-    }
-  } while (found);
-
-  process.exit(0);
-}
-
-function printDeviceTree(device)
-{
-  var print = function(objects, i) {
-    var o = objects[i];
-    var a = [];
-
-    if (!o) {
-      microblink(objects);
-      return;
-    }
-
-    a.push(o.GetRole().then((role) => console.log("Role:", role)));
-    o.get_properties().forEach((p) => {
-      const getter = p.getter(o);
-      if (!getter) return;
-      a.push(getter().then((val) => console.log(" %s: %o ", p.name, val)));
-    });
-
-    Promise.all(a)
-      .then(
-        () => print(objects, i+1),
-        (err) => {
-          console.error(err);
-          print(objects, i+1)
-        });
-  };
-
-  device.discover_all().then(
-    function(o) {
-      print(o, 0);
-    },
-    function(err) {
-      console.error(err);
-    });
-}

package/tests/device/check_tree.js

@@ -1,101 +0,0 @@
-import { ObjectTest } from './test.js';
-
-class CheckTree extends ObjectTest {
-  async check_object(o, parent, i) {
-    if (Array.isArray(o))
-    {
-      this.check(i > 0, "Children follow their parent object.");
-      await check_children(children[i-1], o);
-    }
-    else
-    {
-      try {
-        const ono = await o.GetOwner();
-
-        this.check(ono === parent.ObjectNumber, "object %O has owner property %o (should be %o)",
-                   o.ObjectNumber, ono, parent.ObjectNumber);
-      } catch (e) {
-        this.fail('GetOwner is not implemented in object %o.', o.ObjectNumber);
-      }
-
-      this.check(o.ObjectNumber >= 4096, "object has reserved ObjectNumber ( below 4096 )");
-
-      try {
-        const id = await o.GetClassIdentification();
-        const class_version = o.ClassVersion;
-        const class_id = o.ClassID;
-
-        this.check(id.ClassID.startsWith(o.ClassID), "ClassID does not match in object %o (%o vs. %o)",
-                   o.ObjectNumber, id.ClassID, o.ClassID);
-      } catch (e) {
-        this.fail('GetOwner is not implemented in object %o.', o.ObjectNumber);
-      }
-    }
-  }
-}
-
-class CheckPath extends ObjectTest {
-  constructor(device)
-  {
-    super(device);
-    this.roles = new Map();
-  }
-
-  get_roles_for(o)
-  {
-    if (!this.roles.has(o))
-    {
-      this.roles.set(o, new Set());
-    }
-
-    return this.roles.get(o);
-  }
-
-  async check_object(o, parent, i)
-  {
-    const roles = this.get_roles_for(parent);
-
-    const role = await o.GetRole();
-
-    this.check(role.length, "Role name is empty.");
-
-    this.check(!roles.has(role), "Role name collision with object %d (role: %o)", o.ono, role);
-
-    roles.add(role);
-  }
-}
-
-class CheckRoleMap extends ObjectTest {
-  constructor(get_device)
-  {
-    super(get_device);
-    this.rolemap = null;
-  }
-
-  async prepare()
-  {
-    await super.prepare();
-    this.rolemap = await this.device.get_role_map();
-  }
-
-  async check_object(o, parent, i)
-  {
-    let found = false;
-
-    const role = await o.GetRole();
-
-    this.rolemap.forEach((tmp, path) => {
-      if (o === tmp)
-      {
-        this.check(!found, "Found object %o in role map twice.", o.ono);
-        this.check(path.split("/").pop().startsWith(role), "Role names do not match.");
-
-        found = true;
-      }
-    });
-
-    this.check(found, "Could not find object %o in role map.", o.ono);
-  }
-}
-
-export default [ CheckTree, CheckPath, CheckRoleMap ];

package/tests/device/custom_class.js

@@ -1,61 +0,0 @@
-const RemoteControlClasses = require('../../lib').RemoteControlClasses;
-const Types = require('../../lib').Types;
-const define_custom_class = require('../../lib').controller.define_custom_class;
-const Test = require('./test').Test;
-
-
-const SimpleBlock = define_custom_class(
-    "SimpleBlock",
-    3,
-    "1.1.3",
-    2,
-    "OcaWorker",
-    [
-      [ "GetMembers", 3, 5, [  ], [ [ 'LIST', Types.OcaObjectIdentification ] ] ],
-      [ "GetMembersRecursive", 3, 6, [  ], [ [ 'LIST', Types.OcaBlockMember ] ] ],
-    ],
-    [
-    ],
-    [ ]
-);
-
-class CustomBlock extends Test
-{
-  async prepare()
-  {
-    await super.prepare();
-    this.device2 = await this.get_device();
-    this.device2.add_control_classes([ SimpleBlock ]);
-  }
-
-  async run()
-  {
-    this.check(SimpleBlock.ClassID === "\u0001\u0001\u0003",
-               'SimpleBlock class id is wrong: %o', SimpleBlock.ClassID);
-    const rolemap1 = await this.device.get_role_map();
-    const rolemap2 = await this.device2.get_role_map();
-
-    this.check(rolemap1.size == rolemap2.size, "Different number of objects.");
-    this.check(
-               JSON.stringify(Array.from(rolemap1.keys())) ===
-               JSON.stringify(Array.from(rolemap2.keys())), "Same role map.");
-
-    rolemap2.forEach((o) => {
-      if (o.ClassID === SimpleBlock.ClassID)
-        this.check(o instanceof SimpleBlock,
-                   "Custom class was not used.");
-    });
-  }
-
-  cleanup()
-  {
-    super.cleanup();
-    if (this.device2 !== null)
-    {
-      this.device2.close();
-      this.device2 = null;
-    }
-  }
-}
-
-module.exports = [ CustomBlock ];

package/tests/device/keepalive.js

@@ -1,50 +0,0 @@
-import { Test } from './test.js';
-import { UDPConnection } from '../../src/controller/udp_connection.js';
-
-function wait(n)
-{
-  return new Promise(function(resolve, reject)
-    {
-      setTimeout(resolve, n*1000);
-    });
-}
-
-class IdleTime extends Test {
-  async run()
-  {
-    this.device.set_keepalive_interval(1);
-
-    await wait(2);
-
-    const connection = this.device.connection;
-
-    this.check(connection.tx_idle_time() < 1500, "TX Idle time too big: %o", connection.tx_idle_time());
-    this.check(connection.rx_idle_time() < 1500, "RX Idle time too big: %o", connection.rx_idle_time());
-  }
-}
-
-class RemoteClose extends Test {
-  run()
-  {
-    // we cannot detect this properly
-    if (this.device.connection instanceof UDPConnection)
-      return Promise.resolve(true);
-
-    return new Promise((resolve, reject) => {
-      this.device.set_keepalive_interval(1);
-      const connection = this.device.connection;
-
-      // we manually remove the keepalive interval
-      // out connection will be silent from now on
-      clearInterval(connection.keepalive_interval);
-
-      // we expect a close
-      connection.on('close', resolve);
-      setTimeout(function() {
-        reject(new Error("Connection not closed by remote side."));
-      }, 1000 * 4);
-    });
-  }
-}
-
-export default [ IdleTime, RemoteClose ];

package/tests/device/locking.js

@@ -1,52 +0,0 @@
-import { ObjectTest } from './test.js';
-import { OcaStatus } from '../../src/types/OcaStatus.js';
-
-class Locking extends ObjectTest
-{
-  async prepare()
-  {
-    await super.prepare();
-    this.other_device = await this.get_device();
-  }
-
-  async check_object(o)
-  {
-    try {
-      if (!await o.GetLockable()) return;
-    } catch (e) {
-      if (e.status == OcaStatus.NotImplemented) return;
-      throw e;
-    }
-
-    const o2 = this.other_device.allocate(o.constructor, o.ono);
-
-    this.check(await o2.GetRole() == await o.GetRole(),
-               "Role names do not match.");
-
-    await o.LockTotal();
-
-    await o.GetRole();
-
-    try {
-      await o2.GetRole();
-      this.check(false, "Object should be locked for other clients now.");
-    } catch (e) {
-      this.check(e.status == OcaStatus.Locked,
-                 "Calling methods as a second client should return OcaStatus::Locked."); 
-    }
-
-    await o.Unlock();
-
-    this.check(await o2.GetRole() == await o.GetRole(),
-               "Role names do not match.");
-  }
-
-  cleanup()
-  {
-    super.cleanup();
-    this.close_device(this.other_device);
-    this.other_device = null;
-  }
-}
-
-export default [ Locking ];

package/tests/device/method_callback.js

@@ -1,24 +0,0 @@
-import { Test } from './test.js';
-
-class CheckCallbackMethod extends Test {
-  async run() {
-    const root = this.device.Root;
-
-    const result = await root.GetMembers();
-
-    const result2 = await new Promise((resolve, reject) => {
-      const tmp = root.GetMembers((ok, result) => {
-        (ok ? resolve : reject)(result);
-      });
-      if (tmp) {
-        console.error('got %o', tmp);
-        throw new Error('Unexpected return value.');
-      }
-    });
-
-    if (result.length !== result2.length)
-      throw new Error('Result mismatch.');
-  }
-}
-
-export default [ CheckCallbackMethod ];

package/tests/device/property_changes.js

@@ -1,113 +0,0 @@
-import { ObjectTest } from './test.js';
-import { Arguments } from '../../src/controller/arguments.js';
-import { OcaStatus } from '../../src/types/OcaStatus.js';
-import { OcaPropertyChangeType } from '../../src/types/OcaPropertyChangeType.js';
-
-function isEqual(a, b) {
-  if (a === b) return true;
-
-  if (Array.isArray(a)) {
-    if (!Array.isArray(b)) return false;
-    if (a.length !== b.length) return false;
-
-    return a.every((element, i) => isEqual(element, b[i]));
-  }
-
-  if (typeof a === 'object') {
-    if (typeof b !== 'object') return false;
-    if (a.constructor !== b.constructor) return false;
-
-    for (const name in a) {
-      if (a[name] !== b[name]) return false;
-    }
-
-    return true;
-  }
-
-  return false;
-}
-
-class PropertyChanges extends ObjectTest
-{
-  async check_object(o)
-  {
-    const sync = o.GetPropertySync();
-    await sync.sync();
-
-    sync.forEach((value, name) => {
-      this.check(sync[name] === value, "PropertySync Getters are broken: %o vs. %o", sync[name], value);
-    });
-
-    await Promise.all(o.get_properties().forEach(async (prop) => {
-      const name = prop.name;
-      const setter = prop.setter(o);
-      const getter = prop.getter(o);
-      const event = prop.event(o);
-
-      if (!setter || !getter) return;
-
-      let a;
-
-      try {
-        a = await getter();  
-      } catch (e) {
-        if (e.status === OcaStatus.NotImplemented) return;
-        throw e;
-      }
-      
-      if (!(a instanceof Arguments)) return;
-
-      const val = a.item(0);
-      const min = a.item(1);
-      const max = a.item(2);
-
-      // this happens with GetThreshold() in OcaDynamics
-      if (typeof val !== typeof min || typeof val !== typeof max) return;
-
-      this.check(isEqual(sync[name], val),
-                 "Property Sync value '%s' is not equal to current: %o vs. %o", name, sync[name], val);
-
-      const test_set = async (to) => {
-        let called = false;
-
-        const cb = (value, changeType) => {
-          if (changeType !== OcaPropertyChangeType.CurrentChanged)
-            return;
-
-          this.check(isEqual(value, to), "Received event for different value change: %o vs. %o", to, value);
-
-          called = true;
-        };
-
-        await event.subscribe(cb);
-
-        try {
-          await setter(to);
-        } catch (e) {
-          if (e.status === OcaStatus.NotImplemented) return;
-          throw e;
-        }
-
-        const tmp = (await getter()).item(0);
-
-        await event.unsubscribe(cb);
-
-        this.check(called, "PropertyChanged event was not received for '%s'", name);
-
-        this.check(isEqual(to, tmp),
-                   "Property '%s' set to %o succeeded but get returned %o", name, to, tmp);
-        this.check(isEqual(to, sync[name]),
-                   "Property '%s' set to %o succeeded but sync contains %o", name, to, sync[name]);
-      };
-
-      // set to min first
-      await test_set(min);
-      await test_set(max);
-      await test_set(val);
-    }));
-
-    sync.Dispose();
-  }
-}
-
-export default [ PropertyChanges ];