@ray-js/api 1.7.81 → 1.7.82

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * PlayNetKit
3
3
  *
4
- * @version 7.3.0
4
+ * @version 7.9.1
5
5
  */
6
6
  declare namespace ty.playnet {
7
7
  /**
@@ -55,7 +55,7 @@ declare namespace ty.playnet {
55
55
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
56
56
  complete?: () => void
57
57
  /** 接口调用成功的回调函数 */
58
- success?: (params: null) => void
58
+ success?: () => void
59
59
  /** 接口调用失败的回调函数 */
60
60
  fail?: (params: {
61
61
  /** 错误信息 */
@@ -123,7 +123,7 @@ declare namespace ty.playnet {
123
123
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
124
124
  complete?: () => void
125
125
  /** 接口调用成功的回调函数 */
126
- success?: (params: null) => void
126
+ success?: () => void
127
127
  /** 接口调用失败的回调函数 */
128
128
  fail?: (params: {
129
129
  /** 错误信息 */
@@ -277,7 +277,7 @@ declare namespace ty.playnet {
277
277
  */
278
278
  matterPayload?: SetupPayload
279
279
  /**
280
- * connectResult
280
+ * Matter 设备连接结果,connectMatterDevice 成功后传入以继续配网
281
281
  * @since PlayNetKit 1.3.0
282
282
  */
283
283
  connectResult?: ConnectResult
@@ -290,7 +290,7 @@ declare namespace ty.playnet {
290
290
  * 目前 子设备配网是否是通过自发现配网 会添加到内部
291
291
  * @since PlayNetKit 1.3.0
292
292
  */
293
- extensions?: Record<string, {}>
293
+ extensions?: Record<string, Record<string, any>>
294
294
  /**
295
295
  * 二维码信息 matter配网使用
296
296
  * @since PlayNetKit 1.3.0
@@ -299,7 +299,7 @@ declare namespace ty.playnet {
299
299
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
300
300
  complete?: () => void
301
301
  /** 接口调用成功的回调函数 */
302
- success?: (params: null) => void
302
+ success?: () => void
303
303
  /** 接口调用失败的回调函数 */
304
304
  fail?: (params: {
305
305
  /** 错误信息 */
@@ -453,7 +453,7 @@ declare namespace ty.playnet {
453
453
  */
454
454
  matterPayload?: SetupPayload
455
455
  /**
456
- * connectResult
456
+ * Matter 设备连接结果,connectMatterDevice 成功后传入以继续配网
457
457
  * @since PlayNetKit 1.3.0
458
458
  */
459
459
  connectResult?: ConnectResult
@@ -466,7 +466,7 @@ declare namespace ty.playnet {
466
466
  * 目前 子设备配网是否是通过自发现配网 会添加到内部
467
467
  * @since PlayNetKit 1.3.0
468
468
  */
469
- extensions?: Record<string, {}>
469
+ extensions?: Record<string, Record<string, any>>
470
470
  /**
471
471
  * 二维码信息 matter配网使用
472
472
  * @since PlayNetKit 1.3.0
@@ -475,7 +475,7 @@ declare namespace ty.playnet {
475
475
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
476
476
  complete?: () => void
477
477
  /** 接口调用成功的回调函数 */
478
- success?: (params: null) => void
478
+ success?: () => void
479
479
  /** 接口调用失败的回调函数 */
480
480
  fail?: (params: {
481
481
  /** 错误信息 */
@@ -509,42 +509,42 @@ declare namespace ty.playnet {
509
509
  /** 接口调用成功的回调函数 */
510
510
  success?: (params: {
511
511
  /**
512
- * version
512
+ * Matter Setup Payload 版本号
513
513
  * @since PlayNetKit 1.3.0
514
514
  */
515
515
  version?: number
516
516
  /**
517
- * vendorId
517
+ * Matter 厂商 ID(Vendor ID)
518
518
  * @since PlayNetKit 1.3.0
519
519
  */
520
520
  vendorId?: number
521
521
  /**
522
- * productId
522
+ * Matter 产品 ID(Product ID)
523
523
  * @since PlayNetKit 1.3.0
524
524
  */
525
525
  productId?: number
526
526
  /**
527
- * setupPinCode
527
+ * Matter 配网 PIN 码
528
528
  * @since PlayNetKit 1.3.0
529
529
  */
530
530
  setupPinCode?: number
531
531
  /**
532
- * commissioningFlow
532
+ * Matter 配网流程类型(Commissioning Flow)
533
533
  * @since PlayNetKit 1.3.0
534
534
  */
535
535
  commissioningFlow?: number
536
536
  /**
537
- * optionalQrCodeInfoMap
537
+ * QR 码可选 TLV 信息映射
538
538
  * @since PlayNetKit 1.3.0
539
539
  */
540
540
  optionalQrCodeInfoMap?: Record<number, MatterQrCodeInfo>
541
541
  /**
542
- * discoveryCapabilities
542
+ * 设备发现能力列表
543
543
  * @since PlayNetKit 1.3.0
544
544
  */
545
545
  discoveryCapabilities?: number[]
546
546
  /**
547
- * commissioningFlow
547
+ * Matter 鉴别码(Discriminator)
548
548
  * @since PlayNetKit 1.3.0
549
549
  */
550
550
  discriminator?: Discriminator
@@ -605,37 +605,37 @@ declare namespace ty.playnet {
605
605
  */
606
606
  discoveryType?: string
607
607
  /**
608
- * port
608
+ * 设备通信端口
609
609
  * @since PlayNetKit 1.3.0
610
610
  */
611
611
  port?: number
612
612
  /**
613
- * ipAddress
613
+ * 设备 IP 地址
614
614
  * @since PlayNetKit 1.3.0
615
615
  */
616
616
  ipAddress?: string
617
617
  /**
618
- * uuid
618
+ * 设备 UUID
619
619
  * @since PlayNetKit 1.3.0
620
620
  */
621
621
  uuid?: string
622
622
  /**
623
- * thingProductId
623
+ * 涂鸦产品 ID
624
624
  * @since PlayNetKit 1.3.0
625
625
  */
626
626
  thingProductId?: string
627
627
  /**
628
- * accessType
628
+ * Matter 接入类型
629
629
  * @since PlayNetKit 1.3.0
630
630
  */
631
631
  accessType?: number
632
632
  /**
633
- * nodeId
633
+ * Matter 节点 ID
634
634
  * @since PlayNetKit 1.3.0
635
635
  */
636
636
  nodeId?: number
637
637
  /**
638
- * isThingMatter
638
+ * 是否为涂鸦 Matter 设备
639
639
  * @since PlayNetKit 1.3.0
640
640
  */
641
641
  isThingMatter?: boolean
@@ -804,7 +804,7 @@ declare namespace ty.playnet {
804
804
  */
805
805
  matterPayload?: SetupPayload
806
806
  /**
807
- * connectResult
807
+ * Matter 设备连接结果,connectMatterDevice 成功后传入以继续配网
808
808
  * @since PlayNetKit 1.3.0
809
809
  */
810
810
  connectResult?: ConnectResult
@@ -817,7 +817,7 @@ declare namespace ty.playnet {
817
817
  * 目前 子设备配网是否是通过自发现配网 会添加到内部
818
818
  * @since PlayNetKit 1.3.0
819
819
  */
820
- extensions?: Record<string, {}>
820
+ extensions?: Record<string, Record<string, any>>
821
821
  /**
822
822
  * 二维码信息 matter配网使用
823
823
  * @since PlayNetKit 1.3.0
@@ -826,7 +826,7 @@ declare namespace ty.playnet {
826
826
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
827
827
  complete?: () => void
828
828
  /** 接口调用成功的回调函数 */
829
- success?: (params: null) => void
829
+ success?: () => void
830
830
  /** 接口调用失败的回调函数 */
831
831
  fail?: (params: {
832
832
  /** 错误信息 */
@@ -891,7 +891,7 @@ declare namespace ty.playnet {
891
891
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
892
892
  complete?: () => void
893
893
  /** 接口调用成功的回调函数 */
894
- success?: (params: null) => void
894
+ success?: () => void
895
895
  /** 接口调用失败的回调函数 */
896
896
  fail?: (params: {
897
897
  /** 错误信息 */
@@ -982,7 +982,7 @@ declare namespace ty.playnet {
982
982
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
983
983
  complete?: () => void
984
984
  /** 接口调用成功的回调函数 */
985
- success?: (params: null) => void
985
+ success?: () => void
986
986
  /** 接口调用失败的回调函数 */
987
987
  fail?: (params: {
988
988
  /** 错误信息 */
@@ -1120,7 +1120,7 @@ declare namespace ty.playnet {
1120
1120
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1121
1121
  complete?: () => void
1122
1122
  /** 接口调用成功的回调函数 */
1123
- success?: (params: null) => void
1123
+ success?: () => void
1124
1124
  /** 接口调用失败的回调函数 */
1125
1125
  fail?: (params: {
1126
1126
  /** 错误信息 */
@@ -1165,7 +1165,7 @@ declare namespace ty.playnet {
1165
1165
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1166
1166
  complete?: () => void
1167
1167
  /** 接口调用成功的回调函数 */
1168
- success?: (params: null) => void
1168
+ success?: () => void
1169
1169
  /** 接口调用失败的回调函数 */
1170
1170
  fail?: (params: {
1171
1171
  /** 错误信息 */
@@ -1192,7 +1192,7 @@ declare namespace ty.playnet {
1192
1192
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1193
1193
  complete?: () => void
1194
1194
  /** 接口调用成功的回调函数 */
1195
- success?: (params: null) => void
1195
+ success?: () => void
1196
1196
  /** 接口调用失败的回调函数 */
1197
1197
  fail?: (params: {
1198
1198
  /** 错误信息 */
@@ -1292,6 +1292,11 @@ declare namespace ty.playnet {
1292
1292
  complete?: () => void
1293
1293
  /** 接口调用成功的回调函数 */
1294
1294
  success?: (params: {
1295
+ /**
1296
+ * uuid
1297
+ * @since PlayNetKit 7.9.0
1298
+ */
1299
+ uuid: string
1295
1300
  /**
1296
1301
  * 设备id
1297
1302
  * @since PlayNetKit 1.1.0
@@ -1351,7 +1356,7 @@ declare namespace ty.playnet {
1351
1356
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1352
1357
  complete?: () => void
1353
1358
  /** 接口调用成功的回调函数 */
1354
- success?: (params: null) => void
1359
+ success?: () => void
1355
1360
  /** 接口调用失败的回调函数 */
1356
1361
  fail?: (params: {
1357
1362
  /** 错误信息 */
@@ -1393,7 +1398,7 @@ declare namespace ty.playnet {
1393
1398
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1394
1399
  complete?: () => void
1395
1400
  /** 接口调用成功的回调函数 */
1396
- success?: (params: null) => void
1401
+ success?: () => void
1397
1402
  /** 接口调用失败的回调函数 */
1398
1403
  fail?: (params: {
1399
1404
  /** 错误信息 */
@@ -1435,7 +1440,7 @@ declare namespace ty.playnet {
1435
1440
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1436
1441
  complete?: () => void
1437
1442
  /** 接口调用成功的回调函数 */
1438
- success?: (params: null) => void
1443
+ success?: () => void
1439
1444
  /** 接口调用失败的回调函数 */
1440
1445
  fail?: (params: {
1441
1446
  /** 错误信息 */
@@ -1477,7 +1482,7 @@ declare namespace ty.playnet {
1477
1482
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1478
1483
  complete?: () => void
1479
1484
  /** 接口调用成功的回调函数 */
1480
- success?: (params: null) => void
1485
+ success?: () => void
1481
1486
  /** 接口调用失败的回调函数 */
1482
1487
  fail?: (params: {
1483
1488
  /** 错误信息 */
@@ -1519,7 +1524,7 @@ declare namespace ty.playnet {
1519
1524
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1520
1525
  complete?: () => void
1521
1526
  /** 接口调用成功的回调函数 */
1522
- success?: (params: null) => void
1527
+ success?: () => void
1523
1528
  /** 接口调用失败的回调函数 */
1524
1529
  fail?: (params: {
1525
1530
  /** 错误信息 */
@@ -1743,6 +1748,11 @@ declare namespace ty.playnet {
1743
1748
  complete?: () => void
1744
1749
  /** 接口调用成功的回调函数 */
1745
1750
  success?: (params: {
1751
+ /**
1752
+ * uuid
1753
+ * @since PlayNetKit 7.9.0
1754
+ */
1755
+ uuid: string
1746
1756
  /**
1747
1757
  * 设备id
1748
1758
  * @since PlayNetKit 1.3.0
@@ -1802,7 +1812,7 @@ declare namespace ty.playnet {
1802
1812
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1803
1813
  complete?: () => void
1804
1814
  /** 接口调用成功的回调函数 */
1805
- success?: (params: null) => void
1815
+ success?: () => void
1806
1816
  /** 接口调用失败的回调函数 */
1807
1817
  fail?: (params: {
1808
1818
  /** 错误信息 */
@@ -1905,7 +1915,7 @@ declare namespace ty.playnet {
1905
1915
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1906
1916
  complete?: () => void
1907
1917
  /** 接口调用成功的回调函数 */
1908
- success?: (params: null) => void
1918
+ success?: () => void
1909
1919
  /** 接口调用失败的回调函数 */
1910
1920
  fail?: (params: {
1911
1921
  /** 错误信息 */
@@ -1949,6 +1959,113 @@ declare namespace ty.playnet {
1949
1959
  }) => void
1950
1960
  }): void
1951
1961
 
1962
+ /**
1963
+ * 获取当前连接Wi-Fi的详细信息
1964
+ * @public
1965
+ * @since PlayNetKit 7.9.0
1966
+ * @platform iOS Android
1967
+ */
1968
+ export function getCurrentWifiInfo(params?: {
1969
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1970
+ complete?: () => void
1971
+ /** 接口调用成功的回调函数 */
1972
+ success?: (params: {
1973
+ /**
1974
+ * 当前连接的Wi-Fi名称
1975
+ * @since PlayNetKit 7.9.0
1976
+ */
1977
+ ssid?: string
1978
+ /**
1979
+ * 当前连接的Wi-Fi BSSID
1980
+ * @since PlayNetKit 7.9.0
1981
+ */
1982
+ bssid?: string
1983
+ /**
1984
+ * 当前Wi-Fi频段
1985
+ * ONLY_24G -> 仅2.4G
1986
+ * ONLY_5G -> 仅5G
1987
+ * BOTH_24G_5G -> 双频同名
1988
+ * UNKNOWN -> 未知
1989
+ * @since PlayNetKit 7.9.0
1990
+ */
1991
+ wifiType?: string
1992
+ /**
1993
+ * 当前Wi-Fi能力串,可用于识别企业网络等
1994
+ * @since PlayNetKit 7.9.0
1995
+ */
1996
+ capabilities?: string
1997
+ }) => void
1998
+ /** 接口调用失败的回调函数 */
1999
+ fail?: (params: {
2000
+ /** 错误信息 */
2001
+ errorMsg: string
2002
+ /** 错误码 */
2003
+ errorCode: string | number
2004
+ /** 错误扩展 */
2005
+ innerError: {
2006
+ /** 错误扩展码 */
2007
+ errorCode: string | number
2008
+ /** 错误扩展信息 */
2009
+ errorMsg: string
2010
+ }
2011
+ }) => void
2012
+ }): void
2013
+
2014
+ /**
2015
+ * 获取当前连接Wi-Fi是否命中已缓存的密码
2016
+ * @public
2017
+ * @since PlayNetKit 7.9.0
2018
+ * @platform iOS Android
2019
+ */
2020
+ export function getCachedCurrentWifiPassword(params?: {
2021
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2022
+ complete?: () => void
2023
+ /** 接口调用成功的回调函数 */
2024
+ success?: (params: CachedWifiPasswordInfo[]) => void
2025
+ /** 接口调用失败的回调函数 */
2026
+ fail?: (params: {
2027
+ /** 错误信息 */
2028
+ errorMsg: string
2029
+ /** 错误码 */
2030
+ errorCode: string | number
2031
+ /** 错误扩展 */
2032
+ innerError: {
2033
+ /** 错误扩展码 */
2034
+ errorCode: string | number
2035
+ /** 错误扩展信息 */
2036
+ errorMsg: string
2037
+ }
2038
+ }) => void
2039
+ }): void
2040
+
2041
+ /**
2042
+ * 打开系统Wi-Fi设置页
2043
+ * Android用于跳转系统选择Wi-Fi;iOS可按平台限制实现为不支持或空操作
2044
+ * @public
2045
+ * @since PlayNetKit 7.9.0
2046
+ * @platform iOS Android
2047
+ */
2048
+ export function openSystemWifiSettings(params?: {
2049
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2050
+ complete?: () => void
2051
+ /** 接口调用成功的回调函数 */
2052
+ success?: () => void
2053
+ /** 接口调用失败的回调函数 */
2054
+ fail?: (params: {
2055
+ /** 错误信息 */
2056
+ errorMsg: string
2057
+ /** 错误码 */
2058
+ errorCode: string | number
2059
+ /** 错误扩展 */
2060
+ innerError: {
2061
+ /** 错误扩展码 */
2062
+ errorCode: string | number
2063
+ /** 错误扩展信息 */
2064
+ errorMsg: string
2065
+ }
2066
+ }) => void
2067
+ }): void
2068
+
1952
2069
  /**
1953
2070
  * 指定时间内扫描对应uuid的设备,扫描结果通过【onBLEScanDeviceWithUUID】事件获取
1954
2071
  * @public
@@ -1982,7 +2099,7 @@ declare namespace ty.playnet {
1982
2099
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1983
2100
  complete?: () => void
1984
2101
  /** 接口调用成功的回调函数 */
1985
- success?: (params: null) => void
2102
+ success?: () => void
1986
2103
  /** 接口调用失败的回调函数 */
1987
2104
  fail?: (params: {
1988
2105
  /** 错误信息 */
@@ -2009,7 +2126,7 @@ declare namespace ty.playnet {
2009
2126
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2010
2127
  complete?: () => void
2011
2128
  /** 接口调用成功的回调函数 */
2012
- success?: (params: null) => void
2129
+ success?: () => void
2013
2130
  /** 接口调用失败的回调函数 */
2014
2131
  fail?: (params: {
2015
2132
  /** 错误信息 */
@@ -2172,89 +2289,702 @@ declare namespace ty.playnet {
2172
2289
  }): void
2173
2290
 
2174
2291
  /**
2175
- * 配网中间态事件
2176
- * @public
2177
- * @since PlayNetKit 1.3.0
2178
- * @platform iOS Android
2179
- */
2180
- export function onActivateIntermediateState(
2181
- listener: (params: IntermediateStateResponse) => void
2182
- ): void
2183
-
2184
- /**
2185
- * 配网中间态事件
2186
- * @public
2187
- * @since PlayNetKit 1.3.0
2188
- * @platform iOS Android
2189
- */
2190
- export function offActivateIntermediateState(
2191
- listener: (params: IntermediateStateResponse) => void
2192
- ): void
2193
-
2194
- /**
2195
- * 扫描到的设备信息
2196
- * @public
2197
- * @since PlayNetKit 1.3.0
2198
- * @platform iOS Android
2199
- */
2200
- export function onScanDeviceInfo(
2201
- listener: (params: ScanDeviceResponse) => void
2202
- ): void
2203
-
2204
- /**
2205
- * 扫描到的设备信息
2292
+ * 启动单设备自发现扫描,扫描结果通过【onSingleDeviceDiscovered】事件持续推送
2206
2293
  * @public
2207
- * @since PlayNetKit 1.3.0
2294
+ * @since PlayNetKit 7.9.0
2208
2295
  * @platform iOS Android
2209
2296
  */
2210
- export function offScanDeviceInfo(
2211
- listener: (params: ScanDeviceResponse) => void
2212
- ): void
2297
+ export function startSingleDeviceDiscovery(params?: {
2298
+ /**
2299
+ * 扫描超时时间,单位秒;不填则持续扫描直到调用stopSingleDeviceDiscovery
2300
+ * @since PlayNetKit 7.9.0
2301
+ */
2302
+ timeout?: number
2303
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2304
+ complete?: () => void
2305
+ /** 接口调用成功的回调函数 */
2306
+ success?: () => void
2307
+ /** 接口调用失败的回调函数 */
2308
+ fail?: (params: {
2309
+ /** 错误信息 */
2310
+ errorMsg: string
2311
+ /** 错误码 */
2312
+ errorCode: string | number
2313
+ /** 错误扩展 */
2314
+ innerError: {
2315
+ /** 错误扩展码 */
2316
+ errorCode: string | number
2317
+ /** 错误扩展信息 */
2318
+ errorMsg: string
2319
+ }
2320
+ }) => void
2321
+ }): void
2213
2322
 
2214
2323
  /**
2215
- * 配网的结果
2324
+ * 停止单设备自发现扫描
2216
2325
  * @public
2217
- * @since PlayNetKit 1.3.0
2326
+ * @since PlayNetKit 7.9.0
2218
2327
  * @platform iOS Android
2219
2328
  */
2220
- export function onDeviceActivateResult(
2221
- listener: (params: DeviceActivateResultResponse) => void
2222
- ): void
2329
+ export function stopSingleDeviceDiscovery(params?: {
2330
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2331
+ complete?: () => void
2332
+ /** 接口调用成功的回调函数 */
2333
+ success?: () => void
2334
+ /** 接口调用失败的回调函数 */
2335
+ fail?: (params: {
2336
+ /** 错误信息 */
2337
+ errorMsg: string
2338
+ /** 错误码 */
2339
+ errorCode: string | number
2340
+ /** 错误扩展 */
2341
+ innerError: {
2342
+ /** 错误扩展码 */
2343
+ errorCode: string | number
2344
+ /** 错误扩展信息 */
2345
+ errorMsg: string
2346
+ }
2347
+ }) => void
2348
+ }): void
2223
2349
 
2224
2350
  /**
2225
- * 配网的结果
2351
+ * 与扫描到的单设备建立蓝牙连接,连接状态通过【onSingleBleConnectionStateChanged】事件推送
2226
2352
  * @public
2227
- * @since PlayNetKit 1.3.0
2353
+ * @since PlayNetKit 7.9.0
2228
2354
  * @platform iOS Android
2229
2355
  */
2230
- export function offDeviceActivateResult(
2231
- listener: (params: DeviceActivateResultResponse) => void
2232
- ): void
2356
+ export function connectSingleBleDevice(params: {
2357
+ /**
2358
+ * 设备uuid,来自onSingleDeviceDiscovered事件
2359
+ * @since PlayNetKit 7.9.0
2360
+ */
2361
+ uuid: string
2362
+ /**
2363
+ * 家庭id
2364
+ * @since PlayNetKit 7.9.0
2365
+ */
2366
+ homeId: number
2367
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2368
+ complete?: () => void
2369
+ /** 接口调用成功的回调函数 */
2370
+ success?: () => void
2371
+ /** 接口调用失败的回调函数 */
2372
+ fail?: (params: {
2373
+ /** 错误信息 */
2374
+ errorMsg: string
2375
+ /** 错误码 */
2376
+ errorCode: string | number
2377
+ /** 错误扩展 */
2378
+ innerError: {
2379
+ /** 错误扩展码 */
2380
+ errorCode: string | number
2381
+ /** 错误扩展信息 */
2382
+ errorMsg: string
2383
+ }
2384
+ }) => void
2385
+ }): void
2233
2386
 
2234
2387
  /**
2235
- * 扫描到设备后进行通知
2388
+ * 断开单设备蓝牙连接并清理会话
2236
2389
  * @public
2237
- * @since PlayNetKit 1.1.0
2390
+ * @since PlayNetKit 7.9.0
2238
2391
  * @platform iOS Android
2239
2392
  */
2240
- export function onBLEScanDevice(
2241
- listener: (params: ScanDevicePacket) => void
2242
- ): void
2393
+ export function disconnectSingleBleDevice(params: {
2394
+ /**
2395
+ * 设备uuid
2396
+ * @since PlayNetKit 7.9.0
2397
+ */
2398
+ uuid: string
2399
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2400
+ complete?: () => void
2401
+ /** 接口调用成功的回调函数 */
2402
+ success?: () => void
2403
+ /** 接口调用失败的回调函数 */
2404
+ fail?: (params: {
2405
+ /** 错误信息 */
2406
+ errorMsg: string
2407
+ /** 错误码 */
2408
+ errorCode: string | number
2409
+ /** 错误扩展 */
2410
+ innerError: {
2411
+ /** 错误扩展码 */
2412
+ errorCode: string | number
2413
+ /** 错误扩展信息 */
2414
+ errorMsg: string
2415
+ }
2416
+ }) => void
2417
+ }): void
2243
2418
 
2244
2419
  /**
2245
- * 扫描到设备后进行通知
2420
+ * 查询单设备当前状态,仅在进入WiFi列表页首次调用;下拉刷新时直接调querySingleDeviceWifiList
2246
2421
  * @public
2247
- * @since PlayNetKit 1.1.0
2422
+ * @since PlayNetKit 7.9.0
2248
2423
  * @platform iOS Android
2249
2424
  */
2250
- export function offBLEScanDevice(
2251
- listener: (params: ScanDevicePacket) => void
2252
- ): void
2425
+ export function querySingleDeviceStatus(params: {
2426
+ /**
2427
+ * 设备uuid
2428
+ * @since PlayNetKit 7.9.0
2429
+ */
2430
+ uuid: string
2431
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2432
+ complete?: () => void
2433
+ /** 接口调用成功的回调函数 */
2434
+ success?: (params: {
2435
+ /**
2436
+ * 设备当前状态
2437
+ * pendingPair -> 待配网
2438
+ * pairing -> 配网中
2439
+ * paired -> 已配网
2440
+ * offline -> 离线
2441
+ * @since PlayNetKit 7.9.0
2442
+ */
2443
+ status: string
2444
+ }) => void
2445
+ /** 接口调用失败的回调函数 */
2446
+ fail?: (params: {
2447
+ /** 错误信息 */
2448
+ errorMsg: string
2449
+ /** 错误码 */
2450
+ errorCode: string | number
2451
+ /** 错误扩展 */
2452
+ innerError: {
2453
+ /** 错误扩展码 */
2454
+ errorCode: string | number
2455
+ /** 错误扩展信息 */
2456
+ errorMsg: string
2457
+ }
2458
+ }) => void
2459
+ }): void
2253
2460
 
2254
2461
  /**
2255
- * wifi状态发生变化
2462
+ * 查询单设备可见WiFi列表,结果通过【onSingleDeviceWifiListUpdated】事件推送;
2463
+ * needActive=true时允许走PlugPlay预激活链路;false时仅查询WiFi列表
2256
2464
  * @public
2257
- * @since PlayNetKit 1.1.0
2465
+ * @since PlayNetKit 7.9.0
2466
+ * @platform iOS Android
2467
+ */
2468
+ export function querySingleDeviceWifiList(params: {
2469
+ /**
2470
+ * 设备uuid
2471
+ * @since PlayNetKit 7.9.0
2472
+ */
2473
+ uuid: string
2474
+ /**
2475
+ * 家庭id
2476
+ * @since PlayNetKit 7.9.0
2477
+ */
2478
+ homeId: number
2479
+ /**
2480
+ * 配网token。needActive=true时必须传,用于PlugPlay预激活
2481
+ * @since PlayNetKit 7.9.0
2482
+ */
2483
+ token?: string
2484
+ /**
2485
+ * 是否允许在查询WiFi列表前触发PlugPlay预激活
2486
+ * true -> 触发预激活并同时查询WiFi列表
2487
+ * false/不传 -> 仅查询WiFi列表
2488
+ * @since PlayNetKit 7.9.0
2489
+ */
2490
+ needActive?: boolean
2491
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2492
+ complete?: () => void
2493
+ /** 接口调用成功的回调函数 */
2494
+ success?: () => void
2495
+ /** 接口调用失败的回调函数 */
2496
+ fail?: (params: {
2497
+ /** 错误信息 */
2498
+ errorMsg: string
2499
+ /** 错误码 */
2500
+ errorCode: string | number
2501
+ /** 错误扩展 */
2502
+ innerError: {
2503
+ /** 错误扩展码 */
2504
+ errorCode: string | number
2505
+ /** 错误扩展信息 */
2506
+ errorMsg: string
2507
+ }
2508
+ }) => void
2509
+ }): void
2510
+
2511
+ /**
2512
+ * 刷新单设备可见WiFi列表,结果通过【onSingleDeviceWifiListUpdated】事件推送;
2513
+ * @public
2514
+ * @since PlayNetKit 7.9.0
2515
+ * @platform iOS Android
2516
+ */
2517
+ export function refreshSingleDeviceWifiList(params: {
2518
+ /**
2519
+ * 设备uuid
2520
+ * @since PlayNetKit 7.9.0
2521
+ */
2522
+ uuid: string
2523
+ /**
2524
+ * 家庭id
2525
+ * @since PlayNetKit 7.9.0
2526
+ */
2527
+ homeId: number
2528
+ /**
2529
+ * 配网token。needActive=true时必须传,用于PlugPlay预激活
2530
+ * @since PlayNetKit 7.9.0
2531
+ */
2532
+ token?: string
2533
+ /**
2534
+ * 是否允许在查询WiFi列表前触发PlugPlay预激活
2535
+ * true -> 触发预激活并同时查询WiFi列表
2536
+ * false/不传 -> 仅查询WiFi列表
2537
+ * @since PlayNetKit 7.9.0
2538
+ */
2539
+ needActive?: boolean
2540
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2541
+ complete?: () => void
2542
+ /** 接口调用成功的回调函数 */
2543
+ success?: () => void
2544
+ /** 接口调用失败的回调函数 */
2545
+ fail?: (params: {
2546
+ /** 错误信息 */
2547
+ errorMsg: string
2548
+ /** 错误码 */
2549
+ errorCode: string | number
2550
+ /** 错误扩展 */
2551
+ innerError: {
2552
+ /** 错误扩展码 */
2553
+ errorCode: string | number
2554
+ /** 错误扩展信息 */
2555
+ errorMsg: string
2556
+ }
2557
+ }) => void
2558
+ }): void
2559
+
2560
+ /**
2561
+ * 下发WiFi或有线配网激活指令,激活过程通过【onSingleActivationProgress】和【onSingleActivationResult】事件推送
2562
+ * ssid/pwd为空时为有线模式(dualGateway路径);非空时为WiFi模式(deviceScanWifi/manualWifi路径)
2563
+ * @public
2564
+ * @since PlayNetKit 7.9.0
2565
+ * @platform iOS Android
2566
+ */
2567
+ export function sendWifiActivation(params: {
2568
+ /**
2569
+ * 主节点(那台已激活、在线的 Beacon+Wi-Fi 设备)的 devId
2570
+ * @since PlayNetKit 7.9.0
2571
+ */
2572
+ relayId?: string
2573
+ /**
2574
+ * 设备uuid
2575
+ * @since PlayNetKit 7.9.0
2576
+ */
2577
+ uuid: string
2578
+ /**
2579
+ * 配网token,通过getPairConfigToken获取
2580
+ * @since PlayNetKit 7.9.0
2581
+ */
2582
+ token: string
2583
+ /**
2584
+ * 家庭id
2585
+ * @since PlayNetKit 7.9.0
2586
+ */
2587
+ homeId: number
2588
+ /**
2589
+ * WiFi名称,有线模式(dualGateway)时不填
2590
+ * @since PlayNetKit 7.9.0
2591
+ */
2592
+ ssid?: string
2593
+ /**
2594
+ * WiFi密码,有线模式(dualGateway)时不填
2595
+ * @since PlayNetKit 7.9.0
2596
+ */
2597
+ pwd?: string
2598
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2599
+ complete?: () => void
2600
+ /** 接口调用成功的回调函数 */
2601
+ success?: () => void
2602
+ /** 接口调用失败的回调函数 */
2603
+ fail?: (params: {
2604
+ /** 错误信息 */
2605
+ errorMsg: string
2606
+ /** 错误码 */
2607
+ errorCode: string | number
2608
+ /** 错误扩展 */
2609
+ innerError: {
2610
+ /** 错误扩展码 */
2611
+ errorCode: string | number
2612
+ /** 错误扩展信息 */
2613
+ errorMsg: string
2614
+ }
2615
+ }) => void
2616
+ }): void
2617
+
2618
+ /**
2619
+ * 下发4G优先激活指令,激活过程通过【onSingleActivationProgress】和【onSingleActivationResult】事件推送
2620
+ * 适用路径:cellular4G
2621
+ * @public
2622
+ * @since PlayNetKit 7.9.0
2623
+ * @platform iOS Android
2624
+ */
2625
+ export function send4GActivation(params: {
2626
+ /**
2627
+ * 设备uuid
2628
+ * @since PlayNetKit 7.9.0
2629
+ */
2630
+ uuid: string
2631
+ /**
2632
+ * 配网token,通过getPairConfigToken获取
2633
+ * @since PlayNetKit 7.9.0
2634
+ */
2635
+ token: string
2636
+ /**
2637
+ * 家庭id
2638
+ * @since PlayNetKit 7.9.0
2639
+ */
2640
+ homeId: number
2641
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2642
+ complete?: () => void
2643
+ /** 接口调用成功的回调函数 */
2644
+ success?: () => void
2645
+ /** 接口调用失败的回调函数 */
2646
+ fail?: (params: {
2647
+ /** 错误信息 */
2648
+ errorMsg: string
2649
+ /** 错误码 */
2650
+ errorCode: string | number
2651
+ /** 错误扩展 */
2652
+ innerError: {
2653
+ /** 错误扩展码 */
2654
+ errorCode: string | number
2655
+ /** 错误扩展信息 */
2656
+ errorMsg: string
2657
+ }
2658
+ }) => void
2659
+ }): void
2660
+
2661
+ /**
2662
+ * 下发PlugPlay蓝牙激活指令,激活过程通过【onSingleActivationProgress】和【onSingleActivationResult】事件推送
2663
+ * 从WiFi路径切入时须复用现有蓝牙连接和token,无需重新调connectSingleBleDevice
2664
+ * 适用路径:plugPlay
2665
+ * @public
2666
+ * @since PlayNetKit 7.9.0
2667
+ * @platform iOS Android
2668
+ */
2669
+ export function sendPlugPlayActivation(params: {
2670
+ /**
2671
+ * 设备uuid
2672
+ * @since PlayNetKit 7.9.0
2673
+ */
2674
+ uuid: string
2675
+ /**
2676
+ * 配网token,通过getPairConfigToken获取
2677
+ * @since PlayNetKit 7.9.0
2678
+ */
2679
+ token: string
2680
+ /**
2681
+ * 家庭id
2682
+ * @since PlayNetKit 7.9.0
2683
+ */
2684
+ homeId: number
2685
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2686
+ complete?: () => void
2687
+ /** 接口调用成功的回调函数 */
2688
+ success?: () => void
2689
+ /** 接口调用失败的回调函数 */
2690
+ fail?: (params: {
2691
+ /** 错误信息 */
2692
+ errorMsg: string
2693
+ /** 错误码 */
2694
+ errorCode: string | number
2695
+ /** 错误扩展 */
2696
+ innerError: {
2697
+ /** 错误扩展码 */
2698
+ errorCode: string | number
2699
+ /** 错误扩展信息 */
2700
+ errorMsg: string
2701
+ }
2702
+ }) => void
2703
+ }): void
2704
+
2705
+ /**
2706
+ * 中止当前设备的激活流程,路径切换或用户取消时调用
2707
+ * 切换到plugPlay前必须先调此方法,避免命令冲突
2708
+ * @public
2709
+ * @since PlayNetKit 7.9.0
2710
+ * @platform iOS Android
2711
+ */
2712
+ export function stopSingleActivation(params: {
2713
+ /**
2714
+ * 设备uuid
2715
+ * @since PlayNetKit 7.9.0
2716
+ */
2717
+ uuid: string
2718
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2719
+ complete?: () => void
2720
+ /** 接口调用成功的回调函数 */
2721
+ success?: () => void
2722
+ /** 接口调用失败的回调函数 */
2723
+ fail?: (params: {
2724
+ /** 错误信息 */
2725
+ errorMsg: string
2726
+ /** 错误码 */
2727
+ errorCode: string | number
2728
+ /** 错误扩展 */
2729
+ innerError: {
2730
+ /** 错误扩展码 */
2731
+ errorCode: string | number
2732
+ /** 错误扩展信息 */
2733
+ errorMsg: string
2734
+ }
2735
+ }) => void
2736
+ }): void
2737
+
2738
+ /**
2739
+ * 通过蓝牙通道向设备下发软重置指令,使设备重新进入配网广播模式
2740
+ * 不断开蓝牙连接,不清除token,仅触发设备侧状态重置
2741
+ * @public
2742
+ * @since PlayNetKit 7.9.0
2743
+ * @platform iOS Android
2744
+ */
2745
+ export function resetSingleBleDevice(params: {
2746
+ /**
2747
+ * 设备uuid
2748
+ * @since PlayNetKit 7.9.0
2749
+ */
2750
+ uuid: string
2751
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2752
+ complete?: () => void
2753
+ /** 接口调用成功的回调函数 */
2754
+ success?: () => void
2755
+ /** 接口调用失败的回调函数 */
2756
+ fail?: (params: {
2757
+ /** 错误信息 */
2758
+ errorMsg: string
2759
+ /** 错误码 */
2760
+ errorCode: string | number
2761
+ /** 错误扩展 */
2762
+ innerError: {
2763
+ /** 错误扩展码 */
2764
+ errorCode: string | number
2765
+ /** 错误扩展信息 */
2766
+ errorMsg: string
2767
+ }
2768
+ }) => void
2769
+ }): void
2770
+
2771
+ /**
2772
+ * 强绑定解绑
2773
+ * @public
2774
+ * @since PlayNetKit 7.9.0
2775
+ * @platform iOS Android
2776
+ */
2777
+ export function goUnbindFeedback(params: {
2778
+ /**
2779
+ * 设备uuid
2780
+ * @since PlayNetKit 7.9.0
2781
+ */
2782
+ uuid: string
2783
+ /** 接口调用成功的回调函数 */
2784
+ success?: () => void
2785
+ /**
2786
+ * 配网成功后的设备id,success为true时有值
2787
+ * @since PlayNetKit 7.9.0
2788
+ */
2789
+ deviceId?: string
2790
+ /**
2791
+ * 错误码,success为false时有值
2792
+ * @since PlayNetKit 7.9.0
2793
+ */
2794
+ errorCode?: number
2795
+ /**
2796
+ * 失败所处阶段(D/E/F/G),success为false时有值
2797
+ * @since PlayNetKit 7.9.0
2798
+ */
2799
+ errorStage?: string
2800
+ /**
2801
+ * 是否可以重试,G阶段账号绑定限制类为false
2802
+ * @since PlayNetKit 7.9.0
2803
+ */
2804
+ canRetry?: boolean
2805
+ /**
2806
+ * 是否可以自动重置设备救回,D/F阶段兜底类为true
2807
+ * @since PlayNetKit 7.9.0
2808
+ */
2809
+ canAutoReset?: boolean
2810
+ /**
2811
+ * 设备名称
2812
+ * @since PlayNetKit 7.9.0
2813
+ */
2814
+ name?: string
2815
+ /**
2816
+ * 设备图标URL
2817
+ * @since PlayNetKit 7.9.0
2818
+ */
2819
+ iconUrl?: string
2820
+ /**
2821
+ * 房间ID
2822
+ * @since PlayNetKit 7.9.0
2823
+ */
2824
+ roomId?: string
2825
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2826
+ complete?: () => void
2827
+ /** 接口调用失败的回调函数 */
2828
+ fail?: (params: {
2829
+ /** 错误信息 */
2830
+ errorMsg: string
2831
+ /** 错误码 */
2832
+ errorCode: string | number
2833
+ /** 错误扩展 */
2834
+ innerError: {
2835
+ /** 错误扩展码 */
2836
+ errorCode: string | number
2837
+ /** 错误扩展信息 */
2838
+ errorMsg: string
2839
+ }
2840
+ }) => void
2841
+ }): void
2842
+
2843
+ /**
2844
+ * 查询当前家庭下的 beacon Wifi Master 节点
2845
+ * @public
2846
+ * @since PlayNetKit 7.9.0
2847
+ * @platform iOS Android
2848
+ */
2849
+ export function queryFlashDistributionNode(params: {
2850
+ /**
2851
+ * 家庭id
2852
+ * @since PlayNetKit 7.9.0
2853
+ */
2854
+ homeId: number
2855
+ /**
2856
+ * ssid
2857
+ * @since PlayNetKit 7.9.0
2858
+ */
2859
+ ssid?: string
2860
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
2861
+ complete?: () => void
2862
+ /** 接口调用成功的回调函数 */
2863
+ success?: () => void
2864
+ /** 接口调用失败的回调函数 */
2865
+ fail?: (params: {
2866
+ /** 错误信息 */
2867
+ errorMsg: string
2868
+ /** 错误码 */
2869
+ errorCode: string | number
2870
+ /** 错误扩展 */
2871
+ innerError: {
2872
+ /** 错误扩展码 */
2873
+ errorCode: string | number
2874
+ /** 错误扩展信息 */
2875
+ errorMsg: string
2876
+ }
2877
+ }) => void
2878
+ }): void
2879
+
2880
+ /**
2881
+ * 配网中间态事件
2882
+ * @public
2883
+ * @since PlayNetKit 1.3.0
2884
+ * @platform iOS Android
2885
+ */
2886
+ export function onActivateIntermediateState(
2887
+ listener: (params: IntermediateStateResponse) => void
2888
+ ): void
2889
+
2890
+ /**
2891
+ * 配网中间态事件
2892
+ * @public
2893
+ * @since PlayNetKit 1.3.0
2894
+ * @example Demo
2895
+ * ```tsx
2896
+ * const listener = function (res) { console.log(res) }
2897
+ * ty.playnet.onActivateIntermediateState(listener)
2898
+ * ty.playnet.offActivateIntermediateState(listener)
2899
+ * ```
2900
+ * @platform iOS Android
2901
+ */
2902
+ export function offActivateIntermediateState(
2903
+ listener: (params: IntermediateStateResponse) => void
2904
+ ): void
2905
+
2906
+ /**
2907
+ * 扫描到的设备信息
2908
+ * @public
2909
+ * @since PlayNetKit 1.3.0
2910
+ * @platform iOS Android
2911
+ */
2912
+ export function onScanDeviceInfo(
2913
+ listener: (params: ScanDeviceResponse) => void
2914
+ ): void
2915
+
2916
+ /**
2917
+ * 扫描到的设备信息
2918
+ * @public
2919
+ * @since PlayNetKit 1.3.0
2920
+ * @example Demo
2921
+ * ```tsx
2922
+ * const listener = function (res) { console.log(res) }
2923
+ * ty.playnet.onScanDeviceInfo(listener)
2924
+ * ty.playnet.offScanDeviceInfo(listener)
2925
+ * ```
2926
+ * @platform iOS Android
2927
+ */
2928
+ export function offScanDeviceInfo(
2929
+ listener: (params: ScanDeviceResponse) => void
2930
+ ): void
2931
+
2932
+ /**
2933
+ * 配网的结果
2934
+ * @public
2935
+ * @since PlayNetKit 1.3.0
2936
+ * @platform iOS Android
2937
+ */
2938
+ export function onDeviceActivateResult(
2939
+ listener: (params: DeviceActivateResultResponse) => void
2940
+ ): void
2941
+
2942
+ /**
2943
+ * 配网的结果
2944
+ * @public
2945
+ * @since PlayNetKit 1.3.0
2946
+ * @example Demo
2947
+ * ```tsx
2948
+ * const listener = function (res) { console.log(res) }
2949
+ * ty.playnet.onDeviceActivateResult(listener)
2950
+ * ty.playnet.offDeviceActivateResult(listener)
2951
+ * ```
2952
+ * @platform iOS Android
2953
+ */
2954
+ export function offDeviceActivateResult(
2955
+ listener: (params: DeviceActivateResultResponse) => void
2956
+ ): void
2957
+
2958
+ /**
2959
+ * 扫描到设备后进行通知
2960
+ * @public
2961
+ * @since PlayNetKit 1.1.0
2962
+ * @platform iOS Android
2963
+ */
2964
+ export function onBLEScanDevice(
2965
+ listener: (params: ScanDevicePacket) => void
2966
+ ): void
2967
+
2968
+ /**
2969
+ * 扫描到设备后进行通知
2970
+ * @public
2971
+ * @since PlayNetKit 1.1.0
2972
+ * @example Demo
2973
+ * ```tsx
2974
+ * const listener = function (res) { console.log(res) }
2975
+ * ty.playnet.onBLEScanDevice(listener)
2976
+ * ty.playnet.offBLEScanDevice(listener)
2977
+ * ```
2978
+ * @platform iOS Android
2979
+ */
2980
+ export function offBLEScanDevice(
2981
+ listener: (params: ScanDevicePacket) => void
2982
+ ): void
2983
+
2984
+ /**
2985
+ * wifi状态发生变化
2986
+ * @public
2987
+ * @since PlayNetKit 1.1.0
2258
2988
  * @platform iOS Android
2259
2989
  */
2260
2990
  export function onWifiStateChange(listener: (params: Privacy) => void): void
@@ -2263,6 +2993,12 @@ declare namespace ty.playnet {
2263
2993
  * wifi状态发生变化
2264
2994
  * @public
2265
2995
  * @since PlayNetKit 1.1.0
2996
+ * @example Demo
2997
+ * ```tsx
2998
+ * const listener = function (res) { console.log(res) }
2999
+ * ty.playnet.onWifiStateChange(listener)
3000
+ * ty.playnet.offWifiStateChange(listener)
3001
+ * ```
2266
3002
  * @platform iOS Android
2267
3003
  */
2268
3004
  export function offWifiStateChange(listener: (params: Privacy) => void): void
@@ -2279,6 +3015,12 @@ declare namespace ty.playnet {
2279
3015
  * 蓝牙状态发生变化
2280
3016
  * @public
2281
3017
  * @since PlayNetKit 1.1.0
3018
+ * @example Demo
3019
+ * ```tsx
3020
+ * const listener = function (res) { console.log(res) }
3021
+ * ty.playnet.onBLEStateChange(listener)
3022
+ * ty.playnet.offBLEStateChange(listener)
3023
+ * ```
2282
3024
  * @platform iOS Android
2283
3025
  */
2284
3026
  export function offBLEStateChange(listener: (params: Privacy) => void): void
@@ -2297,6 +3039,12 @@ declare namespace ty.playnet {
2297
3039
  * 蓝牙权限发生变化
2298
3040
  * @public
2299
3041
  * @since PlayNetKit 1.1.0
3042
+ * @example Demo
3043
+ * ```tsx
3044
+ * const listener = function (res) { console.log(res) }
3045
+ * ty.playnet.onBlePermissionChange(listener)
3046
+ * ty.playnet.offBlePermissionChange(listener)
3047
+ * ```
2300
3048
  * @platform iOS Android
2301
3049
  */
2302
3050
  export function offBlePermissionChange(
@@ -2317,6 +3065,12 @@ declare namespace ty.playnet {
2317
3065
  * 本地网络权限发生变化
2318
3066
  * @public
2319
3067
  * @since PlayNetKit 1.1.0
3068
+ * @example Demo
3069
+ * ```tsx
3070
+ * const listener = function (res) { console.log(res) }
3071
+ * ty.playnet.onlocalNetWorkPermissionChange(listener)
3072
+ * ty.playnet.offlocalNetWorkPermissionChange(listener)
3073
+ * ```
2320
3074
  * @platform iOS Android
2321
3075
  */
2322
3076
  export function offlocalNetWorkPermissionChange(
@@ -2337,6 +3091,12 @@ declare namespace ty.playnet {
2337
3091
  * 老流程配网,阶段上报
2338
3092
  * @public
2339
3093
  * @since PlayNetKit 1.3.0
3094
+ * @example Demo
3095
+ * ```tsx
3096
+ * const listener = function (res) { console.log(res) }
3097
+ * ty.playnet.onReceiveActivatorState(listener)
3098
+ * ty.playnet.offReceiveActivatorState(listener)
3099
+ * ```
2340
3100
  * @platform iOS Android
2341
3101
  */
2342
3102
  export function offReceiveActivatorState(
@@ -2357,12 +3117,200 @@ declare namespace ty.playnet {
2357
3117
  * 扫描到设备后进行通知
2358
3118
  * @public
2359
3119
  * @since PlayNetKit 1.3.0
3120
+ * @example Demo
3121
+ * ```tsx
3122
+ * const listener = function (res) { console.log(res) }
3123
+ * ty.playnet.onBLEScanDeviceWithUUID(listener)
3124
+ * ty.playnet.offBLEScanDeviceWithUUID(listener)
3125
+ * ```
2360
3126
  * @platform iOS Android
2361
3127
  */
2362
3128
  export function offBLEScanDeviceWithUUID(
2363
3129
  listener: (params: ScanDevicePacket) => void
2364
3130
  ): void
2365
3131
 
3132
+ /**
3133
+ * 自发现到新设备时回调
3134
+ * @public
3135
+ * @since PlayNetKit 7.9.0
3136
+ * @platform iOS Android
3137
+ */
3138
+ export function onSingleDeviceDiscovered(
3139
+ listener: (params: SingleDeviceDiscoveredEvent) => void
3140
+ ): void
3141
+
3142
+ /**
3143
+ * 自发现到新设备时回调
3144
+ * @public
3145
+ * @since PlayNetKit 7.9.0
3146
+ * @example Demo
3147
+ * ```tsx
3148
+ * const listener = function (res) { console.log(res) }
3149
+ * ty.playnet.onSingleDeviceDiscovered(listener)
3150
+ * ty.playnet.offSingleDeviceDiscovered(listener)
3151
+ * ```
3152
+ * @platform iOS Android
3153
+ */
3154
+ export function offSingleDeviceDiscovered(
3155
+ listener: (params: SingleDeviceDiscoveredEvent) => void
3156
+ ): void
3157
+
3158
+ /**
3159
+ * 蓝牙连接状态变化回调
3160
+ * @public
3161
+ * @since PlayNetKit 7.9.0
3162
+ * @platform iOS Android
3163
+ */
3164
+ export function onSingleBleConnectionStateChanged(
3165
+ listener: (params: SingleBleConnectionEvent) => void
3166
+ ): void
3167
+
3168
+ /**
3169
+ * 蓝牙连接状态变化回调
3170
+ * @public
3171
+ * @since PlayNetKit 7.9.0
3172
+ * @example Demo
3173
+ * ```tsx
3174
+ * const listener = function (res) { console.log(res) }
3175
+ * ty.playnet.onSingleBleConnectionStateChanged(listener)
3176
+ * ty.playnet.offSingleBleConnectionStateChanged(listener)
3177
+ * ```
3178
+ * @platform iOS Android
3179
+ */
3180
+ export function offSingleBleConnectionStateChanged(
3181
+ listener: (params: SingleBleConnectionEvent) => void
3182
+ ): void
3183
+
3184
+ /**
3185
+ * 单设备可见WiFi列表更新回调,可能多次触发(设备端流式返回)
3186
+ * @public
3187
+ * @since PlayNetKit 7.9.0
3188
+ * @platform iOS Android
3189
+ */
3190
+ export function onSingleDeviceWifiListUpdated(
3191
+ listener: (params: SingleDeviceWifiListEvent) => void
3192
+ ): void
3193
+
3194
+ /**
3195
+ * 单设备可见WiFi列表更新回调,可能多次触发(设备端流式返回)
3196
+ * @public
3197
+ * @since PlayNetKit 7.9.0
3198
+ * @example Demo
3199
+ * ```tsx
3200
+ * const listener = function (res) { console.log(res) }
3201
+ * ty.playnet.onSingleDeviceWifiListUpdated(listener)
3202
+ * ty.playnet.offSingleDeviceWifiListUpdated(listener)
3203
+ * ```
3204
+ * @platform iOS Android
3205
+ */
3206
+ export function offSingleDeviceWifiListUpdated(
3207
+ listener: (params: SingleDeviceWifiListEvent) => void
3208
+ ): void
3209
+
3210
+ /**
3211
+ * 配网中间阶段进度回调
3212
+ * @public
3213
+ * @since PlayNetKit 7.9.0
3214
+ * @platform iOS Android
3215
+ */
3216
+ export function onSingleActivationProgress(
3217
+ listener: (params: SingleActivationProgressEvent) => void
3218
+ ): void
3219
+
3220
+ /**
3221
+ * 配网中间阶段进度回调
3222
+ * @public
3223
+ * @since PlayNetKit 7.9.0
3224
+ * @example Demo
3225
+ * ```tsx
3226
+ * const listener = function (res) { console.log(res) }
3227
+ * ty.playnet.onSingleActivationProgress(listener)
3228
+ * ty.playnet.offSingleActivationProgress(listener)
3229
+ * ```
3230
+ * @platform iOS Android
3231
+ */
3232
+ export function offSingleActivationProgress(
3233
+ listener: (params: SingleActivationProgressEvent) => void
3234
+ ): void
3235
+
3236
+ /**
3237
+ * 配网最终结果回调,每次激活只触发一次
3238
+ * @public
3239
+ * @since PlayNetKit 7.9.0
3240
+ * @platform iOS Android
3241
+ */
3242
+ export function onSingleActivationResult(
3243
+ listener: (params: SingleActivationResultEvent) => void
3244
+ ): void
3245
+
3246
+ /**
3247
+ * 配网最终结果回调,每次激活只触发一次
3248
+ * @public
3249
+ * @since PlayNetKit 7.9.0
3250
+ * @example Demo
3251
+ * ```tsx
3252
+ * const listener = function (res) { console.log(res) }
3253
+ * ty.playnet.onSingleActivationResult(listener)
3254
+ * ty.playnet.offSingleActivationResult(listener)
3255
+ * ```
3256
+ * @platform iOS Android
3257
+ */
3258
+ export function offSingleActivationResult(
3259
+ listener: (params: SingleActivationResultEvent) => void
3260
+ ): void
3261
+
3262
+ /**
3263
+ * Plugplay结果回调
3264
+ * @public
3265
+ * @since PlayNetKit 7.9.0
3266
+ * @platform iOS Android
3267
+ */
3268
+ export function onSingleActivationPlugPlayResult(
3269
+ listener: (params: SingleActivationResultEvent) => void
3270
+ ): void
3271
+
3272
+ /**
3273
+ * Plugplay结果回调
3274
+ * @public
3275
+ * @since PlayNetKit 7.9.0
3276
+ * @example Demo
3277
+ * ```tsx
3278
+ * const listener = function (res) { console.log(res) }
3279
+ * ty.playnet.onSingleActivationPlugPlayResult(listener)
3280
+ * ty.playnet.offSingleActivationPlugPlayResult(listener)
3281
+ * ```
3282
+ * @platform iOS Android
3283
+ */
3284
+ export function offSingleActivationPlugPlayResult(
3285
+ listener: (params: SingleActivationResultEvent) => void
3286
+ ): void
3287
+
3288
+ /**
3289
+ * wifi 发生变化
3290
+ * @public
3291
+ * @since PlayNetKit 7.9.0
3292
+ * @platform iOS Android
3293
+ */
3294
+ export function onReachabilityChanged(
3295
+ listener: (params: Record<string, any>) => void
3296
+ ): void
3297
+
3298
+ /**
3299
+ * wifi 发生变化
3300
+ * @public
3301
+ * @since PlayNetKit 7.9.0
3302
+ * @example Demo
3303
+ * ```tsx
3304
+ * const listener = function (res) { console.log(res) }
3305
+ * ty.playnet.onReachabilityChanged(listener)
3306
+ * ty.playnet.offReachabilityChanged(listener)
3307
+ * ```
3308
+ * @platform iOS Android
3309
+ */
3310
+ export function offReachabilityChanged(
3311
+ listener: (params: Record<string, any>) => void
3312
+ ): void
3313
+
2366
3314
  /** @since PlayNetKit 1.3.0 */
2367
3315
  export interface ScanParams {
2368
3316
  /**
@@ -2429,7 +3377,7 @@ declare namespace ty.playnet {
2429
3377
  */
2430
3378
  icon?: string
2431
3379
  /**
2432
- * 设备icon
3380
+ * 产品 ID(Product ID)
2433
3381
  * @since PlayNetKit 1.3.0
2434
3382
  * @defaultValue ""
2435
3383
  */
@@ -2456,7 +3404,7 @@ declare namespace ty.playnet {
2456
3404
  */
2457
3405
  isThingMatter?: boolean
2458
3406
  /**
2459
- * 错误码,0-为成功
3407
+ * 扫描异常时的错误码,成功或未出错时可不传;0 表示无错误
2460
3408
  * @since PlayNetKit 1.3.0
2461
3409
  */
2462
3410
  errorCode?: string
@@ -2509,93 +3457,93 @@ declare namespace ty.playnet {
2509
3457
  /** @since PlayNetKit 1.3.0 */
2510
3458
  export interface HgwBean {
2511
3459
  /**
2512
- * ip
3460
+ * 网关 IP 地址
2513
3461
  * @since PlayNetKit 1.3.0
2514
3462
  */
2515
3463
  ip: string
2516
3464
  /**
2517
- * gwId
3465
+ * 网关设备 ID
2518
3466
  * @since PlayNetKit 1.3.0
2519
3467
  */
2520
3468
  gwId: string
2521
3469
  /**
2522
- * active
3470
+ * 激活状态
2523
3471
  * @since PlayNetKit 1.3.0
2524
3472
  */
2525
3473
  active?: number
2526
3474
  /**
2527
- * ablilty
3475
+ * 能力位(字段名 ablilty 为历史拼写)
2528
3476
  * @since PlayNetKit 1.3.0
2529
3477
  */
2530
3478
  ablilty?: number
2531
3479
  /**
2532
- * lastSeenTime
3480
+ * 最后一次被发现的时间戳
2533
3481
  * @since PlayNetKit 1.3.0
2534
3482
  */
2535
3483
  lastSeenTime?: number
2536
3484
  /**
2537
- * mode
3485
+ * 工作模式
2538
3486
  * @since PlayNetKit 1.3.0
2539
3487
  */
2540
3488
  mode?: number
2541
3489
  /**
2542
- * productKey
3490
+ * 产品 Key
2543
3491
  * @since PlayNetKit 1.3.0
2544
3492
  */
2545
3493
  productKey?: string
2546
3494
  /**
2547
- * encrypt
3495
+ * 是否加密通信
2548
3496
  * @since PlayNetKit 1.3.0
2549
3497
  */
2550
3498
  encrypt?: boolean
2551
3499
  /**
2552
- * version
3500
+ * 协议版本号
2553
3501
  * @since PlayNetKit 1.3.0
2554
3502
  */
2555
3503
  version: string
2556
3504
  /**
2557
- * token
3505
+ * 是否支持 Token 配网
2558
3506
  * @since PlayNetKit 1.3.0
2559
3507
  */
2560
3508
  token?: boolean
2561
3509
  /**
2562
- * wf_cfg
3510
+ * 是否支持 Wi-Fi 配置
2563
3511
  * @since PlayNetKit 1.3.0
2564
3512
  */
2565
3513
  wf_cfg?: boolean
2566
3514
  /**
2567
- * extend
3515
+ * 扩展信息
2568
3516
  * @since PlayNetKit 1.3.0
2569
3517
  */
2570
3518
  extend?: string
2571
3519
  /**
2572
- * ssid
3520
+ * 网关当前连接的 Wi-Fi 名称
2573
3521
  * @since PlayNetKit 1.3.0
2574
3522
  */
2575
3523
  ssid?: string
2576
3524
  /**
2577
- * devConfigAttribute
3525
+ * 设备配置属性
2578
3526
  * @since PlayNetKit 1.3.0
2579
3527
  */
2580
3528
  devConfigAttribute?: number
2581
3529
  /**
2582
- * apConfigType
3530
+ * AP 配网类型
2583
3531
  * @since PlayNetKit 1.3.0
2584
3532
  */
2585
3533
  apConfigType?: number
2586
3534
  /**
2587
- * sl
3535
+ * 信号强度等级
2588
3536
  * @since PlayNetKit 1.3.0
2589
3537
  * @defaultValue -1
2590
3538
  */
2591
3539
  sl?: number
2592
3540
  /**
2593
- * uuid
3541
+ * 设备 UUID
2594
3542
  * @since PlayNetKit 1.3.0
2595
3543
  */
2596
3544
  uuid?: string
2597
3545
  /**
2598
- * proAbility
3546
+ * 产品能力位
2599
3547
  * @since PlayNetKit 1.3.0
2600
3548
  */
2601
3549
  proAbility?: number
@@ -2604,17 +3552,17 @@ declare namespace ty.playnet {
2604
3552
  /** @since PlayNetKit 1.3.0 */
2605
3553
  export interface MatterQrCodeInfo {
2606
3554
  /**
2607
- * tag
3555
+ * QR 码 TLV 标签
2608
3556
  * @since PlayNetKit 1.3.0
2609
3557
  */
2610
3558
  tag?: number
2611
3559
  /**
2612
- * intDataValue
3560
+ * 整型数据值
2613
3561
  * @since PlayNetKit 1.3.0
2614
3562
  */
2615
3563
  intDataValue?: number
2616
3564
  /**
2617
- * data
3565
+ * 字符串数据值
2618
3566
  * @since PlayNetKit 1.3.0
2619
3567
  */
2620
3568
  data?: string
@@ -2629,12 +3577,12 @@ declare namespace ty.playnet {
2629
3577
  /** @since PlayNetKit 1.3.0 */
2630
3578
  export interface Discriminator {
2631
3579
  /**
2632
- * value
3580
+ * 鉴别码数值
2633
3581
  * @since PlayNetKit 1.3.0
2634
3582
  */
2635
3583
  value?: number
2636
3584
  /**
2637
- * shortDiscriminator
3585
+ * 是否为短鉴别码(12 bit)
2638
3586
  * @since PlayNetKit 1.3.0
2639
3587
  */
2640
3588
  shortDiscriminator?: boolean
@@ -2643,42 +3591,42 @@ declare namespace ty.playnet {
2643
3591
  /** @since PlayNetKit 1.3.0 */
2644
3592
  export interface SetupPayload {
2645
3593
  /**
2646
- * version
3594
+ * Matter Setup Payload 版本号
2647
3595
  * @since PlayNetKit 1.3.0
2648
3596
  */
2649
3597
  version?: number
2650
3598
  /**
2651
- * vendorId
3599
+ * Matter 厂商 ID(Vendor ID)
2652
3600
  * @since PlayNetKit 1.3.0
2653
3601
  */
2654
3602
  vendorId?: number
2655
3603
  /**
2656
- * productId
3604
+ * Matter 产品 ID(Product ID)
2657
3605
  * @since PlayNetKit 1.3.0
2658
3606
  */
2659
3607
  productId?: number
2660
3608
  /**
2661
- * setupPinCode
3609
+ * Matter 配网 PIN 码
2662
3610
  * @since PlayNetKit 1.3.0
2663
3611
  */
2664
3612
  setupPinCode?: number
2665
3613
  /**
2666
- * commissioningFlow
3614
+ * Matter 配网流程类型(Commissioning Flow)
2667
3615
  * @since PlayNetKit 1.3.0
2668
3616
  */
2669
3617
  commissioningFlow?: number
2670
3618
  /**
2671
- * optionalQrCodeInfoMap
3619
+ * QR 码可选 TLV 信息映射
2672
3620
  * @since PlayNetKit 1.3.0
2673
3621
  */
2674
3622
  optionalQrCodeInfoMap?: Record<number, MatterQrCodeInfo>
2675
3623
  /**
2676
- * discoveryCapabilities
3624
+ * 设备发现能力列表
2677
3625
  * @since PlayNetKit 1.3.0
2678
3626
  */
2679
3627
  discoveryCapabilities?: number[]
2680
3628
  /**
2681
- * commissioningFlow
3629
+ * Matter 鉴别码(Discriminator)
2682
3630
  * @since PlayNetKit 1.3.0
2683
3631
  */
2684
3632
  discriminator?: Discriminator
@@ -2693,37 +3641,37 @@ declare namespace ty.playnet {
2693
3641
  */
2694
3642
  discoveryType?: string
2695
3643
  /**
2696
- * port
3644
+ * 设备通信端口
2697
3645
  * @since PlayNetKit 1.3.0
2698
3646
  */
2699
3647
  port?: number
2700
3648
  /**
2701
- * ipAddress
3649
+ * 设备 IP 地址
2702
3650
  * @since PlayNetKit 1.3.0
2703
3651
  */
2704
3652
  ipAddress?: string
2705
3653
  /**
2706
- * uuid
3654
+ * 设备 UUID
2707
3655
  * @since PlayNetKit 1.3.0
2708
3656
  */
2709
3657
  uuid?: string
2710
3658
  /**
2711
- * thingProductId
3659
+ * 涂鸦产品 ID
2712
3660
  * @since PlayNetKit 1.3.0
2713
3661
  */
2714
3662
  thingProductId?: string
2715
3663
  /**
2716
- * accessType
3664
+ * Matter 接入类型
2717
3665
  * @since PlayNetKit 1.3.0
2718
3666
  */
2719
3667
  accessType?: number
2720
3668
  /**
2721
- * nodeId
3669
+ * Matter 节点 ID
2722
3670
  * @since PlayNetKit 1.3.0
2723
3671
  */
2724
3672
  nodeId?: number
2725
3673
  /**
2726
- * isThingMatter
3674
+ * 是否为涂鸦 Matter 设备
2727
3675
  * @since PlayNetKit 1.3.0
2728
3676
  */
2729
3677
  isThingMatter?: boolean
@@ -2743,74 +3691,73 @@ declare namespace ty.playnet {
2743
3691
  /** @since PlayNetKit 1.3.0 */
2744
3692
  export interface ScanDeviceBean {
2745
3693
  /**
2746
- * id
3694
+ * 设备唯一标识
2747
3695
  * @since PlayNetKit 1.3.0
2748
3696
  */
2749
3697
  id?: string
2750
3698
  /**
2751
- * name
3699
+ * 设备名称
2752
3700
  * @since PlayNetKit 1.3.0
2753
3701
  */
2754
3702
  name?: string
2755
3703
  /**
2756
- * providerName
3704
+ * 设备提供商名称
2757
3705
  * @since PlayNetKit 1.3.0
2758
3706
  */
2759
3707
  providerName?: string
2760
3708
  /**
2761
- * data
3709
+ * 设备原始扫描数据
2762
3710
  * @since PlayNetKit 1.3.0
2763
3711
  */
2764
3712
  data?: string
2765
3713
  /**
2766
- * configType
3714
+ * 配网配置类型
2767
3715
  * @since PlayNetKit 1.3.0
2768
3716
  */
2769
3717
  configType?: string
2770
3718
  /**
2771
- * productId
3719
+ * 产品 ID
2772
3720
  * @since PlayNetKit 1.3.0
2773
3721
  */
2774
3722
  productId?: string
2775
3723
  /**
2776
- * uuid
3724
+ * 设备 UUID
2777
3725
  * @since PlayNetKit 1.3.0
2778
3726
  */
2779
3727
  uuid?: string
2780
3728
  /**
2781
- * mac
3729
+ * 设备 MAC 地址
2782
3730
  * @since PlayNetKit 1.3.0
2783
3731
  */
2784
3732
  mac?: string
2785
3733
  /**
2786
- * address
3734
+ * 设备网络地址
2787
3735
  * @since PlayNetKit 1.3.0
2788
3736
  */
2789
3737
  address?: string
2790
3738
  /**
2791
- * deviceType
3739
+ * 设备类型
2792
3740
  * @since PlayNetKit 1.3.0
2793
3741
  */
2794
3742
  deviceType?: number
2795
3743
  /**
2796
- * isbind
3744
+ * 是否已绑定
2797
3745
  * @since PlayNetKit 1.3.0
2798
3746
  */
2799
3747
  isbind?: boolean
2800
3748
  /**
2801
- * flag
3749
+ * 设备标志位
2802
3750
  * @since PlayNetKit 1.3.0
2803
3751
  * @defaultValue 0
2804
3752
  */
2805
3753
  flag?: number
2806
3754
  /**
2807
- * /**
2808
- * isShare
3755
+ * 是否为共享设备
2809
3756
  * @since PlayNetKit 1.3.0
2810
3757
  */
2811
3758
  isShare?: boolean
2812
3759
  /**
2813
- * isRoam
3760
+ * 是否为漫游设备
2814
3761
  * @since PlayNetKit 1.3.0
2815
3762
  */
2816
3763
  isRoam?: boolean
@@ -2948,7 +3895,7 @@ declare namespace ty.playnet {
2948
3895
  */
2949
3896
  matterPayload?: SetupPayload
2950
3897
  /**
2951
- * connectResult
3898
+ * Matter 设备连接结果,connectMatterDevice 成功后传入以继续配网
2952
3899
  * @since PlayNetKit 1.3.0
2953
3900
  */
2954
3901
  connectResult?: ConnectResult
@@ -2961,7 +3908,7 @@ declare namespace ty.playnet {
2961
3908
  * 目前 子设备配网是否是通过自发现配网 会添加到内部
2962
3909
  * @since PlayNetKit 1.3.0
2963
3910
  */
2964
- extensions?: Record<string, {}>
3911
+ extensions?: Record<string, Record<string, any>>
2965
3912
  /**
2966
3913
  * 二维码信息 matter配网使用
2967
3914
  * @since PlayNetKit 1.3.0
@@ -3079,7 +4026,7 @@ declare namespace ty.playnet {
3079
4026
  */
3080
4027
  ssid?: string
3081
4028
  /**
3082
- * i-Fi信号强度
4029
+ * Wi-Fi 信号强度,单位 dBm,数值越大信号越强
3083
4030
  * @since PlayNetKit 1.3.0
3084
4031
  * @defaultValue 0
3085
4032
  */
@@ -3123,12 +4070,12 @@ declare namespace ty.playnet {
3123
4070
  */
3124
4071
  uuid: string
3125
4072
  /**
3126
- * 配网阶段
4073
+ * 配网阶段编号,用于标识当前配网流程所处的阶段
3127
4074
  * @since PlayNetKit 1.3.0
3128
4075
  */
3129
4076
  configStage: number
3130
4077
  /**
3131
- * 状态
4078
+ * 配网中间态状态码,与 configStage 配合表示当前进度或结果
3132
4079
  * @since PlayNetKit 1.3.0
3133
4080
  */
3134
4081
  state: number
@@ -3495,6 +4442,11 @@ declare namespace ty.playnet {
3495
4442
 
3496
4443
  /** @since PlayNetKit 1.1.0 */
3497
4444
  export interface DeviceInfo {
4445
+ /**
4446
+ * uuid
4447
+ * @since PlayNetKit 7.9.0
4448
+ */
4449
+ uuid: string
3498
4450
  /**
3499
4451
  * 设备id
3500
4452
  * @since PlayNetKit 1.1.0
@@ -3767,6 +4719,53 @@ declare namespace ty.playnet {
3767
4719
  capabilities: string
3768
4720
  }
3769
4721
 
4722
+ /** @since PlayNetKit 7.9.0 */
4723
+ export interface CurrentWifiInfo {
4724
+ /**
4725
+ * 当前连接的Wi-Fi名称
4726
+ * @since PlayNetKit 7.9.0
4727
+ */
4728
+ ssid?: string
4729
+ /**
4730
+ * 当前连接的Wi-Fi BSSID
4731
+ * @since PlayNetKit 7.9.0
4732
+ */
4733
+ bssid?: string
4734
+ /**
4735
+ * 当前Wi-Fi频段
4736
+ * ONLY_24G -> 仅2.4G
4737
+ * ONLY_5G -> 仅5G
4738
+ * BOTH_24G_5G -> 双频同名
4739
+ * UNKNOWN -> 未知
4740
+ * @since PlayNetKit 7.9.0
4741
+ */
4742
+ wifiType?: string
4743
+ /**
4744
+ * 当前Wi-Fi能力串,可用于识别企业网络等
4745
+ * @since PlayNetKit 7.9.0
4746
+ */
4747
+ capabilities?: string
4748
+ }
4749
+
4750
+ /** @since PlayNetKit 7.9.0 */
4751
+ export interface CachedWifiPasswordInfo {
4752
+ /**
4753
+ * 当前连接Wi-Fi是否命中已缓存密码
4754
+ * @since PlayNetKit 7.9.0
4755
+ */
4756
+ hit: boolean
4757
+ /**
4758
+ * 命中时返回缓存ssid
4759
+ * @since PlayNetKit 7.9.0
4760
+ */
4761
+ ssid?: string
4762
+ /**
4763
+ * 命中时返回缓存password
4764
+ * @since PlayNetKit 7.9.0
4765
+ */
4766
+ password?: string
4767
+ }
4768
+
3770
4769
  /** @since PlayNetKit 1.3.0 */
3771
4770
  export interface BLEScanMatchParam {
3772
4771
  /**
@@ -3873,4 +4872,389 @@ declare namespace ty.playnet {
3873
4872
  */
3874
4873
  devId?: string
3875
4874
  }
4875
+
4876
+ /** @since PlayNetKit 7.9.0 */
4877
+ export interface SingleDeviceDiscoveryParam {
4878
+ /**
4879
+ * 扫描超时时间,单位秒;不填则持续扫描直到调用stopSingleDeviceDiscovery
4880
+ * @since PlayNetKit 7.9.0
4881
+ */
4882
+ timeout?: number
4883
+ }
4884
+
4885
+ /** @since PlayNetKit 7.9.0 */
4886
+ export interface SingleBleConnectParam {
4887
+ /**
4888
+ * 设备uuid,来自onSingleDeviceDiscovered事件
4889
+ * @since PlayNetKit 7.9.0
4890
+ */
4891
+ uuid: string
4892
+ /**
4893
+ * 家庭id
4894
+ * @since PlayNetKit 7.9.0
4895
+ */
4896
+ homeId: number
4897
+ }
4898
+
4899
+ /** @since PlayNetKit 7.9.0 */
4900
+ export interface SingleStopParam {
4901
+ /**
4902
+ * 设备uuid
4903
+ * @since PlayNetKit 7.9.0
4904
+ */
4905
+ uuid: string
4906
+ }
4907
+
4908
+ /** @since PlayNetKit 7.9.0 */
4909
+ export interface SingleDeviceStatusParam {
4910
+ /**
4911
+ * 设备uuid
4912
+ * @since PlayNetKit 7.9.0
4913
+ */
4914
+ uuid: string
4915
+ }
4916
+
4917
+ /** @since PlayNetKit 7.9.0 */
4918
+ export interface SingleDeviceStatusResult {
4919
+ /**
4920
+ * 设备当前状态
4921
+ * pendingPair -> 待配网
4922
+ * pairing -> 配网中
4923
+ * paired -> 已配网
4924
+ * offline -> 离线
4925
+ * @since PlayNetKit 7.9.0
4926
+ */
4927
+ status: string
4928
+ }
4929
+
4930
+ /** @since PlayNetKit 7.9.0 */
4931
+ export interface SingleDeviceWifiQueryParam {
4932
+ /**
4933
+ * 设备uuid
4934
+ * @since PlayNetKit 7.9.0
4935
+ */
4936
+ uuid: string
4937
+ /**
4938
+ * 家庭id
4939
+ * @since PlayNetKit 7.9.0
4940
+ */
4941
+ homeId: number
4942
+ /**
4943
+ * 配网token。needActive=true时必须传,用于PlugPlay预激活
4944
+ * @since PlayNetKit 7.9.0
4945
+ */
4946
+ token?: string
4947
+ /**
4948
+ * 是否允许在查询WiFi列表前触发PlugPlay预激活
4949
+ * true -> 触发预激活并同时查询WiFi列表
4950
+ * false/不传 -> 仅查询WiFi列表
4951
+ * @since PlayNetKit 7.9.0
4952
+ */
4953
+ needActive?: boolean
4954
+ }
4955
+
4956
+ /** @since PlayNetKit 7.9.0 */
4957
+ export interface SingleActivationWifiParam {
4958
+ /**
4959
+ * 主节点(那台已激活、在线的 Beacon+Wi-Fi 设备)的 devId
4960
+ * @since PlayNetKit 7.9.0
4961
+ */
4962
+ relayId?: string
4963
+ /**
4964
+ * 设备uuid
4965
+ * @since PlayNetKit 7.9.0
4966
+ */
4967
+ uuid: string
4968
+ /**
4969
+ * 配网token,通过getPairConfigToken获取
4970
+ * @since PlayNetKit 7.9.0
4971
+ */
4972
+ token: string
4973
+ /**
4974
+ * 家庭id
4975
+ * @since PlayNetKit 7.9.0
4976
+ */
4977
+ homeId: number
4978
+ /**
4979
+ * WiFi名称,有线模式(dualGateway)时不填
4980
+ * @since PlayNetKit 7.9.0
4981
+ */
4982
+ ssid?: string
4983
+ /**
4984
+ * WiFi密码,有线模式(dualGateway)时不填
4985
+ * @since PlayNetKit 7.9.0
4986
+ */
4987
+ pwd?: string
4988
+ }
4989
+
4990
+ /** @since PlayNetKit 7.9.0 */
4991
+ export interface SingleActivation4GParam {
4992
+ /**
4993
+ * 设备uuid
4994
+ * @since PlayNetKit 7.9.0
4995
+ */
4996
+ uuid: string
4997
+ /**
4998
+ * 配网token,通过getPairConfigToken获取
4999
+ * @since PlayNetKit 7.9.0
5000
+ */
5001
+ token: string
5002
+ /**
5003
+ * 家庭id
5004
+ * @since PlayNetKit 7.9.0
5005
+ */
5006
+ homeId: number
5007
+ }
5008
+
5009
+ /** @since PlayNetKit 7.9.0 */
5010
+ export interface SingleActivationPlugPlayParam {
5011
+ /**
5012
+ * 设备uuid
5013
+ * @since PlayNetKit 7.9.0
5014
+ */
5015
+ uuid: string
5016
+ /**
5017
+ * 配网token,通过getPairConfigToken获取
5018
+ * @since PlayNetKit 7.9.0
5019
+ */
5020
+ token: string
5021
+ /**
5022
+ * 家庭id
5023
+ * @since PlayNetKit 7.9.0
5024
+ */
5025
+ homeId: number
5026
+ }
5027
+
5028
+ /** @since PlayNetKit 7.9.0 */
5029
+ export interface SingleActivationResultEvent {
5030
+ /**
5031
+ * 设备uuid
5032
+ * @since PlayNetKit 7.9.0
5033
+ */
5034
+ uuid: string
5035
+ /**
5036
+ * 是否配网成功
5037
+ * @since PlayNetKit 7.9.0
5038
+ */
5039
+ success: boolean
5040
+ /**
5041
+ * 配网成功后的设备id,success为true时有值
5042
+ * @since PlayNetKit 7.9.0
5043
+ */
5044
+ deviceId?: string
5045
+ /**
5046
+ * 错误码,success为false时有值
5047
+ * @since PlayNetKit 7.9.0
5048
+ */
5049
+ errorCode?: number
5050
+ /**
5051
+ * 失败所处阶段(D/E/F/G),success为false时有值
5052
+ * @since PlayNetKit 7.9.0
5053
+ */
5054
+ errorStage?: string
5055
+ /**
5056
+ * 是否可以重试,G阶段账号绑定限制类为false
5057
+ * @since PlayNetKit 7.9.0
5058
+ */
5059
+ canRetry?: boolean
5060
+ /**
5061
+ * 是否可以自动重置设备救回,D/F阶段兜底类为true
5062
+ * @since PlayNetKit 7.9.0
5063
+ */
5064
+ canAutoReset?: boolean
5065
+ /**
5066
+ * 设备名称
5067
+ * @since PlayNetKit 7.9.0
5068
+ */
5069
+ name?: string
5070
+ /**
5071
+ * 设备图标URL
5072
+ * @since PlayNetKit 7.9.0
5073
+ */
5074
+ iconUrl?: string
5075
+ /**
5076
+ * 房间ID
5077
+ * @since PlayNetKit 7.9.0
5078
+ */
5079
+ roomId?: string
5080
+ }
5081
+
5082
+ /** @since PlayNetKit 7.9.0 */
5083
+ export interface DistributionNodeInfo {
5084
+ /**
5085
+ * 家庭id
5086
+ * @since PlayNetKit 7.9.0
5087
+ */
5088
+ homeId: number
5089
+ /**
5090
+ * ssid
5091
+ * @since PlayNetKit 7.9.0
5092
+ */
5093
+ ssid?: string
5094
+ }
5095
+
5096
+ /** @since PlayNetKit 7.9.0 */
5097
+ export interface SingleDeviceDiscoveredEvent {
5098
+ /**
5099
+ * 设备uuid
5100
+ * @since PlayNetKit 7.9.0
5101
+ */
5102
+ uuid: string
5103
+ /**
5104
+ * 设备mac地址
5105
+ * @since PlayNetKit 7.9.0
5106
+ */
5107
+ mac: string
5108
+ /**
5109
+ * 产品id
5110
+ * @since PlayNetKit 7.9.0
5111
+ */
5112
+ productId: string
5113
+ /**
5114
+ * 设备名称
5115
+ * @since PlayNetKit 7.9.0
5116
+ */
5117
+ name: string
5118
+ /**
5119
+ * 设备类型,用于上层分发配网路径
5120
+ * @since PlayNetKit 7.9.0
5121
+ */
5122
+ deviceType: number
5123
+ /**
5124
+ * 信号强度
5125
+ * @since PlayNetKit 7.9.0
5126
+ */
5127
+ rssi: number
5128
+ /**
5129
+ * 配网类型
5130
+ * @since PlayNetKit 7.9.0
5131
+ */
5132
+ configType: string
5133
+ /**
5134
+ * 设备蓝牙地址
5135
+ * @since PlayNetKit 7.9.0
5136
+ */
5137
+ address: string
5138
+ /**
5139
+ * 归一化后的设备能力集合,供小程序做path分发
5140
+ * CELLULAR_4G_PREFER -> 4G优先
5141
+ * WIFI_LIST_SCAN -> 支持设备端扫描WiFi列表
5142
+ * PLUG_PLAY -> 支持PlugPlay兜底
5143
+ * DUAL_GATEWAY -> 支持双联网关
5144
+ * SUPPORT_5G -> 支持5G
5145
+ * @since PlayNetKit 7.9.0
5146
+ */
5147
+ caps?: string[]
5148
+ /**
5149
+ * 是否支持PlugPlay
5150
+ * @since PlayNetKit 7.9.0
5151
+ */
5152
+ supportPlugPlay?: boolean
5153
+ /**
5154
+ * 是否支持5G
5155
+ * @since PlayNetKit 7.9.0
5156
+ */
5157
+ support5G?: boolean
5158
+ /**
5159
+ * 是否支持4G优先激活
5160
+ * @since PlayNetKit 7.9.0
5161
+ */
5162
+ support4G?: boolean
5163
+ /**
5164
+ * 是否支持双联网关
5165
+ * @since PlayNetKit 7.9.0
5166
+ */
5167
+ supportDualGateway?: boolean
5168
+ /**
5169
+ * 是否支持 Beacon+Wi-Fi(闪电分发),供上层判定是否走 WiFi+Beacon 设备配网路径
5170
+ * @since PlayNetKit 7.9.0
5171
+ */
5172
+ isBeaconWifi?: boolean
5173
+ }
5174
+
5175
+ /** @since PlayNetKit 7.9.0 */
5176
+ export interface SingleBleConnectionEvent {
5177
+ /**
5178
+ * 设备uuid
5179
+ * @since PlayNetKit 7.9.0
5180
+ */
5181
+ uuid: string
5182
+ /**
5183
+ * 连接状态
5184
+ * connecting -> 连接中
5185
+ * connected -> 已连接
5186
+ * disconnected -> 已断开
5187
+ * failed -> 连接失败
5188
+ * @since PlayNetKit 7.9.0
5189
+ */
5190
+ state: string
5191
+ /**
5192
+ * 错误码,仅在state为failed时有值
5193
+ * @since PlayNetKit 7.9.0
5194
+ */
5195
+ errorCode?: number
5196
+ /**
5197
+ * 强绑定(DEVICE_ALREADY_BIND)失败时,服务端回带的云端真实设备 devId。
5198
+ * 小程序「提交解绑申请」(goUnbindFeedback) 需要它作为 hdId 拉起解绑反馈页。
5199
+ * 仅在 state 为 failed 且 errorCode 为 207228 时有值。
5200
+ * 注:TUNI 错误通道只透传 errorCode/errorMsg,模型无法随 reject 下发,故挂在本事件上。
5201
+ * @since PlayNetKit 7.9.0
5202
+ */
5203
+ boundDeviceId?: string
5204
+ /**
5205
+ * 强绑定失败时云端真实设备名称(展示用,可空)。
5206
+ * @since PlayNetKit 7.9.0
5207
+ */
5208
+ boundDeviceName?: string
5209
+ /**
5210
+ * 强绑定失败时云端真实设备图标 URL(展示用,可空)。
5211
+ * @since PlayNetKit 7.9.0
5212
+ */
5213
+ boundDeviceIconUrl?: string
5214
+ }
5215
+
5216
+ /** @since PlayNetKit 7.9.0 */
5217
+ export interface SingleDeviceWifiListEvent {
5218
+ /**
5219
+ * 设备uuid
5220
+ * @since PlayNetKit 7.9.0
5221
+ */
5222
+ uuid: string
5223
+ /**
5224
+ * 设备可见的WiFi列表
5225
+ * @since PlayNetKit 7.9.0
5226
+ */
5227
+ wifiList: WiFiInfo[]
5228
+ }
5229
+
5230
+ /** @since PlayNetKit 7.9.0 */
5231
+ export interface SingleActivationProgressEvent {
5232
+ /**
5233
+ * 设备uuid
5234
+ * @since PlayNetKit 7.9.0
5235
+ */
5236
+ uuid: string
5237
+ /**
5238
+ * 配网阶段标识
5239
+ * A -> 设备发现
5240
+ * B -> 蓝牙连接
5241
+ * C -> 鉴权
5242
+ * D -> 下发WiFi凭证
5243
+ * E -> 设备联网
5244
+ * F -> 云端激活
5245
+ * G -> 绑定限制
5246
+ * @since PlayNetKit 7.9.0
5247
+ */
5248
+ stage: string
5249
+ /**
5250
+ * 阶段状态描述
5251
+ * @since PlayNetKit 7.9.0
5252
+ */
5253
+ status: string
5254
+ /**
5255
+ * 标准化进度百分比,取值范围0-100;无明确百分比时可不传
5256
+ * @since PlayNetKit 7.9.0
5257
+ */
5258
+ percent?: number
5259
+ }
3876
5260
  }