Tizen Native API  5.5

The Power API provides functions to control the power service.

Required Header

#include <device/power.h>

Overview

The Power API provides the way to control the power service. It can be made to hold the specific state to avoid changing display and CPU state internally.

Related Features

This API is related with the following features:

  • http://tizen.org/feature/display.state

It is recommended to design feature related codes in your application for reliability.

You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.

To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.

More details on featuring your application can be found from feature element description.

Functions

int device_power_request_lock (power_lock_e type, int timeout_ms)
 Locks the given lock state for a specified time.
int device_power_release_lock (power_lock_e type)
 Releases the given lock state which was locked before.
int device_power_wakeup (bool dim) TIZEN_DEPRECATED_API
 Changes the current power state to the normal/dim state.
int device_power_reboot (const char *reason)
 Reboots the device.

Enumeration Type Documentation

Enumeration for lock type.

Each enum ensures that the suitable device is on until all the lock requests have been released or after a timeout.

Enum TypeCPUBrightness(Display)
POWER_LOCK_CPUONOFF
POWER_LOCK_DISPLAYONON(Normal)
POWER_LOCK_DISPLAY_DIMONON(Dim)
Since :
2.3.1
Remarks:
An application can lock the specific type.
These enums are mutually exclusive.
You cannot combine with an enum below.
Enumerator:
POWER_LOCK_CPU 

CPU lock

POWER_LOCK_DISPLAY 

Display normal lock

POWER_LOCK_DISPLAY_DIM 

Display dim lock


Function Documentation

int device_power_reboot ( const char *  reason)

Reboots the device.

Warning:
This is not for use by third-party applications.

Will not return if the reboot is successful.
It operates asynchronously.

Since :
2.3.1
Privilege Level:
platform
Privilege:
http://tizen.org/privilege/reboot
Parameters:
[in]reasonPass to the platform and kernel to request special reboot reason, or null
Returns:
0 on success, otherwise a negative error value
Return values:
DEVICE_ERROR_NONESuccessful
DEVICE_ERROR_INVALID_PARAMETERInvalid parameter
DEVICE_ERROR_PERMISSION_DENIEDPermission denied
DEVICE_ERROR_OPERATION_FAILEDOperation failed

Releases the given lock state which was locked before.

Since :
2.3.1
Privilege Level:
public
Privilege:
http://tizen.org/privilege/display
Parameters:
[in]typeThe power type to release lock
Returns:
0 on success, otherwise a negative error value
Return values:
DEVICE_ERROR_NONESuccessful
DEVICE_ERROR_INVALID_PARAMETERInvalid parameter
DEVICE_ERROR_PERMISSION_DENIEDPermission denied
DEVICE_ERROR_OPERATION_FAILEDOperation failed
See also:
device_power_request_lock()
int device_power_request_lock ( power_lock_e  type,
int  timeout_ms 
)

Locks the given lock state for a specified time.

After the given timeout_ms (in milliseconds), unlock the given lock state automatically.

Since :
2.3.1
Privilege Level:
public
Privilege:
http://tizen.org/privilege/display
Remarks:
If the process dies, then every lock will be removed.
Parameters:
[in]typeThe power type to request lock
[in]timeout_msThe positive number in milliseconds or 0 for permanent lock
So you must release the permanent lock of power state with device_power_release_lock() if timeout_ms is zero
Returns:
0 on success, otherwise a negative error value
Return values:
DEVICE_ERROR_NONESuccessful
DEVICE_ERROR_INVALID_PARAMETERInvalid parameter
DEVICE_ERROR_PERMISSION_DENIEDPermission denied
DEVICE_ERROR_OPERATION_FAILEDOperation failed
See also:
device_power_release_lock()
int device_power_wakeup ( bool  dim)

Changes the current power state to the normal/dim state.

Deprecated:
Deprecated Since 3.0
Since :
2.3.1
Privilege Level:
public
Privilege:
http://tizen.org/privilege/display
Remarks:
This API triggers turn on process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state.
DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: http://tizen.org/feature/display.state.
Parameters:
[in]dimSet true to set the dim state, otherwise set false to not set the dim state
Returns:
0 on success, otherwise a negative error value
Return values:
DEVICE_ERROR_NONESuccessful
DEVICE_ERROR_INVALID_PARAMETERInvalid parameter
DEVICE_ERROR_PERMISSION_DENIEDPermission denied
DEVICE_ERROR_OPERATION_FAILEDOperation failed
DEVICE_ERROR_NOT_SUPPORTEDNot supported device
Postcondition:
The device will be in DISPLAY_STATE_NORMAL state.