Skip to content

Comments

Fix documentation, grammar, and spelling in bindings W-Z#19603

Merged
jlaur merged 14 commits intoopenhab:mainfrom
lsiepel:spelling-w
Feb 1, 2026
Merged

Fix documentation, grammar, and spelling in bindings W-Z#19603
jlaur merged 14 commits intoopenhab:mainfrom
lsiepel:spelling-w

Conversation

@lsiepel
Copy link
Contributor

@lsiepel lsiepel commented Nov 1, 2025

No description provided.

@ccutrer
Copy link
Member

ccutrer commented Nov 1, 2025

In WiZ, you changed the light#mode channel from a string to a number. The handler provides a StringType when sending updates to that channel, even though its value will be the string representation of a number. For commands, it treats it as a string and will look for values matching it as a number, or various string forms. Creating the channel as a Number circumvents that's extra logic. If your contention is that the channel definition already handles the mapping of string named modes to the number representation, that's probably fine, but I think that would be better as a separate PR that also removes the string matching in the handler. And updates the handler to provide a DecimalType instead of a StringType when sending updates to the channel.

@lsiepel
Copy link
Contributor Author

lsiepel commented Nov 1, 2025

In WiZ, you changed the light#mode channel from a string to a number.

That one slipped trough, Thanks for checking. I'll revert that itemtype. When i see the option list, i must say a number type would be a better fit, but that should be changed in a separate PR.

Edit: Fixed.

Copy link
Member

@ccutrer ccutrer left a comment

Choose a reason for hiding this comment

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

LGTM for WiZ

Copy link
Contributor

@marcelrv marcelrv left a comment

Choose a reason for hiding this comment

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

LGTM wrt windcentrale

Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

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

Otherwise LGTM for WeMo.

@lsiepel
Copy link
Contributor Author

lsiepel commented Nov 22, 2025

Build fails due to #19650

Copy link
Contributor

@hmerk hmerk left a comment

Choose a reason for hiding this comment

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

LGTM

@lsiepel lsiepel requested a review from jlaur November 23, 2025 15:06
Copilot AI review requested due to automatic review settings December 7, 2025 08:40
Copilot AI review requested due to automatic review settings December 28, 2025 21:19
@lsiepel lsiepel requested a review from grro as a code owner December 28, 2025 21:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request provides comprehensive documentation, grammar, and spelling improvements across openHAB bindings with names starting with letters W through Z. The changes focus on improving clarity, consistency, and correctness in user-facing text.

Key Changes

  • Capitalization consistency: Standardized "Thing" capitalization throughout documentation and configuration files
  • Grammar and punctuation improvements: Fixed sentence structure, added missing periods, improved comma usage, and corrected verb forms
  • Spelling corrections: Fixed typos like "sendComand" → "sendCommand", brand names like "WeatherUnderground" → "Weather Underground"
  • Terminology improvements: Clarified technical terms (e.g., "WiFi" → "Wi‑Fi", "WebSocket server" → "web service")
  • Documentation clarity: Improved descriptions to be more precise and user-friendly across configuration parameters and channel descriptions

Reviewed changes

Copilot reviewed 67 out of 67 changed files in this pull request and generated no comments.

Show a summary per file
File Description
zway binding Capitalized "Thing" consistently, improved grammar in descriptions
zwavejs binding Fixed punctuation, improved parameter descriptions, capitalized "Command Class" and "Node", changed "required=true" to "required=false" for optional parameters
zoneminder binding Improved channel descriptions, fixed grammar, standardized terminology
yioremote binding Enhanced description clarity, fixed grammar
yeelight binding Improved channel descriptions for better clarity
yamahareceiver binding Fixed capitalization ("Receiver" → "receiver"), improved descriptions with better punctuation
yamahamusiccast binding Enhanced clarity of MusicCast-related descriptions
xmppclient binding Improved XMPP terminology descriptions, better formatting
xmltv binding Capitalized "XMLTV" consistently, improved channel descriptions
x binding Improved Twitter/X binding descriptions for clarity
wundergroundupdatereceiver Capitalized "Thing" consistently
wolfsmartset binding Improved table formatting and descriptions
wled binding Enhanced channel descriptions and table formatting
wlanthermo binding Capitalized "Thing" consistently
wiz binding Fixed "WiFi" → "Wi‑Fi", improved descriptions
windcentrale binding Improved refresh interval descriptions
wifiled binding Fixed "WiFi" → "Wi‑Fi", improved program names (e.g., "Red,Green" → "Red/Green")
wemo binding Fixed numerous typos (e.g., "DemoLoght2" → "DemoLight2"), improved channel descriptions, capitalized "WeMo" correctly
webthing binding Improved table formatting
webexteams binding Rebranded "WebexTeams" → "Webex Teams" consistently
weatherunderground binding Fixed capitalization, improved descriptions and table formatting
weathercompany binding Fixed label errors ("Day 3" → "Day 4"), improved descriptions, fixed pattern formatting
warmup binding Fixed "WiFi" → "Wi‑Fi", improved channel descriptions

