Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pollen-robotics/reachy2021-unity-package
Unity package for Reachy 2021
https://github.com/pollen-robotics/reachy2021-unity-package
robotics unity unity3d
Last synced: 2 months ago
JSON representation
Unity package for Reachy 2021
- Host: GitHub
- URL: https://github.com/pollen-robotics/reachy2021-unity-package
- Owner: pollen-robotics
- License: other
- Created: 2021-05-24T13:31:54.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-02T08:32:41.000Z (over 1 year ago)
- Last Synced: 2024-03-19T00:47:44.021Z (10 months ago)
- Topics: robotics, unity, unity3d
- Language: C#
- Homepage:
- Size: 248 MB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# reachy2021-unity-package
| License | |
| ------------- | :-------------: |
| Title | [Creatives Commons BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode) |
| Logo | [ ](http://creativecommons.org/licenses/by-nc-sa/4.0/) |
Reachy simulator based on Unity 2021. It allows to simply play around with our SDK or the teleoperation app.
## Quick start
Download the zip archive from the [release page](https://github.com/pollen-robotics/Simulator_Reachy2021/releases), and unzip it on a Windows computer. Simply run *Simulator.exe*. The simulator is ready [to be used](#use-your-simulator)!
## Install the simulator to your Unity project
1. Download the Unity package available on the [release page](https://github.com/pollen-robotics/Simulator_Reachy2021/releases), or add
```
https://github.com/pollen-robotics/reachy2021-unity-package.git?path=/Packages/ReachySimulator#master
```
to the Package Manager (add package from git URL).
2. Download the [grpc_unity_package](https://packages.grpc.io/archive/2022/04/67538122780f8a081c774b66884289335c290cbe-f15a2c1c-582b-4c51-acf2-ab6d711d2c59/csharp/grpc_unity_package.2.47.0-dev202204190851.zip) from the [gRPC daily builds](https://packages.grpc.io/archive/2022/04/67538122780f8a081c774b66884289335c290cbe-f15a2c1c-582b-4c51-acf2-ab6d711d2c59/index.xml). Unzip it in the **Assets** folder. It can be done automatically from the menu "Pollen Robotics/Install GRPC". You may want to restart Unity if the menu is not visible after installing the package.
## Create your own simulator
1. Create a new 3D Unity project (or open an existing one).
2. Follow the previous installation steps to add the package to your project.
3. Drag and drop Reachy and the Server from the Prefabs folder into your scene.
4. Then click Play and start controlling the robot.
You can create your own scene and environment for Reachy to evolve in!
## Use your simulator
The Unity simulator is only offering the gRPC services of the robot, not the below ROS2 services.
For this reason, the simulator is compatible with:
- [Reachy 2021 Python SDK](https://docs.pollen-robotics.com/sdk/getting-started/introduction/):
connect to the simulated robot with the usual command:
```
from reachy_sdk import ReachySDK
reachy = ReachySDK(host='localhost') # Replace with the actual IP
```
**Use the SDK version 0.5.4**. Later versions are for Reachy 2023. ``` pip install reachy-sdk==0.5.4```
- VR teleoperation app
- Any gRPC client you may create, based on [reachy-sdk-api](https://github.com/pollen-robotics/reachy-sdk-api)
Check out our [Medium article](https://medium.com/pollen-robotics/controlling-a-reachy-robot-in-unity-f3d90d550345) to see the python SDK in action!