@zwave-js/nvmedit 8.9.0-beta.4-pr-3789-c208add

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2021 AlCalzone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# Z-Wave JS: NVM editor
+
+CLI utility to convert binary NVM backups from Z-Wave controllers into JSON and back. Can be used to edit a Z-Wave controller's memory or convert it between different firmware revisions.  
+**WARNING:** This is highly experimental. Use at your own risk!
+
+(Probably) supports all NVM files in the NVM3 format, which is used starting with Z-Wave SDK 6.61+.
+
+## Convert one NVM to be compatible with another one
+
+**This is probably the command you're looking for.** It converts the format of an NVM backup between different Z-Wave modules.
+
+```
+npx @zwave-js/nvmedit convert --source <source> --target <target> --out <output>
+```
+
+`<source>` specifies the source NVM filename. This file will be converted to match the target NVM.  
+`<target>` specifies the target NVM filename. This file will used to determine how to convert the source NVM.  
+The resulting NVM will be written to `<output>`.
+
+## Convert binary NVM file to JSON
+
+```
+npx @zwave-js/nvmedit nvm2json --in /path/to/nvm.bin --out /path/to/nvm.json [--verbose]
+```
+
+The `--verbose` flag will print additional output like memory page contents or parsed NVM objects to the console.
+
+The `.bin` file must either contain a 700-series NVM (SDK version 7.x) or a 500-series NVM (SDK version 6.61+). The `.json` output format will depend on the SDK version.
+
+## Convert JSON NVM file to binary
+
+```
+npx @zwave-js/nvmedit json2nvm --in /path/to/nvm.json --out /path/to/nvm.bin --version <ver.si.on>
+```
+
+`<ver.si.on>` determines the output format of the NVM file and must be replaced with the target SDK version which must match your stick's firmware version
+Only firmware version `7.x` is supported. Converting a 500-series `.json` to a 700-series `.json` must be done beforehand in a separate step.
+
+**ATTENTION:** The input `.json` file must contain a `"meta"` section which contains some information about the target stick. If it is missing, you can use the `nvm2json` command to convert a backup of the target stick and copy the section from there.
+
+## Convert 500-series JSON to 700-series JSON
+
+```
+npx @zwave-js/nvmedit 500to700 --in /path/to/nvm500.json --out /path/to/nvm700.json [--truncate]
+```
+
+Some 500-series NVM backups contain more application data than the 700-series NVM has reserved for this field. The conversion routine will try to remove 0-bytes at the start and end, but if this is not enough, it will fail. Set the `--truncate` option to allow truncating potentially valid application data.
+
+## Convert 700-series JSON to 500-series JSON
+
+```
+npx @zwave-js/nvmedit 700to500 --in /path/to/nvm700.json --out /path/to/nvm500.json
+```

package/bin/nvmedit.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../build/cli.js");

package/build/cli.d.ts

@@ -0,0 +1,3 @@
+import "reflect-metadata";
+import "./index";
+//# sourceMappingURL=cli.d.ts.map

package/build/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAEA,OAAO,kBAAkB,CAAC;AAW1B,OAAO,SAAS,CAAC"}

package/build/cli.js

