Skip to content

Commit dc739dd

Browse files
authored
Create README.md
1 parent 7357d37 commit dc739dd

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Simulator_Reachy2021
2+
3+
| License | |
4+
| ------------- | :-------------: |
5+
| Title | [Creatives Commons BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode) |
6+
| Logo | [![Creative Commons BY-NC-SA 4.0](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png) ](http://creativecommons.org/licenses/by-nc-sa/4.0/) |
7+
8+
9+
## Create your own simulator
10+
11+
To use the simulator, download the Unity package.
12+
13+
To start using the simulator:
14+
1. Create a new 3D Unity project (or open an existing one)
15+
2. From **Assets/Import Package/Custom Package...**, import the package you previously downloaded.
16+
3. Drag and drop Reachy and the Server from the Prefabs folder into your scene.
17+
4. Then click Play and choose how to connect to your robot
18+
19+
You can create your own scene and environment for Reachy to evolve in!
20+
21+
## Use your simulator
22+
23+
The Unity simulator is only offering the gRPC services of the robot, not the below ROS2 services.
24+
For this reason, the simulator is compatible with:
25+
- [Reachy 2021 Python SDK](https://docs.pollen-robotics.com/sdk/getting-started/introduction/):
26+
connect to the simulated robot with the usual [Reachy 2021 Python SDK](https://docs.pollen-robotics.com/sdk/getting-started/introduction/) command:
27+
28+
```
29+
from reachy_sdk import ReachySDK
30+
31+
reachy = ReachySDK(host='localhost') # Replace with the actual IP
32+
```
33+
34+
- VR teleoperation app
35+
- Any gRPC client you may create, based on [reachy-sdk-api](https://github.com/pollen-robotics/reachy-sdk-api)

0 commit comments

Comments
 (0)