Prepare for PR into Master

[boc-tothefuture]

With the addition of the audio zone controls, I have what I need to stop using the V1 driver and use this for control of our system.
I am opening this issue so we can track what we need to do to prepare a PR to merge this into the 2.1 branch for release with the next version of OpenHab.

Items that I know are missing:

• Documentation
• Migrate to new build system
• Standardize item and trigger naming conventions
• Add non-null annotations
• Update license headers
• Fix SAT / Compiler check errors

[digitaldan]

If no one else has one, i can check in the initial README

[boc-tothefuture]

@digitaldan - Sounds good to me. I don't have one. I was wondering if we could try and recruit someone from the forum who isn't a developer but wants to use the driver. They could help via documentation. But if you have a first pass, go for it!

[digitaldan]

Just checked in a README we can start working on.

[boc-tothefuture]

@digitaldan @craigham -
Do we think we are ready to push this to master? Or do we still need to work on the documentation more?

[digitaldan]

Hi guys, sorry I have been not around much lately. I'm in between houses (sold mine and moved out, remodeling the new one before we move in) and don't have a real OH server running. So I'm not going to be much help. So i leave it to you :-)

[craigham]

@digitaldan you're not going to live try living without an omnilink at your new house are you?

[craigham]

@boc-tothefuture I'll try to make some time to get the code fitting the guidelines. I've been working on some other projects lately, but I'll try and get to it late next week. Unless you want to run with it a bit, that is cool too.

[boc-tothefuture]

The main thing holding this back from being able to merge into the official openhab is a lack of documentation.
@swamiller / @BCS-JonW -
Would either of you be willing to take the task of creating the documentation for the binding? If someone else can own the task of making the documentation I can focus on our backlog of features.
I am happy to help by answering any questions.

[W6HBR]

@boc-tothefuture - unfortunately I have a few projects at the moment that are sucking up my time. I'm about 60 days out from seeing any letup to take on anything else.

[swamiller]

@boc-tothefuture - I don't mind helping document where I can but I have zero GitHub skills.

[bschimmelmann]

Hi everyone,
I just wanted to ask, if the RNET code was abandoned? It appears it has been removed, rather than pulled into the master? Was that just for lack of documentation? Is there anything anyone can do to help? I would so much love for this feature to be available.

[boc-tothefuture]

@bschimmelmann -> Can you point to the RNET code you are talking about?

[bschimmelmann]

@boc-tothefuture - thanks for the quick response. I'm a real novice in this, but it appears that the entire folder openhab2-addons/addons/binding/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rnet/ is gone with all related classes. From my understanding, this was the main thing that Craig had developed last year. If I understand the log correctly, this was removed on 13/Dec/17, which I don't understand (or am I just reading this wrong?).

[boc-tothefuture]

Ahh.. @craigham will have to answer that. I guess this repository is used for both russound and Omnilink. I am only familiar with the omnilink side of the project (and that is what this particular issue is tracking).

[bschimmelmann]

Oh, sorry, dind't realize this was Omnilink related. I thought it was a general PR into Master (incl. the RNET content). @craigham, has the RNET content been removed in order to get Omnilink merged into Master? If so, is there another branch that is attempting to get RNET back into Master as well? I would be really keen in seeing your RNET implementation in action :-).

[craigham]

@bschimmelmann the russound rnet code which could be contributed to the russound binding is in the russound-rnet2 branch now.

I have not been very active with the openhab stuff lately as I have been working on other things. I think the biggest thing holding back this rnet code getting merged to master are simple things like documentation, and other code compliance requirements such as licenses, etc. If you think you could help by moving that along it would be much appreciated. My master is now maybe 2 minor releases behind the main openhab, and I have found getting it caught up very complex and confusing, and that has pretty much stalled me for both the russound binding as well as the other two bindings (omnilink, isy) which you will find the code for in my repository. I do hope to make some more time this fall for the openhab stuff, but just not sure.

[boc-tothefuture]

Updated the checklist above.. Before we merge into master we should standardize (and match the openhab standard) for our channel names. Some are camelCase, some are snake_case.