sinricpro 2.2.5 → 2.3.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,32 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - run: npm ci 
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -1,191 +1,15 @@
-# SinricPro (NodeJs-SDK)
-
-[![](https://img.shields.io/npm/v/sinricpro)](https://www.npmjs.com/package/sinricpro)
-[![](https://img.shields.io/npm/dependency-version/sinricpro/dev/eslint)](https://www.npmjs.com/package/sinricpro)
-[![](https://img.shields.io/bundlephobia/min/sinricpro)](https://www.npmjs.com/package/sinricpro)
-[![](https://img.shields.io/github/languages/code-size/sinricpro/nodejs-sdk)](https://www.npmjs.com/package/sinricpro)
-
-### Installation
-
-```
-npm install sinricpro
-```
-
-### Dependencies
-
-- [websockets](https://www.npmjs.com/package/ws)
-
-- [crypto](https://nodejs.org/api/crypto.html)
-
-- [uuid](https://www.npmjs.com/package/uuid)
-
-- [dgram]()
-
-- [rxjs](https://www.npmjs.com/package/rxjs)
-
-### Basic example
-
-```javascript 1.8
-const {
-  SinricPro,
-  SinricProActions,
-  raiseEvent,
-  eventNames,
-  SinricProUdp
-} = require("../index"); // Use require('sinricpro'); if you are using NPM
-
-const appKey = ""; // d89f1***-****-****-****-************
-const secretKey = ""; // f44d1d31-1c19-****-****-9bc96c34b5bb-d19f42dd-****-****-****-************
-const device1 = ""; // 5d7e7d96069e275ea9******
-const device2 = ""; // 5d80ac5713fa175e99******
-const deviceId = [device1, device2];
-
-function setPowerState(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-const callbacks = {
-  setPowerState
-};
-
-const sinricpro = new SinricPro(appKey, deviceId, secretKey, true);
-
-SinricProActions(sinricpro, callbacks);
-
-setInterval(() => {
-  raiseEvent(sinricpro, eventNames.powerState, device1, { state: "On" });
-}, 2000);
-
-// https://github.com/sinricpro/nodejs-sdk/blob/master/examples/simple-example/simple-example.js
-```
-
-### Advanced example
-
-#### Add a credential file into your root folder (credential.js)
-
-```javascript 1.8
-const credential = {
-  appkey: "",
-  secretKey: ""
-};
-
-const deviceIds = {
-  deviceId1: "",
-  deviceId2: "",
-  deviceId3: ""
-};
-
-// No need to edit the code below
-
-let deviceIdT = [];
-
-for (let key in deviceIds) {
-  if (deviceIds.hasOwnProperty(key)) {
-    deviceIdT.push(deviceIds[key]);
-  }
-}
-
-module.exports = {
-  appKey: credential.appkey,
-  secretKey: credential.secretKey,
-  deviceId: deviceIdT
-};
-```
-
-#### Example (app.js)
-
-```javascript
-const { appKey, deviceId, secretKey } = require("../credentials");
-const {
-  SinricPro,
-  SinricProActions,
-  raiseEvent,
-  eventNames,
-  SinricProUdp
-} = require("../index");
-
-function setPowerState(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-function setPowerLevel(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function adjustPowerLevel(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setColor(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setRangeValue(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-function setLockState(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setBrightness(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setVolume(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function adjustVolume(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setMute(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-const callbacks = {
-  setPowerState,
-  setPowerLevel,
-  adjustPowerLevel,
-  setColor,
-  setRangeValue,
-  setLockState,
-  setBrightness,
-  setVolume,
-  adjustVolume,
-  setMute
-};
-
-const sinricpro = new SinricPro(appKey, deviceId, secretKey, true);
-SinricProActions(sinricpro, callbacks);
-
-setInterval(() => {
-  // raiseEvent(sinricpro, eventNames.powerState, 'deviceId', { state: 'On' });
-  // raiseEvent(sinricpro, eventNames.setBrightness, 'deviceId', { brightness: 44 });
-  // raiseEvent(sinricpro, eventNames.powerLevel, 'deviceId', { powerLevel: 44 });
-  // raiseEvent(sinricpro, eventNames.color, 'DeviceId', { color: { b: 0, g: 0, r: 0 } });
-  // raiseEvent(sinricpro, eventNames.colorTemperature, 'Deviceid', { colorTemperature: 8 });
-  // raiseEvent(sinricpro, eventNames.doorBell, 'DeviceId', { state: 'pressed' });
-  // raiseEvent(sinricpro, eventNames.thermostatMode, 'DeviceId', { thermostatMode: 'AUTO' });
-  // raiseEvent(sinricpro, eventNames.rangvalue, 'DeviceId', { rangvalue: 3 });
-  // raiseEvent(sinricpro, eventNames.motion, 'DeviceId', { state: 'detected' });
-  // raiseEvent(sinricpro, eventNames.contact, 'DeviceId', { state: 'closed' });
-  // raiseEvent(sinricpro, eventNames.setVolume, 'DeviceId', { volume: 29 });
-  // raiseEvent(sinricpro, eventNames.selectInput, 'DeviceId', { input: 'HDMI' });
-  // raiseEvent(sinricpro, eventNames.media, 'DeviceId', { control: 'FastForward' });
-  // raiseEvent(sinricpro, eventNames.channel, 'DeviceId', { channel: { name: 'HBO' } });
-  // raiseEvent(sinricpro, eventNames.mode, 'DeviceId', { mode: 'MOVIE' });
-  // raiseEvent(sinricpro, eventNames.lock, 'DeviceId', { state: 'LOCKED' });
-  // raiseEvent(sinricpro, eventNames.mute, 'DeviceId', { mute: true });
-}, 2000);
-```
+# SinricPro (NodeJs-SDK)
+
+[![](https://img.shields.io/npm/v/sinricpro)](https://www.npmjs.com/package/sinricpro)
+[![](https://img.shields.io/npm/dependency-version/sinricpro/dev/eslint)](https://www.npmjs.com/package/sinricpro)
+[![](https://img.shields.io/bundlephobia/min/sinricpro)](https://www.npmjs.com/package/sinricpro)
+[![](https://img.shields.io/github/languages/code-size/sinricpro/nodejs-sdk)](https://www.npmjs.com/package/sinricpro)
+
+### Installation
+
+```
+npm install sinricpro
+```
+
+### Examples
+Check the examples [here](https://github.com/sinricpro/nodejs-sdk/tree/master/examples) 

package/lib/cbhandler.js

@@ -10,10 +10,10 @@ const { powerState, powerLevel, powerLevelAdjust } = require('./contorllers/powe
 const { Brightness, BrightnessAdjust } = require('./contorllers/brightness_controller');
 const { Color } = require('./contorllers/color_controller');
 const { ColorTemperature } = require('./contorllers/color_temperature');
-const { ThermoStatMode, Lock } = require('./contorllers/sensors_controller');
+const { ThermoStatMode, ThermoStatTemperature, Lock } = require('./contorllers/sensors_controller');
 const { RangeValue, RangeValueAdjust } = require('./contorllers/range_value_controller');
 const { Volume, VolumeAdjust, Mute } = require('./contorllers/tv_controller');
-const { ChangeChannel, SkipChannel, Media, } = require('./contorllers/tv_controller');
+const { ChangeChannel, SkipChannel, Media } = require('./contorllers/tv_controller');
 const { Input } = require('./contorllers/tv_controller');
 const { Bands, Mode, BandReset } = require('./contorllers/speaker_controller');
 const { AdjustBands } = require('./contorllers/speaker_controller');
@@ -87,13 +87,18 @@ const handlePayload = (client, payload, signature, callbacks) => verifySignature
         .catch((err) => {
           console.log(err.message);
         });
-    }
-    else if (action === 'setThermostatMode') {
+    } else if (action === 'setThermostatMode') {
       return ThermoStatMode(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
           console.log(err.message);
         });
+    } else if (action === 'targetTemperature') {
+      return ThermoStatTemperature(payload, callbacks)
+        .then((value) => jsonResponse(client, payload, value))
+        .catch((err) => {
+          console.log(err.message);
+        });
     } else if (action === 'setRangeValue') {
       return RangeValue(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
@@ -178,7 +183,7 @@ const handlePayload = (client, payload, signature, callbacks) => verifySignature
         .catch((err) => {
           console.log(err.message);
         });
-    } 
+    }
     return {};
   })
   .catch((err) => {

package/lib/contorllers/color_temperature.js

@@ -11,7 +11,7 @@ const sinricProData = require('../storage');
 const ColorTemperature = (payload, callbacks) => {
   sinricProData.colorTemperature = payload.value.colorTemperature;
   const resp = callbacks.setColorTemperature(payload.deviceId, payload.value.colorTemperature);
-  
+
   return new Promise((resolve, reject) => {
     if (payload.value.colorTemperature && resp) resolve(payload.value);
     else reject(new Error('color temperature is undefined'));

package/lib/contorllers/sensors_controller.js

@@ -9,13 +9,21 @@
 const sinricProData = require('../storage');
 
 const ThermoStatMode = (payload, callbacks) => {
-  sinricProData.thermostat = payload.value.thermostatMode;
-  const resp = callbacks.setThermoStatMode(payload.deviceId, sinricProData.thermostat);
+  sinricProData.thermostat.mode = payload.value.thermostatMode;
+  const resp = callbacks.setThermostatMode(payload.deviceId, sinricProData.thermostat.mode);
   return new Promise((resolve, reject) => {
     if (payload.value.thermostatMode && resp) resolve(payload.value);
     else reject(new Error('Thermostat mode undefined'));
   });
 };
+const ThermoStatTemperature = (payload, callbacks) => {
+  sinricProData.thermostat.temperature = payload.value.temperature;
+  const resp = callbacks.targetTemperature(payload.deviceId, sinricProData.thermostat.temperature);
+  return new Promise((resolve, reject) => {
+    if (payload.value.temperature && resp) resolve(payload.value);
+    else reject(new Error('Thermostat temperature undefined'));
+  });
+};
 
 const Lock = (payload, callbacks) => {
   const resp = callbacks.setLockState(payload.deviceId, payload.value.state);
@@ -25,4 +33,4 @@ const Lock = (payload, callbacks) => {
   });
 };
 
-module.exports = { ThermoStatMode, Lock };
+module.exports = { ThermoStatMode, ThermoStatTemperature, Lock };

package/lib/contorllers/tv_controller.js

@@ -55,9 +55,10 @@ const Media = (payload, callbacks) => {
 };
 
 const ChangeChannel = (payload, callbacks) => {
-  const resp = callbacks.changeChannel(payload.deviceId, payload.value.channel.name);
+  const channel = payload.value.channel.name || payload.value.channel.number;
+  const resp = callbacks.changeChannel(payload.deviceId, channel);
   return new Promise((resolve, reject) => {
-    if (payload.value.channel.name && resp) resolve(payload.value);
+    if (channel && resp) resolve(payload.value);
     else reject(new Error('Channel name undefined'));
   });
 };

package/lib/events/event_handler.js

@@ -7,10 +7,10 @@
  */
 
 const uuidv4 = require('uuid/v4');
+const { RateLimiterMemory, BurstyRateLimiter } = require('rate-limiter-flexible');
 const { getSignature } = require('../signature');
-const {RateLimiterMemory, BurstyRateLimiter} = require('rate-limiter-flexible');
 
-/* 
+/*
  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  * !!                                                 !!
  * !!             WARNING: DON'T TOUCH !              !!
@@ -31,7 +31,7 @@ const burstyLimiter = new BurstyRateLimiter(
     keyPrefix: 'burst',
     points: 10,
     duration: 60,
-  })
+  }),
 );
 
 // @TODO resteBands
@@ -83,15 +83,14 @@ const getJson = (client, eventName, deviceId, value) => {
 };
 
 const raiseEvent = async (client, eventName, deviceId, value) => {
-  if (actionArr.includes(eventName)) {    
+  if (actionArr.includes(eventName)) {
     try {
       await burstyLimiter.consume('queue');
       client.send(JSON.stringify(getJson(client, eventName, deviceId, value)));
     } catch (rlRejected) {
-      console.log(`Too many events!`);         
+      console.log('Too many events!');
     }
-  }
-  else {
+  } else {
     console.log('Invalid Event');
   }
 };

package/lib/sinrcpro.js

@@ -5,23 +5,22 @@
  *  This file is part of the Sinric Pro (https://github.com/sinricpro/)
  *
  */
-const Websocket = require('ws');
-const rx = require('rxjs');
+const Websocket = require("ws");
+const rx = require("rxjs");
 
 const callbackHandler = require('./cbhandler');
 const { raiseEvent, eventNames } = require('./events/event_handler');
 const SinricProUdp = require('./sinricproudp');
-
-const VERSION = '2.2.4';
+const sdkVersion = require('./../package.json').version;
 
 class SinricPro extends Websocket {
   constructor(appkey, deviceids, secretKey, restoreStates) {
-    super('ws://ws.sinric.pro', {
+    super("ws://ws.sinric.pro", {
       headers: {
         appkey,
         deviceids: deviceids.join(';'),
         platform: 'nodejs',
-        version: VERSION,
+        sdkversion: sdkVersion,
         restoredevicestates: restoreStates,
       },
     });
@@ -37,17 +36,18 @@ class SinricPro extends Websocket {
   }
 }
 
-const SinricProActions = (client, callbacks) => {
+const startSinricPro = (client, callbacks) => {
   client.on('open', () => {
     console.log('Connected to Sinric Pro');
   });
 
-  client.on('message', (data) => {
+  client.on("message", (data) => {
     const parsedData = JSON.parse(data);
-    
+
     if (parsedData.timestamp) {
-      if (Math.floor(new Date() / 1000) - parsedData.timestamp > 60000) console.log('Timestamp is not in sync');
-      else console.log('TimeStamp is in sync');
+      if (Math.floor(new Date() / 1000) - parsedData.timestamp > 60000) {
+        console.log("Timestamp is not in sync");
+      } else console.log("TimeStamp is in sync");
     } else {
       const response = callbackHandler(
         client,
@@ -64,18 +64,25 @@ const SinricProActions = (client, callbacks) => {
         });
     }
   });
+
+  client.on("close", () => {
+    if (callbacks.onDisconnect) {
+      callbacks.onDisconnect();
+    }
+  });
 };
 
-const SinricProActionsObservable = (client, callbacks) => new rx.Observable((observer) => {
+const startSinricProObservable = (client, callbacks) => new rx.Observable((observer) => {
   client.on('open', () => {
     console.log('Connected');
   });
 
-  client.on('message', (data) => {
+  client.on("message", (data) => {
     const parsedData = JSON.parse(data);
     if (parsedData.timestamp) {
-      if (Math.floor(new Date() / 1000) - parsedData.timestamp > 60000) console.log('Timestamp is not in sync');
-      else console.log('TimeStamp is in sync');
+      if (Math.floor(new Date() / 1000) - parsedData.timestamp > 60000) {
+        console.log("Timestamp is not in sync");
+      } else console.log("TimeStamp is in sync");
     } else {
       const response = callbackHandler(
         client,
@@ -95,16 +102,19 @@ const SinricProActionsObservable = (client, callbacks) => new rx.Observable((obs
     }
   });
 
-  client.on('close', () => {
+  client.on("close", () => {
     observer.complete();
-    console.log('Disconnected');
+    if (callbacks.onDisconnect) {
+      callbacks.onDisconnect();
+    }
+    console.log("Disconnected");
   });
 });
 
 module.exports = {
   SinricPro,
-  SinricProActions,
-  SinricProActionsObservable,
+  startSinricPro,
+  startSinricProObservable,
   raiseEvent,
   eventNames,
   SinricProUdp,

package/lib/storage.js

@@ -13,7 +13,10 @@ let data = {
     b: 0,
   },
   lockState: '',
-  thermostat: '',
+  thermostat: {
+    mode: '',
+    temperature: 0,
+  },
   rangeValue: 0,
   volume: 0,
   colorTemperature: 0,

package/package.json

@@ -1,42 +1,38 @@
-{
-  "name": "sinricpro",
-  "version": "2.2.5",
-  "description": "Sinric Pro Nodejs SDK",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint --fix ./"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sinricpro/nodejs-sdk.git"
-  },
-  "author": "Dhanush",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/sinricpro/nodejs-sdk/issues"
-  },
-  "homepage": "https://github.com/sinricpro/nodejs-sdk#readme",
-  "dependencies": {
-    "dgram": "^1.0.1",
-    "leaky-bucket": "^3.0.4",
-    "process": "^0.11.10",
-    "rate-limiter-flexible": "^2.2.1",
-    "rxjs": "^6.6.3",
-    "uuid": "^3.3.3",
-    "ws": "^7.4.2"
-  },
-  "keywords": [
-    "sinricpro",
-    "sinric"
-  ],
-  "devDependencies": {
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-config-standard": "^14.1.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-node": "^10.0.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1"
-  }
-}
+{
+  "name": "sinricpro",
+  "version": "2.3.1",
+  "description": "Sinric Pro Nodejs SDK",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sinricpro/nodejs-sdk.git"
+  },
+  "author": "Dhanush",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/sinricpro/nodejs-sdk/issues"
+  },
+  "homepage": "https://github.com/sinricpro/nodejs-sdk#readme",
+  "dependencies": {
+    "dgram": "^1.0.1",
+    "leaky-bucket": "^4.1.4",
+    "process": "^0.11.10",
+    "rate-limiter-flexible": "^2.3.6",
+    "rxjs": "^6.6.3",
+    "uuid": "^3.3.3",
+    "ws": "^8.5.0"
+  },
+  "keywords": [
+    "sinricpro",
+    "sinric"
+  ],
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb-base": "^14.0.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-node": "^10.0.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1"
+  }
+}