Initializing project

Author: kenny-y

.eslintrc.json

@@ -0,0 +1,29 @@
+{
+  "extends": "google",
+  "parserOptions": {
+    "ecmaVersion": 6
+  },
+  "plugins": [
+    "header"
+  ],
+  "rules": {
+    "header/header": [2, "config/header.js"],
+    "max-len": ["error",
+      // Following Google Javascript 100 char line limit
+      100,
+      // Use 2-space as tab width
+      2,
+      { "ignoreUrls": true }
+    ],
+    // Prefer to use single quotes
+    "quotes": ["error", "single"],
+    // Disable JSDoc
+    "require-jsdoc": ["error", {
+      "require": {
+        "FunctionDeclaration": false,
+        "MethodDefinition": false,
+        "ClassDeclaration": false
+      }
+    }]
+  }
+}

.gitignore

@@ -0,0 +1,18 @@
+*~
+.DS_Store
+.*.sw?
+*.gypcmd
+*.mk
+*.pyc
+*.tar.gz
+*.log
+build
+cscope.*
+gen
+node_modules
+npm-debug.log
+src/common/tests/data
+tags
+tools/.boto_config.json
+tools/.no_password.expect
+tools/.docker

.jshintrc

@@ -0,0 +1,4 @@
+{
+  "esversion": 6,
+  "node": true
+}

.travis.yml

