Skip to content

Commit f4b3fb2

Browse files
Merge branch 'main' into claude/elated-boyd-553b72
2 parents 400cb60 + 653d939 commit f4b3fb2

34 files changed

Lines changed: 47 additions & 48 deletions

docs/hardware/common-components/add-a-base.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Add a base to your machine's configuration to drive a mobile robot with movement
1818

1919
A base component gives you a movement API (`MoveStraight`, `Spin`, `SetVelocity`, `Stop`) regardless of the underlying drive system. The most common model is `wheeled`, which handles differential steering for robots with left and right motors. Other models exist for different platforms, including `sensor-controlled` (adds IMU feedback to improve accuracy) and module-based models for specific hardware.
2020

21-
Browse all available base models in the [Viam registry](https://app.viam.com/registry?type=component&subtype=base).
21+
Search for `base` in the [Viam registry](https://app.viam.com/registry) to see available models.
2222

2323
This page covers the `wheeled` model. You configure your motors first, then the base references them.
2424

@@ -45,7 +45,7 @@ Viam-maintained base modules:
4545
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
4646
| [`viam:controlled-components`](https://app.viam.com/module/viam/controlled-components) | Sensor-controlled base that adds PID feedback from a movement sensor to another base |
4747

48-
For bases not covered above, browse [all base modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=base).
48+
For bases not covered above, search for `base` in the [Viam registry](https://app.viam.com/registry).
4949

5050
## Steps
5151

docs/hardware/common-components/add-a-board.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A board component exposes the low-level I/O on your single-board computer:
2323

2424
Most of the time a board represents the single-board computer itself (Raspberry Pi, Jetson, Orange Pi). A board can also represent an IO expander such as the [PCA9685](https://app.viam.com/module/viam/pca) or a microcontroller connected over serial that exposes GPIO-like interfaces. In both cases, motors, encoders, and servos reference the board by name to access the pins they're wired to.
2525

26-
Browse all available board models in the [Viam registry](https://app.viam.com/registry?type=component&subtype=board).
26+
Search for `board` in the [Viam registry](https://app.viam.com/registry) to see available models.
2727

2828
{{< alert title="Pin numbering" color="note" >}}
2929

@@ -50,7 +50,7 @@ Viam-maintained board modules:
5050
| [`viam:texas-instruments`](https://app.viam.com/module/viam/texas-instruments) | Texas Instruments TDA4VM board |
5151
| [`viam:pca`](https://app.viam.com/module/viam/pca) | PCA9685 16-channel PWM IO expander |
5252

53-
For boards not covered above, browse [all board modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=board).
53+
For boards not covered above, search for `board` in the [Viam registry](https://app.viam.com/registry).
5454

5555
## Steps
5656

docs/hardware/common-components/add-a-button.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Add a button to your machine's configuration so you can trigger button presses p
1717

1818
A button component represents a momentary push button. The API is intentionally simple: a single `Push` method that simulates pressing the button. The button API does not listen for or report incoming presses; a module can still react to real presses internally, but from SDK code you only initiate presses.
1919

20-
Physical button hardware typically comes from a module in the [Viam registry](https://app.viam.com/registry?type=component&subtype=button) that watches a GPIO pin.
20+
Physical button hardware typically comes from a module in the [Viam registry](https://app.viam.com/registry) (search for `button`) that watches a GPIO pin.
2121

2222
The `fake` built-in model is useful for testing code without physical hardware.
2323

2424
### Built-in models
2525

2626
### Registry modules
2727

28-
For hardware the built-in models don't cover, browse the [Viam registry](https://app.viam.com/registry?type=component&subtype=button). Each module's configuration is documented on its registry page.
28+
For hardware the built-in models don't cover, search for `button` in the [Viam registry](https://app.viam.com/registry). Each module's configuration is documented on its registry page.
2929

3030
## Steps
3131

docs/hardware/common-components/add-a-camera.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Viam-maintained camera modules:
4343
| [`viam:csi-cam-pi`](https://app.viam.com/module/viam/csi-cam-pi) | Raspberry Pi CSI cameras |
4444
| [`viam:rplidar`](https://app.viam.com/module/viam/rplidar) | RPLidar 2D lidar (exposed as a point-cloud camera) |
4545

46-
For cameras not covered above, browse [all camera modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=camera).
46+
For cameras not covered above, search for `camera` in the [Viam registry](https://app.viam.com/registry).
4747

4848
## Steps
4949

docs/hardware/common-components/add-a-gantry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Viam includes two built-in gantry models:
3131
| `single-axis` | Controls one linear rail driven by a motor. |
3232
| `multi-axis` | Composes multiple single-axis gantries into a coordinated system. |
3333

34-
The `fake` built-in model is useful for testing without hardware. Browse all available gantry models in the [Viam registry](https://app.viam.com/registry?type=component&subtype=gantry).
34+
The `fake` built-in model is useful for testing without hardware. Search for `gantry` in the [Viam registry](https://app.viam.com/registry) to see available models.
3535

3636
### Built-in models
3737

@@ -47,7 +47,7 @@ Viam-maintained gantry modules:
4747
| ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
4848
| [`viam:generic-gantry`](https://app.viam.com/module/viam/generic-gantry) | Single- and multi-axis gantries with motor control, limit switches, and encoder homing |
4949

50-
For gantries not covered above, browse [all gantry modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=gantry). Each module's configuration is documented on its registry page.
50+
For gantries not covered above, search for `gantry` in the [Viam registry](https://app.viam.com/registry). Each module's configuration is documented on its registry page.
5151

5252
## Steps
5353

docs/hardware/common-components/add-a-generic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module author defines what commands are supported and what they do.
2727

2828
Use generic when no other component type fits. If your hardware produces images, use [camera](/hardware/common-components/add-a-camera/). If it produces readings, use [sensor](/hardware/common-components/add-a-sensor/). Standard types give you typed SDK methods like `GetImage` or `GetReadings`, richer test-panel controls tailored to the component, and motion or vision services that know how to work with them. Generic exposes only `DoCommand`, so callers have to know the module-specific command shape.
2929

30-
Browse available generic models in the [Viam registry](https://app.viam.com/registry?type=component&subtype=generic).
30+
Search for `generic` in the [Viam registry](https://app.viam.com/registry) to see available models.
3131

3232
The `fake` built-in model echoes commands back for testing.
3333

@@ -37,7 +37,7 @@ The `fake` built-in model echoes commands back for testing.
3737

3838
### Registry modules
3939

40-
For hardware the built-in models don't cover, browse the [Viam registry](https://app.viam.com/registry?type=component&subtype=generic). Each module's configuration is documented on its registry page.
40+
For hardware the built-in models don't cover, search for `generic` in the [Viam registry](https://app.viam.com/registry). Each module's configuration is documented on its registry page.
4141

4242
## Steps
4343

docs/hardware/common-components/add-a-gripper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A gripper component controls a grasping device. The API provides:
2222
- **IsHoldingSomething**: checks whether the gripper currently holds an object.
2323
- **Stop**: stops any in-progress motion.
2424

25-
Gripper models almost always come from modules in the [Viam registry](https://app.viam.com/registry?type=component&subtype=gripper) because each
25+
Gripper models almost always come from modules in the [Viam registry](https://app.viam.com/registry) (search for `gripper`) because each
2626
gripper has its own communication protocol and control logic. For example, the
2727
[UFactory module](https://app.viam.com/module/viam/ufactory) includes gripper
2828
models for xArm parallel-jaw and vacuum grippers.
@@ -42,7 +42,7 @@ Viam-maintained gripper modules:
4242
| [`viam:ufactory`](https://app.viam.com/module/viam/ufactory) | xArm finger gripper, xArm Lite gripper, vacuum gripper |
4343
| [`viam:robotiq`](https://app.viam.com/module/viam/robotiq) | Robotiq 2F-series two-finger grippers |
4444

45-
For grippers not covered above, browse [all gripper modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=gripper). Each module's configuration is documented on its registry page.
45+
For grippers not covered above, search for `gripper` in the [Viam registry](https://app.viam.com/registry). Each module's configuration is documented on its registry page.
4646

4747
## Steps
4848

docs/hardware/common-components/add-a-motor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Add a motor to your machine's configuration so you can control it from the Viam
1515

1616
## Concepts
1717

18-
The motor API gives you `SetPower`, `GoFor` (rotate a number of revolutions at a given speed), `GoTo` (move to an absolute position), and `Stop`. Other models exist as modules for network-controlled motors and specific motor controllers. Browse available motor models in the [Viam registry](https://app.viam.com/registry?type=component&subtype=motor).
18+
The motor API gives you `SetPower`, `GoFor` (rotate a number of revolutions at a given speed), `GoTo` (move to an absolute position), and `Stop`. Other models exist as modules for network-controlled motors and specific motor controllers. Search for `motor` in the [Viam registry](https://app.viam.com/registry) to see available models.
1919

2020
This page covers the `gpio` model, which controls a motor through a motor driver wired to GPIO pins on a [board](/hardware/common-components/add-a-board/). You need to add a board first.
2121

@@ -48,7 +48,7 @@ Viam-maintained motor modules:
4848
| [`viam:odrive`](https://app.viam.com/module/viam/odrive) | ODrive brushless motor controllers (serial) |
4949
| [`viam:uln2003`](https://app.viam.com/module/viam/uln2003) | 28BYJ-48 stepper motor through the ULN2003 driver |
5050

51-
For motors not covered above, browse [all motor modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=motor).
51+
For motors not covered above, search for `motor` in the [Viam registry](https://app.viam.com/registry).
5252

5353
## Steps
5454

docs/hardware/common-components/add-a-movement-sensor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Viam-maintained movement-sensor modules:
5252
| [`viam:gps`](https://app.viam.com/module/viam/gps) | NMEA GPS, RTK GPS (serial / PMTK), and dual-antenna RTK |
5353
| [`viam:wit-motion`](https://app.viam.com/module/viam/wit-motion) | Wit-Motion multi-axis tilt and IMU sensors |
5454

55-
For movement sensors not covered above, browse [all movement-sensor modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=movement_sensor).
55+
For movement sensors not covered above, search for `movement sensor` in the [Viam registry](https://app.viam.com/registry).
5656

5757
## Steps
5858

docs/hardware/common-components/add-a-power-sensor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Viam-maintained power-sensor modules:
3333
| ------------------------------------------------------------------------------ | -------------------------------------------- |
3434
| [`viam:texas-instruments`](https://app.viam.com/module/viam/texas-instruments) | Texas Instruments INA219 and INA226 monitors |
3535

36-
For power sensors not covered above (Renogy controllers, other chips), browse [all power-sensor modules in the Viam registry](https://app.viam.com/registry?type=component&subtype=power_sensor).
36+
For power sensors not covered above (Renogy controllers, other chips), search for `power sensor` in the [Viam registry](https://app.viam.com/registry).
3737

3838
## Steps
3939

0 commit comments

Comments
 (0)