aes70/src/controller/ControlClasses/OcaPowerManager.d.ts

A controller library for the AES70 protocol.

import { IOcaPowerState, OcaPowerState } from '../../types/OcaPowerState';
import { PropertyEvent } from '../property_event';
import { RemoteDevice } from '../remote_device';
import { OcaManager } from './OcaManager';

/**
 * Optional manager that manages power settings and state.
 *
 *  - May be instantiated once in any device.
 *
 *  - If instantiated, object number must be 5.
 *
 *
 * @extends OcaManager
 * @class OcaPowerManager
 */
export declare class OcaPowerManager extends OcaManager {
  /**
   * This event is emitted whenever State changes.
   */
  OnStateChanged: PropertyEvent<OcaPowerState>;

  /**
   * This event is emitted whenever PowerSupplies changes.
   */
  OnPowerSuppliesChanged: PropertyEvent<number[]>;

  /**
   * This event is emitted whenever ActivePowerSupplies changes.
   */
  OnActivePowerSuppliesChanged: PropertyEvent<number[]>;

  /**
   * This event is emitted whenever AutoState changes.
   */
  OnAutoStateChanged: PropertyEvent<boolean>;

  /**
   * This event is emitted whenever TargetState changes.
   */
  OnTargetStateChanged: PropertyEvent<OcaPowerState>;

  constructor(objectNumber: number, device: RemoteDevice);

  /**
   * Retrieve the value of property **03p01 State**, the current power state of
   * the device. Return value indicates whether the value was successfully
   * retrieved.
   *
   * @method OcaPowerManager#GetState
   * @returns {Promise<OcaPowerState>}
   *   A promise which resolves to a single value of type :class:`OcaPowerState`.
   */
  GetState(): Promise<OcaPowerState>;

  /**
   * Change the device power state. The return value indicates whether the
   * requested change has been successfully made.
   *
   * @method OcaPowerManager#SetState
   * @param {IOcaPowerState} State
   *
   * @returns {Promise<void>}
   */
  SetState(State: IOcaPowerState): Promise<void>;

  /**
   * Retrieves list of object number(s) of all power supply(ies). Return value
   * indicates whether the data was successfully retrieved.
   *
   * @method OcaPowerManager#GetPowerSupplies
   * @returns {Promise<number[]>}
   *   A promise which resolves to a single value of type ``number[]``.
   */
  GetPowerSupplies(): Promise<number[]>;

  /**
   * Retrieves list of object number(s) of active power supply(ies). Return
   * value indicates whether the data was successfully retrieved.
   *
   * @method OcaPowerManager#GetActivePowerSupplies
   * @returns {Promise<number[]>}
   *   A promise which resolves to a single value of type ``number[]``.
   */
  GetActivePowerSupplies(): Promise<number[]>;

  /**
   * 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.
   *
   * @method OcaPowerManager#ExchangePowerSupply
   * @param {number} oldPsu
   * @param {number} newPsu
   * @param {boolean} powerOffOld
   *
   * @returns {Promise<void>}
   */
  ExchangePowerSupply(
    oldPsu: number,
    newPsu: number,
    powerOffOld: boolean
  ): Promise<void>;

  /**
   * Gets the value of the **AutoState** property. The return value indicates
   * whether the value was successfully retrieved.
   *
   * @method OcaPowerManager#GetAutoState
   * @returns {Promise<boolean>}
   *   A promise which resolves to a single value of type ``boolean``.
   */
  GetAutoState(): Promise<boolean>;
}