aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaDeviceTimeManager.js

@@ -1,5 +1,5 @@
 import { OcaList } from '../../OCP1/OcaList.js';
-import { OcaTimePTP } from '../../OCP1/OcaTimePTP.js';
+import { OcaTime } from '../../OCP1/OcaTime.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
 import { OcaUint64 } from '../../OCP1/OcaUint64.js';
 import { make_control_class } from '../make_control_class.js';
@@ -9,10 +9,12 @@ import { OcaManager } from './OcaManager.js';
  * Manager that allows controlling and monitoring a device's time-of-day clock,
  * and that collects the device's time source objects.
  *
- *  - Must be instantiated once in every device that has more than one time
- *    source object. In this context, a "time source object" is an instance of
+ *  - Must be instantiated in every device that has more than one time source
+ *    object. In this context, a "time source object" is an instance of
  *    **OcaTimeSource** or a subclass of it.
  *
+ *  - May be instantiated at most once in any device.
+ *
  *  - If instantiated, object number must be 10.
  *
  *
@@ -29,7 +31,7 @@ export const OcaDeviceTimeManager = make_control_class(
   'OcaDeviceTimeManager',
   3,
   '\u0001\u0003\n',
-  2,
+  3,
   OcaManager,
   [
     ['GetDeviceTimeNTP', 3, 1, [], [OcaUint64]],
@@ -37,8 +39,8 @@ export const OcaDeviceTimeManager = make_control_class(
     ['GetTimeSources', 3, 3, [], [OcaList(OcaUint32)]],
     ['GetCurrentDeviceTimeSource', 3, 4, [], [OcaUint32]],
     ['SetCurrentDeviceTimeSource', 3, 5, [OcaUint32], []],
-    ['GetDeviceTimePTP', 3, 6, [], [OcaTimePTP]],
-    ['SetDeviceTimePTP', 3, 7, [OcaTimePTP], []],
+    ['GetDeviceTime', 3, 6, [], [OcaTime], ['GetDeviceTimePTP']],
+    ['SetDeviceTime', 3, 7, [OcaTime], [], ['SetDeviceTimePTP']],
   ],
   [
     ['TimeSources', [OcaList(OcaUint32)], 3, 1, false, false, null],
@@ -48,18 +50,17 @@ export const OcaDeviceTimeManager = make_control_class(
 );
 
 /**
- * Get current value of device time-of-day clock in NTP format. Return value
- * indicates whether value was successfully retrieved. This method is optional
- * and deprecated.
+ * Get current value of device time-of-day clock in NTP format. **Deprecated**
+ * in version 3 of this class.
  *
  * @method OcaDeviceTimeManager#GetDeviceTimeNTP
  * @returns {Promise<number|BigInt>}
  *   A promise which resolves to a single value of type ``number|BigInt``.
  */
 /**
- * Sets device time-of-day clock in NTP format. Return value indicates whether
- * value was successfully set. Not available if a time source is identified in
- * property CurrentDeviceTimeSource. This method is optional and deprecated.
+ * Sets device time-of-day clock in NTP format. Not available if a time source
+ * is identified in property CurrentDeviceTimeSource. **Deprecated** in version
+ * 3 of this class.
  *
  * @method OcaDeviceTimeManager#SetDeviceTimeNTP
  * @param {number|BigInt} DeviceTime
@@ -67,24 +68,21 @@ export const OcaDeviceTimeManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns list of object numbers of OcaTimeSource instances in this device.
- * Return value indicates whether list was successfully retrieved.
+ * Gets the list of object numbers of OcaTimeSource instances in this device.
  *
  * @method OcaDeviceTimeManager#GetTimeSources
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * Retrieves ONo of current time source object, or zero if none. Return value
- * indicates whether value was successfully retrieved.
+ * Retrieves **ONo** of current time source object, or zero if none.
  *
  * @method OcaDeviceTimeManager#GetCurrentDeviceTimeSource
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Sets ONo of current time source object, or zero if none. Return value
- * indicates whether value was successfully retrieved.
+ * Sets **ONo** of current time source object, or zero if none.
  *
  * @method OcaDeviceTimeManager#SetCurrentDeviceTimeSource
  * @param {number} TimeSourceONo
@@ -92,34 +90,51 @@ export const OcaDeviceTimeManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Get current value of device time-of-day clock in PTP format. Return value
- * indicates whether value was successfully retrieved.
+ * Get current value of device time-of-day clock.
+ *
+ * @method OcaDeviceTimeManager#GetDeviceTime
+ * @returns {Promise<OcaTime>}
+ *   A promise which resolves to a single value of type :class:`OcaTime`.
+ */
+/**
+ * Get current value of device time-of-day clock.
+ * An alias for GetDeviceTime.
  *
  * @method OcaDeviceTimeManager#GetDeviceTimePTP
- * @returns {Promise<OcaTimePTP>}
- *   A promise which resolves to a single value of type :class:`OcaTimePTP`.
+ * @returns {Promise<OcaTime>}
+ *   A promise which resolves to a single value of type :class:`OcaTime`.
+ */
+/**
+ * Sets device time-of-day clock Not available if a time source is identified in
+ * property **CurrentDeviceTimeSource**.
+ *
+ * @method OcaDeviceTimeManager#SetDeviceTime
+ * @param {IOcaTime} DeviceTime
+ *
+ * @returns {Promise<void>}
  */
 /**
- * Sets device time-of-day clock in PTP format. Return value indicates whether
- * value was successfully set. Not available if a time source is identified in
- * property CurrentDeviceTimeSource.
+ * Sets device time-of-day clock Not available if a time source is identified in
+ * property **CurrentDeviceTimeSource**.
+ * An alias for SetDeviceTime.
  *
  * @method OcaDeviceTimeManager#SetDeviceTimePTP
- * @param {IOcaTimePTP} DeviceTime
+ * @param {IOcaTime} DeviceTime
  *
  * @returns {Promise<void>}
  */
 /**
  * This event is emitted when the property ``TimeSources`` changes in the remote object.
  * The property ``TimeSources`` is described in the AES70 standard as follows.
- * The list of ONos of OcaTimeSource objects in this device
+ * The list of **ONos** of **OcaTimeSource** objects in this device
  *
  * @member {PropertyEvent<number[]>} OcaDeviceTimeManager#OnTimeSourcesChanged
  */
 /**
  * This event is emitted when the property ``CurrentDeviceTimeSource`` changes in the remote object.
  * The property ``CurrentDeviceTimeSource`` is described in the AES70 standard as follows.
- * The current time source for this device's device time, or zero if none.
+ * ONo of the **OcaTimeSource** object that represents current time source for
+ * this device's device time, or zero if none.
  *
  * @member {PropertyEvent<number>} OcaDeviceTimeManager#OnCurrentDeviceTimeSourceChanged
  */

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

@@ -6,7 +6,7 @@ import { OcaManager } from './OcaManager';
  * manager classes, OcaDiagnosticManager may be subclassed to provide
  * proprietary application diagnostic enhancements.
  *
- *  - May be instantiated once in any device.
+ *  - May be instantiated at most once in any device.
  *
  *  - If instantiated, object number must be 13.
  *
@@ -16,16 +16,4 @@ import { OcaManager } from './OcaManager';
  */
 export declare class OcaDiagnosticManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
-
-  /**
-   * Retrieves a text description of the given object's lock status. Return
-   * value indicates success of the retrieval.
-   *
-   * @method OcaDiagnosticManager#GetLockStatus
-   * @param {number} ONo
-   *
-   * @returns {Promise<string>}
-   *   A promise which resolves to a single value of type ``string``.
-   */
-  GetLockStatus(ONo: number): Promise<string>;
 }

package/src/controller/ControlClasses/OcaDiagnosticManager.js

@@ -1,5 +1,3 @@
-import { OcaString } from '../../OCP1/OcaString.js';
-import { OcaUint32 } from '../../OCP1/OcaUint32.js';
 import { make_control_class } from '../make_control_class.js';
 import { OcaManager } from './OcaManager.js';
 
@@ -8,7 +6,7 @@ import { OcaManager } from './OcaManager.js';
  * manager classes, OcaDiagnosticManager may be subclassed to provide
  * proprietary application diagnostic enhancements.
  *
- *  - May be instantiated once in any device.
+ *  - May be instantiated at most once in any device.
  *
  *  - If instantiated, object number must be 13.
  *
@@ -20,20 +18,9 @@ export const OcaDiagnosticManager = make_control_class(
   'OcaDiagnosticManager',
   3,
   '\u0001\u0003\r',
-  1,
+  3,
   OcaManager,
-  [['GetLockStatus', 3, 1, [OcaUint32], [OcaString]]],
+  [],
   [],
   []
 );
-
-/**
- * Retrieves a text description of the given object's lock status. Return value
- * indicates success of the retrieval.
- *
- * @method OcaDiagnosticManager#GetLockStatus
- * @param {number} ONo
- *
- * @returns {Promise<string>}
- *   A promise which resolves to a single value of type ``string``.
- */

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

@@ -18,11 +18,11 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * A multipurpose dynamics processor. Can be configured as compressor, limiter,
- * expander, or gate. This class is expected to handle the majority of the basic
+ * Multipurpose dynamics processor. Can be configured as compressor, limiter,
+ * expander, or gate. This class is designed to handle the majority of the basic
  * cases. More complex devices may be described in a different manner, using one
  * or more **OcaDynamicsDetector** and **OcaDynamicsCurve** objects, in
- * conjunction with other Worker objects as needed.
+ * conjunction with other **Worker** objects as needed.
  * @extends OcaActuator
  * @class OcaDynamics
  */
@@ -100,8 +100,7 @@ export declare class OcaDynamics extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the Triggered property. The return value indicates
-   * whether the property was successfully retrieved.
+   * Gets the value of the **Triggered** property.
    *
    * @method OcaDynamics#GetTriggered
    * @returns {Promise<boolean>}
@@ -110,8 +109,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetTriggered(): Promise<boolean>;
 
   /**
-   * Gets the value of the DynamicGain property. The return value indicates
-   * whether the property was successfully retrieved.
+   * Gets the value of the **DynamicGain** property.
    *
    * @method OcaDynamics#GetDynamicGain
    * @returns {Promise<number>}
@@ -120,8 +118,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetDynamicGain(): Promise<number>;
 
   /**
-   * Sets the value of the Function property. The return value indicates whether
-   * the property was successfully retrieved.
+   * Sets the value of the **Function** property.
    *
    * @method OcaDynamics#GetFunction
    * @returns {Promise<OcaDynamicsFunction>}
@@ -130,8 +127,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetFunction(): Promise<OcaDynamicsFunction>;
 
   /**
-   * Sets the value of the Function property. The return value indicates whether
-   * the property was successfully set.
+   * Sets the value of the **Function** property.
    *
    * @method OcaDynamics#SetFunction
    * @param {IOcaDynamicsFunction} Func
@@ -141,9 +137,8 @@ export declare class OcaDynamics extends OcaActuator {
   SetFunction(Func: IOcaDynamicsFunction): Promise<void>;
 
   /**
-   * Gets the value of the Ratio property. The return value indicates whether
-   * the property was successfully retrieved. GetRatio() is a DEPRECATED method.
-   * Please use **GetSlope()** instead.
+   * Gets the value and limits of the **Ratio** property. DEPRECATED method,
+   * please use **GetSlope()** instead.
    * The return values of this method are
    *
    * - Ratio of type ``number``
@@ -156,9 +151,8 @@ export declare class OcaDynamics extends OcaActuator {
   GetRatio(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the Ratio property. The return value indicates whether
-   * the property was successfully set. SetRatio() is a DEPRECATED method.
-   * Please use **SetSlope()** instead.
+   * Sets the value of the **Ratio** property. DEPRECATED method, please use
+   * **SetSlope()** instead.
    *
    * @method OcaDynamics#SetRatio
    * @param {number} Ratio
@@ -168,8 +162,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetRatio(Ratio: number): Promise<void>;
 
   /**
-   * Gets the value of the Threshold property. The return value indicates if the
-   * value was successfully retrieved.
+   * Gets the value and limits of the **Threshold** property.
    * The return values of this method are
    *
    * - Threshold of type ``IOcaDBr``
@@ -182,8 +175,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetThreshold(): Promise<Arguments<[OcaDBr, number, number]>>;
 
   /**
-   * Sets the value of the Threshold property. The return value indicates if the
-   * value was successfully set.
+   * Sets the value of the **Threshold** property.
    *
    * @method OcaDynamics#SetThreshold
    * @param {IOcaDBr} threshold
@@ -193,8 +185,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetThreshold(threshold: IOcaDBr): Promise<void>;
 
   /**
-   * Gets the value of the ThresholdPresentationUnits property. The return value
-   * indicates if the value was successfully retrieved.
+   * Gets the value of the **ThresholdPresentationUnits** property.
    *
    * @method OcaDynamics#GetThresholdPresentationUnits
    * @returns {Promise<OcaPresentationUnit>}
@@ -203,8 +194,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetThresholdPresentationUnits(): Promise<OcaPresentationUnit>;
 
   /**
-   * Sets the value of the ThresholdPresentationUnits property. The return value
-   * indicates if the value was successfully set.
+   * Sets the value of the **ThresholdPresentationUnits** property.
    *
    * @method OcaDynamics#SetThresholdPresentationUnits
    * @param {IOcaPresentationUnit} Units
@@ -214,8 +204,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetThresholdPresentationUnits(Units: IOcaPresentationUnit): Promise<void>;
 
   /**
-   * Sets the value of the DetectorLaw property. The return value indicates if
-   * the value was successfully set.
+   * Sets the value of the **DetectorLaw** property.
    *
    * @method OcaDynamics#GetDetectorLaw
    * @returns {Promise<OcaLevelDetectionLaw>}
@@ -224,8 +213,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetDetectorLaw(): Promise<OcaLevelDetectionLaw>;
 
   /**
-   * Sets the value of the DetectorLaw property. The return value indicates if
-   * the value was successfully set.
+   * Sets the value of the **DetectorLaw** property.
    *
    * @method OcaDynamics#SetDetectorLaw
    * @param {IOcaLevelDetectionLaw} Law
@@ -235,8 +223,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetDetectorLaw(Law: IOcaLevelDetectionLaw): Promise<void>;
 
   /**
-   * Gets the value of the AttackTime property. The return value indicates if
-   * the value was successfully retrieved.
+   * Gets the value and limits of the **AttackTime** property.
    * The return values of this method are
    *
    * - Time of type ``number``
@@ -249,8 +236,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetAttackTime(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the AttackTime property. The return value indicates if
-   * the value was successfully set.
+   * Sets the value of the **AttackTime** property.
    *
    * @method OcaDynamics#SetAttackTime
    * @param {number} Time
@@ -260,8 +246,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetAttackTime(Time: number): Promise<void>;
 
   /**
-   * Gets the value of the ReleaseTime property. The return value indicates if
-   * the value was successfully retrieved.
+   * Gets the value and limits of the **ReleaseTime** property.
    * The return values of this method are
    *
    * - Time of type ``number``
@@ -274,8 +259,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetReleaseTime(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the ReleaseTime property. The return value indicates if
-   * the value was successfully set.
+   * Sets the value of the **ReleaseTime** property.
    *
    * @method OcaDynamics#SetReleaseTime
    * @param {number} Time
@@ -285,8 +269,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetReleaseTime(Time: number): Promise<void>;
 
   /**
-   * Gets the value of the HoldTime property. The return value indicates if the
-   * value was successfully retrieved.
+   * Gets the value and limits of the **HoldTime** property.
    * The return values of this method are
    *
    * - Time of type ``number``
@@ -299,8 +282,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetHoldTime(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the HoldTime property. The return value indicates if the
-   * value was successfully set.
+   * Sets the value of the **HoldTime** property.
    *
    * @method OcaDynamics#SetHoldTime
    * @param {number} Time
@@ -310,8 +292,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetHoldTime(Time: number): Promise<void>;
 
   /**
-   * Gets the value of the DynamicGainFLoor property. The return value indicates
-   * if the value was successfully retrieved.
+   * Gets the value and limits of the **DynamicGainFloor** property.
    * The return values of this method are
    *
    * - Limit of type ``number``
@@ -324,8 +305,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetDynamicGainFloor(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the DynamicGainFloor property. The return value indicates
-   * if the value was successfully set.
+   * Sets the value of the **DynamicGainFloor** property.
    *
    * @method OcaDynamics#SetDynamicGainFloor
    * @param {number} Limit
@@ -335,8 +315,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetDynamicGainFloor(Limit: number): Promise<void>;
 
   /**
-   * Gets the value of the DynamicGainCeiling property. The return value
-   * indicates if the value was successfully retrieved.
+   * Gets the value and limits of the **DynamicGainCeiling** property.
    * The return values of this method are
    *
    * - Limit of type ``number``
@@ -349,8 +328,8 @@ export declare class OcaDynamics extends OcaActuator {
   GetDynamicGainCeiling(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the DynamicGainCeiling property. The return value
-   * indicates if the value was successfully set.
+   * Value to which the DynamicGainCeiling property shall be set if the method
+   * succeeds
    *
    * @method OcaDynamics#SetDynamicGainCeiling
    * @param {number} Limit
@@ -360,8 +339,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetDynamicGainCeiling(Limit: number): Promise<void>;
 
   /**
-   * Gets the value of the KneeParameter property. The return value indicates if
-   * the value was successfully retrieved.
+   * Gets the value and limits of the **KneeParameter** property.
    * The return values of this method are
    *
    * - Parameter of type ``number``
@@ -374,8 +352,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetKneeParameter(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the KneeParameter property. The return value indicates if
-   * the value was successfully set.
+   * Sets the value of the **KneeParameter** property.
    *
    * @method OcaDynamics#SetKneeParameter
    * @param {number} Parameter
@@ -385,8 +362,7 @@ export declare class OcaDynamics extends OcaActuator {
   SetKneeParameter(Parameter: number): Promise<void>;
 
   /**
-   * Gets the value of the Slope property. The return value indicates whether
-   * the property was successfully retrieved.
+   * Gets the value and limits of the **Slope** property.
    * The return values of this method are
    *
    * - Slope of type ``number``
@@ -399,8 +375,7 @@ export declare class OcaDynamics extends OcaActuator {
   GetSlope(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the Slope property. The return value indicates whether
-   * the property was successfully set.
+   * Sets the value of the **Slope** property.
    *
    * @method OcaDynamics#SetSlope
    * @param {number} Slope
@@ -410,9 +385,9 @@ export declare class OcaDynamics extends OcaActuator {
   SetSlope(Slope: number): Promise<void>;
 
   /**
-   * Sets some or all dynamics parameters. The return value indicates if the
-   * parameters were successfully set. The action of this method is atomic - if
-   * any of the value changes fails, none of the changes are made.
+   * Sets some or all dynamics parameters. The action of this method shall be
+   * atomic - if any of the value changes fails, **none** of the changes shall
+   * be made.
    *
    * @method OcaDynamics#SetMultiple
    * @param {IOcaParameterMask} Mask
@@ -425,8 +400,8 @@ export declare class OcaDynamics extends OcaActuator {
    * @param {number} HoldTime
    * @param {number} DynamicGainCeiling
    * @param {number} DynamicGainFloor
-   * @param {number} Slope
    * @param {number} KneeParameter
+   * @param {number} Slope
    *
    * @returns {Promise<void>}
    */
@@ -441,7 +416,7 @@ export declare class OcaDynamics extends OcaActuator {
     HoldTime: number,
     DynamicGainCeiling: number,
     DynamicGainFloor: number,
-    Slope: number,
-    KneeParameter: number
+    KneeParameter: number,
+    Slope: number
   ): Promise<void>;
 }