@ohos.thermal (Thermal Management)

The thermal module provides thermal level-related callback and query APIs to obtain the information required for thermal control.

NOTE

The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import {thermal} from '@kit.BasicServicesKit';

thermal.registerThermalLevelCallback⁹⁺

registerThermalLevelCallback(callback: Callback<ThermalLevel>): void

API description: Registers a callback to be invoked when the thermal level changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.PowerManager.ThermalManager

Parameters

Name	Type	Mandatory	Description
callback	Callback<ThermalLevel>	Yes	Callback used to return thermal level. This parameter is of the function type.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Incorrect parameter types.

Example

try {
    thermal.registerThermalLevelCallback((level: thermal.ThermalLevel) => {
        console.info('thermal level is: ' + level);
    });
    console.info('register thermal level callback success.');
} catch(err) {
    console.error('register thermal level callback failed, err: ' + err);
}

thermal.unregisterThermalLevelCallback⁹⁺

unregisterThermalLevelCallback(callback?: Callback<void>): void

API description: Unregisters the callback to be invoked when the thermal level changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.PowerManager.ThermalManager

Parameters

Name	Type	Mandatory	Description
callback	Callback<void>	No	(Optional) Callback that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Incorrect parameter types.

Example

try {
    thermal.unregisterThermalLevelCallback(() => {
        console.info('unsubscribe thermal level success.');
    });
    console.info('unregister thermal level callback success.');
} catch(err) {
    console.error('unregister thermal level callback failed, err: ' + err);
}

thermal.getLevel⁹⁺

getLevel(): ThermalLevel

API description: Obtains this thermal level.

System capability: SystemCapability.PowerManager.ThermalManager

Return value

Type	Description
ThermalLevel	Thermal level.

Example

let level = thermal.getLevel();
console.info('thermal level is: ' + level);

thermal.subscribeThermalLevel^(deprecated)

subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use thermal.registerThermalLevelCallback instead.

API description: Subscribes to the thermal level changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.PowerManager.ThermalManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<ThermalLevel>	Yes	Callback used to return the result. The return value contains only one parameter, that is, thermal level.

Example

thermal.subscribeThermalLevel((err: Error, level: thermal.ThermalLevel) => {
    console.info('thermal level is: ' + level);
});

thermal.unsubscribeThermalLevel^(deprecated)

unsubscribeThermalLevel(callback?: AsyncCallback<void>): void

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use thermal.unregisterThermalLevelCallback instead.

API description: Unsubscribes from the thermal level changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.PowerManager.ThermalManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	No	Callback that returns no value. If this parameter is not set, all callbacks will be unregistered.

Example

thermal.unsubscribeThermalLevel(() => {
    console.info('unsubscribe thermal level success.');
});

thermal.getThermalLevel^(deprecated)

getThermalLevel(): ThermalLevel

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use thermal.getLevel instead.

API description: Obtains this thermal level.

System capability: SystemCapability.PowerManager.ThermalManager

Return value

Type	Description
ThermalLevel	Thermal level.

Example

let level = thermal.getThermalLevel();
console.info('thermal level is: ' + level);

ThermalLevel

Enumerates thermal levels.

System capability: SystemCapability.PowerManager.ThermalManager

Name	Value	Description
COOL	0	The device is cool, and services are not restricted.
NORMAL	1	The device is in the normal temperature range but it is getting warm. You need to downgrade or reduce the load of imperceptible services.
WARM	2	The device is warm. You need to stop or delay some imperceptible services.
HOT	3	The device is heating up. You need to stop all imperceptible services and downgrade or reduce the load of non-critical services.
OVERHEATED	4	The device is overheated. You need to stop all imperceptible services and downgrade or reduce the load of major foreground services.
WARNING	5	The device is overheated and is about to enter the emergency state. You need to stop all imperceptible services and downgrade major foreground services to the maximum extent.
EMERGENCY	6	The device has entered the emergency state. You need to stop all services except those for fundamental use.
ESCAPE11+	7	The device is about to enter the escape state. You need to stop all services and take necessary emergency measures such as data backup. Note: This API is supported since API version 11.