Skip to content

Commit

Permalink
RSDK-4525 - Link to example module repos (#152)
Browse files Browse the repository at this point in the history
  • Loading branch information
cheukt authored Sep 21, 2023
1 parent 97dd61a commit 3c886d8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/viam/examples/modules/simple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Modular resources allow you to define custom components and services and add the

For more information, see the [documentation](https://docs.viam.com/program/extend/modular-resources/). 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.

For a fully fleshed-out example of a C++ module that uses Github CI to upload to the Viam Registry, take a look at [module-example-cpp](https://github.com/viamrobotics/module-example-cpp). For a list of example modules in different Viam SDKs, take a look [here](https://github.com/viamrobotics/upload-module/#example-repos).

## Project structure
The `main.cpp` file contains the definition of a new generic model and code to register it. It also has the optional validator function and implements reconfigure. The validator function is defined upon resource registration, and the reconfigure method is implemented on the resource class.

Expand Down
2 changes: 2 additions & 0 deletions src/viam/examples/modules/tflite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@
This example goes through how to create a custom audio classification modular resource using Viam's C++ SDK and TensorFlow Lite, and how to connect it to a Robot.
Refer to main.cpp and the comments throughout for more information. For other C++ module examples, refer to the [simple module example](https://github.com/viamrobotics/viam-cpp-sdk/tree/main/src/viam/examples/modules/simple) or [complex module example](https://github.com/viamrobotics/viam-cpp-sdk/tree/main/src/viam/examples/modules/complex).

For a fully fleshed-out example of a C++ module that uses Github CI to upload to the Viam Registry, take a look at [module-example-cpp](https://github.com/viamrobotics/module-example-cpp). For a list of example modules in different Viam SDKs, take a look [here](https://github.com/viamrobotics/upload-module/#example-repos).

This is a limited document. For a more in-depth understanding of modules generally, see the [documentation](https://docs.viam.com/program/extend/modular-resources/).

0 comments on commit 3c886d8

Please sign in to comment.