On this page
FAQWhy does the call to cloud capabilities fail?

cleanDeviceData(params: CleanDeviceDataParams)

Requires:
@tuya-miniapp/cloud-api≥1.3.0
Additional notesRead the full notes
This API depends on cloud capabilities. In the Mini App Developer Platform, go to Development Settings - Cloud Capabilities to configure authorization. Before using this API, ensure the product to which the device belongs has enabled the advanced capability **Power Consumption Statistics** on the Tuya IoT Development Platform. Products that have not enabled this capability cannot collect energy consumption/electricity cost data; the API will return empty data or errors. To use it, create a product with energy consumption/electricity cost statistics and enable the corresponding advanced capability in the product details.

Description

Clear the specified device's energy statistics. This operation is irreversible; after clearing, historical statistics such as energy consumption and electricity cost will be deleted. We recommend prompting the user to confirm before calling.

Parameters

ParameterTypeRequiredDescription
YesRequest parameters

Return Value

Type: Promise<boolean>
Whether the clearing succeeded; this operation is irreversible. It is recommended to call exportDeviceData to back up the data before clearing.

Examples

Request example

import { cleanDeviceData } from '@tuya-miniapp/cloud-api';

cleanDeviceData({ devId: 'vdevo123' })
  .then(result => {
    console.log('Device energy data cleared successfully:', result);
  })
  .catch(error => {
    console.error('Failed to clear device energy data:', error);
  });

Response example

true

FAQ

Why does the call to cloud capabilities fail?

Before using this API, please ensure that the product to which the device belongs has enabled the Electricity Statistics advanced capability on the Tuya IoT Development Platform. Products without this capability enabled cannot collect electricity consumption/cost data, and the API will return empty data or an error. If you need to use it, please create a product with electricity consumption/cost statistics functions and enable the corresponding advanced capabilities in the product details. At the same time, the API depends on cloud capabilities, and authorization configuration is required in Development Settings - Cloud Capabilities on the Mini Program Developer Platform.