@ray-js/api 1.7.79 → 1.7.80

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.
Files changed (56) hide show
  1. package/@types/AIKit.d.ts +1140 -1009
  2. package/@types/AVideoKit.d.ts +26 -101
  3. package/@types/BaseKit.d.ts +234 -210
  4. package/@types/BizKit.d.ts +271 -296
  5. package/@types/DeviceKit.d.ts +57 -88
  6. package/@types/GroupCITestKit.d.ts +1 -3
  7. package/@types/HealthKit.d.ts +273 -230
  8. package/@types/HomeKit.d.ts +1062 -891
  9. package/@types/IPCKit.d.ts +23 -50
  10. package/@types/LightKit.d.ts +2 -2
  11. package/@types/MapKit.d.ts +592 -381
  12. package/@types/MediaPlayerKit.d.ts +4 -28
  13. package/@types/MiniKit.d.ts +198 -375
  14. package/@types/P2PKit.d.ts +139 -205
  15. package/@types/PayKit.d.ts +10 -79
  16. package/@types/SweeperKit.d.ts +10 -10
  17. package/@types/ThirdAuthKit.d.ts +28 -252
  18. package/@types/WearKit.d.ts +630 -1593
  19. package/@types/api-extend.d.ts +0 -63
  20. package/lib/AIKit-1.6.0.d.ts +732 -35
  21. package/lib/AIKit-1.6.0.js +732 -51
  22. package/lib/BaseKit-3.17.7.d.ts +0 -214
  23. package/lib/BaseKit-3.17.7.js +1 -227
  24. package/lib/DeviceKit-4.13.1.d.ts +3666 -0
  25. package/lib/DeviceKit-4.13.1.js +3666 -0
  26. package/lib/HealthKit-6.5.0.d.ts +603 -0
  27. package/lib/HealthKit-6.5.0.js +603 -0
  28. package/lib/HomeKit-3.1.4.d.ts +4 -0
  29. package/lib/HomeKit-3.1.4.js +4 -0
  30. package/lib/IPCKit-6.4.5.d.ts +0 -1
  31. package/lib/IPCKit-6.4.5.js +0 -1
  32. package/lib/MapKit-3.4.13.d.ts +251 -0
  33. package/lib/MapKit-3.4.13.js +251 -0
  34. package/lib/MediaKit-3.4.1.d.ts +16 -0
  35. package/lib/MediaKit-3.4.1.js +16 -0
  36. package/lib/PlayNetKit-1.3.30.d.ts +930 -0
  37. package/lib/PlayNetKit-1.3.30.js +930 -0
  38. package/lib/cloud/alarm.d.ts +38 -5
  39. package/lib/cloud/alarm.js +38 -5
  40. package/lib/cloud/device.d.ts +42 -6
  41. package/lib/cloud/device.js +42 -6
  42. package/lib/cloud/gateway.d.ts +16 -0
  43. package/lib/cloud/gateway.js +16 -0
  44. package/lib/cloud/health.d.ts +1 -0
  45. package/lib/cloud/health.js +272 -0
  46. package/lib/cloud/interface.d.ts +161 -0
  47. package/lib/cloud/interface.js +18 -0
  48. package/lib/cloud/statistic.d.ts +112 -26
  49. package/lib/cloud/statistic.js +112 -26
  50. package/lib/cloud/timer.d.ts +2 -4
  51. package/lib/nativeRouters/outdoors.d.ts +2 -0
  52. package/lib/nativeRouters/outdoors.js +2 -0
  53. package/lib/nativeRouters/remoteGroup.d.ts +2 -0
  54. package/lib/nativeRouters/remoteGroup.js +2 -0
  55. package/lib/panel/publishDps.js +1 -1
  56. package/package.json +5 -5
@@ -2,1245 +2,4911 @@
2
2
  /**
3
3
  * @public
4
4
  * @since @ray-js/ray 0.6.23
5
+ * @example 基础调用
6
+ * ```tsx
7
+ * import { device } from '@ray-js/ray';
8
+ *
9
+ * const { unregisterLeaveBeaconFenceEvent } = device;
10
+ *
11
+ * unregisterLeaveBeaconFenceEvent({
12
+ * deviceId: 'device_001',
13
+ * success: () => {
14
+ * console.log('unregisterLeaveBeaconFenceEvent success');
15
+ * },
16
+ * fail: (error) => {
17
+ * console.log('unregisterLeaveBeaconFenceEvent fail', error.errorMsg);
18
+ * },
19
+ * });
20
+ * ```
5
21
  */
6
22
  export declare const unregisterLeaveBeaconFenceEvent: typeof ty.device.unregisterLeaveBeaconFenceEvent;
7
23
  /**
8
24
  * @public
9
25
  * @since @ray-js/ray 0.6.23
26
+ * @example 基础调用
27
+ * ```tsx
28
+ * import { device } from '@ray-js/ray';
29
+ *
30
+ * const { registerLeaveBeaconFenceEvent } = device;
31
+ *
32
+ * registerLeaveBeaconFenceEvent({
33
+ * deviceId: 'device_001',
34
+ * success: () => {
35
+ * console.log('registerLeaveBeaconFenceEvent success');
36
+ * },
37
+ * fail: (error) => {
38
+ * console.log('registerLeaveBeaconFenceEvent fail', error.errorMsg);
39
+ * },
40
+ * });
41
+ * ```
10
42
  */
11
43
  export declare const registerLeaveBeaconFenceEvent: typeof ty.device.registerLeaveBeaconFenceEvent;
12
44
  /**
13
45
  * @public
14
46
  * @since @ray-js/ray 0.6.23
47
+ * @example 基础调用
48
+ * ```tsx
49
+ * import { device } from '@ray-js/ray';
50
+ *
51
+ * const { writeBeaconFenceConfig } = device;
52
+ *
53
+ * writeBeaconFenceConfig({
54
+ * deviceId: 'device_001',
55
+ * beaconFenceRssi: 0,
56
+ * isOpenEventWhenApproachingBeaconFence: true,
57
+ * isOpenEventWhenLeaveBeaconFence: true,
58
+ * isOpenNotifyWhenLeaveBeaconFence: true,
59
+ * success: () => {
60
+ * console.log('writeBeaconFenceConfig success');
61
+ * },
62
+ * fail: (error) => {
63
+ * console.log('writeBeaconFenceConfig fail', error.errorMsg);
64
+ * },
65
+ * });
66
+ * ```
15
67
  */
16
68
  export declare const writeBeaconFenceConfig: typeof ty.device.writeBeaconFenceConfig;
17
69
  /**
18
70
  * @public
19
71
  * @since @ray-js/ray 0.6.23
72
+ * @example 基础调用
73
+ * ```tsx
74
+ * import { device } from '@ray-js/ray';
75
+ *
76
+ * const { readBeaconFenceConfig } = device;
77
+ *
78
+ * readBeaconFenceConfig({
79
+ * deviceId: 'device_001',
80
+ * success: (result) => {
81
+ * console.log('readBeaconFenceConfig success', result);
82
+ * },
83
+ * fail: (error) => {
84
+ * console.log('readBeaconFenceConfig fail', error.errorMsg);
85
+ * },
86
+ * });
87
+ * ```
20
88
  */
21
89
  export declare const readBeaconFenceConfig: typeof ty.device.readBeaconFenceConfig;
22
90
  /**
23
91
  * @public
24
92
  * @since @ray-js/ray 0.6.23
93
+ * @example 基础调用
94
+ * ```tsx
95
+ * import { device } from '@ray-js/ray';
96
+ *
97
+ * const { disconnectBTBond } = device;
98
+ *
99
+ * disconnectBTBond({
100
+ * mac: 'example',
101
+ * success: () => {
102
+ * console.log('disconnectBTBond success');
103
+ * },
104
+ * fail: (error) => {
105
+ * console.log('disconnectBTBond fail', error.errorMsg);
106
+ * },
107
+ * });
108
+ * ```
25
109
  */
26
110
  export declare const disconnectBTBond: typeof ty.device.disconnectBTBond;
27
111
  /**
28
112
  * @public
29
113
  * @since @ray-js/ray 0.6.23
114
+ * @example 基础调用
115
+ * ```tsx
116
+ * import { device } from '@ray-js/ray';
117
+ *
118
+ * const { connectBTBond } = device;
119
+ *
120
+ * connectBTBond({
121
+ * mac: 'example',
122
+ * success: () => {
123
+ * console.log('connectBTBond success');
124
+ * },
125
+ * fail: (error) => {
126
+ * console.log('connectBTBond fail', error.errorMsg);
127
+ * },
128
+ * });
129
+ * ```
30
130
  */
31
131
  export declare const connectBTBond: typeof ty.device.connectBTBond;
32
132
  /**
33
133
  * @public
34
134
  * @since @ray-js/ray 0.6.23
135
+ * @example 基础调用
136
+ * ```tsx
137
+ * import { device } from '@ray-js/ray';
138
+ *
139
+ * const { cancelBLEFileTransfer } = device;
140
+ *
141
+ * cancelBLEFileTransfer({
142
+ * deviceId: 'device_001',
143
+ * fileId: 0,
144
+ * fileIdentifier: 'example',
145
+ * fileVersion: 0,
146
+ * filePath: 'example',
147
+ * success: () => {
148
+ * console.log('cancelBLEFileTransfer success');
149
+ * },
150
+ * fail: (error) => {
151
+ * console.log('cancelBLEFileTransfer fail', error.errorMsg);
152
+ * },
153
+ * });
154
+ * ```
35
155
  */
36
156
  export declare const cancelBLEFileTransfer: typeof ty.device.cancelBLEFileTransfer;
37
157
  /**
38
158
  * @public
39
159
  * @since @ray-js/ray 0.6.23
160
+ * @example 基础调用
161
+ * ```tsx
162
+ * import { device } from '@ray-js/ray';
163
+ *
164
+ * const { postBLEFileTransfer } = device;
165
+ *
166
+ * postBLEFileTransfer({
167
+ * deviceId: 'device_001',
168
+ * fileId: 0,
169
+ * fileIdentifier: 'example',
170
+ * fileVersion: 0,
171
+ * filePath: 'example',
172
+ * success: (result) => {
173
+ * console.log('postBLEFileTransfer success', result);
174
+ * },
175
+ * fail: (error) => {
176
+ * console.log('postBLEFileTransfer fail', error.errorMsg);
177
+ * },
178
+ * });
179
+ * ```
40
180
  */
41
181
  export declare const postBLEFileTransfer: typeof ty.device.postBLEFileTransfer;
42
182
  /**
43
183
  * @public
44
184
  * @since @ray-js/ray 0.6.23
185
+ * @example 基础调用
186
+ * ```tsx
187
+ * import { device } from '@ray-js/ray';
188
+ *
189
+ * const { getBLEDeviceRSSI } = device;
190
+ *
191
+ * getBLEDeviceRSSI({
192
+ * deviceId: 'device_001',
193
+ * success: (result) => {
194
+ * console.log('getBLEDeviceRSSI success', result);
195
+ * },
196
+ * fail: (error) => {
197
+ * console.log('getBLEDeviceRSSI fail', error.errorMsg);
198
+ * },
199
+ * });
200
+ * ```
45
201
  */
46
202
  export declare const getBLEDeviceRSSI: typeof ty.device.getBLEDeviceRSSI;
47
203
  /**
48
204
  * @public
49
205
  * @since @ray-js/ray 0.6.23
206
+ * @example 基础调用
207
+ * ```tsx
208
+ * import { device } from '@ray-js/ray';
209
+ *
210
+ * const { subscribeBLEConnectStatus } = device;
211
+ *
212
+ * subscribeBLEConnectStatus({
213
+ * deviceId: 'device_001',
214
+ * success: () => {
215
+ * console.log('subscribeBLEConnectStatus success');
216
+ * },
217
+ * fail: (error) => {
218
+ * console.log('subscribeBLEConnectStatus fail', error.errorMsg);
219
+ * },
220
+ * });
221
+ * ```
50
222
  */
51
223
  export declare const subscribeBLEConnectStatus: typeof ty.device.subscribeBLEConnectStatus;
52
224
  /**
53
225
  * @public
54
226
  * @since @ray-js/ray 0.6.23
227
+ * @example 基础调用
228
+ * ```tsx
229
+ * import { device } from '@ray-js/ray';
230
+ *
231
+ * const { unsubscribeBLEConnectStatus } = device;
232
+ *
233
+ * unsubscribeBLEConnectStatus({
234
+ * deviceId: 'device_001',
235
+ * success: () => {
236
+ * console.log('unsubscribeBLEConnectStatus success');
237
+ * },
238
+ * fail: (error) => {
239
+ * console.log('unsubscribeBLEConnectStatus fail', error.errorMsg);
240
+ * },
241
+ * });
242
+ * ```
55
243
  */
56
244
  export declare const unsubscribeBLEConnectStatus: typeof ty.device.unsubscribeBLEConnectStatus;
57
245
  /**
58
246
  * @public
59
247
  * @since @ray-js/ray 0.6.23
248
+ * @example 基础调用
249
+ * ```tsx
250
+ * import { device } from '@ray-js/ray';
251
+ *
252
+ * const { connectBLEDevice } = device;
253
+ *
254
+ * connectBLEDevice({
255
+ * deviceId: 'device_001',
256
+ * success: () => {
257
+ * console.log('connectBLEDevice success');
258
+ * },
259
+ * fail: (error) => {
260
+ * console.log('connectBLEDevice fail', error.errorMsg);
261
+ * },
262
+ * });
263
+ * ```
60
264
  */
61
265
  export declare const connectBLEDevice: typeof ty.device.connectBLEDevice;
62
266
  /**
63
267
  * @public
64
268
  * @since @ray-js/ray 0.6.23
269
+ * @example 基础调用
270
+ * ```tsx
271
+ * import { device } from '@ray-js/ray';
272
+ *
273
+ * const { directConnectBLEDevice } = device;
274
+ *
275
+ * directConnectBLEDevice({
276
+ * deviceId: 'device_001',
277
+ * success: () => {
278
+ * console.log('directConnectBLEDevice success');
279
+ * },
280
+ * fail: (error) => {
281
+ * console.log('directConnectBLEDevice fail', error.errorMsg);
282
+ * },
283
+ * });
284
+ * ```
65
285
  */
66
286
  export declare const directConnectBLEDevice: typeof ty.device.directConnectBLEDevice;
67
287
  /**
68
288
  * @public
69
289
  * @since @ray-js/ray 0.6.23
290
+ * @example 基础调用
291
+ * ```tsx
292
+ * import { device } from '@ray-js/ray';
293
+ *
294
+ * const { disconnectBLEDevice } = device;
295
+ *
296
+ * disconnectBLEDevice({
297
+ * deviceId: 'device_001',
298
+ * success: () => {
299
+ * console.log('disconnectBLEDevice success');
300
+ * },
301
+ * fail: (error) => {
302
+ * console.log('disconnectBLEDevice fail', error.errorMsg);
303
+ * },
304
+ * });
305
+ * ```
70
306
  */
71
307
  export declare const disconnectBLEDevice: typeof ty.device.disconnectBLEDevice;
72
308
  /**
73
309
  * @public
74
310
  * @since @ray-js/ray 0.6.23
311
+ * @example 基础调用
312
+ * ```tsx
313
+ * import { device } from '@ray-js/ray';
314
+ *
315
+ * const { getBLEOnlineState } = device;
316
+ *
317
+ * getBLEOnlineState({
318
+ * deviceId: 'device_001',
319
+ * success: (result) => {
320
+ * console.log('getBLEOnlineState success', result);
321
+ * },
322
+ * fail: (error) => {
323
+ * console.log('getBLEOnlineState fail', error.errorMsg);
324
+ * },
325
+ * });
326
+ * ```
75
327
  */
76
328
  export declare const getBLEOnlineState: typeof ty.device.getBLEOnlineState;
77
329
  /**
78
330
  * @public
79
331
  * @since @ray-js/ray 0.6.23
332
+ * @example 基础调用
333
+ * ```tsx
334
+ * import { device } from '@ray-js/ray';
335
+ *
336
+ * const { subscribeBLETransparentDataReport } = device;
337
+ *
338
+ * subscribeBLETransparentDataReport({
339
+ * deviceId: 'device_001',
340
+ * success: () => {
341
+ * console.log('subscribeBLETransparentDataReport success');
342
+ * },
343
+ * fail: (error) => {
344
+ * console.log('subscribeBLETransparentDataReport fail', error.errorMsg);
345
+ * },
346
+ * });
347
+ * ```
80
348
  */
81
349
  export declare const subscribeBLETransparentDataReport: typeof ty.device.subscribeBLETransparentDataReport;
82
350
  /**
83
351
  * @public
84
352
  * @since @ray-js/ray 0.6.23
353
+ * @example 基础调用
354
+ * ```tsx
355
+ * import { device } from '@ray-js/ray';
356
+ *
357
+ * const { unsubscribeBLETransparentDataReport } = device;
358
+ *
359
+ * unsubscribeBLETransparentDataReport({
360
+ * deviceId: 'device_001',
361
+ * success: () => {
362
+ * console.log('unsubscribeBLETransparentDataReport success');
363
+ * },
364
+ * fail: (error) => {
365
+ * console.log('unsubscribeBLETransparentDataReport fail', error.errorMsg);
366
+ * },
367
+ * });
368
+ * ```
85
369
  */
86
370
  export declare const unsubscribeBLETransparentDataReport: typeof ty.device.unsubscribeBLETransparentDataReport;
87
371
  /**
88
372
  * @public
89
373
  * @since @ray-js/ray 0.6.23
374
+ * @example 基础调用
375
+ * ```tsx
376
+ * import { device } from '@ray-js/ray';
377
+ *
378
+ * const { publishBLETransparentData } = device;
379
+ *
380
+ * publishBLETransparentData({
381
+ * deviceId: 'device_001',
382
+ * data: 'example',
383
+ * success: () => {
384
+ * console.log('publishBLETransparentData success');
385
+ * },
386
+ * fail: (error) => {
387
+ * console.log('publishBLETransparentData fail', error.errorMsg);
388
+ * },
389
+ * });
390
+ * ```
90
391
  */
91
392
  export declare const publishBLETransparentData: typeof ty.device.publishBLETransparentData;
92
393
  /**
93
394
  * @public
94
395
  * @since @ray-js/ray 0.6.23
396
+ * @example 基础调用
397
+ * ```tsx
398
+ * import { device } from '@ray-js/ray';
399
+ *
400
+ * const { getEncryptLocalKeyWithData } = device;
401
+ *
402
+ * getEncryptLocalKeyWithData({
403
+ * deviceId: 'device_001',
404
+ * keyDeviceId: 'example',
405
+ * success: (result) => {
406
+ * console.log('getEncryptLocalKeyWithData success', result);
407
+ * },
408
+ * fail: (error) => {
409
+ * console.log('getEncryptLocalKeyWithData fail', error.errorMsg);
410
+ * },
411
+ * });
412
+ * ```
95
413
  */
96
414
  export declare const getEncryptLocalKeyWithData: typeof ty.device.getEncryptLocalKeyWithData;
97
415
  /**
98
416
  * @public
99
417
  * @since @ray-js/ray 0.6.23
418
+ * @example 基础调用
419
+ * ```tsx
420
+ * import { device } from '@ray-js/ray';
421
+ *
422
+ * const { postBLEBigDataChannelWithProgress } = device;
423
+ *
424
+ * postBLEBigDataChannelWithProgress({
425
+ * deviceId: 'device_001',
426
+ * requestParams: {},
427
+ * success: (result) => {
428
+ * console.log('postBLEBigDataChannelWithProgress success', result);
429
+ * },
430
+ * fail: (error) => {
431
+ * console.log('postBLEBigDataChannelWithProgress fail', error.errorMsg);
432
+ * },
433
+ * });
434
+ * ```
100
435
  */
101
436
  export declare const postBLEBigDataChannelWithProgress: typeof ty.device.postBLEBigDataChannelWithProgress;
102
437
  /**
103
438
  * @public
104
439
  * @since @ray-js/ray 0.6.23
440
+ * @example 基础调用
441
+ * ```tsx
442
+ * import { device } from '@ray-js/ray';
443
+ *
444
+ * const { startBLEMeshLowPowerConnection } = device;
445
+ *
446
+ * startBLEMeshLowPowerConnection({
447
+ * deviceId: 'device_001',
448
+ * success: () => {
449
+ * console.log('startBLEMeshLowPowerConnection success');
450
+ * },
451
+ * fail: (error) => {
452
+ * console.log('startBLEMeshLowPowerConnection fail', error.errorMsg);
453
+ * },
454
+ * });
455
+ * ```
105
456
  */
106
457
  export declare const startBLEMeshLowPowerConnection: typeof ty.device.startBLEMeshLowPowerConnection;
107
458
  /**
108
459
  * @public
109
460
  * @since @ray-js/ray 0.6.23
461
+ * @example 基础调用
462
+ * ```tsx
463
+ * import { device } from '@ray-js/ray';
464
+ *
465
+ * const { stopBLEMeshLowPowerConnection } = device;
466
+ *
467
+ * stopBLEMeshLowPowerConnection({
468
+ * deviceId: 'device_001',
469
+ * success: () => {
470
+ * console.log('stopBLEMeshLowPowerConnection success');
471
+ * },
472
+ * fail: (error) => {
473
+ * console.log('stopBLEMeshLowPowerConnection fail', error.errorMsg);
474
+ * },
475
+ * });
476
+ * ```
110
477
  */
111
478
  export declare const stopBLEMeshLowPowerConnection: typeof ty.device.stopBLEMeshLowPowerConnection;
112
479
  /**
113
480
  * @public
114
481
  * @since @ray-js/ray 0.6.23
482
+ * @example 基础调用
483
+ * ```tsx
484
+ * import { device } from '@ray-js/ray';
485
+ *
486
+ * const { startBLEScanBeacon } = device;
487
+ *
488
+ * startBLEScanBeacon({
489
+ * deviceId: 'device_001',
490
+ * success: () => {
491
+ * console.log('startBLEScanBeacon success');
492
+ * },
493
+ * fail: (error) => {
494
+ * console.log('startBLEScanBeacon fail', error.errorMsg);
495
+ * },
496
+ * });
497
+ * ```
115
498
  */
116
499
  export declare const startBLEScanBeacon: typeof ty.device.startBLEScanBeacon;
117
500
  /**
118
501
  * @public
119
502
  * @since @ray-js/ray 0.6.23
503
+ * @example 基础调用
504
+ * ```tsx
505
+ * import { device } from '@ray-js/ray';
506
+ *
507
+ * const { stopBLEScanBeacon } = device;
508
+ *
509
+ * stopBLEScanBeacon({
510
+ * deviceId: 'device_001',
511
+ * success: () => {
512
+ * console.log('stopBLEScanBeacon success');
513
+ * },
514
+ * fail: (error) => {
515
+ * console.log('stopBLEScanBeacon fail', error.errorMsg);
516
+ * },
517
+ * });
518
+ * ```
120
519
  */
121
520
  export declare const stopBLEScanBeacon: typeof ty.device.stopBLEScanBeacon;
122
521
  /**
123
522
  * @public
124
523
  * @since @ray-js/ray 0.6.23
524
+ * @example 基础调用
525
+ * ```tsx
526
+ * import { device } from '@ray-js/ray';
527
+ *
528
+ * const { bluetoothCapabilityOfBLEBeacon } = device;
529
+ *
530
+ * bluetoothCapabilityOfBLEBeacon({
531
+ * deviceId: 'device_001',
532
+ * success: (result) => {
533
+ * console.log('bluetoothCapabilityOfBLEBeacon success', result);
534
+ * },
535
+ * fail: (error) => {
536
+ * console.log('bluetoothCapabilityOfBLEBeacon fail', error.errorMsg);
537
+ * },
538
+ * });
539
+ * ```
125
540
  */
126
541
  export declare const bluetoothCapabilityOfBLEBeacon: typeof ty.device.bluetoothCapabilityOfBLEBeacon;
