xUesvaJs

A JavaScript Client Library for NodeJs that uses the xUesva plugin.

Prerequisites

1. Need X-Plane with the xUesva plugin installed.
2. NodeJs >= 8.0.0

Installation

Install via NPM

$ npm install xuesvajs

Connecting to X-Plane

Make sure X-Plane is started and the plugin is installed and active.

xUesvaJs Config

Modify the config.json or modify the config of object passed to xUesvaJs

{
    "host": "127.0.0.1",
    "port": 17152,
    "broadcast": false,
    "debug": false
}

Client API

client.key(key_id)

Press a key

client.msg(cmd)

Send and Show a message into X-Plane

client.once(cmd)

Execute a command

client.begin(cmd)

Begin a command

client.end(cmd)

End a command

client.button(button_id)

Press a button

client.release(button_id)

Release a button

client.set(data_ref, value)

Set a data refs value

client.subscribe(data_ref, [accuracy])

Subscribe to a data ref

client.unsubscribe(data_ref)

Unsubscribe to a data ref

client.interval(value)

Override the data update interval from X-Plane

client.disconnect()

Send the disconnect command

License

GPL License - Copyright © Uesva