qcloud-iotexplorer-h5-panel-sdk - npm Package Compare versions

Comparing version 1.1.7 to 1.1.8

CHANGELOG.md

 # CHANGELOG
 
+### v1.1.8(2020.6.16)
+
+* getDeviceData等若干方法支持传入 deviceId 等参数来指定需要获取数据的设备
+* sdk 增加暴露当前家庭下的房间列表 roomList 属性
+* 修复文档若干错误及遗漏
+
 ### v1.1.6(2020.6.15)
@@ -4,0 +10,0 @@

package.json

 {
   "name": "qcloud-iotexplorer-h5-panel-sdk",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/release/qcloud-iotexplorer-h5-panel-sdk",

README.md

@@ -22,3 +22,7 @@ # qcloud-iotexplorer-h5-panel-sdk
 
-### sdk.controlDeviceData:  (data) => Promise
+### sdk.controlDeviceData:  (data, deviceId?: string) => Promise
+
+* data: any;
+* deviceId?: string; 可选，不传则使用当前设备deviceId
+
 控制设备属性，如：
@@ -31,51 +35,65 @@ ```
 
-### sdk.getDeviceDataHistory
-查询设备历史数据，具体用法参见: AppGetDeviceDataHistory 接口文档
+### sdk.getDeviceDataHistory: (options) => Promise<{ RequestId: string, Context: string, FieldName: string, Listover: boolean, Results: any[] }>
 
-### sdk.getUserInfo
-拉取用户信息，调用后会更新到 sdk.userInfo 中，具体用法参考 AppGetUser 接口文档
+* options.FieldName: string; 查询的属性名称
+* options.MaxTime: number; 结束时间，毫秒时间戳
+* options.MinTime: number; 开始时间，毫秒时间戳
+* options.Context?: string; 翻页游标，首次查询时，可不带
+* options.Limit: number; 单页数据量
 
-### sdk.getProductInfo
-拉取设备所属产品信息，调用后会更新 sdk.productInfo 和 sdk.dataTemplate，具体用法参考 AppGetProducts 接口文档
+查询设备历史数据，具体用法参见: [AppGetDeviceDataHistory 接口文档](https://cloud.tencent.com/document/product/1081/43119)
 
-### sdk.getDeviceData
-拉取设备最新的属性，调用后会更新 sdk.deviceData，具体用法参考 AppGetDeviceData 接口文档
+### sdk.getUserInfo()
+拉取用户信息，具体用法参考 AppGetUser 接口文档
 
-### sdk.getDeviceStatus
-拉取设备当前在线状态，调用后会更新 sdk.deviceStatus，具体用法参考 AppGetDeviceStatuses 接口文档
+### sdk.getProductInfo: ({ productId?: string }) => Promise<ProductInfo>
 
-### sdk.goDeviceDetailPage:  (options) => void
-* options.reload?: boolean; 如果传了 reload=true，则进入详情页后会重新拉取一次该设备的数据
+* productId?: string; 可选，不传则使用当前产品 ProductId
 
-跳转到腾讯连连通用的产品详情页（小程序页面）
+拉取设备所属产品信息，具体用法参考 AppGetProducts 接口文档
 
-### sdk.onWsClose: (callback) => void;
+### sdk.getDeviceInfo: ({ deviceId?: string }) => Promise<DeviceInfo>
 
-* callback: ({ code, reason }) => void;
+* deviceId?: string; 可选，不传则使用当前设备deviceId
 
-当 websocket close 事件触发后执行回调
+拉取设备信息
 
-### sdk.onWsError: (callback) => void;
+### sdk.getDeviceData: ({ deviceId?: string }) => Promise<any>
 
-* callback: (error) => void;
+* deviceId?: string;  可选，不传则使用当前设备deviceId
 
-当 websocket 触发 error 事件后触发回调
+拉取设备最新的属性，具体用法参考 AppGetDeviceData 接口文档
 
-### sdk.onWsControl: (callback) => void;
+### sdk.getDeviceStatus: ({ deviceId?: string }) => Promise<0 | 1>
 
-* callback: ({ deviceId, deviceData }) => void;
+* deviceId?: string;  可选，不传则使用当前设备deviceId 
 
-当 websocket 收到 `control` 指令后触发
+拉取设备当前在线状态，0 - 离线，1 - 在线
 
-### sdk.onWsReport: (callback) => void;
+### sdk.deleteDevice: ({ deviceId?: string }) => Promise
+删除设备，deviceId可选，不传则使用当前设备deviceId
 
-* callback: ({ deviceId, deviceData }) => void;
+### sdk.showDeviceDetail(options) => void;
 
-当 websocket 收到 `report` 指令后触发
+* options.deviceInfo?: Object; 展示详情的设备信息，不传则使用当前设备信息
+* options.labelWidth?: number; 设备详情的label宽度，默认 110，单位 px
+* options.marginTop?: number; 设备详情的上间距，默认 10，单位 px
+* options.extendItems?: ExtendItemConfig[]; 自定义菜单配置
+* options.extendItems.labelIcon?: string; 展示在 label 前的 icon 地址
+* options.extendItems.label: string; 自定义菜单项的标题
+* options.extendItems.content?: string; 自定义菜单项的内容
+* options.extendItems.className?: string; 自定义菜单项的样式类名
+* options.extendItems.onClick?: () => any; 点击自定义菜单项后触发的回调
+* options.extendButtons?: ExtendButtonConfig[]; 自定义按钮配置
+* options.extendButtons.text: string; 自定义按钮文案
+* options.extendButtons.className?: string; 自定义按钮的样式类名
+* options.extendButtons.type?: 'danger' | 'primary' | 'warning'; 自定义按钮的风格
+* options.extendButtons.onClick: () => any; 自定义按钮点击后触发的回调
+* options.containerClassName?: string; 容器的样式名
 
-### sdk.onWsStatusChange: (callback) => void;
+在当前 H5 展示一个铺满全屏的设备详情视图，支持自定义拓展菜单项及按钮。
 
-* callback: ({ deviceId, deviceStatus }) => void;
+### sdk.hideDeviceDetail() => void;
 
-当 websocket 收到设备状态改变推送后触发回调
+关闭设备详情视图
 
@@ -88,9 +106,13 @@ ### sdk.requestTokenApi: (action, data, options) => Promise
 
-### sdk.share: ({ title, imgUrl }) => Promise
+### sdk.goDeviceDetailPage:  (options) => void
+* options.reload?: boolean; 如果传了 reload=true，则进入详情页后会重新拉取一次该设备的数据
+* options.deviceId?: string;  可选，不传则使用当前设备deviceId
+* options.isShareDevice?: boolean; 可选，设备是否分享设备，不传则使用当前 sdk.isShareDevice
 
-* title: string 分享的标题
-* imgUrl?: string 分享图片的地址，默认会取当前页面截图
+跳转到腾讯连连通用的产品详情页（小程序页面）
 
-设置当前页面的分享内容，通过 [wx.miniProgram.postMessage](https://developers.weixin.qq.com/miniprogram/dev/component/web-view.html) 向小程序推送分享信息，具体参考 [小程序页面分享文档](https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#onShareAppMessage-Object-object)
+### sdk.goFeedBackPage()
 
+前往连连小程序反馈页面
+
 ### sdk.goDeviceInfoPage: ({ deviceId?: string }) => Promise
@@ -108,29 +130,13 @@ 前往设备信息页，deviceId可选，不传则使用当前设备deviceId
 
-### sdk.deleteDevice: ({ deviceId?: string }) => Promise
-删除设备，deviceId可选，不传则使用当前设备deviceId
+### sdk.reloadAfterUnmount()
 
-### sdk.showDeviceDetail(options) => void;
+退出当前h5页面返回连连小程序后，让小程序主动刷新一次当前数据。
 
-* options.deviceInfo?: Object; 展示详情的设备信息，不传则使用当前设备信息
-* options.labelWidth?: number; 设备详情的label宽度，默认 110，单位 px
-* options.marginTop?: number; 设备详情的上间距，默认 10，单位 px
-* options.extendItems?: ExtendItemConfig[]; 自定义菜单配置
-* options.extendItems.labelIcon?: string; 展示在 label 前的 icon 地址
-* options.extendItems.label: string; 自定义菜单项的标题
-* options.extendItems.content?: string; 自定义菜单项的内容
-* options.extendItems.className?: string; 自定义菜单项的样式类名
-* options.extendItems.onClick?: () => any; 点击自定义菜单项后触发的回调
-* options.extendButtons?: ExtendButtonConfig[]; 自定义按钮配置
-* options.extendButtons.text: string; 自定义按钮文案
-* options.extendButtons.className?: string; 自定义按钮的样式类名
-* options.extendButtons.text?: 'danger' | 'primary' | 'warning'; 自定义按钮的风格
-* options.extendButtons.onClick: () => any; 自定义按钮点击后触发的回调
-* options.containerClassName?: string; 容器的样式名
+### sdk.setShareConfig: ({ title, imgUrl }) => Promise
 
-在当前 H5 展示一个铺满全屏的设备详情视图，支持自定义拓展菜单项及按钮。
+* title: string 分享的标题
+* imgUrl?: string 分享图片的地址，默认会取当前页面截图
 
-### sdk.hideDeviceDetail() => void;
+设置当前页面的分享内容，通过 [wx.miniProgram.postMessage](https://developers.weixin.qq.com/miniprogram/dev/component/web-view.html) 向小程序推送分享信息，具体参考 [小程序页面分享文档](https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#onShareAppMessage-Object-object)
 
-关闭设备详情视图
-
 ### sdk.navBack: () => Promise
@@ -155,2 +161,32 @@ 调用 wx.miniProgram.navigateBack 返回上一级页面
 
+### sdk.onWsClose: (callback) => void;
+
+* callback: ({ code, reason }) => void;
+
+当 websocket close 事件触发后执行回调
+
+### sdk.onWsError: (callback) => void;
+
+* callback: (error) => void;
+
+当 websocket 触发 error 事件后触发回调
+
+### sdk.onWsControl: (callback) => void;
+
+* callback: ({ deviceId, deviceData }) => void;
+
+当 websocket 收到 `control` 指令后触发
+
+### sdk.onWsReport: (callback) => void;
+
+* callback: ({ deviceId, deviceData }) => void;
+
+当 websocket 收到 `report` 指令后触发
+
+### sdk.onWsStatusChange: (callback) => void;
+
+* callback: ({ deviceId, deviceStatus }) => void;
+
+当 websocket 收到设备状态改变推送后触发回调
+
 ### sdk.tips
@@ -296,2 +332,10 @@ tips模块，样式和风格与连连小程序一致
 
+### sdk.roomList
+
+当前家庭的房间列表
+
+### sdk.roomName
+
+当前设备的房间名称
+
 ### sdk.dataTemplate
@@ -298,0 +342,0 @@ 设备所在产品的物模型，如：

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

127400

increased by1.82%

Lines of code

405

increased by0.75%

Number of lines in readme file

580

increased by8.21%

No dependency changes