127
542
  /**
128
543
  * @public
129
544
  * @since @ray-js/ray 0.6.23
545
+ * @example 基础调用
546
+ * ```tsx
547
+ * import { device } from '@ray-js/ray';
548
+ *
549
+ * const { bluetoothIsPowerOn } = device;
550
+ *
551
+ * bluetoothIsPowerOn({
552
+ * success: (result) => {
553
+ * console.log('bluetoothIsPowerOn success', result);
554
+ * },
555
+ * fail: (error) => {
556
+ * console.log('bluetoothIsPowerOn fail', error.errorMsg);
557
+ * },
558
+ * });
559
+ * ```
130
560
  */
131
561
  export declare const bluetoothIsPowerOn: typeof ty.device.bluetoothIsPowerOn;
132
562
  /**
133
563
  * @public
134
564
  * @since @ray-js/ray 0.6.23
565
+ * @example 基础调用
566
+ * ```tsx
567
+ * import { device } from '@ray-js/ray';
568
+ *
569
+ * const { startBLEScanBindDevice } = device;
570
+ *
571
+ * startBLEScanBindDevice({
572
+ * interval: 0,
573
+ * scanType: 'example',
574
+ * success: () => {
575
+ * console.log('startBLEScanBindDevice success');
576
+ * },
577
+ * fail: (error) => {
578
+ * console.log('startBLEScanBindDevice fail', error.errorMsg);
579
+ * },
580
+ * });
581
+ * ```
135
582
  */
136
583
  export declare const startBLEScanBindDevice: typeof ty.device.startBLEScanBindDevice;
137
584
  /**
138
585
  * @public
139
586
  * @since @ray-js/ray 0.6.23
587
+ * @example 基础调用
588
+ * ```tsx
589
+ * import { device } from '@ray-js/ray';
590
+ *
591
+ * const { startBLEScan } = device;
592
+ *
593
+ * startBLEScan({
594
+ * success: () => {
595
+ * console.log('startBLEScan success');
596
+ * },
597
+ * fail: (error) => {
598
+ * console.log('startBLEScan fail', error.errorMsg);
599
+ * },
600
+ * });
601
+ * ```
140
602
  */
141
603
  export declare const startBLEScan: typeof ty.device.startBLEScan;
142
604
  /**
143
605
  * @public
144
606
  * @since @ray-js/ray 0.6.23
607
+ * @example 基础调用
608
+ * ```tsx
609
+ * import { device } from '@ray-js/ray';
610
+ *
611
+ * const { startBLEScanSync } = device;
612
+ *
613
+ * const result = startBLEScanSync();
614
+ * console.log('startBLEScanSync result', result);
615
+ * ```
145
616
  */
146
617
  export declare const startBLEScanSync: typeof ty.device.startBLEScanSync;
147
618
  /**
148
619
  * @public
149
620
  * @since @ray-js/ray 0.6.23
621
+ * @example 基础调用
622
+ * ```tsx
623
+ * import { device } from '@ray-js/ray';
624
+ *
625
+ * const { stopBLEScan } = device;
626
+ *
627
+ * stopBLEScan({
628
+ * success: () => {
629
+ * console.log('stopBLEScan success');
630
+ * },
631
+ * fail: (error) => {
632
+ * console.log('stopBLEScan fail', error.errorMsg);
633
+ * },
634
+ * });
635
+ * ```
150
636
  */
151
637
  export declare const stopBLEScan: typeof ty.device.stopBLEScan;
152
638
  /**
153
639
  * @public
154
640
  * @since @ray-js/ray 0.6.23
641
+ * @example 基础调用
642
+ * ```tsx
643
+ * import { device } from '@ray-js/ray';
644
+ *
645
+ * const { stopBLEScanSync } = device;
646
+ *
647
+ * const result = stopBLEScanSync();
648
+ * console.log('stopBLEScanSync result', result);
649
+ * ```
155
650
  */
156
651
  export declare const stopBLEScanSync: typeof ty.device.stopBLEScanSync;
157
652
  /**
158
653
  * @public
159
654
  * @since @ray-js/ray 0.6.23
655
+ * @example 基础调用
656
+ * ```tsx
657
+ * import { device } from '@ray-js/ray';
658
+ *
659
+ * const { bluetoothCapabilityIsSupport } = device;
660
+ *
661
+ * bluetoothCapabilityIsSupport({
662
+ * deviceId: 'device_001',
663
+ * capability: 0,
664
+ * success: (result) => {
665
+ * console.log('bluetoothCapabilityIsSupport success', result);
666
+ * },
667
+ * fail: (error) => {
668
+ * console.log('bluetoothCapabilityIsSupport fail', error.errorMsg);
669
+ * },
670
+ * });
671
+ * ```
160
672
  */
161
673
  export declare const bluetoothCapabilityIsSupport: typeof ty.device.bluetoothCapabilityIsSupport;
162
674
  /**
163
675
  * @public
164
676
  * @since @ray-js/ray 0.6.23
677
+ * @example 基础调用
678
+ * ```tsx
679
+ * import { device } from '@ray-js/ray';
680
+ *
681
+ * const { getBTDeviceInfo } = device;
682
+ *
683
+ * getBTDeviceInfo({
684
+ * deviceId: 'device_001',
685
+ * success: (result) => {
686
+ * console.log('getBTDeviceInfo success', result);
687
+ * },
688
+ * fail: (error) => {
689
+ * console.log('getBTDeviceInfo fail', error.errorMsg);
690
+ * },
691
+ * });
692
+ * ```
165
693
  */
166
694
  export declare const getBTDeviceInfo: typeof ty.device.getBTDeviceInfo;
167
695
  /**
168
696
  * @public
169
697
  * @since @ray-js/ray 0.6.23
698
+ * @example 基础调用
699
+ * ```tsx
700
+ * import { device } from '@ray-js/ray';
701
+ *
702
+ * const { startGWActivation } = device;
703
+ *
704
+ * startGWActivation({
705
+ * gateway: { gwId: 'example' },
706
+ * timeout: 0,
707
+ * success: () => {
708
+ * console.log('startGWActivation success');
709
+ * },
710
+ * fail: (error) => {
711
+ * console.log('startGWActivation fail', error.errorMsg);
712
+ * },
713
+ * });
714
+ * ```
170
715
  */
171
716
  export declare const startGWActivation: typeof ty.device.startGWActivation;
172
717
  /**
173
718
  * @public
174
719
  * @since @ray-js/ray 0.6.23
720
+ * @example 基础调用
721
+ * ```tsx
722
+ * import { device } from '@ray-js/ray';
723
+ *
724
+ * const { stopGWActivation } = device;
725
+ *
726
+ * stopGWActivation({
727
+ * gwId: 'example',
728
+ * success: () => {
729
+ * console.log('stopGWActivation success');
730
+ * },
731
+ * fail: (error) => {
732
+ * console.log('stopGWActivation fail', error.errorMsg);
733
+ * },
734
+ * });
735
+ * ```
175
736
  */
176
737
  export declare const stopGWActivation: typeof ty.device.stopGWActivation;
177
738
  /**
178
739
  * @public
179
740
  * @since @ray-js/ray 0.6.23
741
+ * @example 基础调用
742
+ * ```tsx
743
+ * import { device } from '@ray-js/ray';
744
+ *
745
+ * const { openReconnectPage } = device;
746
+ *
747
+ * openReconnectPage({
748
+ * deviceId: 'device_001',
749
+ * success: () => {
750
+ * console.log('openReconnectPage success');
751
+ * },
752
+ * fail: (error) => {
753
+ * console.log('openReconnectPage fail', error.errorMsg);
754
+ * },
755
+ * });
756
+ * ```
180
757
  */
181
758
  export declare const openReconnectPage: typeof ty.device.openReconnectPage;
182
759
  /**
183
760
  * @public
184
761
  * @since @ray-js/ray 0.6.23
762
+ * @example 基础调用
763
+ * ```tsx
764
+ * import { device } from '@ray-js/ray';
765
+ *
766
+ * const { startDirectlyConnectedDeviceActivator } = device;
767
+ *
768
+ * startDirectlyConnectedDeviceActivator({
769
+ * device: { deviceId: 'device_001' },
770
+ * timeout: 0,
771
+ * success: () => {
772
+ * console.log('startDirectlyConnectedDeviceActivator success');
773
+ * },
774
+ * fail: (error) => {
775
+ * console.log('startDirectlyConnectedDeviceActivator fail', error.errorMsg);
776
+ * },
777
+ * });
778
+ * ```
185
779
  */
186
780
  export declare const startDirectlyConnectedDeviceActivator: typeof ty.device.startDirectlyConnectedDeviceActivator;
187
781
  /**
188
782
  * @public
189
783
  * @since @ray-js/ray 0.6.23
784
+ * @example 基础调用
785
+ * ```tsx
786
+ * import { device } from '@ray-js/ray';
787
+ *
788
+ * const { stopDirectlyConnectedDeviceActivator } = device;
789
+ *
790
+ * stopDirectlyConnectedDeviceActivator({
791
+ * device: { deviceId: 'device_001' },
792
+ * timeout: 0,
793
+ * success: () => {
794
+ * console.log('stopDirectlyConnectedDeviceActivator success');
795
+ * },
796
+ * fail: (error) => {
797
+ * console.log('stopDirectlyConnectedDeviceActivator fail', error.errorMsg);
798
+ * },
799
+ * });
800
+ * ```
190
801
  */
191
802
  export declare const stopDirectlyConnectedDeviceActivator: typeof ty.device.stopDirectlyConnectedDeviceActivator;
192
803
  /**
193
804
  * @public
194
805
  * @since @ray-js/ray 0.6.23
806
+ * @example 基础调用
807
+ * ```tsx
808
+ * import { device } from '@ray-js/ray';
809
+ *
810
+ * const { openCategoryActivatorPage } = device;
811
+ *
812
+ * openCategoryActivatorPage({
813
+ * success: () => {
814
+ * console.log('openCategoryActivatorPage success');
815
+ * },
816
+ * fail: (error) => {
817
+ * console.log('openCategoryActivatorPage fail', error.errorMsg);
818
+ * },
819
+ * });
820
+ * ```
195
821
  */
196
822
  export declare const openCategoryActivatorPage: typeof ty.device.openCategoryActivatorPage;
197
823
  /**
198
824
  * @public
199
825
  * @since @ray-js/ray 0.6.23
826
+ * @example 基础调用
827
+ * ```tsx
828
+ * import { device } from '@ray-js/ray';
829
+ *
830
+ * const { startDirectlyConnectedSearchDevice } = device;
831
+ *
832
+ * startDirectlyConnectedSearchDevice({
833
+ * device: { deviceId: 'device_001' },
834
+ * timeout: 0,
835
+ * success: () => {
836
+ * console.log('startDirectlyConnectedSearchDevice success');
837
+ * },
838
+ * fail: (error) => {
839
+ * console.log('startDirectlyConnectedSearchDevice fail', error.errorMsg);
840
+ * },
841
+ * });
842
+ * ```
200
843
  */
201
844
  export declare const startDirectlyConnectedSearchDevice: typeof ty.device.startDirectlyConnectedSearchDevice;
202
845
  /**
203
846
  * @public
204
847
  * @since @ray-js/ray 0.6.23
848
+ * @example 基础调用
849
+ * ```tsx
850
+ * import { device } from '@ray-js/ray';
851
+ *
852
+ * const { stopDirectlyConnectedSearchDevice } = device;
853
+ *
854
+ * stopDirectlyConnectedSearchDevice({
855
+ * device: { deviceId: 'device_001' },
856
+ * timeout: 0,
857
+ * success: () => {
858
+ * console.log('stopDirectlyConnectedSearchDevice success');
859
+ * },
860
+ * fail: (error) => {
861
+ * console.log('stopDirectlyConnectedSearchDevice fail', error.errorMsg);
862
+ * },
863
+ * });
864
+ * ```
205
865
  */
206
866
  export declare const stopDirectlyConnectedSearchDevice: typeof ty.device.stopDirectlyConnectedSearchDevice;
207
867
  /**
208
868
  * @public
209
869
  * @since @ray-js/ray 0.6.23
870
+ * @example 基础调用
871
+ * ```tsx
872
+ * import { device } from '@ray-js/ray';
873
+ *
874
+ * const { getDeviceWifiActivatorStatus } = device;
875
+ *
876
+ * getDeviceWifiActivatorStatus({
877
+ * deviceId: 'device_001',
878
+ * success: (result) => {
879
+ * console.log('getDeviceWifiActivatorStatus success', result);
880
+ * },
881
+ * fail: (error) => {
882
+ * console.log('getDeviceWifiActivatorStatus fail', error.errorMsg);
883
+ * },
884
+ * });
885
+ * ```
210
886
  */
211
887
  export declare const getDeviceWifiActivatorStatus: typeof ty.device.getDeviceWifiActivatorStatus;
212
888
  /**
213
889
  * @public
214
890
  * @since @ray-js/ray 0.6.23
891
+ * @example 基础调用
892
+ * ```tsx
893
+ * import { device } from '@ray-js/ray';
894
+ *
895
+ * const { startDeviceWifiActivator } = device;
896
+ *
897
+ * startDeviceWifiActivator({
898
+ * deviceId: 'device_001',
899
+ * success: (result) => {
900
+ * console.log('startDeviceWifiActivator success', result);
901
+ * },
902
+ * fail: (error) => {
903
+ * console.log('startDeviceWifiActivator fail', error.errorMsg);
904
+ * },
905
+ * });
906
+ * ```
215
907
  */
216
908
  export declare const startDeviceWifiActivator: typeof ty.device.startDeviceWifiActivator;
217
909
  /**
218
910
  * @public
219
911
  * @since @ray-js/ray 0.6.23
912
+ * @example 基础调用
913
+ * ```tsx
914
+ * import { device } from '@ray-js/ray';
915
+ *
916
+ * const { renameDeviceName } = device;
917
+ *
918
+ * renameDeviceName({
919
+ * deviceId: 'device_001',
920
+ * name: 'example',
921
+ * success: () => {
922
+ * console.log('renameDeviceName success');
923
+ * },
924
+ * fail: (error) => {
925
+ * console.log('renameDeviceName fail', error.errorMsg);
926
+ * },
927
+ * });
928
+ * ```
220
929
  */
221
930
  export declare const renameDeviceName: typeof ty.device.renameDeviceName;
222
931
  /**
223
932
  * @public
224
933
  * @since @ray-js/ray 0.6.23
934
+ * @example 基础调用
935
+ * ```tsx
936
+ * import { device } from '@ray-js/ray';
937
+ *
938
+ * const { resetFactory } = device;
939
+ *
940
+ * resetFactory({
941
+ * deviceId: 'device_001',
942
+ * success: () => {
943
+ * console.log('resetFactory success');
944
+ * },
945
+ * fail: (error) => {
946
+ * console.log('resetFactory fail', error.errorMsg);
947
+ * },
948
+ * });
949
+ * ```
225
950
  */
226
951
  export declare const resetFactory: typeof ty.device.resetFactory;
227
952
  /**
228
953
  * @public
229
954
  * @since @ray-js/ray 0.6.23
955
+ * @example 基础调用
956
+ * ```tsx
957
+ * import { device } from '@ray-js/ray';
958
+ *
959
+ * const { removeDevice } = device;
960
+ *
961
+ * removeDevice({
962
+ * deviceId: 'device_001',
963
+ * success: () => {
964
+ * console.log('removeDevice success');
965
+ * },
966
+ * fail: (error) => {
967
+ * console.log('removeDevice fail', error.errorMsg);
968
+ * },
969
+ * });
970
+ * ```
230
971
  */
231
972
  export declare const removeDevice: typeof ty.device.removeDevice;
232
973
  /**
233
974
  * @public
234
975
  * @since @ray-js/ray 0.6.23
976
+ * @example 基础调用
977
+ * ```tsx
978
+ * import { device } from '@ray-js/ray';
979
+ *
980
+ * const { registerZigbeeGateWaySubDeviceListener } = device;
981
+ *
982
+ * registerZigbeeGateWaySubDeviceListener({
983
+ * deviceId: 'device_001',
984
+ * success: () => {
985
+ * console.log('registerZigbeeGateWaySubDeviceListener success');
986
+ * },
987
+ * fail: (error) => {
988
+ * console.log('registerZigbeeGateWaySubDeviceListener fail', error.errorMsg);
989
+ * },
990
+ * });
991
+ * ```
235
992
  */
236
993
  export declare const registerZigbeeGateWaySubDeviceListener: typeof ty.device.registerZigbeeGateWaySubDeviceListener;
237
994
  /**
238
995
  * @public
239
996
  * @since @ray-js/ray 0.6.23
997
+ * @example 基础调用
998
+ * ```tsx
999
+ * import { device } from '@ray-js/ray';
1000
+ *
1001
+ * const { unregisterZigbeeGateWaySubDeviceListener } = device;
1002
+ *
1003
+ * unregisterZigbeeGateWaySubDeviceListener({
1004
+ * deviceId: 'device_001',
1005
+ * success: () => {
1006
+ * console.log('unregisterZigbeeGateWaySubDeviceListener success');
1007
+ * },
1008
+ * fail: (error) => {
1009
+ * console.log('unregisterZigbeeGateWaySubDeviceListener fail', error.errorMsg);
1010
+ * },
1011
+ * });
1012
+ * ```
240
1013
  */
241
1014
  export declare const unregisterZigbeeGateWaySubDeviceListener: typeof ty.device.unregisterZigbeeGateWaySubDeviceListener;
242
1015
  /**
243
1016
  * @public
244
1017
  * @since @ray-js/ray 0.6.23
1018
+ * @example 基础调用
1019
+ * ```tsx
1020
+ * import { device } from '@ray-js/ray';
1021
+ *
1022
+ * const { getDeviceOnlineType } = device;
1023
+ *
1024
+ * getDeviceOnlineType({
1025
+ * deviceId: 'device_001',
1026
+ * success: (result) => {
1027
+ * console.log('getDeviceOnlineType success', result);
1028
+ * },
1029
+ * fail: (error) => {
1030
+ * console.log('getDeviceOnlineType fail', error.errorMsg);
1031
+ * },
1032
+ * });
1033
+ * ```
245
1034
  */
246
1035
  export declare const getDeviceOnlineType: typeof ty.device.getDeviceOnlineType;
247
1036
  /**
248
1037
  * @public
249
1038
  * @since @ray-js/ray 0.6.23
1039
+ * @example 基础调用
1040
+ * ```tsx
1041
+ * import { device } from '@ray-js/ray';
1042
+ *
1043
+ * const { getDeviceInfo } = device;
1044
+ *
1045
+ * getDeviceInfo({
1046
+ * deviceId: 'device_001',
1047
+ * success: (result) => {
1048
+ * console.log('getDeviceInfo success', result);
1049
+ * },
1050
+ * fail: (error) => {
1051
+ * console.log('getDeviceInfo fail', error.errorMsg);
1052
+ * },
1053
+ * });
1054
+ * ```
250
1055
  */
251
1056
  export declare const getDeviceInfo: typeof ty.device.getDeviceInfo;
252
1057
  /**
253
1058
  * @public
254
1059
  * @since @ray-js/ray 0.6.23
1060
+ * @example 基础调用
1061
+ * ```tsx
1062
+ * import { device } from '@ray-js/ray';
1063
+ *
1064
+ * const { getProductInfo } = device;
1065
+ *
1066
+ * getProductInfo({
1067
+ * productId: 'example',
1068
+ * success: (result) => {
1069
+ * console.log('getProductInfo success', result);
1070
+ * },
1071
+ * fail: (error) => {
1072
+ * console.log('getProductInfo fail', error.errorMsg);
1073
+ * },
1074
+ * });
1075
+ * ```
255
1076
  */
256
1077
  export declare const getProductInfo: typeof ty.device.getProductInfo;
257
1078
  /**
258
1079
  * @public
259
1080
  * @since @ray-js/ray 0.6.23
1081
+ * @example 基础调用
1082
+ * ```tsx
1083
+ * import { device } from '@ray-js/ray';
1084
+ *
1085
+ * const { getSubDeviceInfoList } = device;
1086
+ *
1087
+ * getSubDeviceInfoList({
1088
+ * meshId: 'example',
1089
+ * success: (result) => {
1090
+ * console.log('getSubDeviceInfoList success', result);
1091
+ * },
1092
+ * fail: (error) => {
1093
+ * console.log('getSubDeviceInfoList fail', error.errorMsg);
1094
+ * },
1095
+ * });
1096
+ * ```
260
1097
  */
261
1098
  export declare const getSubDeviceInfoList: typeof ty.device.getSubDeviceInfoList;
262
1099
  /**
263
1100
  * @public
264
1101
  * @since @ray-js/ray 0.6.23
1102
+ * @example 基础调用
1103
+ * ```tsx
1104
+ * import { device } from '@ray-js/ray';
1105
+ *
1106
+ * const { validDeviceOnlineType } = device;
1107
+ *
1108
+ * validDeviceOnlineType({
1109
+ * deviceId: 'device_001',
1110
+ * onlineType: 0,
1111
+ * success: (result) => {
1112
+ * console.log('validDeviceOnlineType success', result);
1113
+ * },
1114
+ * fail: (error) => {
1115
+ * console.log('validDeviceOnlineType fail', error.errorMsg);
1116
+ * },
1117
+ * });
1118
+ * ```
265
1119
  */
266
1120
  export declare const validDeviceOnlineType: typeof ty.device.validDeviceOnlineType;
267
1121
  /**
268
1122
  * @public
269
1123
  * @since @ray-js/ray 0.10.4
1124
+ * @example 基础调用
1125
+ * ```tsx
1126
+ * import { device } from '@ray-js/ray';
1127
+ *
1128
+ * const { publishDpsBase } = device;
1129
+ *
1130
+ * publishDpsBase({
1131
+ * deviceId: 'device_001',
1132
+ * dps: {},
1133
+ * mode: 0,
1134
+ * pipelines: [],
1135
+ * options: {},
1136
+ * success: (result) => {
1137
+ * console.log('publishDpsBase success', result);
1138
+ * },
1139
+ * fail: (error) => {
1140
+ * console.log('publishDpsBase fail', error.errorMsg);
1141
+ * },
1142
+ * });
1143
+ * ```
270
1144
  */
271
1145
  export declare const publishDpsBase: typeof ty.device.publishDps;
272
1146
  /**
273
1147
  * @public
274
1148
  * @since @ray-js/ray 0.10.4
1149
+ * @example 基础调用
1150
+ * ```tsx
1151
+ * import { device } from '@ray-js/ray';
1152
+ *
1153
+ * const { publishDps } = device;
1154
+ *
1155
+ * publishDps({
1156
+ * deviceId: 'device_001',
1157
+ * dps: {},
1158
+ * mode: 0,
1159
+ * pipelines: [],
1160
+ * options: {},
1161
+ * success: (result) => {
1162
+ * console.log('publishDpsBase success', result);
1163
+ * },
1164
+ * fail: (error) => {
1165
+ * console.log('publishDpsBase fail', error.errorMsg);
1166
+ * },
1167
+ * });
1168
+ * ```
275
1169
  */
276
1170
  export declare const publishDps: typeof ty.device.publishDps;
277
1171
  /**
278
1172
  * @public
279
1173
  * @since @ray-js/ray 0.6.23
1174
+ * @example 基础调用
1175
+ * ```tsx
1176
+ * import { device } from '@ray-js/ray';
1177
+ *
1178
+ * const { publishCommands } = device;
1179
+ *
1180
+ * publishCommands({
1181
+ * deviceId: 'device_001',
1182
+ * dps: {},
1183
+ * mode: 0,
1184
+ * pipelines: [],
1185
+ * options: {},
1186
+ * success: (result) => {
1187
+ * console.log('publishCommands success', result);
1188
+ * },
1189
+ * fail: (error) => {
1190
+ * console.log('publishCommands fail', error.errorMsg);
1191
+ * },
1192
+ * });
1193
+ * ```
280
1194
  */
281
1195
  export declare const publishCommands: typeof ty.device.publishCommands;
282
1196
  /**
283
1197
  * @public
284
1198
  * @since @ray-js/ray 0.6.23
1199
+ * @example 基础调用
1200
+ * ```tsx
1201
+ * import { device } from '@ray-js/ray';
1202
+ *
1203
+ * const { publishDpsWithPipeType } = device;
1204
+ *
1205
+ * publishDpsWithPipeType({
1206
+ * deviceId: 'device_001',
1207
+ * dps: {},
1208
+ * mode: 0,
1209
+ * pipelines: [],
1210
+ * options: {},
1211
+ * success: (result) => {
1212
+ * console.log('publishDpsWithPipeType success', result);
1213
+ * },
1214
+ * fail: (error) => {
1215
+ * console.log('publishDpsWithPipeType fail', error.errorMsg);
1216
+ * },
1217
+ * });
1218
+ * ```
285
1219
  */
