Zigbee and zwave manual install script

A number of people have run into trouble performing manual installs of the Zigbee and Z-Wave bindings. A manual install (dropping the jar into addons) is rarely needed, but some people prefer a manual install over apt-get, or want to use a stable OH release with a recent Zigbee or Z-Wave binding. Here is a script that will hopefully make it easier to install, upgrade, and uninstall these bindings, and prevent some of the common issues.

Who would benefit from this script:

  • Anyone wanting to test development versions of the Zigbee or Z-Wave bindings before they are available in a snapshot or milestone build. If this is the case, then you are likely working closely with Chris to resolve and issue or implement a feature.
  • Anyone wanting to remove a manually installed Zigbee or Z-Wave binding. It’s easy to delete the jar, but OH may have cached the bundle, which then needs to be uninstalled through the Karaf console.
  • Anyone wanting to install the openhab-transport-serial feature. This needs to be reinstalled after an OH update or after clearing the OH cache, if you’ve manually installed one of these bindings. I’ll typically just run this script to update the bindings after updating OH, which will also installs this feature.
  • Anyone who wants to use a manual install of one of these bindings, but doesn’t know where to download them.
  • Anyone wanting to automate the upgrade of a manually installed version of these bindings.

More details in the readme.md, including the steps to manually install the Zigbee and Z-Wave bindings. I have tested the script quite a bit, but feedback from others would be much appreciated! Reminder… if you install/upgrade/uninstall the refactored Z-Wave binding, don’t forget to delete and rediscover your Things to pick up any updated Thing definitions!

Note: the development Z-Wave binding has been merged into the master branch, so if using this script, only choose the development version for Z-Wave if Chris instructs you to do so (he may throw a test jar out there).

Donations are very much appreciated! :beers:

