@ray-js/api 1.6.0-beta.9 → 1.6.1

package/@types/api-cloud.d.ts

@@ -0,0 +1,145 @@
+// api云能力扩展
+declare namespace ty {
+  // #region 获取云存储配置
+  type GetSweeperStorageConfigParams = {
+    // 设备id
+    devId: string
+    // 类型
+    type?: string
+  }
+
+  // 获取云存储配置返回值
+  type GetSweeperStorageConfigResponse = {
+    // ak
+    ak: string
+    // bucket
+    bucket: string
+    // sk
+    sk: string
+    // token
+    token: string
+    // endpoint
+    endpoint: string
+    // 过期时间
+    expiration: string
+    // 生命周期
+    lifeCycle: number
+    // 区域
+    region: string
+  }
+
+  /**
+   * 获取云存储配置
+   * @returns 获取云存储配置结果的 Promise
+   */
+  function getSweeperStorageConfig(
+    params: GetSweeperStorageConfigParams
+  ): Promise<GetSweeperStorageConfigResponse>
+
+  // #region 获取扫地机的历史地图
+  type GetMultipleMapFilesParams = {
+    //设备id
+    devId: string
+  }
+
+  type GetMultipleMapFilesResponse = {
+    datas: {
+      bucket: string // 存储文件的存储桶
+      extend: string // 文件的附加信息
+      time: number // 文件的时间戳
+      id: number // 文件的唯一标识符
+      file: string // 文件路径或路径
+      devId: string // 与文件关联的设备ID
+      fileType: string // 文件类型
+    }[] // 历史地图列表
+    totalCount: number // 数据总数
+  }
+
+  /**
+   * 获取扫地机的历史地图
+   * @returns 获取扫地机的历史地图结果的 Promise
+   */
+  export function getMultipleMapFiles(
+    params: GetMultipleMapFilesParams
+  ): Promise<GetMultipleMapFilesResponse>
+
+  // #region 获取清扫记录列表
+  type GetCleaningRecordsParams = {
+    startTime: string // 开始时间
+    endTime: string // 结束时间
+    limit: number // 返回的数据长度限制
+    offset: number // 偏移量
+    devId: string // 设备Id
+    fileType?: string // 可选参数，默认'pic'
+  }
+
+  type GetCleaningRecordsResponse = {
+    datas: {
+      bucket: string
+      extend: string // 清扫信息
+      devId: string
+      file: string
+      time: number
+      id: number // 清扫记录的唯一ID
+      fileType: string
+    }[]
+    totalCount: number // 清扫记录总长度
+  }
+
+  export function getCleaningRecords(
+    params: GetCleaningRecordsParams
+  ): Promise<GetCleaningRecordsResponse>
+
+  // #region 删除清扫记录
+  type DeleteCleaningRecordParams = {
+    devId: string // 设备id
+    fileIds: number[] // 要删除的记录id
+  }
+
+  type DeleteCleaningRecordResponse = boolean
+
+  /**
+   * 删除清扫记录
+   * @returns 删除清扫记录结果的 Promise
+   */
+  function deleteCleaningRecord(
+    params: DeleteCleaningRecordParams
+  ): Promise<DeleteCleaningRecordResponse>
+
+  // #region 获取扫地机的语音包列表
+  type GetVoiceListParams = {
+    //设备id
+    devId: string
+    //设备id - 兼容
+    deviceId?: string
+    // 分页参数，一般配置的语言包不多，可以不是用分页查询，直接使用0
+    offset: number
+    // 每页大小，可以传入100
+    limit: number
+  }
+
+  type GetVoiceListResponse = {
+    datas: {
+      auditionUrl: string // 试听链接
+      desc?: string // 描述
+      extendData: {
+        extendId: number // 扩展ID，通过这个id与设备上报的语言包id进行对比，判断语音包是否使用中
+        version: string // 版本
+      }
+      id: number // ID
+      imgUrl: string // 图片链接
+      name: string // 名称
+      officialUrl: string // 官方链接
+      productId: string // 产品ID
+      region: string[] // 区域代码
+    }[] // 语音数据数组
+    pageNo: number // 页码
+    totalCount: number // 数据总数
+  }
+
+  /**
+   * 获取扫地机的语音包列表
+   * @returns 获取扫地机的语音包列表结果的 Promise
+   */
+  function getVoiceList(params: GetVoiceListParams): Promise<GetVoiceListResponse>
+}