286
1220
  export declare const publishDpsWithPipeType: typeof ty.device.publishDpsWithPipeType;
287
1221
  /**
288
1222
  * @public
289
1223
  * @since @ray-js/ray 0.6.23
1224
+ * @example 基础调用
1225
+ * ```tsx
1226
+ * import { device } from '@ray-js/ray';
1227
+ *
1228
+ * const { queryDps } = device;
1229
+ *
1230
+ * queryDps({
1231
+ * deviceId: 'device_001',
1232
+ * dpIds: [],
1233
+ * success: (result) => {
1234
+ * console.log('queryDps success', result);
1235
+ * },
1236
+ * fail: (error) => {
1237
+ * console.log('queryDps fail', error.errorMsg);
1238
+ * },
1239
+ * });
1240
+ * ```
290
1241
  */
291
1242
  export declare const queryDps: typeof ty.device.queryDps;
292
1243
  /**
293
1244
  * @public
294
1245
  * @since @ray-js/ray 0.6.23
1246
+ * @example 基础调用
1247
+ * ```tsx
1248
+ * import { device } from '@ray-js/ray';
1249
+ *
1250
+ * const { publishMqttMessage } = device;
1251
+ *
1252
+ * publishMqttMessage({
1253
+ * message: {},
1254
+ * deviceId: 'device_001',
1255
+ * protocol: 0,
1256
+ * options: {},
1257
+ * success: (result) => {
1258
+ * console.log('publishMqttMessage success', result);
1259
+ * },
1260
+ * fail: (error) => {
1261
+ * console.log('publishMqttMessage fail', error.errorMsg);
1262
+ * },
1263
+ * });
1264
+ * ```
295
1265
  */
296
1266
  export declare const publishMqttMessage: typeof ty.device.publishMqttMessage;
297
1267
  /**
298
1268
  * @public
299
1269
  * @since @ray-js/ray 0.6.23
1270
+ * @example 基础调用
1271
+ * ```tsx
1272
+ * import { device } from '@ray-js/ray';
1273
+ *
1274
+ * const { publishLanMessage } = device;
1275
+ *
1276
+ * publishLanMessage({
1277
+ * message: 'example',
1278
+ * deviceId: 'device_001',
1279
+ * protocol: 0,
1280
+ * success: (result) => {
1281
+ * console.log('publishLanMessage success', result);
1282
+ * },
1283
+ * fail: (error) => {
1284
+ * console.log('publishLanMessage fail', error.errorMsg);
1285
+ * },
1286
+ * });
1287
+ * ```
300
1288
  */
301
1289
  export declare const publishLanMessage: typeof ty.device.publishLanMessage;
302
1290
  /**
303
1291
  * @public
304
1292
  * @since @ray-js/ray 0.6.23
1293
+ * @example 基础调用
1294
+ * ```tsx
1295
+ * import { device } from '@ray-js/ray';
1296
+ *
1297
+ * const { publishSocketMessage } = device;
1298
+ *
1299
+ * publishSocketMessage({
1300
+ * message: {},
1301
+ * deviceId: 'device_001',
1302
+ * type: 0,
1303
+ * options: {},
1304
+ * success: (result) => {
1305
+ * console.log('publishSocketMessage success', result);
1306
+ * },
1307
+ * fail: (error) => {
1308
+ * console.log('publishSocketMessage fail', error.errorMsg);
1309
+ * },
1310
+ * });
1311
+ * ```
305
1312
  */
306
1313
  export declare const publishSocketMessage: typeof ty.device.publishSocketMessage;
307
1314
  /**
308
1315
  * @public
309
1316
  * @since @ray-js/ray 0.6.23
1317
+ * @example 基础调用
1318
+ * ```tsx
1319
+ * import { device } from '@ray-js/ray';
1320
+ *
1321
+ * const { getDeviceProperty } = device;
1322
+ *
1323
+ * getDeviceProperty({
1324
+ * deviceId: 'device_001',
1325
+ * success: (result) => {
1326
+ * console.log('getDeviceProperty success', result);
1327
+ * },
1328
+ * fail: (error) => {
1329
+ * console.log('getDeviceProperty fail', error.errorMsg);
1330
+ * },
1331
+ * });
1332
+ * ```
310
1333
  */
311
1334
  export declare const getDeviceProperty: typeof ty.device.getDeviceProperty;
312
1335
  /**
313
1336
  * @public
314
1337
  * @since @ray-js/ray 0.6.23
1338
+ * @example 基础调用
1339
+ * ```tsx
1340
+ * import { device } from '@ray-js/ray';
1341
+ *
1342
+ * const { setDeviceProperty } = device;
1343
+ *
1344
+ * setDeviceProperty({
1345
+ * deviceId: 'device_001',
1346
+ * code: 'example',
1347
+ * value: 'example',
1348
+ * success: (result) => {
1349
+ * console.log('setDeviceProperty success', result);
1350
+ * },
1351
+ * fail: (error) => {
1352
+ * console.log('setDeviceProperty fail', error.errorMsg);
1353
+ * },
1354
+ * });
1355
+ * ```
315
1356
  */
316
1357
  export declare const setDeviceProperty: typeof ty.device.setDeviceProperty;
317
1358
  /**
318
1359
  * @public
319
1360
  * @since @ray-js/ray 0.6.23
1361
+ * @example 基础调用
1362
+ * ```tsx
1363
+ * import { device } from '@ray-js/ray';
1364
+ *
1365
+ * const { syncDeviceInfo } = device;
1366
+ *
1367
+ * syncDeviceInfo({
1368
+ * deviceId: 'device_001',
1369
+ * success: () => {
1370
+ * console.log('syncDeviceInfo success');
1371
+ * },
1372
+ * fail: (error) => {
1373
+ * console.log('syncDeviceInfo fail', error.errorMsg);
1374
+ * },
1375
+ * });
1376
+ * ```
320
1377
  */
321
1378
  export declare const syncDeviceInfo: typeof ty.device.syncDeviceInfo;
322
1379
  /**
323
1380
  * @public
324
1381
  * @since @ray-js/ray 0.6.23
1382
+ * @example 基础调用
1383
+ * ```tsx
1384
+ * import { device } from '@ray-js/ray';
1385
+ *
1386
+ * const { subscribeDeviceRemoved } = device;
1387
+ *
1388
+ * subscribeDeviceRemoved({
1389
+ * deviceId: 'device_001',
1390
+ * success: () => {
1391
+ * console.log('subscribeDeviceRemoved success');
1392
+ * },
1393
+ * fail: (error) => {
1394
+ * console.log('subscribeDeviceRemoved fail', error.errorMsg);
1395
+ * },
1396
+ * });
1397
+ * ```
325
1398
  */
326
1399
  export declare const subscribeDeviceRemoved: typeof ty.device.subscribeDeviceRemoved;
327
1400
  /**
328
1401
  * @public
329
1402
  * @since @ray-js/ray 0.6.23
1403
+ * @example 基础调用
1404
+ * ```tsx
1405
+ * import { device } from '@ray-js/ray';
1406
+ *
1407
+ * const { unSubscribeDeviceRemoved } = device;
1408
+ *
1409
+ * unSubscribeDeviceRemoved({
1410
+ * deviceId: 'device_001',
1411
+ * success: () => {
1412
+ * console.log('unSubscribeDeviceRemoved success');
1413
+ * },
1414
+ * fail: (error) => {
1415
+ * console.log('unSubscribeDeviceRemoved fail', error.errorMsg);
1416
+ * },
1417
+ * });
1418
+ * ```
330
1419
  */
331
1420
  export declare const unSubscribeDeviceRemoved: typeof ty.device.unSubscribeDeviceRemoved;
332
1421
  /**
333
1422
  * @public
334
1423
  * @since @ray-js/ray 0.6.23
1424
+ * @example 基础调用
1425
+ * ```tsx
1426
+ * import { device } from '@ray-js/ray';
1427
+ *
1428
+ * const { registerMQTTDeviceListener } = device;
1429
+ *
1430
+ * registerMQTTDeviceListener({
1431
+ * deviceId: 'device_001',
1432
+ * success: () => {
1433
+ * console.log('registerMQTTDeviceListener success');
1434
+ * },
1435
+ * fail: (error) => {
1436
+ * console.log('registerMQTTDeviceListener fail', error.errorMsg);
1437
+ * },
1438
+ * });
1439
+ * ```
335
1440
  */
336
1441
  export declare const registerMQTTDeviceListener: typeof ty.device.registerMQTTDeviceListener;
337
1442
  /**
338
1443
  * @public
339
1444
  * @since @ray-js/ray 0.6.23
1445
+ * @example 基础调用
1446
+ * ```tsx
1447
+ * import { device } from '@ray-js/ray';
1448
+ *
1449
+ * const { unregisterMQTTDeviceListener } = device;
1450
+ *
1451
+ * unregisterMQTTDeviceListener({
1452
+ * deviceId: 'device_001',
1453
+ * success: () => {
1454
+ * console.log('unregisterMQTTDeviceListener success');
1455
+ * },
1456
+ * fail: (error) => {
1457
+ * console.log('unregisterMQTTDeviceListener fail', error.errorMsg);
1458
+ * },
1459
+ * });
1460
+ * ```
340
1461
  */
341
1462
  export declare const unregisterMQTTDeviceListener: typeof ty.device.unregisterMQTTDeviceListener;
342
1463
  /**
343
1464
  * @public
344
1465
  * @since @ray-js/ray 0.6.23
1466
+ * @example 基础调用
1467
+ * ```tsx
1468
+ * import { device } from '@ray-js/ray';
1469
+ *
1470
+ * const { registerMQTTProtocolListener } = device;
1471
+ *
1472
+ * registerMQTTProtocolListener({
1473
+ * protocol: 0,
1474
+ * success: () => {
1475
+ * console.log('registerMQTTProtocolListener success');
1476
+ * },
1477
+ * fail: (error) => {
1478
+ * console.log('registerMQTTProtocolListener fail', error.errorMsg);
1479
+ * },
1480
+ * });
1481
+ * ```
345
1482
  */
346
1483
  export declare const registerMQTTProtocolListener: typeof ty.device.registerMQTTProtocolListener;
347
1484
  /**
348
1485
  * @public
349
1486
  * @since @ray-js/ray 0.6.23
1487
+ * @example 基础调用
1488
+ * ```tsx
1489
+ * import { device } from '@ray-js/ray';
1490
+ *
1491
+ * const { unregisterMQTTProtocolListener } = device;
1492
+ *
1493
+ * unregisterMQTTProtocolListener({
1494
+ * protocol: 0,
1495
+ * success: () => {
1496
+ * console.log('unregisterMQTTProtocolListener success');
1497
+ * },
1498
+ * fail: (error) => {
1499
+ * console.log('unregisterMQTTProtocolListener fail', error.errorMsg);
1500
+ * },
1501
+ * });
1502
+ * ```
350
1503
  */
351
1504
  export declare const unregisterMQTTProtocolListener: typeof ty.device.unregisterMQTTProtocolListener;
352
1505
  /**
353
1506
  * @public
354
1507
  * @since @ray-js/ray 0.6.23
1508
+ * @example 基础调用
1509
+ * ```tsx
1510
+ * import { device } from '@ray-js/ray';
1511
+ *
1512
+ * const { registerDeviceListListener } = device;
1513
+ *
1514
+ * registerDeviceListListener({
1515
+ * deviceIdList: ['example'],
1516
+ * success: () => {
1517
+ * console.log('registerDeviceListListener success');
1518
+ * },
1519
+ * fail: (error) => {
1520
+ * console.log('registerDeviceListListener fail', error.errorMsg);
1521
+ * },
1522
+ * });
1523
+ * ```
355
1524
  */
356
1525
  export declare const registerDeviceListListener: typeof ty.device.registerDeviceListListener;
357
1526
  /**
358
1527
  * @public
359
1528
  * @since @ray-js/ray 0.6.23
1529
+ * @example 基础调用
1530
+ * ```tsx
1531
+ * import { device } from '@ray-js/ray';
1532
+ *
1533
+ * const { unregisterDeviceListListener } = device;
1534
+ *
1535
+ * unregisterDeviceListListener({
1536
+ * success: () => {
1537
+ * console.log('unregisterDeviceListListener success');
1538
+ * },
1539
+ * fail: (error) => {
1540
+ * console.log('unregisterDeviceListListener fail', error.errorMsg);
1541
+ * },
1542
+ * });
1543
+ * ```
360
1544
  */
361
1545
  export declare const unregisterDeviceListListener: typeof ty.device.unregisterDeviceListListener;
362
1546
  /**
363
1547
  * @public
364
1548
  * @since @ray-js/ray 0.6.23
1549
+ * @example 基础调用
1550
+ * ```tsx
1551
+ * import { device } from '@ray-js/ray';
1552
+ *
1553
+ * const { registerTopicListListener } = device;
1554
+ *
1555
+ * registerTopicListListener({
1556
+ * topicList: ['example'],
1557
+ * success: () => {
1558
+ * console.log('registerTopicListListener success');
1559
+ * },
1560
+ * fail: (error) => {
1561
+ * console.log('registerTopicListListener fail', error.errorMsg);
1562
+ * },
1563
+ * });
1564
+ * ```
365
1565
  */
366
1566
  export declare const registerTopicListListener: typeof ty.device.registerTopicListListener;
367
1567
  /**
368
1568
  * @public
369
1569
  * @since @ray-js/ray 0.6.23
1570
+ * @example 基础调用
1571
+ * ```tsx
1572
+ * import { device } from '@ray-js/ray';
1573
+ *
1574
+ * const { unregisterTopicListListener } = device;
1575
+ *
1576
+ * unregisterTopicListListener({
1577
+ * success: () => {
1578
+ * console.log('unregisterTopicListListener success');
1579
+ * },
1580
+ * fail: (error) => {
1581
+ * console.log('unregisterTopicListListener fail', error.errorMsg);
1582
+ * },
1583
+ * });
1584
+ * ```
370
1585
  */
371
1586
  export declare const unregisterTopicListListener: typeof ty.device.unregisterTopicListListener;
372
1587
  /**
373
1588
  * @public
374
1589
  * @since @ray-js/ray 0.6.23
1590
+ * @example 基础调用
1591
+ * ```tsx
1592
+ * import { device } from '@ray-js/ray';
1593
+ *
1594
+ * const { getMqttConnectState } = device;
1595
+ *
1596
+ * getMqttConnectState({
1597
+ * success: (result) => {
1598
+ * console.log('getMqttConnectState success', result);
1599
+ * },
1600
+ * fail: (error) => {
1601
+ * console.log('getMqttConnectState fail', error.errorMsg);
1602
+ * },
1603
+ * });
1604
+ * ```
375
1605
  */
376
1606
  export declare const getMqttConnectState: typeof ty.device.getMqttConnectState;
377
1607
  /**
378
1608
  * @public
379
1609
  * @since @ray-js/ray 0.6.23
1610
+ * @example 基础调用
1611
+ * ```tsx
1612
+ * import { device } from '@ray-js/ray';
1613
+ *
1614
+ * const { checkOTAUpdateInfo } = device;
1615
+ *
1616
+ * checkOTAUpdateInfo({
1617
+ * deviceId: 'device_001',
1618
+ * success: () => {
1619
+ * console.log('checkOTAUpdateInfo success');
1620
+ * },
1621
+ * fail: (error) => {
1622
+ * console.log('checkOTAUpdateInfo fail', error.errorMsg);
1623
+ * },
1624
+ * });
1625
+ * ```
380
1626
  */
381
1627
  export declare const checkOTAUpdateInfo: typeof ty.device.checkOTAUpdateInfo;
382
1628
  /**
383
1629
  * @public
384
1630
  * @since @ray-js/ray 0.6.23
1631
+ * @example 基础调用
1632
+ * ```tsx
1633
+ * import { device } from '@ray-js/ray';
1634
+ *
1635
+ * const { openDeviceDetailPage } = device;
1636
+ *
1637
+ * openDeviceDetailPage({
1638
+ * deviceId: 'device_001',
1639
+ * success: () => {
1640
+ * console.log('openDeviceDetailPage success');
1641
+ * },
1642
+ * fail: (error) => {
1643
+ * console.log('openDeviceDetailPage fail', error.errorMsg);
1644
+ * },
1645
+ * });
1646
+ * ```
385
1647
  */
386
1648
  export declare const openDeviceDetailPage: typeof ty.device.openDeviceDetailPage;
387
1649
  /**
388
1650
  * @public
389
1651
  * @since @ray-js/ray 0.6.23
1652
+ * @example 基础调用
1653
+ * ```tsx
1654
+ * import { device } from '@ray-js/ray';
1655
+ *
1656
+ * const { openGroupDetailPage } = device;
1657
+ *
1658
+ * openGroupDetailPage({
1659
+ * groupId: 'example',
1660
+ * success: () => {
1661
+ * console.log('openGroupDetailPage success');
1662
+ * },
1663
+ * fail: (error) => {
1664
+ * console.log('openGroupDetailPage fail', error.errorMsg);
1665
+ * },
1666
+ * });
1667
+ * ```
390
1668
  */
391
1669
  export declare const openGroupDetailPage: typeof ty.device.openGroupDetailPage;
392
1670
  /**
393
1671
  * @public
394
1672
  * @since @ray-js/ray 0.6.23
1673
+ * @example 基础调用
1674
+ * ```tsx
1675
+ * import { device } from '@ray-js/ray';
1676
+ *
1677
+ * const { openTimerPage } = device;
1678
+ *
1679
+ * openTimerPage({
1680
+ * deviceId: 'device_001',
1681
+ * category: 'example',
1682
+ * data: [],
1683
+ * success: () => {
1684
+ * console.log('openTimerPage success');
1685
+ * },
1686
+ * fail: (error) => {
1687
+ * console.log('openTimerPage fail', error.errorMsg);
1688
+ * },
1689
+ * });
1690
+ * ```
395
1691
  */
396
1692
  export declare const openTimerPage: typeof ty.device.openTimerPage;
397
1693
  /**
398
1694
  * @public
399
1695
  * @since @ray-js/ray 0.6.23
1696
+ * @example 基础调用
1697
+ * ```tsx
1698
+ * import { device } from '@ray-js/ray';
1699
+ *
1700
+ * const { openGroupTimerPage } = device;
1701
+ *
1702
+ * openGroupTimerPage({
1703
+ * groupId: 'example',
1704
+ * category: 'example',
1705
+ * data: [],
1706
+ * success: () => {
1707
+ * console.log('openGroupTimerPage success');
1708
+ * },
1709
+ * fail: (error) => {
1710
+ * console.log('openGroupTimerPage fail', error.errorMsg);
1711
+ * },
1712
+ * });
1713
+ * ```
400
1714
  */
401
1715
  export declare const openGroupTimerPage: typeof ty.device.openGroupTimerPage;
402
1716
  /**
403
1717
  * @public
404
1718
  * @since @ray-js/ray 0.6.23
1719
+ * @example 基础调用
1720
+ * ```tsx
1721
+ * import { device } from '@ray-js/ray';
1722
+ *
1723
+ * const { openDeviceWifiNetworkMonitorPage } = device;
1724
+ *
1725
+ * openDeviceWifiNetworkMonitorPage({
1726
+ * deviceId: 'device_001',
1727
+ * success: () => {
1728
+ * console.log('openDeviceWifiNetworkMonitorPage success');
1729
+ * },
1730
+ * fail: (error) => {
1731
+ * console.log('openDeviceWifiNetworkMonitorPage fail', error.errorMsg);
1732
+ * },
1733
+ * });
1734
+ * ```
405
1735
  */
406
1736
  export declare const openDeviceWifiNetworkMonitorPage: typeof ty.device.openDeviceWifiNetworkMonitorPage;
407
1737
  /**
408
1738
  * @public
409
1739
  * @since @ray-js/ray 0.6.23
1740
+ * @example 基础调用
1741
+ * ```tsx
1742
+ * import { device } from '@ray-js/ray';
1743
+ *
1744
+ * const { syncTimerTask } = device;
1745
+ *
1746
+ * syncTimerTask({
1747
+ * category: 'example',
1748
+ * success: (result) => {
1749
+ * console.log('syncTimerTask success', result);
1750
+ * },
1751
+ * fail: (error) => {
1752
+ * console.log('syncTimerTask fail', error.errorMsg);
1753
+ * },
1754
+ * });
1755
+ * ```
410
1756
  */
411
1757
  export declare const syncTimerTask: typeof ty.device.syncTimerTask;
412
1758
  /**
413
1759
  * @public
414
1760
  * @since @ray-js/ray 0.6.23
1761
+ * @example 基础调用
1762
+ * ```tsx
1763
+ * import { device } from '@ray-js/ray';
1764
+ *
1765
+ * const { addTimer } = device;
1766
+ *
1767
+ * addTimer({
1768
+ * category: 'example',
1769
+ * timer: { time: 'example', loops: 'example', dps: {} },
1770
+ * success: (result) => {
1771
+ * console.log('addTimer success', result);
1772
+ * },
1773
+ * fail: (error) => {
1774
+ * console.log('addTimer fail', error.errorMsg);
1775
+ * },
1776
+ * });
1777
+ * ```
415
1778
  */
416
1779
  export declare const addTimer: typeof ty.device.addTimer;
417
1780
  /**
418
1781
  * @public
419
1782
  * @since @ray-js/ray 0.6.23
1783
+ * @example 基础调用
1784
+ * ```tsx
1785
+ * import { device } from '@ray-js/ray';
1786
+ *
1787
+ * const { updateTimer } = device;
1788
+ *
1789
+ * updateTimer({
1790
+ * timer: { timerId: 'example', time: 'example', loops: 'example', dps: {} },
1791
+ * success: () => {
1792
+ * console.log('updateTimer success');
1793
+ * },
1794
+ * fail: (error) => {
1795
+ * console.log('updateTimer fail', error.errorMsg);
1796
+ * },
1797
+ * });
1798
+ * ```
420
1799
  */
421
1800
  export declare const updateTimer: typeof ty.device.updateTimer;
422
1801
  /**
423
1802
  * @public
424
1803
  * @since @ray-js/ray 0.6.23
1804
+ * @example 基础调用
1805
+ * ```tsx
1806
+ * import { device } from '@ray-js/ray';
1807
+ *
1808
+ * const { updateTimerStatus } = device;
1809
+ *
1810
+ * updateTimerStatus({
1811
+ * timerId: 'example',
1812
+ * status: true,
1813
+ * success: () => {
1814
+ * console.log('updateTimerStatus success');
1815
+ * },
1816
+ * fail: (error) => {
1817
+ * console.log('updateTimerStatus fail', error.errorMsg);
1818
+ * },
1819
+ * });
1820
+ * ```
425
1821
  */
426
1822
  export declare const updateTimerStatus: typeof ty.device.updateTimerStatus;
427
1823
  /**
428
1824
  * @public
429
1825
  * @since @ray-js/ray 0.6.23
1826
+ * @example 基础调用
1827
+ * ```tsx
1828
+ * import { device } from '@ray-js/ray';
1829
+ *
1830
+ * const { removeTimer } = device;
1831
+ *
1832
+ * removeTimer({
1833
+ * timerId: 'example',
1834
+ * success: () => {
1835
+ * console.log('removeTimer success');
1836
+ * },
1837
+ * fail: (error) => {
1838
+ * console.log('removeTimer fail', error.errorMsg);
1839
+ * },
1840
+ * });
1841
+ * ```
430
1842
  */
431
1843
  export declare const removeTimer: typeof ty.device.removeTimer;
