Skip to content

Lupiv3D/CircuitVision

Repository files navigation

CircuitVision

Static Badge

CSCI321 Capstone Project of Team Legionnaires from the University of Wollongong Dubai.

CircuitVision is an augmented-reality learning app that allows users to visualize breadboard assembly through their phone.

Key features

  • Schematic Detection
  • AR overlays for placemnet guidance
  • Save progress and resume from last checkpoint
  • Component recognition and information

Prerequisites

Before you can run this project, you need to ensure that your system meets the following requirements:

For Unity

  • Unity Editor: 2022.3.13f1.
  • For AR:Apple ARKit package in unity.
  • iOS Build Support: Included in Unity installation.
  • Apple Developer Account: Required for deploying to iOS devices.
  • Xcode: For building and deploying to iOS.

For iOS Development

  • Mac Computer: With a recent version of macOS.
  • iOS Device: For testing (e.g., iPhone or iPad).
  • Provisioning Profile and Certificates: Set up in your Apple Developer account.

For Database and Local Server

  • XAMPP: For local server environment and PHP.
  • SQL Database: MySQL (included in XAMPP).
  • phpMyAdmin: For database management (included in XAMPP).
  • Network Configuration: Configured to allow communication between Unity and the server.

For API Development

  • PHP: For backend API development (included in XAMPP).

Installation

Follow these steps to get your development environment set up:

  1. Clone the Repository
git clone https://github.com/Lupiv3D/CircuitVision.git
  1. Unity Setup
  • Open the project in Unity.
  • Switch the build platform to iOS in Unity’s Build Settings. iOS Build module is required
  1. XAMPP Setup
  • Install XAMPP from XAMPP.
  • Start Apache and MySQL services.

start Apache

Start MySQL

  1. Database Setup
  • Access phpMyAdmin at http://localhost/phpmyadmin.
  • Import the database into the server to create the necessary tables.
  1. API Setup
  • Create a folder in htdocs and place your PHP project files.
  • Ensure the Unity project is configured to communicate with your local PHP API (adjust URLs/endpoints as needed).
    • In the C# file(registration) change the URLs in each function.
  1. iOS Device Testing
  • Connect your iOS device.
  • In Xcode, configure your developer account and provisioning profile. Provisioning profile is required
  • Build the Unity-iPhone project with the iOS device still connected