@wiotp/sdk 0.4.2 → 0.6.2

package/src/device/DeviceConfig.js

@@ -1,176 +1,176 @@
-/**
- *****************************************************************************
- Copyright (c) 2019 IBM Corporation and other Contributors.
- All rights reserved. This program and the accompanying materials
- are made available under the terms of the Eclipse Public License v1.0
- which accompanies this distribution, and is available at
- http://www.eclipse.org/legal/epl-v10.html
- *****************************************************************************
- *
- */
-import { default as BaseConfig } from '../BaseConfig';
-import log from 'loglevel';
-const YAML = require('yaml');
-const fs = require('fs');
-
-
-export default class DeviceConfig extends BaseConfig{
-    constructor(identity, auth, options) {
-        super(identity, auth, options);
-
-        //Validate the arguments
-        if (this.identity == null) {
-            throw new Error("Missing identity from configuration");
-        }
-        if (!("orgId" in this.identity) || this.identity.orgId == null) {
-            throw new Error("Missing identity.orgId from configuration");
-        }
-        if (!("typeId" in this.identity) || this.identity == null) {
-            throw new Error("Missing identity.typeId from configuration");
-        }
-        if (!("deviceId" in this.identity) || this.identity.deviceId == null) {
-            throw new Error("Missing identity.deviceId from configuration");
-        }
-
-        // Authentication is not supported for quickstart
-        if (this.identity.orgId == "quickstart") {
-            if (this.auth != null) {
-                throw new Error("Quickstart service does not support device authentication");
-            }
-        } else {
-            if (this.auth == null) {
-                throw new Error("Missing auth from configuration");
-            }
-            if (!("token" in this.auth) || this.auth.token == null) {
-                throw new Error("Missing auth.token from configuration");
-            }
-        }
-
-    }
-
-    getOrgId() {
-        return this.identity.orgId;
-    }
-
-    getClientId() {
-        return "d:" + this.identity.orgId + ":" + this.identity.typeId + ":" + this.identity.deviceId;
-    }
-
-    getMqttUsername() {
-        return "use-token-auth";
-    }
-    getMqttPassword() {
-        return this.auth.token;
-    }
-
-    static parseEnvVars() {
-        
-        //Identity
-        let orgId = process.env.WIOTP_IDENTITY_ORGID || null;
-        let typeId = process.env.WIOTP_IDENTITY_TYPEID || null;
-        let deviceId = process.env.WIOTP_IDENTITY_DEVICEID || null;
-
-        // Auth
-        let authToken = process.env.WIOTP_AUTH_TOKEN || null;
-    
-        // Also support WIOTP_API_TOKEN usage
-        if (authToken == null) {
-            authToken = process.env.WIOTP_API_TOKEN || null;
-        }
-
-        // Options
-        let domain = process.env.WIOTP_OPTIONS_DOMAIN || null;
-        let logLevel = process.env.WIOTP_OPTIONS_LOGLEVEL || "info";
-        let port = process.env.WIOTP_OPTIONS_MQTT_PORT || null;
-        let transport = process.env.WIOTP_OPTIONS_MQTT_TRANSPORT || null;
-        let caFile = process.env.WIOTP_OPTIONS_MQTT_CAFILE || null;
-        let cleanStart = process.env.WIOTP_OPTIONS_MQTT_CLEANSTART || "true";
-        let sessionExpiry = process.env.WIOTP_OPTIONS_MQTT_SESSIONEXPIRY || 3600;
-        let keepAlive = process.env.WIOTP_OPTIONS_MQTT_KEEPALIVE || 60;
-        let sharedSubs = process.env.WIOTP_OPTIONS_MQTT_SHAREDSUBSCRIPTION || "false";
-    
-        // String to int conversions
-        if (port != null) {
-            port = parseInt(port);
-        }
-        sessionExpiry = parseInt(sessionExpiry);
-        keepAlive = parseInt(keepAlive)
-    
-        let identity = {orgId:orgId, typeId: typeId, deviceId:deviceId};
-        let options = {
-            domain: domain,
-            logLevel: logLevel,
-            mqtt: {
-                port: port,
-                transport: transport,
-                cleanStart: (["True", "true", "1"].includes(cleanStart)),
-                sessionExpiry: sessionExpiry,
-                keepAlive: keepAlive,
-                sharedSubscription: (["True", "true", "1"].includes(sharedSubs)),
-                caFile: caFile,
-            },
-        };
-        let auth = null;
-        // Quickstart doesn't support auth, so ensure we only add this if it's defined
-        if (authToken != null) {
-            auth = {token: authToken};
-        }
-
-        return new DeviceConfig(identity, auth, options);
-    }
-
-    static parseConfigFile(configFilePath) {
-
-        //Example Device Configuration File:
-
-        /*
-        identity:
-            orgId: org1id
-            typeId: raspberry-pi-3
-            deviceId: 00ef08ac05
-        auth:
-             token: Ab$76s)asj8_s5
-        options:
-            domain: internetofthings.ibmcloud.com
-            logLevel: error|warning|info|debug
-            mqtt:
-                port: 8883
-                transport: tcp
-                cleanStart: true
-                sessionExpiry: 3600
-                keepAlive: 60
-                caFile: /path/to/certificateAuthorityFile.pem
-        */  
-
-        const configFile = fs.readFileSync(configFilePath, 'utf8');
-        var data = YAML.parse(configFile);
-      
-        
-        if(!fs.existsSync(configFilePath)) {
-            throw new Error("File not found");
-        }else
-        {try {
-            const configFile = fs.readFileSync(configFilePath, 'utf8');
-            var data = YAML.parse(configFile);
-        } catch (err) {
-            throw new Error("Error reading device configuration file: " + err.code);
-          }
-        }
-        
-
-        if (("options" in data) & ("logLevel" in data["options"]))
-        {
-            var validLevels = ["error", "warning", "info", "debug"];
-            if (!(validLevels.includes(data["options"]["logLevel"])))
-            {
-                throw new Error("Optional setting options.logLevel must be one of error, warning, info, debug" + data["options"]["logLevel"])
-            }
-        }
-        else
-        {
-            data["options"]["logLevel"] = log.GetLogger(data["options"]["logLevel"].toUpperCase());
-        }
-
-        return new DeviceConfig(data['identity'],data['auth'],data['options'])
-    }
+/**
+ *****************************************************************************
+ Copyright (c) 2019 IBM Corporation and other Contributors.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ *****************************************************************************
+ *
+ */
+import { default as BaseConfig } from '../BaseConfig';
+import log from 'loglevel';
+const YAML = require('yaml');
+const fs = require('fs');
+
+
+export default class DeviceConfig extends BaseConfig{
+    constructor(identity, auth, options) {
+        super(identity, auth, options);
+
+        //Validate the arguments
+        if (this.identity == null) {
+            throw new Error("Missing identity from configuration");
+        }
+        if (!("orgId" in this.identity) || this.identity.orgId == null) {
+            throw new Error("Missing identity.orgId from configuration");
+        }
+        if (!("typeId" in this.identity) || this.identity.typeId == null) {
+            throw new Error("Missing identity.typeId from configuration");
+        }
+        if (!("deviceId" in this.identity) || this.identity.deviceId == null) {
+            throw new Error("Missing identity.deviceId from configuration");
+        }
+
+        // Authentication is not supported for quickstart
+        if (this.identity.orgId == "quickstart") {
+            if (this.auth != null) {
+                throw new Error("Quickstart service does not support device authentication");
+            }
+        } else {
+            if (this.auth == null) {
+                throw new Error("Missing auth from configuration");
+            }
+            if (!("token" in this.auth) || this.auth.token == null) {
+                throw new Error("Missing auth.token from configuration");
+            }
+        }
+
+    }
+
+    getOrgId() {
+        return this.identity.orgId;
+    }
+
+    getClientId() {
+        return "d:" + this.identity.orgId + ":" + this.identity.typeId + ":" + this.identity.deviceId;
+    }
+
+    getMqttUsername() {
+        return "use-token-auth";
+    }
+    getMqttPassword() {
+        return this.auth.token;
+    }
+
+    static parseEnvVars() {
+        
+        //Identity
+        let orgId = process.env.WIOTP_IDENTITY_ORGID || null;
+        let typeId = process.env.WIOTP_IDENTITY_TYPEID || null;
+        let deviceId = process.env.WIOTP_IDENTITY_DEVICEID || null;
+
+        // Auth
+        let authToken = process.env.WIOTP_AUTH_TOKEN || null;
+    
+        // Also support WIOTP_API_TOKEN usage
+        if (authToken == null) {
+            authToken = process.env.WIOTP_API_TOKEN || null;
+        }
+
+        // Options
+        let domain = process.env.WIOTP_OPTIONS_DOMAIN || null;
+        let logLevel = process.env.WIOTP_OPTIONS_LOGLEVEL || "info";
+        let port = process.env.WIOTP_OPTIONS_MQTT_PORT || null;
+        let transport = process.env.WIOTP_OPTIONS_MQTT_TRANSPORT || null;
+        let caFile = process.env.WIOTP_OPTIONS_MQTT_CAFILE || null;
+        let cleanStart = process.env.WIOTP_OPTIONS_MQTT_CLEANSTART || "true";
+        let sessionExpiry = process.env.WIOTP_OPTIONS_MQTT_SESSIONEXPIRY || 3600;
+        let keepAlive = process.env.WIOTP_OPTIONS_MQTT_KEEPALIVE || 60;
+        let sharedSubs = process.env.WIOTP_OPTIONS_MQTT_SHAREDSUBSCRIPTION || "false";
+    
+        // String to int conversions
+        if (port != null) {
+            port = parseInt(port);
+        }
+        sessionExpiry = parseInt(sessionExpiry);
+        keepAlive = parseInt(keepAlive)
+    
+        let identity = {orgId:orgId, typeId: typeId, deviceId:deviceId};
+        let options = {
+            domain: domain,
+            logLevel: logLevel,
+            mqtt: {
+                port: port,
+                transport: transport,
+                cleanStart: (["True", "true", "1"].includes(cleanStart)),
+                sessionExpiry: sessionExpiry,
+                keepAlive: keepAlive,
+                sharedSubscription: (["True", "true", "1"].includes(sharedSubs)),
+                caFile: caFile,
+            },
+        };
+        let auth = null;
+        // Quickstart doesn't support auth, so ensure we only add this if it's defined
+        if (authToken != null) {
+            auth = {token: authToken};
+        }
+
+        return new DeviceConfig(identity, auth, options);
+    }
+
+    static parseConfigFile(configFilePath) {
+
+        //Example Device Configuration File:
+
+        /*
+        identity:
+            orgId: org1id
+            typeId: raspberry-pi-3
+            deviceId: 00ef08ac05
+        auth:
+             token: Ab$76s)asj8_s5
+        options:
+            domain: internetofthings.ibmcloud.com
+            logLevel: error|warning|info|debug
+            mqtt:
+                port: 8883
+                transport: tcp
+                cleanStart: true
+                sessionExpiry: 3600
+                keepAlive: 60
+                caFile: /path/to/certificateAuthorityFile.pem
+        */  
+
+        const configFile = fs.readFileSync(configFilePath, 'utf8');
+        var data = YAML.parse(configFile);
+      
+        
+        if(!fs.existsSync(configFilePath)) {
+            throw new Error("File not found");
+        }else
+        {try {
+            const configFile = fs.readFileSync(configFilePath, 'utf8');
+            var data = YAML.parse(configFile);
+        } catch (err) {
+            throw new Error("Error reading device configuration file: " + err.code);
+          }
+        }
+        
+
+        if (("options" in data) & ("logLevel" in data["options"]))
+        {
+            var validLevels = ["error", "warning", "info", "debug"];
+            if (!(validLevels.includes(data["options"]["logLevel"])))
+            {
+                throw new Error("Optional setting options.logLevel (Currently: " + data["options"]["logLevel"] + ") must be one of error, warning, info, debug")
+            }
+        }
+        else
+        {
+            data["options"]["logLevel"] = log.GetLogger(data["options"]["logLevel"].toUpperCase());
+        }
+
+        return new DeviceConfig(data['identity'],data['auth'],data['options'])
+    }
 }

package/src/device/index.js

@@ -1,14 +1,14 @@
-/**
- *****************************************************************************
- Copyright (c) 2019 IBM Corporation and other Contributors.
- All rights reserved. This program and the accompanying materials
- are made available under the terms of the Eclipse Public License v1.0
- which accompanies this distribution, and is available at
- http://www.eclipse.org/legal/epl-v10.html
- *****************************************************************************
- *
- */
-
-export { default as DeviceClient } from './DeviceClient';
-export { default as DeviceConfig } from './DeviceConfig';
-
+/**
+ *****************************************************************************
+ Copyright (c) 2019 IBM Corporation and other Contributors.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ *****************************************************************************
+ *
+ */
+
+export { default as DeviceClient } from './DeviceClient';
+export { default as DeviceConfig } from './DeviceConfig';
+

package/src/gateway/GatewayClient.js

@@ -1,114 +1,114 @@
-/**
- *****************************************************************************
- Copyright (c) 2014, 2019 IBM Corporation and other Contributors.
- All rights reserved. This program and the accompanying materials
- are made available under the terms of the Eclipse Public License v1.0
- which accompanies this distribution, and is available at
- http://www.eclipse.org/legal/epl-v10.html
- *****************************************************************************
- *
- */
-import { default as BaseClient } from '../BaseClient';
-import { default as GatewayConfig } from './GatewayConfig';
-
-const CMD_RE = /^iot-2\/type\/(.+)\/id\/(.+)\/cmd\/(.+)\/fmt\/(.+)$/;
-
-const util = require('util');
-
-export default class GatewayClient extends BaseClient {
-
-  constructor(config){
-    if (!config instanceof GatewayConfig) {
-      throw new Error("Config must be an instance of GatewayConfig");
-    }
-    if (config.isQuickstart()) {
-      throw new Error('[GatewayClient:constructor] Quickstart not supported in Gateways');
-    }
-    super(config);
-
-    this.log.debug("[GatewayClient:constructor] GatewayClient initialized for " + config.getClientId());
-  }
-
-
-  connect(){
-    super.connect();
-
-    this.mqtt.on('connect', () => {
-      // This gateway client implemention does not automatically subscribe to any commands!?
-    });
-
-    this.mqtt.on('message', (topic, payload) => {
-      this.log.debug("[GatewayClient:onMessage] Message received on topic : "+ topic + " with payload : "+ payload);
-
-      let match = CMD_RE.exec(topic);
-      if(match){
-        this.emit('command', match[1], match[2], match[3], match[4], payload, topic);
-      }
-    });
-  }
-
-
-  publishEvent(eventId, format, payload, qos, callback){
-    return this._publishEvent(this.config.identity.typeId, this.config.identity.deviceId, eventId, format, payload, qos, callback);
-  }
-
-
-  publishDeviceEvent(typeid, deviceId, eventid, format, payload, qos, callback){
-    return this._publishEvent(typeId, deviceId, eventid, format, payload, qos, callback);
-  }
-
-
-  _publishEvent(typeId, deviceId, eventId, format, data, qos, callback){
-    let topic = util.format("iot-2/type/%s/id/%s/evt/%s/fmt/%s", typeId, deviceId, eventId, format);
-    qos = qos || 0;
-    this._publish(topic, data, qos, callback);
-    return this;
-  }
-
-
-  subscribeToDeviceCommands(typeId, deviceId, commandId, format, qos, callback){
-    typeId = typeId || '+';
-    deviceId = deviceId || '+';
-    commandId = commandid || '+';
-    format = format || '+';
-    qos = qos || 0;
-
-    let topic = "iot-2/type/" + typeId + "/id/" + deviceId + "/cmd/"+ commandId + "/fmt/" + format;
-    this._subscribe(topic,qos, callback);
-    return this;
-  }
-
-
-  unsubscribeFromDeviceCommands(typeId, deviceId, commandId, format, callback){
-    typeId = typeId || '+';
-    deviceId = deviceId || '+';
-    commandId = commandId || '+';
-    format = format || '+';
-
-    let topic = "iot-2/type/" + typeId + "/id/" + deviceId + "/cmd/"+ commandId + "/fmt/" + format;
-    this._unsubscribe(topic, callback);
-    return this;
-  }
-
-
-  subscribeToCommands(commandId, format, qos, callback){
-    commandId = commandId || '+';
-    format = format || '+';
-    qos = qos || 0;
-
-    let topic = "iot-2/type/" + this.config.identity.typeId + "/id/" + this.config.identity.deviceId + "/cmd/"+ commandId + "/fmt/" + format;
-    this._subscribe(topic, qos, callback);
-    return this;
-  }
-
-
-  unsubscribeFromCommands(commandId, format, callback){
-    commandId = commandId || '+';
-    format = format || '+';
-
-    let topic = "iot-2/type/" + this.config.identity.typeId + "/id/" + this.config.identity.deviceId + "/cmd/"+ commandId + "/fmt/" + format;
-    this._unsubscribe(topic, callback);
-    return this;
-  }
-
-}
+/**
+ *****************************************************************************
+ Copyright (c) 2014, 2019 IBM Corporation and other Contributors.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ *****************************************************************************
+ *
+ */
+import { default as BaseClient } from '../BaseClient';
+import { default as GatewayConfig } from './GatewayConfig';
+
+const CMD_RE = /^iot-2\/type\/(.+)\/id\/(.+)\/cmd\/(.+)\/fmt\/(.+)$/;
+
+const util = require('util');
+
+export default class GatewayClient extends BaseClient {
+
+  constructor(config){
+    if (!config instanceof GatewayConfig) {
+      throw new Error("Config must be an instance of GatewayConfig");
+    }
+    if (config.isQuickstart()) {
+      throw new Error('[GatewayClient:constructor] Quickstart not supported in Gateways');
+    }
+    super(config);
+
+    this.log.debug("[GatewayClient:constructor] GatewayClient initialized for " + config.getClientId());
+  }
+
+
+  connect(){
+    super.connect();
+
+    this.mqtt.on('connect', () => {
+      // This gateway client implemention does not automatically subscribe to any commands!?
+    });
+
+    this.mqtt.on('message', (topic, payload) => {
+      this.log.debug("[GatewayClient:onMessage] Message received on topic : "+ topic + " with payload : "+ payload);
+
+      let match = CMD_RE.exec(topic);
+      if(match){
+        this.emit('command', match[1], match[2], match[3], match[4], payload, topic);
+      }
+    });
+  }
+
+
+  publishEvent(eventId, format, payload, qos, callback){
+    return this._publishEvent(this.config.identity.typeId, this.config.identity.deviceId, eventId, format, payload, qos, callback);
+  }
+
+
+  publishDeviceEvent(typeid, deviceId, eventid, format, payload, qos, callback){
+    return this._publishEvent(typeId, deviceId, eventid, format, payload, qos, callback);
+  }
+
+
+  _publishEvent(typeId, deviceId, eventId, format, data, qos, callback){
+    let topic = util.format("iot-2/type/%s/id/%s/evt/%s/fmt/%s", typeId, deviceId, eventId, format);
+    qos = qos || 0;
+    this._publish(topic, data, qos, callback);
+    return this;
+  }
+
+
+  subscribeToDeviceCommands(typeId, deviceId, commandId, format, qos, callback){
+    typeId = typeId || '+';
+    deviceId = deviceId || '+';
+    commandId = commandid || '+';
+    format = format || '+';
+    qos = qos || 0;
+
+    let topic = "iot-2/type/" + typeId + "/id/" + deviceId + "/cmd/"+ commandId + "/fmt/" + format;
+    this._subscribe(topic,qos, callback);
+    return this;
+  }
+
+
+  unsubscribeFromDeviceCommands(typeId, deviceId, commandId, format, callback){
+    typeId = typeId || '+';
+    deviceId = deviceId || '+';
+    commandId = commandId || '+';
+    format = format || '+';
+
+    let topic = "iot-2/type/" + typeId + "/id/" + deviceId + "/cmd/"+ commandId + "/fmt/" + format;
+    this._unsubscribe(topic, callback);
+    return this;
+  }
+
+
+  subscribeToCommands(commandId, format, qos, callback){
+    commandId = commandId || '+';
+    format = format || '+';
+    qos = qos || 0;
+
+    let topic = "iot-2/type/" + this.config.identity.typeId + "/id/" + this.config.identity.deviceId + "/cmd/"+ commandId + "/fmt/" + format;
+    this._subscribe(topic, qos, callback);
+    return this;
+  }
+
+
+  unsubscribeFromCommands(commandId, format, callback){
+    commandId = commandId || '+';
+    format = format || '+';
+
+    let topic = "iot-2/type/" + this.config.identity.typeId + "/id/" + this.config.identity.deviceId + "/cmd/"+ commandId + "/fmt/" + format;
+    this._unsubscribe(topic, callback);
+    return this;
+  }
+
+}

package/src/gateway/GatewayConfig.js

@@ -1,22 +1,22 @@
-/**
- *****************************************************************************
- Copyright (c) 2019 IBM Corporation and other Contributors.
- All rights reserved. This program and the accompanying materials
- are made available under the terms of the Eclipse Public License v1.0
- which accompanies this distribution, and is available at
- http://www.eclipse.org/legal/epl-v10.html
- *****************************************************************************
- *
- */
-import { default as DeviceConfig } from '../device/DeviceConfig';
-
-export default class GatewayConfig extends DeviceConfig{
-    constructor(identity, auth, options) {
-        super(identity, auth, options);
-    }
-
-    getClientId() {
-        return "g:" + this.identity.orgId + ":" + this.identity.typeId + ":" + this.identity.deviceId;
-    }
-
+/**
+ *****************************************************************************
+ Copyright (c) 2019 IBM Corporation and other Contributors.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ *****************************************************************************
+ *
+ */
+import { default as DeviceConfig } from '../device/DeviceConfig';
+
+export default class GatewayConfig extends DeviceConfig{
+    constructor(identity, auth, options) {
+        super(identity, auth, options);
+    }
+
+    getClientId() {
+        return "g:" + this.identity.orgId + ":" + this.identity.typeId + ":" + this.identity.deviceId;
+    }
+
 };