Skip to content

[tibber] Rework binding (channel groups, UoM, Thing actions and more) #18726

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.

Sign up for GitHub

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

Merged
lsiepel merged 31 commits into from
Jul 13, 2025
Merged

[tibber] Rework binding (channel groups, UoM, Thing actions and more) #18726

Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
11b23ab
use common httpclient
weymann May 16, 2025
d249a20
stability rework initial version
weymann May 18, 2025
a7ffca3
move to cron scheduling
weymann May 19, 2025
89abe99
version update
weymann May 19, 2025
4c2de8b
thing actions
weymann May 28, 2025
b8e1067
v0.2-alpha
weymann May 29, 2025
3c3e1bb
OH5 header changes
weymann May 29, 2025
6f6498d
full example
weymann May 29, 2025
4c31562
full example
weymann May 29, 2025
f8abb57
update instructions
weymann May 30, 2025
c916515
add level to PriceInfo
weymann May 30, 2025
dd8e50f
thing status translations
weymann May 30, 2025
11a140f
header check
weymann May 30, 2025
8fe4836
checkstyle
weymann May 30, 2025
1409641
junit test cleanup
weymann May 30, 2025
45e3e27
compiler warnings
weymann May 30, 2025
a368355
optimize message handling
weymann May 31, 2025
7b5af91
JSON error handling
weymann May 31, 2025
4efb2c7
readme
weymann May 31, 2025
152a9c1
readme
weymann May 31, 2025
7701800
readme
weymann May 31, 2025
e7405ce
spot price update
weymann May 31, 2025
eb56a1c
fix channel typo
weymann Jul 8, 2025
68002f4
fix obvious review findings
weymann Jul 10, 2025
faadc5a
further review findings
weymann Jul 12, 2025
9bc6f62
Use HTTP status constant
jlaur Jul 13, 2025
954d21a
Remove undocumented values
jlaur Jul 13, 2025
49c688d
Extend warning
jlaur Jul 13, 2025
9ebfb53
Remove spaces before colons
jlaur Jul 13, 2025
f2f7c09
Reapply semantic tags
jlaur Jul 13, 2025
72cf430
Revert indirection
jlaur Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
650 changes: 416 additions & 234 deletions bundles/org.openhab.binding.tibber/README.md
View file
Open in desktop

Large diffs are not rendered by default.

128 changes: 81 additions & 47 deletions ...ding.tibber/src/main/java/org/openhab/binding/tibber/internal/TibberBindingConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
import org.openhab.core.thing.ThingTypeUID;

