Freeboard
/
plugins
mirror of https://github.com/Freeboard/plugins.git
1
0
Fork 0
Code Issues Releases Wiki Activity
plugins/datasources/plugin_nodejs_sample
History
Hugo Sequeira 2b17965f01 Datasources can subscribe to multiple events. 2014-07-08 17:16:55 +02:00
..
LICENSE Sample project contained whitin a new folder. 2014-06-27 10:43:25 +02:00
README.md Readme files updated. 2014-07-02 10:45:04 +02:00
plugin_node_sample_client.html Datasources can subscribe to multiple events. 2014-07-08 17:16:55 +02:00
plugin_node_sample_config.json Freeaboard.io source files removed from the sample project. 2014-07-02 10:36:53 +02:00
plugin_node_sample_screenshot.png Freeaboard.io source files removed from the sample project. 2014-07-02 10:36:53 +02:00
plugin_node_sample_server.js Sample project contained whitin a new folder. 2014-06-27 10:43:25 +02:00

README.md

freeboard.io-node.js

This is a datasource plugin to connect freeboard.io dashboards to real-time node.js servers.

  • Subscribe to real-time events using WebSockets (Sockets.io)
  • Listen for events from different servers
  • Restrict events from only certain namespaces or rooms

Installation

  1. Place the file /datasources/plugin_node.js in yours freeboard.io plugins folder (freeboard-master/js/freeboard/plugins).

  2. Edit your freeboard.io main HTML file and add the plugin to the header:

<script type="text/javascript">
	head.js(
			...
			"js/freeboard/plugins/plugin_node.js",

Testing

  1. Follow the steps of the installation section to place the /datasources/plugin_node.js file in yours freeboard.io plugins folder (freeboard-master/js/freeboard/plugins).

  2. You can run the sample node.js server (located at /datasources/plugin_nodejs_sample/plugin_node_sample_server.js) with this command:

node plugin_node_sample_server.js
  1. Place and open the sample freeboard.io dashboard (located at /datasources/plugin_nodejs_sample/plugin_node_sample_client.html) in yours freeboard.io root folder (freeboard-master/).

Requirements

To run the sample server make sure you have following dependencies installed:

  1. Node.js

  2. Socket.io

Screenshots

In this screenshot, you can see the sample server and dashboard running with multiple clients receiving data in real-time.

Image

License

MIT