@busy-app/busy-lib 0.10.0 → 0.12.0
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 +1 -1
- package/dist/index.d.ts +1205 -598
- package/dist/index.js +509 -463
- package/package.json +4 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { Client } from 'openapi-fetch';
|
|
2
2
|
|
|
3
|
-
export declare type AccountInfo = components[
|
|
3
|
+
export declare type AccountInfo = components['schemas']['AccountInfo'];
|
|
4
4
|
|
|
5
|
-
export declare type AccountLink = components[
|
|
5
|
+
export declare type AccountLink = components['schemas']['AccountLink'];
|
|
6
6
|
|
|
7
7
|
declare class AccountMethods {
|
|
8
8
|
/**
|
|
@@ -18,9 +18,9 @@ declare class AccountMethods {
|
|
|
18
18
|
*
|
|
19
19
|
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
20
20
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
21
|
-
* @returns {Promise<
|
|
21
|
+
* @returns {Promise<AccountStatus>} A promise that resolves to the account state.
|
|
22
22
|
*/
|
|
23
|
-
AccountStateGet(this: BusyBar, params?: TimeoutOptions): Promise<
|
|
23
|
+
AccountStateGet(this: BusyBar, params?: TimeoutOptions): Promise<AccountStatus>;
|
|
24
24
|
/**
|
|
25
25
|
* Get account profile.
|
|
26
26
|
*
|
|
@@ -33,7 +33,8 @@ declare class AccountMethods {
|
|
|
33
33
|
* Set account profile.
|
|
34
34
|
*
|
|
35
35
|
* @param {SetAccountProfileParams} params - Parameters for setting the account profile.
|
|
36
|
-
* @param {string} params.profile - Profile
|
|
36
|
+
* @param {string} params.profile - Profile name.
|
|
37
|
+
* @param {string} [params.custom_url] - Custom profile URL.
|
|
37
38
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
38
39
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
39
40
|
*/
|
|
@@ -56,31 +57,33 @@ declare class AccountMethods {
|
|
|
56
57
|
AccountLink(this: BusyBar, params?: TimeoutOptions): Promise<AccountLink>;
|
|
57
58
|
}
|
|
58
59
|
|
|
59
|
-
export declare type AccountProfile = components[
|
|
60
|
+
export declare type AccountProfile = components['schemas']['AccountProfile'];
|
|
60
61
|
|
|
61
|
-
export declare interface AccountProfileSetParams extends TimeoutOptions {
|
|
62
|
-
profile: operations["setAccountProfile"]["parameters"]["query"]["profile"];
|
|
62
|
+
export declare interface AccountProfileSetParams extends TimeoutOptions, AccountProfile {
|
|
63
63
|
}
|
|
64
64
|
|
|
65
|
-
export declare type
|
|
65
|
+
export declare type AccountStatus = components['schemas']['AccountStatus'];
|
|
66
|
+
|
|
67
|
+
export declare type AnimationElement = components['schemas']['AnimationElement'];
|
|
66
68
|
|
|
67
69
|
declare type ApiKey = string;
|
|
68
70
|
|
|
69
|
-
declare type ApiSemver = components[
|
|
71
|
+
declare type ApiSemver = components['schemas']['VersionInfo']['api_semver'];
|
|
70
72
|
|
|
71
|
-
export declare interface AssetsDeleteParams extends TimeoutOptions {
|
|
72
|
-
appId: paths["/assets/upload"]["delete"]["parameters"]["query"]["app_id"];
|
|
73
|
+
export declare interface AssetsDeleteParams extends TimeoutOptions, AssetsDeleteQuery {
|
|
73
74
|
}
|
|
74
75
|
|
|
76
|
+
declare type AssetsDeleteQuery = operations['deleteAppAssets']['parameters']['query'];
|
|
77
|
+
|
|
75
78
|
declare class AssetsMethods {
|
|
76
79
|
/**
|
|
77
80
|
* Upload asset file with app ID. Uploads a file to a specific app's assets directory.
|
|
78
81
|
*
|
|
79
82
|
* @param {UploadParams} params - Parameters for the upload.
|
|
80
|
-
* @param {
|
|
81
|
-
* @param {
|
|
82
|
-
* @param {
|
|
83
|
-
* @param {
|
|
83
|
+
* @param {string} params.application_name - Application name for organizing assets.
|
|
84
|
+
* @param {string} params.file - Filename for the uploaded asset.
|
|
85
|
+
* @param {BusyFile} params.data - File data to upload.
|
|
86
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
84
87
|
* @returns {Promise<SuccessResponse>} Result of the upload operation.
|
|
85
88
|
*/
|
|
86
89
|
AssetsUpload(this: BusyBar, params: AssetsUploadParams): Promise<SuccessResponse>;
|
|
@@ -88,25 +91,25 @@ declare class AssetsMethods {
|
|
|
88
91
|
* Delete app assets. Deletes all assets for a specific app ID.
|
|
89
92
|
*
|
|
90
93
|
* @param {DeleteParams} params - Parameters for the delete.
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {
|
|
94
|
+
* @param {string} params.application_name - Application name whose assets should be deleted.
|
|
95
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
93
96
|
* @returns {Promise<SuccessResponse>} Result of the delete operation.
|
|
94
97
|
*/
|
|
95
98
|
AssetsDelete(this: BusyBar, params: AssetsDeleteParams): Promise<SuccessResponse>;
|
|
96
99
|
}
|
|
97
100
|
|
|
98
|
-
export declare interface AssetsUploadParams extends TimeoutOptions {
|
|
99
|
-
|
|
100
|
-
fileName: paths["/assets/upload"]["post"]["parameters"]["query"]["file"];
|
|
101
|
-
file: BusyFile;
|
|
101
|
+
export declare interface AssetsUploadParams extends TimeoutOptions, AssetsUploadQuery {
|
|
102
|
+
data: BusyFile_2;
|
|
102
103
|
}
|
|
103
104
|
|
|
105
|
+
declare type AssetsUploadQuery = operations['uploadAssetWithAppId']['parameters']['query'];
|
|
106
|
+
|
|
104
107
|
declare class AudioMethods {
|
|
105
108
|
/**
|
|
106
109
|
* Play audio file. Plays a file from internal storage.
|
|
107
110
|
*
|
|
108
111
|
* @param {AudioPlayParams} params - Parameters for audio playback.
|
|
109
|
-
* @param {string} params.
|
|
112
|
+
* @param {string} params.application_name - Application name.
|
|
110
113
|
* @param {string} params.path - Path to the audio file.
|
|
111
114
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
112
115
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful play command.
|
|
@@ -139,17 +142,20 @@ declare class AudioMethods {
|
|
|
139
142
|
AudioVolumeSet(this: BusyBar, params: AudioVolumeParams): Promise<SuccessResponse>;
|
|
140
143
|
}
|
|
141
144
|
|
|
142
|
-
export declare interface AudioPlayParams extends TimeoutOptions {
|
|
143
|
-
appId: paths["/audio/play"]["post"]["parameters"]["query"]["app_id"];
|
|
144
|
-
path: paths["/audio/play"]["post"]["parameters"]["query"]["path"];
|
|
145
|
+
export declare interface AudioPlayParams extends TimeoutOptions, AudioPlayQuery {
|
|
145
146
|
}
|
|
146
147
|
|
|
147
|
-
|
|
148
|
+
declare type AudioPlayQuery = operations['playAudio']['parameters']['query'];
|
|
149
|
+
|
|
150
|
+
export declare type AudioVolumeInfo = components['schemas']['AudioVolumeInfo'];
|
|
148
151
|
|
|
149
|
-
export declare interface AudioVolumeParams extends TimeoutOptions {
|
|
150
|
-
volume: operations["setAudioVolume"]["parameters"]["query"]["volume"];
|
|
152
|
+
export declare interface AudioVolumeParams extends TimeoutOptions, AudioVolumeQuery {
|
|
151
153
|
}
|
|
152
154
|
|
|
155
|
+
declare type AudioVolumeQuery = operations['setAudioVolume']['parameters']['query'];
|
|
156
|
+
|
|
157
|
+
export declare type AutoUpdateSettings = components['schemas']['AutoupdateSettings'];
|
|
158
|
+
|
|
153
159
|
declare class BleMethods {
|
|
154
160
|
/**
|
|
155
161
|
* Enable BLE. Starts advertising.
|
|
@@ -185,11 +191,11 @@ declare class BleMethods {
|
|
|
185
191
|
BleStatusGet(this: BusyBar, params?: TimeoutOptions): Promise<BleStatusResponse>;
|
|
186
192
|
}
|
|
187
193
|
|
|
188
|
-
export declare type BleStatusResponse = components[
|
|
194
|
+
export declare type BleStatusResponse = components['schemas']['BleStatusResponse'];
|
|
189
195
|
|
|
190
|
-
declare type Brightness = number |
|
|
196
|
+
declare type Brightness = number | 'auto';
|
|
191
197
|
|
|
192
|
-
export declare interface BusyBar extends SystemMethods, UpdateMethods, TimeMethods, AccountMethods, DisplayMethods, AudioMethods, WifiMethods, StorageMethods, SettingsMethods, BleMethods, InputMethods, AssetsMethods,
|
|
198
|
+
export declare interface BusyBar extends SystemMethods, UpdateMethods, TimeMethods, AccountMethods, DisplayMethods, AudioMethods, WifiMethods, StorageMethods, SettingsMethods, BleMethods, InputMethods, AssetsMethods, SmartHomeMethods {
|
|
193
199
|
}
|
|
194
200
|
|
|
195
201
|
/**
|
|
@@ -221,7 +227,7 @@ export declare class BusyBar {
|
|
|
221
227
|
* - "usb": Device allows access without token (returned 200).
|
|
222
228
|
* - "unknown": Detection failed or not yet completed.
|
|
223
229
|
*/
|
|
224
|
-
connectionType:
|
|
230
|
+
connectionType: 'usb' | 'wifi' | 'unknown';
|
|
225
231
|
/**
|
|
226
232
|
* Creates an instance of BUSY Bar.
|
|
227
233
|
* Initializes the API client with the provided host address.
|
|
@@ -269,9 +275,11 @@ export declare type BusyBarConfig = {
|
|
|
269
275
|
token?: string;
|
|
270
276
|
};
|
|
271
277
|
|
|
272
|
-
declare type BusyFile = Buffer | Blob | File | ArrayBuffer;
|
|
278
|
+
export declare type BusyFile = Buffer | Blob | File | ArrayBuffer;
|
|
279
|
+
|
|
280
|
+
declare type BusyFile_2 = Buffer | Blob | File | ArrayBuffer;
|
|
273
281
|
|
|
274
|
-
declare type
|
|
282
|
+
declare type ClearDisplayQuery = NonNullable<operations['clearDisplay']['parameters']['query']>;
|
|
275
283
|
|
|
276
284
|
declare interface components {
|
|
277
285
|
schemas: {
|
|
@@ -282,23 +290,19 @@ declare interface components {
|
|
|
282
290
|
*/
|
|
283
291
|
result: string;
|
|
284
292
|
};
|
|
285
|
-
/**
|
|
286
|
-
* @example {
|
|
293
|
+
/** @example {
|
|
287
294
|
* "error": "Invalid parameter",
|
|
288
295
|
* "code": 400
|
|
289
|
-
* }
|
|
290
|
-
*/
|
|
296
|
+
* } */
|
|
291
297
|
Error: {
|
|
292
298
|
/** @description Error message */
|
|
293
299
|
error: string;
|
|
294
300
|
/** @description Error code */
|
|
295
301
|
code?: number;
|
|
296
302
|
};
|
|
297
|
-
/**
|
|
298
|
-
* @example {
|
|
303
|
+
/** @example {
|
|
299
304
|
* "api_semver": "0.0.0"
|
|
300
|
-
* }
|
|
301
|
-
*/
|
|
305
|
+
* } */
|
|
302
306
|
VersionInfo: {
|
|
303
307
|
/**
|
|
304
308
|
* @description API SemVer
|
|
@@ -306,8 +310,7 @@ declare interface components {
|
|
|
306
310
|
*/
|
|
307
311
|
api_semver: string;
|
|
308
312
|
};
|
|
309
|
-
/**
|
|
310
|
-
* @example {
|
|
313
|
+
/** @example {
|
|
311
314
|
* "install": {
|
|
312
315
|
* "is_allowed": true,
|
|
313
316
|
* "event": "none",
|
|
@@ -323,10 +326,9 @@ declare interface components {
|
|
|
323
326
|
* "check": {
|
|
324
327
|
* "available_version": "1.2.3",
|
|
325
328
|
* "event": "stop",
|
|
326
|
-
* "
|
|
329
|
+
* "status": "available"
|
|
327
330
|
* }
|
|
328
|
-
* }
|
|
329
|
-
*/
|
|
331
|
+
* } */
|
|
330
332
|
UpdateStatus: {
|
|
331
333
|
install?: {
|
|
332
334
|
/** @description Whether update installation is allowed (battery check) */
|
|
@@ -335,17 +337,17 @@ declare interface components {
|
|
|
335
337
|
* @description Current update event
|
|
336
338
|
* @enum {string}
|
|
337
339
|
*/
|
|
338
|
-
event?:
|
|
340
|
+
event?: 'session_start' | 'session_stop' | 'action_begin' | 'action_done' | 'detail_change' | 'action_progress' | 'none';
|
|
339
341
|
/**
|
|
340
342
|
* @description Current update action
|
|
341
343
|
* @enum {string}
|
|
342
344
|
*/
|
|
343
|
-
action?:
|
|
345
|
+
action?: 'download' | 'sha_verification' | 'unpack' | 'prepare' | 'apply' | 'none';
|
|
344
346
|
/**
|
|
345
347
|
* @description Current or last operation status
|
|
346
348
|
* @enum {string}
|
|
347
349
|
*/
|
|
348
|
-
status?:
|
|
350
|
+
status?: 'ok' | 'battery_low' | 'busy' | 'download_failure' | 'download_abort' | 'sha_mismatch' | 'unpack_staging_dir_failure' | 'unpack_archive_open_failure' | 'unpack_archive_unpack_failure' | 'install_manifest_not_found' | 'install_manifest_invalid' | 'install_session_config_failure' | 'install_pointer_setup_failure' | 'unknown_failure';
|
|
349
351
|
/** @description Optional status detail string */
|
|
350
352
|
detail?: string;
|
|
351
353
|
download?: {
|
|
@@ -364,19 +366,35 @@ declare interface components {
|
|
|
364
366
|
* @description Current check event
|
|
365
367
|
* @enum {string}
|
|
366
368
|
*/
|
|
367
|
-
event?:
|
|
369
|
+
event?: 'start' | 'stop' | 'none';
|
|
368
370
|
/**
|
|
369
371
|
* @description Check result status
|
|
370
372
|
* @enum {string}
|
|
371
373
|
*/
|
|
372
|
-
status?:
|
|
374
|
+
status?: 'available' | 'not_available' | 'failure' | 'none';
|
|
373
375
|
};
|
|
374
376
|
};
|
|
375
|
-
/**
|
|
376
|
-
|
|
377
|
+
/** @description Autoupdate configuration settings. All fields are optional for POST requests. */
|
|
378
|
+
AutoupdateSettings: {
|
|
379
|
+
/**
|
|
380
|
+
* @description Whether automatic updates are enabled
|
|
381
|
+
* @example true
|
|
382
|
+
*/
|
|
383
|
+
is_enabled?: boolean;
|
|
384
|
+
/**
|
|
385
|
+
* @description Start of autoupdate window in HH:MM format (e.g., "08:00")
|
|
386
|
+
* @example 00:00
|
|
387
|
+
*/
|
|
388
|
+
interval_start?: string;
|
|
389
|
+
/**
|
|
390
|
+
* @description End of autoupdate window in HH:MM format (e.g., "23:59")
|
|
391
|
+
* @example 08:00
|
|
392
|
+
*/
|
|
393
|
+
interval_end?: string;
|
|
394
|
+
};
|
|
395
|
+
/** @example {
|
|
377
396
|
* "name": "BUSY bar"
|
|
378
|
-
* }
|
|
379
|
-
*/
|
|
397
|
+
* } */
|
|
380
398
|
NameInfo: {
|
|
381
399
|
/**
|
|
382
400
|
* @description Device name
|
|
@@ -390,15 +408,14 @@ declare interface components {
|
|
|
390
408
|
* @example key
|
|
391
409
|
* @enum {string}
|
|
392
410
|
*/
|
|
393
|
-
mode?:
|
|
411
|
+
mode?: 'disabled' | 'enabled' | 'key';
|
|
394
412
|
/**
|
|
395
413
|
* @description Access key was set and is valid
|
|
396
414
|
* @example true
|
|
397
415
|
*/
|
|
398
416
|
key_valid?: boolean;
|
|
399
417
|
};
|
|
400
|
-
/**
|
|
401
|
-
* @example {
|
|
418
|
+
/** @example {
|
|
402
419
|
* "list": [
|
|
403
420
|
* {
|
|
404
421
|
* "type": "file",
|
|
@@ -410,11 +427,10 @@ declare interface components {
|
|
|
410
427
|
* "name": "assets"
|
|
411
428
|
* }
|
|
412
429
|
* ]
|
|
413
|
-
* }
|
|
414
|
-
*/
|
|
430
|
+
* } */
|
|
415
431
|
StorageList: {
|
|
416
432
|
/** @description Array of elements to display */
|
|
417
|
-
list: components[
|
|
433
|
+
list: components['schemas']['StorageListElement'][];
|
|
418
434
|
};
|
|
419
435
|
StorageStatus: {
|
|
420
436
|
/** @example 123456 */
|
|
@@ -432,11 +448,11 @@ declare interface components {
|
|
|
432
448
|
* @description Element type
|
|
433
449
|
* @enum {string}
|
|
434
450
|
*/
|
|
435
|
-
type:
|
|
451
|
+
type: 'file' | 'dir';
|
|
436
452
|
/** @description File or directory name */
|
|
437
453
|
name: string;
|
|
438
454
|
};
|
|
439
|
-
StorageFileElement: Omit<components[
|
|
455
|
+
StorageFileElement: Omit<components['schemas']['StorageListElement'], 'type'> & {
|
|
440
456
|
/** @description File size in bytes */
|
|
441
457
|
size: number;
|
|
442
458
|
} & {
|
|
@@ -444,14 +460,14 @@ declare interface components {
|
|
|
444
460
|
* @description discriminator enum property added by openapi-typescript
|
|
445
461
|
* @enum {string}
|
|
446
462
|
*/
|
|
447
|
-
type:
|
|
463
|
+
type: 'file';
|
|
448
464
|
};
|
|
449
|
-
StorageDirElement: Omit<components[
|
|
465
|
+
StorageDirElement: Omit<components['schemas']['StorageListElement'], 'type'> & Record<string, never> & {
|
|
450
466
|
/**
|
|
451
467
|
* @description discriminator enum property added by openapi-typescript
|
|
452
468
|
* @enum {string}
|
|
453
469
|
*/
|
|
454
|
-
type:
|
|
470
|
+
type: 'dir';
|
|
455
471
|
};
|
|
456
472
|
/**
|
|
457
473
|
* Format: binary
|
|
@@ -465,9 +481,8 @@ declare interface components {
|
|
|
465
481
|
*/
|
|
466
482
|
file: string;
|
|
467
483
|
};
|
|
468
|
-
/**
|
|
469
|
-
*
|
|
470
|
-
* "app_id": "my_app",
|
|
484
|
+
/** @example {
|
|
485
|
+
* "application_name": "my_app",
|
|
471
486
|
* "elements": [
|
|
472
487
|
* {
|
|
473
488
|
* "id": "0",
|
|
@@ -505,21 +520,20 @@ declare interface components {
|
|
|
505
520
|
* "display": "back"
|
|
506
521
|
* }
|
|
507
522
|
* ]
|
|
508
|
-
* }
|
|
509
|
-
*/
|
|
523
|
+
* } */
|
|
510
524
|
DisplayElements: {
|
|
511
525
|
/**
|
|
512
526
|
* @description Application ID for organizing assets
|
|
513
527
|
* @example my_app
|
|
514
528
|
*/
|
|
515
|
-
|
|
529
|
+
application_name: string;
|
|
516
530
|
/**
|
|
517
|
-
* @description Draw
|
|
518
|
-
* @default
|
|
531
|
+
* @description Draw priority in the range [1, 100] inclusive. A draw request is accepted when its priority is greater than or equal to (>=) the priority of the currently running system app. Equal-priority requests from a different application_name override whatever is on screen. System app priority levels: stub/poweroff apps = 0 (always preemptable), any standard built-in app = 10, active BUSY/CUSTOM work session = 90. The draw API only accepts values 1–100; 0 is reserved for internal use.
|
|
532
|
+
* @default 50
|
|
519
533
|
*/
|
|
520
534
|
priority: number;
|
|
521
535
|
/** @description Array of elements to display */
|
|
522
|
-
elements: components[
|
|
536
|
+
elements: (components['schemas']['TextElement'] | components['schemas']['ImageElement'] | components['schemas']['AnimationElement'] | components['schemas']['CountdownElement'])[];
|
|
523
537
|
};
|
|
524
538
|
DisplayElement: {
|
|
525
539
|
/** @description Unique identifier for the element */
|
|
@@ -532,32 +546,37 @@ declare interface components {
|
|
|
532
546
|
* @description Type of display element
|
|
533
547
|
* @enum {string}
|
|
534
548
|
*/
|
|
535
|
-
type:
|
|
536
|
-
/**
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
549
|
+
type: 'text' | 'image' | 'animation' | 'countdown';
|
|
550
|
+
/**
|
|
551
|
+
* @description X coordinate of selected anchor point relative to top-left of display
|
|
552
|
+
* @default 0
|
|
553
|
+
*/
|
|
554
|
+
x: number;
|
|
555
|
+
/**
|
|
556
|
+
* @description Y coordinate of selected anchor point relative to top-left of display
|
|
557
|
+
* @default 0
|
|
558
|
+
*/
|
|
559
|
+
y: number;
|
|
540
560
|
/**
|
|
541
561
|
* @description Which display to show the element on (for dual-display devices)
|
|
542
562
|
* @default front
|
|
543
563
|
* @enum {string}
|
|
544
564
|
*/
|
|
545
|
-
display:
|
|
565
|
+
display: 'front' | 'back';
|
|
546
566
|
/**
|
|
547
567
|
* @description Anchor point of element. Also use `x` and `y` to position element.
|
|
548
568
|
* @enum {string}
|
|
549
569
|
*/
|
|
550
|
-
align?:
|
|
570
|
+
align?: 'top_left' | 'top_mid' | 'top_right' | 'mid_left' | 'center' | 'mid_right' | 'bottom_left' | 'bottom_mid' | 'bottom_right';
|
|
551
571
|
};
|
|
552
|
-
TextElement: Omit<components[
|
|
572
|
+
TextElement: Omit<components['schemas']['DisplayElement'], 'type'> & {
|
|
553
573
|
/** @description Text content to display */
|
|
554
574
|
text: string;
|
|
555
575
|
/**
|
|
556
576
|
* @description One of the available fonts to display the text in
|
|
557
|
-
* @default tiny5_8
|
|
558
577
|
* @enum {string}
|
|
559
578
|
*/
|
|
560
|
-
font:
|
|
579
|
+
font: 'small' | 'medium' | 'medium_condensed' | 'big';
|
|
561
580
|
/**
|
|
562
581
|
* @description Color to display the text in, in #RRGGBBAA format
|
|
563
582
|
* @default #FFFFFFFF
|
|
@@ -572,27 +591,27 @@ declare interface components {
|
|
|
572
591
|
* @description discriminator enum property added by openapi-typescript
|
|
573
592
|
* @enum {string}
|
|
574
593
|
*/
|
|
575
|
-
type:
|
|
594
|
+
type: 'text';
|
|
576
595
|
};
|
|
577
|
-
ImageElement: Omit<components[
|
|
596
|
+
ImageElement: Omit<components['schemas']['DisplayElement'], 'type'> & ({
|
|
578
597
|
/** @description Path to the image file in the app's assets */
|
|
579
|
-
path
|
|
598
|
+
path: string;
|
|
580
599
|
} | {
|
|
581
|
-
/** @description
|
|
582
|
-
|
|
600
|
+
/** @description Stock image file name */
|
|
601
|
+
stock_path: string;
|
|
583
602
|
}) & {
|
|
584
603
|
/**
|
|
585
604
|
* @description discriminator enum property added by openapi-typescript
|
|
586
605
|
* @enum {string}
|
|
587
606
|
*/
|
|
588
|
-
type:
|
|
607
|
+
type: 'image';
|
|
589
608
|
};
|
|
590
|
-
|
|
609
|
+
AnimationElement: Omit<components['schemas']['DisplayElement'], 'type'> & (({
|
|
591
610
|
/** @description Path to the animation file in the app's assets */
|
|
592
611
|
path?: string;
|
|
593
612
|
} | {
|
|
594
|
-
/** @description
|
|
595
|
-
|
|
613
|
+
/** @description Stock animation file name */
|
|
614
|
+
stock_path?: string;
|
|
596
615
|
}) & {
|
|
597
616
|
/**
|
|
598
617
|
* @description Whether to loop the requested part of the animation
|
|
@@ -604,16 +623,16 @@ declare interface components {
|
|
|
604
623
|
* @default false
|
|
605
624
|
*/
|
|
606
625
|
await_previous_end: boolean;
|
|
607
|
-
/** @description Name of the section to play back. Specifying
|
|
608
|
-
|
|
626
|
+
/** @description Name of the section to play back. Specifying "default" selects the entire animation. */
|
|
627
|
+
section?: string;
|
|
609
628
|
}) & {
|
|
610
629
|
/**
|
|
611
630
|
* @description discriminator enum property added by openapi-typescript
|
|
612
631
|
* @enum {string}
|
|
613
632
|
*/
|
|
614
|
-
type:
|
|
633
|
+
type: 'animation';
|
|
615
634
|
};
|
|
616
|
-
CountdownElement: Omit<components[
|
|
635
|
+
CountdownElement: Omit<components['schemas']['DisplayElement'], 'type'> & {
|
|
617
636
|
/** @description Seconds-based Unix UTC timestamp to count down or up to. Note: it's a number in a string. */
|
|
618
637
|
timestamp: string;
|
|
619
638
|
/**
|
|
@@ -625,18 +644,18 @@ declare interface components {
|
|
|
625
644
|
* @description Whether to count up or down
|
|
626
645
|
* @enum {string}
|
|
627
646
|
*/
|
|
628
|
-
direction:
|
|
647
|
+
direction: 'time_left' | 'time_since';
|
|
629
648
|
/**
|
|
630
649
|
* @description When to show the hours position
|
|
631
650
|
* @enum {string}
|
|
632
651
|
*/
|
|
633
|
-
show_hours:
|
|
652
|
+
show_hours: 'when_non_zero' | 'always';
|
|
634
653
|
} & {
|
|
635
654
|
/**
|
|
636
655
|
* @description discriminator enum property added by openapi-typescript
|
|
637
656
|
* @enum {string}
|
|
638
657
|
*/
|
|
639
|
-
type:
|
|
658
|
+
type: 'countdown';
|
|
640
659
|
};
|
|
641
660
|
DisplayBrightnessInfo: {
|
|
642
661
|
/**
|
|
@@ -661,56 +680,112 @@ declare interface components {
|
|
|
661
680
|
};
|
|
662
681
|
TimezoneInfo: {
|
|
663
682
|
/**
|
|
664
|
-
* @description
|
|
665
|
-
* @example
|
|
683
|
+
* @description Time zone name
|
|
684
|
+
* @example Bangalore
|
|
685
|
+
*/
|
|
686
|
+
name: string;
|
|
687
|
+
/**
|
|
688
|
+
* @description Time zone offset from UTC
|
|
689
|
+
* @example +05:30
|
|
690
|
+
*/
|
|
691
|
+
offset: string;
|
|
692
|
+
/**
|
|
693
|
+
* @description Time zone abbreviation
|
|
694
|
+
* @example IST
|
|
666
695
|
*/
|
|
667
|
-
|
|
696
|
+
abbr: string;
|
|
668
697
|
};
|
|
669
698
|
Status: {
|
|
670
|
-
|
|
671
|
-
|
|
699
|
+
device?: components['schemas']['StatusDevice'];
|
|
700
|
+
firmware?: components['schemas']['StatusFirmware'];
|
|
701
|
+
system?: components['schemas']['StatusSystem'];
|
|
702
|
+
power?: components['schemas']['StatusPower'];
|
|
672
703
|
};
|
|
673
|
-
|
|
704
|
+
StatusDevice: {
|
|
674
705
|
/**
|
|
675
706
|
* @description Device serial number
|
|
676
707
|
* @example 203638485431500400123456
|
|
677
708
|
*/
|
|
678
|
-
serial_number
|
|
709
|
+
serial_number: string;
|
|
679
710
|
/**
|
|
680
|
-
* @description
|
|
681
|
-
* @example
|
|
711
|
+
* @description MAC of USB ethernet device
|
|
712
|
+
* @example 0c:fa:22:21:2a:31
|
|
713
|
+
*/
|
|
714
|
+
usb_mac: string;
|
|
715
|
+
/**
|
|
716
|
+
* @description WIFI MAC
|
|
717
|
+
* @example 0c:fa:22:21:2a:31
|
|
718
|
+
*/
|
|
719
|
+
wifi_mac?: string;
|
|
720
|
+
/**
|
|
721
|
+
* @description BLE MAC
|
|
722
|
+
* @example 0c:fa:22:21:2a:31
|
|
682
723
|
*/
|
|
683
|
-
|
|
724
|
+
ble_mac?: string;
|
|
725
|
+
/**
|
|
726
|
+
* @description Is OTP data valid
|
|
727
|
+
* @example true
|
|
728
|
+
*/
|
|
729
|
+
otp_valid: boolean;
|
|
730
|
+
/**
|
|
731
|
+
* @description Device model code
|
|
732
|
+
* @example BB.1
|
|
733
|
+
*/
|
|
734
|
+
otp_model?: string;
|
|
735
|
+
/**
|
|
736
|
+
* @description Production timestamp
|
|
737
|
+
* @example 1767225600
|
|
738
|
+
*/
|
|
739
|
+
otp_timestamp?: number;
|
|
740
|
+
};
|
|
741
|
+
StatusFirmware: {
|
|
684
742
|
/**
|
|
685
743
|
* @description Firmware version
|
|
686
744
|
* @example 1.0.0
|
|
687
745
|
*/
|
|
688
|
-
version
|
|
746
|
+
version: string;
|
|
747
|
+
/**
|
|
748
|
+
* @description Firmware target code
|
|
749
|
+
* @example 22
|
|
750
|
+
*/
|
|
751
|
+
target: number;
|
|
689
752
|
/**
|
|
690
753
|
* @description Git branch name
|
|
691
754
|
* @example main
|
|
692
755
|
*/
|
|
693
|
-
branch
|
|
756
|
+
branch: string;
|
|
694
757
|
/**
|
|
695
758
|
* @description Build date
|
|
696
759
|
* @example 2024-01-01
|
|
697
760
|
*/
|
|
698
|
-
build_date
|
|
761
|
+
build_date: string;
|
|
699
762
|
/**
|
|
700
763
|
* @description Git commit hash (may include -dirty suffix)
|
|
701
764
|
* @example abc123def456-dirty
|
|
702
765
|
*/
|
|
703
|
-
commit_hash
|
|
766
|
+
commit_hash: string;
|
|
767
|
+
/**
|
|
768
|
+
* @description Radio firmware version
|
|
769
|
+
* @example 1711.2.14.5.2.0.7
|
|
770
|
+
*/
|
|
771
|
+
nwp_version?: string;
|
|
772
|
+
};
|
|
773
|
+
StatusSystem: {
|
|
774
|
+
/**
|
|
775
|
+
* @description API SemVer
|
|
776
|
+
* @example 0.0.0
|
|
777
|
+
*/
|
|
778
|
+
api_semver: string;
|
|
704
779
|
/**
|
|
705
780
|
* @description System uptime
|
|
706
781
|
* @example 00d 00h 04m 13s
|
|
707
782
|
*/
|
|
708
|
-
uptime
|
|
783
|
+
uptime: string;
|
|
709
784
|
/**
|
|
710
785
|
* @description System boot timestamp
|
|
711
786
|
* @example 1767225600
|
|
712
787
|
*/
|
|
713
|
-
boot_time
|
|
788
|
+
boot_time: number;
|
|
714
789
|
};
|
|
715
790
|
StatusPower: {
|
|
716
791
|
/**
|
|
@@ -718,68 +793,85 @@ declare interface components {
|
|
|
718
793
|
* @example discharging
|
|
719
794
|
* @enum {string}
|
|
720
795
|
*/
|
|
721
|
-
state
|
|
796
|
+
state: 'discharging' | 'charging' | 'charged';
|
|
722
797
|
/**
|
|
723
798
|
* @description Battery charge percent
|
|
724
799
|
* @example 99
|
|
725
800
|
*/
|
|
726
|
-
battery_charge
|
|
801
|
+
battery_charge: number;
|
|
727
802
|
/**
|
|
728
803
|
* @description Battery voltage in mV
|
|
729
804
|
* @example 4183
|
|
730
805
|
*/
|
|
731
|
-
battery_voltage
|
|
806
|
+
battery_voltage: number;
|
|
732
807
|
/**
|
|
733
808
|
* @description Battery current in mA
|
|
734
809
|
* @example -180
|
|
735
810
|
*/
|
|
736
|
-
battery_current
|
|
811
|
+
battery_current: number;
|
|
737
812
|
/**
|
|
738
813
|
* @description USB voltage in mV
|
|
739
814
|
* @example 4843
|
|
740
815
|
*/
|
|
741
|
-
usb_voltage
|
|
816
|
+
usb_voltage: number;
|
|
742
817
|
};
|
|
743
818
|
/**
|
|
744
819
|
* @example WPA3
|
|
745
820
|
* @enum {string}
|
|
746
821
|
*/
|
|
747
|
-
WifiSecurityMethod:
|
|
822
|
+
WifiSecurityMethod: 'Open' | 'WPA' | 'WPA2' | 'WEP' | 'WPA/WPA2' | 'WPA3' | 'WPA2/WPA3' | 'Unsupported';
|
|
748
823
|
/**
|
|
749
824
|
* @example dhcp
|
|
750
825
|
* @enum {string}
|
|
751
826
|
*/
|
|
752
|
-
WifiIpMethod:
|
|
827
|
+
WifiIpMethod: 'dhcp' | 'static';
|
|
753
828
|
/**
|
|
754
829
|
* @example ipv4
|
|
755
830
|
* @enum {string}
|
|
756
831
|
*/
|
|
757
|
-
WifiIpType:
|
|
832
|
+
WifiIpType: 'ipv4' | 'ipv6';
|
|
758
833
|
Network: {
|
|
759
834
|
/** @example 42 */
|
|
760
835
|
ssid?: string;
|
|
761
|
-
security?: components[
|
|
836
|
+
security?: components['schemas']['WifiSecurityMethod'];
|
|
762
837
|
/** @example 58 */
|
|
763
838
|
rssi?: number;
|
|
764
839
|
};
|
|
840
|
+
/** @description Wi-Fi status. Only `state` is always present.
|
|
841
|
+
* Fields `ssid`, `bssid`, `channel`, `rssi`, `security`, and `ip_config` are only included when state is "connected".
|
|
842
|
+
* */
|
|
765
843
|
StatusResponse: {
|
|
766
844
|
/**
|
|
767
845
|
* @example disconnected
|
|
768
846
|
* @enum {string}
|
|
769
847
|
*/
|
|
770
|
-
state
|
|
771
|
-
/**
|
|
848
|
+
state: 'unknown' | 'disconnected' | 'connected' | 'connecting' | 'disconnecting' | 'reconnecting';
|
|
849
|
+
/**
|
|
850
|
+
* @description Only present when connected
|
|
851
|
+
* @example Your_WIFI_SSID
|
|
852
|
+
*/
|
|
772
853
|
ssid?: string;
|
|
773
|
-
/**
|
|
854
|
+
/**
|
|
855
|
+
* @description Only present when connected
|
|
856
|
+
* @example EC:5A:00:0B:55:1D
|
|
857
|
+
*/
|
|
774
858
|
bssid?: string;
|
|
775
|
-
/**
|
|
859
|
+
/**
|
|
860
|
+
* @description Only present when connected
|
|
861
|
+
* @example 3
|
|
862
|
+
*/
|
|
776
863
|
channel?: number;
|
|
777
|
-
/**
|
|
864
|
+
/**
|
|
865
|
+
* @description Only present when connected
|
|
866
|
+
* @example -43
|
|
867
|
+
*/
|
|
778
868
|
rssi?: number;
|
|
779
|
-
|
|
869
|
+
/** @description Only present when connected */
|
|
870
|
+
security?: components['schemas']['WifiSecurityMethod'];
|
|
871
|
+
/** @description Only present when connected */
|
|
780
872
|
ip_config?: {
|
|
781
|
-
ip_method?: components[
|
|
782
|
-
ip_type?: components[
|
|
873
|
+
ip_method?: components['schemas']['WifiIpMethod'];
|
|
874
|
+
ip_type?: components['schemas']['WifiIpType'];
|
|
783
875
|
/** @example 192.168.50.5 */
|
|
784
876
|
address?: string;
|
|
785
877
|
};
|
|
@@ -789,14 +881,14 @@ declare interface components {
|
|
|
789
881
|
ssid?: string;
|
|
790
882
|
/** @example Your_WIFI_Pass */
|
|
791
883
|
password?: string;
|
|
792
|
-
security?: components[
|
|
884
|
+
security?: components['schemas']['WifiSecurityMethod'];
|
|
793
885
|
ip_config?: {
|
|
794
|
-
ip_method?: components[
|
|
886
|
+
ip_method?: components['schemas']['WifiIpMethod'];
|
|
795
887
|
/**
|
|
796
888
|
* @example ipv4
|
|
797
889
|
* @enum {string}
|
|
798
890
|
*/
|
|
799
|
-
ip_type?:
|
|
891
|
+
ip_type?: 'ipv4' | 'ipv6';
|
|
800
892
|
/** @example 192.168.50.5 */
|
|
801
893
|
address?: string;
|
|
802
894
|
/** @example 255.255.255.0 */
|
|
@@ -808,7 +900,7 @@ declare interface components {
|
|
|
808
900
|
NetworkResponse: {
|
|
809
901
|
/** @example 1 */
|
|
810
902
|
count?: number;
|
|
811
|
-
networks?: components[
|
|
903
|
+
networks?: components['schemas']['Network'][];
|
|
812
904
|
};
|
|
813
905
|
/**
|
|
814
906
|
* Format: base64
|
|
@@ -825,20 +917,23 @@ declare interface components {
|
|
|
825
917
|
/** @example 12345678-9abc-def0-1234-56789abcdef0 */
|
|
826
918
|
user_id?: string;
|
|
827
919
|
};
|
|
828
|
-
|
|
920
|
+
AccountStatus: {
|
|
829
921
|
/**
|
|
830
922
|
* @example connected
|
|
831
923
|
* @enum {string}
|
|
832
924
|
*/
|
|
833
|
-
|
|
925
|
+
status?: 'error' | 'disconnected' | 'connected';
|
|
834
926
|
};
|
|
835
927
|
AccountProfile: {
|
|
836
928
|
/**
|
|
837
929
|
* @example dev
|
|
838
930
|
* @enum {string}
|
|
839
931
|
*/
|
|
840
|
-
|
|
841
|
-
/**
|
|
932
|
+
profile: 'dev' | 'prod' | 'local' | 'custom';
|
|
933
|
+
/**
|
|
934
|
+
* @description Only present when profile is "custom"
|
|
935
|
+
* @example mqtts://mqtt.example.com:8883
|
|
936
|
+
*/
|
|
842
937
|
custom_url?: string;
|
|
843
938
|
};
|
|
844
939
|
AccountLink: {
|
|
@@ -852,45 +947,42 @@ declare interface components {
|
|
|
852
947
|
* @example connected
|
|
853
948
|
* @enum {string}
|
|
854
949
|
*/
|
|
855
|
-
|
|
856
|
-
/** @example 50:DA:D6:FE:DD:A9 */
|
|
857
|
-
address?: string;
|
|
950
|
+
status: 'reset' | 'initialization' | 'disabled' | 'enabled' | 'connectable' | 'connected' | 'internal error';
|
|
858
951
|
/**
|
|
859
|
-
* @
|
|
860
|
-
* @
|
|
952
|
+
* @description Remote device address. Only present when status is "connected".
|
|
953
|
+
* @example 50:DA:D6:FE:DD:A9
|
|
861
954
|
*/
|
|
862
|
-
|
|
955
|
+
address?: string;
|
|
863
956
|
};
|
|
864
957
|
BusySnapshot: {
|
|
865
|
-
snapshot: components[
|
|
958
|
+
snapshot: (components['schemas']['BusySnapshotNotStarted'] | components['schemas']['BusySnapshotInfinite'] | components['schemas']['BusySnapshotSimple'] | components['schemas']['BusySnapshotInterval']) & {
|
|
959
|
+
busy_bar_settings: components['schemas']['BusyBarSettings'];
|
|
960
|
+
};
|
|
866
961
|
/** @example 1761582532251 */
|
|
867
962
|
snapshot_timestamp_ms: number;
|
|
868
963
|
};
|
|
869
964
|
BusySnapshotNotStarted: {
|
|
870
|
-
/**
|
|
871
|
-
|
|
872
|
-
* @enum {string}
|
|
873
|
-
*/
|
|
874
|
-
type: "NOT_STARTED";
|
|
965
|
+
/** @constant */
|
|
966
|
+
type: 'NOT_STARTED';
|
|
875
967
|
};
|
|
876
968
|
BusySnapshotInfinite: {
|
|
969
|
+
/** @constant */
|
|
970
|
+
type: 'INFINITE';
|
|
877
971
|
/**
|
|
878
|
-
*
|
|
879
|
-
* @
|
|
972
|
+
* Format: uuid
|
|
973
|
+
* @example 00000000-0000-0000-0000-000000000000
|
|
880
974
|
*/
|
|
881
|
-
type: "INFINITE";
|
|
882
|
-
/** @example 00000000-0000-0000-0000-000000000000 */
|
|
883
975
|
card_id: string;
|
|
884
976
|
/** @example false */
|
|
885
977
|
is_paused: boolean;
|
|
886
978
|
};
|
|
887
979
|
BusySnapshotSimple: {
|
|
980
|
+
/** @constant */
|
|
981
|
+
type: 'SIMPLE';
|
|
888
982
|
/**
|
|
889
|
-
*
|
|
890
|
-
* @
|
|
983
|
+
* Format: uuid
|
|
984
|
+
* @example 00000000-0000-0000-0000-000000000000
|
|
891
985
|
*/
|
|
892
|
-
type: "SIMPLE";
|
|
893
|
-
/** @example 00000000-0000-0000-0000-000000000000 */
|
|
894
986
|
card_id: string;
|
|
895
987
|
/** @example 9000 */
|
|
896
988
|
time_left_ms: number;
|
|
@@ -898,12 +990,12 @@ declare interface components {
|
|
|
898
990
|
is_paused: boolean;
|
|
899
991
|
};
|
|
900
992
|
BusySnapshotInterval: {
|
|
993
|
+
/** @constant */
|
|
994
|
+
type: 'INTERVAL';
|
|
901
995
|
/**
|
|
902
|
-
*
|
|
903
|
-
* @
|
|
996
|
+
* Format: uuid
|
|
997
|
+
* @example 00000000-0000-0000-0000-000000000000
|
|
904
998
|
*/
|
|
905
|
-
type: "INTERVAL";
|
|
906
|
-
/** @example 00000000-0000-0000-0000-000000000000 */
|
|
907
999
|
card_id: string;
|
|
908
1000
|
/** @example 1 */
|
|
909
1001
|
current_interval: number;
|
|
@@ -913,94 +1005,110 @@ declare interface components {
|
|
|
913
1005
|
current_interval_time_left_ms: number;
|
|
914
1006
|
/** @example false */
|
|
915
1007
|
is_paused: boolean;
|
|
916
|
-
interval_settings: components[
|
|
1008
|
+
interval_settings: components['schemas']['BusyTimerIntervalSettings'];
|
|
917
1009
|
};
|
|
918
|
-
|
|
1010
|
+
BusyProfile: {
|
|
1011
|
+
/** @example -1 */
|
|
1012
|
+
sort_order: number;
|
|
1013
|
+
/** @example study */
|
|
1014
|
+
title: string;
|
|
919
1015
|
/**
|
|
920
|
-
*
|
|
921
|
-
* @
|
|
1016
|
+
* Format: uuid
|
|
1017
|
+
* @example 00000000-0000-0000-0000-000000000000
|
|
922
1018
|
*/
|
|
923
|
-
|
|
1019
|
+
id: string;
|
|
1020
|
+
timer_settings: components['schemas']['BusyTimerInfiniteSettings'] | components['schemas']['BusyTimerSimpleSettings'] | components['schemas']['BusyTimerIntervalSettings'];
|
|
1021
|
+
busy_bar_settings: components['schemas']['BusyBarSettings'];
|
|
1022
|
+
/** @example 1761582532251 */
|
|
1023
|
+
profile_timestamp_ms: number;
|
|
1024
|
+
};
|
|
1025
|
+
/**
|
|
1026
|
+
* @example busy
|
|
1027
|
+
* @enum {string}
|
|
1028
|
+
*/
|
|
1029
|
+
BusyProfileSlot: 'busy' | 'custom';
|
|
1030
|
+
BusyTimerInfiniteSettings: {
|
|
1031
|
+
/** @constant */
|
|
1032
|
+
type: 'INFINITE';
|
|
1033
|
+
};
|
|
1034
|
+
BusyTimerSimpleSettings: {
|
|
1035
|
+
/** @constant */
|
|
1036
|
+
type: 'SIMPLE';
|
|
1037
|
+
/** @example 300000 */
|
|
1038
|
+
total_time_ms: number;
|
|
1039
|
+
};
|
|
1040
|
+
BusyTimerIntervalSettings: {
|
|
1041
|
+
/** @constant */
|
|
1042
|
+
type: 'INTERVAL';
|
|
924
1043
|
/** @example 120000 */
|
|
925
|
-
interval_work_ms
|
|
1044
|
+
interval_work_ms: number;
|
|
926
1045
|
/** @example 60000 */
|
|
927
|
-
interval_rest_ms
|
|
1046
|
+
interval_rest_ms: number;
|
|
928
1047
|
/** @example 3 */
|
|
929
|
-
interval_work_cycles_count
|
|
1048
|
+
interval_work_cycles_count: number;
|
|
930
1049
|
/** @example false */
|
|
931
|
-
is_autostart_enabled
|
|
1050
|
+
is_autostart_enabled: boolean;
|
|
1051
|
+
};
|
|
1052
|
+
BusyBarSettings: {
|
|
1053
|
+
/** @example on_air */
|
|
1054
|
+
theme: string;
|
|
1055
|
+
/** @example false */
|
|
1056
|
+
show_work_phase_only: boolean;
|
|
1057
|
+
/** @example true */
|
|
1058
|
+
trigger_smart_home: boolean;
|
|
932
1059
|
};
|
|
933
1060
|
TimezoneListResponse: {
|
|
1061
|
+
list?: components['schemas']['TimezoneInfo'][];
|
|
1062
|
+
};
|
|
1063
|
+
SmartHomePairingInfo: {
|
|
934
1064
|
/**
|
|
935
|
-
* @description
|
|
936
|
-
* @example Bangalore
|
|
937
|
-
*/
|
|
938
|
-
name?: string;
|
|
939
|
-
/**
|
|
940
|
-
* @description Time zone offset from UTC
|
|
941
|
-
* @example +05:30
|
|
942
|
-
*/
|
|
943
|
-
offset?: string;
|
|
944
|
-
/**
|
|
945
|
-
* @description Time zone abbreviation
|
|
946
|
-
* @example IST
|
|
947
|
-
*/
|
|
948
|
-
abbr?: string;
|
|
949
|
-
}[];
|
|
950
|
-
MatterCommissionedFabrics: {
|
|
951
|
-
/**
|
|
952
|
-
* @description Number of Matter smart homes ("fabrics") that this device is linked with ("commissioned into")
|
|
1065
|
+
* @description Number of smart homes (Matter "fabrics") that this device is paired with ("commissioned into")
|
|
953
1066
|
* @example 1
|
|
954
1067
|
*/
|
|
955
1068
|
fabric_count?: number;
|
|
956
|
-
|
|
1069
|
+
latest_pairing_status?: {
|
|
957
1070
|
/**
|
|
958
|
-
* @description Latest state of
|
|
1071
|
+
* @description Latest state of smart home pairing (Matter "commissioning") process. Note: "never_started" only refers to the current power cycle of the device; this status is not recorded across reboots.
|
|
959
1072
|
* @example completed_successfully
|
|
960
1073
|
* @enum {string}
|
|
961
1074
|
*/
|
|
962
|
-
value?:
|
|
1075
|
+
value?: 'never_started' | 'started' | 'completed_successfully' | 'failed';
|
|
963
1076
|
/**
|
|
964
|
-
* @description UTC Unix
|
|
965
|
-
* @example
|
|
1077
|
+
* @description UTC Unix second timestamp of latest state update. Only present when a status update has occurred.
|
|
1078
|
+
* @example 1769436711
|
|
966
1079
|
*/
|
|
967
|
-
timestamp?:
|
|
1080
|
+
timestamp?: number;
|
|
968
1081
|
};
|
|
969
1082
|
};
|
|
970
|
-
|
|
1083
|
+
/** @description Set of information for pairing with a Matter smart home */
|
|
1084
|
+
SmartHomePairingPayload: {
|
|
971
1085
|
/**
|
|
972
|
-
* @description
|
|
1086
|
+
* @description Pairing with ("commissioning into") a Matter smart home using the provided payload is possible before this UTC Unix millisecond timestamp. Note: it's a number in a string.
|
|
973
1087
|
* @example 1769437579000
|
|
974
1088
|
*/
|
|
975
1089
|
available_until?: string;
|
|
976
1090
|
/**
|
|
977
|
-
* @description Payload of the QR code for
|
|
1091
|
+
* @description Payload of the QR code for pairing with ("commissioning into") a smart home
|
|
978
1092
|
* @example MT:YNDA0-O913..VV7I000
|
|
979
1093
|
*/
|
|
980
1094
|
qr_code?: string;
|
|
981
1095
|
/**
|
|
982
|
-
* @description Manual code for
|
|
1096
|
+
* @description Manual code for pairing with ("commissioning into") a smart home
|
|
983
1097
|
* @example 1155-360-0377
|
|
984
1098
|
*/
|
|
985
1099
|
manual_code?: string;
|
|
986
1100
|
};
|
|
987
|
-
|
|
988
|
-
/**
|
|
989
|
-
* @description Type of device emulated by a Matter endpoint. Currently only "switch" is implemented.
|
|
990
|
-
* @example switch
|
|
991
|
-
* @enum {string}
|
|
992
|
-
*/
|
|
993
|
-
type?: "switch";
|
|
1101
|
+
SmartHomeSwitchState: {
|
|
994
1102
|
/**
|
|
995
|
-
* @description State of
|
|
1103
|
+
* @description State of emulated switch.
|
|
996
1104
|
* @example false
|
|
997
1105
|
*/
|
|
998
1106
|
state?: boolean;
|
|
999
1107
|
/**
|
|
1000
|
-
* @description
|
|
1108
|
+
* @description State of emulated switch on startup. Never sent by the server, but can be specified by the client.
|
|
1001
1109
|
* @enum {string}
|
|
1002
1110
|
*/
|
|
1003
|
-
startup?:
|
|
1111
|
+
startup?: 'off' | 'on' | 'toggle' | 'last';
|
|
1004
1112
|
};
|
|
1005
1113
|
};
|
|
1006
1114
|
responses: never;
|
|
@@ -1010,55 +1118,58 @@ declare interface components {
|
|
|
1010
1118
|
pathItems: never;
|
|
1011
1119
|
}
|
|
1012
1120
|
|
|
1013
|
-
declare type
|
|
1121
|
+
export declare type CountdownElement = components['schemas']['CountdownElement'];
|
|
1014
1122
|
|
|
1015
|
-
declare type
|
|
1016
|
-
[K in keyof T as SnakeToCamel<K & string>]: DeepCamelize<T[K]>;
|
|
1017
|
-
} : T;
|
|
1123
|
+
declare type DataListener = (data: Uint8Array) => void;
|
|
1018
1124
|
|
|
1019
1125
|
export declare enum DeviceScreen {
|
|
1020
1126
|
FRONT = 0,
|
|
1021
1127
|
BACK = 1
|
|
1022
1128
|
}
|
|
1023
1129
|
|
|
1024
|
-
export declare type DisplayBrightnessInfo = components[
|
|
1130
|
+
export declare type DisplayBrightnessInfo = components['schemas']['DisplayBrightnessInfo'];
|
|
1025
1131
|
|
|
1026
1132
|
export declare interface DisplayBrightnessParams extends TimeoutOptions {
|
|
1027
|
-
value
|
|
1133
|
+
value: Brightness;
|
|
1134
|
+
}
|
|
1135
|
+
|
|
1136
|
+
export declare interface DisplayClearParams extends TimeoutOptions, Partial<ClearDisplayQuery> {
|
|
1028
1137
|
}
|
|
1029
1138
|
|
|
1030
|
-
export declare interface DisplayDrawParams extends TimeoutOptions {
|
|
1031
|
-
appId: components["schemas"]["DisplayElements"]["app_id"];
|
|
1032
|
-
elements: components["schemas"]["DisplayElements"]["elements"];
|
|
1033
|
-
/** @default 6 */
|
|
1034
|
-
priority?: components["schemas"]["DisplayElements"]["priority"];
|
|
1139
|
+
export declare interface DisplayDrawParams extends TimeoutOptions, DisplayElements {
|
|
1035
1140
|
}
|
|
1036
1141
|
|
|
1142
|
+
export declare type DisplayElement = components['schemas']['DisplayElement'];
|
|
1143
|
+
|
|
1144
|
+
export declare type DisplayElements = components['schemas']['DisplayElements'];
|
|
1145
|
+
|
|
1037
1146
|
declare class DisplayMethods {
|
|
1038
1147
|
/**
|
|
1039
|
-
* Draw on display.
|
|
1148
|
+
* Draw on display. Sends drawing data to the display. Supports JSON-defined display elements.
|
|
1040
1149
|
*
|
|
1041
1150
|
* @param {DrawParams} params - Parameters for the draw operation.
|
|
1042
|
-
* @param {
|
|
1043
|
-
* @param {
|
|
1044
|
-
* @param {
|
|
1151
|
+
* @param {string} params.application_name - Application ID for organizing assets.
|
|
1152
|
+
* @param {Array} params.elements - Display elements to draw.
|
|
1153
|
+
* @param {number} [params.priority=50] - Draw priority in the range [1, 100].
|
|
1045
1154
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1046
1155
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful draw command.
|
|
1047
1156
|
*/
|
|
1048
1157
|
DisplayDraw(this: BusyBar, params: DisplayDrawParams): Promise<SuccessResponse>;
|
|
1049
1158
|
/**
|
|
1050
|
-
* Clear display.
|
|
1159
|
+
* Clear display. Deletes display elements drawn by the Canvas application.
|
|
1160
|
+
* If application_name is specified, only elements for that app are removed.
|
|
1051
1161
|
*
|
|
1052
|
-
* @param {
|
|
1162
|
+
* @param {ClearParams} [params] - Optional parameters.
|
|
1163
|
+
* @param {string} [params.application_name] - Application identifier.
|
|
1053
1164
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1054
1165
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful clear command.
|
|
1055
1166
|
*/
|
|
1056
|
-
DisplayClear(this: BusyBar, params?:
|
|
1167
|
+
DisplayClear(this: BusyBar, params?: DisplayClearParams): Promise<SuccessResponse>;
|
|
1057
1168
|
/**
|
|
1058
1169
|
* Get single frame for requested screen.
|
|
1059
1170
|
*
|
|
1060
1171
|
* @param {GetScreenFrameParams} params - Parameters for the frame request.
|
|
1061
|
-
* @param {
|
|
1172
|
+
* @param {number} params.display - Type of the display (Front = 0, Back = 1).
|
|
1062
1173
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1063
1174
|
* @returns {Promise<Blob>} A promise that resolves to the screen frame as a Blob.
|
|
1064
1175
|
*/
|
|
@@ -1074,15 +1185,15 @@ declare class DisplayMethods {
|
|
|
1074
1185
|
/**
|
|
1075
1186
|
* Set display brightness.
|
|
1076
1187
|
*
|
|
1077
|
-
* @param {BrightnessParams} params - Brightness parameters
|
|
1078
|
-
* @param {
|
|
1188
|
+
* @param {BrightnessParams} params - Brightness parameters.
|
|
1189
|
+
* @param {number | 'auto'} params.value - Brightness (0-100 or "auto").
|
|
1079
1190
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1080
1191
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
1081
1192
|
*/
|
|
1082
1193
|
DisplayBrightnessSet(this: BusyBar, params: DisplayBrightnessParams): Promise<SuccessResponse>;
|
|
1083
1194
|
}
|
|
1084
1195
|
|
|
1085
|
-
declare type Error_2 = components[
|
|
1196
|
+
declare type Error_2 = components['schemas']['Error'];
|
|
1086
1197
|
export { Error_2 as Error }
|
|
1087
1198
|
|
|
1088
1199
|
declare type ErrorListener = (payload: ErrorPayload) => void;
|
|
@@ -1093,13 +1204,15 @@ declare interface ErrorPayload {
|
|
|
1093
1204
|
raw: Error_2 | CloseEvent | Event;
|
|
1094
1205
|
}
|
|
1095
1206
|
|
|
1096
|
-
export declare type HttpAccessInfo = components[
|
|
1207
|
+
export declare type HttpAccessInfo = components['schemas']['HttpAccessInfo'];
|
|
1097
1208
|
|
|
1098
|
-
export declare interface HttpAccessParams extends TimeoutOptions {
|
|
1099
|
-
mode: operations["setHttpAccess"]["parameters"]["query"]["mode"];
|
|
1100
|
-
key: operations["setHttpAccess"]["parameters"]["query"]["key"];
|
|
1209
|
+
export declare interface HttpAccessParams extends TimeoutOptions, HttpAccessQuery {
|
|
1101
1210
|
}
|
|
1102
1211
|
|
|
1212
|
+
declare type HttpAccessQuery = operations['setHttpAccess']['parameters']['query'];
|
|
1213
|
+
|
|
1214
|
+
export declare type ImageElement = components['schemas']['ImageElement'];
|
|
1215
|
+
|
|
1103
1216
|
export declare class Input {
|
|
1104
1217
|
readonly addr: string;
|
|
1105
1218
|
connected: boolean;
|
|
@@ -1131,61 +1244,30 @@ export declare interface InputConfig {
|
|
|
1131
1244
|
apiSemver?: ApiSemver;
|
|
1132
1245
|
}
|
|
1133
1246
|
|
|
1134
|
-
export declare interface InputKeyParams extends TimeoutOptions {
|
|
1135
|
-
keyName: KeyName;
|
|
1247
|
+
export declare interface InputKeyParams extends TimeoutOptions, InputKeyQuery {
|
|
1136
1248
|
}
|
|
1137
1249
|
|
|
1250
|
+
declare type InputKeyQuery = operations['setInputKey']['parameters']['query'];
|
|
1251
|
+
|
|
1138
1252
|
declare class InputMethods {
|
|
1139
1253
|
/**
|
|
1140
1254
|
* Send input event. Send single key press event.
|
|
1141
1255
|
*
|
|
1142
1256
|
* @param {InputKeyParams} params - Button press parameters:
|
|
1143
|
-
* @param {KeyName} params.
|
|
1257
|
+
* @param {KeyName} params.key - Key name.
|
|
1144
1258
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1145
1259
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
1146
1260
|
*/
|
|
1147
1261
|
InputSend(this: BusyBar, params: InputKeyParams): Promise<SuccessResponse>;
|
|
1148
1262
|
}
|
|
1149
1263
|
|
|
1150
|
-
export declare type KeyName = operations[
|
|
1264
|
+
export declare type KeyName = operations['setInputKey']['parameters']['query']['key'];
|
|
1151
1265
|
|
|
1152
1266
|
export declare type KeyValue = 1 | 0;
|
|
1153
1267
|
|
|
1154
|
-
declare
|
|
1155
|
-
/**
|
|
1156
|
-
* Get Matter status.
|
|
1157
|
-
*
|
|
1158
|
-
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
1159
|
-
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1160
|
-
* @returns {Promise<MatterStatus>} A promise that resolves to the Matter status.
|
|
1161
|
-
*/
|
|
1162
|
-
MatterStatusGet(this: BusyBar, params?: TimeoutOptions): Promise<MatterStatus>;
|
|
1163
|
-
/**
|
|
1164
|
-
* Pair Matter device.
|
|
1165
|
-
*
|
|
1166
|
-
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
1167
|
-
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1168
|
-
* @returns {Promise<MatterPairingInfo>} A promise that resolves on success.
|
|
1169
|
-
*/
|
|
1170
|
-
MatterPair(this: BusyBar, params?: TimeoutOptions): Promise<MatterPairingInfo>;
|
|
1171
|
-
/**
|
|
1172
|
-
* Erase Matter devices.
|
|
1173
|
-
*
|
|
1174
|
-
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
1175
|
-
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
1176
|
-
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
1177
|
-
*/
|
|
1178
|
-
MatterErase(this: BusyBar, params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
1179
|
-
}
|
|
1180
|
-
|
|
1181
|
-
export declare type MatterPairingInfo = components["schemas"]["MatterCommissioningPayload"];
|
|
1268
|
+
export declare type NameInfo = components['schemas']['NameInfo'];
|
|
1182
1269
|
|
|
1183
|
-
export declare
|
|
1184
|
-
|
|
1185
|
-
export declare type NameInfo = components["schemas"]["NameInfo"];
|
|
1186
|
-
|
|
1187
|
-
export declare interface NameParams extends TimeoutOptions {
|
|
1188
|
-
name: NameInfo["name"];
|
|
1270
|
+
export declare interface NameParams extends TimeoutOptions, NameInfo {
|
|
1189
1271
|
}
|
|
1190
1272
|
|
|
1191
1273
|
declare interface operations {
|
|
@@ -1204,7 +1286,7 @@ declare interface operations {
|
|
|
1204
1286
|
[name: string]: unknown;
|
|
1205
1287
|
};
|
|
1206
1288
|
content: {
|
|
1207
|
-
|
|
1289
|
+
'application/json': components['schemas']['VersionInfo'];
|
|
1208
1290
|
};
|
|
1209
1291
|
};
|
|
1210
1292
|
/** @description Internal server error */
|
|
@@ -1213,7 +1295,7 @@ declare interface operations {
|
|
|
1213
1295
|
[name: string]: unknown;
|
|
1214
1296
|
};
|
|
1215
1297
|
content: {
|
|
1216
|
-
|
|
1298
|
+
'application/json': components['schemas']['Error'];
|
|
1217
1299
|
};
|
|
1218
1300
|
};
|
|
1219
1301
|
};
|
|
@@ -1233,7 +1315,7 @@ declare interface operations {
|
|
|
1233
1315
|
[name: string]: unknown;
|
|
1234
1316
|
};
|
|
1235
1317
|
content: {
|
|
1236
|
-
|
|
1318
|
+
'application/json': components['schemas']['HttpAccessInfo'];
|
|
1237
1319
|
};
|
|
1238
1320
|
};
|
|
1239
1321
|
};
|
|
@@ -1245,12 +1327,12 @@ declare interface operations {
|
|
|
1245
1327
|
* @description Access mode
|
|
1246
1328
|
* @example key
|
|
1247
1329
|
*/
|
|
1248
|
-
mode:
|
|
1330
|
+
mode: 'disabled' | 'enabled' | 'key';
|
|
1249
1331
|
/**
|
|
1250
|
-
* @description Access key (4-10 digits length)
|
|
1332
|
+
* @description Access key (4-10 digits length). Required when mode is "key".
|
|
1251
1333
|
* @example 12345678
|
|
1252
1334
|
*/
|
|
1253
|
-
key
|
|
1335
|
+
key?: string;
|
|
1254
1336
|
};
|
|
1255
1337
|
header?: never;
|
|
1256
1338
|
path?: never;
|
|
@@ -1264,7 +1346,7 @@ declare interface operations {
|
|
|
1264
1346
|
[name: string]: unknown;
|
|
1265
1347
|
};
|
|
1266
1348
|
content: {
|
|
1267
|
-
|
|
1349
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1268
1350
|
};
|
|
1269
1351
|
};
|
|
1270
1352
|
/** @description Invalid request data */
|
|
@@ -1273,7 +1355,7 @@ declare interface operations {
|
|
|
1273
1355
|
[name: string]: unknown;
|
|
1274
1356
|
};
|
|
1275
1357
|
content: {
|
|
1276
|
-
|
|
1358
|
+
'application/json': components['schemas']['Error'];
|
|
1277
1359
|
};
|
|
1278
1360
|
};
|
|
1279
1361
|
};
|
|
@@ -1287,7 +1369,7 @@ declare interface operations {
|
|
|
1287
1369
|
};
|
|
1288
1370
|
requestBody: {
|
|
1289
1371
|
content: {
|
|
1290
|
-
|
|
1372
|
+
'application/octet-stream': string;
|
|
1291
1373
|
};
|
|
1292
1374
|
};
|
|
1293
1375
|
responses: {
|
|
@@ -1297,7 +1379,7 @@ declare interface operations {
|
|
|
1297
1379
|
[name: string]: unknown;
|
|
1298
1380
|
};
|
|
1299
1381
|
content: {
|
|
1300
|
-
|
|
1382
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1301
1383
|
};
|
|
1302
1384
|
};
|
|
1303
1385
|
/** @description Invalid parameters, invalid TAR file, or update preparation failed. */
|
|
@@ -1306,7 +1388,7 @@ declare interface operations {
|
|
|
1306
1388
|
[name: string]: unknown;
|
|
1307
1389
|
};
|
|
1308
1390
|
content: {
|
|
1309
|
-
|
|
1391
|
+
'application/json': components['schemas']['Error'];
|
|
1310
1392
|
};
|
|
1311
1393
|
};
|
|
1312
1394
|
/** @description Update package too large. */
|
|
@@ -1315,7 +1397,7 @@ declare interface operations {
|
|
|
1315
1397
|
[name: string]: unknown;
|
|
1316
1398
|
};
|
|
1317
1399
|
content: {
|
|
1318
|
-
|
|
1400
|
+
'application/json': components['schemas']['Error'];
|
|
1319
1401
|
};
|
|
1320
1402
|
};
|
|
1321
1403
|
/** @description Internal server error during update process. */
|
|
@@ -1324,7 +1406,7 @@ declare interface operations {
|
|
|
1324
1406
|
[name: string]: unknown;
|
|
1325
1407
|
};
|
|
1326
1408
|
content: {
|
|
1327
|
-
|
|
1409
|
+
'application/json': components['schemas']['Error'];
|
|
1328
1410
|
};
|
|
1329
1411
|
};
|
|
1330
1412
|
};
|
|
@@ -1344,7 +1426,7 @@ declare interface operations {
|
|
|
1344
1426
|
[name: string]: unknown;
|
|
1345
1427
|
};
|
|
1346
1428
|
content: {
|
|
1347
|
-
|
|
1429
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1348
1430
|
};
|
|
1349
1431
|
};
|
|
1350
1432
|
/** @description Update check already in progress */
|
|
@@ -1353,7 +1435,7 @@ declare interface operations {
|
|
|
1353
1435
|
[name: string]: unknown;
|
|
1354
1436
|
};
|
|
1355
1437
|
content: {
|
|
1356
|
-
|
|
1438
|
+
'application/json': components['schemas']['Error'];
|
|
1357
1439
|
};
|
|
1358
1440
|
};
|
|
1359
1441
|
/** @description Failed to start update check */
|
|
@@ -1362,7 +1444,7 @@ declare interface operations {
|
|
|
1362
1444
|
[name: string]: unknown;
|
|
1363
1445
|
};
|
|
1364
1446
|
content: {
|
|
1365
|
-
|
|
1447
|
+
'application/json': components['schemas']['Error'];
|
|
1366
1448
|
};
|
|
1367
1449
|
};
|
|
1368
1450
|
};
|
|
@@ -1382,7 +1464,7 @@ declare interface operations {
|
|
|
1382
1464
|
[name: string]: unknown;
|
|
1383
1465
|
};
|
|
1384
1466
|
content: {
|
|
1385
|
-
|
|
1467
|
+
'application/json': components['schemas']['UpdateStatus'];
|
|
1386
1468
|
};
|
|
1387
1469
|
};
|
|
1388
1470
|
};
|
|
@@ -1408,7 +1490,7 @@ declare interface operations {
|
|
|
1408
1490
|
[name: string]: unknown;
|
|
1409
1491
|
};
|
|
1410
1492
|
content: {
|
|
1411
|
-
|
|
1493
|
+
'application/json': {
|
|
1412
1494
|
/** @description Changelog text */
|
|
1413
1495
|
changelog?: string;
|
|
1414
1496
|
};
|
|
@@ -1420,7 +1502,7 @@ declare interface operations {
|
|
|
1420
1502
|
[name: string]: unknown;
|
|
1421
1503
|
};
|
|
1422
1504
|
content: {
|
|
1423
|
-
|
|
1505
|
+
'application/json': components['schemas']['Error'];
|
|
1424
1506
|
};
|
|
1425
1507
|
};
|
|
1426
1508
|
};
|
|
@@ -1446,7 +1528,7 @@ declare interface operations {
|
|
|
1446
1528
|
[name: string]: unknown;
|
|
1447
1529
|
};
|
|
1448
1530
|
content: {
|
|
1449
|
-
|
|
1531
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1450
1532
|
};
|
|
1451
1533
|
};
|
|
1452
1534
|
/** @description Version parameter missing, update not available, or version mismatch */
|
|
@@ -1455,7 +1537,7 @@ declare interface operations {
|
|
|
1455
1537
|
[name: string]: unknown;
|
|
1456
1538
|
};
|
|
1457
1539
|
content: {
|
|
1458
|
-
|
|
1540
|
+
'application/json': components['schemas']['Error'];
|
|
1459
1541
|
};
|
|
1460
1542
|
};
|
|
1461
1543
|
/** @description Update already in progress */
|
|
@@ -1464,7 +1546,7 @@ declare interface operations {
|
|
|
1464
1546
|
[name: string]: unknown;
|
|
1465
1547
|
};
|
|
1466
1548
|
content: {
|
|
1467
|
-
|
|
1549
|
+
'application/json': components['schemas']['Error'];
|
|
1468
1550
|
};
|
|
1469
1551
|
};
|
|
1470
1552
|
/** @description Failed to start background installation */
|
|
@@ -1473,7 +1555,7 @@ declare interface operations {
|
|
|
1473
1555
|
[name: string]: unknown;
|
|
1474
1556
|
};
|
|
1475
1557
|
content: {
|
|
1476
|
-
|
|
1558
|
+
'application/json': components['schemas']['Error'];
|
|
1477
1559
|
};
|
|
1478
1560
|
};
|
|
1479
1561
|
/** @description Battery too low for update */
|
|
@@ -1482,7 +1564,7 @@ declare interface operations {
|
|
|
1482
1564
|
[name: string]: unknown;
|
|
1483
1565
|
};
|
|
1484
1566
|
content: {
|
|
1485
|
-
|
|
1567
|
+
'application/json': components['schemas']['Error'];
|
|
1486
1568
|
};
|
|
1487
1569
|
};
|
|
1488
1570
|
};
|
|
@@ -1502,7 +1584,78 @@ declare interface operations {
|
|
|
1502
1584
|
[name: string]: unknown;
|
|
1503
1585
|
};
|
|
1504
1586
|
content: {
|
|
1505
|
-
|
|
1587
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1588
|
+
};
|
|
1589
|
+
};
|
|
1590
|
+
};
|
|
1591
|
+
};
|
|
1592
|
+
getAutoupdateSettings: {
|
|
1593
|
+
parameters: {
|
|
1594
|
+
query?: never;
|
|
1595
|
+
header?: never;
|
|
1596
|
+
path?: never;
|
|
1597
|
+
cookie?: never;
|
|
1598
|
+
};
|
|
1599
|
+
requestBody?: never;
|
|
1600
|
+
responses: {
|
|
1601
|
+
/** @description Settings retrieved successfully */
|
|
1602
|
+
200: {
|
|
1603
|
+
headers: {
|
|
1604
|
+
[name: string]: unknown;
|
|
1605
|
+
};
|
|
1606
|
+
content: {
|
|
1607
|
+
'application/json': components['schemas']['AutoupdateSettings'];
|
|
1608
|
+
};
|
|
1609
|
+
};
|
|
1610
|
+
/** @description Internal server error */
|
|
1611
|
+
500: {
|
|
1612
|
+
headers: {
|
|
1613
|
+
[name: string]: unknown;
|
|
1614
|
+
};
|
|
1615
|
+
content: {
|
|
1616
|
+
'application/json': components['schemas']['Error'];
|
|
1617
|
+
};
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
};
|
|
1621
|
+
setAutoupdateSettings: {
|
|
1622
|
+
parameters: {
|
|
1623
|
+
query?: never;
|
|
1624
|
+
header?: never;
|
|
1625
|
+
path?: never;
|
|
1626
|
+
cookie?: never;
|
|
1627
|
+
};
|
|
1628
|
+
requestBody: {
|
|
1629
|
+
content: {
|
|
1630
|
+
'application/json': components['schemas']['AutoupdateSettings'];
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1633
|
+
responses: {
|
|
1634
|
+
/** @description Settings updated successfully */
|
|
1635
|
+
200: {
|
|
1636
|
+
headers: {
|
|
1637
|
+
[name: string]: unknown;
|
|
1638
|
+
};
|
|
1639
|
+
content: {
|
|
1640
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1641
|
+
};
|
|
1642
|
+
};
|
|
1643
|
+
/** @description Invalid time format (expected HH:MM) */
|
|
1644
|
+
400: {
|
|
1645
|
+
headers: {
|
|
1646
|
+
[name: string]: unknown;
|
|
1647
|
+
};
|
|
1648
|
+
content: {
|
|
1649
|
+
'application/json': components['schemas']['Error'];
|
|
1650
|
+
};
|
|
1651
|
+
};
|
|
1652
|
+
/** @description Failed to apply settings */
|
|
1653
|
+
500: {
|
|
1654
|
+
headers: {
|
|
1655
|
+
[name: string]: unknown;
|
|
1656
|
+
};
|
|
1657
|
+
content: {
|
|
1658
|
+
'application/json': components['schemas']['Error'];
|
|
1506
1659
|
};
|
|
1507
1660
|
};
|
|
1508
1661
|
};
|
|
@@ -1514,7 +1667,7 @@ declare interface operations {
|
|
|
1514
1667
|
* @description Application ID for organizing assets
|
|
1515
1668
|
* @example my_app
|
|
1516
1669
|
*/
|
|
1517
|
-
|
|
1670
|
+
application_name: string;
|
|
1518
1671
|
/**
|
|
1519
1672
|
* @description Filename for the uploaded asset
|
|
1520
1673
|
* @example data.png
|
|
@@ -1527,7 +1680,7 @@ declare interface operations {
|
|
|
1527
1680
|
};
|
|
1528
1681
|
requestBody: {
|
|
1529
1682
|
content: {
|
|
1530
|
-
|
|
1683
|
+
'application/octet-stream': string;
|
|
1531
1684
|
};
|
|
1532
1685
|
};
|
|
1533
1686
|
responses: {
|
|
@@ -1537,7 +1690,7 @@ declare interface operations {
|
|
|
1537
1690
|
[name: string]: unknown;
|
|
1538
1691
|
};
|
|
1539
1692
|
content: {
|
|
1540
|
-
|
|
1693
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1541
1694
|
};
|
|
1542
1695
|
};
|
|
1543
1696
|
/** @description Invalid parameters or upload failed */
|
|
@@ -1546,7 +1699,7 @@ declare interface operations {
|
|
|
1546
1699
|
[name: string]: unknown;
|
|
1547
1700
|
};
|
|
1548
1701
|
content: {
|
|
1549
|
-
|
|
1702
|
+
'application/json': components['schemas']['Error'];
|
|
1550
1703
|
};
|
|
1551
1704
|
};
|
|
1552
1705
|
/** @description File too large */
|
|
@@ -1555,7 +1708,7 @@ declare interface operations {
|
|
|
1555
1708
|
[name: string]: unknown;
|
|
1556
1709
|
};
|
|
1557
1710
|
content: {
|
|
1558
|
-
|
|
1711
|
+
'application/json': components['schemas']['Error'];
|
|
1559
1712
|
};
|
|
1560
1713
|
};
|
|
1561
1714
|
};
|
|
@@ -1567,7 +1720,7 @@ declare interface operations {
|
|
|
1567
1720
|
* @description Application ID whose assets should be deleted
|
|
1568
1721
|
* @example my_app
|
|
1569
1722
|
*/
|
|
1570
|
-
|
|
1723
|
+
application_name: string;
|
|
1571
1724
|
};
|
|
1572
1725
|
header?: never;
|
|
1573
1726
|
path?: never;
|
|
@@ -1581,7 +1734,7 @@ declare interface operations {
|
|
|
1581
1734
|
[name: string]: unknown;
|
|
1582
1735
|
};
|
|
1583
1736
|
content: {
|
|
1584
|
-
|
|
1737
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1585
1738
|
};
|
|
1586
1739
|
};
|
|
1587
1740
|
/** @description Invalid request parameters */
|
|
@@ -1590,7 +1743,7 @@ declare interface operations {
|
|
|
1590
1743
|
[name: string]: unknown;
|
|
1591
1744
|
};
|
|
1592
1745
|
content: {
|
|
1593
|
-
|
|
1746
|
+
'application/json': components['schemas']['Error'];
|
|
1594
1747
|
};
|
|
1595
1748
|
};
|
|
1596
1749
|
/** @description Delete failed */
|
|
@@ -1599,7 +1752,7 @@ declare interface operations {
|
|
|
1599
1752
|
[name: string]: unknown;
|
|
1600
1753
|
};
|
|
1601
1754
|
content: {
|
|
1602
|
-
|
|
1755
|
+
'application/json': components['schemas']['Error'];
|
|
1603
1756
|
};
|
|
1604
1757
|
};
|
|
1605
1758
|
};
|
|
@@ -1619,7 +1772,7 @@ declare interface operations {
|
|
|
1619
1772
|
};
|
|
1620
1773
|
requestBody: {
|
|
1621
1774
|
content: {
|
|
1622
|
-
|
|
1775
|
+
'application/octet-stream': string;
|
|
1623
1776
|
};
|
|
1624
1777
|
};
|
|
1625
1778
|
responses: {
|
|
@@ -1629,7 +1782,7 @@ declare interface operations {
|
|
|
1629
1782
|
[name: string]: unknown;
|
|
1630
1783
|
};
|
|
1631
1784
|
content: {
|
|
1632
|
-
|
|
1785
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1633
1786
|
};
|
|
1634
1787
|
};
|
|
1635
1788
|
/** @description Invalid parameters or upload failed */
|
|
@@ -1638,7 +1791,7 @@ declare interface operations {
|
|
|
1638
1791
|
[name: string]: unknown;
|
|
1639
1792
|
};
|
|
1640
1793
|
content: {
|
|
1641
|
-
|
|
1794
|
+
'application/json': components['schemas']['Error'];
|
|
1642
1795
|
};
|
|
1643
1796
|
};
|
|
1644
1797
|
/** @description File too large */
|
|
@@ -1647,7 +1800,7 @@ declare interface operations {
|
|
|
1647
1800
|
[name: string]: unknown;
|
|
1648
1801
|
};
|
|
1649
1802
|
content: {
|
|
1650
|
-
|
|
1803
|
+
'application/json': components['schemas']['Error'];
|
|
1651
1804
|
};
|
|
1652
1805
|
};
|
|
1653
1806
|
};
|
|
@@ -1673,7 +1826,7 @@ declare interface operations {
|
|
|
1673
1826
|
[name: string]: unknown;
|
|
1674
1827
|
};
|
|
1675
1828
|
content: {
|
|
1676
|
-
|
|
1829
|
+
'application/octet-stream': string;
|
|
1677
1830
|
};
|
|
1678
1831
|
};
|
|
1679
1832
|
/** @description Invalid parameters or file not exists */
|
|
@@ -1682,7 +1835,7 @@ declare interface operations {
|
|
|
1682
1835
|
[name: string]: unknown;
|
|
1683
1836
|
};
|
|
1684
1837
|
content: {
|
|
1685
|
-
|
|
1838
|
+
'application/json': components['schemas']['Error'];
|
|
1686
1839
|
};
|
|
1687
1840
|
};
|
|
1688
1841
|
};
|
|
@@ -1708,7 +1861,7 @@ declare interface operations {
|
|
|
1708
1861
|
[name: string]: unknown;
|
|
1709
1862
|
};
|
|
1710
1863
|
content: {
|
|
1711
|
-
|
|
1864
|
+
'application/json': components['schemas']['StorageList'];
|
|
1712
1865
|
};
|
|
1713
1866
|
};
|
|
1714
1867
|
/** @description Invalid parameters or directory does not exist */
|
|
@@ -1717,7 +1870,7 @@ declare interface operations {
|
|
|
1717
1870
|
[name: string]: unknown;
|
|
1718
1871
|
};
|
|
1719
1872
|
content: {
|
|
1720
|
-
|
|
1873
|
+
'application/json': components['schemas']['Error'];
|
|
1721
1874
|
};
|
|
1722
1875
|
};
|
|
1723
1876
|
};
|
|
@@ -1743,7 +1896,7 @@ declare interface operations {
|
|
|
1743
1896
|
[name: string]: unknown;
|
|
1744
1897
|
};
|
|
1745
1898
|
content: {
|
|
1746
|
-
|
|
1899
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1747
1900
|
};
|
|
1748
1901
|
};
|
|
1749
1902
|
/** @description Invalid path or deletion failed */
|
|
@@ -1752,7 +1905,7 @@ declare interface operations {
|
|
|
1752
1905
|
[name: string]: unknown;
|
|
1753
1906
|
};
|
|
1754
1907
|
content: {
|
|
1755
|
-
|
|
1908
|
+
'application/json': components['schemas']['Error'];
|
|
1756
1909
|
};
|
|
1757
1910
|
};
|
|
1758
1911
|
};
|
|
@@ -1778,7 +1931,7 @@ declare interface operations {
|
|
|
1778
1931
|
[name: string]: unknown;
|
|
1779
1932
|
};
|
|
1780
1933
|
content: {
|
|
1781
|
-
|
|
1934
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1782
1935
|
};
|
|
1783
1936
|
};
|
|
1784
1937
|
/** @description Invalid path or creation failed */
|
|
@@ -1787,7 +1940,47 @@ declare interface operations {
|
|
|
1787
1940
|
[name: string]: unknown;
|
|
1788
1941
|
};
|
|
1789
1942
|
content: {
|
|
1790
|
-
|
|
1943
|
+
'application/json': components['schemas']['Error'];
|
|
1944
|
+
};
|
|
1945
|
+
};
|
|
1946
|
+
};
|
|
1947
|
+
};
|
|
1948
|
+
RenameStorageFile: {
|
|
1949
|
+
parameters: {
|
|
1950
|
+
query: {
|
|
1951
|
+
/**
|
|
1952
|
+
* @description Old location path
|
|
1953
|
+
* @example /ext/old_name.txt
|
|
1954
|
+
*/
|
|
1955
|
+
path: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* @description New location path
|
|
1958
|
+
* @example /ext/new_name.txt
|
|
1959
|
+
*/
|
|
1960
|
+
new_path: string;
|
|
1961
|
+
};
|
|
1962
|
+
header?: never;
|
|
1963
|
+
path?: never;
|
|
1964
|
+
cookie?: never;
|
|
1965
|
+
};
|
|
1966
|
+
requestBody?: never;
|
|
1967
|
+
responses: {
|
|
1968
|
+
/** @description Renamed successfully */
|
|
1969
|
+
200: {
|
|
1970
|
+
headers: {
|
|
1971
|
+
[name: string]: unknown;
|
|
1972
|
+
};
|
|
1973
|
+
content: {
|
|
1974
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1975
|
+
};
|
|
1976
|
+
};
|
|
1977
|
+
/** @description Invalid path or operation failed */
|
|
1978
|
+
400: {
|
|
1979
|
+
headers: {
|
|
1980
|
+
[name: string]: unknown;
|
|
1981
|
+
};
|
|
1982
|
+
content: {
|
|
1983
|
+
'application/json': components['schemas']['Error'];
|
|
1791
1984
|
};
|
|
1792
1985
|
};
|
|
1793
1986
|
};
|
|
@@ -1807,7 +2000,7 @@ declare interface operations {
|
|
|
1807
2000
|
[name: string]: unknown;
|
|
1808
2001
|
};
|
|
1809
2002
|
content: {
|
|
1810
|
-
|
|
2003
|
+
'application/json': components['schemas']['StorageStatus'];
|
|
1811
2004
|
};
|
|
1812
2005
|
};
|
|
1813
2006
|
/** @description Invalid parameters or storage doesn't exist */
|
|
@@ -1816,7 +2009,7 @@ declare interface operations {
|
|
|
1816
2009
|
[name: string]: unknown;
|
|
1817
2010
|
};
|
|
1818
2011
|
content: {
|
|
1819
|
-
|
|
2012
|
+
'application/json': components['schemas']['Error'];
|
|
1820
2013
|
};
|
|
1821
2014
|
};
|
|
1822
2015
|
};
|
|
@@ -1830,7 +2023,7 @@ declare interface operations {
|
|
|
1830
2023
|
};
|
|
1831
2024
|
requestBody: {
|
|
1832
2025
|
content: {
|
|
1833
|
-
|
|
2026
|
+
'application/json': components['schemas']['DisplayElements'];
|
|
1834
2027
|
};
|
|
1835
2028
|
};
|
|
1836
2029
|
responses: {
|
|
@@ -1840,7 +2033,7 @@ declare interface operations {
|
|
|
1840
2033
|
[name: string]: unknown;
|
|
1841
2034
|
};
|
|
1842
2035
|
content: {
|
|
1843
|
-
|
|
2036
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1844
2037
|
};
|
|
1845
2038
|
};
|
|
1846
2039
|
/** @description Invalid drawing data */
|
|
@@ -1849,7 +2042,7 @@ declare interface operations {
|
|
|
1849
2042
|
[name: string]: unknown;
|
|
1850
2043
|
};
|
|
1851
2044
|
content: {
|
|
1852
|
-
|
|
2045
|
+
'application/json': components['schemas']['Error'];
|
|
1853
2046
|
};
|
|
1854
2047
|
};
|
|
1855
2048
|
/** @description Requested priority level is below that of currently active app */
|
|
@@ -1858,16 +2051,16 @@ declare interface operations {
|
|
|
1858
2051
|
[name: string]: unknown;
|
|
1859
2052
|
};
|
|
1860
2053
|
content: {
|
|
1861
|
-
|
|
2054
|
+
'application/json': components['schemas']['Error'];
|
|
1862
2055
|
};
|
|
1863
2056
|
};
|
|
1864
|
-
/** @description
|
|
1865
|
-
|
|
2057
|
+
/** @description Failed to load canvas app */
|
|
2058
|
+
503: {
|
|
1866
2059
|
headers: {
|
|
1867
2060
|
[name: string]: unknown;
|
|
1868
2061
|
};
|
|
1869
2062
|
content: {
|
|
1870
|
-
|
|
2063
|
+
'application/json': components['schemas']['Error'];
|
|
1871
2064
|
};
|
|
1872
2065
|
};
|
|
1873
2066
|
};
|
|
@@ -1879,7 +2072,7 @@ declare interface operations {
|
|
|
1879
2072
|
* @description Application identifier
|
|
1880
2073
|
* @example my_app
|
|
1881
2074
|
*/
|
|
1882
|
-
|
|
2075
|
+
application_name?: string;
|
|
1883
2076
|
};
|
|
1884
2077
|
header?: never;
|
|
1885
2078
|
path?: never;
|
|
@@ -1893,16 +2086,7 @@ declare interface operations {
|
|
|
1893
2086
|
[name: string]: unknown;
|
|
1894
2087
|
};
|
|
1895
2088
|
content: {
|
|
1896
|
-
|
|
1897
|
-
};
|
|
1898
|
-
};
|
|
1899
|
-
/** @description Display error */
|
|
1900
|
-
500: {
|
|
1901
|
-
headers: {
|
|
1902
|
-
[name: string]: unknown;
|
|
1903
|
-
};
|
|
1904
|
-
content: {
|
|
1905
|
-
"application/json": components["schemas"]["Error"];
|
|
2089
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1906
2090
|
};
|
|
1907
2091
|
};
|
|
1908
2092
|
};
|
|
@@ -1922,19 +2106,19 @@ declare interface operations {
|
|
|
1922
2106
|
[name: string]: unknown;
|
|
1923
2107
|
};
|
|
1924
2108
|
content: {
|
|
1925
|
-
|
|
2109
|
+
'application/json': components['schemas']['DisplayBrightnessInfo'];
|
|
1926
2110
|
};
|
|
1927
2111
|
};
|
|
1928
2112
|
};
|
|
1929
2113
|
};
|
|
1930
2114
|
setDisplayBrightness: {
|
|
1931
2115
|
parameters: {
|
|
1932
|
-
query
|
|
2116
|
+
query: {
|
|
1933
2117
|
/**
|
|
1934
2118
|
* @description Displays brightness (0-100/auto)
|
|
1935
2119
|
* @example 50
|
|
1936
2120
|
*/
|
|
1937
|
-
value
|
|
2121
|
+
value: string;
|
|
1938
2122
|
};
|
|
1939
2123
|
header?: never;
|
|
1940
2124
|
path?: never;
|
|
@@ -1948,7 +2132,7 @@ declare interface operations {
|
|
|
1948
2132
|
[name: string]: unknown;
|
|
1949
2133
|
};
|
|
1950
2134
|
content: {
|
|
1951
|
-
|
|
2135
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1952
2136
|
};
|
|
1953
2137
|
};
|
|
1954
2138
|
/** @description Invalid request data */
|
|
@@ -1957,7 +2141,7 @@ declare interface operations {
|
|
|
1957
2141
|
[name: string]: unknown;
|
|
1958
2142
|
};
|
|
1959
2143
|
content: {
|
|
1960
|
-
|
|
2144
|
+
'application/json': components['schemas']['Error'];
|
|
1961
2145
|
};
|
|
1962
2146
|
};
|
|
1963
2147
|
};
|
|
@@ -1969,7 +2153,7 @@ declare interface operations {
|
|
|
1969
2153
|
* @description Application ID for organizing assets
|
|
1970
2154
|
* @example my_app
|
|
1971
2155
|
*/
|
|
1972
|
-
|
|
2156
|
+
application_name: string;
|
|
1973
2157
|
/**
|
|
1974
2158
|
* @description Path to audio file within app's assets directory
|
|
1975
2159
|
* @example data.snd
|
|
@@ -1988,7 +2172,7 @@ declare interface operations {
|
|
|
1988
2172
|
[name: string]: unknown;
|
|
1989
2173
|
};
|
|
1990
2174
|
content: {
|
|
1991
|
-
|
|
2175
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
1992
2176
|
};
|
|
1993
2177
|
};
|
|
1994
2178
|
/** @description Invalid file path or file not found */
|
|
@@ -1997,7 +2181,7 @@ declare interface operations {
|
|
|
1997
2181
|
[name: string]: unknown;
|
|
1998
2182
|
};
|
|
1999
2183
|
content: {
|
|
2000
|
-
|
|
2184
|
+
'application/json': components['schemas']['Error'];
|
|
2001
2185
|
};
|
|
2002
2186
|
};
|
|
2003
2187
|
/** @description Audio system error */
|
|
@@ -2006,7 +2190,7 @@ declare interface operations {
|
|
|
2006
2190
|
[name: string]: unknown;
|
|
2007
2191
|
};
|
|
2008
2192
|
content: {
|
|
2009
|
-
|
|
2193
|
+
'application/json': components['schemas']['Error'];
|
|
2010
2194
|
};
|
|
2011
2195
|
};
|
|
2012
2196
|
};
|
|
@@ -2026,7 +2210,7 @@ declare interface operations {
|
|
|
2026
2210
|
[name: string]: unknown;
|
|
2027
2211
|
};
|
|
2028
2212
|
content: {
|
|
2029
|
-
|
|
2213
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2030
2214
|
};
|
|
2031
2215
|
};
|
|
2032
2216
|
/** @description Audio system error */
|
|
@@ -2035,7 +2219,7 @@ declare interface operations {
|
|
|
2035
2219
|
[name: string]: unknown;
|
|
2036
2220
|
};
|
|
2037
2221
|
content: {
|
|
2038
|
-
|
|
2222
|
+
'application/json': components['schemas']['Error'];
|
|
2039
2223
|
};
|
|
2040
2224
|
};
|
|
2041
2225
|
};
|
|
@@ -2055,7 +2239,7 @@ declare interface operations {
|
|
|
2055
2239
|
[name: string]: unknown;
|
|
2056
2240
|
};
|
|
2057
2241
|
content: {
|
|
2058
|
-
|
|
2242
|
+
'application/json': components['schemas']['AudioVolumeInfo'];
|
|
2059
2243
|
};
|
|
2060
2244
|
};
|
|
2061
2245
|
};
|
|
@@ -2081,7 +2265,7 @@ declare interface operations {
|
|
|
2081
2265
|
[name: string]: unknown;
|
|
2082
2266
|
};
|
|
2083
2267
|
content: {
|
|
2084
|
-
|
|
2268
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2085
2269
|
};
|
|
2086
2270
|
};
|
|
2087
2271
|
/** @description Invalid request data */
|
|
@@ -2090,7 +2274,7 @@ declare interface operations {
|
|
|
2090
2274
|
[name: string]: unknown;
|
|
2091
2275
|
};
|
|
2092
2276
|
content: {
|
|
2093
|
-
|
|
2277
|
+
'application/json': components['schemas']['Error'];
|
|
2094
2278
|
};
|
|
2095
2279
|
};
|
|
2096
2280
|
};
|
|
@@ -2117,7 +2301,7 @@ declare interface operations {
|
|
|
2117
2301
|
[name: string]: unknown;
|
|
2118
2302
|
};
|
|
2119
2303
|
content: {
|
|
2120
|
-
|
|
2304
|
+
'application/json': components['schemas']['Error'];
|
|
2121
2305
|
};
|
|
2122
2306
|
};
|
|
2123
2307
|
/** @description Upgrade required */
|
|
@@ -2126,7 +2310,7 @@ declare interface operations {
|
|
|
2126
2310
|
[name: string]: unknown;
|
|
2127
2311
|
};
|
|
2128
2312
|
content: {
|
|
2129
|
-
|
|
2313
|
+
'application/json': components['schemas']['Error'];
|
|
2130
2314
|
};
|
|
2131
2315
|
};
|
|
2132
2316
|
};
|
|
@@ -2138,7 +2322,7 @@ declare interface operations {
|
|
|
2138
2322
|
* @description Key name
|
|
2139
2323
|
* @example ok
|
|
2140
2324
|
*/
|
|
2141
|
-
key:
|
|
2325
|
+
key: 'up' | 'down' | 'ok' | 'back' | 'start' | 'busy' | 'custom' | 'off' | 'apps' | 'settings';
|
|
2142
2326
|
};
|
|
2143
2327
|
header?: never;
|
|
2144
2328
|
path?: never;
|
|
@@ -2152,7 +2336,7 @@ declare interface operations {
|
|
|
2152
2336
|
[name: string]: unknown;
|
|
2153
2337
|
};
|
|
2154
2338
|
content: {
|
|
2155
|
-
|
|
2339
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2156
2340
|
};
|
|
2157
2341
|
};
|
|
2158
2342
|
/** @description Invalid request data */
|
|
@@ -2161,7 +2345,7 @@ declare interface operations {
|
|
|
2161
2345
|
[name: string]: unknown;
|
|
2162
2346
|
};
|
|
2163
2347
|
content: {
|
|
2164
|
-
|
|
2348
|
+
'application/json': components['schemas']['Error'];
|
|
2165
2349
|
};
|
|
2166
2350
|
};
|
|
2167
2351
|
};
|
|
@@ -2181,7 +2365,7 @@ declare interface operations {
|
|
|
2181
2365
|
[name: string]: unknown;
|
|
2182
2366
|
};
|
|
2183
2367
|
content: {
|
|
2184
|
-
|
|
2368
|
+
'application/json': components['schemas']['Status'];
|
|
2185
2369
|
};
|
|
2186
2370
|
};
|
|
2187
2371
|
/** @description Internal server error */
|
|
@@ -2190,7 +2374,65 @@ declare interface operations {
|
|
|
2190
2374
|
[name: string]: unknown;
|
|
2191
2375
|
};
|
|
2192
2376
|
content: {
|
|
2193
|
-
|
|
2377
|
+
'application/json': components['schemas']['Error'];
|
|
2378
|
+
};
|
|
2379
|
+
};
|
|
2380
|
+
};
|
|
2381
|
+
};
|
|
2382
|
+
getStatusDevice: {
|
|
2383
|
+
parameters: {
|
|
2384
|
+
query?: never;
|
|
2385
|
+
header?: never;
|
|
2386
|
+
path?: never;
|
|
2387
|
+
cookie?: never;
|
|
2388
|
+
};
|
|
2389
|
+
requestBody?: never;
|
|
2390
|
+
responses: {
|
|
2391
|
+
/** @description Information retrieved successfully */
|
|
2392
|
+
200: {
|
|
2393
|
+
headers: {
|
|
2394
|
+
[name: string]: unknown;
|
|
2395
|
+
};
|
|
2396
|
+
content: {
|
|
2397
|
+
'application/json': components['schemas']['StatusDevice'];
|
|
2398
|
+
};
|
|
2399
|
+
};
|
|
2400
|
+
/** @description Internal server error */
|
|
2401
|
+
500: {
|
|
2402
|
+
headers: {
|
|
2403
|
+
[name: string]: unknown;
|
|
2404
|
+
};
|
|
2405
|
+
content: {
|
|
2406
|
+
'application/json': components['schemas']['Error'];
|
|
2407
|
+
};
|
|
2408
|
+
};
|
|
2409
|
+
};
|
|
2410
|
+
};
|
|
2411
|
+
getStatusFirmware: {
|
|
2412
|
+
parameters: {
|
|
2413
|
+
query?: never;
|
|
2414
|
+
header?: never;
|
|
2415
|
+
path?: never;
|
|
2416
|
+
cookie?: never;
|
|
2417
|
+
};
|
|
2418
|
+
requestBody?: never;
|
|
2419
|
+
responses: {
|
|
2420
|
+
/** @description Information retrieved successfully */
|
|
2421
|
+
200: {
|
|
2422
|
+
headers: {
|
|
2423
|
+
[name: string]: unknown;
|
|
2424
|
+
};
|
|
2425
|
+
content: {
|
|
2426
|
+
'application/json': components['schemas']['StatusFirmware'];
|
|
2427
|
+
};
|
|
2428
|
+
};
|
|
2429
|
+
/** @description Internal server error */
|
|
2430
|
+
500: {
|
|
2431
|
+
headers: {
|
|
2432
|
+
[name: string]: unknown;
|
|
2433
|
+
};
|
|
2434
|
+
content: {
|
|
2435
|
+
'application/json': components['schemas']['Error'];
|
|
2194
2436
|
};
|
|
2195
2437
|
};
|
|
2196
2438
|
};
|
|
@@ -2210,7 +2452,7 @@ declare interface operations {
|
|
|
2210
2452
|
[name: string]: unknown;
|
|
2211
2453
|
};
|
|
2212
2454
|
content: {
|
|
2213
|
-
|
|
2455
|
+
'application/json': components['schemas']['StatusSystem'];
|
|
2214
2456
|
};
|
|
2215
2457
|
};
|
|
2216
2458
|
/** @description Internal server error */
|
|
@@ -2219,7 +2461,7 @@ declare interface operations {
|
|
|
2219
2461
|
[name: string]: unknown;
|
|
2220
2462
|
};
|
|
2221
2463
|
content: {
|
|
2222
|
-
|
|
2464
|
+
'application/json': components['schemas']['Error'];
|
|
2223
2465
|
};
|
|
2224
2466
|
};
|
|
2225
2467
|
};
|
|
@@ -2239,21 +2481,48 @@ declare interface operations {
|
|
|
2239
2481
|
[name: string]: unknown;
|
|
2240
2482
|
};
|
|
2241
2483
|
content: {
|
|
2242
|
-
|
|
2484
|
+
'application/json': components['schemas']['StatusPower'];
|
|
2485
|
+
};
|
|
2486
|
+
};
|
|
2487
|
+
/** @description Internal server error */
|
|
2488
|
+
500: {
|
|
2489
|
+
headers: {
|
|
2490
|
+
[name: string]: unknown;
|
|
2491
|
+
};
|
|
2492
|
+
content: {
|
|
2493
|
+
'application/json': components['schemas']['Error'];
|
|
2494
|
+
};
|
|
2495
|
+
};
|
|
2496
|
+
};
|
|
2497
|
+
};
|
|
2498
|
+
connectWebSocket: {
|
|
2499
|
+
parameters: {
|
|
2500
|
+
query?: never;
|
|
2501
|
+
header?: never;
|
|
2502
|
+
path?: never;
|
|
2503
|
+
cookie?: never;
|
|
2504
|
+
};
|
|
2505
|
+
requestBody?: never;
|
|
2506
|
+
responses: {
|
|
2507
|
+
/** @description WebSocket connection established */
|
|
2508
|
+
101: {
|
|
2509
|
+
headers: {
|
|
2510
|
+
[name: string]: unknown;
|
|
2243
2511
|
};
|
|
2512
|
+
content?: never;
|
|
2244
2513
|
};
|
|
2245
|
-
/** @description
|
|
2246
|
-
|
|
2514
|
+
/** @description Exceed max clients count */
|
|
2515
|
+
400: {
|
|
2247
2516
|
headers: {
|
|
2248
2517
|
[name: string]: unknown;
|
|
2249
2518
|
};
|
|
2250
2519
|
content: {
|
|
2251
|
-
|
|
2520
|
+
'application/json': components['schemas']['Error'];
|
|
2252
2521
|
};
|
|
2253
2522
|
};
|
|
2254
2523
|
};
|
|
2255
2524
|
};
|
|
2256
|
-
|
|
2525
|
+
connectScreenWebSocket: {
|
|
2257
2526
|
parameters: {
|
|
2258
2527
|
query?: never;
|
|
2259
2528
|
header?: never;
|
|
@@ -2275,7 +2544,7 @@ declare interface operations {
|
|
|
2275
2544
|
[name: string]: unknown;
|
|
2276
2545
|
};
|
|
2277
2546
|
content: {
|
|
2278
|
-
|
|
2547
|
+
'application/json': components['schemas']['Error'];
|
|
2279
2548
|
};
|
|
2280
2549
|
};
|
|
2281
2550
|
};
|
|
@@ -2295,16 +2564,7 @@ declare interface operations {
|
|
|
2295
2564
|
[name: string]: unknown;
|
|
2296
2565
|
};
|
|
2297
2566
|
content: {
|
|
2298
|
-
|
|
2299
|
-
};
|
|
2300
|
-
};
|
|
2301
|
-
/** @description Bad request */
|
|
2302
|
-
400: {
|
|
2303
|
-
headers: {
|
|
2304
|
-
[name: string]: unknown;
|
|
2305
|
-
};
|
|
2306
|
-
content: {
|
|
2307
|
-
"application/json": components["schemas"]["Error"];
|
|
2567
|
+
'application/json': components['schemas']['TimestampInfo'];
|
|
2308
2568
|
};
|
|
2309
2569
|
};
|
|
2310
2570
|
};
|
|
@@ -2324,7 +2584,7 @@ declare interface operations {
|
|
|
2324
2584
|
[name: string]: unknown;
|
|
2325
2585
|
};
|
|
2326
2586
|
content: {
|
|
2327
|
-
|
|
2587
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2328
2588
|
};
|
|
2329
2589
|
};
|
|
2330
2590
|
};
|
|
@@ -2344,7 +2604,7 @@ declare interface operations {
|
|
|
2344
2604
|
[name: string]: unknown;
|
|
2345
2605
|
};
|
|
2346
2606
|
content: {
|
|
2347
|
-
|
|
2607
|
+
'application/json': components['schemas']['AccountLink'];
|
|
2348
2608
|
};
|
|
2349
2609
|
};
|
|
2350
2610
|
/** @description Bad request */
|
|
@@ -2353,7 +2613,7 @@ declare interface operations {
|
|
|
2353
2613
|
[name: string]: unknown;
|
|
2354
2614
|
};
|
|
2355
2615
|
content: {
|
|
2356
|
-
|
|
2616
|
+
'application/json': components['schemas']['Error'];
|
|
2357
2617
|
};
|
|
2358
2618
|
};
|
|
2359
2619
|
};
|
|
@@ -2373,12 +2633,12 @@ declare interface operations {
|
|
|
2373
2633
|
[name: string]: unknown;
|
|
2374
2634
|
};
|
|
2375
2635
|
content: {
|
|
2376
|
-
|
|
2636
|
+
'application/json': components['schemas']['AccountInfo'];
|
|
2377
2637
|
};
|
|
2378
2638
|
};
|
|
2379
2639
|
};
|
|
2380
2640
|
};
|
|
2381
|
-
|
|
2641
|
+
getAccountStatus: {
|
|
2382
2642
|
parameters: {
|
|
2383
2643
|
query?: never;
|
|
2384
2644
|
header?: never;
|
|
@@ -2393,7 +2653,7 @@ declare interface operations {
|
|
|
2393
2653
|
[name: string]: unknown;
|
|
2394
2654
|
};
|
|
2395
2655
|
content: {
|
|
2396
|
-
|
|
2656
|
+
'application/json': components['schemas']['AccountStatus'];
|
|
2397
2657
|
};
|
|
2398
2658
|
};
|
|
2399
2659
|
};
|
|
@@ -2413,7 +2673,7 @@ declare interface operations {
|
|
|
2413
2673
|
[name: string]: unknown;
|
|
2414
2674
|
};
|
|
2415
2675
|
content: {
|
|
2416
|
-
|
|
2676
|
+
'application/json': components['schemas']['AccountProfile'];
|
|
2417
2677
|
};
|
|
2418
2678
|
};
|
|
2419
2679
|
};
|
|
@@ -2422,7 +2682,7 @@ declare interface operations {
|
|
|
2422
2682
|
parameters: {
|
|
2423
2683
|
query: {
|
|
2424
2684
|
/** @example dev */
|
|
2425
|
-
profile:
|
|
2685
|
+
profile: 'dev' | 'prod' | 'local' | 'custom';
|
|
2426
2686
|
custom_url?: string;
|
|
2427
2687
|
};
|
|
2428
2688
|
header?: never;
|
|
@@ -2437,7 +2697,7 @@ declare interface operations {
|
|
|
2437
2697
|
[name: string]: unknown;
|
|
2438
2698
|
};
|
|
2439
2699
|
content: {
|
|
2440
|
-
|
|
2700
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2441
2701
|
};
|
|
2442
2702
|
};
|
|
2443
2703
|
/** @description Bad request */
|
|
@@ -2446,7 +2706,7 @@ declare interface operations {
|
|
|
2446
2706
|
[name: string]: unknown;
|
|
2447
2707
|
};
|
|
2448
2708
|
content: {
|
|
2449
|
-
|
|
2709
|
+
'application/json': components['schemas']['Error'];
|
|
2450
2710
|
};
|
|
2451
2711
|
};
|
|
2452
2712
|
};
|
|
@@ -2472,7 +2732,7 @@ declare interface operations {
|
|
|
2472
2732
|
[name: string]: unknown;
|
|
2473
2733
|
};
|
|
2474
2734
|
content: {
|
|
2475
|
-
|
|
2735
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2476
2736
|
};
|
|
2477
2737
|
};
|
|
2478
2738
|
/** @description Invalid timestamp format or value */
|
|
@@ -2481,7 +2741,7 @@ declare interface operations {
|
|
|
2481
2741
|
[name: string]: unknown;
|
|
2482
2742
|
};
|
|
2483
2743
|
content: {
|
|
2484
|
-
|
|
2744
|
+
'application/json': components['schemas']['Error'];
|
|
2485
2745
|
};
|
|
2486
2746
|
};
|
|
2487
2747
|
};
|
|
@@ -2501,7 +2761,7 @@ declare interface operations {
|
|
|
2501
2761
|
[name: string]: unknown;
|
|
2502
2762
|
};
|
|
2503
2763
|
content: {
|
|
2504
|
-
|
|
2764
|
+
'application/json': components['schemas']['TimezoneInfo'];
|
|
2505
2765
|
};
|
|
2506
2766
|
};
|
|
2507
2767
|
/** @description Invalid timezone offset */
|
|
@@ -2510,7 +2770,7 @@ declare interface operations {
|
|
|
2510
2770
|
[name: string]: unknown;
|
|
2511
2771
|
};
|
|
2512
2772
|
content: {
|
|
2513
|
-
|
|
2773
|
+
'application/json': components['schemas']['Error'];
|
|
2514
2774
|
};
|
|
2515
2775
|
};
|
|
2516
2776
|
};
|
|
@@ -2536,7 +2796,7 @@ declare interface operations {
|
|
|
2536
2796
|
[name: string]: unknown;
|
|
2537
2797
|
};
|
|
2538
2798
|
content: {
|
|
2539
|
-
|
|
2799
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2540
2800
|
};
|
|
2541
2801
|
};
|
|
2542
2802
|
/** @description Invalid timezone offset */
|
|
@@ -2545,7 +2805,7 @@ declare interface operations {
|
|
|
2545
2805
|
[name: string]: unknown;
|
|
2546
2806
|
};
|
|
2547
2807
|
content: {
|
|
2548
|
-
|
|
2808
|
+
'application/json': components['schemas']['Error'];
|
|
2549
2809
|
};
|
|
2550
2810
|
};
|
|
2551
2811
|
};
|
|
@@ -2565,7 +2825,7 @@ declare interface operations {
|
|
|
2565
2825
|
[name: string]: unknown;
|
|
2566
2826
|
};
|
|
2567
2827
|
content: {
|
|
2568
|
-
|
|
2828
|
+
'application/json': components['schemas']['TimezoneListResponse'];
|
|
2569
2829
|
};
|
|
2570
2830
|
};
|
|
2571
2831
|
/** @description Error getting time zone list */
|
|
@@ -2574,7 +2834,7 @@ declare interface operations {
|
|
|
2574
2834
|
[name: string]: unknown;
|
|
2575
2835
|
};
|
|
2576
2836
|
content: {
|
|
2577
|
-
|
|
2837
|
+
'application/json': components['schemas']['Error'];
|
|
2578
2838
|
};
|
|
2579
2839
|
};
|
|
2580
2840
|
};
|
|
@@ -2594,7 +2854,7 @@ declare interface operations {
|
|
|
2594
2854
|
[name: string]: unknown;
|
|
2595
2855
|
};
|
|
2596
2856
|
content: {
|
|
2597
|
-
|
|
2857
|
+
'application/json': components['schemas']['BusySnapshot'];
|
|
2598
2858
|
};
|
|
2599
2859
|
};
|
|
2600
2860
|
/** @description Error getting snapshot */
|
|
@@ -2603,7 +2863,7 @@ declare interface operations {
|
|
|
2603
2863
|
[name: string]: unknown;
|
|
2604
2864
|
};
|
|
2605
2865
|
content: {
|
|
2606
|
-
|
|
2866
|
+
'application/json': components['schemas']['Error'];
|
|
2607
2867
|
};
|
|
2608
2868
|
};
|
|
2609
2869
|
};
|
|
@@ -2617,7 +2877,7 @@ declare interface operations {
|
|
|
2617
2877
|
};
|
|
2618
2878
|
requestBody: {
|
|
2619
2879
|
content: {
|
|
2620
|
-
|
|
2880
|
+
'application/json': components['schemas']['BusySnapshot'];
|
|
2621
2881
|
};
|
|
2622
2882
|
};
|
|
2623
2883
|
responses: {
|
|
@@ -2627,7 +2887,7 @@ declare interface operations {
|
|
|
2627
2887
|
[name: string]: unknown;
|
|
2628
2888
|
};
|
|
2629
2889
|
content: {
|
|
2630
|
-
|
|
2890
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2631
2891
|
};
|
|
2632
2892
|
};
|
|
2633
2893
|
/** @description Error setting snapshot */
|
|
@@ -2636,12 +2896,78 @@ declare interface operations {
|
|
|
2636
2896
|
[name: string]: unknown;
|
|
2637
2897
|
};
|
|
2638
2898
|
content: {
|
|
2639
|
-
|
|
2899
|
+
'application/json': components['schemas']['Error'];
|
|
2900
|
+
};
|
|
2901
|
+
};
|
|
2902
|
+
};
|
|
2903
|
+
};
|
|
2904
|
+
getBusyProfile: {
|
|
2905
|
+
parameters: {
|
|
2906
|
+
query?: never;
|
|
2907
|
+
header?: never;
|
|
2908
|
+
path: {
|
|
2909
|
+
slot: components['schemas']['BusyProfileSlot'];
|
|
2910
|
+
};
|
|
2911
|
+
cookie?: never;
|
|
2912
|
+
};
|
|
2913
|
+
requestBody?: never;
|
|
2914
|
+
responses: {
|
|
2915
|
+
/** @description Got profile successfully */
|
|
2916
|
+
200: {
|
|
2917
|
+
headers: {
|
|
2918
|
+
[name: string]: unknown;
|
|
2919
|
+
};
|
|
2920
|
+
content: {
|
|
2921
|
+
'application/json': components['schemas']['BusyProfile'];
|
|
2922
|
+
};
|
|
2923
|
+
};
|
|
2924
|
+
/** @description Error getting profile */
|
|
2925
|
+
400: {
|
|
2926
|
+
headers: {
|
|
2927
|
+
[name: string]: unknown;
|
|
2928
|
+
};
|
|
2929
|
+
content: {
|
|
2930
|
+
'application/json': components['schemas']['Error'];
|
|
2931
|
+
};
|
|
2932
|
+
};
|
|
2933
|
+
};
|
|
2934
|
+
};
|
|
2935
|
+
setBusyProfile: {
|
|
2936
|
+
parameters: {
|
|
2937
|
+
query?: never;
|
|
2938
|
+
header?: never;
|
|
2939
|
+
path: {
|
|
2940
|
+
slot: components['schemas']['BusyProfileSlot'];
|
|
2941
|
+
};
|
|
2942
|
+
cookie?: never;
|
|
2943
|
+
};
|
|
2944
|
+
requestBody: {
|
|
2945
|
+
content: {
|
|
2946
|
+
'application/json': components['schemas']['BusyProfile'];
|
|
2947
|
+
};
|
|
2948
|
+
};
|
|
2949
|
+
responses: {
|
|
2950
|
+
/** @description Profile successfully set */
|
|
2951
|
+
200: {
|
|
2952
|
+
headers: {
|
|
2953
|
+
[name: string]: unknown;
|
|
2954
|
+
};
|
|
2955
|
+
content: {
|
|
2956
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2957
|
+
};
|
|
2958
|
+
};
|
|
2959
|
+
/** @description Error setting profile */
|
|
2960
|
+
400: {
|
|
2961
|
+
headers: {
|
|
2962
|
+
[name: string]: unknown;
|
|
2963
|
+
};
|
|
2964
|
+
content: {
|
|
2965
|
+
'application/json': components['schemas']['Error'];
|
|
2640
2966
|
};
|
|
2641
2967
|
};
|
|
2642
2968
|
};
|
|
2643
2969
|
};
|
|
2644
|
-
|
|
2970
|
+
getSmartHomeCommissioningStatus: {
|
|
2645
2971
|
parameters: {
|
|
2646
2972
|
query?: never;
|
|
2647
2973
|
header?: never;
|
|
@@ -2650,18 +2976,18 @@ declare interface operations {
|
|
|
2650
2976
|
};
|
|
2651
2977
|
requestBody?: never;
|
|
2652
2978
|
responses: {
|
|
2653
|
-
/** @description Successfully got
|
|
2979
|
+
/** @description Successfully got smart home commissioning status */
|
|
2654
2980
|
200: {
|
|
2655
2981
|
headers: {
|
|
2656
2982
|
[name: string]: unknown;
|
|
2657
2983
|
};
|
|
2658
2984
|
content: {
|
|
2659
|
-
|
|
2985
|
+
'application/json': components['schemas']['SmartHomePairingInfo'];
|
|
2660
2986
|
};
|
|
2661
2987
|
};
|
|
2662
2988
|
};
|
|
2663
2989
|
};
|
|
2664
|
-
|
|
2990
|
+
startSmartHomePairing: {
|
|
2665
2991
|
parameters: {
|
|
2666
2992
|
query?: never;
|
|
2667
2993
|
header?: never;
|
|
@@ -2670,22 +2996,22 @@ declare interface operations {
|
|
|
2670
2996
|
};
|
|
2671
2997
|
requestBody?: never;
|
|
2672
2998
|
responses: {
|
|
2673
|
-
/** @description Successfully started
|
|
2999
|
+
/** @description Successfully started smart home pairing */
|
|
2674
3000
|
200: {
|
|
2675
3001
|
headers: {
|
|
2676
3002
|
[name: string]: unknown;
|
|
2677
3003
|
};
|
|
2678
3004
|
content: {
|
|
2679
|
-
|
|
3005
|
+
'application/json': components['schemas']['SmartHomePairingPayload'];
|
|
2680
3006
|
};
|
|
2681
3007
|
};
|
|
2682
|
-
/** @description Internal
|
|
3008
|
+
/** @description Internal smart home service is broken */
|
|
2683
3009
|
503: {
|
|
2684
3010
|
headers: {
|
|
2685
3011
|
[name: string]: unknown;
|
|
2686
3012
|
};
|
|
2687
3013
|
content: {
|
|
2688
|
-
|
|
3014
|
+
'application/json': components['schemas']['Error'];
|
|
2689
3015
|
};
|
|
2690
3016
|
};
|
|
2691
3017
|
};
|
|
@@ -2697,7 +3023,7 @@ declare interface operations {
|
|
|
2697
3023
|
* Do not make direct changes to the file.
|
|
2698
3024
|
*/
|
|
2699
3025
|
declare interface paths {
|
|
2700
|
-
|
|
3026
|
+
'/version': {
|
|
2701
3027
|
parameters: {
|
|
2702
3028
|
query?: never;
|
|
2703
3029
|
header?: never;
|
|
@@ -2708,7 +3034,7 @@ declare interface paths {
|
|
|
2708
3034
|
* Get API version information
|
|
2709
3035
|
* @description Retrieves API version
|
|
2710
3036
|
*/
|
|
2711
|
-
get: operations[
|
|
3037
|
+
get: operations['getVersion'];
|
|
2712
3038
|
put?: never;
|
|
2713
3039
|
post?: never;
|
|
2714
3040
|
delete?: never;
|
|
@@ -2717,7 +3043,7 @@ declare interface paths {
|
|
|
2717
3043
|
patch?: never;
|
|
2718
3044
|
trace?: never;
|
|
2719
3045
|
};
|
|
2720
|
-
|
|
3046
|
+
'/access': {
|
|
2721
3047
|
parameters: {
|
|
2722
3048
|
query?: never;
|
|
2723
3049
|
header?: never;
|
|
@@ -2728,20 +3054,20 @@ declare interface paths {
|
|
|
2728
3054
|
* Get HTTP API access over Wi-Fi configuration
|
|
2729
3055
|
* @description Get HTTP API access over Wi-Fi configuration
|
|
2730
3056
|
*/
|
|
2731
|
-
get: operations[
|
|
3057
|
+
get: operations['getHttpAccess'];
|
|
2732
3058
|
put?: never;
|
|
2733
3059
|
/**
|
|
2734
3060
|
* Set HTTP API access over Wi-Fi configuration
|
|
2735
3061
|
* @description Set HTTP API access over Wi-Fi configuration
|
|
2736
3062
|
*/
|
|
2737
|
-
post: operations[
|
|
3063
|
+
post: operations['setHttpAccess'];
|
|
2738
3064
|
delete?: never;
|
|
2739
3065
|
options?: never;
|
|
2740
3066
|
head?: never;
|
|
2741
3067
|
patch?: never;
|
|
2742
3068
|
trace?: never;
|
|
2743
3069
|
};
|
|
2744
|
-
|
|
3070
|
+
'/name': {
|
|
2745
3071
|
parameters: {
|
|
2746
3072
|
query?: never;
|
|
2747
3073
|
header?: never;
|
|
@@ -2767,7 +3093,7 @@ declare interface paths {
|
|
|
2767
3093
|
[name: string]: unknown;
|
|
2768
3094
|
};
|
|
2769
3095
|
content: {
|
|
2770
|
-
|
|
3096
|
+
'application/json': components['schemas']['NameInfo'];
|
|
2771
3097
|
};
|
|
2772
3098
|
};
|
|
2773
3099
|
};
|
|
@@ -2786,7 +3112,7 @@ declare interface paths {
|
|
|
2786
3112
|
};
|
|
2787
3113
|
requestBody: {
|
|
2788
3114
|
content: {
|
|
2789
|
-
|
|
3115
|
+
'application/json': components['schemas']['NameInfo'];
|
|
2790
3116
|
};
|
|
2791
3117
|
};
|
|
2792
3118
|
responses: {
|
|
@@ -2796,7 +3122,7 @@ declare interface paths {
|
|
|
2796
3122
|
[name: string]: unknown;
|
|
2797
3123
|
};
|
|
2798
3124
|
content: {
|
|
2799
|
-
|
|
3125
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
2800
3126
|
};
|
|
2801
3127
|
};
|
|
2802
3128
|
/** @description Invalid name parameter, or failed to store new name */
|
|
@@ -2805,7 +3131,7 @@ declare interface paths {
|
|
|
2805
3131
|
[name: string]: unknown;
|
|
2806
3132
|
};
|
|
2807
3133
|
content: {
|
|
2808
|
-
|
|
3134
|
+
'application/json': components['schemas']['Error'];
|
|
2809
3135
|
};
|
|
2810
3136
|
};
|
|
2811
3137
|
};
|
|
@@ -2816,7 +3142,7 @@ declare interface paths {
|
|
|
2816
3142
|
patch?: never;
|
|
2817
3143
|
trace?: never;
|
|
2818
3144
|
};
|
|
2819
|
-
|
|
3145
|
+
'/update': {
|
|
2820
3146
|
parameters: {
|
|
2821
3147
|
query?: never;
|
|
2822
3148
|
header?: never;
|
|
@@ -2829,14 +3155,14 @@ declare interface paths {
|
|
|
2829
3155
|
* Update firmware
|
|
2830
3156
|
* @description Uploads a firmware update package (TAR file) and initiates the update process.
|
|
2831
3157
|
*/
|
|
2832
|
-
post: operations[
|
|
3158
|
+
post: operations['updateFirmware'];
|
|
2833
3159
|
delete?: never;
|
|
2834
3160
|
options?: never;
|
|
2835
3161
|
head?: never;
|
|
2836
3162
|
patch?: never;
|
|
2837
3163
|
trace?: never;
|
|
2838
3164
|
};
|
|
2839
|
-
|
|
3165
|
+
'/update/check': {
|
|
2840
3166
|
parameters: {
|
|
2841
3167
|
query?: never;
|
|
2842
3168
|
header?: never;
|
|
@@ -2849,14 +3175,14 @@ declare interface paths {
|
|
|
2849
3175
|
* Start firmware update check
|
|
2850
3176
|
* @description Initiates an asynchronous check for available firmware updates.
|
|
2851
3177
|
*/
|
|
2852
|
-
post: operations[
|
|
3178
|
+
post: operations['checkFirmwareUpdate'];
|
|
2853
3179
|
delete?: never;
|
|
2854
3180
|
options?: never;
|
|
2855
3181
|
head?: never;
|
|
2856
3182
|
patch?: never;
|
|
2857
3183
|
trace?: never;
|
|
2858
3184
|
};
|
|
2859
|
-
|
|
3185
|
+
'/update/status': {
|
|
2860
3186
|
parameters: {
|
|
2861
3187
|
query?: never;
|
|
2862
3188
|
header?: never;
|
|
@@ -2867,7 +3193,7 @@ declare interface paths {
|
|
|
2867
3193
|
* Get firmware update status
|
|
2868
3194
|
* @description Returns current update and check status including progress information.
|
|
2869
3195
|
*/
|
|
2870
|
-
get: operations[
|
|
3196
|
+
get: operations['getFirmwareUpdateStatus'];
|
|
2871
3197
|
put?: never;
|
|
2872
3198
|
post?: never;
|
|
2873
3199
|
delete?: never;
|
|
@@ -2876,7 +3202,7 @@ declare interface paths {
|
|
|
2876
3202
|
patch?: never;
|
|
2877
3203
|
trace?: never;
|
|
2878
3204
|
};
|
|
2879
|
-
|
|
3205
|
+
'/update/changelog': {
|
|
2880
3206
|
parameters: {
|
|
2881
3207
|
query?: never;
|
|
2882
3208
|
header?: never;
|
|
@@ -2887,7 +3213,7 @@ declare interface paths {
|
|
|
2887
3213
|
* Get update changelog
|
|
2888
3214
|
* @description Returns the changelog for a specific firmware version.
|
|
2889
3215
|
*/
|
|
2890
|
-
get: operations[
|
|
3216
|
+
get: operations['getUpdateChangelog'];
|
|
2891
3217
|
put?: never;
|
|
2892
3218
|
post?: never;
|
|
2893
3219
|
delete?: never;
|
|
@@ -2896,7 +3222,7 @@ declare interface paths {
|
|
|
2896
3222
|
patch?: never;
|
|
2897
3223
|
trace?: never;
|
|
2898
3224
|
};
|
|
2899
|
-
|
|
3225
|
+
'/update/install': {
|
|
2900
3226
|
parameters: {
|
|
2901
3227
|
query?: never;
|
|
2902
3228
|
header?: never;
|
|
@@ -2910,15 +3236,16 @@ declare interface paths {
|
|
|
2910
3236
|
* @description Starts asynchronous firmware installation from a remote URL.
|
|
2911
3237
|
* The update process (download, SHA verification, unpack, prepare, reboot) runs in the background.
|
|
2912
3238
|
* Use /update/status to monitor progress.
|
|
3239
|
+
*
|
|
2913
3240
|
*/
|
|
2914
|
-
post: operations[
|
|
3241
|
+
post: operations['installFirmwareUpdate'];
|
|
2915
3242
|
delete?: never;
|
|
2916
3243
|
options?: never;
|
|
2917
3244
|
head?: never;
|
|
2918
3245
|
patch?: never;
|
|
2919
3246
|
trace?: never;
|
|
2920
3247
|
};
|
|
2921
|
-
|
|
3248
|
+
'/update/abort_download': {
|
|
2922
3249
|
parameters: {
|
|
2923
3250
|
query?: never;
|
|
2924
3251
|
header?: never;
|
|
@@ -2931,14 +3258,38 @@ declare interface paths {
|
|
|
2931
3258
|
* Abort ongoing firmware download
|
|
2932
3259
|
* @description Signals the updater to abort an ongoing download operation.
|
|
2933
3260
|
*/
|
|
2934
|
-
post: operations[
|
|
3261
|
+
post: operations['abortFirmwareDownload'];
|
|
3262
|
+
delete?: never;
|
|
3263
|
+
options?: never;
|
|
3264
|
+
head?: never;
|
|
3265
|
+
patch?: never;
|
|
3266
|
+
trace?: never;
|
|
3267
|
+
};
|
|
3268
|
+
'/update/autoupdate': {
|
|
3269
|
+
parameters: {
|
|
3270
|
+
query?: never;
|
|
3271
|
+
header?: never;
|
|
3272
|
+
path?: never;
|
|
3273
|
+
cookie?: never;
|
|
3274
|
+
};
|
|
3275
|
+
/**
|
|
3276
|
+
* Get autoupdate settings
|
|
3277
|
+
* @description Returns current autoupdate configuration
|
|
3278
|
+
*/
|
|
3279
|
+
get: operations['getAutoupdateSettings'];
|
|
3280
|
+
put?: never;
|
|
3281
|
+
/**
|
|
3282
|
+
* Set autoupdate settings
|
|
3283
|
+
* @description Updates autoupdate configuration. All fields are optional - only provided fields are updated.
|
|
3284
|
+
*/
|
|
3285
|
+
post: operations['setAutoupdateSettings'];
|
|
2935
3286
|
delete?: never;
|
|
2936
3287
|
options?: never;
|
|
2937
3288
|
head?: never;
|
|
2938
3289
|
patch?: never;
|
|
2939
3290
|
trace?: never;
|
|
2940
3291
|
};
|
|
2941
|
-
|
|
3292
|
+
'/assets/upload': {
|
|
2942
3293
|
parameters: {
|
|
2943
3294
|
query?: never;
|
|
2944
3295
|
header?: never;
|
|
@@ -2951,18 +3302,18 @@ declare interface paths {
|
|
|
2951
3302
|
* Upload asset file with app ID
|
|
2952
3303
|
* @description Uploads a file to a specific app's assets directory
|
|
2953
3304
|
*/
|
|
2954
|
-
post: operations[
|
|
3305
|
+
post: operations['uploadAssetWithAppId'];
|
|
2955
3306
|
/**
|
|
2956
3307
|
* Delete app assets
|
|
2957
3308
|
* @description Deletes all assets for a specific app ID
|
|
2958
3309
|
*/
|
|
2959
|
-
delete: operations[
|
|
3310
|
+
delete: operations['deleteAppAssets'];
|
|
2960
3311
|
options?: never;
|
|
2961
3312
|
head?: never;
|
|
2962
3313
|
patch?: never;
|
|
2963
3314
|
trace?: never;
|
|
2964
3315
|
};
|
|
2965
|
-
|
|
3316
|
+
'/storage/write': {
|
|
2966
3317
|
parameters: {
|
|
2967
3318
|
query?: never;
|
|
2968
3319
|
header?: never;
|
|
@@ -2975,14 +3326,14 @@ declare interface paths {
|
|
|
2975
3326
|
* Upload file to internal storage
|
|
2976
3327
|
* @description Uploads a file to a specified path
|
|
2977
3328
|
*/
|
|
2978
|
-
post: operations[
|
|
3329
|
+
post: operations['writeStorageFile'];
|
|
2979
3330
|
delete?: never;
|
|
2980
3331
|
options?: never;
|
|
2981
3332
|
head?: never;
|
|
2982
3333
|
patch?: never;
|
|
2983
3334
|
trace?: never;
|
|
2984
3335
|
};
|
|
2985
|
-
|
|
3336
|
+
'/storage/read': {
|
|
2986
3337
|
parameters: {
|
|
2987
3338
|
query?: never;
|
|
2988
3339
|
header?: never;
|
|
@@ -2993,7 +3344,7 @@ declare interface paths {
|
|
|
2993
3344
|
* Download file from internal storage
|
|
2994
3345
|
* @description Downloads a file from a specified path
|
|
2995
3346
|
*/
|
|
2996
|
-
get: operations[
|
|
3347
|
+
get: operations['readStorageFile'];
|
|
2997
3348
|
put?: never;
|
|
2998
3349
|
post?: never;
|
|
2999
3350
|
delete?: never;
|
|
@@ -3002,7 +3353,7 @@ declare interface paths {
|
|
|
3002
3353
|
patch?: never;
|
|
3003
3354
|
trace?: never;
|
|
3004
3355
|
};
|
|
3005
|
-
|
|
3356
|
+
'/storage/list': {
|
|
3006
3357
|
parameters: {
|
|
3007
3358
|
query?: never;
|
|
3008
3359
|
header?: never;
|
|
@@ -3010,7 +3361,7 @@ declare interface paths {
|
|
|
3010
3361
|
cookie?: never;
|
|
3011
3362
|
};
|
|
3012
3363
|
/** List files on internal storage */
|
|
3013
|
-
get: operations[
|
|
3364
|
+
get: operations['listStorageFiles'];
|
|
3014
3365
|
put?: never;
|
|
3015
3366
|
post?: never;
|
|
3016
3367
|
delete?: never;
|
|
@@ -3019,7 +3370,7 @@ declare interface paths {
|
|
|
3019
3370
|
patch?: never;
|
|
3020
3371
|
trace?: never;
|
|
3021
3372
|
};
|
|
3022
|
-
|
|
3373
|
+
'/storage/remove': {
|
|
3023
3374
|
parameters: {
|
|
3024
3375
|
query?: never;
|
|
3025
3376
|
header?: never;
|
|
@@ -3033,13 +3384,13 @@ declare interface paths {
|
|
|
3033
3384
|
* Remove a file on internal storage
|
|
3034
3385
|
* @description Removes a file with a specified path
|
|
3035
3386
|
*/
|
|
3036
|
-
delete: operations[
|
|
3387
|
+
delete: operations['removeStorageFile'];
|
|
3037
3388
|
options?: never;
|
|
3038
3389
|
head?: never;
|
|
3039
3390
|
patch?: never;
|
|
3040
3391
|
trace?: never;
|
|
3041
3392
|
};
|
|
3042
|
-
|
|
3393
|
+
'/storage/mkdir': {
|
|
3043
3394
|
parameters: {
|
|
3044
3395
|
query?: never;
|
|
3045
3396
|
header?: never;
|
|
@@ -3052,14 +3403,34 @@ declare interface paths {
|
|
|
3052
3403
|
* Create a directory on internal storage
|
|
3053
3404
|
* @description Creates a new directory with a specified path
|
|
3054
3405
|
*/
|
|
3055
|
-
post: operations[
|
|
3406
|
+
post: operations['createStorageDir'];
|
|
3407
|
+
delete?: never;
|
|
3408
|
+
options?: never;
|
|
3409
|
+
head?: never;
|
|
3410
|
+
patch?: never;
|
|
3411
|
+
trace?: never;
|
|
3412
|
+
};
|
|
3413
|
+
'/storage/rename': {
|
|
3414
|
+
parameters: {
|
|
3415
|
+
query?: never;
|
|
3416
|
+
header?: never;
|
|
3417
|
+
path?: never;
|
|
3418
|
+
cookie?: never;
|
|
3419
|
+
};
|
|
3420
|
+
get?: never;
|
|
3421
|
+
put?: never;
|
|
3422
|
+
/**
|
|
3423
|
+
* Rename/move a file
|
|
3424
|
+
* @description Moves a file to a new location
|
|
3425
|
+
*/
|
|
3426
|
+
post: operations['RenameStorageFile'];
|
|
3056
3427
|
delete?: never;
|
|
3057
3428
|
options?: never;
|
|
3058
3429
|
head?: never;
|
|
3059
3430
|
patch?: never;
|
|
3060
3431
|
trace?: never;
|
|
3061
3432
|
};
|
|
3062
|
-
|
|
3433
|
+
'/storage/status': {
|
|
3063
3434
|
parameters: {
|
|
3064
3435
|
query?: never;
|
|
3065
3436
|
header?: never;
|
|
@@ -3067,7 +3438,7 @@ declare interface paths {
|
|
|
3067
3438
|
cookie?: never;
|
|
3068
3439
|
};
|
|
3069
3440
|
/** Show storage usage */
|
|
3070
|
-
get: operations[
|
|
3441
|
+
get: operations['getStorageStatus'];
|
|
3071
3442
|
put?: never;
|
|
3072
3443
|
post?: never;
|
|
3073
3444
|
delete?: never;
|
|
@@ -3076,7 +3447,7 @@ declare interface paths {
|
|
|
3076
3447
|
patch?: never;
|
|
3077
3448
|
trace?: never;
|
|
3078
3449
|
};
|
|
3079
|
-
|
|
3450
|
+
'/display/draw': {
|
|
3080
3451
|
parameters: {
|
|
3081
3452
|
query?: never;
|
|
3082
3453
|
header?: never;
|
|
@@ -3089,19 +3460,20 @@ declare interface paths {
|
|
|
3089
3460
|
* Draw on display
|
|
3090
3461
|
* @description Sends drawing data to the display.
|
|
3091
3462
|
* Supports JSON-defined display elements.
|
|
3463
|
+
*
|
|
3092
3464
|
*/
|
|
3093
|
-
post: operations[
|
|
3465
|
+
post: operations['drawOnDisplay'];
|
|
3094
3466
|
/**
|
|
3095
3467
|
* Clear display
|
|
3096
|
-
* @description
|
|
3468
|
+
* @description Deletes display elements drawn by the Canvas application. If application_name is specified, only elements for that app are removed.
|
|
3097
3469
|
*/
|
|
3098
|
-
delete: operations[
|
|
3470
|
+
delete: operations['clearDisplay'];
|
|
3099
3471
|
options?: never;
|
|
3100
3472
|
head?: never;
|
|
3101
3473
|
patch?: never;
|
|
3102
3474
|
trace?: never;
|
|
3103
3475
|
};
|
|
3104
|
-
|
|
3476
|
+
'/display/brightness': {
|
|
3105
3477
|
parameters: {
|
|
3106
3478
|
query?: never;
|
|
3107
3479
|
header?: never;
|
|
@@ -3112,20 +3484,21 @@ declare interface paths {
|
|
|
3112
3484
|
* Get display brightness
|
|
3113
3485
|
* @description Get brightness value for displays
|
|
3114
3486
|
*/
|
|
3115
|
-
get: operations[
|
|
3487
|
+
get: operations['getDisplayBrightness'];
|
|
3116
3488
|
put?: never;
|
|
3117
3489
|
/**
|
|
3118
3490
|
* Set display brightness
|
|
3119
3491
|
* @description Set brightness for one or both displays
|
|
3492
|
+
*
|
|
3120
3493
|
*/
|
|
3121
|
-
post: operations[
|
|
3494
|
+
post: operations['setDisplayBrightness'];
|
|
3122
3495
|
delete?: never;
|
|
3123
3496
|
options?: never;
|
|
3124
3497
|
head?: never;
|
|
3125
3498
|
patch?: never;
|
|
3126
3499
|
trace?: never;
|
|
3127
3500
|
};
|
|
3128
|
-
|
|
3501
|
+
'/audio/play': {
|
|
3129
3502
|
parameters: {
|
|
3130
3503
|
query?: never;
|
|
3131
3504
|
header?: never;
|
|
@@ -3138,19 +3511,20 @@ declare interface paths {
|
|
|
3138
3511
|
* Play audio file
|
|
3139
3512
|
* @description Plays an audio file from the assets directory.
|
|
3140
3513
|
* Supported formats include .snd files.
|
|
3514
|
+
*
|
|
3141
3515
|
*/
|
|
3142
|
-
post: operations[
|
|
3516
|
+
post: operations['playAudio'];
|
|
3143
3517
|
/**
|
|
3144
3518
|
* Stop audio playback
|
|
3145
3519
|
* @description Stops any currently playing audio
|
|
3146
3520
|
*/
|
|
3147
|
-
delete: operations[
|
|
3521
|
+
delete: operations['stopAudio'];
|
|
3148
3522
|
options?: never;
|
|
3149
3523
|
head?: never;
|
|
3150
3524
|
patch?: never;
|
|
3151
3525
|
trace?: never;
|
|
3152
3526
|
};
|
|
3153
|
-
|
|
3527
|
+
'/audio/volume': {
|
|
3154
3528
|
parameters: {
|
|
3155
3529
|
query?: never;
|
|
3156
3530
|
header?: never;
|
|
@@ -3161,20 +3535,20 @@ declare interface paths {
|
|
|
3161
3535
|
* Get audio volume
|
|
3162
3536
|
* @description Get audio volume value
|
|
3163
3537
|
*/
|
|
3164
|
-
get: operations[
|
|
3538
|
+
get: operations['getAudioVolume'];
|
|
3165
3539
|
put?: never;
|
|
3166
3540
|
/**
|
|
3167
3541
|
* Set audio volume
|
|
3168
3542
|
* @description Set audio volume value
|
|
3169
3543
|
*/
|
|
3170
|
-
post: operations[
|
|
3544
|
+
post: operations['setAudioVolume'];
|
|
3171
3545
|
delete?: never;
|
|
3172
3546
|
options?: never;
|
|
3173
3547
|
head?: never;
|
|
3174
3548
|
patch?: never;
|
|
3175
3549
|
trace?: never;
|
|
3176
3550
|
};
|
|
3177
|
-
|
|
3551
|
+
'/input': {
|
|
3178
3552
|
parameters: {
|
|
3179
3553
|
query?: never;
|
|
3180
3554
|
header?: never;
|
|
@@ -3185,20 +3559,20 @@ declare interface paths {
|
|
|
3185
3559
|
* Input events streaming
|
|
3186
3560
|
* @description Start WebSocket session for input events streaming
|
|
3187
3561
|
*/
|
|
3188
|
-
get: operations[
|
|
3562
|
+
get: operations['connectInputWebSocket'];
|
|
3189
3563
|
put?: never;
|
|
3190
3564
|
/**
|
|
3191
3565
|
* Send input event
|
|
3192
3566
|
* @description Send single key press event
|
|
3193
3567
|
*/
|
|
3194
|
-
post: operations[
|
|
3568
|
+
post: operations['setInputKey'];
|
|
3195
3569
|
delete?: never;
|
|
3196
3570
|
options?: never;
|
|
3197
3571
|
head?: never;
|
|
3198
3572
|
patch?: never;
|
|
3199
3573
|
trace?: never;
|
|
3200
3574
|
};
|
|
3201
|
-
|
|
3575
|
+
'/status': {
|
|
3202
3576
|
parameters: {
|
|
3203
3577
|
query?: never;
|
|
3204
3578
|
header?: never;
|
|
@@ -3209,7 +3583,47 @@ declare interface paths {
|
|
|
3209
3583
|
* Get device status
|
|
3210
3584
|
* @description Get device status
|
|
3211
3585
|
*/
|
|
3212
|
-
get: operations[
|
|
3586
|
+
get: operations['getStatus'];
|
|
3587
|
+
put?: never;
|
|
3588
|
+
post?: never;
|
|
3589
|
+
delete?: never;
|
|
3590
|
+
options?: never;
|
|
3591
|
+
head?: never;
|
|
3592
|
+
patch?: never;
|
|
3593
|
+
trace?: never;
|
|
3594
|
+
};
|
|
3595
|
+
'/status/device': {
|
|
3596
|
+
parameters: {
|
|
3597
|
+
query?: never;
|
|
3598
|
+
header?: never;
|
|
3599
|
+
path?: never;
|
|
3600
|
+
cookie?: never;
|
|
3601
|
+
};
|
|
3602
|
+
/**
|
|
3603
|
+
* Get device info
|
|
3604
|
+
* @description Get device info
|
|
3605
|
+
*/
|
|
3606
|
+
get: operations['getStatusDevice'];
|
|
3607
|
+
put?: never;
|
|
3608
|
+
post?: never;
|
|
3609
|
+
delete?: never;
|
|
3610
|
+
options?: never;
|
|
3611
|
+
head?: never;
|
|
3612
|
+
patch?: never;
|
|
3613
|
+
trace?: never;
|
|
3614
|
+
};
|
|
3615
|
+
'/status/firmware': {
|
|
3616
|
+
parameters: {
|
|
3617
|
+
query?: never;
|
|
3618
|
+
header?: never;
|
|
3619
|
+
path?: never;
|
|
3620
|
+
cookie?: never;
|
|
3621
|
+
};
|
|
3622
|
+
/**
|
|
3623
|
+
* Get firmware info
|
|
3624
|
+
* @description Get firmware info
|
|
3625
|
+
*/
|
|
3626
|
+
get: operations['getStatusFirmware'];
|
|
3213
3627
|
put?: never;
|
|
3214
3628
|
post?: never;
|
|
3215
3629
|
delete?: never;
|
|
@@ -3218,7 +3632,7 @@ declare interface paths {
|
|
|
3218
3632
|
patch?: never;
|
|
3219
3633
|
trace?: never;
|
|
3220
3634
|
};
|
|
3221
|
-
|
|
3635
|
+
'/status/system': {
|
|
3222
3636
|
parameters: {
|
|
3223
3637
|
query?: never;
|
|
3224
3638
|
header?: never;
|
|
@@ -3229,7 +3643,7 @@ declare interface paths {
|
|
|
3229
3643
|
* Get system status
|
|
3230
3644
|
* @description Get system status
|
|
3231
3645
|
*/
|
|
3232
|
-
get: operations[
|
|
3646
|
+
get: operations['getStatusSystem'];
|
|
3233
3647
|
put?: never;
|
|
3234
3648
|
post?: never;
|
|
3235
3649
|
delete?: never;
|
|
@@ -3238,7 +3652,7 @@ declare interface paths {
|
|
|
3238
3652
|
patch?: never;
|
|
3239
3653
|
trace?: never;
|
|
3240
3654
|
};
|
|
3241
|
-
|
|
3655
|
+
'/status/power': {
|
|
3242
3656
|
parameters: {
|
|
3243
3657
|
query?: never;
|
|
3244
3658
|
header?: never;
|
|
@@ -3249,7 +3663,30 @@ declare interface paths {
|
|
|
3249
3663
|
* Get power status
|
|
3250
3664
|
* @description Get power status
|
|
3251
3665
|
*/
|
|
3252
|
-
get: operations[
|
|
3666
|
+
get: operations['getStatusPower'];
|
|
3667
|
+
put?: never;
|
|
3668
|
+
post?: never;
|
|
3669
|
+
delete?: never;
|
|
3670
|
+
options?: never;
|
|
3671
|
+
head?: never;
|
|
3672
|
+
patch?: never;
|
|
3673
|
+
trace?: never;
|
|
3674
|
+
};
|
|
3675
|
+
'/status/ws': {
|
|
3676
|
+
parameters: {
|
|
3677
|
+
query?: never;
|
|
3678
|
+
header?: never;
|
|
3679
|
+
path?: never;
|
|
3680
|
+
cookie?: never;
|
|
3681
|
+
};
|
|
3682
|
+
/**
|
|
3683
|
+
* Device status streaming WebSocket endpoint
|
|
3684
|
+
* @description WebSocket connection for real-time device status and screen streaming.
|
|
3685
|
+
* Upgrade from HTTP to WebSocket protocol is required.
|
|
3686
|
+
* After connection, client must enable streaming by sending JSON: {"enable": true}
|
|
3687
|
+
*
|
|
3688
|
+
*/
|
|
3689
|
+
get: operations['connectWebSocket'];
|
|
3253
3690
|
put?: never;
|
|
3254
3691
|
post?: never;
|
|
3255
3692
|
delete?: never;
|
|
@@ -3258,7 +3695,7 @@ declare interface paths {
|
|
|
3258
3695
|
patch?: never;
|
|
3259
3696
|
trace?: never;
|
|
3260
3697
|
};
|
|
3261
|
-
|
|
3698
|
+
'/wifi/status': {
|
|
3262
3699
|
parameters: {
|
|
3263
3700
|
query?: never;
|
|
3264
3701
|
header?: never;
|
|
@@ -3281,7 +3718,7 @@ declare interface paths {
|
|
|
3281
3718
|
[name: string]: unknown;
|
|
3282
3719
|
};
|
|
3283
3720
|
content: {
|
|
3284
|
-
|
|
3721
|
+
'application/json': components['schemas']['StatusResponse'];
|
|
3285
3722
|
};
|
|
3286
3723
|
};
|
|
3287
3724
|
};
|
|
@@ -3294,7 +3731,7 @@ declare interface paths {
|
|
|
3294
3731
|
patch?: never;
|
|
3295
3732
|
trace?: never;
|
|
3296
3733
|
};
|
|
3297
|
-
|
|
3734
|
+
'/wifi/connect': {
|
|
3298
3735
|
parameters: {
|
|
3299
3736
|
query?: never;
|
|
3300
3737
|
header?: never;
|
|
@@ -3313,7 +3750,7 @@ declare interface paths {
|
|
|
3313
3750
|
};
|
|
3314
3751
|
requestBody: {
|
|
3315
3752
|
content: {
|
|
3316
|
-
|
|
3753
|
+
'application/json': components['schemas']['ConnectRequestConfig'];
|
|
3317
3754
|
};
|
|
3318
3755
|
};
|
|
3319
3756
|
responses: {
|
|
@@ -3323,7 +3760,7 @@ declare interface paths {
|
|
|
3323
3760
|
[name: string]: unknown;
|
|
3324
3761
|
};
|
|
3325
3762
|
content: {
|
|
3326
|
-
|
|
3763
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
3327
3764
|
};
|
|
3328
3765
|
};
|
|
3329
3766
|
/** @description Already connected */
|
|
@@ -3332,7 +3769,7 @@ declare interface paths {
|
|
|
3332
3769
|
[name: string]: unknown;
|
|
3333
3770
|
};
|
|
3334
3771
|
content: {
|
|
3335
|
-
|
|
3772
|
+
'application/json': components['schemas']['Error'];
|
|
3336
3773
|
};
|
|
3337
3774
|
};
|
|
3338
3775
|
};
|
|
@@ -3343,7 +3780,7 @@ declare interface paths {
|
|
|
3343
3780
|
patch?: never;
|
|
3344
3781
|
trace?: never;
|
|
3345
3782
|
};
|
|
3346
|
-
|
|
3783
|
+
'/wifi/disconnect': {
|
|
3347
3784
|
parameters: {
|
|
3348
3785
|
query?: never;
|
|
3349
3786
|
header?: never;
|
|
@@ -3368,7 +3805,7 @@ declare interface paths {
|
|
|
3368
3805
|
[name: string]: unknown;
|
|
3369
3806
|
};
|
|
3370
3807
|
content: {
|
|
3371
|
-
|
|
3808
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
3372
3809
|
};
|
|
3373
3810
|
};
|
|
3374
3811
|
/** @description Already disconnected */
|
|
@@ -3377,7 +3814,7 @@ declare interface paths {
|
|
|
3377
3814
|
[name: string]: unknown;
|
|
3378
3815
|
};
|
|
3379
3816
|
content: {
|
|
3380
|
-
|
|
3817
|
+
'application/json': components['schemas']['Error'];
|
|
3381
3818
|
};
|
|
3382
3819
|
};
|
|
3383
3820
|
};
|
|
@@ -3388,7 +3825,7 @@ declare interface paths {
|
|
|
3388
3825
|
patch?: never;
|
|
3389
3826
|
trace?: never;
|
|
3390
3827
|
};
|
|
3391
|
-
|
|
3828
|
+
'/wifi/networks': {
|
|
3392
3829
|
parameters: {
|
|
3393
3830
|
query?: never;
|
|
3394
3831
|
header?: never;
|
|
@@ -3411,7 +3848,7 @@ declare interface paths {
|
|
|
3411
3848
|
[name: string]: unknown;
|
|
3412
3849
|
};
|
|
3413
3850
|
content: {
|
|
3414
|
-
|
|
3851
|
+
'application/json': components['schemas']['NetworkResponse'];
|
|
3415
3852
|
};
|
|
3416
3853
|
};
|
|
3417
3854
|
/** @description Scan not possible when connected */
|
|
@@ -3420,7 +3857,7 @@ declare interface paths {
|
|
|
3420
3857
|
[name: string]: unknown;
|
|
3421
3858
|
};
|
|
3422
3859
|
content: {
|
|
3423
|
-
|
|
3860
|
+
'application/json': components['schemas']['Error'];
|
|
3424
3861
|
};
|
|
3425
3862
|
};
|
|
3426
3863
|
};
|
|
@@ -3433,7 +3870,7 @@ declare interface paths {
|
|
|
3433
3870
|
patch?: never;
|
|
3434
3871
|
trace?: never;
|
|
3435
3872
|
};
|
|
3436
|
-
|
|
3873
|
+
'/screen': {
|
|
3437
3874
|
parameters: {
|
|
3438
3875
|
query?: never;
|
|
3439
3876
|
header?: never;
|
|
@@ -3462,7 +3899,7 @@ declare interface paths {
|
|
|
3462
3899
|
[name: string]: unknown;
|
|
3463
3900
|
};
|
|
3464
3901
|
content: {
|
|
3465
|
-
|
|
3902
|
+
'image/bmp': components['schemas']['ScreenResponse'];
|
|
3466
3903
|
};
|
|
3467
3904
|
};
|
|
3468
3905
|
/** @description Wrong display */
|
|
@@ -3471,7 +3908,7 @@ declare interface paths {
|
|
|
3471
3908
|
[name: string]: unknown;
|
|
3472
3909
|
};
|
|
3473
3910
|
content: {
|
|
3474
|
-
|
|
3911
|
+
'application/json': components['schemas']['Error'];
|
|
3475
3912
|
};
|
|
3476
3913
|
};
|
|
3477
3914
|
};
|
|
@@ -3484,7 +3921,7 @@ declare interface paths {
|
|
|
3484
3921
|
patch?: never;
|
|
3485
3922
|
trace?: never;
|
|
3486
3923
|
};
|
|
3487
|
-
|
|
3924
|
+
'/screen/ws': {
|
|
3488
3925
|
parameters: {
|
|
3489
3926
|
query?: never;
|
|
3490
3927
|
header?: never;
|
|
@@ -3497,8 +3934,9 @@ declare interface paths {
|
|
|
3497
3934
|
* Upgrade from HTTP to WebSocket protocol is required.
|
|
3498
3935
|
* After connection, client must send desired display ID
|
|
3499
3936
|
* as JSON {"display": 0}
|
|
3937
|
+
*
|
|
3500
3938
|
*/
|
|
3501
|
-
get: operations[
|
|
3939
|
+
get: operations['connectScreenWebSocket'];
|
|
3502
3940
|
put?: never;
|
|
3503
3941
|
post?: never;
|
|
3504
3942
|
delete?: never;
|
|
@@ -3507,7 +3945,7 @@ declare interface paths {
|
|
|
3507
3945
|
patch?: never;
|
|
3508
3946
|
trace?: never;
|
|
3509
3947
|
};
|
|
3510
|
-
|
|
3948
|
+
'/ble/enable': {
|
|
3511
3949
|
parameters: {
|
|
3512
3950
|
query?: never;
|
|
3513
3951
|
header?: never;
|
|
@@ -3535,7 +3973,16 @@ declare interface paths {
|
|
|
3535
3973
|
[name: string]: unknown;
|
|
3536
3974
|
};
|
|
3537
3975
|
content: {
|
|
3538
|
-
|
|
3976
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
3977
|
+
};
|
|
3978
|
+
};
|
|
3979
|
+
/** @description Unable to start BLE */
|
|
3980
|
+
503: {
|
|
3981
|
+
headers: {
|
|
3982
|
+
[name: string]: unknown;
|
|
3983
|
+
};
|
|
3984
|
+
content: {
|
|
3985
|
+
'application/json': components['schemas']['Error'];
|
|
3539
3986
|
};
|
|
3540
3987
|
};
|
|
3541
3988
|
};
|
|
@@ -3546,7 +3993,7 @@ declare interface paths {
|
|
|
3546
3993
|
patch?: never;
|
|
3547
3994
|
trace?: never;
|
|
3548
3995
|
};
|
|
3549
|
-
|
|
3996
|
+
'/ble/disable': {
|
|
3550
3997
|
parameters: {
|
|
3551
3998
|
query?: never;
|
|
3552
3999
|
header?: never;
|
|
@@ -3574,7 +4021,16 @@ declare interface paths {
|
|
|
3574
4021
|
[name: string]: unknown;
|
|
3575
4022
|
};
|
|
3576
4023
|
content: {
|
|
3577
|
-
|
|
4024
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
4025
|
+
};
|
|
4026
|
+
};
|
|
4027
|
+
/** @description Unable to stop BLE */
|
|
4028
|
+
503: {
|
|
4029
|
+
headers: {
|
|
4030
|
+
[name: string]: unknown;
|
|
4031
|
+
};
|
|
4032
|
+
content: {
|
|
4033
|
+
'application/json': components['schemas']['Error'];
|
|
3578
4034
|
};
|
|
3579
4035
|
};
|
|
3580
4036
|
};
|
|
@@ -3585,7 +4041,7 @@ declare interface paths {
|
|
|
3585
4041
|
patch?: never;
|
|
3586
4042
|
trace?: never;
|
|
3587
4043
|
};
|
|
3588
|
-
|
|
4044
|
+
'/ble/pairing': {
|
|
3589
4045
|
parameters: {
|
|
3590
4046
|
query?: never;
|
|
3591
4047
|
header?: never;
|
|
@@ -3614,7 +4070,7 @@ declare interface paths {
|
|
|
3614
4070
|
[name: string]: unknown;
|
|
3615
4071
|
};
|
|
3616
4072
|
content: {
|
|
3617
|
-
|
|
4073
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
3618
4074
|
};
|
|
3619
4075
|
};
|
|
3620
4076
|
/** @description Failed to remove because BLE is not initialized or pairing was already removed */
|
|
@@ -3623,7 +4079,7 @@ declare interface paths {
|
|
|
3623
4079
|
[name: string]: unknown;
|
|
3624
4080
|
};
|
|
3625
4081
|
content: {
|
|
3626
|
-
|
|
4082
|
+
'application/json': components['schemas']['Error'];
|
|
3627
4083
|
};
|
|
3628
4084
|
};
|
|
3629
4085
|
};
|
|
@@ -3633,7 +4089,7 @@ declare interface paths {
|
|
|
3633
4089
|
patch?: never;
|
|
3634
4090
|
trace?: never;
|
|
3635
4091
|
};
|
|
3636
|
-
|
|
4092
|
+
'/ble/status': {
|
|
3637
4093
|
parameters: {
|
|
3638
4094
|
query?: never;
|
|
3639
4095
|
header?: never;
|
|
@@ -3656,7 +4112,7 @@ declare interface paths {
|
|
|
3656
4112
|
[name: string]: unknown;
|
|
3657
4113
|
};
|
|
3658
4114
|
content: {
|
|
3659
|
-
|
|
4115
|
+
'application/json': components['schemas']['BleStatusResponse'];
|
|
3660
4116
|
};
|
|
3661
4117
|
};
|
|
3662
4118
|
};
|
|
@@ -3669,7 +4125,7 @@ declare interface paths {
|
|
|
3669
4125
|
patch?: never;
|
|
3670
4126
|
trace?: never;
|
|
3671
4127
|
};
|
|
3672
|
-
|
|
4128
|
+
'/time': {
|
|
3673
4129
|
parameters: {
|
|
3674
4130
|
query?: never;
|
|
3675
4131
|
header?: never;
|
|
@@ -3680,7 +4136,7 @@ declare interface paths {
|
|
|
3680
4136
|
* Get current timestamp with timezone
|
|
3681
4137
|
* @description Retrieves the current timestamp from RTC with timezone in ISO 8601 format
|
|
3682
4138
|
*/
|
|
3683
|
-
get: operations[
|
|
4139
|
+
get: operations['getTime'];
|
|
3684
4140
|
put?: never;
|
|
3685
4141
|
post?: never;
|
|
3686
4142
|
delete?: never;
|
|
@@ -3689,7 +4145,7 @@ declare interface paths {
|
|
|
3689
4145
|
patch?: never;
|
|
3690
4146
|
trace?: never;
|
|
3691
4147
|
};
|
|
3692
|
-
|
|
4148
|
+
'/account': {
|
|
3693
4149
|
parameters: {
|
|
3694
4150
|
query?: never;
|
|
3695
4151
|
header?: never;
|
|
@@ -3703,13 +4159,13 @@ declare interface paths {
|
|
|
3703
4159
|
* Unlink device from account
|
|
3704
4160
|
* @description Removes account linking data
|
|
3705
4161
|
*/
|
|
3706
|
-
delete: operations[
|
|
4162
|
+
delete: operations['unlinkAccount'];
|
|
3707
4163
|
options?: never;
|
|
3708
4164
|
head?: never;
|
|
3709
4165
|
patch?: never;
|
|
3710
4166
|
trace?: never;
|
|
3711
4167
|
};
|
|
3712
|
-
|
|
4168
|
+
'/account/link': {
|
|
3713
4169
|
parameters: {
|
|
3714
4170
|
query?: never;
|
|
3715
4171
|
header?: never;
|
|
@@ -3722,14 +4178,14 @@ declare interface paths {
|
|
|
3722
4178
|
* Link device to account
|
|
3723
4179
|
* @description Requests account link PIN. Works only if device is connected to MQTT and is not linked to account
|
|
3724
4180
|
*/
|
|
3725
|
-
post: operations[
|
|
4181
|
+
post: operations['linkAccount'];
|
|
3726
4182
|
delete?: never;
|
|
3727
4183
|
options?: never;
|
|
3728
4184
|
head?: never;
|
|
3729
4185
|
patch?: never;
|
|
3730
4186
|
trace?: never;
|
|
3731
4187
|
};
|
|
3732
|
-
|
|
4188
|
+
'/account/info': {
|
|
3733
4189
|
parameters: {
|
|
3734
4190
|
query?: never;
|
|
3735
4191
|
header?: never;
|
|
@@ -3740,7 +4196,7 @@ declare interface paths {
|
|
|
3740
4196
|
* Get linked account info
|
|
3741
4197
|
* @description Retrieves linked account data
|
|
3742
4198
|
*/
|
|
3743
|
-
get: operations[
|
|
4199
|
+
get: operations['getAccountInfo'];
|
|
3744
4200
|
put?: never;
|
|
3745
4201
|
post?: never;
|
|
3746
4202
|
delete?: never;
|
|
@@ -3749,7 +4205,7 @@ declare interface paths {
|
|
|
3749
4205
|
patch?: never;
|
|
3750
4206
|
trace?: never;
|
|
3751
4207
|
};
|
|
3752
|
-
|
|
4208
|
+
'/account/status': {
|
|
3753
4209
|
parameters: {
|
|
3754
4210
|
query?: never;
|
|
3755
4211
|
header?: never;
|
|
@@ -3760,7 +4216,7 @@ declare interface paths {
|
|
|
3760
4216
|
* Get MQTT status info
|
|
3761
4217
|
* @description Retrieves MQTT status
|
|
3762
4218
|
*/
|
|
3763
|
-
get: operations[
|
|
4219
|
+
get: operations['getAccountStatus'];
|
|
3764
4220
|
put?: never;
|
|
3765
4221
|
post?: never;
|
|
3766
4222
|
delete?: never;
|
|
@@ -3769,7 +4225,7 @@ declare interface paths {
|
|
|
3769
4225
|
patch?: never;
|
|
3770
4226
|
trace?: never;
|
|
3771
4227
|
};
|
|
3772
|
-
|
|
4228
|
+
'/account/profile': {
|
|
3773
4229
|
parameters: {
|
|
3774
4230
|
query?: never;
|
|
3775
4231
|
header?: never;
|
|
@@ -3780,20 +4236,20 @@ declare interface paths {
|
|
|
3780
4236
|
* Get MQTT profile
|
|
3781
4237
|
* @description Retrieves MQTT backend type (dev/prod/local)
|
|
3782
4238
|
*/
|
|
3783
|
-
get: operations[
|
|
4239
|
+
get: operations['getAccountProfile'];
|
|
3784
4240
|
put?: never;
|
|
3785
4241
|
/**
|
|
3786
4242
|
* Set MQTT profile
|
|
3787
4243
|
* @description Sets MQTT backend type (dev/prod/local)
|
|
3788
4244
|
*/
|
|
3789
|
-
post: operations[
|
|
4245
|
+
post: operations['setAccountProfile'];
|
|
3790
4246
|
delete?: never;
|
|
3791
4247
|
options?: never;
|
|
3792
4248
|
head?: never;
|
|
3793
4249
|
patch?: never;
|
|
3794
4250
|
trace?: never;
|
|
3795
4251
|
};
|
|
3796
|
-
|
|
4252
|
+
'/time/timestamp': {
|
|
3797
4253
|
parameters: {
|
|
3798
4254
|
query?: never;
|
|
3799
4255
|
header?: never;
|
|
@@ -3805,15 +4261,16 @@ declare interface paths {
|
|
|
3805
4261
|
/**
|
|
3806
4262
|
* Set current timestamp
|
|
3807
4263
|
* @description Sets the RTC timestamp in ISO 8601 format. Time zone qualifier (e.g. Z of UTC or +hh:mm for local time) is required.
|
|
4264
|
+
*
|
|
3808
4265
|
*/
|
|
3809
|
-
post: operations[
|
|
4266
|
+
post: operations['setTimeTimestamp'];
|
|
3810
4267
|
delete?: never;
|
|
3811
4268
|
options?: never;
|
|
3812
4269
|
head?: never;
|
|
3813
4270
|
patch?: never;
|
|
3814
4271
|
trace?: never;
|
|
3815
4272
|
};
|
|
3816
|
-
|
|
4273
|
+
'/time/timezone': {
|
|
3817
4274
|
parameters: {
|
|
3818
4275
|
query?: never;
|
|
3819
4276
|
header?: never;
|
|
@@ -3824,20 +4281,20 @@ declare interface paths {
|
|
|
3824
4281
|
* Get timezone
|
|
3825
4282
|
* @description Get current timezone name
|
|
3826
4283
|
*/
|
|
3827
|
-
get: operations[
|
|
4284
|
+
get: operations['getTimeTimezone'];
|
|
3828
4285
|
put?: never;
|
|
3829
4286
|
/**
|
|
3830
4287
|
* Set timezone
|
|
3831
4288
|
* @description Sets the timezone name. Use /time/tzlist to get available names list.
|
|
3832
4289
|
*/
|
|
3833
|
-
post: operations[
|
|
4290
|
+
post: operations['setTimeTimezone'];
|
|
3834
4291
|
delete?: never;
|
|
3835
4292
|
options?: never;
|
|
3836
4293
|
head?: never;
|
|
3837
4294
|
patch?: never;
|
|
3838
4295
|
trace?: never;
|
|
3839
4296
|
};
|
|
3840
|
-
|
|
4297
|
+
'/time/tzlist': {
|
|
3841
4298
|
parameters: {
|
|
3842
4299
|
query?: never;
|
|
3843
4300
|
header?: never;
|
|
@@ -3848,7 +4305,7 @@ declare interface paths {
|
|
|
3848
4305
|
* Get list of supported time zones
|
|
3849
4306
|
* @description Retrieves the list of time zones accepted by /time/timezone
|
|
3850
4307
|
*/
|
|
3851
|
-
get: operations[
|
|
4308
|
+
get: operations['getTimeTzlist'];
|
|
3852
4309
|
put?: never;
|
|
3853
4310
|
post?: never;
|
|
3854
4311
|
delete?: never;
|
|
@@ -3857,7 +4314,7 @@ declare interface paths {
|
|
|
3857
4314
|
patch?: never;
|
|
3858
4315
|
trace?: never;
|
|
3859
4316
|
};
|
|
3860
|
-
|
|
4317
|
+
'/busy/snapshot': {
|
|
3861
4318
|
parameters: {
|
|
3862
4319
|
query?: never;
|
|
3863
4320
|
header?: never;
|
|
@@ -3868,12 +4325,36 @@ declare interface paths {
|
|
|
3868
4325
|
* Get BUSY timer snapshot
|
|
3869
4326
|
* @description Gets the current state of the BUSY timer in snapshot form
|
|
3870
4327
|
*/
|
|
3871
|
-
get: operations[
|
|
4328
|
+
get: operations['getBusySnapshot'];
|
|
3872
4329
|
/**
|
|
3873
|
-
* Set BUSY
|
|
4330
|
+
* Set BUSY timer snapshot
|
|
3874
4331
|
* @description Run the timer starting from the given snapshot
|
|
3875
4332
|
*/
|
|
3876
|
-
put: operations[
|
|
4333
|
+
put: operations['setBusySnapshot'];
|
|
4334
|
+
post?: never;
|
|
4335
|
+
delete?: never;
|
|
4336
|
+
options?: never;
|
|
4337
|
+
head?: never;
|
|
4338
|
+
patch?: never;
|
|
4339
|
+
trace?: never;
|
|
4340
|
+
};
|
|
4341
|
+
'/busy/profiles/{slot}': {
|
|
4342
|
+
parameters: {
|
|
4343
|
+
query?: never;
|
|
4344
|
+
header?: never;
|
|
4345
|
+
path?: never;
|
|
4346
|
+
cookie?: never;
|
|
4347
|
+
};
|
|
4348
|
+
/**
|
|
4349
|
+
* Get BUSY timer profile
|
|
4350
|
+
* @description Gets the BUSY timer profile under specified slot
|
|
4351
|
+
*/
|
|
4352
|
+
get: operations['getBusyProfile'];
|
|
4353
|
+
/**
|
|
4354
|
+
* Set BUSY time profile
|
|
4355
|
+
* @description Sets the BUSY timer profile under specified slot
|
|
4356
|
+
*/
|
|
4357
|
+
put: operations['setBusyProfile'];
|
|
3877
4358
|
post?: never;
|
|
3878
4359
|
delete?: never;
|
|
3879
4360
|
options?: never;
|
|
@@ -3881,7 +4362,7 @@ declare interface paths {
|
|
|
3881
4362
|
patch?: never;
|
|
3882
4363
|
trace?: never;
|
|
3883
4364
|
};
|
|
3884
|
-
|
|
4365
|
+
'/smart_home/pairing': {
|
|
3885
4366
|
parameters: {
|
|
3886
4367
|
query?: never;
|
|
3887
4368
|
header?: never;
|
|
@@ -3889,10 +4370,10 @@ declare interface paths {
|
|
|
3889
4370
|
cookie?: never;
|
|
3890
4371
|
};
|
|
3891
4372
|
/** Smart home commissioning status */
|
|
3892
|
-
get: operations[
|
|
4373
|
+
get: operations['getSmartHomeCommissioningStatus'];
|
|
3893
4374
|
put?: never;
|
|
3894
4375
|
/** Link device to a smart home */
|
|
3895
|
-
post: operations[
|
|
4376
|
+
post: operations['startSmartHomePairing'];
|
|
3896
4377
|
/** Erase all smart home links */
|
|
3897
4378
|
delete: {
|
|
3898
4379
|
parameters: {
|
|
@@ -3903,22 +4384,22 @@ declare interface paths {
|
|
|
3903
4384
|
};
|
|
3904
4385
|
requestBody?: never;
|
|
3905
4386
|
responses: {
|
|
3906
|
-
/** @description Successfully erased all
|
|
4387
|
+
/** @description Successfully erased all smart home pairing info, device restart is needed */
|
|
3907
4388
|
200: {
|
|
3908
4389
|
headers: {
|
|
3909
4390
|
[name: string]: unknown;
|
|
3910
4391
|
};
|
|
3911
4392
|
content: {
|
|
3912
|
-
|
|
4393
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
3913
4394
|
};
|
|
3914
4395
|
};
|
|
3915
|
-
/** @description Internal
|
|
4396
|
+
/** @description Internal smart home service is broken */
|
|
3916
4397
|
503: {
|
|
3917
4398
|
headers: {
|
|
3918
4399
|
[name: string]: unknown;
|
|
3919
4400
|
};
|
|
3920
4401
|
content: {
|
|
3921
|
-
|
|
4402
|
+
'application/json': components['schemas']['Error'];
|
|
3922
4403
|
};
|
|
3923
4404
|
};
|
|
3924
4405
|
};
|
|
@@ -3928,14 +4409,14 @@ declare interface paths {
|
|
|
3928
4409
|
patch?: never;
|
|
3929
4410
|
trace?: never;
|
|
3930
4411
|
};
|
|
3931
|
-
|
|
4412
|
+
'/smart_home/switch': {
|
|
3932
4413
|
parameters: {
|
|
3933
4414
|
query?: never;
|
|
3934
4415
|
header?: never;
|
|
3935
4416
|
path?: never;
|
|
3936
4417
|
cookie?: never;
|
|
3937
4418
|
};
|
|
3938
|
-
/** Get
|
|
4419
|
+
/** Get state of emulated smart home switch */
|
|
3939
4420
|
get: {
|
|
3940
4421
|
parameters: {
|
|
3941
4422
|
query?: never;
|
|
@@ -3945,28 +4426,28 @@ declare interface paths {
|
|
|
3945
4426
|
};
|
|
3946
4427
|
requestBody?: never;
|
|
3947
4428
|
responses: {
|
|
3948
|
-
/** @description Successfully got
|
|
4429
|
+
/** @description Successfully got state of emulated smart home switch */
|
|
3949
4430
|
200: {
|
|
3950
4431
|
headers: {
|
|
3951
4432
|
[name: string]: unknown;
|
|
3952
4433
|
};
|
|
3953
4434
|
content: {
|
|
3954
|
-
|
|
4435
|
+
'application/json': components['schemas']['SmartHomeSwitchState'];
|
|
3955
4436
|
};
|
|
3956
4437
|
};
|
|
3957
|
-
/** @description Internal
|
|
4438
|
+
/** @description Internal smart home service is broken */
|
|
3958
4439
|
503: {
|
|
3959
4440
|
headers: {
|
|
3960
4441
|
[name: string]: unknown;
|
|
3961
4442
|
};
|
|
3962
4443
|
content: {
|
|
3963
|
-
|
|
4444
|
+
'application/json': components['schemas']['Error'];
|
|
3964
4445
|
};
|
|
3965
4446
|
};
|
|
3966
4447
|
};
|
|
3967
4448
|
};
|
|
3968
4449
|
put?: never;
|
|
3969
|
-
/** Set
|
|
4450
|
+
/** Set state of emulated smart home switch */
|
|
3970
4451
|
post: {
|
|
3971
4452
|
parameters: {
|
|
3972
4453
|
query?: never;
|
|
@@ -3976,26 +4457,26 @@ declare interface paths {
|
|
|
3976
4457
|
};
|
|
3977
4458
|
requestBody: {
|
|
3978
4459
|
content: {
|
|
3979
|
-
|
|
4460
|
+
'application/json': components['schemas']['SmartHomeSwitchState'];
|
|
3980
4461
|
};
|
|
3981
4462
|
};
|
|
3982
4463
|
responses: {
|
|
3983
|
-
/** @description Successfully set
|
|
4464
|
+
/** @description Successfully set state of emulated smart home switch */
|
|
3984
4465
|
200: {
|
|
3985
4466
|
headers: {
|
|
3986
4467
|
[name: string]: unknown;
|
|
3987
4468
|
};
|
|
3988
4469
|
content: {
|
|
3989
|
-
|
|
4470
|
+
'application/json': components['schemas']['SuccessResponse'];
|
|
3990
4471
|
};
|
|
3991
4472
|
};
|
|
3992
|
-
/** @description Internal
|
|
4473
|
+
/** @description Internal smart home service is broken */
|
|
3993
4474
|
503: {
|
|
3994
4475
|
headers: {
|
|
3995
4476
|
[name: string]: unknown;
|
|
3996
4477
|
};
|
|
3997
4478
|
content: {
|
|
3998
|
-
|
|
4479
|
+
'application/json': components['schemas']['Error'];
|
|
3999
4480
|
};
|
|
4000
4481
|
};
|
|
4001
4482
|
};
|
|
@@ -4008,14 +4489,17 @@ declare interface paths {
|
|
|
4008
4489
|
};
|
|
4009
4490
|
}
|
|
4010
4491
|
|
|
4011
|
-
declare type RequiredIpConfig = RequireKeys<NonNullable<
|
|
4492
|
+
declare type RequiredIpConfig = RequireKeys<NonNullable<WifiConnectRequestConfig['ip_config']>, 'ip_method'>;
|
|
4012
4493
|
|
|
4013
4494
|
declare type RequireKeys<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
|
|
4014
4495
|
|
|
4015
|
-
export declare interface ScreenFrameGetParams extends TimeoutOptions {
|
|
4016
|
-
display: paths["/screen"]["get"]["parameters"]["query"]["display"];
|
|
4496
|
+
export declare interface ScreenFrameGetParams extends TimeoutOptions, ScreenQuery {
|
|
4017
4497
|
}
|
|
4018
4498
|
|
|
4499
|
+
declare type ScreenQuery = paths['/screen']['get']['parameters']['query'];
|
|
4500
|
+
|
|
4501
|
+
export declare type ScreenResponse = components['schemas']['ScreenResponse'];
|
|
4502
|
+
|
|
4019
4503
|
export declare class ScreenStream {
|
|
4020
4504
|
private config;
|
|
4021
4505
|
readonly addr: string;
|
|
@@ -4044,6 +4528,8 @@ export declare interface ScreenStreamConfig {
|
|
|
4044
4528
|
apiSemver?: ApiSemver;
|
|
4045
4529
|
}
|
|
4046
4530
|
|
|
4531
|
+
declare type SetTimezoneQuery = operations['setTimeTimezone']['parameters']['query'];
|
|
4532
|
+
|
|
4047
4533
|
declare class SettingsMethods {
|
|
4048
4534
|
/**
|
|
4049
4535
|
* Get HTTP API access over Wi-Fi configuration.
|
|
@@ -4058,7 +4544,7 @@ declare class SettingsMethods {
|
|
|
4058
4544
|
*
|
|
4059
4545
|
* @param {HttpAccessParams} params - Access parameters:
|
|
4060
4546
|
* @param {boolean} params.mode - Enable/disable access.
|
|
4061
|
-
* @param {string} params.key - Access key (4-10 digits).
|
|
4547
|
+
* @param {string} [params.key] - Access key (4-10 digits).
|
|
4062
4548
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4063
4549
|
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
4064
4550
|
*/
|
|
@@ -4082,32 +4568,95 @@ declare class SettingsMethods {
|
|
|
4082
4568
|
SettingsNameSet(this: BusyBar, params: NameParams): Promise<SuccessResponse>;
|
|
4083
4569
|
}
|
|
4084
4570
|
|
|
4085
|
-
declare
|
|
4571
|
+
declare class SmartHomeMethods {
|
|
4572
|
+
/**
|
|
4573
|
+
* Smart home commissioning status.
|
|
4574
|
+
*
|
|
4575
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
4576
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4577
|
+
* @returns {Promise<SmartHomePairingInfo>} A promise that resolves to the pairing info.
|
|
4578
|
+
*/
|
|
4579
|
+
SmartHomePairingGet(this: BusyBar, params?: TimeoutOptions): Promise<SmartHomePairingInfo>;
|
|
4580
|
+
/**
|
|
4581
|
+
* Link device to a smart home.
|
|
4582
|
+
*
|
|
4583
|
+
* @param {TimeoutOptions} [params] - Optional timeout.
|
|
4584
|
+
* @returns {Promise<SmartHomePairingPayload>} A promise that resolves to the pairing payload.
|
|
4585
|
+
*/
|
|
4586
|
+
SmartHomePair(this: BusyBar, params?: TimeoutOptions): Promise<SmartHomePairingPayload>;
|
|
4587
|
+
/**
|
|
4588
|
+
* Erase all smart home links.
|
|
4589
|
+
*
|
|
4590
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
4591
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4592
|
+
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
4593
|
+
*/
|
|
4594
|
+
SmartHomeErase(this: BusyBar, params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
4595
|
+
/**
|
|
4596
|
+
* Get state of emulated smart home switch.
|
|
4597
|
+
*
|
|
4598
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
4599
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4600
|
+
* @returns {Promise<SmartHomeSwitchState>} A promise that resolves to the switch state.
|
|
4601
|
+
*/
|
|
4602
|
+
SmartHomeSwitchStateGet(this: BusyBar, params?: TimeoutOptions): Promise<SmartHomeSwitchState>;
|
|
4603
|
+
/**
|
|
4604
|
+
* Set state of emulated smart home switch.
|
|
4605
|
+
*
|
|
4606
|
+
* @param {SmartHomeSwitchState & TimeoutOptions} params - Switch state and optional timeout.
|
|
4607
|
+
* @returns {Promise<SuccessResponse>} A promise that resolves on success.
|
|
4608
|
+
*/
|
|
4609
|
+
SmartHomeSwitchStateSet(this: BusyBar, params: SmartHomeSwitchState & TimeoutOptions): Promise<SuccessResponse>;
|
|
4610
|
+
/**
|
|
4611
|
+
* @deprecated Use SmartHomePairingGet instead.
|
|
4612
|
+
*/
|
|
4613
|
+
MatterStatusGet(this: BusyBar, params?: TimeoutOptions): Promise<SmartHomePairingInfo>;
|
|
4614
|
+
/**
|
|
4615
|
+
* @deprecated Use SmartHomePair instead.
|
|
4616
|
+
*/
|
|
4617
|
+
MatterPair(this: BusyBar, params?: TimeoutOptions): Promise<SmartHomePairingPayload>;
|
|
4618
|
+
/**
|
|
4619
|
+
* @deprecated Use SmartHomeErase instead.
|
|
4620
|
+
*/
|
|
4621
|
+
MatterErase(this: BusyBar, params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
4622
|
+
}
|
|
4623
|
+
|
|
4624
|
+
export declare type SmartHomePairingInfo = components['schemas']['SmartHomePairingInfo'];
|
|
4625
|
+
|
|
4626
|
+
export declare type SmartHomePairingPayload = components['schemas']['SmartHomePairingPayload'];
|
|
4627
|
+
|
|
4628
|
+
export declare type SmartHomeSwitchState = components['schemas']['SmartHomeSwitchState'];
|
|
4086
4629
|
|
|
4087
|
-
export declare type Status = components[
|
|
4630
|
+
export declare type Status = components['schemas']['Status'];
|
|
4088
4631
|
|
|
4089
|
-
export declare type
|
|
4632
|
+
export declare type StatusDevice = components['schemas']['StatusDevice'];
|
|
4090
4633
|
|
|
4091
|
-
export declare type
|
|
4634
|
+
export declare type StatusFirmware = components['schemas']['StatusFirmware'];
|
|
4635
|
+
|
|
4636
|
+
export declare type StatusPower = components['schemas']['StatusPower'];
|
|
4637
|
+
|
|
4638
|
+
export declare type StatusSystem = components['schemas']['StatusSystem'];
|
|
4092
4639
|
|
|
4093
4640
|
declare type StopListener = () => void;
|
|
4094
4641
|
|
|
4095
|
-
export declare interface StorageCreateDirectoryParams extends TimeoutOptions {
|
|
4096
|
-
path: operations["createStorageDir"]["parameters"]["query"]["path"];
|
|
4642
|
+
export declare interface StorageCreateDirectoryParams extends TimeoutOptions, StorageCreateDirQuery {
|
|
4097
4643
|
}
|
|
4098
4644
|
|
|
4099
|
-
|
|
4645
|
+
declare type StorageCreateDirQuery = operations['createStorageDir']['parameters']['query'];
|
|
4100
4646
|
|
|
4101
|
-
export declare
|
|
4102
|
-
|
|
4103
|
-
|
|
4647
|
+
export declare type StorageDirElement = components['schemas']['StorageDirElement'];
|
|
4648
|
+
|
|
4649
|
+
export declare interface StorageDownloadFileParams extends TimeoutOptions, StorageReadQuery {
|
|
4650
|
+
as_array_buffer?: boolean;
|
|
4104
4651
|
}
|
|
4105
4652
|
|
|
4106
|
-
export declare type StorageFileElement = components[
|
|
4653
|
+
export declare type StorageFileElement = components['schemas']['StorageFileElement'];
|
|
4654
|
+
|
|
4655
|
+
export declare type StorageList = components['schemas']['StorageList'];
|
|
4107
4656
|
|
|
4108
|
-
export declare type
|
|
4657
|
+
export declare type StorageListElement = components['schemas']['StorageListElement'];
|
|
4109
4658
|
|
|
4110
|
-
|
|
4659
|
+
declare type StorageListQuery = operations['listStorageFiles']['parameters']['query'];
|
|
4111
4660
|
|
|
4112
4661
|
declare class StorageMethods {
|
|
4113
4662
|
/**
|
|
@@ -4125,7 +4674,7 @@ declare class StorageMethods {
|
|
|
4125
4674
|
*
|
|
4126
4675
|
* @param {DownloadFileParams} params - Download parameters:
|
|
4127
4676
|
* @param {string} params.path - Path to the file.
|
|
4128
|
-
* @param {boolean} [params.
|
|
4677
|
+
* @param {boolean} [params.as_array_buffer] - Whether to return ArrayBuffer instead of Blob.
|
|
4129
4678
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4130
4679
|
* @returns {Promise<StorageReadResponse>} A promise that resolves to the file content (Blob or ArrayBuffer).
|
|
4131
4680
|
*/
|
|
@@ -4165,26 +4714,44 @@ declare class StorageMethods {
|
|
|
4165
4714
|
* @returns {Promise<StorageStatus>} A promise that resolves to the storage status.
|
|
4166
4715
|
*/
|
|
4167
4716
|
StorageStatusGet(this: BusyBar, params?: TimeoutOptions): Promise<StorageStatus>;
|
|
4717
|
+
/**
|
|
4718
|
+
* Rename/move a file. Moves a file to a new location.
|
|
4719
|
+
*
|
|
4720
|
+
* @param {RenameParams} params - Rename parameters:
|
|
4721
|
+
* @param {RenameParams['path']} params.path - Current path of the file or directory.
|
|
4722
|
+
* @param {RenameParams['new_path']} params.new_path - New path for the file or directory.
|
|
4723
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4724
|
+
* @returns {Promise<SuccessResponse>} A promise that resolves on successful rename.
|
|
4725
|
+
*/
|
|
4726
|
+
StorageRename(this: BusyBar, params: StorageRenameParams): Promise<SuccessResponse>;
|
|
4168
4727
|
}
|
|
4169
4728
|
|
|
4170
|
-
export declare interface StorageReadDirectoryParams extends TimeoutOptions {
|
|
4171
|
-
path: operations["listStorageFiles"]["parameters"]["query"]["path"];
|
|
4729
|
+
export declare interface StorageReadDirectoryParams extends TimeoutOptions, StorageListQuery {
|
|
4172
4730
|
}
|
|
4173
4731
|
|
|
4732
|
+
declare type StorageReadQuery = operations['readStorageFile']['parameters']['query'];
|
|
4733
|
+
|
|
4174
4734
|
export declare type StorageReadResponse = ArrayBuffer | Blob;
|
|
4175
4735
|
|
|
4176
|
-
export declare interface StorageRemoveParams extends TimeoutOptions {
|
|
4177
|
-
|
|
4736
|
+
export declare interface StorageRemoveParams extends TimeoutOptions, StorageRemoveQuery {
|
|
4737
|
+
}
|
|
4738
|
+
|
|
4739
|
+
declare type StorageRemoveQuery = operations['removeStorageFile']['parameters']['query'];
|
|
4740
|
+
|
|
4741
|
+
export declare interface StorageRenameParams extends TimeoutOptions, StorageRenameQuery {
|
|
4178
4742
|
}
|
|
4179
4743
|
|
|
4180
|
-
|
|
4744
|
+
declare type StorageRenameQuery = operations['RenameStorageFile']['parameters']['query'];
|
|
4181
4745
|
|
|
4182
|
-
export declare
|
|
4183
|
-
|
|
4184
|
-
|
|
4746
|
+
export declare type StorageStatus = components['schemas']['StorageStatus'];
|
|
4747
|
+
|
|
4748
|
+
export declare interface StorageUploadFileParams extends TimeoutOptions, StorageWriteQuery {
|
|
4749
|
+
file: BusyFile_2;
|
|
4185
4750
|
}
|
|
4186
4751
|
|
|
4187
|
-
|
|
4752
|
+
declare type StorageWriteQuery = operations['writeStorageFile']['parameters']['query'];
|
|
4753
|
+
|
|
4754
|
+
export declare type SuccessResponse = components['schemas']['SuccessResponse'];
|
|
4188
4755
|
|
|
4189
4756
|
declare class SystemMethods {
|
|
4190
4757
|
/**
|
|
@@ -4196,7 +4763,7 @@ declare class SystemMethods {
|
|
|
4196
4763
|
*/
|
|
4197
4764
|
SystemVersionGet(this: BusyBar, params?: TimeoutOptions): Promise<VersionInfo>;
|
|
4198
4765
|
/**
|
|
4199
|
-
* Get
|
|
4766
|
+
* Get full status.
|
|
4200
4767
|
*
|
|
4201
4768
|
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
4202
4769
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
@@ -4219,8 +4786,26 @@ declare class SystemMethods {
|
|
|
4219
4786
|
* @returns {Promise<StatusPower>} Current power status.
|
|
4220
4787
|
*/
|
|
4221
4788
|
SystemStatusPowerGet(this: BusyBar, params?: TimeoutOptions): Promise<StatusPower>;
|
|
4789
|
+
/**
|
|
4790
|
+
* Get device status.
|
|
4791
|
+
*
|
|
4792
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
4793
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4794
|
+
* @returns {Promise<StatusDevice>} Current device status.
|
|
4795
|
+
*/
|
|
4796
|
+
SystemStatusDeviceGet(this: BusyBar, params?: TimeoutOptions): Promise<StatusDevice>;
|
|
4797
|
+
/**
|
|
4798
|
+
* Get firmware status.
|
|
4799
|
+
*
|
|
4800
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
4801
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4802
|
+
* @returns {Promise<StatusFirmware>} Current firmware status.
|
|
4803
|
+
*/
|
|
4804
|
+
SystemStatusFirmwareGet(this: BusyBar, params?: TimeoutOptions): Promise<StatusFirmware>;
|
|
4222
4805
|
}
|
|
4223
4806
|
|
|
4807
|
+
export declare type TextElement = components['schemas']['TextElement'];
|
|
4808
|
+
|
|
4224
4809
|
declare class TimeMethods {
|
|
4225
4810
|
/**
|
|
4226
4811
|
* Get current timestamp info.
|
|
@@ -4270,36 +4855,39 @@ export declare interface TimeoutOptions {
|
|
|
4270
4855
|
timeout?: number;
|
|
4271
4856
|
}
|
|
4272
4857
|
|
|
4273
|
-
export declare type TimestampInfo = components[
|
|
4858
|
+
export declare type TimestampInfo = components['schemas']['TimestampInfo'];
|
|
4274
4859
|
|
|
4275
|
-
export declare interface TimeTimestampParams extends TimeoutOptions {
|
|
4276
|
-
timestamp: operations["setTimeTimestamp"]["parameters"]["query"]["timestamp"];
|
|
4860
|
+
export declare interface TimeTimestampParams extends TimeoutOptions, TimestampInfo {
|
|
4277
4861
|
}
|
|
4278
4862
|
|
|
4279
|
-
export declare interface TimeTimezoneParams extends TimeoutOptions {
|
|
4280
|
-
timezone: operations["setTimeTimezone"]["parameters"]["query"]["timezone"];
|
|
4863
|
+
export declare interface TimeTimezoneParams extends TimeoutOptions, SetTimezoneQuery {
|
|
4281
4864
|
}
|
|
4282
4865
|
|
|
4283
|
-
export declare type TimezoneInfo = components[
|
|
4866
|
+
export declare type TimezoneInfo = components['schemas']['TimezoneInfo'];
|
|
4867
|
+
|
|
4868
|
+
export declare type TimezoneItem = NonNullable<TimezoneList['list']>[number];
|
|
4284
4869
|
|
|
4285
|
-
export declare type
|
|
4870
|
+
export declare type TimezoneList = components['schemas']['TimezoneListResponse'];
|
|
4286
4871
|
|
|
4287
|
-
export declare
|
|
4872
|
+
export declare interface UpdateAutoUpdateParams extends TimeoutOptions, AutoUpdateSettings {
|
|
4873
|
+
}
|
|
4288
4874
|
|
|
4289
|
-
export declare type UpdateChangelog = operations[
|
|
4875
|
+
export declare type UpdateChangelog = operations['getUpdateChangelog']['responses']['200']['content']['application/json'];
|
|
4290
4876
|
|
|
4291
|
-
export declare interface UpdateChangelogParams extends TimeoutOptions {
|
|
4292
|
-
version: string;
|
|
4877
|
+
export declare interface UpdateChangelogParams extends TimeoutOptions, UpdateChangelogQuery {
|
|
4293
4878
|
}
|
|
4294
4879
|
|
|
4880
|
+
declare type UpdateChangelogQuery = operations['getUpdateChangelog']['parameters']['query'];
|
|
4881
|
+
|
|
4295
4882
|
export declare interface UpdateFromFileParams extends TimeoutOptions {
|
|
4296
|
-
file:
|
|
4883
|
+
file: BusyFile_2;
|
|
4297
4884
|
}
|
|
4298
4885
|
|
|
4299
|
-
export declare interface UpdateInstallParams extends TimeoutOptions {
|
|
4300
|
-
version: string;
|
|
4886
|
+
export declare interface UpdateInstallParams extends TimeoutOptions, UpdateInstallQuery {
|
|
4301
4887
|
}
|
|
4302
4888
|
|
|
4889
|
+
declare type UpdateInstallQuery = operations['installFirmwareUpdate']['parameters']['query'];
|
|
4890
|
+
|
|
4303
4891
|
declare class UpdateMethods {
|
|
4304
4892
|
/**
|
|
4305
4893
|
* Upload firmware update package.
|
|
@@ -4352,21 +4940,40 @@ declare class UpdateMethods {
|
|
|
4352
4940
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful abort.
|
|
4353
4941
|
*/
|
|
4354
4942
|
UpdateAbort(this: BusyBar, params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
4943
|
+
/**
|
|
4944
|
+
* Get current auto-update settings.
|
|
4945
|
+
*
|
|
4946
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
4947
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4948
|
+
* @returns {Promise<AutoUpdateSettings>} A promise that resolves to the current auto-update settings.
|
|
4949
|
+
*/
|
|
4950
|
+
UpdateAutoUpdateGet(this: BusyBar, params?: TimeoutOptions): Promise<AutoUpdateSettings>;
|
|
4951
|
+
/**
|
|
4952
|
+
* Set auto-update settings.
|
|
4953
|
+
*
|
|
4954
|
+
* @param {AutoUpdateParams} params - Parameters for auto-update settings.
|
|
4955
|
+
* @param {AutoUpdateParams['is_enabled']} params.is_enabled - Whether auto-update is enabled.
|
|
4956
|
+
* @param {AutoUpdateParams['interval_start']} params.interval_start - Auto-update interval start time (HH:mm).
|
|
4957
|
+
* @param {AutoUpdateParams['interval_end']} params.interval_end - Auto-update interval end time (HH:mm).
|
|
4958
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4959
|
+
* @returns {Promise<SuccessResponse>} A promise that resolves on successful update of settings.
|
|
4960
|
+
*/
|
|
4961
|
+
UpdateAutoUpdateSet(this: BusyBar, params: UpdateAutoUpdateParams): Promise<SuccessResponse>;
|
|
4355
4962
|
}
|
|
4356
4963
|
|
|
4357
|
-
export declare type UpdateStatus = components[
|
|
4964
|
+
export declare type UpdateStatus = components['schemas']['UpdateStatus'];
|
|
4358
4965
|
|
|
4359
|
-
export declare type VersionInfo = components[
|
|
4966
|
+
export declare type VersionInfo = components['schemas']['VersionInfo'];
|
|
4360
4967
|
|
|
4361
|
-
export declare type WifiConnectParams = RequireKeys<Omit<
|
|
4362
|
-
|
|
4363
|
-
},
|
|
4968
|
+
export declare type WifiConnectParams = RequireKeys<Omit<WifiConnectRequestConfig, 'ip_config'> & {
|
|
4969
|
+
ip_config: RequiredIpConfig;
|
|
4970
|
+
}, 'ssid' | 'security' | 'ip_config'> & TimeoutOptions;
|
|
4364
4971
|
|
|
4365
|
-
export declare type WifiConnectRequestConfig = components[
|
|
4972
|
+
export declare type WifiConnectRequestConfig = components['schemas']['ConnectRequestConfig'];
|
|
4366
4973
|
|
|
4367
|
-
export declare type WifiIpMethod = components[
|
|
4974
|
+
export declare type WifiIpMethod = components['schemas']['WifiIpMethod'];
|
|
4368
4975
|
|
|
4369
|
-
export declare type WifiIpType = components[
|
|
4976
|
+
export declare type WifiIpType = components['schemas']['WifiIpType'];
|
|
4370
4977
|
|
|
4371
4978
|
declare class WifiMethods {
|
|
4372
4979
|
/**
|
|
@@ -4384,7 +4991,7 @@ declare class WifiMethods {
|
|
|
4384
4991
|
* @param {string} params.ssid - Network SSID.
|
|
4385
4992
|
* @param {string} params.password - Network password.
|
|
4386
4993
|
* @param {WifiSecurityMethod} params.security - Security method.
|
|
4387
|
-
* @param {object} params.
|
|
4994
|
+
* @param {object} [params.ip_config] - IP configuration.
|
|
4388
4995
|
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
4389
4996
|
* @returns {Promise<SuccessResponse>} A promise that resolves on successful connection initiation.
|
|
4390
4997
|
*/
|
|
@@ -4407,12 +5014,12 @@ declare class WifiMethods {
|
|
|
4407
5014
|
WifiNetworksGet(this: BusyBar, params?: TimeoutOptions): Promise<WifiNetworkResponse>;
|
|
4408
5015
|
}
|
|
4409
5016
|
|
|
4410
|
-
export declare type WifiNetwork = components[
|
|
5017
|
+
export declare type WifiNetwork = components['schemas']['Network'];
|
|
4411
5018
|
|
|
4412
|
-
export declare type WifiNetworkResponse = components[
|
|
5019
|
+
export declare type WifiNetworkResponse = components['schemas']['NetworkResponse'];
|
|
4413
5020
|
|
|
4414
|
-
export declare type WifiSecurityMethod = components[
|
|
5021
|
+
export declare type WifiSecurityMethod = components['schemas']['WifiSecurityMethod'];
|
|
4415
5022
|
|
|
4416
|
-
export declare type WifiStatusResponse = components[
|
|
5023
|
+
export declare type WifiStatusResponse = components['schemas']['StatusResponse'];
|
|
4417
5024
|
|
|
4418
5025
|
export { }
|