DOCS-3103: Add Go to Hello World Module how-to #3730

JessamyT · 2024-12-04T20:42:54Z

No description provided.

njooma · 2024-12-05T19:37:09Z

docs/how-tos/hello-world-module.md

+   1. Change the name of <file>hello-world/models/module.go</file> to <file>hello-camera.go</file> and change the name of the <file>/models/</file> folder to <file>hellocamera</file> so you have <file>hello-world/hellocamera/hello-camera.go</file>.<br><br>
+
+   1. In the first line of <file>hello-camera.go</file>, change `package models` to `package hellocamera`.<br><br>
+
+   1. Change the name of <file>temporary/models/module.go</file> to <file>hello-sensor.go</file> and change the name of its folder to <file>hellosensor</file>.
+      Move the <file>hellosensor</file> folder from <file>temporary</file> to <file>hello-world</file> so you have <file>hello-world/hellosensor/hello-sensor.go</file>.<br><br>
+
+   1. In the first line of <file>hello-sensor.go</file>, change `package models` to `package hellosensor`.<br><br>


We probably shouldn't tell them to update the directory names, but just the file names. So the file structure should be hello-world/models/hello-camera.go and hello-world/models/hello-sensor.go, both with the package name package models.

What will the generator do when multi-model modules are added to its capabilities? Will it put them all in one models folder?

I made all the necessary changes to get it to work but this way feels like more work for the user than making a directory per model, with the current way the files are generated. I think it'd be great if the Config struct was named mysensorConfig or something (matching the generator inputs) by default.

Likely when the generator can do multiple, it'll all be in the models directory

njooma · 2024-12-05T19:37:37Z

docs/how-tos/hello-world-module.md

+        if err = helloWorld.AddModelFromRegistry(ctx, camera.API, hellocamera.HelloCamera); err != nil {
+            return err
+        }
+
+        if err = helloWorld.AddModelFromRegistry(ctx, sensor.API, hellosensor.HelloSensor); err != nil {
+            return err
+        }


Then here, we add models.HelloCamera and models.HelloSensor

And we also change Config to sensorConfig, and we take out the declaration of errUnimplemented = errors.New("unimplemented") from hello-sensor.go

docs/how-tos/hello-world-module.md

npentrel · 2024-12-06T11:06:45Z

docs/how-tos/hello-world-module.md

@@ -278,6 +380,8 @@ You need to add some sensor-specific code to support the sensor component.

 Edit the stub files to add the logic from your test script in a way that works with the camera and sensor APIs:


Suggested change

Edit the stub files to add the logic from your test script in a way that works with the camera and sensor APIs:

Edit the stub files to add the logic from your test script in a way that works with the camera and sensor APIs.

Oop good catch but actually the following line is a copy paste error; will delete it and then this line will be good as-is.

npentrel · 2024-12-06T11:10:45Z

docs/how-tos/hello-world-module.md

+
+   This adds the `image_path` attribute and causes the resource to rebuild each time the configuration is changed.
+
+1. Delete the `Reconfigure()` function entirely, since the camera will rebuild instead of reconfiguring.


People at this point haven't encountered these concepts so I think we need to provide some context

Suggested change

1. Delete the `Reconfigure()` function entirely, since the camera will rebuild instead of reconfiguring.

1. Delete the `Reconfigure()` function.

Some models use it to reconfigure attributes but in this case we'll have the camera rebuild instead of reconfiguring.

Are you missing the step where you uncomment "resource.TriviallyReconfigurable" in the helloWorldHelloCamera struct? Because this alone does not work and throws an error

Oop I'll just delete this step.

docs/how-tos/hello-world-module.md

npentrel · 2024-12-06T11:13:03Z

docs/how-tos/hello-world-module.md

