Create and configure a smart machine

1. Create a machine in the Viam app

First, create a Viam account if you haven’t already. Log in.

Then create a machine by typing in a name and clicking Add machine.

2. Install Viam on your machine

All of the software that runs your machine on a computer is packaged into a binary called viam-server. If you are using a microcontroller, use viam-micro-server instead. Install it on the computer controlling your smart machine by following the setup instructions in the Viam app.

You can install viam-server on your personal computer, or on a single-board computer (SBC). After following the setup instructions, your machine should connect and appear as Live on the Viam app.

3. Navigate to the CONFIGURE tab of your machine

Machines can be small and simple or very complex but they are all configured on the CONFIGURE tab of the Viam app. A machine can be a single-board computer with a single sensor or LED wired to it, or a machine can consist of multiple computers with many physical components connected, acting as one unit.

Click on the CONFIGURE tab of your machine’s page in the Viam app to navigate to it.

4. Configure your components

Each physical piece of your smart machine that is controlled by a computer is called a component. For example, if your smart machine includes an arm, a motor, and a camera, each of those is a component.

For each component that makes up your machine:

1. Find an appropriate model for your hardware. You can find the available models on the component pages. For example, you can scroll through available sensor models on the sensor page.

2. You need to configure your machine so that viam-server can interact with its hardware. Use the configuration builder tool in the Viam app to create a file that describes what hardware you are using and how it is connected. For example, if you have a DC motor, follow the corresponding configuration instructions to tell the software which pins it is connected to.

3. Add a suitable model to your machine on the CONFIGURE page:

   • Click the + icon next to your machine part in the left-hand menu and select Component.
   • Choose any component type (example: camera) and model (example: webcam). If a component you want to use for your project is not natively supported, you can build your own modular resource.

4. When you add a component model, it will create a panel in the configuration builder tool. Fill in any required attributes, following the documentation for the specific model.

5. Click the TEST area of the configuration panel to test your component, for example to view a camera feed or turn a motor.

6. If any problems occur check the LOGS tab. You can also review the configuration history and roll back changes if needed.

5. Control your components

When you configured each component, you saw the TEST panel on its configuration panel. You can also access the control interfaces for all your components in one place from the CONTROL tab. With the panels, you can drive motors at different speeds, view your camera feeds, see sensor readings, and generally test the basic functionality of your machine before you’ve even written any code.

6. Configure services

Services are built-in Viam software packages that add high-level functionality to your smart machine such as:

• Data Management: Capture and sync data from one or more machines, and use that data for machine learning and beyond.
• Fleet Management: Configure, control, debug, and manage entire fleets of machines.
• Motion Planning: Make your machine plan its movement and move itself.
• Vision: Enable your machine to intelligently see and interpret the world around it.
• Simultaneous Localization And Mapping (SLAM): Make your machine map its surroundings and find its position on a map.

If you want to use any services, see their documentation for configuration and usage information. If you are making a simple machine that doesn’t use services, you can skip this step!