432
1844
  /**
433
1845
  * @public
434
1846
  * @since @ray-js/ray 0.6.23
1847
+ * @example 基础调用
1848
+ * ```tsx
1849
+ * import { device } from '@ray-js/ray';
1850
+ *
1851
+ * const { getShareDeviceInfo } = device;
1852
+ *
1853
+ * getShareDeviceInfo({
1854
+ * deviceId: 'device_001',
1855
+ * success: (result) => {
1856
+ * console.log('getShareDeviceInfo success', result);
1857
+ * },
1858
+ * fail: (error) => {
1859
+ * console.log('getShareDeviceInfo fail', error.errorMsg);
1860
+ * },
1861
+ * });
1862
+ * ```
435
1863
  */
436
1864
  export declare const getShareDeviceInfo: typeof ty.device.getShareDeviceInfo;
437
1865
  /**
438
1866
  * @public
439
1867
  * @since @ray-js/ray 0.6.23
1868
+ * @example 基础调用
1869
+ * ```tsx
1870
+ * import { device } from '@ray-js/ray';
1871
+ *
1872
+ * const { openDeviceEdit } = device;
1873
+ *
1874
+ * openDeviceEdit({
1875
+ * deviceId: 'device_001',
1876
+ * success: () => {
1877
+ * console.log('openDeviceEdit success');
1878
+ * },
1879
+ * fail: (error) => {
1880
+ * console.log('openDeviceEdit fail', error.errorMsg);
1881
+ * },
1882
+ * });
1883
+ * ```
440
1884
  */
441
1885
  export declare const openDeviceEdit: typeof ty.device.openDeviceEdit;
442
1886
  /**
443
1887
  * @public
444
1888
  * @since @ray-js/ray 0.6.23
1889
+ * @example 基础调用
1890
+ * ```tsx
1891
+ * import { device } from '@ray-js/ray';
1892
+ *
1893
+ * const { openGroupEdit } = device;
1894
+ *
1895
+ * openGroupEdit({
1896
+ * groupId: 'example',
1897
+ * success: () => {
1898
+ * console.log('openGroupEdit success');
1899
+ * },
1900
+ * fail: (error) => {
1901
+ * console.log('openGroupEdit fail', error.errorMsg);
1902
+ * },
1903
+ * });
1904
+ * ```
445
1905
  */
446
1906
  export declare const openGroupEdit: typeof ty.device.openGroupEdit;
447
1907
  /**
448
1908
  * @public
449
1909
  * @since @ray-js/ray 0.6.23
1910
+ * @example 基础调用
1911
+ * ```tsx
1912
+ * import { device } from '@ray-js/ray';
1913
+ *
1914
+ * const { openDeviceInfo } = device;
1915
+ *
1916
+ * openDeviceInfo({
1917
+ * deviceId: 'device_001',
1918
+ * success: () => {
1919
+ * console.log('openDeviceInfo success');
1920
+ * },
1921
+ * fail: (error) => {
1922
+ * console.log('openDeviceInfo fail', error.errorMsg);
1923
+ * },
1924
+ * });
1925
+ * ```
450
1926
  */
451
1927
  export declare const openDeviceInfo: typeof ty.device.openDeviceInfo;
452
1928
  /**
453
1929
  * @public
454
1930
  * @since @ray-js/ray 0.6.23
1931
+ * @example 基础调用
1932
+ * ```tsx
1933
+ * import { device } from '@ray-js/ray';
1934
+ *
1935
+ * const { isDeviceSupportOfflineReminder } = device;
1936
+ *
1937
+ * isDeviceSupportOfflineReminder({
1938
+ * deviceId: 'device_001',
1939
+ * success: (result) => {
1940
+ * console.log('isDeviceSupportOfflineReminder success', result);
1941
+ * },
1942
+ * fail: (error) => {
1943
+ * console.log('isDeviceSupportOfflineReminder fail', error.errorMsg);
1944
+ * },
1945
+ * });
1946
+ * ```
455
1947
  */
456
1948
  export declare const isDeviceSupportOfflineReminder: typeof ty.device.isDeviceSupportOfflineReminder;
457
1949
  /**
458
1950
  * @public
459
1951
  * @since @ray-js/ray 0.6.23
1952
+ * @example 基础调用
1953
+ * ```tsx
1954
+ * import { device } from '@ray-js/ray';
1955
+ *
1956
+ * const { getDeviceOfflineReminderState } = device;
1957
+ *
1958
+ * getDeviceOfflineReminderState({
1959
+ * deviceId: 'device_001',
1960
+ * success: (result) => {
1961
+ * console.log('getDeviceOfflineReminderState success', result);
1962
+ * },
1963
+ * fail: (error) => {
1964
+ * console.log('getDeviceOfflineReminderState fail', error.errorMsg);
1965
+ * },
1966
+ * });
1967
+ * ```
460
1968
  */
461
1969
  export declare const getDeviceOfflineReminderState: typeof ty.device.getDeviceOfflineReminderState;
462
1970
  /**
463
1971
  * @public
464
1972
  * @since @ray-js/ray 0.6.23
1973
+ * @example 基础调用
1974
+ * ```tsx
1975
+ * import { device } from '@ray-js/ray';
1976
+ *
1977
+ * const { toggleDeviceOfflineReminder } = device;
1978
+ *
1979
+ * toggleDeviceOfflineReminder({
1980
+ * deviceId: 'device_001',
1981
+ * state: 0,
1982
+ * success: () => {
1983
+ * console.log('toggleDeviceOfflineReminder success');
1984
+ * },
1985
+ * fail: (error) => {
1986
+ * console.log('toggleDeviceOfflineReminder fail', error.errorMsg);
1987
+ * },
1988
+ * });
1989
+ * ```
465
1990
  */
466
1991
  export declare const toggleDeviceOfflineReminder: typeof ty.device.toggleDeviceOfflineReminder;
467
1992
  /**
468
1993
  * @public
469
1994
  * @since @ray-js/ray 0.6.23
1995
+ * @example 基础调用
1996
+ * ```tsx
1997
+ * import { device } from '@ray-js/ray';
1998
+ *
1999
+ * const { getDeviceOfflineReminderWarningText } = device;
2000
+ *
2001
+ * getDeviceOfflineReminderWarningText({
2002
+ * success: (result) => {
2003
+ * console.log('getDeviceOfflineReminderWarningText success', result);
2004
+ * },
2005
+ * fail: (error) => {
2006
+ * console.log('getDeviceOfflineReminderWarningText fail', error.errorMsg);
2007
+ * },
2008
+ * });
2009
+ * ```
470
2010
  */
471
2011
  export declare const getDeviceOfflineReminderWarningText: typeof ty.device.getDeviceOfflineReminderWarningText;
472
2012
  /**
473
2013
  * @public
474
2014
  * @since @ray-js/ray 0.6.23
2015
+ * @example 基础调用
2016
+ * ```tsx
2017
+ * import { device } from '@ray-js/ray';
2018
+ *
2019
+ * const { openDeviceQuestionsAndFeedback } = device;
2020
+ *
2021
+ * openDeviceQuestionsAndFeedback({
2022
+ * deviceId: 'device_001',
2023
+ * success: () => {
2024
+ * console.log('openDeviceQuestionsAndFeedback success');
2025
+ * },
2026
+ * fail: (error) => {
2027
+ * console.log('openDeviceQuestionsAndFeedback fail', error.errorMsg);
2028
+ * },
2029
+ * });
2030
+ * ```
475
2031
  */
476
2032
  export declare const openDeviceQuestionsAndFeedback: typeof ty.device.openDeviceQuestionsAndFeedback;
477
2033
  /**
478
2034
  * @public
479
2035
  * @since @ray-js/ray 0.6.23
2036
+ * @example 基础调用
2037
+ * ```tsx
2038
+ * import { device } from '@ray-js/ray';
2039
+ *
2040
+ * const { openShareDevice } = device;
2041
+ *
2042
+ * openShareDevice({
2043
+ * deviceId: 'device_001',
2044
+ * success: () => {
2045
+ * console.log('openShareDevice success');
2046
+ * },
2047
+ * fail: (error) => {
2048
+ * console.log('openShareDevice fail', error.errorMsg);
2049
+ * },
2050
+ * });
2051
+ * ```
480
2052
  */
481
2053
  export declare const openShareDevice: typeof ty.device.openShareDevice;
482
2054
  /**
483
2055
  * @public
484
2056
  * @since @ray-js/ray 0.6.23
2057
+ * @example 基础调用
2058
+ * ```tsx
2059
+ * import { device } from '@ray-js/ray';
2060
+ *
2061
+ * const { addDeviceToDesk } = device;
2062
+ *
2063
+ * addDeviceToDesk({
2064
+ * deviceId: 'device_001',
2065
+ * success: () => {
2066
+ * console.log('addDeviceToDesk success');
2067
+ * },
2068
+ * fail: (error) => {
2069
+ * console.log('addDeviceToDesk fail', error.errorMsg);
2070
+ * },
2071
+ * });
2072
+ * ```
485
2073
  */
486
2074
  export declare const addDeviceToDesk: typeof ty.device.addDeviceToDesk;
487
2075
  /**
488
2076
  * @public
489
2077
  * @since @ray-js/ray 0.6.23
2078
+ * @example 基础调用
2079
+ * ```tsx
2080
+ * import { device } from '@ray-js/ray';
2081
+ *
2082
+ * const { removeShareDevice } = device;
2083
+ *
2084
+ * removeShareDevice({
2085
+ * deviceId: 'device_001',
2086
+ * success: () => {
2087
+ * console.log('removeShareDevice success');
2088
+ * },
2089
+ * fail: (error) => {
2090
+ * console.log('removeShareDevice fail', error.errorMsg);
2091
+ * },
2092
+ * });
2093
+ * ```
490
2094
  */
491
2095
  export declare const removeShareDevice: typeof ty.device.removeShareDevice;
492
2096
  /**
493
2097
  * @public
494
2098
  * @since @ray-js/ray 0.6.23
2099
+ * @example 基础调用
2100
+ * ```tsx
2101
+ * import { device } from '@ray-js/ray';
2102
+ *
2103
+ * const { getSupportedThirdPartyServices } = device;
2104
+ *
2105
+ * getSupportedThirdPartyServices({
2106
+ * deviceId: 'device_001',
2107
+ * success: (result) => {
2108
+ * console.log('getSupportedThirdPartyServices success', result);
2109
+ * },
2110
+ * fail: (error) => {
2111
+ * console.log('getSupportedThirdPartyServices fail', error.errorMsg);
2112
+ * },
2113
+ * });
2114
+ * ```
495
2115
  */
496
2116
  export declare const getSupportedThirdPartyServices: typeof ty.device.getSupportedThirdPartyServices;
497
2117
  /**
498
2118
  * @public
499
2119
  * @since @ray-js/ray 0.6.23
2120
+ * @example 基础调用
2121
+ * ```tsx
2122
+ * import { device } from '@ray-js/ray';
2123
+ *
2124
+ * const { openRecommendSceneDetail } = device;
2125
+ *
2126
+ * openRecommendSceneDetail({
2127
+ * source: 'example',
2128
+ * sceneModel: {},
2129
+ * success: (result) => {
2130
+ * console.log('openRecommendSceneDetail success', result);
2131
+ * },
2132
+ * fail: (error) => {
2133
+ * console.log('openRecommendSceneDetail fail', error.errorMsg);
2134
+ * },
2135
+ * });
2136
+ * ```
500
2137
  */
501
2138
  export declare const openRecommendSceneDetail: typeof ty.device.openRecommendSceneDetail;
502
2139
  /**
503
2140
  * @public
504
2141
  * @since @ray-js/ray 0.6.23
2142
+ * @example 基础调用
2143
+ * ```tsx
2144
+ * import { device } from '@ray-js/ray';
2145
+ *
2146
+ * const { openDeviceExecutionAndAnutomation } = device;
2147
+ *
2148
+ * openDeviceExecutionAndAnutomation({
2149
+ * deviceId: 'device_001',
2150
+ * success: () => {
2151
+ * console.log('openDeviceExecutionAndAnutomation success');
2152
+ * },
2153
+ * fail: (error) => {
2154
+ * console.log('openDeviceExecutionAndAnutomation fail', error.errorMsg);
2155
+ * },
2156
+ * });
2157
+ * ```
505
2158
  */
506
2159
  export declare const openDeviceExecutionAndAnutomation: typeof ty.device.openDeviceExecutionAndAnutomation;
507
2160
  /**
508
2161
  * @public
509
2162
  * @since @ray-js/ray 0.6.23
2163
+ * @example 基础调用
2164
+ * ```tsx
2165
+ * import { device } from '@ray-js/ray';
2166
+ *
2167
+ * const { saveSceneAction } = device;
2168
+ *
2169
+ * saveSceneAction({
2170
+ * deviceId: 'device_001',
2171
+ * taskPosition: 0,
2172
+ * executorProperty: {},
2173
+ * extraProperty: {},
2174
+ * actionDisplayNew: {},
2175
+ * success: () => {
2176
+ * console.log('saveSceneAction success');
2177
+ * },
2178
+ * fail: (error) => {
2179
+ * console.log('saveSceneAction fail', error.errorMsg);
2180
+ * },
2181
+ * });
2182
+ * ```
510
2183
  */
511
2184
  export declare const saveSceneAction: typeof ty.device.saveSceneAction;
512
2185
  /**
513
2186
  * @public
514
2187
  * @since @ray-js/ray 0.6.23
2188
+ * @example 基础调用
2189
+ * ```tsx
2190
+ * import { device } from '@ray-js/ray';
2191
+ *
2192
+ * const { createAction } = device;
2193
+ *
2194
+ * createAction({
2195
+ * createType: 'example',
2196
+ * smartType: 'example',
2197
+ * actionArray: [],
2198
+ * success: (result) => {
2199
+ * console.log('createAction success', result);
2200
+ * },
2201
+ * fail: (error) => {
2202
+ * console.log('createAction fail', error.errorMsg);
2203
+ * },
2204
+ * });
2205
+ * ```
515
2206
  */
516
2207
  export declare const createAction: typeof ty.device.createAction;
517
2208
  /**
518
2209
  * @public
519
2210
  * @since @ray-js/ray 0.6.23
2211
+ * @example 基础调用
2212
+ * ```tsx
2213
+ * import { device } from '@ray-js/ray';
2214
+ *
2215
+ * const { editAction } = device;
2216
+ *
2217
+ * editAction({
2218
+ * editIndex: 'example',
2219
+ * smartType: 'example',
2220
+ * actionArray: [],
2221
+ * success: (result) => {
2222
+ * console.log('editAction success', result);
2223
+ * },
2224
+ * fail: (error) => {
2225
+ * console.log('editAction fail', error.errorMsg);
2226
+ * },
2227
+ * });
2228
+ * ```
520
2229
  */
521
2230
  export declare const editAction: typeof ty.device.editAction;
522
2231
  /**
523
2232
  * @public
524
2233
  * @since @ray-js/ray 0.6.23
2234
+ * @example 基础调用
2235
+ * ```tsx
2236
+ * import { device } from '@ray-js/ray';
2237
+ *
2238
+ * const { showSceneDialog } = device;
2239
+ *
2240
+ * showSceneDialog({
2241
+ * success: (result) => {
2242
+ * console.log('showSceneDialog success', result);
2243
+ * },
2244
+ * fail: (error) => {
2245
+ * console.log('showSceneDialog fail', error.errorMsg);
2246
+ * },
2247
+ * });
2248
+ * ```
525
2249
  */
526
2250
  export declare const showSceneDialog: typeof ty.device.showSceneDialog;
527
2251
  /**
528
2252
  * @public
529
2253
  * @since @ray-js/ray 0.6.23
2254
+ * @example 基础调用
2255
+ * ```tsx
2256
+ * import { device } from '@ray-js/ray';
2257
+ *
2258
+ * const { openPreConditionPage } = device;
2259
+ *
2260
+ * openPreConditionPage({
2261
+ * success: (result) => {
2262
+ * console.log('openPreConditionPage success', result);
2263
+ * },
2264
+ * fail: (error) => {
2265
+ * console.log('openPreConditionPage fail', error.errorMsg);
2266
+ * },
2267
+ * });
2268
+ * ```
530
2269
  */
531
2270
  export declare const openPreConditionPage: typeof ty.device.openPreConditionPage;
532
2271
  /**
533
2272
  * @public
534
2273
  * @since @ray-js/ray 0.6.23
2274
+ * @example 基础调用
2275
+ * ```tsx
2276
+ * import { device } from '@ray-js/ray';
2277
+ *
2278
+ * const { createCondition } = device;
2279
+ *
2280
+ * createCondition({
2281
+ * type: 'example',
2282
+ * success: (result) => {
2283
+ * console.log('createCondition success', result);
2284
+ * },
2285
+ * fail: (error) => {
2286
+ * console.log('createCondition fail', error.errorMsg);
2287
+ * },
2288
+ * });
2289
+ * ```
535
2290
  */
536
2291
  export declare const createCondition: typeof ty.device.createCondition;
537
2292
  /**
538
2293
  * @public
539
2294
  * @since @ray-js/ray 0.6.23
2295
+ * @example 基础调用
2296
+ * ```tsx
2297
+ * import { device } from '@ray-js/ray';
2298
+ *
2299
+ * const { editCondition } = device;
2300
+ *
2301
+ * editCondition({
2302
+ * type: 'example',
2303
+ * success: (result) => {
2304
+ * console.log('editCondition success', result);
2305
+ * },
2306
+ * fail: (error) => {
2307
+ * console.log('editCondition fail', error.errorMsg);
2308
+ * },
2309
+ * });
2310
+ * ```
540
2311
  */
541
2312
  export declare const editCondition: typeof ty.device.editCondition;
542
2313
  /**
543
2314
  * @public
544
2315
  * @since @ray-js/ray 0.6.23
2316
+ * @example 基础调用
2317
+ * ```tsx
2318
+ * import { device } from '@ray-js/ray';
2319
+ *
2320
+ * const { getGroupDeviceList } = device;
2321
+ *
2322
+ * getGroupDeviceList({
2323
+ * groupId: 'example',
2324
+ * success: (result) => {
2325
+ * console.log('getGroupDeviceList success', result);
2326
+ * },
2327
+ * fail: (error) => {
2328
+ * console.log('getGroupDeviceList fail', error.errorMsg);
2329
+ * },
2330
+ * });
2331
+ * ```
545
2332
  */
546
2333
  export declare const getGroupDeviceList: typeof ty.device.getGroupDeviceList;
547
2334
  /**
548
2335
  * @public
549
2336
  * @since @ray-js/ray 0.6.23
2337
+ * @example 基础调用
2338
+ * ```tsx
2339
+ * import { device } from '@ray-js/ray';
2340
+ *
2341
+ * const { getGroupDeviceNum } = device;
2342
+ *
2343
+ * getGroupDeviceNum({
2344
+ * groupId: 'example',
2345
+ * success: (result) => {
2346
+ * console.log('getGroupDeviceNum success', result);
2347
+ * },
2348
+ * fail: (error) => {
2349
+ * console.log('getGroupDeviceNum fail', error.errorMsg);
2350
+ * },
2351
+ * });
2352
+ * ```
550
2353
  */
551
2354
  export declare const getGroupDeviceNum: typeof ty.device.getGroupDeviceNum;
552
2355
  /**
553
2356
  * @public
554
2357
  * @since @ray-js/ray 0.6.23
2358
+ * @example 基础调用
2359
+ * ```tsx
2360
+ * import { device } from '@ray-js/ray';
2361
+ *
2362
+ * const { getDeviceNumWithDpCode } = device;
2363
+ *
2364
+ * getDeviceNumWithDpCode({
2365
+ * groupId: 'example',
2366
+ * dpCode: 'switch_led',
2367
+ * success: (result) => {
2368
+ * console.log('getDeviceNumWithDpCode success', result);
2369
+ * },
2370
+ * fail: (error) => {
2371
+ * console.log('getDeviceNumWithDpCode fail', error.errorMsg);
2372
+ * },
2373
+ * });
2374
+ * ```
555
2375
  */
556
2376
  export declare const getDeviceNumWithDpCode: typeof ty.device.getDeviceNumWithDpCode;
557
2377
  /**
558
2378
  * @public
559
2379
  * @since @ray-js/ray 0.6.23
2380
+ * @example 基础调用
2381
+ * ```tsx
2382
+ * import { device } from '@ray-js/ray';
2383
+ *
2384
+ * const { publishGroupDpCodes } = device;
2385
+ *
2386
+ * publishGroupDpCodes({
2387
+ * groupId: 'example',
2388
+ * dpCodes: {},
2389
+ * success: () => {
2390
+ * console.log('publishGroupDpCodes success');
2391
+ * },
2392
+ * fail: (error) => {
2393
+ * console.log('publishGroupDpCodes fail', error.errorMsg);
2394
+ * },
2395
+ * });
2396
+ * ```
560
2397
  */
561
2398
  export declare const publishGroupDpCodes: typeof ty.device.publishGroupDpCodes;
562
2399
  /**
563
2400
  * @public
564
2401
  * @since @ray-js/ray 0.6.23
2402
+ * @example 基础调用
2403
+ * ```tsx
2404
+ * import { device } from '@ray-js/ray';
2405
+ *
2406
+ * const { publishSigMeshMultiDps } = device;
2407
+ *
2408
+ * publishSigMeshMultiDps({
2409
+ * groupId: 'example',
2410
+ * localId: 'example',
2411
+ * dps: {},
2412
+ * pcc: 'example',
2413
+ * success: () => {
2414
+ * console.log('publishSigMeshMultiDps success');
2415
+ * },
2416
+ * fail: (error) => {
2417
+ * console.log('publishSigMeshMultiDps fail', error.errorMsg);
2418
+ * },
2419
+ * });
2420
+ * ```
565
2421
  */
566
2422
  export declare const publishSigMeshMultiDps: typeof ty.device.publishSigMeshMultiDps;
567
2423
  /**
568
2424
  * @public
569
2425
  * @since @ray-js/ray 0.6.23
2426
+ * @example 基础调用
2427
+ * ```tsx
2428
+ * import { device } from '@ray-js/ray';
2429
+ *
2430
+ * const { openMeshLocalGroup } = device;
2431
+ *
2432
+ * openMeshLocalGroup({
2433
+ * deviceId: 'device_001',
2434
+ * localId: 'example',
2435
+ * vendorIds: 'example',
2436
+ * success: () => {
2437
+ * console.log('openMeshLocalGroup success');
2438
+ * },
2439
+ * fail: (error) => {
2440
+ * console.log('openMeshLocalGroup fail', error.errorMsg);
2441
+ * },
2442
+ * });
2443
+ * ```
570
2444
  */
571
2445
  export declare const openMeshLocalGroup: typeof ty.device.openMeshLocalGroup;
572
2446
  /**
573
2447
  * @public
574
2448
  * @since @ray-js/ray 0.6.23
2449
+ * @example 基础调用
2450
+ * ```tsx
2451
+ * import { device } from '@ray-js/ray';
2452
+ *
2453
+ * const { getGroupInfo } = device;
2454
+ *
2455
+ * getGroupInfo({
2456
+ * groupId: 'example',
2457
+ * success: (result) => {
2458
+ * console.log('getGroupInfo success', result);
2459
+ * },
2460
+ * fail: (error) => {
2461
+ * console.log('getGroupInfo fail', error.errorMsg);
2462
+ * },
2463
+ * });
2464
+ * ```
575
2465
  */
576
2466
  export declare const getGroupInfo: typeof ty.device.getGroupInfo;
577
2467
  /**
578
2468
  * @public
579
2469
  * @since @ray-js/ray 0.6.23
2470
+ * @example 基础调用
2471
+ * ```tsx
2472
+ * import { device } from '@ray-js/ray';
2473
+ *
2474
+ * const { publishGroupDps } = device;
2475
+ *
2476
+ * publishGroupDps({
2477
+ * groupId: 'example',
2478
+ * dps: {},
2479
+ * success: () => {
2480
+ * console.log('publishGroupDps success');
2481
+ * },
2482
+ * fail: (error) => {
2483
+ * console.log('publishGroupDps fail', error.errorMsg);
2484
+ * },
2485
+ * });
2486
+ * ```
580
2487
  */
581
2488
  export declare const publishGroupDps: typeof ty.device.publishGroupDps;
