aes70/src/controller/ControlClasses/OcaPowerSupply.js

A controller library for the AES70 protocol.

import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
import { OcaPowerSupplyLocation } from '../../OCP1/OcaPowerSupplyLocation.js';
import { OcaPowerSupplyState } from '../../OCP1/OcaPowerSupplyState.js';
import { OcaPowerSupplyType } from '../../OCP1/OcaPowerSupplyType.js';
import { OcaString } from '../../OCP1/OcaString.js';
import { make_control_class } from '../make_control_class.js';
import { OcaAgent } from './OcaAgent.js';

/**
 * A power supply.
 * @extends OcaAgent
 * @class OcaPowerSupply
 */
export const OcaPowerSupply = make_control_class(
  'OcaPowerSupply',
  3,
  '\u0001\u0002\u0007',
  3,
  OcaAgent,
  [
    ['GetType', 3, 1, [], [OcaPowerSupplyType]],
    ['GetModelInfo', 3, 2, [], [OcaString]],
    ['GetState', 3, 3, [], [OcaPowerSupplyState]],
    ['SetState', 3, 4, [OcaPowerSupplyState], []],
    ['GetCharging', 3, 5, [], [OcaBoolean]],
    ['GetLoadFractionAvailable', 3, 6, [], [OcaFloat32]],
    ['GetStorageFractionAvailable', 3, 7, [], [OcaFloat32]],
    ['GetLocation', 3, 8, [], [OcaPowerSupplyLocation]],
  ],
  [
    ['Type', [OcaPowerSupplyType], 3, 1, false, false, null],
    ['ModelInfo', [OcaString], 3, 2, false, false, null],
    ['State', [OcaPowerSupplyState], 3, 3, false, false, null],
    ['Charging', [OcaBoolean], 3, 4, false, false, null],
    ['LoadFractionAvailable', [OcaFloat32], 3, 5, false, false, null],
    ['StorageFractionAvailable', [OcaFloat32], 3, 6, false, false, null],
    ['Location', [OcaPowerSupplyLocation], 3, 7, true, false, null],
  ],
  []
);

/**
 * Gets the type of the power supply. Return value indicates whether the data
 * was successfully retrieved.
 *
 * @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.
 *
 * @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.
 *
 * @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.
 *
 * @method OcaPowerSupply#SetState
 * @param {IOcaPowerSupplyState} state
 *
 * @returns {Promise<void>}
 */
/**
 * Gets the value of property **Charging**. Return value indicates whether the
 * value was successfully retrieved.
 *
 * @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.
 *
 * @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.
 *
 * @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.
 *
 * @method OcaPowerSupply#GetLocation
 * @returns {Promise<OcaPowerSupplyLocation>}
 *   A promise which resolves to a single value of type :class:`OcaPowerSupplyLocation`.
 */
/**
 * This event is emitted when the property ``Type`` changes in the remote object.
 * The property ``Type`` is described in the AES70 standard as follows.
 * Type of power supply.
 *
 * @member {PropertyEvent<OcaPowerSupplyType>} OcaPowerSupply#OnTypeChanged
 */
/**
 * This event is emitted when the property ``ModelInfo`` changes in the remote object.
 * The property ``ModelInfo`` is described in the AES70 standard as follows.
 * Model information for power supply. Text; content is
 * implementation-dependent.
 *
 * @member {PropertyEvent<string>} OcaPowerSupply#OnModelInfoChanged
 */
/**
 * This event is emitted when the property ``State`` changes in the remote object.
 * The property ``State`` is described in the AES70 standard as follows.
 * State of power supply: off, unavailable, available, active.
 *
 * @member {PropertyEvent<OcaPowerSupplyState>} OcaPowerSupply#OnStateChanged
 */
/**
 * 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).
 *
 * @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.
 *
 * @member {PropertyEvent<number>} OcaPowerSupply#OnLoadFractionAvailableChanged
 */
/**
 * This event is emitted when the property ``StorageFractionAvailable`` changes in the remote object.
 * 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.
 *
 * @member {PropertyEvent<number>} OcaPowerSupply#OnStorageFractionAvailableChanged
 */