Prerequisites

To set up a Z-Wave network:

1. The proper OS specific driver must be installed (drivers for Windows and appropriate kernel module for Linux).
2. The Z-Wave Module must be properly configured. See the Configuring the Z-Wave Controller section below.

For management of the Z-Wave network (communication with the attached Z-Wave Controller), user must have read/write access to the serial port. In most Linux distributions the user must be a member of the uucp group (usually requires Root access).

Some Smart Home hardware include a Z-Wave controller wired directly to a serial port (rather than via USB). In such case it can be accessed via /dev/ttyS#, /dev/ttyUSB#, /dev/ttyACM# or similar, where # is a number. Ask your hardware vendor for the serial port to use for accessing the built-in Z-Wave chip.

Installation and Configuration

Automated Installation

The Z-Wave Module provides two Kit Manager installation scripts located in the bin/pscripts folder.

• "Z-Wave" (found in the file zwave.txt), which installs only the Z-Wave Module. For automated installation execute the console command:

  kitman.install "Z-Wave"

• "Z-Wave DA Support" (found in the file zwave-da.txt), which installs the Z-Wave Module along with additional bundles providing integration with the Device Access module via the DA API. For automated installation execute the console command:

  kitman.install "Z-Wave DA Support"

  • To manage items in the web console the Functional Item Management Web Admin needs to be installed.
• "Z-Wave DA HDM Support" (found in the file zwave-da-hdm.txt), which installs the Z-Wave Module along with additional bundles providing integration with the Device Access module via the HDM API. For automated installation execute the console command:

  kitman.install "Z-Wave DA HDM Support"

The kitman command group is exported by the Kit Manager Bundle. You may also write your own install scripts for easier installation (and start) of a certain set of bundles. The required bundles for the Z-Wave Module are listed in the Manual Installation section.

If you need a user friendly web interface, install the Working with web console.

Manual Installation

To install and start the Z-Wave module manually:

1. Install the Serial and Parallel Module.

   kitman.i "Comm (gnu.io) Bundle"

2. Install and start the Z-Wave driver:

   fw.i -f -s com.prosyst.mbs.zwave.util.jar

   fw.i -f -s com.prosyst.mbs.zwave.driver.api.jar

   fw.i -f -s com.prosyst.mbs.zwave.driver.jar

3. Install and start the custom configuration and providers:

   fw.i -f -s com.prosyst.mbs.zwave.device.configuration.custom.jar

   fw.i -f -s com.prosyst.mbs.zwave.device.configuration.provider.jar

If you want to use the abstraction layer provided by the Device Access module, install and start the following Z-Wave bundles:

1. Call the da.txt script:

   kitman.i "Device Access"

2. Call the zwave.txt script:

   kitman.i "Z-Wave"

3. Set the base for bundles:

   set mbs.bundles.base=../../../bundles/

4. Install adapter and DCs api bundles:

   fw.i -f com.prosyst.mbs.zwave.da.hdm.adapter.api.jar

   fw.i -f com.prosyst.mbs.zwave.da.items.api.jar

5. Install all FIM-compliant DC bundles:

   fw.i -f -s com.prosyst.mbs.zwave.da.items.provider.jar

   fw.i -f -s com.prosyst.mbs.zwave.da.items.provider.custom.jar

6. Install all system dc provider fragments:

   fw.i -f com.prosyst.mbs.zwave.da.items.provider.system.jar

   fw.resolve com.prosyst.mbs.zwave.da.items.provider.system.jar

7. Install the HDM adapter:

   fw.i -f -s com.prosyst.mbs.zwave.da.hdm.adapter.jar

If you want to use the abstraction layer provided by the Home Device Manager module, install and start the following Z-Wave bundles:

1. Call the da.hdm.txt script:

   kitman.i "Device Access HDM"

2. Call the zwave.txt script:

   kitman.i "Z-Wave"

3. Set the base for bundles:

   set mbs.bundles.base=../../../bundles/

4. Install adapter and DCs api bundles:

   fw.i -f com.prosyst.mbs.zwave.da.hdm.adapter.api.jar

   fw.i -f com.prosyst.mbs.zwave.da.hdm.dc.api.jar

5. Install all compatibility DC bundles:

   fw.i -f -s com.prosyst.mbs.zwave.da.hdm.dco.provider.jar

   fw.i -f -s com.prosyst.mbs.zwave.da.hdm.dco.provider.custom.jar

6. Install all system dc provider fragments:

   fw.i -f -r com.prosyst.mbs.zwave.da.hdm.dco.provider.system.jar

   fw.resolve com.prosyst.mbs.zwave.da.hdm.dco.provider.system.jar

7. Install the HDM adapter:

   fw.i -f -s com.prosyst.mbs.zwave.da.hdm.adapter.jar

If you need a user friendly web interface, install the Working with web console