aes70 1.3.8 → 1.4.0

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

@@ -1,14 +1,14 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaDelay } from './OcaDelay';
+import { IOcaDelayUnit } from '../../types/OcaDelayUnit';
+import { IOcaDelayValue, OcaDelayValue } from '../../types/OcaDelayValue';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
-import { IOcaDelayUnit } from '../../types/OcaDelayUnit';
-import { IOcaDelayValue } from '../../types/OcaDelayValue';
-import { OcaDelayValue } from '../../types/OcaDelayValue';
+import { RemoteDevice } from '../remote_device';
+import { OcaDelay } from './OcaDelay';
 
 /**
- * Signal delay - extended version. Allows setting delay value in various units. Note that the inherited property 04p01 DelayTime is also supported by this class and reflects actual achieved delay in seconds.
+ * Signal delay - extended version. Allows setting delay value in various units.
+ * Note that the inherited property 04p01 DelayTime is also supported by this
+ * class and reflects actual achieved delay in seconds.
  * @extends OcaDelay
  * @class OcaDelayExtended
  */
@@ -21,12 +21,13 @@ export declare class OcaDelayExtended extends OcaDelay {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the DelayValue property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the DelayValue property. The return value indicates
+   * whether the property was successfully retrieved.
    * The return values of this method are
    *
-   * - Value of type :class:`OcaDelayValue`
-   * - minValue of type :class:`OcaDelayValue`
-   * - maxValue of type :class:`OcaDelayValue`
+   * - Value of type ``IOcaDelayValue``
+   * - minValue of type ``IOcaDelayValue``
+   * - maxValue of type ``IOcaDelayValue``
    *
    * @method OcaDelayExtended#GetDelayValue
    * @returns {Promise<Arguments<OcaDelayValue,OcaDelayValue,OcaDelayValue>>}
@@ -36,20 +37,22 @@ export declare class OcaDelayExtended extends OcaDelay {
   >;
 
   /**
-   * Sets the value of the DelayValue property. The return value indicates whether the property was successfully set.
+   * Sets the value of the DelayValue property. The return value indicates
+   * whether the property was successfully set.
    *
    * @method OcaDelayExtended#SetDelayValue
-   * @param {OcaDelayValue} Value
+   * @param {IOcaDelayValue} Value
    *
    * @returns {Promise<void>}
    */
   SetDelayValue(Value: IOcaDelayValue): Promise<void>;
 
   /**
-   * Return current delay setting, converted to given units. The return value indicates whether the method has succeeded.
+   * Return current delay setting, converted to given units. The return value
+   * indicates whether the method has succeeded.
    *
    * @method OcaDelayExtended#GetDelayValueConverted
-   * @param {OcaDelayUnit} UoM
+   * @param {IOcaDelayUnit} UoM
    *
    * @returns {Promise<OcaDelayValue>}
    *   A promise which resolves to a single value of type :class:`OcaDelayValue`.

package/src/controller/ControlClasses/OcaDelayExtended.js

@@ -1,10 +1,12 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaDelay } from './OcaDelay.js';
 import { OcaDelayUnit } from '../../OCP1/OcaDelayUnit.js';
 import { OcaDelayValue } from '../../OCP1/OcaDelayValue.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaDelay } from './OcaDelay.js';
 
 /**
- * Signal delay - extended version. Allows setting delay value in various units. Note that the inherited property 04p01 DelayTime is also supported by this class and reflects actual achieved delay in seconds.
+ * Signal delay - extended version. Allows setting delay value in various units.
+ * Note that the inherited property 04p01 DelayTime is also supported by this
+ * class and reflects actual achieved delay in seconds.
  * @extends OcaDelay
  * @class OcaDelayExtended
  */
@@ -24,35 +26,38 @@ export const OcaDelayExtended = make_control_class(
 );
 
 /**
- * Gets the value of the DelayValue property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the DelayValue property. The return value indicates whether
+ * the property was successfully retrieved.
  * The return values of this method are
  *
- * - Value of type :class:`OcaDelayValue`
- * - minValue of type :class:`OcaDelayValue`
- * - maxValue of type :class:`OcaDelayValue`
+ * - Value of type ``IOcaDelayValue``
+ * - minValue of type ``IOcaDelayValue``
+ * - maxValue of type ``IOcaDelayValue``
  *
  * @method OcaDelayExtended#GetDelayValue
  * @returns {Promise<Arguments<OcaDelayValue,OcaDelayValue,OcaDelayValue>>}
  */
 /**
- * Sets the value of the DelayValue property. The return value indicates whether the property was successfully set.
+ * Sets the value of the DelayValue property. The return value indicates whether
+ * the property was successfully set.
  *
  * @method OcaDelayExtended#SetDelayValue
- * @param {OcaDelayValue} Value
+ * @param {IOcaDelayValue} Value
  *
  * @returns {Promise<void>}
  */
 /**
- * Return current delay setting, converted to given units. The return value indicates whether the method has succeeded.
+ * Return current delay setting, converted to given units. The return value
+ * indicates whether the method has succeeded.
  *
  * @method OcaDelayExtended#GetDelayValueConverted
- * @param {OcaDelayUnit} UoM
+ * @param {IOcaDelayUnit} UoM
  *
  * @returns {Promise<OcaDelayValue>}
  *   A promise which resolves to a single value of type :class:`OcaDelayValue`.
  */
 /**
- * This event is emitted when the property DelayValue changes in the remote object.
+ * This event is emitted when the property ``DelayValue`` changes in the remote object.
  * The property ``DelayValue`` is described in the AES70 standard as follows.
  * Delay value.
  *

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

@@ -1,21 +1,20 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaManager } from './OcaManager';
-
-import { PropertyEvent } from '../property_event';
 import { OcaDeviceState } from '../../types/OcaDeviceState';
 import { OcaManagerDescriptor } from '../../types/OcaManagerDescriptor';
 import { OcaModelDescription } from '../../types/OcaModelDescription';
 import { OcaModelGUID } from '../../types/OcaModelGUID';
 import { OcaResetCause } from '../../types/OcaResetCause';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaManager } from './OcaManager';
 
 /**
  * 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
  */
@@ -63,7 +62,7 @@ export declare class OcaDeviceManager extends OcaManager {
   /**
    * This event is emitted whenever State changes.
    */
-  OnStateChanged: PropertyEvent<number>;
+  OnStateChanged: PropertyEvent<OcaDeviceState>;
 
   /**
    * This event is emitted whenever Busy changes.
@@ -88,7 +87,8 @@ export declare class OcaDeviceManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * 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>}
@@ -97,7 +97,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetOcaVersion(): Promise<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>}
@@ -106,7 +107,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetModelGUID(): Promise<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>}
@@ -115,7 +117,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetSerialNumber(): Promise<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>}
@@ -124,7 +127,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetDeviceName(): Promise<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
@@ -134,7 +138,8 @@ export declare class OcaDeviceManager extends OcaManager {
   SetDeviceName(Name: string): 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>}
@@ -143,7 +148,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetModelDescription(): Promise<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>}
@@ -152,7 +158,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetDeviceRole(): Promise<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
@@ -162,7 +169,8 @@ export declare class OcaDeviceManager extends OcaManager {
   SetDeviceRole(role: string): 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>}
@@ -171,7 +179,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetUserInventoryCode(): Promise<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
@@ -181,7 +190,8 @@ export declare class OcaDeviceManager extends OcaManager {
   SetUserInventoryCode(Code: string): 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>}
@@ -190,7 +200,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetEnabled(): Promise<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
@@ -200,20 +211,23 @@ export declare class OcaDeviceManager extends OcaManager {
   SetEnabled(enabled: boolean): 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`.
    */
-  GetState(): Promise<number>;
+  GetState(): Promise<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>}
@@ -221,7 +235,8 @@ export declare class OcaDeviceManager extends OcaManager {
   SetResetKey(Key: Uint8Array, Address: Uint8Array): 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>}
@@ -230,7 +245,13 @@ export declare class OcaDeviceManager extends OcaManager {
   GetResetCause(): Promise<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>}
@@ -238,7 +259,8 @@ export declare class OcaDeviceManager extends OcaManager {
   ClearResetCause(): 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>}
@@ -247,7 +269,8 @@ export declare class OcaDeviceManager extends OcaManager {
   GetMessage(): Promise<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
@@ -257,16 +280,18 @@ export declare class OcaDeviceManager extends OcaManager {
   SetMessage(Text: string): 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[]`.
    */
   GetManagers(): Promise<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>}