aes70 1.5.2 → 1.5.4

package/.prettierignore

@@ -0,0 +1,5 @@
+*package.json
+*package-lock.json
+*node_modules
+*Makefile
+.git

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "jsxBracketSameLine": true
+}

package/Changelog

@@ -2,6 +2,10 @@
 
 All notable changes and version updates will be documented in this file.
 
+## [1.5.3] - 2024-06-29
+
+- Fixed an error in keepalive handling and timeout detection.
+
 ## [1.5.2] - 2023-10-17
 
 - Fixed an error in how duplicate role names were handled in get_role_map()

package/README.md

@@ -9,11 +9,11 @@ be used to build AES70 devices.
 
 # Contents
 
-* [AES70](#aes70)
-* [Basics](#basics)
-* [Installation](#installation)
-* [Getting started](#getting-started)
-* [License](#license)
+- [AES70](#aes70)
+- [Basics](#basics)
+- [Installation](#installation)
+- [Getting started](#getting-started)
+- [License](#license)
 
 # AES70
 
@@ -68,7 +68,7 @@ file `dist/AES70.es5.js`. To build this file run
         npm ci
         make dist/AES70.es5.js
 
-Alternatively, the version of AES70 published to NPM already contains the 
+Alternatively, the version of AES70 published to NPM already contains the
 generated source file. After installing `aes70` using NPM a version of AES70.js
 for the browser will be at `node_modules/aes70/dist/AES70.es5.js`.
 
@@ -163,7 +163,7 @@ A full working example:
 
 The tree returned by `RemoteDevice.get_device_tree` returns all objects of the
 device below the root block. They represent all objects defined inside of the
-AES70 device aside from the manager objects. 
+AES70 device aside from the manager objects.
 
 # Documentation
 

package/bin/printDevice.js

@@ -3,67 +3,180 @@
 import { argv, exit } from 'process';
 import { RemoteDevice } from '../src/controller/remote_device.js';
 import { TCPConnection } from '../src/controller/tcp_connection.js';
+import { OcaBlock } from '../src/controller/ControlClasses/OcaBlock.js';
+import { Arguments } from '../src/controller/arguments.js';
 
-if (argv.length < 4)
-{
-  console.log('Usage: node print_tree.js <ip> <port>');
+function badArguments() {
+  console.log('Usage: node print_tree.js [--json] <ip> <port>');
   exit(1);
 }
 
-const host = argv[2];
-const port = parseInt(argv[3]);
+let jsonMode = false;
+const rest = [];
+
+argv.slice(2).forEach((option) => {
+  switch (option) {
+    case '--json':
+      jsonMode = true;
+      break;
+    case '-h':
+    case '--help':
+      badArguments();
+      break;
+    default:
+      rest.push(option);
+      break;
+  }
+});
+
+if (rest.length < 2) badArguments();
+
+const host = rest[0];
+const port = parseInt(rest[1]);
+
+if (!(port > 0 && port <= 0xffff)) badArguments();
+
+function formatPropertyValue(name, value) {
+  if (typeof value === 'object') {
+    if (value instanceof Arguments) {
+      return {
+        [name]: value.item(0),
+        ['min' + name]: value.item(1),
+        ['max' + name]: value.item(2),
+      };
+    } else if (value !== null && value.isEnum) {
+      value = value.name;
+    }
+  }
+
+  return {
+    [name]: value,
+  };
+}
 
 TCPConnection.connect({
-    host: host,
-    port: port,
-  })
-  .then(function(connection) {
+  host: host,
+  port: port,
+})
+  .then(function (connection) {
     return new RemoteDevice(connection);
   })
   .then(printDevice);
 
-async function printTree(objects, prefix)
-{
+async function fetchObjectInfo(o) {
+  const info = {
+    type: o.ClassName,
+  };
+
+  const classIdentification = await o.GetClassIdentification();
+
+  Object.assign(info, classIdentification);
+
+  await Promise.all(
+    o.get_properties().forEach(async (p) => {
+      const { name } = p;
+      if (name === 'ClassID' || name === 'ClassVersion') return;
+      if (o instanceof OcaBlock && name === 'Members') return;
+      const getter = p.getter(o);
+      if (!getter) return;
+      try {
+        const currentValue = await getter();
+
+        Object.assign(info, formatPropertyValue(name, currentValue));
+      } catch (err) {
+        if (err.status != 8)
+          console.error(
+            'Fetching property',
+            o.ClassName,
+            p.name,
+            'failed:',
+            err
+          );
+      }
+    })
+  );
+
+  return info;
+}
+
+async function printTree(objects, prefix) {
   if (!prefix) prefix = [];
 
   let lastPath;
 
-  for (let i = 0; i < objects.length; i++)
-  {
+  for (let i = 0; i < objects.length; i++) {
     const o = objects[i];
 
-    if (Array.isArray(o)) 
-    {
+    if (Array.isArray(o)) {
       await printTree(o, lastPath);
       continue;
     }
 
     const roleName = await o.GetRole();
 
-    const path = prefix.concat([ roleName ]);
+    const path = prefix.concat([roleName]);
 
     lastPath = path;
 
-    console.log('Path: %s', path.join(' / '));
+    console.log('Path: %s', path.join('/'));
 
-    o.get_properties().forEach(async (p) => {
-      if (p.name === 'Members') return;
-      const getter = p.getter(o);
-      if (!getter) return;
-      try {
-        const val = await getter();
-        console.log(" %s: %O ", p.name, val);
-      } catch (e) {
-        console.log(" %s: n/a ", p.name);
+    const info = await fetchObjectInfo(o);
+
+    for (const name in info) {
+      console.log(' %s: %O ', name, info[name]);
+    }
+  }
+}
+
+async function managerExists(manager) {
+  try {
+    await manager.GetClassIdentification();
+    return true;
+  } catch (err) {
+    if (err.status != 5) {
+      throw err;
+    }
+
+    return false;
+  }
+}
+
+async function generateJson(objects) {
+  const result = [];
+
+  for (let i = 0; i < objects.length; i++) {
+    const o = objects[i];
+
+    if (Array.isArray(o)) {
+      await printTreeJson(o, lastPath);
+      continue;
+    }
+
+    const info = await fetchObjectInfo(o);
+
+    if (o instanceof OcaBlock) {
+      const members = objects[i + 1];
+      if (!Array.isArray(members)) {
+        throw new Error('Member missing for OcaBlock.');
       }
-    });
+      info.Members = await generateJson(members);
+      i++;
+    }
+
+    result.push(info);
   }
+
+  return result;
 }
 
-async function printDevice(device)
-{
+async function printTreeJson(objects) {
+  console.log(JSON.stringify(await generateJson(objects), undefined, 2));
+}
+
+async function printDevice(device) {
+  const print = jsonMode ? printTreeJson : printTree;
   try {
-    await printTree(await device.GetDeviceTree());
+    const objects = await device.GetDeviceTree();
     const managers = [
       device.DeviceManager,
       device.SecurityManager,
@@ -77,17 +190,14 @@ async function printDevice(device)
       device.DeviceTimeManager,
       device.TaskManager,
       device.CodingManager,
-      device.DiagnosticManager
+      device.DiagnosticManager,
     ];
-    for (let i = 0; i < managers.length; i++) {
-      try {
-        await printTree([ managers[i] ]);
-      } catch (err) {
-        if (err.status != 5) {
-          throw err;
-        }
-      }
+
+    for (const manager of managers) {
+      if (await managerExists(manager)) objects.push(manager);
     }
+
+    await print(objects);
     exit(0);
   } catch (error) {
     if (error.status) {