Vernier GoIO Lightweight Grapher

Prerequisites

• git
• ruby 1.8.7, 1.9.2 or JRuby 1.5.3+
• the RubyGem: bundler

If you are using Mac OS X or Linux I recommend using rvm to install ruby 1.9.2: http://rvm.beginrescueend.com/.

I've also tested this code under JRuby 1.5.2 and Ruby 1.8.7.

Install

git clone git://github.com/stepheneb/lightweight-sensor-graphs.git
cd lightweight-sensor-graphs
bundle install
cp config/config.sample.yml config/config.yml

Start

If you want to deploy as a Java web servlet into a server like Tomcat create an executable jnlp.war

You need to use JRuby:

$ rvm jruby

$ ruby -v
jruby 1.5.3 (ruby 1.8.7 patchlevel 249) (2010-09-28 7ca06d7) (Java HotSpot(TM) 64-Bit Server VM 1.6.0_22) [x86_64-java]

Use warble to create jnlp.war:

$ warble
rm -f jnlp.war
Creating jnlp.war
$ ls -lh jnlp.war 
-rw-r--r--  1 stephen  staff    16M Nov  4 01:01 jnlp.war

The resulting jnlp.war archive can be deployed to a servlet container or be executed directly using the embedded Winstone Servlet Engine v0.9.10:

$ java -jar jnlp.war 

At this point you can open http://localhost:8080 to start using the sensor-applet system.

The default configuration uses the ./public dir as the root of content being served.

If you only want to deliver content from the ./public/jnlp directory change the :root element in config/config.yml to indicate the root path:

:root: public

If you do this and deploy the war jnlp.war to a servlet container a request to:

http://host/jnlp/org/concord/otrunk/otrunk.jar

will return the jar at this file system path:

./public/jnlp/org/concord/otrunk/otrunk.jar

Demo

1. Plugin a Vernier GoLink with an attached temperature, light probe, or motion probe.
2. Start local server. cd /path/to/lightweight-sensor-graphs ruby start_local_server.rb
3. Open: http://localhost:4321/
4. Select either: goio-temperature-graph.html, goio-light-graph.html or goio-motion-graph.html
5. Click the start button.

Deploying to a remote server

If have a remote server with Apache, install the Ruby gem passenger and follow the installation instructions:

$ gem install passenger
$ passenger-install-apache2-module

If you want to be able to develop on your local machine, push changes to github and then deploy to the remote server take a look at the comments in this script:

bin/update_server.rb

To push the master branch of http://github.com/stepheneb/lightweight-sensor-graphs to the server first copy the file bin/deploy_sample.yml to bin/deploy.yml and enter the host name and path on the remote server as well as the ssh username for the user under which the deploy will be executed.

File: bin/deploy_sample.yml

--- 
:username: username
:dir: /path/on/server
:host: server.com

Apache and Passenger configuration for remote server

See the install and serving rack application sections in the Phusion Passenger users guide.

Apache http.conf Passenger configuration example:

LoadModule passenger_module /usr/local/lib/ruby/gems/1.8/gems/passenger-2.2.15/ext/apache2/mod_passenger.so
PassengerRoot /usr/local/lib/ruby/gems/1.8/gems/passenger-2.2.15
PassengerRuby /usr/local/bin/ruby

Apache vhost example:

<VirtualHost *:80>
    ServerName jnlp.dev.concord.org
    DocumentRoot /web/jnlp.dev.concord.org/public
    <Directory /web/jnlp.dev.concord.org/public>
        Allow from all
        Options -MultiViews
    </Directory>
</VirtualHost>

Example of file system permissions on remote server:

