Merge pull request #11 from MK-2001/master

Added send Option to FS20

Author: GermanBluefox

.gitignore

@@ -1,2 +1,3 @@
 .idea
-node_modules
+node_modules
+.DS_Store

README.md

@@ -18,6 +18,12 @@ ioBroker adapter to control FS20, Max!, HMS and other devices via [CUL](http://b
 - *MORITZ* - MAX!
 - *WS* - KS300TH, S300TH, WS2000/WS7000
 
+## HowTo
+
+### Send a command to a FS20 Device in e.g. JavaScript
+```sendTo("cul.0", "send", {"protocol":"FS20", "housecode":"A1B2", "address":"01", "command":"00"});```
+
+This command uses the CUL Library of this adapter to send the command to a FS20 Device.
 
 ## Changelog
 ### 1.1.0 (2020-01-04)

admin/index.html

@@ -21,13 +21,14 @@
             "de": "CUL Adapter Einstellungen",
             "ru": "Настройки CUL Драйвера"
         },
-        "Serial port:":     {"en": "Serial port:",      "de": "Serialport:",    "ru": "Порт:"},
-        "Baud rate":        {"en": "Baud rate:",        "de": "Baud rate:",     "ru": "Скорость:"},
-        "Mode":             {"en": "Mode",              "de": "Modus:",         "ru": "Режим:"},
-        "Type:":            {"en": "Type:",             "de": "Typ:",           "ru": "Тип:"},
-        "Select port":      {"en": "Select port",       "de": "Port auswählen", "ru": "Select port"},
-        "IP/Hostname:":     {"en": "IP/Hostname:",      "de": "IP/Hostname:",   "ru": "IP/Hostname:"},
-        "Port":             {"en": "Port:",             "de": "Port:",          "ru": "Port:"}
+        "Serial port:":     {"en": "Serial port:",      "de": "Serialport:",        "ru": "Порт:"},
+        "Baud rate":        {"en": "Baud rate:",        "de": "Baud rate:",         "ru": "Скорость:"},
+        "Mode":             {"en": "Mode",              "de": "Modus:",             "ru": "Режим:"},
+        "Type:":            {"en": "Type:",             "de": "Typ:",               "ru": "Тип:"},
+        "Select port":      {"en": "Select port",       "de": "Port auswählen",     "ru": "Select port"},
+        "IP/Hostname:":     {"en": "IP/Hostname:",      "de": "IP/Hostname:",       "ru": "IP/Hostname:"},
+        "Port":             {"en": "Port:",             "de": "Port:",              "ru": "Port:"},
+        "Experimental:":    {"en": "Experimental:",     "de": "Experimentiermodus:","ru": "экспериментальный:"},
     };
 
     var timeout;
@@ -179,13 +180,16 @@
 
         <tr>
             <td><label for="ip" class="translate">IP/Hostname:</label></td>
-	    <td><input id="ip" class="value" value="127.0.0.1"></input></td>
+	        <td><input id="ip" class="value" value="127.0.0.1"></input></td>
         </tr>
-	<tr>
+	    <tr>
             <td><label for="port" class="translate">Port:</label></td>
-	    <td><input id="port" class="value" value="23"></input></td>
+	        <td><input id="port" class="value" value="23"></input></td>
+        </tr>
+        <tr>
+            <td><label for="experimental" class="translate">Experimental:</label></td>
+            <td><input id="experimental" class="value" type="checkbox" value="true" /></td>
         </tr>
-
     </table>
 
 </div>

cul.js

@@ -1,8 +1,9 @@
-/* jshint -W097 */// jshint strict:false
-/*jslint node: true */
+/* jshint -W097 */
+/* jshint strict: false */
+/* jslint node: true */
 
 'use strict';
-var Cul = process.env.DEBUG ? require(__dirname + '/lib/debugCul.js') : require('cul');
+var Cul = process.env.DEBUG ? require('./lib/debugCul.js') : require('cul');
 
 // you have to require the utils module and call adapter function
 var utils = require('@iobroker/adapter-core'); // Get common adapter utils
