@busy-app/busy-lib 0.13.1 → 0.14.1
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.
- package/dist/index.cjs +22 -8
- package/dist/index.d.ts +326 -514
- package/dist/index.js +917 -1053
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
|
+
import type * as Account from 'BusyBar/api/account';
|
|
2
|
+
import type * as Assets from 'BusyBar/api/assets';
|
|
3
|
+
import type * as Audio_2 from 'BusyBar/api/audio';
|
|
1
4
|
import { Client as Client_2 } from 'openapi-fetch';
|
|
2
|
-
import
|
|
5
|
+
import { default as default_2 } from 'long';
|
|
6
|
+
import type * as Display from 'BusyBar/api/display';
|
|
7
|
+
import type * as Input from 'BusyBar/api/input';
|
|
8
|
+
import type * as Settings from 'BusyBar/api/settings';
|
|
9
|
+
import type * as StorageAPI from 'BusyBar/api/storage';
|
|
10
|
+
import type * as Time from 'BusyBar/api/time';
|
|
11
|
+
import type * as Update from 'BusyBar/api/update';
|
|
12
|
+
import type * as Wifi from 'BusyBar/api/wifi';
|
|
3
13
|
|
|
4
14
|
export declare type AccountInfo = components['schemas']['AccountInfo'];
|
|
5
15
|
|
|
@@ -39,7 +49,7 @@ declare class AccountMethods {
|
|
|
39
49
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
40
50
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
41
51
|
*/
|
|
42
|
-
AccountProfileSet(this: BusyBar, params:
|
|
52
|
+
AccountProfileSet(this: BusyBar, params: SetAccountProfileParams): Promise<SuccessResponse>;
|
|
43
53
|
/**
|
|
44
54
|
* Unlink device from account. Removes association with the current account.
|
|
45
55
|
*
|
|
@@ -60,21 +70,17 @@ declare class AccountMethods {
|
|
|
60
70
|
|
|
61
71
|
export declare type AccountProfile = components['schemas']['AccountProfile'];
|
|
62
72
|
|
|
63
|
-
export declare
|
|
64
|
-
}
|
|
73
|
+
export declare type AccountProfileSetParams = Account.SetAccountProfileParams;
|
|
65
74
|
|
|
66
75
|
export declare type AccountStatus = components['schemas']['AccountStatus'];
|
|
67
76
|
|
|
68
77
|
export declare type AnimationElement = components['schemas']['AnimationElement'];
|
|
69
78
|
|
|
70
|
-
declare type ApiKey = string;
|
|
71
|
-
|
|
72
79
|
declare type ApiSemver = components['schemas']['VersionInfo']['api_semver'];
|
|
73
80
|
|
|
74
|
-
export declare
|
|
75
|
-
}
|
|
81
|
+
export declare type AssetsDeleteParams = Assets.DeleteParams;
|
|
76
82
|
|
|
77
|
-
declare type AssetsDeleteQuery = operations['deleteAppAssets']['parameters']['query'];
|
|
83
|
+
export declare type AssetsDeleteQuery = operations['deleteAppAssets']['parameters']['query'];
|
|
78
84
|
|
|
79
85
|
declare class AssetsMethods {
|
|
80
86
|
/**
|
|
@@ -87,7 +93,7 @@ declare class AssetsMethods {
|
|
|
87
93
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
88
94
|
* @returns {Promise<SuccessResponse>} Result of the upload operation.
|
|
89
95
|
*/
|
|
90
|
-
AssetsUpload(this: BusyBar, params:
|
|
96
|
+
AssetsUpload(this: BusyBar, params: UploadParams): Promise<SuccessResponse>;
|
|
91
97
|
/**
|
|
92
98
|
* Delete app assets. Deletes all assets for a specific app ID.
|
|
93
99
|
*
|
|
@@ -96,14 +102,12 @@ declare class AssetsMethods {
|
|
|
96
102
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
97
103
|
* @returns {Promise<SuccessResponse>} Result of the delete operation.
|
|
98
104
|
*/
|
|
99
|
-
AssetsDelete(this: BusyBar, params:
|
|
105
|
+
AssetsDelete(this: BusyBar, params: DeleteParams): Promise<SuccessResponse>;
|
|
100
106
|
}
|
|
101
107
|
|
|
102
|
-
export declare
|
|
103
|
-
data: BusyFile_2;
|
|
104
|
-
}
|
|
108
|
+
export declare type AssetsUploadParams = Assets.UploadParams;
|
|
105
109
|
|
|
106
|
-
declare type AssetsUploadQuery = operations['uploadAssetWithAppId']['parameters']['query'];
|
|
110
|
+
export declare type AssetsUploadQuery = operations['uploadAssetWithAppId']['parameters']['query'];
|
|
107
111
|
|
|
108
112
|
declare class AudioMethods {
|
|
109
113
|
/**
|
|
@@ -115,7 +119,7 @@ declare class AudioMethods {
|
|
|
115
119
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
116
120
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful play command.
|
|
117
121
|
*/
|
|
118
|
-
AudioPlay(this: BusyBar, params:
|
|
122
|
+
AudioPlay(this: BusyBar, params: AudioPlayParams_2): Promise<SuccessResponse>;
|
|
119
123
|
/**
|
|
120
124
|
* Stop audio playback. Stops any currently playing audio.
|
|
121
125
|
*
|
|
@@ -140,20 +144,24 @@ declare class AudioMethods {
|
|
|
140
144
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
141
145
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
142
146
|
*/
|
|
143
|
-
AudioVolumeSet(this: BusyBar, params:
|
|
147
|
+
AudioVolumeSet(this: BusyBar, params: AudioVolumeParams_2): Promise<SuccessResponse>;
|
|
144
148
|
}
|
|
145
149
|
|
|
146
|
-
export declare
|
|
150
|
+
export declare type AudioPlayParams = Audio_2.AudioPlayParams;
|
|
151
|
+
|
|
152
|
+
declare interface AudioPlayParams_2 extends TimeoutOptions, AudioPlayQuery {
|
|
147
153
|
}
|
|
148
154
|
|
|
149
|
-
declare type AudioPlayQuery = operations['playAudio']['parameters']['query'];
|
|
155
|
+
export declare type AudioPlayQuery = operations['playAudio']['parameters']['query'];
|
|
150
156
|
|
|
151
157
|
export declare type AudioVolumeInfo = components['schemas']['AudioVolumeInfo'];
|
|
152
158
|
|
|
153
|
-
export declare
|
|
159
|
+
export declare type AudioVolumeParams = Audio_2.AudioVolumeParams;
|
|
160
|
+
|
|
161
|
+
declare interface AudioVolumeParams_2 extends TimeoutOptions, AudioVolumeQuery {
|
|
154
162
|
}
|
|
155
163
|
|
|
156
|
-
declare type AudioVolumeQuery = operations['setAudioVolume']['parameters']['query'];
|
|
164
|
+
export declare type AudioVolumeQuery = operations['setAudioVolume']['parameters']['query'];
|
|
157
165
|
|
|
158
166
|
/**
|
|
159
167
|
* Authentication progress (Handshake/Token refresh)
|
|
@@ -165,6 +173,9 @@ export declare enum AuthStatus {
|
|
|
165
173
|
FAILED = "FAILED"
|
|
166
174
|
}
|
|
167
175
|
|
|
176
|
+
declare interface AutoUpdateParams extends TimeoutOptions, AutoUpdateSettings {
|
|
177
|
+
}
|
|
178
|
+
|
|
168
179
|
export declare type AutoUpdateSettings = components['schemas']['AutoupdateSettings'];
|
|
169
180
|
|
|
170
181
|
/**
|
|
@@ -305,36 +316,33 @@ export declare type BleStatusResponse = components['schemas']['BleStatusResponse
|
|
|
305
316
|
|
|
306
317
|
declare type Brightness = number | 'auto';
|
|
307
318
|
|
|
319
|
+
declare interface BrightnessParams extends TimeoutOptions {
|
|
320
|
+
value: Brightness;
|
|
321
|
+
}
|
|
322
|
+
|
|
308
323
|
/** Namespace BSB_Error. */
|
|
309
324
|
export declare namespace BSB_Error {
|
|
310
|
-
|
|
311
325
|
/** Cause enum. */
|
|
312
326
|
export enum Cause {
|
|
313
327
|
RESOURCE_LIMIT = 0
|
|
314
328
|
}
|
|
315
|
-
|
|
316
329
|
/** Severity enum. */
|
|
317
330
|
export enum Severity {
|
|
318
331
|
FATAL = 0,
|
|
319
332
|
ERROR = 1,
|
|
320
333
|
WARNING = 2
|
|
321
334
|
}
|
|
322
|
-
|
|
323
335
|
/** Properties of an Error. */
|
|
324
336
|
export interface Error {
|
|
325
|
-
|
|
326
337
|
/** Error cause */
|
|
327
|
-
cause?: (BSB_Error.Cause|null);
|
|
328
|
-
|
|
338
|
+
cause?: (BSB_Error.Cause | null);
|
|
329
339
|
/** Error severity */
|
|
330
|
-
severity?: (BSB_Error.Severity|null);
|
|
340
|
+
severity?: (BSB_Error.Severity | null);
|
|
331
341
|
}
|
|
332
|
-
|
|
333
342
|
}
|
|
334
343
|
|
|
335
344
|
/** Namespace BSB_Frame. */
|
|
336
345
|
export declare namespace BSB_Frame {
|
|
337
|
-
|
|
338
346
|
/** Encoding enum. */
|
|
339
347
|
export enum Encoding {
|
|
340
348
|
PLAIN = 0,
|
|
@@ -342,60 +350,47 @@ export declare namespace BSB_Frame {
|
|
|
342
350
|
DEFLATE = 2,
|
|
343
351
|
DEFLATE_RUN_LENGTH = 3
|
|
344
352
|
}
|
|
345
|
-
|
|
346
353
|
/** PixelFormat enum. */
|
|
347
354
|
export enum PixelFormat {
|
|
348
355
|
RGB888 = 0,
|
|
349
356
|
L8 = 1,
|
|
350
357
|
L4 = 2
|
|
351
358
|
}
|
|
352
|
-
|
|
353
359
|
/** Screen enum. */
|
|
354
360
|
export enum Screen {
|
|
355
361
|
FRONT = 0,
|
|
356
362
|
BACK = 1
|
|
357
363
|
}
|
|
358
|
-
|
|
359
364
|
/** Properties of a Frame. */
|
|
360
365
|
export interface Frame {
|
|
361
|
-
|
|
362
366
|
/** Frame screen */
|
|
363
|
-
screen?: (BSB_Frame.Screen|null);
|
|
364
|
-
|
|
367
|
+
screen?: (BSB_Frame.Screen | null);
|
|
365
368
|
/** Frame width */
|
|
366
|
-
width?: (number|null);
|
|
367
|
-
|
|
369
|
+
width?: (number | null);
|
|
368
370
|
/** Frame height */
|
|
369
|
-
height?: (number|null);
|
|
370
|
-
|
|
371
|
+
height?: (number | null);
|
|
371
372
|
/** Frame encoding */
|
|
372
|
-
encoding?: (BSB_Frame.Encoding|null);
|
|
373
|
-
|
|
373
|
+
encoding?: (BSB_Frame.Encoding | null);
|
|
374
374
|
/** Frame pixelFormat */
|
|
375
|
-
pixelFormat?: (BSB_Frame.PixelFormat|null);
|
|
376
|
-
|
|
375
|
+
pixelFormat?: (BSB_Frame.PixelFormat | null);
|
|
377
376
|
/** Frame data */
|
|
378
|
-
data?: (Uint8Array|null);
|
|
377
|
+
data?: (Uint8Array | null);
|
|
379
378
|
}
|
|
380
|
-
|
|
381
379
|
}
|
|
382
380
|
|
|
383
381
|
/** Namespace BSB_Input. */
|
|
384
382
|
export declare namespace BSB_Input {
|
|
385
|
-
|
|
386
383
|
/** Button enum. */
|
|
387
384
|
export enum Button {
|
|
388
385
|
OK = 0,
|
|
389
386
|
BACK = 1,
|
|
390
387
|
START = 2
|
|
391
388
|
}
|
|
392
|
-
|
|
393
389
|
/** ButtonAction enum. */
|
|
394
390
|
export enum ButtonAction {
|
|
395
391
|
PRESS = 0,
|
|
396
392
|
RELEASE = 1
|
|
397
393
|
}
|
|
398
|
-
|
|
399
394
|
/** SwitchPosition enum. */
|
|
400
395
|
export enum SwitchPosition {
|
|
401
396
|
BUSY = 0,
|
|
@@ -404,199 +399,132 @@ export declare namespace BSB_Input {
|
|
|
404
399
|
APPS = 3,
|
|
405
400
|
SETTINGS = 4
|
|
406
401
|
}
|
|
407
|
-
|
|
408
402
|
/** Properties of a ButtonEvent. */
|
|
409
403
|
export interface ButtonEvent {
|
|
410
|
-
|
|
411
404
|
/** ButtonEvent button */
|
|
412
|
-
button?: (BSB_Input.Button|null);
|
|
413
|
-
|
|
405
|
+
button?: (BSB_Input.Button | null);
|
|
414
406
|
/** ButtonEvent action */
|
|
415
|
-
action?: (BSB_Input.ButtonAction|null);
|
|
407
|
+
action?: (BSB_Input.ButtonAction | null);
|
|
416
408
|
}
|
|
417
|
-
|
|
418
|
-
|
|
419
409
|
/** Properties of a SwitchEvent. */
|
|
420
410
|
export interface SwitchEvent {
|
|
421
|
-
|
|
422
411
|
/** SwitchEvent position */
|
|
423
|
-
position?: (BSB_Input.SwitchPosition|null);
|
|
412
|
+
position?: (BSB_Input.SwitchPosition | null);
|
|
424
413
|
}
|
|
425
|
-
|
|
426
|
-
|
|
427
414
|
/** Properties of an EncoderEvent. */
|
|
428
415
|
export interface EncoderEvent {
|
|
429
|
-
|
|
430
416
|
/** EncoderEvent delta */
|
|
431
|
-
delta?: (number|null);
|
|
417
|
+
delta?: (number | null);
|
|
432
418
|
}
|
|
433
|
-
|
|
434
|
-
|
|
435
419
|
/** Properties of an InputEvent. */
|
|
436
420
|
export interface InputEvent {
|
|
437
|
-
|
|
438
421
|
/** InputEvent buttonEvent */
|
|
439
|
-
buttonEvent?: (BSB_Input.ButtonEvent|null);
|
|
440
|
-
|
|
422
|
+
buttonEvent?: (BSB_Input.ButtonEvent | null);
|
|
441
423
|
/** InputEvent switchEvent */
|
|
442
|
-
switchEvent?: (BSB_Input.SwitchEvent|null);
|
|
443
|
-
|
|
424
|
+
switchEvent?: (BSB_Input.SwitchEvent | null);
|
|
444
425
|
/** InputEvent encoderEvent */
|
|
445
|
-
encoderEvent?: (BSB_Input.EncoderEvent|null);
|
|
426
|
+
encoderEvent?: (BSB_Input.EncoderEvent | null);
|
|
446
427
|
}
|
|
447
|
-
|
|
448
428
|
}
|
|
449
429
|
|
|
450
430
|
/** Namespace BSB_State. */
|
|
451
431
|
export declare namespace BSB_State {
|
|
452
|
-
|
|
453
432
|
/** Properties of a StateUpdate. */
|
|
454
433
|
export interface StateUpdate {
|
|
455
|
-
|
|
456
434
|
/** StateUpdate deviceName */
|
|
457
|
-
deviceName?: (BSB_State.DeviceName|null);
|
|
458
|
-
|
|
435
|
+
deviceName?: (BSB_State.DeviceName | null);
|
|
459
436
|
/** StateUpdate power */
|
|
460
|
-
power?: (BSB_State.Power|null);
|
|
461
|
-
|
|
437
|
+
power?: (BSB_State.Power | null);
|
|
462
438
|
/** StateUpdate brightness */
|
|
463
|
-
brightness?: (BSB_State.Brightness|null);
|
|
464
|
-
|
|
439
|
+
brightness?: (BSB_State.Brightness | null);
|
|
465
440
|
/** StateUpdate audioVolume */
|
|
466
|
-
audioVolume?: (BSB_State.AudioVolume|null);
|
|
467
|
-
|
|
441
|
+
audioVolume?: (BSB_State.AudioVolume | null);
|
|
468
442
|
/** StateUpdate wifi */
|
|
469
|
-
wifi?: (BSB_State.Wifi|null);
|
|
470
|
-
|
|
443
|
+
wifi?: (BSB_State.Wifi | null);
|
|
471
444
|
/** StateUpdate updateState */
|
|
472
|
-
updateState?: (BSB_Update.UpdateState|null);
|
|
473
|
-
|
|
445
|
+
updateState?: (BSB_Update.UpdateState | null);
|
|
474
446
|
/** StateUpdate updateCheck */
|
|
475
|
-
updateCheck?: (BSB_Update.CheckState|null);
|
|
476
|
-
|
|
447
|
+
updateCheck?: (BSB_Update.CheckState | null);
|
|
477
448
|
/** StateUpdate timezone */
|
|
478
|
-
timezone?: (BSB_State.Timezone|null);
|
|
479
|
-
|
|
449
|
+
timezone?: (BSB_State.Timezone | null);
|
|
480
450
|
/** StateUpdate matter */
|
|
481
|
-
matter?: (BSB_State.Matter|null);
|
|
482
|
-
|
|
451
|
+
matter?: (BSB_State.Matter | null);
|
|
483
452
|
/** StateUpdate frame */
|
|
484
|
-
frame?: (BSB_Frame.Frame|null);
|
|
485
|
-
|
|
453
|
+
frame?: (BSB_Frame.Frame | null);
|
|
486
454
|
/** StateUpdate input */
|
|
487
|
-
input?: (BSB_Input.InputEvent|null);
|
|
488
|
-
|
|
455
|
+
input?: (BSB_Input.InputEvent | null);
|
|
489
456
|
/** StateUpdate timer */
|
|
490
|
-
timer?: (BSB_Timer.Timer|null);
|
|
491
|
-
|
|
457
|
+
timer?: (BSB_Timer.Timer | null);
|
|
492
458
|
/** StateUpdate ble */
|
|
493
|
-
ble?: (BSB_State.Ble.Ble|null);
|
|
494
|
-
|
|
459
|
+
ble?: (BSB_State.Ble.Ble | null);
|
|
495
460
|
/** StateUpdate autoUpdateState */
|
|
496
|
-
autoUpdateState?: (BSB_Update.AutoUpdateState|null);
|
|
461
|
+
autoUpdateState?: (BSB_Update.AutoUpdateState | null);
|
|
497
462
|
}
|
|
498
|
-
|
|
499
|
-
|
|
500
463
|
/** Properties of a State. */
|
|
501
464
|
export interface State {
|
|
502
|
-
|
|
503
465
|
/** State timestamp */
|
|
504
|
-
timestamp?: (number|
|
|
505
|
-
|
|
466
|
+
timestamp?: (number | default_2 | null);
|
|
506
467
|
/** State updates */
|
|
507
|
-
updates?: (BSB_State.StateUpdate[]|null);
|
|
508
|
-
|
|
468
|
+
updates?: (BSB_State.StateUpdate[] | null);
|
|
509
469
|
/** State error */
|
|
510
|
-
error?: (BSB_Error.Error|null);
|
|
470
|
+
error?: (BSB_Error.Error | null);
|
|
511
471
|
}
|
|
512
|
-
|
|
513
|
-
|
|
514
472
|
/** Properties of a DeviceName. */
|
|
515
473
|
export interface DeviceName {
|
|
516
|
-
|
|
517
474
|
/** DeviceName name */
|
|
518
|
-
name?: (string|null);
|
|
475
|
+
name?: (string | null);
|
|
519
476
|
}
|
|
520
|
-
|
|
521
|
-
|
|
522
477
|
/** Properties of a BrightnessAutomatic. */
|
|
523
478
|
export interface BrightnessAutomatic {
|
|
524
479
|
}
|
|
525
|
-
|
|
526
|
-
|
|
527
480
|
/** Properties of a BrightnessManual. */
|
|
528
481
|
export interface BrightnessManual {
|
|
529
|
-
|
|
530
482
|
/** BrightnessManual brightness */
|
|
531
|
-
brightness?: (number|null);
|
|
483
|
+
brightness?: (number | null);
|
|
532
484
|
}
|
|
533
|
-
|
|
534
|
-
|
|
535
485
|
/** Properties of a Brightness. */
|
|
536
486
|
export interface Brightness {
|
|
537
|
-
|
|
538
487
|
/** Brightness automatic */
|
|
539
|
-
automatic?: (BSB_State.BrightnessAutomatic|null);
|
|
540
|
-
|
|
488
|
+
automatic?: (BSB_State.BrightnessAutomatic | null);
|
|
541
489
|
/** Brightness manual */
|
|
542
|
-
manual?: (BSB_State.BrightnessManual|null);
|
|
543
|
-
|
|
490
|
+
manual?: (BSB_State.BrightnessManual | null);
|
|
544
491
|
/** Brightness actualBrightness */
|
|
545
|
-
actualBrightness?: (number|null);
|
|
492
|
+
actualBrightness?: (number | null);
|
|
546
493
|
}
|
|
547
|
-
|
|
548
|
-
|
|
549
494
|
/** BatteryStatus enum. */
|
|
550
495
|
export enum BatteryStatus {
|
|
551
496
|
DISCHARGING = 0,
|
|
552
497
|
CHARGING = 1,
|
|
553
498
|
CHARGED = 2
|
|
554
499
|
}
|
|
555
|
-
|
|
556
500
|
/** Properties of an UnknownPowerState. */
|
|
557
501
|
export interface UnknownPowerState {
|
|
558
502
|
}
|
|
559
|
-
|
|
560
|
-
|
|
561
503
|
/** Properties of a PowerState. */
|
|
562
504
|
export interface PowerState {
|
|
563
|
-
|
|
564
505
|
/** PowerState batteryStatus */
|
|
565
|
-
batteryStatus?: (BSB_State.BatteryStatus|null);
|
|
566
|
-
|
|
506
|
+
batteryStatus?: (BSB_State.BatteryStatus | null);
|
|
567
507
|
/** PowerState batteryChargePercent */
|
|
568
|
-
batteryChargePercent?: (number|null);
|
|
569
|
-
|
|
508
|
+
batteryChargePercent?: (number | null);
|
|
570
509
|
/** PowerState batteryVoltageMv */
|
|
571
|
-
batteryVoltageMv?: (number|null);
|
|
572
|
-
|
|
510
|
+
batteryVoltageMv?: (number | null);
|
|
573
511
|
/** PowerState batteryCurrentMa */
|
|
574
|
-
batteryCurrentMa?: (number|null);
|
|
575
|
-
|
|
512
|
+
batteryCurrentMa?: (number | null);
|
|
576
513
|
/** PowerState usbVoltageMv */
|
|
577
|
-
usbVoltageMv?: (number|null);
|
|
514
|
+
usbVoltageMv?: (number | null);
|
|
578
515
|
}
|
|
579
|
-
|
|
580
|
-
|
|
581
516
|
/** Properties of a Power. */
|
|
582
517
|
export interface Power {
|
|
583
|
-
|
|
584
518
|
/** Power unknown */
|
|
585
|
-
unknown?: (BSB_State.UnknownPowerState|null);
|
|
586
|
-
|
|
519
|
+
unknown?: (BSB_State.UnknownPowerState | null);
|
|
587
520
|
/** Power known */
|
|
588
|
-
known?: (BSB_State.PowerState|null);
|
|
521
|
+
known?: (BSB_State.PowerState | null);
|
|
589
522
|
}
|
|
590
|
-
|
|
591
|
-
|
|
592
523
|
/** Properties of an AudioVolume. */
|
|
593
524
|
export interface AudioVolume {
|
|
594
|
-
|
|
595
525
|
/** AudioVolume volume */
|
|
596
|
-
volume?: (number|null);
|
|
526
|
+
volume?: (number | null);
|
|
597
527
|
}
|
|
598
|
-
|
|
599
|
-
|
|
600
528
|
/** WifiConnectionStatus enum. */
|
|
601
529
|
export enum WifiConnectionStatus {
|
|
602
530
|
CONNECTED = 0,
|
|
@@ -604,7 +532,6 @@ export declare namespace BSB_State {
|
|
|
604
532
|
DISCONNECTING = 2,
|
|
605
533
|
RECONNECTING = 3
|
|
606
534
|
}
|
|
607
|
-
|
|
608
535
|
/** WifiSecurity enum. */
|
|
609
536
|
export enum WifiSecurity {
|
|
610
537
|
UNKNOWN = 0,
|
|
@@ -616,103 +543,70 @@ export declare namespace BSB_State {
|
|
|
616
543
|
WPA3 = 6,
|
|
617
544
|
WPA2_WPA3 = 7
|
|
618
545
|
}
|
|
619
|
-
|
|
620
546
|
/** IpConfigurationMethod enum. */
|
|
621
547
|
export enum IpConfigurationMethod {
|
|
622
548
|
DHCP = 0,
|
|
623
549
|
STATIC = 1
|
|
624
550
|
}
|
|
625
|
-
|
|
626
551
|
/** IpProtocol enum. */
|
|
627
552
|
export enum IpProtocol {
|
|
628
553
|
IPV4 = 0,
|
|
629
554
|
IPV6 = 1
|
|
630
555
|
}
|
|
631
|
-
|
|
632
556
|
/** Properties of a WifiStateUnknown. */
|
|
633
557
|
export interface WifiStateUnknown {
|
|
634
558
|
}
|
|
635
|
-
|
|
636
|
-
|
|
637
559
|
/** Properties of a WifiStateDisconnected. */
|
|
638
560
|
export interface WifiStateDisconnected {
|
|
639
561
|
}
|
|
640
|
-
|
|
641
|
-
|
|
642
562
|
/** Properties of a WifiStateConnected. */
|
|
643
563
|
export interface WifiStateConnected {
|
|
644
|
-
|
|
645
564
|
/** WifiStateConnected status */
|
|
646
|
-
status?: (BSB_State.WifiConnectionStatus|null);
|
|
647
|
-
|
|
565
|
+
status?: (BSB_State.WifiConnectionStatus | null);
|
|
648
566
|
/** WifiStateConnected ssid */
|
|
649
|
-
ssid?: (string|null);
|
|
650
|
-
|
|
567
|
+
ssid?: (string | null);
|
|
651
568
|
/** WifiStateConnected bssid */
|
|
652
|
-
bssid?: (string|null);
|
|
653
|
-
|
|
569
|
+
bssid?: (string | null);
|
|
654
570
|
/** WifiStateConnected channel */
|
|
655
|
-
channel?: (number|null);
|
|
656
|
-
|
|
571
|
+
channel?: (number | null);
|
|
657
572
|
/** WifiStateConnected rssi */
|
|
658
|
-
rssi?: (number|null);
|
|
659
|
-
|
|
573
|
+
rssi?: (number | null);
|
|
660
574
|
/** WifiStateConnected security */
|
|
661
|
-
security?: (BSB_State.WifiSecurity|null);
|
|
575
|
+
security?: (BSB_State.WifiSecurity | null);
|
|
662
576
|
}
|
|
663
|
-
|
|
664
|
-
|
|
665
577
|
/** Properties of an IpAddress. */
|
|
666
578
|
export interface IpAddress {
|
|
667
|
-
|
|
668
579
|
/** IpAddress protocol */
|
|
669
|
-
protocol?: (BSB_State.IpProtocol|null);
|
|
670
|
-
|
|
580
|
+
protocol?: (BSB_State.IpProtocol | null);
|
|
671
581
|
/** IpAddress method */
|
|
672
|
-
method?: (BSB_State.IpConfigurationMethod|null);
|
|
673
|
-
|
|
582
|
+
method?: (BSB_State.IpConfigurationMethod | null);
|
|
674
583
|
/** IpAddress address */
|
|
675
|
-
address?: (string|null);
|
|
676
|
-
|
|
584
|
+
address?: (string | null);
|
|
677
585
|
/** IpAddress gateway */
|
|
678
|
-
gateway?: (string|null);
|
|
679
|
-
|
|
586
|
+
gateway?: (string | null);
|
|
680
587
|
/** IpAddress netmask */
|
|
681
|
-
netmask?: (string|null);
|
|
588
|
+
netmask?: (string | null);
|
|
682
589
|
}
|
|
683
|
-
|
|
684
|
-
|
|
685
590
|
/** Properties of a Wifi. */
|
|
686
591
|
export interface Wifi {
|
|
687
|
-
|
|
688
592
|
/** Wifi unknown */
|
|
689
|
-
unknown?: (BSB_State.WifiStateUnknown|null);
|
|
690
|
-
|
|
593
|
+
unknown?: (BSB_State.WifiStateUnknown | null);
|
|
691
594
|
/** Wifi disconnected */
|
|
692
|
-
disconnected?: (BSB_State.WifiStateDisconnected|null);
|
|
693
|
-
|
|
595
|
+
disconnected?: (BSB_State.WifiStateDisconnected | null);
|
|
694
596
|
/** Wifi connected */
|
|
695
|
-
connected?: (BSB_State.WifiStateConnected|null);
|
|
696
|
-
|
|
597
|
+
connected?: (BSB_State.WifiStateConnected | null);
|
|
697
598
|
/** Wifi ipAddresses */
|
|
698
|
-
ipAddresses?: (BSB_State.IpAddress[]|null);
|
|
599
|
+
ipAddresses?: (BSB_State.IpAddress[] | null);
|
|
699
600
|
}
|
|
700
|
-
|
|
701
|
-
|
|
702
601
|
/** Properties of a Timezone. */
|
|
703
602
|
export interface Timezone {
|
|
704
|
-
|
|
705
603
|
/** Timezone name */
|
|
706
|
-
name?: (string|null);
|
|
707
|
-
|
|
604
|
+
name?: (string | null);
|
|
708
605
|
/** Timezone offset */
|
|
709
|
-
offset?: (number|null);
|
|
710
|
-
|
|
606
|
+
offset?: (number | null);
|
|
711
607
|
/** Timezone abbr */
|
|
712
|
-
abbr?: (string|null);
|
|
608
|
+
abbr?: (string | null);
|
|
713
609
|
}
|
|
714
|
-
|
|
715
|
-
|
|
716
610
|
/** MatterCommissioningStatus enum. */
|
|
717
611
|
export enum MatterCommissioningStatus {
|
|
718
612
|
NEVER_STARTED = 0,
|
|
@@ -720,32 +614,22 @@ export declare namespace BSB_State {
|
|
|
720
614
|
COMPLETED_SUCCESSFULLY = 2,
|
|
721
615
|
FAILED = 3
|
|
722
616
|
}
|
|
723
|
-
|
|
724
617
|
/** Properties of a MatterCommissioningState. */
|
|
725
618
|
export interface MatterCommissioningState {
|
|
726
|
-
|
|
727
619
|
/** MatterCommissioningState status */
|
|
728
|
-
status?: (BSB_State.MatterCommissioningStatus|null);
|
|
729
|
-
|
|
620
|
+
status?: (BSB_State.MatterCommissioningStatus | null);
|
|
730
621
|
/** MatterCommissioningState timestamp */
|
|
731
|
-
timestamp?: (number|
|
|
622
|
+
timestamp?: (number | default_2 | null);
|
|
732
623
|
}
|
|
733
|
-
|
|
734
|
-
|
|
735
624
|
/** Properties of a Matter. */
|
|
736
625
|
export interface Matter {
|
|
737
|
-
|
|
738
626
|
/** Matter fabricCount */
|
|
739
|
-
fabricCount?: (number|null);
|
|
740
|
-
|
|
627
|
+
fabricCount?: (number | null);
|
|
741
628
|
/** Matter state */
|
|
742
|
-
state?: (BSB_State.MatterCommissioningState|null);
|
|
629
|
+
state?: (BSB_State.MatterCommissioningState | null);
|
|
743
630
|
}
|
|
744
|
-
|
|
745
|
-
|
|
746
631
|
/** Namespace Ble. */
|
|
747
632
|
export namespace Ble {
|
|
748
|
-
|
|
749
633
|
/** ServiceStatus enum. */
|
|
750
634
|
export enum ServiceStatus {
|
|
751
635
|
RESET = 0,
|
|
@@ -756,35 +640,27 @@ export declare namespace BSB_State {
|
|
|
756
640
|
CONNECTED = 5,
|
|
757
641
|
ERROR = 6
|
|
758
642
|
}
|
|
759
|
-
|
|
760
643
|
/** Properties of a Ble. */
|
|
761
644
|
export interface Ble {
|
|
762
|
-
|
|
763
645
|
/** Ble status */
|
|
764
|
-
status?: (BSB_State.Ble.ServiceStatus|null);
|
|
765
|
-
|
|
646
|
+
status?: (BSB_State.Ble.ServiceStatus | null);
|
|
766
647
|
/** Ble remoteAddress */
|
|
767
|
-
remoteAddress?: (string|null);
|
|
648
|
+
remoteAddress?: (string | null);
|
|
768
649
|
}
|
|
769
|
-
|
|
770
650
|
}
|
|
771
651
|
}
|
|
772
652
|
|
|
773
653
|
/** Namespace BSB_Timer. */
|
|
774
654
|
export declare namespace BSB_Timer {
|
|
775
|
-
|
|
776
655
|
/** Properties of a Timer. */
|
|
777
656
|
export interface Timer {
|
|
778
|
-
|
|
779
657
|
/** Timer json */
|
|
780
|
-
json?: (BSB_Util.Json|null);
|
|
658
|
+
json?: (BSB_Util.Json | null);
|
|
781
659
|
}
|
|
782
|
-
|
|
783
660
|
}
|
|
784
661
|
|
|
785
662
|
/** Namespace BSB_Update. */
|
|
786
663
|
export declare namespace BSB_Update {
|
|
787
|
-
|
|
788
664
|
/** UpdateEvent enum. */
|
|
789
665
|
export enum UpdateEvent {
|
|
790
666
|
SESSION_START = 0,
|
|
@@ -795,7 +671,6 @@ export declare namespace BSB_Update {
|
|
|
795
671
|
ACTION_PROGRESS = 5,
|
|
796
672
|
EVENT_NONE = 6
|
|
797
673
|
}
|
|
798
|
-
|
|
799
674
|
/** UpdateAction enum. */
|
|
800
675
|
export enum UpdateAction {
|
|
801
676
|
DOWNLOAD = 0,
|
|
@@ -805,7 +680,6 @@ export declare namespace BSB_Update {
|
|
|
805
680
|
INSTALLATION_APPLY = 4,
|
|
806
681
|
ACTION_NONE = 5
|
|
807
682
|
}
|
|
808
|
-
|
|
809
683
|
/** UpdateStatus enum. */
|
|
810
684
|
export enum UpdateStatus {
|
|
811
685
|
OK = 0,
|
|
@@ -823,97 +697,68 @@ export declare namespace BSB_Update {
|
|
|
823
697
|
INSTALLATION_PREPARE_POINTER_SETUP_FAILURE = 12,
|
|
824
698
|
UNKNOWN_FAILURE = 13
|
|
825
699
|
}
|
|
826
|
-
|
|
827
700
|
/** CheckError enum. */
|
|
828
701
|
export enum CheckError {
|
|
829
702
|
NOT_AVAILABLE = 0,
|
|
830
703
|
FAILURE = 1,
|
|
831
704
|
IDLE = 2
|
|
832
705
|
}
|
|
833
|
-
|
|
834
706
|
/** Properties of an UpdateAvailable. */
|
|
835
707
|
export interface UpdateAvailable {
|
|
836
|
-
|
|
837
708
|
/** UpdateAvailable version */
|
|
838
|
-
version?: (string|null);
|
|
709
|
+
version?: (string | null);
|
|
839
710
|
}
|
|
840
|
-
|
|
841
|
-
|
|
842
711
|
/** Properties of an UpdateUnavailable. */
|
|
843
712
|
export interface UpdateUnavailable {
|
|
844
|
-
|
|
845
713
|
/** UpdateUnavailable reason */
|
|
846
|
-
reason?: (BSB_Update.CheckError|null);
|
|
714
|
+
reason?: (BSB_Update.CheckError | null);
|
|
847
715
|
}
|
|
848
|
-
|
|
849
|
-
|
|
850
716
|
/** Properties of an UpdateState. */
|
|
851
717
|
export interface UpdateState {
|
|
852
|
-
|
|
853
718
|
/** UpdateState event */
|
|
854
|
-
event?: (BSB_Update.UpdateEvent|null);
|
|
855
|
-
|
|
719
|
+
event?: (BSB_Update.UpdateEvent | null);
|
|
856
720
|
/** UpdateState action */
|
|
857
|
-
action?: (BSB_Update.UpdateAction|null);
|
|
858
|
-
|
|
721
|
+
action?: (BSB_Update.UpdateAction | null);
|
|
859
722
|
/** UpdateState status */
|
|
860
|
-
status?: (BSB_Update.UpdateStatus|null);
|
|
723
|
+
status?: (BSB_Update.UpdateStatus | null);
|
|
861
724
|
}
|
|
862
|
-
|
|
863
|
-
|
|
864
725
|
/** Properties of a CheckState. */
|
|
865
726
|
export interface CheckState {
|
|
866
|
-
|
|
867
727
|
/** CheckState available */
|
|
868
|
-
available?: (BSB_Update.UpdateAvailable|null);
|
|
869
|
-
|
|
728
|
+
available?: (BSB_Update.UpdateAvailable | null);
|
|
870
729
|
/** CheckState unavailable */
|
|
871
|
-
unavailable?: (BSB_Update.UpdateUnavailable|null);
|
|
730
|
+
unavailable?: (BSB_Update.UpdateUnavailable | null);
|
|
872
731
|
}
|
|
873
|
-
|
|
874
|
-
|
|
875
732
|
/** Properties of an AutoUpdateInterval. */
|
|
876
733
|
export interface AutoUpdateInterval {
|
|
877
|
-
|
|
878
734
|
/** AutoUpdateInterval start */
|
|
879
|
-
start?: (number|null);
|
|
880
|
-
|
|
735
|
+
start?: (number | null);
|
|
881
736
|
/** AutoUpdateInterval end */
|
|
882
|
-
end?: (number|null);
|
|
737
|
+
end?: (number | null);
|
|
883
738
|
}
|
|
884
|
-
|
|
885
|
-
|
|
886
739
|
/** Properties of an AutoUpdateState. */
|
|
887
740
|
export interface AutoUpdateState {
|
|
888
|
-
|
|
889
741
|
/** AutoUpdateState enabled */
|
|
890
|
-
enabled?: (boolean|null);
|
|
891
|
-
|
|
742
|
+
enabled?: (boolean | null);
|
|
892
743
|
/** AutoUpdateState interval */
|
|
893
|
-
interval?: (BSB_Update.AutoUpdateInterval|null);
|
|
744
|
+
interval?: (BSB_Update.AutoUpdateInterval | null);
|
|
894
745
|
}
|
|
895
|
-
|
|
896
746
|
}
|
|
897
747
|
|
|
898
748
|
/** Namespace BSB_Util. */
|
|
899
749
|
export declare namespace BSB_Util {
|
|
900
|
-
|
|
901
750
|
/** Compression enum. */
|
|
902
751
|
export enum Compression {
|
|
903
752
|
PLAIN = 0,
|
|
904
753
|
GZIP = 1
|
|
905
754
|
}
|
|
906
|
-
|
|
907
755
|
/** Properties of a Json. */
|
|
908
756
|
export interface Json {
|
|
909
|
-
|
|
910
757
|
/** Json compression */
|
|
911
|
-
compression?: (BSB_Util.Compression|null);
|
|
912
|
-
|
|
758
|
+
compression?: (BSB_Util.Compression | null);
|
|
913
759
|
/** Json data */
|
|
914
|
-
data?: (Uint8Array|null);
|
|
760
|
+
data?: (Uint8Array | null);
|
|
915
761
|
}
|
|
916
|
-
|
|
917
762
|
}
|
|
918
763
|
|
|
919
764
|
export declare interface BusyBar extends SystemMethods, UpdateMethods, TimeMethods, AccountMethods, DisplayMethods, AudioMethods, WifiMethods, StorageMethods, SettingsMethods, BleMethods, InputMethods, AssetsMethods, SmartHomeMethods {
|
|
@@ -970,6 +815,11 @@ export declare class BusyBar {
|
|
|
970
815
|
*
|
|
971
816
|
* Must be provided when `addr` points to a secured proxy endpoint
|
|
972
817
|
* such as `https://proxy.busy.app`.
|
|
818
|
+
*
|
|
819
|
+
* @param {BusyBarConfig['timeout']} config.timeout -
|
|
820
|
+
* Optional default timeout for all requests in milliseconds.
|
|
821
|
+
*
|
|
822
|
+
* Defaults to `3000` if not provided. This value can be overridden in individual method calls.
|
|
973
823
|
*/
|
|
974
824
|
constructor(config?: BusyBarConfig);
|
|
975
825
|
/**
|
|
@@ -989,18 +839,25 @@ export declare class BusyBar {
|
|
|
989
839
|
setToken(token: string): void;
|
|
990
840
|
}
|
|
991
841
|
|
|
992
|
-
declare type BusyBarClient = Client_2<paths, `${string}/${string}
|
|
842
|
+
declare type BusyBarClient = Client_2<paths, `${string}/${string}`> & {
|
|
843
|
+
withTimeout: <T>(requestFn: (signal?: AbortSignal) => Promise<T>, timeoutMs?: number) => Promise<T>;
|
|
844
|
+
};
|
|
993
845
|
|
|
994
846
|
export declare type BusyBarConfig = {
|
|
995
847
|
addr?: string;
|
|
996
848
|
token?: string;
|
|
849
|
+
timeout?: number;
|
|
997
850
|
};
|
|
998
851
|
|
|
999
852
|
export declare type BusyFile = Buffer | Blob | File | ArrayBuffer;
|
|
1000
853
|
|
|
1001
|
-
declare
|
|
854
|
+
declare interface ChangelogParams extends TimeoutOptions, UpdateChangelogQuery {
|
|
855
|
+
}
|
|
856
|
+
|
|
857
|
+
export declare type ClearDisplayQuery = NonNullable<operations['clearDisplay']['parameters']['query']>;
|
|
1002
858
|
|
|
1003
|
-
declare
|
|
859
|
+
declare interface ClearParams extends TimeoutOptions, Partial<ClearDisplayQuery> {
|
|
860
|
+
}
|
|
1004
861
|
|
|
1005
862
|
declare interface components {
|
|
1006
863
|
schemas: {
|
|
@@ -1031,6 +888,17 @@ declare interface components {
|
|
|
1031
888
|
*/
|
|
1032
889
|
api_semver: string;
|
|
1033
890
|
};
|
|
891
|
+
/** @example {
|
|
892
|
+
* "type": "usb"
|
|
893
|
+
* } */
|
|
894
|
+
NetworkInterfaceInfo: {
|
|
895
|
+
/**
|
|
896
|
+
* @description Connection type
|
|
897
|
+
* @example usb
|
|
898
|
+
* @enum {string}
|
|
899
|
+
*/
|
|
900
|
+
type: 'usb' | 'wifi';
|
|
901
|
+
};
|
|
1034
902
|
/** @example {
|
|
1035
903
|
* "install": {
|
|
1036
904
|
* "is_allowed": true,
|
|
@@ -1507,6 +1375,11 @@ declare interface components {
|
|
|
1507
1375
|
* @example 1767225600
|
|
1508
1376
|
*/
|
|
1509
1377
|
boot_time: number;
|
|
1378
|
+
/**
|
|
1379
|
+
* @description Is auto-update enabled
|
|
1380
|
+
* @example true
|
|
1381
|
+
*/
|
|
1382
|
+
auto_update_enabled: boolean;
|
|
1510
1383
|
};
|
|
1511
1384
|
StatusPower: {
|
|
1512
1385
|
/**
|
|
@@ -1849,15 +1722,20 @@ export declare enum ConnectionStatus {
|
|
|
1849
1722
|
RECONNECTING = "RECONNECTING"
|
|
1850
1723
|
}
|
|
1851
1724
|
|
|
1725
|
+
declare type ConnectParams = RequireKeys<Omit<WifiConnectRequestConfig, 'ip_config'> & {
|
|
1726
|
+
ip_config: RequiredIpConfig;
|
|
1727
|
+
}, 'ssid' | 'security' | 'ip_config'> & TimeoutOptions;
|
|
1728
|
+
|
|
1852
1729
|
export declare type CountdownElement = components['schemas']['CountdownElement'];
|
|
1853
1730
|
|
|
1731
|
+
declare interface CreateDirectoryParams extends TimeoutOptions, StorageCreateDirQuery {
|
|
1732
|
+
}
|
|
1733
|
+
|
|
1854
1734
|
/**
|
|
1855
1735
|
* Callbacks for the main thread
|
|
1856
1736
|
*/
|
|
1857
1737
|
export declare type DataCallback = (data: ProcessedState) => void;
|
|
1858
1738
|
|
|
1859
|
-
declare type DataListener = (data: Uint8Array) => void;
|
|
1860
|
-
|
|
1861
1739
|
/**
|
|
1862
1740
|
* Data throughput state
|
|
1863
1741
|
*/
|
|
@@ -1867,22 +1745,16 @@ export declare enum DataStatus {
|
|
|
1867
1745
|
STALE = "STALE"
|
|
1868
1746
|
}
|
|
1869
1747
|
|
|
1870
|
-
|
|
1871
|
-
FRONT = 0,
|
|
1872
|
-
BACK = 1
|
|
1748
|
+
declare interface DeleteParams extends TimeoutOptions, AssetsDeleteQuery {
|
|
1873
1749
|
}
|
|
1874
1750
|
|
|
1875
1751
|
export declare type DisplayBrightnessInfo = components['schemas']['DisplayBrightnessInfo'];
|
|
1876
1752
|
|
|
1877
|
-
export declare
|
|
1878
|
-
value: Brightness;
|
|
1879
|
-
}
|
|
1753
|
+
export declare type DisplayBrightnessParams = Display.BrightnessParams;
|
|
1880
1754
|
|
|
1881
|
-
export declare
|
|
1882
|
-
}
|
|
1755
|
+
export declare type DisplayClearParams = Display.ClearParams;
|
|
1883
1756
|
|
|
1884
|
-
export declare
|
|
1885
|
-
}
|
|
1757
|
+
export declare type DisplayDrawParams = Display.DrawParams;
|
|
1886
1758
|
|
|
1887
1759
|
export declare type DisplayElement = components['schemas']['DisplayElement'];
|
|
1888
1760
|
|
|
@@ -1899,7 +1771,7 @@ declare class DisplayMethods {
|
|
|
1899
1771
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1900
1772
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful draw command.
|
|
1901
1773
|
*/
|
|
1902
|
-
DisplayDraw(this: BusyBar, params:
|
|
1774
|
+
DisplayDraw(this: BusyBar, params: DrawParams): Promise<SuccessResponse>;
|
|
1903
1775
|
/**
|
|
1904
1776
|
* Clear display. Deletes display elements drawn by the Canvas application.
|
|
1905
1777
|
* If application_name is specified, only elements for that app are removed.
|
|
@@ -1909,7 +1781,7 @@ declare class DisplayMethods {
|
|
|
1909
1781
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1910
1782
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful clear command.
|
|
1911
1783
|
*/
|
|
1912
|
-
DisplayClear(this: BusyBar, params?:
|
|
1784
|
+
DisplayClear(this: BusyBar, params?: ClearParams): Promise<SuccessResponse>;
|
|
1913
1785
|
/**
|
|
1914
1786
|
* Get single frame for requested screen.
|
|
1915
1787
|
*
|
|
@@ -1918,7 +1790,7 @@ declare class DisplayMethods {
|
|
|
1918
1790
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1919
1791
|
* @returns {Promise<Blob>} A promise that resolves to the screen frame as a Blob.
|
|
1920
1792
|
*/
|
|
1921
|
-
DisplayScreenFrameGet(this: BusyBar, params:
|
|
1793
|
+
DisplayScreenFrameGet(this: BusyBar, params: GetScreenFrameParams): Promise<Blob>;
|
|
1922
1794
|
/**
|
|
1923
1795
|
* Get display brightness.
|
|
1924
1796
|
*
|
|
@@ -1935,7 +1807,14 @@ declare class DisplayMethods {
|
|
|
1935
1807
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1936
1808
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
1937
1809
|
*/
|
|
1938
|
-
DisplayBrightnessSet(this: BusyBar, params:
|
|
1810
|
+
DisplayBrightnessSet(this: BusyBar, params: BrightnessParams): Promise<SuccessResponse>;
|
|
1811
|
+
}
|
|
1812
|
+
|
|
1813
|
+
declare interface DownloadFileParams extends TimeoutOptions, StorageReadQuery {
|
|
1814
|
+
as_array_buffer?: boolean;
|
|
1815
|
+
}
|
|
1816
|
+
|
|
1817
|
+
declare interface DrawParams extends TimeoutOptions, DisplayElements {
|
|
1939
1818
|
}
|
|
1940
1819
|
|
|
1941
1820
|
declare type Error_2 = components['schemas']['Error'];
|
|
@@ -1944,74 +1823,41 @@ export { Error_2 as Error }
|
|
|
1944
1823
|
declare type ErrorCallback_2 = (error: StateStreamError) => void;
|
|
1945
1824
|
export { ErrorCallback_2 as ErrorCallback }
|
|
1946
1825
|
|
|
1947
|
-
declare
|
|
1948
|
-
|
|
1949
|
-
declare interface ErrorPayload {
|
|
1950
|
-
code: number;
|
|
1951
|
-
message: string;
|
|
1952
|
-
raw: Error_2 | CloseEvent | Event;
|
|
1826
|
+
declare interface GetScreenFrameParams extends TimeoutOptions, ScreenQuery {
|
|
1953
1827
|
}
|
|
1954
1828
|
|
|
1955
1829
|
export declare type HttpAccessInfo = components['schemas']['HttpAccessInfo'];
|
|
1956
1830
|
|
|
1957
|
-
export declare
|
|
1831
|
+
export declare type HttpAccessParams = Settings.HttpAccessParams;
|
|
1832
|
+
|
|
1833
|
+
declare interface HttpAccessParams_2 extends TimeoutOptions, HttpAccessQuery {
|
|
1958
1834
|
}
|
|
1959
1835
|
|
|
1960
|
-
declare type HttpAccessQuery = operations['setHttpAccess']['parameters']['query'];
|
|
1836
|
+
export declare type HttpAccessQuery = operations['setHttpAccess']['parameters']['query'];
|
|
1961
1837
|
|
|
1962
1838
|
export declare type ImageElement = components['schemas']['ImageElement'];
|
|
1963
1839
|
|
|
1964
|
-
export declare
|
|
1965
|
-
readonly addr: string;
|
|
1966
|
-
connected: boolean;
|
|
1967
|
-
private apiKey?;
|
|
1968
|
-
private apiSemver?;
|
|
1969
|
-
private inputEvent;
|
|
1970
|
-
private dataListeners;
|
|
1971
|
-
private stopListeners;
|
|
1972
|
-
private errorListeners;
|
|
1973
|
-
private socket;
|
|
1974
|
-
constructor(config?: InputConfig);
|
|
1975
|
-
onData(listener: DataListener): void;
|
|
1976
|
-
onStop(listener: StopListener): void;
|
|
1977
|
-
onError(listener: ErrorListener): void;
|
|
1978
|
-
protected emitData(data: Uint8Array): void;
|
|
1979
|
-
protected emitStop(): void;
|
|
1980
|
-
protected emitError(payload: ErrorPayload): void;
|
|
1981
|
-
openWebsocket(): Promise<void>;
|
|
1982
|
-
sendInput({ keyName, value }: {
|
|
1983
|
-
keyName: KeyName;
|
|
1984
|
-
value: KeyValue;
|
|
1985
|
-
}): void;
|
|
1986
|
-
closeWebsocket(): Promise<void>;
|
|
1987
|
-
}
|
|
1988
|
-
|
|
1989
|
-
export declare interface InputConfig {
|
|
1990
|
-
addr?: string;
|
|
1991
|
-
apiKey?: ApiKey;
|
|
1992
|
-
apiSemver?: ApiSemver;
|
|
1993
|
-
}
|
|
1840
|
+
export declare type InputKeyParams = Input.InputKeyParams;
|
|
1994
1841
|
|
|
1995
|
-
|
|
1842
|
+
declare interface InputKeyParams_2 extends TimeoutOptions, InputKeyQuery {
|
|
1996
1843
|
}
|
|
1997
1844
|
|
|
1998
|
-
declare type InputKeyQuery = operations['setInputKey']['parameters']['query'];
|
|
1845
|
+
export declare type InputKeyQuery = operations['setInputKey']['parameters']['query'];
|
|
1999
1846
|
|
|
2000
1847
|
declare class InputMethods {
|
|
2001
1848
|
/**
|
|
2002
1849
|
* Send input event. Send single key press event.
|
|
2003
1850
|
*
|
|
2004
1851
|
* @param {InputKeyParams} params - Button press parameters:
|
|
2005
|
-
* @param {
|
|
1852
|
+
* @param {InputKeyParams['key']} params.key - Key name.
|
|
2006
1853
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
2007
1854
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
2008
1855
|
*/
|
|
2009
|
-
InputSend(this: BusyBar, params:
|
|
1856
|
+
InputSend(this: BusyBar, params: InputKeyParams_2): Promise<SuccessResponse>;
|
|
2010
1857
|
}
|
|
2011
1858
|
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
export declare type KeyValue = 1 | 0;
|
|
1859
|
+
declare interface InstallParams extends TimeoutOptions, UpdateInstallQuery {
|
|
1860
|
+
}
|
|
2015
1861
|
|
|
2016
1862
|
export declare const LEDRenderer: LEDRenderer_2;
|
|
2017
1863
|
|
|
@@ -2067,9 +1913,13 @@ export declare interface LocalStreamOptions extends StreamOptions {
|
|
|
2067
1913
|
|
|
2068
1914
|
export declare type NameInfo = components['schemas']['NameInfo'];
|
|
2069
1915
|
|
|
2070
|
-
export declare
|
|
1916
|
+
export declare type NameParams = Settings.NameParams;
|
|
1917
|
+
|
|
1918
|
+
declare interface NameParams_2 extends TimeoutOptions, NameInfo {
|
|
2071
1919
|
}
|
|
2072
1920
|
|
|
1921
|
+
export declare type NetworkInterfaceInfo = components['schemas']['NetworkInterfaceInfo'];
|
|
1922
|
+
|
|
2073
1923
|
declare interface operations {
|
|
2074
1924
|
getVersion: {
|
|
2075
1925
|
parameters: {
|
|
@@ -2100,6 +1950,35 @@ declare interface operations {
|
|
|
2100
1950
|
};
|
|
2101
1951
|
};
|
|
2102
1952
|
};
|
|
1953
|
+
getTransport: {
|
|
1954
|
+
parameters: {
|
|
1955
|
+
query?: never;
|
|
1956
|
+
header?: never;
|
|
1957
|
+
path?: never;
|
|
1958
|
+
cookie?: never;
|
|
1959
|
+
};
|
|
1960
|
+
requestBody?: never;
|
|
1961
|
+
responses: {
|
|
1962
|
+
/** @description Information retrieved successfully */
|
|
1963
|
+
200: {
|
|
1964
|
+
headers: {
|
|
1965
|
+
[name: string]: unknown;
|
|
1966
|
+
};
|
|
1967
|
+
content: {
|
|
1968
|
+
'application/json': components['schemas']['NetworkInterfaceInfo'];
|
|
1969
|
+
};
|
|
1970
|
+
};
|
|
1971
|
+
/** @description Internal server error */
|
|
1972
|
+
500: {
|
|
1973
|
+
headers: {
|
|
1974
|
+
[name: string]: unknown;
|
|
1975
|
+
};
|
|
1976
|
+
content: {
|
|
1977
|
+
'application/json': components['schemas']['Error'];
|
|
1978
|
+
};
|
|
1979
|
+
};
|
|
1980
|
+
};
|
|
1981
|
+
};
|
|
2103
1982
|
getHttpAccess: {
|
|
2104
1983
|
parameters: {
|
|
2105
1984
|
query?: never;
|
|
@@ -3052,6 +2931,11 @@ declare interface operations {
|
|
|
3052
2931
|
* @example 50
|
|
3053
2932
|
*/
|
|
3054
2933
|
volume: number;
|
|
2934
|
+
/**
|
|
2935
|
+
* @description Set volume silently (0 - play volume change sound(default), 1 - do not play sound)
|
|
2936
|
+
* @example 1
|
|
2937
|
+
*/
|
|
2938
|
+
silent?: 0 | 1;
|
|
3055
2939
|
};
|
|
3056
2940
|
header?: never;
|
|
3057
2941
|
path?: never;
|
|
@@ -3079,42 +2963,6 @@ declare interface operations {
|
|
|
3079
2963
|
};
|
|
3080
2964
|
};
|
|
3081
2965
|
};
|
|
3082
|
-
connectInputWebSocket: {
|
|
3083
|
-
parameters: {
|
|
3084
|
-
query?: never;
|
|
3085
|
-
header?: never;
|
|
3086
|
-
path?: never;
|
|
3087
|
-
cookie?: never;
|
|
3088
|
-
};
|
|
3089
|
-
requestBody?: never;
|
|
3090
|
-
responses: {
|
|
3091
|
-
/** @description WebSocket connection established */
|
|
3092
|
-
101: {
|
|
3093
|
-
headers: {
|
|
3094
|
-
[name: string]: unknown;
|
|
3095
|
-
};
|
|
3096
|
-
content?: never;
|
|
3097
|
-
};
|
|
3098
|
-
/** @description WebSocket upgrade failed */
|
|
3099
|
-
400: {
|
|
3100
|
-
headers: {
|
|
3101
|
-
[name: string]: unknown;
|
|
3102
|
-
};
|
|
3103
|
-
content: {
|
|
3104
|
-
'application/json': components['schemas']['Error'];
|
|
3105
|
-
};
|
|
3106
|
-
};
|
|
3107
|
-
/** @description Upgrade required */
|
|
3108
|
-
426: {
|
|
3109
|
-
headers: {
|
|
3110
|
-
[name: string]: unknown;
|
|
3111
|
-
};
|
|
3112
|
-
content: {
|
|
3113
|
-
'application/json': components['schemas']['Error'];
|
|
3114
|
-
};
|
|
3115
|
-
};
|
|
3116
|
-
};
|
|
3117
|
-
};
|
|
3118
2966
|
setInputKey: {
|
|
3119
2967
|
parameters: {
|
|
3120
2968
|
query: {
|
|
@@ -3322,33 +3170,6 @@ declare interface operations {
|
|
|
3322
3170
|
};
|
|
3323
3171
|
};
|
|
3324
3172
|
};
|
|
3325
|
-
connectScreenWebSocket: {
|
|
3326
|
-
parameters: {
|
|
3327
|
-
query?: never;
|
|
3328
|
-
header?: never;
|
|
3329
|
-
path?: never;
|
|
3330
|
-
cookie?: never;
|
|
3331
|
-
};
|
|
3332
|
-
requestBody?: never;
|
|
3333
|
-
responses: {
|
|
3334
|
-
/** @description WebSocket connection established */
|
|
3335
|
-
101: {
|
|
3336
|
-
headers: {
|
|
3337
|
-
[name: string]: unknown;
|
|
3338
|
-
};
|
|
3339
|
-
content?: never;
|
|
3340
|
-
};
|
|
3341
|
-
/** @description Exceed max clients count */
|
|
3342
|
-
400: {
|
|
3343
|
-
headers: {
|
|
3344
|
-
[name: string]: unknown;
|
|
3345
|
-
};
|
|
3346
|
-
content: {
|
|
3347
|
-
'application/json': components['schemas']['Error'];
|
|
3348
|
-
};
|
|
3349
|
-
};
|
|
3350
|
-
};
|
|
3351
|
-
};
|
|
3352
3173
|
getTime: {
|
|
3353
3174
|
parameters: {
|
|
3354
3175
|
query?: never;
|
|
@@ -3843,6 +3664,26 @@ declare interface paths {
|
|
|
3843
3664
|
patch?: never;
|
|
3844
3665
|
trace?: never;
|
|
3845
3666
|
};
|
|
3667
|
+
'/transport': {
|
|
3668
|
+
parameters: {
|
|
3669
|
+
query?: never;
|
|
3670
|
+
header?: never;
|
|
3671
|
+
path?: never;
|
|
3672
|
+
cookie?: never;
|
|
3673
|
+
};
|
|
3674
|
+
/**
|
|
3675
|
+
* Get device network connection info
|
|
3676
|
+
* @description Retrieves device transport type (usb/wifi)
|
|
3677
|
+
*/
|
|
3678
|
+
get: operations['getTransport'];
|
|
3679
|
+
put?: never;
|
|
3680
|
+
post?: never;
|
|
3681
|
+
delete?: never;
|
|
3682
|
+
options?: never;
|
|
3683
|
+
head?: never;
|
|
3684
|
+
patch?: never;
|
|
3685
|
+
trace?: never;
|
|
3686
|
+
};
|
|
3846
3687
|
'/access': {
|
|
3847
3688
|
parameters: {
|
|
3848
3689
|
query?: never;
|
|
@@ -4355,11 +4196,7 @@ declare interface paths {
|
|
|
4355
4196
|
path?: never;
|
|
4356
4197
|
cookie?: never;
|
|
4357
4198
|
};
|
|
4358
|
-
|
|
4359
|
-
* Input events streaming
|
|
4360
|
-
* @description Start WebSocket session for input events streaming
|
|
4361
|
-
*/
|
|
4362
|
-
get: operations['connectInputWebSocket'];
|
|
4199
|
+
get?: never;
|
|
4363
4200
|
put?: never;
|
|
4364
4201
|
/**
|
|
4365
4202
|
* Send input event
|
|
@@ -4721,30 +4558,6 @@ declare interface paths {
|
|
|
4721
4558
|
patch?: never;
|
|
4722
4559
|
trace?: never;
|
|
4723
4560
|
};
|
|
4724
|
-
'/screen/ws': {
|
|
4725
|
-
parameters: {
|
|
4726
|
-
query?: never;
|
|
4727
|
-
header?: never;
|
|
4728
|
-
path?: never;
|
|
4729
|
-
cookie?: never;
|
|
4730
|
-
};
|
|
4731
|
-
/**
|
|
4732
|
-
* Screen streaming WebSocket endpoint
|
|
4733
|
-
* @description WebSocket connection for real-time screen streaming.
|
|
4734
|
-
* Upgrade from HTTP to WebSocket protocol is required.
|
|
4735
|
-
* After connection, client must send desired display ID
|
|
4736
|
-
* as JSON {"display": 0}
|
|
4737
|
-
*
|
|
4738
|
-
*/
|
|
4739
|
-
get: operations['connectScreenWebSocket'];
|
|
4740
|
-
put?: never;
|
|
4741
|
-
post?: never;
|
|
4742
|
-
delete?: never;
|
|
4743
|
-
options?: never;
|
|
4744
|
-
head?: never;
|
|
4745
|
-
patch?: never;
|
|
4746
|
-
trace?: never;
|
|
4747
|
-
};
|
|
4748
4561
|
'/ble/enable': {
|
|
4749
4562
|
parameters: {
|
|
4750
4563
|
query?: never;
|
|
@@ -4915,6 +4728,15 @@ declare interface paths {
|
|
|
4915
4728
|
'application/json': components['schemas']['BleStatusResponse'];
|
|
4916
4729
|
};
|
|
4917
4730
|
};
|
|
4731
|
+
/** @description Failed to get BLE status, because of an error */
|
|
4732
|
+
503: {
|
|
4733
|
+
headers: {
|
|
4734
|
+
[name: string]: unknown;
|
|
4735
|
+
};
|
|
4736
|
+
content: {
|
|
4737
|
+
'application/json': components['schemas']['Error'];
|
|
4738
|
+
};
|
|
4739
|
+
};
|
|
4918
4740
|
};
|
|
4919
4741
|
};
|
|
4920
4742
|
put?: never;
|
|
@@ -5329,6 +5151,9 @@ export declare type ProcessedUpdate = Prettify<Omit<BSB_State.StateUpdate, 'fram
|
|
|
5329
5151
|
|
|
5330
5152
|
export declare type RawDataCallback = (data: Uint8Array | string) => void;
|
|
5331
5153
|
|
|
5154
|
+
declare interface ReadDirectoryParams extends TimeoutOptions, StorageListQuery {
|
|
5155
|
+
}
|
|
5156
|
+
|
|
5332
5157
|
/**
|
|
5333
5158
|
* Wrapped structure for Remote mode
|
|
5334
5159
|
*/
|
|
@@ -5372,46 +5197,32 @@ export declare interface RemoteStreamOptions extends StreamOptions {
|
|
|
5372
5197
|
tokenProvider?: () => Promise<string>;
|
|
5373
5198
|
}
|
|
5374
5199
|
|
|
5200
|
+
declare interface RemoveParams extends TimeoutOptions, StorageRemoveQuery {
|
|
5201
|
+
}
|
|
5202
|
+
|
|
5203
|
+
declare interface RenameParams extends TimeoutOptions, StorageRenameQuery {
|
|
5204
|
+
}
|
|
5205
|
+
|
|
5375
5206
|
declare type RequiredIpConfig = RequireKeys<NonNullable<WifiConnectRequestConfig['ip_config']>, 'ip_method'>;
|
|
5376
5207
|
|
|
5377
5208
|
declare type RequireKeys<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
|
|
5378
5209
|
|
|
5379
|
-
export declare
|
|
5380
|
-
}
|
|
5210
|
+
export declare type ScreenFrameGetParams = Display.GetScreenFrameParams;
|
|
5381
5211
|
|
|
5382
|
-
declare type ScreenQuery = paths['/screen']['get']['parameters']['query'];
|
|
5212
|
+
export declare type ScreenQuery = paths['/screen']['get']['parameters']['query'];
|
|
5383
5213
|
|
|
5384
5214
|
export declare type ScreenResponse = components['schemas']['ScreenResponse'];
|
|
5385
5215
|
|
|
5386
|
-
|
|
5387
|
-
private config;
|
|
5388
|
-
readonly addr: string;
|
|
5389
|
-
connected: boolean;
|
|
5390
|
-
private apiKey?;
|
|
5391
|
-
private apiSemver?;
|
|
5392
|
-
private dataListeners;
|
|
5393
|
-
private stopListeners;
|
|
5394
|
-
private errorListeners;
|
|
5395
|
-
private socket;
|
|
5396
|
-
constructor(config: ScreenStreamConfig);
|
|
5397
|
-
onData(listener: DataListener): void;
|
|
5398
|
-
onStop(listener: StopListener): void;
|
|
5399
|
-
onError(listener: ErrorListener): void;
|
|
5400
|
-
protected emitData(data: Uint8Array): void;
|
|
5401
|
-
protected emitStop(): void;
|
|
5402
|
-
protected emitError(payload: ErrorPayload): void;
|
|
5403
|
-
openWebsocket(): Promise<void>;
|
|
5404
|
-
closeWebsocket(): Promise<void>;
|
|
5216
|
+
declare interface SetAccountProfileParams extends TimeoutOptions, AccountProfile {
|
|
5405
5217
|
}
|
|
5406
5218
|
|
|
5407
|
-
|
|
5408
|
-
|
|
5409
|
-
|
|
5410
|
-
|
|
5411
|
-
apiSemver?: ApiSemver;
|
|
5219
|
+
declare interface SetTimestampParams extends TimeoutOptions, TimestampInfo {
|
|
5220
|
+
}
|
|
5221
|
+
|
|
5222
|
+
declare interface SetTimezoneParams extends TimeoutOptions, SetTimezoneQuery {
|
|
5412
5223
|
}
|
|
5413
5224
|
|
|
5414
|
-
declare type SetTimezoneQuery = operations['setTimeTimezone']['parameters']['query'];
|
|
5225
|
+
export declare type SetTimezoneQuery = operations['setTimeTimezone']['parameters']['query'];
|
|
5415
5226
|
|
|
5416
5227
|
declare class SettingsMethods {
|
|
5417
5228
|
/**
|
|
@@ -5431,7 +5242,7 @@ declare class SettingsMethods {
|
|
|
5431
5242
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5432
5243
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
5433
5244
|
*/
|
|
5434
|
-
SettingsAccessSet(this: BusyBar, params:
|
|
5245
|
+
SettingsAccessSet(this: BusyBar, params: HttpAccessParams_2): Promise<SuccessResponse>;
|
|
5435
5246
|
/**
|
|
5436
5247
|
* Get current device name.
|
|
5437
5248
|
*
|
|
@@ -5448,7 +5259,7 @@ declare class SettingsMethods {
|
|
|
5448
5259
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5449
5260
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
5450
5261
|
*/
|
|
5451
|
-
SettingsNameSet(this: BusyBar, params:
|
|
5262
|
+
SettingsNameSet(this: BusyBar, params: NameParams_2): Promise<SuccessResponse>;
|
|
5452
5263
|
}
|
|
5453
5264
|
|
|
5454
5265
|
declare class SmartHomeMethods {
|
|
@@ -5562,18 +5373,13 @@ export declare type StatusPower = components['schemas']['StatusPower'];
|
|
|
5562
5373
|
|
|
5563
5374
|
export declare type StatusSystem = components['schemas']['StatusSystem'];
|
|
5564
5375
|
|
|
5565
|
-
declare type
|
|
5376
|
+
export declare type StorageCreateDirectoryParams = StorageAPI.CreateDirectoryParams;
|
|
5566
5377
|
|
|
5567
|
-
export declare
|
|
5568
|
-
}
|
|
5569
|
-
|
|
5570
|
-
declare type StorageCreateDirQuery = operations['createStorageDir']['parameters']['query'];
|
|
5378
|
+
export declare type StorageCreateDirQuery = operations['createStorageDir']['parameters']['query'];
|
|
5571
5379
|
|
|
5572
5380
|
export declare type StorageDirElement = components['schemas']['StorageDirElement'];
|
|
5573
5381
|
|
|
5574
|
-
export declare
|
|
5575
|
-
as_array_buffer?: boolean;
|
|
5576
|
-
}
|
|
5382
|
+
export declare type StorageDownloadFileParams = StorageAPI.DownloadFileParams;
|
|
5577
5383
|
|
|
5578
5384
|
export declare type StorageFileElement = components['schemas']['StorageFileElement'];
|
|
5579
5385
|
|
|
@@ -5581,7 +5387,7 @@ export declare type StorageList = components['schemas']['StorageList'];
|
|
|
5581
5387
|
|
|
5582
5388
|
export declare type StorageListElement = components['schemas']['StorageListElement'];
|
|
5583
5389
|
|
|
5584
|
-
declare type StorageListQuery = operations['listStorageFiles']['parameters']['query'];
|
|
5390
|
+
export declare type StorageListQuery = operations['listStorageFiles']['parameters']['query'];
|
|
5585
5391
|
|
|
5586
5392
|
declare class StorageMethods {
|
|
5587
5393
|
/**
|
|
@@ -5593,7 +5399,7 @@ declare class StorageMethods {
|
|
|
5593
5399
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5594
5400
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful upload.
|
|
5595
5401
|
*/
|
|
5596
|
-
StorageWrite(this: BusyBar, params:
|
|
5402
|
+
StorageWrite(this: BusyBar, params: UploadFileParams): Promise<SuccessResponse>;
|
|
5597
5403
|
/**
|
|
5598
5404
|
* Download file from internal storage. Downloads a file from a specified path.
|
|
5599
5405
|
*
|
|
@@ -5603,7 +5409,7 @@ declare class StorageMethods {
|
|
|
5603
5409
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5604
5410
|
* @returns {Promise<StorageReadResponse>} A promise that resolves to the file content (Blob or ArrayBuffer).
|
|
5605
5411
|
*/
|
|
5606
|
-
StorageRead(this: BusyBar, params:
|
|
5412
|
+
StorageRead(this: BusyBar, params: DownloadFileParams): Promise<StorageReadResponse>;
|
|
5607
5413
|
/**
|
|
5608
5414
|
* List files on internal storage.
|
|
5609
5415
|
*
|
|
@@ -5612,7 +5418,7 @@ declare class StorageMethods {
|
|
|
5612
5418
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5613
5419
|
* @returns {Promise<StorageList>} A promise that resolves to a list of files and directories.
|
|
5614
5420
|
*/
|
|
5615
|
-
StorageListGet(this: BusyBar, params:
|
|
5421
|
+
StorageListGet(this: BusyBar, params: ReadDirectoryParams): Promise<StorageList>;
|
|
5616
5422
|
/**
|
|
5617
5423
|
* Remove a file on internal storage. Removes a file with a specified path.
|
|
5618
5424
|
*
|
|
@@ -5621,7 +5427,7 @@ declare class StorageMethods {
|
|
|
5621
5427
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5622
5428
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful removal.
|
|
5623
5429
|
*/
|
|
5624
|
-
StorageRemove(this: BusyBar, params:
|
|
5430
|
+
StorageRemove(this: BusyBar, params: RemoveParams): Promise<SuccessResponse>;
|
|
5625
5431
|
/**
|
|
5626
5432
|
* Create a directory on internal storage. Creates a new directory with a specified path.
|
|
5627
5433
|
*
|
|
@@ -5630,7 +5436,7 @@ declare class StorageMethods {
|
|
|
5630
5436
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5631
5437
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful creation.
|
|
5632
5438
|
*/
|
|
5633
|
-
StorageMkdir(this: BusyBar, params:
|
|
5439
|
+
StorageMkdir(this: BusyBar, params: CreateDirectoryParams): Promise<SuccessResponse>;
|
|
5634
5440
|
/**
|
|
5635
5441
|
* Show storage usage.
|
|
5636
5442
|
*
|
|
@@ -5648,33 +5454,28 @@ declare class StorageMethods {
|
|
|
5648
5454
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5649
5455
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful rename.
|
|
5650
5456
|
*/
|
|
5651
|
-
StorageRename(this: BusyBar, params:
|
|
5457
|
+
StorageRename(this: BusyBar, params: RenameParams): Promise<SuccessResponse>;
|
|
5652
5458
|
}
|
|
5653
5459
|
|
|
5654
|
-
export declare
|
|
5655
|
-
}
|
|
5460
|
+
export declare type StorageReadDirectoryParams = StorageAPI.ReadDirectoryParams;
|
|
5656
5461
|
|
|
5657
|
-
declare type StorageReadQuery = operations['readStorageFile']['parameters']['query'];
|
|
5462
|
+
export declare type StorageReadQuery = operations['readStorageFile']['parameters']['query'];
|
|
5658
5463
|
|
|
5659
5464
|
export declare type StorageReadResponse = ArrayBuffer | Blob;
|
|
5660
5465
|
|
|
5661
|
-
export declare
|
|
5662
|
-
}
|
|
5466
|
+
export declare type StorageRemoveParams = StorageAPI.RemoveParams;
|
|
5663
5467
|
|
|
5664
|
-
declare type StorageRemoveQuery = operations['removeStorageFile']['parameters']['query'];
|
|
5468
|
+
export declare type StorageRemoveQuery = operations['removeStorageFile']['parameters']['query'];
|
|
5665
5469
|
|
|
5666
|
-
export declare
|
|
5667
|
-
}
|
|
5470
|
+
export declare type StorageRenameParams = StorageAPI.RenameParams;
|
|
5668
5471
|
|
|
5669
|
-
declare type StorageRenameQuery = operations['RenameStorageFile']['parameters']['query'];
|
|
5472
|
+
export declare type StorageRenameQuery = operations['RenameStorageFile']['parameters']['query'];
|
|
5670
5473
|
|
|
5671
5474
|
export declare type StorageStatus = components['schemas']['StorageStatus'];
|
|
5672
5475
|
|
|
5673
|
-
export declare
|
|
5674
|
-
file: BusyFile_2;
|
|
5675
|
-
}
|
|
5476
|
+
export declare type StorageUploadFileParams = StorageAPI.UploadFileParams;
|
|
5676
5477
|
|
|
5677
|
-
declare type StorageWriteQuery = operations['writeStorageFile']['parameters']['query'];
|
|
5478
|
+
export declare type StorageWriteQuery = operations['writeStorageFile']['parameters']['query'];
|
|
5678
5479
|
|
|
5679
5480
|
/**
|
|
5680
5481
|
* Global configuration for the stream behavior
|
|
@@ -5775,6 +5576,14 @@ declare class SystemMethods {
|
|
|
5775
5576
|
* @returns {Promise<StatusFirmware>} Current firmware status.
|
|
5776
5577
|
*/
|
|
5777
5578
|
SystemStatusFirmwareGet(this: BusyBar, params?: TimeoutOptions): Promise<StatusFirmware>;
|
|
5579
|
+
/**
|
|
5580
|
+
* Get device transport information.
|
|
5581
|
+
*
|
|
5582
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
5583
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5584
|
+
* @returns {Promise<NetworkInterfaceInfo>} Current transport info (usb/wifi).
|
|
5585
|
+
*/
|
|
5586
|
+
SystemTransportGet(this: BusyBar, params?: TimeoutOptions): Promise<NetworkInterfaceInfo>;
|
|
5778
5587
|
}
|
|
5779
5588
|
|
|
5780
5589
|
export declare type TextElement = components['schemas']['TextElement'];
|
|
@@ -5796,7 +5605,7 @@ declare class TimeMethods {
|
|
|
5796
5605
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5797
5606
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
5798
5607
|
*/
|
|
5799
|
-
TimeTimestampSet(this: BusyBar, params:
|
|
5608
|
+
TimeTimestampSet(this: BusyBar, params: SetTimestampParams): Promise<SuccessResponse>;
|
|
5800
5609
|
/**
|
|
5801
5610
|
* Get current timezone.
|
|
5802
5611
|
*
|
|
@@ -5813,7 +5622,7 @@ declare class TimeMethods {
|
|
|
5813
5622
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5814
5623
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
5815
5624
|
*/
|
|
5816
|
-
TimeTimezoneSet(this: BusyBar, params:
|
|
5625
|
+
TimeTimezoneSet(this: BusyBar, params: SetTimezoneParams): Promise<SuccessResponse>;
|
|
5817
5626
|
/**
|
|
5818
5627
|
* Get list of supported timezones.
|
|
5819
5628
|
*
|
|
@@ -5830,11 +5639,9 @@ export declare interface TimeoutOptions {
|
|
|
5830
5639
|
|
|
5831
5640
|
export declare type TimestampInfo = components['schemas']['TimestampInfo'];
|
|
5832
5641
|
|
|
5833
|
-
export declare
|
|
5834
|
-
}
|
|
5642
|
+
export declare type TimeTimestampParams = Time.SetTimestampParams;
|
|
5835
5643
|
|
|
5836
|
-
export declare
|
|
5837
|
-
}
|
|
5644
|
+
export declare type TimeTimezoneParams = Time.SetTimezoneParams;
|
|
5838
5645
|
|
|
5839
5646
|
export declare type TimezoneInfo = components['schemas']['TimezoneInfo'];
|
|
5840
5647
|
|
|
@@ -5842,24 +5649,19 @@ export declare type TimezoneItem = NonNullable<TimezoneList['list']>[number];
|
|
|
5842
5649
|
|
|
5843
5650
|
export declare type TimezoneList = components['schemas']['TimezoneListResponse'];
|
|
5844
5651
|
|
|
5845
|
-
export declare
|
|
5846
|
-
}
|
|
5652
|
+
export declare type UpdateAutoUpdateParams = Update.AutoUpdateParams;
|
|
5847
5653
|
|
|
5848
5654
|
export declare type UpdateChangelog = operations['getUpdateChangelog']['responses']['200']['content']['application/json'];
|
|
5849
5655
|
|
|
5850
|
-
export declare
|
|
5851
|
-
}
|
|
5656
|
+
export declare type UpdateChangelogParams = Update.ChangelogParams;
|
|
5852
5657
|
|
|
5853
|
-
declare type UpdateChangelogQuery = operations['getUpdateChangelog']['parameters']['query'];
|
|
5658
|
+
export declare type UpdateChangelogQuery = operations['getUpdateChangelog']['parameters']['query'];
|
|
5854
5659
|
|
|
5855
|
-
export declare
|
|
5856
|
-
file: BusyFile_2;
|
|
5857
|
-
}
|
|
5660
|
+
export declare type UpdateFromFileParams = Update.UpdateParams;
|
|
5858
5661
|
|
|
5859
|
-
export declare
|
|
5860
|
-
}
|
|
5662
|
+
export declare type UpdateInstallParams = Update.InstallParams;
|
|
5861
5663
|
|
|
5862
|
-
declare type UpdateInstallQuery = operations['installFirmwareUpdate']['parameters']['query'];
|
|
5664
|
+
export declare type UpdateInstallQuery = operations['installFirmwareUpdate']['parameters']['query'];
|
|
5863
5665
|
|
|
5864
5666
|
declare class UpdateMethods {
|
|
5865
5667
|
/**
|
|
@@ -5870,7 +5672,7 @@ declare class UpdateMethods {
|
|
|
5870
5672
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5871
5673
|
* @returns {Promise<SuccessResponse>} A promise that resolves when upload is complete.
|
|
5872
5674
|
*/
|
|
5873
|
-
UpdateFromFile(this: BusyBar, params:
|
|
5675
|
+
UpdateFromFile(this: BusyBar, params: UpdateParams): Promise<SuccessResponse>;
|
|
5874
5676
|
/**
|
|
5875
5677
|
* Start firmware update check.
|
|
5876
5678
|
*
|
|
@@ -5895,7 +5697,7 @@ declare class UpdateMethods {
|
|
|
5895
5697
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5896
5698
|
* @returns {Promise<UpdateChangelog>} A promise that resolves to the changelog content.
|
|
5897
5699
|
*/
|
|
5898
|
-
UpdateChangelogGet(this: BusyBar, params:
|
|
5700
|
+
UpdateChangelogGet(this: BusyBar, params: ChangelogParams): Promise<UpdateChangelog>;
|
|
5899
5701
|
/**
|
|
5900
5702
|
* Start firmware update installation.
|
|
5901
5703
|
*
|
|
@@ -5904,7 +5706,7 @@ declare class UpdateMethods {
|
|
|
5904
5706
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5905
5707
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful initiation.
|
|
5906
5708
|
*/
|
|
5907
|
-
UpdateInstall(this: BusyBar, params:
|
|
5709
|
+
UpdateInstall(this: BusyBar, params: InstallParams): Promise<SuccessResponse>;
|
|
5908
5710
|
/**
|
|
5909
5711
|
* Abort firmware update download.
|
|
5910
5712
|
*
|
|
@@ -5931,16 +5733,26 @@ declare class UpdateMethods {
|
|
|
5931
5733
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5932
5734
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful update of settings.
|
|
5933
5735
|
*/
|
|
5934
|
-
UpdateAutoUpdateSet(this: BusyBar, params:
|
|
5736
|
+
UpdateAutoUpdateSet(this: BusyBar, params: AutoUpdateParams): Promise<SuccessResponse>;
|
|
5737
|
+
}
|
|
5738
|
+
|
|
5739
|
+
declare interface UpdateParams extends TimeoutOptions {
|
|
5740
|
+
file: BusyFile;
|
|
5935
5741
|
}
|
|
5936
5742
|
|
|
5937
5743
|
export declare type UpdateStatus = components['schemas']['UpdateStatus'];
|
|
5938
5744
|
|
|
5745
|
+
declare interface UploadFileParams extends TimeoutOptions, StorageWriteQuery {
|
|
5746
|
+
file: BusyFile;
|
|
5747
|
+
}
|
|
5748
|
+
|
|
5749
|
+
declare interface UploadParams extends TimeoutOptions, AssetsUploadQuery {
|
|
5750
|
+
data: BusyFile;
|
|
5751
|
+
}
|
|
5752
|
+
|
|
5939
5753
|
export declare type VersionInfo = components['schemas']['VersionInfo'];
|
|
5940
5754
|
|
|
5941
|
-
export declare type WifiConnectParams =
|
|
5942
|
-
ip_config: RequiredIpConfig;
|
|
5943
|
-
}, 'ssid' | 'security' | 'ip_config'> & TimeoutOptions;
|
|
5755
|
+
export declare type WifiConnectParams = Wifi.ConnectParams;
|
|
5944
5756
|
|
|
5945
5757
|
export declare type WifiConnectRequestConfig = components['schemas']['ConnectRequestConfig'];
|
|
5946
5758
|
|
|
@@ -5968,7 +5780,7 @@ declare class WifiMethods {
|
|
|
5968
5780
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
5969
5781
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful connection initiation.
|
|
5970
5782
|
*/
|
|
5971
|
-
WifiConnect(this: BusyBar, params:
|
|
5783
|
+
WifiConnect(this: BusyBar, params: ConnectParams): Promise<SuccessResponse>;
|
|
5972
5784
|
/**
|
|
5973
5785
|
* Disconnects from Wi-Fi.
|
|
5974
5786
|
*
|