582
2489
  /**
583
2490
  * @public
584
2491
  * @since @ray-js/ray 0.6.23
2492
+ * @example 基础调用
2493
+ * ```tsx
2494
+ * import { device } from '@ray-js/ray';
2495
+ *
2496
+ * const { getGroupProperty } = device;
2497
+ *
2498
+ * getGroupProperty({
2499
+ * groupId: 'example',
2500
+ * success: (result) => {
2501
+ * console.log('getGroupProperty success', result);
2502
+ * },
2503
+ * fail: (error) => {
2504
+ * console.log('getGroupProperty fail', error.errorMsg);
2505
+ * },
2506
+ * });
2507
+ * ```
585
2508
  */
586
2509
  export declare const getGroupProperty: typeof ty.device.getGroupProperty;
587
2510
  /**
588
2511
  * @public
589
2512
  * @since @ray-js/ray 0.6.23
2513
+ * @example 基础调用
2514
+ * ```tsx
2515
+ * import { device } from '@ray-js/ray';
2516
+ *
2517
+ * const { setGroupProperty } = device;
2518
+ *
2519
+ * setGroupProperty({
2520
+ * groupId: 'example',
2521
+ * code: 'example',
2522
+ * value: 'example',
2523
+ * success: () => {
2524
+ * console.log('setGroupProperty success');
2525
+ * },
2526
+ * fail: (error) => {
2527
+ * console.log('setGroupProperty fail', error.errorMsg);
2528
+ * },
2529
+ * });
2530
+ * ```
590
2531
  */
591
2532
  export declare const setGroupProperty: typeof ty.device.setGroupProperty;
592
2533
  /**
593
2534
  * @public
594
2535
  * @since @ray-js/ray 0.6.23
2536
+ * @example 基础调用
2537
+ * ```tsx
2538
+ * import { device } from '@ray-js/ray';
2539
+ *
2540
+ * const { registerGroupChange } = device;
2541
+ *
2542
+ * registerGroupChange({
2543
+ * groupIdList: ['example'],
2544
+ * success: () => {
2545
+ * console.log('registerGroupChange success');
2546
+ * },
2547
+ * fail: (error) => {
2548
+ * console.log('registerGroupChange fail', error.errorMsg);
2549
+ * },
2550
+ * });
2551
+ * ```
595
2552
  */
596
2553
  export declare const registerGroupChange: typeof ty.device.registerGroupChange;
597
2554
  /**
598
2555
  * @public
599
2556
  * @since @ray-js/ray 0.6.23
2557
+ * @example 基础调用
2558
+ * ```tsx
2559
+ * import { device } from '@ray-js/ray';
2560
+ *
2561
+ * const { unRegisterGroupChange } = device;
2562
+ *
2563
+ * unRegisterGroupChange({
2564
+ * success: () => {
2565
+ * console.log('unRegisterGroupChange success');
2566
+ * },
2567
+ * fail: (error) => {
2568
+ * console.log('unRegisterGroupChange fail', error.errorMsg);
2569
+ * },
2570
+ * });
2571
+ * ```
600
2572
  */
601
2573
  export declare const unRegisterGroupChange: typeof ty.device.unRegisterGroupChange;
602
2574
  /**
603
2575
  * @public
604
2576
  * @since @ray-js/ray 0.6.23
2577
+ * @example 基础调用
2578
+ * ```tsx
2579
+ * import { device } from '@ray-js/ray';
2580
+ *
2581
+ * const { getMeshDeviceId } = device;
2582
+ *
2583
+ * getMeshDeviceId({
2584
+ * nodeId: 'example',
2585
+ * deviceId: 'device_001',
2586
+ * success: (result) => {
2587
+ * console.log('getMeshDeviceId success', result);
2588
+ * },
2589
+ * fail: (error) => {
2590
+ * console.log('getMeshDeviceId fail', error.errorMsg);
2591
+ * },
2592
+ * });
2593
+ * ```
605
2594
  */
606
2595
  export declare const getMeshDeviceId: typeof ty.device.getMeshDeviceId;
607
2596
  /**
608
2597
  * @public
609
2598
  * @since @ray-js/ray 0.6.23
2599
+ * @example 基础调用
2600
+ * ```tsx
2601
+ * import { device } from '@ray-js/ray';
2602
+ *
2603
+ * const { getDpDataByMesh } = device;
2604
+ *
2605
+ * getDpDataByMesh({
2606
+ * deviceId: 'device_001',
2607
+ * dpIds: [],
2608
+ * success: () => {
2609
+ * console.log('getDpDataByMesh success');
2610
+ * },
2611
+ * fail: (error) => {
2612
+ * console.log('getDpDataByMesh fail', error.errorMsg);
2613
+ * },
2614
+ * });
2615
+ * ```
610
2616
  */
611
2617
  export declare const getDpDataByMesh: typeof ty.device.getDpDataByMesh;
612
2618
  /**
613
2619
  * @public
614
2620
  * @since @ray-js/ray 0.6.23
2621
+ * @example 基础调用
2622
+ * ```tsx
2623
+ * import { device } from '@ray-js/ray';
2624
+ *
2625
+ * const { checkOTAUpgradeStatus } = device;
2626
+ *
2627
+ * checkOTAUpgradeStatus({
2628
+ * deviceId: 'device_001',
2629
+ * success: (result) => {
2630
+ * console.log('checkOTAUpgradeStatus success', result);
2631
+ * },
2632
+ * fail: (error) => {
2633
+ * console.log('checkOTAUpgradeStatus fail', error.errorMsg);
2634
+ * },
2635
+ * });
2636
+ * ```
615
2637
  */
616
2638
  export declare const checkOTAUpgradeStatus: typeof ty.device.checkOTAUpgradeStatus;
617
2639
  /**
618
2640
  * @public
619
2641
  * @since @ray-js/ray 0.6.23
2642
+ * @example 基础调用
2643
+ * ```tsx
2644
+ * import { device } from '@ray-js/ray';
2645
+ *
2646
+ * const { openOTAUpgrade } = device;
2647
+ *
2648
+ * openOTAUpgrade({
2649
+ * deviceId: 'device_001',
2650
+ * success: () => {
2651
+ * console.log('openOTAUpgrade success');
2652
+ * },
2653
+ * fail: (error) => {
2654
+ * console.log('openOTAUpgrade fail', error.errorMsg);
2655
+ * },
2656
+ * });
2657
+ * ```
620
2658
  */
621
2659
  export declare const openOTAUpgrade: typeof ty.device.openOTAUpgrade;
622
2660
  /**
623
2661
  * @public
624
2662
  * @since @ray-js/ray 0.6.23
2663
+ * @example 基础调用
2664
+ * ```tsx
2665
+ * import { device } from '@ray-js/ray';
2666
+ *
2667
+ * const { deviceIsSupportThingModel } = device;
2668
+ *
2669
+ * deviceIsSupportThingModel({
2670
+ * devId: 'device_001',
2671
+ * success: (result) => {
2672
+ * console.log('deviceIsSupportThingModel success', result);
2673
+ * },
2674
+ * fail: (error) => {
2675
+ * console.log('deviceIsSupportThingModel fail', error.errorMsg);
2676
+ * },
2677
+ * });
2678
+ * ```
625
2679
  */
626
2680
  export declare const deviceIsSupportThingModel: typeof ty.device.deviceIsSupportThingModel;
627
2681
  /**
628
2682
  * @public
629
2683
  * @since @ray-js/ray 0.6.23
2684
+ * @example 基础调用
2685
+ * ```tsx
2686
+ * import { device } from '@ray-js/ray';
2687
+ *
2688
+ * const { updateDeviceThingModelInfo } = device;
2689
+ *
2690
+ * updateDeviceThingModelInfo({
2691
+ * pid: 'example',
2692
+ * productVersion: 'example',
2693
+ * success: () => {
2694
+ * console.log('updateDeviceThingModelInfo success');
2695
+ * },
2696
+ * fail: (error) => {
2697
+ * console.log('updateDeviceThingModelInfo fail', error.errorMsg);
2698
+ * },
2699
+ * });
2700
+ * ```
630
2701
  */
631
2702
  export declare const updateDeviceThingModelInfo: typeof ty.device.updateDeviceThingModelInfo;
632
2703
  /**
633
2704
  * @public
634
2705
  * @since @ray-js/ray 0.6.23
2706
+ * @example 基础调用
2707
+ * ```tsx
2708
+ * import { device } from '@ray-js/ray';
2709
+ *
2710
+ * const { getDeviceThingModelInfo } = device;
2711
+ *
2712
+ * getDeviceThingModelInfo({
2713
+ * devId: 'device_001',
2714
+ * success: (result) => {
2715
+ * console.log('getDeviceThingModelInfo success', result);
2716
+ * },
2717
+ * fail: (error) => {
2718
+ * console.log('getDeviceThingModelInfo fail', error.errorMsg);
2719
+ * },
2720
+ * });
2721
+ * ```
635
2722
  */
636
2723
  export declare const getDeviceThingModelInfo: typeof ty.device.getDeviceThingModelInfo;
637
2724
  /**
638
2725
  * @public
639
2726
  * @since @ray-js/ray 0.6.23
2727
+ * @example 基础调用
2728
+ * ```tsx
2729
+ * import { device } from '@ray-js/ray';
2730
+ *
2731
+ * const { publishThingModelMessage } = device;
2732
+ *
2733
+ * publishThingModelMessage({
2734
+ * devId: 'device_001',
2735
+ * type: 0,
2736
+ * payload: {},
2737
+ * success: () => {
2738
+ * console.log('publishThingModelMessage success');
2739
+ * },
2740
+ * fail: (error) => {
2741
+ * console.log('publishThingModelMessage fail', error.errorMsg);
2742
+ * },
2743
+ * });
2744
+ * ```
640
2745
  */
641
2746
  export declare const publishThingModelMessage: typeof ty.device.publishThingModelMessage;
642
2747
  /**
643
2748
  * @public
644
2749
  * @since @ray-js/ray 0.6.23
2750
+ * @example 基础调用
2751
+ * ```tsx
2752
+ * import { device } from '@ray-js/ray';
2753
+ *
2754
+ * const { subscribeReceivedThingModelMessage } = device;
2755
+ *
2756
+ * subscribeReceivedThingModelMessage({
2757
+ * devId: 'device_001',
2758
+ * success: () => {
2759
+ * console.log('subscribeReceivedThingModelMessage success');
2760
+ * },
2761
+ * fail: (error) => {
2762
+ * console.log('subscribeReceivedThingModelMessage fail', error.errorMsg);
2763
+ * },
2764
+ * });
2765
+ * ```
645
2766
  */
646
2767
  export declare const subscribeReceivedThingModelMessage: typeof ty.device.subscribeReceivedThingModelMessage;
647
2768
  /**
648
2769
  * @public
649
2770
  * @since @ray-js/ray 0.6.23
2771
+ * @example 基础调用
2772
+ * ```tsx
2773
+ * import { device } from '@ray-js/ray';
2774
+ *
2775
+ * const { unSubscribeReceivedThingModelMessage } = device;
2776
+ *
2777
+ * unSubscribeReceivedThingModelMessage({
2778
+ * devId: 'device_001',
2779
+ * success: () => {
2780
+ * console.log('unSubscribeReceivedThingModelMessage success');
2781
+ * },
2782
+ * fail: (error) => {
2783
+ * console.log('unSubscribeReceivedThingModelMessage fail', error.errorMsg);
2784
+ * },
2785
+ * });
2786
+ * ```
650
2787
  */
651
2788
  export declare const unSubscribeReceivedThingModelMessage: typeof ty.device.unSubscribeReceivedThingModelMessage;
652
2789
  /**
653
2790
  * @public
654
2791
  * @since @ray-js/ray 0.6.23
2792
+ * @example 基础调用
2793
+ * ```tsx
2794
+ * import { device } from '@ray-js/ray';
2795
+ *
2796
+ * const { onLeaveBeaconFence } = device;
2797
+ *
2798
+ * onLeaveBeaconFence((res) => {
2799
+ * console.log('onLeaveBeaconFence', res);
2800
+ * });
2801
+ * ```
655
2802
  */
656
2803
  export declare const onLeaveBeaconFence: typeof ty.device.onLeaveBeaconFence;
657
2804
  /**
658
2805
  * @public
659
2806
  * @since @ray-js/ray 0.6.23
2807
+ * @example 基础调用
2808
+ * ```tsx
2809
+ * import { device } from '@ray-js/ray';
2810
+ *
2811
+ * const { offLeaveBeaconFence } = device;
2812
+ *
2813
+ * offLeaveBeaconFence((res) => {
2814
+ * console.log('offLeaveBeaconFence', res);
2815
+ * });
2816
+ * ```
660
2817
  */
661
2818
  export declare const offLeaveBeaconFence: typeof ty.device.offLeaveBeaconFence;
662
2819
  /**
663
2820
  * @public
664
2821
  * @since @ray-js/ray 0.6.23
2822
+ * @example 基础调用
2823
+ * ```tsx
2824
+ * import { device } from '@ray-js/ray';
2825
+ *
2826
+ * const { onFileTransferProgress } = device;
2827
+ *
2828
+ * onFileTransferProgress((res) => {
2829
+ * console.log('onFileTransferProgress', res);
2830
+ * });
2831
+ * ```
665
2832
  */
666
2833
  export declare const onFileTransferProgress: typeof ty.device.onFileTransferProgress;
667
2834
  /**
668
2835
  * @public
669
2836
  * @since @ray-js/ray 0.6.23
2837
+ * @example 基础调用
2838
+ * ```tsx
2839
+ * import { device } from '@ray-js/ray';
2840
+ *
2841
+ * const { offFileTransferProgress } = device;
2842
+ *
2843
+ * offFileTransferProgress((res) => {
2844
+ * console.log('offFileTransferProgress', res);
2845
+ * });
2846
+ * ```
670
2847
  */
671
2848
  export declare const offFileTransferProgress: typeof ty.device.offFileTransferProgress;
672
2849
  /**
673
2850
  * @public
674
2851
  * @since @ray-js/ray 0.6.23
2852
+ * @example 基础调用
2853
+ * ```tsx
2854
+ * import { device } from '@ray-js/ray';
2855
+ *
2856
+ * const { onBLEConnectStatusChange } = device;
2857
+ *
2858
+ * onBLEConnectStatusChange((res) => {
2859
+ * console.log('onBLEConnectStatusChange', res);
2860
+ * });
2861
+ * ```
675
2862
  */
676
2863
  export declare const onBLEConnectStatusChange: typeof ty.device.onBLEConnectStatusChange;
677
2864
  /**
678
2865
  * @public
679
2866
  * @since @ray-js/ray 0.6.23
2867
+ * @example 基础调用
2868
+ * ```tsx
2869
+ * import { device } from '@ray-js/ray';
2870
+ *
2871
+ * const { offBLEConnectStatusChange } = device;
2872
+ *
2873
+ * offBLEConnectStatusChange((res) => {
2874
+ * console.log('offBLEConnectStatusChange', res);
2875
+ * });
2876
+ * ```
680
2877
  */
681
2878
  export declare const offBLEConnectStatusChange: typeof ty.device.offBLEConnectStatusChange;
682
2879
  /**
683
2880
  * @public
684
2881
  * @since @ray-js/ray 0.6.23
2882
+ * @example 基础调用
2883
+ * ```tsx
2884
+ * import { device } from '@ray-js/ray';
2885
+ *
2886
+ * const { onBLETransparentDataReport } = device;
2887
+ *
2888
+ * onBLETransparentDataReport((res) => {
2889
+ * console.log('onBLETransparentDataReport', res);
2890
+ * });
2891
+ * ```
685
2892
  */
686
2893
  export declare const onBLETransparentDataReport: typeof ty.device.onBLETransparentDataReport;
687
2894
  /**
688
2895
  * @public
689
2896
  * @since @ray-js/ray 0.6.23
2897
+ * @example 基础调用
2898
+ * ```tsx
2899
+ * import { device } from '@ray-js/ray';
2900
+ *
2901
+ * const { offBLETransparentDataReport } = device;
2902
+ *
2903
+ * offBLETransparentDataReport((res) => {
2904
+ * console.log('offBLETransparentDataReport', res);
2905
+ * });
2906
+ * ```
690
2907
  */
691
2908
  export declare const offBLETransparentDataReport: typeof ty.device.offBLETransparentDataReport;
692
2909
  /**
693
2910
  * @public
694
2911
  * @since @ray-js/ray 0.6.23
2912
+ * @example 基础调用
2913
+ * ```tsx
2914
+ * import { device } from '@ray-js/ray';
2915
+ *
2916
+ * const { onBLEBigDataChannelProgressEvent } = device;
2917
+ *
2918
+ * onBLEBigDataChannelProgressEvent((res) => {
2919
+ * console.log('onBLEBigDataChannelProgressEvent', res);
2920
+ * });
2921
+ * ```
695
2922
  */
696
2923
  export declare const onBLEBigDataChannelProgressEvent: typeof ty.device.onBLEBigDataChannelProgressEvent;
697
2924
  /**
698
2925
  * @public
699
2926
  * @since @ray-js/ray 0.6.23
2927
+ * @example 基础调用
2928
+ * ```tsx
2929
+ * import { device } from '@ray-js/ray';
2930
+ *
2931
+ * const { offBLEBigDataChannelProgressEvent } = device;
2932
+ *
2933
+ * offBLEBigDataChannelProgressEvent((res) => {
2934
+ * console.log('offBLEBigDataChannelProgressEvent', res);
2935
+ * });
2936
+ * ```
700
2937
  */
701
2938
  export declare const offBLEBigDataChannelProgressEvent: typeof ty.device.offBLEBigDataChannelProgressEvent;
702
2939
  /**
703
2940
  * @public
704
2941
  * @since @ray-js/ray 0.6.23
2942
+ * @example 基础调用
2943
+ * ```tsx
2944
+ * import { device } from '@ray-js/ray';
2945
+ *
2946
+ * const { onBLEScanBindDevice } = device;
2947
+ *
2948
+ * onBLEScanBindDevice((res) => {
2949
+ * console.log('onBLEScanBindDevice', res);
2950
+ * });
2951
+ * ```
705
2952
  */
706
2953
  export declare const onBLEScanBindDevice: typeof ty.device.onBLEScanBindDevice;
707
2954
  /**
708
2955
  * @public
709
2956
  * @since @ray-js/ray 0.6.23
2957
+ * @example 基础调用
2958
+ * ```tsx
2959
+ * import { device } from '@ray-js/ray';
2960
+ *
2961
+ * const { offBLEScanBindDevice } = device;
2962
+ *
2963
+ * offBLEScanBindDevice((res) => {
2964
+ * console.log('offBLEScanBindDevice', res);
2965
+ * });
2966
+ * ```
710
2967
  */
711
2968
  export declare const offBLEScanBindDevice: typeof ty.device.offBLEScanBindDevice;
712
2969
  /**
713
2970
  * @public
714
2971
  * @since @ray-js/ray 0.6.23
2972
+ * @example 基础调用
2973
+ * ```tsx
2974
+ * import { device } from '@ray-js/ray';
2975
+ *
2976
+ * const { onBLEBigDataChannelDeviceToAppSuccess } = device;
2977
+ *
2978
+ * onBLEBigDataChannelDeviceToAppSuccess((res) => {
2979
+ * console.log('onBLEBigDataChannelDeviceToAppSuccess', res);
2980
+ * });
2981
+ * ```
715
2982
  */
716
2983
  export declare const onBLEBigDataChannelDeviceToAppSuccess: typeof ty.device.onBLEBigDataChannelDeviceToAppSuccess;
717
2984
  /**
718
2985
  * @public
719
2986
  * @since @ray-js/ray 0.6.23
2987
+ * @example 基础调用
2988
+ * ```tsx
2989
+ * import { device } from '@ray-js/ray';
2990
+ *
2991
+ * const { offBLEBigDataChannelDeviceToAppSuccess } = device;
2992
+ *
2993
+ * offBLEBigDataChannelDeviceToAppSuccess((res) => {
2994
+ * console.log('offBLEBigDataChannelDeviceToAppSuccess', res);
2995
+ * });
2996
+ * ```
720
2997
  */
721
2998
  export declare const offBLEBigDataChannelDeviceToAppSuccess: typeof ty.device.offBLEBigDataChannelDeviceToAppSuccess;
722
2999
  /**
723
3000
  * @public
724
3001
  * @since @ray-js/ray 0.6.23
3002
+ * @example 基础调用
3003
+ * ```tsx
3004
+ * import { device } from '@ray-js/ray';
3005
+ *
3006
+ * const { onBLEBigDataChannelUploadCloudProgress } = device;
3007
+ *
3008
+ * onBLEBigDataChannelUploadCloudProgress((res) => {
3009
+ * console.log('onBLEBigDataChannelUploadCloudProgress', res);
3010
+ * });
3011
+ * ```
725
3012
  */
726
3013
  export declare const onBLEBigDataChannelUploadCloudProgress: typeof ty.device.onBLEBigDataChannelUploadCloudProgress;
727
3014
  /**
728
3015
  * @public
729
3016
  * @since @ray-js/ray 0.6.23
3017
+ * @example 基础调用
3018
+ * ```tsx
3019
+ * import { device } from '@ray-js/ray';
3020
+ *
3021
+ * const { offBLEBigDataChannelUploadCloudProgress } = device;
3022
+ *
3023
+ * offBLEBigDataChannelUploadCloudProgress((res) => {
3024
+ * console.log('offBLEBigDataChannelUploadCloudProgress', res);
3025
+ * });
3026
+ * ```
730
3027
  */
731
3028
  export declare const offBLEBigDataChannelUploadCloudProgress: typeof ty.device.offBLEBigDataChannelUploadCloudProgress;
732
3029
  /**
733
3030
  * @public
734
3031
  * @since @ray-js/ray 0.6.23
3032
+ * @example 基础调用
3033
+ * ```tsx
3034
+ * import { device } from '@ray-js/ray';
3035
+ *
3036
+ * const { onSubDeviceInfoUpdateEvent } = device;
3037
+ *
3038
+ * onSubDeviceInfoUpdateEvent((res) => {
3039
+ * console.log('onSubDeviceInfoUpdateEvent', res);
3040
+ * });
3041
+ * ```
735
3042
  */
736
3043
  export declare const onSubDeviceInfoUpdateEvent: typeof ty.device.onSubDeviceInfoUpdateEvent;
737
3044
  /**
738
3045
  * @public
739
3046
  * @since @ray-js/ray 0.6.23
3047
+ * @example 基础调用
3048
+ * ```tsx
3049
+ * import { device } from '@ray-js/ray';
3050
+ *
3051
+ * const { offSubDeviceInfoUpdateEvent } = device;
3052
+ *
3053
+ * offSubDeviceInfoUpdateEvent((res) => {
3054
+ * console.log('offSubDeviceInfoUpdateEvent', res);
3055
+ * });
3056
+ * ```
740
3057
  */
741
3058
  export declare const offSubDeviceInfoUpdateEvent: typeof ty.device.offSubDeviceInfoUpdateEvent;
742
3059
  /**
743
3060
  * @public
744
3061
  * @since @ray-js/ray 0.6.23
3062
+ * @example 基础调用
3063
+ * ```tsx
3064
+ * import { device } from '@ray-js/ray';
3065
+ *
3066
+ * const { onDirectlyConnectedSearchDeviceEvent } = device;
3067
+ *
3068
+ * onDirectlyConnectedSearchDeviceEvent((res) => {
3069
+ * console.log('onDirectlyConnectedSearchDeviceEvent', res);
3070
+ * });
3071
+ * ```
745
3072
  */
746
3073
  export declare const onDirectlyConnectedSearchDeviceEvent: typeof ty.device.onDirectlyConnectedSearchDeviceEvent;
747
3074
  /**
748
3075
  * @public
749
3076
  * @since @ray-js/ray 0.6.23
3077
+ * @example 基础调用
3078
+ * ```tsx
3079
+ * import { device } from '@ray-js/ray';
3080
+ *
3081
+ * const { offDirectlyConnectedSearchDeviceEvent } = device;
3082
+ *
3083
+ * offDirectlyConnectedSearchDeviceEvent((res) => {
3084
+ * console.log('offDirectlyConnectedSearchDeviceEvent', res);
3085
+ * });
3086
+ * ```
750
3087
  */
751
3088
  export declare const offDirectlyConnectedSearchDeviceEvent: typeof ty.device.offDirectlyConnectedSearchDeviceEvent;
