aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaFilterParametric.js

@@ -1,8 +1,8 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaActuator } from './OcaActuator.js';
-import { OcaBitSet16 } from '../../OCP1/OcaBitSet16.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
+import { OcaParameterMask } from '../../OCP1/OcaParameterMask.js';
 import { OcaParametricEQShape } from '../../OCP1/OcaParametricEQShape.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
 
 /**
  * A parametric equalizer section with various shape options.
@@ -31,7 +31,7 @@ export const OcaFilterParametric = make_control_class(
       4,
       11,
       [
-        OcaBitSet16,
+        OcaParameterMask,
         OcaFloat32,
         OcaParametricEQShape,
         OcaFloat32,
@@ -52,7 +52,8 @@ export const OcaFilterParametric = make_control_class(
 );
 
 /**
- * Gets the equalizer frequency setpoint. The return value indicates whether the data was successfully retrieved.
+ * Gets the equalizer frequency setpoint. The return value indicates whether the
+ * data was successfully retrieved.
  * The return values of this method are
  *
  * - Frequency of type ``number``
@@ -63,7 +64,8 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the equalizer frequency. The return value indicates whether the value was successfully set.
+ * Sets the equalizer frequency. The return value indicates whether the value
+ * was successfully set.
  *
  * @method OcaFilterParametric#SetFrequency
  * @param {number} Frequency
@@ -71,22 +73,25 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the curve shape of the equalizer. The return value indicates whether the data was successfully retrieved.
+ * Gets the curve shape of the equalizer. The return value indicates whether the
+ * data was successfully retrieved.
  *
  * @method OcaFilterParametric#GetShape
  * @returns {Promise<OcaParametricEQShape>}
  *   A promise which resolves to a single value of type :class:`OcaParametricEQShape`.
  */
 /**
- * Sets the curve shape shape of the equalizer. The return value indicates whether the shape was successfully set.
+ * Sets the curve shape shape of the equalizer. The return value indicates
+ * whether the shape was successfully set.
  *
  * @method OcaFilterParametric#SetShape
- * @param {OcaParametricEQShape} type
+ * @param {IOcaParametricEQShape} type
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the width parameter property of the equalizer. The return value indicates whether the data was successfully retrieved.
+ * Gets the width parameter property of the equalizer. The return value
+ * indicates whether the data was successfully retrieved.
  * The return values of this method are
  *
  * - Width of type ``number``
@@ -97,7 +102,8 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the width parameter property of the equalizer. The return value indicates whether the Q was successfully set.
+ * Sets the width parameter property of the equalizer. The return value
+ * indicates whether the Q was successfully set.
  *
  * @method OcaFilterParametric#SetWidthParameter
  * @param {number} Width
@@ -105,7 +111,8 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the in-band gain of the equalizer. The return value indicates whether the data was successfully retrieved.
+ * Returns the in-band gain of the equalizer. The return value indicates whether
+ * the data was successfully retrieved.
  * The return values of this method are
  *
  * - gain of type ``number``
@@ -116,7 +123,8 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the in-band gain of the equalizer. The return value indicates whether the gain was successfully set.
+ * Sets the in-band gain of the equalizer. The return value indicates whether
+ * the gain was successfully set.
  *
  * @method OcaFilterParametric#SetInbandGain
  * @param {number} gain
@@ -124,7 +132,8 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the shape parameter of the equalizer. The return value indicates whether the data was successfully retrieved.
+ * Returns the shape parameter of the equalizer. The return value indicates
+ * whether the data was successfully retrieved.
  * The return values of this method are
  *
  * - shape of type ``number``
@@ -135,7 +144,8 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the shape parameter of the equalizer. The return value indicates whether the parameter was successfully set.
+ * Sets the shape parameter of the equalizer. The return value indicates whether
+ * the parameter was successfully set.
  *
  * @method OcaFilterParametric#SetShapeParameter
  * @param {number} shape
@@ -143,58 +153,54 @@ export const OcaFilterParametric = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Sets some or all filter 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 filter 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 OcaFilterParametric#SetMultiple
- * @param {number} Mask
- *
+ * @param {IOcaParameterMask} Mask
  * @param {number} Frequency
- *
- * @param {OcaParametricEQShape} Shape
- *
+ * @param {IOcaParametricEQShape} Shape
  * @param {number} WidthParameter
- *
  * @param {number} InBandGain
- *
  * @param {number} ShapeParameter
  *
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property Frequency changes in the remote object.
+ * This event is emitted when the property ``Frequency`` changes in the remote object.
  * The property ``Frequency`` is described in the AES70 standard as follows.
  * The frequency setpoint of the parametric filter.
  *
  * @member {PropertyEvent<number>} OcaFilterParametric#OnFrequencyChanged
  */
 /**
- * This event is emitted when the property Shape changes in the remote object.
+ * This event is emitted when the property ``Shape`` changes in the remote object.
  * The property ``Shape`` is described in the AES70 standard as follows.
  * The shape of the parametric filter - peak, shelf, etc.
  *
  * @member {PropertyEvent<OcaParametricEQShape>} OcaFilterParametric#OnShapeChanged
  */
 /**
- * This event is emitted when the property WidthParameter changes in the remote object.
+ * This event is emitted when the property ``WidthParameter`` changes in the remote object.
  * The property ``WidthParameter`` is described in the AES70 standard as follows.
- * Width parameter. For normal parametric implementations, this is the Q
- * of the filter.
+ * Width parameter. For normal parametric implementations, this is the Q of the
+ * filter.
  *
  * @member {PropertyEvent<number>} OcaFilterParametric#OnWidthParameterChanged
  */
 /**
- * This event is emitted when the property InbandGain changes in the remote object.
+ * This event is emitted when the property ``InbandGain`` changes in the remote object.
  * The property ``InbandGain`` is described in the AES70 standard as follows.
  * In-band gain of the parametric filter.
  *
  * @member {PropertyEvent<number>} OcaFilterParametric#OnInbandGainChanged
  */
 /**
- * This event is emitted when the property ShapeParameter changes in the remote object.
+ * This event is emitted when the property ``ShapeParameter`` changes in the remote object.
  * The property ``ShapeParameter`` is described in the AES70 standard as follows.
- * Width parameter. For certain filter types, this parameter may be used
- * to represent extra information about the shape of the transfer
- * function.
+ * Width parameter. For certain filter types, this parameter may be used to
+ * represent extra information about the shape of the transfer function.
  *
  * @member {PropertyEvent<number>} OcaFilterParametric#OnShapeParameterChanged
  */

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

