Skip to content

Commit

Permalink
Update docs/how-tos/sensor-module.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Dec 12, 2024
1 parent 9bfec6f commit adc5d2a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/how-tos/sensor-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ You can create these automatically using the Viam module generator:
| Language | The language for the module. To follow this guide, choose Python. |
| Visibility | Choose `Private` to share only with your organization, or `Public` to share publicly with all organizations. If you are testing, choose `Private`. |
| Namespace/Organization ID | In the [Viam app](https://app.viam.com), navigate to your organization settings through the menu in upper right corner of the page. Find the **Public namespace** and copy that string. In the example snippets below, the namespace is `jessamy`. |
| Resource to add to the module (API) | The [component API](/appendix/apis/#component-apis) or [service API](/appendix/apis/#service apis) the resource you're creating implements. Choose `Sensor Component` for this guide. |
| Resource to add to the module (API) | The [component API](/appendix/apis/#component-apis) or [service API](/appendix/apis/#service-apis) the resource you're creating implements. Choose `Sensor Component` for this guide. |
| Model name | Name your sensor based on what it supports, for example, if it supports a model of ultrasonic sensor called “XYZ Sensor 1234” you could call your model `XYZ_1234` or similar. |
| Enable cloud build | You can select `No` for this guide because you'll build the module yourself before uploading it. If you select `Yes` and push the generated files (including the <file>.github</file> folder) and create a release of the format `vX.X.X`, the module will build and upload to the Viam registry. |
| Register module | Select `Yes` unless you are creating a local-only module for testing purposes and do not intend to upload it. |
Expand Down

0 comments on commit adc5d2a

Please sign in to comment.