| Tizen Native API
    4.0
    | 
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.
| 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
| enum power_lock_e | 
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 Type | CPU | Brightness(Display) | 
|---|---|---|
| POWER_LOCK_CPU | ON | OFF | 
| POWER_LOCK_DISPLAY | ON | ON(Normal) | 
| POWER_LOCK_DISPLAY_DIM | ON | ON(Dim) | 
- Since :
- 2.3
- Remarks:
- An application can lock the specific type.
- These enums are mutually exclusive.
- You cannot combine with an enum below.
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] reason Pass to the platform and kernel to request special reboot reason, or null 
- Returns:
- 0on success, otherwise a negative error value
- Return values:
- 
  DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation failed 
| int device_power_release_lock | ( | power_lock_e | type | ) | 
Releases the given lock state which was locked before.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Parameters:
- 
  [in] type The power type to release lock 
- Returns:
- 0on success, otherwise a negative error value
- Return values:
- 
  DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation 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
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Remarks:
- If the process dies, then every lock will be removed.
- Parameters:
- 
  [in] type The power type to request lock [in] timeout_ms The positive number in milliseconds or 0for permanent lock
 So you must release the permanent lock of power state with device_power_release_lock() if timeout_ms is zero
- Returns:
- 0on success, otherwise a negative error value
- Return values:
- 
  DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation 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 2.4
- Since :
- 2.3
- 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.
- Parameters:
- 
  [in] dim Set trueto set the dim state, otherwise setfalseto not set the dim state
- Returns:
- 0on success, otherwise a negative error value
- Return values:
- 
  DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation failed 
- Postcondition:
- The device will be in DISPLAY_STATE_NORMAL state.