homebridge-kasa-python 1.0.0

package/dist/utils.js

@@ -0,0 +1,172 @@
+import { spawn } from 'child_process';
+import { writeFile } from 'fs/promises';
+export function isObjectLike(candidate) {
+    return ((typeof candidate === 'object' && candidate !== null) ||
+        typeof candidate === 'function');
+}
+/**
+ * Creates a function that will "batch" calls that are within the `timeout`
+ *
+ * The first time the function that is created is called, it will wait the `timeout` for additional calls.
+ * After the `timeout` expires the result of one execution of `fn` will be resolved to all calls during the `timeout`.
+ *
+ * If `runNowFn` is specified it will be run synchronously without a timeout. Useful for functions that are used to set rather than get.
+ *
+ * @param {() => Promise<T>} fn
+ * @param {number} timeout (ms)
+ * @param {(arg: U) => void} [runNowFn]
+ * @returns {(arg?: U) => Promise<T>}
+ */
+export function deferAndCombine(fn, timeout, runNowFn) {
+    const requests = [];
+    let isWaiting = false;
+    return (arg) => {
+        if (runNowFn !== undefined && arg !== undefined) {
+            runNowFn(arg);
+        }
+        return new Promise((resolve, reject) => {
+            requests.push({ resolve, reject });
+            if (isWaiting) {
+                return;
+            }
+            isWaiting = true;
+            setTimeout(() => {
+                isWaiting = false;
+                fn(requests.length)
+                    .then((value) => {
+                    for (const d of requests) {
+                        d.resolve(value);
+                    }
+                })
+                    .catch((error) => {
+                    for (const d of requests) {
+                        d.reject(error);
+                    }
+                });
+            }, timeout);
+        });
+    };
+}
+export function delay(ms) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+}
+export function getOrAddCharacteristic(service, characteristic) {
+    if (!hasCharacteristic(service.characteristics.concat(service.optionalCharacteristics), characteristic)) {
+        // This it to suppress warning: Characteristic not in required or optional characteristic section for service
+        service.addOptionalCharacteristic(characteristic);
+    }
+    return (service.getCharacteristic(characteristic) ||
+        service.addCharacteristic(characteristic));
+}
+export function hasCharacteristic(characteristics, characteristic) {
+    return (characteristics.find((char) => 
+    // @ts-expect-error: still want to check UUID
+    char instanceof characteristic || char.UUID === characteristic.UUID) !== undefined);
+}
+export function kelvinToMired(kelvin) {
+    return 1e6 / kelvin;
+}
+export function lookup(object, compareFn, value) {
+    const compare = compareFn ??
+        ((objectProp, search) => objectProp === search);
+    if (isObjectLike(object)) {
+        const keys = Object.keys(object);
+        for (let i = 0; i < keys.length; i += 1) {
+            if (compare(object[keys[i]], value)) {
+                return keys[i];
+            }
+        }
+    }
+    return undefined;
+}
+export function lookupCharacteristicNameByUUID(characteristic, uuid) {
+    const keys = Object.keys(characteristic);
+    for (let i = 0; i < keys.length; i += 1) {
+        const key = keys[i];
+        // @ts-expect-error: not sure how to make this correct in typescript
+        const c = characteristic[key];
+        if ('UUID' in c && c.UUID === uuid) {
+            return key;
+        }
+    }
+    return undefined;
+}
+export function miredToKelvin(mired) {
+    return 1e6 / mired;
+}
+export async function runCommand(logger, command, args, options, hideStdout = false, hideStderr = false) {
+    let stdout = '';
+    let stderr = '';
+    let redirectOutputToFile = false;
+    let outputFile = '';
+    if (args) {
+        const argsBeforeRedirect = [];
+        for (const arg of args) {
+            if (arg.startsWith('>')) {
+                redirectOutputToFile = true;
+                outputFile = arg.substring(1).trim();
+                break;
+            }
+            else {
+                argsBeforeRedirect.push(arg);
+            }
+        }
+        if (redirectOutputToFile && outputFile) {
+            args = argsBeforeRedirect;
+        }
+    }
+    logger.debug(`Running command: ${command} ${args?.join(' ')}`);
+    const p = spawn(command, args, options);
+    logger.debug(`Command PID: ${p.pid}`);
+    p.stdout.setEncoding('utf8');
+    p.stdout.on('data', (data) => {
+        stdout += data;
+        if (!hideStdout) {
+            logger.info(data.trim());
+        }
+    });
+    p.stderr.setEncoding('utf8');
+    p.stderr.on('data', (data) => {
+        stderr += data;
+        if (!hideStderr) {
+            if (data.startsWith('WARNING')) {
+                logger.warn(data.trim());
+            }
+            else {
+                logger.error(data.trim());
+            }
+        }
+    });
+    const exitCode = await new Promise((resolve, reject) => {
+        p.on('close', resolve);
+        p.on('error', reject);
+    });
+    if (redirectOutputToFile && outputFile) {
+        await writeFile(outputFile, stdout);
+    }
+    logger.debug('Command finished.');
+    return [stdout, stderr, exitCode];
+}
+function cloneLogger(logger) {
+    // @ts-expect-error this doesn't work on function types
+    const clonedLogger = logger.info.bind(logger);
+    clonedLogger.info = logger.info;
+    clonedLogger.warn = logger.warn;
+    clonedLogger.error = logger.error;
+    clonedLogger.debug = logger.debug;
+    clonedLogger.log = logger.log;
+    clonedLogger.prefix = logger.prefix;
+    return clonedLogger;
+}
+export function prefixLogger(logger, prefix) {
+    const newLogger = cloneLogger(logger);
+    const origLog = logger.log.bind(newLogger);
+    newLogger.log = function log(level, message, ...parameters) {
+        const prefixEval = prefix instanceof Function ? prefix() : prefix;
+        origLog(level, `${prefixEval} ${message}`, ...parameters);
+    };
+    return newLogger;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AASA,OAAO,EAAkC,KAAK,EAA4B,MAAM,eAAe,CAAC;AAChG,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAMxC,MAAM,UAAU,YAAY,CAC1B,SAAkB;IAElB,OAAO,CACL,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC;QACrD,OAAO,SAAS,KAAK,UAAU,CAChC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe,CAC7B,EAAwC,EACxC,OAAe,EACf,QAA2B;IAE3B,MAAM,QAAQ,GAGR,EAAE,CAAC;IACT,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,OAAO,CAAC,GAAG,EAAE,EAAE;QACb,IAAI,QAAQ,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YAChD,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;YAEnC,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO;YACT,CAAC;YACD,SAAS,GAAG,IAAI,CAAC;YAEjB,UAAU,CAAC,GAAG,EAAE;gBACd,SAAS,GAAG,KAAK,CAAC;gBAClB,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;qBAChB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBACd,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;wBACzB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBACnB,CAAC;gBACH,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACf,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;wBACzB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAClB,CAAC;gBACH,CAAC,CAAC,CAAC;YACP,CAAC,EAAE,OAAO,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,EAAU;IAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,OAAgB,EAChB,cAAkD;IAElD,IACE,CAAC,iBAAiB,CAChB,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAC/D,cAAc,CACf,EACD,CAAC;QACD,6GAA6G;QAC7G,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,CACL,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC;QACzC,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAC1C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,eAAsC,EACtC,cAAoD;IAEpD,OAAO,CACL,eAAe,CAAC,IAAI,CAClB,CAAC,IAAI,EAAE,EAAE;IACP,6CAA6C;IAC7C,IAAI,YAAY,cAAc,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,CACtE,KAAK,SAAS,CAChB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,OAAO,GAAG,GAAG,MAAM,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,MAAM,CACpB,MAAe,EACf,SAAoE,EACpE,KAAQ;IAER,MAAM,OAAO,GACX,SAAS;QACT,CAAC,CAAC,UAAmB,EAAE,MAAS,EAAW,EAAE,CAAC,UAAU,KAAK,MAAM,CAAC,CAAC;IAEvE,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;gBACpC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC5C,cAAqC,EACrC,IAAY;IAEZ,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,oEAAoE;QACpE,MAAM,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACnC,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAO,GAAG,GAAG,KAAK,CAAC;AACrB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAc,EACd,OAAe,EACf,IAAwB,EACxB,OAAkC,EAClC,aAAsB,KAAK,EAC3B,aAAsB,KAAK;IAE3B,IAAI,MAAM,GAAW,EAAE,CAAC;IACxB,IAAI,MAAM,GAAW,EAAE,CAAC;IACxB,IAAI,oBAAoB,GAAY,KAAK,CAAC;IAC1C,IAAI,UAAU,GAAW,EAAE,CAAC;IAE5B,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,kBAAkB,GAAG,EAAE,CAAC;QAE9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,oBAAoB,GAAG,IAAI,CAAC;gBAC5B,UAAU,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM;YACR,CAAC;iBAAM,CAAC;gBACN,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,IAAI,UAAU,EAAE,CAAC;YACvC,IAAI,GAAG,kBAAkB,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,oBAAoB,OAAO,IAAI,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/D,MAAM,CAAC,GAAmC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACxE,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAEtC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;QACnC,MAAM,IAAI,IAAI,CAAC;QACf,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;QACnC,MAAM,IAAI,IAAI,CAAC;QACf,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAkB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpE,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,IAAI,oBAAoB,IAAI,UAAU,EAAE,CAAC;QACvC,MAAM,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAClC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,WAAW,CAAC,MAAe;IAClC,uDAAuD;IACvD,MAAM,YAAY,GAAuB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClE,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAChC,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAChC,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAClC,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAClC,YAAY,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;IAE9B,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAEpC,OAAO,YAAuB,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAc,EACd,MAA+B;IAE/B,MAAM,SAAS,GAAG,WAAW,CAAC,MAAiB,CAAC,CAAC;IAEjD,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAE3C,SAAS,CAAC,GAAG,GAAG,SAAS,GAAG,CAC1B,KAAe,EACf,OAAe,EACf,GAAG,UAAqB;QAExB,MAAM,UAAU,GAAG,MAAM,YAAY,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QAClE,OAAO,CAAC,KAAK,EAAE,GAAG,UAAU,IAAI,OAAO,EAAE,EAAE,GAAG,UAAU,CAAC,CAAC;IAC5D,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "displayName": "Homebridge Kasa Python",
+  "name": "homebridge-kasa-python",
+  "version": "1.0.0",
+  "description": "Plugin that uses Python-Kasa API to communicate with Kasa Devices.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ZeliardM/homebridge-kasa-python.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ZeliardM/homebridge-kasa-python/issues"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.9.0",
+    "homebridge": "^1.8.0",
+    "python": "^3.9.0"
+  },
+  "main": "dist/index.js",
+  "scripts": {
+    "lint": "eslint src/**/*.ts --max-warnings=0",
+    "watch": "npm run build && npm link && nodemon",
+    "build": "npm ci && rimraf -I ./dist && npm run lint && tsc && cp ./src/python/*.py ./dist/python",
+    "prepublishOnly": "npm run lint && npm run build"
+  },
+  "keywords": [
+    "homebridge",
+    "homebridge-plugin",
+    "homebridge-kasa",
+    "homebridge-kasa-python",
+    "homekit",
+    "kasa",
+    "plugin",
+    "python",
+    "python-kasa",
+    "smarthome",
+    "tplink",
+    "tplink-kasa",
+    "tplink-smarthome"
+  ],
+  "files": [
+    "config.schema.json",
+    "dist",
+    "LICENSE",
+    "requirements.txt"
+  ],
+  "devDependencies": {
+    "@types/lodash.defaults": "^4.2.9",
+    "@types/node": "^20.12.13",
+    "@types/semver": "^7.5.8",
+    "@typescript-eslint/eslint-plugin": "^7.11.0",
+    "@typescript-eslint/parser": "^7.11.0",
+    "eslint": "^8.57.0",
+    "homebridge": "^1.8.2",
+    "nodemon": "^3.1.2",
+    "rimraf": "^5.0.7",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  },
+  "homepage": "https://github.com/ZeliardM/homebridge-kasa-python#readme",
+  "funding": [
+    {
+      "type": "paypal",
+      "url": "https://www.paypal.me/ZeliardM/USD"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/ZeliardM"
+    }
+  ],
+  "dependencies": {
+    "ajv": "^8.16.0",
+    "ajv-formats": "^3.0.1",
+    "axios": "^1.7.2",
+    "lodash.defaults": "^4.2.0",
+    "ts-essentials": "^10.0.1"
+  }
+}

package/requirements.txt

@@ -0,0 +1 @@
+python-kasa==0.7.0.3