XWebSockets

UDP ⇆ WebSockets translator for X-Plane

Features:

Static asset server
Simple, JSON-based communication

Currently supported operations:

CMND
RREF
DREF

Installation

Prerequisites: Node.js, NPM

Clone the repository, open up your shell and navigate to the repo folder. Run npm i to install dependencies and node start to compile and start the server.

Settings

Settings are changed via xws_config.txt.

Name	Description	Example
`XWS_PORT`	The port to serve on	`8080`
`XWS_STATIC`	The directory to serve static assets from	`./dist`
`XWS_ENV`	Change from `debug` to `prod` to prevent logging requests	`debug`

Commands

To actuate a command, send the following JSON:

{
    "header": "CMND",
    "path": "sim/autopilot/heading_sync"
}

Datarefs

To set a dataref, send the following JSON:

{
    "header": "DREF",
    "path": "sim/cockpit/radios/transponder_code",
    "data": 1200
}

To subscribe to dataref updates, send the following JSON:

{
    "header": "RREF",
    "freq": 5,
    "index": 101,
    "path": "sim/cockpit/autopilot/heading_mag"
}

freq times per second, you'll receive the following JSON:

{
    "header": "RREF",
    "data": [
        [101, 212.366]
    ]
}

X-Plane is smart and can batch datarefs over UDP, and XWebSockets matches that behavior. Returned JSON could look like:

{
    "header": "RREF",
    "data": [
        [101, 212.366],
        [102, 1200],
        [103, 129100]
    ]
}

harryrabin / xwebsockets