Woopsa

This is the node.js Woopsa module. To find out more about Woopsa and get the C# / Embedded C or jQuery implementation, go to http://www.woopsa.org!

Woopsa is a protocol that's simple, lightweight, free, open-source, web and object-oriented, publish-subscribe, real-time capable and Industry 4.0 ready. It contributes to the revolution of the Internet of Things.

Woopsa allows you to share the complete object model of your application in a way that's similar to OPC-UA. It's based on rock-solid foundations such as HTTP and JSON, which makes it work on the web out-of-the-box. Our mission is to get Woopsa on as many platforms as possible. Today, C# and JavaScript implementations exist, but there are much more to come!

As a node module, Woopsa is very useful if you wish to quickly create a RESTful API.

On the server-side, just give Woopsa any JavaScript object with properties and functions, and the library will create a RESTful API allowing you to read/write properties and call functions, automagically!

var woopsa = require('woopsa');
var weatherStation = {
    Temperature: 24.2,
    IsRaining: false,
    Sensitivity: 0.5,
    Altitude: 430,
    City: "Geneva",
    Time: new Date(),
    GetWeatherAtDate: function (date){
        var date = new Date(date);
        if ( date.getDay() === 1 ) // monday?
            return "rainy";
        else
            return "sunny";
    },
    Thermostat: {
        SetPoint: 24.0
    }
}
var server = new woopsa.Server(weatherStation, {port: 80});

To give it a test, just go on http://{ip-of-your-server}/woopsa/read/Temperature and see the magic! Woopsa is fully RESTful which means you can easily test it with your browser. It publishes your entire object's structure, and you can see all the data it publishes by going on http://{ip-of-your-server}/woopsa/meta/ .

On the client-side, just get the Woopsa jQuery/browser library on http://www.woopsa.org and you can immediately work with your object:

var woopsa = new WoopsaClient("http://{ip-of-your-server}/woopsa", jQuery);
woopsa.read("/Temperature", function(result){
//result = 24.2
});
woopsa.invoke("/GetWeatherAtDate", {date: new Date(2016,0,1)}, function(result){
//result = sunny (jan. 1st of 2016 was not a monday)
} 

Woopsa uses expressjs in the background, which means it can easily plug itself into your already existing server. We have a very detailed "Getting Started" guide here which explains how to do just that.

Getting started

Our Getting Started tutorial allows you to get started quickly with Woopsa. It's really easy and we promise you'll be convinced!