aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaSwitch.js

@@ -6,7 +6,9 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaActuator } from './OcaActuator.js';
 
 /**
- * (n)-position single-pole switch.
+ * (n)-position switch. Single-pole or multipole, as determined by number of
+ * input and output ports. May be instantiated with no ports for use as an
+ * option selector.
  * @extends OcaActuator
  * @class OcaSwitch
  */
@@ -14,7 +16,7 @@ export const OcaSwitch = make_control_class(
   'OcaSwitch',
   4,
   '\u0001\u0001\u0001\u0004',
-  2,
+  3,
   OcaActuator,
   [
     ['GetPosition', 4, 1, [], [OcaUint16, OcaUint16, OcaUint16]],
@@ -23,23 +25,57 @@ export const OcaSwitch = make_control_class(
     ['SetPositionName', 4, 4, [OcaUint16, OcaString], []],
     ['GetPositionNames', 4, 5, [], [OcaList(OcaString)]],
     ['SetPositionNames', 4, 6, [OcaList(OcaString)], []],
-    ['GetPositionEnabled', 4, 7, [OcaUint16], [OcaBoolean]],
-    ['SetPositionEnabled', 4, 8, [OcaUint16, OcaBoolean], []],
-    ['GetPositionEnableds', 4, 9, [], [OcaList(OcaBoolean)]],
-    ['SetPositionEnableds', 4, 10, [OcaList(OcaBoolean)], []],
+    [
+      'GetPositionEnableFlag',
+      4,
+      7,
+      [OcaUint16],
+      [OcaBoolean],
+      ['GetPositionEnabled'],
+    ],
+    [
+      'SetPositionEnableFlag',
+      4,
+      8,
+      [OcaUint16, OcaBoolean],
+      [],
+      ['SetPositionEnabled'],
+    ],
+    [
+      'GetPositionEnableFlags',
+      4,
+      9,
+      [],
+      [OcaList(OcaBoolean)],
+      ['GetPositionEnableds'],
+    ],
+    [
+      'SetPositionEnableFlags',
+      4,
+      10,
+      [OcaList(OcaBoolean)],
+      [],
+      ['SetPositionEnableds'],
+    ],
   ],
   [
     ['Position', [OcaUint16], 4, 1, false, false, null],
     ['PositionNames', [OcaList(OcaString)], 4, 2, false, false, null],
-    ['PositionEnableds', [OcaList(OcaBoolean)], 4, 3, false, false, null],
+    [
+      'PositionEnableFlags',
+      [OcaList(OcaBoolean)],
+      4,
+      3,
+      false,
+      false,
+      ['PositionEnable', 'PositionEnableds'],
+    ],
   ],
   []
 );
 
 /**
- * Gets the value of the Position property and, optionally, its implementation
- * min and max. The return value indicates whether the data was successfully
- * retrieved.
+ * Gets the value and limits of the **Position** property.
  * The return values of this method are
  *
  * - position of type ``number``
@@ -50,8 +86,7 @@ export const OcaSwitch = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Position property. The return value indicates whether
- * the property was successfully set.
+ * Sets the value of the Position property.
  *
  * @method OcaSwitch#SetPosition
  * @param {number} position
@@ -59,8 +94,7 @@ export const OcaSwitch = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the name assigned to a given switch position. The return value indicates
- * whether the name was successfully retrieved.
+ * Gets the name assigned to a given switch position.
  *
  * @method OcaSwitch#GetPositionName
  * @param {number} Index
@@ -69,8 +103,7 @@ export const OcaSwitch = make_control_class(
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Assigns a name to a given switch position. The return value indicates whether
- * the name was successfully assigned.
+ * Assigns a name to a given switch position.
  *
  * @method OcaSwitch#SetPositionName
  * @param {number} Index
@@ -79,16 +112,14 @@ export const OcaSwitch = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets list of names assigned to the switch's positions. The return value
- * indicates whether the names were successfully retrieved.
+ * Gets list of names assigned to the switch's positions.
  *
  * @method OcaSwitch#GetPositionNames
  * @returns {Promise<string[]>}
  *   A promise which resolves to a single value of type ``string[]``.
  */
 /**
- * Assigns names to the switch's positions. The return value indicates whether
- * the names were successfully assigned.
+ * Assigns names to the switch's positions.
  *
  * @method OcaSwitch#SetPositionNames
  * @param {string[]} Names
@@ -96,8 +127,17 @@ export const OcaSwitch = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the Enabled flag assigned to a given switch position. The return value
- * indicates whether the flag was successfully retrieved.
+ * Gets the Enabled flag assigned to a given switch position.
+ *
+ * @method OcaSwitch#GetPositionEnableFlag
+ * @param {number} Index
+ *
+ * @returns {Promise<boolean>}
+ *   A promise which resolves to a single value of type ``boolean``.
+ */
+/**
+ * Gets the Enabled flag assigned to a given switch position.
+ * An alias for GetPositionEnableFlag.
  *
  * @method OcaSwitch#GetPositionEnabled
  * @param {number} Index
@@ -106,8 +146,17 @@ export const OcaSwitch = make_control_class(
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Sets the Enabled flag assigned to a given switch position. The return value
- * indicates whether the flag was successfully set.
+ * Sets the Enabled flag assigned to a given switch position.
+ *
+ * @method OcaSwitch#SetPositionEnableFlag
+ * @param {number} Index
+ * @param {boolean} enabled
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Sets the Enabled flag assigned to a given switch position.
+ * An alias for SetPositionEnableFlag.
  *
  * @method OcaSwitch#SetPositionEnabled
  * @param {number} Index
@@ -116,19 +165,34 @@ export const OcaSwitch = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets list of Enabled flags assigned to the switch's positions. The return
- * value indicates whether the flags were successfully retrieved.
+ * Gets list of position-enabled flags assigned to the switch's positions.
+ *
+ * @method OcaSwitch#GetPositionEnableFlags
+ * @returns {Promise<boolean[]>}
+ *   A promise which resolves to a single value of type ``boolean[]``.
+ */
+/**
+ * Gets list of position-enabled flags assigned to the switch's positions.
+ * An alias for GetPositionEnableFlags.
  *
  * @method OcaSwitch#GetPositionEnableds
  * @returns {Promise<boolean[]>}
  *   A promise which resolves to a single value of type ``boolean[]``.
  */
 /**
- * Sets list of Enabled flags for the switch's positions. The return value
- * indicates whether the flags were successfully set.
+ * Sets list of position-enable flags for the switch's positions.
+ *
+ * @method OcaSwitch#SetPositionEnableFlags
+ * @param {boolean[]} flags
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Sets list of position-enable flags for the switch's positions.
+ * An alias for SetPositionEnableFlags.
  *
  * @method OcaSwitch#SetPositionEnableds
- * @param {boolean[]} enableds
+ * @param {boolean[]} flags
  *
  * @returns {Promise<void>}
  */
@@ -136,24 +200,38 @@ export const OcaSwitch = make_control_class(
  * This event is emitted when the property ``Position`` changes in the remote object.
  * The property ``Position`` is described in the AES70 standard as follows.
  * The current position of the switch. Positions shall be numbered from
- * minPosition to (including) maxPosition. If the object does not return the
- * optional parameters minPosition and maxPosition in its GetPosition method the
- * positions shall be numbered from 1 to n.
+ * **minPosition** to (including) **maxPosition**. If the object does not return
+ * the optional parameters **minPosition** and **maxPosition** in its
+ * **GetPosition** method, the positions shall be numbered from 1 to n.
  *
  * @member {PropertyEvent<number>} OcaSwitch#OnPositionChanged
  */
 /**
  * This event is emitted when the property ``PositionNames`` changes in the remote object.
  * The property ``PositionNames`` is described in the AES70 standard as follows.
- * Vector of switch position names. Supplied by controller.
+ * Vector of switch position names. Defined at object construction time. In some
+ * implementations, may be changed by controller. FIrst element of list
+ * corresponds to the position value of **minPosition** as returned by
+ * **GetPosition(...)**.
  *
  * @member {PropertyEvent<string[]>} OcaSwitch#OnPositionNamesChanged
  */
 /**
- * This event is emitted when the property ``PositionEnableds`` changes in the remote object.
- * The property ``PositionEnableds`` is described in the AES70 standard as follows.
+ * This event is emitted when the property ``PositionEnableFlags`` changes in the remote object.
+ * The property ``PositionEnableFlags`` is described in the AES70 standard as follows.
  * Vector of booleans which enable or disable corresponding switch positions.
  * Default values are a construction parameter. The usual default value is True.
+ * Renamed to **PositionEnableFlags** in v3 of this class.
+ *
+ * @member {PropertyEvent<boolean[]>} OcaSwitch#OnPositionEnableFlagsChanged
+ */
+/**
+ * An alias for OnPositionEnableFlagsChanged
+ *
+ * @member {PropertyEvent<boolean[]>} OcaSwitch#OnPositionEnableChanged
+ */
+/**
+ * An alias for OnPositionEnableFlagsChanged
  *
  * @member {PropertyEvent<boolean[]>} OcaSwitch#OnPositionEnabledsChanged
  */

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

@@ -0,0 +1,192 @@
+import { IOcaProgramRunMode } from '../../types/OcaProgramRunMode';
+import { OcaTaskOperationalState } from '../../types/OcaTaskOperationalState';
+import { Event } from '../event';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaAgent } from './OcaAgent';
+
+/**
+ * Task scheduler. Holds a queue of task-program pairs to be executed under
+ * specific future conditions.
+ * @extends OcaAgent
+ * @class OcaTaskAgent
+ */
+export declare class OcaTaskAgent extends OcaAgent {
+  /**
+   * Event raised when execution terminates for any reason.
+   * @member OcaTaskAgent#OnExecutionTerminated {Event}
+   */
+  OnExecutionTerminated: Event;
+  /**
+   * This event is emitted whenever ExecutableONo changes.
+   */
+  OnExecutableONoChanged: PropertyEvent<number>;
+
+  /**
+   * This event is emitted whenever GroupID changes.
+   */
+  OnGroupIDChanged: PropertyEvent<number>;
+
+  /**
+   * This event is emitted whenever ExecutionParameters changes.
+   */
+  OnExecutionParametersChanged: PropertyEvent<Uint8Array>;
+
+  /**
+   * This event is emitted whenever RunMode changes.
+   */
+  OnRunModeChanged: PropertyEvent<IOcaProgramRunMode>;
+
+  /**
+   * This event is emitted whenever Blocked changes.
+   */
+  OnBlockedChanged: PropertyEvent<boolean>;
+
+  /**
+   * This event is emitted whenever OperationalState changes.
+   */
+  OnOperationalStateChanged: PropertyEvent<OcaTaskOperationalState>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Prepares task for program execution, but does not start execution. Sets
+   * **ExecutableONo** and **ExecutionParameters**. Changes state from
+   * **NotPrepared** to **Ready**. If property **.Blocked** is TRUE, does
+   * nothing and returns status of **ProcessingFailed**.
+   *
+   * @method OcaTaskAgent#ActionPrepare
+   * @param {number} Program
+   * @param {Uint8Array} ExecutionParameters
+   * @param {IOcaProgramRunMode} RunMode
+   *
+   * @returns {Promise<void>}
+   */
+  ActionPrepare(
+    Program: number,
+    ExecutionParameters: Uint8Array,
+    RunMode: IOcaProgramRunMode
+  ): Promise<void>;
+
+  /**
+   * Execute the given program immediately. Sets **ExecutableONo** and
+   * **ExecutionParameters**. Changes state from **NotPrepared** to **Running**.
+   * If property **.Blocked** is TRUE, does nothing and returns status of
+   * **ProcessingFailed**.
+   *
+   * @method OcaTaskAgent#ActionRun
+   * @param {number} Program
+   * @param {Uint8Array} ExecutionParameters
+   * @param {IOcaProgramRunMode} RunMode
+   *
+   * @returns {Promise<void>}
+   */
+  ActionRun(
+    Program: number,
+    ExecutionParameters: Uint8Array,
+    RunMode: IOcaProgramRunMode
+  ): Promise<void>;
+
+  /**
+   * Executes the prepared program. Changes state from **Ready** to **Running**.
+   * If property **.Blocked** is TRUE, does nothing and returns status of
+   * **ProcessingFailed**.
+   *
+   * @method OcaTaskAgent#ActionStart
+   * @returns {Promise<void>}
+   */
+  ActionStart(): Promise<void>;
+
+  /**
+   * Requests orderly termination of running program. Changes state from
+   * **Running** to **Stopping**. When termination is complete, state changes
+   * from **Stopping** to **Ended.**
+   *
+   * @method OcaTaskAgent#ActionStop
+   * @returns {Promise<void>}
+   */
+  ActionStop(): Promise<void>;
+
+  /**
+   * Resets all internal states to their values at start of execution. Forces
+   * immediate termination of running or stopping program. Changes state from
+   * **Running, Stopping,** or **Ended** to **Ready.**
+   *
+   * @method OcaTaskAgent#ActionReset
+   * @returns {Promise<void>}
+   */
+  ActionReset(): Promise<void>;
+
+  /**
+   * Clears all memory of program and program execution from the task agent.
+   * Forces immediate termination of running or stopping program. Changes state
+   * from **Running, Stopping,** or **Ended** to **NotPrepared. ** Sets property
+   * **ExecutableONo** to zero, property **ExecutionParameters** to a null blob,
+   * and property **RunMode** to **None**.
+   *
+   * @method OcaTaskAgent#ActionClear
+   * @returns {Promise<void>}
+   */
+  ActionClear(): Promise<void>;
+
+  /**
+   * Gets property **Blocked**.
+   *
+   * @method OcaTaskAgent#GetBlocked
+   * @returns {Promise<boolean>}
+   *   A promise which resolves to a single value of type ``boolean``.
+   */
+  GetBlocked(): Promise<boolean>;
+
+  /**
+   * Sets the **Blocked** property.
+   *
+   * @method OcaTaskAgent#SetBlocked
+   * @param {boolean} Blocked
+   *
+   * @returns {Promise<void>}
+   */
+  SetBlocked(Blocked: boolean): Promise<void>;
+
+  /**
+   * Gets value of the **OperationalState** property.
+   *
+   * @method OcaTaskAgent#GetOperationalState
+   * @returns {Promise<OcaTaskOperationalState>}
+   *   A promise which resolves to a single value of type :class:`OcaTaskOperationalState`.
+   */
+  GetOperationalState(): Promise<OcaTaskOperationalState>;
+
+  /**
+   * Gets value of **ExecutableONo** property, as set by the
+   * **ActionPrepare(...)** and **ActionRun(...)** methods. Returns zero if no
+   * execution is pending or in progress.
+   *
+   * @method OcaTaskAgent#GetExecutableONo
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  GetExecutableONo(): Promise<number>;
+
+  /**
+   * Gets value of **ExecutionParameters** property, as set by the
+   * **ActionPrepare(...)** and **ActionRun(...)** methods. Returns an empty
+   * blob if no execution is pending or in progress.
+   *
+   * @method OcaTaskAgent#GetExecutionParameters
+   * @returns {Promise<Uint8Array>}
+   *   A promise which resolves to a single value of type ``Uint8Array``.
+   */
+  GetExecutionParameters(): Promise<Uint8Array>;
+
+  /**
+   * Gets the value of the **RunMode** property, as set by the
+   * **ActionPrepare(...)** and **ActionRun(...)** methods. Returns the value
+   * **None** if no execution is pending or in progress.
+   *
+   * @method OcaTaskAgent#GetRunMode
+   * @returns {Promise<IOcaProgramRunMode>}
+   *   A promise which resolves to a single value of type ``IOcaProgramRunMode``.
+   */
+  GetRunMode(): Promise<IOcaProgramRunMode>;
+}

package/src/controller/ControlClasses/OcaTaskAgent.js

@@ -0,0 +1,212 @@
+import { OcaBlob } from '../../OCP1/OcaBlob.js';
+import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
+import { OcaProgramRunMode } from '../../OCP1/OcaProgramRunMode.js';
+import { OcaTaskExecutionTerminatedEventData } from '../../OCP1/OcaTaskExecutionTerminatedEventData.js';
+import { OcaTaskOperationalState } from '../../OCP1/OcaTaskOperationalState.js';
+import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
+
+/**
+ * Task scheduler. Holds a queue of task-program pairs to be executed under
+ * specific future conditions.
+ * @extends OcaAgent
+ * @class OcaTaskAgent
+ */
+export const OcaTaskAgent = make_control_class(
+  'OcaTaskAgent',
+  3,
+  '\u0001\u0002\f',
+  1,
+  OcaAgent,
+  [
+    ['ActionPrepare', 3, 1, [OcaUint32, OcaBlob, OcaProgramRunMode], []],
+    ['ActionRun', 3, 2, [OcaUint32, OcaBlob, OcaProgramRunMode], []],
+    ['ActionStart', 3, 3, [], []],
+    ['ActionStop', 3, 4, [], []],
+    ['ActionReset', 3, 5, [], []],
+    ['ActionClear', 3, 6, [], []],
+    ['GetBlocked', 3, 7, [], [OcaBoolean]],
+    ['SetBlocked', 3, 8, [OcaBoolean], []],
+    ['GetOperationalState', 3, 9, [], [OcaTaskOperationalState]],
+    ['GetExecutableONo', 3, 10, [], [OcaUint32]],
+    ['GetExecutionParameters', 3, 11, [], [OcaBlob]],
+    ['GetRunMode', 3, 12, [], [OcaProgramRunMode]],
+  ],
+  [
+    ['ExecutableONo', [OcaUint32], 3, 1, false, false, null],
+    ['GroupID', [OcaUint16], 3, 2, false, false, null],
+    ['ExecutionParameters', [OcaBlob], 3, 3, false, false, null],
+    ['RunMode', [OcaProgramRunMode], 3, 4, false, false, null],
+    ['Blocked', [OcaBoolean], 3, 5, false, false, null],
+    ['OperationalState', [OcaTaskOperationalState], 3, 6, false, false, null],
+  ],
+  [['ExecutionTerminated', 3, 1, [OcaTaskExecutionTerminatedEventData]]]
+);
+
+/**
+ * Prepares task for program execution, but does not start execution. Sets
+ * **ExecutableONo** and **ExecutionParameters**. Changes state from
+ * **NotPrepared** to **Ready**. If property **.Blocked** is TRUE, does nothing
+ * and returns status of **ProcessingFailed**.
+ *
+ * @method OcaTaskAgent#ActionPrepare
+ * @param {number} Program
+ * @param {Uint8Array} ExecutionParameters
+ * @param {IOcaProgramRunMode} RunMode
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Execute the given program immediately. Sets **ExecutableONo** and
+ * **ExecutionParameters**. Changes state from **NotPrepared** to **Running**.
+ * If property **.Blocked** is TRUE, does nothing and returns status of
+ * **ProcessingFailed**.
+ *
+ * @method OcaTaskAgent#ActionRun
+ * @param {number} Program
+ * @param {Uint8Array} ExecutionParameters
+ * @param {IOcaProgramRunMode} RunMode
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Executes the prepared program. Changes state from **Ready** to **Running**.
+ * If property **.Blocked** is TRUE, does nothing and returns status of
+ * **ProcessingFailed**.
+ *
+ * @method OcaTaskAgent#ActionStart
+ * @returns {Promise<void>}
+ */
+/**
+ * Requests orderly termination of running program. Changes state from
+ * **Running** to **Stopping**. When termination is complete, state changes from
+ * **Stopping** to **Ended.**
+ *
+ * @method OcaTaskAgent#ActionStop
+ * @returns {Promise<void>}
+ */
+/**
+ * Resets all internal states to their values at start of execution. Forces
+ * immediate termination of running or stopping program. Changes state from
+ * **Running, Stopping,** or **Ended** to **Ready.**
+ *
+ * @method OcaTaskAgent#ActionReset
+ * @returns {Promise<void>}
+ */
+/**
+ * Clears all memory of program and program execution from the task agent.
+ * Forces immediate termination of running or stopping program. Changes state
+ * from **Running, Stopping,** or **Ended** to **NotPrepared. ** Sets property
+ * **ExecutableONo** to zero, property **ExecutionParameters** to a null blob,
+ * and property **RunMode** to **None**.
+ *
+ * @method OcaTaskAgent#ActionClear
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets property **Blocked**.
+ *
+ * @method OcaTaskAgent#GetBlocked
+ * @returns {Promise<boolean>}
+ *   A promise which resolves to a single value of type ``boolean``.
+ */
+/**
+ * Sets the **Blocked** property.
+ *
+ * @method OcaTaskAgent#SetBlocked
+ * @param {boolean} Blocked
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets value of the **OperationalState** property.
+ *
+ * @method OcaTaskAgent#GetOperationalState
+ * @returns {Promise<OcaTaskOperationalState>}
+ *   A promise which resolves to a single value of type :class:`OcaTaskOperationalState`.
+ */
+/**
+ * Gets value of **ExecutableONo** property, as set by the
+ * **ActionPrepare(...)** and **ActionRun(...)** methods. Returns zero if no
+ * execution is pending or in progress.
+ *
+ * @method OcaTaskAgent#GetExecutableONo
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * Gets value of **ExecutionParameters** property, as set by the
+ * **ActionPrepare(...)** and **ActionRun(...)** methods. Returns an empty blob
+ * if no execution is pending or in progress.
+ *
+ * @method OcaTaskAgent#GetExecutionParameters
+ * @returns {Promise<Uint8Array>}
+ *   A promise which resolves to a single value of type ``Uint8Array``.
+ */
+/**
+ * Gets the value of the **RunMode** property, as set by the
+ * **ActionPrepare(...)** and **ActionRun(...)** methods. Returns the value
+ * **None** if no execution is pending or in progress.
+ *
+ * @method OcaTaskAgent#GetRunMode
+ * @returns {Promise<IOcaProgramRunMode>}
+ *   A promise which resolves to a single value of type ``IOcaProgramRunMode``.
+ */
+/**
+ * Event raised when execution terminates for any reason.
+ * @member OcaTaskAgent#OnExecutionTerminated {Event}
+ */
+/**
+ * This event is emitted when the property ``ExecutableONo`` changes in the remote object.
+ * The property ``ExecutableONo`` is described in the AES70 standard as follows.
+ * **ONo** of **OcaProgram** or **OcaCommandSet** assigned to this task. Set by
+ * the **ActionPrepare(...)** and **ActionRun(...)** methods. Value is zero if
+ * no **OcaProgram** or **OcaCommandSet** is attached. or zero if no executable
+ * is assigned.
+ *
+ * @member {PropertyEvent<number>} OcaTaskAgent#OnExecutableONoChanged
+ */
+/**
+ * This event is emitted when the property ``GroupID`` changes in the remote object.
+ * The property ``GroupID`` is described in the AES70 standard as follows.
+ * ID of group the task is in, or zero if it isn't in a group
+ *
+ * @member {PropertyEvent<number>} OcaTaskAgent#OnGroupIDChanged
+ */
+/**
+ * This event is emitted when the property ``ExecutionParameters`` changes in the remote object.
+ * The property ``ExecutionParameters`` is described in the AES70 standard as follows.
+ * Application-specific parameters for running the executable, as set by the
+ * methods **ActionPrepare(...)** and **ActionRun(...)**. Value is an empty blob
+ * if**** if no execution is pending. or in progress.
+ *
+ * @member {PropertyEvent<Uint8Array>} OcaTaskAgent#OnExecutionParametersChanged
+ */
+/**
+ * This event is emitted when the property ``RunMode`` changes in the remote object.
+ * The property ``RunMode`` is described in the AES70 standard as follows.
+ * Run mode as set by the methods **ActionPrepare(...)** and **ActionRun(...)**.
+ * Value is **None** if no execution is pending or in progress.
+ *
+ * @member {PropertyEvent<IOcaProgramRunMode>} OcaTaskAgent#OnRunModeChanged
+ */
+/**
+ * This event is emitted when the property ``Blocked`` changes in the remote object.
+ * The property ``Blocked`` is described in the AES70 standard as follows.
+ * If value is TRUE, the task agent is allowed to complete any work in progress,
+ * but is prevented from accepting any new work. When TRUE, the methods
+ * **ActionPrepare, ActionRun,** and **ActionStart** will fail with **OcaStatus
+ * = ProcessingFailed**.
+ *
+ * @member {PropertyEvent<boolean>} OcaTaskAgent#OnBlockedChanged
+ */
+/**
+ * This event is emitted when the property ``OperationalState`` changes in the remote object.
+ * The property ``OperationalState`` is described in the AES70 standard as follows.
+ * Operational state of this agent's task = {generic state, task-specific blob}
+ * .
+ *
+ * @member {PropertyEvent<OcaTaskOperationalState>} OcaTaskAgent#OnOperationalStateChanged
+ */

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

@@ -8,7 +8,8 @@ import { RemoteDevice } from '../remote_device';
 import { OcaManager } from './OcaManager';
 
 /**
- * Optional manager that collects OcaTask and OcaProgram objects.
+ * This class is **deprecated** in version 2 (OCA 1.5). Optional manager that
+ * collects **OcaTask** and **OcaProgram** objects.
  *
  *  - May be instantiated once in any device.
  *
@@ -148,12 +149,9 @@ export declare class OcaTaskManager extends OcaManager {
    * successfully created.
    *
    * @method OcaTaskManager#AddTask
-   * @param {IOcaTask} Task
-   *
-   * @returns {Promise<OcaTask>}
-   *   A promise which resolves to a single value of type :class:`OcaTask`.
+   * @returns {Promise<void>}
    */
-  AddTask(Task: IOcaTask): Promise<OcaTask>;
+  AddTask(): Promise<void>;
 
   /**
    * Gets map of Tasks in the device. Return value indicates whether map was