Skip to content

查询设备类型定义列表

查询当前认证客户端可访问设备所使用的设备类型定义,包含各类型的硬件能力和操作说明。

使用建议

每个 profiles[] 元素都对应一个 deviceTypeprofiles[].deviceType查询设备列表查询设备详情 返回的 deviceType 一一匹配。客户端拿到设备的 deviceType 后,可在本接口结果中查找同值的 profile,用于判断可展示的数据和可用控制能力。建议在应用启动时拉取一次并本地缓存;当设备返回新的 deviceType 时再重新拉取。若设备返回 UNSUPPORTED,表示该设备当前还没有可用的 OpenAPI 设备类型定义,暂不能按标准能力模型接入。

限流

维度规则触发后行为
同一应用60 秒内最多 60返回 429 RATE_LIMITED

端点

http
GET /wlte/v1/device-profiles

权限要求

Scope必须说明
device:read查询当前客户端可访问设备对应的设备类型定义列表

请求

完整地址:

http
GET {baseUrl}/wlte/v1/device-profiles

请求头:

http
Authorization: Bearer {accessToken}
Accept: application/json

请求参数:

  • 当前版本无请求参数
  • 当前版本不支持分页,接口会一次性返回当前客户端可访问设备使用到的全部设备类型定义

成功响应

HTTP 状态码:

text
200 OK

响应体:

json
{
  "code": "SUCCESS",
  "message": "OK.",
  "requestId": "req_001",
  "data": {
    "profiles": [
      {
        "deviceType": "SM4_T_TH",
        "capabilities": {
          "relayCount": 4,
          "digitalInputCount": 4,
          "sensorInterfaces": [
            {
              "index": 1,
              "supportedTypes": ["TEMP", "TEMP_HUMI"]
            }
          ],
          "operationSpecs": {
            "relay": {
              "actions": ["ON", "OFF", "JOG"]
            }
          }
        }
      }
    ]
  }
}

返回范围

  • 只返回当前认证客户端可访问设备使用到的设备类型定义
  • 当当前认证客户端没有可访问设备时,返回 profiles: []

响应 data 结构

字段类型必填说明
profilesarray<DeviceProfile>当前账号可访问设备使用到的设备类型定义列表

DeviceProfile 结构

字段类型必填说明
deviceTypestring稳定的设备能力类型码,用于标识设备的能力特征
capabilitiesobject设备类型能力说明

Capabilities 结构

字段类型必填说明
relayCountinteger继电器通道数量。未返回表示没有继电器能力
digitalInputCountinteger数字输入通道数量。未返回表示没有数字输入能力
sensorInterfacesarray<SensorInterface>传感器接口列表
operationSpecsobject继电器等可控能力的补充说明

SensorInterface 结构

字段类型必填说明
indexinteger传感器接口或通道序号,从 1 开始
supportedTypesarray<string>该接口可接入的物理传感器类型列表

支持的传感器类型值

说明
TEMP温度传感器
TEMP_HUMI温湿度传感器

OperationSpecs 结构

字段类型必填说明
relay.actionsarray<string>继电器控制支持的动作,可能包含 ONOFFJOG

补充说明:

  • relay.actions 包含 JOG 时,说明该设备类型支持点动命令
  • 点动时长通过 PUT /wlte/v1/devices/{deviceId}/relays/{index}/jog-config 配置
  • 当前接口仅保证 durationSec 为正整数秒;Profile 响应暂不返回按型号区分的最小值和最大值

错误响应

可能返回:

  • 400 INVALID_REQUEST
  • 401 AUTH_REQUIRED
  • 401 AUTH_INVALID
  • 401 AUTH_EXPIRED
  • 403 AUTH_SCOPE_DENIED
  • 429 RATE_LIMITED
  • 500 INTERNAL_ERROR
Docs buildVersion v1.2.19-20260602-174859-60
Copyright © 2026 WLTE