You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/operate/get-started/other-hardware/cpp-module.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ draft: true # Take out Go and Python, and check updatedness before un-drafting.
17
17
---
18
18
19
19
Viam provides built-in support for a variety of different {{< glossary_tooltip term_id="component" text="components" >}} and {{< glossary_tooltip term_id="service" text="services" >}}, as well as a registry full of {{< glossary_tooltip term_id="module" text="modules" >}} created by other users.
20
-
If no [existing modules](/registry/modular-resources/) support your specific use case, you can write your own custom modular {{< glossary_tooltip term_id="resource" text="resources" >}} by creating a module, and either upload it to the [Viam Registry](https://app.viam.com/registry) to share it publicly, or deploy it to your machine as a local module without uploading it to the registry.
20
+
If no [existing modules](/operate/get-started/supported-hardware/) support your specific use case, you can write your own custom modular {{< glossary_tooltip term_id="resource" text="resources" >}} by creating a module, and either upload it to the [Viam Registry](https://app.viam.com/registry) to share it publicly, or deploy it to your machine as a local module without uploading it to the registry.
21
21
22
22
Follow the instructions below to learn how to write a new module using your preferred language and its corresponding [Viam SDK](/dev/reference/sdks/), and then deploy it to your machines.
23
23
@@ -175,7 +175,7 @@ For more Python module examples:
175
175
176
176
- See the [Python SDK `examples` directory](https://github.com/viamrobotics/viam-python-sdk/tree/main/examples) for sample module code of varying complexity.
177
177
- For an example featuring a sensor, see [MCP300x](https://github.com/viam-labs/mcp300x-adc-sensor).
178
-
- For additional examples use the [modular resources search](/registry/modular-resources/) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
178
+
- For additional examples use the [modular resources search](/operate/get-started/supported-hardware/#for-use-with-64-bit-architecture) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
179
179
180
180
{{% /tab %}}
181
181
{{% tab name="Go" %}}
@@ -190,7 +190,7 @@ For more Python module examples:
190
190
For more Go module examples:
191
191
192
192
- See the [Go SDK `examples` directory](https://github.com/viamrobotics/rdk/blob/main/examples/) for sample module code of varying complexity.
193
-
- For additional examples use the [modular resources search](/registry/modular-resources/) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
193
+
- For additional examples use the [modular resources search](/operate/get-started/supported-hardware/#for-use-with-64-bit-architecture) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
For an example featuring a sensor, see [MCP3004-8](https://github.com/mestcihazal/mcp3004-8-go).
663
663
664
-
For additional examples use the [modular resources search](/registry/modular-resources/) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
664
+
For additional examples use the [modular resources search](/operate/get-started/supported-hardware/#for-use-with-64-bit-architecture) to search for examples of the model you are implementing, and click on the model's link to be able to browse its code.
665
665
{{< /alert >}}
666
666
667
667
When implementing built-in methods from the Viam Go SDK in your model, be sure your implementation of those methods returns any values designated in the built-in method's return signature, typed correctly.
@@ -1477,7 +1477,7 @@ Strings of the form `<INSERT X>` indicate placeholders that you need to replace
1477
1477
````md
1478
1478
# [`<INSERT MODULE NAME>` module](<INSERT LINK TO MODULE REPO>)
1479
1479
1480
-
This [module](https://docs.viam.com/registry/modular-resources/) implements the [`<INSERT API TRIPLET>` API]<INSERT LINK TO DOCS (if applicable)> in an <INSERT MODEL> model.
1480
+
This [module](https://docs.viam.com/operate/get-started/supported-hardware/) implements the [`<INSERT API TRIPLET>` API]<INSERT LINK TO DOCS (if applicable)> in an <INSERT MODEL> model.
1481
1481
With this model, you can...
1482
1482
1483
1483
## Requirements
@@ -1608,7 +1608,7 @@ To test: `make test`
1608
1608
1609
1609
{{% alert title="Tip" color="tip" %}}
1610
1610
1611
-
If you would like to test your module locally against a target platform other than your development machine before uploading it, you can follow the steps for [Iterative module development](/registry/advanced/iterative-development/) to verify that any code changes you have made work as expected on your target platform.
1611
+
If you would like to test your module locally against a target platform other than your development machine before uploading it, you can for example sync your code to an SBC with architecture that matches your target platform, and test your module there to verify that any code changes you have made work as expected on your target platform.
1612
1612
1613
1613
{{% /alert %}}
1614
1614
@@ -1661,7 +1661,7 @@ See [Update and manage modules you created](/operate/get-started/other-hardware/
1661
1661
You have now created a module, and are ready to deploy it to a fleet of machines.
1662
1662
There are two ways to deploy a module:
1663
1663
1664
-
- Through the Viam Registry: Once you have uploaded your new module to the Viam Registry, [add the module to one or more machines in the Viam app](/registry/modular-resources/).
1664
+
- Through the Viam Registry: Once you have uploaded your new module to the Viam Registry, [add the module to one or more machines in the Viam app](/operate/get-started/supported-hardware/#configure-hardware-on-your-machine).
1665
1665
You can also choose to configure [automated uploads for new module versions](/operate/get-started/other-hardware/manage-modules/#update-an-existing-module-using-a-github-action) through a continuous integration (CI) workflow, using a GitHub Action if desired, greatly simplifying how you push changes to your module to the registry as you make them.
1666
1666
- As a local module (without uploading it to the Viam app), as you did in the [Test your module locally step above](#test-your-module-locally).
1667
1667
This is a great way to test, but if you'd like to use the module on more machines it's easiest to add it to the registry either publicly or privately.
Viam uses peer-to-peer communication, where all machines running `viam-server` or [`viam-micro-server`](/installation/viam-micro-server-dev/) (the version of `viam-server` for microcontrollers) communicate directly with each other as well as with the cloud.
87
+
Viam uses peer-to-peer communication, where all machines running `viam-server` or [`viam-micro-server`](/operate/reference/viam-micro-server/) (the version of `viam-server` for microcontrollers) communicate directly with each other as well as with the cloud.
88
88
This peer-to-peer connectivity is enabled by sending [gRPC commands over WebRTC connections](/operate/reference/architecture/machine-to-machine-comms/#low-level-inter-robotsdk-communication).
89
89
90
90
On startup, `viam-server` establishes a {{< glossary_tooltip term_id="webrtc" text="WebRTC" >}} connection with the [Viam app](https://app.viam.com).
To use this model, you must follow the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/), which enables you to install and activate the ESP-IDF.
37
-
At the step [Generate a new project from a template](/installation/viam-micro-server-dev/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
38
-
Finish the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/) and return to this guide.
36
+
To use this model, you must follow the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/), which enables you to install and activate the ESP-IDF.
37
+
At the step [Generate a new project from a template](/operate/get-started/other-hardware/micro-module/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
38
+
Finish the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/) and return to this guide.
39
39
{{< /alert >}}
40
40
41
41
{{< alert title="Data management not supported" color="caution" >}}
To use this model, you must follow the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/), which enables you to install and activate the ESP-IDF.
22
-
At the step [Generate a new project from a template](/installation/viam-micro-server-dev/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
23
-
Finish the [`viam-micro-server` Development Setup](/installation/viam-micro-server-dev/) and return to this guide.
21
+
To use this model, you must follow the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/), which enables you to install and activate the ESP-IDF.
22
+
At the step [Generate a new project from a template](/operate/get-started/other-hardware/micro-module/#creating-a-project-or-module) where you create a new project with `cargo generate`, select the option to include camera module traits when prompted.
23
+
Finish the [`viam-micro-server` Development Setup](/operate/get-started/other-hardware/micro-module/) and return to this guide.
0 commit comments