@@ -0,0 +1,175 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const typeguards_1 = require("alcalzone-shared/typeguards");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+require("reflect-metadata");
+const yargs_1 = __importDefault(require("yargs"));
+const convert_1 = require("./convert");
+require("./index");
+void yargs_1.default
+    .env("NVMEDIT")
+    .strict()
+    .usage("Z-Wave JS NVM converter utility\n\nUsage: $0 [options]")
+    .alias("h", "help")
+    .alias("v", "version")
+    .wrap(Math.min(100, yargs_1.default.terminalWidth()))
+    .options({
+    verbose: {
+        alias: "vv",
+        describe: "Print verbose output",
+        type: "boolean",
+    },
+})
+    .command("nvm2json", "Convert an NVM backup to JSON", (yargs) => yargs.usage("$0 nvm2json --in <input> --out <output>").options({
+    in: {
+        describe: "NVM backup filename",
+        type: "string",
+        required: true,
+    },
+    out: {
+        describe: "JSON output filename",
+        type: "string",
+        required: true,
+    },
+}), async (argv) => {
+    const buffer = await fs_extra_1.default.readFile(argv.in);
+    let json;
+    try {
+        json = (0, convert_1.nvmToJSON)(buffer, argv.verbose);
+    }
+    catch (e) {
+        try {
+            json = (0, convert_1.nvm500ToJSON)(buffer);
+        }
+        catch (ee) {
+            console.error(e);
+            process.exit(1);
+        }
+    }
+    await fs_extra_1.default.writeJSON(argv.out, json, { spaces: "\t" });
+    console.error(`NVM (JSON) written to ${argv.out}`);
+    process.exit(0);
+})
+    .command("json2nvm", "Convert the JSON representation of an NVM to binary", (yargs) => yargs
+    .usage("$0 json2nvm --in <input> --out <output> --protocolVersion <version>")
+    .options({
+    in: {
+        describe: "JSON input filename",
+        type: "string",
+        required: true,
+    },
+    out: {
+        describe: "NVM output filename",
+        type: "string",
+        required: true,
+    },
+    protocolVersion: {
+        alias: "V",
+        describe: "target protocol version, determines the NVM format",
+        type: "string",
+        required: true,
+    },
+}), async (argv) => {
+    const { protocolVersion } = argv;
+    const versionIs500 = /^\d\.\d+$/.test(protocolVersion);
+    const json = await fs_extra_1.default.readJson(argv.in);
+    const jsonIs500 = json.format === 500;
+    if (versionIs500 && !jsonIs500) {
+        console.error(`ERROR: Protocol version ${protocolVersion} looks like a 500-series version, but the JSON file does not belong to a 500-series NVM!
+Convert it first using the 700to500 command.`);
+        process.exit(1);
+    }
+    else if (jsonIs500 && !versionIs500) {
+        console.error(`ERROR: Protocol version ${protocolVersion} looks like a 700-series version, but the JSON file belong to a 500-series NVM!
+Convert it first using the 500to700 command.`);
+        process.exit(1);
+    }
+    if (!(0, typeguards_1.isObject)(json.meta)) {
+        console.error(`ERROR: The JSON file does not contain the meta section, which is required for the conversion to a binary NVM!
+Create a backup of the target stick, use the nvm2json command to convert it to JSON and copy the meta section from there.`);
+        process.exit(1);
+    }
+    const nvm = versionIs500
+        ? (0, convert_1.jsonToNVM500)(json, protocolVersion)
+        : (0, convert_1.jsonToNVM)(json, protocolVersion);
+    await fs_extra_1.default.writeFile(argv.out, nvm);
+    console.error(`NVM (binary) written to ${argv.out}`);
+    process.exit(0);
+})
+    .command("500to700", "Convert a 500-series JSON file into a 700-series JSON file", (yargs) => yargs
+    .usage("$0 500to700 --in <input> --out <output> [--truncate]")
+    .options({
+    in: {
+        describe: "500 series JSON input filename",
+        type: "string",
+        required: true,
+    },
+    out: {
+        describe: "700 series output filename",
+        type: "string",
+        required: true,
+    },
+    truncate: {
+        alias: "t",
+        describe: "Truncate application data if it is too large (> 512 bytes)",
+        type: "boolean",
+        required: false,
+        default: false,
+    },
+}), async (argv) => {
+    const json500 = await fs_extra_1.default.readJson(argv.in);
+    const json700 = (0, convert_1.json500To700)(json500, argv.truncate);
+    await fs_extra_1.default.writeJSON(argv.out, json700, { spaces: "\t" });
+    console.error(`700-series NVM (JSON) written to ${argv.out}`);
+    process.exit(0);
+})
+    .command("700to500", "Convert a 700-series JSON file into a 500-series JSON file", (yargs) => yargs.usage("$0 700to500 --in <input> --out <output>").options({
+    in: {
+        describe: "700 series JSON input filename",
+        type: "string",
+        required: true,
+    },
+    out: {
+        describe: "500 series output filename",
+        type: "string",
+        required: true,
+    },
+}), async (argv) => {
+    const json700 = await fs_extra_1.default.readJson(argv.in);
+    const json500 = (0, convert_1.json700To500)(json700);
+    await fs_extra_1.default.writeJSON(argv.out, json500, { spaces: "\t" });
+    console.error(`500-series NVM (JSON) written to ${argv.out}`);
+    process.exit(0);
+})
+    .command("convert", "Convert the format of an NVM backup between different Z-Wave modules", (yargs) => yargs
+    .usage("$0 convert --source <source> --target <target> --out <output>")
+    .options({
+    source: {
+        describe: "The source NVM filename. This file will be converted to match the target NVM.",
+        type: "string",
+        required: true,
+    },
+    target: {
+        describe: "The target NVM filename. This file will used to determine how to convert the source NVM.",
+        type: "string",
+        required: true,
+    },
+    out: {
+        describe: "The output filename where the convert NVM will be written.",
+        type: "string",
+        required: true,
+    },
+}), async (argv) => {
+    const source = await fs_extra_1.default.readFile(argv.source);
+    const target = await fs_extra_1.default.readFile(argv.target);
+    const output = (0, convert_1.migrateNVM)(source, target);
+    await fs_extra_1.default.writeFile(argv.out, output);
+    console.error(`Converted NVM written to ${argv.out}`);
+    process.exit(0);
+})
+    .demandCommand(1, "Please specify a command")
+    .parseAsync();
+//# sourceMappingURL=cli.js.map

