• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

ToiPowerControl

Class Summary

Extends:
  • ToiEventTarget

ToiPowerControl is used for power management.

There are several regulating bodies with respect to power consumption, eg. Energy Star, EU, IEC, and this interface is intended to allow applications to be compliant with each.

  • Methods
  • Members
  • Types
  • Events

Method Summary

getCurrentPowerProfile ( )  → profile

Returns the current power profile.
releaseInstance ( )

This method to release a power control instance. Power control instances are created by using ToiPlatformService.
reportPowerProfile ( profile )

When a profile switch has been initiated this call is used to report the currently lowest possible power profile.
reportPowerProfileActionsComplete ( )

This call is used to acknowledge that the selected power profile can now be executed.
requestPowerProfile ( profile , reason )

This method is used to request a change in power profile.
setWakeupTimeout ( timeSpan )

An application can use this method to request a wakeup to active standby. If the device is in active when the timer expires nothing happens. This method must be called for each round of voting since the platform won't save values between voting rounds.

Inherited Methods

addEventListener ( type , listener )

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.
removeEventListener ( type , listener )

This method removes an event listener for a specific event.

Type Definitions

ToiPowerProfile (Type: enum)

These power profiles are a mix of European Power Code of Conduct, Energy Star and IEC.
  • PROFILE_ACTIVE
  • PROFILE_ACTIVE_STANDBY
  • PROFILE_PASSIVE_STANDBY
ToiPowerProfileAccess (Type: enum)

Power profile control possibility.
  • ACCESS_REPORT_AND_REQUEST
  • ACCESS_REPORT_ONLY
ToiPowerProfileChangeReason (Type: enum)

The possible reasons for a device to switch power profile.
  • REASON_AUTO_POWER_DOWN
  • REASON_STANDARD

Events

  • ON_AUTO_POWER_DOWN_TIMER_EXPIRED
  • ON_POWER_PROFILE_REQUESTED
  • ON_POWER_PROFILE_SELECTED

Methods

addEventListener ( type , listener )

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

Inherited From:

  • ToiEventTarget#addEventListener

Parameters:

Name Type Description
type number

The event type of the event to subscribe to.
listener ToiEventListener

The JavaScript function that will receive events.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.
getCurrentPowerProfile ( )  → profile

Returns the current power profile.

Returns:

The current power profile.

Type: ToiPowerControl.ToiPowerProfile
releaseInstance ( )

This method to release a power control instance. Power control instances are created by using ToiPlatformService.

removeEventListener ( type , listener )

This method removes an event listener for a specific event.

Inherited From:

  • ToiEventTarget#removeEventListener

Parameters:

Name Type Description
type number

The event type of the event to remove the listener from.
listener ToiEventListener

The JavaScript function that was previously added as an event listener.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener has not previously been added.
reportPowerProfile ( profile )

When a profile switch has been initiated this call is used to report the currently lowest possible power profile.

See also:

  • ToiPowerControlPowerProfileRequestedEvent

Parameters:

Name Type Description
profile ToiPowerControl.ToiPowerProfile

Denotes the lowest power profile currently possible for the responding application/service.

Throws:

ToiInvalidPreconditionException

Raised if this call is made without an ongoing voting procedure.
reportPowerProfileActionsComplete ( )

This call is used to acknowledge that the selected power profile can now be executed.

See also:

  • ToiPowerControlPowerProfileSelectedEvent

Throws:

ToiInvalidPreconditionException

Raised if this call is made without an ongoing voting procedure.
requestPowerProfile ( profile , reason )

This method is used to request a change in power profile.

Parameters:

Name Type Description
profile ToiPowerControl.ToiPowerProfile

Denotes the desired power profile.
reason ToiPowerControl.ToiPowerProfileChangeReason

Denotes the reason for requesting a power profile switch.

Throws:

ToiInvalidArgumentException

Raised if the power profile or reason is incorrect.
ToiPermissionDeniedException

Raised if an application that hasn't registered for power profile request tries to request a new power profile.
ToiInvalidPreconditionException

Raised if this call is made during an ongoing vote.
setWakeupTimeout ( timeSpan )

An application can use this method to request a wakeup to active standby. If the device is in active when the timer expires nothing happens. This method must be called for each round of voting since the platform won't save values between voting rounds.

Parameters:

Name Type Description
timeSpan number

Seconds until next wakeup.

Throws:

ToiInvalidPreconditionException

