DOCS-3003: Add prerequisite of physically assembling hardware to comp…

…onents and services (#3540)

docs/components/arm/eva.md

@@ -12,7 +12,10 @@ aliases:
 # SMEs: Bucket, Motion
 ---
 
-Configure an `eva` arm to integrate a [Automata Eva](https://automata.tech/products/hardware/about-eva/) robotic arm into your machine:
+Configure an `eva` arm to integrate an [Automata Eva](https://automata.tech/products/hardware/about-eva/) robotic arm into your machine.
+
+If you want to test your arm as you configure it, connect it to your machine's computer and turn it on.
+Then, configure the arm:
 
 {{< tabs name="Configure an eva Arm" >}}
 {{% tab name="JSON Template" %}}

docs/components/arm/lite6.md

@@ -11,7 +11,10 @@ component_description: "Supports UFACTORY Lite 6."
 # SMEs: Bucket, Motion
 ---
 
-Configure a `lite6` arm to add a [UFACTORY Lite 6](https://www.ufactory.cc/product-page/ufactory-lite-6/) to your machine:
+Configure a `lite6` arm to add a [UFACTORY Lite 6](https://www.ufactory.cc/product-page/ufactory-lite-6/) to your machine.
+
+If you want to test your arm as you configure it, connect it to your machine's computer and turn it on.
+Then, configure the arm:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/arm/ur5e.md

@@ -11,7 +11,10 @@ aliases:
 component_description: "Supports Universal Robots UR5e."
 ---
 
-Configure a `ur5e` arm to add a [Universal Robots UR5e](https://www.universal-robots.com/products/ur5-robot) to your machine:
+Configure a `ur5e` arm to add a [Universal Robots UR5e](https://www.universal-robots.com/products/ur5-robot) to your machine.
+
+If you want to test your arm as you configure it, connect it to your machine's computer and turn it on.
+Then, configure the arm:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/arm/xarm6.md

@@ -12,7 +12,10 @@ component_description: "Supports UFACTORY xArm 6."
 # SMEs: Bucket, Motion
 ---
 
-Configure an `xArm6` arm to integrate a [UFACTORY xArm 6](https://www.ufactory.cc/product-page/ufactory-xarm-6) into your machine:
+Configure an `xArm6` arm to integrate a [UFACTORY xArm 6](https://www.ufactory.cc/product-page/ufactory-xarm-6) into your machine.
+
+If you want to test your arm as you configure it, connect it to your machine's computer and turn it on.
+Then, configure the arm:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/arm/xarm7.md

@@ -12,7 +12,10 @@ component_description: "Supports UFACTORY xArm 7."
 # SMEs: Bucket, Motion
 ---
 
-Configure an `xArm7` arm to integrate a [UFACTORY xArm 7](https://www.ufactory.cc/product-page/ufactory-xarm-7) into your machine:
+Configure an `xArm7` arm to integrate a [UFACTORY xArm 7](https://www.ufactory.cc/product-page/ufactory-xarm-7) into your machine.
+
+If you want to test your arm as you configure it, connect it to your machine's computer and turn it on.
+Then, configure the arm:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/arm/yahboom-dofbot.md

@@ -14,7 +14,10 @@ aliases:
 Viam supports the [Yahboom DOFBOT](https://category.yahboom.net/collections/r-robotics-arm) arm as a {{< glossary_tooltip term_id="modular-resource" text="modular resource" >}}.
 You can explore the source code on the [Viam-labs Yahboom GitHub repository](https://github.com/viam-labs/yahboom).
 
-Configure a `dofbot` arm to add it to your machine:
+Configure a `dofbot` arm to add it to your machine.
+
+If you want to test your arm as you configure it, connect it to your machine's computer and turn it on.
+Then, configure the arm:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/base/two_wheeled_base.md

@@ -23,7 +23,8 @@ The`two_wheeled_base` base model is not currently available as a built-in option
 
 {{< /alert >}}
 
-Configure a `two_wheeled_base` base as follows:
+If you want to test your base as you configure it, physically assemble the base, connect it to your machine's computer, and turn it on.
+Then, configure a `two_wheeled_base` base as follows:
 
 {{< tabs name="Configure a Wheeled Base" >}}
 {{% tab name="JSON Template" %}}

docs/components/base/wheeled.md

@@ -15,7 +15,8 @@ component_description: "Supports mobile wheeled robotic bases with motors on bot
 A `wheeled` base supports mobile robotic bases with motors on both sides (differential steering).
 To configure a `wheeled` base as a component of your machine, first configure the [board](/components/board/) controlling the base and any [motors](/components/motor/) attached to the base.
 
-Configure a `wheeled` base as follows:
+If you want to test your base as you configure it, physically assemble the base, connect it to your machine's computer, and turn it on.
+Then, configure a `wheeled` base as follows:
 
 {{< tabs name="Configure a Wheeled Base" >}}
 {{% tab name="Config Builder" %}}

docs/components/board/beaglebone.md

@@ -18,7 +18,11 @@ Follow the [setup guide](/installation/prepare/beaglebone-setup/) to prepare you
 
 {{% /alert %}}
 
-Configure a `beaglebone` board to integrate [BeagleBoard's BeagleBone AI 64](https://www.beagleboard.org/boards/beaglebone-ai-64) into your machine:
+Configure a `beaglebone` board to integrate [BeagleBoard's BeagleBone AI 64](https://www.beagleboard.org/boards/beaglebone-ai-64) into your machine.
+
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
 
 {{< tabs name="Configure an beaglebone Board" >}}
 {{% tab name="Config Builder" %}}

docs/components/board/esp32.md

@@ -29,7 +29,9 @@ Your microcontroller should have at least the following resources available to w
 
 {{% /alert %}}
 
-To add an `esp32` board, navigate to the **CONFIGURE** tab of your machine's page in the [Viam app](https://app.viam.com) and select **JSON** mode.
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+To configure an `esp32` board, navigate to the **CONFIGURE** tab of your machine's page in the [Viam app](https://app.viam.com) and select **JSON** mode.
 
 {{< alert title="Info" color="info" >}}
 

docs/components/board/jetson.md

@@ -31,7 +31,11 @@ For the Jetson Nano, see pages 1-3 of the [Jetson Nano Developer Kit 40-Pin Expa
 
 {{% /alert %}}
 
-Configure a `jetson` board to integrate an [NVIDIA Jetson Orin Module and Developer Kit](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-orin/), [NVIDIA Jetson AGX](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-agx-xavier/), or [NVIDIA Jetson Nano](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-nano/) into your machine:
+Configure a `jetson` board to integrate an [NVIDIA Jetson Orin Module and Developer Kit](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-orin/), [NVIDIA Jetson AGX](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-agx-xavier/), or [NVIDIA Jetson Nano](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-nano/) into your machine.
+
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/board/numato.md

@@ -14,7 +14,11 @@ component_description: "Supports Numato GPIO Modules and peripherals for adding
 
 <!-- TODO: section on why configuring this one WITH another board is necessary & why the module is useful. -->
 
-Configure a `numato` board to integrate [Numato GPIO Peripheral Modules](https://numato.com/product-category/automation/gpio-modules/) into your machine:
+Configure a `numato` board to integrate [Numato GPIO Peripheral Modules](https://numato.com/product-category/automation/gpio-modules/) into your machine.
+
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
 
 {{< tabs name="Configure an numato Board" >}}
 {{% tab name="Config Builder" %}}

docs/components/board/odroid.md

@@ -15,7 +15,11 @@ Follow the [setup guide](/installation/prepare/odroid-c4-setup/) to prepare your
 
 {{% /alert %}}
 
-Configure an `odroid` board to integrate an [Odroid-C4](https://www.hardkernel.com/shop/odroid-c4/) into your machine:
+Configure an `odroid` board to integrate an [Odroid-C4](https://www.hardkernel.com/shop/odroid-c4/) into your machine.
+
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
 
 {{< tabs name="Configure an odroid Board" >}}
 {{% tab name="Config Builder" %}}

docs/components/board/orangepi.md

@@ -12,7 +12,9 @@ component_description: "Supports Orange Pi Zero2, Orange Pi Zero 2W or OrangePi
 
 Configure an `orangepi` board to integrate the GPIO pins of an [Orange Pi Zero2](http://www.orangepi.org/html/hardWare/computerAndMicrocontrollers/details/Orange-Pi-Zero-2.html), [Orange Pi Zero 2W](http://www.orangepi.org/html/hardWare/computerAndMicrocontrollers/details/Orange-Pi-Zero-2W.html) or [OrangePi 3 LTS](http://www.orangepi.org/html/hardWare/computerAndMicrocontrollers/details/orange-pi-3-LTS.html) into your machine.
 
-First, follow the installation guide for your specific Orange Pi board:
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Follow the installation guide for your specific Orange Pi board:
 
 - For an Orange Pi Zero2: follow the [Orange Pi Zero2 installation guide](/installation/prepare/orange-pi-zero2/).
 - For an Orange Pi 3 LTS, follow the [Orange Pi 3 LTS installation guide](/installation/prepare/orange-pi-3-lts/).

docs/components/board/pca9685.md

@@ -12,7 +12,11 @@ component_description: "Supports PCA9685 Arduino I2C Interface, a 16-channel I2C
 # SMEs: Gautham, Rand
 ---
 
-Configure a `pca9685` board to integrate a [PCA9685 Arduino I<sup>2</sup>C Interface](https://www.adafruit.com/product/815) into your machine:
+Configure a `pca9685` board to integrate a [PCA9685 Arduino I<sup>2</sup>C Interface](https://www.adafruit.com/product/815) into your machine.
+
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
 
 {{< tabs name="Configure an pca9685 Board" >}}
 {{% tab name="Config Builder" %}}

docs/components/board/pi5.md

@@ -35,6 +35,10 @@ If you do not enable hardware PWM, these pins will have no function.
 
 ### Configuration
 
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
+
 {{< tabs name="Configure a pi5 Board" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/board/ti.md

@@ -18,7 +18,11 @@ Follow the [setup guide](/installation/prepare/sk-tda4vm/) to prepare your TDA4V
 
 {{% /alert %}}
 
-Configure a `ti` board to integrate a [Texas Instruments TDA4VM](https://devices.amazonaws.com/detail/a3G8a00000E2QErEAN/TI-TDA4VM-Starter-Kit-for-Edge-AI-vision-systems) into your machine:
+Configure a `ti` board to integrate a [Texas Instruments TDA4VM](https://devices.amazonaws.com/detail/a3G8a00000E2QErEAN/TI-TDA4VM-Starter-Kit-for-Edge-AI-vision-systems) into your machine.
+
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
 
 {{< tabs name="Configure an ti Board" >}}
 {{% tab name="Config Builder" %}}

docs/components/board/upboard.md

@@ -18,6 +18,8 @@ Complete the following setup requirements, then move on to configuring your boar
 
 ## Setup requirements
 
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
 You must flash your Intel-based board with:
 
 1. The Ubuntu `"Server install image"` version of the operating system.

docs/components/camera/esp32-camera.md

@@ -40,6 +40,9 @@ The `esp32-camera` camera model does not currently support the [data management
 
 {{< /alert >}}
 
+First, connect your camera to your machine's microcontroller and turn the microcontroller on.
+Then, configure your camera:
+
 {{< tabs name="Configure a esp32-camera" >}}
 {{% tab name="JSON Template" %}}
 

docs/components/camera/ffmpeg.md

@@ -21,6 +21,9 @@ When used with a streaming camera, the `ffmpeg` camera model supports any stream
 The [`ffmpeg` program](https://ffmpeg.org/) program must be installed separately from `viam-server` on your system for this driver to work.
 {{< /alert >}}
 
+First, connect your camera to your machine's computer and power both on.
+Then, configure your camera:
+
 {{< tabs name="Configure a ffmpeg camera" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/camera/webcam.md

@@ -17,6 +17,9 @@ toc_hide: true
 `webcam` is the general camera model.
 If the camera drivers are among those in [this mediadevices repository](https://github.com/pion/mediadevices), the camera will work with the webcam model.
 
+First, connect your camera to your machine's computer (unless it is built-in like a webcam on a laptop) and power both on.
+Then, configure your camera:
+
 {{< tabs name="Configure a Webcam" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/component/board1.md

@@ -20,6 +20,10 @@ Follow the [setup guide](/installation/prepare/board1-setup) to prepare your <mo
 
 Configure a `<board-model>` board to integrate an [<board-series-model>](http://www.example.com), [<board-series-model-1>](http://example.com), or [<board-series-model-2>](http://example.com) board into your machine.
 
+To test your board as you configure it, power it on.
+If you plan to connect hardware to the board's pins, connect the hardware while it's powered off.
+Then, configure the board:
+
 {{< tabs name="Configure a <board-model> Board" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/component/model1.md

@@ -13,6 +13,9 @@ draft: true
 The `model1` arm model supports the XYZ unit made by Some Company(INSERT LINK AS APPLICABLE).
 Optional additional description/information.
 
+To be able to test your component as you configure it, first physically assemble the component and connect it to your machine's computer. Power both on.
+Then, configure the component:
+
 {{< tabs >}}
 {{% tab name="Config Builder" %}}
 

docs/components/encoder/ams-as5048.md

@@ -18,6 +18,9 @@ This is an absolute encoder that uses an I<sup>2</sup>C or SPI interface to conn
 Any [motor](/components/motor/) using the `AMS-AS5048` encoder must have its `ticks_per_rotation` attribute configured as `1` because this encoder provides angular measurements directly.
 {{% /alert %}}
 
+To be able to test the encoder as you configure it, connect the encoder to your machine's computer and power both on.
+Then, configure the encoder:
+
 {{< tabs name="Configure an AMS-AS5048 Encoder" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/encoder/incremental-micro-rdk.md

@@ -18,6 +18,9 @@ Use the `incremental` encoder model to configure [a quadrature encoder](https://
 Configuring an `incremental` encoder requires specifying the {{< glossary_tooltip term_id="pin-number" text="pin numbers" >}} of the two pins on the board to which the encoder is wired.
 These two pins provide the phase outputs used to measure the speed and direction of rotation in relation to a given reference point.
 
+To be able to test the encoder as you configure it, connect the encoder to your microcontroller and power both on.
+Then, configure the encoder:
+
 {{< tabs name="Configure an incremental encoder" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/encoder/incremental.md

@@ -16,6 +16,9 @@ Use the `incremental` encoder model to configure [a quadrature encoder](https://
 Configuring an `incremental` encoder requires specifying the {{< glossary_tooltip term_id="pin-number" text="pin numbers" >}} of the two pins on the board to which the encoder is wired.
 These two pins provide the phase outputs used to measure the speed and direction of rotation in relation to a given reference point.
 
+To be able to test the encoder as you configure it, connect the encoder to your machine's computer and power both on.
+Then, configure the encoder:
+
 {{< tabs name="Configure an incremental encoder" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/encoder/single-micro-rdk.md

@@ -15,6 +15,9 @@ micrordk_component: true
 A `single` encoder sends a signal from the rotating encoder over a single wire to one pin on the [board](/components/board/).
 The direction of spin is dictated by the [motor](/components/motor/) that has this encoder's name in its `encoder` attribute field.
 
+To be able to test the encoder as you configure it, connect the encoder to your machine's computer and power both on.
+Then, configure the encoder:
+
 {{< tabs name="Configure an single encoder" >}}
 {{% tab name="JSON Template" %}}
 

docs/components/encoder/single.md

@@ -14,6 +14,9 @@ component_description: "A single pin 'pulse output' encoder which returns its re
 A `single` encoder sends a signal from the rotating encoder over a single wire to one pin on the [board](/components/board/).
 The direction of spin is dictated by the [motor](/components/motor/) that has this encoder's name in its `encoder` attribute field.
 
+To be able to test the encoder as you configure it, connect the encoder to your machine's computer and power both on.
+Then, configure the encoder:
+
 {{< tabs name="Configure an single encoder" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/gantry/multi-axis.md

@@ -13,7 +13,12 @@ component_description: "Supports a gantry with multiple linear rails. Composed o
 # SME: Rand, Martha
 ---
 
-Configure a `multi-axis` gantry to integrate a gantry made up of multiple [`single-axis`](/components/gantry/single-axis/) gantries into your machine:
+Configure a `multi-axis` gantry to integrate a gantry made up of multiple [`single-axis`](/components/gantry/single-axis/) gantries into your machine.
+
+First, physically assemble the gantry and connect it to your machine's computer.
+Power both on.
+Next, configure each single-axis gantry that is part of the muti-axis gantry.
+Then, configure the multi-axis gantry:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/gantry/single-axis.md

@@ -14,7 +14,10 @@ component_description: "Supports a gantry with a singular linear rail."
 ---
 
 Configure a `single-axis` gantry to integrate a single-axis gantry into your machine.
-Before configuring the gantry, configure any [motor components](/components/motor/) that are part of the gantry.
+First, be sure to physically assemble the gantry and connect it to your machine's computer.
+Power both on.
+Also, configure any [motor components](/components/motor/) that are part of the gantry.
+Then, configure the gantry:
 
 {{< tabs >}}
 {{% tab name="Config Builder" %}}

docs/components/gripper/softrobotics.md

@@ -12,6 +12,9 @@ component_description: "Supports the mGrip soft gripper by Soft Robotics."
 
 The `softrobotics` model supports the [Soft Robotics *m*Grip](https://www.softroboticsinc.com/uploads/2021/03/Soft_Robotics_ModularGripping_800129_RevD_LR.pdf) gripper controlled by the [Soft Robotics *co*Drive Control Unit](https://www.softroboticsinc.com/uploads/2020/05/Tech_Sheet_coDrive_Control_Unit_-__TS-200210_Rev_B.pdf).
 
+First, connect the gripper to your machine's computer and turn it on.
+Then, configure the gripper:
+
 {{< tabs name="Configure a softrobotics gripper" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/input-controller/gamepad.md

@@ -15,6 +15,9 @@ component_description: "Supports X-box, Playstation, and similar controllers wit
 Configuring a `gamepad` input controller allows you to use a Linux-supported gamepad as a device to communicate with your machine.
 Linux supports most standard gamepads, such as PlayStation or Xbox type game controllers, as well as many joysticks, racing wheels, and more.
 
+To be able to test your gamepad as you configure it, physically connect your gamepad to your machine's computer and turn both on.
+Then, configure the controller:
+
 {{< tabs name="Configure a `gamepad` input controller" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/input-controller/gpio.md

@@ -14,6 +14,9 @@ component_description: "Customizable GPIO/ADC based device using a board compone
 
 Configure a `gpio` input controller to use a GPIO- or ADC-based device to communicate with your machine.
 
+To be able to test your controller as you configure it, physically connect your controller to your machine's computer and turn both on.
+Then, configure the controller:
+
 {{< tabs name="Configure a `gpio` input controller" >}}
 {{% tab name="Config Builder" %}}
 

docs/components/input-controller/webgamepad.md

@@ -19,6 +19,9 @@ You **must** use "WebGamepad" as the `name` of the web gamepad controller.
 This restriction will be removed in the future.
 {{% /alert %}}
 
+To be able to test your gamepad as you configure it, physically connect your gamepad to your machine's computer and turn both on.
+Then, configure the controller.
+
 ## Configuration
 
 Use the following configuration for an input controller of model `webgamepad`: