aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaTaskManager.js

@@ -4,15 +4,16 @@ import { OcaMap } from '../../OCP1/OcaMap.js';
 import { OcaTask } from '../../OCP1/OcaTask.js';
 import { OcaTaskCommand } from '../../OCP1/OcaTaskCommand.js';
 import { OcaTaskManagerState } from '../../OCP1/OcaTaskManagerState.js';
-import { OcaTaskStateChangedEventData } from '../../OCP1/OcaTaskStateChangedEventData.js';
 import { OcaTaskStatus } from '../../OCP1/OcaTaskStatus.js';
+import { OcaTaskStatusChangedEventData } from '../../OCP1/OcaTaskStatusChangedEventData.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
 import { make_control_class } from '../make_control_class.js';
 import { OcaManager } from './OcaManager.js';
 
 /**
- * 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.
  *
@@ -42,7 +43,7 @@ export const OcaTaskManager = make_control_class(
   'OcaTaskManager',
   3,
   '\u0001\u0003\u000b',
-  1,
+  3,
   OcaManager,
   [
     ['Enable', 3, 1, [OcaBoolean], []],
@@ -52,7 +53,7 @@ export const OcaTaskManager = make_control_class(
     ['GetState', 3, 5, [], [OcaTaskManagerState]],
     ['GetTaskStatuses', 3, 6, [], [OcaTaskStatus]],
     ['GetTaskStatus', 3, 7, [OcaUint32], [OcaTaskStatus]],
-    ['AddTask', 3, 8, [OcaTask], [OcaTask]],
+    ['AddTask', 3, 8, [], []],
     ['GetTasks', 3, 9, [], [OcaMap(OcaUint32, OcaTask)]],
     ['GetTask', 3, 10, [OcaUint32], [OcaTask]],
     ['SetTask', 3, 11, [OcaUint32, OcaTask], []],
@@ -62,7 +63,7 @@ export const OcaTaskManager = make_control_class(
     ['State', [OcaTaskManagerState], 3, 1, false, false, null],
     ['Tasks', [OcaMap(OcaUint32, OcaTask)], 3, 2, false, false, null],
   ],
-  [['TaskStateChanged', 3, 1, [OcaTaskStateChangedEventData]]]
+  [['TaskStateChanged', 3, 1, [OcaTaskStatusChangedEventData]]]
 );
 
 /**
@@ -137,10 +138,7 @@ export const OcaTaskManager = make_control_class(
  * 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>}
  */
 /**
  * Gets map of Tasks in the device. Return value indicates whether map was

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

@@ -0,0 +1,150 @@
+import { IOcaJobQueueItem, OcaJobQueueItem } from '../../types/OcaJobQueueItem';
+import { OcaTaskSchedulerState } from '../../types/OcaTaskSchedulerState';
+import { Event } from '../event';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaAgent } from './OcaAgent';
+
+/**
+ * Optional scheduler for scheduling tasks to run programs and commandsets in
+ * the future.
+ * @extends OcaAgent
+ * @class OcaTaskScheduler
+ */
+export declare class OcaTaskScheduler extends OcaAgent {
+  /**
+   * Event raised when a job queue item is removed from the queue, either
+   * because it has fulfilled its purpose or because it has been explicitly
+   * deleted by the **DeleteJob()** or **ClearJobQueue()** method.
+   * @member OcaTaskScheduler#OnJobDisposed {Event}
+   */
+  OnJobDisposed: Event;
+  /**
+   * This event is emitted whenever State changes.
+   */
+  OnStateChanged: PropertyEvent<OcaTaskSchedulerState>;
+
+  /**
+   * This event is emitted whenever TaskAgents changes.
+   */
+  OnTaskAgentsChanged: PropertyEvent<number[]>;
+
+  /**
+   * This event is emitted whenever JobQueue changes.
+   */
+  OnJobQueueChanged: PropertyEvent<OcaJobQueueItem[]>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Changes state to **Running.**
+   *
+   * @method OcaTaskScheduler#ActionStart
+   * @returns {Promise<void>}
+   */
+  ActionStart(): Promise<void>;
+
+  /**
+   * Changes state to **Stopped.**
+   *
+   * @method OcaTaskScheduler#ActionStop
+   * @returns {Promise<void>}
+   */
+  ActionStop(): Promise<void>;
+
+  /**
+   * Changes state to **Paused.**
+   *
+   * @method OcaTaskScheduler#ActionPause
+   * @returns {Promise<void>}
+   */
+  ActionPause(): Promise<void>;
+
+  /**
+   * Changes state to **Draining.**
+   *
+   * @method OcaTaskScheduler#ActionDrain
+   * @returns {Promise<void>}
+   */
+  ActionDrain(): Promise<void>;
+
+  /**
+   * Gets the scheduler's state.
+   *
+   * @method OcaTaskScheduler#GetState
+   * @returns {Promise<OcaTaskSchedulerState>}
+   *   A promise which resolves to a single value of type :class:`OcaTaskSchedulerState`.
+   */
+  GetState(): Promise<OcaTaskSchedulerState>;
+
+  /**
+   * Gets the list of all **OcaTaskAgent** ONos.
+   *
+   * @method OcaTaskScheduler#GetTaskAgents
+   * @returns {Promise<number[]>}
+   *   A promise which resolves to a single value of type ``number[]``.
+   */
+  GetTaskAgents(): Promise<number[]>;
+
+  /**
+   * Gets the job queue.
+   *
+   * @method OcaTaskScheduler#GetJobQueue
+   * @returns {Promise<OcaJobQueueItem[]>}
+   *   A promise which resolves to a single value of type :class:`OcaJobQueueItem[]`.
+   */
+  GetJobQueue(): Promise<OcaJobQueueItem[]>;
+
+  /**
+   * Gets a jobqueue item, given its ID.
+   *
+   * @method OcaTaskScheduler#GetJob
+   * @param {number} ID
+   *
+   * @returns {Promise<OcaJobQueueItem>}
+   *   A promise which resolves to a single value of type :class:`OcaJobQueueItem`.
+   */
+  GetJob(ID: number): Promise<OcaJobQueueItem>;
+
+  /**
+   * Replaces a job queue item, given its ID. If given ID references a
+   * nonexistent job queue item, method shall return status value
+   * **ParameterOutOfRange**.
+   *
+   * @method OcaTaskScheduler#SetJob
+   * @param {number} ID
+   * @param {IOcaJobQueueItem} Item
+   *
+   * @returns {Promise<void>}
+   */
+  SetJob(ID: number, Item: IOcaJobQueueItem): Promise<void>;
+
+  /**
+   * Adds a job queue item, returns its ID.
+   *
+   * @method OcaTaskScheduler#AddJob
+   * @param {IOcaJobQueueItem} Item
+   *
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  AddJob(Item: IOcaJobQueueItem): Promise<number>;
+
+  /**
+   * Deletes a job queue item given its ID.
+   *
+   * @method OcaTaskScheduler#DeleteJob
+   * @param {number} ID
+   *
+   * @returns {Promise<void>}
+   */
+  DeleteJob(ID: number): Promise<void>;
+
+  /**
+   * Deletes all job queue items.
+   *
+   * @method OcaTaskScheduler#ClearJobQueue
+   * @returns {Promise<void>}
+   */
+  ClearJobQueue(): Promise<void>;
+}

