aes70 1.3.8 → 1.4.0

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

@@ -1,19 +1,19 @@
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaManager } from './OcaManager';
 
-import { PropertyEvent } from '../property_event';
-
 /**
- * Manager that collects and controls security settings (including security keys).
- *
- *  - Must be instantiated in every device that supports secure control and monitoring; otherwise, is optional.
+ * Manager that collects and controls security settings (including security
+ * keys).
  *
+ *  - Must be instantiated in every device that supports secure control and
+ *    monitoring; otherwise, is optional.
  *
  *  - May be instantiated at most once in any device.
  *
- *
  *  - If instantiated, object number must be 2.
  *
+ *
  * @extends OcaManager
  * @class OcaSecurityManager
  */
@@ -26,11 +26,14 @@ export declare class OcaSecurityManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Adds a pre-shared key (identified by the passed identity) to the device. By 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.
+   * Adds a pre-shared key (identified by the passed identity) to the device. By
+   * 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.
    *
    * @method OcaSecurityManager#AddPreSharedKey
    * @param {string} identity
-   *
    * @param {Uint8Array} key
    *
    * @returns {Promise<void>}
@@ -38,11 +41,13 @@ export declare class OcaSecurityManager extends OcaManager {
   AddPreSharedKey(identity: string, key: Uint8Array): Promise<void>;
 
   /**
-   * 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.
+   * 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.
    *
    * @method OcaSecurityManager#ChangePreSharedKey
    * @param {string} identity
-   *
    * @param {Uint8Array} newKey
    *
    * @returns {Promise<void>}
@@ -50,7 +55,12 @@ export declare class OcaSecurityManager extends OcaManager {
   ChangePreSharedKey(identity: string, newKey: 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 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.
    *
    * @method OcaSecurityManager#DeletePreSharedKey
    * @param {string} identity
@@ -60,7 +70,10 @@ export declare class OcaSecurityManager extends OcaManager {
   DeletePreSharedKey(identity: string): Promise<void>;
 
   /**
-   * 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.
+   * 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.
    *
    * @method OcaSecurityManager#DisableControlSecurity
    * @returns {Promise<void>}
@@ -68,7 +81,10 @@ export declare class OcaSecurityManager extends OcaManager {
   DisableControlSecurity(): Promise<void>;
 
   /**
-   * 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.
+   * 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.
    *
    * @method OcaSecurityManager#EnableControlSecurity
    * @returns {Promise<void>}

package/src/controller/ControlClasses/OcaSecurityManager.js

@@ -1,20 +1,21 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaManager } from './OcaManager.js';
 import { OcaBlob } from '../../OCP1/OcaBlob.js';
 import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
 import { OcaString } from '../../OCP1/OcaString.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaManager } from './OcaManager.js';
 
 /**
- * Manager that collects and controls security settings (including security keys).
- *
- *  - Must be instantiated in every device that supports secure control and monitoring; otherwise, is optional.
+ * Manager that collects and controls security settings (including security
+ * keys).
  *
+ *  - Must be instantiated in every device that supports secure control and
+ *    monitoring; otherwise, is optional.
  *
  *  - May be instantiated at most once in any device.
  *
- *
  *  - If instantiated, object number must be 2.
  *
+ *
  * @extends OcaManager
  * @class OcaSecurityManager
  */
@@ -36,27 +37,37 @@ export const OcaSecurityManager = make_control_class(
 );
 
 /**
- * Adds a pre-shared key (identified by the passed identity) to the device. By 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.
+ * Adds a pre-shared key (identified by the passed identity) to the device. By
+ * 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.
  *
  * @method OcaSecurityManager#AddPreSharedKey
  * @param {string} identity
- *
  * @param {Uint8Array} key
  *
  * @returns {Promise<void>}
  */
 /**
- * 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.
+ * 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.
  *
  * @method OcaSecurityManager#ChangePreSharedKey
  * @param {string} identity
- *
  * @param {Uint8Array} newKey
  *
  * @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 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 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.
  *
  * @method OcaSecurityManager#DeletePreSharedKey
  * @param {string} identity
@@ -64,19 +75,25 @@ export const OcaSecurityManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * 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.
+ * 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.
  *
  * @method OcaSecurityManager#DisableControlSecurity
  * @returns {Promise<void>}
  */
 /**
- * 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.
+ * 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.
  *
  * @method OcaSecurityManager#EnableControlSecurity
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property secureControlData changes in the remote object.
+ * 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.
  *

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

@@ -1,9 +1,8 @@
+import { OcaSensorReadingState } from '../../types/OcaSensorReadingState';
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaWorker } from './OcaWorker';
 
-import { PropertyEvent } from '../property_event';
-import { OcaSensorReadingState } from '../../types/OcaSensorReadingState';
-
 /**
  * Abstract base class for all sensor classes.
  * @extends OcaWorker
@@ -18,7 +17,8 @@ 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. The return value indicates
+   * whether the state was successfully retrived.
    *
    * @method OcaSensor#GetReadingState
    * @returns {Promise<OcaSensorReadingState>}

package/src/controller/ControlClasses/OcaSensor.js

@@ -1,6 +1,6 @@
+import { OcaSensorReadingState } from '../../OCP1/OcaSensorReadingState.js';
 import { make_control_class } from '../make_control_class.js';
 import { OcaWorker } from './OcaWorker.js';
-import { OcaSensorReadingState } from '../../OCP1/OcaSensorReadingState.js';
 
 /**
  * Abstract base class for all sensor classes.
@@ -19,17 +19,18 @@ export const OcaSensor = make_control_class(
 );
 
 /**
- * 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. The return value indicates
+ * whether the state was successfully retrived.
  *
  * @method OcaSensor#GetReadingState
  * @returns {Promise<OcaSensorReadingState>}
  *   A promise which resolves to a single value of type :class:`OcaSensorReadingState`.
  */
 /**
- * This event is emitted when the property ReadingState changes in the remote object.
+ * This event is emitted when the property ``ReadingState`` changes in the remote object.
  * The property ``ReadingState`` is described in the AES70 standard as follows.
- * Enum that describes whether current reading value is valid and if not,
- * why not. Readonly.
+ * Enum that describes whether current reading value is valid and if not, why
+ * not. Readonly.
  *
  * @member {PropertyEvent<OcaSensorReadingState>} OcaSensor#OnReadingStateChanged
  */

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

@@ -1,12 +1,10 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaActuator } from './OcaActuator';
+import { IOcaParameterMask } from '../../types/OcaParameterMask';
+import { IOcaSweepType, OcaSweepType } from '../../types/OcaSweepType';
+import { IOcaWaveformType, OcaWaveformType } from '../../types/OcaWaveformType';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
-import { IOcaSweepType } from '../../types/OcaSweepType';
-import { IOcaWaveformType } from '../../types/OcaWaveformType';
-import { OcaSweepType } from '../../types/OcaSweepType';
-import { OcaWaveformType } from '../../types/OcaWaveformType';
+import { RemoteDevice } from '../remote_device';
+import { OcaActuator } from './OcaActuator';
 
 /**
  * Multiwaveform signal generator with optional sweep capability.
@@ -57,7 +55,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the Frequency1 property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the Frequency1 property. The return value indicates
+   * whether the property was successfully retrieved.
    * The return values of this method are
    *
    * - frequency of type ``number``
@@ -70,7 +69,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetFrequency1(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the Frequency1 property. The return value indicates whether the property was successfully set.
+   * Sets the value of the Frequency1 property. The return value indicates
+   * whether the property was successfully set.
    *
    * @method OcaSignalGenerator#SetFrequency1
    * @param {number} frequency
@@ -80,7 +80,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   SetFrequency1(frequency: number): Promise<void>;
 
   /**
-   * Gets the value of the Frequency2 property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the Frequency2 property. The return value indicates
+   * whether the property was successfully retrieved.
    * The return values of this method are
    *
    * - frequency of type ``number``
@@ -93,7 +94,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetFrequency2(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the Frequency2 property. The return value indicates whether the property was successfully set.
+   * Sets the value of the Frequency2 property. The return value indicates
+   * whether the property was successfully set.
    *
    * @method OcaSignalGenerator#SetFrequency2
    * @param {number} frequency
@@ -103,7 +105,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   SetFrequency2(frequency: number): Promise<void>;
 
   /**
-   * Gets the value of the Level property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the Level property. The return value indicates whether
+   * the property was successfully retrieved.
    * The return values of this method are
    *
    * - Level of type ``number``
@@ -116,7 +119,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetLevel(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the Level property. The return value indicates whether the property was successfully set.
+   * Sets the value of the Level property. The return value indicates whether
+   * the property was successfully set.
    *
    * @method OcaSignalGenerator#SetLevel
    * @param {number} Level
@@ -126,7 +130,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   SetLevel(Level: number): Promise<void>;
 
   /**
-   * Gets the value of the Waveform property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the Waveform property. The return value indicates whether
+   * the property was successfully retrieved.
    *
    * @method OcaSignalGenerator#GetWaveform
    * @returns {Promise<OcaWaveformType>}
@@ -135,17 +140,19 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetWaveform(): Promise<OcaWaveformType>;
 
   /**
-   * Sets the value of the Waveform property. The return value indicates whether the property was successfully set.
+   * Sets the value of the Waveform property. The return value indicates whether
+   * the property was successfully set.
    *
    * @method OcaSignalGenerator#SetWaveform
-   * @param {OcaWaveformType} waveform
+   * @param {IOcaWaveformType} waveform
    *
    * @returns {Promise<void>}
    */
   SetWaveform(waveform: IOcaWaveformType): Promise<void>;
 
   /**
-   * Gets the value of the SweepType property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the SweepType property. The return value indicates
+   * whether the property was successfully retrieved.
    *
    * @method OcaSignalGenerator#GetSweepType
    * @returns {Promise<OcaSweepType>}
@@ -154,17 +161,19 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetSweepType(): Promise<OcaSweepType>;
 
   /**
-   * Sets the value of the SweepType property. The return value indicates whether the property was successfully set.
+   * Sets the value of the SweepType property. The return value indicates
+   * whether the property was successfully set.
    *
    * @method OcaSignalGenerator#SetSweepType
-   * @param {OcaSweepType} sweepType
+   * @param {IOcaSweepType} sweepType
    *
    * @returns {Promise<void>}
    */
   SetSweepType(sweepType: IOcaSweepType): Promise<void>;
 
   /**
-   * Gets the value of the SweepTime property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the SweepTime property. The return value indicates
+   * whether the property was successfully retrieved.
    * The return values of this method are
    *
    * - sweepTime of type ``number``
@@ -177,7 +186,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetSweepTime(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the SweepTime property. The return value indicates whether the property was successfully set.
+   * Sets the value of the SweepTime property. The return value indicates
+   * whether the property was successfully set.
    *
    * @method OcaSignalGenerator#SetSweepTime
    * @param {number} sweepTime
@@ -187,7 +197,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   SetSweepTime(sweepTime: number): Promise<void>;
 
   /**
-   * Gets the value of the SweepRepeat property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the SweepRepeat property. The return value indicates
+   * whether the property was successfully retrieved.
    *
    * @method OcaSignalGenerator#GetSweepRepeat
    * @returns {Promise<boolean>}
@@ -196,7 +207,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetSweepRepeat(): Promise<boolean>;
 
   /**
-   * Sets the value of the SweepRepeat property. The return value indicates whether the property was successfully set.
+   * Sets the value of the SweepRepeat property. The return value indicates
+   * whether the property was successfully set.
    *
    * @method OcaSignalGenerator#SetSweepRepeat
    * @param {boolean} sweepRepeat
@@ -206,7 +218,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   SetSweepRepeat(sweepRepeat: boolean): Promise<void>;
 
   /**
-   * Gets the value of the Generating property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the Generating property. The return value indicates
+   * whether the property was successfully retrieved.
    *
    * @method OcaSignalGenerator#GetGenerating
    * @returns {Promise<boolean>}
@@ -215,7 +228,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   GetGenerating(): Promise<boolean>;
 
   /**
-   * Starts the signal generator. The return value indicates whether the signal generator was successfully started.
+   * Starts the signal generator. The return value indicates whether the signal
+   * generator was successfully started.
    *
    * @method OcaSignalGenerator#Start
    * @returns {Promise<void>}
@@ -223,7 +237,8 @@ export declare class OcaSignalGenerator extends OcaActuator {
   Start(): Promise<void>;
 
   /**
-   * Stops the signal generator. The return value indicates whether the signal generator was successfully stopped.
+   * Stops the signal generator. The return value indicates whether the signal
+   * generator was successfully stopped.
    *
    * @method OcaSignalGenerator#Stop
    * @returns {Promise<void>}
@@ -231,29 +246,24 @@ export declare class OcaSignalGenerator extends OcaActuator {
   Stop(): Promise<void>;
 
   /**
-   * Sets some or all signal generation 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 signal generation 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.
    *
    * @method OcaSignalGenerator#SetMultiple
-   * @param {number} Mask
-   *
+   * @param {IOcaParameterMask} Mask
    * @param {number} Frequency1
-   *
    * @param {number} Frequency2
-   *
    * @param {number} Level
-   *
-   * @param {OcaWaveformType} Waveform
-   *
-   * @param {OcaSweepType} SweepType
-   *
+   * @param {IOcaWaveformType} Waveform
+   * @param {IOcaSweepType} SweepType
    * @param {number} SweepTime
-   *
    * @param {boolean} SweepRepeat
    *
    * @returns {Promise<void>}
    */
   SetMultiple(
-    Mask: number,
+    Mask: IOcaParameterMask,
     Frequency1: number,
     Frequency2: number,
     Level: number,