aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaPowerManager.js

@@ -8,7 +8,7 @@ import { OcaManager } from './OcaManager.js';
 /**
  * Optional manager that manages power settings and state.
  *
- *  - May be instantiated once in any device.
+ *  - May be instantiated at most once in any device.
  *
  *  - If instantiated, object number must be 5.
  *
@@ -20,15 +20,16 @@ export const OcaPowerManager = make_control_class(
   'OcaPowerManager',
   3,
   '\u0001\u0003\u0005',
-  2,
+  3,
   OcaManager,
   [
     ['GetState', 3, 1, [], [OcaPowerState]],
-    ['SetState', 3, 2, [OcaPowerState], []],
+    ['SetTargetState', 3, 2, [OcaPowerState], [], ['SetState']],
     ['GetPowerSupplies', 3, 3, [], [OcaList(OcaUint32)]],
     ['GetActivePowerSupplies', 3, 4, [], [OcaList(OcaUint32)]],
     ['ExchangePowerSupply', 3, 5, [OcaUint32, OcaUint32, OcaBoolean], []],
     ['GetAutoState', 3, 6, [], [OcaBoolean]],
+    ['GetTargetState', 3, 7, [], [OcaPowerState]],
   ],
   [
     ['State', [OcaPowerState], 3, 1, false, false, null],
@@ -41,17 +42,26 @@ export const OcaPowerManager = make_control_class(
 );
 
 /**
- * Retrieve the value of property **03p01 State**, the current power state of
- * the device. Return value indicates whether the value was successfully
- * retrieved.
+ * Retrieve the value of property **State**, the current power state of the
+ * device.
  *
  * @method OcaPowerManager#GetState
  * @returns {Promise<OcaPowerState>}
  *   A promise which resolves to a single value of type :class:`OcaPowerState`.
  */
 /**
- * Change the device power state. The return value indicates whether the
- * requested change has been successfully made.
+ * Change the target power state. Erroneously named **SetState** prior to v3 of
+ * this class.
+ *
+ * @method OcaPowerManager#SetTargetState
+ * @param {IOcaPowerState} State
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Change the target power state. Erroneously named **SetState** prior to v3 of
+ * this class.
+ * An alias for SetTargetState.
  *
  * @method OcaPowerManager#SetState
  * @param {IOcaPowerState} State
@@ -59,16 +69,14 @@ export const OcaPowerManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Retrieves list of object number(s) of all power supply(ies). Return value
- * indicates whether the data was successfully retrieved.
+ * Retrieves list of object number(s) of all power supply(ies).
  *
  * @method OcaPowerManager#GetPowerSupplies
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * Retrieves list of object number(s) of active power supply(ies). Return value
- * indicates whether the data was successfully retrieved.
+ * Retrieves list of object number(s) of active power supply(ies).
  *
  * @method OcaPowerManager#GetActivePowerSupplies
  * @returns {Promise<number[]>}
@@ -77,8 +85,7 @@ export const OcaPowerManager = make_control_class(
 /**
  * Deactivate one power supply and activate another. An option switch indicates
  * whether the previously active power supply is to be turned off. If it is not
- * turned off, it will be placed in the **Unavailable** state. The return value
- * indicates whether the requested exchange has been successfully made.
+ * turned off, it will be placed in the **Unavailable** state.
  *
  * @method OcaPowerManager#ExchangePowerSupply
  * @param {number} oldPsu
@@ -88,13 +95,20 @@ export const OcaPowerManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the **AutoState** property. The return value indicates
- * whether the value was successfully retrieved.
+ * Gets the value of the **AutoState** property.
  *
  * @method OcaPowerManager#GetAutoState
  * @returns {Promise<boolean>}
  *   A promise which resolves to a single value of type ``boolean``.
  */
