Skip to content

Commit

Permalink
Document use_asyncio in robot_parameters.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hello-binit authored Aug 28, 2024
1 parent a6772eb commit 463df86
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/robot_parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

The behavior of Stretch's hardware and software is tweakable through "robot parameters", which are dozens of key-value pairs stored in YAML files and read into Stretch Body when the Python SDK is used. To learn about the parameter system and tweaking the values, follow the [Parameter Management Tutorial](../../stretch_tutorials/stretch_body/tutorial_parameter_management.md). In this document, a description of every parameter and its default value is provided.

### use_asyncio

A boolean to toggle the use of Asyncio for coordination serial communication with the stepper motors. Using asyncio enables the program flow to move onto other computation while waiting for a reply from a stepper.

| Parameter | Default Value |
|-------------------|---------------|
| robot.use_asyncio | `1` |

### params

Additional sources of parameters for Stretch Body to import in when organizing the robot's complete set of parameters. This parameter is an array of strings, where each string is an importable Python module. Therefore, it's important that your additional source of parameters is on the "Python Path" (i.e. you can import it from Python).
Expand Down

0 comments on commit 463df86

Please sign in to comment.