package/src/controller/ControlClasses/OcaTaskScheduler.js

@@ -0,0 +1,159 @@
+import { OcaJobDisposedEventData } from '../../OCP1/OcaJobDisposedEventData.js';
+import { OcaJobQueueItem } from '../../OCP1/OcaJobQueueItem.js';
+import { OcaList } from '../../OCP1/OcaList.js';
+import { OcaTaskSchedulerState } from '../../OCP1/OcaTaskSchedulerState.js';
+import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
+
+/**
+ * Optional scheduler for scheduling tasks to run programs and commandsets in
+ * the future.
+ * @extends OcaAgent
+ * @class OcaTaskScheduler
+ */
+export const OcaTaskScheduler = make_control_class(
+  'OcaTaskScheduler',
+  3,
+  '\u0001\u0002\r',
+  1,
+  OcaAgent,
+  [
+    ['ActionStart', 3, 1, [], []],
+    ['ActionStop', 3, 2, [], []],
+    ['ActionPause', 3, 3, [], []],
+    ['ActionDrain', 3, 4, [], []],
+    ['GetState', 3, 5, [], [OcaTaskSchedulerState]],
+    ['GetTaskAgents', 3, 6, [], [OcaList(OcaUint32)]],
+    ['GetJobQueue', 3, 7, [], [OcaList(OcaJobQueueItem)]],
+    ['GetJob', 3, 8, [OcaUint32], [OcaJobQueueItem]],
+    ['SetJob', 3, 9, [OcaUint32, OcaJobQueueItem], []],
+    ['AddJob', 3, 10, [OcaJobQueueItem], [OcaUint32]],
+    ['DeleteJob', 3, 11, [OcaUint32], []],
+    ['ClearJobQueue', 3, 12, [], []],
+  ],
+  [
+    ['State', [OcaTaskSchedulerState], 3, 1, false, false, null],
+    ['TaskAgents', [OcaList(OcaUint32)], 3, 2, false, false, null],
+    ['JobQueue', [OcaList(OcaJobQueueItem)], 3, 3, false, false, null],
+  ],
+  [['JobDisposed', 3, 1, [OcaJobDisposedEventData]]]
+);
+
+/**
+ * Changes state to **Running.**
+ *
+ * @method OcaTaskScheduler#ActionStart
+ * @returns {Promise<void>}
+ */
+/**
+ * Changes state to **Stopped.**
+ *
+ * @method OcaTaskScheduler#ActionStop
+ * @returns {Promise<void>}
+ */
+/**
+ * Changes state to **Paused.**
+ *
+ * @method OcaTaskScheduler#ActionPause
+ * @returns {Promise<void>}
+ */
+/**
+ * Changes state to **Draining.**
+ *
+ * @method OcaTaskScheduler#ActionDrain
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the scheduler's state.
+ *
+ * @method OcaTaskScheduler#GetState
+ * @returns {Promise<OcaTaskSchedulerState>}
+ *   A promise which resolves to a single value of type :class:`OcaTaskSchedulerState`.
+ */
+/**
+ * Gets the list of all **OcaTaskAgent** ONos.
+ *
+ * @method OcaTaskScheduler#GetTaskAgents
+ * @returns {Promise<number[]>}
+ *   A promise which resolves to a single value of type ``number[]``.
+ */
+/**
+ * Gets the job queue.
+ *
+ * @method OcaTaskScheduler#GetJobQueue
+ * @returns {Promise<OcaJobQueueItem[]>}
+ *   A promise which resolves to a single value of type :class:`OcaJobQueueItem[]`.
+ */
+/**
+ * Gets a jobqueue item, given its ID.
+ *
+ * @method OcaTaskScheduler#GetJob
+ * @param {number} ID
+ *
+ * @returns {Promise<OcaJobQueueItem>}
+ *   A promise which resolves to a single value of type :class:`OcaJobQueueItem`.
+ */
+/**
+ * Replaces a job queue item, given its ID. If given ID references a nonexistent
+ * job queue item, method shall return status value **ParameterOutOfRange**.
+ *
+ * @method OcaTaskScheduler#SetJob
+ * @param {number} ID
+ * @param {IOcaJobQueueItem} Item
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Adds a job queue item, returns its ID.
+ *
+ * @method OcaTaskScheduler#AddJob
+ * @param {IOcaJobQueueItem} Item
+ *
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * Deletes a job queue item given its ID.
+ *
+ * @method OcaTaskScheduler#DeleteJob
+ * @param {number} ID
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Deletes all job queue items.
+ *
+ * @method OcaTaskScheduler#ClearJobQueue
+ * @returns {Promise<void>}
+ */
+/**
+ * Event raised when a job queue item is removed from the queue, either because
+ * it has fulfilled its purpose or because it has been explicitly deleted by the
+ * **DeleteJob()** or **ClearJobQueue()** method.
+ * @member OcaTaskScheduler#OnJobDisposed {Event}
+ */
+/**
+ * This event is emitted when the property ``State`` changes in the remote object.
+ * The property ``State`` is described in the AES70 standard as follows.
+ * See **OcaTaskSchedulerState** for state values and their semantics.
+ *
+ * @member {PropertyEvent<OcaTaskSchedulerState>} OcaTaskScheduler#OnStateChanged
+ */
+/**
+ * This event is emitted when the property ``TaskAgents`` changes in the remote object.
+ * The property ``TaskAgents`` is described in the AES70 standard as follows.
+ * List of ONos of **OcaTaskAgent** objects. Readonly; updated automatically
+ * when **OcaTaskAgent** objects are created or deleted.
+ *
+ * @member {PropertyEvent<number[]>} OcaTaskScheduler#OnTaskAgentsChanged
+ */
+/**
+ * This event is emitted when the property ``JobQueue`` changes in the remote object.
+ * The property ``JobQueue`` is described in the AES70 standard as follows.
+ * List of queued jobs. Items are added to the queue by the **AddJob()** method,
+ * and removed from the queue when they have run to completion, or by the
+ * **DeleteJob()** or **ClearJobQueue()** methods.
+ *
+ * @member {PropertyEvent<OcaJobQueueItem[]>} OcaTaskScheduler#OnJobQueueChanged
+ */

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

