Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an alias and some links #3836

Merged
merged 3 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/operate/get-started/other-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ aliases:
- /how-tos/sensor-module/
- /registry/advanced/iterative-development/
- /build/program/extend/modular-resources/
- /program/extend/modular-resources/
- /extend/modular-resources/
- /extend/
- /build/program/extend/modular-resources/key-concepts/
Expand Down
14 changes: 7 additions & 7 deletions docs/tutorials/configure/pet-photographer.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Follow the instructions below to download the `colorfilter` module in your prefe
```

1. Navigate to the Go color filter directory, `colorfilter`.
1. Inside of the `module` directory, [compile the executable](/how-tos/create-module/#compile-or-package-your-module) that runs your module.
1. Inside of the `module` directory, [compile the executable](/operate/get-started/other-hardware/#test-your-module-locally) that runs your module.
1. Save the path to your module's executable for later use.
1. [Add the `colorfilter` module to your smart machine as a local module](#add-as-a-local-module) and continue the tutorial from there.

Expand Down Expand Up @@ -142,7 +142,7 @@ For example, the camera's <file>client.py</file> file is located at <file>[/comp
- Exclude the `get_images` method, which you will customize to add filtering functionality in the upcoming section.
- Include the other methods within the class corresponding to your resource type (in this case, the `CameraClient` class).

For more information, refer to [Write your new resource model definition](/how-tos/create-module/#write-your-new-resource-model-definition).
For more information, refer to [Write your new resource model definition](/operate/get-started/other-hardware/#write-your-module).

{{% /tab %}}
{{% tab name="Go"%}}
Expand All @@ -154,7 +154,7 @@ For example, the camera's <file>client.go</file> file is located at <file>[/comp
Exclude the `Read` method, which you will replace with a method, `Next`, to add filtering functionality in the upcoming section.
- You can create your own code or copy the code from the [viam-labs `colorfilter` repository's <file>color_filter.go</file>](https://github.com/viam-labs/modular-filter-examples/blob/main/colorfilter/color_filter.go) file.

For more information, refer to [Write your new resource model definition](/how-tos/create-module/#write-your-new-resource-model-definition).
For more information, refer to [Write your new resource model definition](/operate/get-started/other-hardware/#write-your-module).

{{% /tab %}}
{{< /tabs >}}
Expand Down Expand Up @@ -696,7 +696,7 @@ In this code:
{{% /tab %}}
{{< /tabs >}}

For more information, see [Write your new resource model definition](/how-tos/create-module/#write-your-new-resource-model-definition).
For more information, see [Write your new resource model definition](/operate/get-started/other-hardware/#write-your-module).

#### Code an entry point file

Expand Down Expand Up @@ -804,9 +804,9 @@ func mainWithArgs(ctx context.Context, args []string, logger logging.Logger) (er
{{% /tab %}}
{{< /tabs >}}

For more information, see [Create a new module](/how-tos/create-module/).
For more information, see [Create a new module](/operate/get-started/other-hardware/).

Once you've written your filter module, [compile your module into a single executable](/how-tos/create-module/#compile-or-package-your-module) that runs your module when executed.
Once you've written your filter module, [compile your module into a single executable](/operate/get-started/other-hardware/#test-your-module-locally) that runs your module when executed.

Note the absolute path to your module’s executable for use in the next section.

Expand All @@ -817,7 +817,7 @@ Whether you've downloaded the `colorfilter` module, or written your own color fi
1. Navigate to the **CONFIGURE** tab of your machine's page in the [Viam app](https://app.viam.com/robots).
1. Click the **+** (Create) button next to your main part in the left-hand menu and select **Local module**, then **Local module**.

1. Enter a name or use the suggested name for your local module, enter the [module's executable path](/how-tos/create-module/#compile-or-package-your-module), then click **Create**.
1. Enter a name or use the suggested name for your local module, enter the [module's executable path](/operate/get-started/other-hardware/#test-your-module-locally), then click **Create**.
- The name must use only lowercase characters.
1. Then, click the **Save** button in the top right corner of the page to save your changes.

Expand Down
Loading