Zigbee binding
Can I use the latest zwave-2.4.0-SNAPSHOT with OH2.3.0 Release Build?
How to install Zigbee 2.4.0?
ZWave Controller Offline After Reboot
Zibee Yale YRD216 PBDB
ZWave binding updates
Two brand new Aeotec Z-Wave devices to add to the database
Qubino Dimmer in opensmarthome database ZMNHSD1 missing?
[SOLVED] OH3 ZWave Binding is unable to find Technisat Dimmer
ABUS SHLM10000 E27 LED RGBW Bulb: Unkown Color mode: null
Issue with Z-wave and Openhab
Z-Wave DB - Honeywell / Jasco ZW4103 Unknown Device
Zooz Zen34 Remote Switch unknown device
Eurotronics Spirit can't be added as a thing
[SOLVED] Zwave, unknown device NEO Coolcam power plug
Zooz ZEN25 energy reporting
Zooz ZEN16 Multirelay v1.2 not recognized
Fibaro Wall Plug not recognized (FGWP101 Metered Wall Plug Switch)
Aeotec ZWA-009 in DB but still unknown
Eurotronic Spirit Thermostatic Valve (TRV)
Fibaro wallplug FGWP102 not reporting
Can't change the heating of thermostats in openHAB 3
I messed up my zwave controller
How to configure the Nortek HUSBZB-1 Zigbee/Zwave radio on OH 3?
Fibaro FGFS-101 Unknown Device after Z-Wave Discovery
Problems with the discovering of an Eurotronic Spirit Z-Wave Plus thermostat
Latest Zwave binding download
Unknown Device Eurotronics Spirit Z-Wave Plus
Ring Alarm Components - Zwave
Minoston 2 channel plug
[OH3] Z-Wave - Is it possible to force-reinitialise devices without re-pairing?
Fibaro FGFS001 ZW5
Failure to enroll garage door opener in zwave network
"Unable to find thing type (010F:0B01:1002:3.2)" - which is a Fibaro FGFS-101 v3.2
GoControl GD00Z-8-GC Discovery
Z-Wave Zooz ZEN24 Lightswitch - Online, but can't see status on/off in Openhab
Monoprice Z-Wave Plus On/Off Switch (36737) linking as "Unknown Device"
Cant remove Associations
Monoprice Z-Wave Plus On/Off Switch (36737) linking as "Unknown Device"
No luminance from RS LED D2 Z-Wave Indoor LED-light with motion sensor
Heatit Z-TRM3 lists as "Unknown Device"
Fibaro Flood Sensor unknown to zwave binding
FGWPB-121 Not in Database - but it is
FGWPB-121 Not in Database - but it is
GoControl GD00Z-8-GC Discovery
Zipato NE_NAS-AB02Z Indoor Siren - need to send a NOTIFICATION to it or raw zwave command
Generic Z-Wave Siren Alarm : AB01Z? or AB02Z? + Missing Commands
Please, add Zwave device Philio PSR03-C to DB
Merten 506004 battery wall switch database entry
Zigbee Devices Experiencing Battery Drain w/OpenHab
Debugging a Z-Wave device (Ecolink garage door sensor, TILTZWAVE2.5-ECO)
Zigbee OTA Firmware Provider
Openhab 2.4.0 - issues with Xaiomi aquara, humidity sensor
Aeotec Nano-Shutter problem with firmware update to 3.1
2.5.3 Z-wave - thing receives a command, mostly does it, then goes offline
Inovelli Switches not updating
Zooz ZSE29 Sensor in Z-wave database, but wrong firmware
Adding new device - Minoston NIE Tech Inovelli - Z-Wave Outdoor Smart Plug
Zooz ZSE29 Sensor in Z-wave database, but wrong firmware
Latest Zwave binding missing module?
Adding Z wave Node
Adding Z wave Node
Problem with "thingid" when creating new device in database
Adding Z wave Node
Honeywell In-wall Light Switch: unable to be approved: Duplicate channels?
Z-wave device Error after update openhabian to Version 2.5.4_01
[SOLVED] OH2.5.4-1 Zwave stick keeps restarting
[SOLVED] OH2.5.4-1 Zwave stick keeps restarting
Centralite HA Thermostat Setpoint Doesn't Always Update
One thing detected by z-stick but Openhab does almost nothing with it
One thing detected by z-stick but Openhab does almost nothing with it
Z-wave device Error after update openhabian to Version 2.5.4_01
Openhabian-config tool NOT pulling latest snapshot
Z-wave device Error after update openhabian to Version 2.5.4_01
New Jasco ZWave Smart Dimmer Work around
[SOLVED] Unknown Device - Neo Coolcam Motion Sensor(PIR)
Z-Wave Binding - what is the procedure for moving back to a newer release binding after testing a snapshot?
Fibaro RGBW Controller 2 (FGRGBW-442) - Device unknown - Openhab 2.4.0-1 Release-Build
How to update to latest Zwave Database?
Zooz ZSE29 v2 include trouble
Zigbee devices work for sometime and then suddenly stop working
Processing DATA_AVAILABLE event: Serial buffer overrun since Update 2.5.1-1 to 2.5.1-2
Zigbee devices work for sometime and then suddenly stop working
Change thing UID for zwave device/ or force additional parameter value
Unkown Device , ABUS CFA 3010
WallMote Quad (ZW130) sliding does not work
[SOLVED] How to add new zwave device after adding in the online DB
Clock Class for Devolo Thermostat (MT02650)
Z-Wave Device not adding
[SOLVED] Home Energy Meter HEM G3 AEON Labs GEN5 ZW095 do not report automatically
Z-wave: HABmin only works with devices registered in an open database
Qubino Mini Dimmer ZMNHHD no Channels
[SOLVED] Upgrade openhabian from 2.4.0-1 to 2.5 because need the updated z-wave things
ZMNHHD Qubino Mini Dimmer missing association groups,channels , configuration options but works
Zooz Zen30 Dimmer Issue
Merten 50x5xx: configure travel time UP/DOWN
POPP Solar Siren not recognized after upgrading from OH 2.3
A minimum of 600 and a maximum of 1 - huh?!
[SOLVED] Zigbee not working (ember)
Danalock not reporting status
[SOLVED] New entry in Z-Wave Database does not work properly with Z-Wave Binding
Danfoss LC-13 Thermostate discovered as unknown device
Not getting temperature from ZMNHAD / ZMNHEA1 (qubino)
Openhab unstable after upgrade to 2.5
[SOLVED] NEO Wallplug (NAS-WR01ZE) is in the database but is shown as Unknown Device
Upgrade z-wave db within stable version
Zwave Roller Shutter control
Honeywell ZW4005
ZWave binding updates
[SOLVED] Unknown Zwave device not yet in the databse
Trane XL850 Thermostat is an Unknown ZWave Device
Kwikest 910 lock not recognized
[SOLVED] Logic home ZDB5100 Z-wave unknown device
Jasco GE 46202, but different manufacturer ID
[SOLVED] New Z-Wave Device: What steps after adding to the database?
GE 14298 Showing up as `Unknown Device`
New Inovelli Z-Wave On-Off switches (LZW30), Z-Wave integration with Openhab
Cannot set custom position to Aeotec Nano Shutter
[SOLVED] Zwave, unknown device NEO Coolcam power plug
[SOLVED] Aeotec Smart Switch 7 - Unknown Device, some beginner questions
PaperUI not setting association groups for Aeotec Door / Window Sensor 7
Reading more data than in the device handler
Problems include z-wave NAS-WR01ZE wall plug
ID Lock 150 Zwave
[SOLVED] Unknown device for z water heatit - how to proceed?
[SOLVED] Upgrade to OH2.5/MS4 over a existing OH2.4 - possible?
Roller Shutter 3 not findable
[SOLVED] Zwave binding: Fibaro fgr 223 - unknown device
Unknown zwave device: Fibaro Walli Rollershutter Switch
ZWave: COMMAND_CLASS_SWITCH_BINARY for endpoint 2 not found
ZWave: COMMAND_CLASS_SWITCH_BINARY for endpoint 2 not found
Fibaro RGBW Controller 2 (FGRGBW-442) - Device unknown - Openhab 2.4.0-1 Release-Build
Nortek HUSBZB-1 Ember Coordinator - Serial Error: Port /dev/ttyUSB1 does not exist
False Motion Alerts from Zooz 4-in-1 (ver 2.0) Sensors
Minoston 2 channel plug
[SOLVED] Nexa Dimmer z-wave zv-9101 version openhab2 2.4.0-1
False Motion Alerts from Zooz 4-in-1 (ver 2.0) Sensors
Fibaro FGD-212 Dimmer 2 v3.5 Type/ID not in Database
ZWave, Fibaro Dimmer2, Scene Activation, "Channel unlinked, polling stopped"
Zipato rgbw2 zwave light bulb erratic behavior
Cancelled Frames after adding new Z-wave devices
[zwave] openHAB 2.5.0 Build #1723 exception during startup
ZWave, Fibaro Dimmer2, Scene Activation, "Channel unlinked, polling stopped"
WTRFID Mini Keypad RFID/Z-Wave
Z-wave UZB after hard reset see nothing
How Do I Set Up A Z-Wave Dead Bolt Lock
Zigbee lights turns back on after Astro-rule turned it off
GE/Jasco New Z-Wave Light Switch not recognized
Secure thermostat not visible in OH
How to control Fakro ARZ solar roller shutter?
Configuring endpoints in the Z-Wave database
Sylvania Smart+ Zigbee BR30 Bulbs with Nortek HUSBZB-1
Zwave2 - Philio PSM02 Slim Multisensor: motion and door sensors seem to be linked
Adding Xstick throws exception
Zigbee Binding 2.4 and Ikea Motion Sensor
Cephei ZigBee Switch
Z-TRM2fx device database update
Configuring zigbee binding
Use latest zwave database with zwave-2.4.0
[SOLVED] [ZWAVE] Lumi switch LM-SxZW showing as Unknown Device
Zwave add new device to OH 2.4 stable
[SOLVED] Z-Wave, Unknown device, 010F:0303:1000:5.0, Fibaro Roller Shutter 3 (FGR-223)
[SOLVED] Z-Wave, Unknown device, 010F:0303:1000:5.0, Fibaro Roller Shutter 3 (FGR-223)
Manually adding Thing Not Recognized Through PaperUI Discovery
HomeSeer HS-WD200+ Channels
Openhab2 zwave binding new devices
Adding Parameters to Aeotec Nano Dimmer
ZWave - Not able to include device FGR223 - how to verify zwave-binding installation
Build binding for 2.4.0, not 2.5.0-SNAPSHOT
Monoprice RGBW Dimmer Not in Database?
WiDOM Smart double switch inclusion problem, no channels
Bitron Video ZigBee USB Funkstick stops working after a while
New Aeotec Door/Window Sensor 7 not in Database yet?
Z-Wave device POPP 700982 (Door/Window sensor) - Unknown association group 1
[SOLVED] Configuration Parameters menu missing from Z-wave device in HABmin - Remotec ZTS-500
New Aeotec Door/Window Sensor 7 not in Database yet?
[SOLVED] Manually Update ZWave Binding?
Unknown Z-Wave device: How to proceed?
[SOLVED] Null pointer exception after switching zigbee device
Trying to switch to Zwave SNAPSHOT binding 2.50
Zigbee device stopped working after update from 2.3 to 2.4
After reboot lost zwave things
HS-WD200+ Update - New Association Group 2
Problems with secure inclusion of Zwave Kwikset 914 lock
Snapshot version of zwave cannot find serial port after OH restart
BE469ZP zwave listed as unknown
Bulbs causing zibee binding to become unresponsive
HANK Flood Sensor FLD01 not recognized
ZWave binding updates
Adding new device or amending exiting device in CD Jackson DB?
[SOLVED] ZW3004 Honeywell Dimmer Switch Unrecognized
OSRAM Smart+ motion sensor
How to upgrade Z-Wave plugin but keep rest of OH intact?
Aeotec LED Bulb 6 in database?
Zigbee binding
Zigbee Re-Joining After Child Aging Timeout
Zigbee - XBee - Coordinator stuck on UNKNOWN
Zigbee binding
Zigbee - XBee - Coordinator stuck on UNKNOWN
[SOLVED] Z-Wave devices remain unknown after update
XBee S2B
Zigbee binding
Smartthings Zigbee outlet item in OH flips off as soon as I turn the outlet on
Battery Drain - Danfoss - Pulling every few seconds
Simplified Jython rule definition (similar to Rules DSL) using a universal decorator
Best practices for z-wave?
QUBINO ZMNHXD1 not included despite in Z-Wave Database
ZWave binding migration to development version
Null pointer exceptions and 500 - Internal server error when configuring z-wave smoke detector
Funky looking z-wave network (which still works fine)?
Z-Wave: No xml for The OCTAN Remote (NodOn)
OH2 Z-Wave refactoring and testing... and SECURITY
Modify a zwave binding jar to add/change a zwave device while waiting for a build
openHAB 2.5.1x release discussion
Benext Energy Switch detected as thing type unknown device
Z-wave database update question
Steinel RS LED D2 Zwave : properties of things are not allowing values which are allowed according to overview
Getting updates
OH3 and zwave binding problem with qubino flush shutter
OH3: MCOHome MH7-WH Thermostat not fully discovered
Z-Wave device should exist in database, but isn't recognized
How to update to latest Zwave Database?
[SOLVED] Very frustrated with ZWave binding and OpenHAB UI
Zigbee CC2531 works for some minutes and then remains "uninitialized"
Options for adding Fibaro FGR223 on OH 2.4

