aes70 1.6.1 → 2.0.0

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

@@ -3,7 +3,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaBasicSensor } from './OcaBasicSensor';
 
 /**
- * Basic boolean sensor.
+ * Boolean sensor
  * @extends OcaBasicSensor
  * @class OcaBooleanSensor
  */
@@ -16,8 +16,7 @@ export declare class OcaBooleanSensor extends OcaBasicSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the **Reading** property. The return value indicates whether the data
-   * was successfully retrieved.
+   * Gets the value of the **Reading** property.
    *
    * @method OcaBooleanSensor#GetReading
    * @returns {Promise<boolean>}

package/src/controller/ControlClasses/OcaBooleanSensor.js

@@ -3,7 +3,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaBasicSensor } from './OcaBasicSensor.js';
 
 /**
- * Basic boolean sensor.
+ * Boolean sensor
  * @extends OcaBasicSensor
  * @class OcaBooleanSensor
  */
@@ -11,7 +11,7 @@ export const OcaBooleanSensor = make_control_class(
   'OcaBooleanSensor',
   5,
   '\u0001\u0001\u0002\u0001\u0001',
-  2,
+  3,
   OcaBasicSensor,
   [['GetReading', 5, 1, [], [OcaBoolean]]],
   [['Reading', [OcaBoolean], 5, 1, false, false, null]],
@@ -19,8 +19,7 @@ export const OcaBooleanSensor = make_control_class(
 );
 
 /**
- * Gets the **Reading** property. The return value indicates whether the data
- * was successfully retrieved.
+ * Gets the value of the **Reading** property.
  *
  * @method OcaBooleanSensor#GetReading
  * @returns {Promise<boolean>}

package/src/controller/ControlClasses/OcaCodingManager.js

@@ -21,7 +21,7 @@ export const OcaCodingManager = make_control_class(
   'OcaCodingManager',
   3,
   '\u0001\u0003\f',
-  1,
+  3,
   OcaManager,
   [
     ['GetAvailableEncodingSchemes', 3, 1, [], [OcaMap(OcaUint16, OcaString)]],

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

@@ -0,0 +1,89 @@
+import { IOcaCommand, OcaCommand } from '../../types/OcaCommand';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaProgram } from './OcaProgram';
+
+/**
+ * A command set. Child of **OcaProgram**.
+ * @extends OcaProgram
+ * @class OcaCommandSet
+ */
+export declare class OcaCommandSet extends OcaProgram {
+  /**
+   * This event is emitted whenever Commands changes.
+   */
+  OnCommandsChanged: PropertyEvent<OcaCommand[]>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Gets the list of commands in the commandset.
+   *
+   * @method OcaCommandSet#GetCommands
+   * @returns {Promise<OcaCommand[]>}
+   *   A promise which resolves to a single value of type :class:`OcaCommand[]`.
+   */
+  GetCommands(): Promise<OcaCommand[]>;
+
+  /**
+   * Sets the list of commands in the commandset.
+   *
+   * @method OcaCommandSet#SetCommands
+   * @param {IOcaCommand[]} Commands
+   *
+   * @returns {Promise<void>}
+   */
+  SetCommands(Commands: IOcaCommand[]): Promise<void>;
+
+  /**
+   * Gets the command designated by the **Index** parameter.
+   *
+   * @method OcaCommandSet#GetCommand
+   * @param {number} Index
+   *
+   * @returns {Promise<OcaCommand>}
+   *   A promise which resolves to a single value of type :class:`OcaCommand`.
+   */
+  GetCommand(Index: number): Promise<OcaCommand>;
+
+  /**
+   * Replaces the command designated by the **Index** parameter.
+   *
+   * @method OcaCommandSet#SetCommand
+   * @param {number} Index
+   * @param {IOcaCommand} Command
+   *
+   * @returns {Promise<void>}
+   */
+  SetCommand(Index: number, Command: IOcaCommand): Promise<void>;
+
+  /**
+   * Inserts a command into the CommandSet after the command with the given
+   * **Index** value.
+   *
+   * @method OcaCommandSet#InsertCommand
+   * @param {number} Index
+   * @param {IOcaCommand} Command
+   *
+   * @returns {Promise<void>}
+   */
+  InsertCommand(Index: number, Command: IOcaCommand): Promise<void>;
+
+  /**
+   * Removes command with the given **Index** value from the commandset.
+   *
+   * @method OcaCommandSet#DeleteCommand
+   * @param {number} Index
+   *
+   * @returns {Promise<void>}
+   */
+  DeleteCommand(Index: number): Promise<void>;
+
+  /**
+   * Removes all commands from the command set.
+   *
+   * @method OcaCommandSet#Clear
+   * @returns {Promise<void>}
+   */
+  Clear(): Promise<void>;
+}

package/src/controller/ControlClasses/OcaCommandSet.js

@@ -0,0 +1,94 @@
+import { OcaCommand } from '../../OCP1/OcaCommand.js';
+import { OcaList } from '../../OCP1/OcaList.js';
+import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaProgram } from './OcaProgram.js';
+
+/**
+ * A command set. Child of **OcaProgram**.
+ * @extends OcaProgram
+ * @class OcaCommandSet
+ */
+export const OcaCommandSet = make_control_class(
+  'OcaCommandSet',
+  4,
+  '\u0001\u0005\u0002\u0001',
+  2,
+  OcaProgram,
+  [
+    ['GetCommands', 4, 1, [], [OcaList(OcaCommand)]],
+    ['SetCommands', 4, 2, [OcaList(OcaCommand)], []],
+    ['GetCommand', 4, 3, [OcaUint16], [OcaCommand]],
+    ['SetCommand', 4, 4, [OcaUint16, OcaCommand], []],
+    ['InsertCommand', 4, 5, [OcaUint16, OcaCommand], []],
+    ['DeleteCommand', 4, 6, [OcaUint16], []],
+    ['Clear', 4, 7, [], []],
+  ],
+  [['Commands', [OcaList(OcaCommand)], 4, 1, false, false, null]],
+  []
+);
+
+/**
+ * Gets the list of commands in the commandset.
+ *
+ * @method OcaCommandSet#GetCommands
+ * @returns {Promise<OcaCommand[]>}
+ *   A promise which resolves to a single value of type :class:`OcaCommand[]`.
+ */
+/**
+ * Sets the list of commands in the commandset.
+ *
+ * @method OcaCommandSet#SetCommands
+ * @param {IOcaCommand[]} Commands
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the command designated by the **Index** parameter.
+ *
+ * @method OcaCommandSet#GetCommand
+ * @param {number} Index
+ *
+ * @returns {Promise<OcaCommand>}
+ *   A promise which resolves to a single value of type :class:`OcaCommand`.
+ */
+/**
+ * Replaces the command designated by the **Index** parameter.
+ *
+ * @method OcaCommandSet#SetCommand
+ * @param {number} Index
+ * @param {IOcaCommand} Command
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Inserts a command into the CommandSet after the command with the given
+ * **Index** value.
+ *
+ * @method OcaCommandSet#InsertCommand
+ * @param {number} Index
+ * @param {IOcaCommand} Command
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Removes command with the given **Index** value from the commandset.
+ *
+ * @method OcaCommandSet#DeleteCommand
+ * @param {number} Index
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Removes all commands from the command set.
+ *
+ * @method OcaCommandSet#Clear
+ * @returns {Promise<void>}
+ */
+/**
+ * This event is emitted when the property ``Commands`` changes in the remote object.
+ * The property ``Commands`` is described in the AES70 standard as follows.
+ * The commands in the commandSet.
+ *
+ * @member {PropertyEvent<OcaCommand[]>} OcaCommandSet#OnCommandsChanged
+ */

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

