Skip to content

Use the wotcity.io SDK

jollen edited this page Jul 11, 2017 · 1 revision

Install

How to use wotcity.io as the application server SDK.

Step 1: Create a new Node.js project

$ mkdir mywot
$ cd mywot
$ npm init
$ npm i wotcity.io --save

Step 2: Create a simple WebSocket broker application

Create a new file named app.js for example and copy the following sample code:

var Server = require('wotcity.io').Server;
Server.WebsocketBroker.start();

APIs

Class: Server.WebsocketBroker

To start a Websocket broker server:

var Server = require('wotcity.io').Server;
Server.WebsocketBroker.start();

WebsocketBroker.start(options)

  • options <Object> Options containing response events.
    • ondata <Function> Callback function that receives client data
    • onstart <function> Callback function that notifies the success of creating the Websocket connection.

Example:

var Server = require('wotcity.io').Server;

var ondata = function(payload) {
	var obj = JSON.parse(payload.data);
	var paths = payload.pathname.split('/');
	var deviceId = paths[2];

	console.log('[', deviceId, ']', payload.data);
};

var onstart = function(payload) {
}

Server.WebsocketBroker.start({
	onstart: onstart,
	ondata: ondata
});

Class: Server.CoapBroker

To start a CoAP broker server:

var Server = require('wotcity.io').Server;
Server.CoapBroker.start();

CoapBroker.start(options)

  • options <Object> Options containing response events.
    • ondata <Function> Callback function that receives client data
    • onstart <function> Callback function that notifies the success of creating the Websocket connection.

Example:

var Server = require('wotcity.io').Server;

var ondata = function(payload) {
	var obj = JSON.parse(payload.data);
	var paths = payload.pathname.split('/');
	var deviceId = paths[2];

	console.log('[', deviceId, ']', payload.data);
};

var onstart = function(payload) {
}

Server.CoapBroker.start({
	onstart: onstart,
	ondata: ondata
});

Class: Server.WebsocketToCoapProxy

To start a Websocket-to-CoAP protocol translation server:

var Server = require('wotcity.io').Server;
Server.WebsocketToCoapProxy.start();

WebsocketToCoapProxy.start(options)

  • options <Object> Options containing response events.
    • ondata <Function> Callback function that receives client data
    • onstart <function> Callback function that notifies the success of creating the Websocket connection.

Example:

var Server = require('wotcity.io').Server;

var ondata = function(payload) {
	var obj = JSON.parse(payload.data);
	var paths = payload.pathname.split('/');
	var deviceId = paths[2];

	console.log('[', deviceId, ']', payload.data);
};

var onstart = function(payload) {
}

Server.WebsocketToCoapProxy.start({
	onstart: onstart,
	ondata: ondata
});

Class: Server.CoapToWebsocketProxy

To start a CoAP-to-Websocket protocol translation server:

var Server = require('wotcity.io').Server;
Server.CoapToWebsocketProxy.start();

CoapToWebsocketProxy.start(options)

  • options <Object> Options containing response events.
    • ondata <Function> Callback function that receives client data
    • onstart <function> Callback function that notifies the success of creating the Websocket connection.

Example:

var Server = require('wotcity.io').Server;

var ondata = function(payload) {
	var obj = JSON.parse(payload.data);
	var paths = payload.pathname.split('/');
	var deviceId = paths[2];

	console.log('[', deviceId, ']', payload.data);
};

var onstart = function(payload) {
}

Server.CoapToWebsocketProxy.start({
	onstart: onstart,
	ondata: ondata
});

REST APIs

How to use the server REST APIs: