aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaStringActuator.js

@@ -4,7 +4,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaBasicActuator } from './OcaBasicActuator.js';
 
 /**
- * String actuator.
+ * UTF-8 String actuator.
  * @extends OcaBasicActuator
  * @class OcaStringActuator
  */
@@ -12,7 +12,7 @@ export const OcaStringActuator = make_control_class(
   'OcaStringActuator',
   5,
   '\u0001\u0001\u0001\u0001\f',
-  2,
+  3,
   OcaBasicActuator,
   [
     ['GetSetting', 5, 1, [], [OcaString]],
@@ -27,24 +27,23 @@ export const OcaStringActuator = make_control_class(
 );
 
 /**
- * Gets the value and max length of the Value property. The return value
- * indicates whether the data was successfully retrieved.
+ * Gets the value of the **Setting** property.
  *
  * @method OcaStringActuator#GetSetting
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the value of the Value property. The return value indicates whether the
- * property was successfully set.
+ * Sets the value of the **Setting** property.
  *
  * @method OcaStringActuator#SetSetting
- * @param {string} Value
+ * @param {string} Setting
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the maximum string length that this object can handle.
+ * Output parameter that shall hold the maximum allowable length of the Setting
+ * property if the method succeeds
  *
  * @method OcaStringActuator#GetMaxLen
  * @returns {Promise<number>}

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

@@ -3,16 +3,20 @@ import { RemoteDevice } from '../remote_device';
 import { OcaBasicSensor } from './OcaBasicSensor';
 
 /**
- * Text string sensor.
+ * UTF-8 string sensor.
  * @extends OcaBasicSensor
  * @class OcaStringSensor
  */
 export declare class OcaStringSensor extends OcaBasicSensor {
   /**
-   * This event is emitted whenever String changes.
+   * This event is emitted whenever Reading changes.
    */
-  OnStringChanged: PropertyEvent<string>;
+  OnReadingChanged: PropertyEvent<string>;
 
+  /**
+   * An alias for OnReadingChanged
+   */
+  OnStringChanged: PropertyEvent<string>;
   /**
    * This event is emitted whenever MaxLen changes.
    */
@@ -21,8 +25,17 @@ export declare class OcaStringSensor extends OcaBasicSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the entire string. Return status indicates success or failure of the
-   * retrieval.
+   * Gets the entire string.
+   *
+   * @method OcaStringSensor#GetReading
+   * @returns {Promise<string>}
+   *   A promise which resolves to a single value of type ``string``.
+   */
+  GetReading(): Promise<string>;
+
+  /**
+   * Gets the entire string.
+   * An alias for GetReading.
    *
    * @method OcaStringSensor#GetString
    * @returns {Promise<string>}
@@ -31,8 +44,7 @@ export declare class OcaStringSensor extends OcaBasicSensor {
   GetString(): Promise<string>;
 
   /**
-   * Gets the maximum number of bytes that may be returned. Returned status
-   * indicates success or failure of the retrieval.
+   * Gets the maximum number of bytes that may be returned.
    *
    * @method OcaStringSensor#GetMaxLen
    * @returns {Promise<number>}
@@ -41,8 +53,7 @@ export declare class OcaStringSensor extends OcaBasicSensor {
   GetMaxLen(): Promise<number>;
 
   /**
-   * Sets the maximum number of bytes that the object may return. Returned
-   * status indicates success or failure of the set.
+   * Sets the maximum number of bytes that the object may return.
    *
    * @method OcaStringSensor#SetMaxLen
    * @param {number} maxLen

package/src/controller/ControlClasses/OcaStringSensor.js

@@ -4,7 +4,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaBasicSensor } from './OcaBasicSensor.js';
 
 /**
- * Text string sensor.
+ * UTF-8 string sensor.
  * @extends OcaBasicSensor
  * @class OcaStringSensor
  */
@@ -12,39 +12,44 @@ export const OcaStringSensor = make_control_class(
   'OcaStringSensor',
   5,
   '\u0001\u0001\u0002\u0001\f',
-  2,
+  3,
   OcaBasicSensor,
   [
-    ['GetString', 5, 1, [], [OcaString]],
+    ['GetReading', 5, 1, [], [OcaString], ['GetString']],
     ['GetMaxLen', 5, 2, [], [OcaUint16]],
     ['SetMaxLen', 5, 3, [OcaUint16], []],
   ],
   [
-    ['String', [OcaString], 5, 1, false, false, null],
+    ['Reading', [OcaString], 5, 1, false, false, ['String']],
     ['MaxLen', [OcaUint16], 5, 2, false, false, null],
   ],
   []
 );
 
 /**
- * Gets the entire string. Return status indicates success or failure of the
- * retrieval.
+ * Gets the entire string.
+ *
+ * @method OcaStringSensor#GetReading
+ * @returns {Promise<string>}
+ *   A promise which resolves to a single value of type ``string``.
+ */
+/**
+ * Gets the entire string.
+ * An alias for GetReading.
  *
  * @method OcaStringSensor#GetString
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Gets the maximum number of bytes that may be returned. Returned status
- * indicates success or failure of the retrieval.
+ * Gets the maximum number of bytes that may be returned.
  *
  * @method OcaStringSensor#GetMaxLen
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Sets the maximum number of bytes that the object may return. Returned status
- * indicates success or failure of the set.
+ * Sets the maximum number of bytes that the object may return.
  *
  * @method OcaStringSensor#SetMaxLen
  * @param {number} maxLen
@@ -52,9 +57,14 @@ export const OcaStringSensor = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property ``String`` changes in the remote object.
- * The property ``String`` is described in the AES70 standard as follows.
- * The string.
+ * This event is emitted when the property ``Reading`` changes in the remote object.
+ * The property ``Reading`` is described in the AES70 standard as follows.
+ * The string. New name as of v3 of this class.
+ *
+ * @member {PropertyEvent<string>} OcaStringSensor#OnReadingChanged
+ */
+/**
+ * An alias for OnReadingChanged
  *
  * @member {PropertyEvent<string>} OcaStringSensor#OnStringChanged
  */

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

@@ -2,6 +2,7 @@ import { IOcaEvent } from '../../types/OcaEvent';
 import { IOcaMethod } from '../../types/OcaMethod';
 import { IOcaNotificationDeliveryMode } from '../../types/OcaNotificationDeliveryMode';
 import { IOcaPropertyID } from '../../types/OcaPropertyID';
+import { IOcaStatus, OcaStatus } from '../../types/OcaStatus';
 import { OcaSubscriptionManagerState } from '../../types/OcaSubscriptionManagerState';
 import { Event } from '../event';
 import { PropertyEvent } from '../property_event';
@@ -11,15 +12,11 @@ import { OcaManager } from './OcaManager';
 /**
  * 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
  */
@@ -46,13 +43,14 @@ export declare class OcaSubscriptionManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * 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
-   * subscriptions are identical if the **Event, Subscriber,
+   * 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.
+   * all 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
@@ -72,9 +70,9 @@ export declare class OcaSubscriptionManager extends OcaManager {
   ): 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
@@ -85,8 +83,8 @@ export declare class OcaSubscriptionManager extends OcaManager {
   RemoveSubscription(Event: IOcaEvent, Subscriber: IOcaMethod): Promise<void>;
 
   /**
-   * Temporarily disables emitting of event notifications (to all subscribers,
-   * not just to the subscriber calling this method). Events from the
+   * 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
@@ -108,10 +106,9 @@ export declare class OcaSubscriptionManager extends OcaManager {
    * **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.
+   * 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>}
@@ -119,15 +116,14 @@ export declare class OcaSubscriptionManager extends OcaManager {
   ReEnableNotifications(): 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
@@ -149,11 +145,10 @@ export declare class OcaSubscriptionManager extends OcaManager {
   ): 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
@@ -169,16 +164,191 @@ export declare class OcaSubscriptionManager extends OcaManager {
   ): 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
-   * 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.
+   * 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. **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``.
    */
   GetMaximumSubscriberContextLength(): Promise<number>;
+
+  /**
+   * Adds an EV2 subscription.
+   *
+   * @method OcaSubscriptionManager#AddSubscription2
+   * @param {IOcaEvent} Event
+   * @param {IOcaNotificationDeliveryMode} NotificationDeliveryMode
+   * @param {Uint8Array} DestinationInformation
+   *
+   * @returns {Promise<void>}
+   */
+  AddSubscription2(
+    Event: IOcaEvent,
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array
+  ): 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>}
+   */
+  RemoveSubscription2(
+    Event: IOcaEvent,
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array
+  ): 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>}
+   */
+  AddPropertyChangeSubscription2(
+    Emitter: number,
+    Property: IOcaPropertyID,
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array
+  ): 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>}
+   */
+  RemovePropertyChangeSubscription2(
+    Emitter: number,
+    Property: IOcaPropertyID,
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array
+  ): 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[]`.
+   */
+  AddSubscription2List(
+    Events: IOcaEvent[],
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array
+  ): Promise<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>}
+   */
+  RemoveSubscription2List(
+    Events: IOcaEvent[],
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array
+  ): 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>}
+   */
+  AddPropertyChangeSubscription2List(
+    Emitters: number[],
+    Properties: IOcaPropertyID[],
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array,
+    ResultStatuses: IOcaStatus[]
+  ): 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>}
+   */
+  RemovePropertyChangeSubscription2List(
+    Emitters: number[],
+    Properties: IOcaPropertyID[],
+    NotificationDeliveryMode: IOcaNotificationDeliveryMode,
+    DestinationInformation: Uint8Array
+  ): Promise<void>;
 }