rticonnextdds-connector 1.0.0 → 1.3.0

package/README.md

@@ -26,11 +26,12 @@ The `examples/nodejs` directory provides several examples:
 ## Dependencies
 
 RTI Connector for JavaScript has the following dependencies, which are also listed in `package.json`:
-* [ref](https://www.npmjs.com/package/ref): turns Buffer instances into "pointers"
-* [ffi](https://www.npmjs.com/package/ffi): used for loading and calling dynamic libraries using pure JavaScript
+* [ref-napi](https://www.npmjs.com/package/ref-napi): turns Buffer instances into "pointers"
+* [ref-struct-napi](https://www.npmjs.com/package/ref-struct-napi): create ABI-compilant "Struct" instances on top of Buffers
+* [ffi-napi](https://www.npmjs.com/package/ffi-napi): used for loading and calling dynamic libraries using pure JavaScript
 * [events](https://www.npmjs.com/package/events): used for the 'EventEmitter' (legacy implementation of RTI Connector)
 
-Additionally to run the `web_socket` example, [socket.io](https://github.com/Automattic/socket.io) and [OpenLayers](hhttps://openlayers.org] are required.
+Additionally to run the `web_socket` example, [socket.io](https://github.com/Automattic/socket.io) and [OpenLayers](https://openlayers.org) are required.
 
 Additional dependencies are required to run the unit tests and some of the examples. Please see the README files in the appropriate directory.
 
@@ -47,9 +48,9 @@ The dependency [ref](https://www.npmjs.com/package/ref) is shipped as source cod
 
 ## License
 
-RTI Connector for JavaScript and RTI Connector for Python are part of the Connext
-DDS Professional Package. If you have a valid license for the RTI Connext DDS
-Professional Package, such license shall govern your use of RTI Connector for
-Python and RTI Connector for JavaScript. All other use of this software shall
+RTI Connector for JavaScript is part of the Connext
+Professional Package. If you have a valid license for the RTI Connext
+Professional Package, such license shall govern your use of
+RTI Connector for JavaScript. All other use of this software shall
 be governed solely by the terms of RTI’s Software License for Non-Commercial
-Use #4040, included at the top level of the `Connector for Python repository
+Use #4040.

package/README.rst

@@ -2,7 +2,7 @@ RTI Connector for JavaScript
 ============================
 
 RTI® Connext® DDS is a connectivity software framework for integrating
-data sources of all types. At its core is the world’s leading ultra-high
+data sources of all types. At its core is the world's leading ultra-high
 performance, distributed networking databus.
 
 *RTI Connector* provides a quick and easy way to write applications that
@@ -34,15 +34,18 @@ Dependencies
 
 RTI Connector for JavaScript has the following dependencies, which are
 also listed in ``package.json``: \*
-`ref <https://www.npmjs.com/package/ref>`__: turns Buffer instances into
-“pointers” \* `ffi <https://www.npmjs.com/package/ffi>`__: used for
-loading and calling dynamic libraries using pure JavaScript \*
+`ref-napi <https://www.npmjs.com/package/ref-napi>`__: turns Buffer
+instances into "pointers" \*
+`ref-struct-napi <https://www.npmjs.com/package/ref-struct-napi>`__:
+create ABI-compilant "Struct" instances on top of Buffers \*
+`ffi-napi <https://www.npmjs.com/package/ffi-napi>`__: used for loading
+and calling dynamic libraries using pure JavaScript \*
 `events <https://www.npmjs.com/package/events>`__: used for the
-‘EventEmitter’ (legacy implementation of RTI Connector)
+'EventEmitter' (legacy implementation of RTI Connector)
 
 Additionally to run the ``web_socket`` example,
 `socket.io <https://github.com/Automattic/socket.io>`__ and
-[OpenLayers](hhttps://openlayers.org] are required.
+`OpenLayers <https://openlayers.org>`__ are required.
 
 Additional dependencies are required to run the unit tests and some of
 the examples. Please see the README files in the appropriate directory.
@@ -67,10 +70,9 @@ source code and requires a C++11 compiler.
 License
 -------
 
-RTI Connector for JavaScript and RTI Connector for Python are part of
-the Connext DDS Professional Package. If you have a valid license for
-the RTI Connext DDS Professional Package, such license shall govern your
-use of RTI Connector for Python and RTI Connector for JavaScript. All
+RTI Connector for JavaScript is part of
+the Connext Professional Package. If you have a valid license for
+the RTI Connext Professional Package, such license shall govern your
+use of RTI Connector for JavaScript. All
 other use of this software shall be governed solely by the terms of
-RTI’s Software License for Non-Commercial Use #4040, included at the top
-level of the \`Connector for Python repository
+RTI’s Software License for Non-Commercial Use #4040.

package/examples/nodejs/ShapeExample.xml

@@ -8,19 +8,18 @@ This code contains trade secrets of Real-Time Innovations, Inc.
  -->
 
 <dds xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-     xsi:noNamespaceSchemaLocation="http://community.rti.com/schema/6.0.0/rti_dds_profiles.xsd" 
-     version="6.0.0">
+     xsi:noNamespaceSchemaLocation="http://community.rti.com/schema/current/rti_dds_profiles.xsd">
 
     <!-- Qos Library -->
     <qos_library name="QosLibrary">
         <qos_profile name="DefaultProfile"
                      base_name="BuiltinQosLibExp::Generic.StrictReliable"
                      is_default_qos="true">
-            <participant_qos>
+            <domain_participant_qos>
                 <participant_name>
                     <name>Connector Shape Example</name>
                 </participant_name>
-            </participant_qos>
+            </domain_participant_qos>
         </qos_profile>
     </qos_library>
 

package/examples/nodejs/simple/writer.js

@@ -6,7 +6,7 @@
 * This code contains trade secrets of Real-Time Innovations, Inc.             *
 ******************************************************************************/
 
-const sleep = require('sleep')
+const msleep = require('util').promisify(setTimeout)
 const path = require('path')
 const rti = require('rticonnextdds-connector')
 const configFile = path.join(__dirname, '/../ShapeExample.xml')
@@ -26,7 +26,7 @@ const run = async () => {
       output.instance.setString('color', 'BLUE')
       output.write()
 
-      sleep.msleep(500)
+      await msleep(500)
     }
 
     console.log('Exiting...')

package/examples/nodejs/web_socket/README.md

@@ -3,15 +3,18 @@
 ## Example description
 In this example, we create a simple application which visualises the data DDS data it receives.
 `reader_websocket.js` listens at [http://127.0.0.1:7400](http://127.0.0.1:7400) for requests
-on how it should visualise the data. There are two options:
+on how it should visualise the data. There are the following visualisation are available:
 * simple: Prints the information about the current shape
 * maps: Prints the received shapes data on a map
+* charts: Displays the x-position of thereceived shapes data on a chart
 
 ## Dependencies
 This example requires additional packages:
 * [socket.io](https://www.npmjs.com/package/socket.io)
+  * Note: Node.js v13.6.x is incomaptible with socket.io.
 * [ol](https://www.npmjs.com/package/ol)
-They can be installed using `npm install socket.io ol`
+
+These additional dependencies can be installed using `npm install socket.io@^3.0.4 ol@^6.4.3`
 
 ## Running the example
 * Run any *DDS* application that publishes the *Square*, *Circle* or *Triangle* topic. For example run
@@ -19,8 +22,7 @@ They can be installed using `npm install socket.io ol`
 [RTI Shapes Demo](https://www.rti.com/free-trial/shapes-demo) and create a *Square*
 publisher.
 * Run the web server `node ./reader_websocket.js`
-* In a browser, navigate to [http:/localhost:7400](http://127.0.0.1:7400)
+* In a browser, navigate to [http:/127.0.0.1:7400](http://127.0.0.1:7400)
 * Select how you would like to visualize the data (simple or maps).
-* Navigating to [http://localhost:7400/simple](http://localhost:7400/simple) will show the simple visualization and
-[http://localhost:7400/maps](http://localhost:7400/maps) will show the maps visualization.
+* Navigating to [http://127.0.0.1:7400/simple](http://127.0.0.1:7400/simple) will show the simple visualisation, [http://127.0.0.1:7400/maps](http://127.0.0.1:7400/maps) will show the maps visualisation and [http://127.0.0.1:7400/chart](http://127.0.0.1:7400/chart) will show the chart visualisation.
   * Note: The simple visualization may not work in the Safari browser.

package/examples/nodejs/web_socket/indexChart.html

@@ -0,0 +1,121 @@
+<!DOCTYPE html>
+<html lang="en">
+  <!--
+  (c) 2020 Copyright, Real-Time Innovations.  All rights reserved.
+  No duplications, whole or partial, manual or electronic, may be made
+  without express written permission.  Any such copies, or revisions thereof,
+  must display this notice unaltered.
+  This code contains trade secrets of Real-Time Innovations, Inc.
+   -->
+  <head>
+      <meta charset="utf-8" />
+      <title>RTI Connector for Javascript Example - Chart</title>
+    <!-- The line below is only needed for old environments like Internet Explorer and Android 4.x -->
+    <script src="/socket.io/socket.io.js"></script>
+    <script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=requestAnimationFrame,Element.prototype.classList,URL"></script>
+    <script src="https://cdn.rawgit.com/openlayers/openlayers.github.io/master/en/v6.0.1/build/ol.js"></script>
+  </head>
+  <body>
+    <!-- Load the D3 library -->
+    <script src="http://d3js.org/d3.v3.min.js"></script>
+    <script>
+        // The number of datapoints to be displayed
+        var n = 40;
+        // The dataset to be displayed by the line
+        var dataset = d3.range(n).map(() => d3.random.normal(0, .2));
+        
+        var margin = { top: 20, right: 20, bottom: 20, left: 40 },
+            width = 960 - margin.left - margin.right,
+            height = 500 - margin.top - margin.bottom;
+
+        // Configure the X scale to use the range of use our dataset
+        var x = d3.scale.linear()
+            .domain([0, n - 1])
+            .range([0, width]);
+
+        // Configure the Y scale
+        var y = d3.scale.linear()
+            .domain([0, 250])
+            .range([height, 0]);
+        
+        var line = d3.svg.line()
+            .x(function(d, i) { return x(i); })
+            .y(function(d, i) { return y(d); });
+        
+        var svg = d3.select("body").append("svg")
+            .attr("width", width + margin.left + margin.right)
+            .attr("height", height + margin.top + margin.bottom)
+            .append("g")
+            .attr("transform", "translate(" + margin.left + "," + margin.top + ")");
+        
+        svg.append("defs").append("clipPath")
+            .attr("id", "clip")
+            .append("rect")
+            .attr("width", width)
+            .attr("height", height);
+        
+        svg.append("g")
+            .attr("class", "x axis")
+            .attr("transform", "translate(0," + y(0) + ")")
+            .call(d3.svg.axis().scale(x).orient("bottom"));
+        
+        svg.append("g")
+            .attr("class", "y axis")
+            .call(d3.svg.axis().scale(y).orient("left"));
+        
+        var path = svg.append("g")
+            .attr("clip-path", "url(#clip)")
+            .append("path")
+            .datum(dataset)
+            .attr("class", "line")
+            .attr("d", line);
+
+        function tick(number) {
+            // Push a new data point onto the back
+            dataset.push(number);
+            // Redraw the line, and slide it to the left
+            path
+                .attr("d", line)
+                .attr("transform", null)
+                .attr("fill", "none")
+                .attr("stroke", "steelblue")
+                .attr("stroke-width", 1.5)
+                .transition()
+                .attr("transform", "translate(" + x(-1) + ",0)")
+                .each("end", null);
+            // Pop the old data point off the front
+            dataset.shift();
+        }
+    </script>
+
+    <h1>Chart D3 Example</h1>
+    <h2>Current Data</h2>
+    <p id="topic"></p>
+    <p id="x-position"></p>
+    <script src="/socket.io/socket.io.js"></script>
+
+    <script>
+      var socket = io.connect('http://127.0.0.1:7400');
+      var xPos = document.getElementById('x-position');
+      var topic = document.getElementById('topic');
+      socket.on('square', function (data) {
+        console.log('Got udpate from the server for square');
+        xPos.innerHTML = data.x
+        topic.innerHTML = "Square"
+        tick(data.x);
+      });
+      socket.on('triangle', function (data) {
+        console.log('Got udpate from the server for triangle');
+        xPos.innerHTML = data.x
+        topic.innerHTML = "Triangle"
+        tick(data.x);
+      });
+      socket.on('circle', function (data) {
+        console.log('Got udpate from the server for circle');
+        xPos.innerHTML = data.x
+        topic.innerHTML = "Circle"
+        tick(data.x);
+      });
+    </script>
+  </body>
+</html>

package/examples/nodejs/web_socket/indexMaps.html

@@ -13,7 +13,7 @@
     <!-- The line below is only needed for old environments like Internet Explorer and Android 4.x -->
     <script src="/socket.io/socket.io.js"></script>
     <script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=requestAnimationFrame,Element.prototype.classList,URL"></script>
-    <script src="https://cdn.rawgit.com/openlayers/openlayers.github.io/master/en/v6.0.1/build/ol.js"></script>
+    <script src="https://cdn.rawgit.com/openlayers/openlayers.github.io/main/dist/en/v6.0.1/build/ol.js"></script>
     <style>
       .map {
         width: 100%;

package/examples/nodejs/web_socket/reader_websocket.js

@@ -35,9 +35,19 @@ const server = http.createServer(function (req, res) {
         res.end(data, 'utf-8')
       }
     })
+  } else if (req.url === '/chart') {
+    fs.readFile(path.join(__dirname, 'indexChart.html'), (error, data) => {
+      if (error) {
+        console.log('Error: ' + error)
+        throw new Error(error)
+      } else {
+        res.writeHead(200, { 'Content-Type': 'text/html' })
+        res.end(data, 'utf-8')
+      }
+    })
   } else {
     res.writeHead(200, { 'Content-Type': 'text/html' })
-    res.write("Select your visualisation: <a href='simple'>simple</a> or <a href='maps'>maps</a>")
+    res.write("Select your visualisation: <a href='simple'>simple</a>, <a href='chart'>chart</a>  or <a href='maps'>maps</a>")
     res.end()
   }
 }).listen(7400, '127.0.0.1')
@@ -46,7 +56,7 @@ console.log('Server running at http://127.0.0.1:7400/')
 // Create the DDS entities required for this example - a reader of Triangle, Circle
 // and Square (all under the same participant).
 const connector = new rti.Connector('MyParticipantLibrary::MySubParticipant', fullpath)
-const io = socketsio.listen(server)
+const io = socketsio(server)
 // Create an array of each input which we want to receive data on, and its associated
 // topic name. We will emit the topic name from the io object.
 const inputs = [

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "rticonnextdds-connector",
-  "version": "1.0.0",
+  "version": "1.3.0",
   "description": "RTI Connector for JavaScript",
   "main": "rticonnextdds-connector.js",
-  "scripts": {
-    "test": "echo \"test\""
-  },
   "files": [
     "rticonnextdds-connector.js",
     "rticonnextdds-connector/lib",
@@ -16,10 +13,15 @@
     "url": "https://github.com/rticommunity/rticonnextdds-connector-js.git"
   },
   "dependencies": {
-    "events": "*",
-    "ffi": "*",
-    "ref": "*",
-    "sleep": "*"
+    "events": "^3.2.0",
+    "ffi-napi": "^3.1.0",
+    "ref-napi": "^3.0.1",
+    "ref-struct-di": "^1.1.1"
+  },
+  "scripts": {
+    "test": "mocha ./test/nodejs/",
+    "test-junit": "mocha ./test/nodejs/ --reporter mocha-junit-reporter",
+    "test-json": "mocha ./test/nodejs/ --reporter json --reporter-option output=test-results.json"
   },
   "keywords": [
     "rti",
@@ -35,5 +37,12 @@
   "bugs": {
     "url": "https://github.com/rticommunity/rticonnextdds-connector-js/issues"
   },
-  "homepage": "https://github.com/rticommunity/rticonnextdds-connector-js"
+  "homepage": "https://github.com/rticommunity/rticonnextdds-connector-js",
+  "devDependencies": {
+    "chai": "^4.3.4",
+    "chai-as-promised": "^7.1.1",
+    "mocha": "^10.2.0",
+    "mocha-junit-reporter": "^2.2.0",
+    "sinon": "^10.0.0"
+  }
 }