Skip to content

Commit 12b6514

Browse files
Fix 13 app-linked anchor URLs across 10 pages (#4975)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 47b7b21 commit 12b6514

11 files changed

Lines changed: 92 additions & 19 deletions

File tree

docs/build-modules/write-a-logic-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ lifecycle, config validation, dependency, and deployment patterns are the same.
3939
For background on the generic service API, module lifecycle, dependencies, and
4040
background tasks, see the [overview](/build-modules/overview/).
4141

42-
## Steps
42+
## Steps {#program-control-logic-in-module}
4343

4444
When writing a logic module, follow the steps outlined below. To illustrate
4545
each step we'll use a temperature alert monitor as a worked example. It watches

docs/data/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ aliases:
3232
- /use-cases/image-data/
3333
- /get-started/collect-data/
3434
- /fleet/data-management/
35-
- /data-ai/capture-data/capture-sync/
3635
- /data/data-capture-reference/
3736
- /data/how-sync-works/
3837
- /data-ai/capture-data/advanced/how-sync-works/

docs/data/capture-sync/capture-and-sync-data.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ aliases:
1010
- /data/capture-and-sync-data/
1111
- /build/foundation/capture-and-sync-data/
1212
- /foundation/capture-and-sync-data/
13+
- /data-ai/capture-data/capture-sync/
1314
---
1415

1516
Configure your machine to automatically record sensor readings, camera images, and other component data, then sync it to the cloud. For an overview of how data capture and sync work, see the [Manage data overview](/data/overview/).
@@ -19,7 +20,7 @@ Configure your machine to automatically record sensor readings, camera images, a
1920
Go to [app.viam.com](https://app.viam.com) and navigate to your machine.
2021
Confirm it shows as **Live** in the upper left.
2122

22-
## 2. Enable data capture on a component
23+
## 2. Enable data capture on a component {#configure-data-capture}
2324

2425
1. Find your component (for example, `my-camera`) in the machine configuration.
2526
2. Click the **Data Capture** button.
@@ -87,6 +88,27 @@ Wait 30 seconds to a minute for data to accumulate and sync, then:
8788

8889
If you see data flowing in, capture and sync are working correctly.
8990

91+
## Supported resources {#supported-resources}
92+
93+
Any built-in or modular component that implements a capturable method can be configured for data capture. The following table lists the most commonly captured component types and their methods:
94+
95+
| Component type | Capturable methods |
96+
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
97+
| Camera | `ReadImage`, `GetImages`, `NextPointCloud` |
98+
| Sensor | `GetReadings` |
99+
| Movement sensor | `GetPosition`, `GetLinearVelocity`, `GetAngularVelocity`, `GetCompassHeading`, `GetLinearAcceleration`, `GetOrientation`, `GetReadings` |
100+
| Encoder | `GetTicksCount` |
101+
| Motor | `GetPosition`, `IsPowered` |
102+
| Power sensor | `GetVoltage`, `GetCurrent`, `GetPower`, `GetReadings` |
103+
| Servo | `GetPosition` |
104+
| Arm | `GetEndPosition`, `GetJointPositions` |
105+
| Gantry | `GetPosition`, `GetLengths` |
106+
| Board | `Analogs`, `Gpios` |
107+
| Vision service | `CaptureAllFromCamera` |
108+
| SLAM service | `GetPosition`, `GetPointCloudMap` |
109+
110+
Every component and service also supports capturing `DoCommand` responses. Modular components that return readings through any of these methods are automatically capturable.
111+
90112
## Troubleshooting
91113

92114
{{< expand "No data appears in the Data tab" >}}

docs/data/visualize-data.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ Custom visualization with Viam SDKs gives you complete control. You write code t
4343
queries data through the Viam SDK and renders it however you want -- matplotlib
4444
charts, Plotly dashboards, HTML reports, or any other format.
4545

46-
## Build a Viam Teleop dashboard
46+
<a id="dashboard"></a>
47+
48+
## Build a Viam Teleop dashboard {#teleop}
4749

4850
The Viam Teleop dashboard is the fastest way to visualize data from a single machine.
4951

docs/fleet/provision-devices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ If you are setting up a small number of machines manually, you can skip provisio
3535
- A [fragment](/fleet/reuse-configuration/) with the configuration your machines should use. Note the fragment ID.
3636
- A device with a supported Linux OS. See the [platform requirements](/set-up-a-machine/) for supported platforms.
3737

38-
## 1. Create the defaults file
38+
## 1. Create the defaults file {#configure-agent-provisioning}
3939

4040
Create a file called `viam-defaults.json` that defines the provisioning behavior. At minimum, specify a `fragment_id`.
4141

docs/fleet/system-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ In the machine settings card, open **Settings** and expand **Known Networks**. C
5454
| `ipv4_gateway` | string || IPv4 gateway address. |
5555
| `ipv4_route_metric` | integer | `0` | Route metric. Lower values are preferred. `0` defaults to 100 for wired, 600 for wireless. |
5656

57-
## Configure tunneling
57+
## Configure tunneling {#configure-networking-settings-for-tunneling}
5858

5959
Allow secure port forwarding from a local machine to a remote machine through Viam's cloud connection. You must list allowed ports in the machine configuration.
6060

docs/hardware/configure-hardware.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ You don't need to think about where a model comes from. The Viam app shows all a
5656

5757
If no model exists for your hardware, you can [write your own module](/build-modules/write-a-driver-module/) that provides a model implementing the component API.
5858

59+
<a id="browse-supported-hardware-by-component-api"></a>
60+
61+
Browse all available components and services in the [Viam registry](https://app.viam.com/registry).
62+
5963
## Switching hardware without changing code
6064

6165
Because every model of a given type exposes the same API, your application code does not change when you swap hardware.
@@ -70,7 +74,7 @@ This works whether `drive-motor` is configured as a `gpio` motor on a Raspberry
7074
To switch hardware, you change the model and attributes in your machine's configuration.
7175
Your code stays the same.
7276

73-
## Add a component
77+
## Add a component {#configure-hardware-on-your-machine}
7478

7579
The process for adding any component is the same whether you're adding a motor,
7680
a sensor, a board, or anything else. For step-by-step guides for specific

docs/hardware/multi-machine/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Unless you configure a prefix, even the name stays the same.
3333

3434
Viam gives you two ways to create this connection: sub-parts and remote parts.
3535

36-
## Pick a pattern
36+
## Pick a pattern {#machine-parts}
3737

3838
<!-- prettier-ignore -->
3939
| | Sub-part | Remote part |
Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
---
2-
title: "Device Setup"
3-
linkTitle: "Device Setup"
2+
title: "Device setup guides"
3+
linkTitle: "Device setup"
44
weight: 55
5+
layout: "docs"
56
type: "docs"
6-
no_list: true
7-
description: "Setup guides for single-board computers and other devices supported by Viam."
7+
description: "Board-specific setup instructions for single-board computers and microcontrollers supported by Viam."
88
---
9+
10+
Before installing Viam on a single-board computer, follow the setup guide for your board to ensure the OS and firmware are ready.
11+
12+
## Single-board computers
13+
14+
| Board | Guide |
15+
| ------------------------------ | ----------------------------------------------------------------------- |
16+
| Raspberry Pi (all models) | [Raspberry Pi setup](/reference/device-setup/rpi-setup/) |
17+
| NVIDIA Jetson Nano / Orin Nano | [Jetson Nano setup](/reference/device-setup/jetson-nano-setup/) |
18+
| NVIDIA Jetson AGX Orin | [Jetson AGX Orin setup](/reference/device-setup/jetson-agx-orin-setup/) |
19+
| BeagleBone AI-64 | [BeagleBone setup](/reference/device-setup/beaglebone-setup/) |
20+
| Orange Pi Zero 2 | [Orange Pi Zero2 setup](/reference/device-setup/orange-pi-zero2/) |
21+
| Orange Pi 3 LTS | [Orange Pi 3 LTS setup](/reference/device-setup/orange-pi-3-lts/) |
22+
| ODROID-C4 | [ODROID-C4 setup](/reference/device-setup/odroid-c4-setup/) |
23+
| Pumpkin | [Pumpkin setup](/reference/device-setup/pumpkin/) |
24+
| SK-TDA4VM | [SK-TDA4VM setup](/reference/device-setup/sk-tda4vm/) |
25+
26+
## Microcontrollers
27+
28+
| Board | Guide |
29+
| ----- | ------------------------------------------------------- |
30+
| ESP32 | [Set up an ESP32](/reference/device-setup/setup-micro/) |
31+
32+
## After setup
33+
34+
Once your board is ready, return to [Set up a machine](/set-up-a-machine/) to install Viam and connect to the cloud.

docs/set-up-a-machine/overview.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,13 @@ A banner prompts you to set up the machine part.
5050
1. Click **View setup instructions** in the banner.
5151
2. In the wizard dialog that opens, click **Go to Advanced setup**.
5252

53-
## 3. Select your platform
53+
## 3. Select your platform {#sbc-setup-instructions}
5454

5555
Use the **Platform you want to run on** dropdown to select the operating system and architecture of the compute machine for your robot, the computer to which you've attached cameras, sensors, arms, or other components.
5656

5757
Options include Linux / Aarch64, Linux / x86, Mac, Windows native, Windows (WSL), Linux / Armv7l, and ESP32.
5858

59-
{{< alert title="Tip" color="tip" >}}
60-
61-
If you're using a single-board computer like a Raspberry Pi or NVIDIA Jetson, make sure it's running a compatible Linux OS before continuing.
62-
The setup page links to an [installation guide](/reference/device-setup/) for supported single-board computers.
63-
64-
{{< /alert >}}
59+
If you're using a single-board computer, make sure it's running a compatible Linux OS before continuing. See [Device setup guides](/reference/device-setup/) for board-specific instructions.
6560

6661
## 4. Select your installation method
6762

0 commit comments

Comments
 (0)