Skip to content

Commit 699158a

Browse files
author
miot-robot
committed
Merge branch SDK_10079 into SDK_10080 refer ${gitlabAfter}
1 parent 899bea8 commit 699158a

File tree

12 files changed

+37
-37
lines changed

12 files changed

+37
-37
lines changed

bin/config/transformer.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc-md/02-设备管理/03-插件网络操作模块.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ Device.checkFirmwareUpdateAndAlert().then(res => { }).catch(err => { })
441441
<a name="module_miot/device--module.exports+getVirtualDevices"></a>
442442
443443
#### module.exports.getVirtualDevices(type) ⇒ <code>[ &#x27;Promise&#x27; ].&lt;Array.&lt;BasicDevice&gt;&gt;</code>
444-
获取虚拟设备的子设备列表,暂时已上线的虚拟设备有:yeelink和philips灯组和窗帘组。其他的暂不支持。注意:mesh灯组,和灯组2.0,无法通过此接口获取子设备(暂未开放)
444+
获取虚拟设备的子设备列表,暂时已上线的虚拟设备有:yeelink和philips灯组和窗帘组。其他的暂不支持。注意:Mesh灯组,和灯组2.0,无法通过此接口获取子设备(暂未开放)
445445
446446
**Kind**: instance method of [<code>module.exports</code>](#exp_module_miot/device--module.exports)
447447
**Returns**: <code>[ &#x27;Promise&#x27; ].&lt;Array.&lt;BasicDevice&gt;&gt;</code> - resolve:子设备列表

doc-md/05-服务端能力/05-智能家庭模块.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1762,7 +1762,7 @@ Service.smarthome.addStat(key,value,extra);
17621762
**Returns**: <code>[ &#x27;Promise&#x27; ].&lt;object&gt;</code> - 成功时:返回
17631763
{
17641764
"group_did":"group.123456xxx",
1765-
"need_alter_device":false //与mesh组相关,窗帘组可以忽略
1765+
"need_alter_device":false //与Mesh组相关,窗帘组可以忽略
17661766
}
17671767
失败时:返回
17681768
{ "code":xxx,"message":"xxx" }

doc-md/07-UI组件/03-通用设置.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ value: 不显示该设置项的设备类型列表, 用 pid 表示设备类型, [
7979
| secondOptions | <code>array</code> | 二级菜单列表项的keys,keys的顺序代表显示的顺序,不传将显示全部,传空数组将显示必选项 |
8080
| showDot | <code>array</code> | 定义哪些列表项需要显示小红点。为了便于扩展每个列表项都可以显示小红点,默认全部**不显示**,需要显示传入该列表项的key即可。 |
8181
| commonSettingStyle | [<code>CommonSettingStyle</code>](#CommonSettingStyle) | - 10040新增 CommonSetting 中有关字体样式相关设置 |
82-
| extraOptions | <code>object</code> | 其他特殊配置项 ```js // extraOptions extraOptions: { showUpgrade: bool // 「固件升级」是否跳转原生固件升级页面。默认值true。一般来说,wifi设备跳转原生固件升级页面,蓝牙设备(传入bleOtaAuthType除外)不跳转原生固件升级页面 upgradePageKey: string // 「固件升级」如果不跳转原生固件升级页面,请传入想跳转页面的key(定义在 index.js 的 RootStack 中) licenseUrl: 资源id, // 见 miot/Host.ui.privacyAndProtocolReview 的传参说明,SDK_10023 开始废弃 policyUrl: 资源id, // 见 miot/Host.ui.privacyAndProtocolReview 的传参说明,SDK_10023 开始废弃 deleteDeviceMessage: string // 删除设备的弹窗中自定义提示文案,见 miot/Host.ui.openDeleteDevice 的传参说明 ZXhjbHVkZVJlcXVpcmVkT3B0aW9ucw==: [] // %E5%A6%82%E6%9E%9C%E6%83%B3%E8%A6%81%E5%B1%8F%E8%94%BD%E5%BF%85%E9%80%89%E9%A1%B9%EF%BC%8C%E5%9C%A8%E8%BF%99%E9%87%8C%E4%BC%A0%E5%85%A5%20key%20%E5%8D%B3%E5%8F%AF%EF%BC%8C%E4%B8%80%E7%BA%A7%20or%20%E4%BA%8C%E7%BA%A7%E8%8F%9C%E5%8D%95%E7%9A%84%20key%20%E9%83%BD%E5%8F%AF%E4%BB%A5%E3%80%82%E7%89%B9%E6%AE%8A%E9%9C%80%E8%A6%81%EF%BC%8C%E8%B0%A8%E6%85%8E%E4%BD%BF%E7%94%A8 option: object // 见 miot/Host.ui.previewLegalInformationAuthorization 的传参说明 syncDevice: bool // 插件端设置时区后是否需要后台同步到设备端, 见 miot/Host.ui.openDeviceTimeZoneSettingPage 的传参说明 networkInfoConfig: number // 「更多设置」页面是否显示「网络信息」设置项。0:不显示;1:显示;-1:米家默认配置(蓝牙设备不显示,Wi-Fi设备显示) bleOtaAuthType: number // 打开通用的蓝牙固件OTA的原生页面。指定设备的协议类型 0: 普通小米蓝牙协议设备(新接入设备已废弃该类型),1: 安全芯片小米蓝牙设备(比如锁类产品) 4: Standard Auth 标准蓝牙认证协议(通常2019.10.1之后上线的新蓝牙设备) 5: mesh 设备 10059新增 preOperations: object { AllOptions.SHARE: function, AllOptions.FIRMWARE_UPGRADE: function, AllOptions.CREATE_GROUP: function, AllOptions.MANAGE_GROUP: function } // 打开分享、ota、创建组、编辑组页面的前置操作,只会在resolve中执行打开页面 } ``` |
82+
| extraOptions | <code>object</code> | 其他特殊配置项 ```js // extraOptions extraOptions: { showUpgrade: bool // 「固件升级」是否跳转原生固件升级页面。默认值true。一般来说,wifi设备跳转原生固件升级页面,蓝牙设备(传入bleOtaAuthType除外)不跳转原生固件升级页面 upgradePageKey: string // 「固件升级」如果不跳转原生固件升级页面,请传入想跳转页面的key(定义在 index.js 的 RootStack 中) licenseUrl: 资源id, // 见 miot/Host.ui.privacyAndProtocolReview 的传参说明,SDK_10023 开始废弃 policyUrl: 资源id, // 见 miot/Host.ui.privacyAndProtocolReview 的传参说明,SDK_10023 开始废弃 deleteDeviceMessage: string // 删除设备的弹窗中自定义提示文案,见 miot/Host.ui.openDeleteDevice 的传参说明 ZXhjbHVkZVJlcXVpcmVkT3B0aW9ucw==: [] // %E5%A6%82%E6%9E%9C%E6%83%B3%E8%A6%81%E5%B1%8F%E8%94%BD%E5%BF%85%E9%80%89%E9%A1%B9%EF%BC%8C%E5%9C%A8%E8%BF%99%E9%87%8C%E4%BC%A0%E5%85%A5%20key%20%E5%8D%B3%E5%8F%AF%EF%BC%8C%E4%B8%80%E7%BA%A7%20or%20%E4%BA%8C%E7%BA%A7%E8%8F%9C%E5%8D%95%E7%9A%84%20key%20%E9%83%BD%E5%8F%AF%E4%BB%A5%E3%80%82%E7%89%B9%E6%AE%8A%E9%9C%80%E8%A6%81%EF%BC%8C%E8%B0%A8%E6%85%8E%E4%BD%BF%E7%94%A8 option: object // 见 miot/Host.ui.previewLegalInformationAuthorization 的传参说明 syncDevice: bool // 插件端设置时区后是否需要后台同步到设备端, 见 miot/Host.ui.openDeviceTimeZoneSettingPage 的传参说明 networkInfoConfig: number // 「更多设置」页面是否显示「网络信息」设置项。0:不显示;1:显示;-1:米家默认配置(蓝牙设备不显示,Wi-Fi设备显示) bleOtaAuthType: number // 打开通用的蓝牙固件OTA的原生页面。指定设备的协议类型 0: 普通小米蓝牙协议设备(新接入设备已废弃该类型),1: 安全芯片小米蓝牙设备(比如锁类产品) 4: Standard Auth 标准蓝牙认证协议(通常2019.10.1之后上线的新蓝牙设备) 5: Mesh 设备 10059新增 preOperations: object { AllOptions.SHARE: function, AllOptions.FIRMWARE_UPGRADE: function, AllOptions.CREATE_GROUP: function, AllOptions.MANAGE_GROUP: function } // 打开分享、ota、创建组、编辑组页面的前置操作,只会在resolve中执行打开页面 } ``` |
8383
| navigation | <code>object</code> | 必须传入当前插件的路由,即 `this.props.navigation`,否则无法跳转二级页面 **注意:** **1. 如果需要显示「更多设置」「固件升级」的二级菜单页面,需要从 miot/ui/CommonSetting 中导出 MoreSetting 和 FirmwareUpgrade 页面,** **并放在项目入口文件index.js的RootStack中。** ```js // index.js snippet import { FirmwareUpgrade, MoreSetting } from "miot/ui/CommonSetting"; ... const RootStack = createStackNavigator( { Setting, // 设置页 MoreSetting, // 二级菜单——更多设置 FirmwareUpgrade, // 二级菜单——固件升级 } ... ) ``` **2. 必须传入当前插件的路由,即 `this.props.navigation`,否则无法跳转二级页面** ```js <CommonSetting navigation={this.props.navigation} /> ``` |
8484

8585

miot-sdk/device/BasicDevice.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ export class BasicDevice {
340340
}
341341
/**
342342
* 是否虚拟设备,虚拟设备主要指老的设备组(Yeelight灯组,飞利浦灯组)。
343-
* **注意:mesh设备组,灯组2.0均不是虚拟设备**
343+
* **注意:Mesh设备组,灯组2.0均不是虚拟设备**
344344
* @since 10003
345345
* @return {boolean}
346346
* @readonly

miot-sdk/device/WifiDevice.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ export default class IDeviceWifi {
374374
return Promise
375375
}
376376
/**
377-
* 获取虚拟设备的子设备列表,暂时已上线的虚拟设备有:yeelink和philips灯组和窗帘组。其他的暂不支持。注意:mesh灯组,和灯组2.0,无法通过此接口获取子设备(暂未开放)
377+
* 获取虚拟设备的子设备列表,暂时已上线的虚拟设备有:yeelink和philips灯组和窗帘组。其他的暂不支持。注意:Mesh灯组,和灯组2.0,无法通过此接口获取子设备(暂未开放)
378378
* @since 10003。
379379
* change on 10046 获取虚拟窗帘组设备的子设备列表
380380
* 通过传入的type判断返回哪种设备的子设备 yeelink和philips灯组的组设备是N->1,子设备不会出现在设备列表中,但是窗帘设备是N->N+1,所以请求的接口不同,,为兼容旧版,默认type=1

miot-sdk/device/gateway.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export default class IDeviceGateWay {
1414
* 主要有以下字段:{iconURL,did,model,userId,extra,name,event,session,permitLevel,parentId,showMode,mac,propInfo,ip,ssid,bssid,pid,latitude,longitude,isVoiceDevice,isOnline,ownerId,ownerName};
1515
*/
1616
/**
17-
* 获取蓝牙网关关联的普通蓝牙和蓝牙mesh设备列表
17+
* 获取蓝牙网关关联的普通蓝牙和蓝牙Mesh设备列表
1818
* @param {string} [did=Device.deviceID] 蓝牙网关的did,可以为空,为空时默认取当前的Device.deviceID
1919
* @returns {Promise}
2020
* resolve:返回数组设备信息的promise, {"mesh":[Device], "normal":[Device]}

0 commit comments

Comments
 (0)