A small suggestion.
Explain in details what this script does (or suppose to do). Help people, thats always nice. But what if something goes wrong… Then it´s nice to know, what was suppose to happen.

I’m guessing you haven’t looked through the readme or script, because there is a lot more information in both. I didn’t think it was necessary to duplicate that information in this post. I plan to include steps to perform the manual installs in the first post, but I’ve been sitting on this script a while and wanted to get it out for people to be able to use. And hopefully save @chris some headaches! As I noted in the readme, there is currently very little error checking. If people are using the script and running into errors, I’ll likely add some. If the script fails, the worst thing that will happen is that you’ll need to log into Karaf to uninstall any old binding(s) and install the serial transport, remove any old jars, download the new jars, and copy them into addons. Exactly as you would need to do if installing them manually. This is still a WIP!

1 Like

You´re right, I didnt look through the readme or the script, sorry!.
I just thought a small note regarding what it actually does would come in hand… But I see now all info is in the readme.

@chris, what would you like done with the development branch options? The zwave one is dead, at least for now, and the bintray never seems to have anything newer than Cloudbees for zigbee. I could make a note to note use them, pull them out completely, or make them into a custom option that points to your server so you can get some test bindings pushed out.

Removing the option is easy… :wink:

For ZWave, it can be removed. For ZigBee, it would be normal to have newer libraries in bintray than in the TP. The libraries are updated every couple of weeks, but Kai doesn’t want the TP updated too often, so this is likely to be every 2 to 3 months. I would therefore expect that this would still be useful where we flow some change into the core libraries, but the TP isn’t updated yet.

