Skip to content

Commit a4ad7b2

Browse files
PRosenbPRosenb
authored
[iotawatt] Initial contribution (openhab#16491)
* [iotawatt] generate new binding Signed-off-by: Peter Rosenberg <[email protected]>
1 parent 40ed4f7 commit a4ad7b2

30 files changed

+1981
-0
lines changed

‎CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@
162162
/bundles/org.openhab.binding.ihc/ @paulianttila
163163
/bundles/org.openhab.binding.insteon/ @robnielsen
164164
/bundles/org.openhab.binding.intesis/ @hmerk
165+
/bundles/org.openhab.binding.iotawatt/ @PRosenb
165166
/bundles/org.openhab.binding.ipcamera/ @Skinah
166167
/bundles/org.openhab.binding.ipobserver/ @Skinah
167168
/bundles/org.openhab.binding.ipp/ @peuter

‎bom/openhab-addons/pom.xml

+5
Original file line numberDiff line numberDiff line change
@@ -806,6 +806,11 @@
806806
<artifactId>org.openhab.binding.intesis</artifactId>
807807
<version>${project.version}</version>
808808
</dependency>
809+
<dependency>
810+
<groupId>org.openhab.addons.bundles</groupId>
811+
<artifactId>org.openhab.binding.iotawatt</artifactId>
812+
<version>${project.version}</version>
813+
</dependency>
809814
<dependency>
810815
<groupId>org.openhab.addons.bundles</groupId>
811816
<artifactId>org.openhab.binding.ipcamera</artifactId>

‎bundles/org.openhab.binding.iotawatt/NOTICE

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
This content is produced and maintained by the openHAB project.
2+
3+
* Project home: https://www.openhab.org
4+
5+
== Declared Project Licenses
6+
7+
This program and the accompanying materials are made available under the terms
8+
of the Eclipse Public License 2.0 which is available at
9+
https://www.eclipse.org/legal/epl-2.0/.
10+
11+
== Source Code
12+
13+
https://github.com/openhab/openhab-addons

‎bundles/org.openhab.binding.iotawatt/README.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# IoTaWatt Binding
2+
3+
This binding integrates [IoTaWatt™ Open WiFi Electric Power Monitor](https://iotawatt.com/) into openHAB.
4+
5+
Limitations of this version:
6+
7+
- No authentication support
8+
9+
## Supported Things
10+
11+
The IoTaWatt binding supports one Thing called `iotawatt`.
12+
13+
## Discovery
14+
15+
The binding does not auto-discover the IoTaWatt device.
16+
17+
## Thing Configuration
18+
19+
### IoTaWatt Thing Configuration
20+
21+
| Name | Type | Description | Default | Required | Advanced |
22+
|-----------------|---------|------------------------------------------------|---------|----------|----------|
23+
| hostname | text | Hostname or IP address of the device | N/A | yes | no |
24+
| refreshInterval | integer | Interval the device is polled in sec. | 10 | no | no |
25+
| requestTimeout | long | The request timeout to call the device in sec. | 10 | no | no |
26+
27+
## Channels
28+
29+
The binding detects configured inputs and outputs and creates channels for them.
30+
31+
| Channel | Type | ID | Read/Write | Description |
32+
|---------------------|--------------------------|---------------------|------------|---------------------------------|
33+
| Amps | Number:Power | amps | RO | The current amps |
34+
| Frequency | Number:Frequency | frequency | RO | The current AC frequency |
35+
| Power Factor | Number:Dimensionless | power-factor | RO | The current power factor |
36+
| Apparent Power | Number:Power | apparent-power | RO | The current apparent power |
37+
| Reactive Power | Number:Power | reactive-power | RO | The current reactive power |
38+
| Reactive Power hour | Number:Power | reactive-power-hour | RO | The current reactive power hour |
39+
| Voltage | Number:ElectricPotential | voltage | RO | The current voltage |
40+
| Power Consumption | Number:Power | watts | RO | The current power consumption |
41+
| Phase | Number:Dimensionless | phase | RO | The current phase |
42+
43+
## Example Configuration
44+
45+
### Thing with Channels
46+
47+
```java
48+
Thing iotawatt:iotawatt:iotawatt1 "IoTaWatt 1" [ hostname="192.168.1.10" ] {
49+
Channels:
50+
Type voltage : input_00#voltage "Voltage"
51+
Type frequency : input_00#frequency "AC Frequency"
52+
Type phase : input_00#phase "Phase"
53+
Type watts : input_01#watts "Power Consumption"
54+
Type power-factor : input_01#power-factor "Power Factor"
55+
Type phase : input_01#phase "Phase"
56+
57+
Type amps : output_00#Input_1_amps "Amps"
58+
Type frequency : output_01#Input_1_hz "Frequency"
59+
Type power-factor : output_02#Input_1_pf "Power Factor"
60+
Type apparent-power : output_03#Input_1_va "Apparent Power"
61+
Type reactive-power : output_04#Input_1_var "Reactive Power"
62+
Type reactive-power-hour : output_05#Input_1_varh "Reactive Power Hour"
63+
Type voltage : output_06#Input_1_volts "Voltage"
64+
Type watts : output_07#Input_1_watts "Watts"
65+
}
66+
```
67+
68+
### Items
69+
70+
```java
71+
Number:ElectricPotential input_voltage "Voltage" { channel="iotawatt:iotawatt:iotawatt1:input_00#voltage" }
72+
Number:Frequency input_frequency "AC Frequency" { channel="iotawatt:iotawatt:iotawatt1:input_00#frequency" }
73+
Number:Dimensionless input_phase0 "Phase" { channel="iotawatt:iotawatt:iotawatt1:input_00#phase" }
74+
Number:Power input_watts "Watts" { channel="iotawatt:iotawatt:iotawatt1:input_01#watts" }
75+
Number:Dimensionless input_power_factor "Power Factor" { channel="iotawatt:iotawatt:iotawatt1:input_01#power-factor" }
76+
Number:Dimensionless input_phase1 "Phase" { channel="iotawatt:iotawatt:iotawatt1:input_01#phase" }
77+
78+
Number:ElectricCurrent output_amps "Amps" { channel="iotawatt:iotawatt:iotawatt1:output_00#Input_1_amps" }
79+
Number:Frequency output_frequency "AC Frequency" { channel="iotawatt:iotawatt:iotawatt1:output_01#Input_1_hz" }
80+
Number:Dimensionless output_power_factor "Power Factor" { channel="iotawatt:iotawatt:iotawatt1:output_02#Input_1_pf" }
81+
Number:Power output_apparent_power "Apparent Power" { channel="iotawatt:iotawatt:iotawatt1:output_03#Input_1_va" }
82+
Number:Power output_reactive_power "Reactive Power" { channel="iotawatt:iotawatt:iotawatt1:output_04#Input_1_var" }
83+
Number:Energy output_reactive_power_hour "Reactive Power Hour" { channel="iotawatt:iotawatt:iotawatt1:output_05#Input_1_varh" }
84+
Number:ElectricPotential output_voltage "Voltage" { channel="iotawatt:iotawatt:iotawatt1:output_06#Input_1_volts" }
85+
Number:Power output_watts "Watts" { channel="iotawatt:iotawatt:iotawatt1:output_07#Input_1_watts" }
86+
```

‎bundles/org.openhab.binding.iotawatt/pom.xml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4+
5+
<modelVersion>4.0.0</modelVersion>
6+
7+
<parent>
8+
<groupId>org.openhab.addons.bundles</groupId>
9+
<artifactId>org.openhab.addons.reactor.bundles</artifactId>
10+
<version>4.2.0-SNAPSHOT</version>
11+
</parent>
12+
13+
<artifactId>org.openhab.binding.iotawatt</artifactId>
14+
15+
<name>openHAB Add-ons :: Bundles :: IoTaWatt Binding</name>
16+
17+
<dependencies>
18+
<dependency>
19+
<groupId>org.mockito</groupId>
20+
<artifactId>mockito-core</artifactId>
21+
<version>5.11.0</version>
22+
<scope>test</scope>
23+
</dependency>
24+
</dependencies>
25+
</project>

‎bundles/org.openhab.binding.iotawatt/src/main/feature/feature.xml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<features name="org.openhab.binding.iotawatt-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0">
3+
<repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository>
4+
5+
<feature name="openhab-binding-iotawatt" description="IoTaWatt Binding" version="${project.version}">
6+
<feature>openhab-runtime-base</feature>
7+
<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.iotawatt/${project.version}</bundle>
8+
</feature>
9+
</features>

‎bundles/org.openhab.binding.iotawatt/src/main/java/org/openhab/binding/iotawatt/internal/IoTaWattBindingConstants.java

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/**
2+
* Copyright (c) 2010-2024 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.iotawatt.internal;
14+
15+
import org.eclipse.jdt.annotation.NonNullByDefault;
16+
import org.openhab.core.thing.ThingTypeUID;
17+
18+
/**
19+
* The {@link IoTaWattBindingConstants} class defines common constants, which are
20+
* used across the whole binding.
21+
*
22+
* @author Peter Rosenberg - Initial contribution
23+
*/
24+
@NonNullByDefault
25+
public class IoTaWattBindingConstants {
26+
/**
27+
* The binding ID of the IoTaWatt binding
28+
*/
29+
public static final String BINDING_ID = "iotawatt";
30+
31+
/**
32+
* The list of all Thing Type UIDs
33+
*/
34+
public static final ThingTypeUID THING_TYPE_IOTAWATT = new ThingTypeUID(BINDING_ID, "iotawatt");
35+
}

‎bundles/org.openhab.binding.iotawatt/src/main/java/org/openhab/binding/iotawatt/internal/IoTaWattConfiguration.java

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/**
2+
* Copyright (c) 2010-2024 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.iotawatt.internal;
14+
15+
import org.eclipse.jdt.annotation.NonNullByDefault;
16+
import org.slf4j.Logger;
17+
import org.slf4j.LoggerFactory;
18+
19+
/**
20+
* The {@link IoTaWattConfiguration} class contains fields mapping thing configuration parameters.
21+
*
22+
* @author Peter Rosenberg - Initial contribution
23+
*/
24+
@NonNullByDefault
25+
public class IoTaWattConfiguration {
26+
private final Logger logger = LoggerFactory.getLogger(IoTaWattConfiguration.class);
27+
/**
28+
* The default refresh interval of the IoTaWatt device
29+
*/
30+
public static final int REFRESH_INTERVAL_DEFAULT = 10;
31+
/**
32+
* The default of the request timeout
33+
*/
34+
public static final long REQUEST_TIMEOUT_DEFAULT = 10;
35+
36+
/**
37+
* Configuration parameters
38+
*/
39+
public String hostname = "";
40+
/**
41+
* The request timeout in seconds when fetching data from the IoTaWatt device
42+
*/
43+
public long requestTimeout = REQUEST_TIMEOUT_DEFAULT;
44+
/**
45+
* The refresh interval of the IoTaWatt device in seconds
46+
*/
47+
public int refreshInterval = REFRESH_INTERVAL_DEFAULT;
48+
49+
public boolean isValid() {
50+
if (hostname.trim().isBlank()) {
51+
logger.warn("Hostname is blank, please specify the hostname/IP address of IoTaWatt.");
52+
return false;
53+
}
54+
if (requestTimeout <= 0) {
55+
logger.warn("Invalid requestTimeout {}, please use a positive number", requestTimeout);
56+
return false;
57+
}
58+
if (refreshInterval <= 0) {
59+
logger.warn("Invalid refreshInterval {}, please use a positive number", refreshInterval);
60+
return false;
61+
}
62+
// Also update "configuration-error" in src/main/resources/OH-INF/i18n/iotawatt_en.properties
63+
return true;
64+
}
65+
}

‎bundles/org.openhab.binding.iotawatt/src/main/java/org/openhab/binding/iotawatt/internal/IoTaWattHandlerFactory.java

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
/**
2+
* Copyright (c) 2010-2024 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.iotawatt.internal;
14+
15+
import static org.openhab.binding.iotawatt.internal.IoTaWattBindingConstants.THING_TYPE_IOTAWATT;
16+
17+
import java.util.Set;
18+
19+
import org.eclipse.jdt.annotation.NonNullByDefault;
20+
import org.eclipse.jdt.annotation.Nullable;
21+
import org.eclipse.jetty.client.HttpClient;
22+
import org.eclipse.jetty.util.ssl.SslContextFactory;
23+
import org.openhab.binding.iotawatt.internal.client.IoTaWattClient;
24+
import org.openhab.binding.iotawatt.internal.handler.FetchDataServiceProvider;
25+
import org.openhab.binding.iotawatt.internal.handler.HttpClientProvider;
26+
import org.openhab.binding.iotawatt.internal.handler.IoTaWattClientProvider;
27+
import org.openhab.binding.iotawatt.internal.handler.IoTaWattHandler;
28+
import org.openhab.binding.iotawatt.internal.service.DeviceHandlerCallback;
29+
import org.openhab.binding.iotawatt.internal.service.FetchDataService;
30+
import org.openhab.core.thing.Thing;
31+
import org.openhab.core.thing.ThingTypeUID;
32+
import org.openhab.core.thing.binding.BaseThingHandlerFactory;
33+
import org.openhab.core.thing.binding.ThingHandler;
34+
import org.openhab.core.thing.binding.ThingHandlerFactory;
35+
import org.osgi.service.component.annotations.Component;
36+
import org.osgi.service.component.annotations.Deactivate;
37+
38+
import com.google.gson.Gson;
39+
40+
/**
41+
* The {@link IoTaWattHandlerFactory} is responsible for creating things and thing
42+
* handlers.
43+
*
44+
* @author Peter Rosenberg - Initial contribution
45+
*/
46+
@NonNullByDefault
47+
@Component(configurationPid = "binding.iotawatt", service = ThingHandlerFactory.class)
48+
public class IoTaWattHandlerFactory extends BaseThingHandlerFactory
49+
implements HttpClientProvider, IoTaWattClientProvider, FetchDataServiceProvider {
50+
private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(THING_TYPE_IOTAWATT);
51+
52+
private final HttpClient insecureClient;
53+
private final Gson gson = new Gson();
54+
55+
/**
56+
* Creates a IoTaWattHandlerFactory
57+
*/
58+
public IoTaWattHandlerFactory() {
59+
this.insecureClient = new HttpClient(new SslContextFactory.Client(true));
60+
}
61+
62+
@Override
63+
public boolean supportsThingType(ThingTypeUID thingTypeUID) {
64+
return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
65+
}
66+
67+
@Override
68+
protected @Nullable ThingHandler createHandler(Thing thing) {
69+
ThingTypeUID thingTypeUID = thing.getThingTypeUID();
70+
71+
if (THING_TYPE_IOTAWATT.equals(thingTypeUID)) {
72+
return new IoTaWattHandler(thing, this, this);
73+
}
74+
75+
return null;
76+
}
77+
78+
@Override
79+
public HttpClient getInsecureClient() {
80+
return insecureClient;
81+
}
82+
83+
@Override
84+
public IoTaWattClient getIoTaWattClient(String hostname, long requestTimeout) {
85+
return new IoTaWattClient(hostname, requestTimeout, insecureClient, gson);
86+
}
87+
88+
@Override
89+
public FetchDataService getFetchDataService(DeviceHandlerCallback deviceHandlerCallback) {
90+
return new FetchDataService(deviceHandlerCallback);
91+
}
92+
93+
@Deactivate
94+
public void deactivate() {
95+
insecureClient.destroy();
96+
}
97+
}

0 commit comments

Comments
 (0)