Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[nibeheatpump] Added device support for SMO40 control #9376

Merged
merged 7 commits into from
Dec 25, 2020

Conversation

MarkusGafner
Copy link
Contributor

Added the support of a new heatpump. Therefore all files got created and modified, as described in the repository, to communicate with this device. Tested with the system in the last 2 months without any problems

@cpmeister cpmeister added the enhancement An enhancement or new feature for an existing add-on label Dec 15, 2020
@fwolter
Copy link
Member

fwolter commented Dec 15, 2020

@paulianttila can you take a look?

@MarkusGafner can you fix the sign-off in your commit? You could click on the DCO check details below to see what's wrong and how to fix it.

Copy link
Contributor

@paulianttila paulianttila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just few typos, otherwise LGTM

bundles/org.openhab.binding.nibeheatpump/README.md Outdated Show resolved Hide resolved
Copy link
Member

@fwolter fwolter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paulianttila Thanks for reviewing in advance!

@MarkusGafner Thanks for your contribution! Here comes my review feedback.

bundles/org.openhab.binding.nibeheatpump/README.md Outdated Show resolved Hide resolved
<item-type>Number</item-type>
<label>External ERS 1 accessory GQ2 speed</label>
<description>Indicates the speed of the GQ2 fan speed on the ERS accessory.</description>
<state pattern="%d %" readOnly="true">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be escaped. Please check all.

Suggested change
<state pattern="%d %" readOnly="true">
<state pattern="%d %%" readOnly="true">

<channel-type id="smo40-48376" advanced="true">
<item-type>Switch</item-type>
<label>Op mode circ.pump Heat Slave 7</label>
<description></descr
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the spaces in the pattern intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The label string is given by the manufacturer

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like GitHub mixed up some lines in this review. I was refering to line 8110:
<state min="-10" max="10" step="1" pattern="%d " readOnly="false">

<channel-type id="smo40-48376" advanced="true">
<item-type>Switch</item-type>
<label>Op mode circ.pump Heat Slave 7</label>
<description></descr
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this file generated code? Actually labels are expected to be as short as possible. Guideline is 2-3 words with up to 25 chars. See https://www.openhab.org/docs/developer/bindings/thing-xml.html#formatting-labels-and-descriptions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As written before, the strings are given by the manufacturer and I won't change them.

<description>UDP port to send write commands to the NibeGW.</description>
<default>10000</default>
</parameter>
<parameter name="refreshInterval" type="integer">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<parameter name="refreshInterval" type="integer">
<parameter name="refreshInterval" type="integer" min="0" unit="s">


<config-description>
<parameter name="serialPort" type="text" required="true">
<label>Serial Port</label>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could specify <context>serial-port</context> to get a free validation.

<label>Serial Port</label>
<description>Serial port to connect to the heat pump.</description>
</parameter>
<parameter name="refreshInterval" type="integer">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<parameter name="refreshInterval" type="integer">
<parameter name="refreshInterval" type="integer" min="0" unit="s">

<default>false</default>
</parameter>
<parameter name="enableWriteCommandsToRegisters" type="text">
<label>Register List for Write Commands</label>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above. Label length.

</channel-groups>

<config-description>
<parameter name="refreshInterval" type="integer">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<parameter name="refreshInterval" type="integer">
<parameter name="refreshInterval" type="integer" min="0" unit="s">

@fwolter fwolter self-assigned this Dec 19, 2020
@fwolter
Copy link
Member

fwolter commented Dec 19, 2020

Your changes look good! Can you fix the DCO check? You can click on details below to view the necessary commands.

MarkusGafner and others added 7 commits December 19, 2020 19:38
Signed-off-by: Markus Gafner <[email protected]>
Co-authored-by: Fabian Wolter <[email protected]>
Signed-off-by: Markus Gafner <[email protected]>
…-INF/thing/SMO40-types.xml

Co-authored-by: Fabian Wolter <[email protected]>
Signed-off-by: Markus Gafner <[email protected]>
Signed-off-by: Markus Gafner <[email protected]>
Signed-off-by: Markus Gafner <[email protected]>
Copy link
Member

@fwolter fwolter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

As OH3 is already feature-freezed, your PR will be merged as soon as OH3 is released. Your changes will go into OH3.1, then.

@fwolter fwolter merged commit ca64d11 into openhab:main Dec 25, 2020
seaside1 pushed a commit to seaside1/openhab-addons that referenced this pull request Dec 28, 2020
seaside1 pushed a commit to seaside1/openhab-addons that referenced this pull request Dec 28, 2020
thinkingstone pushed a commit to thinkingstone/openhab-addons that referenced this pull request Nov 7, 2021
marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this pull request May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An enhancement or new feature for an existing add-on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants