Wiki - Plugins

Is this the most powerful simulator for developers?

Plugins

Plugins for AeroSIM-RC

A plugin is a piece of software that is added to the simulator, allowing the emulation of real OSD, Auto Pilots, Ground Station, etc. and which are created by the same developers of the real devices.

Plugin capabilities

A plugin can perform many functions:

- OSD (see demo plugin)

- Run auto-pilot code (see demo plugin)

- Communicate with a Ground Station

Benefits for Users

- Users can familiarise and learn to use the emulated equipment.

Benefits for Developers

- Speed up the development of your OSD, AutoPilot, etc.

- Can do hundreds of flight tests at zero risk, with zero time overhead, and comfortably at the lab while raining outside.

- Can push the flight tests beyond the safety limit since there is no risk involved in the simulation. Thus, achieving an increased reliability in real life.

- Free demo platform for potential customers to try your product.

Information for Developers

If I were interested in developing a Plugin, where do I start?

Firstly, edit file config2.txt and set I_AM_DEVELOPER_OF_PLUGIN to 1.
This will enable new options in the Plugin menu, and a new debug menu item.

Then play around with the DemoPlugin and try all its menu options.

And after that, have a look at the demo source files. These can be found in the folder \Plugin\PluginDemo\src, under the AeroSIM-RC installation folder.

Most of the information you will need is in this file:
C:\Program Files (x86)\AeroSIM-RC\Plugin\PluginDemo\src\Plugin.h

The demo plugin illustrates:
- how to define a custom menu
- how to change aircraft position (useful to repeat tests from same position, velocity, attitude, etc.)
- a simple aileron autopilot that takes the roll angle and move the ailerons to keep roll at 0º
- a simple elevator autopilot that takes the pitch angle and move the elevator to keep pitch at 0º
- a OSD with a simplified MAX7456 emulation
- a simple HUD

PluginDemo.vcproj is the project file for Visual Studio. The plugin demo is programmed in C.

Briefly

1. To create a plugin, you write a DLL consisting basically on a function that will be called from AeroSIM-RC in each simulation cycle.
2. This function receives the flight data (position, velocity, acceleration, angles, height above the ground and stick positions)
3. The function returns a data structure to optionally overwrite the stick positions, aircraft variables, and OSD display.

Some details

A Plugin is composed of the following files:

The plugin name is taken from the folder where the files can be found. No spaces are allowed in the name.

In the sample plugin, PluginDemo is the name of the plugin, and its files are found in C:\Program Files\AeroSIM-RC\Plugin\PluginDemo

Help for developers

There is more information in the source code, and in any case, send us an email if you need help to create your plugin or need any new feature.

FrSky Telemetry

This plugin generates a FrSky Smart Port telemetry data stream.

The plugin is open source, and it outputs the following sensor information:

The data is output to other devices through one of the serial ports of the computer running AeroSIM-RC

The COM port number and baud rate are selected by editing the following files:
   C:\Program Files (x86)\AeroSIM_RC\Plugin\FrSkyTelemetry\COM_PORT_NUMBER.txt
   C:\Program Files (x86)\AeroSIM_RC\Plugin\FrSkyTelemetry\COM_PORT_BAUD_RATE.txt

The Telemetry data generated by AeroSIM-RC can be used in many ways. Here are two practical examples.

Example 1: Telemetry on a Tablet or Phone

Telemetry on Tablet.

Top screen: AeroSIM-RC simulator.
Bottom screen: Tablet with App "iNav SmartPort telemetry viewer"

You need:

• The S.Port Telemetry Viewer App (for example iNav SmartPort telemetry viewer and logger)
• A tablet or phone to run the App
• Bluetooth on the computer running AeroSIM-RC

How to set up:

1. On your tablet or phone, install the App.
2. On your computer, create a COM port via Bluetooth:
   (Windows settings ➞ Bluetooth settings ➞ Turn on Bluetooth ➞ More Bluetooth options ➞ COM ports ➞ Add... ➞ Incoming)
3. Write the COM port number just created in the file
   C:\Program Files (x86)\AeroSIM_RC\Plugin\FrSkyTelemetry\COM_PORT_NUMBER.txt
4. Run AeroSIM-RC and open the FrSky Telemetry plugin. On the FrSky Telemetry menu, click on Serial Port Open.
5. Run the App on the tablet, and click on "Connect" to establish communications via Bluetooth with the computer.
6. Enjoy!

Example 2: Telemetry on the Remote Controller display

AeroSIM-RC generated FrSky Telemetry displayed on a Taranis
From left to right: FrSky XSR receiver, FrSky STK, AeroSIM-RC wireless USB interface, FrSky Taranis Plus

You need:

• FrSky Remote Controller
• FrSky receiver with S.Port (for example the FrSky XSR receiver, which has S.Port and PPM output)
• LUA telemetry script (for example iNav Telemetry LUA script)
• FrSky STK S.Port Tool Kit (or equivalent to convert the USB COM port to FrSky Smart Port)

How to set up:

1. Install the LUA script on your Remote Controller.
2. Connect the STK to the computer, and find it's COM port number in Windows Device Manager.
3. Open the file
   C:\Program Files (x86)\AeroSIM_RC\Plugin\FrSkyTelemetry\COM_PORT_NUMBER.txt
   and write the COM port number of the STK.
4. Run AeroSIM-RC and open the FrSky Telemetry plugin. On the FrSky Telemetry menu, click on Serial Port Open.
5. On the Remote Controller:
   - Go to the TELEMETRY page, and click on "Discover new sensors".
   - Go to the DISPLAY page, and assign the LUA script to Screen 1.
   - Exit all menus.
   - Long press on button "Page" to run the telemetry script.
6. Enjoy!

Wiki - Plugins

Is this the most powerful simulator for developers?