Skip to content

Commit 21164c8

Browse files
committed
docs: updated readme and deleted unused config.py
1 parent 2821296 commit 21164c8

File tree

2 files changed

+18
-65
lines changed

2 files changed

+18
-65
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Robot Control Stack
2+
RCS is a unified and multilayered robot control interface over a MuJoCo simulation and real world robot currently implemented for the FR3.
23
## Requirements
34
We build and test RCS on the latest Debian and on the latest Ubuntu LTS.
45

@@ -29,17 +30,27 @@ Import the library in python:
2930
```python
3031
import rcsss
3132
```
32-
The package includes a command line interface which define useful commands to handle the hardware robot.
33+
Checkout the python examples that we provide in [python/examples](python/examples):
34+
- [fr3.py](python/examples/fr3.py) shows direct robot control with RCS's python bindings
35+
- [env_joint_control.py](python/examples/env_joint_control.py) and [env_cartesian_control.py](python/examples/env_cartesian_control.py) demonstrates RCS's high level [gymnasium](https://gymnasium.farama.org/) interface both for joint- and end effector space control
36+
All of these examples work both in the MuJoCo simulation as well as on your hardware FR3.
37+
Just switch between the following settings in the example script
38+
```python
39+
ROBOT_INSTANCE = RobotInstance.SIMULATION
40+
# ROBOT_INSTANCE = RobotInstance.HARDWARE
41+
```
42+
and add your robot credentials to a `.env` file like this:
43+
```env
44+
DESK_USERNAME=...
45+
DESK_PASSWORD=...
46+
```
47+
48+
### Command Line Interface
49+
The package includes a command line interface which define useful commands to handle the FR3 robot without the need to use the Desk Website.
3350
To list all available subcommands use:
3451
```shell
3552
python -m rcsss --help
3653
```
37-
A sample config can be generated via the following CLI command.
38-
```shell
39-
python -m rcsss sample-config
40-
```
41-
The command will produce a `config.yaml` file with sample values.
42-
See [config.py](python/rcsss/config.py) for a description of the config fields.
4354

4455
## Development
4556
```shell

python/rcsss/config.py

Lines changed: 0 additions & 58 deletions
This file was deleted.

0 commit comments

Comments
 (0)