package/@types/api-extend.d.ts

@@ -122,20 +122,20 @@ interface setNavigationBarBackParam {
 
 interface CanvasGetImageDataProps extends Callback {
   canvasId: string
-  x: string
-  y: string
-  width: string
-  height: string
-  success(res: { width: string; height: string; data: Uint8ClampedArray }): void
+  x: number
+  y: number
+  width: number
+  height: number
+  success(res: { width: number; height: number; data: Array }): void
 }
 
 interface CanvasPutImageDataProps extends Callback {
   canvasId: string
-  x: string
-  y: string
-  width: string
-  height: string
-  data: Uint8ClampedArray
+  x: number
+  y: number
+  width: number
+  height: number
+  data: Array
 }
 
 interface VideoContext {
@@ -226,6 +226,29 @@ interface WebviewContext {
   postMessage(options: { data: Record<string, any> }): void
   reload(options: Callback): void
 }
+
+interface SocketTask {
+  send(option: { data: string | ArrayBuffer; success?: () => void; fail?: () => void; complete?: () => void }): void
+  close(option: { code?: number; reason?: string; success?: () => void; fail?: () => void; complete?: () => void }): void
+  onOpen(callback: () => void): void
+  onClose(callback: () => void): void
+  onError(callback: () => void): void
+  onMessage(callback: (res: { data: string | ArrayBuffer }) => void): void
+}
+
+interface ConnectSocketProps {
+  url: string;
+  protocols?: string[];
+  header?: Record<string, string>;
+  timeout?: number;
+  tcpNoDelay?: boolean;
+  perMessageDeflate?: boolean;
+  forceCellularNetwork?: boolean;
+  success?: () => void;
+  fail?: () => void;
+  complete?: () => void
+}
+
 declare namespace ty {
   /**
    * 小程序云能力
@@ -284,7 +307,16 @@ declare namespace ty {
   export type env = {
     USER_DATA_PATH: string
   }
+  export function connectSocket(param: ConnectSocketProps): SocketTask
+
+  /**
+   * 判断小程序的API，回调，组件等是否可用 (BaseKit 需要 3.15.1 及以上版本)
+   * @param schema 使用 ${API}.${method}.${param}.${option} 或者 ${component}.${attribute}.${option} 方式来调用
+   * @returns 是否可用
+   */
+  export function canIUse(schema: string): boolean
 }
+
 declare namespace WechatMiniprogram {
   interface Wx {
     requestCloud(params: RequestCloudParams): RequestCloudReturn

package/@types/api.d.ts

@@ -1,2 +1,6 @@
 /// <reference path="./all-kits.d.ts" />
 /// <reference path="./api-extend.d.ts" />
+/// <reference path="./api-cloud.d.ts" />
+/// <reference path="./gateway.d.ts" />
+/// <reference path="./health.d.ts" />
+/// <reference path="./energy.d.ts" />

package/@types/energy.d.ts

@@ -0,0 +1,250 @@
+declare namespace ty.energy {
+  // 1. 单设备多指标汇总查询
+  type GetDeviceDataMultipleSumParams = {
+    devId: string // 设备id
+    indicatorCodes: string // 维度
+    dateType: 'day' | 'week' | 'month' | 'year' // 日期类型
+    beginDate: string // 开始日期
+    endDate: string // 结束日期
+  }
+
+  type GetDeviceDataMultipleSumResponse = {
+    [key: string]: string
+  }
+
+  function getDeviceDataMultipleSum(
+    params: GetDeviceDataMultipleSumParams
+  ): Promise<GetDeviceDataMultipleSumResponse>
+
+  // 2. 查询逆变器设备信息
+  type GetInverterDeviceInfoParams = {
+    devId: string // 设备id
+  }
+
+  type GetInverterDeviceInfoResponse = {
+    inverterDailyCharge: string // 当日充电量
+    inverterDailyDischarge: string // 当日放电量
+    inverterEsTotalCharge: string // 累计充电量
+    inverterEsTotalDischarge: string // 累计放电量
+    inverterSoc: string // 当天电量
+    inverterSoh: string // 电池健康度
+    inverterStatus: string // 逆变器状态
+    inverterWorkMode: string // 能源模式
+  }
+
+  function getInverterDeviceInfo(
+    params: GetInverterDeviceInfoParams
+  ): Promise<GetInverterDeviceInfoResponse>
+
+  // 3. 查询逆变器仪表盘信息
+  type GetInverterPanelInfoParams = {
+    devId: string // 设备id
+  }
+
+  type GetInverterPanelInfoResponse = {
+    eleProduce: string // 当天发电量
+    inverterWorkModeSetting: string // 能源模式
+    netOutput: string // 净输出
+    score: string // 得分
+    inverterDcVoltage1: string // 1号当前电压
+    inverterDcCurrent1: string // 1号当前电流
+    inverterPv1InputPower: string // 1号当前功率
+    inverterDcVoltage2: string // 2号当前电压
+    inverterDcCurrent2: string // 2号当前电流
+    inverterPv2InputPower: string // 2号当前功率
+    inverterDcVoltage3: string // 3号当前电压
+    inverterDcCurrent3: string // 3号当前电流
+    inverterPv3InputPower: string // 3号当前功率
+    inverterDcVoltage4: string // 4号当前电压
+    inverterDcCurrent4: string // 4号当前电流
+    inverterPv4InputPower: string // 4号当前功率
+  }
+
+  function getInverterPanelInfo(
+    params: GetInverterPanelInfoParams
+  ): Promise<GetInverterPanelInfoResponse>
+
+  // 4. 查询流向图功率
+  type GetInverterFlowInfoParams = {
+    devId: string // 设备id
+  }
+
+  type GetInverterFlowInfoResponse = {
+    loadPower: string // 负载功率
+    pvPower: string // pv功率
+  }
+
+  function getInverterFlowInfo(
+    params: GetInverterFlowInfoParams
+  ): Promise<GetInverterFlowInfoResponse>
+
+  // 5. 获取设备属性
+  type GetPropertyInfoParams = {
+    devId: string // 设备id
+    bizType: number // bizType类型
+    code: string // 能力code
+  }
+
+  type GetPropertyInfoResponse = {
+    value: string // 装机容量
+  }[]
+
+  function getPropertyInfo(params: GetPropertyInfoParams): Promise<GetPropertyInfoResponse>
+
+  // 6. 保存设备属性
+  type SavePropertyParams = {
+    devId: string // 设备id
+    bizType: number // bizType类型
+    code: string // 能力code
+    value: string // 装机容量
+  }
+
+  type SavePropertyResponse = boolean
+
+  function saveProperty(params: SavePropertyParams): Promise<SavePropertyResponse>
+
+  // 7. 查询EMS系统设备故障事件列表
+  type GetDeviceAlarmEventParams = {
+    devId: string // 设备id
+    brandCode?: string // 品牌商标识（kkt）可选
+    weight: number // 目前事件多语言名称权重为1，事件起因多语言权重为3，事件解决方案多语言权重为5
+    startTime: number // 开始时间戳
+    endTime: number // 结束时间戳
+    eventType: 'fault' | 'alarm' // 事件类型 alarm 阈值告警/fault 故障告警
+    eventStatus: 0 | 1 // 事件状态 0 已恢复/1 未恢复
+    pageNum: number // 当前页
+    pageSize: number // 页数
+  }
+
+  type GetDeviceAlarmEventResponse = {
+    data: {
+      deviceId: string // 设备ID
+      startTime: number // 开始时间戳
+      endTime: number // 结束时间戳
+      name: string // 事件名称
+      desc: string // 事件描述
+    }[]
+  }
+
+  function getDeviceAlarmEvent(
+    params: GetDeviceAlarmEventParams
+  ): Promise<GetDeviceAlarmEventResponse>
+
+  // 8. 查询EMS系统设备故障事件详情
+  type GetDeviceAlarmEventDetailParams = {
+    devId: string // 设备id
+    brandCode?: string // 品牌商标识（kkt）可选
+    weight: number // 目前事件多语言名称权重为1，事件起因多语言权重为3，事件解决方案多语言权重为5
+    eventId: string // 事件ID
+  }
+
+  type GetDeviceAlarmEventDetailResponse = {
+    name: string // 事件名称
+    eventSolution: string // 解决方案
+    startTime: number // 开始时间戳
+    endTime: number // 结束时间戳
+  }
+
+  function getDeviceAlarmEventDetail(
+    params: GetDeviceAlarmEventDetailParams
+  ): Promise<GetDeviceAlarmEventDetailResponse>
+
+  // 9. 炭排放查询
+  type GetDeviceEnergySavingDataParams = {
+    devId: string // 设备id
+    phoneCode: string // 国家手机号前缀/或国家码 如德国DE 优先填写国家码,部分国家的手机号前缀一样
+    types: string // 节能数据类型: 1.碳排放(吨) 2.煤炭节约量(吨) 3.等效植树量(棵) 5.三口之家1天用电(天)
+  }
+
+  type GetDeviceEnergySavingDataResponse = {
+    type: string
+    value: string
+  }[]
+
+  function getDeviceEnergySavingData(
+    params: GetDeviceEnergySavingDataParams
+  ): Promise<GetDeviceEnergySavingDataResponse>
+
+  // 10. 单设备多指标趋势查询
+  type GetDeviceDataTrendParams = {
+    devId: string // 设备id
+    dateType: 'hour' | 'day' | 'month' // 日期维度
+    indicatorCodes: string // 指标code
+    beginDate: string // 开始时间
+    endDate: string // 结束时间
+    aggregationType?: 'SUM' | 'AVG' | 'MAX' | 'MIN' | 'NUM'
+  }
+
+  type GetDeviceDataTrendResponse = {
+    indicator: string // 指标code
+    total: number // 总数值
+    unit: string // 单位
+    list: {
+      date: string // 日期
+      value: number // 数值
+    }[]
+  }[]
+
+  function getPropertySettingTranslate(
+    params: GetDeviceDataTrendParams
+  ): Promise<GetDeviceDataTrendResponse>
+
+  // 11. 查询逆变器设备模型
+  type GetInverterDeviceModelParams = {
+    devId: string // 设备id
+  }
+
+  type GetInverterDeviceModelResponse = {
+    code: string // 指标code
+    data_spec: {
+      range: string[]
+      range_info: {
+        code: string
+        name: string
+      }[]
+      standard: {
+        [key: string]: string
+      }
+    }
+    data_type: string
+    group: number
+    name: string // 工作模式
+    type: string // 工作类型
+  }[]
+
+  function getInverterDeviceModel(
+    params: GetInverterDeviceModelParams
+  ): Promise<GetInverterDeviceModelResponse>
+
+  // 12. 能源设备属性查询
+  type GetDevicePropertySettingTranslateParams = {
+    devId: string // 设备id
+    codes: string // 指标code
+  }
+
+  type GetDevicePropertySettingTranslateResponse = {
+    code: string
+    langValue: string
+    time: number
+    value: string
+  }[]
+
+  function getDevicePropertySettingTranslate(
+    params: GetDevicePropertySettingTranslateParams
+  ): Promise<GetDevicePropertySettingTranslateResponse>
+
+  // 13. 逆变器设备属性下发
+  type SetDevicePropertySettingParams = {
+    devId: string // 设备id
+    setting: {
+      code: string // 指标code
+      value: string // 下发数值
+    }[]
+  }
+
+  type SetDevicePropertySettingResponse = boolean
+
+  function setDevicePropertySetting(
+    params: SetDevicePropertySettingParams
+  ): Promise<SetDevicePropertySettingResponse>
+}

package/@types/gateway.d.ts

@@ -0,0 +1,146 @@
+declare namespace ty.gateway {
+  // 1. 下发更新LQI指令
+  type SendCmdForRefreshDeviceLQIParams = {
+    devId: string; // 子设备id
+  };
+
+  type SendCmdForRefreshDeviceLQIResponse = boolean; // 是否下发成功
+
+  function sendCmdForRefreshDeviceLQI(params: SendCmdForRefreshDeviceLQIParams): Promise<SendCmdForRefreshDeviceLQIResponse>;
+
+  // 2. 获取设备最新LQI
+  type GetLastDeviceLQIParams = {
+    devId: string; //子设备id
+    offsetTime: number; //时间偏移量，单位为毫秒
+  };
+
+  type DeviceLQI = {
+    deviceId: string; //设备id
+    deviceName: string; //设备名称
+    isGateway: boolean; //是否是网关
+    lqi: number; // 子设备lqi值
+  }
+
+  type GetLastDeviceLQIResponse = DeviceLQI[];
+
+  function getLastDeviceLQI(params: GetLastDeviceLQIParams): Promise<GetLastDeviceLQIResponse>;
+
+  // 3. 查询设备高级能力
+  type GetSeniorAbilityParams = {
+    devId: string; // 设备id
+  };
+
+  type GetSeniorAbilityResponse = {
+    [key: string]: string;
+  };
+
+  function getSeniorAbility(params: GetSeniorAbilityParams): Promise<GetSeniorAbilityResponse>;
+
+  // 4. 获取网关子设备数量限制
+  type GetGatewaySubDevLimitParams = {
+    devId: string; // 设备id
+  };
+
+  type GetGatewaySubDevLimitResponse = {
+    max?: number; // 子设备数量上限
+    blu?: number; // 蓝牙子设备数量上限
+    zig?: number; // zigbee子设备数量上限
+    ver?: number; // 版本，嵌入式端上报
+  };
+
+  function getGatewaySubDevLimit(params: GetGatewaySubDevLimitParams): Promise<GetGatewaySubDevLimitResponse>;
+
+  // 5. mesh类设备拖拽
+  type UpdateRelationMeshParams = {
+    nodeIds: string[]; // 需要拖拽的子设备id列表
+    sourceMeshId?: string; // 原meshId或者网关Id
+    targetMeshId?: string; // 目标meshId或者网关Id
+  };
+
+  type UpdateRelationMeshResponse = {
+    repeatNodeIds: string[]; //已在网关下的设备列表
+  };
+
+  function updateRelationMesh(params: UpdateRelationMeshParams): Promise<UpdateRelationMeshResponse>;
+
+  // 6. 蓝牙单点类设备拖拽
+  type UpdateRelationBlueParams = {
+    nodes: {
+      devId: string;
+      uuid: string;
+    }[]; // 需要拖拽的子设备id与uuid列表
+    sourceMeshId?: string; // 原网关Id
+    targetMeshId?: string; // 目标网关Id
+  };
+
+  type UpdateRelationBlueResponse = {
+    repeatNodeIds: string[]; //已在网关下的设备列表
+  };
+
+  function updateRelationBlue(params: UpdateRelationBlueParams): Promise<UpdateRelationBlueResponse>;
+
+  // 7. beacon类设备拖拽
+  type UpdateRelationBeaconParams = {
+    nodes: {
+      devId: string;
+      mac: string;
+    }[]; // 需要拖拽的子设备id与mac列表
+    sourceMeshId?: string; // 原网关Id
+    targetMeshId?: string; // 目标网关Id
+  };
+
+  type UpdateRelationBeaconResponse = {
+    repeatNodeIds: string[]; //已在网关下的设备列表
+  };
+
+  function updateRelationBeacon(params: UpdateRelationBeaconParams): Promise<UpdateRelationBeaconResponse>;
+
+  // 8. 获取网关的能力
+  type GetGatewayAbilityParams = {
+    devIds: string; // 设备id拼成的字符串，以逗号分隔
+  };
+
+  type GatewayAbility = {
+    capability: number; // 能力值
+    devId: string; // 设备id
+    lqi: number; // 设备信号质量
+    performance?: number; // 网关性能指标
+    subMaximum?: { // 子设备数量上线
+      data?: { // 各类型子设备数量上线
+        [key: string]: number;
+      },
+      version?: number; // 版本
+    };
+  }
+
+  type GetGatewayAbilityResponse = GatewayAbility[];
+
+  function getGatewayAbility(params: GetGatewayAbilityParams): Promise<GetGatewayAbilityResponse>;
+
+  // 9. 获取设备日志
+  type GetSecurityDeviceLogParams = {
+    queryStr: string;
+  };
+
+  type DeviceLogData = {
+    rowkey: string; // key
+    dpName: string; // dp名称
+    createTime: number; // 创建时间
+    eventTime: number; // 上报时间
+    dpId: string; // dpId
+    eventType: string; // 事件类型
+    value: string; // dp值
+    deviceId: string; // 设备id
+  }
+
+  type GetSecurityDeviceLogResponse = {
+    devId: string; // 设备id
+    datas: DeviceLogData[];
+    hasNext: boolean; // 是否还有下一页
+    totalCount: number; // 总数
+    currentPageStartRowKey?: string; // 当前页起始key
+  };
+
+  function getSecurityDeviceLog(params: GetSecurityDeviceLogParams): Promise<GetSecurityDeviceLogResponse>;
+}
+