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

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,5 @@
 /// <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" />

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>;
+}
+

package/@types/health.d.ts

@@ -0,0 +1,309 @@
+declare namespace ty.health {
+  // 新增用户
+  type AddPanelUserParams = {
+    userInfo: {
+      devId: string; // 设备id
+      type: 1 | 2 | 3 | 6; // 业务类型：1-血压计；2-厨房秤；3-体脂称；6-血氧仪
+      userName: string; // 用户名
+      sex: 0 | 1; // 性别 0-男 1-女
+      birthday: number; // 生日 时间戳
+      height: number; // 身高
+      heightUnit: 'cm' | 'inch'; // 身高单位
+      weight: number; // 体重
+      weightUnit: 'kg' | 'lb' | 'st' | 'jin'; // 体重单位
+      userType: number; // 用户类型, 1-主用户,2-临时用户,其他-dp配置用户
+      avatar?: string; // 头像
+      extInfo?: string | { weightScale: number }; // 扩大10倍保存体重，因为云端不支持小数存储
+    },
+  };
+
+  type AddPanelUserResponse = string; // 新增用户 id
+
+  function addPanelUser(params: AddPanelUserParams): Promise<AddPanelUserResponse>;
+
+  // 更新用户
+  type UpdatePanelUserParams = {
+    userInfo: {
+      userId: string; // 用户id
+      devId: string; // 设备id
+      type: 1 | 2 | 3 | 6; // 业务类型：1-血压计；2-厨房秤；3-体脂称；6-血氧仪
+      userName: string; // 用户名
+      sex: 0 | 1; // 性别 0-男 1-女
+      birthday: number; // 生日 时间戳
+      height: number; // 身高
+      heightUnit: 'cm' | 'inch'; // 身高单位
+      weight: number; // 体重
+      weightUnit: 'kg' | 'lb' | 'st' | 'jin'; // 体重单位
+      userType: number; // 用户类型, 1-主用户,2-临时用户,其他-dp配置用户
+      avatar?: string; // 头像
+      extInfo?: string | { weightScale: number }; // 扩大10倍保存体重，因为云端不支持小数存储
+    },
+  };
+
+  type UpdatePanelUserResponse = boolean; // 是否调用成功
+
+  function updatePanelUser(params: UpdatePanelUserParams): Promise<UpdatePanelUserResponse>;
+
+  // 删除用户
+  type DeletePanelUserParams = {
+    userId: string; // 用户id
+  };
+
+  type DeletePanelUserResponse = boolean; // 是否调用成功
+
+  function deletePanelUser(params: DeletePanelUserParams): Promise<DeletePanelUserResponse>;
+
+  // 获取用户列表
+  type GetPanelUserListParams = {
+    devId: string; // 设备id
+  };
+
+  type User = {
+    userId: string; // 用户id
+    devId: string; // 设备id
+    type: 1 | 2 | 3 | 6; // 业务类型：1-血压计；2-厨房秤；3-体脂称；6-血氧仪
+    userName: string; // 用户名
+    sex: 0 | 1; // 性别 0-男 1-女
+    birthday: number; // 生日 时间戳
+    height: number; // 身高
+    heightUnit: 'cm' | 'inch'; // 身高单位
+    weight: number; // 体重
+    weightUnit: 'kg' | 'lb' | 'st' | 'jin'; // 体重单位
+    userType: number; // 用户类型, 1-主用户,2-临时用户,其他-dp配置用户
+    avatar?: string; // 头像
+    extInfo?: string | { weightScale: number }; // 扩大10倍保存体重，因为云端不支持小数存储
+  }
+
+  type GetPanelUserListResponse = User[]; // 用户列表
+
+  function getPanelUserList(params: GetPanelUserListParams): Promise<GetPanelUserListResponse>;
+
+  // 获取默认头像列表
+  type GetDefaultAvatarListParams = {
+    bizCode: 'default_avatar'
+  };
+
+  type Avatar = {
+    key: string; // 头像名
+    path: string; // 头像地址
+  }
+
+  type GetDefaultAvatarListResponse = Avatar[]; // 头像列表
+
+  function getDefaultAvatarList(params: GetDefaultAvatarListParams): Promise<GetDefaultAvatarListResponse>;
+
+  // 血压数据相关API定义
+
+  // 1. 面板上传血压数据
+  type BpgData = {
+    dps: {
+      1: number, // 收缩压
+      2: number, // 舒张压
+      3: number, // 脉搏
+      4: boolean, // 是否心率不齐
+      9: string, // 用户标识
+    },
+    dpsTime: number // dp 上报时间戳
+  }
+
+  type ReportPanelBpgDataParams = {
+    devId: string; // 设备id
+    userId: string; // 用户id
+    dataJson: BpgData[]
+  };
+
+  type ReportPanelBpgDataResponse = {
+    allocate: boolean, // 是否已成功上传 
+    uuid: number, // 血压数据id
+  };
+
+  function reportPanelBpgData(params: ReportPanelBpgDataParams): Promise<ReportPanelBpgDataResponse>;
+
+  // 2. 手动上传血压数据
+  type ReportSingleBpgDataParams = {
+    dataInfo: {
+      devId: string, // 设备id
+      userId: string, // 用户id
+      sys: number, // 收缩压
+      dia: number, // 舒张压
+      pulse: number, // 脉搏
+      time: number, // 时间戳
+      remark: string, // 备注
+    }
+  };
+
+  type ReportSingleBpgDataResponse = {
+    allocate: boolean, // 是否已成功上传 
+    uuid: number, // 血压数据id
+  };
+
+  function reportSingleBpgData(params: ReportSingleBpgDataParams): Promise<ReportSingleBpgDataResponse>;
+
+  // 3. 更新血压数据备注
+  type UpdateBpgDataRemarkParams = {
+    remark: string; // 备注
+    uuid: string; // 血压数据id
+  };
+
+  type UpdateBpgDataRemarkResponse = boolean; // 是否调用成功
+
+  function updateBpgDataRemark(params: UpdateBpgDataRemarkParams): Promise<UpdateBpgDataRemarkResponse>;
+
+  // 4. 删除血压数据
+  type DeleteBpgDataParams = {
+    userId: string; // 用户id
+    uuids: string; // 血压数据id
+  };
+
+  type DeleteBpgDataResponse = boolean; // 是否调用成功
+
+  function deleteBpgData(params: DeleteBpgDataParams): Promise<DeleteBpgDataResponse>;
+
+  // 5. 获取历史血压数据
+  type GetBpgDataHistoryParams = {
+    devId: string; // 设备id
+    userId: string; // 用户id
+    startTime: number; // 开始时间
+    endTime: number; // 结束时间
+    bpLevels: string; // 血压等级
+    existRemark: string; // 备注
+    offset: number; // 页数
+    limit: number; // 每页几条数据
+  };
+
+  type BpgHistoryData = {
+    arr: boolean; // 是否心率不齐
+    bpLevel: 'WHO_LV0' | 'WHO_LV1' | 'WHO_LV2' | 'WHO_LV3' | 'WHO_LV4' | 'WHO_LV5'; // 血压等级
+    devId: string; // 设备id
+    dia: string; // 舒张压
+    pulse: string; // 脉搏
+    remark: string; // 备注
+    reportType: 1 | 2; // 数据类型 1-面板上报 2-手动添加
+    sys: string; // 收缩压
+    time: number; // 时间戳
+    userId: string; // 用户id
+    uuid: string; // 血压id
+  }
+
+  type GetBpgDataHistoryResponse = {
+    datas: BpgHistoryData[]; // 血压数据列表
+    hasNext: boolean; // 是否有下一页
+    totalCount: number; // 血压数据总数
+  }
+
+  function getBpgDataHistory(params: GetBpgDataHistoryParams): Promise<GetBpgDataHistoryResponse>;
+
+  // 6. 获取最新一天血压统计数据
+  type GetBpgDataTrendLatestParams = {
+    devId: string; // 设备id
+    userId: string; // 用户id
+  };
+
+  type BpgTrendData = {
+    avgDia: string; // 舒张压
+    avgPulse: string; // 脉搏
+    avgSys: string; // 收缩压
+    time: number; // 时间戳
+  }
+
+  type GetBpgDataTrendLatestResponse = {
+    avgTotalDia: string; // 平均舒张压
+    avgTotalPulse: string; // 平均脉搏
+    avgTotalSys: string; // 平均收缩压
+    list: BpgTrendData[]
+  }
+
+  function getBpgDataTrendLatest(params: GetBpgDataTrendLatestParams): Promise<GetBpgDataTrendLatestResponse>;
+
+  // 7. 获取血压等级统计数据
+  type GetBpgDataLevnumParams = {
+    devId: string; // 设备id
+    userId: string; // 用户id
+    startTime: number; // 开始时间戳
+    endTime: number; // 结束时间戳
+  };
+
+  type GetBpgDataLevnumResponse = {
+    lv0Num: number; // 理想血压数量
+    lv0Ratio: number; // 理想血压占比
+    lv1Num: number; // 正常血压数量
+    lv1Ratio: number; // 正常血压占比
+    lv2Num: number; // 正常高压数量
+    lv2Ratio: number; // 正常高压占比
+    lv3Num: number; // 轻度高血压数量
+    lv3Ratio: number; // 轻度高血压占比
+    lv4Num: number; // 中度高血压数量
+    lv4Ratio: number; // 中度高血压占比
+    lv5Num: number; // 高度高血压数量
+    lv5Ratio: number; // 高度高血压占比
+    totalNum: number; // 数据总条数
+    userId: string; // 用户id
+  }
+
+  function getBpgDataLevnum(params: GetBpgDataLevnumParams): Promise<GetBpgDataLevnumResponse>;
+
+  // 8. 获取血压数据统计信息
+  type GetBpgDataTrendParams = {
+    dataType: 'year' | 'month' | 'week' // 数据类型
+    devId: string; // 设备id
+    userId: string; // 用户id
+    startTime: number; // 开始时间戳
+    endTime: number; // 结束时间戳
+  };
+
+  type GetBpgDataTrendResponse = {
+    avgTotalDia: string; // 平均舒张压
+    avgTotalPulse: string; // 平均脉搏
+    avgTotalSys: string; // 平均收缩压
+    list: BpgTrendData[]
+  }
+
+  function getBpgDataTrend(params: GetBpgDataTrendParams): Promise<GetBpgDataTrendResponse>;
+
+  // 9. 获取有血压数据的日期
+  type GetBpgDataDaysParams = {
+    devId: string; // 设备id
+    userId: string; // 用户id
+    startTime: number; // 开始时间戳
+    endTime: number; // 结束时间戳
+  };
+
+  type GetBpgDataDaysResponse = number[]; // 日期时间戳
+
+  function getBpgDataDays(params: GetBpgDataDaysParams): Promise<GetBpgDataDaysResponse>;
+
+  // 10. 获取未分配血压数据
+  type GetBpgDataUnallocatedParams = {
+    devId: string; // 设备id
+    limit: number; // 每页数量
+    offset: number; // 页码
+  };
+
+  type GetBpgDataUnallocatedResponse = {
+    datas: BpgHistoryData[]; // 血压数据列表
+    hasNext: boolean; // 是否有下一页
+    totalCount: number; // 血压数据总数
+  }
+
+  function getBpgDataUnallocated(params: GetBpgDataUnallocatedParams): Promise<GetBpgDataUnallocatedResponse>;
+
+  // 11. 分配未分配血压数据
+  type UpdateBpgDataUnallocatedParams = {
+    userId: string; // 用户id
+    uuids: string; // 血压数据id，用,分隔多个uuid
+    devId: string; // 设备id
+  };
+
+  type UpdateBpgDataUnallocatedResponse = boolean; // 是否调用成功
+
+  function updateBpgDataUnallocated(params: UpdateBpgDataUnallocatedParams): Promise<UpdateBpgDataUnallocatedResponse>;
+
+  // 12. 删除未分配血压数据
+  type DeleteBpgDataUnallocatedParams = {
+    uuids: string; // 血压数据id，用,分隔多个uuid
+  };
+
+  type DeleteBpgDataUnallocatedResponse = boolean; // 是否调用成功
+
+  function deleteBpgDataUnallocated(params: DeleteBpgDataUnallocatedParams): Promise<DeleteBpgDataUnallocatedResponse>;
+}