aes70 1.3.8 → 1.4.1

package/src/controller/abstract_udp_connection.js

@@ -11,15 +11,15 @@ function delay(n) {
 
 async function waitForKeepalive(socket, options) {
   const waiter = socket.receiveMessage().then((buffer) => {
-      const pdus = [];
-      let pos = 0;
+    const pdus = [];
+    const pos = decodeMessage(new DataView(buffer), 0, pdus);
 
-      pos = decodeMessage(new DataView(buffer), 0, pdus);
+    if (pdus.length !== 1) throw new Error('Expected keepalive response.');
+    if (pos !== buffer.byteLength)
+      throw new Error('Trailing data in initial keepalive pdu.');
 
-      if (pdus.length !== 1) throw new Error('Expected keepalive response.');
-
-      return true;
-    });
+    return true;
+  });
 
   const msg = encodeMessage(new KeepAlive(1000));
   const t = 5 * (options.retry_interval || 250);
@@ -97,7 +97,11 @@ export class AbstractUDPConnection extends ClientConnection {
    *    The connection.
    */
   static async connect(udpApi, options) {
-    const socket = await udpApi.connect(options.host, options.port, options.type);
+    const socket = await udpApi.connect(
+      options.host,
+      options.port,
+      options.type
+    );
 
     await waitForKeepalive(socket, options);
 

package/src/controller/client_connection.d.ts

@@ -1,6 +1,6 @@
 import { IConnectionOptions, Connection } from '../connection';
 
-export type IClientConnectionOptions = IConnectionOptions
+export type IClientConnectionOptions = IConnectionOptions;
 
 /**
  * A generic base class for all client connections.

package/src/controller/node_udp.js

@@ -1,12 +1,11 @@
 /* eslint-env node */
 
 import { createSocket } from 'dgram';
-import { isIPv4, isIPv6 } from 'net';
+import { isIP } from 'net';
 import { lookup } from 'dns';
 
 function lookup_address(host) {
-  if (isIPv4(host))
-    return Promise.resolve(host);
+  if (isIP(host)) return Promise.resolve(host);
 
   return new Promise((resolve, reject) => {
     lookup(host, { family: 4 }, (err, address) => {
@@ -69,7 +68,7 @@ export class NodeUDP {
 
     onerror(error);
   }
-  
+
   send(buf) {
     this.socket.send(Buffer.from(buf));
   }

package/src/controller/property_event.js

@@ -12,7 +12,7 @@ import { error } from '../log.js';
 export class PropertyEvent extends BaseEvent {
   constructor(object, id, propertyType) {
     super(object, id, propertyType);
-    this.callback = (id, dataView, changeType) => {
+    this.callback = ([id, dataView, changeType]) => {
       if (
         id.DefLevel !== this.id.DefLevel ||
         id.PropertyIndex !== this.id.PropertyIndex

package/src/controller/websocket_connection.d.ts

@@ -0,0 +1,17 @@
+import {
+  WebSocketConnectionBase,
+  IWebSocketConnectionBaseOptions,
+} from './websocket_connection_base';
+
+export type WebSocketConnectionOptions = IWebSocketConnectionBaseOptions;
+
+export class WebSocketConnection extends WebSocketConnectionBase {
+  constructor(ws: WebSocket, options: WebSocketConnectionOptions);
+  static connectWebSocket(
+    WebSocket: typeof WebSocket,
+    options: WebSocketConnectionOptions
+  ): Promise<WebSocket>;
+  static connect(
+    options: WebSocketConnectionOptions
+  ): Promise<WebSocketConnection>;
+}

package/src/controller/websocket_connection.js

@@ -1,30 +1,9 @@
-import { ClientConnection } from './client_connection.js';
+import { WebSocketConnectionBase } from './websocket_connection_base.js';
 
 /**
- * :class:`ClientConnection` subclass which implements OCP.1 with WebSocket
- * transport.
+ * Connection which implements OCP.1 with WebSocket transport.
  */
-export class WebSocketConnection extends ClientConnection {
-  constructor(ws, options) {
-    super(options);
-    this.ws = ws;
-    ws.binaryType = 'arraybuffer';
-    ws.addEventListener('message', (ev) => {
-      this.read(ev.data);
-    });
-    ws.addEventListener('close', () => {
-      this.emit('close');
-    });
-    ws.addEventListener('error', () => {
-      this.emit('error');
-    });
-  }
-
-  write(buf) {
-    this.ws.send(buf);
-    super.write(buf);
-  }
-
+export class WebSocketConnection extends WebSocketConnectionBase {
   /**
    * Connect to the given endpoint.
    *
@@ -35,28 +14,7 @@ export class WebSocketConnection extends ClientConnection {
    *    The connection.
    */
   static connect(options) {
-    return new Promise((resolve, reject) => {
-      const ws = new WebSocket(options.url);
-      const on_error = function (e) {
-        reject(e);
-      };
-
-      ws.addEventListener('open', () => {
-        ws.removeEventListener('error', on_error);
-        resolve(new this(ws, options));
-      });
-      ws.addEventListener('error', on_error);
-    });
-  }
-
-  cleanup() {
-    super.cleanup();
-    if (this.ws) {
-      try {
-        this.ws.close();
-      } catch (err) {}
-      this.ws = null;
-    }
+    return super.connect(WebSocket, options);
   }
 
   _now() {

package/src/controller/websocket_connection_base.d.ts

@@ -0,0 +1,18 @@
+import {
+  IClientConnectionOptions,
+  ClientConnection,
+} from './client_connection';
+
+export interface IWebSocketConnectionBaseOptions
+  extends IClientConnectionOptions {
+  url: string;
+}
+
+/**
+ * :class:`ClientConnection` subclass which implements OCP.1 with WebSocket
+ * transport. This is a generic base class used both by NodeJS and in the
+ * Browser.
+ */
+export class WebSocketConnectionBase extends ClientConnection {
+  write(buf: ArrayBuffer): void;
+}

package/src/controller/websocket_connection_base.js

@@ -0,0 +1,70 @@
+import { ClientConnection } from './client_connection.js';
+
+/**
+ * :class:`ClientConnection` subclass which implements OCP.1 with WebSocket
+ * transport. This is a generic base class used both by NodeJS and in the
+ * Browser.
+ */
+export class WebSocketConnectionBase extends ClientConnection {
+  constructor(ws, options) {
+    super(options);
+    this.ws = ws;
+    ws.binaryType = 'arraybuffer';
+    ws.addEventListener('message', (ev) => {
+      try {
+        this.read(ev.data);
+      } catch (e) {
+        this.emit('error', e);
+      }
+    });
+    ws.addEventListener('close', () => {
+      this.emit('close');
+    });
+    ws.addEventListener('error', (e) => {
+      this.emit('error', e);
+    });
+  }
+
+  write(buf) {
+    this.ws.send(buf);
+    super.write(buf);
+  }
+
+  /**
+   * Connect to the given endpoint.
+   *
+   * @param {Function} WebSocket
+   *    WebSocket implementation.
+   * @param {object} options
+   * @param {String} options.url
+   *    Endpoint WebSocket url.
+   * @returns {Promise<WebSocket>}
+   *    The connection.
+   */
+  static connect(WebSocket, options) {
+    return new Promise((resolve, reject) => {
+      const ws = new WebSocket(options.url);
+      const on_error = function (e) {
+        reject(e);
+      };
+
+      ws.addEventListener('open', () => {
+        ws.removeEventListener('error', on_error);
+        resolve(new this(ws, options));
+      });
+      ws.addEventListener('error', on_error);
+    });
+  }
+
+  cleanup() {
+    super.cleanup();
+    if (this.ws) {
+      try {
+        this.ws.close();
+      } catch (err) {
+        // ignore error
+      }
+      this.ws = null;
+    }
+  }
+}

package/src/controller/websocket_connection_node.d.ts

@@ -0,0 +1,18 @@
+import {
+  WebSocketConnectionBase,
+  IWebSocketConnectionBaseOptions,
+} from './websocket_connection_base';
+import WebSocket from 'ws';
+
+export type WebSocketConnectionOptions = IWebSocketConnectionBaseOptions;
+
+export class WebSocketConnection extends WebSocketConnectionBase {
+  constructor(ws: WebSocket, options: WebSocketConnectionOptions);
+  static connectWebSocket(
+    WebSocket: typeof WebSocket,
+    options: WebSocketConnectionOptions
+  ): Promise<WebSocket>;
+  static connect(
+    options: WebSocketConnectionOptions
+  ): Promise<WebSocketConnection>;
+}

package/src/controller/websocket_connection_node.js

@@ -2,64 +2,20 @@
 
 import WebSocket from 'ws';
 import { performance } from 'perf_hooks';
-
-import { ClientConnection } from './client_connection.js';
+import { WebSocketConnectionBase } from './websocket_connection_base.js';
 
 /**
- * :class:`ClientConnection` subclass which implements OCP.1 with WebSocket
- * transport.
+ * Connection which implements OCP.1 with WebSocket transport.
  */
-export class WebSocketConnection extends ClientConnection {
-  constructor(ws, options) {
-    super(options);
-    this.ws = ws;
-    ws.binaryType = 'arraybuffer';
-    ws.addEventListener('message', (ev) => {
-      this.read(ev.data);
-    });
-    ws.addEventListener('close', () => {
-      this.emit('close');
-    });
-    ws.addEventListener('error', () => {
-      this.emit('error');
-    });
-  }
-
-  write(buf) {
-    this.ws.send(buf);
-    super.write(buf);
-  }
-
+export class WebSocketConnection extends WebSocketConnectionBase {
   /**
    * Connect to the given endpoint.
    *
    * @param {String} options.url - Endpoint WebSocket url.
    * @returns {Promise<WebSocketConnection>} - The connection.
    */
-  static connect(options) {
-    return new Promise((resolve, reject) => {
-      const ws = new WebSocket(options.url);
-      const on_error = function (e) {
-        reject(e);
-      };
-
-      ws.addEventListener('open', () => {
-        ws.removeEventListener('error', on_error);
-        resolve(new this(ws, options));
-      });
-      ws.addEventListener('error', on_error);
-    });
-  }
-
-  cleanup() {
-    super.cleanup();
-    if (this.ws) {
-      try {
-        this.ws.close();
-      } catch (err) {}
-      this.ws.removeAllListeners();
-      this.ws = null;
-    }
+  static async connect(options) {
+    return super.connect(WebSocket, options);
   }
 
   _now() {

package/src/types/OcaBlockMember.d.ts

@@ -1,10 +1,9 @@
 /*
  * This file has been generated.
  */
-
 import {
-  OcaObjectIdentification,
   IOcaObjectIdentification,
+  OcaObjectIdentification,
 } from './OcaObjectIdentification';
 
 export declare interface IOcaBlockMember {

package/src/types/OcaClassAuthorityID.d.ts

@@ -5,39 +5,50 @@
 export declare interface IOcaClassAuthorityID {
   /**
    * Sentinel signifying an Authority ID
+   * @type number
    */
   Sentinel: number;
 
   /**
    * Reserved, must be zero.
+   * @type number
    */
   Reserved: number;
 
   /**
-   * Authority's IEEE public Company ID (public CID) or IEEE Organizational Unique Identifier (OUI), or the value zero, which signifies the Authority of this AES70 standard.
+   * Authority's IEEE public Company ID (public CID) or IEEE Organizational
+   * Unique Identifier (OUI), or the value zero, which signifies the Authority
+   * of this AES70 standard.
+   * @type Uint8Array
    */
   OrganizationID: Uint8Array;
 }
 
 export declare class OcaClassAuthorityID implements IOcaClassAuthorityID {
   /**
-   * Class authority identifier. Identifies the authority for a class's definition.
+   * Class authority identifier. Identifies the authority for a class's
+   * definition.
    * @class OcaClassAuthorityID
    */
   constructor(Sentinel: number, Reserved: number, OrganizationID: Uint8Array);
 
   /**
    * Sentinel signifying an Authority ID
+   * @type number
    */
   Sentinel: number;
 
   /**
    * Reserved, must be zero.
+   * @type number
    */
   Reserved: number;
 
   /**
-   * Authority's IEEE public Company ID (public CID) or IEEE Organizational Unique Identifier (OUI), or the value zero, which signifies the Authority of this AES70 standard.
+   * Authority's IEEE public Company ID (public CID) or IEEE Organizational
+   * Unique Identifier (OUI), or the value zero, which signifies the Authority
+   * of this AES70 standard.
+   * @type Uint8Array
    */
   OrganizationID: Uint8Array;
 }

package/src/types/OcaClassAuthorityID.js

@@ -4,20 +4,26 @@
 
 export class OcaClassAuthorityID {
   /**
-   * Class authority identifier. Identifies the authority for a class's definition.
+   * Class authority identifier. Identifies the authority for a class's
+   * definition.
    * @class OcaClassAuthorityID
    */
   constructor(Sentinel, Reserved, OrganizationID) {
     /**
      * Sentinel signifying an Authority ID
+     * @type number
      */
     this.Sentinel = Sentinel;
     /**
      * Reserved, must be zero.
+     * @type number
      */
     this.Reserved = Reserved;
     /**
-     * Authority's IEEE public Company ID (public CID) or IEEE Organizational Unique Identifier (OUI), or the value zero, which signifies the Authority of this AES70 standard.
+     * Authority's IEEE public Company ID (public CID) or IEEE Organizational
+     * Unique Identifier (OUI), or the value zero, which signifies the Authority
+     * of this AES70 standard.
+     * @type Uint8Array
      */
     this.OrganizationID = OrganizationID;
   }

package/src/types/OcaClassIdentification.d.ts

@@ -4,30 +4,31 @@
 
 export declare interface IOcaClassIdentification {
   /**
-   * This was not documented in the OCA standard.
+   * @type string
    */
   ClassID: string;
 
   /**
    * Version number of the class.
+   * @type number
    */
   ClassVersion: number;
 }
 
 export declare class OcaClassIdentification implements IOcaClassIdentification {
   /**
-   * This was not documented in the OCA standard.
    * @class OcaClassIdentification
    */
   constructor(ClassID: string, ClassVersion: number);
 
   /**
-   * This was not documented in the OCA standard.
+   * @type string
    */
   ClassID: string;
 
   /**
    * Version number of the class.
+   * @type number
    */
   ClassVersion: number;
 }

package/src/types/OcaClassIdentification.js

@@ -4,16 +4,16 @@
 
 export class OcaClassIdentification {
   /**
-   * This was not documented in the OCA standard.
    * @class OcaClassIdentification
    */
   constructor(ClassID, ClassVersion) {
     /**
-     * This was not documented in the OCA standard.
+     * @type string
      */
     this.ClassID = ClassID;
     /**
      * Version number of the class.
+     * @type number
      */
     this.ClassVersion = ClassVersion;
   }

package/src/types/OcaComponent.d.ts

@@ -2,7 +2,9 @@
  * This file has been generated.
  */
 /**
- * Enumeration (16-bit) for of software :raw:html:`&` firmware components in the device. Except for the boot loader, all other values of this enum are device-specific and will be specified by subclassing this class.
+ * Enumeration (16-bit) for of software & firmware components in the device.
+ * Except for the boot loader, all other values of this enum are device-specific
+ * and will be specified by subclassing this class.
  * @class OcaComponent
  */
 export class OcaComponent {

package/src/types/OcaComponent.js

@@ -4,7 +4,9 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration (16-bit) for of software :raw:html:`&` firmware components in the device. Except for the boot loader, all other values of this enum are device-specific and will be specified by subclassing this class.
+ * Enumeration (16-bit) for of software & firmware components in the device.
+ * Except for the boot loader, all other values of this enum are device-specific
+ * and will be specified by subclassing this class.
  * @class OcaComponent
  */
 export class OcaComponent extends Enum({

package/src/types/OcaDBr.d.ts

@@ -4,13 +4,14 @@
 
 export declare interface IOcaDBr {
   /**
-   * Absolute level in decibels relative to value of  **Ref**  property.
+   * Absolute level in decibels relative to value of **Ref** property.
    * @type number
    */
   Value: number;
 
   /**
-   * Reference level in dBz. See the definition of OcaDBz for an explanation of the dBz unit.
+   * Reference level in dBz. See the definition of OcaDBz for an explanation of
+   * the dBz unit.
    * @type number
    */
   Ref: number;
@@ -24,13 +25,14 @@ export declare class OcaDBr implements IOcaDBr {
   constructor(Value: number, Ref: number);
 
   /**
-   * Absolute level in decibels relative to value of  **Ref**  property.
+   * Absolute level in decibels relative to value of **Ref** property.
    * @type number
    */
   Value: number;
 
   /**
-   * Reference level in dBz. See the definition of OcaDBz for an explanation of the dBz unit.
+   * Reference level in dBz. See the definition of OcaDBz for an explanation of
+   * the dBz unit.
    * @type number
    */
   Ref: number;

package/src/types/OcaDBr.js

@@ -9,12 +9,13 @@ export class OcaDBr {
    */
   constructor(Value, Ref) {
     /**
-     * Absolute level in decibels relative to value of  **Ref**  property.
+     * Absolute level in decibels relative to value of **Ref** property.
      * @type number
      */
     this.Value = Value;
     /**
-     * Reference level in dBz. See the definition of OcaDBz for an explanation of the dBz unit.
+     * Reference level in dBz. See the definition of OcaDBz for an explanation
+     * of the dBz unit.
      * @type number
      */
     this.Ref = Ref;

package/src/types/OcaDelayValue.d.ts

@@ -1,8 +1,7 @@
 /*
  * This file has been generated.
  */
-
-import { OcaDelayUnit, IOcaDelayUnit } from './OcaDelayUnit';
+import { IOcaDelayUnit, OcaDelayUnit } from './OcaDelayUnit';
 
 export declare interface IOcaDelayValue {
   /**

package/src/types/OcaDeviceState.d.ts

@@ -2,7 +2,10 @@
  * This file has been generated.
  */
 /**
- * Bitset defining bit flags that indicate the device states CAP devices can be in. The state is returned by the device's Device Manager on request. Any combination of the flags may be returned, unless specified otherwise for the specific flag. The value 0x0000 indicates the device is fully operational.
+ * Bitset defining bit flags that indicate the device states CAP devices can be
+ * in. The state is returned by the device's Device Manager on request. Any
+ * combination of the flags may be returned, unless specified otherwise for the
+ * specific flag. The value 0x0000 indicates the device is fully operational.
  * @enum {number}
  * @readonly
  */
@@ -31,11 +34,6 @@ export declare const OcaDeviceState: {
    * Entry with value ``16``.
    */
   Updating: number;
-
-  /**
-   * Entry with value ``32``.
-   */
-  unused: number;
 };
 
 export declare type IOcaDeviceState = number;

package/src/types/OcaDeviceState.js

@@ -2,7 +2,10 @@
  * This file has been generated.
  */
 /**
- * Bitset defining bit flags that indicate the device states CAP devices can be in. The state is returned by the device's Device Manager on request. Any combination of the flags may be returned, unless specified otherwise for the specific flag. The value 0x0000 indicates the device is fully operational.
+ * Bitset defining bit flags that indicate the device states CAP devices can be
+ * in. The state is returned by the device's Device Manager on request. Any
+ * combination of the flags may be returned, unless specified otherwise for the
+ * specific flag. The value 0x0000 indicates the device is fully operational.
  * @enum {number}
  * @readonly
  */
@@ -12,7 +15,6 @@ export const OcaDeviceState = {
   Error: 4,
   Initializing: 8,
   Updating: 16,
-  unused: 32,
 };
 
 /**
@@ -50,10 +52,3 @@ export const OcaDeviceState = {
  * @memberof OcaDeviceState
  * @static
  */
-/**
- * Entry with value ``32``.
- * @type {number}
- * @member unused
- * @memberof OcaDeviceState
- * @static
- */

package/src/types/OcaDynamicsFunction.d.ts

@@ -2,7 +2,8 @@
  * This file has been generated.
  */
 /**
- * Enumeration of the types of dynamics functions available from class OcaDynamics.
+ * Enumeration of the types of dynamics functions available from class
+ * OcaDynamics.
  * @class OcaDynamicsFunction
  */
 export class OcaDynamicsFunction {

package/src/types/OcaDynamicsFunction.js

@@ -4,7 +4,8 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration of the types of dynamics functions available from class OcaDynamics.
+ * Enumeration of the types of dynamics functions available from class
+ * OcaDynamics.
  * @class OcaDynamicsFunction
  */
 export class OcaDynamicsFunction extends Enum({

package/src/types/OcaEvent.d.ts

@@ -1,8 +1,7 @@
 /*
  * This file has been generated.
  */
-
-import { OcaEventID, IOcaEventID } from './OcaEventID';
+import { IOcaEventID, OcaEventID } from './OcaEventID';
 
 export declare interface IOcaEvent {
   /**
@@ -20,7 +19,8 @@ export declare interface IOcaEvent {
 
 export declare class OcaEvent implements IOcaEvent {
   /**
-   * Representation of an OCA event, i.e. the unique combination of emitter ONo and the EventID.
+   * Representation of an OCA event, i.e. the unique combination of emitter ONo
+   * and the EventID.
    * @class OcaEvent
    */
   constructor(EmitterONo: number, EventID: OcaEventID);