Skip to content

KOE-Wayfind/KOE-Wayfinder-App

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KOE Wayfinder App

Final Year Project (Mechatronics | 2022/2023)

About project

Augmented Reality (AR) turn-by-turn navigation in Kuliyyah of Engineering building.

Getting started

Prerequisites

Using AR Server

To run the localization inference, AR Server need to be running. Learn more on how to setup AR Server here https://github.com/KOE-Wayfind/AR-server.

Build and run

  1. Create keystore for signing the app (if you don't have it yet). Learn more here
  2. Go to Edit > Project Settings > Player > Android > Publishing Settings and fill in the keystore information.
  3. Go to File > Build Settings and select Android as the platform.
  4. Connect Android device to the computer. See development device.
  5. Click Build and Run.

Development device

The application is best run on a real physical device, because you can interact with it physically (ie holding, walking, moving around with the camera)

There is a package called AR Foundation Remote 2.0 that allows debugging AR application right from the Unity editor.

Android Requirements

  • Android 7.0 (API Level 24) or later

List of the supported devices by ARCore: https://developers.google.com/ar/devices

I'm using Redmi Note 11 (Android 12) for development.

Overall working principle

Sequence diagram below shows the overall working principles of the application.

sequenceDiagram
    participant User
    participant Unity3D
    participant FlaskServer

    User->>Unity3D: Launch AR Navigation
    Unity3D->>Unity3D: Show Main Menu

    User->>Unity3D: Choose Destination
    Unity3D->>Unity3D: Show Localization Screen

    User->>Unity3D: Point Camera to Area
    Unity3D->>Unity3D: Take Picture
    Unity3D-->>FlaskServer: Send Picture for Processing
    FlaskServer-->>Unity3D: Determine Location from Picture

    User->>Unity3D: Align with Building
    Unity3D->>Unity3D: Use Compass to Align

    User->>Unity3D: Click Start
    Unity3D->>Unity3D: Calculate Route
    Unity3D->>Unity3D: Display Route with Turn-by-Turn Directions

    User->>Unity3D: Start Navigation

    loop Update Position
        Unity3D->>Unity3D: Track User's Position
        Unity3D->>Unity3D: Update User's Location on AR Scene
        Unity3D-->>Unity3D: Update Navigation Instructions
    end

    User->>Unity3D: Reach Destination
    Unity3D->>Unity3D: Stop Navigation
    Unity3D->>Unity3D: Show "Destination Reached" Message

Releases

Download the app from releases page

References