Updating to jadonk

.travis.yml

@@ -1,11 +1,9 @@
+sudo: required
 language: node_js
-dist: trusty
 node_js:
-   - "0.10"
-   - "0.12"
-   - "4"
    - "6"
-   - "7"
+   - "8"
+   - "10"
 after_script:
   - npm run-script coveralls
 notifications:

README.md

@@ -23,37 +23,30 @@ and to further provide support for rapidly creating GUIs for your embedded
 applications through the use of HTML5/JavaScript web pages.
 
 
-Installation
-------------
-BoneScript comes installed on your BeagleBone. To update
-to the latest revision or install it on another distribution, use 'npm':
-
+Global Installation
+-------------------
+BoneScript comes installed on your BeagleBone. To update to the latest revision, use 'npm'
+on a recent BeagleBoard.org Debian image from https://beagleboard.org/latest-images
+and perform:
 ````sh
-TERM=none npm install -g bonescript
+TERM=none sudo npm cache clear
+TERM=none sudo npm install -g --prefix /usr/local --unsafe-perm bonescript
+sudo shutdown -r now
 ````
 
-Angstrom prerequisites:
-````sh
-opkg update
-opkg install python-misc python-modules
-````
-
-Debian and Ubuntu prerequisites:
-* Credit to http://learn.adafruit.com/introduction-to-the-beaglebone-black-device-tree/compiling-an-overlay
-````sh
-sudo apt-get install -y build-essential g++ python-setuptools python2.7-dev
-wget -c https://raw.github.com/RobertCNelson/tools/master/pkgs/dtc.sh
-chmod +x dtc.sh
-./dtc.sh
-````
+Testing on other distributions is limited.
 
-Some steps to consider:
+There are some additional installation steps that can be performed, but are typically
+installed by other mechanisms on the BeagleBoard.org Debian images. These setup
+background services (bone101 webserver with bonescript RPC and bonescript autorun
+service) as well as configure environment variables for these services and other
+globally run scripts.
 ````sh
-cp bonescript/etc/default/node /etc/default/node
-cp bonescript/etc/profile.d/node.sh /etc/profile.d/node.sh
-cp bonescript/systemd/\* /lib/systemd/system
-systemctl enable bonescript.socket
-systemctl enable bonescript-autorun.service
+sudo cp bonescript/etc/default/node /etc/default/node
+sudo cp bonescript/etc/profile.d/node.sh /etc/profile.d/node.sh
+sudo cp bonescript/systemd/\* /lib/systemd/system
+sudo systemctl enable bonescript.socket
+sudo systemctl enable bonescript-autorun.service
 ````
 
 Launching applications persistently
@@ -83,7 +76,7 @@ Directory layout
 
 Template
 ========
-For a Bonescript application, you must currently manually 'require' the
+For a BoneScript application, you must currently manually 'require' the
 bonescript library.  Functions are then referenced through the object
 provided back from require.
 
@@ -159,6 +152,19 @@ Uses https://github.com/korevec/node-i2c
 * i2cReadBytes(port, command, length, [callback])
 * i2cStream(port, command, length, [callback])
 
+Robot Control
+-------------
+__new in 0.7.0__ Runs on BeagleBone Blue; or BeagleBone Black or BeagleBone Black Wireless with BeagleBoard.org Robotics Cape
+* rcInitialize([callback])
+* rcState([state], [callback]) -> state
+* rcLED(led, [value], [callback]) -> value
+* rcOn(event, [callback])
+* rcMotor(motor, value, [callback])
+* rcServo(option, value, [callback])
+* rcBMP([option], [callback]) -> value
+* rcIMU([option], [callback]) -> value
+* rcEncoder(encoder, [value], [callback]) -> value
+
 Bits/Bytes, Math, Trigonometry and Random Numbers
 -------------------------------------------------
 * lowByte(value)
@@ -210,6 +216,16 @@ that respond to events in the system.  What makes JavaScript so much easier
 than other languages for doing this is that it keeps the full context around
 the handler, so you don't have to worry about it.
 
