aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaDataset.d.ts

@@ -0,0 +1,223 @@
+import { IOcaLockState } from '../../types/OcaLockState';
+import { OcaTime } from '../../types/OcaTime';
+import { Arguments } from '../arguments';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaRoot } from './OcaRoot';
+
+/**
+ *
+ *  - An OCA Dataset. A dataset is like a simple binary file that can be read
+ *    and written.
+ *
+ *  - Every dataset is a separate **OcaDataset** object.
+ *
+ *
+ * @extends OcaRoot
+ * @class OcaDataset
+ */
+export declare class OcaDataset extends OcaRoot {
+  /**
+   * This event is emitted whenever Name changes.
+   */
+  OnNameChanged: PropertyEvent<string>;
+
+  /**
+   * This event is emitted whenever Type changes.
+   */
+  OnTypeChanged: PropertyEvent<string>;
+
+  /**
+   * This event is emitted whenever ReadOnly changes.
+   */
+  OnReadOnlyChanged: PropertyEvent<boolean>;
+
+  /**
+   * This event is emitted whenever LastModificationTime changes.
+   */
+  OnLastModificationTimeChanged: PropertyEvent<OcaTime>;
+
+  /**
+   * This event is emitted whenever MaxSize changes.
+   */
+  OnMaxSizeChanged: PropertyEvent<number | BigInt>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Opens a reading session. Returns status = **ProcessingFailed** if handle
+   * pool is used up.
+   * The return values of this method are
+   *
+   * - DatasetSize of type ``number|BigInt``
+   * - Handle of type ``number``
+   *
+   * @method OcaDataset#OpenRead
+   * @param {IOcaLockState} RequestedLockState
+   *
+   * @returns {Promise<Arguments<number|BigInt,number>>}
+   */
+  OpenRead(
+    RequestedLockState: IOcaLockState
+  ): Promise<Arguments<[number | BigInt, number]>>;
+
+  /**
+   * Opens a writing session. Returns status = **ProcessingFailed** if handle
+   * pool is used up.
+   * The return values of this method are
+   *
+   * - MaxPartSize of type ``number|BigInt``
+   * - Handle of type ``number``
+   *
+   * @method OcaDataset#OpenWrite
+   * @param {IOcaLockState} RequestedLockState
+   *
+   * @returns {Promise<Arguments<number|BigInt,number>>}
+   */
+  OpenWrite(
+    RequestedLockState: IOcaLockState
+  ): Promise<Arguments<[number | BigInt, number]>>;
+
+  /**
+   * Closes a reading or writing session.
+   *
+   * @method OcaDataset#Close
+   * @param {number} Handle
+   *
+   * @returns {Promise<void>}
+   */
+  Close(Handle: number): Promise<void>;
+
+  /**
+   * Reads a part of the Dataset.
+   * The return values of this method are
+   *
+   * - EndOfData of type ``boolean``
+   * - Part of type ``Uint8Array``
+   *
+   * @method OcaDataset#Read
+   * @param {number} Handle
+   * @param {number|BigInt} Position
+   * @param {number|BigInt} PartSize
+   *
+   * @returns {Promise<Arguments<boolean,Uint8Array>>}
+   */
+  Read(
+    Handle: number,
+    Position: number | BigInt,
+    PartSize: number | BigInt
+  ): Promise<Arguments<[boolean, Uint8Array]>>;
+
+  /**
+   * Writes a part of the dataset.
+   *
+   * @method OcaDataset#Write
+   * @param {number} Handle
+   * @param {number|BigInt} Position
+   * @param {Uint8Array} Part
+   *
+   * @returns {Promise<void>}
+   */
+  Write(
+    Handle: number,
+    Position: number | BigInt,
+    Part: Uint8Array
+  ): Promise<void>;
+
+  /**
+   * Removes all data from the dataset.
+   *
+   * @method OcaDataset#Clear
+   * @param {number} Handle
+   *
+   * @returns {Promise<void>}
+   */
+  Clear(Handle: number): Promise<void>;
+
+  /**
+   * Gets the value of property **Owner**.
+   *
+   * @method OcaDataset#GetOwner
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  GetOwner(): Promise<number>;
+
+  /**
+   * Gets the value of property **Name**.
+   *
+   * @method OcaDataset#GetName
+   * @returns {Promise<string>}
+   *   A promise which resolves to a single value of type ``string``.
+   */
+  GetName(): Promise<string>;
+
+  /**
+   * Sets the value of property **Name**.
+   *
+   * @method OcaDataset#SetName
+   * @param {string} Name
+   *
+   * @returns {Promise<void>}
+   */
+  SetName(Name: string): Promise<void>;
+
+  /**
+   * Gets the value of property **Type**.
+   *
+   * @method OcaDataset#GetType
+   * @returns {Promise<string>}
+   *   A promise which resolves to a single value of type ``string``.
+   */
+  GetType(): Promise<string>;
+
+  /**
+   * Sets the value of property **Type** .
+   *
+   * @method OcaDataset#SetType
+   * @param {string} Type
+   *
+   * @returns {Promise<void>}
+   */
+  SetType(Type: string): Promise<void>;
+
+  /**
+   * Gets the value of the **Readonly** property.
+   *
+   * @method OcaDataset#GetReadOnly
+   * @returns {Promise<boolean>}
+   *   A promise which resolves to a single value of type ``boolean``.
+   */
+  GetReadOnly(): Promise<boolean>;
+
+  /**
+   * Sets the value of the **Readonly** property. Optional method.
+   *
+   * @method OcaDataset#SetReadOnly
+   * @param {boolean} ReadOnly
+   *
+   * @returns {Promise<void>}
+   */
+  SetReadOnly(ReadOnly: boolean): Promise<void>;
+
+  /**
+   * Gets the value of property **LastModificationTime**. Optional method.
+   *
+   * @method OcaDataset#GetLastModificationTime
+   * @returns {Promise<OcaTime>}
+   *   A promise which resolves to a single value of type :class:`OcaTime`.
+   */
+  GetLastModificationTime(): Promise<OcaTime>;
+
+  /**
+   * Gets current & max sizes
+   * The return values of this method are
+   *
+   * - CurrentSize of type ``number|BigInt``
+   * - MaxSize of type ``number|BigInt``
+   *
+   * @method OcaDataset#GetDatasetSizes
+   * @returns {Promise<Arguments<number|BigInt,number|BigInt>>}
+   */
+  GetDatasetSizes(): Promise<Arguments<[number | BigInt, number | BigInt]>>;
+}