+/**
+ * Retrieve the value of property** TargetState**, the power state of the device
+ * to which the device is transitioning.
+ *
+ * @method OcaPowerManager#GetTargetState
+ * @returns {Promise<OcaPowerState>}
+ *   A promise which resolves to a single value of type :class:`OcaPowerState`.
+ */
 /**
  * This event is emitted when the property ``State`` changes in the remote object.
  * The property ``State`` is described in the AES70 standard as follows.
@@ -120,6 +134,7 @@ export const OcaPowerManager = make_control_class(
  * This event is emitted when the property ``AutoState`` changes in the remote object.
  * The property ``AutoState`` is described in the AES70 standard as follows.
  * True if current state was invoked automatically, not by a controller action.
+ * Readonly.
  *
  * @member {PropertyEvent<boolean>} OcaPowerManager#OnAutoStateChanged
  */
@@ -127,7 +142,7 @@ export const OcaPowerManager = make_control_class(
  * This event is emitted when the property ``TargetState`` changes in the remote object.
  * The property ``TargetState`` is described in the AES70 standard as follows.
  * Power state to which the device is transitioning. If no transition is in
- * progress, has value None. Readonly.
+ * progress, has value None. Set by calls to **SetTargetState()**.
  *
  * @member {PropertyEvent<OcaPowerState>} OcaPowerManager#OnTargetStateChanged
  */

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

@@ -0,0 +1,38 @@
+import { Arguments } from '../arguments';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaSensor } from './OcaSensor';
+
+/**
+ * Power sensor. Reading shall be a watts value and a power factor value.
+ * @extends OcaSensor
+ * @class OcaPowerSensor
+ */
+export declare class OcaPowerSensor extends OcaSensor {
+  /**
+   * This event is emitted whenever Power changes.
+   */
+  OnPowerChanged: PropertyEvent<number>;
+
+  /**
+   * This event is emitted whenever PowerFactor changes.
+   */
+  OnPowerFactorChanged: PropertyEvent<number>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Gets the value and limits of the **Power** property, and the value of the
+   * **PowerFactor** propert**y**.
+   * The return values of this method are
+   *
+   * - Power of type ``number``
+   * - PowerFactor of type ``number``
+   * - minPower of type ``number``
+   * - maxPower of type ``number``
+   *
+   * @method OcaPowerSensor#GetReading
+   * @returns {Promise<Arguments<number,number,number,number>>}
+   */
+  GetReading(): Promise<Arguments<[number, number, number, number]>>;
+}

package/src/controller/ControlClasses/OcaPowerSensor.js

@@ -0,0 +1,51 @@
+import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaSensor } from './OcaSensor.js';
+
+/**
+ * Power sensor. Reading shall be a watts value and a power factor value.
+ * @extends OcaSensor
+ * @class OcaPowerSensor
+ */
+export const OcaPowerSensor = make_control_class(
+  'OcaPowerSensor',
+  4,
+  '\u0001\u0001\u0002\u000b',
+  1,
+  OcaSensor,
+  [['GetReading', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32, OcaFloat32]]],
+  [
+    ['Power', [OcaFloat32], 4, 1, false, false, null],
+    ['PowerFactor', [OcaFloat32], 4, 2, false, false, null],
+  ],
+  []
+);
+
+/**
+ * Gets the value and limits of the **Power** property, and the value of the
+ * **PowerFactor** propert**y**.
+ * The return values of this method are
+ *
+ * - Power of type ``number``
+ * - PowerFactor of type ``number``
+ * - minPower of type ``number``
+ * - maxPower of type ``number``
+ *
+ * @method OcaPowerSensor#GetReading
+ * @returns {Promise<Arguments<number,number,number,number>>}
+ */
+/**
+ * This event is emitted when the property ``Power`` changes in the remote object.
+ * The property ``Power`` is described in the AES70 standard as follows.
+ * Power in watts.
+ *
+ * @member {PropertyEvent<number>} OcaPowerSensor#OnPowerChanged
+ */
+/**
+ * This event is emitted when the property ``PowerFactor`` changes in the remote object.
+ * The property ``PowerFactor`` is described in the AES70 standard as follows.
+ * Power factor. Value shall range from 1 to zero, with 1 applying to a purely
+ * resistive circuit.
+ *
+ * @member {PropertyEvent<number>} OcaPowerSensor#OnPowerFactorChanged
+ */

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

