v1.0 Merge to master

Dev > Master v1

Author: basvanrooten

.gitignore

@@ -0,0 +1,100 @@
+
+# Created by https://www.gitignore.io/api/node,visualstudiocode
+# Edit at https://www.gitignore.io/?templates=node,visualstudiocode
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+#DynamoDB Local files
+.dynamodb/
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+
+# End of https://www.gitignore.io/api/node,visualstudiocode
+
+# Plug state for Home Assistant
+states/

README.md

@@ -1,2 +1,35 @@
-# hwl-api
-Home Wizard Lite DIY API RESTFUL API
+# Home Wizard Lite RESTFUL Proxy API (Node.JS)
+HomeWizard Lite Proxy API, built for integrating cheap HomeWizard Lite smartplugs into [Home Assistant](https://www.home-assistant.io/) for example, freeing the user from the dreadful HWL Android or iOS app.
+
+## Installation
+
+    $ git clone https://github.com/basvanrooten/hwl-api
+    $ npm install
+    $ npm start
+    $ node index.js
+
+The API depends on environment variables for authentication with HomeWizard API.
+
+| Key | Value |
+|--|--|
+| HWL_USERNAME | HomeWizard Lite App Username |
+| HWL_PASSWORD | HomeWizard Lite App Password |
+| LOGLEVEL | [Tracer Logger Level](https://github.com/baryon/tracer#customize-output-format)  (default trace) |
+
+## Deploying
+The API should be deployed on a local network, because it has no built-in authentication. It is always possible to protect the API with HTTP Basic Auth and make it accessible over the internet, but take note of the insecurities of HTTP Basic Auth.
+
+The API could also be deployed in a docker container
+
+## Requests
+|Method | URL | Description |
+| -- | -- | -- |
+| GET | /api/test/session | Returns valid session key (Only necessary for testing)* |
+| GET | /api/test/communication | Returns status 200 when API can connect to Google Test API to verify internet connectivity |
+| -- | -- | -- |
+| GET | /api/plug | Returns all registered plugs |
+| GET | /api/act/smartplug/:smartPlugID/plug/:plugID | Returns `true` or `false` for is_active state of a plug specified by plugID |
+| POST | /api/act/smartplug/:smartPlugID/plug/:plugID | Switches plug when request body contains `"action": "on"` or `"action": "off"`. Returns is_active state.
+
+## Contribution
+This project was started by an IT-student as a small 2 day project to improve home-automation by enabling Home Assistant to control HomeWizard Lite plugs. Development will continue when I need more features. Contribution is appreciated.

app.js

@@ -0,0 +1,41 @@
+// Node dependencies
+const express = require('express');
+const cors = require('cors');
+const bodyParser = require('body-parser');
+const morgan = require("morgan");
+const config = require('./config/config');
+const logger = require('./config/config').logger
+
+// Import models
+const ApiResponse = require('./models/ApiResponse');
+
+// Import routes
+const test_routes = require('./routes/test_routes');
+const plug_routes = require('./routes/plug_routes');
+
+const app = express();
+
+// Parse the request body to JSON
+app.use(bodyParser.json());
+
+// Setup Morgan as Logger
+app.use(morgan("dev"));
+
+// Enable CORS-support
+app.use(cors());
+
+app.get('/', function(req, res, next) {
+    res.status(200).send(new ApiResponse("Hello World!", 202));
+});
+
+app.use('/api', test_routes);
+app.use('/api', plug_routes);
+
+
+
+//This endpoint is called when no other one was found, and throws a 404 error
+app.use('*', function(req, res, next){
+    res.status(404).send(new ApiResponse("This endpoint doesnt't exist", 404));
+});
+
+module.exports = app;

auth/authentication_manager.js

@@ -0,0 +1,56 @@
+const logger = require('../config/config').logger
+const config = require('../config/config');
+var sha1 = require('sha1');
+const axios = require('axios');
+
+module.exports = {
+
+    // Get Session Key from HomeWizard Lite
+    getSessionKey() {
+
+        // Get Username and Password from config file
+        let username = config.hwlUsername;
+        let password = sha1(config.hwlPassword);
+        logger.debug(username);
+        logger.debug(password);
+
+        // Login to HWL using user credentials
+        return axios({
+                method: 'get',
+                url: 'https://cloud.homewizard.com/account/login',
+                auth: {
+                    username: username,
+                    password: password
+                }
+            })
+            .then(response => {
+
+                // Check status
+                if (response.data.status === "ok") {
+
+                    // Authentication passed, returning session token
+                    logger.debug(response.data.session);
+                    return response.data.session;
+
+                } else if (response.data.status === "failed" && response.data.error === 110) {
+
+                    // Authentication failed, returning FAILED
+                    logger.error("HWL returned invalid credentials! Check credentials for validity!")
+                    logger.debug(response.data);
+                    return "ERROR";
+
+                } else {
+
+                    // Authentication failed, but with unknown reason
+                    logger.error("HWL returned unknown authentication error. ERROR :", response.data);
+                    return "ERROR";
+                }
+            })
+            .catch(e => {
+                // Cannot communicate with HWL, returning error
+                logger.error("Failed to communicate with HWL! ERROR: ", e.message);
+                return "ERROR";
+            });
+    }
+
+}

captain-definition

@@ -0,0 +1,4 @@
+{
+    "schemaVersion": 2,
+    "templateId": "node/8.7.0"
+}

config/config.js

@@ -0,0 +1,28 @@
+// Set debug level for tracer
+const loglevel = process.env.LOGLEVEL || 'trace'
+
+module.exports = {
+
+    // Web port where the server will listen to
+    "webPort": process.env.PORT || 3000,
+    "authKey": process.env.AUTHKEY || "",
+
+    // Authentication for Homewizard Lite API
+    "hwlUsername": process.env.HWL_USERNAME || "",
+    "hwlPassword": process.env.HWL_PASSWORD || "",
+
+
+    // Tracer for logging purposes
+    logger: require('tracer')
+    .console({
+        format: [
+            "{{timestamp}} <{{title}}> {{file}}:{{line}} : {{message}}"
+        ],
+        preprocess: function (data) {
+            data.title = data.title.toUpperCase();
+        },
+        dateformat: "isoUtcDateTime",
+        level: loglevel
+    })
+
+}