Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nobatgeldi authored Jun 17, 2020
1 parent a50a84b commit f15fff9
Showing 1 changed file with 56 additions and 2 deletions.
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,56 @@
# SimulatorSDK
Covisart Motion Simulator SDK
# Covisart Motion Simulator SDK for Unity Game engine

[![N|Solid](https://raw.githubusercontent.com/COVISART/SimulatorSDK/master/LogoStylesSideBySide.png)](https://unity.com/)

[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/github/COVISART/SimulatorSDK)

Vehicle simulator based on a motion system developed using virtual and augmented reality technologies. System supports multi axis motion systems. This simulator allows users to use the aircraft they want in a virtual environment. Using AR technology, user can interact with virtual cockpit. Unlimited rotation system provide most realistic flight experience.


- Virtual Reality
- Augmented Reality
- High Precision Motion System

# Features!

- Control power situation of all connected motors.
- Calibrate motion system with one function
- Calibrate each axis one by one
- Send axis data to system on each frame
- Reset errors on motors at runtime

You can also:
- Manage joystcik inputs
- Manage VR headset data to match exact position when rotating system
- Export documents as Markdown, HTML and PDF

You can find example codes and scene one folders

> We use Resharper when coding,
> Resharper formatting syntax is to make it as readable
> as possible.
### Tech

Motion Simulator uses a number of open source projects to work properly:

* [TwinCAT 3](https://www.beckhoff.com/TwinCAT3/) - eXtended Automation (XA) to control sensors and motors
* [Visual Studio Professional](https://visualstudio.microsoft.com/vs/professional/) - integrated development environment
* [Angular](https://angular.io/) - a platform for building mobile and desktop web applications.
* [node.js] - evented I/O for the backend

And of course Covisart Motion Simulator itself is open source with a [public repository][dill]
on GitHub.

### Installation

Covisart Motion Simulator requires [Unity 2019 LTS](https://unity.com/releases/2019-lts?_ga=2.266885710.1795603025.1592424756-2133270114.1577918347) to run.

Download repo and import [CovisartMotionSDK](https://github.com/COVISART/SimulatorSDK/tree/master/Assets/CovisartMotionSDK) and [Plugins](https://github.com/COVISART/SimulatorSDK/tree/master/Assets/Plugins) to your project.

For easy setup, download Unity package from [release](https://github.com/COVISART/SimulatorSDK/releases) and import it.

### Todos

- Write MORE Tests
- Add communication control mode

0 comments on commit f15fff9

Please sign in to comment.