752
3089
  /**
753
3090
  * @public
754
3091
  * @since @ray-js/ray 0.6.23
3092
+ * @example 基础调用
3093
+ * ```tsx
3094
+ * import { device } from '@ray-js/ray';
3095
+ *
3096
+ * const { onDpDataChange } = device;
3097
+ *
3098
+ * onDpDataChange((result) => {
3099
+ * console.log('onDpDataChange', result);
3100
+ * });
3101
+ * ```
755
3102
  */
756
3103
  export declare const onDpDataChange: typeof ty.device.onDpDataChange;
757
3104
  /**
758
3105
  * @public
759
3106
  * @since @ray-js/ray 0.6.23
3107
+ * @example 基础调用
3108
+ * ```tsx
3109
+ * import { device } from '@ray-js/ray';
3110
+ *
3111
+ * const { offDpDataChange } = device;
3112
+ *
3113
+ * offDpDataChange((result) => {
3114
+ * console.log('offDpDataChange', result);
3115
+ * });
3116
+ * ```
760
3117
  */
761
3118
  export declare const offDpDataChange: typeof ty.device.offDpDataChange;
762
3119
  /**
763
3120
  * @public
764
3121
  * @since @ray-js/ray 0.6.23
3122
+ * @example 基础调用
3123
+ * ```tsx
3124
+ * import { device } from '@ray-js/ray';
3125
+ *
3126
+ * const { onMqttMessageReceived } = device;
3127
+ *
3128
+ * onMqttMessageReceived((res) => {
3129
+ * console.log('onMqttMessageReceived', res);
3130
+ * });
3131
+ * ```
765
3132
  */
766
3133
  export declare const onMqttMessageReceived: typeof ty.device.onMqttMessageReceived;
767
3134
  /**
768
3135
  * @public
769
3136
  * @since @ray-js/ray 0.6.23
3137
+ * @example 基础调用
3138
+ * ```tsx
3139
+ * import { device } from '@ray-js/ray';
3140
+ *
3141
+ * const { offMqttMessageReceived } = device;
3142
+ *
3143
+ * offMqttMessageReceived((res) => {
3144
+ * console.log('offMqttMessageReceived', res);
3145
+ * });
3146
+ * ```
770
3147
  */
771
3148
  export declare const offMqttMessageReceived: typeof ty.device.offMqttMessageReceived;
772
3149
  /**
773
3150
  * @public
774
3151
  * @since @ray-js/ray 0.6.23
3152
+ * @example 基础调用
3153
+ * ```tsx
3154
+ * import { device } from '@ray-js/ray';
3155
+ *
3156
+ * const { onSocketMessageReceived } = device;
3157
+ *
3158
+ * onSocketMessageReceived((res) => {
3159
+ * console.log('onSocketMessageReceived', res);
3160
+ * });
3161
+ * ```
775
3162
  */
776
3163
  export declare const onSocketMessageReceived: typeof ty.device.onSocketMessageReceived;
777
3164
  /**
778
3165
  * @public
779
3166
  * @since @ray-js/ray 0.6.23
3167
+ * @example 基础调用
3168
+ * ```tsx
3169
+ * import { device } from '@ray-js/ray';
3170
+ *
3171
+ * const { offSocketMessageReceived } = device;
3172
+ *
3173
+ * offSocketMessageReceived((res) => {
3174
+ * console.log('offSocketMessageReceived', res);
3175
+ * });
3176
+ * ```
780
3177
  */
781
3178
  export declare const offSocketMessageReceived: typeof ty.device.offSocketMessageReceived;
782
3179
  /**
783
3180
  * @public
784
3181
  * @since @ray-js/ray 0.6.23
3182
+ * @example 基础调用
3183
+ * ```tsx
3184
+ * import { device } from '@ray-js/ray';
3185
+ *
3186
+ * const { onDeviceOnlineStatusUpdate } = device;
3187
+ *
3188
+ * onDeviceOnlineStatusUpdate((res) => {
3189
+ * console.log('onDeviceOnlineStatusUpdate', res);
3190
+ * });
3191
+ * ```
785
3192
  */
786
3193
  export declare const onDeviceOnlineStatusUpdate: typeof ty.device.onDeviceOnlineStatusUpdate;
787
3194
  /**
788
3195
  * @public
789
3196
  * @since @ray-js/ray 0.6.23
3197
+ * @example 基础调用
3198
+ * ```tsx
3199
+ * import { device } from '@ray-js/ray';
3200
+ *
3201
+ * const { offDeviceOnlineStatusUpdate } = device;
3202
+ *
3203
+ * offDeviceOnlineStatusUpdate((res) => {
3204
+ * console.log('offDeviceOnlineStatusUpdate', res);
3205
+ * });
3206
+ * ```
790
3207
  */
791
3208
  export declare const offDeviceOnlineStatusUpdate: typeof ty.device.offDeviceOnlineStatusUpdate;
792
3209
  /**
793
3210
  * @public
794
3211
  * @since @ray-js/ray 0.6.23
3212
+ * @example 基础调用
3213
+ * ```tsx
3214
+ * import { device } from '@ray-js/ray';
3215
+ *
3216
+ * const { onDeviceInfoUpdated } = device;
3217
+ *
3218
+ * onDeviceInfoUpdated((res) => {
3219
+ * console.log('onDeviceInfoUpdated', res);
3220
+ * });
3221
+ * ```
795
3222
  */
796
3223
  export declare const onDeviceInfoUpdated: typeof ty.device.onDeviceInfoUpdated;
797
3224
  /**
798
3225
  * @public
799
3226
  * @since @ray-js/ray 0.6.23
3227
+ * @example 基础调用
3228
+ * ```tsx
3229
+ * import { device } from '@ray-js/ray';
3230
+ *
3231
+ * const { offDeviceInfoUpdated } = device;
3232
+ *
3233
+ * offDeviceInfoUpdated((res) => {
3234
+ * console.log('offDeviceInfoUpdated', res);
3235
+ * });
3236
+ * ```
800
3237
  */
801
3238
  export declare const offDeviceInfoUpdated: typeof ty.device.offDeviceInfoUpdated;
802
3239
  /**
803
3240
  * @public
804
3241
  * @since @ray-js/ray 0.6.23
3242
+ * @example 基础调用
3243
+ * ```tsx
3244
+ * import { device } from '@ray-js/ray';
3245
+ *
3246
+ * const { onDeviceRemoved } = device;
3247
+ *
3248
+ * onDeviceRemoved((res) => {
3249
+ * console.log('onDeviceRemoved', res);
3250
+ * });
3251
+ * ```
805
3252
  */
806
3253
  export declare const onDeviceRemoved: typeof ty.device.onDeviceRemoved;
807
3254
  /**
808
3255
  * @public
809
3256
  * @since @ray-js/ray 0.6.23
3257
+ * @example 基础调用
3258
+ * ```tsx
3259
+ * import { device } from '@ray-js/ray';
3260
+ *
3261
+ * const { offDeviceRemoved } = device;
3262
+ *
3263
+ * offDeviceRemoved((res) => {
3264
+ * console.log('offDeviceRemoved', res);
3265
+ * });
3266
+ * ```
810
3267
  */
811
3268
  export declare const offDeviceRemoved: typeof ty.device.offDeviceRemoved;
812
3269
  /**
813
3270
  * @public
814
3271
  * @since @ray-js/ray 0.6.23
3272
+ * @example 基础调用
3273
+ * ```tsx
3274
+ * import { device } from '@ray-js/ray';
3275
+ *
3276
+ * const { onMqttConnectState } = device;
3277
+ *
3278
+ * onMqttConnectState((res) => {
3279
+ * console.log('onMqttConnectState', res);
3280
+ * });
3281
+ * ```
815
3282
  */
816
3283
  export declare const onMqttConnectState: typeof ty.device.onMqttConnectState;
817
3284
  /**
818
3285
  * @public
819
3286
  * @since @ray-js/ray 0.6.23
3287
+ * @example 基础调用
3288
+ * ```tsx
3289
+ * import { device } from '@ray-js/ray';
3290
+ *
3291
+ * const { offMqttConnectState } = device;
3292
+ *
3293
+ * offMqttConnectState((res) => {
3294
+ * console.log('offMqttConnectState', res);
3295
+ * });
3296
+ * ```
820
3297
  */
821
3298
  export declare const offMqttConnectState: typeof ty.device.offMqttConnectState;
822
3299
  /**
823
3300
  * @public
824
3301
  * @since @ray-js/ray 0.6.23
3302
+ * @example 基础调用
3303
+ * ```tsx
3304
+ * import { device } from '@ray-js/ray';
3305
+ *
3306
+ * const { onTimerUpdate } = device;
3307
+ *
3308
+ * onTimerUpdate((res) => {
3309
+ * console.log('onTimerUpdate', res);
3310
+ * });
3311
+ * ```
825
3312
  */
826
3313
  export declare const onTimerUpdate: typeof ty.device.onTimerUpdate;
827
3314
  /**
828
3315
  * @public
829
3316
  * @since @ray-js/ray 0.6.23
3317
+ * @example 基础调用
3318
+ * ```tsx
3319
+ * import { device } from '@ray-js/ray';
3320
+ *
3321
+ * const { offTimerUpdate } = device;
3322
+ *
3323
+ * offTimerUpdate((res) => {
3324
+ * console.log('offTimerUpdate', res);
3325
+ * });
3326
+ * ```
830
3327
  */
831
3328
  export declare const offTimerUpdate: typeof ty.device.offTimerUpdate;
832
3329
  /**
833
3330
  * @public
834
3331
  * @since @ray-js/ray 0.6.23
3332
+ * @example 基础调用
3333
+ * ```tsx
3334
+ * import { device } from '@ray-js/ray';
3335
+ *
3336
+ * const { onGroupInfoChange } = device;
3337
+ *
3338
+ * onGroupInfoChange((res) => {
3339
+ * console.log('onGroupInfoChange', res);
3340
+ * });
3341
+ * ```
835
3342
  */
836
3343
  export declare const onGroupInfoChange: typeof ty.device.onGroupInfoChange;
837
3344
  /**
838
3345
  * @public
839
3346
  * @since @ray-js/ray 0.6.23
3347
+ * @example 基础调用
3348
+ * ```tsx
3349
+ * import { device } from '@ray-js/ray';
3350
+ *
3351
+ * const { offGroupInfoChange } = device;
3352
+ *
3353
+ * offGroupInfoChange((res) => {
3354
+ * console.log('offGroupInfoChange', res);
3355
+ * });
3356
+ * ```
840
3357
  */
841
3358
  export declare const offGroupInfoChange: typeof ty.device.offGroupInfoChange;
842
3359
  /**
843
3360
  * @public
844
3361
  * @since @ray-js/ray 0.6.23
3362
+ * @example 基础调用
3363
+ * ```tsx
3364
+ * import { device } from '@ray-js/ray';
3365
+ *
3366
+ * const { onGroupDpCodeChange } = device;
3367
+ *
3368
+ * onGroupDpCodeChange((res) => {
3369
+ * console.log('onGroupDpCodeChange', res);
3370
+ * });
3371
+ * ```
845
3372
  */
846
3373
  export declare const onGroupDpCodeChange: typeof ty.device.onGroupDpCodeChange;
847
3374
  /**
848
3375
  * @public
849
3376
  * @since @ray-js/ray 0.6.23
3377
+ * @example 基础调用
3378
+ * ```tsx
3379
+ * import { device } from '@ray-js/ray';
3380
+ *
3381
+ * const { offGroupDpCodeChange } = device;
3382
+ *
3383
+ * offGroupDpCodeChange((res) => {
3384
+ * console.log('offGroupDpCodeChange', res);
3385
+ * });
3386
+ * ```
850
3387
  */
851
3388
  export declare const offGroupDpCodeChange: typeof ty.device.offGroupDpCodeChange;
852
3389
  /**
853
3390
  * @public
854
3391
  * @since @ray-js/ray 0.6.23
3392
+ * @example 基础调用
3393
+ * ```tsx
3394
+ * import { device } from '@ray-js/ray';
3395
+ *
3396
+ * const { onGroupRemovedEvent } = device;
3397
+ *
3398
+ * onGroupRemovedEvent((res) => {
3399
+ * console.log('onGroupRemovedEvent', res);
3400
+ * });
3401
+ * ```
855
3402
  */
856
3403
  export declare const onGroupRemovedEvent: typeof ty.device.onGroupRemovedEvent;
857
3404
  /**
858
3405
  * @public
859
3406
  * @since @ray-js/ray 0.6.23
3407
+ * @example 基础调用
3408
+ * ```tsx
3409
+ * import { device } from '@ray-js/ray';
3410
+ *
3411
+ * const { offGroupRemovedEvent } = device;
3412
+ *
3413
+ * offGroupRemovedEvent((res) => {
3414
+ * console.log('offGroupRemovedEvent', res);
3415
+ * });
3416
+ * ```
860
3417
  */
861
3418
  export declare const offGroupRemovedEvent: typeof ty.device.offGroupRemovedEvent;
862
3419
  /**
863
3420
  * @public
864
3421
  * @since @ray-js/ray 0.6.23
3422
+ * @example 基础调用
3423
+ * ```tsx
3424
+ * import { device } from '@ray-js/ray';
3425
+ *
3426
+ * const { onGroupDpDataChangeEvent } = device;
3427
+ *
3428
+ * onGroupDpDataChangeEvent((res) => {
3429
+ * console.log('onGroupDpDataChangeEvent', res);
3430
+ * });
3431
+ * ```
865
3432
  */
866
3433
  export declare const onGroupDpDataChangeEvent: typeof ty.device.onGroupDpDataChangeEvent;
867
3434
  /**
868
3435
  * @public
869
3436
  * @since @ray-js/ray 0.6.23
3437
+ * @example 基础调用
3438
+ * ```tsx
3439
+ * import { device } from '@ray-js/ray';
3440
+ *
3441
+ * const { offGroupDpDataChangeEvent } = device;
3442
+ *
3443
+ * offGroupDpDataChangeEvent((res) => {
3444
+ * console.log('offGroupDpDataChangeEvent', res);
3445
+ * });
3446
+ * ```
870
3447
  */
871
3448
  export declare const offGroupDpDataChangeEvent: typeof ty.device.offGroupDpDataChangeEvent;
872
3449
  /**
873
3450
  * @public
874
3451
  * @since @ray-js/ray 0.6.23
3452
+ * @example 基础调用
3453
+ * ```tsx
3454
+ * import { device } from '@ray-js/ray';
3455
+ *
3456
+ * const { onReceivedThingModelMessage } = device;
3457
+ *
3458
+ * onReceivedThingModelMessage((res) => {
3459
+ * console.log('onReceivedThingModelMessage', res);
3460
+ * });
3461
+ * ```
875
3462
  */
876
3463
  export declare const onReceivedThingModelMessage: typeof ty.device.onReceivedThingModelMessage;
877
3464
  /**
878
3465
  * @public
879
3466
  * @since @ray-js/ray 0.8.0
3467
+ * @example 基础调用
3468
+ * ```tsx
3469
+ * import { device } from '@ray-js/ray';
3470
+ *
3471
+ * const { offReceivedThingModelMessage } = device;
3472
+ *
3473
+ * offReceivedThingModelMessage((res) => {
3474
+ * console.log('offReceivedThingModelMessage', res);
3475
+ * });
3476
+ * ```
880
3477
  */
881
3478
  export declare const offReceivedThingModelMessage: typeof ty.device.offReceivedThingModelMessage;
882
3479
  /**
883
3480
  * @public
884
3481
  * @since @ray-js/ray 0.8.0
3482
+ * @example 基础调用
3483
+ * ```tsx
3484
+ * import { device } from '@ray-js/ray';
3485
+ *
3486
+ * const { connectBluetoothDevice } = device;
3487
+ *
3488
+ * connectBluetoothDevice({
3489
+ * devId: 'device_001',
3490
+ * success: () => {
3491
+ * console.log('connectBluetoothDevice success');
3492
+ * },
3493
+ * fail: (error) => {
3494
+ * console.log('connectBluetoothDevice fail', error.errorMsg);
3495
+ * },
3496
+ * });
3497
+ * ```
885
3498
  */
886
3499
  export declare const connectBluetoothDevice: typeof ty.device.connectBluetoothDevice;
887
3500
  /**
888
3501
  * @public
889
3502
  * @since @ray-js/ray 0.8.0
3503
+ * @example 基础调用
3504
+ * ```tsx
3505
+ * import { device } from '@ray-js/ray';
3506
+ *
3507
+ * const { disconnectBluetoothDevice } = device;
3508
+ *
3509
+ * disconnectBluetoothDevice({
3510
+ * devId: 'device_001',
3511
+ * success: () => {
3512
+ * console.log('disconnectBluetoothDevice success');
3513
+ * },
3514
+ * fail: (error) => {
3515
+ * console.log('disconnectBluetoothDevice fail', error.errorMsg);
3516
+ * },
3517
+ * });
3518
+ * ```
890
3519
  */
891
3520
  export declare const disconnectBluetoothDevice: typeof ty.device.disconnectBluetoothDevice;
892
3521
  /**
893
3522
  * @public
894
3523
  * @since @ray-js/ray 0.8.0
3524
+ * @example 基础调用
3525
+ * ```tsx
3526
+ * import { device } from '@ray-js/ray';
3527
+ *
3528
+ * const { onSubDeviceAdded } = device;
3529
+ *
3530
+ * onSubDeviceAdded((res) => {
3531
+ * console.log('onSubDeviceAdded', res);
3532
+ * });
3533
+ * ```
895
3534
  */
896
3535
  export declare const onSubDeviceAdded: typeof ty.device.onSubDeviceAdded;
897
3536
  /**
898
3537
  * @public
899
3538
  * @since @ray-js/ray 0.8.0
3539
+ * @example 基础调用
3540
+ * ```tsx
3541
+ * import { device } from '@ray-js/ray';
3542
+ *
3543
+ * const { offSubDeviceAdded } = device;
3544
+ *
3545
+ * offSubDeviceAdded((res) => {
3546
+ * console.log('offSubDeviceAdded', res);
3547
+ * });
3548
+ * ```
900
3549
  */
901
3550
  export declare const offSubDeviceAdded: typeof ty.device.offSubDeviceAdded;
902
3551
  /**
903
3552
  * @public
904
3553
  * @since @ray-js/ray 0.8.0
3554
+ * @example 基础调用
3555
+ * ```tsx
3556
+ * import { device } from '@ray-js/ray';
3557
+ *
3558
+ * const { onSubDeviceDpUpdate } = device;
3559
+ *
3560
+ * onSubDeviceDpUpdate((res) => {
3561
+ * console.log('onSubDeviceDpUpdate', res);
3562
+ * });
3563
+ * ```
905
3564
  */
906
3565
  export declare const onSubDeviceDpUpdate: typeof ty.device.onSubDeviceDpUpdate;
907
3566
  /**
908
3567
  * @public
909
3568
  * @since @ray-js/ray 0.8.0
3569
+ * @example 基础调用
3570
+ * ```tsx
3571
+ * import { device } from '@ray-js/ray';
3572
+ *
3573
+ * const { offSubDeviceDpUpdate } = device;
3574
+ *
3575
+ * offSubDeviceDpUpdate((res) => {
3576
+ * console.log('offSubDeviceDpUpdate', res);
3577
+ * });
3578
+ * ```
910
3579
  */
911
3580
  export declare const offSubDeviceDpUpdate: typeof ty.device.offSubDeviceDpUpdate;
912
3581
  /**
913
3582
  * @public
914
3583
  * @since @ray-js/ray 0.8.0
3584
+ * @example 基础调用
3585
+ * ```tsx
3586
+ * import { device } from '@ray-js/ray';
3587
+ *
3588
+ * const { onSubDeviceInfoUpdate } = device;
3589
+ *
3590
+ * onSubDeviceInfoUpdate((res) => {
3591
+ * console.log('onSubDeviceInfoUpdate', res);
3592
+ * });
3593
+ * ```
915
3594
  */
916
3595
  export declare const onSubDeviceInfoUpdate: typeof ty.device.onSubDeviceInfoUpdate;
917
3596
  /**
918
3597
  * @public
919
3598
  * @since @ray-js/ray 0.8.0
3599
+ * @example 基础调用
3600
+ * ```tsx
3601
+ * import { device } from '@ray-js/ray';
3602
+ *
3603
+ * const { offSubDeviceInfoUpdate } = device;
3604
+ *
3605
+ * offSubDeviceInfoUpdate((res) => {
3606
+ * console.log('offSubDeviceInfoUpdate', res);
3607
+ * });
3608
+ * ```
920
3609
  */
921
3610
  export declare const offSubDeviceInfoUpdate: typeof ty.device.offSubDeviceInfoUpdate;
922
3611
  /**
923
3612
  * @public
924
3613
  * @since @ray-js/ray 0.8.0
3614
+ * @example 基础调用
3615
+ * ```tsx
3616
+ * import { device } from '@ray-js/ray';
3617
+ *
3618
+ * const { onSubDeviceRemoved } = device;
3619
+ *
3620
+ * onSubDeviceRemoved((res) => {
3621
+ * console.log('onSubDeviceRemoved', res);
3622
+ * });
3623
+ * ```
925
3624
  */
926
3625
  export declare const onSubDeviceRemoved: typeof ty.device.onSubDeviceRemoved;
927
3626
  /**
928
3627
  * @public
929
3628
  * @since @ray-js/ray 0.8.0
3629
+ * @example 基础调用
3630
+ * ```tsx
3631
+ * import { device } from '@ray-js/ray';
3632
+ *
3633
+ * const { offSubDeviceRemoved } = device;
3634
+ *
3635
+ * offSubDeviceRemoved((res) => {
3636
+ * console.log('offSubDeviceRemoved', res);
3637
+ * });
3638
+ * ```
930
3639
  */
931
3640
  export declare const offSubDeviceRemoved: typeof ty.device.offSubDeviceRemoved;
932
3641
  /**
933
3642
  * @public
934
3643
  * @since @ray-js/ray 0.8.0
3644
+ * @example 基础调用
3645
+ * ```tsx
3646
+ * import { device } from '@ray-js/ray';
3647
+ *
3648
+ * const { registerGateWaySubDeviceListener } = device;
3649
+ *
3650
+ * registerGateWaySubDeviceListener({
3651
+ * deviceId: 'device_001',
3652
+ * success: () => {
3653
+ * console.log('registerGateWaySubDeviceListener success');
3654
+ * },
3655
+ * fail: (error) => {
3656
+ * console.log('registerGateWaySubDeviceListener fail', error.errorMsg);
3657
+ * },
3658
+ * });
3659
+ * ```
935
3660
  */
936
3661
  export declare const registerGateWaySubDeviceListener: typeof ty.device.registerGateWaySubDeviceListener;
937
3662
  /**
938
3663
  * @public
939
3664
  * @since @ray-js/ray 0.9.0
3665
+ * @example 基础调用
3666
+ * ```tsx
3667
+ * import { device } from '@ray-js/ray';
3668
+ *
3669
+ * const { unregisterGateWaySubDeviceListener } = device;
3670
+ *
3671
+ * unregisterGateWaySubDeviceListener({
3672
+ * deviceId: 'device_001',
3673
+ * success: () => {
3674
+ * console.log('unregisterGateWaySubDeviceListener success');
3675
+ * },
3676
+ * fail: (error) => {
3677
+ * console.log('unregisterGateWaySubDeviceListener fail', error.errorMsg);
3678
+ * },
3679
+ * });
3680
+ * ```
940
3681
  */
941
3682
  export declare const unregisterGateWaySubDeviceListener: typeof ty.device.unregisterGateWaySubDeviceListener;
942
3683
  /**
943
3684
  * @public
944
3685
  * @since @ray-js/ray 0.9.0
3686
+ * @example 基础调用
3687
+ * ```tsx
3688
+ * import { device } from '@ray-js/ray';
3689
+ *
3690
+ * const { getDeviceListByDevIds } = device;
3691
+ *
3692
+ * getDeviceListByDevIds({
3693
+ * deviceIds: ['device_001'],
3694
+ * success: (result) => {
3695
+ * console.log('getDeviceListByDevIds success', result);
3696
+ * },
3697
+ * fail: (error) => {
3698
+ * console.log('getDeviceListByDevIds fail', error.errorMsg);
3699
+ * },
3700
+ * });
3701
+ * ```
945
3702
  */