@@ -47,8 +47,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the type of the power supply. Return value indicates whether the data
-   * was successfully retrieved.
+   * Gets the type of the power supply.
    *
    * @method OcaPowerSupply#GetType
    * @returns {Promise<OcaPowerSupplyType>}
@@ -57,8 +56,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   GetType(): Promise<OcaPowerSupplyType>;
 
   /**
-   * Gets the power supply's model information text. Return value indicates
-   * whether the data was successfully retrieved.
+   * Gets the power supply's model information text.
    *
    * @method OcaPowerSupply#GetModelInfo
    * @returns {Promise<string>}
@@ -67,8 +65,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   GetModelInfo(): Promise<string>;
 
   /**
-   * Gets the state of the power supply. Return value indicates whether the data
-   * was successfully retrieved.
+   * Gets the state of the power supply.
    *
    * @method OcaPowerSupply#GetState
    * @returns {Promise<OcaPowerSupplyState>}
@@ -77,8 +74,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   GetState(): Promise<OcaPowerSupplyState>;
 
   /**
-   * Changes the power supply's state. Return value indicates whether the state
-   * was successfully changed.
+   * Changes the power supply's state.
    *
    * @method OcaPowerSupply#SetState
    * @param {IOcaPowerSupplyState} state
@@ -88,8 +84,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   SetState(state: IOcaPowerSupplyState): Promise<void>;
 
   /**
-   * Gets the value of property **Charging**. Return value indicates whether the
-   * value was successfully retrieved.
+   * Gets the value of property **Charging**.
    *
    * @method OcaPowerSupply#GetCharging
    * @returns {Promise<boolean>}
@@ -98,8 +93,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   GetCharging(): Promise<boolean>;
 
   /**
-   * Gets the available load fraction. Return value indicates whether the data
-   * was successfully retrieved.
+   * Gets the available load fraction.
    *
    * @method OcaPowerSupply#GetLoadFractionAvailable
    * @returns {Promise<number>}
@@ -108,8 +102,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   GetLoadFractionAvailable(): Promise<number>;
 
   /**
-   * Gets the available storage fraction. Return value indicates whether the
-   * data was successfully retrieved.
+   * Gets the available storage fraction.
    *
    * @method OcaPowerSupply#GetStorageFractionAvailable
    * @returns {Promise<number>}
@@ -118,8 +111,7 @@ export declare class OcaPowerSupply extends OcaAgent {
   GetStorageFractionAvailable(): Promise<number>;
 
   /**
-   * Gets the power supply physical location. Return value indicates whether the
-   * data was successfully retrieved.
+   * Gets the power supply physical location.
    *
    * @method OcaPowerSupply#GetLocation
    * @returns {Promise<OcaPowerSupplyLocation>}

package/src/controller/ControlClasses/OcaPowerSupply.js

@@ -41,32 +41,28 @@ export const OcaPowerSupply = make_control_class(
 );
 
 /**
- * Gets the type of the power supply. Return value indicates whether the data
- * was successfully retrieved.
+ * Gets the type of the power supply.
  *
  * @method OcaPowerSupply#GetType
  * @returns {Promise<OcaPowerSupplyType>}
  *   A promise which resolves to a single value of type :class:`OcaPowerSupplyType`.
  */
 /**
- * Gets the power supply's model information text. Return value indicates
- * whether the data was successfully retrieved.
+ * Gets the power supply's model information text.
  *
  * @method OcaPowerSupply#GetModelInfo
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Gets the state of the power supply. Return value indicates whether the data
- * was successfully retrieved.
+ * Gets the state of the power supply.
  *
  * @method OcaPowerSupply#GetState
  * @returns {Promise<OcaPowerSupplyState>}
  *   A promise which resolves to a single value of type :class:`OcaPowerSupplyState`.
  */
 /**
- * Changes the power supply's state. Return value indicates whether the state
- * was successfully changed.
+ * Changes the power supply's state.
  *
  * @method OcaPowerSupply#SetState
  * @param {IOcaPowerSupplyState} state
@@ -74,32 +70,28 @@ export const OcaPowerSupply = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of property **Charging**. Return value indicates whether the
- * value was successfully retrieved.
+ * Gets the value of property **Charging**.
  *
  * @method OcaPowerSupply#GetCharging
  * @returns {Promise<boolean>}
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Gets the available load fraction. Return value indicates whether the data was
- * successfully retrieved.
+ * Gets the available load fraction.
  *
  * @method OcaPowerSupply#GetLoadFractionAvailable
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the available storage fraction. Return value indicates whether the data
- * was successfully retrieved.
+ * Gets the available storage fraction.
  *
  * @method OcaPowerSupply#GetStorageFractionAvailable
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the power supply physical location. Return value indicates whether the
- * data was successfully retrieved.
+ * Gets the power supply physical location.
  *
  * @method OcaPowerSupply#GetLocation
  * @returns {Promise<OcaPowerSupplyLocation>}
@@ -130,16 +122,16 @@ export const OcaPowerSupply = make_control_class(
 /**
  * This event is emitted when the property ``Charging`` changes in the remote object.
  * The property ``Charging`` is described in the AES70 standard as follows.
- * True iff charging. For rechargable supplies (obviously).
+ * True if and only if charging. For rechargable supplies (obviously).
  *
  * @member {PropertyEvent<boolean>} OcaPowerSupply#OnChargingChanged
  */
 /**
  * This event is emitted when the property ``LoadFractionAvailable`` changes in the remote object.
  * The property ``LoadFractionAvailable`` is described in the AES70 standard as follows.
- * Fraction of power supply's load capacity that is currently not being used.
- * Readonly. Normal value range 0...1. A negative value indicates this data is
- * not available.
+ * Fraction of power supply's load capacity that is currently **not** being
+ * used. Readonly. Normal value range 0...1. A negative value indicates this
+ * data is unavailable.
  *
  * @member {PropertyEvent<number>} OcaPowerSupply#OnLoadFractionAvailableChanged
  */
