diff --git a/docs/operate/get-started/setup.md b/docs/operate/get-started/setup.md index da3018fc93..579edc637a 100644 --- a/docs/operate/get-started/setup.md +++ b/docs/operate/get-started/setup.md @@ -62,7 +62,7 @@ When you create a new machine in the Viam app, Viam generates a unique set of cr ### Installation methods: `viam-agent` versus manual -`viam-agent` is a service manager that automatically updates `viam-server` and includes tools for [provisioning your devices](/manage/fleet/provision/setup/) configuring operating system updates. +`viam-agent` is a service manager that automatically updates `viam-server` and includes tools for [provisioning your devices](/manage/fleet/provision/setup/) and configuring operating system updates. When you set up a Linux device in the Viam app, you'll see an option to install using `viam-agent`, or to manually install only `viam-server`. Using `viam-agent` is generally recommended when installing `viam-server` on a single-board computer. @@ -106,4 +106,4 @@ Viam also offers a lightweight binary to support the following 32-bit microcontr ESP32 microcontrollers must have at least 2 cores, 384kB SRAM, 2MB PSRAM and 4MB flash to work with Viam. Viam can run on Windows Subsystem for Linux (WSL), but WSL itself does not currently support exposing many types of Windows hardware to the embedded Linux kernel. -This means that some hardware, such as a connected webcam, may not be available to `viam-server` with WSL, even though it is fully supported for native Linux systems. \ No newline at end of file +This means that some hardware, such as a connected webcam, may not be available to `viam-server` with WSL, even though it is fully supported for native Linux systems. diff --git a/docs/operate/get-started/supported-hardware.md b/docs/operate/get-started/supported-hardware.md index b806d01fd1..2eae5921e7 100644 --- a/docs/operate/get-started/supported-hardware.md +++ b/docs/operate/get-started/supported-hardware.md @@ -9,20 +9,37 @@ description: "Use supported hardware with your machine." modulescript: true --- -Viam supports a wide variety of sensors, cameras, motors, robotic arms, and other physical hardware. -Viam also supports various software services such as [data capture](/data-ai/get-started/capture-sync/), [computer vision](/data-ai/ai/create-dataset/), and [motion planning](/operate/mobility/move-arm/), designed to integrate seamlessly with the hardware driver modules. - -Any hardware that is not already supported by a Viam {{< glossary_tooltip term_id="module" text="module" >}} can be added into Viam's system of modular resources by [creating a new module](../other-hardware/) that provides a driver for the hardware. - -After [setting up your machine's computer](/operate/get-started/setup/), you can start adding supported hardware. +Viam supports a wide variety of sensors, cameras, and other physical hardware, with APIs for each of the following types of hardware: + +{{< cards >}} +{{% relatedcard link="/dev/reference/apis/components/arm/" %}} +{{% relatedcard link="/dev/reference/apis/components/base/" %}} +{{% relatedcard link="/dev/reference/apis/components/board/" %}} +{{% relatedcard link="/dev/reference/apis/components/camera/" %}} +{{% relatedcard link="/dev/reference/apis/components/encoder/" %}} +{{% relatedcard link="/dev/reference/apis/components/gantry/" %}} +{{% relatedcard link="/dev/reference/apis/components/gripper/" %}} +{{% relatedcard link="/dev/reference/apis/components/input-controller/" %}} +{{% relatedcard link="/dev/reference/apis/components/motor/" %}} +{{% relatedcard link="/dev/reference/apis/components/movement-sensor/" %}} +{{% relatedcard link="/dev/reference/apis/components/power-sensor/" %}} +{{% relatedcard link="/dev/reference/apis/components/sensor/" %}} +{{% relatedcard link="/dev/reference/apis/components/servo/" %}} +{{< /cards >}} + +These standardized APIs are implemented by {{< glossary_tooltip term_id="module" text="modules" >}} that provide drivers for specific models of hardware. + +Any hardware that is not already supported by a Viam module can be added into Viam's system of modular resources by [creating a new module](../other-hardware/) that provides a driver for the hardware. + +Viam also supports various software services such as [data capture](/data-ai/get-started/capture-sync/) and [computer vision](/data-ai/ai/create-dataset/), designed to integrate seamlessly with the hardware driver modules. ## Supported hardware -Many modules are designed to run alongside the full version of [`viam-server`](/operate/get-started/setup/), which runs on 64-bit architectures such as single-board computers and laptop/desktop computers running 64-bit Linux, as well as macOS. +Many modules are designed to run alongside the full version of [`viam-server`](/operate/reference/viam-server/), which runs on 64-bit architectures such as single-board computers and laptop/desktop computers running 64-bit Linux, as well as macOS. -Other modules are designed to run on microcontrollers alongside `viam-micro-server`. +Other modules are designed to run on microcontrollers alongside [`viam-micro-server`](/operate/reference/viam-micro-server/). -{{< expand "For use with 64-bit architecture" >}} +### For use with 64-bit architecture The following modular components are available for computers and SBCs running `viam-server`. @@ -40,8 +57,7 @@ The Viam Registry is the storage and distribution system for not just hardware m You can browse the [Viam Registry in the Viam app](https://app.viam.com/registry?type=Module). {{% /alert %}} -{{< /expand >}} -{{< expand "For use with ESP-32 microcontrollers" >}} +### For use with ESP-32 microcontrollers The following is a selection of components (some built-ins and some modules) written for use with `viam-micro-server`. To use any of the built-in components, configure them according to their readmes. @@ -57,11 +73,9 @@ To use a module with `viam-micro-server`, you need to [build firmware that combi | `moisture_sensor` | [GitHub repo](https://github.com/viamrobotics/micro-rdk/tree/main/examples/modular-drivers/src). | No | | `water_pump` | [GitHub repo](https://github.com/viamrobotics/micro-rdk/tree/main/examples/modular-drivers/src). | No | -{{< /expand >}} - ## Configure hardware on your machine -After installing `viam-server` or `viam-micro-server` on your computer or microcontroller, you can configure hardware components on your machine's page in the [Viam app](https://app.viam.com): +After [installing `viam-server` or `viam-micro-server`](/operate/get-started/setup/) on your computer or microcontroller, you can configure hardware components on your machine's page in the [Viam app](https://app.viam.com): 1. Click the **+** button on your machine's **CONFIGURE** tab. 1. Click **Component**, then select from available components from the Viam Registry (as well as built-in resources).