+What's New
+==========
+
+0.7.0 key updates
+-----------------
+Most of these fixes came from a [Google Summer of Code 2018 project](https://github.com/vaishnav98/bone101/wiki/BeagleBoard-GSoC'18:-Fixing-Bugs-in-BoneScript-and-Improving-BeagleBone-User-Interface)
+* Fixes in PWM output during analogWrite updates
+* Added function calls for Robot Control library support on BeagleBone Blue or Robotics Cape
+* Added support for node-style callbacks with error and data separated (optional)
+
 Plans
 =====
 * SPI support

autorun.js

@@ -2,4 +2,4 @@ var b = require('bonescript');
 
 var directory = (process.env.AUTORUN_DIR) ? process.env.AUTORUN_DIR : '/var/lib/cloud9/autorun';
 
-b.autorun(directory);
+b.autorun(directory);

lint-config.json

@@ -0,0 +1,23 @@
+{
+    "indent_size": 4,
+    "indent_char": " ",
+    "indent_with_tabs": false,
+    "eol": "\n",
+    "end_with_newline": false,
+    "indent_level": 0,
+    "preserve_newlines": true,
+    "max_preserve_newlines": 10,
+    "space_in_paren": false,
+    "space_in_empty_paren": false,
+    "jslint_happy": true,
+    "space_after_anon_function": false,
+    "brace_style": "collapse",
+    "unindent_chained_methods": false,
+    "break_chained_methods": false,
+    "keep_array_indentation": false,
+    "unescape_strings": false,
+    "wrap_line_length": 0,
+    "e4x": false,
+    "comma_first": false,
+    "operator_position": "before-newline"
+}

main.js

@@ -1,3 +1,3 @@
-module.exports = process.env.BONESCRIPT_COV
-  ? require('./src-cov/index')
-  : require('./src/index');
+module.exports = process.env.BONESCRIPT_COV ?
+    require('./src-cov/index') :
+    require('./src/index');

package.json

@@ -15,39 +15,47 @@
     "gpio",
     "arduino"
   ],
-  "version": "0.6.1",
+  "version": "0.7.1",
   "homepage": "http://beagleboard.org/bonescript",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git://github.com/jadonk/bonescript"
   },
   "main": "main",
+  "types": "./src/index.d.ts",
   "engines": {
-    "node": ">= 0.12.1"
+    "node": ">= 6.0.0"
   },
   "dependencies": {
+    "chokidar": "2.0.3",
+    "express": "4.13.4",
     "socket.io": "1.4.5",
-    "systemd": "0.2.6",
+    "systemd": "0.3.1",
     "winston": "2.1.1",
-    "express": "4.13.4",
-    "ffi": "2.0.0"
+    "@types/verror": "latest",
+    "shelljs": "0.8.2"
   },
   "optionalDependencies": {
-    "serialport": "3.1.2",
+    "serialport": "6.0.5",
+    "@types/serialport": "latest",
     "i2c": "0.2.3",
     "epoll": "0.1.18",
-    "pi-spi": "1.0.1",
-    "roboticscape": "0.0.2"
+    "pi-spi": "1.0.2",
+    "roboticscape": "0.0.8",
+    "ffi": "2.2.0"
   },
   "devDependencies": {
-    "jscoverage": "~0.5.1",
-    "nodeunit": "~0.9.0",
-    "coveralls": "~2.10.0"
+    "coveralls": "~3.0.1",
+    "js-beautify": "^1.7.5",
+    "jscoverage": "~0.6.0",
+    "nodeunit": "^0.11.2",
+    "socket.io-client": "1.4.5"
   },
   "scripts": {
     "start": "node server.js",
     "test": "NODE_PATH=.. nodeunit test",
+    "beautify": "NODE_PATH=.. js-beautify --config lint-config.json -r -f *.js src/*.js test/*.js",
     "coveralls": "NODE_PATH=.. jscoverage src && NODE_PATH=.. BONESCRIPT_COV=1 nodeunit --reporter=lcov test | coveralls"
   }
 }

server.js

@@ -1,21 +1,38 @@
 var b = require('bonescript');
 var util = require('util');
+var fs = require('fs');
+var configFile = '/etc/default/bonescript';
+var server;
+//read the configuration from configFile
+fs.readFile(configFile, {
+    encoding: 'ascii'
+}, function read(err, data) {
+    if (err) {
+        server = b.serverStart(); //start server with default settings
+    } else {
+        data = JSON.parse(data); //start server with saved config
+        server = b.serverStart(data.port, data.directory, {
+            data: data.passphrase,
+            hash: data.hash
+        });
+    }
+    onServerStart();
+});
 
-var server = b.serverStart();
-
-server.on('server$listening', serverListening);
-server.on('server$error', serverError);
-server.on('server$connection', serverConnection);
+function onServerStart() {
+    server.on('server$listening', serverListening);
+    server.on('server$error', serverError);
+    server.on('server$connection', serverConnection);
+}
 
 function serverListening() {
-    if(debug) winston.debug('Server listening');
+    if (debug) winston.debug('Server listening');
 }
 
 function serverError(error) {
-    if(debug) winston.debug('Server error: ' + JSON.stringify(error));
+    if (debug) winston.debug('Server error: ' + JSON.stringify(error));
 }
 
 function serverConnection(connection) {
-    if(debug) winston.debug('Server connection: ' + connection);
-}
-
+    if (debug) winston.debug('Server connection: ' + connection);
+}