package/build/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,4DAAuD;AACvD,wDAA0B;AAC1B,4BAA0B;AAC1B,kDAA0B;AAC1B,uCAQmB;AACnB,mBAAiB;AAEjB,KAAK,eAAK;KACR,GAAG,CAAC,SAAS,CAAC;KACd,MAAM,EAAE;KACR,KAAK,CAAC,wDAAwD,CAAC;KAC/D,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;KAClB,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC;KACrB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,eAAK,CAAC,aAAa,EAAE,CAAC,CAAC;KAC1C,OAAO,CAAC;IACR,OAAO,EAAE;QACR,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,sBAAsB;QAChC,IAAI,EAAE,SAAS;KACf;CACD,CAAC;KACD,OAAO,CACP,UAAU,EACV,+BAA+B,EAC/B,CAAC,KAAK,EAAE,EAAE,CACT,KAAK,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC,OAAO,CAAC;IAC9D,EAAE,EAAE;QACH,QAAQ,EAAE,qBAAqB;QAC/B,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,GAAG,EAAE;QACJ,QAAQ,EAAE,sBAAsB;QAChC,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;CACD,CAAC,EACH,KAAK,EAAE,IAAI,EAAE,EAAE;IACd,MAAM,MAAM,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1C,IAAI,IAAS,CAAC;IACd,IAAI;QACH,IAAI,GAAG,IAAA,mBAAS,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;KACvC;IAAC,OAAO,CAAC,EAAE;QACX,IAAI;YACH,IAAI,GAAG,IAAA,sBAAY,EAAC,MAAM,CAAC,CAAC;SAC5B;QAAC,OAAO,EAAE,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAChB;KACD;IACD,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACrD,OAAO,CAAC,KAAK,CAAC,yBAAyB,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAEnD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CACD;KACA,OAAO,CACP,UAAU,EACV,qDAAqD,EACrD,CAAC,KAAK,EAAE,EAAE,CACT,KAAK;KACH,KAAK,CACL,qEAAqE,CACrE;KACA,OAAO,CAAC;IACR,EAAE,EAAE;QACH,QAAQ,EAAE,qBAAqB;QAC/B,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,GAAG,EAAE;QACJ,QAAQ,EAAE,qBAAqB;QAC/B,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,eAAe,EAAE;QAChB,KAAK,EAAE,GAAG;QACV,QAAQ,EACP,oDAAoD;QACrD,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;CACD,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;IACd,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IACjC,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAEvD,MAAM,IAAI,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC;IACtC,IAAI,YAAY,IAAI,CAAC,SAAS,EAAE;QAC/B,OAAO,CAAC,KAAK,CACZ,2BAA2B,eAAe;6CACF,CACxC,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KAChB;SAAM,IAAI,SAAS,IAAI,CAAC,YAAY,EAAE;QACtC,OAAO,CAAC,KAAK,CACZ,2BAA2B,eAAe;6CACF,CACxC,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KAChB;IAED,IAAI,CAAC,IAAA,qBAAQ,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzB,OAAO,CAAC,KAAK,CACZ;0HACqH,CACrH,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KAChB;IAED,MAAM,GAAG,GAAG,YAAY;QACvB,CAAC,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,eAAe,CAAC;QACrC,CAAC,CAAC,IAAA,mBAAS,EAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACpC,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAClC,OAAO,CAAC,KAAK,CAAC,2BAA2B,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAErD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CACD;KACA,OAAO,CACP,UAAU,EACV,4DAA4D,EAC5D,CAAC,KAAK,EAAE,EAAE,CACT,KAAK;KACH,KAAK,CAAC,sDAAsD,CAAC;KAC7D,OAAO,CAAC;IACR,EAAE,EAAE;QACH,QAAQ,EAAE,gCAAgC;QAC1C,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,GAAG,EAAE;QACJ,QAAQ,EAAE,4BAA4B;QACtC,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,QAAQ,EAAE;QACT,KAAK,EAAE,GAAG;QACV,QAAQ,EACP,4DAA4D;QAC7D,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;KACd;CACD,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;IACd,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,IAAA,sBAAY,EAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,OAAO,CAAC,KAAK,CAAC,oCAAoC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAE9D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CACD;KACA,OAAO,CACP,UAAU,EACV,4DAA4D,EAC5D,CAAC,KAAK,EAAE,EAAE,CACT,KAAK,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC,OAAO,CAAC;IAC9D,EAAE,EAAE;QACH,QAAQ,EAAE,gCAAgC;QAC1C,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,GAAG,EAAE;QACJ,QAAQ,EAAE,4BAA4B;QACtC,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;CACD,CAAC,EACH,KAAK,EAAE,IAAI,EAAE,EAAE;IACd,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,IAAA,sBAAY,EAAC,OAAO,CAAC,CAAC;IACtC,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,OAAO,CAAC,KAAK,CAAC,oCAAoC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAE9D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CACD;KACA,OAAO,CACP,SAAS,EACT,sEAAsE,EACtE,CAAC,KAAK,EAAE,EAAE,CACT,KAAK;KACH,KAAK,CACL,+DAA+D,CAC/D;KACA,OAAO,CAAC;IACR,MAAM,EAAE;QACP,QAAQ,EACP,+EAA+E;QAChF,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,MAAM,EAAE;QACP,QAAQ,EACP,0FAA0F;QAC3F,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;IACD,GAAG,EAAE;QACJ,QAAQ,EACP,4DAA4D;QAC7D,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACd;CACD,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;IACd,MAAM,MAAM,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,4BAA4B,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAEtD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CACD;KACA,aAAa,CAAC,CAAC,EAAE,0BAA0B,CAAC;KAC5C,UAAU,EAAE,CAAC"}