@@ -148,7 +140,7 @@ export const OcaPowerSupply = make_control_class(
  * The property ``StorageFractionAvailable`` is described in the AES70 standard as follows.
  * Fraction of power supply's energy storage that remains available. For battery
  * supplies. Readonly. Normal value range 0...1. A negative value indicates this
- * data is not available.
+ * data is unavailable.
  *
  * @member {PropertyEvent<number>} OcaPowerSupply#OnStorageFractionAvailableChanged
  */

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

@@ -0,0 +1,63 @@
+import { IOcaProgramRunMode } from '../../types/OcaProgramRunMode';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaDataset } from './OcaDataset';
+
+/**
+ * A Program. Child of **OcaDataset**. **Execution:** A program executes in a
+ * task. Tasks may be explicitly created by **OcaTaskManager2**, or they may be
+ * implicitly created at execution time. The execution task may be explicitly
+ * specified, by giving its task ID, or automatically created by the device. In
+ * either case, the given task ID parameter will be updated by the **Run()** or
+ * **Schedule()** method call to reflect the task actually assigned to the run.
+ * Once a task is set up, subscribing controllers will receive notifications
+ * about changes in its status from **OcaTaskManager2.** As well, running tasks
+ * can be controlled using **OcaTaskManager2** methods. Running and scheduling
+ * methods are as follows:
+ *
+ *  - **Run(...)** starts execution, then returns immediately.
+ *
+ *  - **Schedule(...)** schedules execution, then returns immediately.
+ *
+ *  - **RunWait(...)** starts execution, but does not return until execution
+ *    terminates.
+ *
+ *  - **ScheduleWait(...)** schedules execution, but does not return until
+ *    execution termiantes.
+ *
+ *
+ * If execution is invoked via **Run(...)** or **Schedule(...),
+ * OcaTaskManager2** will raise a **CommandSetTerminated** event when execution
+ * terminates. If execution is invoked via **RunWait(...)** or
+ * **ScheduleWait(...),** termination information is returned by the method, and
+ * no such event is raised.
+ * @extends OcaDataset
+ * @class OcaProgram
+ */
+export declare class OcaProgram extends OcaDataset {
+  /**
+   * This event is emitted whenever SupportedRunModes changes.
+   */
+  OnSupportedRunModesChanged: PropertyEvent<IOcaProgramRunMode[]>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Gets the list of run modes this program supports.
+   *
+   * @method OcaProgram#GetSupportedRunModes
+   * @returns {Promise<IOcaProgramRunMode[]>}
+   *   A promise which resolves to a single value of type ``IOcaProgramRunMode[]``.
+   */
+  GetSupportedRunModes(): Promise<IOcaProgramRunMode[]>;
+
+  /**
+   * Sets the list of run modes this program supports.
+   *
+   * @method OcaProgram#SetSupportedRunModes
+   * @param {IOcaProgramRunMode[]} RunModes
+   *
+   * @returns {Promise<void>}
+   */
+  SetSupportedRunModes(RunModes: IOcaProgramRunMode[]): Promise<void>;
+}

