@busy-app/busy-lib 0.6.0 → 0.7.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 +369 -193
- package/dist/index.js +1112 -702
- package/package.json +2 -1
package/dist/index.d.ts
CHANGED
|
@@ -6,38 +6,27 @@ declare type ApiKey = string;
|
|
|
6
6
|
|
|
7
7
|
declare type ApiSemver = components["schemas"]["VersionInfo"]["api_semver"];
|
|
8
8
|
|
|
9
|
-
export declare interface AssetsDeleteParams {
|
|
9
|
+
export declare interface AssetsDeleteParams extends TimeoutOptions {
|
|
10
10
|
appId: paths["/assets/upload"]["delete"]["parameters"]["query"]["app_id"];
|
|
11
11
|
}
|
|
12
12
|
|
|
13
|
-
export declare interface AssetsUploadParams {
|
|
13
|
+
export declare interface AssetsUploadParams extends TimeoutOptions {
|
|
14
14
|
appId: paths["/assets/upload"]["post"]["parameters"]["query"]["app_id"];
|
|
15
15
|
fileName: paths["/assets/upload"]["post"]["parameters"]["query"]["file"];
|
|
16
16
|
file: BusyFile;
|
|
17
17
|
}
|
|
18
18
|
|
|
19
|
-
export declare interface AudioPlayParams {
|
|
19
|
+
export declare interface AudioPlayParams extends TimeoutOptions {
|
|
20
20
|
appId: paths["/audio/play"]["post"]["parameters"]["query"]["app_id"];
|
|
21
21
|
path: paths["/audio/play"]["post"]["parameters"]["query"]["path"];
|
|
22
22
|
}
|
|
23
23
|
|
|
24
24
|
export declare type AudioVolumeInfo = components["schemas"]["AudioVolumeInfo"];
|
|
25
25
|
|
|
26
|
-
export declare interface AudioVolumeParams {
|
|
26
|
+
export declare interface AudioVolumeParams extends TimeoutOptions {
|
|
27
27
|
volume: operations["setAudioVolume"]["parameters"]["query"]["volume"];
|
|
28
28
|
}
|
|
29
29
|
|
|
30
|
-
declare interface BaseConfig {
|
|
31
|
-
deviceScreen: DeviceScreen;
|
|
32
|
-
apiKey?: ApiKey;
|
|
33
|
-
apiSemver?: ApiSemver;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
declare interface BaseConfig_2 {
|
|
37
|
-
apiKey?: ApiKey;
|
|
38
|
-
apiSemver?: ApiSemver;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
30
|
export declare type BleStatusResponse = components["schemas"]["BleStatusResponse"];
|
|
42
31
|
|
|
43
32
|
declare type Brightness = number | "auto";
|
|
@@ -53,12 +42,19 @@ export declare class BusyBar {
|
|
|
53
42
|
* @type {BusyBarConfig['host']}
|
|
54
43
|
* @readonly
|
|
55
44
|
*/
|
|
56
|
-
readonly addr:
|
|
45
|
+
readonly addr: string;
|
|
57
46
|
/**
|
|
58
47
|
* Current API semantic version.
|
|
59
48
|
* @type {ApiSemver}
|
|
60
49
|
*/
|
|
61
50
|
apiSemver: ApiSemver;
|
|
51
|
+
/**
|
|
52
|
+
* Detected connection type based on auth requirements.
|
|
53
|
+
* - "wifi": Device requires authentication (returned 401/403).
|
|
54
|
+
* - "usb": Device allows access without token (returned 200).
|
|
55
|
+
* - "unknown": Detection failed or not yet completed.
|
|
56
|
+
*/
|
|
57
|
+
connectionType: "usb" | "wifi" | "unknown";
|
|
62
58
|
/**
|
|
63
59
|
* Creates an instance of BUSY Bar.
|
|
64
60
|
* Initializes the API client with the provided host address.
|
|
@@ -83,154 +79,242 @@ export declare class BusyBar {
|
|
|
83
79
|
*/
|
|
84
80
|
constructor(config?: BusyBarConfig);
|
|
85
81
|
/**
|
|
86
|
-
*
|
|
82
|
+
* Probes the device to determine connection type.
|
|
83
|
+
* Sends a request without authentication credentials.
|
|
84
|
+
*/
|
|
85
|
+
private detectConnectionType;
|
|
86
|
+
/**
|
|
87
|
+
* Get API version information.
|
|
87
88
|
*
|
|
89
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
90
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
88
91
|
* @returns {Promise<VersionInfo>} A promise that resolves to an object containing the `api_semver` string.
|
|
89
92
|
*/
|
|
90
|
-
|
|
93
|
+
SystemVersion(params?: TimeoutOptions): Promise<VersionInfo>;
|
|
94
|
+
/**
|
|
95
|
+
* @deprecated Use `SystemVersion` instead. will be removed in the next release.
|
|
96
|
+
*/
|
|
97
|
+
getApiVersion(params?: TimeoutOptions): Promise<VersionInfo>;
|
|
91
98
|
/**
|
|
92
|
-
*
|
|
99
|
+
* Update firmware. Uploads a firmware update package (TAR file) and initiates the update process.
|
|
93
100
|
*
|
|
94
101
|
* @param {UpdateParams} params - Parameters for the firmware update.
|
|
95
|
-
*
|
|
96
|
-
*
|
|
102
|
+
* @param {UpdateParams['name']} params.name - Name for the update package.
|
|
103
|
+
* @param {UpdateParams['file']} params.file - File data to upload.
|
|
104
|
+
* @param {UpdateParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
97
105
|
* @returns {Promise<SuccessResponse>} Result of the update operation.
|
|
98
106
|
*/
|
|
107
|
+
SystemUpdate(params: SystemUpdateParams): Promise<SuccessResponse>;
|
|
108
|
+
/**
|
|
109
|
+
* @deprecated Use `SystemUpdate` instead. will be removed in the next release.
|
|
110
|
+
*/
|
|
99
111
|
updateFirmware(params: SystemUpdateParams): Promise<SuccessResponse>;
|
|
100
112
|
/**
|
|
101
|
-
*
|
|
113
|
+
* Get device status.
|
|
102
114
|
*
|
|
115
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
116
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
103
117
|
* @returns {Promise<Status>} Current status of the device.
|
|
104
118
|
*/
|
|
105
|
-
|
|
119
|
+
SystemStatus(params?: TimeoutOptions): Promise<Status>;
|
|
120
|
+
/**
|
|
121
|
+
* @deprecated Use `SystemStatus` instead. will be removed in the next release.
|
|
122
|
+
*/
|
|
123
|
+
deviceStatus(params?: TimeoutOptions): Promise<Status>;
|
|
106
124
|
/**
|
|
107
|
-
*
|
|
125
|
+
* Get system status.
|
|
108
126
|
*
|
|
127
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
128
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
109
129
|
* @returns {Promise<StatusSystem>} Current system status.
|
|
110
130
|
*/
|
|
111
|
-
|
|
131
|
+
SystemInfo(params?: TimeoutOptions): Promise<StatusSystem>;
|
|
112
132
|
/**
|
|
113
|
-
*
|
|
133
|
+
* @deprecated Use `SystemInfo` instead. will be removed in the next release.
|
|
134
|
+
*/
|
|
135
|
+
systemStatus(params?: TimeoutOptions): Promise<StatusSystem>;
|
|
136
|
+
/**
|
|
137
|
+
* Get power status.
|
|
114
138
|
*
|
|
139
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
140
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
115
141
|
* @returns {Promise<StatusPower>} Current power status.
|
|
116
142
|
*/
|
|
117
|
-
|
|
143
|
+
SystemStatusPower(params?: TimeoutOptions): Promise<StatusPower>;
|
|
118
144
|
/**
|
|
119
|
-
*
|
|
145
|
+
* @deprecated Use `SystemStatusPower` instead. will be removed in the next release.
|
|
146
|
+
*/
|
|
147
|
+
powerStatus(params?: TimeoutOptions): Promise<StatusPower>;
|
|
148
|
+
/**
|
|
149
|
+
* Get current timestamp with timezone. Retrieves the current timestamp from RTC with timezone in ISO 8601 format.
|
|
120
150
|
*
|
|
151
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
152
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
121
153
|
* @returns {Promise<TimestampInfo>} Current device timestamp as an ISO 8601 string.
|
|
122
154
|
*/
|
|
123
|
-
|
|
155
|
+
SystemTime(params?: TimeoutOptions): Promise<TimestampInfo>;
|
|
156
|
+
/**
|
|
157
|
+
* @deprecated Use `SystemTime` instead. will be removed in the next release.
|
|
158
|
+
*/
|
|
159
|
+
getTime(params?: TimeoutOptions): Promise<TimestampInfo>;
|
|
124
160
|
/**
|
|
125
|
-
* Sets the
|
|
161
|
+
* Set current timestamp. Sets the RTC timestamp in ISO 8601 format.
|
|
162
|
+
* * - Without 'Z': treated as local time
|
|
163
|
+
* * - With 'Z': treated as UTC and converted to local time using current timezone offset
|
|
126
164
|
*
|
|
127
165
|
* @param {SetTimestampParams} params - The parameters for setting the timestamp.
|
|
128
|
-
*
|
|
166
|
+
* @param {SetTimestampParams['timestamp']} params.timestamp - The new timestamp (ISO 8601 string).
|
|
167
|
+
* @param {SetTimestampParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
129
168
|
* @returns {Promise<SuccessResponse>} A success response if the timestamp was set.
|
|
130
169
|
*/
|
|
170
|
+
SystemTimeTimestamp(params: SystemTimestampParams): Promise<SuccessResponse>;
|
|
171
|
+
/**
|
|
172
|
+
* @deprecated Use `SystemTimeTimestamp` instead. will be removed in the next release.
|
|
173
|
+
*/
|
|
131
174
|
setTimestamp(params: SystemTimestampParams): Promise<SuccessResponse>;
|
|
132
175
|
/**
|
|
133
|
-
* Sets the
|
|
176
|
+
* Set timezone offset. Sets the timezone offset in ±HH:MM format.
|
|
134
177
|
*
|
|
135
178
|
* @param {SetTimezoneParams} params - The parameters for setting the timezone.
|
|
136
|
-
*
|
|
179
|
+
* @param {SetTimezoneParams['timezone']} params.timezone - The new timezone identifier (IANA TZ string).
|
|
180
|
+
* @param {SetTimezoneParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
137
181
|
* @returns {Promise<SuccessResponse>} A success response if the timezone was set.
|
|
138
182
|
*/
|
|
183
|
+
SystemTimeTimezone(params: SystemTimezoneParams): Promise<SuccessResponse>;
|
|
184
|
+
/**
|
|
185
|
+
* @deprecated Use `SystemTimeTimezone` instead. will be removed in the next release.
|
|
186
|
+
*/
|
|
139
187
|
setTimezone(params: SystemTimezoneParams): Promise<SuccessResponse>;
|
|
140
188
|
/**
|
|
141
|
-
*
|
|
189
|
+
* Get MQTT status info.
|
|
142
190
|
*
|
|
191
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
192
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
143
193
|
* @returns {Promise<AccountInfo>} Information about the current MQTT account status.
|
|
144
194
|
*/
|
|
145
|
-
|
|
195
|
+
Account(params?: TimeoutOptions): Promise<AccountInfo>;
|
|
146
196
|
/**
|
|
147
|
-
*
|
|
197
|
+
* @deprecated Use `Account` instead. will be removed in the next release.
|
|
198
|
+
*/
|
|
199
|
+
getMqttStatus(params?: TimeoutOptions): Promise<AccountInfo>;
|
|
200
|
+
/**
|
|
201
|
+
* Unlink device from account. Removes account linking data.
|
|
148
202
|
*
|
|
203
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
204
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
149
205
|
* @returns {Promise<SuccessResponse>} Result of the account unlink operation.
|
|
150
206
|
*/
|
|
151
|
-
|
|
207
|
+
AccountUnlink(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
152
208
|
/**
|
|
153
|
-
*
|
|
209
|
+
* @deprecated Use `AccountUnlink` instead. will be removed in the next release.
|
|
210
|
+
*/
|
|
211
|
+
unlinkAccount(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
212
|
+
/**
|
|
213
|
+
* Link device to account. Requests account link PIN. Works only if device is connected to MQTT and is not linked to account.
|
|
154
214
|
*
|
|
215
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
216
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
155
217
|
* @returns {Promise<AccountLink>} Information about the account link operation.
|
|
156
218
|
*/
|
|
157
|
-
|
|
219
|
+
AccountLink(params?: TimeoutOptions): Promise<AccountLink>;
|
|
158
220
|
/**
|
|
159
|
-
*
|
|
221
|
+
* @deprecated Use `AccountLink` instead. will be removed in the next release.
|
|
222
|
+
*/
|
|
223
|
+
linkAccount(params?: TimeoutOptions): Promise<AccountLink>;
|
|
224
|
+
/**
|
|
225
|
+
* Upload asset file with app ID. Uploads a file to a specific app's assets directory.
|
|
160
226
|
*
|
|
161
227
|
* @param {UploadParams} params - Parameters for the upload.
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
228
|
+
* @param {UploadParams['appId']} params.appId - Application ID for organizing assets.
|
|
229
|
+
* @param {UploadParams['fileName']} params.fileName - Filename for the uploaded asset.
|
|
230
|
+
* @param {UploadParams['file']} params.file - File data to upload.
|
|
231
|
+
* @param {UploadParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
165
232
|
* @returns {Promise<SuccessResponse>} Result of the upload operation.
|
|
166
233
|
*/
|
|
234
|
+
AssetsUpload(params: AssetsUploadParams): Promise<SuccessResponse>;
|
|
235
|
+
/**
|
|
236
|
+
* @deprecated Use `AssetsUpload` instead. will be removed in the next release.
|
|
237
|
+
*/
|
|
167
238
|
uploadAsset(params: AssetsUploadParams): Promise<SuccessResponse>;
|
|
168
239
|
/**
|
|
169
|
-
* Deletes all assets for a specific
|
|
240
|
+
* Delete app assets. Deletes all assets for a specific app ID.
|
|
170
241
|
*
|
|
171
242
|
* @param {DeleteParams} params - Parameters for the delete.
|
|
172
|
-
*
|
|
243
|
+
* @param {DeleteParams['appId']} params.appId - Application ID whose assets should be deleted.
|
|
244
|
+
* @param {DeleteParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
173
245
|
* @returns {Promise<SuccessResponse>} Result of the delete operation.
|
|
174
246
|
*/
|
|
247
|
+
AssetsDelete(params: AssetsDeleteParams): Promise<SuccessResponse>;
|
|
248
|
+
/**
|
|
249
|
+
* @deprecated Use `AssetsDelete` instead. will be removed in the next release.
|
|
250
|
+
*/
|
|
175
251
|
deleteAssets(params: AssetsDeleteParams): Promise<SuccessResponse>;
|
|
176
252
|
/**
|
|
177
|
-
*
|
|
253
|
+
* Draw on display. Sends drawing data to the display. Supports JSON-defined display elements.
|
|
178
254
|
*
|
|
179
255
|
* @param {DrawParams} params - Parameters for the draw operation.
|
|
180
|
-
*
|
|
181
|
-
*
|
|
256
|
+
* @param {DrawParams['appId']} params.appId - Application ID for organizing display elements.
|
|
257
|
+
* @param {DrawParams['elements'][]} params.elements - Array of display elements (text or image).
|
|
258
|
+
* @param {DrawParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
182
259
|
* @returns {Promise<SuccessResponse>} Result of the draw operation.
|
|
183
260
|
*/
|
|
261
|
+
DisplayDraw(params: DisplayDrawParams): Promise<SuccessResponse>;
|
|
262
|
+
/**
|
|
263
|
+
* @deprecated Use `DisplayDraw` instead. will be removed in the next release.
|
|
264
|
+
*/
|
|
184
265
|
drawDisplay(params: DisplayDrawParams): Promise<SuccessResponse>;
|
|
185
266
|
/**
|
|
186
|
-
* Clears the
|
|
267
|
+
* Clear display. Clears the display and stops the Canvas application if running.
|
|
187
268
|
*
|
|
269
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
270
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
188
271
|
* @returns {Promise<SuccessResponse>} Result of the clear operation.
|
|
189
272
|
*/
|
|
190
|
-
|
|
273
|
+
DisplayClear(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
274
|
+
/**
|
|
275
|
+
* @deprecated Use `DisplayClear` instead. will be removed in the next release.
|
|
276
|
+
*/
|
|
277
|
+
clearDisplay(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
191
278
|
/**
|
|
192
|
-
* Plays an audio file from the assets directory.
|
|
279
|
+
* Play audio file. Plays an audio file from the assets directory. Supported formats include .snd files.
|
|
193
280
|
*
|
|
194
281
|
* @param {AudioPlayParams} params - Parameters for the audio playback.
|
|
195
|
-
*
|
|
196
|
-
*
|
|
282
|
+
* @param {AudioPlayParams['appId']} params.appId - Application ID for organizing assets.
|
|
283
|
+
* @param {AudioPlayParams['path']} params.path - Path to the audio file within the app's assets directory.
|
|
284
|
+
* @param {AudioPlayParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
197
285
|
* @returns {Promise<SuccessResponse>} Result of the play operation.
|
|
198
286
|
*/
|
|
287
|
+
AudioPlay(params: AudioPlayParams): Promise<SuccessResponse>;
|
|
288
|
+
/**
|
|
289
|
+
* @deprecated Use `AudioPlay` instead. will be removed in the next release.
|
|
290
|
+
*/
|
|
199
291
|
playSound(params: AudioPlayParams): Promise<SuccessResponse>;
|
|
200
292
|
/**
|
|
201
|
-
* Stops any currently playing audio
|
|
293
|
+
* Stop audio playback. Stops any currently playing audio.
|
|
202
294
|
*
|
|
295
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
296
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
203
297
|
* @returns {Promise<SuccessResponse>} Result of the stop operation.
|
|
204
298
|
*/
|
|
205
|
-
|
|
299
|
+
AudioStop(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
206
300
|
/**
|
|
207
|
-
* @deprecated
|
|
208
|
-
*
|
|
209
|
-
* This method is no longer supported and does nothing.
|
|
210
|
-
*
|
|
211
|
-
* Works only with BusyLib v0.5.0 and device firmware v0.3.0.
|
|
212
|
-
*
|
|
213
|
-
* Always throws an error.
|
|
301
|
+
* @deprecated Use `AudioStop` instead. will be removed in the next release.
|
|
214
302
|
*/
|
|
215
|
-
|
|
303
|
+
stopSound(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
216
304
|
/**
|
|
217
|
-
*
|
|
305
|
+
* Returns current Wi-Fi status.
|
|
218
306
|
*
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
* Always throws an error.
|
|
307
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
308
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
309
|
+
* @returns {Promise<WifiStatusResponse>} Current Wi-Fi status.
|
|
224
310
|
*/
|
|
225
|
-
|
|
311
|
+
WifiStatus(params?: TimeoutOptions): Promise<WifiStatusResponse>;
|
|
226
312
|
/**
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
* @returns {Promise<WifiStatusResponse>} Current Wi-Fi status.
|
|
313
|
+
* @deprecated Use `WifiStatus` instead. will be removed in the next release.
|
|
230
314
|
*/
|
|
231
|
-
statusWifi(): Promise<WifiStatusResponse>;
|
|
315
|
+
statusWifi(params?: TimeoutOptions): Promise<WifiStatusResponse>;
|
|
232
316
|
/**
|
|
233
|
-
*
|
|
317
|
+
* Attempts to connect to Wi-Fi using config.
|
|
234
318
|
*
|
|
235
319
|
* @param {ConnectParams} params - Connection parameters:
|
|
236
320
|
* @param {ConnectParams['ssid']} params.ssid - SSID (network name) to connect to.
|
|
@@ -242,138 +326,220 @@ export declare class BusyBar {
|
|
|
242
326
|
* @param {ConnectParams['ipConfig']['address']} [params.ipConfig.address] - Static IP address (if using "static" method).
|
|
243
327
|
* @param {ConnectParams['ipConfig']['mask']} [params.ipConfig.mask] - Subnet mask (if using "static" method).
|
|
244
328
|
* @param {ConnectParams['ipConfig']['gateway']} [params.ipConfig.gateway] - Gateway address (if using "static" method).
|
|
329
|
+
* @param {ConnectParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
245
330
|
* @returns {Promise<SuccessResponse>} Result of the connect operation.
|
|
246
331
|
*/
|
|
332
|
+
WifiConnect(params: WifiConnectParams): Promise<SuccessResponse>;
|
|
333
|
+
/**
|
|
334
|
+
* @deprecated Use `WifiConnect` instead. will be removed in the next release.
|
|
335
|
+
*/
|
|
247
336
|
connectWifi(params: WifiConnectParams): Promise<SuccessResponse>;
|
|
248
337
|
/**
|
|
249
|
-
* Disconnects
|
|
338
|
+
* Disconnects from Wi-Fi.
|
|
250
339
|
*
|
|
340
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
341
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
251
342
|
* @returns {Promise<SuccessResponse>} Result of the disconnect operation.
|
|
252
343
|
*/
|
|
253
|
-
|
|
344
|
+
WifiDisconnect(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
345
|
+
/**
|
|
346
|
+
* @deprecated Use `WifiDisconnect` instead. will be removed in the next release.
|
|
347
|
+
*/
|
|
348
|
+
disconnectWifi(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
254
349
|
/**
|
|
255
|
-
* Scans for available Wi-Fi networks
|
|
350
|
+
* Scans environment for available Wi-Fi networks.
|
|
256
351
|
*
|
|
352
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
353
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
257
354
|
* @returns {Promise<WifiNetworkResponse>} List of discovered networks.
|
|
258
355
|
*/
|
|
259
|
-
|
|
356
|
+
WifiNetworks(params?: TimeoutOptions): Promise<WifiNetworkResponse>;
|
|
260
357
|
/**
|
|
261
|
-
* @deprecated
|
|
262
|
-
*
|
|
263
|
-
* This method is no longer supported and does nothing.
|
|
264
|
-
*
|
|
265
|
-
* Works only with BusyLib v0.5.0 and device firmware v0.3.0.
|
|
266
|
-
*
|
|
267
|
-
* Always throws an error.
|
|
358
|
+
* @deprecated Use `WifiNetworks` instead. will be removed in the next release.
|
|
268
359
|
*/
|
|
269
|
-
|
|
360
|
+
networksWifi(params?: TimeoutOptions): Promise<WifiNetworkResponse>;
|
|
270
361
|
/**
|
|
271
|
-
* Uploads a file to
|
|
362
|
+
* Upload file to internal storage. Uploads a file to a specified path.
|
|
272
363
|
*
|
|
273
364
|
* @param {UploadFileParams} params - Upload parameters:
|
|
274
365
|
* @param {UploadFileParams['path']} params.path - Path where the file will be saved (e.g., "/ext/test.png").
|
|
275
366
|
* @param {UploadFileParams['file']} params.file - File data to upload.
|
|
367
|
+
* @param {UploadFileParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
276
368
|
* @returns {Promise<SuccessResponse>} Result of the upload operation.
|
|
277
369
|
*/
|
|
278
|
-
|
|
370
|
+
StorageWrite(params: StorageUploadFileParams): Promise<SuccessResponse>;
|
|
371
|
+
/**
|
|
372
|
+
* @deprecated Use `StorageWrite` instead. will be removed in the next release.
|
|
373
|
+
*/
|
|
374
|
+
uploadFile(params: StorageUploadFileParams): Promise<SuccessResponse>;
|
|
279
375
|
/**
|
|
280
|
-
* Downloads a file from
|
|
376
|
+
* Download file from internal storage. Downloads a file from a specified path.
|
|
281
377
|
*
|
|
282
378
|
* @param {DownloadFileParams} params - Download parameters:
|
|
283
379
|
* @param {DownloadFileParams['path']} params.path - Path to the file to download (e.g., "/ext/test.png").
|
|
284
380
|
* @param {DownloadFileParams['asArrayBuffer']} [params.asArrayBuffer] - If true, returns data as ArrayBuffer; otherwise, as Blob.
|
|
381
|
+
* @param {DownloadFileParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
285
382
|
* @returns {Promise<StorageReadResponse>} The file data.
|
|
286
383
|
*/
|
|
287
|
-
|
|
384
|
+
StorageRead(params: StorageDownloadFileParams): Promise<StorageReadResponse>;
|
|
288
385
|
/**
|
|
289
|
-
*
|
|
386
|
+
* @deprecated Use `StorageRead` instead. will be removed in the next release.
|
|
387
|
+
*/
|
|
388
|
+
downloadFile(params: StorageDownloadFileParams): Promise<StorageReadResponse>;
|
|
389
|
+
/**
|
|
390
|
+
* List files on internal storage.
|
|
290
391
|
*
|
|
291
392
|
* @param {ReadDirectoryParams} params - List parameters:
|
|
292
393
|
* @param {ReadDirectoryParams['path']} params.path - Path to the directory to list (e.g., "/ext").
|
|
394
|
+
* @param {ReadDirectoryParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
293
395
|
* @returns {Promise<StorageList>} List of files and directories.
|
|
294
396
|
*/
|
|
295
|
-
|
|
397
|
+
StorageList(params: StorageReadDirectoryParams): Promise<StorageList>;
|
|
296
398
|
/**
|
|
297
|
-
*
|
|
399
|
+
* @deprecated Use `StorageList` instead. will be removed in the next release.
|
|
400
|
+
*/
|
|
401
|
+
readDirectory(params: StorageReadDirectoryParams): Promise<StorageList>;
|
|
402
|
+
/**
|
|
403
|
+
* Remove a file on internal storage. Removes a file with a specified path.
|
|
298
404
|
*
|
|
299
405
|
* @param {RemoveParams} params - Remove parameters:
|
|
300
406
|
* @param {RemoveParams['path']} params.path - Path of the file to remove (e.g., "/ext/test.png").
|
|
407
|
+
* @param {RemoveParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
301
408
|
* @returns {Promise<SuccessResponse>} Result of the remove operation.
|
|
302
409
|
*/
|
|
303
|
-
|
|
410
|
+
StorageRemove(params: StorageRemoveParams): Promise<SuccessResponse>;
|
|
304
411
|
/**
|
|
305
|
-
*
|
|
412
|
+
* @deprecated Use `StorageRemove` instead. will be removed in the next release.
|
|
413
|
+
*/
|
|
414
|
+
removeResource(params: StorageRemoveParams): Promise<SuccessResponse>;
|
|
415
|
+
/**
|
|
416
|
+
* Create a directory on internal storage. Creates a new directory with a specified path.
|
|
306
417
|
*
|
|
307
418
|
* @param {CreateDirectoryParams} params - Directory creation parameters:
|
|
308
419
|
* @param {CreateDirectoryParams['path']} params.path - Path to the new directory (e.g., "/ext/newdir").
|
|
420
|
+
* @param {CreateDirectoryParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
309
421
|
* @returns {Promise<SuccessResponse>} Result of the create operation.
|
|
310
422
|
*/
|
|
311
|
-
|
|
423
|
+
StorageMkdir(params: StorageCreateDirectoryParams): Promise<SuccessResponse>;
|
|
424
|
+
/**
|
|
425
|
+
* @deprecated Use `StorageMkdir` instead. will be removed in the next release.
|
|
426
|
+
*/
|
|
427
|
+
createDirectory(params: StorageCreateDirectoryParams): Promise<SuccessResponse>;
|
|
312
428
|
/**
|
|
313
|
-
*
|
|
429
|
+
* Show storage usage.
|
|
314
430
|
*
|
|
431
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
432
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
315
433
|
* @returns {Promise<StorageStatus>} Current storage status information.
|
|
316
434
|
*/
|
|
317
|
-
|
|
435
|
+
StorageStatus(params?: TimeoutOptions): Promise<StorageStatus>;
|
|
436
|
+
/**
|
|
437
|
+
* @deprecated Use `StorageStatus` instead. will be removed in the next release.
|
|
438
|
+
*/
|
|
439
|
+
statusStorage(params?: TimeoutOptions): Promise<StorageStatus>;
|
|
318
440
|
/**
|
|
319
|
-
*
|
|
441
|
+
* Get brightness value for displays.
|
|
320
442
|
*
|
|
443
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
444
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
321
445
|
* @returns {Promise<DisplayBrightnessInfo>} Current brightness information for front and back panels.
|
|
322
446
|
*/
|
|
323
|
-
|
|
447
|
+
DisplayBrightness(params?: TimeoutOptions): Promise<DisplayBrightnessInfo>;
|
|
324
448
|
/**
|
|
325
|
-
*
|
|
449
|
+
* @deprecated Use `DisplayBrightness` instead. will be removed in the next release.
|
|
450
|
+
*/
|
|
451
|
+
getDisplayBrightness(params?: TimeoutOptions): Promise<DisplayBrightnessInfo>;
|
|
452
|
+
/**
|
|
453
|
+
* Set display brightness. Set brightness for one or both displays.
|
|
326
454
|
*
|
|
327
455
|
* @param {BrightnessParams} params - Brightness parameters:
|
|
328
456
|
* @param {BrightnessParams['front']} [params.front] - Brightness for the front panel (0-100 or "auto").
|
|
329
457
|
* @param {BrightnessParams['back']} [params.back] - Brightness for the back panel (0-100 or "auto").
|
|
458
|
+
* @param {BrightnessParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
330
459
|
* @returns {Promise<SuccessResponse>} Result of the brightness update operation.
|
|
331
460
|
* @throws {Error} If brightness value is outside the range 0-100 or not "auto".
|
|
332
461
|
*/
|
|
462
|
+
DisplayBrightnessSet(params: DisplayBrightnessParams): Promise<SuccessResponse>;
|
|
463
|
+
/**
|
|
464
|
+
* @deprecated Use `DisplayBrightnessSet` instead. will be removed in the next release.
|
|
465
|
+
*/
|
|
333
466
|
setDisplayBrightness(params: DisplayBrightnessParams): Promise<SuccessResponse>;
|
|
334
467
|
/**
|
|
335
|
-
*
|
|
468
|
+
* Get audio volume.
|
|
336
469
|
*
|
|
470
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
471
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
337
472
|
* @returns {Promise<AudioVolumeInfo>} Current audio volume (0-100).
|
|
338
473
|
*/
|
|
339
|
-
|
|
474
|
+
AudioVolume(params?: TimeoutOptions): Promise<AudioVolumeInfo>;
|
|
340
475
|
/**
|
|
341
|
-
*
|
|
476
|
+
* @deprecated Use `AudioVolume` instead. will be removed in the next release.
|
|
477
|
+
*/
|
|
478
|
+
getAudioVolume(params?: TimeoutOptions): Promise<AudioVolumeInfo>;
|
|
479
|
+
/**
|
|
480
|
+
* Set audio volume.
|
|
342
481
|
*
|
|
343
482
|
* @param {AudioVolumeParams} params - Audio volume parameters:
|
|
344
483
|
* @param {AudioVolumeParams['volume']} params.volume - Audio volume (number from 0 to 100).
|
|
484
|
+
* @param {AudioVolumeParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
345
485
|
* @returns {Promise<SuccessResponse>} Result of the volume update operation.
|
|
346
486
|
* @throws {Error} If volume is outside the range 0-100 or request fails.
|
|
347
487
|
*/
|
|
488
|
+
AudioVolumeSet(params: AudioVolumeParams): Promise<SuccessResponse>;
|
|
489
|
+
/**
|
|
490
|
+
* @deprecated Use `AudioVolumeSet` instead. will be removed in the next release.
|
|
491
|
+
*/
|
|
348
492
|
setAudioVolume(params: AudioVolumeParams): Promise<SuccessResponse>;
|
|
349
493
|
/**
|
|
350
|
-
*
|
|
494
|
+
* Get HTTP API access over Wi-Fi configuration.
|
|
351
495
|
*
|
|
496
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
497
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
352
498
|
* @returns {Promise<HttpAccessInfo>} Current HTTP access info.
|
|
353
499
|
*/
|
|
354
|
-
|
|
500
|
+
SettingsAccess(params?: TimeoutOptions): Promise<HttpAccessInfo>;
|
|
501
|
+
/**
|
|
502
|
+
* @deprecated Use `SettingsAccess` instead. will be removed in the next release.
|
|
503
|
+
*/
|
|
504
|
+
getHttpAccess(params?: TimeoutOptions): Promise<HttpAccessInfo>;
|
|
355
505
|
/**
|
|
356
|
-
*
|
|
506
|
+
* Set HTTP API access over Wi-Fi configuration.
|
|
357
507
|
*
|
|
358
508
|
* @param {HttpAccessParams} params - Access parameters:
|
|
359
509
|
* @param {HttpAccessParams['mode']} params.mode - Access mode ("disabled", "enabled", "key").
|
|
360
510
|
* @param {HttpAccessParams['key']} params.key - Access key (4-10 digits).
|
|
511
|
+
* @param {HttpAccessParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
361
512
|
* @returns {Promise<SuccessResponse>} Result of the set operation.
|
|
362
513
|
*/
|
|
514
|
+
SettingsAccessSet(params: HttpAccessParams): Promise<SuccessResponse>;
|
|
515
|
+
/**
|
|
516
|
+
* @deprecated Use `SettingsAccessSet` instead. will be removed in the next release.
|
|
517
|
+
*/
|
|
363
518
|
setHttpAccess(params: HttpAccessParams): Promise<SuccessResponse>;
|
|
364
519
|
/**
|
|
365
|
-
*
|
|
520
|
+
* Get current device name.
|
|
366
521
|
*
|
|
522
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
523
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
367
524
|
* @returns {Promise<NameInfo>} The current device name information.
|
|
368
525
|
*/
|
|
369
|
-
|
|
526
|
+
SettingsName(params?: TimeoutOptions): Promise<NameInfo>;
|
|
527
|
+
/**
|
|
528
|
+
* @deprecated Use `SettingsName` instead. will be removed in the next release.
|
|
529
|
+
*/
|
|
530
|
+
getName(params?: TimeoutOptions): Promise<NameInfo>;
|
|
370
531
|
/**
|
|
371
|
-
*
|
|
532
|
+
* Set new device name.
|
|
372
533
|
*
|
|
373
534
|
* @param {NameParams} params - The parameters for setting the device name.
|
|
374
|
-
*
|
|
535
|
+
* @param {NameParams['name']} params.name - The new device name.
|
|
536
|
+
* @param {NameParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
375
537
|
* @returns {Promise<SuccessResponse>} Result of setting the device name.
|
|
376
538
|
*/
|
|
539
|
+
SettingsNameSet(params: NameParams): Promise<SuccessResponse>;
|
|
540
|
+
/**
|
|
541
|
+
* @deprecated Use `SettingsNameSet` instead. will be removed in the next release.
|
|
542
|
+
*/
|
|
377
543
|
setName(params: NameParams): Promise<SuccessResponse>;
|
|
378
544
|
/**
|
|
379
545
|
* Sets API key for all subsequent requests.
|
|
@@ -381,42 +547,72 @@ export declare class BusyBar {
|
|
|
381
547
|
*/
|
|
382
548
|
setApiKey(key: string): void;
|
|
383
549
|
/**
|
|
384
|
-
* Enables BLE module.
|
|
550
|
+
* Enable BLE. Enables BLE module and starts advertising.
|
|
551
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
552
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
385
553
|
* @returns {Promise<SuccessResponse>} Result of the enable operation.
|
|
386
554
|
*/
|
|
387
|
-
|
|
555
|
+
BleEnable(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
388
556
|
/**
|
|
389
|
-
*
|
|
557
|
+
* @deprecated Use `BleEnable` instead. will be removed in the next release.
|
|
558
|
+
*/
|
|
559
|
+
enableBle(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
560
|
+
/**
|
|
561
|
+
* Disable BLE. Stops advertising.
|
|
562
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
563
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
390
564
|
* @returns {Promise<SuccessResponse>} Result of the disable operation.
|
|
391
565
|
*/
|
|
392
|
-
|
|
566
|
+
BleDisable(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
393
567
|
/**
|
|
394
|
-
*
|
|
568
|
+
* @deprecated Use `BleDisable` instead. will be removed in the next release.
|
|
569
|
+
*/
|
|
570
|
+
disableBle(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
571
|
+
/**
|
|
572
|
+
* Remove pairing. Remove pairing with previous device.
|
|
395
573
|
*
|
|
574
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
575
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
396
576
|
* @returns {Promise<SuccessResponse>} Result of the BLE pairing removal operation.
|
|
397
577
|
*/
|
|
398
|
-
|
|
578
|
+
BleUnpair(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
579
|
+
/**
|
|
580
|
+
* @deprecated Use `BleUnpair` instead. will be removed in the next release.
|
|
581
|
+
*/
|
|
582
|
+
pairingBle(params?: TimeoutOptions): Promise<SuccessResponse>;
|
|
399
583
|
/**
|
|
400
|
-
*
|
|
584
|
+
* Returns current BLE status.
|
|
401
585
|
*
|
|
586
|
+
* @param {TimeoutOptions} [params] - Optional parameters.
|
|
587
|
+
* @param {TimeoutOptions['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
402
588
|
* @returns {Promise<BleStatusResponse>} Current BLE status information.
|
|
403
589
|
*/
|
|
404
|
-
|
|
590
|
+
BleStatus(params?: TimeoutOptions): Promise<BleStatusResponse>;
|
|
591
|
+
/**
|
|
592
|
+
* @deprecated Use `BleStatus` instead. will be removed in the next release.
|
|
593
|
+
*/
|
|
594
|
+
statusBle(params?: TimeoutOptions): Promise<BleStatusResponse>;
|
|
405
595
|
/**
|
|
406
|
-
*
|
|
596
|
+
* Send input event. Send single key press event.
|
|
407
597
|
*
|
|
408
598
|
* @param params - Button press parameters:
|
|
409
599
|
* @param {InputKeyParams['keyName']} params.keyName - Button key.
|
|
600
|
+
* @param {InputKeyParams['timeout']} [params.timeout] - Request timeout in milliseconds.
|
|
410
601
|
* @example
|
|
411
602
|
* {
|
|
412
|
-
* keyName: "ok"
|
|
603
|
+
* keyName: "ok",
|
|
604
|
+
* timeout: 1000
|
|
413
605
|
* }
|
|
414
606
|
* @returns {Promise<SuccessResponse>} Result of pressing the button.
|
|
415
607
|
*/
|
|
608
|
+
InputSend(params: InputKeyParams): Promise<SuccessResponse>;
|
|
609
|
+
/**
|
|
610
|
+
* @deprecated Use `InputSend` instead. will be removed in the next release.
|
|
611
|
+
*/
|
|
416
612
|
pressButton(params: InputKeyParams): Promise<SuccessResponse>;
|
|
417
613
|
}
|
|
418
614
|
|
|
419
|
-
declare type BusyBarConfig = {
|
|
615
|
+
export declare type BusyBarConfig = {
|
|
420
616
|
addr?: string;
|
|
421
617
|
token?: string;
|
|
422
618
|
};
|
|
@@ -852,22 +1048,12 @@ declare interface components {
|
|
|
852
1048
|
pathItems: never;
|
|
853
1049
|
}
|
|
854
1050
|
|
|
855
|
-
declare interface CreateDirectoryParams {
|
|
856
|
-
path: operations["createStorageDir"]["parameters"]["query"]["path"];
|
|
857
|
-
}
|
|
858
|
-
export { CreateDirectoryParams }
|
|
859
|
-
export { CreateDirectoryParams as StorageCreateDirectoryParams }
|
|
860
|
-
|
|
861
1051
|
declare type DataListener = (data: Uint8Array) => void;
|
|
862
1052
|
|
|
863
1053
|
declare type DeepCamelize<T> = T extends (...args: any[]) => any ? T : T extends Array<infer U> ? Array<DeepCamelize<U>> : T extends object ? {
|
|
864
1054
|
[K in keyof T as SnakeToCamel<K & string>]: DeepCamelize<T[K]>;
|
|
865
1055
|
} : T;
|
|
866
1056
|
|
|
867
|
-
declare type DeviceConfig = LocalConfig | SiteConfig;
|
|
868
|
-
|
|
869
|
-
declare type DeviceConfig_2 = LocalConfig_2 | SiteConfig_2;
|
|
870
|
-
|
|
871
1057
|
export declare enum DeviceScreen {
|
|
872
1058
|
FRONT = 0,
|
|
873
1059
|
BACK = 1
|
|
@@ -875,23 +1061,16 @@ export declare enum DeviceScreen {
|
|
|
875
1061
|
|
|
876
1062
|
export declare type DisplayBrightnessInfo = components["schemas"]["DisplayBrightnessInfo"];
|
|
877
1063
|
|
|
878
|
-
export declare interface DisplayBrightnessParams {
|
|
1064
|
+
export declare interface DisplayBrightnessParams extends TimeoutOptions {
|
|
879
1065
|
front?: Brightness;
|
|
880
1066
|
back?: Brightness;
|
|
881
1067
|
}
|
|
882
1068
|
|
|
883
|
-
export declare interface DisplayDrawParams {
|
|
1069
|
+
export declare interface DisplayDrawParams extends TimeoutOptions {
|
|
884
1070
|
appId: components["schemas"]["DisplayElements"]["app_id"];
|
|
885
1071
|
elements: components["schemas"]["DisplayElements"]["elements"];
|
|
886
1072
|
}
|
|
887
1073
|
|
|
888
|
-
declare interface DownloadFileParams {
|
|
889
|
-
path: operations["readStorageFile"]["parameters"]["query"]["path"];
|
|
890
|
-
asArrayBuffer?: boolean;
|
|
891
|
-
}
|
|
892
|
-
export { DownloadFileParams }
|
|
893
|
-
export { DownloadFileParams as StorageDownloadFileParams }
|
|
894
|
-
|
|
895
1074
|
declare type Error_2 = components["schemas"]["Error"];
|
|
896
1075
|
export { Error_2 as Error }
|
|
897
1076
|
|
|
@@ -905,13 +1084,13 @@ declare interface ErrorPayload {
|
|
|
905
1084
|
|
|
906
1085
|
export declare type HttpAccessInfo = components["schemas"]["HttpAccessInfo"];
|
|
907
1086
|
|
|
908
|
-
export declare interface HttpAccessParams {
|
|
1087
|
+
export declare interface HttpAccessParams extends TimeoutOptions {
|
|
909
1088
|
mode: operations["setHttpAccess"]["parameters"]["query"]["mode"];
|
|
910
1089
|
key: operations["setHttpAccess"]["parameters"]["query"]["key"];
|
|
911
1090
|
}
|
|
912
1091
|
|
|
913
1092
|
export declare class Input {
|
|
914
|
-
|
|
1093
|
+
readonly addr: string;
|
|
915
1094
|
connected: boolean;
|
|
916
1095
|
private apiKey?;
|
|
917
1096
|
private apiSemver?;
|
|
@@ -920,7 +1099,7 @@ export declare class Input {
|
|
|
920
1099
|
private stopListeners;
|
|
921
1100
|
private errorListeners;
|
|
922
1101
|
private socket;
|
|
923
|
-
constructor(config
|
|
1102
|
+
constructor(config?: InputConfig);
|
|
924
1103
|
onData(listener: DataListener): void;
|
|
925
1104
|
onStop(listener: StopListener): void;
|
|
926
1105
|
onError(listener: ErrorListener): void;
|
|
@@ -935,7 +1114,13 @@ export declare class Input {
|
|
|
935
1114
|
closeWebsocket(): Promise<void>;
|
|
936
1115
|
}
|
|
937
1116
|
|
|
938
|
-
export declare interface
|
|
1117
|
+
export declare interface InputConfig {
|
|
1118
|
+
addr?: string;
|
|
1119
|
+
apiKey?: ApiKey;
|
|
1120
|
+
apiSemver?: ApiSemver;
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
export declare interface InputKeyParams extends TimeoutOptions {
|
|
939
1124
|
keyName: KeyName;
|
|
940
1125
|
}
|
|
941
1126
|
|
|
@@ -943,19 +1128,9 @@ export declare type KeyName = operations["setInputKey"]["parameters"]["query"]["
|
|
|
943
1128
|
|
|
944
1129
|
export declare type KeyValue = 1 | 0;
|
|
945
1130
|
|
|
946
|
-
declare interface LocalConfig extends BaseConfig {
|
|
947
|
-
mode: "local";
|
|
948
|
-
barUrl: string;
|
|
949
|
-
}
|
|
950
|
-
|
|
951
|
-
declare interface LocalConfig_2 extends BaseConfig_2 {
|
|
952
|
-
mode: "local";
|
|
953
|
-
barUrl: string;
|
|
954
|
-
}
|
|
955
|
-
|
|
956
1131
|
export declare type NameInfo = components["schemas"]["NameInfo"];
|
|
957
1132
|
|
|
958
|
-
export declare interface NameParams {
|
|
1133
|
+
export declare interface NameParams extends TimeoutOptions {
|
|
959
1134
|
name: NameInfo["name"];
|
|
960
1135
|
}
|
|
961
1136
|
|
|
@@ -3040,24 +3215,13 @@ declare interface paths {
|
|
|
3040
3215
|
};
|
|
3041
3216
|
}
|
|
3042
3217
|
|
|
3043
|
-
declare interface ReadDirectoryParams {
|
|
3044
|
-
path: operations["listStorageFiles"]["parameters"]["query"]["path"];
|
|
3045
|
-
}
|
|
3046
|
-
export { ReadDirectoryParams }
|
|
3047
|
-
export { ReadDirectoryParams as StorageReadDirectoryParams }
|
|
3048
|
-
|
|
3049
|
-
declare interface RemoveParams {
|
|
3050
|
-
path: operations["removeStorageFile"]["parameters"]["query"]["path"];
|
|
3051
|
-
}
|
|
3052
|
-
export { RemoveParams }
|
|
3053
|
-
export { RemoveParams as StorageRemoveParams }
|
|
3054
|
-
|
|
3055
3218
|
declare type RequiredIpConfig = RequireKeys<NonNullable<CamelizedRequest["ipConfig"]>, "ipMethod">;
|
|
3056
3219
|
|
|
3057
3220
|
declare type RequireKeys<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
|
|
3058
3221
|
|
|
3059
3222
|
export declare class ScreenStream {
|
|
3060
3223
|
private config;
|
|
3224
|
+
readonly addr: string;
|
|
3061
3225
|
connected: boolean;
|
|
3062
3226
|
private apiKey?;
|
|
3063
3227
|
private apiSemver?;
|
|
@@ -3065,7 +3229,7 @@ export declare class ScreenStream {
|
|
|
3065
3229
|
private stopListeners;
|
|
3066
3230
|
private errorListeners;
|
|
3067
3231
|
private socket;
|
|
3068
|
-
constructor(config:
|
|
3232
|
+
constructor(config: ScreenStreamConfig);
|
|
3069
3233
|
onData(listener: DataListener): void;
|
|
3070
3234
|
onStop(listener: StopListener): void;
|
|
3071
3235
|
onError(listener: ErrorListener): void;
|
|
@@ -3076,18 +3240,11 @@ export declare class ScreenStream {
|
|
|
3076
3240
|
closeWebsocket(): Promise<void>;
|
|
3077
3241
|
}
|
|
3078
3242
|
|
|
3079
|
-
declare interface
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
}
|
|
3085
|
-
|
|
3086
|
-
declare interface SiteConfig_2 extends BaseConfig_2 {
|
|
3087
|
-
mode: "cloud";
|
|
3088
|
-
domain: string;
|
|
3089
|
-
token: string;
|
|
3090
|
-
idDevice: string;
|
|
3243
|
+
export declare interface ScreenStreamConfig {
|
|
3244
|
+
deviceScreen: DeviceScreen;
|
|
3245
|
+
addr?: string;
|
|
3246
|
+
apiKey?: ApiKey;
|
|
3247
|
+
apiSemver?: ApiSemver;
|
|
3091
3248
|
}
|
|
3092
3249
|
|
|
3093
3250
|
declare type SnakeToCamel<S extends string> = S extends `${infer Head}_${infer Tail}` ? `${Head}${Capitalize<SnakeToCamel<Tail>>}` : S;
|
|
@@ -3100,47 +3257,66 @@ export declare type StatusSystem = components["schemas"]["StatusSystem"];
|
|
|
3100
3257
|
|
|
3101
3258
|
declare type StopListener = () => void;
|
|
3102
3259
|
|
|
3260
|
+
export declare interface StorageCreateDirectoryParams extends TimeoutOptions {
|
|
3261
|
+
path: operations["createStorageDir"]["parameters"]["query"]["path"];
|
|
3262
|
+
}
|
|
3263
|
+
|
|
3103
3264
|
export declare type StorageDirElement = components["schemas"]["StorageDirElement"];
|
|
3104
3265
|
|
|
3266
|
+
export declare interface StorageDownloadFileParams extends TimeoutOptions {
|
|
3267
|
+
path: operations["readStorageFile"]["parameters"]["query"]["path"];
|
|
3268
|
+
asArrayBuffer?: boolean;
|
|
3269
|
+
}
|
|
3270
|
+
|
|
3105
3271
|
export declare type StorageFileElement = components["schemas"]["StorageFileElement"];
|
|
3106
3272
|
|
|
3107
3273
|
export declare type StorageList = components["schemas"]["StorageList"];
|
|
3108
3274
|
|
|
3109
3275
|
export declare type StorageListElement = components["schemas"]["StorageListElement"];
|
|
3110
3276
|
|
|
3277
|
+
export declare interface StorageReadDirectoryParams extends TimeoutOptions {
|
|
3278
|
+
path: operations["listStorageFiles"]["parameters"]["query"]["path"];
|
|
3279
|
+
}
|
|
3280
|
+
|
|
3111
3281
|
export declare type StorageReadResponse = ArrayBuffer | Blob;
|
|
3112
3282
|
|
|
3283
|
+
export declare interface StorageRemoveParams extends TimeoutOptions {
|
|
3284
|
+
path: operations["removeStorageFile"]["parameters"]["query"]["path"];
|
|
3285
|
+
}
|
|
3286
|
+
|
|
3113
3287
|
export declare type StorageStatus = components["schemas"]["StorageStatus"];
|
|
3114
3288
|
|
|
3289
|
+
export declare interface StorageUploadFileParams extends TimeoutOptions {
|
|
3290
|
+
path: operations["writeStorageFile"]["parameters"]["query"]["path"];
|
|
3291
|
+
file: BusyFile;
|
|
3292
|
+
}
|
|
3293
|
+
|
|
3115
3294
|
export declare type SuccessResponse = components["schemas"]["SuccessResponse"];
|
|
3116
3295
|
|
|
3117
|
-
export declare interface SystemTimestampParams {
|
|
3296
|
+
export declare interface SystemTimestampParams extends TimeoutOptions {
|
|
3118
3297
|
timestamp: operations["setTimeTimestamp"]["parameters"]["query"]["timestamp"];
|
|
3119
3298
|
}
|
|
3120
3299
|
|
|
3121
|
-
export declare interface SystemTimezoneParams {
|
|
3300
|
+
export declare interface SystemTimezoneParams extends TimeoutOptions {
|
|
3122
3301
|
timezone: operations["setTimeTimezone"]["parameters"]["query"]["timezone"];
|
|
3123
3302
|
}
|
|
3124
3303
|
|
|
3125
|
-
export declare interface SystemUpdateParams {
|
|
3304
|
+
export declare interface SystemUpdateParams extends TimeoutOptions {
|
|
3126
3305
|
name?: string;
|
|
3127
3306
|
file: BusyFile;
|
|
3128
3307
|
}
|
|
3129
3308
|
|
|
3130
|
-
|
|
3131
|
-
|
|
3132
|
-
declare interface UploadFileParams {
|
|
3133
|
-
path: operations["writeStorageFile"]["parameters"]["query"]["path"];
|
|
3134
|
-
file: BusyFile;
|
|
3309
|
+
declare interface TimeoutOptions {
|
|
3310
|
+
timeout?: number;
|
|
3135
3311
|
}
|
|
3136
|
-
|
|
3137
|
-
export
|
|
3312
|
+
|
|
3313
|
+
export declare type TimestampInfo = components["schemas"]["TimestampInfo"];
|
|
3138
3314
|
|
|
3139
3315
|
export declare type VersionInfo = components["schemas"]["VersionInfo"];
|
|
3140
3316
|
|
|
3141
3317
|
export declare type WifiConnectParams = RequireKeys<Omit<CamelizedRequest, "ipConfig"> & {
|
|
3142
3318
|
ipConfig: RequiredIpConfig;
|
|
3143
|
-
}, "ssid" | "security" | "ipConfig"
|
|
3319
|
+
}, "ssid" | "security" | "ipConfig"> & TimeoutOptions;
|
|
3144
3320
|
|
|
3145
3321
|
export declare type WifiConnectRequestConfig = components["schemas"]["ConnectRequestConfig"];
|
|
3146
3322
|
|