diff --git a/assets/use-cases/new-machine.png b/assets/use-cases/new-machine.png new file mode 100644 index 0000000000..246eb3c685 Binary files /dev/null and b/assets/use-cases/new-machine.png differ diff --git a/assets/use-cases/signup-narrow.png b/assets/use-cases/signup-narrow.png new file mode 100644 index 0000000000..16d44a77a4 Binary files /dev/null and b/assets/use-cases/signup-narrow.png differ diff --git a/docs/build/configure/_index.md b/docs/build/configure/_index.md index f33c19f6bc..710708eb4c 100644 --- a/docs/build/configure/_index.md +++ b/docs/build/configure/_index.md @@ -14,7 +14,7 @@ aliases: Before you can program a robot, you must configure it. -A robot's configuration tells the code running the robot what _resources_ (hardware _components_ and software _services_) it has access to, as well as any relevant parameters for those resources. +A robot's configuration tells the code running the robot what _{{< glossary_tooltip term_id="resource" text="resources" >}}_ (hardware _{{< glossary_tooltip term_id="component" text="components" >}}_ and software _{{< glossary_tooltip term_id="service" text="services" >}}_) it has access to, as well as any relevant parameters for those resources. To start configuring, go to the [Viam app](https://app.viam.com), create a new robot and follow the steps on your new robot’s **Setup** tab. diff --git a/docs/use-cases/configure.md b/docs/use-cases/configure.md index 445bf5f474..7501b7daa5 100644 --- a/docs/use-cases/configure.md +++ b/docs/use-cases/configure.md @@ -3,6 +3,68 @@ title: "Build a simple smart machine" linkTitle: "Build simple smart machines" weight: 10 type: "docs" -layout: "empty" -canonical: "build/configure/" +description: "Build a simple smart machine in a few steps using Viam's modular system of components and services without writing much or any code." +tags: ["components", "configuration"] --- + +You can get a smart machine running with Viam in just a few steps. + +Viam's modular system of {{< glossary_tooltip term_id="component" text="components" >}} and {{< glossary_tooltip term_id="service" text="services" >}} means that you can start doing interesting things with your machine without writing much or any code. + + + + + + + + + + + + + + + + + + + + +
{{}} + 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 smart machine is packaged into a binary called viam-server. + Install it on the computer controlling your smart machine by following the steps on your machine's Setup tab in the Viam app.

+
{{}} + 3. Configure your components

+

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

+

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.

+
{{}} + 4. Test your components

+

When you configure a component, a remote control panel is generated for it in the Control tab of the Viam app. 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 robot before you've even written any code. +

+
{{}} + 5. Configure services

+

Services are built-in Viam software packages that add high-level functionality to your smart machine like computer vision or motion planning. + 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! +

+
{{}} + 6. Do more with code

+

Write a program to control your smart machine using the programming language of your choice. Viam has SDKs for Python, Golang, C++, TypeScript and Flutter.

+

The easiest way to get started is to copy the auto-generated boilerplate code from your machine's Code sample tab in the Viam app. You can run this code directly on the machine or from a separate computer; it will connect to the machine using API keys.

+
+ +## Next steps + +{{< cards >}} +{{% card link="/get-started/try-viam/" %}} +{{% card link="/tutorials/get-started/lazy-susan/" %}} +{{% card link="/tutorials/get-started/blink-an-led/" %}} +{{% card link="/tutorials/services/color-detection-scuttle/" %}} +{{< /cards >}}