Skip to content

Commit d65c225

Browse files
committed
More links
1 parent deb5a8e commit d65c225

File tree

14 files changed

+49
-49
lines changed

14 files changed

+49
-49
lines changed

docs/dev/reference/apis/fleet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The fleet management API supports the following methods:
4545
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).
4646
See the following example for reference.
4747

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

5050
```python {class="line-numbers linkable-line-numbers"}
5151
import asyncio

docs/dev/reference/apis/ml-training-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The ML training client API supports the following methods:
3030
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).
3131
See the following example for reference.
3232

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

3535
```python {class="line-numbers linkable-line-numbers"}
3636
import asyncio

docs/dev/reference/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -988,7 +988,7 @@ For more information on using data synced to the cloud to train machine learning
988988

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

991-
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.
991+
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.
992992
The constraint system also provides flexibility to specify that obstacles should only impact specific frames of a machine.
993993

994994
{{% /changelog %}}

docs/dev/reference/try-viam/reserve-a-rover.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ date: "2022-01-01"
1818
_Try Viam_ is a way to try out the Viam platform without setting up any hardware yourself.
1919
You can take over a Viam Rover in our robotics lab to play around!
2020

21-
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):
21+
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):
2222

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

docs/dev/reference/try-viam/rover-resources/rover-tutorial-1.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ All together, your kit looks like this:
7171
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/encoder-motors.jpg" resize="400x" declaredimensions=true alt="two motors with encoders" >}}
7272

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

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

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

9595
### 3D accelerometer
9696

@@ -99,7 +99,7 @@ For more information, see [Camera Component](/components/camera/).
9999
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.
100100
You can access it with a SPI (3-wire or 4-wire) or I<sup>2</sup>C digital interface.
101101

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

104104
### Buck converter
105105

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

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

docs/dev/reference/try-viam/rover-resources/rover-tutorial-fragments.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ Click **Save** in the upper right corner of the page to save your new configurat
4444
The fragment adds the following components to your machine's JSON configuration:
4545

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

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

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

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

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

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

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

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

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

docs/dev/reference/try-viam/rover-resources/rover-tutorial/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ All together, your kit looks like this:
7777
{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/encoder-motors.jpg" resize="400x" declaredimensions=true alt="two motors with encoders" >}}
7878

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

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

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

101101
### Motherboard
102102

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

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

docs/dev/reference/try-viam/try-viam-tutorial.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The order of these components may vary.
4848

4949
### Base control
5050

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

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

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

9696
### Camera control
9797

98-
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:
98+
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:
9999

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

112112
### Motor control
113113

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

154154
### Encoder configuration
155155

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

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

165165
### Motor configuration
166166

167-
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.
167+
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.
168168

169169
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.
170170

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

175175
### Base configuration
176176

177-
The [base component](/components/base/) is the platform that the other parts of a mobile robot attach to.
177+
The [base component](/operate/reference/components/base/) is the platform that the other parts of a mobile robot attach to.
178178
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.
179179
The base's type is `base` and its model is `wheeled` which configures a robot with wheels on its base, like the Viam Rover.
180180
The **left** and **right** attributes configure the motors on the left and right side of the rover, which are named `left` and `right`, respectively.
@@ -187,10 +187,10 @@ The **Spin Slip Factor** of 1.76 is used in steering calculations to account for
187187

188188
### Camera configuration
189189

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

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

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

0 commit comments

Comments
 (0)