EVRYTHNG-WS.JS (plugin for EVT.js)

evrythng-ws.js is an extension plugin to be used with evrythng.js or evrythng-extended.js JS libraries.

It adds WebSockets support to any resource, allowing to publish, subscribe and unsubscribe to the resource's topics easily.

evrythng-ws.js is available as a Bower package and uses bower-mqttws library as a dependency.

Installation

Browser

With Bower

bower install evrythng-ws --save

The Bower package is AMD-compatible. This means you can load it asynchronously using tools like Require.js or simply dropping the script tag into your HTML page:

<script src="bower_components/bower-mqttws/mqttws31.js"></script>
<script src="bower_components/evrythng-ws/dist/evrythng-ws.js"></script>

evrythng-ws.js depends on bower-mqttws external lib, which is installed automatically.

See Usage below for more details.

Load from CDN

Add the script tags into your HTML page:

<script src="http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.javascript.git/plain/src/mqttws31.js"></script>
<script src="//cdn.evrythng.net/toolkit/evrythng-js-sdk/evrythng-ws-1.0.3.min.js"></script>

Or always get the last release:

<script src="//cdn.evrythng.net/toolkit/evrythng-js-sdk/evrythng-ws.js"></script>
<script src="//cdn.evrythng.net/toolkit/evrythng-js-sdk/evrythng-ws.min.js"></script>

For HTTPS you need to use:

<script src="//d10ka0m22z5ju5.cloudfront.net/toolkit/evrythng-js-sdk/evrythng-ws-1.0.3.min.js"></script>
<script src="//d10ka0m22z5ju5.cloudfront.net/toolkit/evrythng-js-sdk/evrythng-ws.js"></script>
<script src="//d10ka0m22z5ju5.cloudfront.net/toolkit/evrythng-js-sdk/evrythng-ws.min.js"></script>

Usage

RequireJS (AMD)

requirejs.config({
    paths: {
        'bower-mqttws': '../bower_components/bower-mqttws/mqttws31',
        'evrythng': '../bower_components/evrythng/dist/evrythng',
        'evrythng-ws': '../bower_components/evrythng-ws/dist/evrythng-ws'
    },
    shim: {
      'bower-mqttws': {
        'exports': 'Paho'
      },
      'evrythng': ['bower-mqttws']
    }
});

require(['evrythng', 'evrythng-ws'], function (EVT, WS) {

  EVT.use(WS);
  ...

});

Globals

// The plugin is attached as EVT.WS
EVT.use(EVT.WS);
...

Examples

General

// Use different settings (below are defaults)
WS.setup({
  apiUrl: 'wss://ws.evrythng.com:443/mqtt',
  reconnectPeriod: 1000,
  keepAlive: 50,
  clientIdPrefix: 'evtjs'
});

var device = new EVT.Device(DEVICE_API_KEY);

// Subscribe to property updates on a device
device.property().subscribe(function(update){
  console.log(update);
});

// Subscribe to explicit location changes
device.location().subscribe(function(newLocation){
  console.log(newLocation);
});

// Publish
// Property updates
device.property('test').publish(123);

// Actions
device.action('scans').publish();

// Thng
device.publish({
  name: 'My new cool name'
});

// Unsubscribe to a subscribed topic
device.property().unsubscribe();


// Or using any other scope
var operator = new EVT.Operator(OPERATOR_API_KEY;

operator.product('{productId}').property().subscribe(function(update){
  console.log(update);
});

...

---

Documentation

Check all the available subscriptions on the EVRYTHNG Pubsub documentation.

Source Maps

Source Maps are available, which means that when using the minified version, if you open Developer Tools (Chrome, Safari, Firefox), .map files will be downloaded to help you debug code using the original uncompressed version of the library.

Related tools

evrythng.js

evrythng.js is the core version of evrythng.js intended to be used in public applications and/or devices.

evrythng-extended.js

evrythng-extended.js is an extended version of evrythng.js which includes Operator access to the API.

License

Apache 2.0 License, check LICENSE.txt

Copyright (c) EVRYTHNG Ltd.