/**
* The {@link TibberBindingConstants} class defines common constants, which are
* used across the whole binding.
* The {@link TibberBindingConstants} class defines common constants, which are used across the whole binding.
*
* @author Stian Kjoglum - Initial contribution
* @author Bernd Weymann - Enhance used constants
*/
@NonNullByDefault
public class TibberBindingConstants {
Expand All @@ -34,55 +34,89 @@ public class TibberBindingConstants {
// Tibber base URL for queries and mutations
public static final String BASE_URL = "https://api.tibber.com/v1-beta/gql";

// Tibber driver version
public static final String TIBBER_DRIVER = "com.tibber/1.8.3";

// List of all Thing Type UIDs
public static final ThingTypeUID TIBBER_THING_TYPE = new ThingTypeUID(BINDING_ID, "tibberapi");

// List of all Channel ids - Used for queries
public static final String CURRENT_TOTAL = "current_total";
public static final String CURRENT_STARTSAT = "current_startsAt";
public static final String CURRENT_LEVEL = "current_level";

public static final String TODAY_PRICES = "today_prices";
public static final String TOMORROW_PRICES = "tomorrow_prices";
public static final String DAILY_FROM = "daily_from";
public static final String DAILY_TO = "daily_to";
public static final String DAILY_COST = "daily_cost";
public static final String DAILY_CONSUMPTION = "daily_consumption";
public static final String HOURLY_FROM = "hourly_from";
public static final String HOURLY_TO = "hourly_to";
public static final String HOURLY_COST = "hourly_cost";
public static final String HOURLY_CONSUMPTION = "hourly_consumption";
public static final String LIVE_TIMESTAMP = "live_timestamp";
public static final String LIVE_POWER = "live_power";
public static final String LIVE_LASTMETERCONSUMPTION = "live_lastMeterConsumption";
public static final String LIVE_LASTMETERPRODUCTION = "live_lastMeterProduction";
public static final String LIVE_ACCUMULATEDCONSUMPTION = "live_accumulatedConsumption";
public static final String LIVE_ACCUMULATEDCONSUMPTION_THIS_HOUR = "live_accumulatedConsumptionThisHour";
public static final String LIVE_ACCUMULATEDCOST = "live_accumulatedCost";
public static final String LIVE_ACCUMULATEREWARD = "live_accumulatedReward";
public static final String LIVE_CURRENCY = "live_currency";
public static final String LIVE_MINPOWER = "live_minPower";
public static final String LIVE_AVERAGEPOWER = "live_averagePower";
public static final String LIVE_MAXPOWER = "live_maxPower";
public static final String LIVE_VOLTAGE1 = "live_voltage1";
public static final String LIVE_VOLTAGE2 = "live_voltage2";
public static final String LIVE_VOLTAGE3 = "live_voltage3";
public static final String LIVE_CURRENT1 = "live_current1";
public static final String LIVE_CURRENT2 = "live_current2";
public static final String LIVE_CURRENT3 = "live_current3";
public static final String LIVE_POWERPRODUCTION = "live_powerProduction";
public static final String LIVE_ACCUMULATEDPRODUCTION = "live_accumulatedProduction";
public static final String LIVE_ACCUMULATEDPRODUCTION_THIS_HOUR = "live_accumulatedProductionThisHour";
public static final String LIVE_MINPOWERPRODUCTION = "live_minPowerproduction";
public static final String LIVE_MAXPOWERPRODUCTION = "live_maxPowerproduction";

// Lift of all config ids
public static final String CONFIG_BRIDGE_TOKEN = "token";
public static final String CONFIG_BRIDGE_REFRESH = "refresh";
// Channel groups
public static final String CHANNEL_GROUP_PRICE = "price";
public static final String CHANNEL_GROUP_LIVE = "live";
public static final String CHANNEL_GROUP_STATISTICS = "statistics";

// price channels
public static final String CHANNEL_SPOT_PRICE = "spot-price";
public static final String CHANNEL_PRICE_LEVELS = "level";
public static final String CHANNEL_AVERAGE = "average";

// live channels
public static final String CHANNEL_CONSUMPTION = "consumption";
public static final String CHANNEL_MIN_COSNUMPTION = "minimum-consumption";
public static final String CHANNEL_PEAK_CONSUMPTION = "peak-consumption";
public static final String CHANNEL_PRODUCTION = "production";
public static final String CHANNEL_MIN_PRODUCTION = "minimum-production";
public static final String CHANNEL_PEAK_PRODUCTION = "peak-production";
public static final String CHANNEL_VOLTAGE_1 = "voltage1";
public static final String CHANNEL_VOLTAGE_2 = "voltage2";
public static final String CHANNEL_VOLTAGE_3 = "voltage3";
public static final String CHANNEL_CURRENT_1 = "current1";
public static final String CHANNEL_CURRENT_2 = "current2";
public static final String CHANNEL_CURRENT_3 = "current3";

// statistics channels
public static final String CHANNEL_TOTAL_CONSUMPTION = "total-consumption";
public static final String CHANNEL_DAILY_CONSUMPTION = "daily-consumption";
public static final String CHANNEL_DAILY_COST = "daily-cost";
public static final String CHANNEL_LAST_HOUR_CONSUMPTION = "last-hour-consumption";
public static final String CHANNEL_TOTAL_PRODUCTION = "total-production";
public static final String CHANNEL_DAILY_PRODUCTION = "daily-production";
public static final String CHANNEL_LAST_HOUR_PRODUCTION = "last-hour-production";

public static final String CURRENCY_QUERY_RESOURCE_PATH = "/graphql/currency.graphql";
public static final String PRICE_QUERY_RESOURCE_PATH = "/graphql/prices.graphql";
public static final String REALTIME_QUERY_RESOURCE_PATH = "/graphql/realtime.graphql";
public static final String WEBSOCKET_SUBSCRIPTION_RESOURCE_PATH = "/graphql/websocket.graphql";

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 }}\"}}";
Comment on lines +78 to +83

