aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaRamper.js

@@ -6,6 +6,9 @@ import { OcaRamperInterpolationLaw } from '../../OCP1/OcaRamperInterpolationLaw.
 import { OcaRamperState } from '../../OCP1/OcaRamperState.js';
 import { OcaTimeMode } from '../../OCP1/OcaTimeMode.js';
 import { OcaUint64 } from '../../OCP1/OcaUint64.js';
+import { OcaVariant } from '../../OCP1/OcaVariant.js';
+import { OcaWhenPhysicalAbsolute } from '../../OCP1/OcaWhenPhysicalAbsolute.js';
+import { OcaWhenPhysicalRelative } from '../../OCP1/OcaWhenPhysicalRelative.js';
 import { make_control_class } from '../make_control_class.js';
 import { OcaAgent } from './OcaAgent.js';
 
@@ -52,6 +55,20 @@ export const OcaRamper = make_control_class(
     ['SetInterpolationLaw', 3, 12, [OcaRamperInterpolationLaw], []],
     ['GetGoal', 3, 13, [], [OcaFloat64]],
     ['SetGoal', 3, 14, [OcaFloat64], []],
+    [
+      'GetStartWhen',
+      3,
+      15,
+      [],
+      [OcaVariant(OcaWhenPhysicalAbsolute, OcaWhenPhysicalRelative)],
+    ],
+    [
+      'SetStartWhen',
+      3,
+      16,
+      [OcaVariant(OcaWhenPhysicalAbsolute, OcaWhenPhysicalRelative)],
+      [],
+    ],
   ],
   [
     ['State', [OcaRamperState], 3, 1, false, false, null],
@@ -61,12 +78,21 @@ export const OcaRamper = make_control_class(
     ['Duration', [OcaFloat32], 3, 5, false, false, null],
     ['InterpolationLaw', [OcaRamperInterpolationLaw], 3, 6, false, false, null],
     ['Goal', [OcaFloat64], 3, 7, false, false, null],
+    [
+      'StartWhen',
+      [OcaVariant(OcaWhenPhysicalAbsolute, OcaWhenPhysicalRelative)],
+      3,
+      8,
+      false,
+      false,
+      null,
+    ],
   ],
   []
 );
 
 /**
- * Executes the given ramper command. The return value indicates whether the
+ * Executes the given Ramper command. The return value indicates whether the
  * command was successfully executed.
  *
  * @method OcaRamper#Control
@@ -100,16 +126,16 @@ export const OcaRamper = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets ramper time mode (absolute or relative). The return value indicates
- * whether the time mode was successfully retrieved.
+ * Gets ramper time mode (absolute or relative). **Deprecated** in v3 of this
+ * class.
  *
  * @method OcaRamper#GetTimeMode
  * @returns {Promise<OcaTimeMode>}
  *   A promise which resolves to a single value of type :class:`OcaTimeMode`.
  */
 /**
- * Sets ramper time mode (absolute or relative). The return value indicates
- * whether the time mode was successfully set.
+ * Sets ramper time mode (absolute or relative). **Deprecated** in v3 of this
+ * class.
  *
  * @method OcaRamper#SetTimeMode
  * @param {IOcaTimeMode} TimeMode
@@ -117,16 +143,15 @@ export const OcaRamper = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets ramp start time. The return value indicates whether the start time was
- * successfully retrieved.
+ * Output parameter that holds the start time of the ramp if the method
+ * succeeds. **Deprecated** in version 3 of this class.
  *
  * @method OcaRamper#GetStartTime
  * @returns {Promise<number|BigInt>}
  *   A promise which resolves to a single value of type ``number|BigInt``.
  */
 /**
- * Sets ramper start time. The return value indicates whether the start time was
- * successfully set.
+ * Sets ramper start time. **Deprecated** in v3 of this class.
  *
  * @method OcaRamper#SetStartTime
  * @param {number|BigInt} TimeMode
@@ -139,7 +164,7 @@ export const OcaRamper = make_control_class(
  * The return values of this method are
  *
  * - Duration of type ``number``
- * - miinDuration of type ``number``
+ * - minDuration of type ``number``
  * - maxDuration of type ``number``
  *
  * @method OcaRamper#GetDuration
@@ -188,6 +213,22 @@ export const OcaRamper = make_control_class(
  *
  * @returns {Promise<void>}
  */