946
3703
  export declare const getDeviceListByDevIds: typeof ty.device.getDeviceListByDevIds;
947
3704
  /**
948
3705
  * @public
949
3706
  * @since @ray-js/ray 1.4.21
3707
+ * @example 基础调用
3708
+ * ```tsx
3709
+ * import { device } from '@ray-js/ray';
3710
+ *
3711
+ * const { sendMqttMessage } = device;
3712
+ *
3713
+ * sendMqttMessage({
3714
+ * message: {},
3715
+ * deviceId: 'device_001',
3716
+ * protocol: 0,
3717
+ * options: {},
3718
+ * success: (result) => {
3719
+ * console.log('sendMqttMessage success', result);
3720
+ * },
3721
+ * fail: (error) => {
3722
+ * console.log('sendMqttMessage fail', error.errorMsg);
3723
+ * },
3724
+ * });
3725
+ * ```
950
3726
  */
951
3727
  export declare const sendMqttMessage: typeof ty.device.sendMqttMessage;
952
3728
  /**
953
3729
  * @public
954
3730
  * @since @ray-js/ray 1.4.21
3731
+ * @example 基础调用
3732
+ * ```tsx
3733
+ * import { device } from '@ray-js/ray';
3734
+ *
3735
+ * const { dispatchSubFunctionTouchEvent } = device;
3736
+ *
3737
+ * dispatchSubFunctionTouchEvent({
3738
+ * id: 'example',
3739
+ * success: () => {
3740
+ * console.log('dispatchSubFunctionTouchEvent success');
3741
+ * },
3742
+ * fail: (error) => {
3743
+ * console.log('dispatchSubFunctionTouchEvent fail', error.errorMsg);
3744
+ * },
3745
+ * });
3746
+ * ```
955
3747
  */
956
3748
  export declare const dispatchSubFunctionTouchEvent: typeof ty.device.dispatchSubFunctionTouchEvent;
957
3749
  /**
958
3750
  * @public
959
3751
  * @since @ray-js/ray 1.4.57
3752
+ * @example 基础调用
3753
+ * ```tsx
3754
+ * import { device } from '@ray-js/ray';
3755
+ *
3756
+ * const { onSubFunctionDataChange } = device;
3757
+ *
3758
+ * onSubFunctionDataChange((res) => {
3759
+ * console.log('onSubFunctionDataChange', res);
3760
+ * });
3761
+ * ```
960
3762
  */
961
3763
  export declare const onSubFunctionDataChange: typeof ty.device.onSubFunctionDataChange;
962
3764
  /**
963
3765
  * @public
964
3766
  * @since @ray-js/ray 1.5.30
3767
+ * @example 基础调用
3768
+ * ```tsx
3769
+ * import { device } from '@ray-js/ray';
3770
+ *
3771
+ * const { activeDeviceExtendModule } = device;
3772
+ *
3773
+ * activeDeviceExtendModule({
3774
+ * deviceId: 'device_001',
3775
+ * activeType: 0,
3776
+ * success: () => {
3777
+ * console.log('activeDeviceExtendModule success');
3778
+ * },
3779
+ * fail: (error) => {
3780
+ * console.log('activeDeviceExtendModule fail', error.errorMsg);
3781
+ * },
3782
+ * });
3783
+ * ```
965
3784
  */
966
3785
  export declare const activeDeviceExtendModule: typeof ty.device.activeDeviceExtendModule;
967
3786
  /**
968
3787
  * @public
969
3788
  * @since @ray-js/ray 1.5.30
3789
+ * @example 基础调用
3790
+ * ```tsx
3791
+ * import { device } from '@ray-js/ray';
3792
+ *
3793
+ * const { updateMeshProxyState } = device;
3794
+ *
3795
+ * updateMeshProxyState({
3796
+ * deviceId: 'device_001',
3797
+ * isOpen: true,
3798
+ * success: () => {
3799
+ * console.log('updateMeshProxyState success');
3800
+ * },
3801
+ * fail: (error) => {
3802
+ * console.log('updateMeshProxyState fail', error.errorMsg);
3803
+ * },
3804
+ * });
3805
+ * ```
970
3806
  */
971
3807
  export declare const updateMeshProxyState: typeof ty.device.updateMeshProxyState;
972
3808
  /**
973
3809
  * @public
974
3810
  * @since @ray-js/ray 1.5.30
3811
+ * @example 基础调用
3812
+ * ```tsx
3813
+ * import { device } from '@ray-js/ray';
3814
+ *
3815
+ * const { updateMeshRelayState } = device;
3816
+ *
3817
+ * updateMeshRelayState({
3818
+ * deviceId: 'device_001',
3819
+ * isOpen: true,
3820
+ * success: () => {
3821
+ * console.log('updateMeshRelayState success');
3822
+ * },
3823
+ * fail: (error) => {
3824
+ * console.log('updateMeshRelayState fail', error.errorMsg);
3825
+ * },
3826
+ * });
3827
+ * ```
975
3828
  */
976
3829
  export declare const updateMeshRelayState: typeof ty.device.updateMeshRelayState;
977
3830
  /**
978
3831
  * @public
979
3832
  * @since @ray-js/ray 1.5.30
3833
+ * @example 基础调用
3834
+ * ```tsx
3835
+ * import { device } from '@ray-js/ray';
3836
+ *
3837
+ * const { recordBleConnectEvent } = device;
3838
+ *
3839
+ * recordBleConnectEvent({
3840
+ * deviceId: 'device_001',
3841
+ * src: 0,
3842
+ * actId: 'example',
3843
+ * success: () => {
3844
+ * console.log('recordBleConnectEvent success');
3845
+ * },
3846
+ * fail: (error) => {
3847
+ * console.log('recordBleConnectEvent fail', error.errorMsg);
3848
+ * },
3849
+ * });
3850
+ * ```
980
3851
  */
981
3852
  export declare const recordBleConnectEvent: typeof ty.device.recordBleConnectEvent;
982
3853
  /**
983
3854
  * @public
984
3855
  * @since @ray-js/ray 1.5.30
3856
+ * @example 基础调用
3857
+ * ```tsx
3858
+ * import { device } from '@ray-js/ray';
3859
+ *
3860
+ * const { requestWifiSignal } = device;
3861
+ *
3862
+ * requestWifiSignal({
3863
+ * deviceId: 'device_001',
3864
+ * success: (result) => {
3865
+ * console.log('requestWifiSignal success', result);
3866
+ * },
3867
+ * fail: (error) => {
3868
+ * console.log('requestWifiSignal fail', error.errorMsg);
3869
+ * },
3870
+ * });
3871
+ * ```
985
3872
  */
986
3873
  export declare const requestWifiSignal: typeof ty.device.requestWifiSignal;
987
3874
  /**
988
3875
  * @public
989
3876
  * @since @ray-js/ray 1.5.30
3877
+ * @example 基础调用
3878
+ * ```tsx
3879
+ * import { device } from '@ray-js/ray';
3880
+ *
3881
+ * const { yuChannelSync } = device;
3882
+ *
3883
+ * yuChannelSync({
3884
+ * success: () => {
3885
+ * console.log('yuChannelSync success');
3886
+ * },
3887
+ * fail: (error) => {
3888
+ * console.log('yuChannelSync fail', error.errorMsg);
3889
+ * },
3890
+ * });
3891
+ * ```
990
3892
  */
991
3893
  export declare const yuChannelSync: typeof ty.device.yuChannelSync;
992
3894
  /**
993
3895
  * @public
994
3896
  * @since @ray-js/ray 1.5.30
3897
+ * @example 基础调用
3898
+ * ```tsx
3899
+ * import { device } from '@ray-js/ray';
3900
+ *
3901
+ * const { isYuDeviceOnline } = device;
3902
+ *
3903
+ * isYuDeviceOnline({
3904
+ * deviceId: 'device_001',
3905
+ * success: (result) => {
3906
+ * console.log('isYuDeviceOnline success', result);
3907
+ * },
3908
+ * fail: (error) => {
3909
+ * console.log('isYuDeviceOnline fail', error.errorMsg);
3910
+ * },
3911
+ * });
3912
+ * ```
995
3913
  */
996
3914
  export declare const isYuDeviceOnline: typeof ty.device.isYuDeviceOnline;
997
3915
  /**
998
3916
  * @public
999
3917
  * @since @ray-js/ray 1.5.30
3918
+ * @example 基础调用
3919
+ * ```tsx
3920
+ * import { device } from '@ray-js/ray';
3921
+ *
3922
+ * const { isYuDeviceOnlineSync } = device;
3923
+ *
3924
+ * const result = isYuDeviceOnlineSync();
3925
+ * console.log('isYuDeviceOnlineSync result', result);
3926
+ * ```
1000
3927
  */
1001
3928
  export declare const isYuDeviceOnlineSync: typeof ty.device.isYuDeviceOnlineSync;
1002
3929
  /**
1003
3930
  * @public
1004
3931
  * @since @ray-js/ray 1.5.30
3932
+ * @example 基础调用
3933
+ * ```tsx
3934
+ * import { device } from '@ray-js/ray';
3935
+ *
3936
+ * const { syncDeviceMeshDps } = device;
3937
+ *
3938
+ * syncDeviceMeshDps({
3939
+ * deviceId: 'device_001',
3940
+ * success: () => {
3941
+ * console.log('syncDeviceMeshDps success');
3942
+ * },
3943
+ * fail: (error) => {
3944
+ * console.log('syncDeviceMeshDps fail', error.errorMsg);
3945
+ * },
3946
+ * });
3947
+ * ```
1005
3948
  */
1006
3949
  export declare const syncDeviceMeshDps: typeof ty.device.syncDeviceMeshDps;
1007
3950
  /**
1008
3951
  * @public
1009
3952
  * @since @ray-js/ray 1.5.30
3953
+ * @example 基础调用
3954
+ * ```tsx
3955
+ * import { device } from '@ray-js/ray';
3956
+ *
3957
+ * const { getOTAUpdateInfo } = device;
3958
+ *
3959
+ * getOTAUpdateInfo({
3960
+ * deviceId: 'device_001',
3961
+ * success: (result) => {
3962
+ * console.log('getOTAUpdateInfo success', result);
3963
+ * },
3964
+ * fail: (error) => {
3965
+ * console.log('getOTAUpdateInfo fail', error.errorMsg);
3966
+ * },
3967
+ * });
3968
+ * ```
1010
3969
  */
1011
3970
  export declare const getOTAUpdateInfo: typeof ty.device.getOTAUpdateInfo;
1012
3971
  /**
1013
3972
  * @public
1014
3973
  * @since @ray-js/ray 1.5.30
3974
+ * @example 基础调用
3975
+ * ```tsx
3976
+ * import { device } from '@ray-js/ray';
3977
+ *
3978
+ * const { getDeviceDetailConfiguration } = device;
3979
+ *
3980
+ * getDeviceDetailConfiguration({
3981
+ * success: (result) => {
3982
+ * console.log('getDeviceDetailConfiguration success', result);
3983
+ * },
3984
+ * fail: (error) => {
3985
+ * console.log('getDeviceDetailConfiguration fail', error.errorMsg);
3986
+ * },
3987
+ * });
3988
+ * ```
1015
3989
  */
1016
3990
  export declare const getDeviceDetailConfiguration: typeof ty.device.getDeviceDetailConfiguration;
1017
3991
  /**
1018
3992
  * @public
1019
3993
  * @since @ray-js/ray 1.5.30
3994
+ * @example 基础调用
3995
+ * ```tsx
3996
+ * import { device } from '@ray-js/ray';
3997
+ *
3998
+ * const { dispatchDataResult } = device;
3999
+ *
4000
+ * dispatchDataResult({
4001
+ * id: 'example',
4002
+ * success: () => {
4003
+ * console.log('dispatchDataResult success');
4004
+ * },
4005
+ * fail: (error) => {
4006
+ * console.log('dispatchDataResult fail', error.errorMsg);
4007
+ * },
4008
+ * });
4009
+ * ```
1020
4010
  */
1021
4011
  export declare const dispatchDataResult: typeof ty.device.dispatchDataResult;
1022
4012
  /**
1023
4013
  * @public
1024
4014
  * @since @ray-js/ray 1.5.30
4015
+ * @example 基础调用
4016
+ * ```tsx
4017
+ * import { device } from '@ray-js/ray';
4018
+ *
4019
+ * const { getSubFunctionShowState } = device;
4020
+ *
4021
+ * getSubFunctionShowState({
4022
+ * ids: ['example'],
4023
+ * success: (result) => {
4024
+ * console.log('getSubFunctionShowState success', result);
4025
+ * },
4026
+ * fail: (error) => {
4027
+ * console.log('getSubFunctionShowState fail', error.errorMsg);
4028
+ * },
4029
+ * });
4030
+ * ```
1025
4031
  */
1026
4032
  export declare const getSubFunctionShowState: typeof ty.device.getSubFunctionShowState;
1027
4033
  /**
1028
4034
  * @public
1029
4035
  * @since @ray-js/ray 1.5.30
4036
+ * @example 基础调用
4037
+ * ```tsx
4038
+ * import { device } from '@ray-js/ray';
4039
+ *
4040
+ * const { getSubFunctionExtShowData } = device;
4041
+ *
4042
+ * getSubFunctionExtShowData({
4043
+ * id: 'example',
4044
+ * success: (result) => {
4045
+ * console.log('getSubFunctionExtShowData success', result);
4046
+ * },
4047
+ * fail: (error) => {
4048
+ * console.log('getSubFunctionExtShowData fail', error.errorMsg);
4049
+ * },
4050
+ * });
4051
+ * ```
1030
4052
  */
1031
4053
  export declare const getSubFunctionExtShowData: typeof ty.device.getSubFunctionExtShowData;
1032
4054
  /**
1033
4055
  * @public
1034
4056
  * @since @ray-js/ray 1.5.30
4057
+ * @example 基础调用
4058
+ * ```tsx
4059
+ * import { device } from '@ray-js/ray';
4060
+ *
4061
+ * const { getRemoteRebootTimers } = device;
4062
+ *
4063
+ * getRemoteRebootTimers({
4064
+ * deviceId: 'device_001',
4065
+ * success: (result) => {
4066
+ * console.log('getRemoteRebootTimers success', result);
4067
+ * },
4068
+ * fail: (error) => {
4069
+ * console.log('getRemoteRebootTimers fail', error.errorMsg);
4070
+ * },
4071
+ * });
4072
+ * ```
1035
4073
  */
1036
4074
  export declare const getRemoteRebootTimers: typeof ty.device.getRemoteRebootTimers;
1037
4075
  /**
1038
4076
  * @public
1039
4077
  * @since @ray-js/ray 1.5.30
4078
+ * @example 基础调用
4079
+ * ```tsx
4080
+ * import { device } from '@ray-js/ray';
4081
+ *
4082
+ * const { onDispatchEvent } = device;
4083
+ *
4084
+ * onDispatchEvent((res) => {
4085
+ * console.log('onDispatchEvent', res);
4086
+ * });
4087
+ * ```
1040
4088
  */
1041
4089
  export declare const onDispatchEvent: typeof ty.device.onDispatchEvent;
1042
4090
  /**
1043
4091
  * @public
1044
4092
  * @since @ray-js/ray 1.5.30
4093
+ * @example 基础调用
4094
+ * ```tsx
4095
+ * import { device } from '@ray-js/ray';
4096
+ *
4097
+ * const { offDispatchEvent } = device;
4098
+ *
4099
+ * offDispatchEvent((res) => {
4100
+ * console.log('offDispatchEvent', res);
4101
+ * });
4102
+ * ```
1045
4103
  */
1046
4104
  export declare const offDispatchEvent: typeof ty.device.offDispatchEvent;
1047
4105
  /**
1048
4106
  * @public
1049
4107
  * @since @ray-js/ray 1.5.30
4108
+ * @example 基础调用
4109
+ * ```tsx
4110
+ * import { device } from '@ray-js/ray';
4111
+ *
4112
+ * const { otaStatus } = device;
4113
+ *
4114
+ * otaStatus({
4115
+ * deviceId: 'device_001',
4116
+ * success: (result) => {
4117
+ * console.log('otaStatus success', result);
4118
+ * },
4119
+ * fail: (error) => {
4120
+ * console.log('otaStatus fail', error.errorMsg);
4121
+ * },
4122
+ * });
4123
+ * ```
1050
4124
  */
1051
4125
  export declare const otaStatus: typeof ty.device.otaStatus;
1052
4126
  /**
1053
4127
  * @public
1054
4128
  * @since @ray-js/ray 1.5.30
4129
+ * @example 基础调用
4130
+ * ```tsx
4131
+ * import { device } from '@ray-js/ray';
4132
+ *
4133
+ * const { registerOTACompleted } = device;
4134
+ *
4135
+ * registerOTACompleted({
4136
+ * success: () => {
4137
+ * console.log('registerOTACompleted success');
4138
+ * },
4139
+ * fail: (error) => {
4140
+ * console.log('registerOTACompleted fail', error.errorMsg);
4141
+ * },
4142
+ * });
4143
+ * ```
1055
4144
  */
1056
4145
  export declare const registerOTACompleted: typeof ty.device.registerOTACompleted;
1057
4146
  /**
1058
4147
  * @public
1059
4148
  * @since @ray-js/ray 1.5.30
4149
+ * @example 基础调用
4150
+ * ```tsx
4151
+ * import { device } from '@ray-js/ray';
4152
+ *
4153
+ * const { onOtaCompleted } = device;
4154
+ *
4155
+ * onOtaCompleted((res) => {
4156
+ * console.log('onOtaCompleted', res);
4157
+ * });
4158
+ * ```
1060
4159
  */
1061
4160
  export declare const onOtaCompleted: typeof ty.device.onOtaCompleted;
1062
4161
  /**
1063
4162
  * @public
1064
4163
  * @since @ray-js/ray 1.5.30
4164
+ * @example 基础调用
4165
+ * ```tsx
4166
+ * import { device } from '@ray-js/ray';
4167
+ *
4168
+ * const { offOtaCompleted } = device;
4169
+ *
4170
+ * offOtaCompleted((res) => {
4171
+ * console.log('offOtaCompleted', res);
4172
+ * });
4173
+ * ```
1065
4174
  */
1066
4175
  export declare const offOtaCompleted: typeof ty.device.offOtaCompleted;
1067
4176
  /**
1068
4177
  * @public
1069
4178
  * @since @ray-js/ray 1.5.30
4179
+ * @example 基础调用
4180
+ * ```tsx
4181
+ * import { device } from '@ray-js/ray';
4182
+ *
4183
+ * const { initVirtualDevice } = device;
4184
+ *
4185
+ * initVirtualDevice({
4186
+ * pid: 'example',
4187
+ * success: (result) => {
4188
+ * console.log('initVirtualDevice success', result);
4189
+ * },
4190
+ * fail: (error) => {
4191
+ * console.log('initVirtualDevice fail', error.errorMsg);
4192
+ * },
4193
+ * });
4194
+ * ```
1070
4195
  */
1071
4196
  export declare const initVirtualDevice: typeof ty.device.initVirtualDevice;
1072
4197
  /**
1073
4198
  * @public
1074
4199
  * @since @ray-js/ray 1.6.8
4200
+ * @example 基础调用
4201
+ * ```tsx
4202
+ * import { device } from '@ray-js/ray';
4203
+ *
4204
+ * const { startBLECommRodScanDevice } = device;
4205
+ *
4206
+ * startBLECommRodScanDevice({
4207
+ * success: () => {
4208
+ * console.log('startBLECommRodScanDevice success');
4209
+ * },
4210
+ * fail: (error) => {
4211
+ * console.log('startBLECommRodScanDevice fail', error.errorMsg);
4212
+ * },
4213
+ * });
4214
+ * ```
1075
4215
  */
1076
4216
  export declare const startBLECommRodScanDevice: typeof ty.device.startBLECommRodScanDevice;
1077
4217
  /**
1078
4218
  * @public
1079
4219
  * @since @ray-js/ray 1.6.8
4220
+ * @example 基础调用
4221
+ * ```tsx
4222
+ * import { device } from '@ray-js/ray';
4223
+ *
4224
+ * const { stopBLECommRodScanDevice } = device;
4225
+ *
4226
+ * stopBLECommRodScanDevice({
4227
+ * success: () => {
4228
+ * console.log('stopBLECommRodScanDevice success');
4229
+ * },
4230
+ * fail: (error) => {
4231
+ * console.log('stopBLECommRodScanDevice fail', error.errorMsg);
4232
+ * },
4233
+ * });
4234
+ * ```
1080
4235
  */
1081
4236
  export declare const stopBLECommRodScanDevice: typeof ty.device.stopBLECommRodScanDevice;
1082
4237
  /**
1083
4238
  * @public
1084
4239
  * @since @ray-js/ray 1.6.8
4240
+ * @example 基础调用
4241
+ * ```tsx
4242
+ * import { device } from '@ray-js/ray';
4243
+ *
4244
+ * const { connectBLECommRodDevice } = device;
4245
+ *
4246
+ * connectBLECommRodDevice({
4247
+ * deviceInfo: { deviceId: 'device_001', name: 'example', uuid: 'example', pid: 'example', mac: 'example', isActive: false },
4248
+ * machineKey: 'example',
4249
+ * schema: 'example',
4250
+ * success: () => {
4251
+ * console.log('connectBLECommRodDevice success');
4252
+ * },
4253
+ * fail: (error) => {
4254
+ * console.log('connectBLECommRodDevice fail', error.errorMsg);
4255
+ * },
4256
+ * });
4257
+ * ```
1085
4258
  */
1086
4259
  export declare const connectBLECommRodDevice: typeof ty.device.connectBLECommRodDevice;
1087
4260
  /**
1088
4261
  * @public
1089
4262
  * @since @ray-js/ray 1.6.8
4263
+ * @example 基础调用
4264
+ * ```tsx
4265
+ * import { device } from '@ray-js/ray';
4266
+ *
4267
+ * const { disconnectBLECommRodDevice } = device;
4268
+ *
4269
+ * disconnectBLECommRodDevice({
4270
+ * deviceId: 'device_001',
4271
+ * name: 'example',
4272
+ * uuid: 'example',
4273
+ * pid: 'example',
4274
+ * mac: 'example',
4275
+ * isActive: true,
4276
+ * success: () => {
4277
+ * console.log('disconnectBLECommRodDevice success');
4278
+ * },
4279
+ * fail: (error) => {
4280
+ * console.log('disconnectBLECommRodDevice fail', error.errorMsg);
4281
+ * },
4282
+ * });
4283
+ * ```
1090
4284
  */
1091
4285
  export declare const disconnectBLECommRodDevice: typeof ty.device.disconnectBLECommRodDevice;
1092
4286
  /**
1093
4287
  * @public
1094
4288
  * @since @ray-js/ray 1.6.8
4289
+ * @example 基础调用
4290
+ * ```tsx
4291
+ * import { device } from '@ray-js/ray';
4292
+ *
4293
+ * const { publishBLECommRodDps } = device;
4294
+ *
4295
+ * publishBLECommRodDps({
4296
+ * deviceInfo: { deviceId: 'device_001', name: 'example', uuid: 'example', pid: 'example', mac: 'example', isActive: false },
4297
+ * dps: {},
4298
+ * success: () => {
4299
+ * console.log('publishBLECommRodDps success');
4300
+ * },
4301
+ * fail: (error) => {
4302
+ * console.log('publishBLECommRodDps fail', error.errorMsg);
4303
+ * },
4304
+ * });
4305
+ * ```
1095
4306
  */
1096
4307
  export declare const publishBLECommRodDps: typeof ty.device.publishBLECommRodDps;
1097
4308
  /**
1098
4309
  * @public
1099
4310
  * @since @ray-js/ray 1.6.8
4311
+ * @example 基础调用
4312
+ * ```tsx
4313
+ * import { device } from '@ray-js/ray';
4314
+ *
4315
+ * const { onBLECommRodScanDevice } = device;
4316
+ *
4317
+ * onBLECommRodScanDevice((res) => {
4318
+ * console.log('onBLECommRodScanDevice', res);
4319
+ * });
4320
+ * ```
1100
4321
  */