@lsiepel lsiepel Jul 13, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@jlaur jlaur Jul 13, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See #18726 (comment)


public static final String[] CURRENCY_QUERY_JSON_PATH = new String[] { "data", "viewer", "home",
"currentSubscription", "priceInfo", "current" };
public static final String[] PRICE_INFO_JSON_PATH = new String[] { "data", "viewer", "home", "currentSubscription",
"priceInfo" };
public static final String[] REALTIME_FEATURE_JSON_PATH = new String[] { "data", "viewer", "home", "features" };
public static final String[] SOCKET_MESSAGE_JSON_PATH = new String[] { "payload", "data", "liveMeasurement" };

public static final String EMPTY_VALUE = "";
public static final String NULL_VALUE = "null-value";

public static final String CRON_DAILY_AT = "30 0 %s ? * * *";

public static final String JSON_DATA = "data";
public static final String JSON_VIEWER = "viewer";
public static final String JSON_HOME = "home";
public static final String JSON_SUBSRCIPTION = "currentSubscription";
public static final String JSON_DAILY = "daily";
public static final String JSON_HOURLY = "hourly";
public static final String JSON_NODES = "nodes";

public static final String PRICE_LEVEL_VERY_CHEAP = "very_cheap";
public static final String PRICE_LEVEL_CHEAP = "cheap";
public static final String PRICE_LEVEL_NORMAL = "normal";
public static final String PRICE_LEVEL_EXPENSIVE = "expensive";
public static final String PRICE_LEVEL_VERY_EXPENSIVE = "very_expensive";

public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Stream.of(TIBBER_THING_TYPE)
.collect(Collectors.toSet());

// parameter keys
public static final String PARAM_EARLIEST_START = "earliestStart";
public static final String PARAM_LATEST_END = "latestEnd";
public static final String PARAM_ASCENDING = "ascending";
public static final String PARAM_POWER = "power";
public static final String PARAM_DURATION = "duration";
public static final String PARAM_CURVE = "curve";
public static final String PARAM_TIMESTAMP = "timestamp";
}
19 changes: 18 additions & 1 deletion ...inding.tibber/src/main/java/org/openhab/binding/tibber/internal/TibberHandlerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,39 @@
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.tibber.internal.handler.TibberHandler;
import org.openhab.core.i18n.TimeZoneProvider;
import org.openhab.core.io.net.http.HttpClientFactory;
import org.openhab.core.scheduler.CronScheduler;
import org.openhab.core.thing.Thing;
import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.binding.BaseThingHandlerFactory;
import org.openhab.core.thing.binding.ThingHandler;
import org.openhab.core.thing.binding.ThingHandlerFactory;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

/**
* The {@link TibberHandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Stian Kjoglum - Initial contribution
* @author Bernd Weymann - Use HttpClientFactory, CronScheduler and TimeZoneProvider
*/
@NonNullByDefault
@Component(configurationPid = "binding.tibber", service = ThingHandlerFactory.class)
public class TibberHandlerFactory extends BaseThingHandlerFactory {
private final HttpClientFactory httpFactory;
private final CronScheduler cron;
private final TimeZoneProvider timeZoneProvider;

@Activate
public TibberHandlerFactory(final @Reference HttpClientFactory httpFactory, final @Reference CronScheduler cron,
final @Reference TimeZoneProvider timeZoneProvider) {
this.httpFactory = httpFactory;
this.cron = cron;
this.timeZoneProvider = timeZoneProvider;
}

@Override
public boolean supportsThingType(ThingTypeUID thingTypeUID) {
Expand All @@ -43,7 +60,7 @@ public boolean supportsThingType(ThingTypeUID thingTypeUID) {
protected @Nullable ThingHandler createHandler(Thing thing) {
ThingTypeUID thingTypeUID = thing.getThingTypeUID();
if (thingTypeUID.equals(TIBBER_THING_TYPE)) {
return new TibberHandler(thing);
return new TibberHandler(thing, httpFactory.getCommonHttpClient(), cron, bundleContext, timeZoneProvider);
} else {
return null;
}
Expand Down
Loading