package/src/controller/ControlClasses/OcaProgram.js

@@ -0,0 +1,82 @@
+import { OcaList } from '../../OCP1/OcaList.js';
+import { OcaProgramRunMode } from '../../OCP1/OcaProgramRunMode.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaDataset } from './OcaDataset.js';
+
+/**
+ * A Program. Child of **OcaDataset**. **Execution:** A program executes in a
+ * task. Tasks may be explicitly created by **OcaTaskManager2**, or they may be
+ * implicitly created at execution time. The execution task may be explicitly
+ * specified, by giving its task ID, or automatically created by the device. In
+ * either case, the given task ID parameter will be updated by the **Run()** or
+ * **Schedule()** method call to reflect the task actually assigned to the run.
+ * Once a task is set up, subscribing controllers will receive notifications
+ * about changes in its status from **OcaTaskManager2.** As well, running tasks
+ * can be controlled using **OcaTaskManager2** methods. Running and scheduling
+ * methods are as follows:
+ *
+ *  - **Run(...)** starts execution, then returns immediately.
+ *
+ *  - **Schedule(...)** schedules execution, then returns immediately.
+ *
+ *  - **RunWait(...)** starts execution, but does not return until execution
+ *    terminates.
+ *
+ *  - **ScheduleWait(...)** schedules execution, but does not return until
+ *    execution termiantes.
+ *
+ *
+ * If execution is invoked via **Run(...)** or **Schedule(...),
+ * OcaTaskManager2** will raise a **CommandSetTerminated** event when execution
+ * terminates. If execution is invoked via **RunWait(...)** or
+ * **ScheduleWait(...),** termination information is returned by the method, and
+ * no such event is raised.
+ * @extends OcaDataset
+ * @class OcaProgram
+ */
+export const OcaProgram = make_control_class(
+  'OcaProgram',
+  3,
+  '\u0001\u0005\u0002',
+  1,
+  OcaDataset,
+  [
+    ['GetSupportedRunModes', 3, 1, [], [OcaList(OcaProgramRunMode)]],
+    ['SetSupportedRunModes', 3, 2, [OcaList(OcaProgramRunMode)], []],
+  ],
+  [
+    [
+      'SupportedRunModes',
+      [OcaList(OcaProgramRunMode)],
+      3,
+      1,
+      false,
+      false,
+      null,
+    ],
+  ],
+  []
+);
+
+/**
+ * Gets the list of run modes this program supports.
+ *
+ * @method OcaProgram#GetSupportedRunModes
+ * @returns {Promise<IOcaProgramRunMode[]>}
+ *   A promise which resolves to a single value of type ``IOcaProgramRunMode[]``.
+ */
+/**
+ * Sets the list of run modes this program supports.
+ *
+ * @method OcaProgram#SetSupportedRunModes
+ * @param {IOcaProgramRunMode[]} RunModes
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * This event is emitted when the property ``SupportedRunModes`` changes in the remote object.
+ * The property ``SupportedRunModes`` is described in the AES70 standard as follows.
+ * List of runmodes the task supports.
+ *
+ * @member {PropertyEvent<IOcaProgramRunMode[]>} OcaProgram#OnSupportedRunModesChanged
+ */

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

@@ -6,6 +6,14 @@ import {
 } from '../../types/OcaRamperInterpolationLaw';
 import { OcaRamperState } from '../../types/OcaRamperState';
 import { IOcaTimeMode, OcaTimeMode } from '../../types/OcaTimeMode';
