Modular Resources
Integrate additional hardware or software functionality into your machine with modular resources.
Tag: Services
Configure a color_detector
A heuristic detector that draws boxes around objects according to their hue (does not detect black, gray, and white).
Configure a Fake Generic Service
Configure a fake generic service using the generic service API.
Configure an mlmodel Detector or Classifier
A detector or classifier that uses an ML model available on the machine to draw bounding boxes around objects or return a class label.
Train and deploy computer vision models
Use your image data to train a model, so your machines can make inferences about their environments.
Vision Service
The vision service enables your machine to use its on-board cameras to intelligently see and interpret the world around it.
Vision service API
Give commands to get detections, classifications, or point cloud objects, depending on the ML model the vision service is using.
Configure a detector_3d_segmenter
This model takes 2D bounding boxes from an object detector and projects the pixels in the bounding box to points in 3D space.
Configure an obstacles_depth Segmenter
A segmenter for depth cameras that returns the perceived obstacles as a set of 3-dimensional bounding boxes, each with a Pose as a vector.
Configure an obstacles_distance Segmenter
A segmenter that takes point clouds from a camera input and returns the average single closest point to the camera as a perceived obstacle.
Configure an obstacles_pointcloud Segmenter
A segmenter that identifies well-separated objects above a flat plane.
Create a Hello World module
Get started writing your own modular resources by creating a Hello World module.
Create a new module
Add support for a new component or service model by writing a module.
Create a sensor module with Python
Add a new model of sensor component by writing a module in Python.
Upload a module to the Viam Registry
Make your module available to others by uploading it to the modular resource registry.
Update and manage modules you created
Update or delete your existing modules, or change their privacy settings.
Capture, filter, and sync image data
Capture images from a camera on your machine and selectively sync images to the cloud with filtering.
Detect objects in a camera stream
Detect people and their location in an image with any webcam and a vision service.
Configure multiple similar machines
Viam has a built-in tool called fragments for using the same configuration on multiple machines.
Data Management
Capture data from machines, sync it to the cloud, and access it and train image classification and object detection models on the data.
Motion Service
The motion service enables your machine to plan and move its components relative to itself, other machines, and the world.
Machine Architecture: Parts
Connect multiple machine parts to each other as sub-parts or remotes.
Reference Frame Configuration
How to configure the frame system in an scenario where a component is fixed to a static object.
Nested Reference Frame Configuration
How to configure the Frame System in an scenario where a component is attached to another component.
The Robot Frame System
The frame system holds reference frame information for the relative position of components in space.
Navigation service API
Give commands to define waypoints and move your machine along those waypoints while avoiding obstacles.
Navigation Service
The navigation service uses GPS to autonomously navigate a rover to user-defined waypoints.
Teleoperate and navigate rovers
Use Viam to teleoperate and navigate rover bases.
Generic service API
Give commands to your generic components for running model-specific commands using DoCommand.
SLAM service API
Give commands to get a machine’s position within a map.
SLAM Service
Simultaneous localization and mapping (SLAM) allows your machine to create a map of its surroundings and find its location within that map.
Manage a fleet of machines
Use Viam’s fleet management capabilities to share and manage access to your machines.
Base Remote Control service API
Give commands to get a list of inputs from the controller that are being monitored for that control mode.
Base Remote Control Service
The base remote control service allows you to remotely control a base with an input controller like a gamepad.
Cartographer Modular Resource
Configure a Simultaneous Localization And Mapping (SLAM) service with the Cartographer modular resource.
CloudSLAM Wrapper Modular Resource
Configure a Simultaneous Localization And Mapping (SLAM) service that runs in the cloud using Viam.
Configure Complex Kinematic Chains
Define kinematic parameters to configure intermediate reference frames for components with complex kinematic chains.
Modular Resource Examples
Tutorials and repositories with modular resources configuration examples.
Add a TensorFlow Lite Modular Service
Add an ML model modular-resource-based service which uses TensorFlow Lite to classify audio samples.
Advanced Modular Resources
Some usage may require you to define new APIs or deploy custom components using a server on a remote part
Viam Architecture
How a machine running on Viam is structured, from on-device to cloud communications.
Generic Service
A service that does not fit any of the other APIs.
The Viam Registry
Add additional models of components and services or ML models from the Viam Registry, or extend Viam by creating new modular resources.
Visualize Data With Grafana
Collect data from your machine or fleet and visualize it in Grafana.
Create a Facial Verification System
Create an alarm system that can detect people and can recognize faces, allowing it to smartly trigger alarms.
Pet Photographer: Create a Data Filtering Module
Use the filter modular component in the Viam app to photograph your pet in their collar.
Add Constraints and Transforms to a Motion Plan
Use constraints and transforms with the motion service.
Plan Motion with an Arm and a Gripper
Use the motion service to move robot arms and other components.
Detect color with a webcam
Detect colors and their location in an image with any webcam and a vision service.
Build a Line Follower with a Rover and a Webcam
Build a line-following robot that relies on a webcam and color detection.
Follow a Colored Object with a Rover (like SCUTTLE)
Instructions for detecting and following a colored object with a rover, like a SCUTTLE robot.