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: src/viam/examples/modules/simple/README.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# VIAM Simple Module Example
2
-
This example goes through how to create custom modular resources using Viam's C++ SDK, and how to connect it to a Robot.
2
+
This example goes through how to create custom modular resources using Viam's C++ SDK, and how to connect it to a machine.
3
3
4
4
This is a limited document. For a more in-depth understanding of modules, see the [documentation](https://docs.viam.com/registry/).
5
5
6
6
## Purpose
7
-
Modular resources allow you to define custom components and services and add them to your robot. Viam ships with many component types, but you're not limited to only using those types -- you can create your own using modules.
7
+
Modular resources allow you to define custom components and services and add them to your machine. Viam ships with many component types, but you're not limited to only using those types -- you can create your own using modules.
8
8
9
9
For more information, see the [documentation](https://docs.viam.com/registry/). For a more complex example, take a look at the [complex module example](https://github.com/viamrobotics/viam-cpp-sdk/tree/main/src/viam/examples/modules/complex), which contains multiple new APIs and custom resource models.
10
10
@@ -17,12 +17,12 @@ The validator function can throw errors that are triggered due to errors in the
17
17
18
18
The reconfiguration method reconfigures the resource based on the new configuration passed in.
19
19
20
-
When simple_module is run, the main function creates and starts the module. Read further to learn how to connect this module to your robot.
20
+
When simple_module is run, the main function creates and starts the module. Read further to learn how to connect this module to your machine.
21
21
22
22
## Configuring and using the module
23
-
The `simple_module` binary generated after building is the entrypoint for this module. To connect this module with your robot, you must add this module's entrypoint to the robot's config. For example, this could be `/home/viam-cpp-sdk/build/install/bin/simple_module`. See the [documentation](https://docs.viam.com/registry/configure/#add-a-local-module) for more details.
23
+
The `simple_module` binary generated after building is the entrypoint for this module. To connect this module with your machine, you must add this module's entrypoint to the machine's config. For example, this could be `/home/viam-cpp-sdk/build/install/bin/simple_module`. See the [documentation](https://docs.viam.com/registry/configure/#add-a-local-module) for more details.
24
24
25
-
Once the module has been added to your robot, you will then need to add a component that uses the `viam:sensor:mysensor` model. See the [documentation](https://docs.viam.com/registry/configure/#add-a-local-modular-resource) for more details.
25
+
Once the module has been added to your machine, you will then need to add a component that uses the `viam:sensor:mysensor` model. See the [documentation](https://docs.viam.com/registry/configure/#add-a-local-modular-resource) for more details.
26
26
27
27
An example configuration for our sensor could look like this:
0 commit comments