Having test bindings on my server is something I might do occasionally in special circumstances (eg maybe I want to temporarily add some heavy debugging, but don’t want to actually put this into github), but I prefer to avoid it if possible. Having an option for this though might be useful as I know it can confuse people.

Thanks for providing this.

Hi @5iver,

I noticed this on GitHub

This script is interactive and will prompt for input. It requires to be executed from the addons directory on the openHAB server, using the same account that runs openHAB . A

Is this account typically openhab?


Yes. The script will let you know if you are using a different account to make sure you know what you are doing.

I seem to be doing something wrong.

I’m trying to run:

sudo -u openhab bash /usr/share/openhab2/zzManualInstall.sh --ACTION zwave --ZWAVE_BRANCH development
Querying configuration parameters...
mkdir: cannot create directory ‘/home/archive’: Permission denied
mkdir: cannot create directory ‘/opt/openhab2-backup’: Permission denied
mkdir: cannot create directory ‘/home/archive’: Permission denied

Downloading latest jar...
mv: cannot stat '/opt/openhab2/userdata/logs/zwave/zwave.log': No such file or directory
cp: cannot stat '/opt/openhab2': No such file or directory
diff: /opt/openhab2: No such file or directory
diff: /home/archive/20181008_230008_openhab2_full/openhab2: No such file or directory

