Skip to content

Commit

Permalink
More links
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT committed Jan 7, 2025
1 parent deb5a8e commit d65c225
Show file tree
Hide file tree
Showing 14 changed files with 49 additions and 49 deletions.
2 changes: 1 addition & 1 deletion docs/dev/reference/apis/fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The fleet management API supports the following methods:
To use the Viam fleet management API, you first need to instantiate a [`ViamClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient) and then instantiate an [`AppClient`](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient).
See the following example for reference.

You can create an [API key](/cloud/rbac/#api-keys) on your settings page.
You can create an [API key](/manage/manage/access/) on your settings page.

```python {class="line-numbers linkable-line-numbers"}
import asyncio
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/apis/ml-training-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The ML training client API supports the following methods:
To use the Viam ML training client API, you first need to instantiate a [`ViamClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient) and then instantiate an [`MLTrainingClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient.ml_training_client).
See the following example for reference.

You can create an [API key](/cloud/rbac/#api-keys) on your settings page.
You can create an [API key](/manage/manage/access/) on your settings page.

```python {class="line-numbers linkable-line-numbers"}
import asyncio
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -988,7 +988,7 @@ For more information on using data synced to the cloud to train machine learning

{{% changelog date="2023-03-31" color="added" title="Motion planning with new `constraint` parameter" %}}

A new parameter, [`constraint`](/services/motion/constraints/), has been added to the [Motion service API](/dev/reference/apis/services/motion/#api), allowing you to define restrictions on the machine's movement.
A new parameter, [`constraint`](/operate/reference/services/motion/constraints/), has been added to the [Motion service API](/dev/reference/apis/services/motion/#api), allowing you to define restrictions on the machine's movement.
The constraint system also provides flexibility to specify that obstacles should only impact specific frames of a machine.

{{% /changelog %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/try-viam/reserve-a-rover.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ date: "2022-01-01"
_Try Viam_ is a way to try out the Viam platform without setting up any hardware yourself.
You can take over a Viam Rover in our robotics lab to play around!

Watch this tutorial video for a walkthrough of Try Viam, including [how to reserve a Viam Rover](#using-the-reservation-system), [navigate the Viam platform](/fleet/), and [drive the rover](/components/base/wheeled/#test-the-base):
Watch this tutorial video for a walkthrough of Try Viam, including [how to reserve a Viam Rover](#using-the-reservation-system), [navigate the Viam platform](/fleet/), and [drive the rover](/operate/reference/components/base/wheeled/#test-the-base):

{{<youtube embed_url="https://www.youtube-nocookie.com/embed/YYpZ9CVDwMU" max-width="600px">}}

Expand Down
10 changes: 5 additions & 5 deletions docs/dev/reference/try-viam/rover-resources/rover-tutorial-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ All together, your kit looks like this:
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/encoder-motors.jpg" resize="400x" declaredimensions=true alt="two motors with encoders" >}}

The motors come with integrated encoders.
For information on encoders, see [Encoder Component](/components/encoder/).
For more information on encoded DC motors, see [Encoded Motors](/components/motor/encoded-motor/).
For information on encoders, see [Encoder Component](/operate/reference/components/encoder/).
For more information on encoded DC motors, see [Encoded Motors](/operate/reference/components/motor/encoded-motor/).

The kit also includes stiffer suspension springs that you can substitute for the ones on the rover.
Generally, a stiff suspension helps with precise steering control.
Expand All @@ -90,7 +90,7 @@ L298 is a high voltage and high current motor drive chip, and H-Bridge is typica
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/webcam.jpg" resize="400x" declaredimensions=true alt="Webcam with cables" >}}

The webcam that comes with the kit is a standard USB camera device and the rover has a custom camera mount for it.
For more information, see [Camera Component](/components/camera/).
For more information, see [Camera Component](/operate/reference/components/camera/).

### 3D accelerometer

Expand All @@ -99,7 +99,7 @@ For more information, see [Camera Component](/components/camera/).
The [ADXL345](https://github.com/viam-modules/analog-devices/) sensor manufactured by Analog Devices is a digital 3-axis accelerometer that can read acceleration up to ±16g for high-resolution (13-bit) measurements.
You can access it with a SPI (3-wire or 4-wire) or I<sup>2</sup>C digital interface.

In Viam, you can configure it as a [movement sensor component](/components/movement-sensor/).
In Viam, you can configure it as a [movement sensor component](/operate/reference/components/movement-sensor/).

### Buck converter

Expand Down Expand Up @@ -280,7 +280,7 @@ The following are just a few ideas, but you can expand or modify the rover kit w

- For GPS navigation, we support NMEA (using serial and I<sup>2</sup>C) and RTK.
Make and model don't make a difference as long as you use these protocols.
See [Movement Sensor Component](/components/movement-sensor/) for more information.
See [Movement Sensor Component](/operate/reference/components/movement-sensor/) for more information.
- For [LiDAR laser range scanning](/services/slam/cartographer/), we recommend RPlidar (including A1, which is a sub-$100 LIDAR).
- For robot arms, we tried the [Yahboom DOFBOT robotics arm](https://category.yahboom.net/products/dofbot-jetson_nano) with success.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ Click **Save** in the upper right corner of the page to save your new configurat
The fragment adds the following components to your machine's JSON configuration:

- A [board component](/components/board/) named `local` representing the Raspberry Pi.
- Two [motors](/components/motor/gpio/) (`right` and `left`)
- Two [motors](/operate/reference/components/motor/gpio/) (`right` and `left`)
- The configured pin numbers correspond to where the motor drivers are connected to the board.
- Two [encoders](/components/encoder/single/), one for each motor
- A wheeled [base](/components/base/), an abstraction that coordinates the movement of the right and left motors
- Two [encoders](/operate/reference/components/encoder/single/), one for each motor
- A wheeled [base](/operate/reference/components/base/), an abstraction that coordinates the movement of the right and left motors
- Width between the wheel centers: 356 mm
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- A webcam [camera](/operate/reference/components/camera/webcam/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

Expand All @@ -75,14 +75,14 @@ Click **Save** in the upper right corner of the page to save your new configurat
The fragment adds the following components to your machine's JSON configuration:

- A [board component](/components/board/) named `local` representing the Raspberry Pi.
- Two [motors](/components/motor/gpio/) (`right` and `left`)
- Two [motors](/operate/reference/components/motor/gpio/) (`right` and `left`)
- The configured pin numbers correspond to where the motor drivers are connected to the board.
- Two [encoders](/components/encoder/single/), one for each motor
- A wheeled [base](/components/base/), an abstraction that coordinates the movement of the right and left motors
- Two [encoders](/operate/reference/components/encoder/single/), one for each motor
- A wheeled [base](/operate/reference/components/base/), an abstraction that coordinates the movement of the right and left motors
- Width between the wheel centers: 356 mm
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- A webcam [camera](/operate/reference/components/camera/webcam/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

Expand All @@ -107,14 +107,14 @@ The fragment adds the following components to your machine's JSON configuration:

- A [board component](/components/board/) named `local` representing the Raspberry Pi
- An I<sup>2</sup>C bus for connection to the accelerometer.
- Two [motors](/components/motor/gpio/) (`right` and `left`)
- Two [motors](/operate/reference/components/motor/gpio/) (`right` and `left`)
- The configured pin numbers correspond to where the motor drivers are connected to the board.
- Two [encoders](/components/encoder/single/), one for each motor
- A wheeled [base](/components/base/), an abstraction that coordinates the movement of the right and left motors
- Two [encoders](/operate/reference/components/encoder/single/), one for each motor
- A wheeled [base](/operate/reference/components/base/), an abstraction that coordinates the movement of the right and left motors
- Width between the wheel centers: 260 mm
- Wheel circumference: 217 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- A webcam [camera](/operate/reference/components/camera/webcam/)
- An [accelerometer](https://github.com/viam-modules/analog-devices/)

{{% alert title="Info" color="info" %}}
Expand Down Expand Up @@ -144,14 +144,14 @@ Click **Save** in the upper right corner of the page to save your new configurat
The fragment adds the following components to your machine's JSON configuration:

- A [board component](/components/board/) named `local` representing the Jetson.
- Two [motors](/components/motor/gpio/) (`right` and `left`)
- Two [motors](/operate/reference/components/motor/gpio/) (`right` and `left`)
- The configured pin numbers correspond to where the motor drivers are connected to the board.
- Two [encoders](/components/encoder/single/), one for each motor
- A wheeled [base](/components/base/), an abstraction that coordinates the movement of the right and left motors
- Two [encoders](/operate/reference/components/encoder/single/), one for each motor
- A wheeled [base](/operate/reference/components/base/), an abstraction that coordinates the movement of the right and left motors
- Width between the wheel centers: 356 mm
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- A webcam [camera](/operate/reference/components/camera/webcam/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

Expand All @@ -175,14 +175,14 @@ Click **Save** in the upper right corner of the page to save your new configurat
The fragment adds the following components to your machine's JSON configuration:

- A [board component](/components/board/) named `local` representing the Jetson.
- Two [motors](/components/motor/gpio/) (`right` and `left`)
- Two [motors](/operate/reference/components/motor/gpio/) (`right` and `left`)
- The configured pin numbers correspond to where the motor drivers are connected to the board.
- Two [encoders](/components/encoder/single/), one for each motor
- A wheeled [base](/components/base/), an abstraction that coordinates the movement of the right and left motors
- Two [encoders](/operate/reference/components/encoder/single/), one for each motor
- A wheeled [base](/operate/reference/components/base/), an abstraction that coordinates the movement of the right and left motors
- Width between the wheel centers: 356 mm
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- A webcam [camera](/operate/reference/components/camera/webcam/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ All together, your kit looks like this:
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/encoder-motors.jpg" resize="400x" declaredimensions=true alt="two motors with encoders" >}}

The motors come with integrated encoders.
For information on encoders, see [Encoder Component](/components/encoder/).
For more information on encoded DC motors, see [Encoded Motors](/components/motor/encoded-motor/).
For information on encoders, see [Encoder Component](/operate/reference/components/encoder/).
For more information on encoded DC motors, see [Encoded Motors](/operate/reference/components/motor/encoded-motor/).

The kit also includes stiffer suspension springs that you can substitute for the ones on the rover.
Generally, a stiff suspension helps with precise steering control.
Expand All @@ -96,7 +96,7 @@ L298 is a high voltage and high current motor drive chip, and H-Bridge is typica
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/webcam.jpg" resize="400x" declaredimensions=true alt="Webcam with cables" >}}

The webcam that comes with the kit is a standard USB camera device and the rover has a custom camera mount for it.
For more information, see [Camera Component](/components/camera/).
For more information, see [Camera Component](/operate/reference/components/camera/).

### Motherboard

Expand Down Expand Up @@ -419,7 +419,7 @@ The following are just a few ideas, but you can expand or modify the rover kit w

- For GPS navigation, we support NMEA (using serial and I<sup>2</sup>C) and RTK.
Make and model don't make a difference as long as you use these protocols.
See [Movement Sensor Component](/components/movement-sensor/) for more information.
See [Movement Sensor Component](/operate/reference/components/movement-sensor/) for more information.
- For [LiDAR laser range scanning](/services/slam/cartographer/), we recommend RPlidar (including A1, which is a sub-$100 LIDAR).
- For robot arms, we tried the [Yahboom DOFBOT robotics arm](https://category.yahboom.net/products/dofbot-jetson_nano) with success.

Expand Down
16 changes: 8 additions & 8 deletions docs/dev/reference/try-viam/try-viam-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The order of these components may vary.

### Base control

The [base component](/components/base/) is the platform that the other parts of a mobile machine attach to.
The [base component](/operate/reference/components/base/) is the platform that the other parts of a mobile machine attach to.

Click the `viam_base` component to expand the base control pane to reveal the camera feed and driving interfaces.

Expand Down Expand Up @@ -95,7 +95,7 @@ If you go from the from **Keyboard** to the **Discrete** tab, you can choose bet

### Camera control

While you can view the camera streams [from the base component panel](#camera-views), you can access more features on each individual [camera component](/components/camera/) panel. In these panels, you can:
While you can view the camera streams [from the base component panel](#camera-views), you can access more features on each individual [camera component](/operate/reference/components/camera/) panel. In these panels, you can:

- Set the refresh frequency
- Export screenshots
Expand All @@ -111,7 +111,7 @@ While you can view the camera streams [from the base component panel](#camera-vi

### Motor control

The [motor components](/components/motor/) enable you to move the base.
The [motor components](/operate/reference/components/motor/) enable you to move the base.
The motors are named `left` and `right`, corresponding to their location on the rover base.
Their initial state is **Idle**.
You can click on each motor panel and make the motor **RUN** or **STOP**.
Expand Down Expand Up @@ -153,7 +153,7 @@ For the Viam Rover, the board component is a Raspberry Pi with **Name** `local`,

### Encoder configuration

An [encoder](/components/encoder/) is a device that is used to sense angular position, direction and/or speed of rotation.
An [encoder](/operate/reference/components/encoder/) is a device that is used to sense angular position, direction and/or speed of rotation.
In this case, the encoders on the left and right motors are `Lenc` and `Renc` and configure the pins to `le` and `re`.

{{< alert title="Important" color="note" >}}
Expand All @@ -164,7 +164,7 @@ When configuring encoded motors for your own robot, you must configure the encod

### Motor configuration

Both [motors](/components/motor/) on this rover use the model `gpio` which is the model for basic DC motors that are connected to and controlled by the configured board.
Both [motors](/operate/reference/components/motor/) on this rover use the model `gpio` which is the model for basic DC motors that are connected to and controlled by the configured board.

The attributes section lists the board the motor is wired to, and since the rover's motors are encoded the user interface also shows the encoded motor attributes: the encoder name, motor ramp rate limit, encoder ticks per rotation, and max RPM limit.

Expand All @@ -174,7 +174,7 @@ Click **Switch to Builder** to return to the default graphical user interface.

### Base configuration

The [base component](/components/base/) is the platform that the other parts of a mobile robot attach to.
The [base component](/operate/reference/components/base/) is the platform that the other parts of a mobile robot attach to.
By configuring a base component, the individual components are organized to produce coordinated movement and you gain an interface to control the movement of the whole physical base of the robot without needing to send separate commands to individual motors.
The base's type is `base` and its model is `wheeled` which configures a robot with wheels on its base, like the Viam Rover.
The **left** and **right** attributes configure the motors on the left and right side of the rover, which are named `left` and `right`, respectively.
Expand All @@ -187,10 +187,10 @@ The **Spin Slip Factor** of 1.76 is used in steering calculations to account for

### Camera configuration

The [camera component](/components/camera/) configures the webcam that is plugged into the Raspberry Pi of the rover.
The [camera component](/operate/reference/components/camera/) configures the webcam that is plugged into the Raspberry Pi of the rover.
The camera component has the **Type** `camera`, the **Model** `webcam`, and the **Video Path** is `video0`.

For more information on choosing the correct video path, refer to our [webcam documentation](/components/camera/webcam/).
For more information on choosing the correct video path, refer to our [webcam documentation](/operate/reference/components/camera/webcam/).

![The video path in the webcam configuration panel is set to 'video0'.](appendix/try-viam/try-viam/camera-config.png)

Expand Down
Loading

0 comments on commit d65c225

Please sign in to comment.