diff --git a/docs/components/arm/eva.md b/docs/components/arm/eva.md index 3bf3f85fdb..6db4c2e0d8 100644 --- a/docs/components/arm/eva.md +++ b/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" %}} diff --git a/docs/components/arm/lite6.md b/docs/components/arm/lite6.md index dc9712e195..a35a9aaaa8 100644 --- a/docs/components/arm/lite6.md +++ b/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" %}} diff --git a/docs/components/arm/ur5e.md b/docs/components/arm/ur5e.md index 42e0c91d6a..02b7133bed 100644 --- a/docs/components/arm/ur5e.md +++ b/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" %}} diff --git a/docs/components/arm/xarm6.md b/docs/components/arm/xarm6.md index e80c584138..12f4890015 100644 --- a/docs/components/arm/xarm6.md +++ b/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" %}} diff --git a/docs/components/arm/xarm7.md b/docs/components/arm/xarm7.md index 573ed8d8e9..aacb20ad75 100644 --- a/docs/components/arm/xarm7.md +++ b/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" %}} diff --git a/docs/components/arm/yahboom-dofbot.md b/docs/components/arm/yahboom-dofbot.md index 48c8dde021..243c0ce28e 100644 --- a/docs/components/arm/yahboom-dofbot.md +++ b/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" %}} diff --git a/docs/components/base/two_wheeled_base.md b/docs/components/base/two_wheeled_base.md index bd5802c449..41a2bbf774 100644 --- a/docs/components/base/two_wheeled_base.md +++ b/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" %}} diff --git a/docs/components/base/wheeled.md b/docs/components/base/wheeled.md index f54fa3a41e..1562a43dea 100644 --- a/docs/components/base/wheeled.md +++ b/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" %}} diff --git a/docs/components/board/beaglebone.md b/docs/components/board/beaglebone.md index b7f1dc6cb1..c6f9a2ddae 100644 --- a/docs/components/board/beaglebone.md +++ b/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" %}} diff --git a/docs/components/board/esp32.md b/docs/components/board/esp32.md index 2eeadfec95..a94abc5689 100644 --- a/docs/components/board/esp32.md +++ b/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" >}} diff --git a/docs/components/board/jetson.md b/docs/components/board/jetson.md index a756a8c6f4..42b712c250 100644 --- a/docs/components/board/jetson.md +++ b/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" %}} diff --git a/docs/components/board/numato.md b/docs/components/board/numato.md index 415578265e..9cf21e4d2d 100644 --- a/docs/components/board/numato.md +++ b/docs/components/board/numato.md @@ -14,7 +14,11 @@ component_description: "Supports Numato GPIO Modules and peripherals for adding -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" %}} diff --git a/docs/components/board/odroid.md b/docs/components/board/odroid.md index fe20825385..70d97f81ee 100644 --- a/docs/components/board/odroid.md +++ b/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" %}} diff --git a/docs/components/board/orangepi.md b/docs/components/board/orangepi.md index 29f964ee17..85d2973f9d 100644 --- a/docs/components/board/orangepi.md +++ b/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/). diff --git a/docs/components/board/pca9685.md b/docs/components/board/pca9685.md index 6d2a1fea69..07393323d3 100644 --- a/docs/components/board/pca9685.md +++ b/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 I2C Interface](https://www.adafruit.com/product/815) into your machine: +Configure a `pca9685` board to integrate a [PCA9685 Arduino I2C 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" %}} diff --git a/docs/components/board/pi5.md b/docs/components/board/pi5.md index 690d43dc2c..5f54817bac 100644 --- a/docs/components/board/pi5.md +++ b/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" %}} diff --git a/docs/components/board/ti.md b/docs/components/board/ti.md index 3ad2dc4448..2786e2a82a 100644 --- a/docs/components/board/ti.md +++ b/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" %}} diff --git a/docs/components/board/upboard.md b/docs/components/board/upboard.md index 547176ddb3..6ab122ca91 100644 --- a/docs/components/board/upboard.md +++ b/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. diff --git a/docs/components/camera/esp32-camera.md b/docs/components/camera/esp32-camera.md index 67f6c6c815..feae07a20d 100644 --- a/docs/components/camera/esp32-camera.md +++ b/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" %}} diff --git a/docs/components/camera/ffmpeg.md b/docs/components/camera/ffmpeg.md index ed8b93064b..33b7201995 100644 --- a/docs/components/camera/ffmpeg.md +++ b/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" %}} diff --git a/docs/components/camera/webcam.md b/docs/components/camera/webcam.md index 40030b9c4b..f17b650538 100644 --- a/docs/components/camera/webcam.md +++ b/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" %}} diff --git a/docs/components/component/board1.md b/docs/components/component/board1.md index a3bd3e1b9d..1b322757f6 100644 --- a/docs/components/component/board1.md +++ b/docs/components/component/board1.md @@ -20,6 +20,10 @@ Follow the [setup guide](/installation/prepare/board1-setup) to prepare your ` board to integrate an [](http://www.example.com), [](http://example.com), or [](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" >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/component/model1.md b/docs/components/component/model1.md index 695b7edb1f..1316152521 100644 --- a/docs/components/component/model1.md +++ b/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" %}} diff --git a/docs/components/encoder/ams-as5048.md b/docs/components/encoder/ams-as5048.md index 5cd585fb8d..156b48f2b8 100644 --- a/docs/components/encoder/ams-as5048.md +++ b/docs/components/encoder/ams-as5048.md @@ -18,6 +18,9 @@ This is an absolute encoder that uses an I2C 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" %}} diff --git a/docs/components/encoder/incremental-micro-rdk.md b/docs/components/encoder/incremental-micro-rdk.md index 0aca5b5823..78c24ff40f 100644 --- a/docs/components/encoder/incremental-micro-rdk.md +++ b/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" %}} diff --git a/docs/components/encoder/incremental.md b/docs/components/encoder/incremental.md index 7c1e2251c8..222c99bc23 100644 --- a/docs/components/encoder/incremental.md +++ b/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" %}} diff --git a/docs/components/encoder/single-micro-rdk.md b/docs/components/encoder/single-micro-rdk.md index a978f92fd5..6e01bb30ca 100644 --- a/docs/components/encoder/single-micro-rdk.md +++ b/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" %}} diff --git a/docs/components/encoder/single.md b/docs/components/encoder/single.md index d39f185f0b..79885828b6 100644 --- a/docs/components/encoder/single.md +++ b/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" %}} diff --git a/docs/components/gantry/multi-axis.md b/docs/components/gantry/multi-axis.md index 09ba2a085b..f02329ee24 100644 --- a/docs/components/gantry/multi-axis.md +++ b/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" %}} diff --git a/docs/components/gantry/single-axis.md b/docs/components/gantry/single-axis.md index 58a3c614ac..fd5e741cd3 100644 --- a/docs/components/gantry/single-axis.md +++ b/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" %}} diff --git a/docs/components/gripper/softrobotics.md b/docs/components/gripper/softrobotics.md index 555d6e88fa..360c99a09f 100644 --- a/docs/components/gripper/softrobotics.md +++ b/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" %}} diff --git a/docs/components/input-controller/gamepad.md b/docs/components/input-controller/gamepad.md index 817c6b87d5..9f56c20be0 100644 --- a/docs/components/input-controller/gamepad.md +++ b/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" %}} diff --git a/docs/components/input-controller/gpio.md b/docs/components/input-controller/gpio.md index d4acadb93b..fc55994130 100644 --- a/docs/components/input-controller/gpio.md +++ b/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" %}} diff --git a/docs/components/input-controller/webgamepad.md b/docs/components/input-controller/webgamepad.md index 327f0d4a71..2564aea69e 100644 --- a/docs/components/input-controller/webgamepad.md +++ b/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`: diff --git a/docs/components/motor/28byj48.md b/docs/components/motor/28byj48.md index b6f1ce6505..35097303d2 100644 --- a/docs/components/motor/28byj48.md +++ b/docs/components/motor/28byj48.md @@ -21,8 +21,10 @@ Viam also supports: {{< /alert >}} -To configure a `28byj48` motor as a component of your machine, first configure the [board](/components/board/) to which the motor driver is wired. -Then, add the motor: +To use a `28byj48` motor as a component of your machine, first wire your 28BYJ-48 or similar small stepper motor to a suitable motor driver such as the ULN2003, and wire the driver to a board. +Connect the system to power if you want to test it while configuring. +Configure the [board](/components/board/) to which the motor driver is wired. +Then configure the motor: {{< tabs name="gpiostepper-config">}} {{% tab name="Config Builder" %}} diff --git a/docs/components/motor/dmc4000.md b/docs/components/motor/dmc4000.md index 4651d15ce5..306ded1636 100644 --- a/docs/components/motor/dmc4000.md +++ b/docs/components/motor/dmc4000.md @@ -19,6 +19,10 @@ When using it, you do not need to configure a [board component](/components/boar The DMC-40x0 controller can drive a variety of motor types, but the built-in Viam implementation supports only stepper motors at this time. You can drive other types of motors with Viam and the DMC-40x0 controller by creating a {{< glossary_tooltip term_id="modular-resource" text="modular resource" >}} to add support for it. +Physically connect your motor to the DMC controller, and connect the controller to your machine's computer. +Power both on. +Then, configure the motor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/motor/encoded-motor.md b/docs/components/motor/encoded-motor.md index 2a072bac0c..5a2fd4fbc2 100644 --- a/docs/components/motor/encoded-motor.md +++ b/docs/components/motor/encoded-motor.md @@ -21,6 +21,11 @@ See the [encoder component documentation](/components/encoder/) for more informa Viam supports `gpio` model motors with encoders. To configure an encoded motor, you must configure the encoder [per the encoder documentation](/components/encoder/) and then configure a `gpio` motor with an `encoder` attribute in addition to the [standard `gpio` model attributes](/components/motor/gpio/). +Physically connect your motor to a suitable driver chip, and connect that to your board, as well as connecting the encoder. +Connect the system to power if you want to test it while configuring. +Configure the [board](/components/board/) and the [encoder](/components/encoder/). +Then, configure the motor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/motor/gpio-micro-rdk.md b/docs/components/motor/gpio-micro-rdk.md index 826778abde..d645673bd9 100644 --- a/docs/components/motor/gpio-micro-rdk.md +++ b/docs/components/motor/gpio-micro-rdk.md @@ -16,7 +16,10 @@ The `gpio` model supports [DC motors](https://en.wikipedia.org/wiki/DC_motor) (b You can configure [encoders](/components/encoder/) to work with `gpio` motors. Find more information in the [encoded motor documentation](/components/motor/encoded-motor/). -To configure a DC motor as a component of your machine, first configure the [board](/components/board/) to which the motor driver is wired. +To configure a DC motor as a component of your machine, first make sure the motor is wired to a suitable motor driver, which is in turn wired to the microcontroller. +Connect the system to power if you want to test it while configuring. +Configure the [board](/components/board/esp32/) to which the motor driver is wired. +Then configure the motor: Then add your motor: {{< tabs name="gpio-config">}} diff --git a/docs/components/motor/gpio.md b/docs/components/motor/gpio.md index 0a8e2532a6..3d3d38ebe7 100644 --- a/docs/components/motor/gpio.md +++ b/docs/components/motor/gpio.md @@ -20,8 +20,10 @@ The `gpio` model supports [DC motors](https://en.wikipedia.org/wiki/DC_motor) (b Find more information in the [encoded motor documentation](/components/motor/encoded-motor/). {{< /alert >}} -To configure a DC motor as a component of your machine, first configure the [board](/components/board/) to which the motor driver is wired. -Then add your motor: +To configure a DC motor as a component of your machine, first make sure the motor is wired to a suitable motor driver, which is in turn wired to a board. +Connect the system to power if you want to test it while configuring. +Configure the [board](/components/board/) to which the motor driver is wired. +Then configure your motor: {{< tabs name="gpio-config">}} {{% tab name="Config Builder" %}} diff --git a/docs/components/motor/gpiostepper.md b/docs/components/motor/gpiostepper.md index bebca75781..4374865bad 100644 --- a/docs/components/motor/gpiostepper.md +++ b/docs/components/motor/gpiostepper.md @@ -18,8 +18,9 @@ The `gpiostepper` model of the motor component supports bipolar [stepper motors] Viam also supports some more advanced stepper driver chips ([TMC5072](../tmc5072/), [DMC4000](../dmc4000/)) that have their own microcontrollers that handle things like speed and acceleration control. {{< /alert >}} -To configure a `gpiostepper` motor as a component of your machine, first configure the [board](/components/board/) to which the motor driver is wired. -Then, add the motor: +To use a `gpiostepper` motor as a component of your machine, first wire your motor to a suitable stepper motor driver, which is in turn wired to a board. +Configure the [board](/components/board/) to which the motor driver is wired. +Then configure the motor: {{< tabs name="gpiostepper-config">}} {{% tab name="Config Builder" %}} diff --git a/docs/components/motor/roboclaw.md b/docs/components/motor/roboclaw.md index c735e3ba85..f969feb361 100644 --- a/docs/components/motor/roboclaw.md +++ b/docs/components/motor/roboclaw.md @@ -22,7 +22,10 @@ Follow [this guide](https://resources.basicmicro.com/roboclaw-motor-controllers- {{< /alert >}} -To configure a `roboclaw` motor as a component of your machine: +To use a `roboclaw` motor as a component of your machine, first wire your DC motor to the RoboClaw motor driver, and wire the driver to a board. +Connect the system to power if you want to test it while configuring. +Configure the [board](/components/board/) to which the motor driver is wired. +Then configure the motor: {{< tabs name="Configure your roboclaw motor">}} {{% tab name="Config Builder" %}} diff --git a/docs/components/motor/tmc5072.md b/docs/components/motor/tmc5072.md index 563976c1c2..1369d702b3 100644 --- a/docs/components/motor/tmc5072.md +++ b/docs/components/motor/tmc5072.md @@ -15,6 +15,10 @@ The `TMC5072` model supports stepper motors controlled by the [TMC5072 chip](htt Whereas a basic low-level stepper driver supported by the [`gpiostepper` model](/components/motor/gpiostepper/) sends power to a stepper motor based on PWM signals from GPIO pins, the TMC5072 chip uses SPI bus to communicate with the board, does some processing on the chip itself, and provides convenient features including StallGuard2TM. +To configure a TMC5072-driven motor as a component of your machine, first make sure your stepper motor is wired to a TMC5072 motor driver, which is in turn wired to a board. +Configure the [board](/components/board/) to which the motor driver is wired. +Then, configure the motor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/accel-adxl345-micro-rdk.md b/docs/components/movement-sensor/accel-adxl345-micro-rdk.md index 35b3e002cd..4929547b56 100644 --- a/docs/components/movement-sensor/accel-adxl345-micro-rdk.md +++ b/docs/components/movement-sensor/accel-adxl345-micro-rdk.md @@ -18,6 +18,9 @@ This three axis accelerometer supplies linear acceleration data, supporting the If you are using a [Viam Rover](/appendix/try-viam/), this is the accelerometer on it. +Physically connect your movement sensor to your microcontroller and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/adxl345.md b/docs/components/movement-sensor/adxl345.md index 2c03156256..233469d9b8 100644 --- a/docs/components/movement-sensor/adxl345.md +++ b/docs/components/movement-sensor/adxl345.md @@ -17,6 +17,9 @@ This three axis accelerometer supplies linear acceleration data, supporting the If you are using a [Viam Rover](/appendix/try-viam/), this is the accelerometer on it. +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/dual-gps-rtk.md b/docs/components/movement-sensor/dual-gps-rtk.md index 1fd6b989f9..60c22c5f33 100644 --- a/docs/components/movement-sensor/dual-gps-rtk.md +++ b/docs/components/movement-sensor/dual-gps-rtk.md @@ -15,6 +15,9 @@ aliases: The `dual-gps-rtk` model of movement sensor calculates a compass heading from two GPS movement sensors, and returns the midpoint position between the first and second GPS devices as its position. In addition to [`GetCompassHeading()`](/appendix/apis/components/movement-sensor/#getcompassheading), this model provides data for [`GetPosition()`](/appendix/apis/components/movement-sensor/#getposition) and [`GetAccuracy()`](/appendix/apis/components/movement-sensor/#getaccuracy). +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md b/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md index a264dd7b14..063df9a52e 100644 --- a/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md +++ b/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md @@ -37,6 +37,9 @@ If your movement sensor uses serial communication instead of I2C, use {{% /alert %}} +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/gps-nmea-rtk-serial.md b/docs/components/movement-sensor/gps-nmea-rtk-serial.md index 3fe6e56c05..11da95e290 100644 --- a/docs/components/movement-sensor/gps-nmea-rtk-serial.md +++ b/docs/components/movement-sensor/gps-nmea-rtk-serial.md @@ -38,6 +38,9 @@ If your movement sensor uses I2C communication instead of serial, use {{% /alert %}} +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/gps-nmea.md b/docs/components/movement-sensor/gps-nmea.md index c75f74614c..b2379c38a8 100644 --- a/docs/components/movement-sensor/gps-nmea.md +++ b/docs/components/movement-sensor/gps-nmea.md @@ -19,7 +19,10 @@ You can obtain fix and correction data by using the sensor [`GetReadings`](/appe The `gps-nmea` movement sensor model supports [NMEA-based](https://en.wikipedia.org/wiki/NMEA_0183) GPS units and RTCM versions up to 3.3. This GPS model uses communication standards set by the National Marine Electronics Association (NMEA). -The `gps-nmea` model can be connected using USB and send data through a serial connection to any device, or employ an I2C connection to a board: +The `gps-nmea` model can be connected using USB and send data through a serial connection to any device, or employ an I2C connection to a board. + +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/gyro-mpu6050-micro-rdk.md b/docs/components/movement-sensor/gyro-mpu6050-micro-rdk.md index 29e3d92bdd..44c5926c18 100644 --- a/docs/components/movement-sensor/gyro-mpu6050-micro-rdk.md +++ b/docs/components/movement-sensor/gyro-mpu6050-micro-rdk.md @@ -15,6 +15,9 @@ toc_hide: true The `gyro-mpu6050` movement sensor model supports a combination [gyroscope and accelerometer manufactured by TDK InvenSense](https://invensense.tdk.com/products/motion-tracking/6-axis/mpu-6050/). +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/imu-vectornav.md b/docs/components/movement-sensor/imu-vectornav.md index d8bb45e6d0..d32734f147 100644 --- a/docs/components/movement-sensor/imu-vectornav.md +++ b/docs/components/movement-sensor/imu-vectornav.md @@ -17,6 +17,9 @@ Acceleration and magnetometer data are available by using the [sensor](/componen The `imu-vectornav` movement sensor model supports IMUs manufactured by [VectorNav](https://www.vectornav.com/products) that support SPI connection. +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/imu-wit-hwt905.md b/docs/components/movement-sensor/imu-wit-hwt905.md index 5b9e230914..b59446ed66 100644 --- a/docs/components/movement-sensor/imu-wit-hwt905.md +++ b/docs/components/movement-sensor/imu-wit-hwt905.md @@ -17,6 +17,9 @@ To get all the raw sensor data, you can use the [sensor](/components/sensor/) [` The `imu-wit-hwt905` movement sensor model supports the [HWT905-TTL IMU](https://www.wit-motion.com/proztgjd/39.html) manufactured by WitMotion. +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/imu-wit.md b/docs/components/movement-sensor/imu-wit.md index e57c2614bc..bbd50e8d31 100644 --- a/docs/components/movement-sensor/imu-wit.md +++ b/docs/components/movement-sensor/imu-wit.md @@ -31,6 +31,9 @@ If you are using WitMotion's HWT905 IMU, configure an [`imu-wit-hwt905`](../imu- {{% /alert %}} +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/movement-sensor/mpu6050.md b/docs/components/movement-sensor/mpu6050.md index ee059bc925..ca1fe158b3 100644 --- a/docs/components/movement-sensor/mpu6050.md +++ b/docs/components/movement-sensor/mpu6050.md @@ -14,6 +14,9 @@ component_description: "Supports the MPU-6050 movement sensor." The `gyro-mpu6050` movement sensor model supports a combination [gyroscope and accelerometer manufactured by TDK InvenSense](https://invensense.tdk.com/products/motion-tracking/6-axis/mpu-6050/). +Physically connect your movement sensor to your machine's computer and power both on. +Then, configure the movement sensor: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/power-sensor/ina219.md b/docs/components/power-sensor/ina219.md index 529e7f88de..a4c9204a7d 100644 --- a/docs/components/power-sensor/ina219.md +++ b/docs/components/power-sensor/ina219.md @@ -14,7 +14,10 @@ component_description: "Supports the INA219 power sensor for current and power m # SME: --- -Configure an `INA219` power sensor to integrate a [Texas Instruments INA219](https://www.ti.com/product/INA229) into your machine: +Configure an `INA219` power sensor to integrate a [Texas Instruments INA219](https://www.ti.com/product/INA229) into your machine. + +Physically connect your power sensor to your machine's computer and power both on. +Then, configure the power sensor: {{< tabs name="Configure an INA219 Power Sensor" >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/power-sensor/ina226.md b/docs/components/power-sensor/ina226.md index 2f825d1a16..3991fff775 100644 --- a/docs/components/power-sensor/ina226.md +++ b/docs/components/power-sensor/ina226.md @@ -12,7 +12,9 @@ component_description: "Supports the INA226 power sensor for current and power m # SME: --- -Configure an `INA226` power sensor to integrate a [Texas Instruments INA226](https://www.ti.com/product/INA226) into your machine: +Configure an `INA226` power sensor to integrate a [Texas Instruments INA226](https://www.ti.com/product/INA226) into your machine. +Physically connect your power sensor to your machine's computer and power both on. +Then, configure the power sensor: {{< tabs name="Configure an INA226 Power Sensor" >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/power-sensor/renogy.md b/docs/components/power-sensor/renogy.md index 895a237522..a27da1e508 100644 --- a/docs/components/power-sensor/renogy.md +++ b/docs/components/power-sensor/renogy.md @@ -13,7 +13,9 @@ component_description: "Supports the renogy power sensor - a solar charge contro # SME: #team-bucket --- -Configure a `renogy` sensor to integrate a [Renogy charge controller](https://www.renogy.com/wanderer-10a-pwm-charge-controller/) into your machine: +Configure a `renogy` sensor to integrate a [Renogy charge controller](https://www.renogy.com/wanderer-10a-pwm-charge-controller/) into your machine. +Physically connect your power sensor to your machine's computer and power both on. +Then, configure the power sensor: {{< tabs name="Configure a Renogy Sensor" >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/sensor/bme280.md b/docs/components/sensor/bme280.md index ad9681b3b2..b68b9d6cdc 100644 --- a/docs/components/sensor/bme280.md +++ b/docs/components/sensor/bme280.md @@ -13,7 +13,9 @@ component_description: "Supports the BME280 environmental sensor." # SME: #team-bucket --- -Configure a `bme280` sensor to integrate a [BME280 environmental sensor](https://www.adafruit.com/product/2652), used for sensing temperature, humidity, and barometric pressure, into your machine: +Configure a `bme280` sensor to integrate a [BME280 environmental sensor](https://www.adafruit.com/product/2652), used for sensing temperature, humidity, and barometric pressure, into your machine. +Physically connect your sensor to your machine's computer and power both on. +Then, configure the sensor: {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/sensor/ds18b20.md b/docs/components/sensor/ds18b20.md index 4647e04cd2..679f17563b 100644 --- a/docs/components/sensor/ds18b20.md +++ b/docs/components/sensor/ds18b20.md @@ -13,7 +13,9 @@ component_description: "Supports the DallasTemperature DS18B20 digital temperatu # SME: #team-bucket --- -Configure a `ds18b20` sensor to integrate a [DallasTemperature DS18B20 1-wire digital temperature sensor](https://www.adafruit.com/product/381) into your machine: +Configure a `ds18b20` sensor to integrate a [DallasTemperature DS18B20 1-wire digital temperature sensor](https://www.adafruit.com/product/381) into your machine. +Physically connect your sensor to your machine's computer and power both on. +Then, configure the sensor: {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/sensor/sensirion-sht3xd.md b/docs/components/sensor/sensirion-sht3xd.md index 2b96d222d7..a1047591b7 100644 --- a/docs/components/sensor/sensirion-sht3xd.md +++ b/docs/components/sensor/sensirion-sht3xd.md @@ -13,7 +13,9 @@ component_description: "Supports the Sensirion SHT3x-DIS temperature and humidit # SME: #team-bucket --- -Configure a `sensirion-sht3xd` sensor to integrate a [Sensirion SHT3x-DIS temperature and humidity sensor](https://www.adafruit.com/product/2857) into your machine: +Configure a `sensirion-sht3xd` sensor to integrate a [Sensirion SHT3x-DIS temperature and humidity sensor](https://www.adafruit.com/product/2857) into your machine. +Physically connect your sensor to your machine's computer and power both on. +Then, configure the sensor: {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/sensor/ultrasonic-micro-rdk.md b/docs/components/sensor/ultrasonic-micro-rdk.md index 805ae0c99a..d76481b131 100644 --- a/docs/components/sensor/ultrasonic-micro-rdk.md +++ b/docs/components/sensor/ultrasonic-micro-rdk.md @@ -13,7 +13,9 @@ aliases: # SME: Andrew Morrow --- -Configure an `ultrasonic` sensor to integrate the [HC-S204](https://www.sparkfun.com/products/15569) ultrasonic distance sensor into your machine: +Configure an `ultrasonic` sensor to integrate the [HC-S204](https://www.sparkfun.com/products/15569) ultrasonic distance sensor into your machine. +Physically connect your sensor to your microcontroller and power both on. +Then, configure the sensor: {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/servo/gpio-micro-rdk.md b/docs/components/servo/gpio-micro-rdk.md index 96fdd24493..d525e84336 100644 --- a/docs/components/servo/gpio-micro-rdk.md +++ b/docs/components/servo/gpio-micro-rdk.md @@ -14,7 +14,9 @@ micrordk_component: true # SME: Gautham --- -Configure a `gpio` servo to integrate a hobby servo controlled by general-purpose input/output (GPIO) pins into your machine: +Configure a `gpio` servo to integrate a hobby servo controlled by general-purpose input/output (GPIO) pins into your machine. +Physically connect your servo to your microcontroller and power both on. +Then, configure the servo: {{< tabs name="Configure a gpio Servo" >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/servo/gpio.md b/docs/components/servo/gpio.md index ff344f7186..2c8392a173 100644 --- a/docs/components/servo/gpio.md +++ b/docs/components/servo/gpio.md @@ -13,7 +13,9 @@ component_description: "Supports hobby servos wired to any model of board beside # SME: Rand --- -Configure a `gpio` servo to integrate a hobby servo controlled by general-purpose input/output (GPIO) pins on a non-`viam:raspberry-pi:rpi` model [board](/components/board/) into your machine: +Configure a `gpio` servo to integrate a hobby servo controlled by general-purpose input/output (GPIO) pins on a non-`viam:raspberry-pi:rpi` model [board](/components/board/) into your machine. +Physically connect your servo to your board and power both on. +Then, configure the servo: {{< tabs name="Configure a gpio Servo" >}} {{% tab name="Config Builder" %}} diff --git a/docs/services/base-rc/_index.md b/docs/services/base-rc/_index.md index c186883c76..78050d8247 100644 --- a/docs/services/base-rc/_index.md +++ b/docs/services/base-rc/_index.md @@ -43,6 +43,9 @@ You can monitor the input from these controls in the **CONTROL** tab of the [Via You must configure a [base](/components/base/) with a [movement sensor](/components/movement-sensor/) as part of your machine to be able to use a base remote control service. +First, make sure your base is physically assembled and powered on. +Then, configure the service: + {{< tabs >}} {{% tab name="Builder" %}} diff --git a/docs/services/navigation/_index.md b/docs/services/navigation/_index.md index 2bc7a43d9f..3a35d7b089 100644 --- a/docs/services/navigation/_index.md +++ b/docs/services/navigation/_index.md @@ -40,6 +40,9 @@ See [navigation concepts](#navigation-concepts) for more info on how to implemen ## Configuration +First, make sure your base is physically assembled and powered on. +Then, configure the service: + {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/services/vision/detector_3d_segmenter.md b/docs/services/vision/detector_3d_segmenter.md index 45bd935589..86fc60f604 100644 --- a/docs/services/vision/detector_3d_segmenter.md +++ b/docs/services/vision/detector_3d_segmenter.md @@ -18,6 +18,9 @@ The `detector_3d_segmenter` vision service model takes 2D bounding boxes from an If the chosen camera is not equipped to do projections from 2D to 3D, then this vision model will fail. The label and the pixels associated with the 2D detections become the label and point cloud associated with the 3D segmenter. +First, make sure your camera is connected to your machine's computer and both are powered on. +Then, configure the service: + {{< tabs >}} {{% tab name="Builder" %}} diff --git a/docs/services/vision/obstacles_depth.md b/docs/services/vision/obstacles_depth.md index 35406f8770..0e5da97777 100644 --- a/docs/services/vision/obstacles_depth.md +++ b/docs/services/vision/obstacles_depth.md @@ -16,7 +16,8 @@ _Changed in [RDK v0.2.36 and API v0.1.118](/appendix/changelog/#vision-service)_ The `obstacles_depth` vision service model is for depth cameras, and is best for motion planning with transient obstacles. Use this segmenter to identify well separated objects above a flat plane. -Configure an `obstacles_depth` segmenter: +First, make sure your camera is connected to your machine's computer and both are powered on. +Then, configure an `obstacles_depth` segmenter: {{< tabs >}} {{% tab name="Builder" %}} diff --git a/docs/services/vision/obstacles_distance.md b/docs/services/vision/obstacles_distance.md index 95a3e2269e..21ee09cdc3 100644 --- a/docs/services/vision/obstacles_distance.md +++ b/docs/services/vision/obstacles_distance.md @@ -18,6 +18,9 @@ It is best for transient obstacle avoidance. For example, if you have an ultrasonic distance sensor as [`viam:ultrasonic:camera`](https://github.com/viam-modules/viam-ultrasonic), this model will query the sensor `"num_queries"` times, and then take the average point from those measurements and return that as an obstacle. +First, make sure your camera is connected to your machine's computer and both are powered on. +Then, configure the service: + {{< tabs >}} {{% tab name="Builder" %}} diff --git a/docs/services/vision/obstacles_pointcloud.md b/docs/services/vision/obstacles_pointcloud.md index e3a7725b37..96dfc15459 100644 --- a/docs/services/vision/obstacles_pointcloud.md +++ b/docs/services/vision/obstacles_pointcloud.md @@ -16,6 +16,9 @@ _Changed in [RDK v0.2.36 and API v0.1.118](/appendix/changelog/#vision-service)_ `obstacles_pointcloud` is a segmenter that identifies well separated objects above a flat plane. It first identifies the biggest plane in the scene, eliminates that plane, and clusters the remaining points into objects. +First, make sure your camera is connected to your machine's computer and both are powered on. +Then, configure the service: + {{< tabs >}} {{% tab name="Builder" %}}