aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaDeviceManager.js

@@ -1,5 +1,3 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaManager } from './OcaManager.js';
 import { OcaBlob } from '../../OCP1/OcaBlob.js';
 import { OcaBlobFixedLen } from '../../OCP1/OcaBlobFixedLen.js';
 import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
@@ -11,15 +9,17 @@ import { OcaModelGUID } from '../../OCP1/OcaModelGUID.js';
 import { OcaResetCause } from '../../OCP1/OcaResetCause.js';
 import { OcaString } from '../../OCP1/OcaString.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaManager } from './OcaManager.js';
 
 /**
  * Mandatory manager that contains information relevant to the whole device.
  *
  *  - Must be instantiated once in every device.
  *
- *
  *  - Must have object number 1.
  *
+ *
  * @extends OcaManager
  * @class OcaDeviceManager
  */
@@ -71,35 +71,40 @@ export const OcaDeviceManager = make_control_class(
 );
 
 /**
- * Gets the value of the OcaVersion property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the OcaVersion property. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaDeviceManager#GetOcaVersion
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the model GUID. The return value indicates whether the GUID was successfully retrieved.
+ * Gets the model GUID. The return value indicates whether the GUID was
+ * successfully retrieved.
  *
  * @method OcaDeviceManager#GetModelGUID
  * @returns {Promise<OcaModelGUID>}
  *   A promise which resolves to a single value of type :class:`OcaModelGUID`.
  */
 /**
- * Gets the value of the SerialNumber property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the SerialNumber property. The return value indicates
+ * whether the property was successfully retrieved.
  *
  * @method OcaDeviceManager#GetSerialNumber
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Gets the device name. The return value indicates whether the property was successfully retrieved.
+ * Gets the device name. The return value indicates whether the property was
+ * successfully retrieved.
  *
  * @method OcaDeviceManager#GetDeviceName
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the device name. The return value indicates whether the property was successfully set.
+ * Sets the device name. The return value indicates whether the property was
+ * successfully set.
  *
  * @method OcaDeviceManager#SetDeviceName
  * @param {string} Name
@@ -107,21 +112,24 @@ export const OcaDeviceManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the model description. The return value indicates whether the description was successfully retrieved.
+ * Gets the model description. The return value indicates whether the
+ * description was successfully retrieved.
  *
  * @method OcaDeviceManager#GetModelDescription
  * @returns {Promise<OcaModelDescription>}
  *   A promise which resolves to a single value of type :class:`OcaModelDescription`.
  */
 /**
- * Gets the value of the Role property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Role property. The return value indicates whether the
+ * property was successfully retrieved.
  *
  * @method OcaDeviceManager#GetDeviceRole
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the value of the Role property. The return value indicates whether the property was successfully set.
+ * Sets the value of the Role property. The return value indicates whether the
+ * property was successfully set.
  *
  * @method OcaDeviceManager#SetDeviceRole
  * @param {string} role
@@ -129,14 +137,16 @@ export const OcaDeviceManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the UserInventoryCode property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the UserInventoryCode property. The return value indicates
+ * whether the property was successfully retrieved.
  *
  * @method OcaDeviceManager#GetUserInventoryCode
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the value of the UserInventoryCode property. The return value indicates whether the property was successfully set.
+ * Sets the value of the UserInventoryCode property. The return value indicates
+ * whether the property was successfully set.
  *
  * @method OcaDeviceManager#SetUserInventoryCode
  * @param {string} Code
@@ -144,14 +154,16 @@ export const OcaDeviceManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Enabled property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the Enabled property. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaDeviceManager#GetEnabled
  * @returns {Promise<boolean>}
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Sets the value of the Enabled property. The return value indicates whether the property was successfully set.
+ * Sets the value of the Enabled property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaDeviceManager#SetEnabled
  * @param {boolean} enabled
@@ -159,44 +171,56 @@ export const OcaDeviceManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the State property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the State property. The return value indicates whether the
+ * property was successfully retrieved.
  *
  * @method OcaDeviceManager#GetState
- * @returns {Promise<number>}
- *   A promise which resolves to a single value of type :class:`number`.
+ * @returns {Promise<OcaDeviceState>}
+ *   A promise which resolves to a single value of type :class:`OcaDeviceState`.
  */
 /**
- * Sets the value of the reset key of the device. The return value indicates whether the property was successfully set. Note that the device manager must inform the CAP gateway of this key (via the host interface), since the CAP gateway will check for and handle the special reset message.
+ * Sets the value of the reset key of the device. The return value indicates
+ * whether the property was successfully set. Note that the device manager must
+ * inform the CAP gateway of this key (via the host interface), since the CAP
+ * gateway will check for and handle the special reset message.
  *
  * @method OcaDeviceManager#SetResetKey
  * @param {Uint8Array} Key
- *
  * @param {Uint8Array} Address
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the ResetCause property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the ResetCause property. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaDeviceManager#GetResetCause
  * @returns {Promise<OcaResetCause>}
  *   A promise which resolves to a single value of type :class:`OcaResetCause`.
  */
 /**
- * Clears the ResetCause property, i.e. resets it to the default value 'PowerOn'. Must be used after the reset cause has been read out to ensure differentation between reconnects due to network loss and reconnects due to external or internal reset. Offered as a separate method (instead of implicitly clearing the cause after it has been read out) to accomodate systems that have multiple controllers. The return value indicates whether the property was successfully retrieved.
+ * Clears the ResetCause property, i.e. resets it to the default value
+ * 'PowerOn'. Must be used after the reset cause has been read out to ensure
+ * differentation between reconnects due to network loss and reconnects due to
+ * external or internal reset. Offered as a separate method (instead of
+ * implicitly clearing the cause after it has been read out) to accomodate
+ * systems that have multiple controllers. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaDeviceManager#ClearResetCause
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of property  **Message** . Return value indicates whether value was successfully retrieved.
+ * Gets the value of property **Message**. Return value indicates whether value
+ * was successfully retrieved.
  *
  * @method OcaDeviceManager#GetMessage
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Set arbitrary text message into  **Message** property. The return value indicates whether the value was successfully set.
+ * Set arbitrary text message into **Message** property. The return value
+ * indicates whether the value was successfully set.
  *
  * @method OcaDeviceManager#SetMessage
  * @param {string} Text
@@ -204,21 +228,23 @@ export const OcaDeviceManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Retrive the list of descriptors of managers instantiated in this device. The return value indicates whether the retrieval was successful.
+ * Retrive the list of descriptors of managers instantiated in this device. The
+ * return value indicates whether the retrieval was successful.
  *
  * @method OcaDeviceManager#GetManagers
  * @returns {Promise<OcaManagerDescriptor[]>}
- *   A promise which resolves to a single value of type ``OcaManagerDescriptor[]``.
+ *   A promise which resolves to a single value of type :class:`OcaManagerDescriptor[]`.
  */
 /**
- * Gets the value of property  **DeviceRevisionID** . Return value indicates whether value was successfully retrieved.
+ * Gets the value of property **DeviceRevisionID**. Return value indicates
+ * whether value was successfully retrieved.
  *
  * @method OcaDeviceManager#GetDeviceRevisionID
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * This event is emitted when the property ModelGUID changes in the remote object.
+ * This event is emitted when the property ``ModelGUID`` changes in the remote object.
  * The property ``ModelGUID`` is described in the AES70 standard as follows.
  * Read-only property that identifies the model of the device. Note this
  * property is not equivalent to a MAC address, because (a) MAC addresses
@@ -228,31 +254,29 @@ export const OcaDeviceManager = make_control_class(
  * @member {PropertyEvent<OcaModelGUID>} OcaDeviceManager#OnModelGUIDChanged
  */
 /**
- * This event is emitted when the property SerialNumber changes in the remote object.
+ * This event is emitted when the property ``SerialNumber`` changes in the remote object.
  * The property ``SerialNumber`` is described in the AES70 standard as follows.
- * Read-only property that identifies the serial number of the CAP
- * device.
+ * Read-only property that identifies the serial number of the CAP device.
  *
  * @member {PropertyEvent<string>} OcaDeviceManager#OnSerialNumberChanged
  */
 /**
- * This event is emitted when the property ModelDescription changes in the remote object.
+ * This event is emitted when the property ``ModelDescription`` changes in the remote object.
  * The property ``ModelDescription`` is described in the AES70 standard as follows.
- * Read-only property that contains text names for this model, its
- * manufacturer, and its version.
+ * Read-only property that contains text names for this model, its manufacturer,
+ * and its version.
  *
  * @member {PropertyEvent<OcaModelDescription>} OcaDeviceManager#OnModelDescriptionChanged
  */
 /**
- * This event is emitted when the property DeviceName changes in the remote object.
+ * This event is emitted when the property ``DeviceName`` changes in the remote object.
  * The property ``DeviceName`` is described in the AES70 standard as follows.
- * Name of the device. Should be unique manufacturer-qualified
- * identifier.
+ * Name of the device. Should be unique manufacturer-qualified identifier.
  *
  * @member {PropertyEvent<string>} OcaDeviceManager#OnDeviceNameChanged
  */
 /**
- * This event is emitted when the property OcaVersion changes in the remote object.
+ * This event is emitted when the property ``OcaVersion`` changes in the remote object.
  * The property ``OcaVersion`` is described in the AES70 standard as follows.
  * Read-only property that indicates the AES70 version number used by the
  * device.
@@ -260,58 +284,58 @@ export const OcaDeviceManager = make_control_class(
  * @member {PropertyEvent<number>} OcaDeviceManager#OnOcaVersionChanged
  */
 /**
- * This event is emitted when the property DeviceRole changes in the remote object.
+ * This event is emitted when the property ``DeviceRole`` changes in the remote object.
  * The property ``DeviceRole`` is described in the AES70 standard as follows.
  * Role of device in application (arbitrary).
  *
  * @member {PropertyEvent<string>} OcaDeviceManager#OnDeviceRoleChanged
  */
 /**
- * This event is emitted when the property UserInventoryCode changes in the remote object.
+ * This event is emitted when the property ``UserInventoryCode`` changes in the remote object.
  * The property ``UserInventoryCode`` is described in the AES70 standard as follows.
  * Code used for equipment tracking.
  *
  * @member {PropertyEvent<string>} OcaDeviceManager#OnUserInventoryCodeChanged
  */
 /**
- * This event is emitted when the property Enabled changes in the remote object.
+ * This event is emitted when the property ``Enabled`` changes in the remote object.
  * The property ``Enabled`` is described in the AES70 standard as follows.
  * Indicates whether the device is enabled (and therefore operational).
  *
  * @member {PropertyEvent<boolean>} OcaDeviceManager#OnEnabledChanged
  */
 /**
- * This event is emitted when the property State changes in the remote object.
+ * This event is emitted when the property ``State`` changes in the remote object.
  * The property ``State`` is described in the AES70 standard as follows.
  * Read-only property that indicates the current state of the device.
  *
- * @member {PropertyEvent<number>} OcaDeviceManager#OnStateChanged
+ * @member {PropertyEvent<OcaDeviceState>} OcaDeviceManager#OnStateChanged
  */
 /**
- * This event is emitted when the property Busy changes in the remote object.
+ * This event is emitted when the property ``Busy`` changes in the remote object.
  * The property ``Busy`` is described in the AES70 standard as follows.
- * True iff device is working on something and is not available for OCA
- * command activity. Readonly.
+ * True iff device is working on something and is not available for OCA command
+ * activity. Readonly.
  *
  * @member {PropertyEvent<boolean>} OcaDeviceManager#OnBusyChanged
  */
 /**
- * This event is emitted when the property ResetCause changes in the remote object.
+ * This event is emitted when the property ``ResetCause`` changes in the remote object.
  * The property ``ResetCause`` is described in the AES70 standard as follows.
  * Read-only attribute that indicates the reset cause of the last reset.
  *
  * @member {PropertyEvent<OcaResetCause>} OcaDeviceManager#OnResetCauseChanged
  */
 /**
- * This event is emitted when the property Message changes in the remote object.
+ * This event is emitted when the property ``Message`` changes in the remote object.
  * The property ``Message`` is described in the AES70 standard as follows.
- * Arbitrary text message provided by controller. Display and handling of
- * the text is device-dependent and not defined by OCA.
+ * Arbitrary text message provided by controller. Display and handling of the
+ * text is device-dependent and not defined by OCA.
  *
  * @member {PropertyEvent<string>} OcaDeviceManager#OnMessageChanged
  */
 /**
- * This event is emitted when the property Managers changes in the remote object.
+ * This event is emitted when the property ``Managers`` changes in the remote object.
  * The property ``Managers`` is described in the AES70 standard as follows.
  * List of all manager objects instantiated in this device.
  *

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

@@ -1,18 +1,25 @@
+import { IOcaTimePTP, OcaTimePTP } from '../../types/OcaTimePTP';
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaManager } from './OcaManager';
 
-import { PropertyEvent } from '../property_event';
-import { IOcaTimePTP } from '../../types/OcaTimePTP';
-import { OcaTimePTP } from '../../types/OcaTimePTP';
-
 /**
- * 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  **OcaTimeSource** or a subclass of it.
+ * 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
+ *    **OcaTimeSource** or a subclass of it.
  *
  *  - If instantiated, object number must be 10.
- *   Note: The clock value is accessible via Get and Set methods, but has not been defined as a public property because its value is volatile and should not cause property-change events. The current value of the  **OcaTimeSource** object designated by the  **CurrentDeviceTimeSource** property of this Manager is known as the  **Device Time** . The property  **TimeSources** was added in version 2 of this class.
+ *
+ *
+ * Note: The clock value is accessible via Get and Set methods, but has not been
+ * defined as a public property because its value is volatile and should not
+ * cause property-change events. The current value of the **OcaTimeSource**
+ * object designated by the **CurrentDeviceTimeSource** property of this Manager
+ * is known as the **Device Time**. The property **TimeSources** was added in
+ * version 2 of this class.
  * @extends OcaManager
  * @class OcaDeviceTimeManager
  */