1101
4322
  export declare const onBLECommRodScanDevice: typeof ty.device.onBLECommRodScanDevice;
1102
4323
  /**
1103
4324
  * @public
1104
4325
  * @since @ray-js/ray 1.6.8
4326
+ * @example 基础调用
4327
+ * ```tsx
4328
+ * import { device } from '@ray-js/ray';
4329
+ *
4330
+ * const { onBLECommRodConnectStatusChange } = device;
4331
+ *
4332
+ * onBLECommRodConnectStatusChange((res) => {
4333
+ * console.log('onBLECommRodConnectStatusChange', res);
4334
+ * });
4335
+ * ```
1105
4336
  */
1106
4337
  export declare const onBLECommRodConnectStatusChange: typeof ty.device.onBLECommRodConnectStatusChange;
1107
4338
  /**
1108
4339
  * @public
1109
4340
  * @since @ray-js/ray 1.6.8
4341
+ * @example 基础调用
4342
+ * ```tsx
4343
+ * import { device } from '@ray-js/ray';
4344
+ *
4345
+ * const { onBLECommRodSchemaUpload } = device;
4346
+ *
4347
+ * onBLECommRodSchemaUpload((res) => {
4348
+ * console.log('onBLECommRodSchemaUpload', res);
4349
+ * });
4350
+ * ```
1110
4351
  */
1111
4352
  export declare const onBLECommRodSchemaUpload: typeof ty.device.onBLECommRodSchemaUpload;
1112
4353
  /**
1113
4354
  * @public
1114
4355
  * @since @ray-js/ray 1.6.8
4356
+ * @example 基础调用
4357
+ * ```tsx
4358
+ * import { device } from '@ray-js/ray';
4359
+ *
4360
+ * const { onBLECommRodDpsChange } = device;
4361
+ *
4362
+ * onBLECommRodDpsChange((res) => {
4363
+ * console.log('onBLECommRodDpsChange', res);
4364
+ * });
4365
+ * ```
1115
4366
  */
1116
4367
  export declare const onBLECommRodDpsChange: typeof ty.device.onBLECommRodDpsChange;
1117
4368
  /**
1118
4369
  * @public
1119
4370
  * @since @ray-js/ray 1.6.8
4371
+ * @example 基础调用
4372
+ * ```tsx
4373
+ * import { device } from '@ray-js/ray';
4374
+ *
4375
+ * const { yuChannelSaveState } = device;
4376
+ *
4377
+ * yuChannelSaveState({
4378
+ * deviceId: 'device_001',
4379
+ * state: 0,
4380
+ * success: () => {
4381
+ * console.log('yuChannelSaveState success');
4382
+ * },
4383
+ * fail: (error) => {
4384
+ * console.log('yuChannelSaveState fail', error.errorMsg);
4385
+ * },
4386
+ * });
4387
+ * ```
1120
4388
  */
1121
4389
  export declare const yuChannelSaveState: typeof ty.device.yuChannelSaveState;
1122
4390
  /**
1123
4391
  * @public
1124
4392
  * @since @ray-js/ray 1.6.8
4393
+ * @example 基础调用
4394
+ * ```tsx
4395
+ * import { device } from '@ray-js/ray';
4396
+ *
4397
+ * const { yuChannelSyncSingle } = device;
4398
+ *
4399
+ * yuChannelSyncSingle({
4400
+ * deviceId: 'device_001',
4401
+ * success: () => {
4402
+ * console.log('yuChannelSyncSingle success');
4403
+ * },
4404
+ * fail: (error) => {
4405
+ * console.log('yuChannelSyncSingle fail', error.errorMsg);
4406
+ * },
4407
+ * });
4408
+ * ```
1125
4409
  */
1126
4410
  export declare const yuChannelSyncSingle: typeof ty.device.yuChannelSyncSingle;
1127
4411
  /**
1128
4412
  * @public
1129
4413
  * @since @ray-js/ray 1.6.8
4414
+ * @example 基础调用
4415
+ * ```tsx
4416
+ * import { device } from '@ray-js/ray';
4417
+ *
4418
+ * const { yuChannelSyncSingleSync } = device;
4419
+ *
4420
+ * const result = yuChannelSyncSingleSync();
4421
+ * console.log('yuChannelSyncSingleSync result', result);
4422
+ * ```
1130
4423
  */
1131
4424
  export declare const yuChannelSyncSingleSync: typeof ty.device.yuChannelSyncSingleSync;
1132
4425
  /**
1133
4426
  * @public
1134
4427
  * @since @ray-js/ray 1.6.8
4428
+ * @example 基础调用
4429
+ * ```tsx
4430
+ * import { device } from '@ray-js/ray';
4431
+ *
4432
+ * const { yuChannelQueryNodes } = device;
4433
+ *
4434
+ * yuChannelQueryNodes({
4435
+ * deviceId: 'device_001',
4436
+ * success: (result) => {
4437
+ * console.log('yuChannelQueryNodes success', result);
4438
+ * },
4439
+ * fail: (error) => {
4440
+ * console.log('yuChannelQueryNodes fail', error.errorMsg);
4441
+ * },
4442
+ * });
4443
+ * ```
1135
4444
  */
1136
4445
  export declare const yuChannelQueryNodes: typeof ty.device.yuChannelQueryNodes;
1137
4446
  /**
1138
4447
  * @public
1139
4448
  * @since @ray-js/ray 1.6.8
4449
+ * @example 基础调用
4450
+ * ```tsx
4451
+ * import { device } from '@ray-js/ray';
4452
+ *
4453
+ * const { checkCanJoinMatter } = device;
4454
+ *
4455
+ * checkCanJoinMatter({
4456
+ * deviceId: 'device_001',
4457
+ * success: () => {
4458
+ * console.log('checkCanJoinMatter success');
4459
+ * },
4460
+ * fail: (error) => {
4461
+ * console.log('checkCanJoinMatter fail', error.errorMsg);
4462
+ * },
4463
+ * });
4464
+ * ```
1140
4465
  */
1141
4466
  export declare const checkCanJoinMatter: typeof ty.device.checkCanJoinMatter;
1142
4467
  /**
1143
4468
  * @public
1144
4469
  * @since @ray-js/ray 1.6.8
4470
+ * @example 基础调用
4471
+ * ```tsx
4472
+ * import { device } from '@ray-js/ray';
4473
+ *
4474
+ * const { fetchAvailableMatterGatewayList } = device;
4475
+ *
4476
+ * fetchAvailableMatterGatewayList({
4477
+ * spaceId: 'example',
4478
+ * success: (result) => {
4479
+ * console.log('fetchAvailableMatterGatewayList success', result);
4480
+ * },
4481
+ * fail: (error) => {
4482
+ * console.log('fetchAvailableMatterGatewayList fail', error.errorMsg);
4483
+ * },
4484
+ * });
4485
+ * ```
1145
4486
  */
1146
4487
  export declare const fetchAvailableMatterGatewayList: typeof ty.device.fetchAvailableMatterGatewayList;
1147
4488
  /**
1148
4489
  * @public
1149
4490
  * @since @ray-js/ray 1.6.8
4491
+ * @example 基础调用
4492
+ * ```tsx
4493
+ * import { device } from '@ray-js/ray';
4494
+ *
4495
+ * const { checkShowMatterMutilpleShare } = device;
4496
+ *
4497
+ * checkShowMatterMutilpleShare({
4498
+ * deviceId: 'device_001',
4499
+ * success: () => {
4500
+ * console.log('checkShowMatterMutilpleShare success');
4501
+ * },
4502
+ * fail: (error) => {
4503
+ * console.log('checkShowMatterMutilpleShare fail', error.errorMsg);
4504
+ * },
4505
+ * });
4506
+ * ```
1150
4507
  */
1151
4508
  export declare const checkShowMatterMutilpleShare: typeof ty.device.checkShowMatterMutilpleShare;
1152
4509
  /**
1153
4510
  * @public
1154
4511
  * @since @ray-js/ray 1.6.8
4512
+ * @example 基础调用
4513
+ * ```tsx
4514
+ * import { device } from '@ray-js/ray';
4515
+ *
4516
+ * const { changeDeviceAdvMatterState } = device;
4517
+ *
4518
+ * changeDeviceAdvMatterState({
4519
+ * deviceId: 'device_001',
4520
+ * success: (result) => {
4521
+ * console.log('changeDeviceAdvMatterState success', result);
4522
+ * },
4523
+ * fail: (error) => {
4524
+ * console.log('changeDeviceAdvMatterState fail', error.errorMsg);
4525
+ * },
4526
+ * });
4527
+ * ```
1155
4528
  */
1156
4529
  export declare const changeDeviceAdvMatterState: typeof ty.device.changeDeviceAdvMatterState;
1157
4530
  /**
1158
4531
  * @public
1159
4532
  * @since @ray-js/ray 1.6.8
4533
+ * @example 基础调用
4534
+ * ```tsx
4535
+ * import { device } from '@ray-js/ray';
4536
+ *
4537
+ * const { pairDeviceIntoHomeKit } = device;
4538
+ *
4539
+ * pairDeviceIntoHomeKit({
4540
+ * matterCode: 'example',
4541
+ * success: () => {
4542
+ * console.log('pairDeviceIntoHomeKit success');
4543
+ * },
4544
+ * fail: (error) => {
4545
+ * console.log('pairDeviceIntoHomeKit fail', error.errorMsg);
4546
+ * },
4547
+ * });
4548
+ * ```
1160
4549
  */
1161
4550
  export declare const pairDeviceIntoHomeKit: typeof ty.device.pairDeviceIntoHomeKit;
1162
4551
  /**
1163
4552
  * @public
1164
4553
  * @since @ray-js/ray 1.6.8
4554
+ * @example 基础调用
4555
+ * ```tsx
4556
+ * import { device } from '@ray-js/ray';
4557
+ *
4558
+ * const { pairMatterDevice } = device;
4559
+ *
4560
+ * pairMatterDevice({
4561
+ * matterCode: 'example',
4562
+ * gwID: 'example',
4563
+ * spaceID: 'example',
4564
+ * success: () => {
4565
+ * console.log('pairMatterDevice success');
4566
+ * },
4567
+ * fail: (error) => {
4568
+ * console.log('pairMatterDevice fail', error.errorMsg);
4569
+ * },
4570
+ * });
4571
+ * ```
1165
4572
  */
1166
4573
  export declare const pairMatterDevice: typeof ty.device.pairMatterDevice;
1167
4574
  /**
1168
4575
  * @public
1169
4576
  * @since @ray-js/ray 1.6.8
4577
+ * @example 基础调用
4578
+ * ```tsx
4579
+ * import { device } from '@ray-js/ray';
4580
+ *
4581
+ * const { cancelMatterActivator } = device;
4582
+ *
4583
+ * cancelMatterActivator({
4584
+ * success: () => {
4585
+ * console.log('cancelMatterActivator success');
4586
+ * },
4587
+ * fail: (error) => {
4588
+ * console.log('cancelMatterActivator fail', error.errorMsg);
4589
+ * },
4590
+ * });
4591
+ * ```
1170
4592
  */
1171
4593
  export declare const cancelMatterActivator: typeof ty.device.cancelMatterActivator;
1172
4594
  /**
1173
4595
  * @public
1174
4596
  * @since @ray-js/ray 1.6.8
4597
+ * @example 基础调用
4598
+ * ```tsx
4599
+ * import { device } from '@ray-js/ray';
4600
+ *
4601
+ * const { publishMeshCustomDataEvent } = device;
4602
+ *
4603
+ * publishMeshCustomDataEvent({
4604
+ * meshId: 'example',
4605
+ * nodeId: 'example',
4606
+ * opCode: 0,
4607
+ * payloadHexString: 'example',
4608
+ * success: () => {
4609
+ * console.log('publishMeshCustomDataEvent success');
4610
+ * },
4611
+ * fail: (error) => {
4612
+ * console.log('publishMeshCustomDataEvent fail', error.errorMsg);
4613
+ * },
4614
+ * });
4615
+ * ```
1175
4616
  */
1176
4617
  export declare const publishMeshCustomDataEvent: typeof ty.device.publishMeshCustomDataEvent;
1177
4618
  /**
1178
4619
  * @public
1179
4620
  * @since @ray-js/ray 1.6.8
4621
+ * @example 基础调用
4622
+ * ```tsx
4623
+ * import { device } from '@ray-js/ray';
4624
+ *
4625
+ * const { lowPowerDeviceAwake } = device;
4626
+ *
4627
+ * lowPowerDeviceAwake({
4628
+ * deviceId: 'device_001',
4629
+ * timeout: 0,
4630
+ * success: (result) => {
4631
+ * console.log('lowPowerDeviceAwake success', result);
4632
+ * },
4633
+ * fail: (error) => {
4634
+ * console.log('lowPowerDeviceAwake fail', error.errorMsg);
4635
+ * },
4636
+ * });
4637
+ * ```
1180
4638
  */
1181
4639
  export declare const lowPowerDeviceAwake: typeof ty.device.lowPowerDeviceAwake;
1182
4640
  /**
1183
4641
  * @public
1184
4642
  * @since @ray-js/ray 1.6.8
4643
+ * @example 基础调用
4644
+ * ```tsx
4645
+ * import { device } from '@ray-js/ray';
4646
+ *
4647
+ * const { getDeviceDetailInfo } = device;
4648
+ *
4649
+ * getDeviceDetailInfo({
4650
+ * deviceId: 'device_001',
4651
+ * success: (result) => {
4652
+ * console.log('getDeviceDetailInfo success', result);
4653
+ * },
4654
+ * fail: (error) => {
4655
+ * console.log('getDeviceDetailInfo fail', error.errorMsg);
4656
+ * },
4657
+ * });
4658
+ * ```
1185
4659
  */
1186
4660
  export declare const getDeviceDetailInfo: typeof ty.device.getDeviceDetailInfo;
1187
4661
  /**
1188
4662
  * @public
1189
4663
  * @since @ray-js/ray 1.6.8
4664
+ * @example 基础调用
4665
+ * ```tsx
4666
+ * import { device } from '@ray-js/ray';
4667
+ *
4668
+ * const { getDeviceDetailCubeConfig } = device;
4669
+ *
4670
+ * getDeviceDetailCubeConfig({
4671
+ * success: (result) => {
4672
+ * console.log('getDeviceDetailCubeConfig success', result);
4673
+ * },
4674
+ * fail: (error) => {
4675
+ * console.log('getDeviceDetailCubeConfig fail', error.errorMsg);
4676
+ * },
4677
+ * });
4678
+ * ```
1190
4679
  */
1191
4680
  export declare const getDeviceDetailCubeConfig: typeof ty.device.getDeviceDetailCubeConfig;
1192
4681
  /**
1193
4682
  * @public
1194
4683
  * @since @ray-js/ray 1.6.8
4684
+ * @example 基础调用
4685
+ * ```tsx
4686
+ * import { device } from '@ray-js/ray';
4687
+ *
4688
+ * const { wakeUpDevice } = device;
4689
+ *
4690
+ * wakeUpDevice({
4691
+ * deviceId: 'device_001',
4692
+ * success: () => {
4693
+ * console.log('wakeUpDevice success');
4694
+ * },
4695
+ * fail: (error) => {
4696
+ * console.log('wakeUpDevice fail', error.errorMsg);
4697
+ * },
4698
+ * });
4699
+ * ```
1195
4700
  */
1196
4701
  export declare const wakeUpDevice: typeof ty.device.wakeUpDevice;
1197
4702
  /**
1198
4703
  * @public
1199
4704
  * @since @ray-js/ray 1.6.8
4705
+ * @example 基础调用
4706
+ * ```tsx
4707
+ * import { device } from '@ray-js/ray';
4708
+ *
4709
+ * const { validDeviceOnline } = device;
4710
+ *
4711
+ * validDeviceOnline({
4712
+ * deviceId: 'device_001',
4713
+ * success: (result) => {
4714
+ * console.log('validDeviceOnline success', result);
4715
+ * },
4716
+ * fail: (error) => {
4717
+ * console.log('validDeviceOnline fail', error.errorMsg);
4718
+ * },
4719
+ * });
4720
+ * ```
1200
4721
  */
1201
4722
  export declare const validDeviceOnline: typeof ty.device.validDeviceOnline;
1202
4723
  /**
1203
4724
  * @public
1204
4725
  * @since @ray-js/ray 1.6.8
4726
+ * @example 基础调用
4727
+ * ```tsx
4728
+ * import { device } from '@ray-js/ray';
4729
+ *
4730
+ * const { queryGatewayReplacementCapabilityDeviceModel } = device;
4731
+ *
4732
+ * queryGatewayReplacementCapabilityDeviceModel({
4733
+ * deviceId: 'device_001',
4734
+ * success: (result) => {
4735
+ * console.log('queryGatewayReplacementCapabilityDeviceModel success', result);
4736
+ * },
4737
+ * fail: (error) => {
4738
+ * console.log('queryGatewayReplacementCapabilityDeviceModel fail', error.errorMsg);
4739
+ * },
4740
+ * });
4741
+ * ```
1205
4742
  */
1206
4743
  export declare const queryGatewayReplacementCapabilityDeviceModel: typeof ty.device.queryGatewayReplacementCapabilityDeviceModel;
1207
4744
  /**
1208
4745
  * @public
1209
4746
  * @since @ray-js/ray 1.6.8
4747
+ * @example 基础调用
4748
+ * ```tsx
4749
+ * import { device } from '@ray-js/ray';
4750
+ *
4751
+ * const { fetchReplaceableSubDevicesDeviceModel } = device;
4752
+ *
4753
+ * fetchReplaceableSubDevicesDeviceModel({
4754
+ * deviceId: 'device_001',
4755
+ * success: (result) => {
4756
+ * console.log('fetchReplaceableSubDevicesDeviceModel success', result);
4757
+ * },
4758
+ * fail: (error) => {
4759
+ * console.log('fetchReplaceableSubDevicesDeviceModel fail', error.errorMsg);
4760
+ * },
4761
+ * });
4762
+ * ```
1210
4763
  */
1211
4764
  export declare const fetchReplaceableSubDevicesDeviceModel: typeof ty.device.fetchReplaceableSubDevicesDeviceModel;
1212
4765
  /**
1213
4766
  * @public
1214
4767
  * @since @ray-js/ray 1.6.8
4768
+ * @example 基础调用
4769
+ * ```tsx
4770
+ * import { device } from '@ray-js/ray';
4771
+ *
4772
+ * const { subDeviceReplace } = device;
4773
+ *
4774
+ * subDeviceReplace({
4775
+ * defaultSubDeviceId: 'example',
4776
+ * replaceSubDevId: 'example',
4777
+ * deleteOriginal: true,
4778
+ * timeout: 0,
4779
+ * success: (result) => {
4780
+ * console.log('subDeviceReplace success', result);
4781
+ * },
4782
+ * fail: (error) => {
4783
+ * console.log('subDeviceReplace fail', error.errorMsg);
4784
+ * },
4785
+ * });
4786
+ * ```
1215
4787
  */
1216
4788
  export declare const subDeviceReplace: typeof ty.device.subDeviceReplace;
1217
4789
  /**
1218
4790
  * @public
1219
4791
  * @since @ray-js/ray 1.6.8
4792
+ * @example 基础调用
4793
+ * ```tsx
4794
+ * import { device } from '@ray-js/ray';
4795
+ *
4796
+ * const { fetchReplacementOutcomeJobModel } = device;
4797
+ *
4798
+ * fetchReplacementOutcomeJobModel({
4799
+ * defaultSubDeviceId: 'example',
4800
+ * jobId: 'example',
4801
+ * success: (result) => {
4802
+ * console.log('fetchReplacementOutcomeJobModel success', result);
4803
+ * },
4804
+ * fail: (error) => {
4805
+ * console.log('fetchReplacementOutcomeJobModel fail', error.errorMsg);
4806
+ * },
4807
+ * });
4808
+ * ```
1220
4809
  */
1221
4810
  export declare const fetchReplacementOutcomeJobModel: typeof ty.device.fetchReplacementOutcomeJobModel;
1222
4811
  /**
1223
4812
  * @public
1224
4813
  * @since @ray-js/ray 1.6.8
4814
+ * @example 基础调用
4815
+ * ```tsx
4816
+ * import { device } from '@ray-js/ray';
4817
+ *
4818
+ * const { getMeshDeviceIdHex } = device;
4819
+ *
4820
+ * getMeshDeviceIdHex({
4821
+ * nodeId: 'example',
4822
+ * deviceId: 'device_001',
4823
+ * success: (result) => {
4824
+ * console.log('getMeshDeviceIdHex success', result);
4825
+ * },
4826
+ * fail: (error) => {
4827
+ * console.log('getMeshDeviceIdHex fail', error.errorMsg);
4828
+ * },
4829
+ * });
4830
+ * ```
1225
4831
  */
1226
4832
  export declare const getMeshDeviceIdHex: typeof ty.device.getMeshDeviceIdHex;
1227
4833
  /**
1228
4834
  * @public
1229
4835
  * @since @ray-js/ray 1.6.8
4836
+ * @example 基础调用
4837
+ * ```tsx
4838
+ * import { device } from '@ray-js/ray';
4839
+ *
4840
+ * const { onSubDeviceReplaceResult } = device;
4841
+ *
4842
+ * onSubDeviceReplaceResult((res) => {
4843
+ * console.log('onSubDeviceReplaceResult', res);
4844
+ * });
4845
+ * ```
1230
4846
  */
1231
4847
  export declare const onSubDeviceReplaceResult: typeof ty.device.onSubDeviceReplaceResult;
1232
4848
  /**
1233
4849
  * @public
1234
4850
  * @since @ray-js/ray 1.7.56
4851
+ * @example 基础调用
4852
+ * ```tsx
4853
+ * import { device } from '@ray-js/ray';
4854
+ *
4855
+ * const { aes128EncryptedStringWithPassword } = device;
4856
+ *
4857
+ * aes128EncryptedStringWithPassword({
4858
+ * deviceId: 'device_001',
4859
+ * password: 'example',
4860
+ * success: (result) => {
4861
+ * console.log('aes128EncryptedStringWithPassword success', result);
4862
+ * },
4863
+ * fail: (error) => {
4864
+ * console.log('aes128EncryptedStringWithPassword fail', error.errorMsg);
4865
+ * },
4866
+ * });
4867
+ * ```
1235
4868
  */
1236
4869
  export declare const aes128EncryptedStringWithPassword: typeof ty.device.aes128EncryptedStringWithPassword;
1237
4870
  /**
1238
4871
  * @public
1239
4872
  * @since @ray-js/ray 1.7.56
4873
+ * @example 基础调用
4874
+ * ```tsx
4875
+ * import { device } from '@ray-js/ray';
4876
+ *
4877
+ * const { aes128DecryptedStringWithPassword } = device;
4878
+ *
4879
+ * aes128DecryptedStringWithPassword({
4880
+ * deviceId: 'device_001',
4881
+ * password: 'example',
4882
+ * success: (result) => {
4883
+ * console.log('aes128DecryptedStringWithPassword success', result);
4884
+ * },
4885
+ * fail: (error) => {
4886
+ * console.log('aes128DecryptedStringWithPassword fail', error.errorMsg);
4887
+ * },
4888
+ * });
4889
+ * ```
1240
4890
  */
1241
4891
  export declare const aes128DecryptedStringWithPassword: typeof ty.device.aes128DecryptedStringWithPassword;
1242
4892
  /**
1243
4893
  * @public
1244
4894
  * @since @ray-js/ray 1.7.41
4895
+ * @example 基础调用
4896
+ * ```tsx
4897
+ * import { device } from '@ray-js/ray';
4898
+ *
4899
+ * const { getDeviceNetworkManager } = device;
4900
+ *
4901
+ * getDeviceNetworkManager({
4902
+ * deviceId: 'device_001',
4903
+ * success: () => {
4904
+ * console.log('getDeviceNetworkManager success');
4905
+ * },
4906
+ * fail: (error) => {
4907
+ * console.log('getDeviceNetworkManager fail', error.errorMsg);
4908
+ * },
4909
+ * });
4910
+ * ```
1245
4911
  */
1246
4912
  export declare const getDeviceNetworkManager: typeof ty.device.getDeviceNetworkManager;