a3be4cb1b6
* Minor improvements to the handling of landing gear by the SetGear and HandlePOSI functions * sendPOSI command change (double for lat/lon/h) (#111) * Updated POSI to use doubles for lat/lon/alt, as step size for floats was unacceptably large at high longitudes. * Updated Java library for MATLAB, updated Java project, and updated Windows plugin binaries * Rolled back Java version to 1.7 for MATLAB compatibility * Update MessageHandlers.cpp * Update DataManager.cpp * Added pause functionality for individual a/c Adds new cases such that: 0: Unpauses all a/c 1: Pauses all a/c 2: Switches case for all a/c 100:119: Pauses a/c 0:19 200:219: Unpauses a/c 0:19 Updates log messages. Keeps the 0,1,2 arguments as they previously were. * Finished individual pause functionality * Update DataManager.cpp * Updated flags to allow for individual pause commands * Individual pause command documentation * Updated flags to allow for individual pause commands * Adding individual pause to documentation * Updated flags to allow for individual pause commands * Requested changes, cleaning * Update CMakeLists.txt Include "-fno-stack-protector" for linking and compiling for systems that do not have this have this flag as a default. * Enabling AI after setting position (#118) Previously, the code enabled the AI before setting the position of a/c, which negated its purpose. * Updated XPlane SDK to version 2.1.3 * Resolve function ambiguity for std::abs on mac Fixes #126 * Update copyright notice * Update Windows binaries * Update Linux binaries * Update version numbers * fix osx abs ambiguity (#142) * fix indexing error (#143) * Runway camera location control (#144) * update ignore * basics working * set cam pos remotely * log cam position * keep default behaviour, if short view message is received Compatibility with existing software * all to tabs * rename variable * option to use camera direction fields * Added UDP multicast for plugin discovery (#153) * Added Timer * Added UDPSocket::GetAddr * Added MessageHandlers::SendBeacon() * PoC of starting a timer on PluginEnable * C++11 * Added Timer to xcode project * C++11 in cmake * added Timer to cmake * use function pointer in Timer * moved Timer to namespace + wait for thread to join when stopping the timer * Windows: changed uint to unisgned short * Windows: Added Timer.h/cpp to project * GetAddr static * Send xplane and plugin version with BECN * SendBeacon with params * fixed file copyrights * Include functional to fix Linux compile error * review fixes * Send plugin receive port in BECN * review fixes * Fixed tabs vs spaces indentations (#157) * Java client BECN implementation (#155) * Added MS Azure Dev Ops CI integration (#162) * Do not build for i386 on macOS Use ARCHS_STANDARD to avoid the error “The i386 architecture is deprecated. You should update your ARCHS build setting to remove the i386 architecture.” * Fixed missing include The Visual Studio solution was not compiling * Fixed isnan ambigious refernce Ambigious reference when compiling on travis https://stackoverflow.com/questions/33770374/why-is-isnan-ambiguous-and-how-to-avoid-it * Set MSVC warning level to 3 Too many warnings were generated when building a Release build making Travis job to fail because of too much output * Use default toolset for Visual Studio AppVeyor recommends to set the default toolset * #include <cstdint> * Use MSVC ToolsVersion="14.0" # Conflicts: # xpcPlugin/xpcPlugin/xpcPlugin.vcxproj * Removed binaries from repository # Conflicts: # xpcPlugin/XPlaneConnect/64/win.xpl # xpcPlugin/XPlaneConnect/win.xpl * Added ms azure ci xcode linux linux + macos linux + macos removed branch filter win tests win tests Test all platfroms artifacts tests * output all binaries to ‘XPlaneConnect’ All platforms produce a binary in xpcPlugin/XPlaneConnect/ xpcPlugin/XPlaneConnect/64/ * Added ms azure GH deploy deploy stage GH release test trigger tags * Clean up yml file - Added variables - Added job decriptions * Ignore script to ignore .exp files + fixed output path * Renamed ms azure GH connection * Update service connection for azure pipeline * Added Python3 compatible xpc client. (#156) * Update Azure Pipelines service connection
123 lines
6.5 KiB
Markdown
123 lines
6.5 KiB
Markdown
# X-Plane Connect
|
|
The X-Plane Connect (XPC) Toolbox is an open source research tool used to
|
|
interact with the commercial flight simulator software X-Plane. XPC allows users
|
|
to control aircraft and receive state information from aircraft simulated in
|
|
X-Plane using functions written in C, C++, Java, MATLAB, or Python in real time over the
|
|
network. This research tool has been used to visualize flight paths, test control
|
|
algorithms, simulate an active airspace, or generate out-the-window visuals for
|
|
in-house flight simulation software. Possible applications include active control
|
|
of an XPlane simulation, flight visualization, recording states during a flight,
|
|
or interacting with a mission over UDP.
|
|
|
|
### Migrating to 1.0
|
|
For existing users, several important breaking changes have been made in version
|
|
1.0. For detailed information, see the 1.0 release changelog. For client-specific
|
|
guidelines on migrating to 1.0, refer to the follwing guides:
|
|
|
|
#### [C](https://github.com/nasa/XPlaneConnect/wiki/Migrating-to-1.0-C)
|
|
|
|
#### [MATLAB](https://github.com/nasa/XPlaneConnect/wiki/Migrating-to-1.0-MATLAB)
|
|
|
|
#### [Java](https://github.com/nasa/XPlaneConnect/wiki/Migrating-to-1.0-Java)
|
|
|
|
### Architecture
|
|
XPC includes an X-Plane plugin (xpcPlugin) and clients written in several
|
|
languages that interact with the plugin.
|
|
|
|
#### Quick Start
|
|
To get started using X-Plane Connect, do the following.
|
|
|
|
1. Purchase and install X-Plane 9, 10 or 11.
|
|
2. Copy the X-Plane Plugin folder (`xpcPlugin/XPlaneConnect`) to the plugin
|
|
directory (`[X-Plane Directory]/Resources/plugins/`)
|
|
3. Write some code using one of the clients to manipulate X-Plane data.
|
|
|
|
Each client is located in a top-level directory of the repository named for the
|
|
client's language. The client directories generally include a `src` folder
|
|
containing the client source code, and an `Examples` folder containing sample
|
|
code demonstrating how to use the client.
|
|
|
|
#### Additional Information
|
|
For detailed information about XPC and how to use the XPC clients, refer to the
|
|
[XPC Wiki](https://github.com/nasa/XPlaneConnect/wiki).
|
|
|
|
#### Capabilities
|
|
The XPC Toolbox allows the user to manipulate the internal state of X-Plane by
|
|
reading and setting DataRefs, a complete list of which can be found on the
|
|
[X-Plane SDK wiki](http://www.xsquawkbox.net/xpsdk/docs/DataRefs.html).
|
|
|
|
In addition, several convenience functions are provided, which allow the user to
|
|
efficiently execute common commands. These functions include the ability to set
|
|
the position and control surfaces of both player and multiplayer aircraft. In
|
|
addition, the pause function allows users to easily pause and un-pause X-Plane's
|
|
physics simulation engine.
|
|
|
|
### Compatibility
|
|
XPC has been tested with the following software versions:
|
|
* Windows: Vista, 7, & 8
|
|
* Mac OSX: 10.8-10.14
|
|
* Linux: Tested on Red Hat Enterprise Linux Workstation release 6.6
|
|
* X-Plane: 9, 10 & 11
|
|
|
|
### Contributing
|
|
All contributions are welcome! If you are having problems with the plugin, please
|
|
open an issue on GitHub or email [Chris Teubert](mailto:christopher.a.teubert@nasa.gov).
|
|
If you would like to contribute directly, please feel free to open a pull request
|
|
against the "develop" branch. Pull requests will be evaluated and integrated into
|
|
the next official release.
|
|
|
|
|
|
### Notices
|
|
Copyright ©2013-2018 United States Government as represented by the Administrator
|
|
of the National Aeronautics and Space Administration. All Rights Reserved.
|
|
|
|
No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY
|
|
KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY
|
|
WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM
|
|
INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY
|
|
WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE.
|
|
THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT
|
|
AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE,
|
|
SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT
|
|
SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES
|
|
REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND
|
|
DISTRIBUTES IT "AS IS."
|
|
|
|
Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THE
|
|
UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY
|
|
PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY
|
|
LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE,
|
|
INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE
|
|
OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED
|
|
STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR
|
|
RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH
|
|
MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.
|
|
|
|
#### X-Plane API
|
|
Copyright (c) 2008, Sandy Barbour and Ben Supnik All rights reserved.
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
this software and associated documentation files (the "Software"), to deal in the
|
|
Software without restriction, including without limitation the rights to use,
|
|
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
|
Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
* Redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer.
|
|
* Neither the names of the authors nor that of X-Plane or Laminar Research may
|
|
be used to endorse or promote products derived from this software without
|
|
specific prior written permission from the authors or Laminar Research,
|
|
respectively.
|
|
|
|
X-Plane API SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
|
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
|
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
|
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|