From 81ce499b6db0394be99a5d672e711aaa711c1728 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 6 Aug 2024 13:08:01 +0200 Subject: [PATCH] Update autogenerated methods (#3194) --- docs/get-started/installation/_index.md | 2 +- static/include/app/apis/generated/app.md | 2 +- static/include/components/apis/generated/board.md | 2 +- static/include/robot/apis/generated/robot.md | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/get-started/installation/_index.md b/docs/get-started/installation/_index.md index 35a2d7938c..4b311df25a 100644 --- a/docs/get-started/installation/_index.md +++ b/docs/get-started/installation/_index.md @@ -321,7 +321,7 @@ You can find additional assistance in the [Troubleshooting section](/appendix/tr {{< snippet "social.md" >}} -#### Computer not recognizing the microcontroller +#### Ubuntu not recognizing the microcontroller If you’re trying to connect a microcontroller using serial port to an Ubuntu system and the computer doesn’t seem to be recognizing the microcontroller, check if the `brltty` service or its secondary service `brltty-udev` are active (`brltty` is a service installed by default that provides access to a braille display): diff --git a/static/include/app/apis/generated/app.md b/static/include/app/apis/generated/app.md index 09361aaac4..774f138861 100644 --- a/static/include/app/apis/generated/app.md +++ b/static/include/app/apis/generated/app.md @@ -1440,7 +1440,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ ### CreateRegistryItem -Create a registry item +Create a registry item. {{< tabs >}} {{% tab name="Python" %}} diff --git a/static/include/components/apis/generated/board.md b/static/include/components/apis/generated/board.md index f3988b3c26..0962731762 100644 --- a/static/include/components/apis/generated/board.md +++ b/static/include/components/apis/generated/board.md @@ -866,7 +866,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. - `mode` [(pb.PowerMode)](https://pkg.go.dev/go.viam.com/api/component/board/v1#PowerMode): Options to specify power usage of the board: `boardpb.PowerMode_POWER_MODE_UNSPECIFIED`, `boardpb.PowerMode_POWER_MODE_NORMAL`, and `boardpb.PowerMode_POWER_MODE_OFFLINE_DEEP`. -- `duration` [(\*time.Duration)](https://pkg.go.dev/time#Duration): If provided, the board will exit the given power mode after the specified duration. +- `duration` [(*time.Duration)](https://pkg.go.dev/time#Duration): If provided, the board will exit the given power mode after the specified duration. **Returns:** diff --git a/static/include/robot/apis/generated/robot.md b/static/include/robot/apis/generated/robot.md index 3ded01ba9c..167136a9e4 100644 --- a/static/include/robot/apis/generated/robot.md +++ b/static/include/robot/apis/generated/robot.md @@ -305,13 +305,13 @@ 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. -- `pose` [(\*referenceframe.PoseInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#PoseInFrame): The pose that should be transformed. +- `pose` [(*referenceframe.PoseInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#PoseInFrame): The pose that should be transformed. - `dst` [(string)](https://pkg.go.dev/builtin#string): The name of the reference pose to transform the given pose to. -- `additionalTransforms` [([]\*referenceframe.LinkInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#LinkInFrame): Any additional transforms. +- `additionalTransforms` [([]*referenceframe.LinkInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#LinkInFrame): Any additional transforms. **Returns:** -- [(\*referenceframe.PoseInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#PoseInFrame): Transformed pose in frame. +- [(*referenceframe.PoseInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#PoseInFrame): Transformed pose in frame. - [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred. **Example:** @@ -371,7 +371,7 @@ If no names are passed in, the status of every resource configured on the machin **Returns:** -- None. +- ([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:**