@@ -0,0 +1,31 @@
+import { IOcaCommand } from '../../types/OcaCommand';
+import { OcaCommandResult } from '../../types/OcaCommandResult';
+import { RemoteDevice } from '../remote_device';
+import { OcaAgent } from './OcaAgent';
+
+/**
+ * Agent for immediate execution of commandsets. This agent provides a mechanism
+ * for simple execution of commandsets in cases where the application does not
+ * require the more advanced storage and scheduling features provided by the
+ * **OcaCommandSet**, **OcaTaskAgent**, and **OcaTaskScheduler** classes.
+ * @extends OcaAgent
+ * @class OcaCommandSetAgent
+ */
+export declare class OcaCommandSetAgent extends OcaAgent {
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Execute a command set. Return the status and returned parameter values from
+   * each command. The **OcaStatus** value returned by this** Execute(...)**
+   * method shall be as follows: **OK ** Given commands were executed; all,
+   * none, or some of them succeeded. **<anything else>** Problem, no command
+   * execution was attempted
+   *
+   * @method OcaCommandSetAgent#Execute
+   * @param {IOcaCommand[]} Commands
+   *
+   * @returns {Promise<OcaCommandResult[]>}
+   *   A promise which resolves to a single value of type :class:`OcaCommandResult[]`.
+   */
+  Execute(Commands: IOcaCommand[]): Promise<OcaCommandResult[]>;
+}

