node-zwave-js/docs/config-files/importing-from-others.md

2.2 KiB

Importing config files from other sources

We provide import scripts to import and convert Z-Wave config files from other sources.

[!NOTE] It is intended that these config files will be used only as a starting point. Almost always the resulting config files will need to be edited to comply with our mandatory style guide. For manufacturers with multiple similar devices, it may be necessary to define and use templates. Parameters may also need to be defined conditionally or converted to partial parameters.

Z-Wave Alliance

Most devices are registered in the Z-Wave Alliance Product DB. The information from there can be imported by specifying the ID found in the product page URL. For example, the device from https://products.z-wavealliance.org/products/1234has the ID 1234:

yarn run config import -s zwa -Dd --ids 1234

Multiple devices can be imported at once by specifying multiple IDs:

yarn run config import -s zwa -Dd --ids 1234 2345 3456

OpenZWave

If your device is already present in the OpenZWave devices DB, you can import it by using its device id (which you can find in the Z-Wave JS UI). Device config files also contain the device id but the format is different: 0086:0075:0004 in the file needs to be formatted as 0x0086-0x0075-0x0004 for the following commands.

The command to use is:

yarn run config import -s ozw -Dd --ids 0x0086-0x0075-0x0004

You can specify multiple device ids too:

yarn run config import -s ozw -Dd --ids 0x0258-0x1027-0x0200 0x041a-0x0008-0x0200

OpenSmartHouse Z-Wave Device Database (OpenHAB)

If you can find the file here, you can import it with the following commands:

yarn run config import -s oh -Dd --ids 1234

To specify multiple device IDs, just append them to the command:

yarn run config import -s oh -Dd --ids 1234 1235

The device ID can be found in the browser URL - the device at https://opensmarthouse.org/zwavedatabase/256 has the ID 256.