Raised if this call is made without an ongoing voting procedure.

Members

ON_AUTO_POWER_DOWN_TIMER_EXPIRED (Type: ToiPowerControlAutoPowerDownTimerExpiredEvent) (value = 4402) (static, constant)

This is an Event identifier for ToiPowerControlAutoPowerDownTimerExpiredEvent.

The power control issues this event when there has not been any user input during a pre-determined time span. The event is only triggered for application(s) in ToiPowerControl.ACCESS_REPORT_AND_REQUEST mode. Application(s) can use this information to initiate their own tailored auto power down.

This constant can also be accessed from toi.consts.ToiPowerControl.ON_AUTO_POWER_DOWN_TIMER_EXPIRED.
ON_POWER_PROFILE_REQUESTED (Type: ToiPowerControlPowerProfileRequestedEvent) (value = 4400) (static, constant)

This is an Event identifier for ToiPowerControlPowerProfileRequestedEvent.

This call is used by the power control to initiate a switch in the power profile. Interested parties need to register for the event and can also affect the outcome by calling ToiPowerControl#reportPowerProfile.

This constant can also be accessed from toi.consts.ToiPowerControl.ON_POWER_PROFILE_REQUESTED.
ON_POWER_PROFILE_SELECTED (Type: ToiPowerControlPowerProfileSelectedEvent) (value = 4401) (static, constant)

This is an Event identifier for ToiPowerControlPowerProfileSelectedEvent.

This call is used by the power control to communicate the selected profile.

This constant can also be accessed from toi.consts.ToiPowerControl.ON_POWER_PROFILE_SELECTED.
ACCESS_REPORT_AND_REQUEST (Type: ToiPowerControl.ToiPowerProfileAccess) (value = 1) (static, constant)

The application wants the possibility to initiate power profile switches.

This constant can also be accessed from toi.consts.ToiPowerControl.ACCESS_REPORT_AND_REQUEST.
ACCESS_REPORT_ONLY (Type: ToiPowerControl.ToiPowerProfileAccess) (value = 0) (static, constant)

The application does not want to initiate a power profile switch.

This constant can also be accessed from toi.consts.ToiPowerControl.ACCESS_REPORT_ONLY.
PROFILE_ACTIVE (Type: ToiPowerControl.ToiPowerProfile) (value = 0) (static, constant)

The device is in active mode.

This constant can also be accessed from toi.consts.ToiPowerControl.PROFILE_ACTIVE.
PROFILE_ACTIVE_STANDBY (Type: ToiPowerControl.ToiPowerProfile) (value = 1) (static, constant)

The device is in active mode but all video and audio outputs are disabled.

This constant can also be accessed from toi.consts.ToiPowerControl.PROFILE_ACTIVE_STANDBY.
PROFILE_PASSIVE_STANDBY (Type: ToiPowerControl.ToiPowerProfile) (value = 2) (static, constant)

Passive standby. Real power saving mode. Sometimes known as energy saving or energy efficient mode.

This constant can also be accessed from toi.consts.ToiPowerControl.PROFILE_PASSIVE_STANDBY.
REASON_AUTO_POWER_DOWN (Type: ToiPowerControl.ToiPowerProfileChangeReason) (value = 1) (static, constant)

The auto power down timer has expired.

This constant can also be accessed from toi.consts.ToiPowerControl.REASON_AUTO_POWER_DOWN.
REASON_STANDARD (Type: ToiPowerControl.ToiPowerProfileChangeReason) (value = 0) (static, constant)

A reason that isn't specific in any way.

This constant can also be accessed from toi.consts.ToiPowerControl.REASON_STANDARD.
ToiPowerControllerInfo (Type: struct) (static)

Information about a power controller.

Struct fields

Name Description
access

The power controller access possibility.

Type: ToiPowerControl.ToiPowerProfileAccess

Events

ON_AUTO_POWER_DOWN_TIMER_EXPIRED ( )

This is an Event identifier for ToiPowerControlAutoPowerDownTimerExpiredEvent.

Value: 4402

ON_POWER_PROFILE_REQUESTED ( )

This is an Event identifier for ToiPowerControlPowerProfileRequestedEvent.

Value: 4400

ON_POWER_PROFILE_SELECTED ( )

This is an Event identifier for ToiPowerControlPowerProfileSelectedEvent.

Value: 4401

5.1.1.p8

Copyright (c) 2018 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.