ghoma - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

 {
   "name": "ghoma",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A control server for g-homa wifi plugs",
@@ -5,0 +5,0 @@ "main": "ghoma.js",

README.md

@@ -12,5 +12,7 @@ A control server for G-Homa Wifi plugs written in [node](http://nodejs.org).
 
-Usage example
--------------
+Usage examples
+--------------
 
+This example shows the callback methods provided.
+
 ```js
@@ -49,2 +51,97 @@ var ghoma = require('ghoma');
 
+The next example shows the node-ghoma library in combination with the express framework.
+```js
+/**
+ * Usage example for the ghoma control server library together with a minimal express.js application.
+ *
+ * You have to 'npm install express' before starting this example by 'node express_example.js'.
+ * A ghoma control server is started on port 4196 and a http server is started on port 3000.
+ *
+ * Now you can open your browser with these urls:
+ *
+ * http://localhost:3000/list       Displays a list of all registered ghoma wifi plugs.
+ * http://localhost:3000/allon      Switch all plugs on.
+ * http://localhost:3000/alloff     Switch all plugs off.
+ * http://localhost:3000/on/ID      Switch a plug on. Replace ID with the short mac, that can be retrieved by the 'list' call.
+ * http://localhost:3000/off/ID     Switch a plug off. Replace ID with the short mac, that can be retrieved by the 'list' call.
+ */
+var ghoma = require('./ghoma.js');
+var express = require('express');
+var app = express();
+
+// Uncomment this line to get a detailed log output
+// ghoma.log=console.log;
+
+/**
+ * List all registered plugs.
+ */
+app.get('/list', function (req, res) {
+  var plugs = [];
+  ghoma.forEach(function(plug,idx) {
+    plugs.push( {
+      id : plug.id,
+      state : plug.state,
+    });
+  });
+  res.setHeader('Content-Type', 'application/json');
+    res.send(JSON.stringify(plugs));
+});
+
+/**
+ * Switch a plug on by id
+ */
+app.get('/on/:id', function (req, res) {
+    var plug = ghoma.get(req.params.id);
+    if ( plug ) {
+      plug.on();
+      res.sendStatus(200);
+    } else {
+      res.sendStatus(404);
+    }
+});
+
+/**
+ * Switch a plug off by id
+ */
+app.get('/off/:id', function (req, res) {
+    var plug = ghoma.get(req.params.id);
+    if ( plug ) {
+      plug.off();
+      res.sendStatus(200);
+    } else {
+      res.sendStatus(404);
+    }
+});
+
+/**
+ * Switch all registered plugs on
+ */
+app.get('/allon', function (req, res) {
+  ghoma.forEach(function(plug,idx) { plug.on(); });
+  res.sendStatus(200);
+});
+
+/**
+ * Switch all registered plugs off
+ */
+app.get('/alloff', function (req, res) {
+  ghoma.forEach(function(plug,idx) { plug.off(); });
+  res.sendStatus(200);
+});
+
+// Register a listener for new plugs, this is only for a log output
+ghoma.onNew = function(plug) {
+  console.log('Registerd plug from ' + plug.remoteAddress+" with id "+plug.id);
+}
+
+// Start the ghoma control server listening server on this port
+ghoma.startServer(4196);
+
+// Start the express http server listening on port 3000
+app.listen(3000, function () {
+  console.log('ghoma express example app start listening on port 3000 for http requests.');
+});
+```
+
+
 API description
@@ -51,0 +148,0 @@ ---------------

No alert changes

Improved metrics

Total package byte prevSize

19132

increased by39.82%

Number of package files

7

increased by16.67%

Lines of code

340

increased by31.27%

Number of lines in readme file

217

increased by80.83%

No dependency changes