From 172c576604ba92d76339622bbee13983aeb01257 Mon Sep 17 00:00:00 2001 From: Brandon Shrewsbury Date: Mon, 13 Jul 2026 09:59:16 -0600 Subject: [PATCH 1/4] Document GetStatus across component and service APIs The Python, TypeScript, and Flutter SDKs expose a resource-level GetStatus method (backed by the common GetStatus RPC) on every component and most services, but it had no rows in sdk_protos_map.csv, so the API reference never mentioned it and the weekly SDK method coverage job flagged ~70 unused-method warnings. Add a GetStatus row for each of the 18 components and 8 services, filling only the SDK columns the coverage scraper actually finds (the Go SDK has no per-resource GetStatus; Flutter lacks encoder, input controller, and switch). Add a proto description override file per resource, and regenerate the affected component and service markdown. Also ignore the capitalized 'GetStatus' the Python scraper picks up from the world_state_store page, matching the existing entries for that page's other proto-cased duplicates (ListUUIDs, GetTransform). Refs #5142. --- .github/workflows/sdk_protos_map.csv | 26 +++ .github/workflows/update_sdk_methods.py | 2 +- .../components/apis/generated/arm-table.md | 29 +-- .../include/components/apis/generated/arm.md | 68 ++++++- .../apis/generated/audio_in-table.md | 15 +- .../components/apis/generated/audio_in.md | 60 +++++- .../apis/generated/audio_out-table.md | 17 +- .../components/apis/generated/audio_out.md | 140 ++++++++------ .../components/apis/generated/base-table.md | 25 +-- .../include/components/apis/generated/base.md | 78 ++++++-- .../components/apis/generated/board-table.md | 39 ++-- .../components/apis/generated/board.md | 76 ++++++-- .../components/apis/generated/button-table.md | 11 +- .../components/apis/generated/button.md | 60 +++++- .../components/apis/generated/camera-table.md | 15 +- .../components/apis/generated/camera.md | 72 +++++-- .../apis/generated/encoder-table.md | 17 +- .../components/apis/generated/encoder.md | 52 ++++- .../components/apis/generated/gantry-table.md | 25 +-- .../components/apis/generated/gantry.md | 67 ++++++- .../apis/generated/generic_component-table.md | 9 +- .../apis/generated/generic_component.md | 108 ++++++----- .../apis/generated/gripper-table.md | 27 +-- .../components/apis/generated/gripper.md | 162 ++++++++-------- .../apis/generated/input_controller-table.md | 19 +- .../apis/generated/input_controller.md | 51 ++++- .../components/apis/generated/motor-table.md | 31 +-- .../components/apis/generated/motor.md | 75 ++++++-- .../apis/generated/movement_sensor.md | 108 ++++++----- .../apis/generated/power_sensor-table.md | 17 +- .../components/apis/generated/power_sensor.md | 80 +++++--- .../components/apis/generated/sensor-table.md | 13 +- .../components/apis/generated/sensor.md | 60 +++++- .../components/apis/generated/servo-table.md | 19 +- .../components/apis/generated/servo.md | 60 +++++- .../components/apis/generated/switch-table.md | 13 +- .../components/apis/generated/switch.md | 47 ++++- .../apis/overrides/protos/arm.GetStatus.md | 1 + .../overrides/protos/audio_in.GetStatus.md | 1 + .../overrides/protos/audio_out.GetStatus.md | 1 + .../apis/overrides/protos/base.GetStatus.md | 1 + .../apis/overrides/protos/board.GetStatus.md | 1 + .../apis/overrides/protos/button.GetStatus.md | 1 + .../apis/overrides/protos/camera.GetStatus.md | 1 + .../overrides/protos/encoder.GetStatus.md | 1 + .../apis/overrides/protos/gantry.GetStatus.md | 1 + .../protos/generic_component.GetStatus.md | 1 + .../overrides/protos/gripper.GetStatus.md | 1 + .../protos/input_controller.GetStatus.md | 1 + .../apis/overrides/protos/motor.GetStatus.md | 1 + .../protos/movement_sensor.GetStatus.md | 1 + .../protos/power_sensor.GetStatus.md | 1 + .../apis/overrides/protos/sensor.GetStatus.md | 1 + .../apis/overrides/protos/servo.GetStatus.md | 1 + .../apis/overrides/protos/switch.GetStatus.md | 1 + .../apis/generated/data_manager-table.md | 13 +- .../services/apis/generated/data_manager.md | 47 +++-- .../apis/generated/discovery-table.md | 9 +- .../services/apis/generated/discovery.md | 60 +++++- .../apis/generated/generic_service-table.md | 7 +- .../apis/generated/generic_service.md | 60 +++++- .../services/apis/generated/mlmodel-table.md | 13 +- .../services/apis/generated/mlmodel.md | 26 +++ .../services/apis/generated/motion-table.md | 25 +-- .../include/services/apis/generated/motion.md | 103 ++++++---- .../services/apis/generated/slam-table.md | 21 ++- .../include/services/apis/generated/slam.md | 51 ++++- .../services/apis/generated/vision-table.md | 23 +-- .../include/services/apis/generated/vision.md | 178 +++++++++++------- .../apis/generated/world_state_store-table.md | 13 +- .../apis/generated/world_state_store.md | 68 ++++--- .../protos/data_manager.GetStatus.md | 1 + .../overrides/protos/discovery.GetStatus.md | 1 + .../protos/generic_service.GetStatus.md | 1 + .../overrides/protos/mlmodel.GetStatus.md | 1 + .../apis/overrides/protos/motion.GetStatus.md | 1 + .../apis/overrides/protos/slam.GetStatus.md | 1 + .../apis/overrides/protos/vision.GetStatus.md | 1 + .../protos/world_state_store.GetStatus.md | 1 + 79 files changed, 1793 insertions(+), 743 deletions(-) create mode 100644 static/include/components/apis/overrides/protos/arm.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/audio_in.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/audio_out.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/base.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/board.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/button.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/camera.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/encoder.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/gantry.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/generic_component.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/gripper.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/input_controller.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/motor.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/movement_sensor.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/power_sensor.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/sensor.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/servo.GetStatus.md create mode 100644 static/include/components/apis/overrides/protos/switch.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/data_manager.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/discovery.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/generic_service.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/mlmodel.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/motion.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/slam.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/vision.GetStatus.md create mode 100644 static/include/services/apis/overrides/protos/world_state_store.GetStatus.md diff --git a/.github/workflows/sdk_protos_map.csv b/.github/workflows/sdk_protos_map.csv index b15c8dbe61..1901f20597 100644 --- a/.github/workflows/sdk_protos_map.csv +++ b/.github/workflows/sdk_protos_map.csv @@ -14,6 +14,7 @@ arm,Stop,,stop,Stop,stop,stop arm,GetGeometries,,get_geometries,Geometries,,getGeometries arm,Reconfigure,,,Reconfigure,, arm,DoCommand,,do_command,DoCommand,doCommand,doCommand +arm,GetStatus,,get_status,,getStatus,getStatus arm,GetResourceName,,get_resource_name,Name,getResourceName,name arm,Close,,close,Close,, @@ -23,6 +24,7 @@ audio_in,GetProperties,,get_properties,Properties,getProperties,getProperties audio_in,GetGeometries,,get_geometries,,, audio_in,Reconfigure,,,Reconfigure,, audio_in,DoCommand,,do_command,DoCommand,doCommand,doCommand +audio_in,GetStatus,,get_status,,getStatus,getStatus audio_in,GetResourceName,,get_resource_name,Name,,name audio_in,Close,,close,Close,, @@ -33,6 +35,7 @@ audio_out,GetProperties,,get_properties,Properties,getProperties,getProperties audio_out,GetGeometries,,get_geometries,,, audio_out,Reconfigure,,,Reconfigure,, audio_out,DoCommand,,do_command,DoCommand,doCommand,doCommand +audio_out,GetStatus,,get_status,,getStatus,getStatus audio_out,GetResourceName,,get_resource_name,Name,,name audio_out,Close,,close,Close,, @@ -48,6 +51,7 @@ base,Stop,Yes,stop,Stop,stop,stop base,GetGeometries,No,get_geometries,Geometries,,getGeometries base,Reconfigure,No,,Reconfigure,, base,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand +base,GetStatus,No,get_status,,getStatus,getStatus base,GetResourceName,No,get_resource_name,Name,getResourceName,name base,Close,No,close,Close,, @@ -73,6 +77,7 @@ board,GPIOPinByName,No,gpio_pin_by_name,GPIOPinByName,, board,GetGeometries,No,get_geometries,,, board,Reconfigure,No,,Reconfigure,, board,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand +board,GetStatus,No,get_status,,getStatus,getStatus board,GetResourceName,No,get_resource_name,Name,getResourceName,name board,Close,No,close,Close,, @@ -80,6 +85,7 @@ board,Close,No,close,Close,, button,Push,Yes,push,Push,push,push button,Reconfigure,No,,Reconfigure,, button,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand +button,GetStatus,No,get_status,,getStatus,getStatus button,GetResourceName,No,get_resource_name,Name,getResourceName,name button,Close,No,close,Close,, @@ -89,6 +95,7 @@ camera,GetPointCloud,,get_point_cloud,NextPointCloud,pointCloud,getPointCloud camera,GetProperties,,get_properties,Properties,properties,getProperties ## TED: Camera in Go SDK doesn't appear to implement (inherit) these: camera,DoCommand,,do_command,DoCommand,doCommand,doCommand +camera,GetStatus,,get_status,,getStatus,getStatus camera,GetGeometries,,get_geometries,Geometries,,getGeometries ## HACK: proto for close, manually mapping: camera,GetResourceName,,get_resource_name,Name,getResourceName,name @@ -102,6 +109,7 @@ encoder,GetGeometries,No,get_geometries,,, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: encoder,Reconfigure,No,,Reconfigure,, encoder,DoCommand,Yes,do_command,DoCommand,,doCommand +encoder,GetStatus,No,get_status,,,getStatus encoder,GetResourceName,No,get_resource_name,Name,,name encoder,Close,No,close,Close,, @@ -117,6 +125,7 @@ gantry,IsMoving,,is_moving,IsMoving,isMoving,isMoving gantry,Stop,,stop,Stop,stop,stop gantry,Reconfigure,,,Reconfigure,, gantry,DoCommand,,do_command,DoCommand,doCommand,doCommand +gantry,GetStatus,,get_status,,getStatus,getStatus gantry,GetKinematics,,get_kinematics,Kinematics,, gantry,GetResourceName,,get_resource_name,Name,getResourceName,name gantry,Close,,close,Close,, @@ -125,6 +134,7 @@ gantry,Close,,close,Close,, ## NOTED:Generic Component in Go SDK doesn't appear to implement (inherit) these: generic_component,GetGeometries,No,get_geometries,,,getGeometries generic_component,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand +generic_component,GetStatus,No,get_status,,getStatus,getStatus ## HACK: No proto for close, manually mapping: ## NOTED: Go SDK also missing Close, but we have it in our docs?: generic_component,GetResourceName,No,get_resource_name,Name,getResourceName,name @@ -142,6 +152,7 @@ gripper,GetCurrentInputs,,get_current_inputs,CurrentInputs,,getCurrentInputs gripper,GoToInputs,,go_to_inputs,GoToInputs,,goToInputs gripper,Reconfigure,,,Reconfigure,, gripper,DoCommand,,do_command,DoCommand,doCommand,doCommand +gripper,GetStatus,,get_status,,getStatus,getStatus gripper,GetKinematics,,get_kinematics,Kinematics,getKinematics, gripper,GetResourceName,,get_resource_name,Name,getResourceName,name gripper,Close,,close,Close,, @@ -158,6 +169,7 @@ input_controller,RegisterControlCallback,,register_control_callback,RegisterCont ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: input_controller,Reconfigure,,,Reconfigure,, input_controller,DoCommand,,do_command,DoCommand,, +input_controller,GetStatus,,get_status,,,getStatus input_controller,GetResourceName,,get_resource_name,Name,,name input_controller,Close,,close,Close,, @@ -178,6 +190,7 @@ motor,GetGeometries,No,get_geometries,,, motor,Reconfigure,No,,Reconfigure,, # NOT implemented in other languages motor,DoCommand,,do_command,DoCommand,doCommand,doCommand +motor,GetStatus,No,get_status,,getStatus,getStatus motor,GetResourceName,No,get_resource_name,Name,getResourceName,name motor,Close,No,close,Close,, @@ -196,6 +209,7 @@ movement_sensor,GetGeometries,No,get_geometries,,, movement_sensor,GetReadings,Yes,get_readings,Readings,readings,getReadings movement_sensor,Reconfigure,No,,Reconfigure,, movement_sensor,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand +movement_sensor,GetStatus,No,get_status,,getStatus,getStatus movement_sensor,GetResourceName,No,get_resource_name,Name,getResourceName,name movement_sensor,Close,No,close,Close,, @@ -210,6 +224,7 @@ power_sensor,GetReadings,,get_readings,Readings,readings,getReadings ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: power_sensor,Reconfigure,,,Reconfigure,, power_sensor,DoCommand,,do_command,DoCommand,doCommand,doCommand +power_sensor,GetStatus,,get_status,,getStatus,getStatus power_sensor,GetResourceName,,get_resource_name,Name,getResourceName,name power_sensor,Close,,close,Close,, @@ -221,6 +236,7 @@ sensor,GetGeometries,,get_geometries,,, sensor,Reconfigure,No,,Reconfigure,, # NOT implemented in other languages sensor,DoCommand,,do_command,DoCommand,doCommand,doCommand +sensor,GetStatus,No,get_status,,getStatus,getStatus sensor,GetResourceName,No,get_resource_name,Name,getResourceName,name sensor,Close,No,close,Close,, @@ -235,6 +251,7 @@ servo,GetGeometries,No,get_geometries,,, servo,Reconfigure,No,,Reconfigure,, # NOT implemented in other languages servo,DoCommand,,do_command,DoCommand,doCommand,doCommand +servo,GetStatus,No,get_status,,getStatus,getStatus servo,GetResourceName,No,get_resource_name,Name,getResourceName,name servo,Close,No,close,Close,, @@ -243,6 +260,7 @@ switch,SetPosition,Yes,set_position,SetPosition,,setPosition switch,GetPosition,Yes,get_position,GetPosition,,getPosition switch,GetNumberOfPositions,Yes,get_number_of_positions,GetNumberOfPositions,,getNumberOfPositions switch,DoCommand,Yes,do_command,DoCommand,,doCommand +switch,GetStatus,No,get_status,,,getStatus switch,GetResourceName,No,get_resource_name,Name,,name switch,Close,No,close,Close,, @@ -261,12 +279,14 @@ data_manager,UploadBinaryDataToDatasets,No,,UploadBinaryDataToDatasets,,uploadBi ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: data_manager,Reconfigure,No,,Reconfigure,, data_manager,DoCommand,No,,DoCommand,,doCommand +data_manager,GetStatus,No,,,,getStatus data_manager,GetResourceName,No,,Name,,name data_manager,Close,No,,Close,, ## Generic Service ## TED:Generic Component in Go SDK doesn't appear to implement (inherit) these: generic_service,DoCommand,,do_command,DoCommand,doCommand,doCommand +generic_service,GetStatus,,get_status,,getStatus,getStatus ## HACK: proto for close, manually mapping: ## TED: Go SDK also missing Close, but we have it in our docs?: generic_service,GetResourceName,,get_resource_name,Name,getResourceName,name @@ -278,6 +298,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,GetStatus,,get_status,,, mlmodel,GetResourceName,,get_resource_name,Name,, mlmodel,Close,,close,Close,, @@ -293,6 +314,7 @@ motion,GetPlan,,get_plan,PlanHistory,,getPlan motion,Reconfigure,,,Reconfigure,, motion,FromRobot,,from_robot,,, motion,DoCommand,,do_command,DoCommand,,doCommand +motion,GetStatus,,get_status,,,getStatus motion,GetResourceName,,get_resource_name,Name,,name motion,Close,,close,Close,, @@ -310,6 +332,7 @@ slam,PointCloudMapFull,,,PointCloudMapFull,, ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: slam,Reconfigure,,,Reconfigure,, slam,DoCommand,,do_command,DoCommand,,doCommand +slam,GetStatus,,get_status,,,getStatus slam,GetResourceName,,get_resource_name,Name,,name slam,Close,,close,Close,, @@ -323,6 +346,7 @@ vision,CaptureAllFromCamera,,capture_all_from_camera,CaptureAllFromCamera,,captu ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: vision,Reconfigure,,,Reconfigure,, vision,DoCommand,,do_command,DoCommand,doCommand,doCommand +vision,GetStatus,,get_status,,getStatus,getStatus vision,GetResourceName,,get_resource_name,Name,getResourceName,name vision,GetProperties,,get_properties,GetProperties,properties,getProperties vision,Close,,close,Close,, @@ -332,6 +356,7 @@ world_state_store,ListUUIDs,,list_uuids,,,listUUIDs world_state_store,GetTransform,,get_transform,,,getTransform world_state_store,StreamTransformChanges,,stream_transform_changes,,,streamTransformChanges world_state_store,DoCommand,,do_command,,,doCommand +world_state_store,GetStatus,,get_status,,,getStatus world_state_store,GetResourceName,,get_resource_name,,,name world_state_store,Close,,close,,, @@ -488,6 +513,7 @@ data_sync,StreamingDataCaptureUpload,,streaming_data_capture_upload,,streamingDa discovery,DiscoverResources,,discover_resources,DiscoverResources,discoverResources,discoverResources discovery,GetResourceName,,get_resource_name,Name,getResourceName,name discovery,DoCommand,,do_command,DoCommand,doCommand,doCommand +discovery,GetStatus,,get_status,,getStatus,getStatus discovery,Close,,close,Close,, ## MLTraining diff --git a/.github/workflows/update_sdk_methods.py b/.github/workflows/update_sdk_methods.py index 47778dfcf6..d7a3fdd05d 100755 --- a/.github/workflows/update_sdk_methods.py +++ b/.github/workflows/update_sdk_methods.py @@ -771,7 +771,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", "transform", "updated_fields", "ListUUIDs", "GetTransform", "StreamTransformChanges", "DoCommand"] 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", "GetStatus"] or \ lang == "go" and method not in ["Reconfigure", "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"]: diff --git a/static/include/components/apis/generated/arm-table.md b/static/include/components/apis/generated/arm-table.md index e04be683e2..73fb8de8e0 100644 --- a/static/include/components/apis/generated/arm-table.md +++ b/static/include/components/apis/generated/arm-table.md @@ -1,17 +1,18 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetEndPosition`](/reference/apis/components/arm/#getendposition) | Get the current position of the arm as a pose. | -| [`MoveToPosition`](/reference/apis/components/arm/#movetoposition) | Move the end of the arm in a straight line to the desired pose, relative to the base of the arm. | -| [`MoveToJointPositions`](/reference/apis/components/arm/#movetojointpositions) | Move each joint on the arm to the position specified in `positions`. | -| [`MoveThroughJointPositions`](/reference/apis/components/arm/#movethroughjointpositions) | Move the arm's joints through the given positions in the order they are specified. | -| [`GetJointPositions`](/reference/apis/components/arm/#getjointpositions) | Get the current position of each joint on the arm. | -| [`Get3DModels`](/reference/apis/components/arm/#get3dmodels) | Get the 3D models of the arm. | -| [`GetKinematics`](/reference/apis/components/arm/#getkinematics) | Get the kinematics information associated with the arm as the format and byte contents of the kinematics file. | -| [`IsMoving`](/reference/apis/components/arm/#ismoving) | Get if the arm is currently moving. | -| [`Stop`](/reference/apis/components/arm/#stop) | Stop all motion of the arm. | -| [`GetGeometries`](/reference/apis/components/arm/#getgeometries) | Get all the geometries associated with the arm in its current configuration, in the frame of the arm. | -| [`Reconfigure`](/reference/apis/components/arm/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/components/arm/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/arm/#getresourcename) | Get the `ResourceName` for this arm. | -| [`Close`](/reference/apis/components/arm/#close) | Safely shut down the resource and prevent further use. | +| [`GetEndPosition`](/dev/reference/apis/components/arm/#getendposition) | Get the current position of the arm as a pose. | +| [`MoveToPosition`](/dev/reference/apis/components/arm/#movetoposition) | Move the end of the arm in a straight line to the desired pose, relative to the base of the arm. | +| [`MoveToJointPositions`](/dev/reference/apis/components/arm/#movetojointpositions) | Move each joint on the arm to the position specified in `positions`. | +| [`MoveThroughJointPositions`](/dev/reference/apis/components/arm/#movethroughjointpositions) | Move the arm's joints through the given positions in the order they are specified. | +| [`GetJointPositions`](/dev/reference/apis/components/arm/#getjointpositions) | Get the current position of each joint on the arm. | +| [`Get3DModels`](/dev/reference/apis/components/arm/#get3dmodels) | Get the 3D models of the arm. | +| [`GetKinematics`](/dev/reference/apis/components/arm/#getkinematics) | Get the kinematics information associated with the arm as the format and byte contents of the kinematics file. | +| [`IsMoving`](/dev/reference/apis/components/arm/#ismoving) | Get if the arm is currently moving. | +| [`Stop`](/dev/reference/apis/components/arm/#stop) | Stop all motion of the arm. | +| [`GetGeometries`](/dev/reference/apis/components/arm/#getgeometries) | Get all the geometries associated with the arm in its current configuration, in the frame of the arm. | +| [`Reconfigure`](/dev/reference/apis/components/arm/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/components/arm/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/arm/#getstatus) | Get the current status of the arm as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/components/arm/#getresourcename) | Get the `ResourceName` for this arm. | +| [`Close`](/dev/reference/apis/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 5f5f150b47..ec3bcfc7ea 100644 --- a/static/include/components/apis/generated/arm.md +++ b/static/include/components/apis/generated/arm.md @@ -161,7 +161,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `pose` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): The destination pose for the arm. +- `pose` ([Pose](https://ts.viam.dev/types/Pose.html)) (required): The destination pose for the arm. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -597,8 +597,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- (Promise): The legacy kinematics data shape or the newer object containing -kinematics data plus a map of URDF mesh file paths to mesh data. +- (Promise): The legacy kinematics data shape or the newer object containing kinematics data plus a +map of URDF mesh file paths to mesh data. **Example:** @@ -608,7 +608,7 @@ const kinematics = await arm.getKinematics(); console.log(kinematics); For more information, see [Arm -API](https://docs.viam.com/reference/apis/components/arm/#getkinematics). +API](https://docs.viam.com/dev/reference/apis/components/arm/#getkinematics). ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ArmClient.html#getkinematics). @@ -980,8 +980,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -999,9 +999,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ArmClient.html#docommand). @@ -1030,6 +1028,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the arm as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ArmClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this arm. diff --git a/static/include/components/apis/generated/audio_in-table.md b/static/include/components/apis/generated/audio_in-table.md index a93ed3cb94..dd8e9405a1 100644 --- a/static/include/components/apis/generated/audio_in-table.md +++ b/static/include/components/apis/generated/audio_in-table.md @@ -1,10 +1,11 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetAudio`](/reference/apis/components/audio-in/#getaudio) | Get a stream of audio from the device. | -| [`GetProperties`](/reference/apis/components/audio-in/#getproperties) | Get the audio device’s properties. | -| [`GetGeometries`](/reference/apis/components/audio-in/#getgeometries) | Get all the geometries associated with the audio in component in its current configuration, in the frame of the audio in component. | -| [`Reconfigure`](/reference/apis/components/audio-in/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/components/audio-in/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/audio-in/#getresourcename) | Get the `ResourceName` for this audio in component. | -| [`Close`](/reference/apis/components/audio-in/#close) | Safely shut down the resource and prevent further use. | +| [`GetAudio`](/dev/reference/apis/components/audio-in/#getaudio) | Get a stream of audio from the device. | +| [`GetProperties`](/dev/reference/apis/components/audio-in/#getproperties) | Get the audio device’s properties. | +| [`GetGeometries`](/dev/reference/apis/components/audio-in/#getgeometries) | Get all the geometries associated with the audio in component in its current configuration, in the frame of the audio in component. | +| [`Reconfigure`](/dev/reference/apis/components/audio-in/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/components/audio-in/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/audio-in/#getstatus) | Get the current status of the audio input component as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/components/audio-in/#getresourcename) | Get the `ResourceName` for this audio in component. | +| [`Close`](/dev/reference/apis/components/audio-in/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/audio_in.md b/static/include/components/apis/generated/audio_in.md index d44c0f69c3..a416906b79 100644 --- a/static/include/components/apis/generated/audio_in.md +++ b/static/include/components/apis/generated/audio_in.md @@ -285,8 +285,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -304,9 +304,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/AudioInClient.html#docommand). @@ -335,6 +333,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the audio input component as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/audio_in/client/index.html#viam.components.audio_in.client.AudioInClient.get_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/AudioInClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/AudioInClient/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this audio in component. diff --git a/static/include/components/apis/generated/audio_out-table.md b/static/include/components/apis/generated/audio_out-table.md index 09b057f6da..836d5dc270 100644 --- a/static/include/components/apis/generated/audio_out-table.md +++ b/static/include/components/apis/generated/audio_out-table.md @@ -1,11 +1,12 @@ | Method Name | Description | | ----------- | ----------- | -| [`Play`](/reference/apis/components/audio-out/#play) | Play the given audio data. | -| [`PlayStream`](/reference/apis/components/audio-out/#playstream) | Stream audio data in chunks for playback. | -| [`GetProperties`](/reference/apis/components/audio-out/#getproperties) | Get the audio device’s properties. | -| [`GetGeometries`](/reference/apis/components/audio-out/#getgeometries) | Get all the geometries associated with the audio out component in its current configuration, in the frame of the audio out component. | -| [`Reconfigure`](/reference/apis/components/audio-out/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/components/audio-out/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/audio-out/#getresourcename) | Get the `ResourceName` for this audio out component. | -| [`Close`](/reference/apis/components/audio-out/#close) | Safely shut down the resource and prevent further use. | +| [`Play`](/dev/reference/apis/components/audio-out/#play) | Play the given audio data. | +| [`PlayStream`](/dev/reference/apis/components/audio-out/#playstream) | Stream audio data in chunks for playback. | +| [`GetProperties`](/dev/reference/apis/components/audio-out/#getproperties) | Get the audio device’s properties. | +| [`GetGeometries`](/dev/reference/apis/components/audio-out/#getgeometries) | Get all the geometries associated with the audio out component in its current configuration, in the frame of the audio out component. | +| [`Reconfigure`](/dev/reference/apis/components/audio-out/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/components/audio-out/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/audio-out/#getstatus) | Get the current status of the audio output component as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/components/audio-out/#getresourcename) | Get the `ResourceName` for this audio out component. | +| [`Close`](/dev/reference/apis/components/audio-out/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/audio_out.md b/static/include/components/apis/generated/audio_out.md index 47f8ef82cb..b6ccf12f55 100644 --- a/static/include/components/apis/generated/audio_out.md +++ b/static/include/components/apis/generated/audio_out.md @@ -38,7 +38,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ - `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. - `data` [([]byte)](https://pkg.go.dev/builtin#byte) -- `info` [(\*utils.AudioInfo)](https://pkg.go.dev/go.viam.com/rdk/utils#AudioInfo) +- `info` [(*utils.AudioInfo)](https://pkg.go.dev/go.viam.com/rdk/utils#AudioInfo) - `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call. **Returns:** @@ -53,8 +53,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** - `audioData` (Uint8Array) (required): The audio data to play. -- `audioInfo` ([AudioInfo](https://ts.viam.dev/classes/commonApi.AudioInfo.html)) (optional): Information about the audio format (optional, required - for raw pcm data). +- `audioInfo` ([AudioInfo](https://ts.viam.dev/classes/commonApi.AudioInfo.html)) (optional): Information about the audio format (optional, required for raw pcm data). - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -100,8 +99,8 @@ Stream audio data in chunks for playback. **Parameters:** -- `chunks` ([AsyncIterator](https://docs.python.org/3/library/collections.abc.html#collections.abc.AsyncIterator)[[bytes](https://docs.python.org/3/library/stdtypes.html#bytes-objects)]) (required): Async iterator of audio data chunks to play. -- `info` (viam.components.audio_out.audio_out.AudioInfo) (optional): Information about the audio data such as codec, sample rate, and channel count. +- `chunks` (AsyncIterator[[bytes](https://docs.python.org/3/library/stdtypes.html#bytes-objects)]) (required): async iterator of audio data chunks to play. +- `info` (viam.components.audio_out.audio_out.AudioInfo) (optional): (optional) information about the audio data such as codec, sample rate, and channel count. - `extra` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Extra options to pass to the underlying RPC call. - `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. @@ -130,33 +129,14 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Parameters:** - `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. -- `info` [(\*utils.AudioInfo)](https://pkg.go.dev/go.viam.com/rdk/utils#AudioInfo): Information about the audio data such as codec, sample rate, and channel count. -- `chunks` [(<-chan []byte)](https://pkg.go.dev/builtin#byte): A receive-only channel of audio data chunks. Close the channel to signal end of stream. +- `info` [(*utils.AudioInfo)](https://pkg.go.dev/go.viam.com/rdk/utils#AudioInfo) +- `info` [(*utils.AudioInfo)](https://pkg.go.dev/go.viam.com/rdk/utils#AudioInfo) - `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. -**Example:** - -```go {class="line-numbers linkable-line-numbers"} -myAudioOut, err := audioout.FromProvider(machine, "my_audio_out") - -info := &utils.AudioInfo{ - Codec: utils.CodecPCM16, - SampleRateHz: 44100, - NumChannels: 2, -} - -chunks := make(chan []byte, 2) -chunks <- audioChunk1 -chunks <- audioChunk2 -close(chunks) - -err = myAudioOut.PlayStream(context.Background(), info, chunks, nil) -``` - For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/components/audioout#AudioOut). {{% /tab %}} @@ -164,21 +144,22 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `audioInfo` ([AudioInfo](https://ts.viam.dev/classes/commonApi.AudioInfo.html)) (required): Information about the audio format (codec, sample rate, channels) that applies to every chunk. -- `chunks` (AsyncIterable\) (required): Async iterable of audio byte chunks to play in order. +- `audioInfo` ([AudioInfo](https://ts.viam.dev/classes/commonApi.AudioInfo.html)) (required): Information about the audio format (codec, sample rate, channels) that + applies to every chunk. +- `chunks` (AsyncIterable) (required): Async iterable of audio byte chunks to play in order. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) **Returns:** -- (Promise\) +- (Promise) **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const audioOut = new VIAM.AudioOutClient(machine, "my_audio_out"); +const audioOut = new VIAM.AudioOutClient(machine, 'my_audio_out'); const audioInfo = { - codec: "pcm16", + codec: 'pcm16', sampleRateHz: 22050, numChannels: 1, }; @@ -197,26 +178,13 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ **Parameters:** -- `audioInfo` [AudioInfo](https://flutter.viam.dev/viam_protos.common.common/AudioInfo-class.html) (required): Information about the audio format (codec, sample rate, channels) that applies to every chunk. -- `audioStream` [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)\<[Uint8List](https://api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html)\> (required): A stream of raw audio byte chunks to play in order. -- `extra` [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>? (optional) +- `audioInfo` [AudioInfo](https://flutter.viam.dev/viam_protos.common.common/AudioInfo-class.html) (optional) +- `audioStream` [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[Uint8List](https://api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html)> (optional) +- `extra` [Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic>? (optional) **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[PlayStreamResponse](https://flutter.viam.dev/viam_protos.component.audioout/PlayStreamResponse-class.html)\> - -**Example:** - -```dart {class="line-numbers linkable-line-numbers"} -final audioOut = AudioOut.fromRobot(robot, 'my_audio_out'); -final audioInfo = AudioInfo() - ..codec = AudioCodec.PCM16 - ..sampleRateHz = 22050 - ..numChannels = 1; - -final stream = Stream.fromIterable(audioChunks); -await audioOut.playStream(audioInfo: audioInfo, audioStream: stream); -``` +- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[PlayStreamResponse](https://flutter.viam.dev/viam_protos.component.audioout/PlayStreamResponse-class.html)> For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/AudioOutClient/playStream.html). @@ -237,7 +205,7 @@ Get the audio device’s properties. **Returns:** -- ([viam.components.audio_out.audio_out.AudioOut.Properties](https://python.viam.dev/autoapi/viam/components/audio_out/audio_out/index.html#viam.components.audio_out.audio_out.AudioOut.Properties)): : The properties of the audio output device. +- ([viam.components.audio_out.audio_out.AudioOut.Properties](https://python.viam.dev/autoapi/viam/components/audio_out/audio_out/index.html#viam.components.audio_out.audio_out.AudioOut.Properties)): : The properties of the audio output device. **Example:** @@ -278,7 +246,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const audioOut = new VIAM.AudioOutClient(machine, "my_audio_out"); +const audioOut = new VIAM.AudioOutClient(machine, 'my_audio_out'); const properties = await audioOut.getProperties(); ``` @@ -315,7 +283,7 @@ The [motion](/reference/services/motion/) and [navigation](/reference/services/n **Returns:** -- ([List[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Geometry)): : The geometries associated with the Component. +- ([List[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Geometry)): : The geometries associated with the Component. **Example:** @@ -373,7 +341,7 @@ If you are implementing your own arm and want to add features that have no corre **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): : Result of the executed command. +- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): : Result of the executed command. **Raises:** @@ -418,8 +386,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -431,15 +399,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r ```ts {class="line-numbers linkable-line-numbers"} // Plain object (recommended) const result = await resource.doCommand({ - myCommand: { key: "value" }, + myCommand: { key: 'value' }, }); // Struct (still supported) -import { Struct } from "@viamrobotics/sdk"; +import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: "value" } }), -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/AudioOutClient.html#docommand). @@ -468,6 +434,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the audio output component as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/audio_out/client/index.html#viam.components.audio_out.client.AudioOutClient.get_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/AudioOutClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/AudioOutClient/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this audio out component. @@ -481,7 +499,7 @@ Get the `ResourceName` for this audio out component. **Returns:** -- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. +- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. **Example:** @@ -526,7 +544,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -audio_out.name; +audio_out.name ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/AudioOutClient.html#name). diff --git a/static/include/components/apis/generated/base-table.md b/static/include/components/apis/generated/base-table.md index 3c6f63b566..1be36405c9 100644 --- a/static/include/components/apis/generated/base-table.md +++ b/static/include/components/apis/generated/base-table.md @@ -1,15 +1,16 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`MoveStraight`](/reference/apis/components/base/#movestraight) | Move the base in a straight line across the given distance (mm) at the given velocity (mm/sec). | | -| [`Spin`](/reference/apis/components/base/#spin) | Turn the base in place, rotating it to the given angle (degrees) at the given angular velocity (degrees/sec). | | -| [`SetPower`](/reference/apis/components/base/#setpower) | Set the linear and angular power of the base, represented as a percentage of max power for each direction in the range of [-1.0 to 1.0]. |

