Note
This is a module template. Read the instructions for a step by step guide on how to create your module.
This module implements... With this model, you can...
Add instructions here for any requirements.
To use this module, follow the instructions to add a module from the Viam Registry and select the <INSERT API NAMESPACE>:<INSERT API NAME>:<INSERT MODEL> model from the [<INSERT MODEL> module](https://app.viam.com/module//).
Note
Before configuring your sensor you must create a machine.
Navigate to the Config tab of your machine's page in the Viam app.
Click on the Components subtab and click Create component.
Select the <INSERT API NAME> type, then select the <INSERT MODEL> model.
Click Add module, then enter a name for your sensor and click Create.
On the new component panel, copy and paste the following attribute template into your sensor’s Attributes box:
{
<INSERT SAMPLE ATTRIBUTES>
}Note
For more information, see Configure a Machine.
The following attributes are available for <INSERT API NAMESPACE>:<INSERT API NAME>:<INSERT MODEL> sensor's:
| Name | Type | Inclusion | Description |
|---|---|---|---|
todo1 |
string | Required | TODO |
todo2 |
string | Optional | TODO |
{
<INSERT SAMPLE CONFIGURATION(S)>
}Add any additional information you want readers to know and direct them towards what to do next with this module. For example:
- To test your...
- To write code against your...
Add troubleshooting notes here.