@@ -27,7 +28,27 @@ try {
 }
 
 adapter.on('stateChange', function (id, state) {
-    //if (cul) cul.cmd();
+    if (!state.ack) {
+        adapter.log.debug('State Change ' + JSON.stringify(id) + ', State: ' + JSON.stringify(state));
+        //  State Change "cul.0.FS20.123401.cmd" State: {"val":2,"ack":false,"ts":1581365531968,"q":0,"from":"system.adapter.admin.0","user":"system.user.admin","lc":1581365531968}
+        var oAddr = id.split('.');
+        // 0: cul; 1:0; 2:FS20; 3:123401; 4:cmd;
+        var sHousecode = oAddr[3].substring(0, 4);
+        var sAddress   = oAddr[3].substring(4, 6);
+        if (oAddr[2] === 'FS20' || adapter.config.experimental === true || adapter.config.experimental === 'true') {
+            switch (oAddr[4]) {
+                case 'cmdRaw':
+                    sendCommand({protocol: oAddr[2], housecode: sHousecode, address: sAddress, command: state.val});
+                    break;
+                    
+                deafult:
+                    adapter.log.error('Write of State ' + oAddr[4] + ' currently not implemented');
+                    break;
+            }
+        } else {
+            dapter.log.error('Only FS20 Devices are tested. Please contribute here: https://github.com/ioBroker/ioBroker.cul');
+        }
+    }
 });
 
 adapter.on('unload', function (callback) {
@@ -42,7 +63,8 @@ adapter.on('unload', function (callback) {
 });
 
 adapter.on('ready', function () {
-    adapter.setState('info.connection', false, false);
+    adapter.setState('info.connection', false, true);
+    
     checkPort(function (err) {
         if (!err || process.env.DEBUG) {
             main();
@@ -68,25 +90,44 @@ adapter.on('message', function (obj) {
                         adapter.sendTo(obj.from, obj.command, [{comName: 'Not available'}], obj.callback);
                     }
                 }
-
+                break;
+                
+            case 'send':
+                sendCommand({protocol: obj.message.protocol, housecode: obj.message.housecode, address: obj.message.address, command: obj.message.command});
+                break;
+                
+            default:
+                adapter.log.error('No such command: ' + obj.command);
                 break;
         }
     }
 });
 
+/***
+ * Send a command to the cul module
+ * @param {obj.message.protocol, obj.message.housecode, obj.message.address, obj.message.command} 
+ */
+function sendCommand(o) {
+    adapter.log.info('Send command received. Housecode: ' + o.housecode + '; address: ' + o.address + '; command: ' + o.command);
+    cul.cmd(o.protocol, o.housecode, o.address, o.command);
+}
+
 function checkConnection(host, port, timeout, callback) {
         timeout = timeout || 10000; //default 10 seconds
+    
         var timer = setTimeout(function() {
             socket.end();
-            callback("Timeout");
+            callback('Timeout');
             callback = null;
         }, timeout);
+    
         var socket = Net.createConnection(port, host, function() {
             clearTimeout(timer);
             socket.end();
             callback(null);
             callback = null;
         });
+    
         socket.on('error', function(err) {
             clearTimeout(timer);
             socket.end();
@@ -98,12 +139,12 @@ function checkConnection(host, port, timeout, callback) {
 function checkPort(callback) {
     if (adapter.config.type === 'cuno') {
         checkConnection(adapter.config.ip, adapter.config.port, 10000, function(err) {
-            if (callback) callback(err);
+            callback && callback(err);
             callback = null;
         });
     } else {
         if (!adapter.config.serialport) {
-            if (callback) callback('Port is not selected');
+            callback && callback('Port is not selected');
             return;
         }
         var sPort;
@@ -114,24 +155,23 @@ function checkPort(callback) {
             });
             sPort.on('error', function (err) {
                 if (sPort.isOpen) sPort.close();
-                if (callback) callback(err);
+                callback && callback(err);
                 callback = null;
             });
 
             sPort.open(function (err) {
-                if (sPort.isOpen) sPort.close();
-
-                if (callback) callback(err);
+                sPort.isOpen && sPort.close();
+                callback && callback(err);
                 callback = null;
             });
         } catch (e) {
             adapter.log.error('Cannot open port: ' + e);
             try {
-                if (sPort.isOpen) sPort.close();
+                sPort.isOpen && sPort.close();
             } catch (ee) {
 
             }
-            if (callback) callback(e);
+            callback && callback(e);
         }
     }
 }
@@ -141,6 +181,7 @@ var tasks = [];
 function processTasks() {
     if (tasks.length) {
         var task = tasks.shift();
+        
         if (task.type === 'state') {
             adapter.setForeignState(task.id, task.val, true, function () {
                 setTimeout(processTasks, 0);
@@ -178,7 +219,9 @@ function setStates(obj) {
     var isStart = !tasks.length;
 
     for (var state in obj.data) {
-        if (!obj.data.hasOwnProperty(state)) continue;
+        if (!obj.data.hasOwnProperty(state)) {
+            continue;
+        }
         var oid  = adapter.namespace + '.' + id + '.' + state;
         var meta = objects[oid];
         var val  = obj.data[state];
@@ -193,7 +236,7 @@ function setStates(obj) {
         }
         tasks.push({type: 'state', id: oid, val: val});
     }
-    if (isStart) processTasks();
+    isStart && processTasks();
 }
 
 function connect() {
@@ -207,7 +250,7 @@ function connect() {
         host:       adapter.config.ip,
         port:       adapter.config.port,
         debug:      true,
-        logger:     adapter.log.info
+        logger:     adapter.log.debug
     };
 
     cul = new Cul(options);
@@ -276,22 +319,16 @@ function connect() {
         }
 
         setStates(obj);
-        if (isStart) processTasks();
+        isStart && processTasks();
     });
 
 }
 
-function insertObjects(objs, cb) {
-    if (objs && objs.length) {
-        var newObject = objs.pop();
-
-    } else if (cb) {
-        cb();
-    }
-}
-
 function main() {
-
+    
+    // in this template all states changes inside the adapters namespace are subscribed
+    adapter.subscribeStates('*');
+    
     adapter.getForeignObject('cul.meta.roles', function (err, res) {
         metaRoles = res.native;
         adapter.getObjectView('system', 'device', {startkey: adapter.namespace + '.', endkey: adapter.namespace + '.\u9999'}, function (err, res) {

io-package.json

@@ -1,8 +1,20 @@
 {
     "common": {
         "name": "cul",
-        "version": "1.1.0",
+        "version": "1.1.1",
         "news": {
+            "1.1.1": {
+			  "en": "Sending of FS20 cmdRAW possible or via sendTo as described in the readme.",
+			  "de": "Senden von FS20 cmdRAW möglich oder über sendTo wie in der Readme beschrieben.",
+			  "ru": "Отправка FS20 cmdRAW возможна или через sendTo, как описано в файле readme.",
+			  "pt": "É possível enviar FS20 cmdRAW ou via sendTo, conforme descrito no leia-me.",
+			  "nl": "Verzenden van FS20 cmdRAW mogelijk of via sendTo zoals beschreven in de readme.",
+			  "fr": "Envoi de FS20 cmdRAW possible ou via sendTo comme décrit dans le readme.",
+			  "it": "Invio di cmdRAW FS20 possibile o tramite sendTo come descritto nel file Leggimi.",
+			  "es": "Se puede enviar FS20 cmdRAW o mediante sendTo como se describe en el archivo Léame.",
+			  "pl": "Wysyłanie FS20 cmdRAW jest możliwe lub poprzez sendTo zgodnie z opisem w pliku Readme.",
+			  "zh-cn": "可以发送FS20 cmdRAW，也可以按照自述文件中的说明发送sendTo。"
+			},
             "1.1.0": {
                 "en": "removed usage of adapter.objects",
                 "de": "Verwendung von adapter.objects entfernt",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.cul",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Javascript/Node.js based Busware CUL USB / culfw adapter",
   "author": "hobbyquaker <hq@ccu.io>",
   "contributors": [