New binding: panStamp wireless Arduino modules #3187

GideonLeGrange · 2015-09-20T20:48:34Z

A binding to support panStamp wireless Arduino modules.

I have successfully tested the binding on openhab 1.7.x and in compatibility mode on openhab 2.0 alpha2.
I'm busy writing wiki documentation, but for the interim my testing documentation and configs are available here: https://github.com/AutoMates/openhab-panstamp-test

For more information about panStamp, please see: http://panstamp.com/
This library is based on panstamp-java, please see: https://github.com/GideonLeGrange/panstamp-java

GideonLeGrange · 2015-09-22T20:39:31Z

Added Wiki page: https://github.com/openhab/openhab/wiki/panStamp-Binding

watou · 2015-09-23T06:49:53Z

...ab.binding.panstamp/src/main/java/org/openhab/binding/panstamp/internal/PanStampBinding.java

+	}
+
+	@Override
+	protected void execute() {


If you don't use the polling of an AbstractActiveBinding, extend AbstractBinding instead.

GideonLeGrange · 2015-09-23T19:39:10Z

@watou I have changed the inheritance as requested

watou · 2015-09-23T20:16:36Z

Thank you. I hope to offer more comments. Is there a discussion thread?

GideonLeGrange · 2015-09-24T08:26:43Z

Yes, there is: https://community.openhab.org/t/new-binding-panstamp-wireless-arduino-modules/2731

watou · 2015-10-31T10:17:17Z

bundles/binding/org.openhab.binding.panstamp/pom.xml

+	<properties>
+		<bundle.symbolicName>org.openhab.binding.panstamp</bundle.symbolicName>
+		<bundle.namespace>org.openhab.binding.panstamp</bundle.namespace>
+		<deb.name>openhab-addon-binding-PanStamp</deb.name>


use lower case: openhab-addon-binding-panstamp

watou · 2015-10-31T10:49:39Z

Hi @GideonLeGrange, I've made a few more minor review comments on the pull request. Also, could you use the openHAB code formatting (Preferences->Java->Code Style->Formatter) and reformat to that (max line length at 120, for example). There is new activity on the forum with a user hitting a problem with serial port access; perhaps you could comment there? Thanks very much for your excellent work! Regards, John

GideonLeGrange · 2015-11-02T20:40:11Z

Thanks for your code review. I've fixed all the errors you pointed out. I am busy testing and will update the pull request once done.

watou · 2015-11-02T22:26:21Z

Thank you @GideonLeGrange for your excellent work. Could you also add this binding to distribution/pom.xml please?

GideonLeGrange · 2015-11-10T07:39:29Z

@watou I'm having trouble getting Eclipse to find the openHAB code formatter. I followed your instructions but there is no openHAB formatter. I downloaded and ran the yoxos installer as described in the wiki and this installed different version of Eclipse, once again with no formatter.

Any advice is appreciated. I would hate for code formatting to cause my binding to be excluded 😕

hakan42 · 2015-11-29T16:44:44Z

bundles/binding/org.openhab.binding.panstamp/META-INF/MANIFEST.MF

+Bundle-DocURL: http://www.openhab.org
+Bundle-RequiredExecutionEnvironment: J2SE-1.5
+Service-Component: OSGI-INF/binding.xml, OSGI-INF/genericbindingprovider.xml
+Bundle-ClassPath: .,


While not strictly required for OH1, could you add an about.html similiar to https://github.com/openhab/openhab2/blob/master/addons/binding/org.openhab.binding.avmfritz/about.html showing the additional libraries you are using and the licenses they are distributed with?

hakan42 · 2015-12-08T17:11:48Z

@GideonLeGrange , are you still active on the PR?

watou · 2015-12-08T18:02:29Z

I would like to finish my review and merge your binding, @GideonLeGrange, so please let us know and thank you!

watou · 2015-12-27T13:16:18Z

Hello @GideonLeGrange, we are nearly out of time to consider including your binding in openHAB 1.8. Would you be able to make final changes, tests, squash the commit into one, and verify the accuracy/completeness of the companion wiki page, in the coming days? Many thanks for past and future efforts!

watou · 2015-12-27T13:18:02Z

...also, please add the binding to binding/pom.xml and distribution/pom.xml in this PR. Thank you!

GideonLeGrange · 2015-12-29T08:03:38Z

I've got a bit of time this week and will fix the above. I'll be finished before the 1st

watou · 2015-12-29T09:38:16Z

Thanks very much, @GideonLeGrange !

GideonLeGrange · 2015-12-29T12:31:08Z

Recap of this PR:

Tested binding on openhab 1.7
Tested binding on openhab 2.0 alpha2
Created wiki page https://github.com/openhab/openhab/wiki/panStamp-Binding
Fixed a long list of concerns raised by @watou
Formatted code using openHAB code formatter
Added to distribution/pom.xml
Reviewed the wiki page to make sure it is current
Added about.html as requested by @hakan42
Did top-level mvn clean install successfully
Did squash on pull request

GideonLeGrange · 2015-12-29T12:33:37Z

@watou I'm done, except that I'm having issues with the squash. I tried the squash as per this document https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request but run into two problems:

There seems to be an issue with distribution/pom.xml where I keep having to fix merge conflicts when rebasing.
I still see multiple commits at the top of the PR. It isn't clear to me if this is correct or indicative of a non-squashed commit.

watou · 2015-12-29T13:40:47Z

Here is how I would go about rebasing and squashing. In your local fork:

git checkout master
git fetch upstream
git merge upstream/master
# your local master is now same as openhab repo
git push origin master
# up-to-dateness is now reflected in your fork at github
git checkout panstamp-pr
git merge-base panstamp-pr master
# copy the return string to clipboard
git rebase -i <the string returned above>
# fix any merge conflicts  between >>>> and <<<< markers
# change 2nd and subsequent pick to squash
# force push your branch to github:
git push -f origin panstamp-pr
# go to github and see if the PR looks correct

GideonLeGrange · 2015-12-29T15:18:49Z

@watou Squash completed, I think this should be it.

hakan42 · 2015-12-29T15:24:23Z

@GideonLeGrange sorry to come up with a last comment but I just noticed that you reference (and bring the binary for it) slf4j-api-1.7.7 in your pull request. Is that necessary? Is it possible to remove that dependency and use whatever the Openhab core provides to you?

watou · 2015-12-29T15:50:18Z

Good catch, @hakan42. @GideonLeGrange, if you could remove that lib, make sure mvn clean install still works in your project, make sure the resulting (and now smaller) binding JAR still works correctly, commit the change, squash the commits, and git push -f origin <your branch>, we should be good to merge.

Also, please promote your work, if you don't mind, at https://community.openhab.org, also describing the PanStamp system and its features and benefits. The binding will be available after the next nightly build after the merge, and also in openHAB 1.8.

Thanks for your perseverance!

watou · 2015-12-29T15:53:09Z

bundles/binding/org.openhab.binding.panstamp/about.html

+		<strong>slf4j 1.7.7</strong> <br/><br/>
+		<a href="https://github.com/GideonLeGrange/panstamp-java">The Simple Logging Facade for Java</a> obtained from Maven central repository under 
+		<a href="http://www.slf4j.org/license.html">a copy of the MIT License</a>.
+		</em></p>


remove above section

@watou

Changed binding to extend AbstractBinding Moved to panstamp-java 2.1 Changes as requested by @watou. Still needs formatting fixed. Updated to latest panstamp-java library build Formatted with openHAB formatter Revert "Formatted with openHAB formatter" This reverts commit ee8f6df. Reformatting of files not in my work sneaked in. Reformatted using openHAB code formatter (this time excluding other directories) Fixed mistake I made when fixing merge conflicts Removed slf4j from includes Removed spurious reference to io.caldav? Removed include of nrjavaserial Trying to sort that weird caldav include

GideonLeGrange · 2015-12-29T17:28:01Z

@hakan42 @watou I've removed all external jars except for the panstamp-java library. I found gnu.io (provided by nrjavaserial) being exported by one of the transport modules, so dependencies are stripped to the absolute minimum.

@watou I've removed that spurious reference to io.caldav too - it seems to have been bad dependency ordering in the pom on my part, probably happened when resolving merge conflicts.

Commits squashed.

New binding: panStamp wireless Arduino modules

watou · 2015-12-29T17:49:56Z

Nice wiki page. I've made a small typo correction to it. Many thanks.

hakan42 · 2015-12-29T19:27:51Z

Very nice, thank you for your efforts.

watou reviewed Sep 23, 2015
View reviewed changes

teichsta added the new-binding-action-service label Oct 5, 2015

watou reviewed Oct 31, 2015
View reviewed changes

teichsta added the awaiting-feedback label Nov 2, 2015

watou mentioned this pull request Nov 24, 2015

New generic JDBC Persistence Service #3248

Merged

hakan42 reviewed Nov 29, 2015
View reviewed changes

watou mentioned this pull request Dec 9, 2015

Added Sallegra binding #3520

Closed

hakan42 mentioned this pull request Dec 14, 2015

Mystrom Binding #3076

Merged

watou reviewed Dec 29, 2015
View reviewed changes

watou removed the awaiting-feedback label Dec 29, 2015

watou added this to the 1.8.0 milestone Dec 29, 2015

watou added a commit that referenced this pull request Dec 29, 2015

Merge pull request #3187 from AutoMates/panstamp-pr

6d7130c

New binding: panStamp wireless Arduino modules

watou merged commit 6d7130c into openhab:master Dec 29, 2015

GideonLeGrange deleted the panstamp-pr branch December 29, 2015 20:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New binding: panStamp wireless Arduino modules #3187

New binding: panStamp wireless Arduino modules #3187

GideonLeGrange commented Sep 20, 2015

GideonLeGrange commented Sep 22, 2015

watou Sep 23, 2015

GideonLeGrange commented Sep 23, 2015

watou commented Sep 23, 2015

GideonLeGrange commented Sep 24, 2015

watou Oct 31, 2015

watou commented Oct 31, 2015

GideonLeGrange commented Nov 2, 2015

watou commented Nov 2, 2015

GideonLeGrange commented Nov 10, 2015

hakan42 Nov 29, 2015

hakan42 commented Dec 8, 2015

watou commented Dec 8, 2015

watou commented Dec 27, 2015

watou commented Dec 27, 2015

GideonLeGrange commented Dec 29, 2015

watou commented Dec 29, 2015

GideonLeGrange commented Dec 29, 2015

GideonLeGrange commented Dec 29, 2015

watou commented Dec 29, 2015

GideonLeGrange commented Dec 29, 2015

hakan42 commented Dec 29, 2015

watou commented Dec 29, 2015

watou Dec 29, 2015

GideonLeGrange commented Dec 29, 2015

watou commented Dec 29, 2015

hakan42 commented Dec 29, 2015

New binding: panStamp wireless Arduino modules #3187

New binding: panStamp wireless Arduino modules #3187

Conversation

GideonLeGrange commented Sep 20, 2015

GideonLeGrange commented Sep 22, 2015

watou Sep 23, 2015

Choose a reason for hiding this comment

GideonLeGrange commented Sep 23, 2015

watou commented Sep 23, 2015

GideonLeGrange commented Sep 24, 2015

watou Oct 31, 2015

Choose a reason for hiding this comment

watou commented Oct 31, 2015

GideonLeGrange commented Nov 2, 2015

watou commented Nov 2, 2015

GideonLeGrange commented Nov 10, 2015

hakan42 Nov 29, 2015

Choose a reason for hiding this comment

hakan42 commented Dec 8, 2015

watou commented Dec 8, 2015

watou commented Dec 27, 2015

watou commented Dec 27, 2015

GideonLeGrange commented Dec 29, 2015

watou commented Dec 29, 2015

GideonLeGrange commented Dec 29, 2015

Recap of this PR:

GideonLeGrange commented Dec 29, 2015

watou commented Dec 29, 2015

GideonLeGrange commented Dec 29, 2015

hakan42 commented Dec 29, 2015

watou commented Dec 29, 2015

watou Dec 29, 2015

Choose a reason for hiding this comment

GideonLeGrange commented Dec 29, 2015

watou commented Dec 29, 2015

hakan42 commented Dec 29, 2015