Viam Documentation
  • SDK Documentation
    Python SDK Documentation Go Client SDK Documentation
  • Welcome to the Viam Documentation Site
    • Getting Started
      • What is Viam?
      • Using the Viam App
      • Try Viam
    • Installation
      • Viam Server on Linux
      • Viam Server on macOS
      • Raspberry Pi Setup
      • BeagleBone Setup
    • Product Overviews
      • Fleet Management
      • Data Management
      • Robot Development Kit
      • SDKs as Client
      • SDKs as Server
    • Tutorials
      • Blink an LED with a Pi and the Viam App
      • Blink an LED with a Pi and the SDK
      • Configure a Camera
      • Configure a SCUTTLE Robot
      • Driving SCUTTLE with a Gamepad
      • Drive a Yahboom Rover with a Gamepad
      • Colored Object Follower
      • RGB Line Follower
      • Try Viam Rover Tutorial
      • Try Viam: Drive the Rover with the SDK
      • Build a Mock Robot
      • Try Viam: Color Detection
      • Calibrate a Camera
      • Run SLAM on your Robot
      • Intro to Data Management
      • Dart Launcher Robot
    • Components
      • Arm
      • Base
      • Board
      • Camera
      • Encoder
      • Gantry
      • Input Controller
      • Motor
      • Movement Sensor
      • Sensor
      • Servo
    • Services
      • Data Management
      • Motion
      • Frame System
      • SLAM
      • Vision
      • Robot Service
    • Deeper Dive
      • Control Package
      • Robot-to-Robot Communication
    • Appendix
      • Try Viam FAQ
      • Orientation Vector
      • Glossary
      • Release Notes
      • Troubleshooting
  • Product Overviews
  • Tutorials
  • Components - Pieces of hardware in your robot
  • Services - Higher level software-only APIs
  • Deep Dives
  • Appendix
  • SDKs
  1. Welcome to the Viam Documentation Site

Welcome to the Viam Documentation Site

Getting Started

Looking to get started with Viam? Check out the following:

  • Viam Overview
  • Try Viam
  • Viam Use Cases
  • Intro Video
  • Build a Mock Robot without Hardware
Click to view our Founder's Message (Link opens in new tab)

Product Overviews

  • Overview of Viam-Server and RDK
  • Viam’s Fleet Management
  • Using Viam’s SDKs as a Client Application
  • Using Viam’s SDKs for a Server Hardware Implementation
  • Viam’s Data Management Platform

Tutorials

The Tutorials topic and the TOC list our tutorials in order from the basic to complex.

SCUTTLE-based tutorials

  • Configuring SCUTTLE Rover with a Camera
  • Controlling a SCUTTLE Rover with a Bluetooth Gamepad
  • Detecting Color with the SCUTTLE Rover

Yahboom-based tutorials

  • Setting up a Yahboom 4WD Rover with a Bluetooth Gamepad

Simple Raspberry Pi tutorials

  • Making an LED Blink with a Raspberry Pi
  • Making an LED Blink with a Raspberry Pi and Viam’s SDKs

Other tutorials

  • Building a Line-Following Robot with a Rover and a Camera
  • All Tutorials

Components - Pieces of hardware in your robot

  • Arm
  • Base - a mobile robot base, examples: wheeled, tracked, boat, drone
  • Board
  • Camera
  • Encoder
  • Gantry
  • Input Controller
  • Motor
  • Movement Sensor
  • Sensor
  • Servo

Services - Higher level software-only APIs

  • Robot Service - meta data about a robot and robot level operations
  • Vision
  • Motion
  • Data Management
  • Simultaneous Localization and Mapping (SLAM)

Deep Dives

  • End-to-End Flow

Appendix

  • Glossary
  • Orientation Vector
  • Troubleshooting

SDKs

  • Python SDK
© 2025 Viam, Inc. - Documentation is licensed under Creative Commons ShareAlike License. All Rights Reserved
PRIVACY POLICY