RSDK-4033, RSDK-4043 - Add simple module example, streamline arm example + other updates #369
Conversation
| Modular resources allows 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. | ||
|
|
||
| For more information, see the [documentation](https://docs.viam.com/program/extend/modular-resources/). | ||
| For more information, see the [documentation](https://docs.viam.com/program/extend/modular-resources/). For a simpler example, take a look at the [simple module example](https://github.com/viamrobotics/viam-python-sdk/tree/main/examples/simple_module), which only contains one custom resource model in one file. |
There was a problem hiding this comment.
it may be good to start with simple and then offer the grander example with custom proto
There was a problem hiding this comment.
the readme here is part of the complex_module example folder, so I feel like unless we want to restructure the examples even more, it's the user's choice as to which example they start with (the line here is just to remind them there's something simpler)
There was a problem hiding this comment.
ahh. sorry. i'd misunderstood. thanks
examples/complex_module/run.sh
Outdated
| cd `dirname $0` | ||
|
|
||
| # Create a virtual environment to run our code | ||
| VENV="venv" |
There was a problem hiding this comment.
is this the name of the venv? if so can we make that more explicit so as to not confuse it with the command proper? ex, VENV_NAME
| cd `dirname $0` | ||
|
|
||
| # Create a virtual environment to run our code | ||
| VENV_NAME="venv" |
There was a problem hiding this comment.
Does this not assume you have venv installed? and a virtual env named venv?
There was a problem hiding this comment.
venv is baked into python 3.4 and up, so should be good for the versions of python we support.
I've used venv for myself for the longest time haha, is there a different name you like?
There was a problem hiding this comment.
AH sorry this is creating a virtual env. I guess then it assumes that there isn't already a virtual env named venv? What would happen if a user already have a venv?
There was a problem hiding this comment.
NVM, it creates it in this directory, so there should be no collisions.
| cd `dirname $0` | ||
|
|
||
| # Create a virtual environment to run our code | ||
| VENV_NAME="venv" |
There was a problem hiding this comment.
AH sorry this is creating a virtual env. I guess then it assumes that there isn't already a virtual env named venv? What would happen if a user already have a venv?
| cd `dirname $0` | ||
|
|
||
| # Create a virtual environment to run our code | ||
| VENV_NAME="venv" |
There was a problem hiding this comment.
NVM, it creates it in this directory, so there should be no collisions.
|
LGTM! This simple example will help a lot. Thanks for reorganizing it. |
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
Made the current example the complex example, added a single file sensor example. Single file does not use an init.py.
The arm example in jupyter notebook is now single file and does not depend on a kinematics.json file.
Made the env consistent between examples and jupyter notebook (requirements.txt) and removes the use of poetry (extra dependency)
For the jupyter example, reworded a bunch of stuff but mostly to make it consistent with the simple example and also point to the complex example when necessary.
tested by downloading a fresh copy of the repo on a pi and just adding it to the config.
still a lot of improvements that can be made, but wanted to get something out for now
cc @Fahmina @michaellee1019 @dannenberg