package/src/controller/ControlClasses/OcaDataset.js

@@ -0,0 +1,234 @@
+import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
+import { OcaLockState } from '../../OCP1/OcaLockState.js';
+import { OcaLongBlob } from '../../OCP1/OcaLongBlob.js';
+import { OcaString } from '../../OCP1/OcaString.js';
+import { OcaTime } from '../../OCP1/OcaTime.js';
+import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { OcaUint64 } from '../../OCP1/OcaUint64.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaRoot } from './OcaRoot.js';
+
+/**
+ *
+ *  - An OCA Dataset. A dataset is like a simple binary file that can be read
+ *    and written.
+ *
+ *  - Every dataset is a separate **OcaDataset** object.
+ *
+ *
+ * @extends OcaRoot
+ * @class OcaDataset
+ */
+export const OcaDataset = make_control_class(
+  'OcaDataset',
+  2,
+  '\u0001\u0005',
+  1,
+  OcaRoot,
+  [
+    ['OpenRead', 2, 1, [OcaLockState], [OcaUint64, OcaUint32]],
+    ['OpenWrite', 2, 2, [OcaLockState], [OcaUint64, OcaUint32]],
+    ['Close', 2, 3, [OcaUint32], []],
+    [
+      'Read',
+      2,
+      4,
+      [OcaUint32, OcaUint64, OcaUint64],
+      [OcaBoolean, OcaLongBlob],
+    ],
+    ['Write', 2, 5, [OcaUint32, OcaUint64, OcaLongBlob], []],
+    ['Clear', 2, 6, [OcaUint32], []],
+    ['GetOwner', 2, 7, [], [OcaUint32]],
+    ['GetName', 2, 8, [], [OcaString]],
+    ['SetName', 2, 9, [OcaString], []],
+    ['GetType', 2, 10, [], [OcaString]],
+    ['SetType', 2, 11, [OcaString], []],
+    ['GetReadOnly', 2, 12, [], [OcaBoolean]],
+    ['SetReadOnly', 2, 13, [OcaBoolean], []],
+    ['GetLastModificationTime', 2, 14, [], [OcaTime]],
+    ['GetDatasetSizes', 2, 15, [], [OcaUint64, OcaUint64]],
+  ],
+  [
+    ['Owner', [OcaUint32], 2, 1, true, false, null],
+    ['Name', [OcaString], 2, 2, false, false, null],
+    ['Type', [OcaString], 2, 3, false, false, null],
+    ['ReadOnly', [OcaBoolean], 2, 4, false, false, null],
+    ['LastModificationTime', [OcaTime], 2, 5, false, false, null],
+    ['MaxSize', [OcaUint64], 2, 6, false, false, null],
+  ],
+  []
+);
+
+/**
+ * Opens a reading session. Returns status = **ProcessingFailed** if handle pool
+ * is used up.
+ * The return values of this method are
+ *
+ * - DatasetSize of type ``number|BigInt``
+ * - Handle of type ``number``
+ *
+ * @method OcaDataset#OpenRead
+ * @param {IOcaLockState} RequestedLockState
+ *
+ * @returns {Promise<Arguments<number|BigInt,number>>}
+ */
+/**
+ * Opens a writing session. Returns status = **ProcessingFailed** if handle pool
+ * is used up.
+ * The return values of this method are
+ *
+ * - MaxPartSize of type ``number|BigInt``
+ * - Handle of type ``number``
+ *
+ * @method OcaDataset#OpenWrite
+ * @param {IOcaLockState} RequestedLockState
+ *
+ * @returns {Promise<Arguments<number|BigInt,number>>}
+ */
+/**
+ * Closes a reading or writing session.
+ *
+ * @method OcaDataset#Close
+ * @param {number} Handle
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Reads a part of the Dataset.
+ * The return values of this method are
+ *
+ * - EndOfData of type ``boolean``
+ * - Part of type ``Uint8Array``
+ *
+ * @method OcaDataset#Read
+ * @param {number} Handle
+ * @param {number|BigInt} Position
+ * @param {number|BigInt} PartSize
+ *
+ * @returns {Promise<Arguments<boolean,Uint8Array>>}
+ */
+/**
+ * Writes a part of the dataset.
+ *
+ * @method OcaDataset#Write
+ * @param {number} Handle
+ * @param {number|BigInt} Position
+ * @param {Uint8Array} Part
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Removes all data from the dataset.
+ *
+ * @method OcaDataset#Clear
+ * @param {number} Handle
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of property **Owner**.
+ *
+ * @method OcaDataset#GetOwner
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * Gets the value of property **Name**.
+ *
+ * @method OcaDataset#GetName
+ * @returns {Promise<string>}
+ *   A promise which resolves to a single value of type ``string``.
+ */
+/**
+ * Sets the value of property **Name**.
+ *
+ * @method OcaDataset#SetName
+ * @param {string} Name
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of property **Type**.
+ *
+ * @method OcaDataset#GetType
+ * @returns {Promise<string>}
+ *   A promise which resolves to a single value of type ``string``.
+ */
+/**
+ * Sets the value of property **Type** .
+ *
+ * @method OcaDataset#SetType
+ * @param {string} Type
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of the **Readonly** property.
+ *
+ * @method OcaDataset#GetReadOnly
+ * @returns {Promise<boolean>}
+ *   A promise which resolves to a single value of type ``boolean``.
+ */
+/**
+ * Sets the value of the **Readonly** property. Optional method.
+ *
+ * @method OcaDataset#SetReadOnly
+ * @param {boolean} ReadOnly
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of property **LastModificationTime**. Optional method.
+ *
+ * @method OcaDataset#GetLastModificationTime
+ * @returns {Promise<OcaTime>}
+ *   A promise which resolves to a single value of type :class:`OcaTime`.
+ */
+/**
+ * Gets current & max sizes
+ * The return values of this method are
+ *
+ * - CurrentSize of type ``number|BigInt``
+ * - MaxSize of type ``number|BigInt``
+ *
+ * @method OcaDataset#GetDatasetSizes
+ * @returns {Promise<Arguments<number|BigInt,number|BigInt>>}
+ */
+/**
+ * This event is emitted when the property ``Name`` changes in the remote object.
+ * The property ``Name`` is described in the AES70 standard as follows.
+ * Name of dataset. Must be unique in the device.
+ *
+ * @member {PropertyEvent<string>} OcaDataset#OnNameChanged
+ */
+/**
+ * This event is emitted when the property ``Type`` changes in the remote object.
+ * The property ``Type`` is described in the AES70 standard as follows.
+ * Type of dataset - MIME 'content-type' value. See the definition of
+ * **OcaMimeType**. The standard MIME types for AES70 datasets are defined
+ * normatively in [AES70-1(Dataset Type)].
+ *
+ * @member {PropertyEvent<string>} OcaDataset#OnTypeChanged
+ */
+/**
+ * This event is emitted when the property ``ReadOnly`` changes in the remote object.
+ * The property ``ReadOnly`` is described in the AES70 standard as follows.
+ * TRUE ``=>`` dataset is read-only. Value may or may not be changed, depending
+ * on implementation.
+ *
+ * @member {PropertyEvent<boolean>} OcaDataset#OnReadOnlyChanged
+ */
+/**
+ * This event is emitted when the property ``LastModificationTime`` changes in the remote object.
+ * The property ``LastModificationTime`` is described in the AES70 standard as follows.
+ * Time of last modification. Optional, may be zero if not implemented.
+ *
+ * @member {PropertyEvent<OcaTime>} OcaDataset#OnLastModificationTimeChanged
+ */
+/**
+ * This event is emitted when the property ``MaxSize`` changes in the remote object.
+ * The property ``MaxSize`` is described in the AES70 standard as follows.
+ * Maximum dataset size in bytes.
+ *
+ * @member {PropertyEvent<number|BigInt>} OcaDataset#OnMaxSizeChanged
+ */

