Skip to content

Commit 4542b9b

Browse files
authored
DOCS-3002: Add instructions for physically connecting components to how-tos (#3535)
1 parent 6624728 commit 4542b9b

File tree

10 files changed

+26
-12
lines changed

10 files changed

+26
-12
lines changed

docs/how-tos/collect-sensor-data.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Navigate to the **CONFIGURE** tab of your machine's page in [the Viam app](https
4949
Click the **+** icon next to your machine part in the left-hand menu and select **Component**.
5050
Then [find and add a sensor model](/components/sensor/) that supports your sensor.
5151

52+
If you have a physical sensor, make sure to connect it physically to your computer.
53+
5254
If you do not have a physical sensor or if you're not sure which sensor model to choose, add the `viam:viam-sensor:telegrafsensor` which captures performance data (CPU, memory usage, and more) from your machine. After adding the component, use the following attribute configuration:
5355

5456
```json {class="line-numbers linkable-line-numbers"}

docs/how-tos/configure.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,21 @@ Each physical piece of your smart machine that is controlled by a computer is ca
8181

8282
For each component that makes up your machine:
8383

84-
1. Find an appropriate model for your hardware.
84+
1. Physically connect the hardware to your machine's computer.
85+
2. Find an appropriate model for your hardware.
8586
You can find the available models on the [component pages](/components/).
8687
For example, you can scroll through available sensor models on the [sensor page](/components/sensor/#available-models).
87-
2. You need to [_configure_](/configure/) your machine so that `viam-server` can interact with its hardware.
88+
3. You need to [_configure_](/configure/) your machine so that `viam-server` can interact with its hardware.
8889
Use the configuration builder tool in the Viam app to create a file that describes what hardware you are using and how it is connected.
8990
For example, if you have a DC motor, follow the [corresponding configuration instructions](/components/motor/gpio/) to tell the software which pins it is connected to.
90-
3. Add a suitable model to your machine on the **CONFIGURE** page:
91+
4. Add a suitable model to your machine on the **CONFIGURE** page:
9192

9293
- Click the + icon next to your machine part in the left-hand menu and select Component.
9394
- Choose any component type (example: `camera`) and model (example: `webcam`). If a component you want to use for your project is not natively supported, you can [build your own modular resource](/how-tos/create-module/).
9495

95-
4. When you add a component model, it will create a panel in the configuration builder tool. Fill in any required attributes, following the documentation for the specific model.
96-
5. Click the **TEST** area of the configuration panel to test your component, for example to view a camera feed or turn a motor.
97-
6. If any problems occur check the [**LOGS** tab](/cloud/machines/#logs). You can also review the [configuration history](/cloud/machines/#configure) and roll back changes if needed.
96+
5. When you add a component model, it will create a panel in the configuration builder tool. Fill in any required attributes, following the documentation for the specific model.
97+
6. Click the **TEST** area of the configuration panel to test your component, for example to view a camera feed or turn a motor.
98+
7. If any problems occur check the [**LOGS** tab](/cloud/machines/#logs). You can also review the [configuration history](/cloud/machines/#configure) and roll back changes if needed.
9899

99100
{{% /tablestep %}}
100101
{{% tablestep %}}

docs/how-tos/create-module.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1613,7 +1613,8 @@ If you would like to test your module locally against a target platform other th
16131613
16141614
{{% /alert %}}
16151615
1616-
To use a local module on your machine, first add its module to your machine's config, then add the component or service it implements:
1616+
To use a local module on your machine, first make sure any physical hardware implemented in your module is connected to your machine's computer.
1617+
Add the module to your machine's config, then add the component or service it implements:
16171618
16181619
1. Navigate to the **CONFIGURE** tab of your machine's page in [the Viam app](https://app.viam.com).
16191620

docs/how-tos/deploy-ml.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ You could then use that knowledge to [give your dog treats](https://www.viam.com
5555

5656
{{% expand "A configured camera. Click to see instructions." %}}
5757

58-
Navigate to the **CONFIGURE** tab of your machine's page in [the Viam app](https://app.viam.com).
58+
First, connect the camera to your machine's computer if it's not already connected (like with an inbuilt laptop webcam).
59+
60+
Then, navigate to the **CONFIGURE** tab of your machine's page in [the Viam app](https://app.viam.com).
5961
Click the **+** icon next to your machine part in the left-hand menu and select **Component**.
6062
Then [find and add a camera model](/components/camera/) that supports your camera.
6163

docs/how-tos/detect-color.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ Select the Platform you want to install `viam-server` on.
8989
{{% /expand%}}
9090
{{% expand "Step 3: Configure your webcam" %}}
9191

92+
First, make sure to connect your webcam to your machine if it's not already connected (like with an inbuilt laptop webcam).
93+
9294
Click the **+** icon next to your machine part in the left-hand menu and select **Component**.
9395
Select the `camera` type, then select the `webcam` model.
9496
Enter a name or use the suggested name for your camera and click **Create**.

docs/how-tos/drive-rover.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ If you are running out of time during your session, you can [extend your rover s
7777
{{% tab name="Other Rover" %}}
7878

7979
{{% alert title="Important" color="note" %}}
80-
If you are using your own robot for this tutorial instead of [borrowing one](https://app.viam.com/try), be sure to [install `viam-server`](/installation/#install-viam-server) on it and [configure](/tutorials/configure/configure-rover/) its hardware before proceeding with this tutorial.
80+
If you are using your own robot for this tutorial instead of [borrowing one](https://app.viam.com/try), be sure to [install `viam-server`](/installation/#install-viam-server) on it, and connect and [configure](/tutorials/configure/configure-rover/) its hardware before proceeding with this tutorial.
8181
{{% /alert %}}
8282

8383
{{% /tab %}}

docs/how-tos/image-data.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ From there, you can use your image data to do things like [train ML models](/how
4747

4848
{{% expand "A configured camera. Click to see instructions." %}}
4949

50+
First, make sure to connect your camera to your machine if it's not already connected (like with an inbuilt laptop webcam).
51+
5052
Navigate to the **CONFIGURE** tab of your machine's page in [the Viam app](https://app.viam.com).
5153
Click the **+** icon next to your machine part in the left-hand menu and select **Component**.
5254
Then [find and add a camera model](/components/camera/) that supports your camera.

docs/how-tos/navigate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Once you have configured your machine, you can remotely control your machine on
2828
**1. Teleoperate**
2929

3030
You can remotely control your rover from anywhere through the [Viam app](https://app.viam.com).
31-
Create an account and add a machine, [install `viam-server`](/installation/), and [configure your rover base](/components/base/).
31+
After physically setting up the hardware on your base and powering the base on, create an account and add a machine, [install `viam-server`](/installation/), and [configure your rover base](/components/base/).
3232
Then, go to the **CONTROL** tab and access a remote control card for your base, with an interface for controlling speed, direction, and power.
3333
You can also view live feeds from any cameras you configure.
3434

docs/how-tos/sensor-module.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,7 @@ sudo chmod +x <your-file-path-to>/run.sh
384384
{{% expand "Prerequisite: A running machine connected to the Viam app." %}}
385385

386386
You can write a module without a machine, but to test your module you'll need a machine.
387+
Make sure to physically connect your sensor to your machine's computer to prepare your machine for testing.
387388

388389
{{% snippet "setup.md" %}}
389390

docs/how-tos/trigger-sync.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ Also leave both **Capturing** and **Syncing** toggles in the "on" position.
5858

5959
{{% expand "Create a sensor module. Click to see instructions." %}}
6060

61-
Start by [creating a sensor module](/how-tos/sensor-module/). Your sensor should have access to the information you need to determine if your machine should sync or not.
61+
Start by [creating a sensor module](/how-tos/sensor-module/).
62+
Your sensor should have access to the information you need to determine if your machine should sync or not.
6263
Based on that data, make the sensor return true when the machine should sync and false when it should not.
6364
For example, if your want your machine to return data only during a specific time interval, your sensor needs to be able to access the time as well as be configured with the time interval during which you would like to sync data.
6465
It can then return true during the specified sync time interval and false otherwise.
@@ -115,7 +116,8 @@ For additional examples, see the `Readings` function of the [time-interval-trigg
115116

116117
## Add your sensor to determine when to sync
117118

118-
Add your module to your machine and configure it. In this example we will continue to use [`sync-at-time:timesyncsensor`](https://app.viam.com/module/naomi/sync-at-time).
119+
Add your module to your machine and configure it.
120+
In this example we will continue to use [`sync-at-time:timesyncsensor`](https://app.viam.com/module/naomi/sync-at-time).
119121
You will need to follow the same steps with your module:
120122

121123
{{< table >}}
@@ -286,6 +288,7 @@ You have now configured sync to happen during a specific time slot.
286288
## Test your sync configuration
287289

288290
To test your setup, [configure a webcam](/components/camera/webcam/) or another component and [enable data capture on the component](/services/data/capture-sync/#configure-data-capture-and-sync).
291+
Make sure to physically connect any hardware parts to the computer controlling your machine.
289292
For a camera component, use the `ReadImage` method.
290293
The data manager will now capture data.
291294
Go to the [**CONTROL** tab](/fleet/control/).

0 commit comments

Comments
 (0)