@@ -30,7 +37,9 @@ export declare class OcaDeviceTimeManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * 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. Return value
+   * indicates whether value was successfully retrieved. This method is optional
+   * and deprecated.
    *
    * @method OcaDeviceTimeManager#GetDeviceTimeNTP
    * @returns {Promise<number|BigInt>}
@@ -39,7 +48,9 @@ export declare class OcaDeviceTimeManager extends OcaManager {
   GetDeviceTimeNTP(): Promise<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. 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.
    *
    * @method OcaDeviceTimeManager#SetDeviceTimeNTP
    * @param {number|BigInt} DeviceTime
@@ -49,7 +60,8 @@ export declare class OcaDeviceTimeManager extends OcaManager {
   SetDeviceTimeNTP(DeviceTime: number | BigInt): Promise<void>;
 
   /**
-   * Returns list of object numbers of OcaTimeSource instances in this device. Return value indicates whether list was successfully retrieved.
+   * Returns list of object numbers of OcaTimeSource instances in this device.
+   * Return value indicates whether list was successfully retrieved.
    *
    * @method OcaDeviceTimeManager#GetTimeSources
    * @returns {Promise<number[]>}
@@ -58,7 +70,8 @@ export declare class OcaDeviceTimeManager extends OcaManager {
   GetTimeSources(): Promise<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. Return value
+   * indicates whether value was successfully retrieved.
    *
    * @method OcaDeviceTimeManager#GetCurrentDeviceTimeSource
    * @returns {Promise<number>}
@@ -67,7 +80,8 @@ export declare class OcaDeviceTimeManager extends OcaManager {
   GetCurrentDeviceTimeSource(): Promise<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. Return value
+   * indicates whether value was successfully retrieved.
    *
    * @method OcaDeviceTimeManager#SetCurrentDeviceTimeSource
    * @param {number} TimeSourceONo
@@ -77,7 +91,8 @@ export declare class OcaDeviceTimeManager extends OcaManager {
   SetCurrentDeviceTimeSource(TimeSourceONo: number): 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 in PTP format. Return value
+   * indicates whether value was successfully retrieved.
    *
    * @method OcaDeviceTimeManager#GetDeviceTimePTP
    * @returns {Promise<OcaTimePTP>}
@@ -86,10 +101,12 @@ export declare class OcaDeviceTimeManager extends OcaManager {
   GetDeviceTimePTP(): Promise<OcaTimePTP>;
 
   /**
-   * 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 in PTP format. Return value indicates whether
+   * value was successfully set. Not available if a time source is identified in
+   * property CurrentDeviceTimeSource.
    *
    * @method OcaDeviceTimeManager#SetDeviceTimePTP
-   * @param {OcaTimePTP} DeviceTime
+   * @param {IOcaTimePTP} DeviceTime
    *
    * @returns {Promise<void>}
    */

package/src/controller/ControlClasses/OcaDeviceTimeManager.js

@@ -1,18 +1,27 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaManager } from './OcaManager.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaTimePTP } from '../../OCP1/OcaTimePTP.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
 import { OcaUint64 } from '../../OCP1/OcaUint64.js';
+import { make_control_class } from '../make_control_class.js';
+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  **OcaTimeSource** or a subclass of it.
+ * 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
+ *    **OcaTimeSource** or a subclass of it.
  *
  *  - If instantiated, object number must be 10.
- *   Note: The clock value is accessible via Get and Set methods, but has not been defined as a public property because its value is volatile and should not cause property-change events. The current value of the  **OcaTimeSource** object designated by the  **CurrentDeviceTimeSource** property of this Manager is known as the  **Device Time** . The property  **TimeSources** was added in version 2 of this class.
+ *
+ *
+ * Note: The clock value is accessible via Get and Set methods, but has not been
+ * defined as a public property because its value is volatile and should not
+ * cause property-change events. The current value of the **OcaTimeSource**
+ * object designated by the **CurrentDeviceTimeSource** property of this Manager
+ * is known as the **Device Time**. The property **TimeSources** was added in
+ * version 2 of this class.
  * @extends OcaManager
  * @class OcaDeviceTimeManager
  */
@@ -39,14 +48,18 @@ 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. Return value
+ * indicates whether value was successfully retrieved. This method is optional
+ * and deprecated.
  *
  * @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. 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.
  *
  * @method OcaDeviceTimeManager#SetDeviceTimeNTP
  * @param {number|BigInt} DeviceTime
@@ -54,21 +67,24 @@ 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.
+ * Returns list of object numbers of OcaTimeSource instances in this device.
+ * Return value indicates whether list was successfully retrieved.
  *
  * @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. Return value
+ * indicates whether value was successfully retrieved.
  *
  * @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. Return value
+ * indicates whether value was successfully retrieved.
  *
  * @method OcaDeviceTimeManager#SetCurrentDeviceTimeSource
  * @param {number} TimeSourceONo
@@ -76,32 +92,34 @@ 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 in PTP format. Return value
+ * indicates whether value was successfully retrieved.
  *
  * @method OcaDeviceTimeManager#GetDeviceTimePTP
  * @returns {Promise<OcaTimePTP>}
  *   A promise which resolves to a single value of type :class:`OcaTimePTP`.
  */
 /**
- * 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 in PTP format. Return value indicates whether
+ * value was successfully set. Not available if a time source is identified in
+ * property CurrentDeviceTimeSource.
  *
  * @method OcaDeviceTimeManager#SetDeviceTimePTP
- * @param {OcaTimePTP} DeviceTime
+ * @param {IOcaTimePTP} DeviceTime
  *
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property TimeSources changes in the remote object.
+ * 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
  *
  * @member {PropertyEvent<number[]>} OcaDeviceTimeManager#OnTimeSourcesChanged
  */
 /**
- * This event is emitted when the property CurrentDeviceTimeSource changes in the remote object.
+ * 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.
+ * The 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

@@ -2,13 +2,15 @@ import { RemoteDevice } from '../remote_device';
 import { OcaManager } from './OcaManager';
 
 /**
- * Optional manager that provides application diagnostic aids. Unlike other manager classes, OcaDiagnosticManager may be subclassed to provide proprietary application diagnostic enhancements.
+ * Optional manager that provides application diagnostic aids. Unlike other
+ * manager classes, OcaDiagnosticManager may be subclassed to provide
+ * proprietary application diagnostic enhancements.
  *
  *  - May be instantiated once in any device.
  *
- *
  *  - If instantiated, object number must be 13.
  *
+ *
  * @extends OcaManager
  * @class OcaDiagnosticManager
  */
@@ -16,7 +18,8 @@ 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.
+   * Retrieves a text description of the given object's lock status. Return
+   * value indicates success of the retrieval.
    *
    * @method OcaDiagnosticManager#GetLockStatus
    * @param {number} ONo

package/src/controller/ControlClasses/OcaDiagnosticManager.js

@@ -1,16 +1,18 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaManager } from './OcaManager.js';
 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';
 
 /**
- * Optional manager that provides application diagnostic aids. Unlike other manager classes, OcaDiagnosticManager may be subclassed to provide proprietary application diagnostic enhancements.
+ * Optional manager that provides application diagnostic aids. Unlike other
+ * manager classes, OcaDiagnosticManager may be subclassed to provide
+ * proprietary application diagnostic enhancements.
  *
  *  - May be instantiated once in any device.
  *
- *
  *  - If instantiated, object number must be 13.
  *
+ *
  * @extends OcaManager
  * @class OcaDiagnosticManager
  */
@@ -26,7 +28,8 @@ export const OcaDiagnosticManager = make_control_class(
 );
 
 /**
- * Retrieves a text description of the given object's lock status. Return value indicates success of the retrieval.
+ * Retrieves a text description of the given object's lock status. Return value
+ * indicates success of the retrieval.
  *
  * @method OcaDiagnosticManager#GetLockStatus
  * @param {number} ONo