You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For quick instructions on configuring a module on your machine, see [Configure hardware on your machine](/operate/get-started/supported-hardware/#configure-hardware-on-your-machine).
15
15
16
-
###Modular resource configuration details
16
+
## Modular resource configuration details
17
17
18
18
The modular resource card allows you to configure attributes for the resource.
19
19
@@ -79,7 +79,7 @@ The following properties are available for modular resources:
79
79
|`model`| string |**Required**| The full {{< glossary_tooltip term_id="model-namespace-triplet" text="model namespace triplet">}} of the modular resource's {{< glossary_tooltip term_id="model" text="model" >}}. |
80
80
|`depends_on`| array | Optional | The `name` of components you want to confirm are available on your machine alongside your modular resource. Often a [board](/operate/reference/components/board/). Unnecessary if you coded [implicit dependencies](/operate/get-started/other-hardware/dependencies/). |
81
81
82
-
###Module configuration details
82
+
## Module configuration details
83
83
84
84
{{< tabs >}}
85
85
{{% tab name="Config Builder" %}}
@@ -196,7 +196,7 @@ You can add and edit `env` by switching from **Builder** to **JSON** mode in the
196
196
|`name`| string |**Required**| A name for this instance of the module. |
197
197
|`env`| object | Optional | Environment variables available to the module. For example `{ "API_KEY": "${environment.API_KEY}" }`. Some modules require that you set environment variables as part of configuration. Check the module's readme for more information. See [environment variables](#environment-variables). |
198
198
199
-
####Module versioning
199
+
### Module versioning
200
200
201
201
You can configure how each module on your machine updates itself when a newer version becomes available from the Viam Registry.
202
202
By default, a newly-added module is set to pin to the latest release (**Latest**) of the version you added.
@@ -227,7 +227,7 @@ For any version type other than **Patch (X.Y.Z)**, the module will upgrade as so
227
227
If, for example, the module provides a motor component, and the motor is running, it will stop while the module upgrades.
228
228
{{% /alert %}}
229
229
230
-
####Environment variables
230
+
### Environment variables
231
231
232
232
Each module has access to the following default environment variables.
233
233
Not all of these variables are automatically available on [local modules](/operate/get-started/other-hardware/#test-your-module-locally); you can manually set variables your module requires if necessary.
@@ -291,3 +291,70 @@ To set the path to a program or library on a machine, you can set a system varia
291
291
```
292
292
293
293
{{% /expand%}}
294
+
295
+
## Configure an unlisted module
296
+
297
+
To configure a module that is uploaded to the Viam Registry but has [visibility](/operate/get-started/other-hardware/manage-modules/#change-module-visibility) set to **Unlisted**, you need to manually add the module to your configuration:
298
+
299
+
1. Navigate to the module's page in the Viam Registry, using the link to the module.
300
+
301
+
1. Find the **Unlisted module usage** section.
302
+
303
+
1. Copy the module configuration JSON snippet.
304
+
305
+
1. In the Viam app, navigate to the **CONFIGURE** tab of the machine you want to configure.
306
+
307
+
1. Switch to **JSON** mode.
308
+
309
+
1. Paste the copied module configuration into your `modules` array.
310
+
311
+
1. Copy the model configuration snippet for the model you want to use, and add it to your `components` or `services` array (as appropriate).
0 commit comments