Full backup successful...

Next step is to remove unneeded files. Do you wish to continue?
1) Yes
2) No

What am I doing wrong?

Is this the path where you have your addons ??
I believe the script should be place in the same folder where your addons are located.

1 Like
  1. You are running the backup_and_update.sh script.

  2. You should not select the Development Z-Wave branch, since it has been merged into Master. The discussion above with Chris was in regards to removing the option from the script.

  3. You are not following the instructions in the README.

It requires to be executed from the addons directory on the openHAB server, using the same account that runs openHAB.

@stephanSH, I’m replying here, to keep the Zigbee thread cleaner. I’ve gotten very little feedback on the script, so this is helpful. I’ve been using it successfully for a while, but recently I’ve noticed a couple of issues, likely from OH changes, and plan to clean them up. To address your concerns…

I’ll mention the requirement of curl in the readme, and maybe add a check in the script and message that curl is not installed. Although, I could also use wget. Is that installed by default?

I’m not sure what you meant by this, but assume the context was in the other thread. Are you using the script with arguments? I’ve only been using the menus.

This should not have happened, and does not occur for me. I’m specifically removing any old versions, as having more than one installed will cause a lot of issues. Were there any errors when the script ran?

This definitely should not have happened. I’m thinking the script may have had an error and did not complete. Did you get a message saying it completed successfully?

How are you adding it to the addons.cfg? TMK, this is not possible, but you could be adding the serial binding, which will also install the serial transport. This is what I’ve done, since I was tired of installing it after every OH upgrade (I use snapshots).

Hi scott, thanks for your detailed replies.
I am relatively new to OH so the script was a great help for me and I only wanted to help others with my notes:

  • curl is fine - great idea to add it to the readme. wget is installed by default in ubuntu server 18.04.1
  • following the readme section I thougt I had to insert this value (1.1.7) in the script so chris helped me with the actual version and I thought others might be interested. I used the script with menus but changed that value before
  • the necessity for removal might be explained by the installation of the zigbee binding through PaperUI. I had one error (unfortunately I don’t remember exactly) but the script continued and afterwards it gave me a “completely successful” so I was just happy:-)
  • I added binding = serial1 in the addons.cfg - so after your explanation this is probably the binding. For me it had the same effect as the karaf command

I also use snapshots - but my actual problem is that the mqtt binding is updated which means a lot of work to change many item, but that is another topic…

