DOCS-2691: Add Create a Sensor Module how-to #3259

JessamyT · 2024-08-16T02:26:01Z

https://docs-test.viam.dev/3259/how-tos/sensor-module/

sguequierre · 2024-08-16T14:56:49Z

docs/use-cases/sensor-module.md

+
+{{< /expand >}}
+
+Run your test script from your command line and make sure you are able to get readings from the sensor before proceeding.


Suggested change

Run your test script from your command line and make sure you are able to get readings from the sensor before proceeding.

Run your test script from your command line interface and make sure you are able to get readings from the sensor before proceeding.

I think?

I believe a "CLI" is something you interface with from within the terminal, such as the Viam CLI. I will change this to "terminal window" or "terminal" because that seems to be more general, whereas "command prompt" is more Windows-based.

sguequierre · 2024-08-16T14:57:35Z

docs/use-cases/sensor-module.md

+
+## Generate boilerplate module code
+
+You need some boilerplate files to make your module.


this might be hard to understand without knowing what boilerplate means, maybe simple explanation of term?

sguequierre · 2024-08-16T14:58:35Z

docs/use-cases/sensor-module.md

+1. When prompted for a model triplet, use `<your organization public namespace>:<repo name>:<what you want to call your sensor model>`.
+   For example, `jessamy:weather:meteo_PM`.
+
+   - You can find your organization namespace by going to your organization settings in the [Viam app](https://app.viam.com).


might need more explanation, idk what to do in organization settings. Or is that next bullet point?

I thought about this, but since nowadays we're erring on the side of less verbosity, if someone can figure out how to write a module I trust them to find this with a gesture in the right direction. I think clicking the name of their org, and then clicking "settings", is intuitive enough if they know they're looking for organization settings.

sguequierre · 2024-08-16T15:01:57Z

docs/use-cases/sensor-module.md

+{{< expand "Example sensor module README" >}}
+
+````md
+# meteo_PM modular component


Suggested change

# meteo_PM modular component

# `meteo_PM` modular component

sguequierre · 2024-08-16T15:02:10Z

docs/use-cases/sensor-module.md

+
+To use this module, follow these instructions to [add a module from the Viam Registry](https://docs.viam.com/registry/configure/#add-a-modular-resource-from-the-viam-registry) and select the `rdk:sensor:jessamy:weather:meteo_PM` model from the [`jessamy:weather:meteo_PM` module](https://app.viam.com/module/rdk/jessamy:weather:_PM).
+
+## Configure your meteo_PM sensor


Suggested change

## Configure your meteo_PM sensor

## Configure your `meteo_PM` sensor

npentrel · 2024-08-16T16:44:51Z

I don't have the time to go through this in detail today unfortunately.
From a brief review:

I love the test script start and the examples you have there.
do you think you could change the formatting to be similar to https://docs-test.viam.dev/3259/use-cases/collect-sensor-data/ ? I think this is now short enough that that could work, and I do think it's important we try to keep these consistent in styling...

docs/how-tos/sensor-module.md

npentrel · 2024-08-19T17:08:43Z

docs/how-tos/sensor-module.md

+   For example, `jessamy:weather:meteo_PM`.
+
+   - You can find your organization namespace by going to your organization settings in the [Viam app](https://app.viam.com).
+   - The repo name (family name) is the name of the GitHub repo where you will put your module code.


Suggested change

- The repo name (family name) is the name of the GitHub repo where you will put your module code.

- The repo name (also used as family name) is generally the name of the GitHub repo where you will put your module code.

We say repo name elsewhere in the docs, but the generator says family name. What exactly does "also used as" mean here?

docs/how-tos/sensor-module.md

npentrel · 2024-08-19T17:16:33Z

docs/how-tos/sensor-module.md

+
+It's a good idea to test your module locally before uploading it to the [Viam registry](https://app.viam.com/registry):
+
+1. Follow [the local module testing instructions](/how-tos/create-module/#test-your-module-locally) to configure your local module and then the associated model on your machine.


I think those steps are so small state you can include them directly, maybe in slightly shortened form

docs/how-tos/sensor-module.md

npentrel

The content is very good. I do think there is value in conforming to the how-to template for this. I don't want this to merge without conforming to the template. And I don't know that we'll be able to make a decision on a new formatting quickly. I think I'd like to see where the formatting fails before we make a decision on moving away from the format.

The create a module and the update and manage modules page don't conform to it but I think that's because we still have work to do on them. For this how-to I don't see why the format shouldn't work right now.

docs/how-tos/sensor-module.md

npentrel · 2024-08-20T13:04:56Z

docs/how-tos/sensor-module.md

+{{< /expand >}}
+{{% /tablestep %}}
+{{% tablestep %}}
+**2. Run your test script**


You can if you want to skip having steps for this part. I agree that here it feels a bit unnecessary. In the rest it's more helpful. Up to you.

Sorry i'm not sure what this comment is in relation to

I'm saying you don't need to put tablesteps here into the "Start with a test script" section if you don't want to

npentrel · 2024-08-20T13:07:14Z

docs/how-tos/sensor-module.md

+{{% tablestep %}}
+**1. Install and run the module generator**
+
+Follow the steps in the [readme](https://github.com/viam-labs/generator-viam-module/tree/main) to install the generator and run it.


Given the instruction can be one command to run I don't see a reason to direct them to the readme. It's better if we keep them on one page

Suggested change

Follow the steps in the [readme](https://github.com/viam-labs/generator-viam-module/tree/main) to install the generator and run it.

The following commands will install a module generator [generator-viam-module](https://github.com/viam-labs/generator-viam-module/tree/main).

You must have node 16 or newer installed.

npm install -g yo generator-viam-module

Then run the generator with:

yo viam-module

npentrel · 2024-08-20T13:08:15Z

docs/how-tos/sensor-module.md

+
+{{< table >}}
+{{% tablestep %}}
+**1. Install and run the module generator**


Suggested change

**1. Install and run the module generator**

**1. Install the module generator**

docs/how-tos/sensor-module.md

npentrel

A few minor things then I think this is ready for merge

docs/how-tos/sensor-module.md

Co-authored-by: Naomi Pentrel <[email protected]>

…ator steps

docs/how-tos/sensor-module.md

Co-authored-by: Naomi Pentrel <[email protected]>

docs/how-tos/sensor-module.md

viambot · 2024-08-20T22:43:54Z

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3259

viambot added the safe to build label Aug 16, 2024

JessamyT changed the title ~~2691sensormodule~~ DOCS-2691: Add Create a Sensor Module how-to Aug 16, 2024

sguequierre reviewed Aug 16, 2024

View reviewed changes

JessamyT force-pushed the 2691sensormodule branch from ae128d8 to bc38515 Compare August 16, 2024 19:45

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Show resolved Hide resolved

npentrel reviewed Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Show resolved Hide resolved

npentrel requested changes Aug 19, 2024

View reviewed changes

JessamyT commented Aug 19, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

JessamyT force-pushed the 2691sensormodule branch from 89a5e0e to 5528015 Compare August 19, 2024 23:10

JessamyT requested a review from npentrel August 19, 2024 23:10

npentrel reviewed Aug 20, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 20, 2024

View reviewed changes

JessamyT commented Aug 20, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

npentrel reviewed Aug 20, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

JessamyT and others added 17 commits August 20, 2024 14:07

DOCS-2691: Add Create a Sensor Module How-to

9a9cbce

DOCS-2691: Add sensor module how-to

cf18ad4

nits

c74087a

python lint

020a8e4

lint

d574ca7

nit

1830fca

Address Sierra feedback and add in this page

10fcfa0

Fix links and line

ab4831c

tweaks

8fd9fb5

tweak update title

a9171e7

Apply suggestions from code review

9c4fe41

Co-authored-by: Naomi Pentrel <[email protected]>

Apply suggestions from code review

6381211

Co-authored-by: Naomi Pentrel <[email protected]>

Format with tablestep

d15ad93

Add module config instructions in line

f79bb6c

Apply suggestions from code review

2a607c9

Co-authored-by: Naomi Pentrel <[email protected]>

Remove step formatting from write a test script, and add module gener…

016cea8

…ator steps

feedback

Loading
Loading status checks…

7cdf645

JessamyT force-pushed the 2691sensormodule branch from 24a7ab8 to 7cdf645 Compare August 20, 2024 21:08

JessamyT requested a review from npentrel August 20, 2024 21:14

Fix em dash

Loading
Loading status checks…

f200555

JessamyT commented Aug 20, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

Apply suggestions from code review

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

GPG key ID: B5690EEEBB952194

Verified
Learn about vigilant mode

Loading
Loading status checks…

9be3e13

Co-authored-by: Naomi Pentrel <[email protected]>

npentrel approved these changes Aug 20, 2024

View reviewed changes

JessamyT commented Aug 20, 2024

View reviewed changes

docs/how-tos/sensor-module.md Outdated Show resolved Hide resolved

remove trailing space

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

GPG key ID: B5690EEEBB952194

Verified
Learn about vigilant mode

Loading
Loading status checks…

c13c5cc

JessamyT merged commit 93d00b0 into viamrobotics:main Aug 20, 2024
9 checks passed

JessamyT deleted the 2691sensormodule branch August 20, 2024 23:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCS-2691: Add Create a Sensor Module how-to #3259

DOCS-2691: Add Create a Sensor Module how-to #3259

JessamyT commented Aug 16, 2024 •

edited

Loading

sguequierre Aug 16, 2024 •

edited

Loading

JessamyT Aug 16, 2024

sguequierre Aug 16, 2024

sguequierre Aug 16, 2024

JessamyT Aug 16, 2024

sguequierre Aug 16, 2024

sguequierre Aug 16, 2024

npentrel commented Aug 16, 2024

npentrel Aug 19, 2024

JessamyT Aug 19, 2024

npentrel Aug 19, 2024

npentrel left a comment

npentrel Aug 20, 2024

JessamyT Aug 20, 2024

npentrel Aug 20, 2024

JessamyT Aug 20, 2024

npentrel Aug 20, 2024 •

edited

Loading

npentrel Aug 20, 2024

npentrel left a comment

viambot commented Aug 20, 2024


		{{< /expand >}}

		Run your test script from your command line and make sure you are able to get readings from the sensor before proceeding.


		## Generate boilerplate module code

		You need some boilerplate files to make your module.


		To use this module, follow these instructions to [add a module from the Viam Registry](https://docs.viam.com/registry/configure/#add-a-modular-resource-from-the-viam-registry) and select the `rdk:sensor:jessamy:weather:meteo_PM` model from the [`jessamy:weather:meteo_PM` module](https://app.viam.com/module/rdk/jessamy:weather:_PM).

		## Configure your meteo_PM sensor

	## Configure your meteo_PM sensor
	## Configure your `meteo_PM` sensor

	- The repo name (family name) is the name of the GitHub repo where you will put your module code.
	- The repo name (also used as family name) is generally the name of the GitHub repo where you will put your module code.


		It's a good idea to test your module locally before uploading it to the [Viam registry](https://app.viam.com/registry):

		1. Follow [the local module testing instructions](/how-tos/create-module/#test-your-module-locally) to configure your local module and then the associated model on your machine.

-Follow the steps in the [readme](https://github.com/viam-labs/generator-viam-module/tree/main) to install the generator and run it.
+The following commands will install a module generator [generator-viam-module](https://github.com/viam-labs/generator-viam-module/tree/main).
+You must have node 16 or newer installed.
+npm install -g yo generator-viam-module
+Then run the generator with:
+yo viam-module

	1. Install and run the module generator
	1. Install the module generator

DOCS-2691: Add Create a Sensor Module how-to #3259

DOCS-2691: Add Create a Sensor Module how-to #3259

Conversation

JessamyT commented Aug 16, 2024 • edited Loading

sguequierre Aug 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

npentrel commented Aug 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

npentrel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

npentrel Aug 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

npentrel left a comment

Choose a reason for hiding this comment

viambot commented Aug 20, 2024

JessamyT commented Aug 16, 2024 •

edited

Loading

sguequierre Aug 16, 2024 •

edited

Loading

npentrel Aug 20, 2024 •

edited

Loading