Added Tibber plugin
This commit is contained in:
parent
2e924d2882
commit
c4cb9ff458
6 changed files with 413 additions and 0 deletions
|
|
@ -0,0 +1,183 @@
|
|||
/*
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2024 Ziver Koc
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package se.hal.plugin.tibber;
|
||||
|
||||
import se.hal.HalContext;
|
||||
import se.hal.HalServer;
|
||||
import se.hal.intf.*;
|
||||
import zutil.ObjectUtil;
|
||||
import zutil.log.LogUtil;
|
||||
import zutil.net.http.HttpClient;
|
||||
import zutil.net.http.HttpHeader;
|
||||
import zutil.parser.DataNode;
|
||||
import zutil.parser.json.JSONParser;
|
||||
import zutil.ui.UserMessageManager;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.CopyOnWriteArrayList;
|
||||
import java.util.concurrent.ScheduledExecutorService;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
|
||||
public class TibberController implements HalSensorController, Runnable, HalDaemon, HalAutostartController {
|
||||
private static final Logger logger = LogUtil.getLogger();
|
||||
|
||||
private static final String CONFIG_TIBBER_TOKEN = "hal_tibber.token";
|
||||
|
||||
private static final String TIBBER_API_ENDPOINT = "https://api.tibber.com/v1-beta/gql";
|
||||
private static final int POLL_TIME = 60*60; // poll every 1h defined in sec
|
||||
|
||||
private List<TibberDevice> registeredDevices = new ArrayList<>();
|
||||
private List<HalDeviceReportListener> deviceListeners = new CopyOnWriteArrayList<>();
|
||||
private ScheduledExecutorService executor;
|
||||
|
||||
|
||||
public TibberController() {}
|
||||
|
||||
@Override
|
||||
public boolean isAvailable() {
|
||||
return HalContext.containsProperty(CONFIG_TIBBER_TOKEN);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void initialize() {
|
||||
HalServer.registerDaemon(this);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void initiate(ScheduledExecutorService executor) {
|
||||
this.executor = executor;
|
||||
executor.scheduleAtFixedRate(this, 10, POLL_TIME, TimeUnit.SECONDS);
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized void run() {
|
||||
if (!isAvailable()) {
|
||||
logger.warning("Controller not available yet.");
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
logger.fine("Querying Tibber API for new data.");
|
||||
|
||||
HttpClient client = new HttpClient(HttpClient.HttpRequestType.POST);
|
||||
client.setURL(TIBBER_API_ENDPOINT);
|
||||
client.setHeader("Authorization", "Bearer " + HalContext.getStringProperty(CONFIG_TIBBER_TOKEN));
|
||||
client.setContent("application/json");
|
||||
String requestQuery = "{ " +
|
||||
"\"query\": \"{" +
|
||||
"viewer {" +
|
||||
"homes {" +
|
||||
"consumption(resolution: HOURLY, last: 1) {" +
|
||||
"nodes {" +
|
||||
"from " +
|
||||
"to " +
|
||||
"cost " + // Total cost
|
||||
"unitPrice " + // Cost per Kwh
|
||||
"unitPriceVAT " + // Cost per Kwh with taxes
|
||||
"consumption " + // Total consumption
|
||||
"consumptionUnit " + // Should be Kwh
|
||||
"}" +
|
||||
"}" +
|
||||
// "currentSubscription {" +
|
||||
// "priceInfo {" +
|
||||
// "current {" +
|
||||
// "total " +
|
||||
// "energy " +
|
||||
// "tax " +
|
||||
// "startsAt " +
|
||||
// "}" +
|
||||
// "}" +
|
||||
// "}" +
|
||||
"}" +
|
||||
"}" +
|
||||
"}\"" +
|
||||
"}";
|
||||
client.setContent(requestQuery);
|
||||
logger.finest("Request: " + requestQuery);
|
||||
|
||||
HttpHeader header = client.send();
|
||||
JSONParser parser = new JSONParser(header.getInputStream());
|
||||
DataNode json = parser.read();
|
||||
logger.finest("Response: " + json);
|
||||
|
||||
if (header.getResponseStatusCode() != 200) {
|
||||
logger.severe("There was a error fetching data from tibber: StatusCode=" + header.getResponseStatusCode() + ", Response=" + header.getResponseStatusString());
|
||||
HalContext.getUserMessageManager().add(new UserMessageManager.UserMessage(
|
||||
UserMessageManager.MessageLevel.ERROR,
|
||||
"Tibber API error.",
|
||||
"There was a error fetching data from tibber: StatusCode=" + header.getResponseStatusCode() + ", Response=" + header.getResponseStatusString(),
|
||||
UserMessageManager.MessageTTL.DISMISSED));
|
||||
return;
|
||||
}
|
||||
|
||||
if (!ObjectUtil.isEmpty(json.get("error"))) {
|
||||
logger.severe("There was a error fetching data from tibber: " + json.getString("error"));
|
||||
HalContext.getUserMessageManager().add(new UserMessageManager.UserMessage(
|
||||
UserMessageManager.MessageLevel.ERROR,
|
||||
"Tibber API error.",
|
||||
"There was a error fetching data from tibber: " + json.getString("error"),
|
||||
UserMessageManager.MessageTTL.DISMISSED));
|
||||
return;
|
||||
}
|
||||
|
||||
DataNode data = json.get("data").get("viewer").get("homes").get(0).get("consumption").get("nodes").get(0);
|
||||
|
||||
} catch (Exception e) {
|
||||
logger.log(Level.SEVERE, "Tibber API querying failed.", e);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized void register(HalDeviceConfig deviceConfig) {
|
||||
if (deviceConfig instanceof TibberDevice)
|
||||
registeredDevices.add((TibberDevice) deviceConfig);
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized void deregister(HalDeviceConfig deviceConfig) {
|
||||
registeredDevices.remove(deviceConfig);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int size() {
|
||||
return registeredDevices.size();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addListener(HalDeviceReportListener listener) {
|
||||
if (!deviceListeners.contains(listener))
|
||||
deviceListeners.add(listener);
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized void close() {
|
||||
registeredDevices = new ArrayList<>();
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
/*
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2024 Ziver Koc
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package se.hal.plugin.tibber;
|
||||
|
||||
public interface TibberDevice {
|
||||
}
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
/*
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2024 Ziver Koc
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package se.hal.plugin.tibber.device;
|
||||
|
||||
import se.hal.intf.HalSensorConfig;
|
||||
import se.hal.intf.HalSensorController;
|
||||
import se.hal.intf.HalSensorData;
|
||||
import se.hal.plugin.tibber.TibberController;
|
||||
import se.hal.struct.devicedata.HumiditySensorData;
|
||||
|
||||
/**
|
||||
* A sensor that calculate current electricity bil
|
||||
*/
|
||||
public class ElectricityCostSensor implements HalSensorConfig {
|
||||
|
||||
|
||||
|
||||
@Override
|
||||
public long getDataInterval() {
|
||||
return 60*60*1000; // 1 h
|
||||
}
|
||||
|
||||
@Override
|
||||
public AggregationMethod getAggregationMethod() {
|
||||
return AggregationMethod.SUM;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HalSensorController> getDeviceControllerClass() {
|
||||
return TibberController.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HalSensorData> getDeviceDataClass() {
|
||||
return CostSensorData.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
return super.equals(obj);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
/*
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2024 Ziver Koc
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package se.hal.plugin.tibber.device;
|
||||
|
||||
import se.hal.intf.HalDeviceData;
|
||||
import se.hal.intf.HalSensorConfig;
|
||||
import se.hal.intf.HalSensorController;
|
||||
import se.hal.intf.HalSensorData;
|
||||
import se.hal.struct.devicedata.HumiditySensorData;
|
||||
import se.hal.plugin.tibber.TibberController;
|
||||
|
||||
/**
|
||||
* A sensor that shows the price of electricity at a specific time
|
||||
*/
|
||||
public class ElectricityPriceSensor implements HalSensorConfig {
|
||||
|
||||
|
||||
|
||||
@Override
|
||||
public long getDataInterval() {
|
||||
return 60*60*1000; // 1 h
|
||||
}
|
||||
|
||||
@Override
|
||||
public AggregationMethod getAggregationMethod() {
|
||||
return AggregationMethod.AVERAGE;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HalSensorController> getDeviceControllerClass() {
|
||||
return TibberController.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HalSensorData> getDeviceDataClass() {
|
||||
return PriceSensorData.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
return super.equals(obj);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
/*
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2024 Ziver Koc
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package se.hal.plugin.tibber.device;
|
||||
|
||||
import se.hal.intf.HalSensorConfig;
|
||||
import se.hal.intf.HalSensorController;
|
||||
import se.hal.intf.HalSensorData;
|
||||
import se.hal.struct.devicedata.TemperatureSensorData;
|
||||
import se.hal.plugin.tibber.TibberController;
|
||||
|
||||
|
||||
public class PowerConsumptionSensor implements HalSensorConfig {
|
||||
|
||||
|
||||
@Override
|
||||
public long getDataInterval() {
|
||||
return 60*60 * 1000; // 1 min
|
||||
}
|
||||
|
||||
@Override
|
||||
public AggregationMethod getAggregationMethod() {
|
||||
return AggregationMethod.AVERAGE;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HalSensorController> getDeviceControllerClass() {
|
||||
return TibberController.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HalSensorData> getDeviceDataClass() {
|
||||
return TemperatureSensorData.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
return super.equals(obj);
|
||||
}
|
||||
}
|
||||
12
plugins/hal-tibber/src/se/hal/plugin/tibber/plugin.json
Normal file
12
plugins/hal-tibber/src/se/hal/plugin/tibber/plugin.json
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
{
|
||||
"version": 0.1,
|
||||
"name": "Hal-Tibber",
|
||||
"description": "Plugin that connects to the Tibber API.",
|
||||
"interfaces": [
|
||||
{"se.hal.intf.HalAutostartController": "se.hal.plugin.tibber.TibberController"},
|
||||
|
||||
{"se.hal.intf.HalSensorConfig": "se.hal.plugin.tibber.device.ElectricityCostSensor"},
|
||||
{"se.hal.intf.HalSensorConfig": "se.hal.plugin.tibber.device.ElectricityPriceSensor"},
|
||||
{"se.hal.intf.HalSensorConfig": "se.hal.plugin.tibber.device.PowerConsumptionSensor"}
|
||||
]
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue