aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaSubscriptionManager.js

@@ -1,9 +1,11 @@
 import { OcaBlob } from '../../OCP1/OcaBlob.js';
 import { OcaEvent } from '../../OCP1/OcaEvent.js';
+import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaMethod } from '../../OCP1/OcaMethod.js';
 import { OcaNotificationDeliveryMode } from '../../OCP1/OcaNotificationDeliveryMode.js';
 import { OcaObjectListEventData } from '../../OCP1/OcaObjectListEventData.js';
 import { OcaPropertyID } from '../../OCP1/OcaPropertyID.js';
+import { OcaStatus } from '../../OCP1/OcaStatus.js';
 import { OcaSubscriptionManagerState } from '../../OCP1/OcaSubscriptionManagerState.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
@@ -13,15 +15,11 @@ import { OcaManager } from './OcaManager.js';
 /**
  * Manager that collects and controls the event subscriptions of the device.
  *
- *  - Must be instantiated once in every device that supports subscriptions.
+ *  - Must be instantiated exactly once in every device.
  *
- *  - May be instantiated at most once in any device.
+ *  - Object number must be 4.
  *
- *  - If instantiated, must have object number 4.
  *
- *
- * Absence of an **OcaSubscriptionManager** object signifies that the device
- * does not support event subscriptions.
  * @extends OcaManager
  * @class OcaSubscriptionManager
  */
