Introduction

Thank you for taking interest in our AmbientHackystat project. If you are a developer and would like to install and work with our source code, please visit our DevelopersGuide wiki page. If not, please continue reading.

Downloading

Download the latest release of AmbientHackystat from our downloads page. The distribution zip file should be named something along the lines of ambientHackystat-0.1.221.zip.

Installation

Download Java 5.0 or greater

In order to run the jar file, you will need to install Java 5.0 or later and also create an environmental variable for Java. Please see the EnvironmentalVariables wiki page if you need help setting up an environmental variable.

Extract Zip File

Once downloaded, install the zip file into a directory with no spaces. For example, C:\tools is good, but C:\My Documents is bad.

Setting up the Configuration File

To set up the configuration file, go to the directory where you unzipped the file and navigate to xml\test\configuration.test.xml file. From there you need to set up the username and password for your HackyStat account.

Make sure to leave the Servers field alone for now. The next thing you need to edit is the Devices fields. Fill in this field with the information for your devices. The only thing you really need to edit is the DeviceId for the Orb which is the serial number located at the bottom of the Orb. The DeviceId for the Nabaztag Bunny which is the serial number at the bottom of the Bunny and the Token is found on the http://my.nabaztag.com site under "My Burrow" in the area called "Nabazphere."

The last thing you need to edit is the project and the Trigger/Action pairs. The picture below only has one project and one Trigger/Action pair but you can add more and the test file should have at least 5 already preinstalled. The only thing you need to edit is the ProjectName and the Owner for each project. The ProjectName must match the project name in HackyStat and the Owner must be the email of the Owner of the project so that you get any DevEvents (Development Events) that come from that project and not just a single HackyStat account.

Running the Server

Once extracted, there should be a ambienthackystat.jar file in the main installation directory. To run it, open up the command prompt and navigate to the installation directory. Invoke the jar file by running

java -jar ambienthackystat.jar [Directory of configuration xml file]

The configuration file is the file you worked on ealier. So you can invoke the jar file with:

java -jar ambienthackystat.jar xml\test\configuration.test.xml

Here is a picture of what the console should look like:

What's happening is the server is checking for the latest information from the sensorbase, and changes the state of the orb accordingly. As you can see, there are some errors but most of these are out of the hands of the user. Most of the errors you will encounter are mostly errors with your internet connection. Since the server is trying to receive data from the sensorbase, if it cannot reach the internet then there will be an error reaching the server.

Any other errors that might be displayed will usually be due to incorrect information in the configuration file. The system is still very fragile so any slight incorrectness in the configuration file will usually trigger some kind of error if not collapsing the system in general. If you do see a printStackTree, a huge amount of garbled text in the command line referring to files in the program and other Java jargon, then it's probably one of those errors.

Here is a sample of this sort of error:

Last of all, there is no graceful way to end the server (yet), so enter Ctrl + C to end it.