Skip to content

lucasangarola/pyprosim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python wrapper for ProSim Simulator

This project is a small and simple wrapper to access ProSim using Python.

The implementation benefits from pythonnet to import ProSim SDK and wrap around some of its methods. For more special usages, the SDK class can also be accessed directly.

The idea of this implementation is to create a simple and fast access to all datarefs in order to connect then with external hardware.

For convenience I have included the ProSim SDK DLL file in this project, nevertheless the SDK can be found here:

https://download.prosim-ar.com/ProSimSDK/

Getting Started

Requirements

Use Python 3.11 or above.

To run the examples I recommend to use a virtual environment of your choice.

Update pip and install requirements:

python -m pip install --upgrade pip
pip install -r requirements.txt

Installing the Module

pip install .

Running Examples

Notes: The examples has been tested with ProSim B738 version 3.29 this means the datarefs used in the examples may not be available in your ProSim. If this is the case please use a valid dataref for your sim for the sake of testing.

Before running any example, please install this module as indicated in the previous section.

In the root directory of this repository run:

python examples/<name of the example here>.py

Contributing

Contributing is always welcome, please submit the issues/improvements to this project to keep a good documentation.

Make sure you use Formatting: Black

License

This code is licensed under MIT license.

Current Status

ProSim provides many features which can be accessed from their SDK. Not all features have been implemented, but this implementation is a good basis to start something bigger (I believe).

Points to Improve

  1. Error handling can be improved digesting the original ProSim exception to extract the reason of failure and finally create a pyprosim exception class. (Just thinking loud)

About

Small wrapper to connect with ProSim simulator using Python

Resources

License

Stars

7 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors

Languages