Detect and Follow a Colored Object with the SCUTTLE Robot on Viam
There are breaking changes in the Vision Service. This tutorial has not yet been updated.
This tutorial shows how to use the Viam Vision Service to make a SCUTTLE rover follow a colored object.
Code used in this tutorial
The prerequisite of this tutorial is to have a SCUTTLE rover connected to the Viam app. Please refer to the Configure a SCUTTLE Robot tutorial if you have not already configured your SCUTTLE.
Set up your code environment
We highly suggest using a virtual Python environment like Poetry or Miniconda.
Then create an environment for Python by running the following on the terminal:
poetry new pysdk # new poetry project conda create -n pysdk python=3.9 # new (mini)conda environment
You can also name your environment as you wish, but please remember to keep it consistent. We named our environment pysdk, referring to the Viam Python SDK.
NOTE: If using (mini)conda, activate the environment by running the following command:
conda activate pysdk
Poetry environments are implicitly activated.
Before you can run the code, you need to install the “viam” module. Follow the Python SDK installation guide to properly install the package.
NOTE: If using a python environment, ensure that the package is installed in the proper environment.
pip freeze | grep viam # generic poetry show | grep viam # for poetry environments conda list | grep viam # for (mini)conda environments
You should see
viam-sdk listed near the end.
Save the code
In the Python code, you must add your robot’s address and secret (payload), which are found on the Code Sample tab of the Viam app. Viam pre-populates the Code Sample tab with the robot name, address, and secret:
Do not share your location secret, robot secret, or robot address publicly. Sharing this information compromises your system security by allowing unauthorized access to the computer running your robot.
In your local copy of
Now you are ready to run the code!
Run the code
Now you should try to drive the SCUTTLE around following the color red. You can use something like a red sports ball or book cover as a target to follow.
Navigate to the folder where you saved the Python script. From that folder, run this in the terminal:
Be sure to replace
Notes on color detection operation
getVisService(robot), a detector is configured with particular properties and subsequently added to the Vision Service.
This particular detector is a color detector, which means the relevant parameters are
detect_color (hex string),
hue_tolerance_pct (float from
Feel free to configure more detectors with different parameters!
To learn about all the different detectors and parameters, check out the Vision Service documentation.
leftOrRight() code splits the screen vertically into thirds (left, center, and right) and makes a determination about which third the object (red ball) is in.
main(), this decides how the robot moves (as configured by the 4 given variables).
Run the code as is before making changes to see how it affects the output!
Have questions, or want to meet other people working on robots? Join our Community Discord.
Was this page helpful?
Glad to hear it! If there is anything we could be doing better, please create an issue.
We're sorry about that. If you'd like to talk to us for help, please join the Community Discord. To ensure we know what's wrong with this page, you can also open an issue.