[tibber] Rework binding (channel groups, UoM, Thing actions and more) by weymann · Pull Request #18726 · openhab/openhab-addons

weymann · 2025-05-29T21:49:13Z

~~It's WIP but I tested now for 2 weeks and it's published on Marketplace. Please start review!~~

On first hand PR shall solve issue #18506. Seeing all these null fields in the binding it's hard to determine which thread is settiing which variable to null so I decided for a rework.

Rework Rationale

spot-prices obtained once per day respecting retry machanism
spot-prices were Number:Dimensionless - now tit's changed to Number:EnergyPrice
price level polled every minute.
price level is a human readable String . Now it's a Number machine readable with < 0 cheap and > 0 expensive.
price level now avaialble as TimeSeries
channels according to styleguide without underlines like live_
logic groups for live power channels and statistic kWh channels

Rework contains:

Configuration
- updateHour - hour of day when prices shall be updated. Retries are performed accoring to Tibber API requirements.
Channels rework
- price group
  - spot-prices current and forecast prices as Number:EnergyPrice
  - level current and forecast price levels as Number with 0=Normal, negative values cheaper, positve values expensive
  - average current and forecast of 24h average prices as Number:EnergyPrice
- live group for Tibber Pulse power, voltage and current values
- statistics group for Tibber Pulse energy values
ThingActions added for price calculations
- priceInfoStart - earliest price info available
- priceInfoEnd - latest price info available
- listPrices - retreive list in ascending / descending order of prices
- bestPricePeriod - calculate best rpice in consecutive period
- bestPriceSchedule - calculate best rpice as non consecutive schedule

openhab-bot · 2025-05-29T22:01:35Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/tibber-oh5/164158/4

mstormi · 2025-07-05T09:49:08Z

@lsiepel I believe @kjoglum is no longer with us, I haven't heard anything from him in several months although I tried to contact him.

Can you please reassign this review to someone else, yourself maybe?
It's really about fixing bugs/annoyances anyone to use the current Tibber binding keeps encountering more or less weekly.
Thanks!

Copilot

Pull Request Overview

This PR reworks the Tibber binding for OpenHAB 5, consolidating channels into three groups, updating the spot-price logic, and adding comprehensive test coverage and migration instructions.

Introduces three channel groups (price, live, statistics) and updates thing-types and channel-types to match the OH5 style guide.
Adds new test resources and unit tests for spot prices, price schedules, laundry-curve parsing, and action APIs.
Updates migration instructions (instructions.xml) to remove old channels and add new ones, and replaces the refresh parameter with updateHour.

Reviewed Changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/main/resources/OH-INF/update/instructions.xml	Updated migration instructions for OH5, removing old and adding new channels.
src/main/resources/OH-INF/thing/thing-types.xml	Removed legacy channels, defined channel groups, bumped `thingTypeVersion` to 3, added `updateHour` config.
src/main/resources/OH-INF/thing/price-group.xml	Defined the `price` channel group with new channel IDs.
src/main/resources/OH-INF/thing/live-group.xml	Defined the `live` channel group and its channels for pulse data.
src/main/resources/OH-INF/thing/statistics-group.xml	Defined the `statistics` channel group for energy/production stats.
src/test/resources/curve.json	Test resource for laundry-curve conversion (contains a JSON syntax issue).

Comments suppressed due to low confidence (2)

bundles/org.openhab.binding.tibber/src/main/resources/OH-INF/thing/price-group.xml:10

Channel ID spot-price does not match the migration instructions which add spot-prices. Please unify the ID names for consistency.

			<channel id="spot-price" typeId="price">

bundles/org.openhab.binding.tibber/src/test/resources/curve.json:2

Invalid JSON: an object literal cannot start with a bare array. Either remove the outer {} or add a property name before the array to form valid JSON.

jlaur

Thank you for this major refactoring! I have had a look and posted some comments.

Since this is a breaking change removing all channels and providing new ones, I'm wondering if should target 5.0 or 5.1. It would have been good to have it included in some milestone releases. How much has the community already been involved in testing?

jlaur · 2025-07-09T08:18:41Z

+            logger.debug("WebSocket connected to Server");
+            // String subScriptionMessage = String.format(handler.getTemplate(WEBSOCKET_SUBSCRIPTION_RESOURCE_PATH),
+            // config.homeid);
+            String subScriptionMessage = String.format(SUBSCRIPTION_MESSAGE, config.homeid);


Is there any reason to subscribe to events for unlinked channels? Consider populating a DTO and serializing this into the subscribe message.

You're right. Can be done very granular.
To be honest this takes now too much effort

check every time which channels are connected

are channels added or removed

unsubscribe then subribe again

To be honest I cannot provide this in short timeframe

This can be refined further later, let's leave it like this for now.

jlaur · 2025-07-09T19:28:45Z

