Git Product home page Git Product logo

hololens2-ros2-interactions-unity's Introduction

MIT License

HoloLens2-ROS2 Interactions in Unity

Control your ROS2 Robot using interaction techniques via the HoloLens 2. This Unity project for the HoloLens 2 contains different interaction techniques to control a ROS2 robot via APIs to the ROS2 Host Machine.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Examples
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

About The Project

This Unity Project is part of the Larger HoloLens2 ROS2 Interactions System. This repository is the Unity Project to be deployed to the HoloLens 2, exposing the interaction techniques of the device and, via an API call, triggering common robot movements in the ROS2 code.

This project is part of my final project for the Robotics and XR course of University of Eastern Finland in 2023.

Interaction Techniques

Our HoloLens exposes the following interaction techniques to control the robot

Holographic Buttons

Traditional pressable buttons representing forward, backwards, left turn, right turn and stop.

Voice Commands

Voice commands in the HoloLens to robot movement. Default keywords include 'Forward', 'Backward', 'Left', 'Right', 'Stop'

Custom Hand Gestures

Custom hand gestures can trigger different robot movements.

Holographic Hand Joy Con

Novel technique using both hands to control robot direction, akin to a large joystick

Built With

Getting Started

Prerequisites

You will need to download and install the following:

Running the Project

  1. Clone the repo
    git clone [email protected]:septianrazi/MRTK-Custom-Gestures-Unity.git
  2. Open Project in Unity (2022 above recommended)
  3. Change build target to Universal Windows Platform in Build Settings
  4. Change the IP address in the API Manager object to the IP address of your ROS2 host machine. (We can change this after build via HoloLens 2 Device Manager) Alt text
  5. Ensure the following capabilities are enabled in Project Settings -> Player: Settings
  6. Build and Run the project to the HoloLens2 by following the deploying to HoloLens from Unity instructions

Changing the IP address on a HoloLens Build

In the persistentDataPath of your hardware, there will be a config.json file that contains fields that can be edited.

For the HoloLens 2, we can access this file and alter it without having to rebuild the Unity Project. We can do this by accessing the HoloLens on Device Portal, and navigating to the persistent data path of the application.

Examples

See the project in action on YouTube

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Choose an Issue you want to work on and assign yourself

    If there is no exsiting issue, please submit one

  2. Fork the Project

  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)

  4. Commit your Changes (git commit -m 'Add some AmazingFeature')

  5. Push to the Branch (git push origin feature/AmazingFeature)

  6. Open a Pull Request linking the issue

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Septian Razi - septianrazi.github.io - [email protected]

Project Link: https://github.com/septianrazi/HoloLens2-ROS2-Interactions-Unity

Acknowledgements

hololens2-ros2-interactions-unity's People

Contributors

septianrazi avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.