Initial commit

Leeft · Leeft · commit e6b8c59d72ff · 2020-09-01T23:38:38.000+01:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+dist
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,16 @@
+{
+  "extends": [
+    "airbnb-base",
+    "plugin:node/recommended-module",
+    "plugin:promise/recommended",
+    "plugin:jest-formatting/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "plugins": ["import"],
+  "env": {
+    "jest": true
+  },
+  "rules": {
+    "no-console": 0
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+dist
diff --git a/.jshintrc b/.jshintrc
@@ -0,0 +1,4 @@
+{
+    "esversion": 8,
+    "laxbreak": true
+}
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all"
+}
diff --git a/.tsconfig b/.tsconfig
@@ -0,0 +1,3 @@
+{
+    "esModuleInterop": true
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,15 @@
+{
+  "version": "0.2.0",
+  "configurations": [{
+    "type": "node",
+    "request": "launch",
+    "name": "server.js",
+    "skipFiles": [
+      "<node_internals>/**",
+      "${workspaceFolder}/node_modules/**"
+    ],
+    "runtimeArgs": ["-r", "sucrase/register"],
+    "cwd": "${workspaceFolder}",
+    "program": "${workspaceFolder}/src/index.js"
+  }]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,14 @@
+{
+  "editor.formatOnSave": true,
+  "[javascript]": {
+    "editor.formatOnSave": false
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "prettier.disableLanguages": ["javascript"],
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "javascript.implicitProjectConfig.checkJs": true
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,25 @@
+{
+	"version": "2.0.0",
+	"tasks": [{
+			"type": "npm",
+			"script": "build",
+			"problemMatcher": [
+				"$eslint-compact"
+			],
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"label": "npm: build",
+			"detail": "pkg . --out-path dist"
+		},
+		{
+			"type": "npm",
+			"script": "install",
+			"problemMatcher": [],
+			"label": "npm: install",
+			"detail": "install dependencies from package",
+			"group": "build"
+		}
+	]
+}
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2020 Lianna Eeftinck <liannaee@gmail.com>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# xplane-websocket-proxy
+
+A basic websocket to X-Plane Legacy UDP proxy written in node; this proxy makes it easy to talk to X-Plane from a Javascript application such as the Stream Deck plugin I'm also working on.
+
+When started, this listens on localhost:8080 (TCP) for websocket connections, and talks to X-Plane on localhost:49000 (UDP).
+
+## Installation
+
+### The easy way
+
+Grab the latest executable for your platform from https://github.com/Leeft/xplane-node-udp-client/releases. Place it anywhere you like, and run it. Windows, MacOS and Linux binaries are included, but only Windows is tested right now.
+
+A window will open which will echo the instructions that are received; as this is project is in early stages this can not currently be disabled nor can anything be configured.
+
+You can't directly do anything with this; use my Stream Deck plugin to talk to your X-Plane.
+
+Hit control-C (or command-C) to stop the server.
+
+### For development
+
+Install node (https://nodejs.org) for your platform, clone this repository and run `npm install` in its directory; this will install all dependencies you need to run it manually.
+
+I recommend the free Visual Studio Code with the appropriate extensions as a good development tool.
+
+Run `node server.js` to start the server, run `node client.js` to start a quick and dirty test client. See inside that script for a bit more information on what it does.
+
+## See also
+
+Includes my little library https://github.com/Leeft/xplane-node-udp-client to talk to X-Plane.
+
+Running this server is currently required for my Stream Deck plugin https://github.com/Leeft/streamdeck-xplane to work.
diff --git a/client.js b/client.js
@@ -0,0 +1,153 @@
+/* eslint-disable no-undef */
+/*
+ * Basic test client for the Websocket to X-Plane UDP proxy
+ *
+ * Start with 'npm client.js', this then connects to your local
+ * websocket proxy on port :8080 (you start this with 'npm server.js')
+ * and that proxy will talk to X-Plane if it's running.
+ *
+ * Press:
+ * 1: Send the command to open/close the glove box on the C172SP.
+ * 2: Send the command to toggle APR mode on the S-TEC like AP.
+ * 3: Tell X-Plane to send you the flaps setting at most once per second.
+ * 4: Tell X-Plane to send you the flaps setting up to four times per second.
+ * 5: Tell X-Plane to stop sending you flaps updates.
+ * 6: Set the flaps value dataRef to 0.0
+ * 7: Set the flaps value dataRef to 1.0
+ * 8: Lower the flaps one notch
+ * 8: Raise the flaps one notch
+ * ctrl-C or command-C: exit the client
+ *
+ * (Note: the websocket proxy currently only sends value updates if the
+ * value changed, so you probably will see fewer responses than requested).
+ */
+
+const WebSocket = require('ws');
+const JsonRPC = require('simple-jsonrpc-js');
+
+function heartbeat() {
+  clearTimeout(this.pingTimeout);
+
+  // Use `WebSocket#terminate()`, which immediately destroys the connection,
+  // instead of `WebSocket#close()`, which waits for the close timer.
+  // Delay should be equal to the interval at which your server
+  // sends out pings plus a conservative assumption of the latency.
+  this.pingTimeout = setTimeout(() => {
+    this.terminate();
+  }, 10000 + 1000);
+}
+
+function connect() {
+  console.log('connecting ...');
+
+  const jrpc = new JsonRPC();
+  const ws = new WebSocket('ws://localhost:8080');
+
+  ws.jrpc = jrpc;
+
+  ws.on('open', heartbeat);
+
+  ws.on('ping', heartbeat);
+
+  ws.on('close', function clear() {
+    clearTimeout(this.pingTimeout);
+    console.log('disconnected');
+  });
+
+  jrpc.on(
+    'dataRefUpdate',
+    ['dataRef', 'value'],
+    (updatedDataRef, updatedValue) => {
+      console.log(`the dataref ${updatedDataRef} has value ${updatedValue}`);
+    },
+  );
+
+  jrpc.toStream = function toStream(_msg) {
+    ws.send(_msg);
+  };
+
+  ws.on('message', function incoming(data) {
+    // console.log(`got message: ${data}`);
+    jrpc.messageHandler(data);
+  });
+
+  return ws;
+}
+
+const ws = connect();
+
+// node.js get keypress
+const { stdin } = process;
+
+// without this, we would only get streams once enter is pressed
+stdin.setRawMode(true);
+
+// resume stdin in the parent process (node app won't quit all by itself
+// unless an error or process.exit() happens)
+stdin.resume();
+// i don't want binary, do you?
+stdin.setEncoding('utf8');
+
+// on any data into stdin
+stdin.on('data', function on(key) {
+  // ctrl-c ( end of text )
+  // @ts-ignore
+  if (key === '\u0003') {
+    // eslint-disable-next-line no-process-exit
+    process.exit();
+  }
+
+  // if (ws !== null) {
+  //  console.log('Not connected');
+  //  return;
+  // }
+
+  // without rawmode, it returns EOL with the string
+  if (key.indexOf('1') === 0) {
+    console.log(`toggling glove box`);
+    ws.jrpc.call('sendCommand', ['sim/operation/slider_24']);
+  }
+
+  if (key.indexOf('2') === 0) {
+    console.log(`toggling AP APR`);
+    ws.jrpc.call('sendCommand', ['sim/autopilot/approach']);
+  }
+
+  if (key.indexOf('3') === 0) {
+    console.log(`requesting flaps at lowest speed (1 per sec)`);
+    ws.jrpc.call('requestDataRef', ['sim/flightmodel/controls/flaprat', 1]);
+  }
+
+  if (key.indexOf('4') === 0) {
+    console.log(`requesting flaps at medium speed (4 per sec)`);
+    ws.jrpc.call('requestDataRef', ['sim/flightmodel/controls/flaprat', 4]);
+  }
+
+  if (key.indexOf('5') === 0) {
+    console.log(`requesting no more flaps updates`);
+    ws.jrpc.call('requestDataRef', ['sim/flightmodel/controls/flaprat', 0]);
+  }
+
+  if (key.indexOf('6') === 0) {
+    console.log(`setting flaps to 1.0`);
+    ws.jrpc.call('setDataRef', ['sim/flightmodel/controls/flaprqst', 1.0]);
+  }
+
+  if (key.indexOf('7') === 0) {
+    console.log(`setting flaps to 0.0`);
+    ws.jrpc.call('setDataRef', ['sim/flightmodel/controls/flaprqst', 0.0]);
+  }
+
+  if (key.indexOf('8') === 0) {
+    console.log(`flaps down one`);
+    ws.jrpc.call('sendCommand', ['sim/flight_controls/flaps_down']);
+  }
+
+  if (key.indexOf('9') === 0) {
+    console.log(`flaps up one`);
+    ws.jrpc.call('sendCommand', ['sim/flight_controls/flaps_up']);
+  }
+
+  // write the key to stdout all normal like
+  // process.stdout.write( key );
+});
diff --git a/jest.config.json b/jest.config.json
@@ -0,0 +1,9 @@
+{
+  "collectCoverage": true,
+  "collectCoverageFrom": ["src/**/*.js", "!**/node_modules/**"],
+  "coverageDirectory": "coverage",
+  "testPathIgnorePatterns": ["<rootDir>/dist/", "<rootDir>/node_modules/"],
+  "transform": {
+    ".(js|jsx|ts|tsx)": "@sucrase/jest-plugin"
+  }
+}
diff --git a/nodemon.json b/nodemon.json
@@ -0,0 +1,5 @@
+{
+  "execMap": {
+    "js": "sucrase-node"
+  }
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/server.js b/server.js

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +    "esversion": 8,
 +    "laxbreak": true
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "esModuleInterop": true`
	`3`	`+}`