diff --git a/src/viam/examples/modules/simple/README.md b/src/viam/examples/modules/simple/README.md index e06705678..e3bc6e32c 100644 --- a/src/viam/examples/modules/simple/README.md +++ b/src/viam/examples/modules/simple/README.md @@ -1,10 +1,10 @@ # VIAM Simple Module Example -This example goes through how to create custom modular resources using Viam's C++ SDK, and how to connect it to a Robot. +This example goes through how to create custom modular resources using Viam's C++ SDK, and how to connect it to a machine. This is a limited document. For a more in-depth understanding of modules, see the [documentation](https://docs.viam.com/registry/). ## Purpose -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. +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. 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. @@ -17,12 +17,12 @@ The validator function can throw errors that are triggered due to errors in the The reconfiguration method reconfigures the resource based on the new configuration passed in. -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. +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. ## Configuring and using the module -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. +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. -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. +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. An example configuration for our sensor could look like this: ```json{