DOCS-3004: Add prereqs to tutorials (#3547)

viamrobotics · Oct 11, 2024 · 11c281d · 11c281d
1 parent b50c119
commit 11c281d
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 7 deletions.
diff --git a/docs/tutorials/configure/configure-rover.md b/docs/tutorials/configure/configure-rover.md
@@ -37,6 +37,8 @@ If you are using a Viam Rover, use the [Viam Rover tutorial fragment](/appendix/
   See our [Installation Guide](/installation/) for instructions.
 - A rover like the [SCUTTLE robot](https://www.scuttlerobot.org/shop/) or the [Yahboom 4WD Smart Robot](https://category.yahboom.net/collections/robotics/products/4wdrobot)
 
+Make sure your rover is assembled before starting this tutorial.
+
 ## Start configuring your robot
 
 {{% snippet "setup.md" %}}
@@ -307,6 +309,7 @@ If you don't have enough space, consider holding your robot off the ground so it
 {{< /alert >}}
 
 Now that you have configured your motors, you can actuate them.
+Make sure your machine is turned on.
 Navigate to the **Control** tab.
 
 You'll see a panel for each configured component.

diff --git a/docs/tutorials/configure/pet-photographer.md b/docs/tutorials/configure/pet-photographer.md
@@ -50,6 +50,8 @@ In this tutorial, the camera is configured to identify and filter images with th
 If your pet already has a distinct color that is different from their environment, you can also configure your camera to use that color to identify pictures of your pet.
 {{< /alert >}}
 
+Make sure your webcam is connected to your computer.
+
 ## Setup
 
 {{% snippet "setup.md" %}}

diff --git a/docs/tutorials/control/air-quality-fleet.md b/docs/tutorials/control/air-quality-fleet.md
@@ -49,10 +49,7 @@ For each machine, you will need the following hardware:
 - A single-board computer (SBC) [capable of running `viam-server`](https://docs.viam.com/installation/)
 - An appropriate power supply
 
-In addition to `viam-server`, this tutorial uses the following software:
-
-- [`sds0011` sensor module](https://github.com/zaporter/viam-sds011)
-- The [Viam TypeScript SDK](https://ts.viam.dev/)
+Make sure all of your sensors are wired to your SBC before starting this tutorial.
 
 ## Decide how you will organize your fleet
 

diff --git a/docs/tutorials/custom/custom-base-dog.md b/docs/tutorials/custom/custom-base-dog.md
@@ -185,6 +185,7 @@ Save the file.
 ### Test the connection
 
 Place the robot dog on a flat, open surface where it has room to take a few steps.
+Make sure it is powered on.
 
 Now you are ready to run the connection test file.
 

diff --git a/docs/tutorials/get-started/blink-an-led.md b/docs/tutorials/get-started/blink-an-led.md
@@ -52,7 +52,7 @@ You will use the following hardware for this tutorial:
 
 Before you build your circuit, you need to set up the operating system on your Raspberry Pi and install `viam-server` on the Pi:
 
-Follow the [Raspberry Pi Setup Guide](/installation/prepare/rpi-setup/) to set up the operating system.
+Power your Pi on and follow the [Raspberry Pi Setup Guide](/installation/prepare/rpi-setup/) to set up the operating system.
 
 {{% snippet "setup.md" %}}
 

diff --git a/docs/tutorials/projects/make-a-plant-watering-robot.md b/docs/tutorials/projects/make-a-plant-watering-robot.md
@@ -67,6 +67,7 @@ You will set up the robot to receive signals from the resistive soil moisture se
 ### Full wiring diagram
 
 Refer back to this diagram as you complete the steps to wire your hardware.
+Turn your Pi off while you are wiring the hardware.
 
 <p><img src="../../plant-watering-pi/full-wiring.png" class="imgzoom" alt="The full wiring diagram for all the hardware for the Plant Watering Robot."></p>
 
@@ -151,6 +152,7 @@ To complete the steps, insert the ends of the jumper wires into the pin gates on
 Now that you have wired your ADC and moisture sensor, make sure that the Serial Peripheral Interface (SPI) is enabled on your Pi.
 Enabling this protocol is necessary to allow the Pi to communicate with the moisture sensor peripheral.
 
+Turn your Pi back on.
 SSH into your Pi and run the following command:
 
 ```shell

diff --git a/docs/tutorials/projects/verification-system.md b/docs/tutorials/projects/verification-system.md
@@ -57,6 +57,7 @@ Before following this tutorial, you should:
 1. [Install `viam-server`](/installation/) on your new machine.
 
 Your machine must have a [camera](/components/camera/) component, such as a [webcam](/components/camera/webcam/).
+Make sure to connect your camera to your machine's computer (if it isn't built-in) before starting the project and power it on.
 
 ## Configure a camera
 

diff --git a/docs/tutorials/services/navigate-with-rover-base.md b/docs/tutorials/services/navigate-with-rover-base.md
@@ -81,6 +81,7 @@ If you are using different hardware, the navigation setup process will be mostly
 {{% /alert %}}
 
 Before you start, make sure to create a machine in [the Viam app](https://app.viam.com) and [install `viam-server`](/installation/) on your robot.
+Also, make sure to physically connect your components together to your machine's computer and power it on.
 
 ## Configure the components you need
 

diff --git a/docs/tutorials/services/visualize-data-grafana.md b/docs/tutorials/services/visualize-data-grafana.md
@@ -40,9 +40,10 @@ For general guidance appropriate for any third-party visualization tool, see [Vi
 
 Before following this tutorial, ensure you have:
 
-- A machine with [connected to the Viam app](/cloud/machines/#add-a-new-machine).
+- A machine that's [connected to the Viam app](/cloud/machines/#add-a-new-machine).
 
 - A configured [sensor component](/components/sensor/), such as the [`bme280`](https://docs.viam.com/components/sensor/bme280/) sensor, that reports data.
+  If it's a physical sensor, make sure to connect it to your machine's computer.
 
   - This tutorial uses a dataset of plant moisture measurements, originally captured for our [Plant watering tutorial](/tutorials/projects/make-a-plant-watering-robot/) using an analog resistive soil moisture sensor connected to an analog-to-digital-converter (ADC).
     The ADC functionality was provided by the [`mcp300x-adc-sensor` module](https://app.viam.com/module/hazalmestci/mcp300x-adc-sensor) from the [Viam registry](https://app.viam.com/registry).

diff --git a/docs/tutorials/services/webcam-line-follower-robot.md b/docs/tutorials/services/webcam-line-follower-robot.md
@@ -53,7 +53,7 @@ To build your own line follower robot, you need the following hardware:
 | Hardware | Avg. price |
 | -------- | ----------------- |
 | **A single-board computer**: This tutorial uses a Raspberry Pi 4. If you use a different single-board computer, choose the [model that supports your board](/components/board/#available-models) when you [configure your board component](#configure-your-components). | $60 |
-| **A wheeled [base component](/components/base/)**: This tutorial uses a [SCUTTLE robot](https://www.scuttlerobot.org/shop/), but any other wheeled base works as long as it can carry the board and camera, and is capable of turning in place. | $99+ |
+| **A wheeled [base component](/components/base/)**: This tutorial uses a [SCUTTLE robot](https://www.scuttlerobot.org/shop/), but any other wheeled base works as long as it can carry the board and camera, and is capable of turning in place. Make sure to assemble this rover. | $99+ |
 | **RGB camera**: A common off-the-shelf webcam (such as the [EMEET C690](https://www.amazon.com/Webcam-Streaming-Recording-Built-Correction/dp/B07M6Y7355/ref=sr_1_5?keywords=webcam&qid=1658796392&sr=8-5&th=1)) connected to the Pi’s USB port, or something like an [ArduCam](https://www.amazon.com/Arducam-Megapixels-Sensor-OV5647-Raspberry/dp/B012V1HEP4/) with a ribbon connector to the Pi’s camera module port. **You must mount the camera on the front of the rover, pointing down towards the floor.** | $30 |
 | **Colored tape**: Any color is suitable as long as the color is suitably different from the floor color. For our tutorial, we used green electrical tape to stand out against our grey carpet. | $4 |
 | **Floor space**: Non-shiny floors tend to work best. | - |