getUnitByIndicatorCode(params: GetUnitByIndicatorCodeParams)

版本要求:
@tuya-miniapp/cloud-api≥1.3.0

描述

根据指标编码查询对应的计量单位(如 kWh、元)。可在查询能源数据前调用,以便在 UI 中正确标注数值含义。

参数

参数类型必填说明
是请求参数

返回值

类型:Promise<string>
指标计量单位字符串,如 kWh(用电量)、元(电费,随设备货币配置变化)

引用对象

enumIndicatorCode
枚举值实际值描述
IndicatorCode.EleUsageele_usage用电量
IndicatorCode.EleCostele_cost电费
enumDateType
枚举值实际值描述
DateType.Hourhour小时维度,日期格式为 `YYYYMMDDHH`,如 `2026010108`
DateType.Dayday天维度,日期格式为 `YYYYMMDD`,如 `20260101`
DateType.Monthmonth月维度,日期格式为 `YYYYMM`,如 `202601`

合法值

IndicatorCode
值说明最低版本
ele_usage用电量-
ele_cost电费-
DateType
值说明最低版本
hour小时维度,日期格式为 `YYYYMMDDHH`,如 `2026010108`-
day天维度,日期格式为 `YYYYMMDD`,如 `20260101`-
month月维度,日期格式为 `YYYYMM`,如 `202601`-

示例代码

请求示例

import { getUnitByIndicatorCode, IndicatorCode, DateType } from '@tuya-miniapp/cloud-api';

getUnitByIndicatorCode({
  devId: 'vdevo123',
  indicatorCode: IndicatorCode.EleUsage,
  dateType: DateType.Day,
  beginDate: '20260101',
  endDate: '20260131',
})
  .then(unit => {
    console.log('指标单位:', unit); // 如 "kWh"
  })
  .catch(error => {
    console.error('获取指标单位失败:', error);
  });

返回示例

"kWh"

常见问题

为什么调用云能力会出现失败的情况?

使用本接口前,请确保设备所属产品已在涂鸦 IoT 开发平台开启电量统计高级能力。未启用该能力的产品无法采集电量/电费数据,接口将返回空数据或报错。如需使用,请创建带有电量/电费统计功能的产品,并在产品详情中启用相应高级能力。同时,接口依赖云能力,需在小程序开发者平台开发设置 - 云能力进行授权配置。