@@ -55,18 +55,18 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
55
55
- ` binaryData ` (Uint8Array) (required): The data to be uploaded, represented in bytes.
56
56
- ` partId ` (string) (required): The part ID of the component used to capture the data.
57
57
- ` componentType ` (string) (required): The type of the component used to capture the data
58
- (for example, "movementSensor").
58
+ (for example, "movementSensor").
59
59
- ` componentName ` (string) (required): The name of the component used to capture the data.
60
60
- ` methodName ` (string) (required): The name of the method used to capture the data.
61
61
- ` fileExtension ` (string) (required): The file extension of binary data including the
62
- period, for example .jpg, .png, or .pcd. The backend will route the binary to its
63
- corresponding mime type based on this extension. Files with a .jpeg,
64
- .jpg, or .png extension will be saved to the images tab.
62
+ period, for example .jpg, .png, or .pcd. The backend will route the
63
+ binary to its corresponding mime type based on this extension. Files with
64
+ a .jpeg, .jpg, or .png extension will be saved to the images tab.
65
65
- ` dataRequestTimes ` (Date) (required): Tuple containing Date objects denoting the times
66
- this data was requested[ 0] by the robot and received[ 1] from the
67
- appropriate sensor.
66
+ this data was requested[ 0] by the robot and received[ 1] from the
67
+ appropriate sensor.
68
68
- ` tags ` (string) (optional): The list of tags to allow for tag-based filtering when
69
- retrieving data.
69
+ retrieving data.
70
70
71
71
** Returns:**
72
72
@@ -77,12 +77,12 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
77
77
``` ts {class="line-numbers linkable-line-numbers"}
78
78
const binaryDataId = await dataClient .binaryDataCaptureUpload (
79
79
binaryData ,
80
- " 123abc45-1234-5678-90ab-cdef12345678" ,
81
- " rdk:component:camera" ,
82
- " my-camera" ,
83
- " ReadImage" ,
84
- " .jpg" ,
85
- [new Date (" 2025-03-19" ), new Date (" 2025-03-19" )],
80
+ ' 123abc45-1234-5678-90ab-cdef12345678' ,
81
+ ' rdk:component:camera' ,
82
+ ' my-camera' ,
83
+ ' ReadImage' ,
84
+ ' .jpg' ,
85
+ [new Date (' 2025-03-19' ), new Date (' 2025-03-19' )]
86
86
);
87
87
```
88
88
@@ -93,19 +93,19 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/
93
93
94
94
** Parameters:**
95
95
96
- - ` binaryData ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) <[ int] ( https://api.flutter.dev/flutter/dart-core/int-class.html ) > (required)
96
+ - ` binaryData ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) \ <[ int] ( https://api.flutter.dev/flutter/dart-core/int-class.html ) \ > (required)
97
97
- ` partId ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) (required)
98
98
- ` fileExtension ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) (required)
99
99
- ` componentType ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
100
100
- ` componentName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
101
101
- ` methodName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
102
- - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any>? (optional)
102
+ - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any\ > ? (optional)
103
103
- ` dataRequestTimes ` ([ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) , [ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) )? (optional)
104
- - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) > (optional)
104
+ - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ > (optional)
105
105
106
106
** Returns:**
107
107
108
- - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) >
108
+ - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ >
109
109
110
110
** Example:**
111
111
@@ -203,19 +203,19 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
203
203
** Parameters:**
204
204
205
205
- ` tabularData ` (Record) (required): The list of data to be uploaded, represented tabularly
206
- as an array.
206
+ as an array.
207
207
- ` partId ` (string) (required): The part ID of the component used to capture the data.
208
208
- ` componentType ` (string) (required): The type of the component used to capture the data
209
- (for example, "movementSensor").
209
+ (for example, "movementSensor").
210
210
- ` componentName ` (string) (required): The name of the component used to capture the data.
211
211
- ` methodName ` (string) (required): The name of the method used to capture the data.
212
212
- ` dataRequestTimes ` (Date) (required): Array of Date tuples, each containing two Date
213
- objects denoting the times this data was requested[ 0] by the robot and
214
- received[ 1] from the appropriate sensor. Passing a list of tabular data
215
- and Timestamps with length n > 1 will result in n datapoints being
216
- uploaded, all tied to the same metadata.
213
+ objects denoting the times this data was requested[ 0] by the robot and
214
+ received[ 1] from the appropriate sensor. Passing a list of tabular data
215
+ and Timestamps with length n > 1 will result in n datapoints being
216
+ uploaded, all tied to the same metadata.
217
217
- ` tags ` (string) (optional): The list of tags to allow for tag-based filtering when
218
- retrieving data.
218
+ retrieving data.
219
219
220
220
** Returns:**
221
221
@@ -227,15 +227,20 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
227
227
const fileId = await dataClient .tabularDataCaptureUpload (
228
228
[
229
229
{
230
- timestamp: " 2025-03-26T10:00:00Z" ,
230
+ timestamp: ' 2025-03-26T10:00:00Z' ,
231
231
value: 10 ,
232
232
},
233
233
],
234
- " 123abc45-1234-5678-90ab-cdef12345678" ,
235
- " rdk:component:sensor" ,
236
- " my-sensor" ,
237
- " Readings" ,
238
- [[new Date (" 2025-03-26T10:00:00Z" ), new Date (" 2025-03-26T10:00:00Z" )]],
234
+ ' 123abc45-1234-5678-90ab-cdef12345678' ,
235
+ ' rdk:component:sensor' ,
236
+ ' my-sensor' ,
237
+ ' Readings' ,
238
+ [
239
+ [
240
+ new Date (' 2025-03-26T10:00:00Z' ),
241
+ new Date (' 2025-03-26T10:00:00Z' ),
242
+ ],
243
+ ]
239
244
);
240
245
```
241
246
@@ -246,18 +251,18 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/
246
251
247
252
** Parameters:**
248
253
249
- - ` tabularData ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) <[ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , dynamic> > (required)
254
+ - ` tabularData ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) \ <[ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , dynamic\>\ > (required)
250
255
- ` partId ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) (required)
251
256
- ` componentType ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
252
257
- ` componentName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
253
258
- ` methodName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
254
- - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any>? (optional)
255
- - ` dataRequestTimes ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) <([ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) , [ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) )>? (optional)
256
- - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) > (optional)
259
+ - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any\ > ? (optional)
260
+ - ` dataRequestTimes ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) \ < ([ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) , [ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) )\ > ? (optional)
261
+ - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ > (optional)
257
262
258
263
** Returns:**
259
264
260
- - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) >
265
+ - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ >
261
266
262
267
** Example:**
263
268
@@ -359,12 +364,12 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
359
364
- ` componentType ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
360
365
- ` componentName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
361
366
- ` methodName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
362
- - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any>? (optional)
363
- - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) > (optional)
367
+ - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any\ > ? (optional)
368
+ - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ > (optional)
364
369
365
370
** Returns:**
366
371
367
- - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) >
372
+ - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ >
368
373
369
374
** Example:**
370
375
@@ -513,19 +518,19 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
513
518
514
519
** Parameters:**
515
520
516
- - ` bytes ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) <[ int] ( https://api.flutter.dev/flutter/dart-core/int-class.html ) > (required)
521
+ - ` bytes ` [ List] ( https://api.flutter.dev/flutter/dart-core/List-class.html ) \ <[ int] ( https://api.flutter.dev/flutter/dart-core/int-class.html ) \ > (required)
517
522
- ` partId ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) (required)
518
523
- ` fileExtension ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) (required)
519
524
- ` componentType ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
520
525
- ` componentName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
521
526
- ` methodName ` [ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) ? (optional)
522
- - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any>? (optional)
527
+ - ` methodParameters ` [ Map] ( https://api.flutter.dev/flutter/dart-core/Map-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) , Any\ > ? (optional)
523
528
- ` dataRequestTimes ` ([ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) , [ DateTime] ( https://api.flutter.dev/flutter/dart-core/DateTime-class.html ) )? (optional)
524
- - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) > (optional)
529
+ - ` tags ` [ Iterable] ( https://api.flutter.dev/flutter/dart-core/Iterable-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ > (optional)
525
530
526
531
** Returns:**
527
532
528
- - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) >
533
+ - [ Future] ( https://api.flutter.dev/flutter/dart-async/Future-class.html ) \ <[ String] ( https://api.flutter.dev/flutter/dart-core/String-class.html ) \ >
529
534
530
535
** Example:**
531
536
0 commit comments