The changes are exclusively documentation improvements with no functional code modifications, making this a safe enhancement to the user experience.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

lsiepel and others added 9 commits January 2, 2026 12:25
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Co-authored-by: Jacob Laursen <jacob-github@vindvejr.dk>
Signed-off-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

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

Thanks! Just a few comments.

| serialNumber | String | Device Serial Number, excluding last 3 characters | true | |
| overrideDuration | Integer | Duration in minutes of override when target temperature is changed | false | 60 |
| serialNumber | String | Device serial number, excluding the last 3 characters | true | |
| overrideDuration | Integer | Duration in minutes of override when target temperature is changed | true | 60 |
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it should rather be changed to required="false" here, since it has a default value:

<parameter name="overrideDuration" type="integer" unit="m" required="true">
<label>Override Duration</label>
<description>Duration in minutes of override when target temperature is changed</description>
<default>60</default>
</parameter>

Suggested change
| overrideDuration | Integer | Duration in minutes of override when target temperature is changed | true | 60 |
| overrideDuration | Integer | Duration in minutes of override when target temperature is changed | false | 60 |

Copy link
Contributor Author

@lsiepel lsiepel Feb 1, 2026

Choose a reason for hiding this comment

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

Are you sure?
Up to now, i thought that having a default or not. Required also signals the UI to have a value.
But now i wonder if that is true, How ould one unset a default value. E.g. remove it from the jsondb to stick to the default value from the binding. aargh :-/

Copy link
Contributor

@jlaur jlaur Feb 1, 2026

Choose a reason for hiding this comment

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

Example (defaults to required="false"):

<parameter name="currencyCode" type="text">
<label>Currency Code</label>
<description>Currency code in which to obtain spot prices.</description>
<default>DKK</default>
<options>
<option value="DKK">Danish Krone</option>
<option value="EUR">Euro</option>
</options>
</parameter>

/**
* Currency code for the prices.
*/
public String currencyCode = EnergiDataServiceBindingConstants.CURRENCY_DKK.getCurrencyCode();

Never set:

Image

Click to upper right corner to clear:

Image

Save - and it's back to default. Code tab:

version: 1
things:
  energidataservice:service:311fd75536:
    config:
      priceArea: DK1
      currencyCode: DKK
      hourlySpotPrices: false
      gridCompanyGLN: "5790000705184"
      energinetGLN: "5790000432752"
      reducedElectricityTax: false

Remove it:

version: 1
things:
  energidataservice:service:311fd75536:
    config:
      priceArea: DK1
      hourlySpotPrices: false
      gridCompanyGLN: "5790000705184"
      energinetGLN: "5790000432752"
      reducedElectricityTax: false

And save. It's back.

Warmup binding:

Image

Deleting the "0", now trying to delete "6", but that instantly causes it to go back to 60:

Image

If I delete it in the code tab, it automatically is restored. File-based configuration seems to work as well:

Thing warmup:room:test"Room" (warmup:my-warmup:test) [serialNumber="123"]
Image

So here the only problem seems to be that you can't actually delete it in the UI.

I think it's most logical to leave parameters having a default value as optional, since the binding can then just use the default value. I think there used to be more annoying issues, but right now can't remember or reproduce.

Copy link
Contributor

Choose a reason for hiding this comment

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

Anyway, that's how the binding is now, and you just updated the documentation to reflect that, so it's fine for this PR.

Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Co-authored-by: Jacob Laursen <jacob-github@vindvejr.dk>
Signed-off-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

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

LGTM

@jlaur jlaur merged commit d07447b into openhab:main Feb 1, 2026
2 checks passed
@jlaur jlaur added this to the 5.2 milestone Feb 1, 2026
@lsiepel lsiepel deleted the spelling-w branch February 1, 2026 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants