OcaPowerManager

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaManager().

This class defines the properties

Name

JavaScript Type

AES70 Type

State

OcaPowerState

OcaPowerState

PowerSupplies

number[]

OcaList<OcaONo>

ActivePowerSupplies

number[]

OcaList<OcaONo>

AutoState

boolean

OcaBoolean

TargetState

OcaPowerState

OcaPowerState

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, State, PowerSupplies, ActivePowerSupplies, AutoState and TargetState.

class OcaPowerManager(objectNumber, device)

Optional manager that manages power settings and state.

  • May be instantiated once in any device.

  • If instantiated, object number must be 5.

OcaPowerManager.OnActivePowerSuppliesChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property ActivePowerSupplies changes in the remote object. The property ActivePowerSupplies is described in the AES70 standard as follows. Object number(s) of power suppl(ies) currently in use.

OcaPowerManager.OnAutoStateChanged

type: PropertyEvent.<boolean>

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.

OcaPowerManager.OnPowerSuppliesChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property PowerSupplies changes in the remote object. The property PowerSupplies is described in the AES70 standard as follows. List of object numbers of available power supplies.

OcaPowerManager.OnStateChanged

type: PropertyEvent.<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. Current power state of device. Readonly.

OcaPowerManager.ExchangePowerSupply(oldPsu, newPsu, powerOffOld)

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.

Arguments

  • oldPsu (number) –

  • newPsu (number) –

  • powerOffOld (boolean) –

Returns

Promise.<void> –

OcaPowerManager.GetActivePowerSupplies()

Retrieves list of object number(s) of active power supply(ies). Return value indicates whether the data was successfully retrieved.

Returns

Promise.<Array.<number>> – A promise which resolves to a single value of type number[].

OcaPowerManager.GetAutoState()

Gets the value of the AutoState property. The return value indicates whether the value was successfully retrieved.

Returns

Promise.<boolean> – A promise which resolves to a single value of type boolean.

OcaPowerManager.GetPowerSupplies()

Retrieves list of object number(s) of all power supply(ies). Return value indicates whether the data was successfully retrieved.

Returns

Promise.<Array.<number>> – A promise which resolves to a single value of type number[].

OcaPowerManager.GetState()

Retrieve the value of property 03p01 State , the current power state of the device. Return value indicates whether the value was successfully retrieved.

Returns

Promise.<OcaPowerState> – A promise which resolves to a single value of type OcaPowerState().

OcaPowerManager.SetState(State)

Change the device power state. The return value indicates whether the requested change has been successfully made.

Arguments
Returns

Promise.<void> –