Funicular.js

Microsoft Kinect to JS communication using Python with WebSockets.

Dependencies

• Kinect Sensor v1
• OpenNI
• PyOpenNI
• Tornado
• Local webserver: eg MAMP, XAMPP

Usage

First run the Python server.py script to start the Kinect tracking and websocket server.

$ python server.py

In a HTML file, load in the funicular.js file and add the following JavaScript.

<script src="funicular.js"></script>
<script>

  /* Override Funicular functions as shown below: */

  window.Funicular = {

    // Connected to websocket server
    onSocketOpen: function() {},

    // Disconnected from websocket server
    onSocketClose: function() {},
    onSocketMessage: function() {},

    // Detected wave gesture
    // x, y, z are coordinates of gesture
    onGestureWave: function(x, y, z) {},

    // Detected click gesture
    // x, y, z are coordinates of gesture
    onGestureClick: function(x, y, z) {},

    // Hand detected, now tracking
    // hand: {id, x, y, z}
    onHandsRegister: function(hand) {},

    // Hand moved.
    // hands: [{id, x, y, z}]
    onHandsMove: function(hands) {},

    // Hand tracking lost hand, no longer tracking
    // hand: {id}
    onHandsUnregister: function(hand) {}
  };

</script>

Setting Dependencies Up

Note: Funicular.js has only been tested on OS X Yosemite running Python 2.7.6. It has been tested in Safari 8.0.2 and Google Chrome 39

1. Install OpenNI. Some instructions for the installation of this are here.
2. Next, you should install PyOpenNI. Be sure to copy the generated lib/openni.<ext> to your Python modules directory. Check it has installed sucessfully by running some of PyOpenNI demos to ensure that the Kinect sensor is communicating with Python.
3. Next, Tornado should be downloaded and installed from the website.

Getting Started

1. Clone the Funicular.js repo to your local webserver.

   git clone git@github.com:adeniszczyc/Funicular.js.git
   

2. Ensure your Kinect is plugged into USB and connected to a power source.
3. From Terminal, run the Python websocket file:

$ python server.py

4. In your browser navigate to the client demo webpage. Be sure to do this through your webserver.
5. Wave at the Kinect sensor, and you should see the hand tracking displaying the coordinates of your hand.

Future Work

• Add more gestures on top of wave and click provided by PyOpenNI. This can include swipe, pull and move.
• Better error handling and support.
• Support for hardware control such as for motor and LEDs.

Credits

• Andrew Deniszczyc - Funicular.js
• DepthJS for inspiration for this project.
• Robert Deniszczyc for the name.