+import {
+  IOcaWhenPhysicalAbsolute,
+  OcaWhenPhysicalAbsolute,
+} from '../../types/OcaWhenPhysicalAbsolute';
+import {
+  IOcaWhenPhysicalRelative,
+  OcaWhenPhysicalRelative,
+} from '../../types/OcaWhenPhysicalRelative';
 import { Arguments } from '../arguments';
 import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
@@ -69,10 +77,17 @@ export declare class OcaRamper extends OcaAgent {
    */
   OnGoalChanged: PropertyEvent<number>;
 
+  /**
+   * This event is emitted whenever StartWhen changes.
+   */
+  OnStartWhenChanged: PropertyEvent<
+    OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative
+  >;
+
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Executes the given ramper command. The return value indicates whether the
+   * Executes the given Ramper command. The return value indicates whether the
    * command was successfully executed.
    *
    * @method OcaRamper#Control
@@ -114,8 +129,8 @@ export declare class OcaRamper extends OcaAgent {
   SetRampedProperty(property: IOcaProperty): Promise<void>;
 
   /**
-   * Gets ramper time mode (absolute or relative). The return value indicates
-   * whether the time mode was successfully retrieved.
+   * Gets ramper time mode (absolute or relative). **Deprecated** in v3 of this
+   * class.
    *
    * @method OcaRamper#GetTimeMode
    * @returns {Promise<OcaTimeMode>}
@@ -124,8 +139,8 @@ export declare class OcaRamper extends OcaAgent {
   GetTimeMode(): Promise<OcaTimeMode>;
 
   /**
-   * Sets ramper time mode (absolute or relative). The return value indicates
-   * whether the time mode was successfully set.
+   * Sets ramper time mode (absolute or relative). **Deprecated** in v3 of this
+   * class.
    *
    * @method OcaRamper#SetTimeMode
    * @param {IOcaTimeMode} TimeMode
@@ -135,8 +150,8 @@ export declare class OcaRamper extends OcaAgent {
   SetTimeMode(TimeMode: IOcaTimeMode): Promise<void>;
 
   /**
-   * Gets ramp start time. The return value indicates whether the start time was
-   * successfully retrieved.
+   * Output parameter that holds the start time of the ramp if the method
+   * succeeds. **Deprecated** in version 3 of this class.
    *
    * @method OcaRamper#GetStartTime
    * @returns {Promise<number|BigInt>}
@@ -145,8 +160,7 @@ export declare class OcaRamper extends OcaAgent {
   GetStartTime(): Promise<number | BigInt>;
 
   /**
-   * Sets ramper start time. The return value indicates whether the start time
-   * was successfully set.
+   * Sets ramper start time. **Deprecated** in v3 of this class.
    *
    * @method OcaRamper#SetStartTime
    * @param {number|BigInt} TimeMode
@@ -161,7 +175,7 @@ export declare class OcaRamper extends OcaAgent {
    * The return values of this method are
    *
    * - Duration of type ``number``
-   * - miinDuration of type ``number``
+   * - minDuration of type ``number``
    * - maxDuration of type ``number``
    *
    * @method OcaRamper#GetDuration
@@ -221,4 +235,26 @@ export declare class OcaRamper extends OcaAgent {
    * @returns {Promise<void>}
    */
   SetGoal(goal: number): Promise<void>;
+
+  /**
+   * Gets the value of the **StartWhen** property.
+   *
+   * @method OcaRamper#GetStartWhen
+   * @returns {Promise<(OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)>}
+   *   A promise which resolves to a single value of type ``(OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)``.
+   */
+  GetStartWhen(): Promise<OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative>;
+
+  /**
+   * Sets the value of the **StartWhen** property. Shall fail if called when
+   * **State** is **Ramping**.
+   *
+   * @method OcaRamper#SetStartWhen
+   * @param {(IOcaWhenPhysicalAbsolute | IOcaWhenPhysicalRelative)} When
+   *
+   * @returns {Promise<void>}
+   */
+  SetStartWhen(
+    When: IOcaWhenPhysicalAbsolute | IOcaWhenPhysicalRelative
+  ): Promise<void>;
 }