| -| [`SetVelocity`](/reference/apis/components/base/#setvelocity) | Set the linear velocity (mm/sec) and angular velocity (degrees/sec) of the base. | | -| [`GetProperties`](/reference/apis/components/base/#getproperties) | Get the width and turning radius of the {{< glossary_tooltip term_id="model" text="model" >}} of base in meters. | | -| [`IsMoving`](/reference/apis/components/base/#ismoving) | Returns whether the base is actively moving (or attempting to move) under its own power. | | -| [`Stop`](/reference/apis/components/base/#stop) | Stop the base from moving immediately. |

| -| [`GetGeometries`](/reference/apis/components/base/#getgeometries) | Get all the geometries associated with the base in its current configuration, in the frame of the base. | | -| [`Reconfigure`](/reference/apis/components/base/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/components/base/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetResourceName`](/reference/apis/components/base/#getresourcename) | Get the `ResourceName` for this base. | | -| [`Close`](/reference/apis/components/base/#close) | Safely shut down the resource and prevent further use. | | +| [`MoveStraight`](/dev/reference/apis/components/base/#movestraight) | Move the base in a straight line across the given distance (mm) at the given velocity (mm/sec). | | +| [`Spin`](/dev/reference/apis/components/base/#spin) | Turn the base in place, rotating it to the given angle (degrees) at the given angular velocity (degrees/sec). | | +| [`SetPower`](/dev/reference/apis/components/base/#setpower) | Set the linear and angular power of the base, represented as a percentage of max power for each direction in the range of [-1.0 to 1.0]. |

| +| [`SetVelocity`](/dev/reference/apis/components/base/#setvelocity) | Set the linear velocity (mm/sec) and angular velocity (degrees/sec) of the base. | | +| [`GetProperties`](/dev/reference/apis/components/base/#getproperties) | Get the width and turning radius of the {{< glossary_tooltip term_id="model" text="model" >}} of base in meters. | | +| [`IsMoving`](/dev/reference/apis/components/base/#ismoving) | Returns whether the base is actively moving (or attempting to move) under its own power. | | +| [`Stop`](/dev/reference/apis/components/base/#stop) | Stop the base from moving immediately. |

| +| [`GetGeometries`](/dev/reference/apis/components/base/#getgeometries) | Get all the geometries associated with the base in its current configuration, in the frame of the base. | | +| [`Reconfigure`](/dev/reference/apis/components/base/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/dev/reference/apis/components/base/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/dev/reference/apis/components/base/#getstatus) | Get the current status of the base as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/base/#getresourcename) | Get the `ResourceName` for this base. | | +| [`Close`](/dev/reference/apis/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 3862244d16..4cc5c7d14a 100644 --- a/static/include/components/apis/generated/base.md +++ b/static/include/components/apis/generated/base.md @@ -311,8 +311,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `linear` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): Desired linear power percentage from -1 to 1. -- `angular` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): Desired angular power percentage from -1 to 1. +- `linear` ([Vector3](https://ts.viam.dev/types/Vector3.html)) (required): Desired linear power percentage from -1 to 1. +- `angular` ([Vector3](https://ts.viam.dev/types/Vector3.html)) (required): Desired angular power percentage from -1 to 1. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -328,25 +328,25 @@ const base = new VIAM.BaseClient(machine, 'my_base'); // Move forward at 75% power await base.setPower( { x: 0, y: 0.75, z: 0 }, // linear power - { x: 0, y: 0, z: 0 } // no rotation + { x: 0, y: 0, z: 0 }, // no rotation ); // Move straight back at 100% power await base.setPower( { x: 0, y: -1, z: 0 }, // linear power - { x: 0, y: 0, z: 0 } // no rotation + { x: 0, y: 0, z: 0 }, // no rotation ); // Turn counter-clockwise at 50% power await base.setPower( { x: 0, y: 0, z: 0 }, // no linear movement - { x: 0, y: 0, z: 0.5 } // rotate around z-axis + { x: 0, y: 0, z: 0.5 }, // rotate around z-axis ); // Turn clockwise at 60% power await base.setPower( { x: 0, y: 0, z: 0 }, // no linear movement - { x: 0, y: 0, z: -0.6 } // rotate around z-axis + { x: 0, y: 0, z: -0.6 }, // rotate around z-axis ); ``` @@ -447,8 +447,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `linear` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): Desired linear velocity in millimeters per second. -- `angular` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): Desired angular velocity in degrees per second. +- `linear` ([Vector3](https://ts.viam.dev/types/Vector3.html)) (required): Desired linear velocity in millimeters per second. +- `angular` ([Vector3](https://ts.viam.dev/types/Vector3.html)) (required): Desired angular velocity in degrees per second. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -464,7 +464,7 @@ const base = new VIAM.BaseClient(machine, 'my_base'); // Move forward at 50mm/s while spinning 15 degrees per second to the left await base.setVelocity( { x: 0, y: 50, z: 0 }, // linear velocity in mm/s - { x: 0, y: 0, z: 15 } // 15 degrees per second counter-clockwise + { x: 0, y: 0, z: 15 }, // 15 degrees per second counter-clockwise ); ``` @@ -974,8 +974,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -993,9 +993,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/BaseClient.html#docommand). @@ -1024,6 +1022,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the base as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/BaseClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this base. diff --git a/static/include/components/apis/generated/board-table.md b/static/include/components/apis/generated/board-table.md index 064b370691..5923613a8e 100644 --- a/static/include/components/apis/generated/board-table.md +++ b/static/include/components/apis/generated/board-table.md @@ -1,22 +1,23 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`SetGPIO`](/reference/apis/components/board/#setgpio) | Set the digital signal output of this pin to low (0V) or high (active, >0V). |

| -| [`GetGPIO`](/reference/apis/components/board/#getgpio) | Get if the digital signal output of this pin is high (active, >0V). |

| -| [`GetPWM`](/reference/apis/components/board/#getpwm) | Get the pin's pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] representing the percentage of time the digital signal output by this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| -| [`SetPWM`](/reference/apis/components/board/#setpwm) | Set the pin's Pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] indicating the percentage of time the digital signal output of this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| -| [`PWMFrequency`](/reference/apis/components/board/#pwmfrequency) | Get the PWM frequency of the GPIO pin. |

| -| [`SetPWMFrequency`](/reference/apis/components/board/#setpwmfrequency) | Set the pin to the given PWM `frequency` (in Hz). When `frequency` is 0, it will use the board’s default PWM frequency. |

| -| [`GetDigitalInterruptValue`](/reference/apis/components/board/#getdigitalinterruptvalue) | Get the current value of a configured digital interrupt. | | -| [`ReadAnalogReader`](/reference/apis/components/board/#readanalogreader) | Read the current integer value of the digital signal output by the ADC. |

| -| [`WriteAnalog`](/reference/apis/components/board/#writeanalog) | Write an analog value to a pin on the board. |

| -| [`StreamTicks`](/reference/apis/components/board/#streamticks) | Start a stream of `DigitalInterrupt` ticks. | | -| [`SetPowerMode`](/reference/apis/components/board/#setpowermode) | Set the board to the indicated `PowerMode`. | | -| [`AnalogByName`](/reference/apis/components/board/#analogbyname) | Get a configured `Analog` by `name`. | | -| [`DigitalInterruptByName`](/reference/apis/components/board/#digitalinterruptbyname) | Get a DigitalInterrupt by `name`. | | -| [`GPIOPinByName`](/reference/apis/components/board/#gpiopinbyname) | Get a `GPIOPin` by {{< glossary_tooltip term_id="pin-number" text="pin number" >}}. | | -| [`GetGeometries`](/reference/apis/components/board/#getgeometries) | Get all the geometries associated with the board in its current configuration, in the frame of the board. | | -| [`Reconfigure`](/reference/apis/components/board/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/components/board/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetResourceName`](/reference/apis/components/board/#getresourcename) | Get the `ResourceName` for this board. | | -| [`Close`](/reference/apis/components/board/#close) | Safely shut down the resource and prevent further use. | | +| [`SetGPIO`](/dev/reference/apis/components/board/#setgpio) | Set the digital signal output of this pin to low (0V) or high (active, >0V). |

| +| [`GetGPIO`](/dev/reference/apis/components/board/#getgpio) | Get if the digital signal output of this pin is high (active, >0V). |

| +| [`GetPWM`](/dev/reference/apis/components/board/#getpwm) | Get the pin's pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] representing the percentage of time the digital signal output by this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| +| [`SetPWM`](/dev/reference/apis/components/board/#setpwm) | Set the pin's Pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] indicating the percentage of time the digital signal output of this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| +| [`PWMFrequency`](/dev/reference/apis/components/board/#pwmfrequency) | Get the PWM frequency of the GPIO pin. |

| +| [`SetPWMFrequency`](/dev/reference/apis/components/board/#setpwmfrequency) | Set the pin to the given PWM `frequency` (in Hz). When `frequency` is 0, it will use the board’s default PWM frequency. |

| +| [`GetDigitalInterruptValue`](/dev/reference/apis/components/board/#getdigitalinterruptvalue) | Get the current value of a configured digital interrupt. | | +| [`ReadAnalogReader`](/dev/reference/apis/components/board/#readanalogreader) | Read the current integer value of the digital signal output by the ADC. |

| +| [`WriteAnalog`](/dev/reference/apis/components/board/#writeanalog) | Write an analog value to a pin on the board. |

| +| [`StreamTicks`](/dev/reference/apis/components/board/#streamticks) | Start a stream of `DigitalInterrupt` ticks. | | +| [`SetPowerMode`](/dev/reference/apis/components/board/#setpowermode) | Set the board to the indicated `PowerMode`. | | +| [`AnalogByName`](/dev/reference/apis/components/board/#analogbyname) | Get a configured `Analog` by `name`. | | +| [`DigitalInterruptByName`](/dev/reference/apis/components/board/#digitalinterruptbyname) | Get a DigitalInterrupt by `name`. | | +| [`GPIOPinByName`](/dev/reference/apis/components/board/#gpiopinbyname) | Get a `GPIOPin` by {{< glossary_tooltip term_id="pin-number" text="pin number" >}}. | | +| [`GetGeometries`](/dev/reference/apis/components/board/#getgeometries) | Get all the geometries associated with the board in its current configuration, in the frame of the board. | | +| [`Reconfigure`](/dev/reference/apis/components/board/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/dev/reference/apis/components/board/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/dev/reference/apis/components/board/#getstatus) | Get the current status of the board as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/board/#getresourcename) | Get the `ResourceName` for this board. | | +| [`Close`](/dev/reference/apis/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 a5317b2e82..ff0749aa48 100644 --- a/static/include/components/apis/generated/board.md +++ b/static/include/components/apis/generated/board.md @@ -63,8 +63,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** - `pin` (string) (required): The pin number. -- `high` (boolean) (required): When true, set the given pin to high. When false, set the - given pin to low. +- `high` (boolean) (required): When true, set the given pin to high. When false, set the given pin to low. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -615,8 +614,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** - `pin` (string) (required): The pin. -- `frequencyHz` (number) (required): The PWM frequency, in hertz. 0 will use the board's - default PWM frequency. +- `frequencyHz` (number) (required): The PWM frequency, in hertz. 0 will use the board's default PWM frequency. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -739,9 +737,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c const board = new VIAM.BoardClient(machine, 'my_board'); // Get the number of times this DigitalInterrupt has been interrupted with a tick. -const count = await board.getDigitalInterruptValue( - 'my_example_digital_interrupt' -); +const count = await board.getDigitalInterruptValue('my_example_digital_interrupt'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/BoardClient.html#getdigitalinterruptvalue). @@ -852,9 +848,7 @@ const board = new VIAM.BoardClient(machine, 'my_board'); // Get the value of the analog signal "my_example_analog_reader" has most // recently measured. -const reading = await board.readAnalogReader( - 'my_example_analog_reader' -); +const reading = await board.readAnalogReader('my_example_analog_reader'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/BoardClient.html#readanalogreader). @@ -1083,7 +1077,7 @@ const ticks = await board.streamTicks(['8', '11']); for await (const tick of ticks) { console.log( - `Pin ${tick.pinName} changed to ${tick.high ? 'high' : 'low'} at ${tick.time}` + `Pin ${tick.pinName} changed to ${tick.high ? 'high' : 'low'} at ${tick.time}`, ); } ``` @@ -1507,8 +1501,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -1526,9 +1520,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/BoardClient.html#docommand). @@ -1557,6 +1549,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the board as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/BoardClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this board. diff --git a/static/include/components/apis/generated/button-table.md b/static/include/components/apis/generated/button-table.md index 4588bcfb61..a3844bf182 100644 --- a/static/include/components/apis/generated/button-table.md +++ b/static/include/components/apis/generated/button-table.md @@ -1,8 +1,9 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`Push`](/reference/apis/components/button/#push) | Push the button. |

| -| [`Reconfigure`](/reference/apis/components/button/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/components/button/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetResourceName`](/reference/apis/components/button/#getresourcename) | Get the `ResourceName` for this button. | | -| [`Close`](/reference/apis/components/button/#close) | Safely shut down the resource and prevent further use. | | +| [`Push`](/dev/reference/apis/components/button/#push) | Push the button. |

| +| [`Reconfigure`](/dev/reference/apis/components/button/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/dev/reference/apis/components/button/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/dev/reference/apis/components/button/#getstatus) | Get the current status of the button as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/button/#getresourcename) | Get the `ResourceName` for this button. | | +| [`Close`](/dev/reference/apis/components/button/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/button.md b/static/include/components/apis/generated/button.md index 76ab9f81bd..0d7d501027 100644 --- a/static/include/components/apis/generated/button.md +++ b/static/include/components/apis/generated/button.md @@ -179,8 +179,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -198,9 +198,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ButtonClient.html#docommand). @@ -229,6 +227,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the button as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/button/client/index.html#viam.components.button.client.ButtonClient.get_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ButtonClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this button. diff --git a/static/include/components/apis/generated/camera-table.md b/static/include/components/apis/generated/camera-table.md index 58c8ecc2f7..5e188cb956 100644 --- a/static/include/components/apis/generated/camera-table.md +++ b/static/include/components/apis/generated/camera-table.md @@ -1,10 +1,11 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetImages`](/reference/apis/components/camera/#getimages) | `GetImages` is used for getting simultaneous images from different imagers from 3D cameras along with associated metadata, and single images from non-3D cameras, for example webcams, RTSP cameras, etc. in the image list in the response. | -| [`GetPointCloud`](/reference/apis/components/camera/#getpointcloud) | Get a point cloud from the camera as bytes with a MIME type describing the structure of the data. | -| [`GetProperties`](/reference/apis/components/camera/#getproperties) | Get the camera intrinsic parameters and camera distortion, as well as whether the camera supports returning point clouds. | -| [`DoCommand`](/reference/apis/components/camera/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetGeometries`](/reference/apis/components/camera/#getgeometries) | Get all the geometries associated with the camera in its current configuration, in the frame of the camera. | -| [`GetResourceName`](/reference/apis/components/camera/#getresourcename) | Get the `ResourceName` for this camera. | -| [`Close`](/reference/apis/components/camera/#close) | Safely shut down the resource and prevent further use. | +| [`GetImages`](/dev/reference/apis/components/camera/#getimages) | `GetImages` is used for getting simultaneous images from different imagers from 3D cameras along with associated metadata, and single images from non-3D cameras, for example webcams, RTSP cameras, etc. in the image list in the response. | +| [`GetPointCloud`](/dev/reference/apis/components/camera/#getpointcloud) | Get a point cloud from the camera as bytes with a MIME type describing the structure of the data. | +| [`GetProperties`](/dev/reference/apis/components/camera/#getproperties) | Get the camera intrinsic parameters and camera distortion, as well as whether the camera supports returning point clouds. | +| [`DoCommand`](/dev/reference/apis/components/camera/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/camera/#getstatus) | Get the current status of the camera as a map of key-value pairs describing its state. | +| [`GetGeometries`](/dev/reference/apis/components/camera/#getgeometries) | Get all the geometries associated with the camera in its current configuration, in the frame of the camera. | +| [`GetResourceName`](/dev/reference/apis/components/camera/#getresourcename) | Get the `ResourceName` for this camera. | +| [`Close`](/dev/reference/apis/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 a60d9d0147..98f9eefa9f 100644 --- a/static/include/components/apis/generated/camera.md +++ b/static/include/components/apis/generated/camera.md @@ -14,7 +14,7 @@ Multiple images returned from `GetImages()` do not represent a time series of im **Parameters:** -- `filter_source_names` (Sequence[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)]) (optional): The filter_source_names parameter can be used to filter only the images from the specified source names. When unspecified, all images are returned. +- `filter_source_names` ([Sequence[str]](https://python.viam.dev/autoapi/viam/gen/app/data/v1/data_pb2/index.html#viam.gen.app.data.v1.data_pb2.Sequence)) (optional): The filter_source_names parameter can be used to filter only the images from the specified source names. When unspecified, all images are returned. - `extra` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Extra options to pass to the underlying RPC call. - `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. @@ -65,14 +65,14 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `filterSourceNames` (string) (optional): A list of source names to filter the images by. - If empty or undefined, all images will be returned. +- `filterSourceNames` (string) (optional): A list of source names to filter the images by. If empty or + undefined, all images will be returned. - `extra` (None) (optional): Extra parameters to pass to the camera. - `callOptions` (CallOptions) (optional) **Returns:** -- (Promise< { images: { image: Uint8Array; mimeType: string; sourceName: string }[]; metadata: ResponseMetadata; }, >) +- (Promise< { images: { image: Uint8Array; mimeType: string; sourceName: string; }[]; metadata: ResponseMetadata; }, >) **Example:** @@ -178,7 +178,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- (Promise) +- (Promise>) **Example:** @@ -355,8 +355,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -374,9 +374,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/CameraClient.html#docommand). @@ -405,6 +403,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the camera as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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:** + +- (Dict[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/CameraClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetGeometries Get all the geometries associated with the camera in its current configuration, in the [frame](/reference/services/frame-system/) of the camera. @@ -420,7 +470,7 @@ The [motion](/reference/services/motion/) and [navigation](/reference/services/n **Returns:** -- ([Sequence[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Geometry)): : The geometries associated with the Component. +- ([Sequence[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/gen/app/data/v1/data_pb2/index.html#viam.gen.app.data.v1.data_pb2.Sequence)): : The geometries associated with the Component. **Example:** diff --git a/static/include/components/apis/generated/encoder-table.md b/static/include/components/apis/generated/encoder-table.md index f4aacec353..57f4abbfad 100644 --- a/static/include/components/apis/generated/encoder-table.md +++ b/static/include/components/apis/generated/encoder-table.md @@ -1,11 +1,12 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`GetPosition`](/reference/apis/components/encoder/#getposition) | Get the current position of the encoder in ticks or degrees. |

| -| [`ResetPosition`](/reference/apis/components/encoder/#resetposition) | Set the current position of the encoder to be the new zero position. |

| -| [`GetProperties`](/reference/apis/components/encoder/#getproperties) | Get a list of all the position types that are supported by a given encoder. |

| -| [`GetGeometries`](/reference/apis/components/encoder/#getgeometries) | Get all the geometries associated with the encoder in its current configuration, in the frame of the encoder. | | -| [`Reconfigure`](/reference/apis/components/encoder/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/components/encoder/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetResourceName`](/reference/apis/components/encoder/#getresourcename) | Get the `ResourceName` for this encoder. | | -| [`Close`](/reference/apis/components/encoder/#close) | Safely shut down the resource and prevent further use. | | +| [`GetPosition`](/dev/reference/apis/components/encoder/#getposition) | Get the current position of the encoder in ticks or degrees. |

| +| [`ResetPosition`](/dev/reference/apis/components/encoder/#resetposition) | Set the current position of the encoder to be the new zero position. |

| +| [`GetProperties`](/dev/reference/apis/components/encoder/#getproperties) | Get a list of all the position types that are supported by a given encoder. |

| +| [`GetGeometries`](/dev/reference/apis/components/encoder/#getgeometries) | Get all the geometries associated with the encoder in its current configuration, in the frame of the encoder. | | +| [`Reconfigure`](/dev/reference/apis/components/encoder/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/dev/reference/apis/components/encoder/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/dev/reference/apis/components/encoder/#getstatus) | Get the current status of the encoder as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/encoder/#getresourcename) | Get the `ResourceName` for this encoder. | | +| [`Close`](/dev/reference/apis/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 84fbef39ba..df39618249 100644 --- a/static/include/components/apis/generated/encoder.md +++ b/static/include/components/apis/generated/encoder.md @@ -66,8 +66,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `positionType` ([PositionType](https://ts.viam.dev/enums/encoderApi.PositionType.html)) (optional): The type of position the encoder returns (ticks or - degrees). +- `positionType` ([PositionType](https://ts.viam.dev/enums/encoderApi.PositionType.html)) (optional): The type of position the encoder returns (ticks or degrees). - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -82,7 +81,7 @@ const encoder = new VIAM.EncoderClient(machine, 'my_encoder'); // Get the position of the encoder in ticks const [position, posType] = await encoder.getPosition( - EncoderPositionType.POSITION_TYPE_TICKS_COUNT + EncoderPositionType.POSITION_TYPE_TICKS_COUNT, ); console.log('The encoder position is currently', position, posType); ``` @@ -368,8 +367,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -387,9 +386,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/EncoderClient.html#docommand). @@ -397,6 +394,45 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the encoder as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/EncoderClient.html#getstatus). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this encoder. diff --git a/static/include/components/apis/generated/gantry-table.md b/static/include/components/apis/generated/gantry-table.md index 70da493e32..70c9ae7e97 100644 --- a/static/include/components/apis/generated/gantry-table.md +++ b/static/include/components/apis/generated/gantry-table.md @@ -1,15 +1,16 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetPosition`](/reference/apis/components/gantry/#getposition) | Get the current positions of the axis of the gantry (mm). | -| [`MoveToPosition`](/reference/apis/components/gantry/#movetoposition) | Move the axes of the gantry to the desired positions (mm) at the requested speeds (mm/sec). | -| [`GetLengths`](/reference/apis/components/gantry/#getlengths) | Get the lengths of the axes of the gantry (mm). | -| [`Home`](/reference/apis/components/gantry/#home) | Run the homing sequence of the gantry to re-calibrate the axes with respect to the limit switches. | -| [`GetGeometries`](/reference/apis/components/gantry/#getgeometries) | Get all the geometries associated with the gantry in its current configuration, in the frame of the gantry. | -| [`IsMoving`](/reference/apis/components/gantry/#ismoving) | Get if the gantry is currently moving. | -| [`Stop`](/reference/apis/components/gantry/#stop) | Stop all motion of the gantry. | -| [`Reconfigure`](/reference/apis/components/gantry/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/components/gantry/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetKinematics`](/reference/apis/components/gantry/#getkinematics) | Get the kinematics information associated with the gantry. | -| [`GetResourceName`](/reference/apis/components/gantry/#getresourcename) | Get the `ResourceName` for this gantry. | -| [`Close`](/reference/apis/components/gantry/#close) | Safely shut down the resource and prevent further use. | +| [`GetPosition`](/dev/reference/apis/components/gantry/#getposition) | Get the current positions of the axis of the gantry (mm). | +| [`MoveToPosition`](/dev/reference/apis/components/gantry/#movetoposition) | Move the axes of the gantry to the desired positions (mm) at the requested speeds (mm/sec). | +| [`GetLengths`](/dev/reference/apis/components/gantry/#getlengths) | Get the lengths of the axes of the gantry (mm). | +| [`Home`](/dev/reference/apis/components/gantry/#home) | Run the homing sequence of the gantry to re-calibrate the axes with respect to the limit switches. | +| [`GetGeometries`](/dev/reference/apis/components/gantry/#getgeometries) | Get all the geometries associated with the gantry in its current configuration, in the frame of the gantry. | +| [`IsMoving`](/dev/reference/apis/components/gantry/#ismoving) | Get if the gantry is currently moving. | +| [`Stop`](/dev/reference/apis/components/gantry/#stop) | Stop all motion of the gantry. | +| [`Reconfigure`](/dev/reference/apis/components/gantry/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/components/gantry/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/gantry/#getstatus) | Get the current status of the gantry as a map of key-value pairs describing its state. | +| [`GetKinematics`](/dev/reference/apis/components/gantry/#getkinematics) | Get the kinematics information associated with the gantry. | +| [`GetResourceName`](/dev/reference/apis/components/gantry/#getresourcename) | Get the `ResourceName` for this gantry. | +| [`Close`](/dev/reference/apis/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 d484887a3b..0a4723f051 100644 --- a/static/include/components/apis/generated/gantry.md +++ b/static/include/components/apis/generated/gantry.md @@ -167,8 +167,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** - `positionsMm` (number) (required): The goal positions for each axis of the gantry. -- `speedsMmPerSec` (number) (required): The desired speed for each axis to move to the - respective position in positionsMm. +- `speedsMmPerSec` (number) (required): The desired speed for each axis to move to the respective position in + positionsMm. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -370,8 +370,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- (Promise): A bool representing whether the gantry has run the homing sequence -successfully. +- (Promise): A bool representing whether the gantry has run the homing sequence successfully. **Example:** @@ -747,8 +746,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -766,9 +765,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GantryClient.html#docommand). @@ -797,6 +794,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the gantry as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GantryClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetKinematics Get the kinematics information associated with the gantry. diff --git a/static/include/components/apis/generated/generic_component-table.md b/static/include/components/apis/generated/generic_component-table.md index e47a8ddd57..0dc2483d24 100644 --- a/static/include/components/apis/generated/generic_component-table.md +++ b/static/include/components/apis/generated/generic_component-table.md @@ -1,7 +1,8 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`GetGeometries`](/reference/apis/components/generic/#getgeometries) | Get all the geometries associated with the generic component in its current configuration, in the frame of the generic component. | | -| [`DoCommand`](/reference/apis/components/generic/#docommand) | Execute model-specific commands. |

| -| [`GetResourceName`](/reference/apis/components/generic/#getresourcename) | Get the `ResourceName` for this generic component. | | -| [`Close`](/reference/apis/components/generic/#close) | Safely shut down the resource and prevent further use. | | +| [`GetGeometries`](/dev/reference/apis/components/generic/#getgeometries) | Get all the geometries associated with the generic component in its current configuration, in the frame of the generic component. | | +| [`DoCommand`](/dev/reference/apis/components/generic/#docommand) | Execute model-specific commands. |

| +| [`GetStatus`](/dev/reference/apis/components/generic/#getstatus) | Get the current status of the generic component as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/generic/#getresourcename) | Get the `ResourceName` for this generic component. | | +| [`Close`](/dev/reference/apis/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 5de32e31e6..05dbb63b95 100644 --- a/static/include/components/apis/generated/generic_component.md +++ b/static/include/components/apis/generated/generic_component.md @@ -13,7 +13,7 @@ The [motion](/reference/services/motion/) and [navigation](/reference/services/n **Returns:** -- ([List[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Geometry)): : The geometries associated with the Component. +- ([List[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Geometry)): : The geometries associated with the Component. **Example:** @@ -28,35 +28,6 @@ if geometries: 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_geometries). -{{% /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. -- `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call. - -**Returns:** - -- [([]spatialmath.Geometry)](https://pkg.go.dev/go.viam.com/rdk/spatialmath#Geometry): The geometries associated with this resource, in any order. -- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. - -**Example:** - -```go {class="line-numbers linkable-line-numbers"} -myGenericComponent, err := generic.FromProvider(machine, "my_generic_component") - -geometries, err := myGenericComponent.Geometries(context.Background(), nil) - -if len(geometries) > 0 { - // Get the center of the first geometry - elem := geometries[0] - fmt.Println("Pose of the first geometry's center point:", elem.Pose()) -} -``` - -For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Shaped). - {{% /tab %}} {{% tab name="TypeScript" %}} @@ -72,14 +43,11 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const generic = new VIAM.GenericComponentClient( - machine, - "my_generic_component", -); +const generic = new VIAM.GenericComponentClient(machine, 'my_generic_component'); // Get the geometries of this component const geometries = await generic.getGeometries(); -console.log("Geometries:", geometries); +console.log('Geometries:', geometries); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GenericComponentClient.html#getgeometries). @@ -103,7 +71,7 @@ Supported by `viam-micro-server`. **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : Result of the executed command. +- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]): : Result of the executed command. **Raises:** @@ -148,8 +116,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -161,15 +129,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r ```ts {class="line-numbers linkable-line-numbers"} // Plain object (recommended) const result = await resource.doCommand({ - myCommand: { key: "value" }, + myCommand: { key: 'value' }, }); // Struct (still supported) -import { Struct } from "@viamrobotics/sdk"; +import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: "value" } }), -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GenericComponentClient.html#docommand). @@ -198,6 +164,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the generic component as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GenericComponentClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this generic component. @@ -211,7 +229,7 @@ Get the `ResourceName` for this generic component. **Returns:** -- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. +- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. **Example:** @@ -256,7 +274,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -generic_component.name; +generic_component.name ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GenericComponentClient.html#name). diff --git a/static/include/components/apis/generated/gripper-table.md b/static/include/components/apis/generated/gripper-table.md index c31cc6a9ff..5f5ac58935 100644 --- a/static/include/components/apis/generated/gripper-table.md +++ b/static/include/components/apis/generated/gripper-table.md @@ -1,16 +1,17 @@ | Method Name | Description | | ----------- | ----------- | -| [`Open`](/reference/apis/components/gripper/#open) | Opens the gripper. | -| [`Grab`](/reference/apis/components/gripper/#grab) | Closes the gripper until it grabs something or closes completely, and returns whether it grabbed something or not. | -| [`IsMoving`](/reference/apis/components/gripper/#ismoving) | Returns whether the gripper is actively moving (or attempting to move) under its own power. | -| [`IsHoldingSomething`](/reference/apis/components/gripper/#isholdingsomething) | Return if the gripper is holding something. | -| [`Stop`](/reference/apis/components/gripper/#stop) | Stops the gripper. | -| [`GetGeometries`](/reference/apis/components/gripper/#getgeometries) | Get all the geometries associated with the gripper in its current configuration, in the frame of the gripper. | -| [`GetCurrentInputs`](/reference/apis/components/gripper/#getcurrentinputs) | Get the current joint input values of the gripper. | -| [`GoToInputs`](/reference/apis/components/gripper/#gotoinputs) | Move the gripper to the specified joint input values. | -| [`Reconfigure`](/reference/apis/components/gripper/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/components/gripper/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetKinematics`](/reference/apis/components/gripper/#getkinematics) | Get the kinematics information associated with the gripper as the format and byte contents of the kinematics file. | -| [`GetResourceName`](/reference/apis/components/gripper/#getresourcename) | Get the `ResourceName` for this gripper. | -| [`Close`](/reference/apis/components/gripper/#close) | Safely shut down the resource and prevent further use. | +| [`Open`](/dev/reference/apis/components/gripper/#open) | Opens the gripper. | +| [`Grab`](/dev/reference/apis/components/gripper/#grab) | Closes the gripper until it grabs something or closes completely, and returns whether it grabbed something or not. | +| [`IsMoving`](/dev/reference/apis/components/gripper/#ismoving) | Returns whether the gripper is actively moving (or attempting to move) under its own power. | +| [`IsHoldingSomething`](/dev/reference/apis/components/gripper/#isholdingsomething) | Return if the gripper is holding something. | +| [`Stop`](/dev/reference/apis/components/gripper/#stop) | Stops the gripper. | +| [`GetGeometries`](/dev/reference/apis/components/gripper/#getgeometries) | Get all the geometries associated with the gripper in its current configuration, in the frame of the gripper. | +| [`GetCurrentInputs`](/dev/reference/apis/components/gripper/#getcurrentinputs) | Get the current joint input values of the gripper. | +| [`GoToInputs`](/dev/reference/apis/components/gripper/#gotoinputs) | Move the gripper to the specified joint input values. | +| [`Reconfigure`](/dev/reference/apis/components/gripper/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/components/gripper/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/gripper/#getstatus) | Get the current status of the gripper as a map of key-value pairs describing its state. | +| [`GetKinematics`](/dev/reference/apis/components/gripper/#getkinematics) | Get the kinematics information associated with the gripper as the format and byte contents of the kinematics file. | +| [`GetResourceName`](/dev/reference/apis/components/gripper/#getresourcename) | Get the `ResourceName` for this gripper. | +| [`Close`](/dev/reference/apis/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 b351f4cdf2..dd4acfba02 100644 --- a/static/include/components/apis/generated/gripper.md +++ b/static/include/components/apis/generated/gripper.md @@ -63,7 +63,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const gripper = new VIAM.GripperClient(machine, "my_gripper"); +const gripper = new VIAM.GripperClient(machine, 'my_gripper'); // Open the gripper await gripper.open(); @@ -107,7 +107,7 @@ Closes the gripper until it grabs something or closes completely, and returns wh **Returns:** -- ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)): : Indicates if the gripper grabbed something. +- ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)): : Indicates if the gripper grabbed something. **Example:** @@ -130,7 +130,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Returns:** -- [(bool)](https://pkg.go.dev/builtin#bool): True if the gripper grabbed something with non-zero thickness. +- [(bool)](https://pkg.go.dev/builtin#bool): True if the gripper grabbed something with non-zero thickness. - [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. **Example:** @@ -159,7 +159,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const gripper = new VIAM.GripperClient(machine, "my_gripper"); +const gripper = new VIAM.GripperClient(machine, 'my_gripper'); // Close the gripper to grab await gripper.grab(); @@ -202,7 +202,7 @@ Returns whether the gripper is actively moving (or attempting to move) under its **Returns:** -- ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)): : Whether the gripper is moving. +- ([bool](https://docs.python.org/3/library/stdtypes.html#boolean-type-bool)): : Whether the gripper is moving. **Example:** @@ -258,11 +258,11 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const gripper = new VIAM.GripperClient(machine, "my_gripper"); +const gripper = new VIAM.GripperClient(machine, 'my_gripper'); // Check if the gripper is currently moving const moving = await gripper.isMoving(); -console.log("Gripper is moving:", moving); +console.log('Gripper is moving:', moving); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GripperClient.html#ismoving). @@ -303,7 +303,7 @@ Return if the gripper is holding something. **Returns:** -- ([viam.components.gripper.gripper.Gripper.HoldingStatus](https://python.viam.dev/autoapi/viam/components/gripper/gripper/index.html#viam.components.gripper.gripper.Gripper.HoldingStatus)): : see documentation on HoldingStatus for more information. +- ([viam.components.gripper.gripper.Gripper.HoldingStatus](https://python.viam.dev/autoapi/viam/components/gripper/gripper/index.html#viam.components.gripper.gripper.Gripper.HoldingStatus)): : see documentation on HoldingStatus for more information. **Example:** @@ -416,7 +416,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const gripper = new VIAM.GripperClient(machine, "my_gripper"); +const gripper = new VIAM.GripperClient(machine, 'my_gripper'); // Stop the gripper's current motion await gripper.stop(); @@ -461,7 +461,7 @@ The [motion](/reference/services/motion/) and [navigation](/reference/services/n **Returns:** -- ([List[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Geometry)): : The geometries associated with the Component. +- ([List[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Geometry)): : The geometries associated with the Component. **Example:** @@ -521,11 +521,11 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const gripper = new VIAM.GripperClient(machine, "my_gripper"); +const gripper = new VIAM.GripperClient(machine, 'my_gripper'); // Get the geometries of this component const geometries = await gripper.getGeometries(); -console.log("Geometries:", geometries); +console.log('Geometries:', geometries); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GripperClient.html#getgeometries). @@ -548,7 +548,7 @@ This method is part of the frame system's `InputEnabled` interface and is releva **Returns:** -- ([List[float]](https://docs.python.org/3/library/stdtypes.html#list)): The current input values of the gripper. +- (List[[float](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)]): : The current input values of the gripper. **Example:** @@ -561,29 +561,6 @@ inputs = await my_gripper.get_current_inputs() 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_current_inputs). -{{% /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:** - -- [([]referenceframe.Input)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#Input): The current input values of the gripper. -- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. - -**Example:** - -```go {class="line-numbers linkable-line-numbers"} -myGripper, err := gripper.FromProvider(machine, "my_gripper") - -// Get the current input values of the gripper. -inputs, err := myGripper.CurrentInputs(context.Background()) -``` - -For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/robot/framesystem#InputEnabled). - {{% /tab %}} {{% tab name="TypeScript" %}} @@ -599,11 +576,11 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const gripper = new VIAM.GripperClient(machine, "my_gripper"); +const gripper = new VIAM.GripperClient(machine, 'my_gripper'); // Get the current inputs of the gripper const inputs = await gripper.getCurrentInputs(); -console.log("Current inputs:", inputs); +console.log('Current inputs:', inputs); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GripperClient.html#getcurrentinputs). @@ -621,7 +598,7 @@ This method is part of the frame system's `InputEnabled` interface and is releva **Parameters:** -- `values` ([List[float]](https://docs.python.org/3/library/stdtypes.html#list)) (required): The input values to move the gripper to. +- `values` (List[[float](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)]) (required): The input values to move the gripper to. - `extra` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Extra options to pass to the underlying RPC call. - `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. @@ -640,35 +617,12 @@ await my_gripper.go_to_inputs([0.5, 0.8]) For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/gripper/client/index.html#viam.components.gripper.client.GripperClient.go_to_inputs). -{{% /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. -- `inputSteps` [([][]referenceframe.Input)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#Input): One or more sets of input values to move the gripper through, in order. - -**Returns:** - -- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. - -**Example:** - -```go {class="line-numbers linkable-line-numbers"} -myGripper, err := gripper.FromProvider(machine, "my_gripper") - -// Move the gripper to specific input values. -err = myGripper.GoToInputs(context.Background(), []referenceframe.Input{0.5}) -``` - -For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/robot/framesystem#InputEnabled). - {{% /tab %}} {{% tab name="TypeScript" %}} **Parameters:** -- `values` (number[]) (required): The input values to move the gripper to. +- `values` (number) (required): The input values to move the gripper to. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -679,7 +633,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const gripper = new VIAM.GripperClient(machine, "my_gripper"); +const gripper = new VIAM.GripperClient(machine, 'my_gripper'); // Move the gripper to specific input values await gripper.goToInputs([0.5]); @@ -730,7 +684,7 @@ If you are implementing your own gripper and want to add features that have no c **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): : Result of the executed command. +- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): : Result of the executed command. **Raises:** @@ -775,8 +729,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -788,15 +742,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r ```ts {class="line-numbers linkable-line-numbers"} // Plain object (recommended) const result = await resource.doCommand({ - myCommand: { key: "value" }, + myCommand: { key: 'value' }, }); // Struct (still supported) -import { Struct } from "@viamrobotics/sdk"; +import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: "value" } }), -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GripperClient.html#docommand). @@ -825,6 +777,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the gripper as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GripperClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetKinematics Get the kinematics information associated with the gripper as the format and byte contents of the [kinematics file](/motion-planning/frame-system/overview/). @@ -839,11 +843,11 @@ Get the kinematics information associated with the gripper as the format and byt **Returns:** -- ([viam.components.KinematicsReturn](https://python.viam.dev/autoapi/viam/components/index.html#viam.components.KinematicsReturn)): : A tuple containing two values; the first [0] value represents the format of the - file, either in URDF format (`KinematicsFileFormat.KINEMATICS_FILE_FORMAT_URDF`) or - Viam’s kinematic parameter format (spatial vector algebra) (`KinematicsFileFormat.KINEMATICS_FILE_FORMAT_SVA`), - and the second [1] value represents the byte contents of the file. - If available, a third [2] value provides meshes keyed by URDF filepath. +- ([viam.components.KinematicsReturn](https://python.viam.dev/autoapi/viam/components/index.html#viam.components.KinematicsReturn)): : A tuple containing two values; the first [0] value represents the format of the + file, either in URDF format (`KinematicsFileFormat.KINEMATICS_FILE_FORMAT_URDF`) or + Viam’s kinematic parameter format (spatial vector algebra) (`KinematicsFileFormat.KINEMATICS_FILE_FORMAT_SVA`), + and the second [1] value represents the byte contents of the file. + If available, a third [2] value provides meshes keyed by URDF filepath. **Example:** @@ -912,7 +916,7 @@ Get the `ResourceName` for this gripper. **Returns:** -- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. +- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. **Example:** @@ -957,7 +961,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -gripper.name; +gripper.name ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GripperClient.html#name). diff --git a/static/include/components/apis/generated/input_controller-table.md b/static/include/components/apis/generated/input_controller-table.md index 6a31e14f3c..c22548f6a7 100644 --- a/static/include/components/apis/generated/input_controller-table.md +++ b/static/include/components/apis/generated/input_controller-table.md @@ -1,12 +1,13 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetControls`](/reference/apis/components/input-controller/#getcontrols) | Get a list of the Controls that your controller provides. | -| [`GetEvents`](/reference/apis/components/input-controller/#getevents) | This method returns the current state of the controller as a map of Event Objects, representing the most recent event that has occurred on each available Control. | -| [`TriggerEvent`](/reference/apis/components/input-controller/#triggerevent) | Directly send an Event Object from external code. | -| [`GetGeometries`](/reference/apis/components/input-controller/#getgeometries) | Get all the geometries associated with the input controller in its current configuration, in the frame of the input controller. | -| [`RegisterControlCallback`](/reference/apis/components/input-controller/#registercontrolcallback) | Defines a callback function to execute whenever one of the EventTypes selected occurs on the given Control. | -| [`Reconfigure`](/reference/apis/components/input-controller/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/components/input-controller/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/input-controller/#getresourcename) | Get the `ResourceName` for this input controller. | -| [`Close`](/reference/apis/components/input-controller/#close) | Safely shut down the resource and prevent further use. | +| [`GetControls`](/dev/reference/apis/components/input-controller/#getcontrols) | Get a list of the Controls that your controller provides. | +| [`GetEvents`](/dev/reference/apis/components/input-controller/#getevents) | This method returns the current state of the controller as a map of Event Objects, representing the most recent event that has occurred on each available Control. | +| [`TriggerEvent`](/dev/reference/apis/components/input-controller/#triggerevent) | Directly send an Event Object from external code. | +| [`GetGeometries`](/dev/reference/apis/components/input-controller/#getgeometries) | Get all the geometries associated with the input controller in its current configuration, in the frame of the input controller. | +| [`RegisterControlCallback`](/dev/reference/apis/components/input-controller/#registercontrolcallback) | Defines a callback function to execute whenever one of the EventTypes selected occurs on the given Control. | +| [`Reconfigure`](/dev/reference/apis/components/input-controller/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/components/input-controller/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/input-controller/#getstatus) | Get the current status of the input controller as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/components/input-controller/#getresourcename) | Get the `ResourceName` for this input controller. | +| [`Close`](/dev/reference/apis/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 c7c53551be..dd210c24f0 100644 --- a/static/include/components/apis/generated/input_controller.md +++ b/static/include/components/apis/generated/input_controller.md @@ -128,10 +128,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const controller = new VIAM.InputControllerClient( - machine, - 'my_controller' -); +const controller = new VIAM.InputControllerClient(machine, 'my_controller'); // Get the most recent Event for each Control const recentEvents = await controller.getEvents(); @@ -202,7 +199,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `event` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required) +- `event` ([InputControllerEvent](https://ts.viam.dev/types/InputControllerEvent.html)) (required) - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -213,10 +210,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const controller = new VIAM.InputControllerClient( - machine, - 'my_controller' -); +const controller = new VIAM.InputControllerClient(machine, 'my_controller'); // Create a "Button is Pressed" event for the control BUTTON_START const buttonPressEvent = new VIAM.InputControllerEvent({ @@ -469,6 +463,45 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the input controller as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/InputControllerClient.html#getstatus). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this input controller. diff --git a/static/include/components/apis/generated/motor-table.md b/static/include/components/apis/generated/motor-table.md index d26a28643a..010b646dd5 100644 --- a/static/include/components/apis/generated/motor-table.md +++ b/static/include/components/apis/generated/motor-table.md @@ -1,18 +1,19 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`SetPower`](/reference/apis/components/motor/#setpower) | Set the portion of max power to send to the motor (between `-1` and `1`). |

| -| [`SetRPM`](/reference/apis/components/motor/#setrpm) | Spin the motor indefinitely at the specified speed, in revolutions per minute. If `rpm` is positive, the motor will spin forwards, and if `rpm` is negative, the motor will spin backwards. | | -| [`GoFor`](/reference/apis/components/motor/#gofor) | Spin the motor the specified number of revolutions at specified revolutions per minute. | | -| [`GoTo`](/reference/apis/components/motor/#goto) | Turn the motor to a specified position (in terms of revolutions from home/zero) at a specified speed in revolutions per minute (RPM). | | -| [`ResetZeroPosition`](/reference/apis/components/motor/#resetzeroposition) | Set the current position (modified by `offset`) to be the new zero (home) position. | | -| [`GetPosition`](/reference/apis/components/motor/#getposition) | Report the position of the motor based on its encoder. |

| -| [`GetProperties`](/reference/apis/components/motor/#getproperties) | Report a dictionary mapping optional properties to whether it is supported by this motor. |

| -| [`IsPowered`](/reference/apis/components/motor/#ispowered) | Return whether or not the motor is currently running, and the portion of max power (between `0` and `1`; if the motor is off the power will be `0`). | | -| [`IsMoving`](/reference/apis/components/motor/#ismoving) | Return whether the motor is actively moving (or attempting to move) under its own power. |

| -| [`Stop`](/reference/apis/components/motor/#stop) | Cut the power to the motor immediately, without any gradual step down. |

| -| [`GetGeometries`](/reference/apis/components/motor/#getgeometries) | Get all the geometries associated with the motor in its current configuration, in the frame of the motor. | | -| [`Reconfigure`](/reference/apis/components/motor/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/components/motor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/motor/#getresourcename) | Get the `ResourceName` for this motor. | | -| [`Close`](/reference/apis/components/motor/#close) | Safely shut down the resource and prevent further use. | | +| [`SetPower`](/dev/reference/apis/components/motor/#setpower) | Set the portion of max power to send to the motor (between `-1` and `1`). |

| +| [`SetRPM`](/dev/reference/apis/components/motor/#setrpm) | Spin the motor indefinitely at the specified speed, in revolutions per minute. If `rpm` is positive, the motor will spin forwards, and if `rpm` is negative, the motor will spin backwards. | | +| [`GoFor`](/dev/reference/apis/components/motor/#gofor) | Spin the motor the specified number of revolutions at specified revolutions per minute. | | +| [`GoTo`](/dev/reference/apis/components/motor/#goto) | Turn the motor to a specified position (in terms of revolutions from home/zero) at a specified speed in revolutions per minute (RPM). | | +| [`ResetZeroPosition`](/dev/reference/apis/components/motor/#resetzeroposition) | Set the current position (modified by `offset`) to be the new zero (home) position. | | +| [`GetPosition`](/dev/reference/apis/components/motor/#getposition) | Report the position of the motor based on its encoder. |

| +| [`GetProperties`](/dev/reference/apis/components/motor/#getproperties) | Report a dictionary mapping optional properties to whether it is supported by this motor. |

| +| [`IsPowered`](/dev/reference/apis/components/motor/#ispowered) | Return whether or not the motor is currently running, and the portion of max power (between `0` and `1`; if the motor is off the power will be `0`). | | +| [`IsMoving`](/dev/reference/apis/components/motor/#ismoving) | Return whether the motor is actively moving (or attempting to move) under its own power. |

| +| [`Stop`](/dev/reference/apis/components/motor/#stop) | Cut the power to the motor immediately, without any gradual step down. |

| +| [`GetGeometries`](/dev/reference/apis/components/motor/#getgeometries) | Get all the geometries associated with the motor in its current configuration, in the frame of the motor. | | +| [`Reconfigure`](/dev/reference/apis/components/motor/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/dev/reference/apis/components/motor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/motor/#getstatus) | Get the current status of the motor as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/motor/#getresourcename) | Get the `ResourceName` for this motor. | | +| [`Close`](/dev/reference/apis/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 dcdfc2993e..dc22d92224 100644 --- a/static/include/components/apis/generated/motor.md +++ b/static/include/components/apis/generated/motor.md @@ -58,8 +58,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** -- `power` (number) (required): A value between -1 and 1 where negative values indicate a - backwards direction and positive values a forward direction. +- `power` (number) (required): A value between -1 and 1 where negative values indicate a backwards direction + and positive values a forward direction. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -261,10 +261,10 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** - `rpm` (number) (required): Speed in revolutions per minute. -- `revolutions` (number) (required): Number of revolutions relative to the motor's starting - position. If this value is 0, this will run the motor at the given rpm - indefinitely. If this value is nonzero, this will block until the number - of revolutions has been completed or another operation comes in. +- `revolutions` (number) (required): Number of revolutions relative to the motor's starting position. If this + value is 0, this will run the motor at the given rpm indefinitely. If this value is nonzero, + this will block until the number of revolutions has been completed or another operation comes + in. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -368,8 +368,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Parameters:** - `rpm` (number) (required): Speed in revolutions per minute. -- `positionRevolutions` (number) (required): Number of revolutions relative to the motor's - home position. +- `positionRevolutions` (number) (required): Number of revolutions relative to the motor's home position. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -1148,8 +1147,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -1167,9 +1166,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MotorClient.html#docommand). @@ -1198,6 +1195,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the motor as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MotorClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this motor. diff --git a/static/include/components/apis/generated/movement_sensor.md b/static/include/components/apis/generated/movement_sensor.md index 7588942d45..49a2da89c6 100644 --- a/static/include/components/apis/generated/movement_sensor.md +++ b/static/include/components/apis/generated/movement_sensor.md @@ -66,10 +66,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const linearVelocity = await movementSensor.getLinearVelocity(); ``` @@ -171,10 +168,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const angularVelocity = await movementSensor.getAngularVelocity(); ``` @@ -270,10 +264,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const compassHeading = await movementSensor.getCompassHeading(); ``` @@ -377,10 +368,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const orientation = await movementSensor.getOrientation(); ``` @@ -478,10 +466,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const position = await movementSensor.getPosition(); ``` @@ -577,10 +562,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const properties = await movementSensor.getProperties(); ``` @@ -690,10 +672,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const accuracy = await movementSensor.getAccuracy(); ``` @@ -792,12 +771,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); -const linearAcceleration = - await movementSensor.getLinearAcceleration(); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); +const linearAcceleration = await movementSensor.getLinearAcceleration(); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MovementSensorClient.html#getlinearacceleration). @@ -925,10 +900,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const movementSensor = new VIAM.MovementSensorClient( - machine, - 'my_movement_sensor' -); +const movementSensor = new VIAM.MovementSensorClient(machine, 'my_movement_sensor'); const readings = await movementSensor.getReadings(); ``` @@ -1042,8 +1014,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -1061,9 +1033,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MovementSensorClient.html#docommand). @@ -1092,6 +1062,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the movement sensor as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MovementSensorClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this movement sensor. diff --git a/static/include/components/apis/generated/power_sensor-table.md b/static/include/components/apis/generated/power_sensor-table.md index 76cb68ca31..430e17b264 100644 --- a/static/include/components/apis/generated/power_sensor-table.md +++ b/static/include/components/apis/generated/power_sensor-table.md @@ -1,11 +1,12 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetVoltage`](/reference/apis/components/power-sensor/#getvoltage) | Return the voltage reading of a specified device and whether it is AC or DC. | -| [`GetCurrent`](/reference/apis/components/power-sensor/#getcurrent) | Return the current of a specified device and whether it is AC or DC. | -| [`GetPower`](/reference/apis/components/power-sensor/#getpower) | Return the power reading in watts. | -| [`GetReadings`](/reference/apis/components/power-sensor/#getreadings) | Get the measurements or readings that this power sensor provides. | -| [`Reconfigure`](/reference/apis/components/power-sensor/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/components/power-sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/power-sensor/#getresourcename) | Get the `ResourceName` for this power sensor. | -| [`Close`](/reference/apis/components/power-sensor/#close) | Safely shut down the resource and prevent further use. | +| [`GetVoltage`](/dev/reference/apis/components/power-sensor/#getvoltage) | Return the voltage reading of a specified device and whether it is AC or DC. | +| [`GetCurrent`](/dev/reference/apis/components/power-sensor/#getcurrent) | Return the current of a specified device and whether it is AC or DC. | +| [`GetPower`](/dev/reference/apis/components/power-sensor/#getpower) | Return the power reading in watts. | +| [`GetReadings`](/dev/reference/apis/components/power-sensor/#getreadings) | Get the measurements or readings that this power sensor provides. | +| [`Reconfigure`](/dev/reference/apis/components/power-sensor/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/components/power-sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/power-sensor/#getstatus) | Get the current status of the power sensor as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/components/power-sensor/#getresourcename) | Get the `ResourceName` for this power sensor. | +| [`Close`](/dev/reference/apis/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 3ad1c1b293..99226091c3 100644 --- a/static/include/components/apis/generated/power_sensor.md +++ b/static/include/components/apis/generated/power_sensor.md @@ -65,10 +65,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const powerSensor = new VIAM.PowerSensorClient( - machine, - 'my_power_sensor' -); +const powerSensor = new VIAM.PowerSensorClient(machine, 'my_power_sensor'); const [voltage, isAc] = await powerSensor.getVoltage(); ``` @@ -165,10 +162,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const powerSensor = new VIAM.PowerSensorClient( - machine, - 'my_power_sensor' -); +const powerSensor = new VIAM.PowerSensorClient(machine, 'my_power_sensor'); const [current, isAc] = await powerSensor.getCurrent(); ``` @@ -263,10 +257,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const powerSensor = new VIAM.PowerSensorClient( - machine, - 'my_power_sensor' -); +const powerSensor = new VIAM.PowerSensorClient(machine, 'my_power_sensor'); const power = await powerSensor.getPower(); ``` @@ -360,10 +351,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const powerSensor = new VIAM.PowerSensorClient( - machine, - 'my_power_sensor' -); +const powerSensor = new VIAM.PowerSensorClient(machine, 'my_power_sensor'); const readings = await powerSensor.getReadings(); ``` @@ -476,8 +464,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -495,9 +483,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/PowerSensorClient.html#docommand). @@ -526,6 +512,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the power sensor as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/PowerSensorClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this power sensor. diff --git a/static/include/components/apis/generated/sensor-table.md b/static/include/components/apis/generated/sensor-table.md index 875d5758a6..1eb6382032 100644 --- a/static/include/components/apis/generated/sensor-table.md +++ b/static/include/components/apis/generated/sensor-table.md @@ -1,9 +1,10 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`GetReadings`](/reference/apis/components/sensor/#getreadings) | Get the measurements or readings that this sensor provides. |

| -| [`GetGeometries`](/reference/apis/components/sensor/#getgeometries) | Get all the geometries associated with the sensor in its current configuration, in the frame of the sensor. | -| [`Reconfigure`](/reference/apis/components/sensor/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/components/sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/sensor/#getresourcename) | Get the `ResourceName` for this sensor. | | -| [`Close`](/reference/apis/components/sensor/#close) | Safely shut down the resource and prevent further use. | | +| [`GetReadings`](/dev/reference/apis/components/sensor/#getreadings) | Get the measurements or readings that this sensor provides. |

| +| [`GetGeometries`](/dev/reference/apis/components/sensor/#getgeometries) | Get all the geometries associated with the sensor in its current configuration, in the frame of the sensor. | +| [`Reconfigure`](/dev/reference/apis/components/sensor/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/dev/reference/apis/components/sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/sensor/#getstatus) | Get the current status of the sensor as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/sensor/#getresourcename) | Get the `ResourceName` for this sensor. | | +| [`Close`](/dev/reference/apis/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 a0ae79ba95..c9fbd6809b 100644 --- a/static/include/components/apis/generated/sensor.md +++ b/static/include/components/apis/generated/sensor.md @@ -211,8 +211,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -230,9 +230,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/SensorClient.html#docommand). @@ -261,6 +259,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the sensor as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/SensorClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this sensor. diff --git a/static/include/components/apis/generated/servo-table.md b/static/include/components/apis/generated/servo-table.md index 5a8e497685..39af82707c 100644 --- a/static/include/components/apis/generated/servo-table.md +++ b/static/include/components/apis/generated/servo-table.md @@ -1,12 +1,13 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`Move`](/reference/apis/components/servo/#move) | Move the servo to the desired angle in degrees. |

| -| [`GetPosition`](/reference/apis/components/servo/#getposition) | Get the current set angle of the servo in degrees. |

| -| [`IsMoving`](/reference/apis/components/servo/#ismoving) | Returns whether the servo is actively moving (or attempting to move) under its own power. | | -| [`Stop`](/reference/apis/components/servo/#stop) | Stop the servo from moving. |

| -| [`GetGeometries`](/reference/apis/components/servo/#getgeometries) | Get all the geometries associated with the servo in its current configuration, in the frame of the servo. | | -| [`Reconfigure`](/reference/apis/components/servo/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/components/servo/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetResourceName`](/reference/apis/components/servo/#getresourcename) | Get the `ResourceName` for this servo. | | -| [`Close`](/reference/apis/components/servo/#close) | Safely shut down the resource and prevent further use. | | +| [`Move`](/dev/reference/apis/components/servo/#move) | Move the servo to the desired angle in degrees. |

| +| [`GetPosition`](/dev/reference/apis/components/servo/#getposition) | Get the current set angle of the servo in degrees. |

| +| [`IsMoving`](/dev/reference/apis/components/servo/#ismoving) | Returns whether the servo is actively moving (or attempting to move) under its own power. | | +| [`Stop`](/dev/reference/apis/components/servo/#stop) | Stop the servo from moving. |

| +| [`GetGeometries`](/dev/reference/apis/components/servo/#getgeometries) | Get all the geometries associated with the servo in its current configuration, in the frame of the servo. | | +| [`Reconfigure`](/dev/reference/apis/components/servo/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/dev/reference/apis/components/servo/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/dev/reference/apis/components/servo/#getstatus) | Get the current status of the servo as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/servo/#getresourcename) | Get the `ResourceName` for this servo. | | +| [`Close`](/dev/reference/apis/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 2618844845..d3b575008c 100644 --- a/static/include/components/apis/generated/servo.md +++ b/static/include/components/apis/generated/servo.md @@ -546,8 +546,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -565,9 +565,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ServoClient.html#docommand). @@ -596,6 +594,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the servo as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ServoClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/Resource/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this servo. diff --git a/static/include/components/apis/generated/switch-table.md b/static/include/components/apis/generated/switch-table.md index 0ba389e99d..f5e1964362 100644 --- a/static/include/components/apis/generated/switch-table.md +++ b/static/include/components/apis/generated/switch-table.md @@ -1,9 +1,10 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`SetPosition`](/reference/apis/components/switch/#setposition) | Set the position of the switch. |

| -| [`GetPosition`](/reference/apis/components/switch/#getposition) | Return the current position of the switch. |

| -| [`GetNumberOfPositions`](/reference/apis/components/switch/#getnumberofpositions) | Return the number of valid positions for this switch. |

| -| [`DoCommand`](/reference/apis/components/switch/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetResourceName`](/reference/apis/components/switch/#getresourcename) | Get the `ResourceName` for this servo. | | -| [`Close`](/reference/apis/components/switch/#close) | Safely shut down the resource and prevent further use. | | +| [`SetPosition`](/dev/reference/apis/components/switch/#setposition) | Set the position of the switch. |

| +| [`GetPosition`](/dev/reference/apis/components/switch/#getposition) | Return the current position of the switch. |

| +| [`GetNumberOfPositions`](/dev/reference/apis/components/switch/#getnumberofpositions) | Return the number of valid positions for this switch. |

| +| [`DoCommand`](/dev/reference/apis/components/switch/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/dev/reference/apis/components/switch/#getstatus) | Get the current status of the switch as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/components/switch/#getresourcename) | Get the `ResourceName` for this servo. | | +| [`Close`](/dev/reference/apis/components/switch/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/switch.md b/static/include/components/apis/generated/switch.md index af857c5020..d831800a4d 100644 --- a/static/include/components/apis/generated/switch.md +++ b/static/include/components/apis/generated/switch.md @@ -320,8 +320,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -339,9 +339,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/SwitchClient.html#docommand). @@ -349,6 +347,45 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the switch as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the component. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await component.get_status() +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/switch/client/index.html#viam.components.switch.client.SwitchClient.get_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/SwitchClient.html#getstatus). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this servo. diff --git a/static/include/components/apis/overrides/protos/arm.GetStatus.md b/static/include/components/apis/overrides/protos/arm.GetStatus.md new file mode 100644 index 0000000000..631b97e7d3 --- /dev/null +++ b/static/include/components/apis/overrides/protos/arm.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the arm as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/audio_in.GetStatus.md b/static/include/components/apis/overrides/protos/audio_in.GetStatus.md new file mode 100644 index 0000000000..02d9935434 --- /dev/null +++ b/static/include/components/apis/overrides/protos/audio_in.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the audio input component as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/audio_out.GetStatus.md b/static/include/components/apis/overrides/protos/audio_out.GetStatus.md new file mode 100644 index 0000000000..2dd4aeecd0 --- /dev/null +++ b/static/include/components/apis/overrides/protos/audio_out.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the audio output component as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/base.GetStatus.md b/static/include/components/apis/overrides/protos/base.GetStatus.md new file mode 100644 index 0000000000..76846edd26 --- /dev/null +++ b/static/include/components/apis/overrides/protos/base.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the base as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/board.GetStatus.md b/static/include/components/apis/overrides/protos/board.GetStatus.md new file mode 100644 index 0000000000..2369d8e3a3 --- /dev/null +++ b/static/include/components/apis/overrides/protos/board.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the board as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/button.GetStatus.md b/static/include/components/apis/overrides/protos/button.GetStatus.md new file mode 100644 index 0000000000..39cd274523 --- /dev/null +++ b/static/include/components/apis/overrides/protos/button.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the button as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/camera.GetStatus.md b/static/include/components/apis/overrides/protos/camera.GetStatus.md new file mode 100644 index 0000000000..85c0d3bb92 --- /dev/null +++ b/static/include/components/apis/overrides/protos/camera.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the camera as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/encoder.GetStatus.md b/static/include/components/apis/overrides/protos/encoder.GetStatus.md new file mode 100644 index 0000000000..cb23989cdb --- /dev/null +++ b/static/include/components/apis/overrides/protos/encoder.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the encoder as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/gantry.GetStatus.md b/static/include/components/apis/overrides/protos/gantry.GetStatus.md new file mode 100644 index 0000000000..c27e73e20f --- /dev/null +++ b/static/include/components/apis/overrides/protos/gantry.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the gantry as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/generic_component.GetStatus.md b/static/include/components/apis/overrides/protos/generic_component.GetStatus.md new file mode 100644 index 0000000000..eef7887a17 --- /dev/null +++ b/static/include/components/apis/overrides/protos/generic_component.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the generic component as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/gripper.GetStatus.md b/static/include/components/apis/overrides/protos/gripper.GetStatus.md new file mode 100644 index 0000000000..588da13583 --- /dev/null +++ b/static/include/components/apis/overrides/protos/gripper.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the gripper as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/input_controller.GetStatus.md b/static/include/components/apis/overrides/protos/input_controller.GetStatus.md new file mode 100644 index 0000000000..6b2c227a5e --- /dev/null +++ b/static/include/components/apis/overrides/protos/input_controller.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the input controller as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/motor.GetStatus.md b/static/include/components/apis/overrides/protos/motor.GetStatus.md new file mode 100644 index 0000000000..d81ff528fc --- /dev/null +++ b/static/include/components/apis/overrides/protos/motor.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the motor as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/movement_sensor.GetStatus.md b/static/include/components/apis/overrides/protos/movement_sensor.GetStatus.md new file mode 100644 index 0000000000..9f331de67c --- /dev/null +++ b/static/include/components/apis/overrides/protos/movement_sensor.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the movement sensor as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/power_sensor.GetStatus.md b/static/include/components/apis/overrides/protos/power_sensor.GetStatus.md new file mode 100644 index 0000000000..808a55598c --- /dev/null +++ b/static/include/components/apis/overrides/protos/power_sensor.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the power sensor as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/sensor.GetStatus.md b/static/include/components/apis/overrides/protos/sensor.GetStatus.md new file mode 100644 index 0000000000..d7fab14638 --- /dev/null +++ b/static/include/components/apis/overrides/protos/sensor.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the sensor as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/servo.GetStatus.md b/static/include/components/apis/overrides/protos/servo.GetStatus.md new file mode 100644 index 0000000000..9c9d3fafca --- /dev/null +++ b/static/include/components/apis/overrides/protos/servo.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the servo as a map of key-value pairs describing its state. diff --git a/static/include/components/apis/overrides/protos/switch.GetStatus.md b/static/include/components/apis/overrides/protos/switch.GetStatus.md new file mode 100644 index 0000000000..dcc7949a3a --- /dev/null +++ b/static/include/components/apis/overrides/protos/switch.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the switch as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/generated/data_manager-table.md b/static/include/services/apis/generated/data_manager-table.md index 293850af59..44cc6d3499 100644 --- a/static/include/services/apis/generated/data_manager-table.md +++ b/static/include/services/apis/generated/data_manager-table.md @@ -1,9 +1,10 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`Sync`](/reference/apis/services/data/#sync) | Sync data stored on the machine to the cloud. | | -| [`UploadBinaryDataToDatasets`](/reference/apis/services/data/#uploadbinarydatatodatasets) | Upload Binary data to the specified datasets. | | -| [`Reconfigure`](/reference/apis/services/data/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/reference/apis/services/data/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | | -| [`GetResourceName`](/reference/apis/services/data/#getresourcename) | Get the `ResourceName` for this instance of the service. | | -| [`Close`](/reference/apis/services/data/#close) | Safely shut down the resource and prevent further use. | | +| [`Sync`](/dev/reference/apis/services/data/#sync) | Sync data stored on the machine to the cloud. | | +| [`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. | | +| [`GetStatus`](/dev/reference/apis/services/data/#getstatus) | Get the current status of the data management service as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/dev/reference/apis/services/data/#getresourcename) | Get the `ResourceName` for this instance of the service. | | +| [`Close`](/dev/reference/apis/services/data/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/services/apis/generated/data_manager.md b/static/include/services/apis/generated/data_manager.md index ff8a005137..247a471889 100644 --- a/static/include/services/apis/generated/data_manager.md +++ b/static/include/services/apis/generated/data_manager.md @@ -45,10 +45,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const dataManager = new VIAM.DataManagerClient( - machine, - 'my_data_manager' -); +const dataManager = new VIAM.DataManagerClient(machine, 'my_data_manager'); await dataManager.sync(); ``` @@ -98,15 +95,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const dataManager = new VIAM.DataManagerClient( - machine, - 'my_data_manager' -); +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 + MimeType.MIME_TYPE_JPEG, ); ``` @@ -174,8 +168,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -193,9 +187,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/DataManagerClient.html#docommand). @@ -203,6 +195,33 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the data management service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional): Call options for the command. + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +**Example:** + +```ts {class="line-numbers linkable-line-numbers"} +const dataManager = new VIAM.DataManagerClient(machine, 'my_data_manager'); +await dataManager.doCommand(new Struct({ cmd: 'test', data1: 500 })); +``` + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/DataManagerClient.html#getstatus). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this instance of the service. diff --git a/static/include/services/apis/generated/discovery-table.md b/static/include/services/apis/generated/discovery-table.md index cbbd494341..329387cfd5 100644 --- a/static/include/services/apis/generated/discovery-table.md +++ b/static/include/services/apis/generated/discovery-table.md @@ -1,7 +1,8 @@ | Method Name | Description | | ----------- | ----------- | -| [`DiscoverResources`](/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`](/reference/apis/services/discovery/#getresourcename) | Get the `ResourceName` for this instance of the service. | -| [`DoCommand`](/reference/apis/services/discovery/#docommand) | Execute model-specific commands. | -| [`Close`](/reference/apis/services/discovery/#close) | Safely shut down the resource and prevent further use. | +| [`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. | +| [`GetStatus`](/dev/reference/apis/services/discovery/#getstatus) | Get the current status of the discovery service as a map of key-value pairs describing its state. | +| [`Close`](/dev/reference/apis/services/discovery/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/discovery.md b/static/include/services/apis/generated/discovery.md index 66b94b6193..60a97bcc8f 100644 --- a/static/include/services/apis/generated/discovery.md +++ b/static/include/services/apis/generated/discovery.md @@ -236,8 +236,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -255,9 +255,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +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). @@ -286,6 +284,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the discovery service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the service. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await service.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/DiscoveryClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/DiscoveryClient/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### Close Safely shut down the resource and prevent further use. diff --git a/static/include/services/apis/generated/generic_service-table.md b/static/include/services/apis/generated/generic_service-table.md index 7f858cf2ea..af9f90573a 100644 --- a/static/include/services/apis/generated/generic_service-table.md +++ b/static/include/services/apis/generated/generic_service-table.md @@ -1,6 +1,7 @@ | Method Name | Description | | ----------- | ----------- | -| [`DoCommand`](/reference/apis/services/generic/#docommand) | Execute model-specific commands. | -| [`GetResourceName`](/reference/apis/services/generic/#getresourcename) | Get the `ResourceName` for this instance of the generic service. | -| [`Close`](/reference/apis/services/generic/#close) | Safely shut down the resource and prevent further use. | +| [`DoCommand`](/dev/reference/apis/services/generic/#docommand) | Execute model-specific commands. | +| [`GetStatus`](/dev/reference/apis/services/generic/#getstatus) | Get the current status of the generic service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/services/generic/#getresourcename) | Get the `ResourceName` for this instance of the generic service. | +| [`Close`](/dev/reference/apis/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 2e4a9a5c96..1d61b0b6bb 100644 --- a/static/include/services/apis/generated/generic_service.md +++ b/static/include/services/apis/generated/generic_service.md @@ -59,8 +59,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -78,9 +78,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GenericServiceClient.html#docommand). @@ -109,6 +107,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the generic service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the service. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await service.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/GenericServiceClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/GenericServiceClient/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this instance of the generic service. diff --git a/static/include/services/apis/generated/mlmodel-table.md b/static/include/services/apis/generated/mlmodel-table.md index 5e4a343741..2560fc1e1c 100644 --- a/static/include/services/apis/generated/mlmodel-table.md +++ b/static/include/services/apis/generated/mlmodel-table.md @@ -1,9 +1,10 @@ | Method Name | Description | | ----------- | ----------- | -| [`Infer`](/reference/apis/services/ml/#infer) | Take an already ordered input tensor as an array, make an inference on the model, and return an output tensor map. | -| [`Metadata`](/reference/apis/services/ml/#metadata) | Get the metadata: name, data type, expected tensor/array shape, inputs, and outputs associated with the ML model. | -| [`Reconfigure`](/reference/apis/services/ml/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/services/ml/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetResourceName`](/reference/apis/services/ml/#getresourcename) | Get the `ResourceName` for this instance of the ML model service. | -| [`Close`](/reference/apis/services/ml/#close) | Safely shut down the resource and prevent further use. | +| [`Infer`](/dev/reference/apis/services/ml/#infer) | Take an already ordered input tensor as an array, make an inference on the model, and return an output tensor map. | +| [`Metadata`](/dev/reference/apis/services/ml/#metadata) | Get the metadata: name, data type, expected tensor/array shape, inputs, and outputs associated with the ML model. | +| [`Reconfigure`](/dev/reference/apis/services/ml/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/services/ml/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/dev/reference/apis/services/ml/#getstatus) | Get the current status of the ML model service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/services/ml/#getresourcename) | Get the `ResourceName` for this instance of the ML model service. | +| [`Close`](/dev/reference/apis/services/ml/#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 a1928fe182..c09d7afbc1 100644 --- a/static/include/services/apis/generated/mlmodel.md +++ b/static/include/services/apis/generated/mlmodel.md @@ -180,6 +180,32 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the ML model service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the service. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await service.get_status() +``` + +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_status). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this instance of the ML model service. diff --git a/static/include/services/apis/generated/motion-table.md b/static/include/services/apis/generated/motion-table.md index dfa35cfc38..bc449c2900 100644 --- a/static/include/services/apis/generated/motion-table.md +++ b/static/include/services/apis/generated/motion-table.md @@ -1,15 +1,16 @@ | Method Name | Description | | ----------- | ----------- | -| [`Move`](/reference/apis/services/motion/#move) | The `Move` method is the primary way to move multiple components, or to move any object to any other location. | -| [`MoveOnMap`](/reference/apis/services/motion/#moveonmap) | Move a base component to a destination pose on a SLAM map. | -| [`MoveOnGlobe`](/reference/apis/services/motion/#moveonglobe) | Move a base component to a destination GPS point, represented in geographic notation _(latitude, longitude)_. | -| [`GetPose`](/reference/apis/services/motion/#getpose) | `GetPose` gets the location and orientation of a component within the frame system. | -| [`StopPlan`](/reference/apis/services/motion/#stopplan) | Stop a base component being moved by an in progress `MoveOnGlobe` or `MoveOnMap` call. | -| [`ListPlanStatuses`](/reference/apis/services/motion/#listplanstatuses) | Returns the statuses of plans created by `MoveOnGlobe` or `MoveOnMap` calls that meet at least one of the following conditions since the motion service initialized: - the plan's status is in progress - the plan's status changed state within the last 24 hours All repeated fields are in chronological order. | -| [`GetPlan`](/reference/apis/services/motion/#getplan) | By default, returns the plan history of the most recent `MoveOnGlobe` or `MoveOnMap` call to move a base component. | -| [`Reconfigure`](/reference/apis/services/motion/#reconfigure) | Reconfigure this resource. | -| [`FromRobot`](/reference/apis/services/motion/#fromrobot) | Get the resource from the provided machine. | -| [`DoCommand`](/reference/apis/services/motion/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetResourceName`](/reference/apis/services/motion/#getresourcename) | Get the `ResourceName` for this instance of the motion service. | -| [`Close`](/reference/apis/services/motion/#close) | Safely shut down the resource and prevent further use. | +| [`Move`](/dev/reference/apis/services/motion/#move) | The `Move` method is the primary way to move multiple components, or to move any object to any other location. | +| [`MoveOnMap`](/dev/reference/apis/services/motion/#moveonmap) | {{< alert title="Not supported by the builtin motion service" color="caution" >}} The builtin motion service no longer implements `MoveOnMap` and returns the error `MoveOnMap not supported by builtin` when called. | +| [`MoveOnGlobe`](/dev/reference/apis/services/motion/#moveonglobe) | Move a base component to a destination GPS point, represented in geographic notation _(latitude, longitude)_. | +| [`GetPose`](/dev/reference/apis/services/motion/#getpose) | `GetPose` gets the location and orientation of a component within the frame system. | +| [`StopPlan`](/dev/reference/apis/services/motion/#stopplan) | Stop a base component being moved by an in progress `MoveOnGlobe` or `MoveOnMap` call. | +| [`ListPlanStatuses`](/dev/reference/apis/services/motion/#listplanstatuses) | Returns the statuses of plans created by `MoveOnGlobe` or `MoveOnMap` calls that meet at least one of the following conditions since the motion service initialized: - the plan's status is in progress - the plan's status changed state within the last 24 hours All repeated fields are in chronological order. | +| [`GetPlan`](/dev/reference/apis/services/motion/#getplan) | By default, returns the plan history of the most recent `MoveOnGlobe` or `MoveOnMap` call to move a base component. | +| [`Reconfigure`](/dev/reference/apis/services/motion/#reconfigure) | Reconfigure this resource. | +| [`FromRobot`](/dev/reference/apis/services/motion/#fromrobot) | Get the resource from the provided machine. | +| [`DoCommand`](/dev/reference/apis/services/motion/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/dev/reference/apis/services/motion/#getstatus) | Get the current status of the motion service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/services/motion/#getresourcename) | Get the `ResourceName` for this instance of the motion service. | +| [`Close`](/dev/reference/apis/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 d9fbeb0403..5448f1f496 100644 --- a/static/include/services/apis/generated/motion.md +++ b/static/include/services/apis/generated/motion.md @@ -16,7 +16,7 @@ The motion service takes the volumes associated with all configured machine comp **Parameters:** - `component_name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The `ResourceName` of the piece of the robot that should arrive at the destination. Note that `move` moves the distal end of the component to the destination. For example, when moving a robotic arm, the piece that will arrive at the destination is the end effector attachment point, not the base of the arm. -- `destination` ([viam.proto.common.PoseInFrame](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.PoseInFrame)) (required): Describes where the `component_name` frame should be moved to. Can be any pose, from the perspective of any component whose location is configured as a [`frame`](/motion-planning/frame-system/). +- `destination` ([viam.proto.common.PoseInFrame](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.PoseInFrame)) (required): Describes where the `component_name` frame should be moved to. Can be any pose, from the perspective of any component whose location is configured as a [`frame`](/reference/services/frame-system/). - `world_state` ([viam.proto.common.WorldState](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.WorldState)) (optional): Data structure specifying information about the world around the machine. Used to augment the motion solving process. `world_state` includes obstacles and transforms: @@ -110,13 +110,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Parameters:** -- `destination` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): Destination to move to, which can a pose in the - reference frame of any frame in the robot's frame system. -- `componentName` (string) (required): Component on the robot to move to the specified - destination. -- `worldState` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional): Avoid obstacles by specifying their geometries in the - world state. Augment the frame system of the robot by specifying - additional transforms to add to it for the duration of the Move. +- `destination` ([PoseInFrame](https://ts.viam.dev/types/PoseInFrame.html)) (required): Destination to move to, which can a pose in the reference frame of any + frame in the robot's frame system. +- `componentName` (string) (required): Component on the robot to move to the specified destination. +- `worldState` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional): Avoid obstacles by specifying their geometries in the world state. Augment + the frame system of the robot by specifying additional transforms to add to it for the + duration of the Move. - `constraints` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional): Constrain the way the robot will move. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -208,7 +207,7 @@ The configuration you want to set across this machine for this motion service. T - `plan_deviation_m` [(float)](https://docs.python.org/3/library/functions.html#float): The distance in meters that the machine can deviate from the motion plan. By default this is set to 2.6 m which is an appropriate value for outdoor usage. When you use the `MoveOnMap()` method from the **CONTROL** tab, the default is overwritten to 0.5 m for testing. - `linear_m_per_sec` [(float)](https://docs.python.org/3/library/functions.html#float): Linear velocity this machine should target when moving. - `angular_degs_per_sec` [(float)](https://docs.python.org/3/library/functions.html#float): Angular velocity this machine should target when turning. -- `obstacles` ([Sequence[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/gen/common/v1/common_pb2/index.html#viam.gen.common.v1.common_pb2.Geometry)) (optional): Obstacles, specified in the SLAM frame coordinate system, to be considered when planning the motion of the component. +- `obstacles` ([Sequence[viam.proto.common.Geometry]](https://python.viam.dev/autoapi/viam/gen/app/data/v1/data_pb2/index.html#viam.gen.app.data.v1.data_pb2.Sequence)) (optional): Obstacles, specified in the SLAM frame coordinate system, to be considered when planning the motion of the component. - `extra` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Extra options to pass to the underlying RPC call. - `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. @@ -300,12 +299,10 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Parameters:** -- `destination` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): Specify a destination to, which can be any `Pose` with - respect to the SLAM map's origin. -- `componentName` (string) (required): Component on the robot to move to the specified - destination. -- `slamServiceName` (string) (required): Name of the `SLAM` service from which the SLAM map - is requested. +- `destination` ([Pose](https://ts.viam.dev/types/Pose.html)) (required): Specify a destination to, which can be any `Pose` with respect to the SLAM + map's origin. +- `componentName` (string) (required): Component on the robot to move to the specified destination. +- `slamServiceName` (string) (required): Name of the `SLAM` service from which the SLAM map is requested. - `motionConfig` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional) - `obstacles` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional): Optional obstacles to be considered for motion planning. - `extra` (None) (optional) @@ -335,11 +332,7 @@ const baseName = 'my_base'; const slamServiceName = 'my_slam_service'; // Move the base to Y=10 (location of 0,10,0) relative to map origin -const executionId = await motion.moveOnMap( - myPose, - baseName, - slamServiceName -); +const executionId = await motion.moveOnMap(myPose, baseName, slamServiceName); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MotionClient.html#moveonmap). @@ -392,7 +385,7 @@ Translation in obstacles is not supported by the [navigation service](/reference - `component_name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The `ResourceName` of the base to move. - `destination` ([viam.proto.common.GeoPoint](https://python.viam.dev/autoapi/viam/components/movement_sensor/index.html#viam.components.movement_sensor.GeoPoint)) (required): The location of the component's destination, represented in geographic notation as a [GeoPoint](https://python.viam.dev/autoapi/viam/components/movement_sensor/index.html#viam.components.movement_sensor.GeoPoint) _(lat, lng)_. - `movement_sensor_name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The `ResourceName` of the [movement sensor](/reference/components/movement-sensor/) that you want to use to check the machine's location. -- `obstacles` ([Sequence[viam.proto.common.GeoGeometry]](https://python.viam.dev/autoapi/viam/gen/common/v1/common_pb2/index.html#viam.gen.common.v1.common_pb2.GeoGeometry)) (optional): Obstacles to consider when planning the motion of the component, with each represented as a `GeoGeometry`.
  • Default: `None`
+- `obstacles` ([Sequence[viam.proto.common.GeoGeometry]](https://python.viam.dev/autoapi/viam/gen/app/data/v1/data_pb2/index.html#viam.gen.app.data.v1.data_pb2.Sequence)) (optional): Obstacles to consider when planning the motion of the component, with each represented as a `GeoGeometry`.
  • Default: `None`
- `heading` ([float](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)) (optional): The compass heading, in degrees, that the machine's movement sensor should report at the `destination` point.
  • Range: `[0-360)` `0`: North, `90`: East, `180`: South, `270`: West
  • Default: `None`
- `configuration` ([viam.proto.service.motion.MotionConfiguration](https://python.viam.dev/autoapi/viam/gen/service/motion/v1/motion_pb2/index.html#viam.gen.service.motion.v1.motion_pb2.MotionConfiguration)) (optional): The configuration you want to set across this machine for this motion service. This parameter and each of its fields are optional. @@ -403,7 +396,7 @@ The configuration you want to set across this machine for this motion service. T - `plan_deviation_m` [(float)](https://docs.python.org/3/library/functions.html#float): The distance in meters that the machine can deviate from the motion plan. - `linear_m_per_sec` [(float)](https://docs.python.org/3/library/functions.html#float): Linear velocity this machine should target when moving. - `angular_degs_per_sec` [(float)](https://docs.python.org/3/library/functions.html#float): Angular velocity this machine should target when turning. -- `bounding_regions` ([Sequence[viam.proto.common.GeoGeometry]](https://python.viam.dev/autoapi/viam/gen/common/v1/common_pb2/index.html#viam.gen.common.v1.common_pb2.GeoGeometry)) (optional): Set of obstacles which the robot must remain within while navigating. +- `bounding_regions` ([Sequence[viam.proto.common.GeoGeometry]](https://python.viam.dev/autoapi/viam/gen/app/data/v1/data_pb2/index.html#viam.gen.app.data.v1.data_pb2.Sequence)) (optional): Set of obstacles which the robot must remain within while navigating. - `extra` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Extra options to pass to the underlying RPC call. - `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. @@ -496,14 +489,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Parameters:** -- `destination` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (required): Destination for the component to move to, represented - as a `GeoPoint`. +- `destination` ([GeoPoint](https://ts.viam.dev/types/GeoPoint.html)) (required): Destination for the component to move to, represented as a `GeoPoint`. - `componentName` (string) (required): The name of the component to move. -- `movementSensorName` (string) (required): The name of the `Movement Sensor` used to check - the robot's location. +- `movementSensorName` (string) (required): The name of the `Movement Sensor` used to check the robot's + location. - `heading` (number) (optional): Compass heading, in degrees, to achieve at destination. -- `obstaclesList` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional): Obstacles to consider when planning the motion of - the component. +- `obstaclesList` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional): Obstacles to consider when planning the motion of the component. - `motionConfig` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional) - `boundingRegionsList` ([PlainMessage](https://ts.viam.dev/types/PlainMessage.html)) (optional) - `extra` (None) (optional) @@ -531,7 +522,7 @@ const movementSensorName = 'my_movement_sensor'; const globeExecutionId = await motion.moveOnGlobe( destination, baseName, - movementSensorName + movementSensorName, ); ``` @@ -542,7 +533,7 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ ### GetPose -`GetPose` gets the location and orientation of a component within the [frame system](/motion-planning/frame-system/). +`GetPose` gets the location and orientation of a component within the [frame system](/reference/services/frame-system/). The return type of this function is a `PoseInFrame` describing the pose of the specified component with respect to the specified destination frame. You can use the `supplemental_transforms` argument to augment the machine's existing frame system with supplemental frames. @@ -783,7 +774,7 @@ All repeated fields are in chronological order. **Returns:** -- ([Sequence[viam.proto.service.motion.PlanStatusWithID]](https://python.viam.dev/autoapi/viam/proto/service/motion/index.html#viam.proto.service.motion.PlanStatusWithID)): : List of last known statuses with the +- ([Sequence[viam.proto.service.motion.PlanStatusWithID]](https://python.viam.dev/autoapi/viam/gen/app/data/v1/data_pb2/index.html#viam.gen.app.data.v1.data_pb2.Sequence)): : List of last known statuses with the associated IDs of all plans within the TTL ordered by timestamp in ascending order. **Example:** @@ -827,8 +818,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Parameters:** -- `onlyActivePlans` (boolean) (optional): If true, the response will only return plans which - are executing. +- `onlyActivePlans` (boolean) (optional): If true, the response will only return plans which are executing. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) @@ -1081,8 +1071,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -1100,9 +1090,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MotionClient.html#docommand). @@ -1110,6 +1098,45 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the motion service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the service. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await service.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/MotionClient.html#getstatus). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this instance of the motion service. diff --git a/static/include/services/apis/generated/slam-table.md b/static/include/services/apis/generated/slam-table.md index 45ac702182..491568d031 100644 --- a/static/include/services/apis/generated/slam-table.md +++ b/static/include/services/apis/generated/slam-table.md @@ -1,13 +1,14 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetPosition`](/reference/apis/services/slam/#getposition) | Get the current position of the component the SLAM service is configured to source point cloud data from in the SLAM map as a `Pose`. | -| [`GetPointCloudMap`](/reference/apis/services/slam/#getpointcloudmap) | Get the point cloud map. | -| [`GetInternalState`](/reference/apis/services/slam/#getinternalstate) | Get the internal state of the SLAM algorithm required to continue mapping/localization. | -| [`GetProperties`](/reference/apis/services/slam/#getproperties) | Get information about the current SLAM session. | -| [`InternalStateFull`](/reference/apis/services/slam/#internalstatefull) | `InternalStateFull` concatenates the streaming responses from `InternalState` into the internal serialized state of the SLAM algorithm. | -| [`PointCloudMapFull`](/reference/apis/services/slam/#pointcloudmapfull) | `PointCloudMapFull` concatenates the streaming responses from `PointCloudMap` into a full point cloud. | -| [`Reconfigure`](/reference/apis/services/slam/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/services/slam/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetResourceName`](/reference/apis/services/slam/#getresourcename) | Get the `ResourceName` for this instance of the SLAM service. | -| [`Close`](/reference/apis/services/slam/#close) | Safely shut down the resource and prevent further use. | +| [`GetPosition`](/dev/reference/apis/services/slam/#getposition) | Get the current position of the component the SLAM service is configured to source point cloud data from in the SLAM map as a `Pose`. | +| [`GetPointCloudMap`](/dev/reference/apis/services/slam/#getpointcloudmap) | Get the point cloud map. | +| [`GetInternalState`](/dev/reference/apis/services/slam/#getinternalstate) | Get the internal state of the SLAM algorithm required to continue mapping/localization. | +| [`GetProperties`](/dev/reference/apis/services/slam/#getproperties) | Get information about the current SLAM session. | +| [`InternalStateFull`](/dev/reference/apis/services/slam/#internalstatefull) | `InternalStateFull` concatenates the streaming responses from `InternalState` into the internal serialized state of the SLAM algorithm. | +| [`PointCloudMapFull`](/dev/reference/apis/services/slam/#pointcloudmapfull) | `PointCloudMapFull` concatenates the streaming responses from `PointCloudMap` into a full point cloud. | +| [`Reconfigure`](/dev/reference/apis/services/slam/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/services/slam/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/dev/reference/apis/services/slam/#getstatus) | Get the current status of the SLAM service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/services/slam/#getresourcename) | Get the `ResourceName` for this instance of the SLAM service. | +| [`Close`](/dev/reference/apis/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 827c64431d..b19a0766e2 100644 --- a/static/include/services/apis/generated/slam.md +++ b/static/include/services/apis/generated/slam.md @@ -124,7 +124,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise) +- (Promise>) **Example:** @@ -191,7 +191,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise) +- (Promise>) **Example:** @@ -418,8 +418,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -437,9 +437,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/SlamClient.html#docommand). @@ -447,6 +445,45 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the SLAM service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the service. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await service.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/SlamClient.html#getstatus). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this instance of the SLAM service. diff --git a/static/include/services/apis/generated/vision-table.md b/static/include/services/apis/generated/vision-table.md index 9a1426c75e..4c644bcd84 100644 --- a/static/include/services/apis/generated/vision-table.md +++ b/static/include/services/apis/generated/vision-table.md @@ -1,14 +1,15 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetDetectionsFromCamera`](/reference/apis/services/vision/#getdetectionsfromcamera) | Get a list of detections from the next image from a specified camera using a configured detector. | -| [`GetDetections`](/reference/apis/services/vision/#getdetections) | Get a list of detections from a given image using a configured detector. | -| [`GetClassificationsFromCamera`](/reference/apis/services/vision/#getclassificationsfromcamera) | Get a list of classifications from the next image from a specified camera using a configured classifier. | -| [`GetClassifications`](/reference/apis/services/vision/#getclassifications) | Get a list of classifications from a given image using a configured classifier. | -| [`GetObjectPointClouds`](/reference/apis/services/vision/#getobjectpointclouds) | Get a list of 3D point cloud objects and associated metadata in the latest picture from a 3D camera (using a specified segmenter). | -| [`CaptureAllFromCamera`](/reference/apis/services/vision/#captureallfromcamera) | Get the next image, detections, classifications, and objects all together, given a camera name. | -| [`Reconfigure`](/reference/apis/services/vision/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/reference/apis/services/vision/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetResourceName`](/reference/apis/services/vision/#getresourcename) | Get the `ResourceName` for this instance of the vision service. | -| [`GetProperties`](/reference/apis/services/vision/#getproperties) | Fetch information about which vision methods a given vision service supports. | -| [`Close`](/reference/apis/services/vision/#close) | Safely shut down the resource and prevent further use. | +| [`GetDetectionsFromCamera`](/dev/reference/apis/services/vision/#getdetectionsfromcamera) | Get a list of detections from the next image from a specified camera using a configured detector. | +| [`GetDetections`](/dev/reference/apis/services/vision/#getdetections) | Get a list of detections from a given image using a configured detector. | +| [`GetClassificationsFromCamera`](/dev/reference/apis/services/vision/#getclassificationsfromcamera) | Get a list of classifications from the next image from a specified camera using a configured classifier. | +| [`GetClassifications`](/dev/reference/apis/services/vision/#getclassifications) | Get a list of classifications from a given image using a configured classifier. | +| [`GetObjectPointClouds`](/dev/reference/apis/services/vision/#getobjectpointclouds) | Get a list of 3D point cloud objects and associated metadata in the latest picture from a 3D camera (using a specified segmenter). | +| [`CaptureAllFromCamera`](/dev/reference/apis/services/vision/#captureallfromcamera) | Get the next image, detections, classifications, and objects all together, given a camera name. | +| [`Reconfigure`](/dev/reference/apis/services/vision/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/dev/reference/apis/services/vision/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/dev/reference/apis/services/vision/#getstatus) | Get the current status of the vision service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/services/vision/#getresourcename) | Get the `ResourceName` for this instance of the vision service. | +| [`GetProperties`](/dev/reference/apis/services/vision/#getproperties) | Fetch information about which vision methods a given vision service supports. | +| [`Close`](/dev/reference/apis/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 101ddab1f9..4d9550c429 100644 --- a/static/include/services/apis/generated/vision.md +++ b/static/include/services/apis/generated/vision.md @@ -13,9 +13,9 @@ Get a list of detections from the next image from a specified camera using a con **Returns:** -- ([List[viam.proto.service.vision.Detection]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Detection)): : A list of 2D bounding boxes, their labels, and the - confidence score of the labels, around the found objects in the next 2D image - from the given camera, with the given detector applied to it. +- ([list[viam.proto.service.vision.Detection]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Detection)): : A list of 2D bounding boxes, their labels, and the + confidence score of the labels, around the found objects in the next 2D image + from the given camera, with the given detector applied to it. **Raises:** @@ -78,13 +78,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Detection](https://ts.viam.dev/classes/visionApi.Detection.html)[]>): \* The list of Detections. +- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Detection](https://ts.viam.dev/classes/visionApi.Detection.html)[]>): * The list of Detections. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const vision = new VIAM.VisionClient(machine, "my_vision"); -const detections = await vision.getDetectionsFromCamera("my_camera"); +const vision = new VIAM.VisionClient(machine, 'my_vision'); +const detections = await vision.getDetectionsFromCamera('my_camera'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/VisionClient.html#getdetectionsfromcamera). @@ -128,9 +128,9 @@ Get a list of detections from a given image using a configured [detector](/refer **Returns:** -- ([List[viam.proto.service.vision.Detection]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Detection)): : A list of 2D bounding boxes, their labels, and the - confidence score of the labels, around the found objects in the next 2D image - from the given camera, with the given detector applied to it. +- ([list[viam.proto.service.vision.Detection]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Detection)): : A list of 2D bounding boxes, their labels, and the + confidence score of the labels, around the found objects in the next 2D image + from the given camera, with the given detector applied to it. **Raises:** @@ -158,7 +158,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Parameters:** - `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. -- `img` [(\*camera.NamedImage)](https://pkg.go.dev/go.viam.com/rdk/components/camera#NamedImage): The image in which to look for detections. +- `img` [(*camera.NamedImage)](https://pkg.go.dev/go.viam.com/rdk/components/camera#NamedImage): The image in which to look for detections. - `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call. **Returns:** @@ -169,17 +169,15 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```go {class="line-numbers linkable-line-numbers"} + // add "go.viam.com/rdk/utils" to imports to use this code snippet + myCam, err := camera.FromProvider(machine, "my_camera") if err != nil { logger.Error(err) return } - // Capture an image from the camera - images, _, err := myCam.Images(context.Background(), nil, nil) - if err != nil { - logger.Error(err) - return - } + // Get an image from the camera decoded as an image.Image + img, err = camera.DecodeImageFromCamera(context.Background(), utils.MimeTypeJPEG, nil, myCam) myDetectorService, err := vision.FromProvider(machine, "my_detector") if err != nil { @@ -187,7 +185,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ return } // Get the detections from the image - detections, err := myDetectorService.Detections(context.Background(), &images[0], nil) + detections, err := myDetectorService.Detections(context.Background(), img, nil) if err != nil { logger.Fatalf("Could not get detections: %v", err) } @@ -212,13 +210,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Detection](https://ts.viam.dev/classes/visionApi.Detection.html)[]>): \* The list of Detections. +- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Detection](https://ts.viam.dev/classes/visionApi.Detection.html)[]>): * The list of Detections. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const camera = new VIAM.CameraClient(machine, "my_camera"); -const vision = new VIAM.VisionClient(machine, "my_vision"); +const camera = new VIAM.CameraClient(machine, 'my_camera'); +const vision = new VIAM.VisionClient(machine, 'my_vision'); const { images } = await camera.getImages(); const detections = await vision.getDetections( @@ -272,7 +270,7 @@ Get a list of classifications from the next image from a specified camera using **Returns:** -- ([List[viam.proto.service.vision.Classification]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Classification)): : The list of Classifications. +- ([list[viam.proto.service.vision.Classification]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Classification)): : The list of Classifications. **Example:** @@ -333,16 +331,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Classification](https://ts.viam.dev/classes/visionApi.Classification.html)[]>): \* The list of Classifications. +- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Classification](https://ts.viam.dev/classes/visionApi.Classification.html)[]>): * The list of Classifications. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const vision = new VIAM.VisionClient(machine, "my_vision"); -const classifications = await vision.getClassificationsFromCamera( - "my_camera", - 10, -); +const vision = new VIAM.VisionClient(machine, 'my_vision'); +const classifications = await vision.getClassificationsFromCamera('my_camera', 10); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/VisionClient.html#getclassificationsfromcamera). @@ -388,7 +383,7 @@ Get a list of classifications from a given image using a configured [classifier] **Returns:** -- ([List[viam.proto.service.vision.Classification]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Classification)): : The list of Classifications. +- ([list[viam.proto.service.vision.Classification]](https://python.viam.dev/autoapi/viam/proto/service/vision/index.html#viam.proto.service.vision.Classification)): : The list of Classifications. **Example:** @@ -412,7 +407,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Parameters:** - `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries. -- `img` [(\*camera.NamedImage)](https://pkg.go.dev/go.viam.com/rdk/components/camera#NamedImage): The image in which to look for classifications. +- `img` [(*camera.NamedImage)](https://pkg.go.dev/go.viam.com/rdk/components/camera#NamedImage): The image in which to look for classifications. - `n` [(int)](https://pkg.go.dev/builtin#int): The number of classifications to return. For example, if you specify `3` you will get the top three classifications with the greatest confidence scores. - `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call. @@ -424,17 +419,15 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```go {class="line-numbers linkable-line-numbers"} + // add "go.viam.com/rdk/utils" to imports to use this code snippet + myCam, err := camera.FromProvider(machine, "my_camera") if err != nil { logger.Error(err) return } - // Capture an image from the camera - images, _, err := myCam.Images(context.Background(), nil, nil) - if err != nil { - logger.Error(err) - return - } + // Get an image from the camera decoded as an image.Image + img, err = camera.DecodeImageFromCamera(context.Background(), utils.MimeTypeJPEG, nil, myCam) myClassifierService, err := vision.FromProvider(machine, "my_classifier") if err != nil { @@ -442,7 +435,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ return } // Get the 2 classifications with the highest confidence scores from the image - classifications, err := myClassifierService.Classifications(context.Background(), &images[0], 2, nil) + classifications, err := myClassifierService.Classifications(context.Background(), img, 2, nil) if err != nil { logger.Fatalf("Could not get classifications: %v", err) } @@ -468,13 +461,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Classification](https://ts.viam.dev/classes/visionApi.Classification.html)[]>): \* The list of Classifications. +- (Promise<[visionApi](https://ts.viam.dev/modules/visionApi.html).[Classification](https://ts.viam.dev/classes/visionApi.Classification.html)[]>): * The list of Classifications. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const camera = new VIAM.CameraClient(machine, "my_camera"); -const vision = new VIAM.VisionClient(machine, "my_vision"); +const camera = new VIAM.CameraClient(machine, 'my_camera'); +const vision = new VIAM.VisionClient(machine, 'my_vision'); const { images } = await camera.getImages(); const classifications = await vision.getClassifications( @@ -529,7 +522,7 @@ Get a list of 3D point cloud objects and associated metadata in the latest pictu **Returns:** -- ([List[viam.proto.common.PointCloudObject]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.PointCloudObject)): : The pointcloud objects with metadata. +- ([list[viam.proto.common.PointCloudObject]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.PointCloudObject)): : The pointcloud objects with metadata. **Example:** @@ -560,7 +553,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Returns:** -- [([]\*viz.Object)](https://pkg.go.dev/go.viam.com/rdk/vision#Object): A list of point clouds and associated metadata like the center coordinates of each point cloud. +- [([]*viz.Object)](https://pkg.go.dev/go.viam.com/rdk/vision#Object): A list of point clouds and associated metadata like the center coordinates of each point cloud. - [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. **Example:** @@ -594,13 +587,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise<[commonApi](https://ts.viam.dev/modules/commonApi.html).[PointCloudObject](https://ts.viam.dev/classes/commonApi.PointCloudObject.html)[]>): \* The list of PointCloudObjects. +- (Promise<[commonApi](https://ts.viam.dev/modules/commonApi.html).[PointCloudObject](https://ts.viam.dev/classes/commonApi.PointCloudObject.html)[]>): * The list of PointCloudObjects. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const vision = new VIAM.VisionClient(machine, "my_vision"); -const pointCloudObjects = await vision.getObjectPointClouds("my_camera"); +const vision = new VIAM.VisionClient(machine, 'my_vision'); +const pointCloudObjects = await vision.getObjectPointClouds('my_camera'); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/VisionClient.html#getobjectpointclouds). @@ -649,9 +642,9 @@ Used for visualization. **Returns:** -- ([viam.services.vision.vision.CaptureAllResult](https://python.viam.dev/autoapi/viam/services/vision/vision/index.html#viam.services.vision.vision.CaptureAllResult)): : A class that stores all potential returns from the vision service. - It can return the image from the camera along with its associated detections, classifications, - and objects, as well as any extra info the model may provide. +- ([viam.services.vision.vision.CaptureAllResult](https://python.viam.dev/autoapi/viam/services/vision/vision/index.html#viam.services.vision.vision.CaptureAllResult)): : A class that stores all potential returns from the vision service. + It can return the image from the camera along with its associated detections, classifications, + and objects, as well as any extra info the model may provide. **Example:** @@ -711,22 +704,21 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Parameters:** -- `cameraName` (string) (required): The name of the camera to use for classification, - detection, and segmentation. -- `__namedParameters` (CaptureAllOptions) (required) +- `cameraName` (string) (required): The name of the camera to use for classification, detection, and + segmentation. +- `opts` (CaptureAllOptions) (required): The fields desired in the response. - `extra` (None) (optional) - `callOptions` (CallOptions) (optional) **Returns:** -- (Promise< { classifications: [visionApi](https://ts.viam.dev/modules/visionApi.html).[Classification](https://ts.viam.dev/classes/visionApi.Classification.html)[]; detections: [visionApi](https://ts.viam.dev/modules/visionApi.html).[Detection](https://ts.viam.dev/classes/visionApi.Detection.html)[]; extra: undefined | [Struct](https://ts.viam.dev/classes/Struct.html); image: undefined | [Image](https://ts.viam.dev/classes/cameraApi.Image.html); objectPointClouds: [commonApi](https://ts.viam.dev/modules/commonApi.html).[PointCloudObject](https://ts.viam.dev/classes/commonApi.PointCloudObject.html)[]; }, >): \* The requested image, classifications, detections, and 3d point - cloud objects. +- (Promise< { classifications: [visionApi](https://ts.viam.dev/modules/visionApi.html).[Classification](https://ts.viam.dev/classes/visionApi.Classification.html)[]; detections: [visionApi](https://ts.viam.dev/modules/visionApi.html).[Detection](https://ts.viam.dev/classes/visionApi.Detection.html)[]; extra: [Struct](https://ts.viam.dev/classes/Struct.html) | undefined; image: [Image](https://ts.viam.dev/classes/cameraApi.Image.html) | undefined; objectPointClouds: [commonApi](https://ts.viam.dev/modules/commonApi.html).[PointCloudObject](https://ts.viam.dev/classes/commonApi.PointCloudObject.html)[]; }, >): * The requested image, classifications, detections, and 3d point cloud objects. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const vision = new VIAM.VisionClient(machine, "my_vision"); -const captureAll = await vision.captureAllFromCamera("my_camera", { +const vision = new VIAM.VisionClient(machine, 'my_vision'); +const captureAll = await vision.captureAllFromCamera('my_camera', { returnImage: true, returnClassifications: true, returnDetections: true, @@ -779,7 +771,7 @@ If you are implementing your own vision service and want to add features that ha **Returns:** -- (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): : Result of the executed command. +- (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): : Result of the executed command. **Example:** @@ -825,8 +817,8 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -838,15 +830,13 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r ```ts {class="line-numbers linkable-line-numbers"} // Plain object (recommended) const result = await resource.doCommand({ - myCommand: { key: "value" }, + myCommand: { key: 'value' }, }); // Struct (still supported) -import { Struct } from "@viamrobotics/sdk"; +import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: "value" } }), -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/VisionClient.html#docommand). @@ -875,6 +865,58 @@ For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_s {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the vision service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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:** + +- (collections.abc.Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), viam.utils.ValueTypes]): : The status of the service. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await service.get_status() +``` + +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_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/VisionClient.html#getstatus). + +{{% /tab %}} +{{% tab name="Flutter" %}} + +**Parameters:** + +- None. + +**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>\> + +For more information, see the [Flutter SDK Docs](https://flutter.viam.dev/viam_sdk/VisionClient/getStatus.html). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the `ResourceName` for this instance of the vision service. @@ -888,7 +930,7 @@ Get the `ResourceName` for this instance of the vision service. **Returns:** -- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. +- ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)): : The ResourceName of this Resource. **Example:** @@ -933,7 +975,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Example:** ```ts {class="line-numbers linkable-line-numbers"} -vision.name; +vision.name ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/VisionClient.html#name). @@ -974,7 +1016,7 @@ Fetch information about which vision methods a given vision service supports. **Returns:** -- ([Vision.Properties](https://python.viam.dev/autoapi/viam/services/vision/vision/index.html#viam.services.vision.vision.Vision.Properties)): : The properties of the vision service. +- ([Vision.Properties](https://python.viam.dev/autoapi/viam/services/vision/vision/index.html#viam.services.vision.vision.Vision.Properties)): : The properties of the vision service. **Example:** @@ -997,7 +1039,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Returns:** -- [(\*Properties)](https://pkg.go.dev/go.viam.com/rdk/services/vision#Properties) +- [(*Properties)](https://pkg.go.dev/go.viam.com/rdk/services/vision#Properties) - [(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/vision#Service). @@ -1012,12 +1054,12 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise< { classificationsSupported: boolean; detectionsSupported: boolean; objectPointCloudsSupported: boolean; }, >): \* The properties of the vision service. +- (Promise< { classificationsSupported: boolean; detectionsSupported: boolean; objectPointCloudsSupported: boolean; }, >): * The properties of the vision service. **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const vision = new VIAM.VisionClient(machine, "my_vision"); +const vision = new VIAM.VisionClient(machine, 'my_vision'); const properties = await vision.getProperties(); ``` diff --git a/static/include/services/apis/generated/world_state_store-table.md b/static/include/services/apis/generated/world_state_store-table.md index 06957fb522..06234858ef 100644 --- a/static/include/services/apis/generated/world_state_store-table.md +++ b/static/include/services/apis/generated/world_state_store-table.md @@ -1,9 +1,10 @@ | Method Name | Description | | ----------- | ----------- | -| [`ListUUIDs`](/reference/apis/services/world-state-store/#listuuids) | List all world state transform UUIDs. | -| [`GetTransform`](/reference/apis/services/world-state-store/#gettransform) | Get a world state transform by UUID. | -| [`StreamTransformChanges`](/reference/apis/services/world-state-store/#streamtransformchanges) | Stream changes to world state transforms. | -| [`DoCommand`](/reference/apis/services/world-state-store/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetResourceName`](/reference/apis/services/world-state-store/#getresourcename) | Get the ResourceName for this Resource with the given name. | -| [`Close`](/reference/apis/services/world-state-store/#close) | Safely shut down the resource and prevent further use. | +| [`ListUUIDs`](/dev/reference/apis/services/world-state-store/#listuuids) | List all world state transform UUIDs. | +| [`GetTransform`](/dev/reference/apis/services/world-state-store/#gettransform) | Get a world state transform by UUID. | +| [`StreamTransformChanges`](/dev/reference/apis/services/world-state-store/#streamtransformchanges) | Stream changes to world state transforms. | +| [`DoCommand`](/dev/reference/apis/services/world-state-store/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/dev/reference/apis/services/world-state-store/#getstatus) | Get the current status of the world state store service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/dev/reference/apis/services/world-state-store/#getresourcename) | Get the ResourceName for this Resource with the given name. | +| [`Close`](/dev/reference/apis/services/world-state-store/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/world_state_store.md b/static/include/services/apis/generated/world_state_store.md index 480e23581f..8e4a1c2563 100644 --- a/static/include/services/apis/generated/world_state_store.md +++ b/static/include/services/apis/generated/world_state_store.md @@ -39,10 +39,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const worldStateStore = new VIAM.WorldStateStoreClient( - machine, - 'builtin' -); +const worldStateStore = new VIAM.WorldStateStoreClient(machine, 'builtin'); // Get all transform UUIDs const uuids = await worldStateStore.listUUIDs(); @@ -96,10 +93,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const worldStateStore = new VIAM.WorldStateStoreClient( - machine, - 'builtin' -); +const worldStateStore = new VIAM.WorldStateStoreClient(machine, 'builtin'); // Get a specific transform by UUID const transform = await worldStateStore.getTransform(uuid); @@ -152,19 +146,12 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```ts {class="line-numbers linkable-line-numbers"} -const worldStateStore = new VIAM.WorldStateStoreClient( - machine, - 'builtin' -); +const worldStateStore = new VIAM.WorldStateStoreClient(machine, 'builtin'); // Stream transform changes const stream = worldStateStore.streamTransformChanges(); for await (const change of stream) { - console.log( - 'Transform change:', - change.changeType, - change.transform - ); + console.log('Transform change:', change.changeType, change.transform); } ``` @@ -212,8 +199,8 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Parameters:** -- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or - a plain object, which will be converted automatically. +- `command` ([Struct](https://ts.viam.dev/classes/Struct.html)) (required): The command to execute. Accepts either a [Struct](https://ts.viam.dev/classes/Struct.html) or a plain object, + which will be converted automatically. - `callOptions` (CallOptions) (optional) **Returns:** @@ -231,9 +218,7 @@ const result = await resource.doCommand({ // Struct (still supported) import { Struct } from '@viamrobotics/sdk'; -const result = await resource.doCommand( - Struct.fromJson({ myCommand: { key: 'value' } }) -); +const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } })); ``` For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/WorldStateStoreClient.html#docommand). @@ -241,6 +226,45 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ {{% /tab %}} {{< /tabs >}} +### GetStatus + +Get the current status of the world state store service as a map of key-value pairs describing its state. + +{{< tabs >}} +{{% tab name="Python" %}} + +**Parameters:** + +- `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]): : The status of the service. + +**Example:** + +```python {class="line-numbers linkable-line-numbers"} +status = await service.get_status() +``` + +For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/worldstatestore/index.html#viam.services.worldstatestore.WorldStateStoreClient.get_status). + +{{% /tab %}} +{{% tab name="TypeScript" %}} + +**Parameters:** + +- `callOptions` (CallOptions) (optional) + +**Returns:** + +- (Promise<[JsonValue](https://ts.viam.dev/types/JsonValue.html)>) + +For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/WorldStateStoreClient.html#getstatus). + +{{% /tab %}} +{{< /tabs >}} + ### GetResourceName Get the ResourceName for this Resource with the given name. diff --git a/static/include/services/apis/overrides/protos/data_manager.GetStatus.md b/static/include/services/apis/overrides/protos/data_manager.GetStatus.md new file mode 100644 index 0000000000..1b12bb7049 --- /dev/null +++ b/static/include/services/apis/overrides/protos/data_manager.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the data management service as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/overrides/protos/discovery.GetStatus.md b/static/include/services/apis/overrides/protos/discovery.GetStatus.md new file mode 100644 index 0000000000..7d31ece0d6 --- /dev/null +++ b/static/include/services/apis/overrides/protos/discovery.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the discovery service as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/overrides/protos/generic_service.GetStatus.md b/static/include/services/apis/overrides/protos/generic_service.GetStatus.md new file mode 100644 index 0000000000..dc373bd10a --- /dev/null +++ b/static/include/services/apis/overrides/protos/generic_service.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the generic service as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/overrides/protos/mlmodel.GetStatus.md b/static/include/services/apis/overrides/protos/mlmodel.GetStatus.md new file mode 100644 index 0000000000..1baac66f3b --- /dev/null +++ b/static/include/services/apis/overrides/protos/mlmodel.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the ML model service as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/overrides/protos/motion.GetStatus.md b/static/include/services/apis/overrides/protos/motion.GetStatus.md new file mode 100644 index 0000000000..eaf23bf116 --- /dev/null +++ b/static/include/services/apis/overrides/protos/motion.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the motion service as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/overrides/protos/slam.GetStatus.md b/static/include/services/apis/overrides/protos/slam.GetStatus.md new file mode 100644 index 0000000000..e88954725b --- /dev/null +++ b/static/include/services/apis/overrides/protos/slam.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the SLAM service as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/overrides/protos/vision.GetStatus.md b/static/include/services/apis/overrides/protos/vision.GetStatus.md new file mode 100644 index 0000000000..a18dcfeccf --- /dev/null +++ b/static/include/services/apis/overrides/protos/vision.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the vision service as a map of key-value pairs describing its state. diff --git a/static/include/services/apis/overrides/protos/world_state_store.GetStatus.md b/static/include/services/apis/overrides/protos/world_state_store.GetStatus.md new file mode 100644 index 0000000000..25117805aa --- /dev/null +++ b/static/include/services/apis/overrides/protos/world_state_store.GetStatus.md @@ -0,0 +1 @@ +Get the current status of the world state store service as a map of key-value pairs describing its state. From 125aa199a37009b5d9591ffad5c4591ef4abd4b1 Mon Sep 17 00:00:00 2001 From: Brandon Shrewsbury Date: Mon, 13 Jul 2026 10:10:04 -0600 Subject: [PATCH 2/4] Strip angle-bracket shortcodes from table descriptions The first-sentence extractor for method-table descriptions only stripped percent-style ({{% alert %}}) shortcode blocks. The motion.MoveOnMap.md override starts with an angle-bracket ({{< alert >}}) block, so regenerating leaked an unclosed shortcode opener into motion-table.md and broke the Hugo build. Strip angle-bracket blocks the same way, non-greedily so a description between two blocks survives. --- .github/workflows/update_sdk_methods.py | 3 +++ static/include/services/apis/generated/motion-table.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/update_sdk_methods.py b/.github/workflows/update_sdk_methods.py index d7a3fdd05d..45175a8068 100755 --- a/.github/workflows/update_sdk_methods.py +++ b/.github/workflows/update_sdk_methods.py @@ -965,6 +965,9 @@ def write_markdown(type, names, methods): with open(proto_override_file, 'r') as f: file_contents = f.read().strip() file_contents = regex.sub(r'\{\{\%.*\%\}\}.*\{\{\% \/[a-b].* \%\}\}', '', file_contents, flags=regex.DOTALL) + ## Same, for angle-bracket shortcodes ({{< alert >}}...{{< /alert >}}), which + ## otherwise leak an unclosed shortcode opener into the table description: + file_contents = regex.sub(r'\{\{<.*?>\}\}.*?\{\{< \/[a-b].*? >\}\}', '', file_contents, flags=regex.DOTALL) search_result = file_contents.split('.\n', 1)[0].strip().replace("\n", " ") ## If the proto description contains any MD links, strip them out: diff --git a/static/include/services/apis/generated/motion-table.md b/static/include/services/apis/generated/motion-table.md index bc449c2900..e0f7f50388 100644 --- a/static/include/services/apis/generated/motion-table.md +++ b/static/include/services/apis/generated/motion-table.md @@ -2,7 +2,7 @@ | Method Name | Description | | ----------- | ----------- | | [`Move`](/dev/reference/apis/services/motion/#move) | The `Move` method is the primary way to move multiple components, or to move any object to any other location. | -| [`MoveOnMap`](/dev/reference/apis/services/motion/#moveonmap) | {{< alert title="Not supported by the builtin motion service" color="caution" >}} The builtin motion service no longer implements `MoveOnMap` and returns the error `MoveOnMap not supported by builtin` when called. | +| [`MoveOnMap`](/dev/reference/apis/services/motion/#moveonmap) | Move a base component to a destination pose on a SLAM map. | | [`MoveOnGlobe`](/dev/reference/apis/services/motion/#moveonglobe) | Move a base component to a destination GPS point, represented in geographic notation _(latitude, longitude)_. | | [`GetPose`](/dev/reference/apis/services/motion/#getpose) | `GetPose` gets the location and orientation of a component within the frame system. | | [`StopPlan`](/dev/reference/apis/services/motion/#stopplan) | Stop a base component being moved by an in progress `MoveOnGlobe` or `MoveOnMap` call. | From e19693c8ed11a9a80c23f11cf02e3aed12599f83 Mon Sep 17 00:00:00 2001 From: Brandon Shrewsbury Date: Mon, 13 Jul 2026 10:15:22 -0600 Subject: [PATCH 3/4] Point generated anchor links at /reference/apis instead of /dev/reference/apis The docs restructure moved the API reference pages from /dev/reference/apis/* to /reference/apis/*, leaving /dev/reference as meta-refresh alias stubs. The generator still hardcoded the old prefix, so the previous regeneration pointed every method-table link at a stub page and htmltest failed. Update the anchor prefixes and regenerate the files in this PR's scope. --- .github/workflows/update_sdk_methods.py | 30 +++++++------- .../components/apis/generated/arm-table.md | 30 +++++++------- .../apis/generated/audio_in-table.md | 16 ++++---- .../apis/generated/audio_out-table.md | 18 ++++----- .../components/apis/generated/base-table.md | 26 ++++++------ .../components/apis/generated/board-table.md | 40 +++++++++---------- .../components/apis/generated/button-table.md | 12 +++--- .../components/apis/generated/camera-table.md | 16 ++++---- .../apis/generated/encoder-table.md | 18 ++++----- .../components/apis/generated/gantry-table.md | 26 ++++++------ .../apis/generated/generic_component-table.md | 10 ++--- .../apis/generated/gripper-table.md | 28 ++++++------- .../apis/generated/input_controller-table.md | 20 +++++----- .../components/apis/generated/motor-table.md | 32 +++++++-------- .../apis/generated/power_sensor-table.md | 18 ++++----- .../components/apis/generated/sensor-table.md | 14 +++---- .../components/apis/generated/servo-table.md | 20 +++++----- .../components/apis/generated/switch-table.md | 14 +++---- .../apis/generated/data_manager-table.md | 14 +++---- .../apis/generated/discovery-table.md | 10 ++--- .../apis/generated/generic_service-table.md | 8 ++-- .../services/apis/generated/mlmodel-table.md | 14 +++---- .../services/apis/generated/motion-table.md | 26 ++++++------ .../services/apis/generated/slam-table.md | 22 +++++----- .../services/apis/generated/vision-table.md | 24 +++++------ .../apis/generated/world_state_store-table.md | 14 +++---- 26 files changed, 260 insertions(+), 260 deletions(-) diff --git a/.github/workflows/update_sdk_methods.py b/.github/workflows/update_sdk_methods.py index 45175a8068..fb0ce26a7c 100755 --- a/.github/workflows/update_sdk_methods.py +++ b/.github/workflows/update_sdk_methods.py @@ -354,7 +354,7 @@ "organization settings page": "/manage/reference/organize/", "image tags": "/data-ai/train/create-dataset/#label-your-images", "API key": "/fleet/cli/#authenticate", - "board model": "/dev/reference/apis/components/board/" + "board model": "/reference/apis/components/board/" } ## Map sdk language to specific code fence formatting syntax for that language: @@ -459,7 +459,7 @@ def get_proto_apis(): ## Link matching text, used in write_markdown(): ## NOTE: Currently does not support formatting for link titles -## (EXAMPLE: bolded DATA tab here: https://docs.viam.com/dev/reference/apis/data-client/#binarydatabyfilter) +## (EXAMPLE: bolded DATA tab here: https://docs.viam.com/reference/apis/data-client/#binarydatabyfilter) def link_description(format_type, full_description, link_text, link_url): ## Supports 'md' link styling or 'html' link styling. @@ -930,31 +930,31 @@ def write_markdown(type, names, methods): if type == 'component': ## Replace underscores, and convert generic_component to just generic: resource_adjusted = resource.replace('generic_component', 'generic').replace('_','-') - proto_anchor_link = '/dev/reference/apis/components/' + resource_adjusted + '/#' + proto_link + proto_anchor_link = '/reference/apis/components/' + resource_adjusted + '/#' + proto_link elif type == 'service' and resource in ['base_remote_control', 'motion', 'slam', 'vision']: - proto_anchor_link = '/dev/reference/apis/services/' + resource.replace('base_remote_control', 'base-rc') + '/#' + proto_link + proto_anchor_link = '/reference/apis/services/' + resource.replace('base_remote_control', 'base-rc') + '/#' + proto_link elif type == 'service' and resource == 'data_manager': - proto_anchor_link = '/dev/reference/apis/services/data/#' + proto_link + proto_anchor_link = '/reference/apis/services/data/#' + proto_link elif type == 'service' and resource == 'discovery': - proto_anchor_link = '/dev/reference/apis/services/discovery/#' + proto_link + proto_anchor_link = '/reference/apis/services/discovery/#' + proto_link elif type == 'service' and resource == 'generic_service': - proto_anchor_link = '/dev/reference/apis/services/generic/#' + proto_link + proto_anchor_link = '/reference/apis/services/generic/#' + proto_link elif type == 'service' and resource == 'audio_in': - proto_anchor_link = '/dev/reference/apis/services/audio-in/#' + proto_link + proto_anchor_link = '/reference/apis/services/audio-in/#' + proto_link elif type == 'service' and resource == 'audio_out': - proto_anchor_link = '/dev/reference/apis/services/audio-out/#' + proto_link + proto_anchor_link = '/reference/apis/services/audio-out/#' + proto_link elif type == 'service' and resource == 'mlmodel': - proto_anchor_link = '/dev/reference/apis/services/ml/#' + proto_link + proto_anchor_link = '/reference/apis/services/ml/#' + proto_link elif type == 'service' and resource == 'world_state_store': - proto_anchor_link = '/dev/reference/apis/services/world-state-store/#' + proto_link + proto_anchor_link = '/reference/apis/services/world-state-store/#' + proto_link elif type == 'app' and resource == 'app': - proto_anchor_link = '/dev/reference/apis/fleet/#' + proto_link + proto_anchor_link = '/reference/apis/fleet/#' + proto_link elif type == 'app' and resource in ["billing", "mltraining"]: - proto_anchor_link = '/dev/reference/apis/' + resource.replace('mltraining','ml-training') + '-client/#' + proto_link + proto_anchor_link = '/reference/apis/' + resource.replace('mltraining','ml-training') + '-client/#' + proto_link elif type == 'app' and resource in ["data", "dataset", "data_sync"]: - proto_anchor_link = '/dev/reference/apis/data-client/#' + proto_link + proto_anchor_link = '/reference/apis/data-client/#' + proto_link elif type == 'robot': - proto_anchor_link = '/dev/reference/apis/' + resource + '/#' + proto_link + proto_anchor_link = '/reference/apis/' + resource + '/#' + proto_link ## Fetch just the first sentence from the proto_override_file (first text string terminated by '.\n'), ignoring hugo ## shortcodes like alerts ('{{%.*%}}.*{{% \[a-b].* %}}'), which precede some override files' (proto descriptions') diff --git a/static/include/components/apis/generated/arm-table.md b/static/include/components/apis/generated/arm-table.md index 73fb8de8e0..08b2cf9a51 100644 --- a/static/include/components/apis/generated/arm-table.md +++ b/static/include/components/apis/generated/arm-table.md @@ -1,18 +1,18 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetEndPosition`](/dev/reference/apis/components/arm/#getendposition) | Get the current position of the arm as a pose. | -| [`MoveToPosition`](/dev/reference/apis/components/arm/#movetoposition) | Move the end of the arm in a straight line to the desired pose, relative to the base of the arm. | -| [`MoveToJointPositions`](/dev/reference/apis/components/arm/#movetojointpositions) | Move each joint on the arm to the position specified in `positions`. | -| [`MoveThroughJointPositions`](/dev/reference/apis/components/arm/#movethroughjointpositions) | Move the arm's joints through the given positions in the order they are specified. | -| [`GetJointPositions`](/dev/reference/apis/components/arm/#getjointpositions) | Get the current position of each joint on the arm. | -| [`Get3DModels`](/dev/reference/apis/components/arm/#get3dmodels) | Get the 3D models of the arm. | -| [`GetKinematics`](/dev/reference/apis/components/arm/#getkinematics) | Get the kinematics information associated with the arm as the format and byte contents of the kinematics file. | -| [`IsMoving`](/dev/reference/apis/components/arm/#ismoving) | Get if the arm is currently moving. | -| [`Stop`](/dev/reference/apis/components/arm/#stop) | Stop all motion of the arm. | -| [`GetGeometries`](/dev/reference/apis/components/arm/#getgeometries) | Get all the geometries associated with the arm in its current configuration, in the frame of the arm. | -| [`Reconfigure`](/dev/reference/apis/components/arm/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/components/arm/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/arm/#getstatus) | Get the current status of the arm as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/components/arm/#getresourcename) | Get the `ResourceName` for this arm. | -| [`Close`](/dev/reference/apis/components/arm/#close) | Safely shut down the resource and prevent further use. | +| [`GetEndPosition`](/reference/apis/components/arm/#getendposition) | Get the current position of the arm as a pose. | +| [`MoveToPosition`](/reference/apis/components/arm/#movetoposition) | Move the end of the arm in a straight line to the desired pose, relative to the base of the arm. | +| [`MoveToJointPositions`](/reference/apis/components/arm/#movetojointpositions) | Move each joint on the arm to the position specified in `positions`. | +| [`MoveThroughJointPositions`](/reference/apis/components/arm/#movethroughjointpositions) | Move the arm's joints through the given positions in the order they are specified. | +| [`GetJointPositions`](/reference/apis/components/arm/#getjointpositions) | Get the current position of each joint on the arm. | +| [`Get3DModels`](/reference/apis/components/arm/#get3dmodels) | Get the 3D models of the arm. | +| [`GetKinematics`](/reference/apis/components/arm/#getkinematics) | Get the kinematics information associated with the arm as the format and byte contents of the kinematics file. | +| [`IsMoving`](/reference/apis/components/arm/#ismoving) | Get if the arm is currently moving. | +| [`Stop`](/reference/apis/components/arm/#stop) | Stop all motion of the arm. | +| [`GetGeometries`](/reference/apis/components/arm/#getgeometries) | Get all the geometries associated with the arm in its current configuration, in the frame of the arm. | +| [`Reconfigure`](/reference/apis/components/arm/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/components/arm/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/arm/#getstatus) | Get the current status of the arm as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/components/arm/#getresourcename) | Get the `ResourceName` for this arm. | +| [`Close`](/reference/apis/components/arm/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/audio_in-table.md b/static/include/components/apis/generated/audio_in-table.md index dd8e9405a1..7eadacac4f 100644 --- a/static/include/components/apis/generated/audio_in-table.md +++ b/static/include/components/apis/generated/audio_in-table.md @@ -1,11 +1,11 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetAudio`](/dev/reference/apis/components/audio-in/#getaudio) | Get a stream of audio from the device. | -| [`GetProperties`](/dev/reference/apis/components/audio-in/#getproperties) | Get the audio device’s properties. | -| [`GetGeometries`](/dev/reference/apis/components/audio-in/#getgeometries) | Get all the geometries associated with the audio in component in its current configuration, in the frame of the audio in component. | -| [`Reconfigure`](/dev/reference/apis/components/audio-in/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/components/audio-in/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/audio-in/#getstatus) | Get the current status of the audio input component as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/components/audio-in/#getresourcename) | Get the `ResourceName` for this audio in component. | -| [`Close`](/dev/reference/apis/components/audio-in/#close) | Safely shut down the resource and prevent further use. | +| [`GetAudio`](/reference/apis/components/audio-in/#getaudio) | Get a stream of audio from the device. | +| [`GetProperties`](/reference/apis/components/audio-in/#getproperties) | Get the audio device’s properties. | +| [`GetGeometries`](/reference/apis/components/audio-in/#getgeometries) | Get all the geometries associated with the audio in component in its current configuration, in the frame of the audio in component. | +| [`Reconfigure`](/reference/apis/components/audio-in/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/components/audio-in/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/audio-in/#getstatus) | Get the current status of the audio input component as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/components/audio-in/#getresourcename) | Get the `ResourceName` for this audio in component. | +| [`Close`](/reference/apis/components/audio-in/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/audio_out-table.md b/static/include/components/apis/generated/audio_out-table.md index 836d5dc270..81596976b4 100644 --- a/static/include/components/apis/generated/audio_out-table.md +++ b/static/include/components/apis/generated/audio_out-table.md @@ -1,12 +1,12 @@ | Method Name | Description | | ----------- | ----------- | -| [`Play`](/dev/reference/apis/components/audio-out/#play) | Play the given audio data. | -| [`PlayStream`](/dev/reference/apis/components/audio-out/#playstream) | Stream audio data in chunks for playback. | -| [`GetProperties`](/dev/reference/apis/components/audio-out/#getproperties) | Get the audio device’s properties. | -| [`GetGeometries`](/dev/reference/apis/components/audio-out/#getgeometries) | Get all the geometries associated with the audio out component in its current configuration, in the frame of the audio out component. | -| [`Reconfigure`](/dev/reference/apis/components/audio-out/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/components/audio-out/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/audio-out/#getstatus) | Get the current status of the audio output component as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/components/audio-out/#getresourcename) | Get the `ResourceName` for this audio out component. | -| [`Close`](/dev/reference/apis/components/audio-out/#close) | Safely shut down the resource and prevent further use. | +| [`Play`](/reference/apis/components/audio-out/#play) | Play the given audio data. | +| [`PlayStream`](/reference/apis/components/audio-out/#playstream) | Stream audio data in chunks for playback. | +| [`GetProperties`](/reference/apis/components/audio-out/#getproperties) | Get the audio device’s properties. | +| [`GetGeometries`](/reference/apis/components/audio-out/#getgeometries) | Get all the geometries associated with the audio out component in its current configuration, in the frame of the audio out component. | +| [`Reconfigure`](/reference/apis/components/audio-out/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/components/audio-out/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/audio-out/#getstatus) | Get the current status of the audio output component as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/components/audio-out/#getresourcename) | Get the `ResourceName` for this audio out component. | +| [`Close`](/reference/apis/components/audio-out/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/base-table.md b/static/include/components/apis/generated/base-table.md index 1be36405c9..4b22a204b6 100644 --- a/static/include/components/apis/generated/base-table.md +++ b/static/include/components/apis/generated/base-table.md @@ -1,16 +1,16 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`MoveStraight`](/dev/reference/apis/components/base/#movestraight) | Move the base in a straight line across the given distance (mm) at the given velocity (mm/sec). | | -| [`Spin`](/dev/reference/apis/components/base/#spin) | Turn the base in place, rotating it to the given angle (degrees) at the given angular velocity (degrees/sec). | | -| [`SetPower`](/dev/reference/apis/components/base/#setpower) | Set the linear and angular power of the base, represented as a percentage of max power for each direction in the range of [-1.0 to 1.0]. |

| -| [`SetVelocity`](/dev/reference/apis/components/base/#setvelocity) | Set the linear velocity (mm/sec) and angular velocity (degrees/sec) of the base. | | -| [`GetProperties`](/dev/reference/apis/components/base/#getproperties) | Get the width and turning radius of the {{< glossary_tooltip term_id="model" text="model" >}} of base in meters. | | -| [`IsMoving`](/dev/reference/apis/components/base/#ismoving) | Returns whether the base is actively moving (or attempting to move) under its own power. | | -| [`Stop`](/dev/reference/apis/components/base/#stop) | Stop the base from moving immediately. |

| -| [`GetGeometries`](/dev/reference/apis/components/base/#getgeometries) | Get all the geometries associated with the base in its current configuration, in the frame of the base. | | -| [`Reconfigure`](/dev/reference/apis/components/base/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/dev/reference/apis/components/base/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetStatus`](/dev/reference/apis/components/base/#getstatus) | Get the current status of the base as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/base/#getresourcename) | Get the `ResourceName` for this base. | | -| [`Close`](/dev/reference/apis/components/base/#close) | Safely shut down the resource and prevent further use. | | +| [`MoveStraight`](/reference/apis/components/base/#movestraight) | Move the base in a straight line across the given distance (mm) at the given velocity (mm/sec). | | +| [`Spin`](/reference/apis/components/base/#spin) | Turn the base in place, rotating it to the given angle (degrees) at the given angular velocity (degrees/sec). | | +| [`SetPower`](/reference/apis/components/base/#setpower) | Set the linear and angular power of the base, represented as a percentage of max power for each direction in the range of [-1.0 to 1.0]. |

| +| [`SetVelocity`](/reference/apis/components/base/#setvelocity) | Set the linear velocity (mm/sec) and angular velocity (degrees/sec) of the base. | | +| [`GetProperties`](/reference/apis/components/base/#getproperties) | Get the width and turning radius of the {{< glossary_tooltip term_id="model" text="model" >}} of base in meters. | | +| [`IsMoving`](/reference/apis/components/base/#ismoving) | Returns whether the base is actively moving (or attempting to move) under its own power. | | +| [`Stop`](/reference/apis/components/base/#stop) | Stop the base from moving immediately. |

| +| [`GetGeometries`](/reference/apis/components/base/#getgeometries) | Get all the geometries associated with the base in its current configuration, in the frame of the base. | | +| [`Reconfigure`](/reference/apis/components/base/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/components/base/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/reference/apis/components/base/#getstatus) | Get the current status of the base as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/base/#getresourcename) | Get the `ResourceName` for this base. | | +| [`Close`](/reference/apis/components/base/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/board-table.md b/static/include/components/apis/generated/board-table.md index 5923613a8e..2bf40480ca 100644 --- a/static/include/components/apis/generated/board-table.md +++ b/static/include/components/apis/generated/board-table.md @@ -1,23 +1,23 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`SetGPIO`](/dev/reference/apis/components/board/#setgpio) | Set the digital signal output of this pin to low (0V) or high (active, >0V). |

| -| [`GetGPIO`](/dev/reference/apis/components/board/#getgpio) | Get if the digital signal output of this pin is high (active, >0V). |

| -| [`GetPWM`](/dev/reference/apis/components/board/#getpwm) | Get the pin's pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] representing the percentage of time the digital signal output by this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| -| [`SetPWM`](/dev/reference/apis/components/board/#setpwm) | Set the pin's Pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] indicating the percentage of time the digital signal output of this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| -| [`PWMFrequency`](/dev/reference/apis/components/board/#pwmfrequency) | Get the PWM frequency of the GPIO pin. |

| -| [`SetPWMFrequency`](/dev/reference/apis/components/board/#setpwmfrequency) | Set the pin to the given PWM `frequency` (in Hz). When `frequency` is 0, it will use the board’s default PWM frequency. |

| -| [`GetDigitalInterruptValue`](/dev/reference/apis/components/board/#getdigitalinterruptvalue) | Get the current value of a configured digital interrupt. | | -| [`ReadAnalogReader`](/dev/reference/apis/components/board/#readanalogreader) | Read the current integer value of the digital signal output by the ADC. |

| -| [`WriteAnalog`](/dev/reference/apis/components/board/#writeanalog) | Write an analog value to a pin on the board. |

| -| [`StreamTicks`](/dev/reference/apis/components/board/#streamticks) | Start a stream of `DigitalInterrupt` ticks. | | -| [`SetPowerMode`](/dev/reference/apis/components/board/#setpowermode) | Set the board to the indicated `PowerMode`. | | -| [`AnalogByName`](/dev/reference/apis/components/board/#analogbyname) | Get a configured `Analog` by `name`. | | -| [`DigitalInterruptByName`](/dev/reference/apis/components/board/#digitalinterruptbyname) | Get a DigitalInterrupt by `name`. | | -| [`GPIOPinByName`](/dev/reference/apis/components/board/#gpiopinbyname) | Get a `GPIOPin` by {{< glossary_tooltip term_id="pin-number" text="pin number" >}}. | | -| [`GetGeometries`](/dev/reference/apis/components/board/#getgeometries) | Get all the geometries associated with the board in its current configuration, in the frame of the board. | | -| [`Reconfigure`](/dev/reference/apis/components/board/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/dev/reference/apis/components/board/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetStatus`](/dev/reference/apis/components/board/#getstatus) | Get the current status of the board as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/board/#getresourcename) | Get the `ResourceName` for this board. | | -| [`Close`](/dev/reference/apis/components/board/#close) | Safely shut down the resource and prevent further use. | | +| [`SetGPIO`](/reference/apis/components/board/#setgpio) | Set the digital signal output of this pin to low (0V) or high (active, >0V). |

| +| [`GetGPIO`](/reference/apis/components/board/#getgpio) | Get if the digital signal output of this pin is high (active, >0V). |

| +| [`GetPWM`](/reference/apis/components/board/#getpwm) | Get the pin's pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] representing the percentage of time the digital signal output by this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| +| [`SetPWM`](/reference/apis/components/board/#setpwm) | Set the pin's Pulse-width modulation (PWM) duty cycle: a float [`0.0`, `1.0`] indicating the percentage of time the digital signal output of this pin is in the high state (active, >0V) relative to the interval period of the PWM signal (interval period being the mathematical inverse of the PWM frequency). |

| +| [`PWMFrequency`](/reference/apis/components/board/#pwmfrequency) | Get the PWM frequency of the GPIO pin. |

| +| [`SetPWMFrequency`](/reference/apis/components/board/#setpwmfrequency) | Set the pin to the given PWM `frequency` (in Hz). When `frequency` is 0, it will use the board’s default PWM frequency. |

| +| [`GetDigitalInterruptValue`](/reference/apis/components/board/#getdigitalinterruptvalue) | Get the current value of a configured digital interrupt. | | +| [`ReadAnalogReader`](/reference/apis/components/board/#readanalogreader) | Read the current integer value of the digital signal output by the ADC. |

| +| [`WriteAnalog`](/reference/apis/components/board/#writeanalog) | Write an analog value to a pin on the board. |

| +| [`StreamTicks`](/reference/apis/components/board/#streamticks) | Start a stream of `DigitalInterrupt` ticks. | | +| [`SetPowerMode`](/reference/apis/components/board/#setpowermode) | Set the board to the indicated `PowerMode`. | | +| [`AnalogByName`](/reference/apis/components/board/#analogbyname) | Get a configured `Analog` by `name`. | | +| [`DigitalInterruptByName`](/reference/apis/components/board/#digitalinterruptbyname) | Get a DigitalInterrupt by `name`. | | +| [`GPIOPinByName`](/reference/apis/components/board/#gpiopinbyname) | Get a `GPIOPin` by {{< glossary_tooltip term_id="pin-number" text="pin number" >}}. | | +| [`GetGeometries`](/reference/apis/components/board/#getgeometries) | Get all the geometries associated with the board in its current configuration, in the frame of the board. | | +| [`Reconfigure`](/reference/apis/components/board/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/components/board/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/reference/apis/components/board/#getstatus) | Get the current status of the board as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/board/#getresourcename) | Get the `ResourceName` for this board. | | +| [`Close`](/reference/apis/components/board/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/button-table.md b/static/include/components/apis/generated/button-table.md index a3844bf182..77dee10bfe 100644 --- a/static/include/components/apis/generated/button-table.md +++ b/static/include/components/apis/generated/button-table.md @@ -1,9 +1,9 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`Push`](/dev/reference/apis/components/button/#push) | Push the button. |

| -| [`Reconfigure`](/dev/reference/apis/components/button/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/dev/reference/apis/components/button/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetStatus`](/dev/reference/apis/components/button/#getstatus) | Get the current status of the button as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/button/#getresourcename) | Get the `ResourceName` for this button. | | -| [`Close`](/dev/reference/apis/components/button/#close) | Safely shut down the resource and prevent further use. | | +| [`Push`](/reference/apis/components/button/#push) | Push the button. |

| +| [`Reconfigure`](/reference/apis/components/button/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/components/button/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/reference/apis/components/button/#getstatus) | Get the current status of the button as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/button/#getresourcename) | Get the `ResourceName` for this button. | | +| [`Close`](/reference/apis/components/button/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/camera-table.md b/static/include/components/apis/generated/camera-table.md index 5e188cb956..e92f736f81 100644 --- a/static/include/components/apis/generated/camera-table.md +++ b/static/include/components/apis/generated/camera-table.md @@ -1,11 +1,11 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetImages`](/dev/reference/apis/components/camera/#getimages) | `GetImages` is used for getting simultaneous images from different imagers from 3D cameras along with associated metadata, and single images from non-3D cameras, for example webcams, RTSP cameras, etc. in the image list in the response. | -| [`GetPointCloud`](/dev/reference/apis/components/camera/#getpointcloud) | Get a point cloud from the camera as bytes with a MIME type describing the structure of the data. | -| [`GetProperties`](/dev/reference/apis/components/camera/#getproperties) | Get the camera intrinsic parameters and camera distortion, as well as whether the camera supports returning point clouds. | -| [`DoCommand`](/dev/reference/apis/components/camera/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/camera/#getstatus) | Get the current status of the camera as a map of key-value pairs describing its state. | -| [`GetGeometries`](/dev/reference/apis/components/camera/#getgeometries) | Get all the geometries associated with the camera in its current configuration, in the frame of the camera. | -| [`GetResourceName`](/dev/reference/apis/components/camera/#getresourcename) | Get the `ResourceName` for this camera. | -| [`Close`](/dev/reference/apis/components/camera/#close) | Safely shut down the resource and prevent further use. | +| [`GetImages`](/reference/apis/components/camera/#getimages) | `GetImages` is used for getting simultaneous images from different imagers from 3D cameras along with associated metadata, and single images from non-3D cameras, for example webcams, RTSP cameras, etc. in the image list in the response. | +| [`GetPointCloud`](/reference/apis/components/camera/#getpointcloud) | Get a point cloud from the camera as bytes with a MIME type describing the structure of the data. | +| [`GetProperties`](/reference/apis/components/camera/#getproperties) | Get the camera intrinsic parameters and camera distortion, as well as whether the camera supports returning point clouds. | +| [`DoCommand`](/reference/apis/components/camera/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/camera/#getstatus) | Get the current status of the camera as a map of key-value pairs describing its state. | +| [`GetGeometries`](/reference/apis/components/camera/#getgeometries) | Get all the geometries associated with the camera in its current configuration, in the frame of the camera. | +| [`GetResourceName`](/reference/apis/components/camera/#getresourcename) | Get the `ResourceName` for this camera. | +| [`Close`](/reference/apis/components/camera/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/encoder-table.md b/static/include/components/apis/generated/encoder-table.md index 57f4abbfad..5529a83065 100644 --- a/static/include/components/apis/generated/encoder-table.md +++ b/static/include/components/apis/generated/encoder-table.md @@ -1,12 +1,12 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`GetPosition`](/dev/reference/apis/components/encoder/#getposition) | Get the current position of the encoder in ticks or degrees. |

| -| [`ResetPosition`](/dev/reference/apis/components/encoder/#resetposition) | Set the current position of the encoder to be the new zero position. |

| -| [`GetProperties`](/dev/reference/apis/components/encoder/#getproperties) | Get a list of all the position types that are supported by a given encoder. |

| -| [`GetGeometries`](/dev/reference/apis/components/encoder/#getgeometries) | Get all the geometries associated with the encoder in its current configuration, in the frame of the encoder. | | -| [`Reconfigure`](/dev/reference/apis/components/encoder/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/dev/reference/apis/components/encoder/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetStatus`](/dev/reference/apis/components/encoder/#getstatus) | Get the current status of the encoder as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/encoder/#getresourcename) | Get the `ResourceName` for this encoder. | | -| [`Close`](/dev/reference/apis/components/encoder/#close) | Safely shut down the resource and prevent further use. | | +| [`GetPosition`](/reference/apis/components/encoder/#getposition) | Get the current position of the encoder in ticks or degrees. |

| +| [`ResetPosition`](/reference/apis/components/encoder/#resetposition) | Set the current position of the encoder to be the new zero position. |

| +| [`GetProperties`](/reference/apis/components/encoder/#getproperties) | Get a list of all the position types that are supported by a given encoder. |

| +| [`GetGeometries`](/reference/apis/components/encoder/#getgeometries) | Get all the geometries associated with the encoder in its current configuration, in the frame of the encoder. | | +| [`Reconfigure`](/reference/apis/components/encoder/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/components/encoder/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/reference/apis/components/encoder/#getstatus) | Get the current status of the encoder as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/encoder/#getresourcename) | Get the `ResourceName` for this encoder. | | +| [`Close`](/reference/apis/components/encoder/#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 70c9ae7e97..3f8a0e9189 100644 --- a/static/include/components/apis/generated/gantry-table.md +++ b/static/include/components/apis/generated/gantry-table.md @@ -1,16 +1,16 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetPosition`](/dev/reference/apis/components/gantry/#getposition) | Get the current positions of the axis of the gantry (mm). | -| [`MoveToPosition`](/dev/reference/apis/components/gantry/#movetoposition) | Move the axes of the gantry to the desired positions (mm) at the requested speeds (mm/sec). | -| [`GetLengths`](/dev/reference/apis/components/gantry/#getlengths) | Get the lengths of the axes of the gantry (mm). | -| [`Home`](/dev/reference/apis/components/gantry/#home) | Run the homing sequence of the gantry to re-calibrate the axes with respect to the limit switches. | -| [`GetGeometries`](/dev/reference/apis/components/gantry/#getgeometries) | Get all the geometries associated with the gantry in its current configuration, in the frame of the gantry. | -| [`IsMoving`](/dev/reference/apis/components/gantry/#ismoving) | Get if the gantry is currently moving. | -| [`Stop`](/dev/reference/apis/components/gantry/#stop) | Stop all motion of the gantry. | -| [`Reconfigure`](/dev/reference/apis/components/gantry/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/components/gantry/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/gantry/#getstatus) | Get the current status of the gantry as a map of key-value pairs describing its state. | -| [`GetKinematics`](/dev/reference/apis/components/gantry/#getkinematics) | Get the kinematics information associated with the gantry. | -| [`GetResourceName`](/dev/reference/apis/components/gantry/#getresourcename) | Get the `ResourceName` for this gantry. | -| [`Close`](/dev/reference/apis/components/gantry/#close) | Safely shut down the resource and prevent further use. | +| [`GetPosition`](/reference/apis/components/gantry/#getposition) | Get the current positions of the axis of the gantry (mm). | +| [`MoveToPosition`](/reference/apis/components/gantry/#movetoposition) | Move the axes of the gantry to the desired positions (mm) at the requested speeds (mm/sec). | +| [`GetLengths`](/reference/apis/components/gantry/#getlengths) | Get the lengths of the axes of the gantry (mm). | +| [`Home`](/reference/apis/components/gantry/#home) | Run the homing sequence of the gantry to re-calibrate the axes with respect to the limit switches. | +| [`GetGeometries`](/reference/apis/components/gantry/#getgeometries) | Get all the geometries associated with the gantry in its current configuration, in the frame of the gantry. | +| [`IsMoving`](/reference/apis/components/gantry/#ismoving) | Get if the gantry is currently moving. | +| [`Stop`](/reference/apis/components/gantry/#stop) | Stop all motion of the gantry. | +| [`Reconfigure`](/reference/apis/components/gantry/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/components/gantry/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/gantry/#getstatus) | Get the current status of the gantry as a map of key-value pairs describing its state. | +| [`GetKinematics`](/reference/apis/components/gantry/#getkinematics) | Get the kinematics information associated with the gantry. | +| [`GetResourceName`](/reference/apis/components/gantry/#getresourcename) | Get the `ResourceName` for this gantry. | +| [`Close`](/reference/apis/components/gantry/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/generic_component-table.md b/static/include/components/apis/generated/generic_component-table.md index 0dc2483d24..5b66b2f5ef 100644 --- a/static/include/components/apis/generated/generic_component-table.md +++ b/static/include/components/apis/generated/generic_component-table.md @@ -1,8 +1,8 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`GetGeometries`](/dev/reference/apis/components/generic/#getgeometries) | Get all the geometries associated with the generic component in its current configuration, in the frame of the generic component. | | -| [`DoCommand`](/dev/reference/apis/components/generic/#docommand) | Execute model-specific commands. |

| -| [`GetStatus`](/dev/reference/apis/components/generic/#getstatus) | Get the current status of the generic component as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/generic/#getresourcename) | Get the `ResourceName` for this generic component. | | -| [`Close`](/dev/reference/apis/components/generic/#close) | Safely shut down the resource and prevent further use. | | +| [`GetGeometries`](/reference/apis/components/generic/#getgeometries) | Get all the geometries associated with the generic component in its current configuration, in the frame of the generic component. | | +| [`DoCommand`](/reference/apis/components/generic/#docommand) | Execute model-specific commands. |

| +| [`GetStatus`](/reference/apis/components/generic/#getstatus) | Get the current status of the generic component as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/generic/#getresourcename) | Get the `ResourceName` for this generic component. | | +| [`Close`](/reference/apis/components/generic/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/gripper-table.md b/static/include/components/apis/generated/gripper-table.md index 5f5ac58935..6569e73ec2 100644 --- a/static/include/components/apis/generated/gripper-table.md +++ b/static/include/components/apis/generated/gripper-table.md @@ -1,17 +1,17 @@ | Method Name | Description | | ----------- | ----------- | -| [`Open`](/dev/reference/apis/components/gripper/#open) | Opens the gripper. | -| [`Grab`](/dev/reference/apis/components/gripper/#grab) | Closes the gripper until it grabs something or closes completely, and returns whether it grabbed something or not. | -| [`IsMoving`](/dev/reference/apis/components/gripper/#ismoving) | Returns whether the gripper is actively moving (or attempting to move) under its own power. | -| [`IsHoldingSomething`](/dev/reference/apis/components/gripper/#isholdingsomething) | Return if the gripper is holding something. | -| [`Stop`](/dev/reference/apis/components/gripper/#stop) | Stops the gripper. | -| [`GetGeometries`](/dev/reference/apis/components/gripper/#getgeometries) | Get all the geometries associated with the gripper in its current configuration, in the frame of the gripper. | -| [`GetCurrentInputs`](/dev/reference/apis/components/gripper/#getcurrentinputs) | Get the current joint input values of the gripper. | -| [`GoToInputs`](/dev/reference/apis/components/gripper/#gotoinputs) | Move the gripper to the specified joint input values. | -| [`Reconfigure`](/dev/reference/apis/components/gripper/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/components/gripper/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/gripper/#getstatus) | Get the current status of the gripper as a map of key-value pairs describing its state. | -| [`GetKinematics`](/dev/reference/apis/components/gripper/#getkinematics) | Get the kinematics information associated with the gripper as the format and byte contents of the kinematics file. | -| [`GetResourceName`](/dev/reference/apis/components/gripper/#getresourcename) | Get the `ResourceName` for this gripper. | -| [`Close`](/dev/reference/apis/components/gripper/#close) | Safely shut down the resource and prevent further use. | +| [`Open`](/reference/apis/components/gripper/#open) | Opens the gripper. | +| [`Grab`](/reference/apis/components/gripper/#grab) | Closes the gripper until it grabs something or closes completely, and returns whether it grabbed something or not. | +| [`IsMoving`](/reference/apis/components/gripper/#ismoving) | Returns whether the gripper is actively moving (or attempting to move) under its own power. | +| [`IsHoldingSomething`](/reference/apis/components/gripper/#isholdingsomething) | Return if the gripper is holding something. | +| [`Stop`](/reference/apis/components/gripper/#stop) | Stops the gripper. | +| [`GetGeometries`](/reference/apis/components/gripper/#getgeometries) | Get all the geometries associated with the gripper in its current configuration, in the frame of the gripper. | +| [`GetCurrentInputs`](/reference/apis/components/gripper/#getcurrentinputs) | Get the current joint input values of the gripper. | +| [`GoToInputs`](/reference/apis/components/gripper/#gotoinputs) | Move the gripper to the specified joint input values. | +| [`Reconfigure`](/reference/apis/components/gripper/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/components/gripper/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/gripper/#getstatus) | Get the current status of the gripper as a map of key-value pairs describing its state. | +| [`GetKinematics`](/reference/apis/components/gripper/#getkinematics) | Get the kinematics information associated with the gripper as the format and byte contents of the kinematics file. | +| [`GetResourceName`](/reference/apis/components/gripper/#getresourcename) | Get the `ResourceName` for this gripper. | +| [`Close`](/reference/apis/components/gripper/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/input_controller-table.md b/static/include/components/apis/generated/input_controller-table.md index c22548f6a7..4de5ce91aa 100644 --- a/static/include/components/apis/generated/input_controller-table.md +++ b/static/include/components/apis/generated/input_controller-table.md @@ -1,13 +1,13 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetControls`](/dev/reference/apis/components/input-controller/#getcontrols) | Get a list of the Controls that your controller provides. | -| [`GetEvents`](/dev/reference/apis/components/input-controller/#getevents) | This method returns the current state of the controller as a map of Event Objects, representing the most recent event that has occurred on each available Control. | -| [`TriggerEvent`](/dev/reference/apis/components/input-controller/#triggerevent) | Directly send an Event Object from external code. | -| [`GetGeometries`](/dev/reference/apis/components/input-controller/#getgeometries) | Get all the geometries associated with the input controller in its current configuration, in the frame of the input controller. | -| [`RegisterControlCallback`](/dev/reference/apis/components/input-controller/#registercontrolcallback) | Defines a callback function to execute whenever one of the EventTypes selected occurs on the given Control. | -| [`Reconfigure`](/dev/reference/apis/components/input-controller/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/components/input-controller/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/input-controller/#getstatus) | Get the current status of the input controller as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/components/input-controller/#getresourcename) | Get the `ResourceName` for this input controller. | -| [`Close`](/dev/reference/apis/components/input-controller/#close) | Safely shut down the resource and prevent further use. | +| [`GetControls`](/reference/apis/components/input-controller/#getcontrols) | Get a list of the Controls that your controller provides. | +| [`GetEvents`](/reference/apis/components/input-controller/#getevents) | This method returns the current state of the controller as a map of Event Objects, representing the most recent event that has occurred on each available Control. | +| [`TriggerEvent`](/reference/apis/components/input-controller/#triggerevent) | Directly send an Event Object from external code. | +| [`GetGeometries`](/reference/apis/components/input-controller/#getgeometries) | Get all the geometries associated with the input controller in its current configuration, in the frame of the input controller. | +| [`RegisterControlCallback`](/reference/apis/components/input-controller/#registercontrolcallback) | Defines a callback function to execute whenever one of the EventTypes selected occurs on the given Control. | +| [`Reconfigure`](/reference/apis/components/input-controller/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/components/input-controller/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/input-controller/#getstatus) | Get the current status of the input controller as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/components/input-controller/#getresourcename) | Get the `ResourceName` for this input controller. | +| [`Close`](/reference/apis/components/input-controller/#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 010b646dd5..fcb52dbc69 100644 --- a/static/include/components/apis/generated/motor-table.md +++ b/static/include/components/apis/generated/motor-table.md @@ -1,19 +1,19 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`SetPower`](/dev/reference/apis/components/motor/#setpower) | Set the portion of max power to send to the motor (between `-1` and `1`). |

| -| [`SetRPM`](/dev/reference/apis/components/motor/#setrpm) | Spin the motor indefinitely at the specified speed, in revolutions per minute. If `rpm` is positive, the motor will spin forwards, and if `rpm` is negative, the motor will spin backwards. | | -| [`GoFor`](/dev/reference/apis/components/motor/#gofor) | Spin the motor the specified number of revolutions at specified revolutions per minute. | | -| [`GoTo`](/dev/reference/apis/components/motor/#goto) | Turn the motor to a specified position (in terms of revolutions from home/zero) at a specified speed in revolutions per minute (RPM). | | -| [`ResetZeroPosition`](/dev/reference/apis/components/motor/#resetzeroposition) | Set the current position (modified by `offset`) to be the new zero (home) position. | | -| [`GetPosition`](/dev/reference/apis/components/motor/#getposition) | Report the position of the motor based on its encoder. |

| -| [`GetProperties`](/dev/reference/apis/components/motor/#getproperties) | Report a dictionary mapping optional properties to whether it is supported by this motor. |

| -| [`IsPowered`](/dev/reference/apis/components/motor/#ispowered) | Return whether or not the motor is currently running, and the portion of max power (between `0` and `1`; if the motor is off the power will be `0`). | | -| [`IsMoving`](/dev/reference/apis/components/motor/#ismoving) | Return whether the motor is actively moving (or attempting to move) under its own power. |

| -| [`Stop`](/dev/reference/apis/components/motor/#stop) | Cut the power to the motor immediately, without any gradual step down. |

| -| [`GetGeometries`](/dev/reference/apis/components/motor/#getgeometries) | Get all the geometries associated with the motor in its current configuration, in the frame of the motor. | | -| [`Reconfigure`](/dev/reference/apis/components/motor/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/dev/reference/apis/components/motor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/motor/#getstatus) | Get the current status of the motor as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/motor/#getresourcename) | Get the `ResourceName` for this motor. | | -| [`Close`](/dev/reference/apis/components/motor/#close) | Safely shut down the resource and prevent further use. | | +| [`SetPower`](/reference/apis/components/motor/#setpower) | Set the portion of max power to send to the motor (between `-1` and `1`). |

| +| [`SetRPM`](/reference/apis/components/motor/#setrpm) | Spin the motor indefinitely at the specified speed, in revolutions per minute. If `rpm` is positive, the motor will spin forwards, and if `rpm` is negative, the motor will spin backwards. | | +| [`GoFor`](/reference/apis/components/motor/#gofor) | Spin the motor the specified number of revolutions at specified revolutions per minute. | | +| [`GoTo`](/reference/apis/components/motor/#goto) | Turn the motor to a specified position (in terms of revolutions from home/zero) at a specified speed in revolutions per minute (RPM). | | +| [`ResetZeroPosition`](/reference/apis/components/motor/#resetzeroposition) | Set the current position (modified by `offset`) to be the new zero (home) position. | | +| [`GetPosition`](/reference/apis/components/motor/#getposition) | Report the position of the motor based on its encoder. |

| +| [`GetProperties`](/reference/apis/components/motor/#getproperties) | Report a dictionary mapping optional properties to whether it is supported by this motor. |

| +| [`IsPowered`](/reference/apis/components/motor/#ispowered) | Return whether or not the motor is currently running, and the portion of max power (between `0` and `1`; if the motor is off the power will be `0`). | | +| [`IsMoving`](/reference/apis/components/motor/#ismoving) | Return whether the motor is actively moving (or attempting to move) under its own power. |

| +| [`Stop`](/reference/apis/components/motor/#stop) | Cut the power to the motor immediately, without any gradual step down. |

| +| [`GetGeometries`](/reference/apis/components/motor/#getgeometries) | Get all the geometries associated with the motor in its current configuration, in the frame of the motor. | | +| [`Reconfigure`](/reference/apis/components/motor/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/components/motor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/motor/#getstatus) | Get the current status of the motor as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/motor/#getresourcename) | Get the `ResourceName` for this motor. | | +| [`Close`](/reference/apis/components/motor/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/power_sensor-table.md b/static/include/components/apis/generated/power_sensor-table.md index 430e17b264..e6514c50a9 100644 --- a/static/include/components/apis/generated/power_sensor-table.md +++ b/static/include/components/apis/generated/power_sensor-table.md @@ -1,12 +1,12 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetVoltage`](/dev/reference/apis/components/power-sensor/#getvoltage) | Return the voltage reading of a specified device and whether it is AC or DC. | -| [`GetCurrent`](/dev/reference/apis/components/power-sensor/#getcurrent) | Return the current of a specified device and whether it is AC or DC. | -| [`GetPower`](/dev/reference/apis/components/power-sensor/#getpower) | Return the power reading in watts. | -| [`GetReadings`](/dev/reference/apis/components/power-sensor/#getreadings) | Get the measurements or readings that this power sensor provides. | -| [`Reconfigure`](/dev/reference/apis/components/power-sensor/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/components/power-sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/power-sensor/#getstatus) | Get the current status of the power sensor as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/components/power-sensor/#getresourcename) | Get the `ResourceName` for this power sensor. | -| [`Close`](/dev/reference/apis/components/power-sensor/#close) | Safely shut down the resource and prevent further use. | +| [`GetVoltage`](/reference/apis/components/power-sensor/#getvoltage) | Return the voltage reading of a specified device and whether it is AC or DC. | +| [`GetCurrent`](/reference/apis/components/power-sensor/#getcurrent) | Return the current of a specified device and whether it is AC or DC. | +| [`GetPower`](/reference/apis/components/power-sensor/#getpower) | Return the power reading in watts. | +| [`GetReadings`](/reference/apis/components/power-sensor/#getreadings) | Get the measurements or readings that this power sensor provides. | +| [`Reconfigure`](/reference/apis/components/power-sensor/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/components/power-sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/power-sensor/#getstatus) | Get the current status of the power sensor as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/components/power-sensor/#getresourcename) | Get the `ResourceName` for this power sensor. | +| [`Close`](/reference/apis/components/power-sensor/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/components/apis/generated/sensor-table.md b/static/include/components/apis/generated/sensor-table.md index 1eb6382032..cf855087a4 100644 --- a/static/include/components/apis/generated/sensor-table.md +++ b/static/include/components/apis/generated/sensor-table.md @@ -1,10 +1,10 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`GetReadings`](/dev/reference/apis/components/sensor/#getreadings) | Get the measurements or readings that this sensor provides. |

| -| [`GetGeometries`](/dev/reference/apis/components/sensor/#getgeometries) | Get all the geometries associated with the sensor in its current configuration, in the frame of the sensor. | -| [`Reconfigure`](/dev/reference/apis/components/sensor/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/dev/reference/apis/components/sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/sensor/#getstatus) | Get the current status of the sensor as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/sensor/#getresourcename) | Get the `ResourceName` for this sensor. | | -| [`Close`](/dev/reference/apis/components/sensor/#close) | Safely shut down the resource and prevent further use. | | +| [`GetReadings`](/reference/apis/components/sensor/#getreadings) | Get the measurements or readings that this sensor provides. |

| +| [`GetGeometries`](/reference/apis/components/sensor/#getgeometries) | Get all the geometries associated with the sensor in its current configuration, in the frame of the sensor. | +| [`Reconfigure`](/reference/apis/components/sensor/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/components/sensor/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/sensor/#getstatus) | Get the current status of the sensor as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/sensor/#getresourcename) | Get the `ResourceName` for this sensor. | | +| [`Close`](/reference/apis/components/sensor/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/servo-table.md b/static/include/components/apis/generated/servo-table.md index 39af82707c..7e5b32ecea 100644 --- a/static/include/components/apis/generated/servo-table.md +++ b/static/include/components/apis/generated/servo-table.md @@ -1,13 +1,13 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`Move`](/dev/reference/apis/components/servo/#move) | Move the servo to the desired angle in degrees. |

| -| [`GetPosition`](/dev/reference/apis/components/servo/#getposition) | Get the current set angle of the servo in degrees. |

| -| [`IsMoving`](/dev/reference/apis/components/servo/#ismoving) | Returns whether the servo is actively moving (or attempting to move) under its own power. | | -| [`Stop`](/dev/reference/apis/components/servo/#stop) | Stop the servo from moving. |

| -| [`GetGeometries`](/dev/reference/apis/components/servo/#getgeometries) | Get all the geometries associated with the servo in its current configuration, in the frame of the servo. | | -| [`Reconfigure`](/dev/reference/apis/components/servo/#reconfigure) | Reconfigure this resource. | | -| [`DoCommand`](/dev/reference/apis/components/servo/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | -| [`GetStatus`](/dev/reference/apis/components/servo/#getstatus) | Get the current status of the servo as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/servo/#getresourcename) | Get the `ResourceName` for this servo. | | -| [`Close`](/dev/reference/apis/components/servo/#close) | Safely shut down the resource and prevent further use. | | +| [`Move`](/reference/apis/components/servo/#move) | Move the servo to the desired angle in degrees. |

| +| [`GetPosition`](/reference/apis/components/servo/#getposition) | Get the current set angle of the servo in degrees. |

| +| [`IsMoving`](/reference/apis/components/servo/#ismoving) | Returns whether the servo is actively moving (or attempting to move) under its own power. | | +| [`Stop`](/reference/apis/components/servo/#stop) | Stop the servo from moving. |

| +| [`GetGeometries`](/reference/apis/components/servo/#getgeometries) | Get all the geometries associated with the servo in its current configuration, in the frame of the servo. | | +| [`Reconfigure`](/reference/apis/components/servo/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/components/servo/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. | +| [`GetStatus`](/reference/apis/components/servo/#getstatus) | Get the current status of the servo as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/servo/#getresourcename) | Get the `ResourceName` for this servo. | | +| [`Close`](/reference/apis/components/servo/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/components/apis/generated/switch-table.md b/static/include/components/apis/generated/switch-table.md index f5e1964362..073a67a6dd 100644 --- a/static/include/components/apis/generated/switch-table.md +++ b/static/include/components/apis/generated/switch-table.md @@ -1,10 +1,10 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`SetPosition`](/dev/reference/apis/components/switch/#setposition) | Set the position of the switch. |

| -| [`GetPosition`](/dev/reference/apis/components/switch/#getposition) | Return the current position of the switch. |

| -| [`GetNumberOfPositions`](/dev/reference/apis/components/switch/#getnumberofpositions) | Return the number of valid positions for this switch. |

| -| [`DoCommand`](/dev/reference/apis/components/switch/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| -| [`GetStatus`](/dev/reference/apis/components/switch/#getstatus) | Get the current status of the switch as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/components/switch/#getresourcename) | Get the `ResourceName` for this servo. | | -| [`Close`](/dev/reference/apis/components/switch/#close) | Safely shut down the resource and prevent further use. | | +| [`SetPosition`](/reference/apis/components/switch/#setposition) | Set the position of the switch. |

| +| [`GetPosition`](/reference/apis/components/switch/#getposition) | Return the current position of the switch. |

| +| [`GetNumberOfPositions`](/reference/apis/components/switch/#getnumberofpositions) | Return the number of valid positions for this switch. |

| +| [`DoCommand`](/reference/apis/components/switch/#docommand) | Execute model-specific commands that are not otherwise defined by the component API. |

| +| [`GetStatus`](/reference/apis/components/switch/#getstatus) | Get the current status of the switch as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/components/switch/#getresourcename) | Get the `ResourceName` for this servo. | | +| [`Close`](/reference/apis/components/switch/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/services/apis/generated/data_manager-table.md b/static/include/services/apis/generated/data_manager-table.md index 44cc6d3499..ed08a2db27 100644 --- a/static/include/services/apis/generated/data_manager-table.md +++ b/static/include/services/apis/generated/data_manager-table.md @@ -1,10 +1,10 @@ | Method Name | Description | `viam-micro-server` Support | | ----------- | ----------- | --------------------------- | -| [`Sync`](/dev/reference/apis/services/data/#sync) | Sync data stored on the machine to the cloud. | | -| [`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. | | -| [`GetStatus`](/dev/reference/apis/services/data/#getstatus) | Get the current status of the data management service as a map of key-value pairs describing its state. | | -| [`GetResourceName`](/dev/reference/apis/services/data/#getresourcename) | Get the `ResourceName` for this instance of the service. | | -| [`Close`](/dev/reference/apis/services/data/#close) | Safely shut down the resource and prevent further use. | | +| [`Sync`](/reference/apis/services/data/#sync) | Sync data stored on the machine to the cloud. | | +| [`UploadBinaryDataToDatasets`](/reference/apis/services/data/#uploadbinarydatatodatasets) | Upload Binary data to the specified datasets. | | +| [`Reconfigure`](/reference/apis/services/data/#reconfigure) | Reconfigure this resource. | | +| [`DoCommand`](/reference/apis/services/data/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | | +| [`GetStatus`](/reference/apis/services/data/#getstatus) | Get the current status of the data management service as a map of key-value pairs describing its state. | | +| [`GetResourceName`](/reference/apis/services/data/#getresourcename) | Get the `ResourceName` for this instance of the service. | | +| [`Close`](/reference/apis/services/data/#close) | Safely shut down the resource and prevent further use. | | diff --git a/static/include/services/apis/generated/discovery-table.md b/static/include/services/apis/generated/discovery-table.md index 329387cfd5..66c73bbc40 100644 --- a/static/include/services/apis/generated/discovery-table.md +++ b/static/include/services/apis/generated/discovery-table.md @@ -1,8 +1,8 @@ | 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. | -| [`GetStatus`](/dev/reference/apis/services/discovery/#getstatus) | Get the current status of the discovery service as a map of key-value pairs describing its state. | -| [`Close`](/dev/reference/apis/services/discovery/#close) | Safely shut down the resource and prevent further use. | +| [`DiscoverResources`](/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`](/reference/apis/services/discovery/#getresourcename) | Get the `ResourceName` for this instance of the service. | +| [`DoCommand`](/reference/apis/services/discovery/#docommand) | Execute model-specific commands. | +| [`GetStatus`](/reference/apis/services/discovery/#getstatus) | Get the current status of the discovery service as a map of key-value pairs describing its state. | +| [`Close`](/reference/apis/services/discovery/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/generic_service-table.md b/static/include/services/apis/generated/generic_service-table.md index af9f90573a..8463198aaa 100644 --- a/static/include/services/apis/generated/generic_service-table.md +++ b/static/include/services/apis/generated/generic_service-table.md @@ -1,7 +1,7 @@ | Method Name | Description | | ----------- | ----------- | -| [`DoCommand`](/dev/reference/apis/services/generic/#docommand) | Execute model-specific commands. | -| [`GetStatus`](/dev/reference/apis/services/generic/#getstatus) | Get the current status of the generic service as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/services/generic/#getresourcename) | Get the `ResourceName` for this instance of the generic service. | -| [`Close`](/dev/reference/apis/services/generic/#close) | Safely shut down the resource and prevent further use. | +| [`DoCommand`](/reference/apis/services/generic/#docommand) | Execute model-specific commands. | +| [`GetStatus`](/reference/apis/services/generic/#getstatus) | Get the current status of the generic service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/services/generic/#getresourcename) | Get the `ResourceName` for this instance of the generic service. | +| [`Close`](/reference/apis/services/generic/#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 2560fc1e1c..9ec86976bc 100644 --- a/static/include/services/apis/generated/mlmodel-table.md +++ b/static/include/services/apis/generated/mlmodel-table.md @@ -1,10 +1,10 @@ | Method Name | Description | | ----------- | ----------- | -| [`Infer`](/dev/reference/apis/services/ml/#infer) | Take an already ordered input tensor as an array, make an inference on the model, and return an output tensor map. | -| [`Metadata`](/dev/reference/apis/services/ml/#metadata) | Get the metadata: name, data type, expected tensor/array shape, inputs, and outputs associated with the ML model. | -| [`Reconfigure`](/dev/reference/apis/services/ml/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/services/ml/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetStatus`](/dev/reference/apis/services/ml/#getstatus) | Get the current status of the ML model service as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/services/ml/#getresourcename) | Get the `ResourceName` for this instance of the ML model service. | -| [`Close`](/dev/reference/apis/services/ml/#close) | Safely shut down the resource and prevent further use. | +| [`Infer`](/reference/apis/services/ml/#infer) | Take an already ordered input tensor as an array, make an inference on the model, and return an output tensor map. | +| [`Metadata`](/reference/apis/services/ml/#metadata) | Get the metadata: name, data type, expected tensor/array shape, inputs, and outputs associated with the ML model. | +| [`Reconfigure`](/reference/apis/services/ml/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/services/ml/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/reference/apis/services/ml/#getstatus) | Get the current status of the ML model service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/services/ml/#getresourcename) | Get the `ResourceName` for this instance of the ML model service. | +| [`Close`](/reference/apis/services/ml/#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 e0f7f50388..0c9f86c47f 100644 --- a/static/include/services/apis/generated/motion-table.md +++ b/static/include/services/apis/generated/motion-table.md @@ -1,16 +1,16 @@ | Method Name | Description | | ----------- | ----------- | -| [`Move`](/dev/reference/apis/services/motion/#move) | The `Move` method is the primary way to move multiple components, or to move any object to any other location. | -| [`MoveOnMap`](/dev/reference/apis/services/motion/#moveonmap) | Move a base component to a destination pose on a SLAM map. | -| [`MoveOnGlobe`](/dev/reference/apis/services/motion/#moveonglobe) | Move a base component to a destination GPS point, represented in geographic notation _(latitude, longitude)_. | -| [`GetPose`](/dev/reference/apis/services/motion/#getpose) | `GetPose` gets the location and orientation of a component within the frame system. | -| [`StopPlan`](/dev/reference/apis/services/motion/#stopplan) | Stop a base component being moved by an in progress `MoveOnGlobe` or `MoveOnMap` call. | -| [`ListPlanStatuses`](/dev/reference/apis/services/motion/#listplanstatuses) | Returns the statuses of plans created by `MoveOnGlobe` or `MoveOnMap` calls that meet at least one of the following conditions since the motion service initialized: - the plan's status is in progress - the plan's status changed state within the last 24 hours All repeated fields are in chronological order. | -| [`GetPlan`](/dev/reference/apis/services/motion/#getplan) | By default, returns the plan history of the most recent `MoveOnGlobe` or `MoveOnMap` call to move a base component. | -| [`Reconfigure`](/dev/reference/apis/services/motion/#reconfigure) | Reconfigure this resource. | -| [`FromRobot`](/dev/reference/apis/services/motion/#fromrobot) | Get the resource from the provided machine. | -| [`DoCommand`](/dev/reference/apis/services/motion/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetStatus`](/dev/reference/apis/services/motion/#getstatus) | Get the current status of the motion service as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/services/motion/#getresourcename) | Get the `ResourceName` for this instance of the motion service. | -| [`Close`](/dev/reference/apis/services/motion/#close) | Safely shut down the resource and prevent further use. | +| [`Move`](/reference/apis/services/motion/#move) | The `Move` method is the primary way to move multiple components, or to move any object to any other location. | +| [`MoveOnMap`](/reference/apis/services/motion/#moveonmap) | Move a base component to a destination pose on a SLAM map. | +| [`MoveOnGlobe`](/reference/apis/services/motion/#moveonglobe) | Move a base component to a destination GPS point, represented in geographic notation _(latitude, longitude)_. | +| [`GetPose`](/reference/apis/services/motion/#getpose) | `GetPose` gets the location and orientation of a component within the frame system. | +| [`StopPlan`](/reference/apis/services/motion/#stopplan) | Stop a base component being moved by an in progress `MoveOnGlobe` or `MoveOnMap` call. | +| [`ListPlanStatuses`](/reference/apis/services/motion/#listplanstatuses) | Returns the statuses of plans created by `MoveOnGlobe` or `MoveOnMap` calls that meet at least one of the following conditions since the motion service initialized: - the plan's status is in progress - the plan's status changed state within the last 24 hours All repeated fields are in chronological order. | +| [`GetPlan`](/reference/apis/services/motion/#getplan) | By default, returns the plan history of the most recent `MoveOnGlobe` or `MoveOnMap` call to move a base component. | +| [`Reconfigure`](/reference/apis/services/motion/#reconfigure) | Reconfigure this resource. | +| [`FromRobot`](/reference/apis/services/motion/#fromrobot) | Get the resource from the provided machine. | +| [`DoCommand`](/reference/apis/services/motion/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/reference/apis/services/motion/#getstatus) | Get the current status of the motion service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/services/motion/#getresourcename) | Get the `ResourceName` for this instance of the motion service. | +| [`Close`](/reference/apis/services/motion/#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 491568d031..c7b6c1853b 100644 --- a/static/include/services/apis/generated/slam-table.md +++ b/static/include/services/apis/generated/slam-table.md @@ -1,14 +1,14 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetPosition`](/dev/reference/apis/services/slam/#getposition) | Get the current position of the component the SLAM service is configured to source point cloud data from in the SLAM map as a `Pose`. | -| [`GetPointCloudMap`](/dev/reference/apis/services/slam/#getpointcloudmap) | Get the point cloud map. | -| [`GetInternalState`](/dev/reference/apis/services/slam/#getinternalstate) | Get the internal state of the SLAM algorithm required to continue mapping/localization. | -| [`GetProperties`](/dev/reference/apis/services/slam/#getproperties) | Get information about the current SLAM session. | -| [`InternalStateFull`](/dev/reference/apis/services/slam/#internalstatefull) | `InternalStateFull` concatenates the streaming responses from `InternalState` into the internal serialized state of the SLAM algorithm. | -| [`PointCloudMapFull`](/dev/reference/apis/services/slam/#pointcloudmapfull) | `PointCloudMapFull` concatenates the streaming responses from `PointCloudMap` into a full point cloud. | -| [`Reconfigure`](/dev/reference/apis/services/slam/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/services/slam/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetStatus`](/dev/reference/apis/services/slam/#getstatus) | Get the current status of the SLAM service as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/services/slam/#getresourcename) | Get the `ResourceName` for this instance of the SLAM service. | -| [`Close`](/dev/reference/apis/services/slam/#close) | Safely shut down the resource and prevent further use. | +| [`GetPosition`](/reference/apis/services/slam/#getposition) | Get the current position of the component the SLAM service is configured to source point cloud data from in the SLAM map as a `Pose`. | +| [`GetPointCloudMap`](/reference/apis/services/slam/#getpointcloudmap) | Get the point cloud map. | +| [`GetInternalState`](/reference/apis/services/slam/#getinternalstate) | Get the internal state of the SLAM algorithm required to continue mapping/localization. | +| [`GetProperties`](/reference/apis/services/slam/#getproperties) | Get information about the current SLAM session. | +| [`InternalStateFull`](/reference/apis/services/slam/#internalstatefull) | `InternalStateFull` concatenates the streaming responses from `InternalState` into the internal serialized state of the SLAM algorithm. | +| [`PointCloudMapFull`](/reference/apis/services/slam/#pointcloudmapfull) | `PointCloudMapFull` concatenates the streaming responses from `PointCloudMap` into a full point cloud. | +| [`Reconfigure`](/reference/apis/services/slam/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/services/slam/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/reference/apis/services/slam/#getstatus) | Get the current status of the SLAM service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/services/slam/#getresourcename) | Get the `ResourceName` for this instance of the SLAM service. | +| [`Close`](/reference/apis/services/slam/#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 4c644bcd84..ec06e20326 100644 --- a/static/include/services/apis/generated/vision-table.md +++ b/static/include/services/apis/generated/vision-table.md @@ -1,15 +1,15 @@ | Method Name | Description | | ----------- | ----------- | -| [`GetDetectionsFromCamera`](/dev/reference/apis/services/vision/#getdetectionsfromcamera) | Get a list of detections from the next image from a specified camera using a configured detector. | -| [`GetDetections`](/dev/reference/apis/services/vision/#getdetections) | Get a list of detections from a given image using a configured detector. | -| [`GetClassificationsFromCamera`](/dev/reference/apis/services/vision/#getclassificationsfromcamera) | Get a list of classifications from the next image from a specified camera using a configured classifier. | -| [`GetClassifications`](/dev/reference/apis/services/vision/#getclassifications) | Get a list of classifications from a given image using a configured classifier. | -| [`GetObjectPointClouds`](/dev/reference/apis/services/vision/#getobjectpointclouds) | Get a list of 3D point cloud objects and associated metadata in the latest picture from a 3D camera (using a specified segmenter). | -| [`CaptureAllFromCamera`](/dev/reference/apis/services/vision/#captureallfromcamera) | Get the next image, detections, classifications, and objects all together, given a camera name. | -| [`Reconfigure`](/dev/reference/apis/services/vision/#reconfigure) | Reconfigure this resource. | -| [`DoCommand`](/dev/reference/apis/services/vision/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetStatus`](/dev/reference/apis/services/vision/#getstatus) | Get the current status of the vision service as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/services/vision/#getresourcename) | Get the `ResourceName` for this instance of the vision service. | -| [`GetProperties`](/dev/reference/apis/services/vision/#getproperties) | Fetch information about which vision methods a given vision service supports. | -| [`Close`](/dev/reference/apis/services/vision/#close) | Safely shut down the resource and prevent further use. | +| [`GetDetectionsFromCamera`](/reference/apis/services/vision/#getdetectionsfromcamera) | Get a list of detections from the next image from a specified camera using a configured detector. | +| [`GetDetections`](/reference/apis/services/vision/#getdetections) | Get a list of detections from a given image using a configured detector. | +| [`GetClassificationsFromCamera`](/reference/apis/services/vision/#getclassificationsfromcamera) | Get a list of classifications from the next image from a specified camera using a configured classifier. | +| [`GetClassifications`](/reference/apis/services/vision/#getclassifications) | Get a list of classifications from a given image using a configured classifier. | +| [`GetObjectPointClouds`](/reference/apis/services/vision/#getobjectpointclouds) | Get a list of 3D point cloud objects and associated metadata in the latest picture from a 3D camera (using a specified segmenter). | +| [`CaptureAllFromCamera`](/reference/apis/services/vision/#captureallfromcamera) | Get the next image, detections, classifications, and objects all together, given a camera name. | +| [`Reconfigure`](/reference/apis/services/vision/#reconfigure) | Reconfigure this resource. | +| [`DoCommand`](/reference/apis/services/vision/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/reference/apis/services/vision/#getstatus) | Get the current status of the vision service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/services/vision/#getresourcename) | Get the `ResourceName` for this instance of the vision service. | +| [`GetProperties`](/reference/apis/services/vision/#getproperties) | Fetch information about which vision methods a given vision service supports. | +| [`Close`](/reference/apis/services/vision/#close) | Safely shut down the resource and prevent further use. | diff --git a/static/include/services/apis/generated/world_state_store-table.md b/static/include/services/apis/generated/world_state_store-table.md index 06234858ef..7a8da6c317 100644 --- a/static/include/services/apis/generated/world_state_store-table.md +++ b/static/include/services/apis/generated/world_state_store-table.md @@ -1,10 +1,10 @@ | Method Name | Description | | ----------- | ----------- | -| [`ListUUIDs`](/dev/reference/apis/services/world-state-store/#listuuids) | List all world state transform UUIDs. | -| [`GetTransform`](/dev/reference/apis/services/world-state-store/#gettransform) | Get a world state transform by UUID. | -| [`StreamTransformChanges`](/dev/reference/apis/services/world-state-store/#streamtransformchanges) | Stream changes to world state transforms. | -| [`DoCommand`](/dev/reference/apis/services/world-state-store/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | -| [`GetStatus`](/dev/reference/apis/services/world-state-store/#getstatus) | Get the current status of the world state store service as a map of key-value pairs describing its state. | -| [`GetResourceName`](/dev/reference/apis/services/world-state-store/#getresourcename) | Get the ResourceName for this Resource with the given name. | -| [`Close`](/dev/reference/apis/services/world-state-store/#close) | Safely shut down the resource and prevent further use. | +| [`ListUUIDs`](/reference/apis/services/world-state-store/#listuuids) | List all world state transform UUIDs. | +| [`GetTransform`](/reference/apis/services/world-state-store/#gettransform) | Get a world state transform by UUID. | +| [`StreamTransformChanges`](/reference/apis/services/world-state-store/#streamtransformchanges) | Stream changes to world state transforms. | +| [`DoCommand`](/reference/apis/services/world-state-store/#docommand) | Execute model-specific commands that are not otherwise defined by the service API. | +| [`GetStatus`](/reference/apis/services/world-state-store/#getstatus) | Get the current status of the world state store service as a map of key-value pairs describing its state. | +| [`GetResourceName`](/reference/apis/services/world-state-store/#getresourcename) | Get the ResourceName for this Resource with the given name. | +| [`Close`](/reference/apis/services/world-state-store/#close) | Safely shut down the resource and prevent further use. | From e43cd57624769c64f9a8fe484e88af98799d0c8c Mon Sep 17 00:00:00 2001 From: Brandon Shrewsbury Date: Mon, 20 Jul 2026 14:15:25 -0600 Subject: [PATCH 4/4] Add the Go Status tab to every GetStatus section Naveed is right that Go has per-resource Status: resource.Named carries Status(ctx) with a default implementation, so every component and service exposes it. The Go parser hand-injects the inherited resource.Resource methods (Reconfigure, DoCommand, Close, Name) and Status was missing from that injection; add it, mirroring DoCommand, including the generic_component/generic_service workaround branch. Fill the GO METHOD column with Status on all GetStatus rows except world_state_store, which the Go parser skips entirely (its page has no Go tabs for any method; pre-existing gap). Regenerated the affected component and service pages: each GetStatus section gains a Go tab linking to pkg.go.dev/go.viam.com/rdk/resource#Resource, matching how DoCommand renders. --- .../__pycache__/parse_flutter.cpython-314.pyc | Bin 0 -> 7872 bytes .../__pycache__/parse_go.cpython-314.pyc | Bin 0 -> 36383 bytes .../__pycache__/parse_python.cpython-314.pyc | Bin 0 -> 24587 bytes .../parse_typescript.cpython-314.pyc | Bin 0 -> 9577 bytes .../__pycache__/parser_utils.cpython-314.pyc | Bin 0 -> 3353 bytes .github/workflows/parse_go.py | 20 +++++++ .github/workflows/sdk_protos_map.csv | 50 +++++++++--------- .../include/components/apis/generated/arm.md | 22 ++++++++ .../components/apis/generated/audio_in.md | 22 ++++++++ .../components/apis/generated/audio_out.md | 22 ++++++++ .../include/components/apis/generated/base.md | 22 ++++++++ .../components/apis/generated/board.md | 22 ++++++++ .../components/apis/generated/button.md | 22 ++++++++ .../components/apis/generated/camera.md | 22 ++++++++ .../components/apis/generated/encoder.md | 22 ++++++++ .../components/apis/generated/gantry.md | 22 ++++++++ .../apis/generated/generic_component.md | 22 ++++++++ .../components/apis/generated/gripper.md | 22 ++++++++ .../apis/generated/input_controller.md | 22 ++++++++ .../components/apis/generated/motor.md | 22 ++++++++ .../apis/generated/movement_sensor.md | 22 ++++++++ .../components/apis/generated/power_sensor.md | 22 ++++++++ .../components/apis/generated/sensor.md | 22 ++++++++ .../components/apis/generated/servo.md | 22 ++++++++ .../components/apis/generated/switch.md | 22 ++++++++ .../services/apis/generated/data_manager.md | 22 ++++++++ .../services/apis/generated/discovery.md | 22 ++++++++ .../apis/generated/generic_service.md | 22 ++++++++ .../services/apis/generated/mlmodel.md | 22 ++++++++ .../include/services/apis/generated/motion.md | 22 ++++++++ .../include/services/apis/generated/slam.md | 22 ++++++++ .../include/services/apis/generated/vision.md | 24 ++++++++- 32 files changed, 596 insertions(+), 26 deletions(-) create mode 100644 .github/workflows/__pycache__/parse_flutter.cpython-314.pyc create mode 100644 .github/workflows/__pycache__/parse_go.cpython-314.pyc create mode 100644 .github/workflows/__pycache__/parse_python.cpython-314.pyc create mode 100644 .github/workflows/__pycache__/parse_typescript.cpython-314.pyc create mode 100644 .github/workflows/__pycache__/parser_utils.cpython-314.pyc diff --git a/.github/workflows/__pycache__/parse_flutter.cpython-314.pyc b/.github/workflows/__pycache__/parse_flutter.cpython-314.pyc new file mode 100644 index 0000000000000000000000000000000000000000..e97a8b1bf49ff500df9f69e6a4fca2c6ee4305ff GIT binary patch literal 7872 zcmc&ZYfKy2dT0CqW1Cla8Emk@#EuEr2_b~=N|tAUz_LSj*zFQ#2YWD1Y>zWDCL8wN zY<{&=x|P!Q$7XeZEOb?c)vZ*w>Q#{{Ra;fPH&Uf)W`VVLx>t+3l~(O9auX?6{nhV` zJ;q_p)%I7NaOTYU9_M?V^L^*c`HFHgf}i}+@}1odgucTs+Rv8jyx^hp2rVO$m_j!Q zk#OR^Zc2AUC+eMu)RP9%NS2VLq=_se&7_62lI3ItSxHur)$n%){%XitvW~1L8%SHg zDjNKVbi7H3#sCsa>QE~p8ygVW)T7JJD3+3TH}W2-N?DA#%hCduOu&mJ#_)GT z-2HfD^?_0yX5%a$3DQ9>mf+%STvSRYvqMUy1`}9*JrZP<+8ksd`#u_tVEoD$x6a0( zM+Q2oWx>SSj_H<7ni$6;4zvB!1+^3?W8j z6!RFgxsg&lBCw)ThC8(IARdHnLdszJNLA4ezEG>(F_G7OUcUAc-gxC$v{e=goCPl?XY| zqARY+1z_NQh9%VML#>Loxu*S3Zg#Z>J5aNPD*L{w^EAlKW1j4Kcgkn+% z_`?x#Ex8iFu+=CB_z7%ZT2mqMKrzwa^oU5)O8rEk3;f!6JIpKeK=TM?S~~Yl_DsXY zO~cQu-&!#r=lj8-@p8;1j> zpU*q|81MCvSu$!6Qb!rBs9V>Q3oj>{89|6LE|q8)Drcw48O@ut(c`BTHm_rB%2+5J zzzp4nM9HiRbUB5VGR|9$xoJJ@3jEVJfQBI9xFK`}OR`j+g@U9dn&gR6s#Mc5T&-dq zYiXoPPH6edB3i1;=`>w9=WNyQmz8r;rSrh!d7Bz(I}Q*i%-hZ_YOii>bpOJnkbBJ%1m1E>YLd_s0_6r zNZ9bN2V}uNCjy_gX8VP0HmP69tRu|4Pf3^t58SopP`ovH3TB2g{zsVYm zP_R-eG#ex;sY=cAVTdVMPlYR`0@hq@w_d|`qH$to5o}XgR2y87RB75Is;DZBa|mc) zH>#RHcS1;b&EvpMb{ft+lu{>uVDSd56>u#KhaB1uxE8@Vg{w{FT3KxM;<8G!MWT8s zpvgp4Yop7k?>_9l-(y{1*EW+)m>X$NoS~|h(QCfEs8Jt3$vTZsqK2x;>!A9DbSz!c zFsT|1?|3bf&3F!2jZa}U*1|qgN7WYfQU%#^?4@EhNYoe1bQ%xmF%M0aqS5IhTl10F zuyi@EK?B+5CrGyzEk$YD$+LM{8)c*FNRR59Gtl#@y*g~+LaS2s>UeE2y^8Lc=QQax zYv*==zXY#=MQ1+Gu4jn&BD*>1D~N~2f_P}uxaQ*FAM^3hp~}|?e)?PRQxo{fUSRDe zjV|FRu$ANgXsc$bxu`u0d{GpBp6t}@T@>C$`ZYLZCj+V`O{c`zh2!|pEE~#J4nKmT znD-JbvsS99IE1o89CW-E2Q65-nZL_=Z*i-5z4aQ!iEM!B$MrM+mgO*Rn0W?!4M7rW zmVo-s0Tsv$RA_=_6d`=wO3ex! zVQ8L>aUu(6u(-%`QAN)r5*z-p@sYPD`&|onBZ&kQ)UIS)NG1{-FR~$5u8wu_EF9|i zAlvWSFsp?!4K;aS!_pOuGJ@b=6JybhnjE7!&V^5au2qhA1#=ajx;k;~imQtkzk+6v zcyvnbNus_R2n`T<@6KS&Ak(4wT-H;$Q9+1PlNYIe3(&mAyLsqLW)r}g<=Xa(I~SLW$`&A&cs+n4~GcFw8jWDBZ|CFr|9A2 zqEu-I6V0>&PS&1B{8@M?roku^TM044%GuYC66&GDKN#g;8eteZS+r#!5*TQH_Xut2 zpPIH!J7coz!Yib2y>f(`jKlfqzvXfkPF- zK+g}t1U$~$N*VYF{0=AZ&vmL9_-+{foZxZED&Pg-QJu{9LYKb+&7WZaMtX#H^nY#o z+?1M-&-K4Tgl~j6QrnEn{j_wubf z%9>6JOqf+noazH6st_OkzuVr-vtp8uV^#TaY~BfM+F~~Uhf{4ns@i;%c+KWZsX5s- zf^9yUvw2B&sttRH;l-{X$FqTnBuvg0?uiZ+$lyDpBG3ZT1-NfuVyBV*0IFECvuAy< zQK9-a?{J@$$91hz%Es}+;FYRKJdqT&eLo5#R`o6`#>ByeyiyvA#sD#@lt6yK3(6d4 z)+1pxPGCL5CZm)H_akC(jX$q4UWr6u{e~5DEGqI0+VKimh-0i}!;F zT-!CB+~{b0Z^lPp{qinMU=A{gh{!}E8!V64n_^mx#6vV}qw2y@Ol&-aCto|h%!!2K zU~d}e1jWE5*m(A`r-WBS819Kg@JW`&C?uj0Q88ei3c)C)Je!CzL6*lSIE6?k29f9^YaaaCSV_CA*yoG|${ucL=3QT#E>~+blX13Bm zyPnOVMvx1_u%<`?#mPxe{M3uzI#WkgXRED;xGJFJx*OJ|6sd@bTa`wT+Tv`dQzz4yozw{aWhl zDqE(yaliS>e)W}1WAmrZPn?p?x6`!WGxzL+gPwP!OYchWhNOD-PxVJ8)YOtkNZm;H zOv*izdp%RqrRitqrF!bI{>Y4~YzLJ+|JmT$s`>MWj}6~8*wq;WDg91TYP!5%+xvB` z_ab0P)plZd%Eqi+;%x7q?-r!n+JC9{k!+vmLAFnZ^zR++jl;TZs`x9`*8bVDhQ(N zd;2r(-luchbE&@F;4g>M?IZi`BY0?Pduk{6*<9-4LHp%h`&aE_nd_s!F8imlXYPNl zcy{mL`ddBwq zvS(3xXGvOKNiW}#m+$O(?mn?(`p0*gW!sgPCgi=4vg~;VpIE+ic6{S#mD;cDT2eoi z#%@b(%li&makPUPf&R3ASoRO^K9CkxB>(W9KPcJGe{c6^oZV?>5B!&$J(;Pc^whFE zwVa*`%2PqfbwRo~F1sdFoZhsvS911dM&3@3yep5qn;uz~N0tF6)hxTN9r}9Gz9HE+ z^jt?Yj}R~Px{gueNySSuayXwn+_U>rt^4*%Ajt4_LUMHOEXj`kLvQDk8!*(~ooYRB z_oUq;vU}u_Pw2YundSz0%mNt!rub+h4lh&U6p{ec*2bUwEX2U@EZJ9ZGjc zZNPd#=gnK8VtzPBcs0CepS}+19yp>%i8X>N~Iv?!LEg zn|gUy4{Q7gKH8kAe^U2x^M6#;J|8#2{&sZ3h^lJSm2SDxEt%Y}-ovX37P8bl@IM0n zfbuWij)nfRU)9@j+uH=~uj`!9?)6)4S;~DzHRr3@m&ZG^npOE$==q2_p9y~w!6^ei ziI`~`N{nO__pLO2FUdr6kV+ap^FZc?f`W~6G|l4!GXKZWD0MWAKfl0dLwt0KtRzKN z0Qzd0R*w}pe+1cRl%}D4EiV`ZGF`H!7+9v8NSJd)lXJu*!amYu$5KKS3I2*;rOFgLOeb(^Bit& zm!{JQEE@MW0``&x*x#ymH&bhC1n>Bm)WKr*Hl592GubRQ8{#?a9(FIA%jU8B*!}DQ zeWp*XquAOZ+NXiA4#G4xpFPMPVhh+pwun8<9$|~wqwF!Zgw?Xg*;2NQEoUp(6YNR0 zlC9Eb`_d0m$0@eDfMRPJ8Hp-i21}PwRk|Nxbg+sRGo9u+&g6CbJ>tF@&c*R|i^<}4 zdfYC~CCS?#z5hzje;}A^y?GB&aRfYhf%I@+7j%@=4`C_`w;WqouHU>(! z0hD2Y_fBYeN}MF8te50x@(sEL&f;_Pfzv6l&e(mk{%IZbwtmL#FuP{-Gn`w`HDxd=Z%3dj6*jld>2}Syt8jk0I584#y zl(rBEi=-#gQ&t-4<5LhfgECKnBD0i_xjF4q9irS6C^1t&IcT4nRTWS^4XgI087W^n zQL;2KquXsT^B}#07F8TxL<{kZj~C$Ob!t4%70qNRBjuu%sF67-zglxCs+bzrx)hSY zssLmZ>%d-8GM3B4=jsuwTEWVyzyhd$x_>h(M!N>9G~!+l@AkPty*wtH-NA|JUhAC6 z&pX5{uZ1^zIP#wE^_gctI>f9Q0OfqMZmYLSC91ug!^R(ns>HpJAp>CvFVcGA#0jxS zKkIgKdhaaH-SO%d>}IFl>b7|6?zs6mAJ1`K5JMjn^!dGdog_GV%md*Ecn|W^1ghv+ z6f;bq=XRgTB<@ofty7XLP@A^_9YbX^WU?JApZ5C$dQsaI)1r- zMpfgCu7l~~RKp1Xo+D@y0szNA{PN>@dY9+=`rS7+QPF;XLu@)e{t@}A1-l!tIu3|IJ-=V0^1J-3i zi;B&Z<4bZpU5-D-_++NiHxp__3OpL4M$!41g9IujFVxa+KIQa((L4G%>c#asL z|B`>~-Y9NpS@Ms~RdPKUY@RU#ge>~=WEwLkm3b9KGy%9$O!dt|yVFy)Tbe`BZ2mdf zCPK?qT|sDhmY(ut8?y{WQS{Ll_F$BToR>iuKwFc4>>;K6O*)<%?pm+{hvHi_QX3!h z>@n_1*}fYTHF;F21@!)y@*WG>0%dM@kv7qO#;-C_N}qW48u#W=T`q$`a6$qIlYq%g;#Vn@RapJStL3+*HT&XrvakSS}6ihT69;oxovZ zHhUO#ua`?jk4~PP?M!f!wqp3QAvYYa^c;LCJgn-B z2Nifj-DaF@EnBCw#;^_jhV6Rt&`asiv3g@Xlr9A&r_RZ<72rla84)Q1&YY8e3XxVA zwO|yC>6V%;jOTCS7@+iADjuYs5wWKgz5qQ9NYB6lqV{HS?Ho|m2L!re} zFo{!4@-r4FsW)jdA32AuGZrLC*ck;r7QST6eMz4K&1Xp4I=7(Zn=qF-`{mLyzVh-p zR^r@rq!!!Isp?yo?e|$2*Hg?uaO|G}DJ!Nr)qOKCN^CV3K6je&6vk#)#^^ZbDKZu* z5}0C!RR}Yz^P6T^>b~EhDE7kEG<9ZJ|2Y!lI)qLlNRmbm%cVdG(?CDt+0!-v0cY1=_-;w`u&tH7npz@;m|rPdvD>GC#Q zYD>+fPTKkw;S;kGd>0~9*30eijO7b zbtmTS8a+J;ct3mZUEbV#FayjW+yl!E65qQ62~UA_V2$0)ez=;@Zq;Y%!|nR1FA48% z$xVL(-ree_fw+De+?{>`-5mnmHGu98?^t(PqPvO~M!r}rjO{t3TJw!Jq}1c>WMCwr zuXfLNj3(gy>@vWSub;*f@a|SW#p~+C?(`Gr>NU{S>!7PQ zcC4${wi#z9w;X5xZ^AhH-G5{nK9$hJyC*p}6Yzd^$+@;!!#nALUKo*0#L~lb5Ju!% zJCL5#n2Q0knP3JX0L;_7gL&Wu;I+izweAw${{VQoIJ~x9!u$A(oSVeU#I|$9nRv)u zoU_g*;N2Ce1j}Ow%X1qn&)kkJk9`}<ve4F(fZ1^H@DF9r$w_`3XZo{S5{?T!1F$I_IZ!2%G|3h{K9{?vG0w-SwPJV4i z^7b>^aPnuj;NKu9dYy5x8de*q~>OnhChLGi7#B|b|9O-zL}?; z`})9>6;I4zM>Nn{*Z&JK1~%Dx>tI@|^k2Xzszy?PGsS$^G1PlT%yvw?8)? za@v~u6qWs*I0-7=kp%rNk)Yq*0hPa-LV}9FA`+BHTe1Yb0+ossr1X6F;v^`MZb^dP z`rLg(B&ajL?+@TqIKL14>A*gbQ>Pj5nu9qF`qqKJ5Ll}YjPFQ}$O$5h771sO?3rEN z>sd-z;iwFkHtVl)&KM8LektdHdd&{{N#R<;{?1o~YhTp9ZNl!!j<`nlvOv}n&d$Cf zT>Dbavv$Na>6}p3b!$JFD?izZ%qG}<;xEJg-VX4jI1B4M)b}aap+kK?1sf&%BFi(u zfN&PWnP==D#>#j~j3tWK3ixAOB-XsdaCx&` zWTSI5kCy$8p>;EaQJY7N9rrUj%FlFxcdO^P@wlOVGn`^!4V_!(4KjUY(oERTc%t5s z;NMu1l7mq{X-}!KRB4YD{EHJj+M<4xo-$)u%C+hr#r#N8=KoeKpWuL2CjZz!RwN}# z2h8bVj4Wfno6tW+Rg*gQ#M-WsT@cLuhq%{HTtgN+o;M@wT0a7Vc%iD zr}(gXs&~N?dk9*&BTsDhPY8d(Zxp=VVO{Yu?`Thru_nKm4Q z?~;6{*~25XY`w9Ptv2pw8;r;FYVe=0j>=jd>5b}CRz&elG*-Qet^LfmE~;=HFj70& zqX+@H86bHFGJQW!QLp5OSQW1$vL7PT_ic$6oke~BOg#6c8(BE=Vb(FG$XMPD-DbI2HOG@;wO7K;GChmi4PYx?yqJry?Ubx1`1rChN z**zY(cco=HxU|VzxF)Tb8NIL>*ax@jbav@#8&Mv(N5!)mb@6=E=LL_APq2KsMZs zB*zx6IDj_Is z2^?)kCJkCZxJcH7VN}c1S--<$C?6%BxEFZ zsZ`D{ZE5-u_RQd5AX6@_s}3-FJ={j-;F_e}gJKXUNnKV~t<*?o1{ke2kgEq(y|QrQ zRNaM1-Bh(cpuq$^^1|i-ArLiwFWz<5LX~2+)J~Jb?wU)`N|axsm46N|&GaklC5#5L zc7gp${uwmMDPVJ>x*DfRFnihtOL{6SY{K}h=s)NdBhsEgmX^C~c6uCKQ&yFlKMx3a zm@QH~TrC1!;9ORsCjgskaa+Ma5?B-HOq4^YV_t02iPwn+@i@!mufXGn@XtF1kDt6w ztqz5o4Z&uEFghM=9{-eLE?MXo-2klT0WMm_04h+m&OpS+2?lJ!GbszwPu$UbXMze zfThxDdu;${_i8O>m&@(bPIKBBKiD-eWt_DZak#WZGPQ1-w$*XRyy#^)yiaY_!ay<# zSF-JhG)9Pd+QDf7pNHd}cCXhCQC;9~WBFXA#dlZRY}Uf>16&T%C#=ePX(^2MnLLm(V6mIl@!(!Krz{e>XUF7Z$=dX$SKn8a$v! zF*d=>FpxLFIGB&3!Gjp2q$imj?sl-gAb^3&=&KgK6=C)2L2@~`-|y9$`Dwe4H}i|c z@aqCUibC$DJEV)8e)5{&%q1>?3P7$kTAzTY4iMutPdFfzAMFy!C?9fgzxgK;j3v?-8Ts|7XF zHeJ#Nj_A60x6{D87wlG!2cBDI?JllXTk2di1x8D&va)cTMpFjR*dtPR#dp=cQt0H; zCT*#Y^ZH7mD9#n?A>quaQ}?sLGWs39Xob$jK(#K)k4mrEwUR~giBz(JP zFTY5uC#K0@G0w=aF~ za|`&UYU3qz+sZ{vyTk3}0>4QDX-?@i+c=mudT0GUt<`z~19}i+EMvxDnPqG^ zEX%SV^J)I%Qkg9C5ir@YwqWaGT)17F)%>I4jmBFWQ& zguLy^!4LWb=5WZ58WW7jUlH4;euPrKJf^fC<`|f~ZH;1<%e-KpA;KK6!!!k=(W+xv z+tds|N$r)eY+r4<)8T~Gu_NFHX!$)_uN>c|Qm4a2ipMoIhG*NF19|b(5)sj&b=yu# zMD-x7*aJsl>?39b*YC+=n=Zg2P-Wa=?By%2D+{M|=P&3^!8$@(@s=Tu(iVK;9RABz z;5}IJt4^ysKz~2pdcDO-`b&Zb^Z>?&nOms8!!WxB{gs0UbQDt3-wd6^$gF@jL35(w z@x|z+QmJv5wNJr2x~s~iV7(p_`zU`tulgvsvr#XUNZhtgtHtMsof%%t==Bc3QU|`p zcUF0e&Ia$y!pGNOz)YC`!43<2h7pemU>gQDZUVoll-tdLv2ydsh#x#GZNVq1)hn%Q zKiiIp!jmssWA`Zxd{wQzvAx#XC9NgF19})^V~iEGc8sy3*2=*HItnQ*hSeiJwva(RyRiSV!`+e10`vcSDz%3&@)c)N)6l29 z1NT7ipd*kM+kqXKg%2ZI#XT@`b#w4}L-=wg=MB6YdyncXc8$^|fm8^d~``YjH!?>{+V__r>9XZBqw)ITOpl9rD;GXo8c(f(DDo;Z7xe98&uH$K>EcA9;&WisK5r7bt6 z;?i|W`m0-}lwVCvI$w>>C}a`Hit+8swowOSRllm0a&B*><|Hdcf(P^n#>Qb$09I<8 znL{fj2M_2dq-3Qu&c#;V8BjYH@7;%!y+xB5VvuNps0!cXbw~Pea5m@;%bBe(YIy^F z%A2e=WP+{rdN_;SX16HPOU@WUc%|^L=gSt@eM-fzDz10Y0K20GxG0m@FYlt)$2oPq_=)OH7alQ5mbef0gux=% zE#AQS*n5H{hLdL*1cp#pCT%u_6jT{2{FRZQ*hrde3Sk6*&tX`nV1$OX!fS7!$v2F*^{e`c(z(XHn4nil8MBjJ_-6c<#61<&}@; z&P7khv3$~RTi+MOLq+wOJyg_u160JL_ahJ9dX%`2d}kY0;C}0X+0*5BIG)J|>v%j! z95cho-AmnT#kE3x zzi?_GSUdoS=23u+V*N_PyXW3H_ipn$&B5Z!a8wR?WZ2+eM>5C>WmYqKXxRKNi#CuZ zxoZU4UO@`sW83&Cd9NO~^ri2L$G7*NOi%WrH<8Qi!2Mbddy@Ye@@~tHdyE48GYCR_ zbbb!rcEHa~wFYXUtKpX)Yz01uZpJ5X0lvJj3;};gfOIf!NbU9+pS+JR)As6zHGyB+ z-F9u-pid%f+dcZgp*YtOaQ0K2Mp8@upMo5`vJGqBu?+)9&E53h!|&I}Y+Il((f1A~ zeFNl+^no;DKq`5#zT4==e*)d`4iio!ILk4|o4}?WZ%TBQ>lSKzf`vU`(&X&T&T<)R zg%`lA9dD8*!?Zb&pGcy#37MQ~xAucem#9YH7pZx~YSY?)hFHUZhBT+?N9d9@I4IJU zB3;!5PGYbQg_WKc)^#GCRmJf5aaQ)q6~u$^S$<{BVuD=*o`=I1 zFJA^AJPu7_h7G*&Ot7gSs_~5s2;i9LaoBy}amIPY9Q!(XWoGiErSiMU*9qzW@R7r1YN$0jH4k8gvAw4{|9(h^34tagh}Oan(Z6L?7OlL|?7NqA_RsN&ss5(@zl^_x;oi~Hq*abAo30M-azYs3?h zP@gA55nnHovM)L1w0Hpc7U$~bC2$}tlCYD%8nGuDLniUpv7%xR{@D-4ONk{jo73k+Hi^W$1%;v8gm40<2m#B`8d;wYFUHE7o7 zbcosDO3S&R1%CWc;u|dPi#9}2p(rQgSOALYzGDK{J*Sty z22^_M-~oRFL;I?~E0W`{hIsjkdlS8WJ&5sP3Grc!XiMKv|7z|p<~~*jGmieS@WdNE z8@UC-5#4&O?!&x;LSfBv&vKJ+=iKj=O9Q}w<9X$K7 zN?m&H(cVw?QZ*NZ{1cFQ;(WNGIatxWI<{8P9cV?-!lYFg;DoZ4aGC9K`-=?f)M=r(cB7*5>G+fJ<C~%UkX-VTD7cIw>_^9Rd+t_19bHlRvZ3o@AD&}Q~g45U8Jn>&-Z>%*7XTAp?bMo zF5wMVw69mRKcD}5{i$VDM1T722hSd?TEhCab$wf;R{!?kv%%H#&nKSiUp3S|6&t^!&&Nwf&KvzW*O>x4_P2Y5@rh8+HKDe7b$qS1^P^1aRQ;za z>O=?q$swxo!n+s0cX9R3dxt`ohX6Wsd2D_Bx^Tm}Htt$$a0{OKPy-)sco=MW2pnr= zI*?d7reeugCDW9 z6X15l(!q?8GDd>MLNY9vVP%{o!$mUuB*RZq?jZV&Gv@^DY3!|&PtQL&zudKYVd;Fh ztn>Y{&QG$UHBSiFZ?84X2@Y2n8rI-mPXFQAi|@{TZ|-@mU>FY@tU-fS;OuLL+iPb5 z${9NA3ZL}{&-&NS-dWC$Tmtq?g)U9KU)l6gI@Rc*L9W~BF&gS$IU3YnhE4=#UijVx z;S#jbB5?k-h6Tv{5K?=;*SmWAy;5QD=31jE+&B|#oDpUnf{R~k^oAP)!N$N^<7>c- zGacA8cmglabV1YV0qdnU`Y(I`ZLiP;4KNE9-zO-!ZODoHbT7hV0Ew5bA}>}7g4zop zo8^^Ho1Zo>HGkOE`(Bw~82Qgtg3%hfYF+E%!d=c_mlJ9ayY2^F_kq7xm{F{yQ*=d8ehhEH;U^}@-f zwX%z=^Xp|-p#E<9IxSqk5$c)@ciDnnHetrG*5wR$@xd-W+!Y9R1%!JjQf*9^RCRZ> z>K|5A3RTT(6_=jV>lLlQ=AGg~igPFfeT#mY`y_Wo9nzjznGI<#KhIv*_J8DLsPY;5 z1v*sEkf^YVa_Yu_6aBa>)HiTTM6yfo)OMp4WAzho*xR83`N*$!j0KTc|EkWaY_{_ zuYnicJ$R`X8tiaogQe%_C3O;cdxF|QK&5XE>pFtE4(Q@8aMgtl(mR=@>>rfrB37cA zRz7TfEoglWa6X{h5rCsRP%t=2FfbsoVH6WiI^<#*BdXK{Gbt6AVwO6d4m}xK=?Ily zSgj0|w?7{Um9xUgtzfx1Vi*^$SqZgMGV#~cQQ{4$h|dmc`;&>kO^Bb9h+n!GIa#xO zZ~bIb#CBV7`oqq9LFc_S=Y1g6MRy^o7yymk%vB8fnL#Y?qKBCO3D*}PfW%>-pTs6H zW&;0a5}U!;ZKhjAV%;i;T~)DCjK$cP%B3cGE;YpF)r)GVc3%BZ4b@@*70s(#H6*cD zLlS#6h($Ai!H{NHLqJ#!!NOwVn5Hd_#M;u9)oG z2-+S1tydT_PIWTf$hR4~2l;jj0?6wFy&^Fq8slpW8LO^IY{vjVyv#i;ca7;np5CIn zkf*&Wn-sHQ%&wZ3V)GdDsRmG3Z_xuNtOoT23adeV6NME6KxRVx1AH92Qtp zu=3VVHg?3UYZ9}rAzvn?bN5NF=wv(?@Qe?6Hp%#<0)9-q%Zy1}8bdBksBTHI zTNtybu1KxDf~{>=_aS@Q)x*dh3;B3A zAGY5K+V8B{7l8q{={D4V43H}@=t9r~_7%$ChIueZgaraf9Arq>Sm%pH15ONp zh^y-BQsT6fIE|1NwGD$=^=%1cPQo&Wi7xdZ_KAfa)NGQ@^iZWi7{0kyY1%-e+rM7Z z54|!&`&63@M|Y?e?eki#B~o{0_1Jn{H-Q}A67qcsvUt6&lR%EW46Hr5N!&A7Y4`$ry|Sq`>vf3xunoaul#&`OQd7k(C9)%^2Z3Q{>3htYE(#nwkqw z`GZq_Vd37|6iUQRX$-@F#I7RIHzl?0W8_r<*+IBT8#fc(6)Nw0Zy;EH9l75iob3sp z9SEKs2$c*(hGA)Km&aqLG9L5NLT3h6X~VRA^C~STs2xb|fH`ED-XV8@#U;2sA-v0+G49JCM2GyBOJ3soSb^*2`~wG?orKurIEsQ~AY@7eWUrV0WnT{JWRl zx%3gk6kWmHp~hBP$UpTWi|VHb=|>&k8v4f2Qb#DiYPm9$-yk%02lIO(qcbToLis)K z6$JB#Bi9#%J9k6Z7sJ=@2e0D}!3{}iFaR;?W%^M+Zh+T4$s=2mH{fdP7C4Uv^T$6N zh3#*j;9m$$+zC(I3r^fy8%6Un29^Zm6a&EA$BZN9F?s?qkAdqx$s->8Hdx$|Joi@h zAnh>cy8%PeHkAA`!-y0po&6Gqt>=&bxSoOy|7L3cVd3bh^?j#SdW0*(p~m5j%dH8g z4xv2#N_H@>IdY}@y(45)RR$+z_X-kM8dod-Qul9kYfV?fO>D3Uw!FZ&TwiOt5o)*r z5@4eHagx#4kK!-{;sA0m#7vk|g=h01VHdPsL; z(;k8j0j(GStq-NmwsJD6vdlDcqI?=T!NFcUfOCu&!7%`E4i<(a@xGLJA0Zzwt;maZ zRVNN6oV4pvE^m5_BD2b22+CAn98+y-Sz0jf9JH*ZlYTx&TH}S50kUKLs$Fj!SuT~! ztEB~Ohl_a)+kpX4?t_7DQ;J1!`xW%E`RpD?S04E-(F$bH#P?uhW1GOxwr0!8y1Z@g!RKgJq+q&YkH$lSR1K3_4dTGiQog=lVZ5 zHwekWv!1oOd7-cxaF?A9m!1ulo?Y>;m0o(B{(~c>Kdh=<9{*19lU?e^*=oQ7(0=lYX(EDz8}{{`SRN7k#V!LVa(z z-Vm%etkttiS2t?TyxG4|QwNVaJ+u~j;Bn4Iq!l%SYC#`r*72 zPJ|90du$CKs}CNlUug&zom($Dw_5-AW#y0CBV{L^wmfNBDGQgKg>B4L?{n+FyBBvp zxReWiWL=G7bP`MsZvGa!N= z&1X?XCtqCML*?cF>cd}rC}bS_v@aXaE8$>NsA&H`Kkmq+&dt-G8fhRH+W%AUC>+H9 z^})lfv+3D?-FO6pzsV=DziBAJ*!NADCtGKa z=u!f)T$9NL*Zzs`j>~N_@$e;4iWlG^9yF0}%h@d^{NR>-+7F+?fD-#mCi1Z>bThGV z;ErJe7o$CKiBJqYrYOldfyci|Paf0o;ynb9pZo&&lzqZvX^wt+cs5N_@`A#rx?I}` zfWpn1q*McZ83alzsW}pke)kMwEC;tdLiqwW3Lp2vPnopYUGPnt4!A|!w%BENfQL|^ z1fg23Rshyvy}+TA}Ff3PwqDS{0tD?=DsWL2LhB2=Ngod}VMz`e=^iOe!9PzLCLzC-9XlyiVm64`Y|bLC57)Wr_^X@o$1ci#fzW zi8uLuc88a^5%P~9o&ODd{2@Z@1LrW1GBY}7k}ubJiOqN>`ysuV^uP2uCBi2Bgu^oaVPP;fG$-v4L-ULP$+)J5RtBggkX%8aOU zA02*iAghQGsDnQ~mbagIeeaLUOAbMF{|f_6Y4!@aH4$~DkX;c`X9+oV2)PXr zb+)hvQgVfToe_18u(v*<&J*_cN7RMF;c1eqe^HQg5RmQr^w>fgUGg!7Ph#Z$A3AQp AI{*Lx literal 0 HcmV?d00001 diff --git a/.github/workflows/__pycache__/parse_python.cpython-314.pyc b/.github/workflows/__pycache__/parse_python.cpython-314.pyc new file mode 100644 index 0000000000000000000000000000000000000000..7c35924038776f8bb78957420c5792fe36209ce8 GIT binary patch literal 24587 zcmdsfZBScDw%EN_;v4f}8v_O#fowoF2n-ku=EHo0L4YqHu)&svbOC|B=3en7e~k0q zChM2oSMg+DGM*$=i}zJx=A}}@rc!U&df6=b=S@<{l_f^XeUq#!Z&F+Pk6BM@Ci~-U z&grWw2@p1(-ASb)o9=tM`Uku z;SqI*V(EU$Lqp8;Gkq$LstD6m{pvooC!vU9)ocQr$R@GL5T~%IY#N)+9%D1eb0)x9 z@R!XVuS)eK>M6Es#bj|g+%6~Q z^hinJBq_`0bT4@z$LZl+c00#Q2_!|zRFDLYU$$8|No_TI%u*VLCX3yMR8(fSTS|pM zNl2Qp+3hyxoRkrMh-4s|z!BGhw-rFxa79dEUI{?NzvwbFq7&yP;#vGj^_u=Vmz`d$THxMrg++ zRJ?36JM?be<#FjjE%n3voY`sfnmsm`)4(}qINm#@)D_kxf??&BtISItm)UKr!h|Y9 zq6$b<*_>8xRaULH6Ms|v{mx~Zhx?Z54->B;EJlX8pf~dl{eaEMIY0y!p~q(DdR#mJ zdZXFC#Erq|@Xj4cAW@oCK=Xi9qS=R5=`A44fil_5`emDybLof70QEb}bDVeLNL&zP z=pjHpz``MfOJaHrxO9N|U^xNIpuib8j~Nu!>|Hrhjb_e{+JPN1MZ zT-EZW@Dmn1SaI!M=49in2VHkrIbJ{F5^Sis*iA7V_PuxERwh{$CW(xPAK%3JK0crk zF-UvZ^7ii6IEQPQbHL`kY7K<&z?!k96hF?r4DJ6|`EzPQPDSL91QWmA~7U4oY zof5%NE2(#=D}M&OKSSO}X*Xk3XHh**DaxHNO}s|L7)e*~qA~bb3C4t24xznad6tEX z&GAGcZ=qvMVBbb(Xs=|A2@3Z|mn`slG|48$v^yi(UgfEnnlKufy09*|nE{a1z(1j= z6zVKx1bw+O3DShzLeL*Aq=4Ud6$E$66SesMUZE2^c5>tT>PSk=QyEij`M&k;aL)@^m8`P z{L)Mn=7H-5<=tjp;7nm(z`Z7=G^5|U>gHRe67XafO_6#9eY4$VG24Y!eWc77@E{aG z@b#~ukz$F(SJS&uE3z}bftlyEKdSZD^!{%l8S?))`853`^)&5Gn`*DTWv=vAS2o_( zB}+MS&7>C6III&~L1?ldWef8z-orVgJVzn~$I)bLqhrKoT9 z7q*GX`Js~YVtM0EN#j=6PRX@E=cIVkw$r(=Q?ejB+&d+1Uvklx=~R(6P-5As>GhXb z{AVp3_m8DeIMKTW%C4y2VqC1nj_y7q6h^-nUtOr-M8e0cvK-d`WuH0_-05_^on z+=-XD6M?&2@UH#kUAySGze`cqm?7qWQIwM&VgMRp?lNDYxGvm zFMg3o<>Y^nL!E2bEu@l*#FCmoQq6zO%zl+wDkhh{21!wSMiW|I)b!W4AVB+Vq=;Px zY2#=di5+=R0)NK1R-L63`@%9TO-CRY&oJg-sL}eNU;pjze)l^aBdHf$Hc&9ZZMS(~ zF-dy_tfrK7F|UJ161d<&Kx6rc3MHjJHh*U|lzIFgtp3UBQ~HNVA0@4;{%QI;yFM!B z>HL`&#N-RFGP52h^Dv=M7Wj+&l=|j{hv6R^Rcr#8FJVT5S`MR^Si`v0hW8^p<-W1>fwmZC05gfy^UYh6 z{D#(~pu`MSky?(zUow%kjCuUfmdkBnYShppDmE3{Fb7j4_6VCsS_J)4NOjW#;Mv9a zgAwn}4L(|AxXOGbj6}S^s4mEF@$?Lv*$~zcccOvOQ|?4#BIsIX5BP9yc$4Q&HYSar zuI~H6d%x@`?#Quy*#NS~6`Sf#F{X@w>Dd2cPbeiK9K#4Hqy}KX9)fZ55Db_A4#CJd z1VcC!lRTFoK9Nou$Z@j8<8SpA%Xql$>bHp1u?D z-0$pJf4EbpbChzRqo@7DFd~`PV{n#@K#+^Mj$taI4SyEF+z}_P#V={Xd?d!m5 z*fTF;;h(ZbD54G-Ga7}L5oquJUt|nG7s7atKkD8{VdU(7n&6}rA53G5*%GA}p(Wbz zOaV52|1ZK5ELUKqdtS*ms@cNWUNNS`LXlR+sXM;qW6#C#a~}CIoOp8`z&9xea*Ai& zN^>JVocq|c(hSOYOyLby!7CKi%~&_FWiY2Evt>jM$H4kAJ%0{5oB`G^)0h$0`oZo* zjP;8ncXt+G#^bCU_B0|kckk$n*MIJ8prcdd9*xCwp}-6y6mDw1Y9jM_#CVH}knE#n+MHBj`wc>Aba$-&b$I`vgsZ5Ng7=U=v@nWwHLgF^h~` zX5e3h-;%|j%gWh-=-6=Q7;}{I(M?(HUz={QYy&OZh=|-t{~u!6Mq@mL zyy;6aCfKB?kCS(YitTZQYb74R_qh9h_<8_;?tEi@+}4e;#fpZ+%^zotO1}HF@$>9XKKlM2%%M~4v{4-?1O<#|VRtYM4=>>bn>!~7xqm=rlgMjLx% zeyEYA{hU%%EFbJ12snr*Yg5#}+=Kg;7JXx{BaSY_n=O>_`;MMS0ehFo+wnG?ROB94 zCb6DKxCg&+d*h7l->+@P0+m~CWH%MwKLJ0Q zz3&*}X@|Qw?p&j}lN2i#g$E^m<6Ltp#=|+pPcat1(@bJvtx*X^WN`5fGT(zSaxE%N zLl-1S)02A-ax3>g_yKONK1hZjwtWnqb=}uCy8B)CyO`t$2;?QME#E^Z^K`H zD|(39?TyjydqS%vJX9#4r0MJ2O#R7v6V`*sC$vWmFM~425MN+r%UygFlLtyB5(WIp>cf zIkoI}-kp=TS-gXsf?fK%gwOv>_*ATtSLXUnt$tfwf55p~v5t8}dVepTT#PCscmuIE zkm!(={q8%IHtg$-$C2K^ev0kEKZ)ejvT^x&vn70+><+eM;!*r_2C+WY-u-)HD)G`Y z2VmujUV3-dKwsEjk9%f8OKGT!l;Ste!Txd~Wn+q{GjQ4s|8*Z5{NSqU3}vHr-}h$h zJzMT&gevdxD)|mY%;8}vC2~X+4t#`fU1Y;iHMpd9xz7ye)j7LWN}ZUuS>}hGoNJcH7XT8?OSD#^E2IQM zX9yUuN_473Yv6hc2ghb?Zag;4U&F#_GVdlln6~F+6ER(g5rnsjAnN<0S?!Q&u)6CA&zUo9*5t&3(-f+;ZYi19v@A z0yLL5doOikq>)Pr8jnlk2HnNjGtX(@bR);x*WiSeh8^kDz$s6=Udkq1m|`@_Yaqll z@JW3z$<2(M^kQdLIxNIIBTYv;by`95b2<#%o-$A z36wNur&VLI!*vBjJw%?~_rvvS%E_%M6xsh>1}3LS#qTcLw_F3$NvT#BUakYPX_b<~ z58hK_Ac-)50_9dY%aVs%!k05j@?K4fT*?tZq5j9CA86uJ@XmZosuEMblqer2lxVZ} zc;p6_2Cl$yywhyw@f-?|M?54o9K4?8&){PsXf9~aQUU;ke{U+?j`zQ!QhH?N8vRfv7~gc?-nelv$iC zD_vHrH&uS*mN}4CWw+nF4qlCc6M~NfP2JaCG@nv?6i z8nXaa8*CD3L8>>!v1YpWz$7eNq@cg?sw z#sQ<$Dj16m9Y*5IiXZz0Ele?t{P` z5x9ZX@UG-g06>z*;p-g$?C8a4V5&26OZq6xMNyH-V|$39&*l<1@1VlqJBX7s+DxWr zf~_Z{%5|yUI|Rly0JD2k>L~om-4DFR&_-HO`ctv=qx$%VA$~KK_`L_Rs{dg~uL0?A zL5Cx9IzT%rvN@VOT_nXBPT)-Mw_BU__Y8JtO{iVV!}b}y(o7L zKFbvxC{m8&oG4~^2&3W< z4xj-&9mB(JI>iq{fF6i!Om$km8&f+Wkn+Q~FCwCYi>^EmSCs`Gof9dUOu?|Skkt4@ zreG~ipb>++nf`eY!lo>$El56!I9LkfOg7vJW^qS&wB_8e--QgBMfG-f~4>a z#CKuRNeo~=i-LylCxht)jC zKS1>3;qpp4O5)T(?*$twWyCBkP0$Uwdtq{4&+XEw9ZW9pB^NyH@+B94o>%&~FH}?axGR`mJ-`VWitlv7m)wk6oc29`MCm(mhrM|3_Vs2F+vud+1aP4NG?q(?e%nyq`DuR1v z8)vuFo6B1)q>Hy^cCJ~(Hmhh|7Ei5wpbBN@i)X3>+11hFqVAS>Y6`P*#QaNv>`T!s zh0=ENmRIbb5>HK&Vo!7a?9BR=KviEr+jpSwjX)dRQ#9|i&4{fQ(c%zDDrRY3<>Y-h`N8B< zt9Y^X$)rE0Etu2k%jw+i^5^tFVP56te|YbMd!n{Bm|GXftqbLy{$bijY3qhyUQHmc zW~=7sSATkS`(E(sXyEFok~tL2s}1DUZgu>8;HLvG)WK#$pxK~gUJvF~1@fx4n4hQp zG;Mn@c;!am$_>a2oUQ&euNrz$d;YoZnQo(VllGU?Y+l+ax%^}Rcs_mhsWo`^lJD%L z&DvmoLm(XCq&pqu7X-l8CK5O072DSA8ZGA|ieV*|wV`Fto`>!4bHLU?nD<-8p zOWDx=dB(;6g~Y`X4ix*lvA_B9O$nR)2Sd*!Ygl7}QPqbW=~Szp7{qR&@C)y2S3A{)$^q z4Zkd^2vxTPt2=zv9nX%vs;*l<_Nu62QynO(3tb-)HCMN;ztr@;D!v#juJaYwZQcwP zx4kTGQ}TS8-cV&ju(Hip*|weXqQ+l2^epw&^|pe2j632z`T(iY|mIf85}vw#}3NH5}D{m{=h=qZ|j zzHvISVB#>Vp@X zeHWX97u$Uo+qbpi(2RJoJ$TXb@}ea)IVIki-a?ApcTNI08%9-U2;hm=DC?=Id279c#~eiL@)C|h8{3tMemFBK*jiPGN{T+ zUtFSU`{~^}>N?HQ8`C?5O5YUp_gZdLVW`-7I*q?iqm&@`aoYDK@0D*@S?B`4Zp^W zF`|VBVOi;M6qc2~iNeANvTwoVd6H*F@$|zTdPuY~b20=&F;cm&up6%P_t5?Hi_`z5 z=odxeO_MnP;6;(Y|DnJ8eIVRJ6FtKSX!J9rzlIqW>G#m1#E|A;Yg>JJ9UvIke7N$_ zm5s)ySKtc+FAFY%#?&|dWctToO;zUy=+`QB{U9wC)VKmW>#oD(P-pO05BV#H zgO%gH%5i_?#M7ZreOIu4&{seB!YGd4^w-}C*3bCrXGF`qxbU98o)-&iL&LL5L&Syw zU*RBBAD&NEpR5LRtNppvyQzEo?V|pZijONcSA!R>fiX^{8XAGnZaP@NU{Qmws9{U( zFKP)Eb@+-pwr!sl4Z~2Zs{3T|FBZ4Tx334g#(iDm!LD1ru3LWnlsJ8RM}KEM4GoY! zsIBv9>w?-wpSE#pbVqyb%VesqVbdFI=<_x71sjHa4a5H0kznnluNHij+oEa4Uu#(( z4AnFTYdU>3oxz%3_=LraM1Rfj`T&qDuML*9_{v~P3zl`fEbI7;od~j1FIlJ-M8Jzn zt2+y;&?Wc5VnZh{LIlut=pX`x`)LaM2|hamgS~A#<7N5qD_vbsN2Z^IpsweouIB*V zHR$zax&ze-BSNhMX?HW@GBl3RBx6Cvn`9QTBu0>E2TKT%z${_ClQ3op`Z6Z2G52NY zK0*(f>ng(9fQqo@D@R$6)3@m0nCa!1NxTcK^aK~~`4-UlEy~6ZBLWenTm+>A8smG6 z-?(i2#%1G&5!ANV_>F^Q7tg^YH}dk_4N$~knx#c{I>=glti?ZM4G!6TL-19K_h7L3 zhgP8I){yTU`bcl!uN}p(C_5PAAUCMBlj*`1kJH`A^f+z6A{as55DX!R#+V7Y36o)t zeCKX}8V}GjH2O<RsDLw@~mP(SX|kNfo#>uI5uHo}un(-azHByUXH@>8)~q)9qlB+1F$aHqH8)W+M(5;A+?H zJGnLR)r0lMKtV;Qb?C)|oz~mIR?gRoj@%qQfzrFl5dCfg^#+S}+gErsR8jZI(8ojm zisr4=or>P4hEP%2Mk9Jk)oss?g^G3X-HR`puyE`4`V291uVG|bwD8CE}0=lp)TUCr8 zv7fntO0Y~5tJ;ZH75e^+Ptz9CUfl2ow2g<*>O{0od1CDZy$AKe2uK5-4f~U#}Ca29Pi@;rW+LwI=2v@^4~#R8Sd4P^4GI zVl<{&z#(m77FD42o%EuLG~=bF?N!HWu;YDS$NNyK9lit#6b8T@0SXua&H!{INhH43 z0GJjii4zt?HZU!uh#euPEbvan0l1De52z-wN-uL$1ysC@8JWWf@@7;Hj9jW^%yX$8 zU>-)0_)yiO2GTB7FGgObPfZx_Q!Dbv8AU6W*6-xjM|2TI)Ep>k4jrXYP|0nEljS@s zw`L6^FVl-0+u)<9z?F>|L9Q@@yc?=%jP9s7%)6tqV;)A3=uj=8jPF2eAhIzlvZz;N zQTtKU=yRb?01`%k)D4pYBn~sTF%cuc9cE0JXJ%|NcSJQD;7~#0LuLT!I+#J^z`=|m z2N*%#xauxOC|1aufp5A(9!8M31Y!l!GpdIeIhgll?%tQVLq+&@^oxw^wm@+kQQI5X zgfYg75y$Xog2zDRf!i_W9!dZs$h!}H08u|E4{$pM$^#`k>6=k*kJ7_H7WEa#{y(O+ z>vMtJ$^%+UBs7Y`=%jBU*BF5mrsOf_Vpe2zSY?#K3&P#F87QtNn4FAhmodqRbiiZ} z1lm>oD8^3udPIJRi3XNn&d8WH8PkR+3(z?bJp?O4Fnc4Iu%hgw$p@f1={XsL*n)Y+ zjbwP{8fqOzfXFi)*pFSRL7B`%giPp6@%mKYOf^gbF=p*rG#}@Kh~79OO(xY3$qbLn z)f1n`2#Y7E{x0LhM2w*NyE0FAnN>M)72AZ)4rv{#)2tRPn~`ye082u3V(OYZBbNW=FV zYA7|pOk&|%%#2*v5-p5Xv;>M;NdJyU(#dGN7AU?((qW;3lNp%>_Hu$c2s0n*pgaL~ zGO}XAWIz(9u;OXiPTdXHFRLlXIAm_ZeTI@ur~2qgI(V|ocd~3ly>qg1V}9pk!&X}0 zWY?G7Y4A$!ixw)sY_~5RUSkF`OMICnVsgn>wp4f#1+Tlr{D$8O=isgBFSMuI+sjk_ z15-ev5(524x(K0v-(H^9-rjf&P5`t+(dZTgPu|maVOkLc@Oe4-;1j+YhU0XpCKGHm zFWK=q-DG-i$!rhjWSZc^Q@r4TH^!XPWis(_Y>nc70fCfbA_ouQ%h6^J>=4Yr=@kL+ zvrY1AVtj#a;p}#k3ARLz#Uuh6oFJgC$sY{E3rIW$%kU?_K?myV@4_45FPYSY;;&Bk zCMIZiDGbThKPjk7_g*HS+Jvoh{Elz!KoNOo>;g9SDioF22?ME0HqZ{0hh z!K-VJ;FZ7YiItJlj~22!ukV5{4u-3<@Eo4Mgb#GVCWE&nQpq93VJ9DUBVdDIX31_2 ze`jxIO+mj((BTA-{FzljPxh~10}j8bt&i?@h3kfG6WEZm%$uD~&hC}J7)x5KV6eFP z9xe=L+?)dL#+cmj2{%BqyOylpi=@Uwkx-ZscD%Z`7Y=V0ggYsMD(GiiX5Oms)qy~m zuN5A?eQbhLrFPd`xRVY;8-dgdL_%Sujv3?x&X? zEHugq_+3>YR-C$YiQzeUBP^Y4U+|_SkIgP`)$wZ7*ykAhGYr--D8t|~209FgQfu(3 z9s?Y+aD-AGVy%1tKpX+WEeLm2G)@0Cb^L!)CI5}m!SW*^?`eKWed=jaNS*U!Eu>C; zYzV1S9yf>7$HdGc0)s_P$awr9q|SVDCZx_1kC*P|A3MW{RQ_)?$4)_fe7F2$KJ!YQ zBBqV*Ccq5?NyGaN@CF$a^JG&_eq!M6oHw}SwDj`iwAKpENKnCz4=3n2giiKxB5 zTZDjyO3*>(MaV2hxP(e*0=T(fwW~$=9F;Hxr-I;9hTy%O$COekp$-!2VPY=>Sfp}( abLBi;_L~t}O=o|VF`h_kUsD(o+5aD3a1HVR literal 0 HcmV?d00001 diff --git a/.github/workflows/__pycache__/parse_typescript.cpython-314.pyc b/.github/workflows/__pycache__/parse_typescript.cpython-314.pyc new file mode 100644 index 0000000000000000000000000000000000000000..1de908612fc138c5d8e6ec0745ffa090e60ada4a GIT binary patch literal 9577 zcmb_CTTB~SmgN^1W58g80UKjp#s-WD5J*EvnuHJtZQ?FS@-(IXf+dtacS=XSH!_T53i+(&TFuX@4T^PgM%KYHHKkNHf~e{*moydq4MF+XW_V z$n5l#;J)v<=Y3C|a(88g0fUGC?8dDxIxy__sG~fNeB-+fXnc;{z;M+xHl<=!&8V%O zR!^x}O}4F>)=ueIT{DJjaUEWQm*RT73^(BAxDl_wEAcAagjeG=xEZ&=e=Ypi;a0pJ zZ@?RI8*ay&a0lM(t71!VXRnGa^MFVyv@vwI^| z$|8oO??l6-T$x`om+zaR32Kc67zvh6#$qHbS52dlvjqe3CX?$ z<@!b{d6%S>+42DD<)=#SM44zZA(s%jT1O|BlB|r$+DM2E$=V52mZCO8vT_+}1etq@ zux!jW-_nSAs%DtP&5%utjGp`Y+h+s-%Zl7NRVMeEHIBv(xhB<84b;$ zk-6-EKC~8zCWFAf(s9(9PRM1sq2wAX>$77Qp=DViSsbXOaiBXC!x7d@I47-KnHL@Q zT_5yAphSxptHLo>eZ$FW>aZjR>Y}z{F%_%DHCBw(;aawYz}Qk;1)?sIP4o9CaxP3q zDK-$IK|HfzO#yra9{T$4?m**n?6N7bH;H2emQX2OLfx5fMyfE(j$L*p6x2YgVdWlF ze`R*({;axi)`y^K6{xrdkkqc5S6P-~MtnY&>Ae#T#d{;sA#zRza zIT|D7QYLac2&yR?m@plp$ZWe5WU+$8RKo(XFag8{<0QM9j4&RJtYyg9GVOvh<+_3e z`ArA{gOGQ*Tyns-nv9b^W|b!IGCqWgFOm#1UJ&_hmL^HY2LeNqUt@f|D^YfJZOMn` zmSag+Pay^e_mAkM?#cQfXhD<>2IYo#CDE%)wZQ4jAQYctlA~u^ZLaPOeM9?=zWF=YhlTez3LPW-XJx9dMj#Q#18C7Z z51~RV>BaEziz-S>s7=^8{p2EsQM$u-^fc}RA#`Z}<@pbwjI<%0AT)tJsqe2ls5c8b zWd^iHXTMPEj4FqJBVho_ z{{WO%;1xtgz^a_RU*nYuu7UdfQKeO&o#g?WGP+*_%wl{;_pNa_ugwa4xSgwiBo4+O zj{~8@YmkMk<2{i5VKxrxVf}cTL%fo-3h5ue2QI$k-{_aT!?E63S@;8F7 zQBD35q*_H(6_u%3;dwxbp%f&cE+%KnM3`{PzUP?f2fTH7ZBM~I!c^G9>k4~RHEyM9 z4#5V+S$o=`SXhL~+BNu)+_TW8wEh$*3Vlj_lsu@K1&Azj4^b0P5KxAo#_JR~N_|6h z;tTMiIS*G8@Dwc0Hz9&-R4g>m{lj@h8xG|PiaYnXQdA~pyeZ)QA!Nc_j0WXAg#yZq zJBS**nK0wdLpb_g415~Og111V+IrY1723>-|==IhIhbT7h&<~4!c7OcO1MQ z2ov&oM71KW6}Y4Ap!YMMq0v7FUg24ICxQ;p{wZ%$Y|bv#;tq4 z_=uai=-w0idnxB39@kk+hkoF3onR3yhsgc_O#$>a`p&Z_74`@Z@LniIBgzjH-YI9S zoIdpK{Szco4147Sr9M&zTl_kFglh4tQ3T*>{N%n~D6~XY zj^NjU9Yy`z0UxsmbL=k%vzVnH$(>fvqUu99P>+ul;lNi%V0&OkQ4X9^WJa|SZADj{ zR#pVy#(4Kpte_byYT<3lUZpN-gCFkO;E}v(&+?|dm^JQuba>+dKT35#l+bZhWLD_I z-i>BwAR0yQT6hc53eit-t2i?HA*??t`l%}#{b*&)7I= z67r;Um>hA+nh-_FhG>E%>E%$EWaQFtEW|L-Q2Ex&&&HyV%j;cbGGzdEy#|dl(Uk#OVDc8^>^b^5IKEsCct>yW#>>6Xfv&KL& zRj$b;;0`X&kHw;i+v`>6m{20Tnxwr^5Ql7l{8;U#T{IdByxjZ+WBUQaRxL%C_=dfkGY?K8&E85_3;#saSaKeJD%gS|DR>z__@(XyG z8-PTnm;5A4r>vnMwOq2a#~DpH2$)tr&_ zb0mXu>Y(2KWMnNyGM+}d3msnyK$ZXlBqXo`+KmPc;Sd#t6n1o-l$($`9iuOyLEt}f5ez+vhNjVwslalB%WEL->cWu-9a?5(Er^3;(1ig>c$f3N z4~>!vS=2xa>*hgbgm zp>tzu*N6>&urVPT+jwJJdSb`u$+&sr!0RgOc2%Ebwmv-h@MP-bD@y}s_rF+uagA%d zvTeEgJ5&9x0dx0c*8cI+2S0u0*_e`Q8y*H91UXAb`s4H`>04W>Ew|Wzj_*Gw^q=RB zO}!}RYUVf2N&we(V!P^u)X?;}`B5`h@5xkWPGq{a#hlc>KZf z&ANwUUyNm{zpnkVHgo4!O`>O<_l!SxiJs|g&-5#2XGZh&r7tgS4gG3SaE_+NQ_H`Y zext+c+`D?L)%CRLNfS3Tm2MJRra7ZSs;l2PFE!XUF8to+O_fS!d%EUa-Zl?Q7Td$w2eav6v2B2F8`zrWCKtH20ikVi+j2uPH>Zc6o_un0ODnV;7u!bo zwvlb~h-7hymJS{`wj#QQc-PR@J#IS4xrPMS&239aGTS!qeq(k?R>#AiKKN;RLa=&7 zYcFr@6|IB3bx^Pl?PA#IE%pCkSp6-vTR68PqYv5_Mt6Su%8s_$DXUU>&GSESVM+ja&hCA(te?x5ZkZw?bmlpwJkNNirq@A){|*PYfn5K zdos3V=Ei2zV?x_SEtb;mUP ztb#X9es97o&3`j0Ev%#_L`yes>CQ~-SdMMEcPyjN{5zHlFUG)h-i(0&-hQaUY^|vh z$~3sQ&gY4AyKYo0qpq=Q1oWwGNX-*GcF`-c|arcUbUdV1~2wXG8F z^j!Ly&@nG|T;)5iZW^SXUNArSqV{;?(MX!y@^6lawlgnnXI}O7|7Kuo?YHZ{UVq-f z1s1o~h2a~*Kv3wrDfTV%eak}MDrfh;a<*~p$Hn$hzJ2uBgwQ@NIL|!)c-uKC4W1JR z{rsT+MTDEbCJbH|2bcK4C1EhaIgh<=?|M4(WM=EL^o-DcUTpt}Z~ths>{UnSSDMVZ zuP=Ogfjfm~E(kqyf_q-*xFmL5=R2+o9gCZWKiYc!{p94o8D7qlT-WlWncokO|LX|X zHM=>pTLL`I7`Eni+$Ww*^X_w!-Nzj}BiY@VM#=8UjP91{1{*hx>1*5deQ#Q@*1osB zn62sW=F)XpUe0qPe#FaJq3NQ~7!Vt;@QqivtE=3tn9vv(8yUWl5gOOT#!vaiPr>Lu zQ=L^qbxwU={T+tcrqtjU8k-)wAGyKKL5qHQT4)@Av5rp8)T#)P<$6x1Mg{YSqS+6B zoY^ngS{{!+8cnm@;Q7r_!8Rq@F7dWYqU|bgyUJY)iMFMewxw5I-)}TqlfRw$^~`fE z=fAl%BMgSb!2~~;5c-mWmlC~qc<&v-`w3s)_1b$3l^!o=aRFCqJzUpGq}<@3TGQth zr8ih%)T%i8qt{)7AJL9TB+bziWa5v}KW>-iTtjtFzs^P)BK(i)Mx17BbN z^7=CiH+ea8UGQEJy^Fkek-HJ*V)r=jqTpQ@y`S;k&%TFmtdr_D*%CO_JEi6TJBJe- z$-ZizLaKfGrTMhf>3w?t$^EV4+&G@TFLcg{omcoy5X23k6Kze& zO#6*WBY3EA!aq|7#sB^c`y6|#Ht0IOZw#w-ox2z+vm|8~&Uy^l zXbgU!5nN-Vv0Ri)Yhf#$ghDn#NEwSRJ^DGd;^!XhK)%{Td{FR(pIJFByD!qlUB?O8BmJEpS$Fv#6hJZ0tUCWR^3hGLFlGd!W%kC-| zjoUhhPHA$e+Z@8B9WI^0hfF-v9^6xDCvE6W)HG%`bb4r}GoD_Y;^}nSOTV{hf#PP; zLk{_7cK3VlegF3Neeb=m=TyB10d0SG;rg~4p})|9MQn}Pp8)0-T0lHAg(exD2~wV& zVkbGBo3!b+NxN=0=eQ|{?u0dN%B8z_TQkz#yo0wlBZ<*HJlBCj&WF@!h%xG4Btlsi zb7kqOTvkGy;Vi3?tdNq)T$e>)c(PO`nm(JcBB8ntcsO|Wv+%lw=1`mg<^=H&E6)zq z^!#Yz3_=Q-IV1 z@7)J+lsNVU+Y+a`6U>JNm{Ok9do7pzK=+wIRioY_{fjN5U0{f;&lG#5-Z- zSlL+;u;NM}FY0$#{}M#6#1@!db8{X@4MRj(z^@G@*abFW>vdV$2=yMK4fwi`MdD7l z!L}!116xPp;EAtGF!1*FJC8gj+bofIyTu)SpGFDyk?dK-*DJ0UT+@F;$l`-A*HN1n zna{xzA6d3I!16m!V0r3u5IfBNXCQX@%ZAuEGyT2K#O#@4SUg!*zGSDho^V;Yh|}}x z1VLu~2^YNozpDE3VZ=_uZu;MKC87)5StK%{r-UFJNuCL!X9`%r*Z3<~C}pvEVq#Ip zf`%s(GgmM@m+>+jtXL(wx`HJ+FJ{6XPfX2gqaF+dXZ9#g6o_d9SV10HNtbg8$3lZ(PMM z8UU4IR;q&2W zbf`bv*B`}Kg`A*@H8r?Bow`^ga#^p~%X;qIaHX!G7p3sQ{Z{!(tOUtQ#K%=tR`D{V zP6wOIrBQ4!xZ=S%n1uw7;))mWP*=oKo+4H`ZGjdJhjDi;5ug(>n9yvcIYyP9v{`8f zcjXefp#Xd&i;3w~&Sc7}O0wXD9mSzWm3A72N62PV1tMgLYS>kwlqV`&jmWU6FlRWj zkTY1K_n~sDC(yb8*ebm}4Gsb` z+{=Qfr>Jj@UNK$Js2q@bipsdnE`x3yH4I~_r#YZSx`iIMpt^?J9dGyEy0~j|et-7O z+1q1}5PIfy_Ax^C1@@D`nYGrB0-dYQM{K*h?UO*u+Q0_86X;pJv>RxCcjQMS?_78g z=-du;uIKLu!mF3|0(iY~{oD5ggTQ-(>$V;5b0GQF^rt@5*!Ag)4D$N_`FH^Nn`lq- zz}LC$>wJuy?zTPeQ`N?E8=3bDcM2P?-d(yE_*Kg-`+pI=$NhZd!NBU^@=@cNE- z;R}!8kq?0Xm-YhG!+SAXY?%G^aB#|N|4nmj=u)fwgH{ZK55^e!{#xw0i9!4C2E8!& zkfl=}anaR+tm8Y{}#vP8bF4#FJurP0pj5yvphpU~Mqqv$q@evASi Sqq@I4SmyjcTz!n+)c+54=JC$} literal 0 HcmV?d00001 diff --git a/.github/workflows/parse_go.py b/.github/workflows/parse_go.py index 2a0b2d5a6c..1d943512ba 100755 --- a/.github/workflows/parse_go.py +++ b/.github/workflows/parse_go.py @@ -284,6 +284,19 @@ def parse(self, type, viam_resources): if resource == "slam": self.go_methods[type][resource]['DoCommand']['code_sample'] = 'mySLAMService, err := slam.FromProvider(machine, "my_slam_svc")\n\ncommand := map[string]interface{}{"cmd": "test", "data1": 500}\nresult, err := mySLAMService.DoCommand(context.Background(), command)\n' + self.go_methods[type][resource]['Status'] = {'proto': 'GetStatus', \ + 'description': 'Status returns the current status of the resource as a map of key-value pairs.', \ + 'usage': 'Status(ctx context.Context) (map[string]interface{}, error)', \ + 'method_link': 'https://pkg.go.dev/go.viam.com/rdk/resource#Resource'} + if type == "component": + self.go_methods[type][resource]['Status']['code_sample'] = 'my' + resource.title().replace("_", "") + ', err := ' + go_resource_overrides.get(resource, resource) + '.FromProvider(machine, "my_' + resource + '")\n\nstatus, err := my' + resource.title().replace("_", "") + '.Status(context.Background())\n' + if resource == "generic_component": + self.go_methods[type][resource]['Status']['code_sample'] = 'myGenericComponent, err := generic.FromProvider(machine, "my_generic_component")\n\nstatus, err := myGenericComponent.Status(context.Background())\n' + else: + self.go_methods[type][resource]['Status']['code_sample'] = 'my' + resource.title().replace("_", "") + 'Svc, err := ' + resource.replace("_", "") + '.FromProvider(machine, "my_' + resource + '_svc")\n\nstatus, err := my' + resource.title().replace("_", "") + 'Svc.Status(context.Background())\n' + if resource == "slam": + self.go_methods[type][resource]['Status']['code_sample'] = 'mySLAMService, err := slam.FromProvider(machine, "my_slam_svc")\n\nstatus, err := mySLAMService.Status(context.Background())\n' + self.go_methods[type][resource]['Close'] = {'proto': 'Close', \ 'description': 'Close must safely shut down the resource and prevent further use. Close must be idempotent. Later reconfiguration may allow a resource to be "open" again.', \ 'usage': 'Close(ctx context.Context) error', \ @@ -421,8 +434,15 @@ def parse(self, type, viam_resources): 'method_link': 'https://pkg.go.dev/go.viam.com/rdk/resource#Resource', \ 'code_sample': 'my' + resource.title().replace("_", "") + ', err := generic.FromProvider(machine, "my_' + resource.lower() + '")\n\nerr = my' + resource.title().replace("_", "") + '.Name()\n'} + self.go_methods[type][resource]['Status'] = {'proto': 'GetStatus', \ + 'description': 'Status returns the current status of the resource as a map of key-value pairs.', \ + 'usage': 'Status(ctx context.Context) (map[string]interface{}, error)', \ + 'method_link': 'https://pkg.go.dev/go.viam.com/rdk/resource#Resource', \ + 'code_sample': 'my' + resource.title().replace("_", "") + ', err := generic.FromProvider(machine, "my_' + resource.lower() + '")\n\nstatus, err := my' + resource.title().replace("_", "") + '.Status(context.Background())\n'} + if resource == "generic_service": self.go_methods[type][resource]['DoCommand']['code_sample'] = 'myGenericService, err := generic.FromProvider(machine, "my_generic_service")\n\ncommand := map[string]interface{}{"cmd": "test", "data1": 500}\nresult, err := myGenericService.DoCommand(context.Background(), command)\n' + self.go_methods[type][resource]['Status']['code_sample'] = 'myGenericService, err := generic.FromProvider(machine, "my_generic_service")\n\nstatus, err := myGenericService.Status(context.Background())\n' elif type == "app": soup = make_soup(url) diff --git a/.github/workflows/sdk_protos_map.csv b/.github/workflows/sdk_protos_map.csv index 1901f20597..32c0fc6e73 100644 --- a/.github/workflows/sdk_protos_map.csv +++ b/.github/workflows/sdk_protos_map.csv @@ -14,7 +14,7 @@ arm,Stop,,stop,Stop,stop,stop arm,GetGeometries,,get_geometries,Geometries,,getGeometries arm,Reconfigure,,,Reconfigure,, arm,DoCommand,,do_command,DoCommand,doCommand,doCommand -arm,GetStatus,,get_status,,getStatus,getStatus +arm,GetStatus,,get_status,Status,getStatus,getStatus arm,GetResourceName,,get_resource_name,Name,getResourceName,name arm,Close,,close,Close,, @@ -24,7 +24,7 @@ audio_in,GetProperties,,get_properties,Properties,getProperties,getProperties audio_in,GetGeometries,,get_geometries,,, audio_in,Reconfigure,,,Reconfigure,, audio_in,DoCommand,,do_command,DoCommand,doCommand,doCommand -audio_in,GetStatus,,get_status,,getStatus,getStatus +audio_in,GetStatus,,get_status,Status,getStatus,getStatus audio_in,GetResourceName,,get_resource_name,Name,,name audio_in,Close,,close,Close,, @@ -35,7 +35,7 @@ audio_out,GetProperties,,get_properties,Properties,getProperties,getProperties audio_out,GetGeometries,,get_geometries,,, audio_out,Reconfigure,,,Reconfigure,, audio_out,DoCommand,,do_command,DoCommand,doCommand,doCommand -audio_out,GetStatus,,get_status,,getStatus,getStatus +audio_out,GetStatus,,get_status,Status,getStatus,getStatus audio_out,GetResourceName,,get_resource_name,Name,,name audio_out,Close,,close,Close,, @@ -51,7 +51,7 @@ base,Stop,Yes,stop,Stop,stop,stop base,GetGeometries,No,get_geometries,Geometries,,getGeometries base,Reconfigure,No,,Reconfigure,, base,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand -base,GetStatus,No,get_status,,getStatus,getStatus +base,GetStatus,No,get_status,Status,getStatus,getStatus base,GetResourceName,No,get_resource_name,Name,getResourceName,name base,Close,No,close,Close,, @@ -77,7 +77,7 @@ board,GPIOPinByName,No,gpio_pin_by_name,GPIOPinByName,, board,GetGeometries,No,get_geometries,,, board,Reconfigure,No,,Reconfigure,, board,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand -board,GetStatus,No,get_status,,getStatus,getStatus +board,GetStatus,No,get_status,Status,getStatus,getStatus board,GetResourceName,No,get_resource_name,Name,getResourceName,name board,Close,No,close,Close,, @@ -85,7 +85,7 @@ board,Close,No,close,Close,, button,Push,Yes,push,Push,push,push button,Reconfigure,No,,Reconfigure,, button,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand -button,GetStatus,No,get_status,,getStatus,getStatus +button,GetStatus,No,get_status,Status,getStatus,getStatus button,GetResourceName,No,get_resource_name,Name,getResourceName,name button,Close,No,close,Close,, @@ -95,7 +95,7 @@ camera,GetPointCloud,,get_point_cloud,NextPointCloud,pointCloud,getPointCloud camera,GetProperties,,get_properties,Properties,properties,getProperties ## TED: Camera in Go SDK doesn't appear to implement (inherit) these: camera,DoCommand,,do_command,DoCommand,doCommand,doCommand -camera,GetStatus,,get_status,,getStatus,getStatus +camera,GetStatus,,get_status,Status,getStatus,getStatus camera,GetGeometries,,get_geometries,Geometries,,getGeometries ## HACK: proto for close, manually mapping: camera,GetResourceName,,get_resource_name,Name,getResourceName,name @@ -109,7 +109,7 @@ encoder,GetGeometries,No,get_geometries,,, ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: encoder,Reconfigure,No,,Reconfigure,, encoder,DoCommand,Yes,do_command,DoCommand,,doCommand -encoder,GetStatus,No,get_status,,,getStatus +encoder,GetStatus,No,get_status,Status,,getStatus encoder,GetResourceName,No,get_resource_name,Name,,name encoder,Close,No,close,Close,, @@ -125,7 +125,7 @@ gantry,IsMoving,,is_moving,IsMoving,isMoving,isMoving gantry,Stop,,stop,Stop,stop,stop gantry,Reconfigure,,,Reconfigure,, gantry,DoCommand,,do_command,DoCommand,doCommand,doCommand -gantry,GetStatus,,get_status,,getStatus,getStatus +gantry,GetStatus,,get_status,Status,getStatus,getStatus gantry,GetKinematics,,get_kinematics,Kinematics,, gantry,GetResourceName,,get_resource_name,Name,getResourceName,name gantry,Close,,close,Close,, @@ -134,7 +134,7 @@ gantry,Close,,close,Close,, ## NOTED:Generic Component in Go SDK doesn't appear to implement (inherit) these: generic_component,GetGeometries,No,get_geometries,,,getGeometries generic_component,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand -generic_component,GetStatus,No,get_status,,getStatus,getStatus +generic_component,GetStatus,No,get_status,Status,getStatus,getStatus ## HACK: No proto for close, manually mapping: ## NOTED: Go SDK also missing Close, but we have it in our docs?: generic_component,GetResourceName,No,get_resource_name,Name,getResourceName,name @@ -152,7 +152,7 @@ gripper,GetCurrentInputs,,get_current_inputs,CurrentInputs,,getCurrentInputs gripper,GoToInputs,,go_to_inputs,GoToInputs,,goToInputs gripper,Reconfigure,,,Reconfigure,, gripper,DoCommand,,do_command,DoCommand,doCommand,doCommand -gripper,GetStatus,,get_status,,getStatus,getStatus +gripper,GetStatus,,get_status,Status,getStatus,getStatus gripper,GetKinematics,,get_kinematics,Kinematics,getKinematics, gripper,GetResourceName,,get_resource_name,Name,getResourceName,name gripper,Close,,close,Close,, @@ -169,7 +169,7 @@ input_controller,RegisterControlCallback,,register_control_callback,RegisterCont ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: input_controller,Reconfigure,,,Reconfigure,, input_controller,DoCommand,,do_command,DoCommand,, -input_controller,GetStatus,,get_status,,,getStatus +input_controller,GetStatus,,get_status,Status,,getStatus input_controller,GetResourceName,,get_resource_name,Name,,name input_controller,Close,,close,Close,, @@ -190,7 +190,7 @@ motor,GetGeometries,No,get_geometries,,, motor,Reconfigure,No,,Reconfigure,, # NOT implemented in other languages motor,DoCommand,,do_command,DoCommand,doCommand,doCommand -motor,GetStatus,No,get_status,,getStatus,getStatus +motor,GetStatus,No,get_status,Status,getStatus,getStatus motor,GetResourceName,No,get_resource_name,Name,getResourceName,name motor,Close,No,close,Close,, @@ -209,7 +209,7 @@ movement_sensor,GetGeometries,No,get_geometries,,, movement_sensor,GetReadings,Yes,get_readings,Readings,readings,getReadings movement_sensor,Reconfigure,No,,Reconfigure,, movement_sensor,DoCommand,Yes,do_command,DoCommand,doCommand,doCommand -movement_sensor,GetStatus,No,get_status,,getStatus,getStatus +movement_sensor,GetStatus,No,get_status,Status,getStatus,getStatus movement_sensor,GetResourceName,No,get_resource_name,Name,getResourceName,name movement_sensor,Close,No,close,Close,, @@ -224,7 +224,7 @@ power_sensor,GetReadings,,get_readings,Readings,readings,getReadings ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: power_sensor,Reconfigure,,,Reconfigure,, power_sensor,DoCommand,,do_command,DoCommand,doCommand,doCommand -power_sensor,GetStatus,,get_status,,getStatus,getStatus +power_sensor,GetStatus,,get_status,Status,getStatus,getStatus power_sensor,GetResourceName,,get_resource_name,Name,getResourceName,name power_sensor,Close,,close,Close,, @@ -236,7 +236,7 @@ sensor,GetGeometries,,get_geometries,,, sensor,Reconfigure,No,,Reconfigure,, # NOT implemented in other languages sensor,DoCommand,,do_command,DoCommand,doCommand,doCommand -sensor,GetStatus,No,get_status,,getStatus,getStatus +sensor,GetStatus,No,get_status,Status,getStatus,getStatus sensor,GetResourceName,No,get_resource_name,Name,getResourceName,name sensor,Close,No,close,Close,, @@ -251,7 +251,7 @@ servo,GetGeometries,No,get_geometries,,, servo,Reconfigure,No,,Reconfigure,, # NOT implemented in other languages servo,DoCommand,,do_command,DoCommand,doCommand,doCommand -servo,GetStatus,No,get_status,,getStatus,getStatus +servo,GetStatus,No,get_status,Status,getStatus,getStatus servo,GetResourceName,No,get_resource_name,Name,getResourceName,name servo,Close,No,close,Close,, @@ -260,7 +260,7 @@ switch,SetPosition,Yes,set_position,SetPosition,,setPosition switch,GetPosition,Yes,get_position,GetPosition,,getPosition switch,GetNumberOfPositions,Yes,get_number_of_positions,GetNumberOfPositions,,getNumberOfPositions switch,DoCommand,Yes,do_command,DoCommand,,doCommand -switch,GetStatus,No,get_status,,,getStatus +switch,GetStatus,No,get_status,Status,,getStatus switch,GetResourceName,No,get_resource_name,Name,,name switch,Close,No,close,Close,, @@ -279,14 +279,14 @@ data_manager,UploadBinaryDataToDatasets,No,,UploadBinaryDataToDatasets,,uploadBi ## HACK: No proto for these (and/or inherited in Go SDK), manually mapping: data_manager,Reconfigure,No,,Reconfigure,, data_manager,DoCommand,No,,DoCommand,,doCommand -data_manager,GetStatus,No,,,,getStatus +data_manager,GetStatus,No,,Status,,getStatus data_manager,GetResourceName,No,,Name,,name data_manager,Close,No,,Close,, ## Generic Service ## TED:Generic Component in Go SDK doesn't appear to implement (inherit) these: generic_service,DoCommand,,do_command,DoCommand,doCommand,doCommand -generic_service,GetStatus,,get_status,,getStatus,getStatus +generic_service,GetStatus,,get_status,Status,getStatus,getStatus ## HACK: proto for close, manually mapping: ## TED: Go SDK also missing Close, but we have it in our docs?: generic_service,GetResourceName,,get_resource_name,Name,getResourceName,name @@ -298,7 +298,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,GetStatus,,get_status,,, +mlmodel,GetStatus,,get_status,Status,, mlmodel,GetResourceName,,get_resource_name,Name,, mlmodel,Close,,close,Close,, @@ -314,7 +314,7 @@ motion,GetPlan,,get_plan,PlanHistory,,getPlan motion,Reconfigure,,,Reconfigure,, motion,FromRobot,,from_robot,,, motion,DoCommand,,do_command,DoCommand,,doCommand -motion,GetStatus,,get_status,,,getStatus +motion,GetStatus,,get_status,Status,,getStatus motion,GetResourceName,,get_resource_name,Name,,name motion,Close,,close,Close,, @@ -332,7 +332,7 @@ slam,PointCloudMapFull,,,PointCloudMapFull,, ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: slam,Reconfigure,,,Reconfigure,, slam,DoCommand,,do_command,DoCommand,,doCommand -slam,GetStatus,,get_status,,,getStatus +slam,GetStatus,,get_status,Status,,getStatus slam,GetResourceName,,get_resource_name,Name,,name slam,Close,,close,Close,, @@ -346,7 +346,7 @@ vision,CaptureAllFromCamera,,capture_all_from_camera,CaptureAllFromCamera,,captu ## HACK: proto for these (and/or inherited in Go SDK), manually mapping: vision,Reconfigure,,,Reconfigure,, vision,DoCommand,,do_command,DoCommand,doCommand,doCommand -vision,GetStatus,,get_status,,getStatus,getStatus +vision,GetStatus,,get_status,Status,getStatus,getStatus vision,GetResourceName,,get_resource_name,Name,getResourceName,name vision,GetProperties,,get_properties,GetProperties,properties,getProperties vision,Close,,close,Close,, @@ -513,7 +513,7 @@ data_sync,StreamingDataCaptureUpload,,streaming_data_capture_upload,,streamingDa discovery,DiscoverResources,,discover_resources,DiscoverResources,discoverResources,discoverResources discovery,GetResourceName,,get_resource_name,Name,getResourceName,name discovery,DoCommand,,do_command,DoCommand,doCommand,doCommand -discovery,GetStatus,,get_status,,getStatus,getStatus +discovery,GetStatus,,get_status,Status,getStatus,getStatus discovery,Close,,close,Close,, ## MLTraining diff --git a/static/include/components/apis/generated/arm.md b/static/include/components/apis/generated/arm.md index ec3bcfc7ea..9f83fc4208 100644 --- a/static/include/components/apis/generated/arm.md +++ b/static/include/components/apis/generated/arm.md @@ -1051,6 +1051,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myArm, err := arm.FromProvider(machine, "my_arm") + +status, err := myArm.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/audio_in.md b/static/include/components/apis/generated/audio_in.md index a416906b79..45e3a330fb 100644 --- a/static/include/components/apis/generated/audio_in.md +++ b/static/include/components/apis/generated/audio_in.md @@ -356,6 +356,28 @@ status = await component.get_status() For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/audio_in/client/index.html#viam.components.audio_in.client.AudioInClient.get_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myAudioIn, err := audioin.FromProvider(machine, "my_audio_in") + +status, err := myAudioIn.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/audio_out.md b/static/include/components/apis/generated/audio_out.md index b6ccf12f55..833b718a29 100644 --- a/static/include/components/apis/generated/audio_out.md +++ b/static/include/components/apis/generated/audio_out.md @@ -457,6 +457,28 @@ status = await component.get_status() For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/audio_out/client/index.html#viam.components.audio_out.client.AudioOutClient.get_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myAudioOut, err := audioout.FromProvider(machine, "my_audio_out") + +status, err := myAudioOut.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/base.md b/static/include/components/apis/generated/base.md index 4cc5c7d14a..f350522ceb 100644 --- a/static/include/components/apis/generated/base.md +++ b/static/include/components/apis/generated/base.md @@ -1045,6 +1045,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myBase, err := base.FromProvider(machine, "my_base") + +status, err := myBase.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/board.md b/static/include/components/apis/generated/board.md index ff0749aa48..c552d25b2e 100644 --- a/static/include/components/apis/generated/board.md +++ b/static/include/components/apis/generated/board.md @@ -1572,6 +1572,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myBoard, err := board.FromProvider(machine, "my_board") + +status, err := myBoard.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/button.md b/static/include/components/apis/generated/button.md index 0d7d501027..6d1acde841 100644 --- a/static/include/components/apis/generated/button.md +++ b/static/include/components/apis/generated/button.md @@ -250,6 +250,28 @@ status = await component.get_status() For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/button/client/index.html#viam.components.button.client.ButtonClient.get_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myButton, err := button.FromProvider(machine, "my_button") + +status, err := myButton.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/camera.md b/static/include/components/apis/generated/camera.md index 98f9eefa9f..1748709a3b 100644 --- a/static/include/components/apis/generated/camera.md +++ b/static/include/components/apis/generated/camera.md @@ -426,6 +426,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myCamera, err := camera.FromProvider(machine, "my_camera") + +status, err := myCamera.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/encoder.md b/static/include/components/apis/generated/encoder.md index df39618249..05acdda7ca 100644 --- a/static/include/components/apis/generated/encoder.md +++ b/static/include/components/apis/generated/encoder.md @@ -417,6 +417,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myEncoder, err := encoder.FromProvider(machine, "my_encoder") + +status, err := myEncoder.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/gantry.md b/static/include/components/apis/generated/gantry.md index 0a4723f051..08d0ed517a 100644 --- a/static/include/components/apis/generated/gantry.md +++ b/static/include/components/apis/generated/gantry.md @@ -817,6 +817,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myGantry, err := gantry.FromProvider(machine, "my_gantry") + +status, err := myGantry.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/generic_component.md b/static/include/components/apis/generated/generic_component.md index 05dbb63b95..5c9878d6d4 100644 --- a/static/include/components/apis/generated/generic_component.md +++ b/static/include/components/apis/generated/generic_component.md @@ -187,6 +187,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myGenericComponent, err := generic.FromProvider(machine, "my_generic_component") + +status, err := myGenericComponent.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/gripper.md b/static/include/components/apis/generated/gripper.md index dd4acfba02..70121b7058 100644 --- a/static/include/components/apis/generated/gripper.md +++ b/static/include/components/apis/generated/gripper.md @@ -800,6 +800,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myGripper, err := gripper.FromProvider(machine, "my_gripper") + +status, err := myGripper.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/input_controller.md b/static/include/components/apis/generated/input_controller.md index dd210c24f0..ce45c8a363 100644 --- a/static/include/components/apis/generated/input_controller.md +++ b/static/include/components/apis/generated/input_controller.md @@ -486,6 +486,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myInputController, err := input.FromProvider(machine, "my_input_controller") + +status, err := myInputController.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/motor.md b/static/include/components/apis/generated/motor.md index dc22d92224..915243dfb8 100644 --- a/static/include/components/apis/generated/motor.md +++ b/static/include/components/apis/generated/motor.md @@ -1218,6 +1218,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myMotor, err := motor.FromProvider(machine, "my_motor") + +status, err := myMotor.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/movement_sensor.md b/static/include/components/apis/generated/movement_sensor.md index 49a2da89c6..2358e7d89c 100644 --- a/static/include/components/apis/generated/movement_sensor.md +++ b/static/include/components/apis/generated/movement_sensor.md @@ -1085,6 +1085,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myMovementSensor, err := movementsensor.FromProvider(machine, "my_movement_sensor") + +status, err := myMovementSensor.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/power_sensor.md b/static/include/components/apis/generated/power_sensor.md index 99226091c3..8b150e950a 100644 --- a/static/include/components/apis/generated/power_sensor.md +++ b/static/include/components/apis/generated/power_sensor.md @@ -535,6 +535,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myPowerSensor, err := powersensor.FromProvider(machine, "my_power_sensor") + +status, err := myPowerSensor.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/sensor.md b/static/include/components/apis/generated/sensor.md index c9fbd6809b..4d3e1861cd 100644 --- a/static/include/components/apis/generated/sensor.md +++ b/static/include/components/apis/generated/sensor.md @@ -282,6 +282,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +mySensor, err := sensor.FromProvider(machine, "my_sensor") + +status, err := mySensor.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/servo.md b/static/include/components/apis/generated/servo.md index d3b575008c..baaa31aea1 100644 --- a/static/include/components/apis/generated/servo.md +++ b/static/include/components/apis/generated/servo.md @@ -617,6 +617,28 @@ status = await component.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myServo, err := servo.FromProvider(machine, "my_servo") + +status, err := myServo.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/components/apis/generated/switch.md b/static/include/components/apis/generated/switch.md index d831800a4d..8a3a8844f6 100644 --- a/static/include/components/apis/generated/switch.md +++ b/static/include/components/apis/generated/switch.md @@ -370,6 +370,28 @@ status = await component.get_status() For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/switch/client/index.html#viam.components.switch.client.SwitchClient.get_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +mySwitch, err := switch.FromProvider(machine, "my_switch") + +status, err := mySwitch.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/services/apis/generated/data_manager.md b/static/include/services/apis/generated/data_manager.md index 247a471889..4ddc137cae 100644 --- a/static/include/services/apis/generated/data_manager.md +++ b/static/include/services/apis/generated/data_manager.md @@ -200,6 +200,28 @@ For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/ Get the current status of the data management service as a map of key-value pairs describing its state. {{< 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. + +**Returns:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myDataManagerSvc, err := datamanager.FromProvider(machine, "my_data_manager_svc") + +status, err := myDataManagerSvc.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + +{{% /tab %}} {{% tab name="TypeScript" %}} **Parameters:** diff --git a/static/include/services/apis/generated/discovery.md b/static/include/services/apis/generated/discovery.md index 60a97bcc8f..501422ada4 100644 --- a/static/include/services/apis/generated/discovery.md +++ b/static/include/services/apis/generated/discovery.md @@ -307,6 +307,28 @@ status = await service.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myDiscoverySvc, err := discovery.FromProvider(machine, "my_discovery_svc") + +status, err := myDiscoverySvc.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/services/apis/generated/generic_service.md b/static/include/services/apis/generated/generic_service.md index 1d61b0b6bb..01f463000e 100644 --- a/static/include/services/apis/generated/generic_service.md +++ b/static/include/services/apis/generated/generic_service.md @@ -130,6 +130,28 @@ status = await service.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myGenericService, err := generic.FromProvider(machine, "my_generic_service") + +status, err := myGenericService.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/services/apis/generated/mlmodel.md b/static/include/services/apis/generated/mlmodel.md index c09d7afbc1..179eba9383 100644 --- a/static/include/services/apis/generated/mlmodel.md +++ b/static/include/services/apis/generated/mlmodel.md @@ -203,6 +203,28 @@ status = await service.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myMlmodelSvc, err := mlmodel.FromProvider(machine, "my_mlmodel_svc") + +status, err := myMlmodelSvc.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{< /tabs >}} diff --git a/static/include/services/apis/generated/motion.md b/static/include/services/apis/generated/motion.md index 5448f1f496..f2e8b90618 100644 --- a/static/include/services/apis/generated/motion.md +++ b/static/include/services/apis/generated/motion.md @@ -1121,6 +1121,28 @@ status = await service.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myMotionSvc, err := motion.FromProvider(machine, "my_motion_svc") + +status, err := myMotionSvc.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/services/apis/generated/slam.md b/static/include/services/apis/generated/slam.md index b19a0766e2..8224bd2383 100644 --- a/static/include/services/apis/generated/slam.md +++ b/static/include/services/apis/generated/slam.md @@ -468,6 +468,28 @@ status = await service.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +mySLAMService, err := slam.FromProvider(machine, "my_slam_svc") + +status, err := mySLAMService.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} diff --git a/static/include/services/apis/generated/vision.md b/static/include/services/apis/generated/vision.md index 4d9550c429..eb7bb4dd74 100644 --- a/static/include/services/apis/generated/vision.md +++ b/static/include/services/apis/generated/vision.md @@ -888,6 +888,28 @@ status = await service.get_status() 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_status). +{{% /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:** + +- [(map[string]interface{})](https://pkg.go.dev/builtin#string) +- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. + +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myVisionSvc, err := vision.FromProvider(machine, "my_vision_svc") + +status, err := myVisionSvc.Status(context.Background()) +``` + +For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/resource#Resource). + {{% /tab %}} {{% tab name="TypeScript" %}} @@ -1054,7 +1076,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- (Promise< { classificationsSupported: boolean; detectionsSupported: boolean; objectPointCloudsSupported: boolean; }, >): * The properties of the vision service. +- (Promise< { classificationsSupported: boolean; defaultCamera: string | undefined; detectionsSupported: boolean; objectPointCloudsSupported: boolean; }, >): * The properties of the vision service. **Example:**