package/src/controller/ControlClasses/OcaDatasetWorker.d.ts

@@ -0,0 +1,31 @@
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaWorker } from './OcaWorker';
+
+/**
+ * Abstract base class for Dataset Workers, i.e. Workers that perform operations
+ * on Datasets.
+ * @extends OcaWorker
+ * @class OcaDatasetWorker
+ */
+export declare class OcaDatasetWorker extends OcaWorker {
+  /**
+   * This event is emitted whenever DatasetONo changes.
+   */
+  OnDatasetONoChanged: PropertyEvent<number>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Returns object number associated Dataset Object, or zero if no Dataset is
+   * associated. Note: There is no corresponding **Set(...)** method, because it
+   * is assumed the Dataset will be associated either at construction time, or
+   * by actions defined by child classes, e.g. the **Open(...)** method of the
+   * child class **OcaMediaRecorderPlayer**.
+   *
+   * @method OcaDatasetWorker#GetDatasetONo
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  GetDatasetONo(): Promise<number>;
+}

package/src/controller/ControlClasses/OcaDatasetWorker.js

@@ -0,0 +1,40 @@
+import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaWorker } from './OcaWorker.js';
+
+/**
+ * Abstract base class for Dataset Workers, i.e. Workers that perform operations
+ * on Datasets.
+ * @extends OcaWorker
+ * @class OcaDatasetWorker
+ */
+export const OcaDatasetWorker = make_control_class(
+  'OcaDatasetWorker',
+  3,
+  '\u0001\u0001\u0007',
+  3,
+  OcaWorker,
+  [['GetDatasetONo', 3, 1, [], [OcaUint32]]],
+  [['DatasetONo', [OcaUint32], 3, 1, false, false, null]],
+  []
+);
+
+/**
+ * Returns object number associated Dataset Object, or zero if no Dataset is
+ * associated. Note: There is no corresponding **Set(...)** method, because it
+ * is assumed the Dataset will be associated either at construction time, or by
+ * actions defined by child classes, e.g. the **Open(...)** method of the child
+ * class **OcaMediaRecorderPlayer**.
+ *
+ * @method OcaDatasetWorker#GetDatasetONo
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * This event is emitted when the property ``DatasetONo`` changes in the remote object.
+ * The property ``DatasetONo`` is described in the AES70 standard as follows.
+ * ONo of the **OcaDataset** object that this Dataset Worker is currently
+ * working on, zero if none.
+ *
+ * @member {PropertyEvent<number>} OcaDatasetWorker#OnDatasetONoChanged
+ */

