@ircam/comote-helpers 0.3.1 → 1.0.1

package/{server.js → src/server.js}

@@ -1,26 +1,15 @@
-"use strict";
+import { WebSocketServer } from 'ws';
+import isValidUTF8 from 'utf-8-validate';
+import { Server as OscServer } from 'node-osc';
+import cloneDeep from 'clone-deep';
+import assignDeep from 'assign-deep';
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Server = void 0;
-
-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 }; }
+console.log(WebSocket);
 
 /**
  * @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 {String} id - id of the client CoMote
+ * @property {Number} interval - period in ms of the sensors for the client CoMote
  * @property {CoMoteTarget} osc - OSC configuration
  * @property {CoMoteTarget} ws - WebSocket configuration
  */
@@ -29,9 +18,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @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
+ * @property {Boolean} autostart - enable streaming on CoMote application
  */
 
+
 /**
  * Launch WebSocket and/or OSC server according to given `CoMoteConfig` object
  *
@@ -39,27 +29,29 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {Object} options - options
  * @param {Object} [options.verbose=false] - logs debug informations
  */
-class Server {
+export class Server {
   constructor(config, options) {
     /**
      * Configuration of the CoMote server
      */
-    this.config = (0, _cloneDeep.default)((0, _assignDeep.default)({
+    this.config = cloneDeep(assignDeep({
       id: null,
       interval: null,
       osc: null,
       ws: null,
-      verbose: false
+      verbose: false,
     }, config));
+
     this._verbose = !!options.verbose;
 
     if (this._verbose) {
-      console.log('+ CoMo.te config:');
+      console.log('+ CoMote config:');
       console.log(this.config, '\n');
     }
 
     this._websocketServer = null;
     this._oscServer = null;
+
     this._wsListeners = new Set();
     this._oscListeners = new Set();
   }
@@ -69,47 +61,41 @@ class Server {
     let oscPromise = true;
 
     if (this.config.ws !== null) {
-      const {
-        hostname,
-        port
-      } = this.config.ws;
+      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}`);
+        console.log(`> CoMote: Launching WebSocket server on port: ${port}`);
       }
 
-      this._websocketServer = new _ws.default.Server({
-        port
-      });
-      const sockets = new Map();
-
+      this._websocketServer = new WebSocketServer({ port });
       this._websocketServer.on('connection', (socket, request) => {
         // const ip = request.socket.remoteAddress;
         socket.on('message', (data, isBinary) => {
-          if (isBinary) {// @todo
+          if (isBinary) {
+            // @todo
           } else {
-            if ((0, _utf8Validate.default)(data)) {
-              // do we really need this check?
+            if (isValidUTF8(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);
-
+                console.log(`> CoMote: 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.
+        });
 
+        // 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');
+            console.log('> CoMote: closed socket connection');
           }
         });
       });
@@ -117,48 +103,45 @@ class Server {
       wsPromise = new Promise((resolve, reject) => {
         this._websocketServer.on('listening', () => {
           if (this._verbose) {
-            console.log(`> CoMo.te: WebSocket server listening`);
+            console.log(`> CoMote: WebSocket server listening`);
           }
 
           resolve();
         });
 
         this._websocketServer.on('error', err => {
-          console.log(`> CoMo.te: WebSocket server error`, err);
+          console.log(`> CoMote: WebSocket server error`, err);
           reject(err);
         });
       });
     }
 
     if (this.config.osc !== null) {
-      const {
-        hostname,
-        port
-      } = this.config.osc;
+      const { hostname, port } = this.config.osc;
 
       if (!Number.isInteger(port)) {
         throw new Error(`Invalid port "${port}" for OSC server`);
-      } // fallback to broadcast
-
+      }
 