@@ -29,7 +27,7 @@ export const OcaSubscriptionManager = make_control_class(
   'OcaSubscriptionManager',
   3,
   '\u0001\u0003\u0004',
-  2,
+  4,
   OcaManager,
   [
     [
@@ -64,6 +62,73 @@ export const OcaSubscriptionManager = make_control_class(
       [],
     ],
     ['GetMaximumSubscriberContextLength', 3, 7, [], [OcaUint16]],
+    [
+      'AddSubscription2',
+      3,
+      8,
+      [OcaEvent, OcaNotificationDeliveryMode, OcaBlob],
+      [],
+    ],
+    [
+      'RemoveSubscription2',
+      3,
+      9,
+      [OcaEvent, OcaNotificationDeliveryMode, OcaBlob],
+      [],
+    ],
+    [
+      'AddPropertyChangeSubscription2',
+      3,
+      10,
+      [OcaUint32, OcaPropertyID, OcaNotificationDeliveryMode, OcaBlob],
+      [],
+    ],
+    [
+      'RemovePropertyChangeSubscription2',
+      3,
+      11,
+      [OcaUint32, OcaPropertyID, OcaNotificationDeliveryMode, OcaBlob],
+      [],
+    ],
+    [
+      'AddSubscription2List',
+      3,
+      12,
+      [OcaList(OcaEvent), OcaNotificationDeliveryMode, OcaBlob],
+      [OcaList(OcaStatus)],
+    ],
+    [
+      'RemoveSubscription2List',
+      3,
+      13,
+      [OcaList(OcaEvent), OcaNotificationDeliveryMode, OcaBlob],
+      [],
+    ],
+    [
+      'AddPropertyChangeSubscription2List',
+      3,
+      14,
+      [
+        OcaList(OcaUint32),
+        OcaList(OcaPropertyID),
+        OcaNotificationDeliveryMode,
+        OcaBlob,
+        OcaList(OcaStatus),
+      ],
+      [],
+    ],
+    [
+      'RemovePropertyChangeSubscription2List',
+      3,
+      15,
+      [
+        OcaList(OcaUint32),
+        OcaList(OcaPropertyID),
+        OcaNotificationDeliveryMode,
+        OcaBlob,
+      ],
+      [],
+    ],
   ],
   [['State', [OcaSubscriptionManagerState], 3, 1, false, false, null]],
   [
@@ -73,12 +138,14 @@ export const OcaSubscriptionManager = make_control_class(
 );
 
 /**
- * Adds a subscription to an event. The subscription is added for the session on
- * which the command came in. If a subscription identical to the one being
- * requested already exists, an additional one shall not be added. Two
+ * Adds an EV1 subscription to an event. The subscription is added for the
+ * session on which the command came in. If a subscription identical to the one
+ * being requested already exists, an additional one shall not be added. Two
  * subscriptions are identical if the **Event, Subscriber,
  * NotificationDeliveryMode**, and **DestinationInformation** parameters are all
- * identical. The return value indicates whether the subscription succeeded.
+ * identical. **Deprecated** in version 3 of this class, replaced by
+ * **AddPropertyChangeSubscription(..).** Deprecated in version 3 of this class,
+ * and replaced by **AddSubscription2**.
  *
  * @method OcaSubscriptionManager#AddSubscription
  * @param {IOcaEvent} Event
@@ -90,9 +157,9 @@ export const OcaSubscriptionManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Removes all subscriptions to the given event with the given **OcaMethod**.
- * The return value indicates whether the subscription(s) was (were)
- * successfully removed.
+ * Removes all EV1 subscriptions to the given event with the given
+ * **OcaMethod**. **Deprecated** in version 3 of this class, and replaced by
+ * **RemoveSubscription2**.
  *
  * @method OcaSubscriptionManager#RemoveSubscription
  * @param {IOcaEvent} Event
@@ -101,8 +168,8 @@ export const OcaSubscriptionManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Temporarily disables emitting of event notifications (to all subscribers, not
- * just to the subscriber calling this method). Events from the Subscription
+ * Temporarily disables emitting of event notifications to all subscribers, not
+ * just to the subscriber calling this method. Events from the Subscription
  * Manager itself are not disabled. This method can be used if either a
  * controller or the local device knows that it is going to change the state of
  * the device significantly, which could lead to a notification storm of events.
@@ -121,24 +188,21 @@ export const OcaSubscriptionManager = make_control_class(
  * are re-enabled, the subscription manager will raise the **SynchronizeState**
  * event, passing the list of objects that have changed state. Subsequently, the
  * subscription manager will transmit all notifications as normal. If the
- * connection to the controller that invoked the DisableEvents() is lost, this
- * method will be called automatically to prevent the situation in which the
- * raising of events would never be re-enabled. The return value indicates if
- * re-enabling the event-based events succeeded.
+ * connection to the controller that invoked the **DisableEvents()** is lost,
+ * this method will be called automatically to prevent the situation in which
+ * the raising of events would never be re-enabled.
  *
  * @method OcaSubscriptionManager#ReEnableNotifications
  * @returns {Promise<void>}
  */
 /**
- * Adds a subscription to the PropertyChanged event in the object Emitter for
- * changes of the property Property. If the NotificationDeliveryMode is Fast,
- * the subscription is added for the session on which the command came in. If a
- * subscription identical to the one being requested already exists, an
- * additional one shall not be added. Two subscriptions are identical if the
- * Emitter, Property, Subscriber, SubsciberContext, NotificationDeliveryMode,
- * and DestinationInformation parameters are all identical. The return value
- * indicates whether the subscription succeeded. Added in v2 of this class, in
- * AES70-2017.
+ * Adds an EV1 subscription to the **PropertyChanged** event in the object
+ * **Emitter** for changes of the property **Property**. If a subscription
+ * identical to the one being requested already exists, an additional one shall
+ * not be added. Two subscriptions are identical if the **Emitter, Property,
+ * Subscriber, SubsciberContext, NotificationDeliveryMode,** and
+ * **DestinationInformation** parameters are all identical. **Deprecated** in
+ * version 3 of this class, replaced by **AddPropertyChangeSubscription2(..).**
  *
  * @method OcaSubscriptionManager#AddPropertyChangeSubscription
  * @param {number} Emitter
@@ -151,11 +215,10 @@ export const OcaSubscriptionManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Removes any subscription to a PropertyChanged event with the given Emitter,
- * Property, Subscriber, SubscriberContext, NotificationDeliveryMode, and
- * DestinationInformation. The return value indicates whether the
- * subscription(s) was (were) successfully removed. Added in v2 of this class,
- * in AES70-2017.
+ * Removes any EV1 subscription to a **PropertyChanged** event with the given
+ * Emitter, Property, Subscriber, SubscriberContext, NotificationDeliveryMode,
+ * and DestinationInformation. **Deprecated** in version 3 of this class,
+ * replaced by **RemovePropertyChangeSubscription2(...).**
  *
  * @method OcaSubscriptionManager#RemovePropertyChangeSubscription
  * @param {number} Emitter
@@ -165,17 +228,139 @@ export const OcaSubscriptionManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns maximum byte length of payload of subscriber context parameter that
- * this device supports. This returned value shall be either zero or four. If
- * the returned payload length is not zero, it shall be four. No other values
+ * Returns maximum byte length of payload of EV1 subscriber context parameter
+ * that this device supports. This returned value shall be either zero or four.
+ * If the returned payload length is not zero, it shall be four. No other values
  * shall be allowed, and the returned value shall not change once the device has
- * initialized. NOTE: In AES70-2015, arbitrary subscriber context lengths were
- * allowed; this is no longer true.
+ * initialized. **Deprecated** in version 3 of this class. Not used in EV2.
+ * NOTE: In AES70-2015, arbitrary subscriber context lengths were allowed; this
+ * is no longer true.
  *
  * @method OcaSubscriptionManager#GetMaximumSubscriberContextLength
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
+/**
+ * Adds an EV2 subscription.
+ *
+ * @method OcaSubscriptionManager#AddSubscription2
+ * @param {IOcaEvent} Event
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Removes all EV2 subscriptions with the given **Event**,
+ * **NotificationDeliveryMode**, and **DestinationInformation**.
+ *
+ * @method OcaSubscriptionManager#RemoveSubscription2
+ * @param {IOcaEvent} Event
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Adds an EV2 subscription to the **PropertyChanged** event in the object
+ * **Emitter** for changes of the property **Property**. If a subscription
+ * identical to the one being requested already exists, an additional one shall
+ * not be added and the method shall return the status value **InvalidRequest**.
+ * Two subscriptions are identical if the **Emitter, Property,
+ * NotificationDeliveryMode,** and **DestinationInformation** parameters are all
+ * identical.
+ *
+ * @method OcaSubscriptionManager#AddPropertyChangeSubscription2
+ * @param {number} Emitter
+ * @param {IOcaPropertyID} Property
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Removes all EV2 subscriptions to **PropertyChanged** events with the given
+ * **Emitter**, **Property**, **NotificationDeliveryMode**, and
+ * **DestinationInformation**.
+ *
+ * @method OcaSubscriptionManager#RemovePropertyChangeSubscription2
+ * @param {number} Emitter
+ * @param {IOcaPropertyID} Property
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Adds a list of EV2 subscriptions. **OcaStatus** return values from this
+ * method are as follows:
+ *
+ *  - **OK**: Requested subscriptions were attempted; all, none, or some
+ *    succeeded. Individual subscription result details are returned in
+ *    parameter **ResultStatuses**.
+ *
+ *  - **<anything else>:** Problem - no subscription attempts were made.
+ *
+ *
+ *
+ * @method OcaSubscriptionManager#AddSubscription2List
+ * @param {IOcaEvent[]} Events
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ *
+ * @returns {Promise<OcaStatus[]>}
+ *   A promise which resolves to a single value of type :class:`OcaStatus[]`.
+ */
+/**
+ * Removes all EV2 subscriptions in the given list of Events that have the
+ * specified **NotificationDeliveryMode** and **DestinationInformation**.
+ *
+ * @method OcaSubscriptionManager#RemoveSubscription2List
+ * @param {IOcaEvent[]} Events
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Adds a list of EV2 property-change subscriptions. **OcaStatus** return values
+ * from this method are as follows:
+ *
+ *  - **OK**: Requested subscriptions were attempted; all, none, or some
+ *    succeeded. Individual subscription result details are returned in list
+ *    parameter **ResultStatuses**.
+ *
+ *  - **<anything else>:** Problem - no subscription attempts were made.
+ *
+ *
+ * If a subscription identical to the one being requested already exists, an
+ * additional one shall not be added and the method shall return the
+ * **ResultStatuses** value **InvalidRequest**. Two subscriptions are identical
+ * if the **Emitter, Property, NotificationDeliveryMode,** and
+ * **DestinationInformation** parameters are all identical.
+ *
+ * @method OcaSubscriptionManager#AddPropertyChangeSubscription2List
+ * @param {number[]} Emitters
+ * @param {IOcaPropertyID[]} Properties
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ * @param {IOcaStatus[]} ResultStatuses
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Removes all EV2 property-change subscriptions in the given lists of Events
+ * and Properties that have the specified **NotificationDeliveryMode** and
+ * **DestinationInformation**.
+ *
+ * @method OcaSubscriptionManager#RemovePropertyChangeSubscription2List
+ * @param {number[]} Emitters
+ * @param {IOcaPropertyID[]} Properties
+ * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+ * @param {Uint8Array} DestinationInformation
+ *
+ * @returns {Promise<void>}
+ */
 /**
  * Event that is raised when the value of the **State** property changes from
  * **Normal **to **EventsDisabled.**

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

@@ -2,8 +2,9 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * Actuator with no control parameters, used as a simple node to represent
- * summations in block signal flows.
+ * Actuator with no control parameters of its own, used as a simple node to
+ * represent summations in block signal flows. Signal path connections are
+ * controlled by methods inherited from **OcaWorker**.
  * @extends OcaActuator
  * @class OcaSummingPoint
  */

package/src/controller/ControlClasses/OcaSummingPoint.js

@@ -2,8 +2,9 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaActuator } from './OcaActuator.js';
 
 /**
- * Actuator with no control parameters, used as a simple node to represent
- * summations in block signal flows.
+ * Actuator with no control parameters of its own, used as a simple node to
+ * represent summations in block signal flows. Signal path connections are
+ * controlled by methods inherited from **OcaWorker**.
  * @extends OcaActuator
  * @class OcaSummingPoint
  */
@@ -11,7 +12,7 @@ export const OcaSummingPoint = make_control_class(
   'OcaSummingPoint',
   4,
   '\u0001\u0001\u0001\u0016',
-  1,
+  3,
   OcaActuator,
   [],
   [],

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

@@ -4,7 +4,9 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * (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
  */
@@ -20,16 +22,23 @@ export declare class OcaSwitch extends OcaActuator {
   OnPositionNamesChanged: PropertyEvent<string[]>;
 
   /**
-   * This event is emitted whenever PositionEnableds changes.
+   * This event is emitted whenever PositionEnableFlags changes.
+   */
+  OnPositionEnableFlagsChanged: PropertyEvent<boolean[]>;
+
+  /**
+   * An alias for OnPositionEnableFlagsChanged
+   */
+  OnPositionEnableChanged: PropertyEvent<boolean[]>;
+  /**
+   * An alias for OnPositionEnableFlagsChanged
    */
   OnPositionEnabledsChanged: PropertyEvent<boolean[]>;
 
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * 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``
@@ -42,8 +51,7 @@ export declare class OcaSwitch extends OcaActuator {
   GetPosition(): 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
@@ -53,8 +61,7 @@ export declare class OcaSwitch extends OcaActuator {
   SetPosition(position: number): 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
@@ -65,8 +72,7 @@ export declare class OcaSwitch extends OcaActuator {
   GetPositionName(Index: number): Promise<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
@@ -77,8 +83,7 @@ export declare class OcaSwitch extends OcaActuator {
   SetPositionName(Index: number, Name: string): 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[]>}
@@ -87,8 +92,7 @@ export declare class OcaSwitch extends OcaActuator {
   GetPositionNames(): Promise<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
@@ -98,8 +102,19 @@ export declare class OcaSwitch extends OcaActuator {
   SetPositionNames(Names: string[]): 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``.
+   */
+  GetPositionEnableFlag(Index: number): Promise<boolean>;
+
+  /**
+   * Gets the Enabled flag assigned to a given switch position.
+   * An alias for GetPositionEnableFlag.
    *
    * @method OcaSwitch#GetPositionEnabled
    * @param {number} Index
@@ -110,8 +125,19 @@ export declare class OcaSwitch extends OcaActuator {
   GetPositionEnabled(Index: number): Promise<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>}
+   */
+  SetPositionEnableFlag(Index: number, enabled: boolean): Promise<void>;
+
+  /**
+   * Sets the Enabled flag assigned to a given switch position.
+   * An alias for SetPositionEnableFlag.
    *
    * @method OcaSwitch#SetPositionEnabled
    * @param {number} Index
@@ -122,8 +148,17 @@ export declare class OcaSwitch extends OcaActuator {
   SetPositionEnabled(Index: number, enabled: boolean): 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[]``.
+   */
+  GetPositionEnableFlags(): Promise<boolean[]>;
+
+  /**
+   * Gets list of position-enabled flags assigned to the switch's positions.
+   * An alias for GetPositionEnableFlags.
    *
    * @method OcaSwitch#GetPositionEnableds
    * @returns {Promise<boolean[]>}
@@ -132,13 +167,23 @@ export declare class OcaSwitch extends OcaActuator {
   GetPositionEnableds(): Promise<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>}
+   */
+  SetPositionEnableFlags(flags: boolean[]): 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>}
    */
-  SetPositionEnableds(enableds: boolean[]): Promise<void>;
+  SetPositionEnableds(flags: boolean[]): Promise<void>;
 }