package/src/controller/ControlClasses/OcaDelay.d.ts

@@ -17,8 +17,7 @@ export declare class OcaDelay extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the DelayTime property. The return value indicates
-   * whether the property was successfully retrieved.
+   * Gets the value and limits of the **DelayTime** property.
    * The return values of this method are
    *
    * - Time of type ``number``
@@ -31,8 +30,7 @@ export declare class OcaDelay extends OcaActuator {
   GetDelayTime(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the DelayTime property. The return value indicates
-   * whether the property was successfully set.
+   * Sets the value of the **DelayTime** property.
    *
    * @method OcaDelay#SetDelayTime
    * @param {number} delayTime

package/src/controller/ControlClasses/OcaDelay.js

@@ -11,7 +11,7 @@ export const OcaDelay = make_control_class(
   'OcaDelay',
   4,
   '\u0001\u0001\u0001\u0007',
-  2,
+  3,
   OcaActuator,
   [
     ['GetDelayTime', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
@@ -22,8 +22,7 @@ export const OcaDelay = make_control_class(
 );
 
 /**
- * Gets the value of the DelayTime property. The return value indicates whether
- * the property was successfully retrieved.
+ * Gets the value and limits of the **DelayTime** property.
  * The return values of this method are
  *
  * - Time of type ``number``
@@ -34,8 +33,7 @@ export const OcaDelay = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the DelayTime property. The return value indicates whether
- * the property was successfully set.
+ * Sets the value of the **DelayTime** property.
  *
  * @method OcaDelay#SetDelayTime
  * @param {number} delayTime

package/src/controller/ControlClasses/OcaDelayExtended.d.ts

@@ -8,7 +8,8 @@ import { OcaDelay } from './OcaDelay';
 /**
  * Signal delay - extended version. Allows setting delay value in various units.
  * Note that the inherited property 04p01 DelayTime is also supported by this
- * class and reflects actual achieved delay in seconds.
+ * class and reflects actual achieved delay in seconds. This class is
+ * **deprecated** in AES70-2022.
  * @extends OcaDelay
  * @class OcaDelayExtended
  */
@@ -21,8 +22,7 @@ export declare class OcaDelayExtended extends OcaDelay {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the DelayValue property. The return value indicates
-   * whether the property was successfully retrieved.
+   * Gets the value and limits of the **DelayValue** property.
    * The return values of this method are
    *
    * - Value of type ``IOcaDelayValue``
@@ -37,8 +37,7 @@ export declare class OcaDelayExtended extends OcaDelay {
   >;
 
   /**
-   * Sets the value of the DelayValue property. The return value indicates
-   * whether the property was successfully set.
+   * Sets the value of the **DelayValue** property.
    *
    * @method OcaDelayExtended#SetDelayValue
    * @param {IOcaDelayValue} Value
@@ -48,8 +47,7 @@ export declare class OcaDelayExtended extends OcaDelay {
   SetDelayValue(Value: IOcaDelayValue): Promise<void>;
 
   /**
-   * Return current delay setting, converted to given units. The return value
-   * indicates whether the method has succeeded.
+   * Get current delay setting, converted to given units.
    *
    * @method OcaDelayExtended#GetDelayValueConverted
    * @param {IOcaDelayUnit} UoM

package/src/controller/ControlClasses/OcaDelayExtended.js

@@ -6,7 +6,8 @@ import { OcaDelay } from './OcaDelay.js';
 /**
  * Signal delay - extended version. Allows setting delay value in various units.
  * Note that the inherited property 04p01 DelayTime is also supported by this
- * class and reflects actual achieved delay in seconds.
+ * class and reflects actual achieved delay in seconds. This class is
+ * **deprecated** in AES70-2022.
  * @extends OcaDelay
  * @class OcaDelayExtended
  */
@@ -14,7 +15,7 @@ export const OcaDelayExtended = make_control_class(
   'OcaDelayExtended',
   5,
   '\u0001\u0001\u0001\u0007\u0001',
-  2,
+  3,
   OcaDelay,
   [
     ['GetDelayValue', 5, 1, [], [OcaDelayValue, OcaDelayValue, OcaDelayValue]],
@@ -26,8 +27,7 @@ export const OcaDelayExtended = make_control_class(
 );
 
 /**
- * Gets the value of the DelayValue property. The return value indicates whether
- * the property was successfully retrieved.
+ * Gets the value and limits of the **DelayValue** property.
  * The return values of this method are
  *
  * - Value of type ``IOcaDelayValue``
@@ -38,8 +38,7 @@ export const OcaDelayExtended = make_control_class(
  * @returns {Promise<Arguments<OcaDelayValue,OcaDelayValue,OcaDelayValue>>}
  */
 /**
- * Sets the value of the DelayValue property. The return value indicates whether
- * the property was successfully set.
+ * Sets the value of the **DelayValue** property.
  *
  * @method OcaDelayExtended#SetDelayValue
  * @param {IOcaDelayValue} Value
@@ -47,8 +46,7 @@ export const OcaDelayExtended = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Return current delay setting, converted to given units. The return value
- * indicates whether the method has succeeded.
+ * Get current delay setting, converted to given units.
  *
  * @method OcaDelayExtended#GetDelayValueConverted
  * @param {IOcaDelayUnit} UoM