package/build/consts.d.ts

@@ -0,0 +1,4 @@
+export declare const SUC_UPDATE_NODEPARM_MAX = 20;
+export declare const SUC_UPDATE_ENTRY_SIZE: number;
+export declare const SUC_MAX_UPDATES = 64;
+//# sourceMappingURL=consts.d.ts.map

package/build/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAC1C,eAAO,MAAM,qBAAqB,QAA8B,CAAC;AACjE,eAAO,MAAM,eAAe,KAAK,CAAC"}

package/build/consts.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUC_MAX_UPDATES = exports.SUC_UPDATE_ENTRY_SIZE = exports.SUC_UPDATE_NODEPARM_MAX = void 0;
+exports.SUC_UPDATE_NODEPARM_MAX = 20;
+exports.SUC_UPDATE_ENTRY_SIZE = 2 + exports.SUC_UPDATE_NODEPARM_MAX;
+exports.SUC_MAX_UPDATES = 64;
+//# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG,EAAE,CAAC;AAC7B,QAAA,qBAAqB,GAAG,CAAC,GAAG,+BAAuB,CAAC;AACpD,QAAA,eAAe,GAAG,EAAE,CAAC"}

package/build/convert.d.ts

@@ -0,0 +1,86 @@
+/// <reference types="node" />
+import { CommandClasses, NodeProtocolInfo } from "@zwave-js/core";
+import { Route, SUCUpdateEntry } from "./files";
+import { NVM3Objects, NVMMeta } from "./nvm3/nvm";
+import type { NVM3Object } from "./nvm3/object";
+import { NVM500JSON } from "./nvm500/NVMParser";
+export interface NVMJSON {
+    format: number;
+    meta?: NVMMeta;
+    controller: NVMJSONController;
+    nodes: Record<number, NVMJSONNode>;
+}
+export interface NVMJSONController {
+    protocolVersion: string;
+    applicationVersion: string;
+    homeId: string;
+    nodeId: number;
+    lastNodeId: number;
+    staticControllerNodeId: number;
+    sucLastIndex: number;
+    controllerConfiguration: number;
+    sucUpdateEntries: SUCUpdateEntry[];
+    sucAwarenessPushNeeded?: number | null;
+    maxNodeId: number;
+    reservedId: number;
+    systemState: number;
+    lastNodeIdLR?: number | null;
+    maxNodeIdLR?: number | null;
+    reservedIdLR?: number | null;
+    primaryLongRangeChannelId?: number | null;
+    dcdcConfig?: number | null;
+    rfConfig?: NVMJSONControllerRFConfig | null;
+    preferredRepeaters?: number[] | null;
+    isListening: boolean;
+    optionalFunctionality: boolean;
+    genericDeviceClass: number;
+    specificDeviceClass: number;
+    commandClasses: {
+        includedInsecurely: CommandClasses[];
+        includedSecurelyInsecureCCs: CommandClasses[];
+        includedSecurelySecureCCs: CommandClasses[];
+    };
+    applicationData?: string | null;
+}
+export interface NVMJSONControllerRFConfig {
+    rfRegion: number;
+    txPower: number;
+    measured0dBm: number;
+    enablePTI: number | null;
+    maxTXPower: number | null;
+}
+export interface NVMJSONNodeWithInfo extends Omit<NodeProtocolInfo, "hasSpecificDeviceClass"> {
+    isVirtual: boolean;
+    genericDeviceClass: number;
+    specificDeviceClass: number | null;
+    neighbors: number[];
+    sucUpdateIndex: number;
+    appRouteLock: boolean;
+    routeSlaveSUC: boolean;
+    sucPendingUpdate: boolean;
+    pendingDiscovery: boolean;
+    lwr?: Route | null;
+    nlwr?: Route | null;
+}
+export interface NVMJSONVirtualNode {
+    isVirtual: true;
+}
+export declare type NVMJSONNode = NVMJSONNodeWithInfo | NVMJSONVirtualNode;
+export declare function nodeHasInfo(node: NVMJSONNode): node is NVMJSONNodeWithInfo;
+/** Converts a compressed set of NVM objects to a JSON representation */
+export declare function nvmObjectsToJSON(applicationObjects: ReadonlyMap<number, NVM3Object>, protocolObjects: ReadonlyMap<number, NVM3Object>): NVMJSON;
+export declare function jsonToNVMObjects_v0(json: NVMJSON, major: number, minor: number, patch: number): NVM3Objects;
+export declare function jsonToNVMObjects_v1_to_v3(format: 1 | 2 | 3, json: NVMJSON, major: number, minor: number, patch: number): NVM3Objects;
+/** Reads an NVM buffer and returns its JSON representation */
+export declare function nvmToJSON(buffer: Buffer, debugLogs?: boolean): Required<NVMJSON>;
+/** Reads an NVM buffer of a 500-series stick and returns its JSON representation */
+export declare function nvm500ToJSON(buffer: Buffer): Required<NVM500JSON>;
+/** Takes a JSON represented NVM and converts it to binary */
+export declare function jsonToNVM(json: Required<NVMJSON>, protocolVersion: string): Buffer;
+/** Takes a JSON represented 500 series NVM and converts it to binary */
+export declare function jsonToNVM500(json: Required<NVM500JSON>, protocolVersion: string): Buffer;
+export declare function json500To700(json: NVM500JSON, truncateApplicationData?: boolean): NVMJSON;
+export declare function json700To500(json: NVMJSON): NVM500JSON;
+/** Converts the given source NVM into a format that is compatible with the given target NVM */
+export declare function migrateNVM(source: Buffer, target: Buffer): Buffer;
+//# sourceMappingURL=convert.d.ts.map

