0.0.6 • Published 9 years ago

xplane v0.0.6

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

X-Plane for Node.js

xplanejs is a Node.js module for data transfer to/from X-Plane. It currently supports reads only via UDP.

Usage

A simple example can be found in the examples/ folder. Either access the stored data directly or listen for events.

var XPlane = require('xplane')
  , xplane = new XPlane({
    port: {
      in: 49000 // default port for X-Plane UDP data
    }
  });
xplane.on('data.airspeed', function(speeds) {
  console.log('IAS: ' + speeds.indicated + ' kts');
});
xplane.listen();
// somewhere else:
console.log(xplane.data.airspeed);

To recieve data, you will need to set up X-Plane to send it. Head over to https://github.com/dmolin/flightSimPanels#architecture for instructions.

Data

XTypes are defined in data/xtypes.js. They can be accessed on-demand from XPlane.data.[xtype.name], or by listening to the data.[xtype.name] event.

The current list of XTypes:

  • time
  • airspeed
    • indicated - KIAS kts
    • equivalent - KEAS kts
    • true - KTAS kts
    • truegnd - KTGS kts
    • mph - IAS mph
    • mphair - mph
    • mphgnd - mph
  • gload
    • mach - Mach number ratio
    • vvi - VVI fpm
    • normal
    • axial
    • side
  • angularmoment
  • angularvelocity
  • attitude
  • aoa
  • compass
  • globalposition
  • simposition
  • throttlecommand
    • [1..8]
  • throttleactual
    • [1..8]
  • enginepower
    • [1..8] - hp
  • enginethrust
    • [1..8]
  • enginetorque
    • [1..8]
  • enginerpm
    • [1..8]
  • proprpm
    • [1..8]
  • proppitch
    • [1..8]
  • enginewash - propwash or jetwash
  • n1 - turbine N1 %
    • [1..8] - %
  • n2 - turbine N2 %
    • [1..8] - %
  • fuelflow
  • itt
  • egt
  • cht
  • oilpressure
  • oiltemp
  • fuelpressure
  • aeroforce
  • engineforce
    • normal - lb
    • axial - lb
    • side - lb

Development

Would you like to contribute? Here's a couple of things the project needs a hand with:

  • Adding xType definitions to data/xtypes.js
  • Support for writing back to the sim via UDP
  • DataRef access via the official SDK

Credits

Code inspired by https://github.com/dmolin/flightSimPanels

License

MIT

0.0.6

9 years ago

0.0.5

9 years ago

0.0.4

9 years ago

0.0.2

9 years ago

0.0.1

9 years ago