Skip to content
This repository has been archived by the owner on Feb 28, 2024. It is now read-only.

iloire/ducksnode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

build status

ducksnode

Node.js Ducksboard API wrapper.

Getting Started

Install the module with: npm install ducksnode

var options = {
	api_key : '#your api key#'
};

var ducksnode = require('ducksnode').create(options);

// simple push to 'my_widget'
ducksnode.push('my_widget', 324);

// pushing an object instead of a primitive value.
ducksnode.push('my_widget', {value: 324, timestamp: 1342421466862});

// push to 'my_widget' with callback
ducksnode.push('my_widget', 324, function (err, response_status){
	if (err){
		console.error(err); //error pushing to ducksboard server.
	}
});

// push to more than one widget, with callback
ducksnode.push(['my_widget1', 'my_widget2'], 324, function (err, response_status){
  //this callback will be called once for each widget
	if (err){
		console.error(err); //error pushing to ducksboard server.
	}
});

Run the tests with: npm test (requires mocha)

Examples

Look into the "examples" folder

Release History

0.1.0 Initial release

Contributions

  • mjschranz : Allow for multiple widget id's to be sent at once.

TODO

  • Pull API
  • Http Pull API
  • Websockets API
  • Dashboard API

License

Copyright (c) 2012 Iván Loire Licensed under the MIT license.

About

Ducksboard API wrapper on node.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published