From 99274bd38b4fbfff0c8b93ad28a03630dc7dcc60 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Mon, 16 Dec 2024 16:47:16 +0100 Subject: [PATCH 1/2] DOCS-3245: Remove status endpoint from SDKs --- .github/workflows/sdk_protos_map.csv | 1 - .../include/components/apis/generated/arm.md | 29 +++++-- .../include/components/apis/generated/base.md | 16 ++-- .../components/apis/generated/board.md | 24 +++--- .../components/apis/generated/camera.md | 8 +- .../components/apis/generated/gantry.md | 14 ++-- .../apis/generated/generic_component.md | 2 +- .../components/apis/generated/gripper.md | 10 +-- .../components/apis/generated/motor.md | 22 ++--- .../apis/generated/movement_sensor.md | 20 ++--- .../components/apis/generated/power_sensor.md | 10 +-- .../components/apis/generated/sensor.md | 4 +- .../components/apis/generated/servo.md | 10 +-- .../robot/apis/generated/robot-table.md | 1 - static/include/robot/apis/generated/robot.md | 80 ++----------------- .../apis/overrides/protos/robot.GetStatus.md | 3 - .../services/apis/generated/mlmodel.md | 17 +++- .../include/services/apis/generated/vision.md | 12 +-- 18 files changed, 118 insertions(+), 165 deletions(-) delete mode 100644 static/include/robot/apis/overrides/protos/robot.GetStatus.md diff --git a/.github/workflows/sdk_protos_map.csv b/.github/workflows/sdk_protos_map.csv index 8291740077..1e1e373acb 100644 --- a/.github/workflows/sdk_protos_map.csv +++ b/.github/workflows/sdk_protos_map.csv @@ -442,7 +442,6 @@ robot,DiscoverComponents,,discover_components,DiscoverComponents,discoverCompone robot,FrameSystemConfig,,get_frame_system_config,FrameSystemConfig, robot,TransformPose,,transform_pose,TransformPose, robot,TransformPCD,,,TransformPointCloud, -robot,GetStatus,,get_status,Status, robot,StreamStatus,,,, robot,StopAll,,stop_all,StopAll, robot,RestartModule,,,RestartModule, diff --git a/static/include/components/apis/generated/arm.md b/static/include/components/apis/generated/arm.md index d2829459f4..7f5ea7b112 100644 --- a/static/include/components/apis/generated/arm.md +++ b/static/include/components/apis/generated/arm.md @@ -57,7 +57,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Pose](https://flutter.viam.dev/viam_sdk/Pose-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Pose](https://flutter.viam.dev/viam_sdk/Pose-class.html)\> **Example:** @@ -142,7 +142,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -237,7 +237,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -273,6 +273,21 @@ This will block until done or a new operation cancels this one. - [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. +**Example:** + +```go {class="line-numbers linkable-line-numbers"} +myArm, err := arm.FromRobot(machine, "my_arm") + +// Declare a 2D array of values with your desired rotational value (in radians) for each joint on the arm. +inputs := [][]referenceframe.Input{ + referenceframe.FloatsToInputs([]float64{0, math.Pi/2, math.Pi}) + referenceframe.FloatsToInputs([]float64{0, 0, 0}) +} + +// Move each joint of the arm through the positions in the slice defined above +err = myArm.MoveThroughJointPositions(context.Background(), inputs, nil, nil) +``` + For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/components/arm#Arm). {{% /tab %}} @@ -338,7 +353,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\> **Example:** @@ -457,7 +472,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -530,7 +545,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -694,7 +709,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/base.md b/static/include/components/apis/generated/base.md index 652412ecd0..c57285028c 100644 --- a/static/include/components/apis/generated/base.md +++ b/static/include/components/apis/generated/base.md @@ -68,7 +68,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -147,7 +147,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -261,7 +261,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -351,7 +351,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -381,7 +381,7 @@ Get the width and turning radius of the {{< glossary_tooltip term_id="model" tex **Returns:** -- (viam.components.base.Base.Properties): The properties of the base. +- ([viam.components.base.Base.Properties](https://python.viam.dev/autoapi/viam/components/base/index.html#viam.components.base.Base.Properties)): The properties of the base. **Example:** @@ -503,7 +503,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -580,7 +580,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -745,7 +745,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/board.md b/static/include/components/apis/generated/board.md index 3d5772e9ca..184fea2545 100644 --- a/static/include/components/apis/generated/board.md +++ b/static/include/components/apis/generated/board.md @@ -68,7 +68,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -150,7 +150,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -240,7 +240,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> **Example:** @@ -325,7 +325,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -407,7 +407,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\> **Example:** @@ -496,7 +496,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -580,7 +580,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\> **Example:** @@ -666,7 +666,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[AnalogValue](https://flutter.viam.dev/viam_sdk/AnalogValue.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[AnalogValue](https://flutter.viam.dev/viam_sdk/AnalogValue.html)\> **Example:** @@ -750,7 +750,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -841,7 +841,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)\<[Tick](https://flutter.viam.dev/viam_sdk/Tick.html)\> +- [Stream](https://api.flutter.dev/flutter/dart-core/Stream-class.html)\<[Tick](https://flutter.viam.dev/viam_sdk/Tick.html)\> **Example:** @@ -929,7 +929,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -1223,7 +1223,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/camera.md b/static/include/components/apis/generated/camera.md index 1b4933f343..e13f2d99ec 100644 --- a/static/include/components/apis/generated/camera.md +++ b/static/include/components/apis/generated/camera.md @@ -111,7 +111,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\> **Example:** @@ -254,7 +254,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\> **Example:** @@ -315,7 +315,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[CameraProperties](https://flutter.viam.dev/viam_sdk/CameraProperties.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[CameraProperties](https://flutter.viam.dev/viam_sdk/CameraProperties.html)\> **Example:** @@ -369,7 +369,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/gantry.md b/static/include/components/apis/generated/gantry.md index 4c6f86312b..743d81c07e 100644 --- a/static/include/components/apis/generated/gantry.md +++ b/static/include/components/apis/generated/gantry.md @@ -58,7 +58,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\> **Example:** @@ -149,7 +149,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -222,7 +222,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\> **Example:** @@ -293,7 +293,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -373,7 +373,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -447,7 +447,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -498,7 +498,7 @@ If you are implementing your own gantry and add features that have no built-in A **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/generic_component.md b/static/include/components/apis/generated/generic_component.md index f7f57c5c01..01ce00bb53 100644 --- a/static/include/components/apis/generated/generic_component.md +++ b/static/include/components/apis/generated/generic_component.md @@ -63,7 +63,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/gripper.md b/static/include/components/apis/generated/gripper.md index 917862143a..e947196dd4 100644 --- a/static/include/components/apis/generated/gripper.md +++ b/static/include/components/apis/generated/gripper.md @@ -57,7 +57,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -130,7 +130,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -207,7 +207,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -281,7 +281,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -395,7 +395,7 @@ If you are implementing your own gripper and add features that have no built-in **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/motor.md b/static/include/components/apis/generated/motor.md index 0b710ed950..de1e8eb1b2 100644 --- a/static/include/components/apis/generated/motor.md +++ b/static/include/components/apis/generated/motor.md @@ -63,7 +63,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -137,7 +137,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -217,7 +217,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -296,7 +296,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -370,7 +370,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -449,7 +449,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> **Example:** @@ -530,7 +530,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[MotorProperties](https://flutter.viam.dev/viam_sdk/MotorProperties.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[MotorProperties](https://flutter.viam.dev/viam_sdk/MotorProperties.html)\> **Example:** @@ -611,7 +611,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[PowerState](https://flutter.viam.dev/viam_sdk/PowerState-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[PowerState](https://flutter.viam.dev/viam_sdk/PowerState-class.html)\> **Example:** @@ -693,7 +693,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -768,7 +768,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -820,7 +820,7 @@ If you are implementing your own motor and add features that have no built-in AP **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/movement_sensor.md b/static/include/components/apis/generated/movement_sensor.md index 26e7f2b2e5..bd192f854d 100644 --- a/static/include/components/apis/generated/movement_sensor.md +++ b/static/include/components/apis/generated/movement_sensor.md @@ -60,7 +60,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Vector3](https://flutter.viam.dev/viam_sdk/Vector3-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Vector3](https://flutter.viam.dev/viam_sdk/Vector3-class.html)\> **Example:** @@ -141,7 +141,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Vector3](https://flutter.viam.dev/viam_sdk/Vector3-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Vector3](https://flutter.viam.dev/viam_sdk/Vector3-class.html)\> **Example:** @@ -216,7 +216,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> **Example:** @@ -299,7 +299,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Orientation](https://flutter.viam.dev/viam_sdk/Orientation-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Orientation](https://flutter.viam.dev/viam_sdk/Orientation-class.html)\> **Example:** @@ -376,7 +376,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Position](https://flutter.viam.dev/viam_sdk/Position-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Position](https://flutter.viam.dev/viam_sdk/Position-class.html)\> **Example:** @@ -451,7 +451,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Properties](https://flutter.viam.dev/viam_sdk/Properties.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Properties](https://flutter.viam.dev/viam_sdk/Properties.html)\> **Example:** @@ -540,7 +540,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Accuracy](https://flutter.viam.dev/viam_sdk/Accuracy.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Accuracy](https://flutter.viam.dev/viam_sdk/Accuracy.html)\> **Example:** @@ -618,7 +618,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Vector3](https://flutter.viam.dev/viam_sdk/Vector3-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Vector3](https://flutter.viam.dev/viam_sdk/Vector3-class.html)\> **Example:** @@ -693,7 +693,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** @@ -794,7 +794,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/power_sensor.md b/static/include/components/apis/generated/power_sensor.md index 8430209f88..c16292dff2 100644 --- a/static/include/components/apis/generated/power_sensor.md +++ b/static/include/components/apis/generated/power_sensor.md @@ -58,7 +58,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Voltage](https://flutter.viam.dev/viam_sdk/Voltage.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Voltage](https://flutter.viam.dev/viam_sdk/Voltage.html)\> **Example:** @@ -133,7 +133,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Current](https://flutter.viam.dev/viam_sdk/Current.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Current](https://flutter.viam.dev/viam_sdk/Current.html)\> **Example:** @@ -207,7 +207,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\> **Example:** @@ -279,7 +279,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** @@ -379,7 +379,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/sensor.md b/static/include/components/apis/generated/sensor.md index 6cba6b44bb..af592f6c92 100644 --- a/static/include/components/apis/generated/sensor.md +++ b/static/include/components/apis/generated/sensor.md @@ -57,7 +57,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** @@ -108,7 +108,7 @@ If you are implementing your own sensor and add features that have no built-in A **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/components/apis/generated/servo.md b/static/include/components/apis/generated/servo.md index 98eee445e9..05d5c87580 100644 --- a/static/include/components/apis/generated/servo.md +++ b/static/include/components/apis/generated/servo.md @@ -75,7 +75,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -165,7 +165,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\> **Example:** @@ -240,7 +240,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\> **Example:** @@ -317,7 +317,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -368,7 +368,7 @@ If you are implementing your own servo and add features that have no built-in AP **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** diff --git a/static/include/robot/apis/generated/robot-table.md b/static/include/robot/apis/generated/robot-table.md index 85b55162d1..0c7df231ac 100644 --- a/static/include/robot/apis/generated/robot-table.md +++ b/static/include/robot/apis/generated/robot-table.md @@ -10,7 +10,6 @@ | [`FrameSystemConfig`](/appendix/apis/robot/#framesystemconfig) | Get the configuration of the frame system of a given machine. | | [`TransformPose`](/appendix/apis/robot/#transformpose) | Transform a given source Pose from the original reference frame to a new destination reference frame. | | [`TransformPCD`](/appendix/apis/robot/#transformpcd) | Transforms the pointcloud to the desired frame in the robot's frame system. | -| [`GetStatus`](/appendix/apis/robot/#getstatus) | Get the status of the resources on the machine. | | [`StopAll`](/appendix/apis/robot/#stopall) | Cancel all current and outstanding operations for the machine and stop all actuators and movement. | | [`RestartModule`](/appendix/apis/robot/#restartmodule) | Reload a module as if its config changed. | | [`Log`](/appendix/apis/robot/#log) | Create a LogEntry object from the log to send to the RDK over gRPC. | diff --git a/static/include/robot/apis/generated/robot.md b/static/include/robot/apis/generated/robot.md index bc74f39cae..e22e054805 100644 --- a/static/include/robot/apis/generated/robot.md +++ b/static/include/robot/apis/generated/robot.md @@ -220,7 +220,7 @@ For more information, see the [Typescript SDK Docs](https://ts.viam.dev/classes/ **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Discovery](https://flutter.viam.dev/viam_sdk/Discovery-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Discovery](https://flutter.viam.dev/viam_sdk/Discovery-class.html)\>\> **Example:** @@ -401,76 +401,6 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r {{% /tab %}} {{< /tabs >}} -### GetStatus - -Get the status of the resources on the machine. -You can provide a list of ResourceNames for which you want statuses. -If no names are passed in, the status of every resource configured on the machine is returned. - -{{< tabs >}} -{{% tab name="Python" %}} - -**Parameters:** - -- `components` ([List[viam.proto.common.ResourceName]](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.ResourceName)) (optional): Optional list of ResourceName for components you want statuses. - -**Returns:** - -- ([List[viam.proto.robot.Status]](https://python.viam.dev/autoapi/viam/proto/robot/index.html#viam.proto.robot.Status)): A list of statuses for each requested resource. - -**Example:** - -```python {class="line-numbers linkable-line-numbers"} -# Get the status of the resources on the machine. -statuses = await machine.get_status() -resource_statuses = machine_status.resources -``` - -For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/robot/client/index.html#viam.robot.client.RobotClient.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. -- `resourceNames` [([]resource.Name)](https://pkg.go.dev/go.viam.com/rdk/resource#Name): A list of resource names for components you want the status of. If no names are passed in, all resource statuses are returned. - -**Returns:** - -- [([]Status)](https://pkg.go.dev/go.viam.com/rdk/robot#Status): The `Status` of each resource queried. If no resource was provided as a parameter, the status of all resources is returned. -- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. - -**Example:** - -```go {class="line-numbers linkable-line-numbers"} -status, err := machine.Status(context.Background(), nil) -``` - -For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/robot#Robot). - -{{% /tab %}} -{{% tab name="TypeScript" %}} - -**Parameters:** - -- `resourceNames` [(commonApi.ResourceName[])](https://ts.viam.dev/classes/commonApi.ResourceName.html): An optional array of ResourceNames for components you want the status of. - If no names are passed in, all resource statuses are returned. - -**Returns:** - -- [(robotApi.Status[])](https://ts.viam.dev/classes/robotApi.Status.html): An array containing the status of each resource. - -For more information, see the [TypeScript SDK Docs](https://ts.viam.dev/classes/RobotClient.html#transformPCD). - -```typescript {class="line-numbers linkable-line-numbers"} -// Get the status of the resources on the machine. -const status = await machine.getStatus(); -``` - -{{% /tab %}} -{{< /tabs >}} - ### StopAll Cancel all current and outstanding operations for the machine and stop all actuators and movement. @@ -642,7 +572,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[CloudMetadata](https://flutter.viam.dev/viam_sdk/CloudMetadata.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[CloudMetadata](https://flutter.viam.dev/viam_sdk/CloudMetadata.html)\> **Example:** @@ -784,7 +714,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[RobotClient](https://flutter.viam.dev/viam_sdk/RobotClient-class.html)\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[RobotClient](https://flutter.viam.dev/viam_sdk/RobotClient-class.html)\> **Example:** @@ -878,7 +808,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** @@ -994,7 +924,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\ +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\ **Example:** diff --git a/static/include/robot/apis/overrides/protos/robot.GetStatus.md b/static/include/robot/apis/overrides/protos/robot.GetStatus.md deleted file mode 100644 index 0aba80a9bc..0000000000 --- a/static/include/robot/apis/overrides/protos/robot.GetStatus.md +++ /dev/null @@ -1,3 +0,0 @@ -Get the status of the resources on the machine. -You can provide a list of ResourceNames for which you want statuses. -If no names are passed in, the status of every resource configured on the machine is returned. diff --git a/static/include/services/apis/generated/mlmodel.md b/static/include/services/apis/generated/mlmodel.md index 1a1526da8e..42e95ddce5 100644 --- a/static/include/services/apis/generated/mlmodel.md +++ b/static/include/services/apis/generated/mlmodel.md @@ -50,7 +50,20 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```go {class="line-numbers linkable-line-numbers"} -input_tensors := ml.Tensors{"0": tensor.New(tensor.WithShape(1, 2, 3), tensor.WithBacking([]int{1, 2, 3, 4, 5, 6}))} +import ( + "go.viam.com/rdk/ml" + "gorgonia.org/tensor" + ) + +myMLModel, err := mlmodel.FromRobot(machine, "my_mlmodel") + +input_tensors := ml.Tensors{ + "image": tensor.New( + tensor.Of(tensor.Uint8), + tensor.WithShape(1, 384, 384, 3), + tensor.WithBacking(make([]uint8, 1*384*384*3)), + ), +} output_tensors, err := myMLModel.Infer(context.Background(), input_tensors) ``` @@ -101,7 +114,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ **Example:** ```go {class="line-numbers linkable-line-numbers"} -myMLModel, err := mlmodel.FromRobot(machine, "my_mlmodel_service") +myMLModel, err := mlmodel.FromRobot(machine, "my_mlmodel") metadata, err := myMLModel.Metadata(context.Background()) ``` diff --git a/static/include/services/apis/generated/vision.md b/static/include/services/apis/generated/vision.md index 0b1669d4bf..c1378e0847 100644 --- a/static/include/services/apis/generated/vision.md +++ b/static/include/services/apis/generated/vision.md @@ -75,7 +75,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Detection](https://flutter.viam.dev/viam_protos.service.vision/Detection-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Detection](https://flutter.viam.dev/viam_protos.service.vision/Detection-class.html)\>\> **Example:** @@ -180,7 +180,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Detection](https://flutter.viam.dev/viam_protos.service.vision/Detection-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Detection](https://flutter.viam.dev/viam_protos.service.vision/Detection-class.html)\>\> **Example:** @@ -271,7 +271,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Classification](https://flutter.viam.dev/viam_protos.service.vision/Classification-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Classification](https://flutter.viam.dev/viam_protos.service.vision/Classification-class.html)\>\> **Example:** @@ -379,7 +379,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Classification](https://flutter.viam.dev/viam_protos.service.vision/Classification-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[Classification](https://flutter.viam.dev/viam_protos.service.vision/Classification-class.html)\>\> **Example:** @@ -473,7 +473,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/s **Returns:** -- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[PointCloudObject](https://flutter.viam.dev/viam_protos.common.common/PointCloudObject-class.html)\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[PointCloudObject](https://flutter.viam.dev/viam_protos.common.common/PointCloudObject-class.html)\>\> **Example:** @@ -662,7 +662,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r **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\>\> +- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\> **Example:** From 37e902e00ffd0853398f8cc611d79a8a955506bf Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Mon, 16 Dec 2024 16:50:28 +0100 Subject: [PATCH 2/2] Fix build --- .github/workflows/run-htmltest.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/run-htmltest.yml b/.github/workflows/run-htmltest.yml index d575d8e050..3d46ebaa02 100644 --- a/.github/workflows/run-htmltest.yml +++ b/.github/workflows/run-htmltest.yml @@ -24,7 +24,7 @@ jobs: - name: Set up Hugo uses: peaceiris/actions-hugo@v2 with: - hugo-version: "latest" + hugo-version: "0.128.2" extended: true - name: Get Date