Development of Binding "Hello Dolly" for openHAB 2.5.x

Jochen_Bauer · October 5, 2019, 2:27pm

Dear Community,

It seems useful for me to create a new binding to improve my skills regarding the new procedures of openHAB 2.5.x.

Therefore I picked the Helly Dolly approach, which is quite famous in the WordPress community: a line of the lyrics of the Louis Armstrong’s song will be shown in a text field on the user interface.

My goal is that this thread will help other developers too, who want to get started with binding development. Maybe it will be even possible to put the contents of this thread into the official docs after the binding will be finished. I will keep this thread updated and thanks in advance for all the people who want to contribute or support me with some advice.

Best regards,
Jochen

Workflow of creating the Helly Dolly binding:

Start with an issue on Github, here issue number 6176, see https://github.com/openhab/openhab2-addons/issues/6176
Start a discussion thread here in this community, see this thread.
Fork openhab2-addons project and create your own fork, here “feature-binding-helly-dolly”, see https://github.com/Jochen1980/openhab2-addons/tree/feature-binding-hello-dolly/bundles/org.openhab.binding.hellodolly
Sign the commit with your name and the corresponding ticket.
Build your binding skeleton by using “mvn clean install”.
copy the jar-file of the binding target folder to an openHAB-runtime environment in the addons folder and verify if the binding was successfully added by opening the PaperUI, binding configuration section.
continue to build the binding …
create a pull request to the main repo.

Bruce_Osborne · October 5, 2019, 2:29pm

That looks to be a variant of the standard “Hello, World” used in programming.

Jochen_Bauer · October 5, 2019, 2:35pm

Yes, it is like a Hello World …

Jochen_Bauer · October 15, 2019, 5:21pm

Next step: as you can see I was assigned to the “hello dolly” binding issue, see https://github.com/openhab/openhab2-addons/issues/6176 .

Now I wrote more code and I want to commit again. The binding code is in its own branch and “mvn clean install -DskipChecks=true -DskipTests=true” builds successfully.

Do I need to update my branch “feature-hello-dolly-binding” by pulling in the newest changes of the current openhab2-addons master branch into my branch? Thanks in advance for your answer.

UPDATE: the contribution guidelines gave me a hint (see https://github.com/openhab/openhab2-addons/blob/master/CONTRIBUTING.md ). So it is forbidden to add commits of other people to a PR - that means imho it is not possible to pull in such commits into your feature branch before your commit?! Summing up, I committed my local changes to my remote repo and created a PR to the master branch of openhab2-addons. Github said that a merge into the master branch should work automatically.

UPDATE 2: the Travis CI tool mentioned that there were no problems related to my PR.