+/**
+ * Gets the value of the **StartWhen** property.
+ *
+ * @method OcaRamper#GetStartWhen
+ * @returns {Promise<(OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)>}
+ *   A promise which resolves to a single value of type ``(OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)``.
+ */
+/**
+ * Sets the value of the **StartWhen** property. Shall fail if called when
+ * **State** is **Ramping**.
+ *
+ * @method OcaRamper#SetStartWhen
+ * @param {(IOcaWhenPhysicalAbsolute | IOcaWhenPhysicalRelative)} When
+ *
+ * @returns {Promise<void>}
+ */
 /**
  * This event is emitted when the property ``State`` changes in the remote object.
  * The property ``State`` is described in the AES70 standard as follows.
@@ -205,7 +246,8 @@ export const OcaRamper = make_control_class(
 /**
  * This event is emitted when the property ``TimeMode`` changes in the remote object.
  * The property ``TimeMode`` is described in the AES70 standard as follows.
- * Absolute or Relative time.
+ * Absolute or Relative time. In version 3 of this class, this property is
+ * **deprecated** and replaced by property **StartWhen**.
  *
  * @member {PropertyEvent<OcaTimeMode>} OcaRamper#OnTimeModeChanged
  */
@@ -215,7 +257,9 @@ export const OcaRamper = make_control_class(
  * Time at which to start ramp. If **TimeMode=Relative**, the actual event start
  * time equals the value of **StartTime** plus the absolute time that
  * **StartTime** was most recently set. If **TimeMode=Absolute**, the actual
- * event start time equals the value of **StartTime**
+ * event start time equals the value of **StartTime.** In version 3 of this
+ * class, this property is **deprecated** and replaced by property
+ * **StartWhen**.
  *
  * @member {PropertyEvent<number|BigInt>} OcaRamper#OnStartTimeChanged
  */
@@ -240,3 +284,12 @@ export const OcaRamper = make_control_class(
  *
  * @member {PropertyEvent<number>} OcaRamper#OnGoalChanged
  */
+/**
+ * This event is emitted when the property ``StartWhen`` changes in the remote object.
+ * The property ``StartWhen`` is described in the AES70 standard as follows.
+ * An **OcaWhen** item that specifies when to start ramp. Absolute or relative
+ * time, according to what the **OcaWhen** item specifies. Relative time values
+ * are based on the absolute time that **StartWhen** was most recently set.
+ *
+ * @member {PropertyEvent<(OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)>} OcaRamper#OnStartWhenChanged
+ */

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

@@ -1,6 +1,8 @@
 import { OcaClassIdentification } from '../../types/OcaClassIdentification';
+import { OcaLockState } from '../../types/OcaLockState';
 import { Event } from '../event';
 import { ObjectBase } from '../object_base';
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 
 /**
@@ -12,18 +14,21 @@ import { RemoteDevice } from '../remote_device';
 export declare class OcaRoot extends ObjectBase {
   /**
    * General event that is emitted when a property changes. In each setter
-   * method (of derived classes) this event must be raised with the proper
+   * method (of derived classes) this event shall be raised with the proper
    * derived event data structure.
    * @member OcaRoot#OnPropertyChanged {Event}
    */
   OnPropertyChanged: Event;
+  /**
+   * This event is emitted whenever LockState changes.
+   */
+  OnLockStateChanged: PropertyEvent<OcaLockState>;
 
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the class identification, a structure that contains the ClassID and
-   * ClassVersion. The return value indicates whether the property was
-   * successfully retrieved.
+   * Gets the class identification, a structure contains the ClassID and
+   * ClassVersion.
    *
    * @method OcaRoot#GetClassIdentification
    * @returns {Promise<OcaClassIdentification>}
@@ -32,8 +37,7 @@ export declare class OcaRoot extends ObjectBase {
   GetClassIdentification(): Promise<OcaClassIdentification>;
 
   /**
-   * Gets the value of the Lockable property. The return value indicates whether
-   * the property was successfully retrieved.
+   * Gets the value of the Lockable property.
    *
    * @method OcaRoot#GetLockable
    * @returns {Promise<boolean>}
@@ -43,11 +47,33 @@ export declare class OcaRoot extends ObjectBase {
 
   /**
    * Locks the object totally, so that it can only be accessed for reading or
-   * writing by the lockholder. If the device is read-only locked (by a prior
-   * call to LockReadonly()) when Lock() is called by the same lockholder, the
-   * lock state is upgraded to total. If the call is from a session other than
-   * the lockholder's, the call fails. The return value indicates whether the
-   * operation succeeded.
+   * writing by the lockholder.
+   *
+   *  - If the object's **LockState** is **LockNoWrite** by the same lockholder,
+   *    the lock state is upgraded to LockNoReadWrite.
+   *
+   *  - If the call is from a session other than the lockholder's, the call
+   *    fails.
+   *
+   *
+   *
+   * @method OcaRoot#SetLockNoReadWrite
+   * @returns {Promise<void>}
+   */
+  SetLockNoReadWrite(): Promise<void>;
+
+  /**
+   * Locks the object totally, so that it can only be accessed for reading or
+   * writing by the lockholder.
+   *
+   *  - If the object's **LockState** is **LockNoWrite** by the same lockholder,
+   *    the lock state is upgraded to LockNoReadWrite.
+   *
+   *  - If the call is from a session other than the lockholder's, the call
+   *    fails.
+   *
+   *
+   * An alias for SetLockNoReadWrite.
    *
    * @method OcaRoot#LockTotal
    * @returns {Promise<void>}
@@ -56,8 +82,7 @@ export declare class OcaRoot extends ObjectBase {
 
   /**
    * Unlocks the object so that it can be freely accessed again. This method can
-   * only succeed if it is called by the lockholder. The return value indicates
-   * whether the operation succeeded.
+   * only succeed if it is called by the lockholder.
    *
    * @method OcaRoot#Unlock
    * @returns {Promise<void>}
@@ -65,8 +90,7 @@ export declare class OcaRoot extends ObjectBase {
   Unlock(): Promise<void>;
 
   /**
-   * Returns value of Role property. The return value indicates whether the
-   * operation succeeded.
+   * Returns value of Role property.
    *
    * @method OcaRoot#GetRole
    * @returns {Promise<string>}
@@ -75,15 +99,36 @@ export declare class OcaRoot extends ObjectBase {
   GetRole(): Promise<string>;
 
   /**
-   * Locks the object so that its properties may only be modified by the
-   * lockholder, but others can still retrieve property values. If the device is
-   * already locked (by a prior call to Lock() or LockReadonly()) when
-   * LockReadonly() is called by the same lockholder, the lock state is set to
-   * read-only. If the call is from a session other than the lockholder's, the
-   * call fails. The return value indicates whether the operation succeeded.
-   *
-   * @method OcaRoot#LockReadonly
+   * Locks the object so that it may only be controlled by the lockholder, but
+   * others can still retrieve property values. If **LockState** is
+   * **LockNoReadWrite** by the same lockholder, the lock state is downgraded to
+   * **LockNoWrite**. If the call is from a session other than the lockholder's,
+   * the call fails.
+   *
+   * @method OcaRoot#SetLockNoWrite
    * @returns {Promise<void>}
    */
-  LockReadonly(): Promise<void>;
+  SetLockNoWrite(): Promise<void>;
+
+  /**
+   * Locks the object so that it may only be controlled by the lockholder, but
+   * others can still retrieve property values. If **LockState** is
+   * **LockNoReadWrite** by the same lockholder, the lock state is downgraded to
+   * **LockNoWrite**. If the call is from a session other than the lockholder's,
+   * the call fails.
+   * An alias for SetLockNoWrite.
+   *
+   * @method OcaRoot#LockReadOnly
+   * @returns {Promise<void>}
+   */
+  LockReadOnly(): Promise<void>;
+
+  /**
+   * Returns the current value of the **LockState** property.
+   *
+   * @method OcaRoot#GetLockState
+   * @returns {Promise<OcaLockState>}
+   *   A promise which resolves to a single value of type :class:`OcaLockState`.
+   */
+  GetLockState(): Promise<OcaLockState>;
 }

package/src/controller/ControlClasses/OcaRoot.js

@@ -1,5 +1,6 @@
 import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
 import { OcaClassIdentification } from '../../OCP1/OcaClassIdentification.js';
+import { OcaLockState } from '../../OCP1/OcaLockState.js';
 import { OcaPropertyChangedEventData } from '../../OCP1/OcaPropertyChangedEventData.js';
 import { OcaString } from '../../OCP1/OcaString.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
@@ -18,15 +19,16 @@ export const OcaRoot = make_control_class(
   'OcaRoot',
   1,
   '\u0001',
-  2,
+  3,
   ObjectBase,
   [
     ['GetClassIdentification', 1, 1, [], [OcaClassIdentification]],
     ['GetLockable', 1, 2, [], [OcaBoolean]],
-    ['LockTotal', 1, 3, [], []],
+    ['SetLockNoReadWrite', 1, 3, [], [], ['LockTotal']],
     ['Unlock', 1, 4, [], []],
     ['GetRole', 1, 5, [], [OcaString]],
-    ['LockReadonly', 1, 6, [], []],
+    ['SetLockNoWrite', 1, 6, [], [], ['LockReadOnly']],
+    ['GetLockState', 1, 7, [], [OcaLockState]],
   ],
   [
     ['ClassID', [String16], 1, 1, true, true, null],
@@ -34,22 +36,21 @@ export const OcaRoot = make_control_class(
     ['ObjectNumber', [OcaUint32], 1, 3, true, false, null],
     ['Lockable', [OcaBoolean], 1, 4, true, false, null],
     ['Role', [OcaString], 1, 5, true, false, null],
+    ['LockState', [OcaLockState], 1, 6, false, false, null],
   ],
   [['PropertyChanged', 1, 1, [OcaPropertyChangedEventData]]]
 );
 
 /**
- * Gets the class identification, a structure that contains the ClassID and
- * ClassVersion. The return value indicates whether the property was
- * successfully retrieved.
+ * Gets the class identification, a structure contains the ClassID and
+ * ClassVersion.
  *
  * @method OcaRoot#GetClassIdentification
  * @returns {Promise<OcaClassIdentification>}
  *   A promise which resolves to a single value of type :class:`OcaClassIdentification`.
  */
 /**
- * Gets the value of the Lockable property. The return value indicates whether
- * the property was successfully retrieved.
+ * Gets the value of the Lockable property.
  *
  * @method OcaRoot#GetLockable
  * @returns {Promise<boolean>}
@@ -57,45 +58,85 @@ export const OcaRoot = make_control_class(
  */
 /**
  * Locks the object totally, so that it can only be accessed for reading or
- * writing by the lockholder. If the device is read-only locked (by a prior call
- * to LockReadonly()) when Lock() is called by the same lockholder, the lock
- * state is upgraded to total. If the call is from a session other than the
- * lockholder's, the call fails. The return value indicates whether the
- * operation succeeded.
+ * writing by the lockholder.
+ *
+ *  - If the object's **LockState** is **LockNoWrite** by the same lockholder,
+ *    the lock state is upgraded to LockNoReadWrite.
+ *
+ *  - If the call is from a session other than the lockholder's, the call fails.
+ *
+ *
+ *
+ * @method OcaRoot#SetLockNoReadWrite
+ * @returns {Promise<void>}
+ */
+/**
+ * Locks the object totally, so that it can only be accessed for reading or
+ * writing by the lockholder.
+ *
+ *  - If the object's **LockState** is **LockNoWrite** by the same lockholder,
+ *    the lock state is upgraded to LockNoReadWrite.
+ *
+ *  - If the call is from a session other than the lockholder's, the call fails.
+ *
+ *
+ * An alias for SetLockNoReadWrite.
  *
  * @method OcaRoot#LockTotal
  * @returns {Promise<void>}
  */
 /**
  * Unlocks the object so that it can be freely accessed again. This method can
- * only succeed if it is called by the lockholder. The return value indicates
- * whether the operation succeeded.
+ * only succeed if it is called by the lockholder.
  *
  * @method OcaRoot#Unlock
  * @returns {Promise<void>}
  */
 /**
- * Returns value of Role property. The return value indicates whether the
- * operation succeeded.
+ * Returns value of Role property.
  *
  * @method OcaRoot#GetRole
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Locks the object so that its properties may only be modified by the
- * lockholder, but others can still retrieve property values. If the device is
- * already locked (by a prior call to Lock() or LockReadonly()) when
- * LockReadonly() is called by the same lockholder, the lock state is set to
- * read-only. If the call is from a session other than the lockholder's, the
- * call fails. The return value indicates whether the operation succeeded.
- *
- * @method OcaRoot#LockReadonly
+ * Locks the object so that it may only be controlled by the lockholder, but
+ * others can still retrieve property values. If **LockState** is
+ * **LockNoReadWrite** by the same lockholder, the lock state is downgraded to
+ * **LockNoWrite**. If the call is from a session other than the lockholder's,
+ * the call fails.
+ *
+ * @method OcaRoot#SetLockNoWrite
+ * @returns {Promise<void>}
+ */
+/**
+ * Locks the object so that it may only be controlled by the lockholder, but
+ * others can still retrieve property values. If **LockState** is
+ * **LockNoReadWrite** by the same lockholder, the lock state is downgraded to
+ * **LockNoWrite**. If the call is from a session other than the lockholder's,
+ * the call fails.
+ * An alias for SetLockNoWrite.
+ *
+ * @method OcaRoot#LockReadOnly
  * @returns {Promise<void>}
  */
+/**
+ * Returns the current value of the **LockState** property.
+ *
+ * @method OcaRoot#GetLockState
+ * @returns {Promise<OcaLockState>}
+ *   A promise which resolves to a single value of type :class:`OcaLockState`.
+ */
 /**
  * General event that is emitted when a property changes. In each setter method
- * (of derived classes) this event must be raised with the proper derived event
+ * (of derived classes) this event shall be raised with the proper derived event
  * data structure.
  * @member OcaRoot#OnPropertyChanged {Event}
  */
+/**
+ * This event is emitted when the property ``LockState`` changes in the remote object.
+ * The property ``LockState`` is described in the AES70 standard as follows.
+ * Current lock state - none, noWrite, or noReadWrite
+ *
+ * @member {PropertyEvent<OcaLockState>} OcaRoot#OnLockStateChanged
+ */

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

@@ -0,0 +1,22 @@
+import { OcaSamplingRateConverterType } from '../../types/OcaSamplingRateConverterType';
+import { RemoteDevice } from '../remote_device';
+import { OcaActuator } from './OcaActuator';
+
+/**
+ * Sampling rate converter. **ClockMap** property inherited from **OcaWorker**
+ * shall define the input and output clocks to be used for the conversion(s).
+ * @extends OcaActuator
+ * @class OcaSamplingRateConverter
+ */
+export declare class OcaSamplingRateConverter extends OcaActuator {
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Gets type of this sampling rate converter.
+   *
+   * @method OcaSamplingRateConverter#GetType
+   * @returns {Promise<OcaSamplingRateConverterType>}
+   *   A promise which resolves to a single value of type :class:`OcaSamplingRateConverterType`.
+   */
+  GetType(): Promise<OcaSamplingRateConverterType>;
+}

package/src/controller/ControlClasses/OcaSamplingRateConverter.js

@@ -0,0 +1,28 @@
+import { OcaSamplingRateConverterType } from '../../OCP1/OcaSamplingRateConverterType.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
+
+/**
+ * Sampling rate converter. **ClockMap** property inherited from **OcaWorker**
+ * shall define the input and output clocks to be used for the conversion(s).
+ * @extends OcaActuator
+ * @class OcaSamplingRateConverter
+ */
+export const OcaSamplingRateConverter = make_control_class(
+  'OcaSamplingRateConverter',
+  4,
+  '\u0001\u0001\u0001\u0017',
+  1,
+  OcaActuator,
+  [['GetType', 4, 1, [], [OcaSamplingRateConverterType]]],
+  [['Type', [OcaSamplingRateConverterType], 4, 1, true, false, null]],
+  []
+);
+
+/**
+ * Gets type of this sampling rate converter.
+ *
+ * @method OcaSamplingRateConverter#GetType
+ * @returns {Promise<OcaSamplingRateConverterType>}
+ *   A promise which resolves to a single value of type :class:`OcaSamplingRateConverterType`.
+ */

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

@@ -27,9 +27,8 @@ export declare class OcaSecurityManager extends OcaManager {
 
   /**
    * Enables security of control data (OCA messages). After calling this method
-   * all OCA messages are sent and received using a secure connection. The
-   * return value indicates whether the operation succeeded. If the operation
-   * fails security is not enabled.
+   * all OCA messages are sent and received using a secure connection. If the
+   * operation fails, security is not enabled.
    *
    * @method OcaSecurityManager#EnableControlSecurity
    * @returns {Promise<void>}
@@ -39,8 +38,7 @@ export declare class OcaSecurityManager extends OcaManager {
   /**
    * Disables security of control data (OCA messages). After calling this method
    * all OCA messages can be sent and received both on insecure and secure
-   * connections. The return value indicates whether the operation succeeded. If
-   * the operation fails security is not disabled.
+   * connections. If the operation fails, security is not disabled.
    *
    * @method OcaSecurityManager#DisableControlSecurity
    * @returns {Promise<void>}
@@ -51,7 +49,7 @@ export declare class OcaSecurityManager extends OcaManager {
    * Changes the pre-shared key identified by the passed identity. Note that
    * changing a PSK over the network will only work if the controller has a
    * secure connection to the device and control security has been turned on. If
-   * this is not the case the method will return DeviceError.
+   * this is not the case, the method will return DeviceError.
    *
    * @method OcaSecurityManager#ChangePreSharedKey
    * @param {string} identity
@@ -66,7 +64,8 @@ export declare class OcaSecurityManager extends OcaManager {
    * having multiple PSKs the device is able to participate in multiple secure
    * systems. Note that adding a PSK over the network will only work if the
    * controller has a secure connection to the device and control security has
-   * been turned on. If this is not the case the method will return DeviceError.
+   * been turned on. If this is not the case, the method will return
+   * DeviceError.
    *
    * @method OcaSecurityManager#AddPreSharedKey
    * @param {string} identity
@@ -77,12 +76,12 @@ export declare class OcaSecurityManager extends OcaManager {
   AddPreSharedKey(identity: string, key: Uint8Array): Promise<void>;
 
   /**
-   * Deletes a pre-shared key (identified by the passed identity) on the device.
-   * After deleting the pre-shared key the device will no longer be able to
-   * participate in the secure system that uses the PSK. Note that deleting a
-   * PSK over the network will only work if the controller has a secure
-   * connection to the device and control security has been turned on. If this
-   * is not the case the method will return DeviceError.
+   * Deletes the pre-shared key identified by the given identity from the
+   * device. After deleting the pre-shared key, the device will no longer be
+   * able to participate in the secure system that uses the PSK. Note that
+   * deleting a PSK over the network will only work if the controller has a
+   * secure connection to the device and control security has been turned on. If
+   * this is not the case, the method will return DeviceError.
    *
    * @method OcaSecurityManager#DeletePreSharedKey
    * @param {string} identity

package/src/controller/ControlClasses/OcaSecurityManager.js

@@ -23,7 +23,7 @@ export const OcaSecurityManager = make_control_class(
   'OcaSecurityManager',
   3,
   '\u0001\u0003\u0002',
-  2,
+  3,
   OcaManager,
   [
     ['EnableControlSecurity', 3, 1, [], []],
@@ -38,9 +38,8 @@ export const OcaSecurityManager = make_control_class(
 
 /**
  * Enables security of control data (OCA messages). After calling this method
- * all OCA messages are sent and received using a secure connection. The return
- * value indicates whether the operation succeeded. If the operation fails
- * security is not enabled.
+ * all OCA messages are sent and received using a secure connection. If the
+ * operation fails, security is not enabled.
  *
  * @method OcaSecurityManager#EnableControlSecurity
  * @returns {Promise<void>}
@@ -48,8 +47,7 @@ export const OcaSecurityManager = make_control_class(
 /**
  * Disables security of control data (OCA messages). After calling this method
  * all OCA messages can be sent and received both on insecure and secure
- * connections. The return value indicates whether the operation succeeded. If
- * the operation fails security is not disabled.
+ * connections. If the operation fails, security is not disabled.
  *
  * @method OcaSecurityManager#DisableControlSecurity
  * @returns {Promise<void>}
@@ -58,7 +56,7 @@ export const OcaSecurityManager = make_control_class(
  * Changes the pre-shared key identified by the passed identity. Note that
  * changing a PSK over the network will only work if the controller has a secure
  * connection to the device and control security has been turned on. If this is
- * not the case the method will return DeviceError.
+ * not the case, the method will return DeviceError.
  *
  * @method OcaSecurityManager#ChangePreSharedKey
  * @param {string} identity
@@ -71,7 +69,7 @@ export const OcaSecurityManager = make_control_class(
  * having multiple PSKs the device is able to participate in multiple secure
  * systems. Note that adding a PSK over the network will only work if the
  * controller has a secure connection to the device and control security has
- * been turned on. If this is not the case the method will return DeviceError.
+ * been turned on. If this is not the case, the method will return DeviceError.
  *
  * @method OcaSecurityManager#AddPreSharedKey
  * @param {string} identity
@@ -80,11 +78,11 @@ export const OcaSecurityManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Deletes a pre-shared key (identified by the passed identity) on the device.
- * After deleting the pre-shared key the device will no longer be able to
+ * Deletes the pre-shared key identified by the given identity from the device.
+ * After deleting the pre-shared key, the device will no longer be able to
  * participate in the secure system that uses the PSK. Note that deleting a PSK
  * over the network will only work if the controller has a secure connection to
- * the device and control security has been turned on. If this is not the case
+ * the device and control security has been turned on. If this is not the case,
  * the method will return DeviceError.
  *
  * @method OcaSecurityManager#DeletePreSharedKey
@@ -95,7 +93,7 @@ export const OcaSecurityManager = make_control_class(
 /**
  * This event is emitted when the property ``secureControlData`` changes in the remote object.
  * The property ``secureControlData`` is described in the AES70 standard as follows.
- * Indicates whether the OCA control data in the system is secured.
+ * TRUE if and only if the OCA control data in the system is secured.
  *
  * @member {PropertyEvent<boolean>} OcaSecurityManager#OnsecureControlDataChanged
  */

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

@@ -17,8 +17,7 @@ export declare class OcaSensor extends OcaWorker {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the current reading state of the sensor. The return value indicates
-   * whether the state was successfully retrived.
+   * Gets the current reading state of the sensor.
    *
    * @method OcaSensor#GetReadingState
    * @returns {Promise<OcaSensorReadingState>}