+            if (!elem.isJsonNull()) {
+                return elem.getAsString();
+            } else {
+                return NULL;


Wouldn't it be better to actually return null so that the string "null" doesn't become some reserved value?

Renamed it to NULL_VALUE to avoid confusion with java null

What I meant was the returning the literal string "null" as a reserved value prevents the actual string "null" to be normally returned. The method could return null in this case to be handled specially.

We can come back to this in a follow-up PR.

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

jlaur · 2025-07-13T11:20:16Z

@lsiepel - can you verify my latest commits?

jlaur

LGTM. There are a few open comments left. I would appreciate any relevant feedback also after the merge.

lsiepel

Thanks, I'll merge this at 16:00, with or without the suggested changes.
You allready highlighted the parts i wanted to mention. A breaking change notice should also be added (of not alread) to the distro repo.

lsiepel · 2025-07-13T11:48:02Z

+    public static final String SCHEDULE_CONTAINER = "{\"size\":%s, \"cost\":%s, \"schedule\":%s}";
+    public static final String QUERY_CONTAINER = "{\"query\":\"%s\"}";
+    public static final String WEBSOCKET_URL_QUERY = "{\"query\":\"{viewer {websocketSubscriptionUrl }}\"}";
+    public static final String CONNECT_MESSAGE = "{\"type\":\"connection_init\", \"payload\":{\"token\":\"%s\"}}";
+    public static final String DISCONNECT_MESSAGE = "{\"type\":\"connection_terminate\",\"payload\":null}";
+    public static final String SUBSCRIPTION_MESSAGE = "{\"id\":\"1\",\"type\":\"subscribe\",\"payload\":{\"variables\":{},\"extensions\":{},\"operationName\":null,\"query\":\"subscription { liveMeasurement(homeId:\\\"%s\\\") { timestamp power lastMeterConsumption lastMeterProduction accumulatedConsumption accumulatedConsumptionLastHour accumulatedCost currency minPower averagePower maxPower voltagePhase1 voltagePhase2 voltagePhase3 currentL1 currentL2 currentL3 powerProduction accumulatedProduction accumulatedProductionLastHour minPowerProduction maxPowerProduction }}\"}}";


For future refactoring it would be a step forward to create proper DTO's for these

See #18726 (comment)

lsiepel · 2025-07-13T11:51:02Z

+
+    @Override
+    public String toString() {
+        return "{\"power\":" + powerWatts + ",\"duration\":" + durationSeconds + "}";


lsiepel · 2025-07-13T11:51:14Z

+
+    @Override
+    public String toString() {
+        return "{\"price\":" + price + ",\"duration\":" + durationSeconds + ",\"level\":" + level + ",\"startsAt\":\""


jlaur · 2025-07-13T12:28:16Z

A breaking change notice should also be added (of not alread) to the distro repo.

I have created openhab/openhab-distro#1766

lsiepel · 2025-07-13T12:48:01Z

Ok looked at the comments that are left, i merge this now. Quick fixes usually tend (let me speak for myself) to create regressions. So if there are any post merge findings a new PR can be created easily. Thanks @weymann for your efforts on this refactoring!

jlaur · 2025-07-13T12:53:57Z

@weymann - thank you for the major rework in the binding! 👍

…openhab#18726) * use common httpclient Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

…openhab#18726) * use common httpclient Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com> Signed-off-by: Paul Smedley <paul@smedley.id.au>

…openhab#18726) * use common httpclient Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com> Signed-off-by: Scott Hanson <scooter_seh@yahoo.com>

…openhab#18726) * use common httpclient Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

weymann requested a review from kjoglum as a code owner May 29, 2025 21:49

lsiepel added the enhancement An enhancement or new feature for an existing add-on label May 30, 2025

weymann changed the title ~~[WIP][tibber] Rework OH5~~ [tibber] Rework OH5 Jun 16, 2025

lsiepel requested a review from Copilot July 6, 2025 08:46

Copilot AI reviewed Jul 6, 2025

View reviewed changes

Comment thread bundles/org.openhab.binding.tibber/src/main/resources/OH-INF/update/instructions.xml Outdated

Comment thread bundles/org.openhab.binding.tibber/src/main/resources/OH-INF/thing/live-group.xml Outdated

jlaur added the (potentially) not backward compatible label Jul 9, 2025

jlaur requested changes Jul 9, 2025

View reviewed changes

weymann added 21 commits July 9, 2025 22:22

use common httpclient

11b23ab

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

stability rework initial version

d249a20

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

move to cron scheduling

a7ffca3

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

version update

89abe99

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

thing actions

4c2de8b

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

v0.2-alpha

b8e1067

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

OH5 header changes

3c3e1bb

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

full example

6f6498d

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

full example

4c31562

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

update instructions

f8abb57

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

add level to PriceInfo

c916515

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

thing status translations

dd8e50f

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

header check

11a140f

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

checkstyle

8fe4836

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

junit test cleanup

1409641

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

compiler warnings

45e3e27

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

optimize message handling

a368355

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

JSON error handling

7b5af91

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

readme

4efb2c7

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

readme

152a9c1

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

readme

7701800

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

Extend warning

49c688d

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>