@@ -1,11 +1,11 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaActuator } from './OcaActuator';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaActuator } from './OcaActuator';
 
 /**
- * A generic Z-domain rational polynomial filter section:  _A(0) + A(1)z + A(2)z^2 + A(3)z^3 + ..._  B(0) + B(1)z + B(2)z^2 + B(3)z^3 + ...
+ * A generic Z-domain rational polynomial filter section: A(0) + A(1)z + A(2)z^2
+ * + A(3)z^3 + ... B(0) + B(1)z + B(2)z^2 + B(3)z^3 + ...
  * @extends OcaActuator
  * @class OcaFilterPolynomial
  */
@@ -44,7 +44,6 @@ export declare class OcaFilterPolynomial extends OcaActuator {
    *
    * @method OcaFilterPolynomial#SetCoefficients
    * @param {number[]} A
-   *
    * @param {number[]} B
    *
    * @returns {Promise<void>}
@@ -75,7 +74,8 @@ export declare class OcaFilterPolynomial extends OcaActuator {
   SetSampleRate(Rate: number): Promise<void>;
 
   /**
-   * Gets the maximum allowable order (= max number of array elements in numerator and for denominator arrays)
+   * Gets the maximum allowable order (= max number of array elements in
+   * numerator and for denominator arrays)
    *
    * @method OcaFilterPolynomial#GetMaxOrder
    * @returns {Promise<number>}

package/src/controller/ControlClasses/OcaFilterPolynomial.js

@@ -1,11 +1,12 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaActuator } from './OcaActuator.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaUint8 } from '../../OCP1/OcaUint8.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaActuator } from './OcaActuator.js';
 
 /**
- * A generic Z-domain rational polynomial filter section:  _A(0) + A(1)z + A(2)z^2 + A(3)z^3 + ..._  B(0) + B(1)z + B(2)z^2 + B(3)z^3 + ...
+ * A generic Z-domain rational polynomial filter section: A(0) + A(1)z + A(2)z^2
+ * + A(3)z^3 + ... B(0) + B(1)z + B(2)z^2 + B(3)z^3 + ...
  * @extends OcaActuator
  * @class OcaFilterPolynomial
  */
@@ -46,7 +47,6 @@ export const OcaFilterPolynomial = make_control_class(
  *
  * @method OcaFilterPolynomial#SetCoefficients
  * @param {number[]} A
- *
  * @param {number[]} B
  *
  * @returns {Promise<void>}
@@ -71,31 +71,32 @@ export const OcaFilterPolynomial = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the maximum allowable order (= max number of array elements in numerator and for denominator arrays)
+ * Gets the maximum allowable order (= max number of array elements in numerator
+ * and for denominator arrays)
  *
  * @method OcaFilterPolynomial#GetMaxOrder
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * This event is emitted when the property A changes in the remote object.
+ * This event is emitted when the property ``A`` changes in the remote object.
  * The property ``A`` is described in the AES70 standard as follows.
  * Numerator - "A"
  *
  * @member {PropertyEvent<number[]>} OcaFilterPolynomial#OnAChanged
  */
 /**
- * This event is emitted when the property B changes in the remote object.
+ * This event is emitted when the property ``B`` changes in the remote object.
  * The property ``B`` is described in the AES70 standard as follows.
  * Denominator - "B"
  *
  * @member {PropertyEvent<number[]>} OcaFilterPolynomial#OnBChanged
  */
 /**
- * This event is emitted when the property SampleRate changes in the remote object.
+ * This event is emitted when the property ``SampleRate`` changes in the remote object.
  * The property ``SampleRate`` is described in the AES70 standard as follows.
- * Sample rate inside the filter. We can't assume it's the same as the
- * device input or output rate.
+ * Sample rate inside the filter. We can't assume it's the same as the device
+ * input or output rate.
  *
  * @member {PropertyEvent<number>} OcaFilterPolynomial#OnSampleRateChanged
  */

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

@@ -1,18 +1,33 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaManager } from './OcaManager';
-
-import { PropertyEvent } from '../property_event';
 import { IOcaComponent } from '../../types/OcaComponent';
 import { OcaVersion } from '../../types/OcaVersion';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaManager } from './OcaManager';
 
 /**
- * Optional manager that manages versions of the different firmware and software images of the device.
+ * Optional manager that manages versions of the different firmware and software
+ * images of the device.
  *
  *  - May be instantiated at most once in any device.
  *
- *
  *  - If instantiated, must have object number 3.
- *   A device that does not support firmware updating may support the subset of this class's functions needed to report firmware version numbers to inquiring controllers. This firmware manager offers a generic interface for updating OCA devices. The actual robustness of the update process is left up to the implementer. The interface allows for any of: - Fully transactional based uploads (i.e. only committing to the newly uploaded images after all component uploads have succeeded, and reverting back to the old images if any step fails) - Partly transactional based uploads (i.e. committing to a newly uploaded image after each individual component upload succeeds, possibly leading to a device containing a mix of old and new images) - Non-transactional based uploads guarded by golden images (i.e. accepting a 'weak' spot in the upload process where interruption may lead to a corrupt regular image, which is solved by loading a read-only failsafe ("golden") image in such cases that will allow recovery of the regular image) - Non-transactional based uploads that may lead to bricked devices
+ *
+ *
+ * A device that does not support firmware updating may support the subset of
+ * this class's functions needed to report firmware version numbers to inquiring
+ * controllers. This firmware manager offers a generic interface for updating
+ * OCA devices. The actual robustness of the update process is left up to the
+ * implementer. The interface allows for any of: - Fully transactional based
+ * uploads (i.e. only committing to the newly uploaded images after all
+ * component uploads have succeeded, and reverting back to the old images if any
+ * step fails) - Partly transactional based uploads (i.e. committing to a newly
+ * uploaded image after each individual component upload succeeds, possibly
+ * leading to a device containing a mix of old and new images) -
+ * Non-transactional based uploads guarded by golden images (i.e. accepting a
+ * 'weak' spot in the upload process where interruption may lead to a corrupt
+ * regular image, which is solved by loading a read-only failsafe ("golden")
+ * image in such cases that will allow recovery of the regular image) -
+ * Non-transactional based uploads that may lead to bricked devices
  * @extends OcaManager
  * @class OcaFirmwareManager
  */
@@ -25,16 +40,22 @@ export declare class OcaFirmwareManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the ComponentVersions property. The return value indicates whether the property was successfully retrieved.
+   * Gets the value of the ComponentVersions property. The return value
+   * indicates whether the property was successfully retrieved.
    *
    * @method OcaFirmwareManager#GetComponentVersions
    * @returns {Promise<OcaVersion[]>}
-   *   A promise which resolves to a single value of type ``OcaVersion[]``.
+   *   A promise which resolves to a single value of type :class:`OcaVersion[]`.
    */
   GetComponentVersions(): Promise<OcaVersion[]>;
 
   /**
-   * Marks the start of the update process of an OCA device, meaning one or more components will be updated. If the method succeeds the device will be in state 'Updating'. One or more active or passive updates can then follow, after which the update process is ended by calling the '03m08 EndUpdateProcess' method. The return value indicates if starting the update process succeeded.
+   * Marks the start of the update process of an OCA device, meaning one or more
+   * components will be updated. If the method succeeds the device will be in
+   * state 'Updating'. One or more active or passive updates can then follow,
+   * after which the update process is ended by calling the '03m08
+   * EndUpdateProcess' method. The return value indicates if starting the update
+   * process succeeded.
    *
    * @method OcaFirmwareManager#StartUpdateProcess
    * @returns {Promise<void>}
@@ -42,21 +63,33 @@ export declare class OcaFirmwareManager extends OcaManager {
   StartUpdateProcess(): Promise<void>;
 
   /**
-   * Starts an active update of a software/firmware image on the device. This generic interface can be used to update any component which can be updated actively, i.e. where the upload tool actively pushes the software/firmware image to the firmware manager. The actual firmware manager implementation may implement separate processes for different components, but in each case the interface is the same. The active interface consists of this method and the methods 03m03 AddImageData, 03m04 VerifyImage and 03m05 EndActiveImageUpdate. The return value indicates if starting the active update succeeded.
+   * Starts an active update of a software/firmware image on the device. This
+   * generic interface can be used to update any component which can be updated
+   * actively, i.e. where the upload tool actively pushes the software/firmware
+   * image to the firmware manager. The actual firmware manager implementation
+   * may implement separate processes for different components, but in each case
+   * the interface is the same. The active interface consists of this method and
+   * the methods 03m03 AddImageData, 03m04 VerifyImage and 03m05
+   * EndActiveImageUpdate. The return value indicates if starting the active
+   * update succeeded.
    *
    * @method OcaFirmwareManager#BeginActiveImageUpdate
-   * @param {OcaComponent} component
+   * @param {IOcaComponent} component
    *
    * @returns {Promise<void>}
    */
   BeginActiveImageUpdate(component: IOcaComponent): Promise<void>;
 
   /**
-   * Adds a new part of the software/firmware image to the upgrade memory as part of the active update. Where this data is stored, is up to the implementation of the manager. It can either be stored in RAM to be written to Flash later, or directly to Flash, dependent on the chosen architecture and requirements. The return value indicates whether the data is correctly received and the data is not out of order.
+   * Adds a new part of the software/firmware image to the upgrade memory as
+   * part of the active update. Where this data is stored, is up to the
+   * implementation of the manager. It can either be stored in RAM to be written
+   * to Flash later, or directly to Flash, dependent on the chosen architecture
+   * and requirements. The return value indicates whether the data is correctly
+   * received and the data is not out of order.
    *
    * @method OcaFirmwareManager#AddImageData
    * @param {number} id
-   *
    * @param {Uint8Array} imageData
    *
    * @returns {Promise<void>}
@@ -64,7 +97,8 @@ export declare class OcaFirmwareManager extends OcaManager {
   AddImageData(id: number, imageData: Uint8Array): Promise<void>;
 
   /**
-   * Verifies the entire host processor image using the passed verification data.
+   * Verifies the entire host processor image using the passed verification
+   * data.
    *
    * @method OcaFirmwareManager#VerifyImage
    * @param {Uint8Array} verifyData
@@ -74,7 +108,11 @@ export declare class OcaFirmwareManager extends OcaManager {
   VerifyImage(verifyData: Uint8Array): Promise<void>;
 
   /**
-   * Ends the active software/firmware image update. This is needed to let the device know that the current active component has finished, and therefore a new active or passive update can be started (or the upload process can be ended by invoking the '03m08 EndUpdateProcess' method). The return value indicates if ending the active update succeeded.
+   * Ends the active software/firmware image update. This is needed to let the
+   * device know that the current active component has finished, and therefore a
+   * new active or passive update can be started (or the upload process can be
+   * ended by invoking the '03m08 EndUpdateProcess' method). The return value
+   * indicates if ending the active update succeeded.
    *
    * @method OcaFirmwareManager#EndActiveImageUpdate
    * @returns {Promise<void>}
@@ -82,13 +120,20 @@ export declare class OcaFirmwareManager extends OcaManager {
   EndActiveImageUpdate(): Promise<void>;
 
   /**
-   * Begin a passive software/firmware component update. This generic interface can be used for any component that can be passively updated, i.e. where the device requests the actual software/firmware image from an external server. In the function the component type, details of the server and the filename of the file containing the component software/firmware image needs to be passed. The device will try to retrieve the new software/firmware image from the server and update its component using this image. The actual method for retrieving the image (e.g. TFTP) and the underlying update technique (e.g. netflash) depend on the implementation and may differ between components. Just the interface is standardized.
+   * Begin a passive software/firmware component update. This generic interface
+   * can be used for any component that can be passively updated, i.e. where the
+   * device requests the actual software/firmware image from an external server.
+   * In the function the component type, details of the server and the filename
+   * of the file containing the component software/firmware image needs to be
+   * passed. The device will try to retrieve the new software/firmware image
+   * from the server and update its component using this image. The actual
+   * method for retrieving the image (e.g. TFTP) and the underlying update
+   * technique (e.g. netflash) depend on the implementation and may differ
+   * between components. Just the interface is standardized.
    *
    * @method OcaFirmwareManager#BeginPassiveComponentUpdate
-   * @param {OcaComponent} component
-   *
+   * @param {IOcaComponent} component
    * @param {Uint8Array} serverAddress
-   *
    * @param {string} updateFileName
    *
    * @returns {Promise<void>}
@@ -100,7 +145,12 @@ export declare class OcaFirmwareManager extends OcaManager {
   ): Promise<void>;
 
   /**
-   * Ends the current update process in which one or more components haven been updated (actively or passively). This action will trigger the device to start using the new images. This should bring the device back into standard operational mode (e.g. rebooting the device, this however depends on the implementation of the upgrade process). As it will usually trigger a reset of the device in some cases no response parameter is used for this method.
+   * Ends the current update process in which one or more components haven been
+   * updated (actively or passively). This action will trigger the device to
+   * start using the new images. This should bring the device back into standard
+   * operational mode (e.g. rebooting the device, this however depends on the
+   * implementation of the upgrade process). As it will usually trigger a reset
+   * of the device in some cases no response parameter is used for this method.
    *
    * @method OcaFirmwareManager#EndUpdateProcess
    * @returns {Promise<void>}

package/src/controller/ControlClasses/OcaFirmwareManager.js

@@ -1,20 +1,36 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaManager } from './OcaManager.js';
 import { OcaBlob } from '../../OCP1/OcaBlob.js';
 import { OcaComponent } from '../../OCP1/OcaComponent.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaString } from '../../OCP1/OcaString.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
 import { OcaVersion } from '../../OCP1/OcaVersion.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaManager } from './OcaManager.js';
 
 /**
- * Optional manager that manages versions of the different firmware and software images of the device.
+ * Optional manager that manages versions of the different firmware and software
+ * images of the device.
  *
  *  - May be instantiated at most once in any device.
  *
- *
  *  - If instantiated, must have object number 3.
- *   A device that does not support firmware updating may support the subset of this class's functions needed to report firmware version numbers to inquiring controllers. This firmware manager offers a generic interface for updating OCA devices. The actual robustness of the update process is left up to the implementer. The interface allows for any of: - Fully transactional based uploads (i.e. only committing to the newly uploaded images after all component uploads have succeeded, and reverting back to the old images if any step fails) - Partly transactional based uploads (i.e. committing to a newly uploaded image after each individual component upload succeeds, possibly leading to a device containing a mix of old and new images) - Non-transactional based uploads guarded by golden images (i.e. accepting a 'weak' spot in the upload process where interruption may lead to a corrupt regular image, which is solved by loading a read-only failsafe ("golden") image in such cases that will allow recovery of the regular image) - Non-transactional based uploads that may lead to bricked devices
+ *
+ *
+ * A device that does not support firmware updating may support the subset of
+ * this class's functions needed to report firmware version numbers to inquiring
+ * controllers. This firmware manager offers a generic interface for updating
+ * OCA devices. The actual robustness of the update process is left up to the
+ * implementer. The interface allows for any of: - Fully transactional based
+ * uploads (i.e. only committing to the newly uploaded images after all
+ * component uploads have succeeded, and reverting back to the old images if any
+ * step fails) - Partly transactional based uploads (i.e. committing to a newly
+ * uploaded image after each individual component upload succeeds, possibly
+ * leading to a device containing a mix of old and new images) -
+ * Non-transactional based uploads guarded by golden images (i.e. accepting a
+ * 'weak' spot in the upload process where interruption may lead to a corrupt
+ * regular image, which is solved by loading a read-only failsafe ("golden")
+ * image in such cases that will allow recovery of the regular image) -
+ * Non-transactional based uploads that may lead to bricked devices
  * @extends OcaManager
  * @class OcaFirmwareManager
  */
@@ -45,32 +61,49 @@ export const OcaFirmwareManager = make_control_class(
 );
 
 /**
- * Gets the value of the ComponentVersions property. The return value indicates whether the property was successfully retrieved.
+ * Gets the value of the ComponentVersions property. The return value indicates
+ * whether the property was successfully retrieved.
  *
  * @method OcaFirmwareManager#GetComponentVersions
  * @returns {Promise<OcaVersion[]>}
- *   A promise which resolves to a single value of type ``OcaVersion[]``.
+ *   A promise which resolves to a single value of type :class:`OcaVersion[]`.
  */
 /**
- * Marks the start of the update process of an OCA device, meaning one or more components will be updated. If the method succeeds the device will be in state 'Updating'. One or more active or passive updates can then follow, after which the update process is ended by calling the '03m08 EndUpdateProcess' method. The return value indicates if starting the update process succeeded.
+ * Marks the start of the update process of an OCA device, meaning one or more
+ * components will be updated. If the method succeeds the device will be in
+ * state 'Updating'. One or more active or passive updates can then follow,
+ * after which the update process is ended by calling the '03m08
+ * EndUpdateProcess' method. The return value indicates if starting the update
+ * process succeeded.
  *
  * @method OcaFirmwareManager#StartUpdateProcess
  * @returns {Promise<void>}
  */
 /**
- * Starts an active update of a software/firmware image on the device. This generic interface can be used to update any component which can be updated actively, i.e. where the upload tool actively pushes the software/firmware image to the firmware manager. The actual firmware manager implementation may implement separate processes for different components, but in each case the interface is the same. The active interface consists of this method and the methods 03m03 AddImageData, 03m04 VerifyImage and 03m05 EndActiveImageUpdate. The return value indicates if starting the active update succeeded.
+ * Starts an active update of a software/firmware image on the device. This
+ * generic interface can be used to update any component which can be updated
+ * actively, i.e. where the upload tool actively pushes the software/firmware
+ * image to the firmware manager. The actual firmware manager implementation may
+ * implement separate processes for different components, but in each case the
+ * interface is the same. The active interface consists of this method and the
+ * methods 03m03 AddImageData, 03m04 VerifyImage and 03m05 EndActiveImageUpdate.
+ * The return value indicates if starting the active update succeeded.
  *
  * @method OcaFirmwareManager#BeginActiveImageUpdate
- * @param {OcaComponent} component
+ * @param {IOcaComponent} component
  *
  * @returns {Promise<void>}
  */
 /**
- * Adds a new part of the software/firmware image to the upgrade memory as part of the active update. Where this data is stored, is up to the implementation of the manager. It can either be stored in RAM to be written to Flash later, or directly to Flash, dependent on the chosen architecture and requirements. The return value indicates whether the data is correctly received and the data is not out of order.
+ * Adds a new part of the software/firmware image to the upgrade memory as part
+ * of the active update. Where this data is stored, is up to the implementation
+ * of the manager. It can either be stored in RAM to be written to Flash later,
+ * or directly to Flash, dependent on the chosen architecture and requirements.
+ * The return value indicates whether the data is correctly received and the
+ * data is not out of order.
  *
  * @method OcaFirmwareManager#AddImageData
  * @param {number} id
- *
  * @param {Uint8Array} imageData
  *
  * @returns {Promise<void>}
@@ -84,35 +117,51 @@ export const OcaFirmwareManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Ends the active software/firmware image update. This is needed to let the device know that the current active component has finished, and therefore a new active or passive update can be started (or the upload process can be ended by invoking the '03m08 EndUpdateProcess' method). The return value indicates if ending the active update succeeded.
+ * Ends the active software/firmware image update. This is needed to let the
+ * device know that the current active component has finished, and therefore a
+ * new active or passive update can be started (or the upload process can be
+ * ended by invoking the '03m08 EndUpdateProcess' method). The return value
+ * indicates if ending the active update succeeded.
  *
  * @method OcaFirmwareManager#EndActiveImageUpdate
  * @returns {Promise<void>}
  */
 /**
- * Begin a passive software/firmware component update. This generic interface can be used for any component that can be passively updated, i.e. where the device requests the actual software/firmware image from an external server. In the function the component type, details of the server and the filename of the file containing the component software/firmware image needs to be passed. The device will try to retrieve the new software/firmware image from the server and update its component using this image. The actual method for retrieving the image (e.g. TFTP) and the underlying update technique (e.g. netflash) depend on the implementation and may differ between components. Just the interface is standardized.
+ * Begin a passive software/firmware component update. This generic interface
+ * can be used for any component that can be passively updated, i.e. where the
+ * device requests the actual software/firmware image from an external server.
+ * In the function the component type, details of the server and the filename of
+ * the file containing the component software/firmware image needs to be passed.
+ * The device will try to retrieve the new software/firmware image from the
+ * server and update its component using this image. The actual method for
+ * retrieving the image (e.g. TFTP) and the underlying update technique (e.g.
+ * netflash) depend on the implementation and may differ between components.
+ * Just the interface is standardized.
  *
  * @method OcaFirmwareManager#BeginPassiveComponentUpdate
- * @param {OcaComponent} component
- *
+ * @param {IOcaComponent} component
  * @param {Uint8Array} serverAddress
- *
  * @param {string} updateFileName
  *
  * @returns {Promise<void>}
  */
 /**
- * Ends the current update process in which one or more components haven been updated (actively or passively). This action will trigger the device to start using the new images. This should bring the device back into standard operational mode (e.g. rebooting the device, this however depends on the implementation of the upgrade process). As it will usually trigger a reset of the device in some cases no response parameter is used for this method.
+ * Ends the current update process in which one or more components haven been
+ * updated (actively or passively). This action will trigger the device to start
+ * using the new images. This should bring the device back into standard
+ * operational mode (e.g. rebooting the device, this however depends on the
+ * implementation of the upgrade process). As it will usually trigger a reset of
+ * the device in some cases no response parameter is used for this method.
  *
  * @method OcaFirmwareManager#EndUpdateProcess
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property ComponentVersions changes in the remote object.
+ * This event is emitted when the property ``ComponentVersions`` changes in the remote object.
  * The property ``ComponentVersions`` is described in the AES70 standard as follows.
- * List of the versions of the components of the device. As of version 2
- * of this class, component numbers are of datatype<b> OcaEnum,
- * </b>rather than the previous <b>OcaUint16.</b>
+ * List of the versions of the components of the device. As of version 2 of this
+ * class, component numbers are of datatype** OcaEnum,** rather than the
+ * previous **OcaUint16.**
  *
  * @member {PropertyEvent<OcaVersion[]>} OcaFirmwareManager#OnComponentVersionsChanged
  */

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

@@ -1,8 +1,7 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaBasicActuator } from './OcaBasicActuator';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaBasicActuator } from './OcaBasicActuator';
 
 /**
  * Basic float32 actuator.
@@ -18,7 +17,8 @@ export declare class OcaFloat32Actuator extends OcaBasicActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value and limits of the  **Setting** property. The return value indicates whether the data was successfully retrieved.
+   * Gets the value and limits of the **Setting** property. The return value
+   * indicates whether the data was successfully retrieved.
    * The return values of this method are
    *
    * - Setting of type ``number``
@@ -31,7 +31,8 @@ export declare class OcaFloat32Actuator extends OcaBasicActuator {
   GetSetting(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the  **Setting** property. The return value indicates whether the property was successfully set.
+   * Sets the **Setting** property. The return value indicates whether the
+   * property was successfully set.
    *
    * @method OcaFloat32Actuator#SetSetting
    * @param {number} Setting