@@ -0,0 +1,33 @@
+language: node_js
+
+node_js:
+  - "4"
+
+sudo: required
+
+services:
+  # Travis CI does not support Ubuntu 16.04, so we use docker to match RealSense requirement.
+  - docker
+
+branches:
+  only:
+  - master
+
+before_install:
+  # Run linter
+  - git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git && export PATH=$PATH:$(pwd)/depot_tools
+  - cd tools && npm install && cd ..
+  - python ./tools/node_modules/widl-nan/tools/lint.py
+
+  # Pull container
+  - sudo docker pull ubuntu:16.04
+
+  # Install dependencies described as Dockerfile
+  - sudo mkdir ./tools/.docker
+  - sudo cat ./tools/Dockerfile.template | sed 's/<your_username>/mrbuild/g' | sed 's/<your_git_name>/Mr. Build/g' | sed 's/<your_git_email>/[email protected]/g' > /tmp/Dockerfile
+  - sudo cp /tmp/Dockerfile ./tools/.docker/Dockerfile
+  - sudo cp ./tools/install_realsense_pkgs.sh ./tools/.docker/
+  - sudo docker build -t realsense ./tools/.docker
+
+script:
+  - sudo docker run -v $(pwd):/home/mrbuild/node-realsense --rm realsense bash -c "sudo -H -u mrbuild /home/mrbuild/node-realsense/tools/try_build_realsense_js.sh"

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Intel Corporation. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# Intel® RealSense™ technology with JavaScript API for Linux OS
+
+[![Build Status](https://travis-ci.com/otcshare/node-realsense.svg?token=R4frH5duwqgLFqkCuqbn&branch=master)](https://travis-ci.com/otcshare/node-realsense)
+
+[ ![License] [license-image] ] [license]
+
+[license-image]: https://img.shields.io/github/license/mashape/apistatus.svg?style=flat
+[license]: LICENSE
+
+This project is offering Node.js modules of [Intel® RealSense™ technology](http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-overview.html) including Person Tracaking, Object Recognization, and SLAM capabilities. The target is [Intel® Joule™](https://software.intel.com/en-us/iot/hardware/joule) and ZR300 camera on top of Ubuntu 16.04 DT.
+
+## Documents
+
+  * [Spec](./doc/spec) - Javascript specification document. (TODO)
+  * [Get Started](./doc/get_started.md) - A guide how to setup environment and run samples.
+  * [Contribution](./doc/contribution.md) - A guide how to contribute code.
+  * [BKMs](./doc/bkms.md) - Best known methods.
+
+## License
+The MIT License (MIT)
+
+Copyright (c) 2016 Intel Corporation. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

config/header.js

@@ -0,0 +1,3 @@
+// Copyright (c) 2016 Intel Corporation. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.

doc/bkms.md

@@ -0,0 +1,99 @@
+## BKMs
+
+* Oh my god somebody please help node-gyp build takes too long time it compiles almost all C++ files every time somebody please help me out...
+
+  Use the below shell script to build (with extra benefits)
+
+    ```
+    # Workaround of node-gyp build issue
+    target=`ls build/*.mk`
+    alter=`ls build/*.mk`".new"
+    sed 's/widl\ FORCE_DO_CMD/widl/' -r $target > $alter
+    cp -f $alter $target
+  
+    # Build current add-on
+    node-gyp build
+    
+    # Lint tool -- Make your code great again by making lint happy again
+    if [ $? -eq 0 ]; then
+    	# Save current dir
+    	saved=`pwd`
+    
+    	cd ../../ && python tools/node_modules/widl-nan/tools/lint.py --base=master
+    
+    	# Test: to do, or not to do
+    	if [ $# -gt 0 ] && [ $1 == "test" ]; then
+    		cd $saved && mocha
+    	else
+    		echo "Note: to run test, type '$0 test'"
+    	fi
+    fi
+    ```
+
+* How to debug node addon
+```
+node-gyp rebuild --debug
+gdb --args `which node` sample.js
+// In gdb
+gdb> b main
+gdb> r
+gdb> b [SOME_FUNCTION_NAME/LINE_NUMBER]
+gdb> c
+gdb> l
+gdb> s/n
+```
+
+* How to debug mocha
+
+```
+    >gdb --args `which node` `which mocha`
+```
+
+*  ZR300 can't work on Ubuntu
+ * Install udev rules
+```
+sudo cp config/99-realsense-libusb.rules /etc/udev/rules.d/
+sudo udevadm control --reload-rules
+sudo udevadm trigger
+```
+ * Above steps should be automatically executed if install librealsense via [PPA](https://code.launchpad.net/~halton-huo/+junk/librealsense).
+
+* Can't connect to camera again if previous run crashed.
+ * Current solution: disconnect and reconnect camera from/to your system.
+* Crash occurs when addon is running smoothly, and then can't connect to RealSense camera again in a restart
+ * The solution: disconnect the camera and then reconnect
+
+Error message of the 1st crash:
+```
+terminate called after throwing an instance of 'std::runtime_error'
+  what():  VIDIOC_DQBUF error 19, No such device
+Aborted (core dumped)
+```
+
+Error message of later failure to connect:
+
+```
+terminate called after throwing an instance of 'rs::error'
+  what():  UVCIOC_CTRL_QUERY:UVC_SET_CUR error 5, Input/output error
+Aborted (core dumped)
+```
+ 
+* If you use add-on directly and has forgotten to inherit from `Node.js` `EventEmitter`, you'll hit the following error (or the like)
+```
+/usr/bin/nodejs[24777]: ../src/node.cc:1345:v8::Local<v8::Value> node::MakeCallback(node::Environment*, v8::Local<v8::Object>, v8::Local<v8::String>, int, v8::Local<v8::Value>*): Assertion `cb_v->IsFunction()' failed.
+ 1: node::Abort() [node]
+ 2: node::Assert(char const* const (*) [4]) [node]
+ 3: node::MakeCallback(v8::Isolate*, v8::Local<v8::Object>, char const*, int, v8::Local<v8::Value>*) [node]
+ 4: FutureMakeCallback::TimerCallback(unsigned long) [/home/yunfei/00_yunfei/github/node-realsense/src/object-recognition/build/Release/realsense_object_recognition.node]
+ 5: WIDLNANTimer::TimerCallbackProc(uv_timer_s*) [/home/yunfei/00_yunfei/github/node-realsense/src/object-recognition/build/Release/realsense_object_recognition.node]
+ 6: 0x13774f5 [node]
+ 7: uv_run [node]
+ 8: node::Start(int, char**) [node]
+ 9: __libc_start_main [/lib/x86_64-linux-gnu/libc.so.6]
+10: _start [node]
+Aborted (core dumped)
+```
+Solution: to inherit from `EventEmitter` or to `require` the `Node.js` wrapper module
+
+* `sudo snap login <your_email>` failed
+Edit your `http_proxy`, https_proxy` to /etc/environment, then `sudo service snapd restart`

doc/contribution.md

@@ -0,0 +1,36 @@
+# Contribution
+Go to [Setup Environment](./setup_environment.md) first to ensure all your hardware and software are ready.
+
+## Coding style guideline
+We're following [Chromium coding style](https://chromium.googlesource.com/chromium/src/+/master/styleguide/styleguide.md) for different languages: [C++](https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md), [Python](https://google.github.io/styleguide/pyguide.html) and [JavaScript](https://google.github.io/styleguide/javascriptguide.xml).
+
+### Install tools
+* [depot_tools](https://www.chromium.org/developers/how-tos/install-depot-tools) need to be installed and added to `PATH` env.
+* Re-use [widl-nan](http://github.com/01org/widl-nan) linter tool
+```
+cd src/tools && npm install
+```
+
+### Run tests
+* Prepare the playback files by running `./src/common/tests/fetch_tests_data.sh <playback_url>`
+
+### Run linter
+Run `python ./tools/node_modules/widl-nan/tools/lint.py` before submitting your code.
+
+## Commit message guideline
+We use same [Chromium commit log guideline](https://www.chromium.org/developers/contributing-code) and [Github closing isses via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/). Use the following form:
+
+```
+Summary of change.
+
+Longer description of change addressing as appropriate: why the change is made,
+context if it is part of many changes, description of previous behavior and
+newly introduced differences, etc.
+
+Long lines should be wrapped to 80 columns for easier log message viewing in
+terminals.
+
+Fixes #123456
+```
+
+## If you need release a build, follow [How to Release](./howto_release.md)

doc/get_started.md

@@ -0,0 +1,24 @@
+# Get Started
+Go to [Setup Environment](./setup_environment.md) first to ensure all your hardware and software are ready.
+
+## For non-display usage
+* Init project
+```
+npm init
+```
+* Install Node.JS modules (Take PT for eg)
+```
+npm install --save person-tracking
+```
+Note: Use below steps instead before we officially register on https://www.npmjs.com
+```
+git clone ssh://[email protected]/otcshare/node-realsense ~/node-realsense
+cd ~/node-realsense/src/person-tracking
+npm run-script maketarball
+cd <your_project_path>
+npm install --save ~/node-realsense/src/person-tracking/*.tar.gz
+```
+
+### Code time (TODO)
+
+## For display usage (TODO)

doc/howto_release.md

@@ -0,0 +1,49 @@
+# How to release a node-realsense build
+Go to [Setup Environment](./setup_environment.md) first to ensure all your hardware and software are ready.
+
+## Preparation
+1. Follow [Generating an SSH key](https://help.github.com/articles/generating-an-ssh-key/) and add this SSH key to your github account. If you ever did that, please bypass this step.
+2. Get push permission for this repo. (Because we need bump the patch version automatically)
+3. Setup the night build archive server, typically HTTP server running on that. Apply an user account with permission to write to the www directory.
+4. Add your ssh key (on step 1) to archive server, follow [Adding SSH Keys to authorized_keys](http://askubuntu.com/questions/46424/adding-ssh-keys-to-authorized-keys). This step ensure you can push code and upload to archive server w/o password.
+
+## Customize
+1. clone this code via SSH way, `git clone [email protected]:otcshare/node-realsense.git`. Otherwise, unable to automatically push commit.
+2. Copy `tools/.boto_config.json.template` to `tools/.boto_config.json` and change the value
+```
+  "archive_server": {
+    "host": "<your_archive_server>",
+    "nightly_dir": "", # The directory of nightly build
+    "official_dir": "", # The directory of official build
+    "usergroup": "", # group on archive server
+    "username": "" # username on archive server
+  },
+  "build_type": "nightly", # Support nightly or official type
+  "bump_version": true, # Whether to bump version
+  "tarball_only": false, # Only make tarball, no install and test
+  "upload_build": true # Whether to upload build to server
+```
+3. Copy `tools/.no_password.expect.template` to `tools/.no_password.expect` and change the right value. NOTE, please keep this file carefully because it contains your passpharse to unlock the SSH key (step1).
+4. Install required packages `sudo apt-get install expect`
+
+## Run Build
+### Nightly
+Ensure `build_type` is ***nightly*** in `tools/.boto_config.json` and execute `tools/build_realsense_js.sh`. Some hints:
+
+* Add it to cronjob via `crontab -e`. For example (run every day at 10pm):
+```
+0 22 * * * cd $HOME/nightly/node-realsense/tools/build_realsense_js.sh
+```
+* `bump_version` is normally set as ***true*** to automatic bump the patch version.
+* `tarball_only` can be set as ***false*** to allow npm install and test run.
+* `upload_build` is mostly ***true***.
+
+## Official
+Ensure `build_type` is ***official*** in `tools/.boto_config.json` and execute `tools/build_realsense_js.sh <version>`. Some hints:
+
+* `bump_version` is ***true*** will auto make tagging and push commit. If you want to the bump commit review by pull request, set `bump_version` as ***false***, then you need follow normal PR review process.
+* `tarball_only` can be set as ***true*** to save time.
+* `upload_build` is mostly ***true***.
+
+## Check build
+There will be `node_realsense-<date>.log` after each run. The tarball of each module and log file will eventually uploaded to the archive server. And the latest link will always point the latest nightly build.

doc/images/state/Makefile

@@ -0,0 +1,8 @@
+pngs :	object-recognition-state.png person-tracking-state.png slam-state.png
+
+object-recognition-state.png : object-recognition-state.dot
+	dot object-recognition-state.dot -Tpng -oobject-recognition-state.png
+person-tracking-state.png : person-tracking-state.dot
+	dot person-tracking-state.dot -Tpng -operson-tracking-state.png
+slam-state.png : slam-state.dot
+	dot slam-state.dot -Tpng -oslam-state.png

doc/images/state/object-recognition-state.dot

@@ -0,0 +1,18 @@
+digraph G {
+  "ready" -> "running" [label="start(), restart()"];
+  "ready" -> "errored" [label="Oops"];
+  "ready" -> "ready" [label="reset()"];
+
+  "running" -> "running" [label="restart()"];
+  "running" -> "ready" [label="reset()"];
+  "running" -> "paused" [label="pause()"];
+  "running" -> "errored" [label="Oops"];
+
+  "paused" -> "ready" [label="reset()"];
+  "paused" -> "running" [label="resume(), restart()"];
+  "paused" -> "errored" [label="Oops"];
+
+  "errored" -> "ready" [label="reset()"];
+  "errored" -> "errored" [label="Oops"];
+  "errored" -> "running" [label="restart()"];
+}