+      // fallback to broadcast
       if (!hostname) {
         hostname = '0.0.0.0';
       }
 
       if (this._verbose) {
-        console.log(`> CoMo.te: Launching OSC server udp://${hostname}:${port}`);
+        console.log(`> CoMote: Launching OSC server udp://${hostname}:${port}`);
       }
 
       oscPromise = new Promise((resolve, reject) => {
-        this._oscServer = new _nodeOsc.Server(this.config.osc.port, hostname, err => {
+        this._oscServer = new OscServer(this.config.osc.port, hostname, err => {
           if (err) {
-            console.log(`> CoMo.te: OSC server error`, err);
+            console.log(`> CoMote: OSC server error`, err);
             reject();
             return;
           }
 
           if (this._verbose) {
-            console.log(`> CoMo.te: OSC server listening`);
+            console.log(`> CoMote: OSC server listening`);
           }
 
           resolve();
@@ -168,7 +151,7 @@ class Server {
           let address = data.shift();
 
           if (this._verbose) {
-            console.log(`> CoMo.te: new OSC message "${address}":`, data);
+            console.log(`> CoMote: new OSC message "${address}":`, data);
           }
 
           this._oscListeners.forEach(callback => callback(address, data));
@@ -188,43 +171,36 @@ class Server {
       this._oscServer.close();
     }
   }
-  /**
-  * Add a listener for incomming WebSocket message
-  */
-
 
+    /**
+   * 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;

package/src/wifi-infos.js

@@ -0,0 +1,33 @@
+import si from 'systeminformation';
+
+/**
+ * @typedef {Object} WifiInfos
+ * @property {number} ssid - SSID of the WiFi connection
+ * @property {number} ip - Related IP (IPV4)
+ */
+
+/**
+ * Retrieve the SSID and related IP of the first WiFi connection found, return
+ * `null` if no WiFi connection found.
+ *
+ * @async
+ * @return {WiFiInfos|null}
+ */
+export async function getWifiInfos() {
+  // find first wifi connection
+  const wifiConnections = await si.wifiConnections();
+  const conn = wifiConnections[0];
+
+  if (!conn) {
+    return null;
+  }
+
+  // find related interface
+  const interfaces = await si.networkInterfaces();
+  const int = interfaces.find(int => int.iface === conn.iface);
+
+  return {
+    ssid: conn.ssid,
+    ip: int.ip4,
+  };
+}

package/README.md

@@ -1,160 +0,0 @@
-# `CoMo.te helpers`
-
-> Javascript and Max/MSP utilities to create applications compatible with iPhone 
-> and Android `CoMo.te` application, cf. [https://ismm-apps.ircam.fr/comote](https://ismm-apps.ircam.fr/comote).
-
-
-The CoMo.te application (iOS and Android) allows for streaming motion data (accelerometer, gyroscope) from the smartphone to desktop applications using either the OSC or Websockets protocols. The network's setup is facilitated by the use of a QR code generated by the targeted remote application receiving the motion sensor data.
-    
-CoMo.te is especially designed for the CoMo applications family that enables real-time interaction between gestures/movements and sounds. Nevertheless, the CoMo.te application can be used with any software that makes use of the OSC protocol.
-
-Among the CoMo applications that make use of CoMo.te are CoMo-Vox to learn and train conducting gestures, and CoMo-Elements to interact collectively thought body movements with recorded sounds.
-
-CoMo.te and the CoMo applications are software designed and developed by IRCAM in the Sound-Music-Movement-Interaction team (UMR STMS).
-
-This repository provides utilities to help to generate the QRCode in the target application both for Max/MSP and Node.js.
-
-
-
-## Table of Contents
-
-<!-- toc -->
-
-- [Max/MSP](#maxmsp)
-- [JS](#js)
-  * [Node.js](#nodejs)
-  * [API](#api)
-- [License](#license)
-
-<!-- tocstop -->
-
-## Max/MSP
-
-Download the Max abstraction (i.e. CoMo.te.zip) from the lastest release in the releases page: https://github.com/ircam-ismm/comote-helpers/releases
-Unzip the package and copy the resulting directory in `~/Documents/Max 8/Packages`
-
-For now, the package only provide abstraction `[comote.connect]` that allows you to generate a QRCode that can be 
-flashed within the CoMo.te application to configure the OSC stream.
-
-You can find more informations in the Helper patch: `~/Document/Max 8/Packages/CoMo.te/extras/CoMo.te.maxpat`
-
-This version requires Max 7.1 or higher.
-
-## JS
-
-### Node.js
-
-```sh
-npm install --save @ircam/comote-helpers
-```
-
-### 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="#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="#CoMoteConfig">CoMoteConfig</a> : <code>Object</code></dt>
-<dd></dd>
-<dt><a href="#CoMoteTarget">CoMoteTarget</a> : <code>Object</code></dt>
-<dd></dd>
-</dl>
-
-<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(await 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
-const qrCode = await CoMoteQRCode.dataURL(config));
-
-<img src="${qrCode}" />
-```
-<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 -->
-
-## Credits
-
-CoMo.te is developed by Ircam and the Music and Sound Science and Technology Joint Research Unit (STMS), supported by Ircam, CNRS, the French Ministry of Culture and Sorbonne University.
-
-Produced with the support of the French Ministry of Education, Youth and Sports (Edu-up system), the National Research Agency (ELEMENT project), and in partnership with Radio France.
-
-## License
-
-BSD-3-Clause

package/wifi-infos.js

@@ -1,41 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getWifiInfos = getWifiInfos;
-
-var _systeminformation = _interopRequireDefault(require("systeminformation"));
-
-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)
- */
-
-/**
- * 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
-  };
-}