absh8989/TwinTurbine
1
0
Fork 1
mirror of https://github.com/Mukheem/TwinTurbine.git synced 2025-05-10 12:00:34 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md - Almost finished

Browse Source
This commit is contained in:
Abdul Mukheem Shaik 2024-06-05 20:02:49 +02:00 committed by GitHub
parent 467c8bcc4e
commit 7d2cb77a1c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 27 additions and 20 deletions

47
README.md

@ -339,7 +339,7 @@ _Requirements:_
You can find the Arduino Code in the file [sketch_VoltageUnity]([TangibleSketches/ESP32/ESP32_sketch_copy_20240512144341/sketch_VoltageUnity.ino](https://github.com/Mukheem/TwinTurbine/blob/Zeinab_ReadmeUpdates/TangibleSketches/Arduino/Arduino_Sketch_copy_20240512144111/Arduino_Sketch_copy_20240512144111.ino)) and ESP32 code in the file
[Esp32_Client_test.ino](https://github.com/Mukheem/TwinTurbine/blob/Zeinab_ReadmeUpdates/TangibleSketches/ESP32/ESP32_sketch_copy_20240512144341/sketch_VoltageUnity/sketch_VoltageUnity.ino)
**_Note:_** In the ESP32 code, you have to change the <ins>Wifi User name and Password</ins> as per your network configuration.
> **_Note:_** In the ESP32 code, you have to change the <ins>Wifi User name and Password</ins> as per your network configuration.
Deploy the corresponding code to Arduino and ESP micro controllers and then turn them on respectively.
@ -368,35 +368,42 @@ _Getting Started with TwinTurbine: A Collaborative Wind Turbine Experience_
TwinTurbine allows you and other users to explore and interact with a virtual wind turbine in real-time using Meta Quest VR headsets. Here's how to get started:
**1. Gear Up and Enter the Virtual Environment:**
Ensure both participants have their Meta Quest VR headsets on and are ready to enter the virtual world.
Ensure both participants have their Meta Quest VR headsets on and are ready to enter the Immersive world.
**2. Navigate the Environment:**
Move around naturally by walking in your physical space, which will be mirrored in the virtual environment.
**2. Join or Create a Room:**
Using your controller, navigate to the menu interface and select either "Create Room (User A)" or "Join Room (User B)" depending on your role. Typically, the "right index trigger" button on your controller will confirm your selection.
**3. Pick Up Your Controllers:**
Both VR controllers are required for interaction within TwinTurbine.
**4. Join or Create a Room (Social Interaction):**
Using your controller, navigate to the menu interface and select either "Create Room (User A)" or "Join Room (User B)" depending on your role. Typically, the "A" button on your controller will confirm your selection.
**5. Synchronize Your Experience (Spatial Alignment):**
**3. Synchronize Your Experience (Spatial Alignment):**
Choose "Create New Anchor & Share It (User A)" or "Align to the Anchor (User B)" to ensure both users see the virtual wind turbine and environment in the same location.
**6. Listen to Your Guide:**
Informative narrations will guide you through the functionalities within the virtual environment.
**4. Listen to Your Guide:**
Informative narrations will guide you through the functionalities within the environment.
**7. Control the Turbine:**
Locate the green virtual button labeled "Start" on the turbine interface. Press this button to activate the virtual wind turbine.
**5. Control the Turbine:**
Locate the green virtual button labeled "Start" on the turbine interface. Press this button to activate the experience.
In case of an emergency, press the red virtual button labeled "Emergency" to immediately reset the turbine's values and stop its rotation.
**8. Real-Time Data Visualization:**
A user-friendly Graphical User Interface (GUI) within the virtual environment displays real-time data such as wind speed, direction, temperature (if integrated), and the voltage generated by the physical wind turbine. This allows you to observe the turbine's performance under various conditions.
**6. Real-Time Data Visualization:**
A user-friendly Graphical User Interface (GUI) within the virtual environment displays real-time data such as wind speed, direction, temperature (upon integration), and the voltage generated by the physical wind turbine. This allows you to observe the turbine's performance under various conditions.
## References
**Code base:**
- [Unity-SharedSpatialAnchors](https://github.com/oculus-samples/Unity-SharedSpatialAnchors) - Boilerplate to start the development
**Networking:**
- [Photon](https://doc.photonengine.com/pun/current/demos-and-tutorials/pun-basics-tutorial/intro) - Networking for multi-user experience
**User Interface (UI):**
- [Valem](https://www.youtube.com/watch?v=yhB921bDLYA&pp=ygUIdmFsZW0gdWk%3D) - GUI interface inspiration
- [Luis Quintero](https://www.linkedin.com/in/luisqtr/) ( A Stockholm University Professor) - GUI interface contribution
**Assets:**
- [Unity Asset Store](https://assetstore.unity.com/account/assets) - Wind Turbine 3D Model (Link to specific asset page)
- [Mixamo](https://www.mixamo.com/) - 3D Avatar
**Audio:**
- Elisa K. (A Stockholm University Student) - Audio Narration
## Contributors