Skip to content

DOCS-1464: Remove ModelAttributes #2313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2023
Merged

DOCS-1464: Remove ModelAttributes #2313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 0 additions & 49 deletions docs/components/board/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,55 +428,6 @@ err := myBoard.Status(context.Background(), nil)
{{% /tab %}}
{{< /tabs >}}

### ModelAttributes

Get the attributes related to the model of this board.

{{< tabs >}}
{{% tab name="Python" %}}

**Parameters:**

- None

**Returns:**

- [(Attributes)](https://python.viam.dev/autoapi/viam/components/board/index.html#viam.components.board.Board.Attributes): Attributes related to the model of this board.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀 That link shouldn't exist any more but it does! and it does because I forgot to delete the Attributes class even though it's no longer used. I'll go make a follow-up PR, and when that's in, the docs at this link should automatically update to match. I'm glad I saw this and noticed my mistake.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh! No worries, thanks for catching -- and teaching me about the process!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linking things up: the follow-up PR is viamrobotics/viam-python-sdk#501

Will include the board's innate `remote` attribute, which is not specified in configuration and is a `bool` indicating whether this model of board is accessed over a remote connection like gRPC.

For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/components/board/index.html#viam.components.board.Board.model_attributes).

```python
my_board = Board.from_robot(robot=robot, name="my_board")

# Get the attributes related to the model of this board.
attributes = await my_board.model_attributes()
```

{{% /tab %}}
{{% tab name="Go" %}}

**Parameters:**

- None

**Returns:**

- [(ModelAttributes)](https://pkg.go.dev/go.viam.com/rdk/components/board#ModelAttributes): Attributes related to the model of this board.
Will include the board's innate `remote` attribute, which is not specified in configuration and is a `bool` indicating whether this model of board is accessed over a remote connection like gRPC.

For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/components/board#ModelAttributes).

```go
myBoard, err := board.FromRobot(robot, "my_board")

// Get the attributes related to the model of this board.
attributes := myBoard.ModelAttributes()
```

{{% /tab %}}
{{< /tabs >}}

### SetPowerMode

Set the board to the indicated `PowerMode`.
Expand Down
1 change: 0 additions & 1 deletion static/include/components/apis/board.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Method Name | Description
[`AnalogReaderNames`](/components/board/#analogreadernames) | Get the `name` of every [`AnalogReader`](/components/board/#analogs).
[`DigitalInterruptNames`](/components/board/#digitalinterruptnames) | Get the `name` of every [`DigitalInterrupt`](/components/board/#digital_interrupts).
[`Status`](/components/board/#status) | Get the current status of this board.
[`ModelAttributes`](/components/board/#modelattributes) | Get the attributes related to the model of this board.
[`SetPowerMode`](/components/board/#setpowermode) | Set the board to the indicated power mode.
[`WriteAnalog`](/components/board/#writeanalog) | Write an analog value to a pin on the board.
[`GetGeometries`](/components/board/#getgeometries) | Get all the geometries associated with the board in its current configuration, in the [frame](/mobility/frame-system/) of the board.
Expand Down