[jnlp.dev.concord.org (master)]$ ls -l
total 44
drwxrwsr-x 2 apache    users 4096 Oct 14 00:45 bin
drwxrwsr-x 2 apache    users 4096 Oct 14 00:45 config
-rw-r--r-- 1 sbannasch users  273 Sep 22 14:10 config.ru
drwxrwsr-x 7 apache    users 4096 Oct 28 12:20 public
drwxrwsr-x 2 apache    users 4096 Sep 24 11:05 rack
-rw-r--r-- 1 sbannasch users  635 Sep 22 22:22 readme.md
-rwxr-xr-x 1 sbannasch users 1256 Oct 14 00:45 start_local_server.rb
drwxrwsr-x 2 sbannasch users 4096 Sep 10 01:28 tmp
-rw-r--r-- 1 sbannasch users 1090 Oct 14 00:45 update_jnlps.rb

Sharing a local server on a mac with bonjour/zeroconf

bin/start_bonjour.rb

Re-signing and generating pack-gzip versions of the jars.

In order to communicate with the GoLink sensor interface the jars and native libraries need to be signed.

The jars and the pack.gz jars in the github repository are signed with Concord Consortiums certificate.

If you re-compile the java code and create new jars you will need to resign the jars.

You need a valid certificate

Copy the file bin/sign_sample.yml to bin/sign.yml and enter the password and alias for the certificate you want to use.

File: bin/sign_sample.yml

--- 
:password: password
:alias: alias

To resign and recreate new pack.gz copies of the jar and native library resources:

bin/resign_jars.rb

To resign and recreate new pack.gz archives for a subset of jars or native library resource add an argument consisting of a regex.

For example this will resign and pack all the jars with 'sensor' in their name:

bin/resign_jars.rb sensor

Loading jnlps and the jars they reference from a remote maven-jnlp server.

The Ruby script: update_jnlps.rb can be used if you would like to add additional collections of jars that are referenced from a jnlp served from a maven-jnlp server.

To use this script first install the jnlp gem:

gem install jnlp

Then edit lines 19-20 in update_jnlps.rb to specify the url to the maven_jnlp server and the name of the family (or families) of jnlp to download.

19 maven_jnlps_url = "http://jnlp.concord.org/dev/org/concord/maven-jnlp"
20 families = %w{all-otrunk-snapshot}

In addition if you are downloading a jnlp with many jars this script will run much faster in JRuby. If you have installed rvm you can install and use Jruby for running this script as follows:

rvm install jruby
rvm use jruby
ruby update_jnlps.rb

Running at http://jnlp.local under Apache2 on your local Mac OS X system

Add the following entry in /etc/hosts:

127.0.0.1       jnlp.local

I recommend using Ruby 1.9.2 installed with rvm:

$ rvm install 1.9.2
$ rvm use 1.9.2
$ gem install bundler
$ gem install passenger
$ passenger-install-apache2-module
$ cd /path/to/lightweight-sensor-graphs.git
$ bundle install

Follow the instructions displayed on the screen. On my system I needed to add the following files to: /etc/apache2/httpd.conf

LoadModule passenger_module /Users/stephen/.rvm/gems/ruby-1.9.2-p180/gems/passenger-3.0.7/ext/apache2/mod_passenger.so
PassengerRoot /Users/stephen/.rvm/gems/ruby-1.9.2-p180/gems/passenger-3.0.7
PassengerRuby /Users/stephen/.rvm/wrappers/ruby-1.9.2-p180/ruby

Add the following new configuration to: /etc/apache2/extra/httpd-vhosts.conf -- edit the paths appropriately.

<VirtualHost jnlp.local:80>
    ServerName jnlp
    DocumentRoot /path/to/lightweight-sensor-graphs.git/public
    <Directory //path/to/lightweight-sensor-graphs.git/public>
        Allow from all
        Options -MultiViews
    </Directory>
</VirtualHost>

After making changes test the new apache configuration:

$ apachectl configtest

After the configuration passes these simple tests restart apache:

$ sudo apachectl restart

And open http://jnlp.local

If there are error tail the apache error log to get clues:

$ tail -n 200 -f /var/log/apache2/error_log