@ircam/comote-helpers 0.0.0

package/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015 IRCAM, Paris, France
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS 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 HOLDER 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.

package/README.md

@@ -0,0 +1,157 @@
+# `@ircam/comote-helpers`
+
+> Javascript and Max/MSP utilities to create applications compatible with iPhone 
+> and Android `CoMo.te` application.
+
+## Table of Contents
+
+<!-- toc -->
+
+- [Install](#install)
+- [API](#api)
+  * [Classes](#classes)
+  * [Functions](#functions)
+  * [Typedefs](#typedefs)
+  * [getWifiInfos() ⇒ WiFiInfos \| null](#getwifiinfos-%E2%87%92-wifiinfos--null)
+  * [rawLink()](#rawlink)
+  * [terminal(config)](#terminalconfig)
+  * [dataURL(config)](#dataurlconfig)
+  * [WifiInfos : Object](#wifiinfos--object)
+  * [CoMoteConfig : Object](#comoteconfig--object)
+  * [CoMoteTarget : Object](#comotetarget--object)
+- [License](#license)
+
+<!-- tocstop -->
+
+## Install
+
+```sh
+npm install --save @ircam/comote-helpers
+```
+
+## JS API
+
+<!-- api -->
+
+### Classes
+
+<dl>
+<dt><a href="#Server">Server</a></dt>
+<dd><p>Launch WebSocket and/or OSC server according to given <code>CoMoteConfig</code> object</p>
+</dd>
+</dl>
+
+### Functions
+
+<dl>
+<dt><a href="#getWifiInfos">getWifiInfos()</a> ⇒ <code>WiFiInfos</code> | <code>null</code></dt>
+<dd><p>Retrieve the SSID and related IP of the first WiFi connection found, return
+<code>null</code> if no WiFi connection found.</p>
+</dd>
+<dt><a href="#rawLink">rawLink()</a></dt>
+<dd><p>Return the link to be encoded in the QRCode accroding to given <code>CoMoteConfig</code></p>
+</dd>
+<dt><a href="#terminal">terminal(config)</a></dt>
+<dd><p>Create a qrcode to be logged in terminal according to given `CoMoteConfig``</p>
+</dd>
+<dt><a href="#dataURL">dataURL(config)</a></dt>
+<dd><p>Create a qrcode to be used as in Image source according to given `CoMoteConfig``</p>
+</dd>
+</dl>
+
+### Typedefs
+
+<dl>
+<dt><a href="#WifiInfos">WifiInfos</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="#CoMoteConfig">CoMoteConfig</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="#CoMoteTarget">CoMoteTarget</a> : <code>Object</code></dt>
+<dd></dd>
+</dl>
+
+<a name="getWifiInfos"></a>
+
+### getWifiInfos() ⇒ <code>WiFiInfos</code> \| <code>null</code>
+Retrieve the SSID and related IP of the first WiFi connection found, return
+`null` if no WiFi connection found.
+
+**Kind**: global function  
+<a name="rawLink"></a>
+
+### rawLink()
+Return the link to be encoded in the QRCode accroding to given `CoMoteConfig`
+
+**Kind**: global function  
+<a name="terminal"></a>
+
+### terminal(config)
+Create a qrcode to be logged in terminal according to given `CoMoteConfig``
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| config | [<code>CoMoteConfig</code>](#CoMoteConfig) | 
+
+**Example**  
+```js
+console(CoMoteQRCode.terminal(config));
+```
+<a name="dataURL"></a>
+
+### dataURL(config)
+Create a qrcode to be used as in Image source according to given `CoMoteConfig``
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| config | [<code>CoMoteConfig</code>](#CoMoteConfig) | 
+
+**Example**  
+```js
+<img src="${CoMoteQRCode.dataURL(config))}" />
+```
+<a name="WifiInfos"></a>
+
+### WifiInfos : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| ssid | <code>number</code> | SSID of the WiFi connection |
+| ip | <code>number</code> | Related IP (IPV4) |
+
+<a name="CoMoteConfig"></a>
+
+### CoMoteConfig : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| id | <code>String</code> | id of the client CoMo.te |
+| interval | <code>Number</code> | period in ms of the sensors for the client CoMo.te |
+| osc | [<code>CoMoteTarget</code>](#CoMoteTarget) | OSC configuration |
+| ws | [<code>CoMoteTarget</code>](#CoMoteTarget) | WebSocket configuration |
+
+<a name="CoMoteTarget"></a>
+
+### CoMoteTarget : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| hostname | <code>String</code> | hostname or ip of the WebSocket or OSC server |
+| port | <code>Number</code> | listening port of the of the WebSocket or OSC server |
+| autostart | <code>Boolean</code> | enable streaming on CoMo.te application |
+
+
+<!-- apistop -->
+
+## License
+
+BSD-3-Clause

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ircam/comote-helpers",
+  "version": "0.0.0",
+  "description": "Server component & utilities for the CoMo.te application",
+  "authors": [
+    "Benjamin.Matuszewski@ircam.fr",
+    "Jean-Philippe.Lambert@ircam.fr"
+  ],
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ircam-ismm/comote-helpers"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "api": "jsdoc-to-readme --src src/server.js src/qrcode.js",
+    "build": "npm run clean && babel src --out-dir .",
+    "clean": "rm -f server.js qrcode.js",
+    "dev": "npm run build && chokidar src -c \"npm run build\"",
+    "doc": "npm run api && npm run toc",
+    "prepublishOnly": "npm run build",
+    "toc": "markdown-toc -i README.md  --maxdepth 3"
+  },
+  "dependencies": {
+    "assign-deep": "^1.0.1",
+    "clone-deep": "^4.0.1",
+    "debug": "^4.3.1",
+    "node-osc": "^7.0.0",
+    "qrcode": "^1.5.0",
+    "systeminformation": "^5.11.15",
+    "utf-8-validate": "^5.0.9",
+    "ws": "^8.6.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.4.4",
+    "@babel/core": "^7.4.5",
+    "@babel/preset-env": "^7.14.7",
+    "chokidar": "^3.0.1",
+    "chokidar-cli": "^2.1.0",
+    "jsdoc-to-readme": "^1.0.2",
+    "markdown-toc": "^1.2.0"
+  }
+}

package/qrcode.js

@@ -0,0 +1,101 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.dataURL = dataURL;
+exports.rawLink = rawLink;
+exports.terminal = terminal;
+
+var _qrcode = _interopRequireDefault(require("qrcode"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function formatConfigToLink(config) {
+  let link = `comote://settings?`;
+  const query = [];
+
+  if (Number.isFinite(config.id) && config.id >= 0) {
+    query.push(`id=${config.id}`);
+  }
+
+  if (Number.isFinite(config.interval) && config.interval > 0) {
+    query.push(`interval=${config.interval}`);
+  }
+
+  if (config.ws) {
+    const {
+      hostname,
+      port
+    } = config.ws;
+
+    if (!hostname || !Number.isInteger(port)) {
+      throw new Error(`Invalid WebSocket config: ${config.ws}`);
+    }
+
+    query.push(`ws-url=ws://${hostname}:${port}`);
+
+    if (config.ws.autostart === true) {
+      query.push(`ws-enable=1`);
+    }
+  }
+
+  if (config.osc) {
+    const {
+      hostname,
+      port
+    } = config.osc;
+
+    if (!hostname || !Number.isInteger(port)) {
+      throw new Error(`Invalid WebSocket config: ${config.osc}`);
+    }
+
+    query.push(`osc-url=udp://${hostname}:${port}`);
+
+    if (config.osc.autostart === true) {
+      query.push(`osc-enable=1`);
+    }
+  }
+
+  link += query.join('&');
+  return link;
+}
+/**
+ * Return the link to be encoded in the QRCode accroding to given `CoMoteConfig`
+ */
+
+
+function rawLink(config) {
+  return formatConfigToLink(config);
+}
+/**
+ * Create a qrcode to be logged in terminal according to given `CoMoteConfig``
+ *
+ * @param {CoMoteConfig} config
+ * @example
+ * console(await CoMoteQRCode.terminal(config));
+ */
+
+
+async function terminal(config) {
+  const link = formatConfigToLink(config);
+  return await _qrcode.default.toString(link, {
+    type: 'terminal',
+    small: true
+  });
+}
+/**
+ * Create a qrcode to be used as in Image source according to given `CoMoteConfig``
+ *
+ * @param {CoMoteConfig} config
+ * @example
+ * const qrCode = await CoMoteQRCode.dataURL(config));
+ *
+ * <img src="${qrCode}" />
+ */
+
+
+async function dataURL(config) {
+  const link = formatConfigToLink(config);
+  return await await _qrcode.default.toDataURL(link);
+}

package/server.js

@@ -0,0 +1,265 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Server = void 0;
+exports.getWifiInfos = getWifiInfos;
+
+var _systeminformation = _interopRequireDefault(require("systeminformation"));
+
+var _ws = _interopRequireDefault(require("ws"));
+
+var _utf8Validate = _interopRequireDefault(require("utf-8-validate"));
+
+var _nodeOsc = require("node-osc");
+
+var _cloneDeep = _interopRequireDefault(require("clone-deep"));
+
+var _assignDeep = _interopRequireDefault(require("assign-deep"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * @typedef {Object} WifiInfos
+ * @property {number} ssid - SSID of the WiFi connection
+ * @property {number} ip - Related IP (IPV4)
+ */
+
+/**
+ * @typedef {Object} CoMoteConfig
+ * @property {String} id - id of the client CoMo.te
+ * @property {Number} interval - period in ms of the sensors for the client CoMo.te
+ * @property {CoMoteTarget} osc - OSC configuration
+ * @property {CoMoteTarget} ws - WebSocket configuration
+ */
+
+/**
+ * @typedef {Object} CoMoteTarget
+ * @property {String} hostname - hostname or ip of the WebSocket or OSC server
+ * @property {Number} port - listening port of the of the WebSocket or OSC server
+ * @property {Boolean} autostart - enable streaming on CoMo.te application
+ */
+
+/**
+ * Retrieve the SSID and related IP of the first WiFi connection found, return
+ * `null` if no WiFi connection found.
+ *
+ * @async
+ * @return {WiFiInfos|null}
+ */
+async function getWifiInfos() {
+  // find first wifi connection
+  const wifiConnections = await _systeminformation.default.wifiConnections();
+  const conn = wifiConnections[0];
+
+  if (!conn) {
+    return null;
+  } // find related interface
+
+
+  const interfaces = await _systeminformation.default.networkInterfaces();
+  const int = interfaces.find(int => int.iface === conn.iface);
+  return {
+    ssid: conn.ssid,
+    ip: int.ip4
+  };
+}
+/**
+ * Launch WebSocket and/or OSC server according to given `CoMoteConfig` object
+ *
+ * @param {CoMoteConfig} config - CoMote configuration
+ * @param {Object} options - options
+ * @param {Object} [options.verbose=false] - logs debug informations
+ */
+
+
+class Server {
+  constructor(config, options) {
+    /**
+     * Configuration of the CoMote server
+     */
+    this.config = (0, _cloneDeep.default)((0, _assignDeep.default)({
+      id: null,
+      interval: null,
+      osc: null,
+      ws: null,
+      verbose: false
+    }, config));
+    this._verbose = !!options.verbose;
+
+    if (this._verbose) {
+      console.log('+ CoMo.te config:');
+      console.log(this.config, '\n');
+    }
+
+    this._websocketServer = null;
+    this._oscServer = null;
+    this._wsListeners = new Set();
+    this._oscListeners = new Set();
+  }
+
+  async start() {
+    let wsPromise = true;
+    let oscPromise = true;
+
+    if (this.config.ws !== null) {
+      const {
+        hostname,
+        port
+      } = this.config.ws;
+
+      if (!Number.isInteger(port)) {
+        throw new Error(`Invalid port "${port}" for WebSocket server`);
+      }
+
+      if (this._verbose) {
+        console.log(`> CoMo.te: Launching WebSocket server on port: ${port}`);
+      }
+
+      this._websocketServer = new _ws.default.Server({
+        port
+      });
+      const sockets = new Map();
+
+      this._websocketServer.on('connection', (socket, request) => {
+        // const ip = request.socket.remoteAddress;
+        socket.on('message', (data, isBinary) => {
+          if (isBinary) {// @todo
+          } else {
+            if ((0, _utf8Validate.default)(data)) {
+              // do we really need this check?
+              data = JSON.parse(data);
+
+              if (this._verbose) {
+                console.log(`> CoMo.te: new WebSocket message`, data);
+              } // console.log(data);
+              // console.log(this._wsListeners.size);
+
+
+              this._wsListeners.forEach(listener => listener(data));
+            }
+          }
+        }); // When a socket closes, or disconnects, remove it from the array.
+
+        socket.on('close', (code, data) => {
+          if (this._verbose) {
+            console.log('> CoMo.te: closed socket connection');
+          }
+        });
+      });
+
+      wsPromise = new Promise((resolve, reject) => {
+        this._websocketServer.on('listening', () => {
+          if (this._verbose) {
+            console.log(`> CoMo.te: WebSocket server listening`);
+          }
+
+          resolve();
+        });
+
+        this._websocketServer.on('error', err => {
+          console.log(`> CoMo.te: WebSocket server error`, err);
+          reject(err);
+        });
+      });
+    }
+
+    if (this.config.osc !== null) {
+      const {
+        hostname,
+        port
+      } = this.config.osc;
+
+      if (!Number.isInteger(port)) {
+        throw new Error(`Invalid port "${port}" for OSC server`);
+      } // fallback to broadcast
+
+
+      if (!hostname) {
+        hostname = '0.0.0.0';
+      }
+
+      if (this._verbose) {
+        console.log(`> CoMo.te: Launching OSC server udp://${hostname}:${port}`);
+      }
+
+      oscPromise = new Promise((resolve, reject) => {
+        this._oscServer = new _nodeOsc.Server(this.config.osc.port, hostname, err => {
+          if (err) {
+            console.log(`> CoMo.te: OSC server error`, err);
+            reject();
+            return;
+          }
+
+          if (this._verbose) {
+            console.log(`> CoMo.te: OSC server listening`);
+          }
+
+          resolve();
+        });
+
+        this._oscServer.on('message', data => {
+          let address = data.shift();
+
+          if (this._verbose) {
+            console.log(`> CoMo.te: new OSC message "${address}":`, data);
+          }
+
+          this._oscListeners.forEach(callback => callback(address, data));
+        });
+      });
+    }
+
+    return Promise.all([wsPromise, oscPromise]);
+  }
+
+  async stop() {
+    if (this._websocketServer) {
+      this._websocketServer.close();
+    }
+
+    if (this._oscServer) {
+      this._oscServer.close();
+    }
+  }
+  /**
+  * Add a listener for incomming WebSocket message
+  */
+
+
+  addWsListener(callback) {
+    this._wsListeners.add(callback);
+
+    return () => this._wsListeners.delete(callback);
+  }
+  /**
+   * Remove WebSocket listener
+   */
+
+
+  removeWsListener(callback) {
+    this._wsListeners.delete(callback);
+  }
+  /**
+   * Add a listener for incomming OSC message
+   */
+
+
+  addOscListener(callback) {
+    this._oscListeners.add(callback);
+
+    return () => this._oscListeners.delete(callback);
+  }
+  /**
+   * Remove OSC listener
+   */
+
+
+  removeOscListener(callback) {
+    this._oscListeners.delete(callback);
+  }
+
+}
+
+exports.Server = Server;