@@ -4,7 +4,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * A temperature actuator. Works in Celsius.
+ * A temperature actuator with Celsius units of measure.
  * @extends OcaActuator
  * @class OcaTemperatureActuator
  */
@@ -17,8 +17,7 @@ export declare class OcaTemperatureActuator extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the Temperature property. The return value indicates
-   * whether the property was successfully retrieved.
+   * Gets the value and limits of the **Temperature** property.
    * The return values of this method are
    *
    * - temperature of type ``number``
@@ -31,8 +30,7 @@ export declare class OcaTemperatureActuator extends OcaActuator {
   GetTemperature(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the Temperature property. The return value indicates
-   * whether the property was successfully set.
+   * Sets the value of the **Temperature** property.
    *
    * @method OcaTemperatureActuator#SetTemperature
    * @param {number} temperature

package/src/controller/ControlClasses/OcaTemperatureActuator.js

@@ -3,7 +3,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaActuator } from './OcaActuator.js';
 
 /**
- * A temperature actuator. Works in Celsius.
+ * A temperature actuator with Celsius units of measure.
  * @extends OcaActuator
  * @class OcaTemperatureActuator
  */
@@ -11,7 +11,7 @@ export const OcaTemperatureActuator = make_control_class(
   'OcaTemperatureActuator',
   4,
   '\u0001\u0001\u0001\u0014',
-  2,
+  3,
   OcaActuator,
   [
     ['GetTemperature', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
@@ -22,8 +22,7 @@ export const OcaTemperatureActuator = make_control_class(
 );
 
 /**
- * Gets the value of the Temperature property. The return value indicates
- * whether the property was successfully retrieved.
+ * Gets the value and limits of the **Temperature** property.
  * The return values of this method are
  *
  * - temperature of type ``number``
@@ -34,8 +33,7 @@ export const OcaTemperatureActuator = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Temperature property. The return value indicates
- * whether the property was successfully set.
+ * Sets the value of the **Temperature** property.
  *
  * @method OcaTemperatureActuator#SetTemperature
  * @param {number} temperature

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

@@ -4,7 +4,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaSensor } from './OcaSensor';
 
 /**
- * Basic temperature sensor.
+ * Temperature sensor. Units of measure are Celsius.
  * @extends OcaSensor
  * @class OcaTemperatureSensor
  */
@@ -17,8 +17,7 @@ export declare class OcaTemperatureSensor extends OcaSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value and limits of the **Reading** property. The return value
-   * indicates whether the data was successfully retrieved.
+   * Gets the value and limits of the **Reading** property.
    * The return values of this method are
    *
    * - Reading of type ``number``

package/src/controller/ControlClasses/OcaTemperatureSensor.js

@@ -3,7 +3,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaSensor } from './OcaSensor.js';
 
 /**
- * Basic temperature sensor.
+ * Temperature sensor. Units of measure are Celsius.
  * @extends OcaSensor
  * @class OcaTemperatureSensor
  */
@@ -11,7 +11,7 @@ export const OcaTemperatureSensor = make_control_class(
   'OcaTemperatureSensor',
   4,
   '\u0001\u0001\u0002\u0005',
-  2,
+  3,
   OcaSensor,
   [['GetReading', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]]],
   [['Reading', [OcaFloat32], 4, 1, false, false, null]],
@@ -19,8 +19,7 @@ export const OcaTemperatureSensor = make_control_class(
 );
 
 /**
- * Gets the value and limits of the **Reading** property. The return value
- * indicates whether the data was successfully retrieved.
+ * Gets the value and limits of the **Reading** property.
  * The return values of this method are
  *
  * - Reading of type ``number``

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

@@ -17,8 +17,7 @@ export declare class OcaTimeIntervalSensor extends OcaSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value and limits of the **Reading** property. The return value
-   * indicates whether the data was successfully retrieved.
+   * Gets the value and limits of the **Reading** property.
    * The return values of this method are
    *
    * - Reading of type ``number``

package/src/controller/ControlClasses/OcaTimeIntervalSensor.js

@@ -11,7 +11,7 @@ export const OcaTimeIntervalSensor = make_control_class(
   'OcaTimeIntervalSensor',
   4,
   '\u0001\u0001\u0002\u0003',
-  2,
+  3,
   OcaSensor,
   [['GetReading', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]]],
   [['Reading', [OcaFloat32], 4, 1, false, false, null]],
@@ -19,8 +19,7 @@ export const OcaTimeIntervalSensor = make_control_class(
 );
 
 /**
- * Gets the value and limits of the **Reading** property. The return value
- * indicates whether the data was successfully retrieved.
+ * Gets the value and limits of the **Reading** property.
  * The return values of this method are
  *
  * - Reading of type ``number``