If youāre new to openHAB (or not upgrade savvy) here are some instructions on how to quickly get my test version of the Plugwise Binding running. If you have an existing openHAB installation you can also create a new directory with openHAB for testing. Both installations can coexist peacefully, as long as they are not running at the same time.
For a more in depth version of the openHAB installation see: http://www.openhab.org/getting-started/index.html
Because openHAB depends on Java, make sure it is installed. To verify it is setup properly, issue ājava -versionā on the command line. When it says version 1.7.0 or higher, continue below.
openHAB 1.8
Version 1.8.3 is the latest stable openHAB version. It works well but may not look as fancy or be as user friendly as openHAB 2.0.
Downloads
File extraction
- Extract all files from distribution-1.8.3-runtime.zip to a new directory (referred to as OH1_HOME from now on)
- Extract org.openhab.binding.serial-1.8.3.jar from distribution-1.8.3-addons.zip to OH1_HOME/addons
- Extract org.openhab.binding.plugwise-1.9.0-SNAPSHOT.jar from openhab-plugwise-binding-issue-4565-test-20160814.zip to OH1_HOME/addons
- Extract plugwise.items from openhab-plugwise-binding-issue-4565-test-20160814.zip to OH1_HOME/configurations/items/plugwise.items
- Extract default.sitemap from openhab-plugwise-binding-issue-4565-test-20160814.zip to OH1_HOME/configurations/sitemaps/default.sitemap
Configuration
- Use the default openHAB configuration as starting point by copying OH1_HOME/configurations/openhab_default.cfg to OH1_HOME/configurations/openhab.cfg
- Open OH1_HOME/configurations/openhab.cfg in your favorite text editor, find the Plugwise section and replace it with that of plugwise.cfg from openhab-plugwise-binding-issue-4565-test-20160814.zip
- Update plugwise:stick.port to the serial port of your Stick. On Windows this is the COM port, e.g.: COM1
- Replace the MAC of plugwise:lamp.mac with that of your Circle+
- Replace the MACs of the other devices with one that matches the device type
- Save your changes to the file
Note 1: The MACs are stickered to the back of devices. The binding uses full MACs i.e. also the fine print on the sticker. If you donāt want to get off your chair, climb up ladders and unplug devices all across your home, causing all sorts of havoc; you can also find them in Source. Open Settings > Appliances . Then double click on an appliance. Click on the little Circle icon to the right of the short Address to see the details of a module and the full MAC (Address). Similarly the MACs of a Scan, Sense and Switch can also be obtained from the Appliances screen by double clicking them in the āSensors and other modulesā list.
Note 2: When you changed the device IDs (lamp, fan, etc.), make sure you update the references to them in OH1_HOME/configurations/items/plugwise.items
Running and testing
- Start the runtime by executing OH1_HOME/start.sh (or OH1_HOME\start.bat) on Windows
- Open the following URL in your browser:
http://<openHAB address or hostname>:8080
- To stop the runtime press
CTRL+C
in the openHAB console
openHAB 2.0
Version 2.0 is the beta openHAB version. It may be a little buggy but it looks better with itās Basic UI and Paper UI. Another major feature is that it is possible to configure things and bindings through the UI instead of editing files. Though this is not yet supported by the current Plugwise Binding.
Downloads
File extraction
- Extract all files from openhab-offline-2.0.0-SNAPSHOT.zip to a new directory (referred to as OH2_HOME from now on)
- Extract org.openhab.binding.plugwise-1.9.0-SNAPSHOT.jar from openhab-plugwise-binding-issue-4565-test-20160814.zip to OH2_HOME/addons
- Extract plugwise.items from openhab-plugwise-binding-issue-4565-test-20160814.zip to OH2_HOME/conf/items/plugwise.items
- Extract plugwise.cfg from openhab-plugwise-binding-issue-4565-test-20160814.zip to OH2_HOME/conf/services/plugwise.cfg
- Extract default.sitemap from openhab-plugwise-binding-issue-4565-test-20160814.zip to OH2_HOME/conf/sitemaps/_default.sitemap <= make sure the file starts with the underscore so it is used as default sitemap
Configuration
- Open OH2_HOME/conf/services/plugwise.cfg in your favorite text editor
- Update plugwise:stick.port to the serial port of your Stick. On Windows this is the COM port, e.g.: COM1
- Replace the MAC of plugwise:lamp.mac with that of your Circle+
- Replace the MACs of the other devices with one that matches the device type
- Save your changes to the file
Note 1: The MACs are stickered to the back of devices. The binding uses full MACs i.e. also the fine print on the sticker. If you donāt want to get off your chair, climb up ladders and unplug devices all across your home, causing all sorts of havoc; you can also find them in Source. Open Settings > Appliances. Then double click on an appliance. Click on the little Circle icon to the right of the short Address to see the details of a module and the full MAC (Address). Similarly the MACs of a Scan, Sense and Switch can also be obtained from the Appliances screen by double clicking them in the āSensors and other modulesā list.
Note 2: When you changed the device IDs (lamp, fan, etc.), make sure you update the references to them in OH2_HOME/conf/items/plugwise.items.
Running and testing
- Start the runtime by executing OH2_HOME/start.sh (or OH2_HOME\start.bat) on Windows
- Open the following URL in your browser:
http://<openHAB address or hostname>:8080
-
(First run only) Install the Serial Binding via
Paper UI > Extensions > Bindings
, and click back until you return to the UI selection screen.
- Choose either Basic UI or Classic UI to start testing
- To stop the runtime press
CTRL+D
in the openHAB console
Known openHAB 2.0 issues you will likely run into
- When you rename or remove devices from plugwise.cfg they are still persisted in openHAB. To fix this enter
config:delete Plugwise
in the openHAB console and restart openHAB. This will clear the persisted Plugwise configuration and reload it from plugwise.cfg
- When items are updated in Basic UI they lose their formatting or show incorrect colors/icons, see: https://github.com/eclipse/smarthome/issues/640
Plugwise binding configuration
For more information on how to configure the Plugwise binding see: