diff --git a/assets/registry/configure/add-local-module-config-builder.png b/assets/registry/configure/add-local-module-config-builder.png deleted file mode 100644 index b137f330f7..0000000000 Binary files a/assets/registry/configure/add-local-module-config-builder.png and /dev/null differ diff --git a/assets/registry/configure/add-local-module-create.png b/assets/registry/configure/add-local-module-create.png index 2a6e55537d..2aaba9339a 100644 Binary files a/assets/registry/configure/add-local-module-create.png and b/assets/registry/configure/add-local-module-create.png differ diff --git a/assets/registry/configure/add-local-module-csi-cam.png b/assets/registry/configure/add-local-module-csi-cam.png index d54915d634..7c96271b38 100644 Binary files a/assets/registry/configure/add-local-module-csi-cam.png and b/assets/registry/configure/add-local-module-csi-cam.png differ diff --git a/assets/registry/configure/add-local-module-list.png b/assets/registry/configure/add-local-module-list.png deleted file mode 100644 index 9386f908ee..0000000000 Binary files a/assets/registry/configure/add-local-module-list.png and /dev/null differ diff --git a/assets/registry/configure/edit-local-module.png b/assets/registry/configure/edit-local-module.png new file mode 100644 index 0000000000..3317c5d797 Binary files /dev/null and b/assets/registry/configure/edit-local-module.png differ diff --git a/docs/registry/configure.md b/docs/registry/configure.md index 07e011d7d2..8d04888942 100644 --- a/docs/registry/configure.md +++ b/docs/registry/configure.md @@ -384,28 +384,23 @@ See the instructions to [compile your module into an executable](/registry/creat To add a local module on your machine, first add its module, then the component or service it implements: -1. Navigate to the **Config** tab of your machine's page in [the Viam app](https://app.viam.com). -1. Click on the **Modules** subtab. -1. Scroll to the **Add local module** section. -1. Enter a **Name** for this instance of your modular resource. -1. Enter the [module's executable path](/registry/create/#compile-or-package-your-module). +1. Navigate to the **CONFIGURE** tab of your machine's page in [the Viam app](https://app.viam.com). +2. Click the **+** icon next to your machine part in the left-hand menu and select **Local module**, then **Local module**. +3. Enter a **Name** for this instance of your modular resource. +4. Enter the [module's executable path](/registry/create/#compile-or-package-your-module). This path must be the absolute path to the executable on your machine's filesystem. -1. Then, click the **Add module** button, and click **Save** in the upper right corner to save your config. +5. Then, click the **Create** button, and click **Save** in the upper right corner to save your config. - {{}} + {{}} This example shows the configuration for adding a [CSI camera](https://github.com/viamrobotics/csi-camera/) as a local module. -1. Navigate to the **Config** tab of your machine's page on [the Viam app](https://app.viam.com). - - - If you are adding a modular [component](/components/), click the **Components** subtab and click **Create component**. - - If you are adding a modular [service](/services/), click the **Services** subtab and click **Create service**. - -1. Then, select the `local component` or `local service` type from the list. +6. Now, stay on the **CONFIGURE** tab of your machine's page on [the Viam app](https://app.viam.com). - {{}} + - Click the **+** icon next to your machine part in the left-hand menu and select **Local module**. + - Then, select **Local component** or **Local service**. -1. On the next screen: +7. On the **Create** menu for a **Local component** or **Local service**: - Select the type of modular resource provided by your module, such as a [camera](/components/camera/), from the dropdown menu. - Enter the {{< glossary_tooltip term_id="model-namespace-triplet" text="model namespace triplet">}} of your modular resource's {{< glossary_tooltip term_id="model" text="model" >}}. @@ -413,19 +408,19 @@ To add a local module on your machine, first add its module, then the component - Enter a name for this instance of your modular resource. This name must be different from the module name. - {{}} + {{}} -1. Click **Create** to create the modular resource provided by the local module. +8. Click **Create** to create the modular resource provided by the local module. -Once you've added your local module using steps 1-6, you can repeat steps 7-10 to add as many additional instances of your modular resource as you need. +Once you've added your local module using steps 1-5, you can repeat steps 6-8 to add as many additional instances of your modular resource as you need. ### Edit the configuration of a local module -Once you have added a modular resource to your machine, you can view and edit the underlying module from the **Modules** subtab: +Once you have added a modular resource to your machine, you can view and edit the underlying module. -1. Navigate to the **Config** tab of your machine's page in [the Viam app](https://app.viam.com). -1. Click on the **Modules** subtab. - Local modules you have added to your machine appear under the **Local** section. +Navigate to the **CONFIGURE** tab of your machine's page in [the Viam app](https://app.viam.com). +Local modules you have added to your machine are identifiable by name. +Locate a module's card in the part-resource hierarchy and click on it to expand. The following properties are available for modules: @@ -436,12 +431,12 @@ The following properties are available for modules: `executable_path` | string | **Required**| The absolute path to the executable on your machine's filesystem. | `type` | string | **Required**| Either `registry` or `local`. | -Add these properties to your module's configuration: +Edit these properties in your module's JSON configuration: {{< tabs >}} {{% tab name="Config Builder" %}} -{{}} +{{}} {{% /tab %}} {{% tab name="JSON Template" %}}