Skip to content

Commit

Permalink
DOCS-1197: Review modular resource docs (#2106)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Oct 31, 2023
1 parent 20007fb commit 77244f7
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 84 deletions.
18 changes: 9 additions & 9 deletions docs/modular-resources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ Viam provides built-in support for a variety of {{< glossary_tooltip term_id="re
- Various types of hardware {{< glossary_tooltip term_id="component" text="components" >}}.
- High-level functionality exposed as {{< glossary_tooltip term_id="service" text="services" >}}.

If the {{< glossary_tooltip term_id="component" text="component" >}} or {{< glossary_tooltip term_id="service" text="service" >}} you want to use for your project is not natively supported, you can [use _modular resources_ from the Viam Registry](#the-viam-registry) or [create your own modular resources](#create-your-own-modular-resources).
If the component or service you want to use for your project is not natively supported, you can use _modular resources_ from the [Viam Registry](#the-viam-registry) or [create your own modular resources](#create-your-own-modular-resources).
You configure and manage modular resources the same way as built-in resources and use the same [standardized APIs](/program/apis/).

## The Viam Registry

The [Viam registry](https://app.viam.com/registry) is the central place where you can browse modular resources that add capabilities to your smart machine beyond what is built-in to `viam-server`.
You can see details about each module in the [Viam registry](https://app.viam.com/registry) on its module details page.
The [Viam registry](https://app.viam.com/registry) is the central place where you can browse modular resources that add capabilities to your smart machine beyond what is built into `viam-server`.
You can see details about each module in the Viam registry on its module details page.

You can search the available modular resources from the Viam Registry here:

Expand All @@ -51,11 +51,11 @@ You can search the available modular resources from the Viam Registry here:
<div id="pagination"></div>
</div>

To use a modular resource from the registry, add it from your robot's **Configuration** tab in [the Viam app](https://app.viam.com/), using the **Create component** button.
To use a modular resource from the registry, add it from your robot's **Config** tab in [the Viam app](https://app.viam.com/), using the **Create component** button.

## Create Your Own Modular Resources
## Create your own modular resources

If none of the existing modular resources in the Viam registry support your use case, you can also create your own modular resources:
If none of the existing modular resources in the Viam registry support your use case, you can create your own modular resources:

- **Implement a custom component**: You can write a driver for an unsupported {{< glossary_tooltip term_id="component" text="component" >}} by implementing the corresponding component API.

Expand All @@ -65,13 +65,13 @@ If none of the existing modular resources in the Viam registry support your use

To create a new modular resource:

1. [Code a new resource model](/modular-resources/create/) by implementing all methods for the component's or services's [standardized APIs](/program/apis/).
1. [Code a new resource model](/modular-resources/create/) by implementing all methods for the component's or service's [standardized APIs](/program/apis/).
1. Package your modular resource or modular resources as a {{< glossary_tooltip term_id="module" text="module" >}} and [upload the module to the Viam registry](/modular-resources/upload/) to make it available for deployment to robots.
You can upload _private_ modules for your [organization](/manage/fleet/organizations/) or _public_ modules.
1. Once you have uploaded your module to the registry, you can [deploy and configure the module](/modular-resources/configure/) from [the Viam app](https://app.viam.com/).
You can test your added resource using the [Control tab](/manage/fleet/#remote-control) and [program](/program/) it with Viam's Go or Python SDKs.
You can test your added resource using the [**Control** tab](/manage/fleet/#remote-control) and [program](/program/) it with Viam's Go or Python SDKs.

Some use cases may require you to extend the standardized API definitions or deploy custom components using a server on a remote part.
Some use cases may require you to define a new API, or to deploy custom components using a server on a remote part.
For more information, see [Advanced Modular Resources](/modular-resources/advanced/).

## Related tutorials
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ However, if you are unable to use [modular resources](/modular-resources/) becau
Once you have coded your custom component and configured the remote servers, you can control and monitor your component with the Viam SDKs, like any other component.

To show how to create a custom resource, the following example creates an arm as a custom component and registers the new arm model with a Viam SDK.
Then you can control it as part of your robot with the same [API methods](/components/arm/#api) available for [arm models built-in to the RDK](/components/arm/#supported-models).
Then you can control it as part of your robot with the same [API methods](/components/arm/#api) available for [arm models built into the RDK](/components/arm/#supported-models).

## Instructions

Expand Down
Loading

0 comments on commit 77244f7

Please sign in to comment.