Skip to content

Commit 4ec0ad8

Browse files
authored
Update README.md (#381)
1 parent 5c457b3 commit 4ec0ad8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Diff for: src/viam/examples/modules/simple/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# 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.
33

44
This is a limited document. For a more in-depth understanding of modules, see the [documentation](https://docs.viam.com/registry/).
55

66
## 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.
88

99
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.
1010

@@ -17,12 +17,12 @@ The validator function can throw errors that are triggered due to errors in the
1717

1818
The reconfiguration method reconfigures the resource based on the new configuration passed in.
1919

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.
2121

2222
## 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.
2424

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.
2626

2727
An example configuration for our sensor could look like this:
2828
```json{

0 commit comments

Comments
 (0)