Glad it helped! And thank you for the feedback. I haven’t heard much, so assumed nobody was using it, or it was working well. It’s worked fine for me until recently (the zwave binding gets upgraded but jasn’t been starting).

The current version should be read in from the repos. If you choose Development, this is displayed as the default, but can be changed…

Occasionally, the build servers are not accessible, or you could have an Internet issue. But I think when this happens, the script will error. The script wold benefit from more error checking, to at least message the user when there is a problem like this.

The script will remove manually installed jars, and bindings installed through Paper UI or Karaf. It sounds to me like the script was not able to get into Karaf when you ran it. This would have prevented the uninstall and installation of the serial transport. Is there anything peculiar to your setup? Are you sure you ran it with the account that runs OH, and entered the correct password?

The older mqtt binding is still available. If you have modified the binding line in addons.cfg, you’ll need to change it to mqtt1.

I believe many had used the scripts as chris had recommended them several times to solve problems. I don’t use zwave - so I had no problems.

great hint for future uses

That might have been the problem… I used it with sudo bash -u openhab …

Yes, I found it, but I don’t believe there is further development in the future so I will have to change it in the future…

Hi @5iver
I´m trying to run your script on a new setup (new Rpi with only one binding running). I discovered I could use it to install the transport-serial-feature.
But I get this error (Karaf). And i can not see if the transport-serial feature got installed.

This script is capable of downloading and manually installing the latest developme                                                     nt or master branch builds of the Z-Wave and Zigbee bindings, and/or the openhab-t                                                     ransport-serial
feature. The script must reside inside the addons folder and be executed on the ma                                                     chine running OH. Before a binding is installed, any previous versions will be
uninstalled. Any manually installed versions will also be backed up by moving them                                                      to addons/archive. The installation of any binding will also include the installa                                                     tion
of the opemnhab-transport-serial feature. After using this script, you can uninsta                                                     ll the bindings by deleting their jars from addons or you can use this script.\033                                                     [0m

!!!!! If you have manually added the Zigbee or Z-Wave binding to your addons.cfg f                                                     ile, they must be removed from the file or the old version will reinstall !!!!!

What would you like to do?
1) Install or upgrade Zigbee binding
2) Install or upgrade Z-Wave binding
3) Install or upgrade both bindings
4) Install the openhab-transport-serial feature
5) Uninstall Zigbee binding
6) Uninstall Z-Wave binding
7) Uninstall both bindings
8) Exit
#? 4

     *****     SUMMARY     *****

Addons path: /usr/share/openhab2/addons
OH account: openhab
Requested action: Install the openhab-transport-serial feature

Is this correct?
1) Yes, start now                      3) Exit
2) No, take me back to the first menu
#? 1

Installing openhab-serial-transport...
mkdir: cannot create directory ‘/usr/share/openhab2/userdata/tmp’: No such file or                                                      directory
KARAF_BASE is not valid: /usr/share/openhab2/userdata


[12:11:25] openhabian@openHABianPi:/usr/share/openhab2/addons$

Sounds like your permissions may be an issue. How are you launching the script? Can you please try getting into Karaf using /usr/share/openhab2/runtime/bin/client?

1 Like

I really hate these permission issues in Linux :face_with_symbols_over_mouth:

I´m not sure how to do that or what you mean :frowning:
I normally enter Karaf by first entering a terminal using openhabian client. And the from the terminal using ssh -p 8101 openhab@localhost. From there I´m promted to write the pw for openhab, which works fine. And then I´m in Karaf.

Just enter the command from an openhabian terminal, instead of using ssh.

Ahh… I thought it was a path… Anyway… It´s working just fine:

[13:26:34] openhabian@openHABianPi:~$ /usr/share/openhab2/runtime/bin/client
Logging in as openhab

                          __  _____    ____
  ____  ____  ___  ____  / / / /   |  / __ )
 / __ \/ __ \/ _ \/ __ \/ /_/ / /| | / __  |
/ /_/ / /_/ /  __/ / / / __  / ___ |/ /_/ /
\____/ .___/\___/_/ /_/_/ /_/_/  |_/_____/
    /_/                        2.4.0
                               Release Build

Hit '<tab>' for a list of available commands
and '[cmd] --help' for help on a specific command.
Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown openHAB.