package/build/convert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../src/convert.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,cAAc,EAEd,gBAAgB,EAGhB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAyCN,KAAK,EAML,cAAc,EACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAGN,WAAW,EACX,OAAO,EAEP,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAGN,UAAU,EAEV,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,OAAO;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,iBAAiB,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,iBAAiB;IACjC,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;IAChC,gBAAgB,EAAE,cAAc,EAAE,CAAC;IACnC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAC5C,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAErC,WAAW,EAAE,OAAO,CAAC;IACrB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAE5B,cAAc,EAAE;QACf,kBAAkB,EAAE,cAAc,EAAE,CAAC;QACrC,2BAA2B,EAAE,cAAc,EAAE,CAAC;QAC9C,yBAAyB,EAAE,cAAc,EAAE,CAAC;KAC5C,CAAC;IAEF,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,yBAAyB;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,mBAChB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,wBAAwB,CAAC;IACxD,SAAS,EAAE,OAAO,CAAC;IAEnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IAEvB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,gBAAgB,EAAE,OAAO,CAAC;IAE1B,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IACnB,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACpB;AAGD,MAAM,WAAW,kBAAkB;IAClC,SAAS,EAAE,IAAI,CAAC;CAChB;AAED,oBAAY,WAAW,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAEnE,wBAAgB,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,IAAI,mBAAmB,CAE1E;AA2BD,wEAAwE;AACxE,wBAAgB,gBAAgB,CAC/B,kBAAkB,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,EACnD,eAAe,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,GAC9C,OAAO,CAyPT;AAqLD,wBAAgB,mBAAmB,CAClC,IAAI,EAAE,OAAO,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACX,WAAW,CAyGb;AAED,wBAAgB,yBAAyB,CACxC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EACjB,IAAI,EAAE,OAAO,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACX,WAAW,CAiHb;AAED,8DAA8D;AAC9D,wBAAgB,SAAS,CACxB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,OAAe,GACxB,QAAQ,CAAC,OAAO,CAAC,CAKnB;AAED,oFAAoF;AACpF,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,CAIjE;AAED,6DAA6D;AAC7D,wBAAgB,SAAS,CACxB,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,EACvB,eAAe,EAAE,MAAM,GACrB,MAAM,CA+CR;AAED,wEAAwE;AACxE,wBAAgB,YAAY,CAC3B,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,EAC1B,eAAe,EAAE,MAAM,GACrB,MAAM,CAiBR;AAED,wBAAgB,YAAY,CAC3B,IAAI,EAAE,UAAU,EAChB,uBAAuB,CAAC,EAAE,OAAO,GAC/B,OAAO,CAyGT;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,CA+CtD;AAED,+FAA+F;AAC/F,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CA0DjE"}