package/src/controller/ControlClasses/OcaCommandSetAgent.js

@@ -0,0 +1,38 @@
+import { OcaCommand } from '../../OCP1/OcaCommand.js';
+import { OcaCommandResult } from '../../OCP1/OcaCommandResult.js';
+import { OcaList32 } from '../../OCP1/OcaList32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
+
+/**
+ * Agent for immediate execution of commandsets. This agent provides a mechanism
+ * for simple execution of commandsets in cases where the application does not
+ * require the more advanced storage and scheduling features provided by the
+ * **OcaCommandSet**, **OcaTaskAgent**, and **OcaTaskScheduler** classes.
+ * @extends OcaAgent
+ * @class OcaCommandSetAgent
+ */
+export const OcaCommandSetAgent = make_control_class(
+  'OcaCommandSetAgent',
+  3,
+  '\u0001\u0002\u0017',
+  1,
+  OcaAgent,
+  [['Execute', 3, 1, [OcaList32(OcaCommand)], [OcaList32(OcaCommandResult)]]],
+  [],
+  []
+);
+
+/**
+ * Execute a command set. Return the status and returned parameter values from
+ * each command. The **OcaStatus** value returned by this** Execute(...)**
+ * method shall be as follows: **OK ** Given commands were executed; all, none,
+ * or some of them succeeded. **<anything else>** Problem, no command execution
+ * was attempted
+ *
+ * @method OcaCommandSetAgent#Execute
+ * @param {IOcaCommand[]} Commands
+ *
+ * @returns {Promise<OcaCommandResult[]>}
+ *   A promise which resolves to a single value of type :class:`OcaCommandResult[]`.
+ */

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