+   return imgByte, camera.ImageMetadata{}, nil
+   ```
+
+1. Delete the `SubscribeRTP` and `Unsubscribe` methods, since they are not applicable to this camera.


does it matter if we leave them in? Doesn't look like it does you just have to also add the not implemented to them.

It's marginally easier to delete than copy paste more lines

Suggested change

1. Delete the `SubscribeRTP` and `Unsubscribe` methods, since they are not applicable to this camera.

1. Delete the `SubscribeRTP` and `Unsubscribe` methods. They are not applicable to this camera.

npentrel · 2024-12-06T11:18:09Z

docs/how-tos/hello-world-module.md

+
+1. Since `errUnimplemented` and `Config` are defined in <file>hello-camera.go</file>, you need to change <file>hello-sensor.go</file> to avoid redeclaring them:<br><br>
+
+   - Delete line 20, `errUnimplemented = errors.New("unimplemented")` from <file>hello-sensor.go</file>.<br><br>


this is line 16 for me. I think it may be impractical to add the line numbers while things with the generator are still changing a lot.

Tell them to do a find and replace instead, I think

Oh you're right it should be 16 or 17 but it depends how many newlines they added to imports. Yes it's hard to maintain but it does make it much easier to follow if it's right....and if it's off by only a line or two I think it'll be okay. I will change the *Config *sensorConfig to a search-replace but for the others since they're one-offs I don't think it makes sense to?

These unimplemented lines are meant to be changed in an upcoming version of the generator anyway, so I think it's fine to do like this for now.

docs/how-tos/hello-world-module.md

npentrel

Overall good - I was able to get it to follow the instructions and get it to work mostly, a few issues. I think it's probably wise to remove the line numbers. That's probably wasted effort since they're likely to change still.

docs/how-tos/hello-world-module.md

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

JessamyT · 2024-12-06T18:46:53Z

I think it's probably wise to remove the line numbers. That's probably wasted effort since they're likely to change still.

@npentrel I am cognizant of this but, the module generator will not just change line numbers but will actually result in many of these steps being eliminated entirely, so the line numbers won't have to be maintained in the future. I've already put them there, and I think if they're close enough they're useful (and most if not all are correct at present).

When QAing, I found it much easier to follow with the line numbers there.

viambot · 2024-12-06T18:50:47Z

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

github-actions · 2024-12-09T20:08:27Z

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)'

JessamyT added 4 commits December 4, 2024 11:42

DOCS-3103: Add Go to hello world module guide

3a867e8

Update for new camera API etc

1ce250e

Add Go upload instructions

4badd2d

Add import

cbbf896

viambot added the safe to build This pull request is marked safe to build from a trusted zone label Dec 4, 2024

JessamyT requested a review from njooma December 5, 2024 18:06

njooma requested changes Dec 5, 2024

View reviewed changes

JessamyT added 3 commits December 5, 2024 17:20

Address Naveed's feedback

8b2f4b9

Fix camera code

4c74b91

More tweaks to put everything in the models folder

131b0db

JessamyT requested a review from njooma December 6, 2024 01:46

More tweaks to change structure

0de1fd1

npentrel reviewed Dec 6, 2024

View reviewed changes

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

npentrel reviewed Dec 6, 2024

View reviewed changes

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

npentrel reviewed Dec 6, 2024

View reviewed changes

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

npentrel reviewed Dec 6, 2024

View reviewed changes

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

npentrel reviewed Dec 6, 2024

View reviewed changes

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

npentrel requested changes Dec 6, 2024

View reviewed changes

JessamyT commented Dec 6, 2024

View reviewed changes

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

JessamyT commented Dec 6, 2024

View reviewed changes

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

JessamyT commented Dec 6, 2024

View reviewed changes

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

JessamyT commented Dec 6, 2024

View reviewed changes

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

JessamyT and others added 2 commits December 6, 2024 10:36

Apply suggestions from code review

ba5aa65

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

Apply suggestions from code review

5277db9

JessamyT requested a review from npentrel December 6, 2024 18:38

Fix code fence

81b46c9

njooma approved these changes Dec 6, 2024

View reviewed changes

npentrel approved these changes Dec 9, 2024

View reviewed changes

npentrel merged commit 6d13eb8 into viamrobotics:main Dec 9, 2024
9 checks passed

JessamyT deleted the 3103goworld branch December 9, 2024 20:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCS-3103: Add Go to Hello World Module how-to #3730

DOCS-3103: Add Go to Hello World Module how-to #3730

JessamyT commented Dec 4, 2024

njooma Dec 5, 2024

JessamyT Dec 6, 2024

JessamyT Dec 6, 2024 •

edited

Loading

njooma Dec 6, 2024

njooma Dec 5, 2024

JessamyT Dec 6, 2024

npentrel Dec 6, 2024

JessamyT Dec 6, 2024

npentrel Dec 6, 2024

npentrel Dec 6, 2024 •

edited

Loading

JessamyT Dec 6, 2024

npentrel Dec 6, 2024 •

edited

Loading

JessamyT Dec 6, 2024

npentrel Dec 9, 2024

npentrel Dec 6, 2024 •

edited

Loading

JessamyT Dec 6, 2024

JessamyT Dec 6, 2024

npentrel left a comment

JessamyT commented Dec 6, 2024 •

edited

Loading

viambot commented Dec 6, 2024

github-actions bot commented Dec 9, 2024

		@@ -278,6 +380,8 @@ You need to add some sensor-specific code to support the sensor component.

		Edit the stub files to add the logic from your test script in a way that works with the camera and sensor APIs:


		This adds the `image_path` attribute and causes the resource to rebuild each time the configuration is changed.

		1. Delete the `Reconfigure()` function entirely, since the camera will rebuild instead of reconfiguring.

	1. Delete the `Reconfigure()` function entirely, since the camera will rebuild instead of reconfiguring.
	1. Delete the `Reconfigure()` function.
	Some models use it to reconfigure attributes but in this case we'll have the camera rebuild instead of reconfiguring.

	1. Delete the `SubscribeRTP` and `Unsubscribe` methods, since they are not applicable to this camera.
	1. Delete the `SubscribeRTP` and `Unsubscribe` methods. They are not applicable to this camera.


		1. Since `errUnimplemented` and `Config` are defined in <file>hello-camera.go</file>, you need to change <file>hello-sensor.go</file> to avoid redeclaring them:<br><br>

		- Delete line 20, `errUnimplemented = errors.New("unimplemented")` from <file>hello-sensor.go</file>.<br><br>

DOCS-3103: Add Go to Hello World Module how-to #3730

DOCS-3103: Add Go to Hello World Module how-to #3730

Conversation

JessamyT commented Dec 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JessamyT Dec 6, 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 Dec 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

npentrel Dec 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

npentrel Dec 6, 2024 • edited Loading

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

JessamyT commented Dec 6, 2024 • edited Loading

viambot commented Dec 6, 2024

github-actions bot commented Dec 9, 2024

JessamyT Dec 6, 2024 •

edited

Loading

npentrel Dec 6, 2024 •

edited

Loading

npentrel Dec 6, 2024 •

edited

Loading

npentrel Dec 6, 2024 •

edited

Loading

JessamyT commented Dec 6, 2024 •

edited

Loading