Skip to content

Commit

Permalink
Update code_structure.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ashkapoor authored Feb 15, 2017
1 parent 018f006 commit 9a0cf58
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions docs/code_structure.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
## AirLib
Majority of code is located in AirLib. This is self-contained library that you should be able to compile with modern C++ compilers. The rpclib requires C++14 but everything else should compile with C++11.
Majority of the code is located in AirLib. This is a self-contained library that you should be able to compile with modern C++ compilers. The rpclib requires C++14 but everything else should compile with C++11.

AirLib consists of following components:
1. *Physics engine:* This header-only physics engine. It is designed to be fast and extensible to implement different vehicles.
AirLib consists of the following components:
1. *Physics engine:* This is header-only physics engine. It is designed to be fast and extensible to implement different vehicles.
2. *Sensor models:* This is header-only models for Barometer, IMU, GPS and Magnetometer
3. *Vehicle models:* This is header-only models for vehicle configurations and models. Currently we have implemented model for MultiRotor and configuration for PX4 QuadRotor in X config.
4. *Control library:* This part of AirLib provides abstract base class for our APIs and concrete implementation for specific vehicle platforms such as MavLink. It also has classes for RPC client and server.
3. *Vehicle models:* This is header-only models for vehicle configurations and models. Currently we have implemented model for a MultiRotor and a configuration for PX4 QuadRotor in the X config.
4. *Control library:* This part of AirLib provides abstract base class for our APIs and concrete implementation for specific vehicle platforms such as MavLink. It also has classes for the RPC client and server.

## Unreal/Plugins/AirSim
This is the only portion of project which is dependent on Unreal engine. We have kept it isolated so we can implement simulator for other platforms as well such as Unity. The Unreal code takes advantage of its UObject based classes including Blueprints.
1. *SimMode_ classes*: We wish to support various simulaor modes such as pure Computer Vision mode where there is no drone. The SimMode classes helps to implement many different modes.
This is the only portion of project which is dependent on Unreal engine. We have kept it isolated so we can implement simulator for other platforms as well (for example, Unity). The Unreal code takes advantage of its UObject based classes including Blueprints.
1. *SimMode_ classes*: We wish to support various simulaor modes such as pure Computer Vision mode where there is no drone. The SimMode classes helps to implement many such different modes.
2. *VehiclePawnBase*: This is the base class for all vehicle pawn visualizations.
3. *VehicleBase*: This class provides abstract interface to implement combination of rendering component (i.e. Unreal pawn), physics component (i.e. MultiRotor) and controller (i.e. MavLinkHelper).

## MavLinkCom
This is the library developed by our own team member Chris Lovett that provides C++ classes to talk to MavLink devices. This library is stand alone and can be used in any project.
This is the library developed by our own team member Chris Lovett that provides C++ classes to talk to the MavLink devices. This library is stand alone and can be used in any project.

## Sample Programs
We have created few sample program to demonstrate how to use API. See HelloDrone and DroneServer. The DroneServer demonstartes how to connect to simulator using UDP port for QGC.


We have created few sample program to demonstrate how to use the API. See HelloDrone and DroneServer. The DroneServer demonstartes how to connect to the simulator using UDP port for QGC.

0 comments on commit 9a0cf58

Please sign in to comment.