@@ -0,0 +1,89 @@
+import {
+  IOcaCounterNotifierFilterParameters,
+  OcaCounterNotifierFilterParameters,
+} from '../../types/OcaCounterNotifierFilterParameters';
+import { OcaCounterUpdate } from '../../types/OcaCounterUpdate';
+import { Event } from '../event';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaAgent } from './OcaAgent';
+
+/**
+ * **Notifier** for an OCA counter. Observes the value of the counter and emits
+ * a **CounterUpdate** notification when specified criteria are met. An OCA
+ * counter wishing to notify controllers of its changing value can designate one
+ * or more notifier objects to which the controllers may subscribe. See the
+ * definition of the **OcaCounter** datatype for additional detail. Notification
+ * criteria are as follows:
+ *
+ *  - **Threshold**. The counter value meets a certain comparison condition. A
+ *    selection of comparison operators is available. The **Operator** property
+ *    is the comparison operator to use for **Threshold.**
+ *
+ *  - **Period**. The value of the** Period** parameter, if nonzero, is a the
+ *    time interval for the recurrent timed emission of **CounterUpdate**
+ *    events. Such events are emitted regardless of the counter's value.
+ *
+ *  - **CountIncrement.** An **CounterUpdate** event is emitted every time the
+ *    counter value changes by an amount equal to or greater than the value of
+ *    this parameter.
+ *
+ *
+ * ** **For combinations of (1), (2), and (3), the criteria are applied as
+ * follows: if (1) is specified and not satisfied, then no observation is
+ * emitted. else if (2) is specified and satisfied or (3) is specified and
+ * satisfied, then an observation is emitted. end end Regardless of filter
+ * parameter values, a notification is always emitted when a counter is
+ * explicitly reset using a **Reset()** method. An **OcaCounterNotifier**
+ * instance and the counter it observes are bound at the time the
+ * **OcaCounterNotifier** instance is constructed. For static devices,
+ * construction will occur during manufacture, or possibly during a subsequent
+ * hardware configuration step. For reconfigurable devices, construction might
+ * be done by online controllers as part of device configuration activity.
+ * @extends OcaAgent
+ * @class OcaCounterNotifier
+ */
+export declare class OcaCounterNotifier extends OcaAgent {
+  /**
+   * Event raised when filter conditions are met.
+   * @member OcaCounterNotifier#OnCounterUpdate {Event}
+   */
+  OnCounterUpdate: Event;
+  /**
+   * This event is emitted whenever FilterParameters changes.
+   */
+  OnFilterParametersChanged: PropertyEvent<OcaCounterNotifierFilterParameters>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Returns the payload of the most recent **CounterUpdate** event emitted by
+   * this object.
+   *
+   * @method OcaCounterNotifier#GetLastUpdate
+   * @returns {Promise<OcaCounterUpdate[]>}
+   *   A promise which resolves to a single value of type :class:`OcaCounterUpdate[]`.
+   */
+  GetLastUpdate(): Promise<OcaCounterUpdate[]>;
+
+  /**
+   * Returns this notifier's set of filter parameters.
+   *
+   * @method OcaCounterNotifier#GetFilterParameters
+   * @returns {Promise<OcaCounterNotifierFilterParameters>}
+   *   A promise which resolves to a single value of type :class:`OcaCounterNotifierFilterParameters`.
+   */
+  GetFilterParameters(): Promise<OcaCounterNotifierFilterParameters>;
+
+  /**
+   * Sets this notifier's set of filter parameters.
+   *
+   * @method OcaCounterNotifier#SetFilterParameters
+   * @param {IOcaCounterNotifierFilterParameters} Parameters
+   *
+   * @returns {Promise<void>}
+   */
+  SetFilterParameters(
+    Parameters: IOcaCounterNotifierFilterParameters
+  ): Promise<void>;
+}

package/src/controller/ControlClasses/OcaCounterNotifier.js

