DOCS-4403: Add new methods (#4656)

Author: npentrel

.github/workflows/sdk_protos_map.csv

@@ -235,6 +235,8 @@ base_remote_control,Close,,,Close,,
 
 ## Data Manager
 data_manager,Sync,No,,Sync,,sync
+data_manager,UploadImageToDatasets,No,,UploadImageToDatasets,,,
+data_manager,UploadBinaryDataToDatasets,No,,UploadBinaryDataToDatasets,,uploadBinaryDataToDatasets
 ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping:
 data_manager,Reconfigure,No,,Reconfigure,,
 data_manager,DoCommand,No,,DoCommand,,doCommand
@@ -255,7 +257,7 @@ mlmodel,Metadata,,metadata,Metadata,,
 ## HACK:  proto for DoCommand or Close (and/or inherited in Go SDK), manually mapping:
 mlmodel,Reconfigure,,,Reconfigure,,
 mlmodel,DoCommand,,,DoCommand,,
-mlmodel,GetResourceName,,get_resource_name,,,
+mlmodel,GetResourceName,,get_resource_name,Name,,
 mlmodel,Close,,close,Close,,
 
 ## Motion
@@ -471,6 +473,9 @@ data_sync,StreamingDataCaptureUpload,,streaming_data_capture_upload,,streamingDa
 
 ## Discovery
 discovery,DiscoverResources,,discover_resources,DiscoverResources,discoverResources,discoverResources
+discovery,GetResourceName,,get_resource_name,Name,getResourceName,name
+discovery,DoCommand,,do_command,DoCommand,doCommand,doCommand
+discovery,Close,,close,Close,,
 
 ## MLTraining
 mltraining,SubmitTrainingJob,,submit_training_job,SubmitTrainingJob,,submitTrainingJob

.github/workflows/update_sdk_methods.py

@@ -766,7 +766,7 @@ def check_for_unused_methods(methods, type):
                 if not "used" in methods[lang][type][resource][method].keys():
                     if resource in ["data_sync", "dataset", "data"]:
                         continue
-                    if lang == "python" and method not in ["from_robot", "close", "get_resource_name", "get_geometries", "do_command", "proto"] or \
+                    if lang == "python" and method not in ["from_robot", "close", "get_resource_name", "get_geometries", "do_command", "proto", "transform", "updated_fields", "ListUUIDs", "GetTransform", "StreamTransformChanges", "DoCommand"] or \
                         lang == "go" and method not in ["Reconfigure", "Stream", "ListTunnels", "Close", "DoCommand", "CurrentPosition", "AddTagsToBinaryDataByFilter", "RemoveTagsFromBinaryDataByFilter"] or \
                         lang == "flutter" and method not in ["getResources", "getStream", "getStreamOptions", "resetStreamOptions", "setStreamOptions", "Discovery.fromProto", "addCallbacks", "getResource"] or \
                         lang == "typescript" and method not in ["connect", "disconnect", "dial", "isConnected", "discoverComponents", "createServiceClient", "getRoverRentalRobots", "doCommand"]:

static/include/app/apis/overrides/protos/data.UploadImageToDatasets.md

@@ -0,0 +1 @@
+Uploads the contents and metadata for an image, adds it to a dataset, and returns the file id of the uploaded data.

static/include/services/apis/generated/data_manager-table.md

@@ -2,6 +2,8 @@
 | Method Name | Description | `viam-micro-server` Support |
 | ----------- | ----------- | --------------------------- |
 | [`Sync`](/dev/reference/apis/services/data/#sync) | Sync data stored on the machine to the cloud. |  |
+| [`UploadImageToDatasets`](/dev/reference/apis/services/data/#uploadimagetodatasets) | Upload an image data to the specified datasets. |  |
+| [`UploadBinaryDataToDatasets`](/dev/reference/apis/services/data/#uploadbinarydatatodatasets) | Upload Binary data to the specified datasets. |  |
 | [`Reconfigure`](/dev/reference/apis/services/data/#reconfigure) | Reconfigure this resource. |  |
 | [`DoCommand`](/dev/reference/apis/services/data/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. |  |
 | [`GetResourceName`](/dev/reference/apis/services/data/#getresourcename) | Get the `ResourceName` for this instance of the service. |  |

static/include/services/apis/generated/data_manager.md

@@ -57,6 +57,89 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/
 {{% /tab %}}
 {{< /tabs >}}
 
+### UploadImageToDatasets
+
+Upload an image data to the specified datasets.
+
+{{< tabs >}}
+{{% tab name="Go" %}}
+
+**Parameters:**
+
+- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
+- `image` [(image.Image)](https://pkg.go.dev/image#Image)
+- `datasetIDs`
+- `tags` [([]string)](https://pkg.go.dev/builtin#string)
+- `mimeType` [(datasyncpb.MimeType)](https://pkg.go.dev/go.viam.com/api/app/datasync/v1#MimeType)
+- `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call.
+
+**Returns:**
+
+- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
+
+For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/services/datamanager#Service).
+
+{{% /tab %}}
+{{< /tabs >}}
+
+### UploadBinaryDataToDatasets
+
+Upload Binary data to the specified datasets.
+
+{{< tabs >}}
+{{% tab name="Go" %}}
+
+**Parameters:**
+
+- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
+- `binaryData` [([]byte)](https://pkg.go.dev/builtin#byte)
+- `datasetIDs`
+- `tags` [([]string)](https://pkg.go.dev/builtin#string)
+- `mimeType` [(datasyncpb.MimeType)](https://pkg.go.dev/go.viam.com/api/app/datasync/v1#MimeType)
+- `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call.
+
+**Returns:**
+
+- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
+
+For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/services/datamanager#Service).
+
+{{% /tab %}}
+{{% tab name="TypeScript" %}}
+
+**Parameters:**
+
+- `binaryData` (Uint8Array) (required): The binary data to upload.
+- `tags` (string) (required): Tags to associate with the binary data.
+- `datasetIds` (string) (required): IDs of the datasets to associate the binary data with.
+- `mimeType` (MimeType) (required): The MIME type of the binary data.
+- `extra` (None) (optional): Extra arguments to pass to the upload request.
+- `callOptions` (CallOptions) (optional): Call options for the upload request.
+
+**Returns:**
+
+- (Promise<void>)
+
+**Example:**
+
+```ts {class="line-numbers linkable-line-numbers"}
+const dataManager = new VIAM.DataManagerClient(
+  machine,
+  'my_data_manager'
+);
+await dataManager.uploadBinaryDataToDatasets(
+  new Uint8Array([1, 2, 3]),
+  ['tag1', 'tag2'],
+  ['datasetId1', 'datasetId2'],
+  MimeType.MIME_TYPE_JPEG
+);
+```
+
+For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/DataManagerClient.html#uploadbinarydatatodatasets).
+
+{{% /tab %}}
+{{< /tabs >}}
+
 ### Reconfigure
 
 Reconfigure this resource.

static/include/services/apis/generated/discovery-table.md

@@ -2,3 +2,6 @@
 | Method Name | Description |
 | ----------- | ----------- |
 | [`DiscoverResources`](/dev/reference/apis/services/discovery/#discoverresources) | Get a list of component configs of all resources available to configure on a machine based on the hardware that is connected to or part of the machine. |
+| [`GetResourceName`](/dev/reference/apis/services/discovery/#getresourcename) | Get the `ResourceName` for this instance of the service. |
+| [`DoCommand`](/dev/reference/apis/services/discovery/#docommand) | Execute model-specific commands. |
+| [`Close`](/dev/reference/apis/services/discovery/#close) | Safely shut down the resource and prevent further use. |

static/include/services/apis/generated/discovery.md

@@ -95,3 +95,236 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s
 
 {{% /tab %}}
 {{< /tabs >}}
+
+### GetResourceName
+
+Get the `ResourceName` for this instance of the service.
+
+{{< tabs >}}
+{{% tab name="Python" %}}
+
+**Parameters:**
+
+- `name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The name of the Resource.
+
+**Returns:**
+
+- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): The ResourceName of this Resource.
+
+**Example:**
+
+```python {class="line-numbers linkable-line-numbers"}
+my_discovery_svc_name = DiscoveryClient.get_resource_name("my_discovery_svc")
+```
+
+For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/discovery/client/index.html#viam.services.discovery.client.DiscoveryClient.get_resource_name).
+
+{{% /tab %}}
+{{% tab name="Go" %}}
+
+**Parameters:**
+
+- None.
+
+**Returns:**
+
+- [(Name)](https://pkg.go.dev/go.viam.com/[email protected]/resource#Name)
+
+**Example:**
+
+```go {class="line-numbers linkable-line-numbers"}
+myDiscoverySvc, err := discovery.FromRobot(machine, "my_discovery_svc")
+
+err = myDiscoverySvc.Name()
+```
+
+For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource).
+
+{{% /tab %}}
+{{% tab name="TypeScript" %}}
+
+**Parameters:**
+
+- None.
+
+**Returns:**
+
+- (string): The name of the resource.
+
+**Example:**
+
+```ts {class="line-numbers linkable-line-numbers"}
+discovery.name
+```
+
+For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/DiscoveryClient.html#name).
+
+{{% /tab %}}
+{{% tab name="Flutter" %}}
+
+**Parameters:**
+
+- `name` [String](https://api.flutter.dev/flutter/dart-core/String-class.html) (required)
+
+**Returns:**
+
+- [ResourceName](https://flutter.viam.dev/viam_sdk/ResourceName-class.html)
+
+For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/DiscoveryClient/getResourceName.html).
+
+{{% /tab %}}
+{{< /tabs >}}
+
+### DoCommand
+
+Execute model-specific commands.
+If you are implementing your own generic service and want to add features that have no corresponding built-in API method, you can implement them with [`DoCommand`](/dev/reference/sdks/docommand/).
+
+{{< tabs >}}
+{{% tab name="Python" %}}
+
+**Parameters:**
+
+- `command` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), ValueTypes]) (required): The command to execute.
+- `timeout` ([float](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)) (optional): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call.
+
+**Returns:**
+
+- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): Result of the executed command.
+
+**Example:**
+
+```python {class="line-numbers linkable-line-numbers"}
+my_discovery_svc = DiscoveryClient.from_robot(robot=machine, "my_discovery_svc")
+
+my_command = {
+  "cmnd": "dosomething",
+  "someparameter": 52
+}
+
+await my_discovery_svc.do_command(command=my_command)
+```
+
+For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/discovery/client/index.html#viam.services.discovery.client.DiscoveryClient.do_command).
+
+{{% /tab %}}
+{{% tab name="Go" %}}
+
+**Parameters:**
+
+- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
+- `cmd` [(map[string]interface{})](https://go.dev/blog/maps): The command to execute.
+
+**Returns:**
+
+- [(map[string]interface{})](https://pkg.go.dev/builtin#string): The command response.
+- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
+
+**Example:**
+
+```go {class="line-numbers linkable-line-numbers"}
+myDiscoverySvc, err := discovery.FromRobot(machine, "my_discovery_svc")
+
+command := map[string]interface{}{"cmd": "test", "data1": 500}
+result, err := myDiscoverySvc.DoCommand(context.Background(), command)
+```
+
+For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource).
+
+{{% /tab %}}
+{{% tab name="TypeScript" %}}
+
+**Parameters:**
+
+- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute.
+- `callOptions` (CallOptions) (optional)
+
+**Returns:**
+
+- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>)
+
+**Example:**
+
+```ts {class="line-numbers linkable-line-numbers"}
+import { Struct } from '@viamrobotics/sdk';
+
+const result = await resource.doCommand(
+  Struct.fromJson({
+    myCommand: { key: 'value' },
+  })
+);
+```
+
+For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/DiscoveryClient.html#docommand).
+
+{{% /tab %}}
+{{% tab name="Flutter" %}}
+
+**Parameters:**
+
+- `command` [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\> (required)
+
+**Returns:**
+
+- [Future](https://api.flutter.dev/flutter/dart-async/Future-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\>\>
+
+**Example:**
+
+```dart {class="line-numbers linkable-line-numbers"}
+// Example using doCommand with an arm component
+const command = {'cmd': 'test', 'data1': 500};
+var result = myArm.doCommand(command);
+```
+
+For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/DiscoveryClient/doCommand.html).
+
+{{% /tab %}}
+{{< /tabs >}}
+
+### Close
+
+Safely shut down the resource and prevent further use.
+
+{{< tabs >}}
+{{% tab name="Python" %}}
+
+**Parameters:**
+
+- None.
+
+**Returns:**
+
+- None.
+
+**Example:**
+
+```python {class="line-numbers linkable-line-numbers"}
+my_discovery_svc = DiscoveryClient.from_robot(robot=machine, name="my_discovery_svc")
+await my_discovery_svc.close()
+```
+
+For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/discovery/client/index.html#viam.services.discovery.client.DiscoveryClient.close).
+
+{{% /tab %}}
+{{% tab name="Go" %}}
+
+**Parameters:**
+
+- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
+
+**Returns:**
+
+- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
+
+**Example:**
+
+```go {class="line-numbers linkable-line-numbers"}
+myDiscoverySvc, err := discovery.FromRobot(machine, "my_discovery_svc")
+
+err = myDiscoverySvc.Close(context.Background())
+```
+
+For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource).
+
+{{% /tab %}}
+{{< /tabs >}}