aes70 1.6.1 → 2.0.0

package/COPYING

@@ -1,14 +1,14 @@
-Copyright (C) 2016-2018  Arne Goedeke       <arne@deuso.de>
+Copyright (C) 2016- Arne Goedeke <arne@deuso.de>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; version 2 of the License.
 
 This program is distributed in the hope that it will be useful,
-     but WITHOUT ANY WARRANTY; without even the implied warranty of
-     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-     GNU General Public License for more details.
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
 
-     You should have received a copy of the GNU General Public License along
-     with this program; if not, write to the Free Software Foundation, Inc.,
-     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

package/Changelog

@@ -2,6 +2,15 @@
 
 All notable changes and version updates will be documented in this file.
 
+## [2.0.0] - 2025-10-07
+
+- Updates to AES70-2024
+  This includes many new datatypes and control classes. It also includes
+  changes APIs, especially around event handling. The main change is that
+  event subscriptions now expect a second callback which can be used to
+  receive error/cancellation events. They were introduced in aes70-2024
+  to signal e.g. object deletion.
+
 ## [1.6.1] - 2025-05-06
 
 - TCPConnection.connect: Add connecSignal to abort

package/README.md

@@ -30,8 +30,7 @@ need to implement all classes involved.
 All classes and datatypes defined in the
 current AES70 Standard are published in the form of an XMI document. This XMI
 document has been used to generate the class structure and interfaces which
-are part of this library. At this point AES70.js fully supports the most recent
-version AES70-2018.
+are part of this library. At this point AES70.js supports the version AES70-2024.
 
 # Basics
 
@@ -108,63 +107,96 @@ done using the method `RemoteDevice.get_device_tree()` method.
 
 A full working example:
 
-        import { TCPConnection, RemoteDevice } from 'aes70';
+```js
+import { TCPConnection, RemoteDevice } from 'aes70';
 
-        async function run()
-        {
-          const connection = await TCPConnection.connect({
-              host: 'example.org',
-              port: 65000,
-          });
-          const device = new RemoteDevice(connection);
+async function run() {
+  const connection = await TCPConnection.connect({
+    host: 'example.org',
+    port: 65000,
+  });
+  const device = new RemoteDevice(connection);
 
-          device.set_keepalive_interval(1);
+  device.set_keepalive_interval(1);
 
-          console.log("Device name:", await device.DeviceManager.GetModelDescription());
+  console.log('Device name:', await device.DeviceManager.GetModelDescription());
 
-          console.log("Object inside this device:");
+  console.log('Object inside this device:');
 
-          const tree = await device.get_device_tree();
+  const tree = await device.get_device_tree();
 
-          const rec = async (a) => {
-            for (let i = 0; i < a.length; i++)
-            {
-              const obj = a[i];
+  const rec = async (a) => {
+    for (let i = 0; i < a.length; i++) {
+      const obj = a[i];
 
-              if (Array.isArray(obj))
-              {
-                // children
-                await rec(obj);
-              }
-              else
-              {
-                console.log("Type: %s", obj.constructor.ClassName);
-                console.log("Properties:");
-                const properties = obj.GetPropertySync();
+      if (Array.isArray(obj)) {
+        // children
+        await rec(obj);
+      } else {
+        console.log('Type: %s', obj.constructor.ClassName);
+        console.log('Properties:');
+        const properties = obj.GetPropertySync();
 
-                // fetch the values of all properties from the device.
-                await properties.sync();
+        // fetch the values of all properties from the device.
+        await properties.sync();
 
-                properties.forEach((value, name) => {
-                  if (value !== undefined)
-                    console.log("  %s: %o", name, value);
-                });
+        properties.forEach((value, name) => {
+          if (value !== undefined) console.log('  %s: %o', name, value);
+        });
 
-                // unsubscribe all event handlers
-                properties.Dispose();
-              }
-            }
-          };
+        // unsubscribe all event handlers
+        properties.Dispose();
+      }
+    }
+  };
 
-          await rec(tree);
-        }
+  await rec(tree);
+}
 
-        run().then(() => console.log("Done."));
+run().then(() => console.log('Done.'));
+```
 
 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.
 
+## Logging AES70 packets
+
+To understand what packets are being sent on a connection one possible option
+is to subscribe to the `send` and `receive` events. The `ClientConnection` class
+can then be queried for additional information about these packets to understand
+what method calls they correspond. This example code can be used:
+
+```js
+connection.on('error', (error) => console.error('connection error', error));
+connection.on('receive', (pdu) => {
+  if (pdu instanceof Response) {
+    const pendingCommand = connection.find_pending_command(pdu);
+    if (pendingCommand) {
+      console.log(
+        'RECV',
+        pendingCommand.name,
+        pendingCommand.get_arguments(),
+        '->',
+        Types.OcaStatus.getName(pdu.status_code)
+      );
+    }
+  } else {
+    console.log('RECV', pdu);
+  }
+});
+connection.on('send', (pdu) => {
+  if (pdu instanceof Command) {
+    const pendingCommand = connection.find_pending_command(pdu);
+    if (pendingCommand) {
+      console.log('SEND', pendingCommand.name, pendingCommand.get_arguments());
+    }
+  } else {
+    console.log('SEND', pdu);
+  }
+});
+```
+
 # Documentation
 
 The documentation for this library is built using