@@ -0,0 +1,101 @@
+import { OcaCounterNotifierFilterParameters } from '../../OCP1/OcaCounterNotifierFilterParameters.js';
+import { OcaCounterUpdate } from '../../OCP1/OcaCounterUpdate.js';
+import { OcaCounterUpdateEventData } from '../../OCP1/OcaCounterUpdateEventData.js';
+import { OcaList } from '../../OCP1/OcaList.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
+
+/**
+ * **Notifier** for an OCA counter. Observes the value of the counter and emits
+ * a **CounterUpdate** notification when specified criteria are met. An OCA
+ * counter wishing to notify controllers of its changing value can designate one
+ * or more notifier objects to which the controllers may subscribe. See the
+ * definition of the **OcaCounter** datatype for additional detail. Notification
+ * criteria are as follows:
+ *
+ *  - **Threshold**. The counter value meets a certain comparison condition. A
+ *    selection of comparison operators is available. The **Operator** property
+ *    is the comparison operator to use for **Threshold.**
+ *
+ *  - **Period**. The value of the** Period** parameter, if nonzero, is a the
+ *    time interval for the recurrent timed emission of **CounterUpdate**
+ *    events. Such events are emitted regardless of the counter's value.
+ *
+ *  - **CountIncrement.** An **CounterUpdate** event is emitted every time the
+ *    counter value changes by an amount equal to or greater than the value of
+ *    this parameter.
+ *
+ *
+ * ** **For combinations of (1), (2), and (3), the criteria are applied as
+ * follows: if (1) is specified and not satisfied, then no observation is
+ * emitted. else if (2) is specified and satisfied or (3) is specified and
+ * satisfied, then an observation is emitted. end end Regardless of filter
+ * parameter values, a notification is always emitted when a counter is
+ * explicitly reset using a **Reset()** method. An **OcaCounterNotifier**
+ * instance and the counter it observes are bound at the time the
+ * **OcaCounterNotifier** instance is constructed. For static devices,
+ * construction will occur during manufacture, or possibly during a subsequent
+ * hardware configuration step. For reconfigurable devices, construction might
+ * be done by online controllers as part of device configuration activity.
+ * @extends OcaAgent
+ * @class OcaCounterNotifier
+ */
+export const OcaCounterNotifier = make_control_class(
+  'OcaCounterNotifier',
+  3,
+  '\u0001\u0002\u0012',
+  1,
+  OcaAgent,
+  [
+    ['GetLastUpdate', 3, 1, [], [OcaList(OcaCounterUpdate)]],
+    ['GetFilterParameters', 3, 2, [], [OcaCounterNotifierFilterParameters]],
+    ['SetFilterParameters', 3, 3, [OcaCounterNotifierFilterParameters], []],
+  ],
+  [
+    [
+      'FilterParameters',
+      [OcaCounterNotifierFilterParameters],
+      3,
+      1,
+      false,
+      false,
+      null,
+    ],
+  ],
+  [['CounterUpdate', 3, 1, [OcaCounterUpdateEventData]]]
+);
+
+/**
+ * Returns the payload of the most recent **CounterUpdate** event emitted by
+ * this object.
+ *
+ * @method OcaCounterNotifier#GetLastUpdate
+ * @returns {Promise<OcaCounterUpdate[]>}
+ *   A promise which resolves to a single value of type :class:`OcaCounterUpdate[]`.
+ */
+/**
+ * Returns this notifier's set of filter parameters.
+ *
+ * @method OcaCounterNotifier#GetFilterParameters
+ * @returns {Promise<OcaCounterNotifierFilterParameters>}
+ *   A promise which resolves to a single value of type :class:`OcaCounterNotifierFilterParameters`.
+ */
+/**
+ * Sets this notifier's set of filter parameters.
+ *
+ * @method OcaCounterNotifier#SetFilterParameters
+ * @param {IOcaCounterNotifierFilterParameters} Parameters
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Event raised when filter conditions are met.
+ * @member OcaCounterNotifier#OnCounterUpdate {Event}
+ */
+/**
+ * This event is emitted when the property ``FilterParameters`` changes in the remote object.
+ * The property ``FilterParameters`` is described in the AES70 standard as follows.
+ * Conditions for emission of the **Observation** event
+ *
+ * @member {PropertyEvent<OcaCounterNotifierFilterParameters>} OcaCounterNotifier#OnFilterParametersChanged
+ */

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

@@ -4,7 +4,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaSensor } from './OcaSensor';
 
 /**
- * Basic current sensor.
+ * Current sensor.
  * @extends OcaSensor
  * @class OcaCurrentSensor
  */
@@ -17,8 +17,7 @@ export declare class OcaCurrentSensor 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/OcaCurrentSensor.js

@@ -3,7 +3,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaSensor } from './OcaSensor.js';
 
 /**
- * Basic current sensor.
+ * Current sensor.
  * @extends OcaSensor
  * @class OcaCurrentSensor
  */
@@ -11,7 +11,7 @@ export const OcaCurrentSensor = make_control_class(
   'OcaCurrentSensor',
   4,
   '\u0001\u0001\u0002\b',
-  1,
+  3,
   OcaSensor,
   [['GetReading', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]]],
   [['Reading', [OcaFloat32], 4, 1, false, false, null]],
@@ -19,8 +19,7 @@ export const OcaCurrentSensor = 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``