diff --git a/.github/workflows/sdk_protos_map.csv b/.github/workflows/sdk_protos_map.csv index 0567887f02..5baa4c2858 100644 --- a/.github/workflows/sdk_protos_map.csv +++ b/.github/workflows/sdk_protos_map.csv @@ -13,7 +13,7 @@ arm,GetGeometries,get_geometries,Geometries, arm,Reconfigure,,Reconfigure, arm,DoCommand,do_command,DoCommand,doCommand arm,FromRobot,,,fromRobot -arm,Name,,,getResourceName +arm,GetResourceName,get_resource_name,,getResourceName arm,Close,close,Close, ## Base @@ -29,7 +29,7 @@ base,GetGeometries,get_geometries,Geometries, base,Reconfigure,,Reconfigure, base,DoCommand,do_command,DoCommand,doCommand base,FromRobot,,,fromRobot -base,Name,,,getResourceName +base,GetResourceName,get_resource_name,,getResourceName base,Close,close,Close, ## Board @@ -57,7 +57,8 @@ board,GPIOPinByName,gpio_pin_by_name,GPIOPinByName, board,Reconfigure,,Reconfigure, board,DoCommand,do_command,DoCommand,doCommand board,FromRobot,,,fromRobot -board,Name,,,getResourceName +board,Name,,Name, +board,GetResourceName,get_resource_name,,getResourceName board,Close,close,Close, ## Camera @@ -71,7 +72,7 @@ camera,DoCommand,do_command,,doCommand camera,GetGeometries,get_geometries,, ## HACK: No proto for close, manually mapping: camera,FromRobot,,,fromRobot -camera,Name,,,getResourceName +camera,GetResourceName,get_resource_name,,getResourceName camera,Close,close,Close, ## Encoder @@ -82,6 +83,7 @@ encoder,GetGeometries,get_geometries,, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: encoder,Reconfigure,,Reconfigure, encoder,DoCommand,do_command,DoCommand, +encoder,GetResourceName,get_resource_name,, encoder,Close,close,Close, ## Gantry @@ -97,7 +99,7 @@ gantry,Stop,stop,Stop,stop gantry,Reconfigure,,Reconfigure, gantry,DoCommand,do_command,DoCommand,doCommand gantry,FromRobot,,,fromRobot -gantry,Name,,,getResourceName +gantry,GetResourceName,get_resource_name,,getResourceName gantry,Close,close,Close, ## Generic Component @@ -107,7 +109,7 @@ generic_component,GetGeometries,get_geometries,, ## HACK: No proto for close, manually mapping: ## NOTED: Go SDK also missing Close, but we have it in our docs?: generic_component,FromRobot,,,fromRobot -generic_component,Name,,,getResourceName +generic_component,GetResourceName,get_resource_name,,getResourceName generic_component,Close,close,, ## Gripper @@ -120,7 +122,7 @@ gripper,GetGeometries,get_geometries,Geometries, gripper,Reconfigure,,Reconfigure, gripper,DoCommand,do_command,DoCommand,doCommand gripper,FromRobot,,,fromRobot -gripper,Name,,,getResourceName +gripper,GetResourceName,get_resource_name,,getResourceName gripper,Close,close,Close, ## Input Controller @@ -135,6 +137,7 @@ input_controller,RegisterControlCallback,register_control_callback,RegisterContr ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: input_controller,Reconfigure,,Reconfigure, input_controller,DoCommand,do_command,DoCommand, +input_controller,GetResourceName,get_resource_name,, input_controller,Close,close,Close, ## Motor @@ -153,7 +156,7 @@ motor,Stop,stop,Stop,stop motor,Reconfigure,,Reconfigure, motor,DoCommand,do_command,DoCommand,doCommand motor,FromRobot,,,fromRobot -motor,Name,,,getResourceName +motor,GetResourceName,get_resource_name,,getResourceName motor,Close,close,Close, ## Movement Sensor @@ -172,7 +175,7 @@ movement_sensor,GetReadings,get_readings,Readings,readings movement_sensor,Reconfigure,,Reconfigure, movement_sensor,DoCommand,do_command,DoCommand,doCommand movement_sensor,FromRobot,,,fromRobot -movement_sensor,Name,,,getResourceName +movement_sensor,GetResourceName,get_resource_name,,getResourceName movement_sensor,Close,close,Close, ## Power Sensor @@ -187,7 +190,7 @@ power_sensor,GetGeometries,get_geometries,, power_sensor,Reconfigure,,Reconfigure, power_sensor,DoCommand,do_command,DoCommand,doCommand power_sensor,FromRobot,,,fromRobot -power_sensor,Name,,,getResourceName +power_sensor,GetResourceName,get_resource_name,,getResourceName power_sensor,Close,close,Close, ## Sensor @@ -197,7 +200,7 @@ sensor,GetGeometries,get_geometries,, sensor,Reconfigure,,Reconfigure, sensor,DoCommand,do_command,DoCommand,doCommand sensor,FromRobot,,,fromRobot -sensor,Name,,,getResourceName +sensor,GetResourceName,get_resource_name,,getResourceName sensor,Close,close,Close, ## Servo @@ -210,7 +213,7 @@ servo,Stop,stop,Stop,stop servo,Reconfigure,,Reconfigure, servo,DoCommand,do_command,DoCommand,doCommand servo,FromRobot,,,fromRobot -servo,Name,,,getResourceName +servo,GetResourceName,get_resource_name,,getResourceName servo,Close,close,Close, ## Base Remote Control @@ -231,6 +234,7 @@ data_manager,Close,,Close, ## Generic Service ## NOTED:Generic Component in Go SDK doesn't appear to implement (inherit) these: generic_service,DoCommand,do_command,DoCommand, +generic_service,GetResourceName,get_resource_name,, ## HACK: No proto for close, manually mapping: ## NOTED: Go SDK also missing Close, but we have it in our docs?: generic_service,Close,close,, @@ -241,6 +245,7 @@ mlmodel,Metadata,metadata,Metadata, ## HACK: No proto for DoCommand or Close (and/or inherited in Go SDK), manually mapping: mlmodel,Reconfigure,,Reconfigure, mlmodel,DoCommand,do_command,DoCommand, +mlmodel,GetResourceName,get_resource_name,, mlmodel,Close,close,Close, ## Motion @@ -254,6 +259,7 @@ motion,GetPlan,get_plan,PlanHistory, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: motion,Reconfigure,,Reconfigure, motion,DoCommand,do_command,DoCommand, +motion,GetResourceName,get_resource_name,, motion,Close,close,Close, ## Navigation @@ -269,6 +275,7 @@ navigation,GetProperties,get_properties,Properties, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: navigation,Reconfigure,,Reconfigure, navigation,DoCommand,do_command,DoCommand, +navigation,GetResourceName,get_resource_name,, navigation,Close,close,Close, ## SLAM @@ -284,6 +291,7 @@ slam,PointCloudMapFull,,PointCloudMapFull, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: slam,Reconfigure,,Reconfigure, slam,DoCommand,do_command,DoCommand, +slam,GetResourceName,get_resource_name,, slam,Close,close,Close, ## Vision @@ -297,7 +305,7 @@ vision,CaptureAllFromCamera,capture_all_from_camera,CaptureAllFromCamera, vision,Reconfigure,,Reconfigure, vision,DoCommand,do_command,DoCommand,doCommand vision,FromRobot,,,fromRobot -vision,Name,,,getResourceName +vision,GetResourceName,get_resource_name,,getResourceName vision,GetProperties,get_properties,GetProperties, vision,Close,close,Close, diff --git a/.github/workflows/update_sdk_methods.py b/.github/workflows/update_sdk_methods.py index 9753c10934..10a75626fb 100755 --- a/.github/workflows/update_sdk_methods.py +++ b/.github/workflows/update_sdk_methods.py @@ -976,11 +976,11 @@ def parse(type, names): id = tag.find("dt", class_="sig sig-object py").get("id") - if not id.endswith(".from_robot") and not id.endswith(".get_resource_name") \ - and not id.endswith(".get_operation") and not id.endswith(".from_proto") \ - and not id.endswith(".to_proto") and not id.endswith(".from_string") \ - and not id.endswith("__") and not id.endswith("HasField") \ - and not id.endswith("WhichOneof") and not id in python_ignore_apis: + if not id.endswith(".from_robot") and not id.endswith(".get_operation") \ + and not id.endswith(".from_proto") and not id.endswith(".to_proto") \ + and not id.endswith(".from_string") and not id.endswith("__") \ + and not id.endswith("HasField") and not id.endswith("WhichOneof") \ + and not id in python_ignore_apis: ## Determine method name, but don't save to dictionary as value; we use it as a key instead: method_name = id.rsplit('.',1)[1] diff --git a/static/include/components/apis/generated/arm-table.md b/static/include/components/apis/generated/arm-table.md index 6008f71925..00f3cfad0f 100644 --- a/static/include/components/apis/generated/arm-table.md +++ b/static/include/components/apis/generated/arm-table.md @@ -12,5 +12,5 @@ | [`Reconfigure`](/components/arm/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/arm/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/arm/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/arm/#name) | Get the `ResourceName` for this arm with the given name. | +| [`GetResourceName`](/components/arm/#getresourcename) | Get the `ResourceName` for this arm with the given name. | | [`Close`](/components/arm/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/arm.md b/static/include/components/apis/generated/arm.md index 13a3cb8de0..39b727e296 100644 --- a/static/include/components/apis/generated/arm.md +++ b/static/include/components/apis/generated/arm.md @@ -709,11 +709,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this arm with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/arm/client/index.html#viam.components.arm.client.ArmClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/base-table.md b/static/include/components/apis/generated/base-table.md index 1aa8485091..d39b4664ca 100644 --- a/static/include/components/apis/generated/base-table.md +++ b/static/include/components/apis/generated/base-table.md @@ -12,5 +12,5 @@ | [`Reconfigure`](/components/base/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/base/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/base/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/base/#name) | Get the `ResourceName` for this base with the given name. | +| [`GetResourceName`](/components/base/#getresourcename) | Get the `ResourceName` for this base with the given name. | | [`Close`](/components/base/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/base.md b/static/include/components/apis/generated/base.md index eae9b20cac..9f86d02c53 100644 --- a/static/include/components/apis/generated/base.md +++ b/static/include/components/apis/generated/base.md @@ -777,11 +777,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this base with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/base/client/index.html#viam.components.base.client.BaseClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/board-table.md b/static/include/components/apis/generated/board-table.md index 4a6fd1165c..21f370c51b 100644 --- a/static/include/components/apis/generated/board-table.md +++ b/static/include/components/apis/generated/board-table.md @@ -21,5 +21,6 @@ | [`Reconfigure`](/components/board/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/board/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/board/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/board/#name) | Get the `ResourceName` for this board with the given name. | +| [`Name`](/components/board/#name) | Get the name of the digital interrupt. | +| [`GetResourceName`](/components/board/#getresourcename) | Get the `ResourceName` for this board with the given name. | | [`Close`](/components/board/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/board.md b/static/include/components/apis/generated/board.md index 32267390cd..dc41ce925a 100644 --- a/static/include/components/apis/generated/board.md +++ b/static/include/components/apis/generated/board.md @@ -1303,9 +1303,49 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s ### Name +Get the name of the digital interrupt. + +{{< tabs >}} +{{% tab name="Go" %}} + +**Parameters:** + +- None. + +**Returns:** + +- [(string)](https://pkg.go.dev/builtin#string): The name of the digital interrupt. + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/components/board#DigitalInterrupt). + +{{% /tab %}} +{{< /tabs >}} + +### GetResourceName + Get the `ResourceName` for this board with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/board/client/index.html#viam.components.board.client.BoardClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/camera-table.md b/static/include/components/apis/generated/camera-table.md index ffafd0d3bc..a1a5c441af 100644 --- a/static/include/components/apis/generated/camera-table.md +++ b/static/include/components/apis/generated/camera-table.md @@ -8,5 +8,5 @@ | [`DoCommand`](/components/camera/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`GetGeometries`](/components/camera/#getgeometries) | Get all the geometries associated with the camera in its current configuration, in the frame of the camera. | | [`FromRobot`](/components/camera/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/camera/#name) | Get the `ResourceName` for this camera with the given name. | +| [`GetResourceName`](/components/camera/#getresourcename) | Get the `ResourceName` for this camera with the given name. | | [`Close`](/components/camera/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/camera.md b/static/include/components/apis/generated/camera.md index 76fc1725a8..58084070ff 100644 --- a/static/include/components/apis/generated/camera.md +++ b/static/include/components/apis/generated/camera.md @@ -431,11 +431,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this camera with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/camera/client/index.html#viam.components.camera.client.CameraClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/encoder-table.md b/static/include/components/apis/generated/encoder-table.md index 97a2e734de..9362a93de2 100644 --- a/static/include/components/apis/generated/encoder-table.md +++ b/static/include/components/apis/generated/encoder-table.md @@ -7,4 +7,5 @@ | [`GetGeometries`](/components/encoder/#getgeometries) | Get all the geometries associated with the encoder in its current configuration, in the frame of the encoder. | | [`Reconfigure`](/components/encoder/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/encoder/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetResourceName`](/components/encoder/#getresourcename) | Get the `ResourceName` for this encoder with the given name. | | [`Close`](/components/encoder/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/encoder.md b/static/include/components/apis/generated/encoder.md index b4b7b22219..b800dbb3ca 100644 --- a/static/include/components/apis/generated/encoder.md +++ b/static/include/components/apis/generated/encoder.md @@ -283,6 +283,33 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetResourceName + +Get the `ResourceName` for this encoder with the given name. + +{{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/encoder/client/index.html#viam.components.encoder.client.EncoderClient.get_resource_name). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/components/apis/generated/gantry-table.md b/static/include/components/apis/generated/gantry-table.md index 693ef22662..fc96941fd5 100644 --- a/static/include/components/apis/generated/gantry-table.md +++ b/static/include/components/apis/generated/gantry-table.md @@ -11,5 +11,5 @@ | [`Reconfigure`](/components/gantry/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/gantry/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/gantry/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/gantry/#name) | Get the `ResourceName` for this gantry with the given name. | +| [`GetResourceName`](/components/gantry/#getresourcename) | Get the `ResourceName` for this gantry with the given name. | | [`Close`](/components/gantry/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/gantry.md b/static/include/components/apis/generated/gantry.md index 2019d4362e..0cb8bc1ec6 100644 --- a/static/include/components/apis/generated/gantry.md +++ b/static/include/components/apis/generated/gantry.md @@ -616,11 +616,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this gantry with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/gantry/client/index.html#viam.components.gantry.client.GantryClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/generic_component-table.md b/static/include/components/apis/generated/generic_component-table.md index d5224302d8..25f57de64b 100644 --- a/static/include/components/apis/generated/generic_component-table.md +++ b/static/include/components/apis/generated/generic_component-table.md @@ -4,5 +4,5 @@ | [`DoCommand`](/components/generic/#docommand) | Execute model-specific commands. | | [`GetGeometries`](/components/generic/#getgeometries) | Get all the geometries associated with the generic component in its current configuration, in the frame of the generic component. | | [`FromRobot`](/components/generic/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/generic/#name) | Get the `ResourceName` for this generic component with the given name. | +| [`GetResourceName`](/components/generic/#getresourcename) | Get the `ResourceName` for this generic component with the given name. | | [`Close`](/components/generic/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/generic_component.md b/static/include/components/apis/generated/generic_component.md index 1e83b0101d..8bf710adb3 100644 --- a/static/include/components/apis/generated/generic_component.md +++ b/static/include/components/apis/generated/generic_component.md @@ -152,11 +152,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this generic component with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/generic/client/index.html#viam.components.generic.client.GenericClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/gripper-table.md b/static/include/components/apis/generated/gripper-table.md index 4b0ac53bfc..e76bfe2008 100644 --- a/static/include/components/apis/generated/gripper-table.md +++ b/static/include/components/apis/generated/gripper-table.md @@ -9,5 +9,5 @@ | [`Reconfigure`](/components/gripper/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/gripper/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/gripper/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/gripper/#name) | Get the `ResourceName` for this gripper with the given name. | +| [`GetResourceName`](/components/gripper/#getresourcename) | Get the `ResourceName` for this gripper with the given name. | | [`Close`](/components/gripper/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/gripper.md b/static/include/components/apis/generated/gripper.md index 82f7f9bdd9..7b676d7305 100644 --- a/static/include/components/apis/generated/gripper.md +++ b/static/include/components/apis/generated/gripper.md @@ -476,11 +476,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this gripper with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/gripper/client/index.html#viam.components.gripper.client.GripperClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/input_controller-table.md b/static/include/components/apis/generated/input_controller-table.md index 981aae2dd5..b4eb2b158c 100644 --- a/static/include/components/apis/generated/input_controller-table.md +++ b/static/include/components/apis/generated/input_controller-table.md @@ -8,4 +8,5 @@ | [`RegisterControlCallback`](/components/input-controller/#registercontrolcallback) | Defines a callback function to execute whenever one of the EventTypes selected occurs on the given Control. | | [`Reconfigure`](/components/input-controller/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/input-controller/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetResourceName`](/components/input-controller/#getresourcename) | Get the `ResourceName` for this input controller with the given name. | | [`Close`](/components/input-controller/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/input_controller.md b/static/include/components/apis/generated/input_controller.md index 8d2322a8bc..2dd5d17875 100644 --- a/static/include/components/apis/generated/input_controller.md +++ b/static/include/components/apis/generated/input_controller.md @@ -392,6 +392,33 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetResourceName + +Get the `ResourceName` for this input controller with the given name. + +{{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/input/client/index.html#viam.components.input.client.ControllerClient.get_resource_name). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/components/apis/generated/motor-table.md b/static/include/components/apis/generated/motor-table.md index 3cc507ca7e..ceca42d7fb 100644 --- a/static/include/components/apis/generated/motor-table.md +++ b/static/include/components/apis/generated/motor-table.md @@ -15,5 +15,5 @@ | [`Reconfigure`](/components/motor/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/motor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/motor/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/motor/#name) | Get the `ResourceName` for this motor with the given name. | +| [`GetResourceName`](/components/motor/#getresourcename) | Get the `ResourceName` for this motor with the given name. | | [`Close`](/components/motor/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/motor.md b/static/include/components/apis/generated/motor.md index 83ae8ea850..c5654b2bd1 100644 --- a/static/include/components/apis/generated/motor.md +++ b/static/include/components/apis/generated/motor.md @@ -926,11 +926,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this motor with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/motor/client/index.html#viam.components.motor.client.MotorClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/movement_sensor.md b/static/include/components/apis/generated/movement_sensor.md index 77da7fea77..15f641f826 100644 --- a/static/include/components/apis/generated/movement_sensor.md +++ b/static/include/components/apis/generated/movement_sensor.md @@ -852,11 +852,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this movement sensor with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/movement_sensor/client/index.html#viam.components.movement_sensor.client.MovementSensorClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/power_sensor-table.md b/static/include/components/apis/generated/power_sensor-table.md index 1680520786..20b2cc65ae 100644 --- a/static/include/components/apis/generated/power_sensor-table.md +++ b/static/include/components/apis/generated/power_sensor-table.md @@ -9,5 +9,5 @@ | [`Reconfigure`](/components/power-sensor/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/power-sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/power-sensor/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/power-sensor/#name) | Get the `ResourceName` for this power sensor with the given name. | +| [`GetResourceName`](/components/power-sensor/#getresourcename) | Get the `ResourceName` for this power sensor with the given name. | | [`Close`](/components/power-sensor/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/power_sensor.md b/static/include/components/apis/generated/power_sensor.md index 3c4f65591f..452c1368a0 100644 --- a/static/include/components/apis/generated/power_sensor.md +++ b/static/include/components/apis/generated/power_sensor.md @@ -447,11 +447,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this power sensor with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/power_sensor/client/index.html#viam.components.power_sensor.client.PowerSensorClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/sensor-table.md b/static/include/components/apis/generated/sensor-table.md index 18d05e3dc3..e6b94e0a72 100644 --- a/static/include/components/apis/generated/sensor-table.md +++ b/static/include/components/apis/generated/sensor-table.md @@ -6,5 +6,5 @@ | [`Reconfigure`](/components/sensor/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/sensor/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/sensor/#name) | Get the `ResourceName` for this sensor with the given name. | +| [`GetResourceName`](/components/sensor/#getresourcename) | Get the `ResourceName` for this sensor with the given name. | | [`Close`](/components/sensor/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/sensor.md b/static/include/components/apis/generated/sensor.md index a7cda8caa0..423f2dbc5b 100644 --- a/static/include/components/apis/generated/sensor.md +++ b/static/include/components/apis/generated/sensor.md @@ -225,11 +225,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this sensor with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/sensor/client/index.html#viam.components.sensor.client.SensorClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/generated/servo-table.md b/static/include/components/apis/generated/servo-table.md index 7daaa9d094..4898a15049 100644 --- a/static/include/components/apis/generated/servo-table.md +++ b/static/include/components/apis/generated/servo-table.md @@ -9,5 +9,5 @@ | [`Reconfigure`](/components/servo/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/components/servo/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | | [`FromRobot`](/components/servo/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/components/servo/#name) | Get the `ResourceName` for this servo with the given name. | +| [`GetResourceName`](/components/servo/#getresourcename) | Get the `ResourceName` for this servo with the given name. | | [`Close`](/components/servo/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/servo.md b/static/include/components/apis/generated/servo.md index 8b2c3d24b8..70f7422a08 100644 --- a/static/include/components/apis/generated/servo.md +++ b/static/include/components/apis/generated/servo.md @@ -477,11 +477,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this servo with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/servo/client/index.html#viam.components.servo.client.ServoClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/components/apis/overrides/methods/go.board.Name.string.return.md b/static/include/components/apis/overrides/methods/go.board.Name.string.return.md new file mode 100644 index 0000000000..ba9476c901 --- /dev/null +++ b/static/include/components/apis/overrides/methods/go.board.Name.string.return.md @@ -0,0 +1 @@ +The name of the digital interrupt. diff --git a/static/include/components/apis/overrides/protos/arm.Name.md b/static/include/components/apis/overrides/protos/arm.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/arm.Name.md rename to static/include/components/apis/overrides/protos/arm.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/base.Name.md b/static/include/components/apis/overrides/protos/base.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/base.Name.md rename to static/include/components/apis/overrides/protos/base.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/board.GetResourceName.md b/static/include/components/apis/overrides/protos/board.GetResourceName.md new file mode 100644 index 0000000000..98e6a69573 --- /dev/null +++ b/static/include/components/apis/overrides/protos/board.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this board with the given name. diff --git a/static/include/components/apis/overrides/protos/board.Name.md b/static/include/components/apis/overrides/protos/board.Name.md index 98e6a69573..1323c6cf3c 100644 --- a/static/include/components/apis/overrides/protos/board.Name.md +++ b/static/include/components/apis/overrides/protos/board.Name.md @@ -1 +1 @@ -Get the `ResourceName` for this board with the given name. +Get the name of the digital interrupt. diff --git a/static/include/components/apis/overrides/protos/camera.Name.md b/static/include/components/apis/overrides/protos/camera.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/camera.Name.md rename to static/include/components/apis/overrides/protos/camera.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/encoder.GetResourceName.md b/static/include/components/apis/overrides/protos/encoder.GetResourceName.md new file mode 100644 index 0000000000..83c2e8a4c5 --- /dev/null +++ b/static/include/components/apis/overrides/protos/encoder.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this encoder with the given name. diff --git a/static/include/components/apis/overrides/protos/gantry.Name.md b/static/include/components/apis/overrides/protos/gantry.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/gantry.Name.md rename to static/include/components/apis/overrides/protos/gantry.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/generic_component.Name.md b/static/include/components/apis/overrides/protos/generic_component.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/generic_component.Name.md rename to static/include/components/apis/overrides/protos/generic_component.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/gripper.Name.md b/static/include/components/apis/overrides/protos/gripper.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/gripper.Name.md rename to static/include/components/apis/overrides/protos/gripper.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/input_controller.GetResourceName.md b/static/include/components/apis/overrides/protos/input_controller.GetResourceName.md new file mode 100644 index 0000000000..b9b35a76a3 --- /dev/null +++ b/static/include/components/apis/overrides/protos/input_controller.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this input controller with the given name. diff --git a/static/include/components/apis/overrides/protos/motor.Name.md b/static/include/components/apis/overrides/protos/motor.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/motor.Name.md rename to static/include/components/apis/overrides/protos/motor.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/movement_sensor.Name.md b/static/include/components/apis/overrides/protos/movement_sensor.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/movement_sensor.Name.md rename to static/include/components/apis/overrides/protos/movement_sensor.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/power_sensor.Name.md b/static/include/components/apis/overrides/protos/power_sensor.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/power_sensor.Name.md rename to static/include/components/apis/overrides/protos/power_sensor.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/sensor.Name.md b/static/include/components/apis/overrides/protos/sensor.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/sensor.Name.md rename to static/include/components/apis/overrides/protos/sensor.GetResourceName.md diff --git a/static/include/components/apis/overrides/protos/servo.Name.md b/static/include/components/apis/overrides/protos/servo.GetResourceName.md similarity index 100% rename from static/include/components/apis/overrides/protos/servo.Name.md rename to static/include/components/apis/overrides/protos/servo.GetResourceName.md diff --git a/static/include/services/apis/generated/generic_service-table.md b/static/include/services/apis/generated/generic_service-table.md index 8bf9cb01fb..93313de81e 100644 --- a/static/include/services/apis/generated/generic_service-table.md +++ b/static/include/services/apis/generated/generic_service-table.md @@ -2,4 +2,5 @@ | Method Name | Description | | ----------- | ----------- | | [`DoCommand`](/services/generic/#docommand) | Execute model-specific commands. | +| [`GetResourceName`](/services/generic/#getresourcename) | Get the `ResourceName` for this instance of the generic service with the given name. | | [`Close`](/services/generic/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/generic_service.md b/static/include/services/apis/generated/generic_service.md index 7408e6cc5f..10e43858c6 100644 --- a/static/include/services/apis/generated/generic_service.md +++ b/static/include/services/apis/generated/generic_service.md @@ -81,6 +81,33 @@ For more information, see the [C++ SDK Docs](https://cpp.viam.dev/classviam_1_1s {{% /tab %}} {{< /tabs >}} +### GetResourceName + +Get the `ResourceName` for this instance of the generic service with the given name. + +{{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/generic/client/index.html#viam.services.generic.client.GenericClient.get_resource_name). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/services/apis/generated/mlmodel-table.md b/static/include/services/apis/generated/mlmodel-table.md index 0b6033b926..e9fba10db2 100644 --- a/static/include/services/apis/generated/mlmodel-table.md +++ b/static/include/services/apis/generated/mlmodel-table.md @@ -5,4 +5,5 @@ | [`Metadata`](/services/ml/deploy/#metadata) | Get the metadata: name, data type, expected tensor/array shape, inputs, and outputs associated with the ML model. | | [`Reconfigure`](/services/ml/deploy/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/services/ml/deploy/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetResourceName`](/services/ml/deploy/#getresourcename) | Get the `ResourceName` for this instance of the ML model service with the given name. | | [`Close`](/services/ml/deploy/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/mlmodel.md b/static/include/services/apis/generated/mlmodel.md index 30f7a1c2ca..a5047547c3 100644 --- a/static/include/services/apis/generated/mlmodel.md +++ b/static/include/services/apis/generated/mlmodel.md @@ -188,6 +188,33 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetResourceName + +Get the `ResourceName` for this instance of the ML model service with the given name. + +{{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/mlmodel/client/index.html#viam.services.mlmodel.client.MLModelClient.get_resource_name). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/services/apis/generated/motion-table.md b/static/include/services/apis/generated/motion-table.md index d3874d7510..e780ca4a48 100644 --- a/static/include/services/apis/generated/motion-table.md +++ b/static/include/services/apis/generated/motion-table.md @@ -10,4 +10,5 @@ | [`GetPlan`](/services/motion/#getplan) | By default, returns the plan history of the most recent `MoveOnGlobe` or `MoveOnMap` call to move a base component. | | [`Reconfigure`](/services/motion/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/services/motion/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetResourceName`](/services/motion/#getresourcename) | Get the `ResourceName` for this instance of the motion service with the given name. | | [`Close`](/services/motion/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/motion.md b/static/include/services/apis/generated/motion.md index 92b48f7e32..0ae674a8b1 100644 --- a/static/include/services/apis/generated/motion.md +++ b/static/include/services/apis/generated/motion.md @@ -847,6 +847,33 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetResourceName + +Get the `ResourceName` for this instance of the motion service with the given name. + +{{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/motion/client/index.html#viam.services.motion.client.MotionClient.get_resource_name). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/services/apis/generated/navigation-table.md b/static/include/services/apis/generated/navigation-table.md index 1de94691a6..6433ccd0fe 100644 --- a/static/include/services/apis/generated/navigation-table.md +++ b/static/include/services/apis/generated/navigation-table.md @@ -12,4 +12,5 @@ | [`GetProperties`](/services/navigation/#getproperties) | Get information about the navigation service. | | [`Reconfigure`](/services/navigation/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/services/navigation/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetResourceName`](/services/navigation/#getresourcename) | Get the `ResourceName` for this instance of the navigation service with the given name. | | [`Close`](/services/navigation/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/navigation.md b/static/include/services/apis/generated/navigation.md index 04b1d0cf8c..55d433fbe4 100644 --- a/static/include/services/apis/generated/navigation.md +++ b/static/include/services/apis/generated/navigation.md @@ -572,6 +572,33 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetResourceName + +Get the `ResourceName` for this instance of the navigation service with the given name. + +{{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/navigation/client/index.html#viam.services.navigation.client.NavigationClient.get_resource_name). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/services/apis/generated/slam-table.md b/static/include/services/apis/generated/slam-table.md index 488953fbfc..d10f387b54 100644 --- a/static/include/services/apis/generated/slam-table.md +++ b/static/include/services/apis/generated/slam-table.md @@ -9,4 +9,5 @@ | [`PointCloudMapFull`](/services/slam/#pointcloudmapfull) | `PointCloudMapFull` concatenates the streaming responses from `PointCloudMap` into a full point cloud. | | [`Reconfigure`](/services/slam/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/services/slam/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetResourceName`](/services/slam/#getresourcename) | Get the `ResourceName` for this instance of the SLAM service with the given name. | | [`Close`](/services/slam/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/slam.md b/static/include/services/apis/generated/slam.md index 71e48e9c29..7b96ada681 100644 --- a/static/include/services/apis/generated/slam.md +++ b/static/include/services/apis/generated/slam.md @@ -294,6 +294,33 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetResourceName + +Get the `ResourceName` for this instance of the SLAM service with the given name. + +{{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/slam/client/index.html#viam.services.slam.client.SLAMClient.get_resource_name). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/services/apis/generated/vision-table.md b/static/include/services/apis/generated/vision-table.md index c7499a694c..08c6815560 100644 --- a/static/include/services/apis/generated/vision-table.md +++ b/static/include/services/apis/generated/vision-table.md @@ -10,6 +10,6 @@ | [`Reconfigure`](/services/vision/#reconfigure) | Reconfigure this resource. | | [`DoCommand`](/services/vision/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | | [`FromRobot`](/services/vision/#fromrobot) | Get the resource from the provided robot with the given name. | -| [`Name`](/services/vision/#name) | Get the `ResourceName` for this instance of the Vision service with the given name. | +| [`GetResourceName`](/services/vision/#getresourcename) | Get the `ResourceName` for this instance of the Vision service with the given name. | | [`GetProperties`](/services/vision/#getproperties) | Fetch information about which vision methods a given vision service supports. | | [`Close`](/services/vision/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/vision.md b/static/include/services/apis/generated/vision.md index 63083c7a83..71dce126d4 100644 --- a/static/include/services/apis/generated/vision.md +++ b/static/include/services/apis/generated/vision.md @@ -655,11 +655,31 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} -### Name +### GetResourceName Get the `ResourceName` for this instance of the Vision service with the given name. {{< 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"} +# Can be used with any resource, using an arm as an example +my_arm_name = my_arm.get_resource_name("my_arm") +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/vision/client/index.html#viam.services.vision.client.VisionClient.get_resource_name). + +{{% /tab %}} {{% tab name="Flutter" %}} **Parameters:** diff --git a/static/include/services/apis/overrides/protos/generic_service.GetResourceName.md b/static/include/services/apis/overrides/protos/generic_service.GetResourceName.md new file mode 100644 index 0000000000..a8dc63c371 --- /dev/null +++ b/static/include/services/apis/overrides/protos/generic_service.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this instance of the generic service with the given name. diff --git a/static/include/services/apis/overrides/protos/mlmodel.GetResourceName.md b/static/include/services/apis/overrides/protos/mlmodel.GetResourceName.md new file mode 100644 index 0000000000..48084e5771 --- /dev/null +++ b/static/include/services/apis/overrides/protos/mlmodel.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this instance of the ML model service with the given name. diff --git a/static/include/services/apis/overrides/protos/motion.GetResourceName.md b/static/include/services/apis/overrides/protos/motion.GetResourceName.md new file mode 100644 index 0000000000..77e1785f5c --- /dev/null +++ b/static/include/services/apis/overrides/protos/motion.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this instance of the motion service with the given name. diff --git a/static/include/services/apis/overrides/protos/navigation.GetResourceName.md b/static/include/services/apis/overrides/protos/navigation.GetResourceName.md new file mode 100644 index 0000000000..12cd9beeb9 --- /dev/null +++ b/static/include/services/apis/overrides/protos/navigation.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this instance of the navigation service with the given name. diff --git a/static/include/services/apis/overrides/protos/slam.GetResourceName.md b/static/include/services/apis/overrides/protos/slam.GetResourceName.md new file mode 100644 index 0000000000..ec08b63e42 --- /dev/null +++ b/static/include/services/apis/overrides/protos/slam.GetResourceName.md @@ -0,0 +1 @@ +Get the `ResourceName` for this instance of the SLAM service with the given name. diff --git a/static/include/services/apis/overrides/protos/vision.Name.md b/static/include/services/apis/overrides/protos/vision.GetResourceName.md similarity index 100% rename from static/include/services/apis/overrides/protos/vision.Name.md rename to static/include/services/apis/overrides/protos/vision.GetResourceName.md