forked from openhab/openhab-addons
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ipobserver] Weather station binding, Initial contribution. (openhab#…
…10567) * Bulk updated to UOM. Signed-off-by: Matthew Skinner <matt@pcmus.com> * ipObserver creation Signed-off-by: Matthew Skinner <matt@pcmus.com> * Bulk updated to UOM. Signed-off-by: Matthew Skinner <matt@pcmus.com> * channel fixup for UOM. Signed-off-by: Matthew Skinner <matt@pcmus.com> * improve UOM. Signed-off-by: Matthew Skinner <matt@pcmus.com> * updates Signed-off-by: Matthew Skinner <matt@pcmus.com> * Battery ch fixed. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Fix time channels. Signed-off-by: Matthew Skinner <matt@pcmus.com> * readme update and remove %unit% from rain channels. Signed-off-by: Matthew Skinner <matt@pcmus.com> * readme fixup. Signed-off-by: Matthew Skinner <matt@pcmus.com> * edit global files. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Fix merge conflicts. Signed-off-by: Matthew Skinner <matt@pcmus.com> * fix up build issues. Signed-off-by: Matthew Skinner <matt@pcmus.com> * remove reboot channel. Signed-off-by: Matthew Skinner <matt@pcmus.com> * readme fixup. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Rename channels to put kind first. Signed-off-by: Matthew Skinner <matt@pcmus.com> * update to build on latest main. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Add support for outBatt1 Signed-off-by: Matthew Skinner <matt@pcmus.com> * Added auto discovery. Signed-off-by: Matthew Skinner <matt@pcmus.com> * add bundle to POM. Signed-off-by: Matthew Skinner <matt@pcmus.com> * newline added. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Fix bug in discovery. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Added tags Signed-off-by: Matthew Skinner <matt@pcmus.com> * update to 3.2.0-SNAPSHOT Signed-off-by: Matthew Skinner <matt@pcmus.com> * Update bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/thing/thing-types.xml Signed-off-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Fabian Wolter <github@fabian-wolter.de> * Update bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/thing/thing-types.xml Signed-off-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Fabian Wolter <github@fabian-wolter.de> * Clean up channels Signed-off-by: Matthew Skinner <matt@pcmus.com> * Update binding description. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Fix jsoup suggestions. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Update bundles/org.openhab.binding.ipobserver/src/main/java/org/openhab/binding/ipobserver/internal/IpObserverDiscoveryService.java Signed-off-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Fabian Wolter <github@fabian-wolter.de> * Update bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/thing/thing-types.xml Signed-off-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Fabian Wolter <github@fabian-wolter.de> * Removed nullable. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Improvements Signed-off-by: Matthew Skinner <matt@pcmus.com> * Fix compiler warnings Signed-off-by: Matthew Skinner <matt@pcmus.com> * Change to datetime Signed-off-by: Matthew Skinner <matt@pcmus.com> * change to use system channels. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Move to Number:Intensity for solar Signed-off-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
- Loading branch information
Showing
15 changed files
with
1,084 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| This content is produced and maintained by the openHAB project. | ||
|
|
||
| * Project home: https://www.openhab.org | ||
|
|
||
| == Declared Project Licenses | ||
|
|
||
| This program and the accompanying materials are made available under the terms | ||
| of the Eclipse Public License 2.0 which is available at | ||
| https://www.eclipse.org/legal/epl-2.0/. | ||
|
|
||
| == Source Code | ||
|
|
||
| https://github.com/openhab/openhab-addons | ||
|
|
||
| == Third-party Content | ||
|
|
||
| jsoup | ||
| * License: MIT License | ||
| * Project: https://jsoup.org/ | ||
| * Source: https://github.com/jhy/jsoup |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # IpObserver Binding | ||
|
|
||
| This binding is for any weather station that sends data to an IP Observer module. | ||
| The weather stations that do this are made by a company in China called `Fine Offset` and then re-branded by many distribution companies around the world. | ||
| Some of the brands include Aercus (433mhz), Ambient Weather (915mhz), Frogitt, Misol (433mhz), Pantech (433mhz), Sainlogic and many more. | ||
| Whilst Ambient Weather has it own cloud based binding, the other brands will not work with that binding and Ambient Weather do not sell outside of the United States. | ||
| This binding works fully offline and uses local scraping of the weather station data at 12 second resolution if you wish and is easy to setup. | ||
| The other binding worth mentioning is the weather underground binding that allows the data to be intercepted on its way to WU, however many of the weather stations do not allow the redirection of the WU data and require you to know how to do redirections with a custom DNS server on your network. | ||
| This binding is by far the easiest method and works for all the brands and will not stop the data still being sent to WU if you wish to do both at the same time. | ||
| If your weather station came with a LCD screen instead of the IP Observer, you can add on the unit and the LCD screen will still work in parallel as the RF data is sent 1 way from the outdoor unit to the inside screens and IP Observer units. | ||
|
|
||
| ## Supported Things | ||
|
|
||
| There is only one thing that can be added and is called `weatherstation`. | ||
|
|
||
| ## Discovery | ||
|
|
||
| Auto discovery is supported and may take a while to complete as it scans all IP addresses on your network one by one. | ||
|
|
||
| ## Thing Configuration | ||
|
|
||
| | Parameter | Required | Description | | ||
| |-|-|-| | ||
| | `address` | Y | Hostname or IP for the IP Observer | | ||
| | `pollTime` | Y | Time in seconds between each Scan of the livedata.htm from the IP Observer | | ||
| | `autoReboot` | Y | Time in milliseconds to wait for a reply before rebooting the IP Observer. A value of 0 disables this feature allowing you to manually trigger or use a rule to handle the reboots. | | ||
|
|
||
| ## Channels | ||
|
|
||
| | channel | type | description | | ||
| |-----------------------|-----------------------|------------------------------| | ||
| | temperatureIndoor | Number:Temperature | The temperature indoors. | | ||
| | temperatureOutdoor | Number:Temperature | The temperature outdoors. | | ||
| | humidityIndoor | Number:Dimensionless | The humidity indoors. | | ||
| | humidityOutdoor | Number:Dimensionless | The humidity outdoors. | | ||
| | pressureAbsolute | Number:Pressure | The atmospheric pressure directly measured by the sensor. | | ||
| | pressureRelative | Number:Pressure | The pressure adjusted to sea level to allow easier comparisons between different locations. | | ||
| | windDirection | Number:Angle | The angle in degrees that the wind is coming from. | | ||
| | windAverageSpeed | Number:Speed | The average wind speed. | | ||
| | windSpeed | Number:Speed | The exact wind speed. Not all stations send this data. | | ||
| | windGust | Number:Speed | The recent wind gust speed. | | ||
| | windMaxGust | Number:Speed | The recent max wind gust speed. | | ||
| | solarRadiation | Number:Intensity | Solar radiation. | | ||
| | uv | Number | UV measurement. | | ||
| | uvIndex | Number | The UV index. | | ||
| | rainHourlyRate | Number:Length | The amount of rain that will fall, if it continues to fall at the same rate for an hour. Measures how heavy the current rain is falling. | | ||
| | rainToday | Number:Length | Amount of rain since 12:00am. | | ||
| | rainForWeek | Number:Length | Amount of rain for the week. | | ||
| | rainForMonth | Number:Length | Amount of rain for the month. | | ||
| | rainForYear | Number:Length | Amount of rain for the year. | | ||
| | batteryIndoor | Switch | Battery status, ON if battery is low. | | ||
| | batteryOutdoor | Switch | Battery status, OFF if battery is normal. | | ||
| | responseTime | Number:Time | How long it took the weather station to reply to a request for the live data. | | ||
| | lastUpdatedTime | DateTime | The time scraped from the weather station when it last read the sensors. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
|
|
||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <parent> | ||
| <groupId>org.openhab.addons.bundles</groupId> | ||
| <artifactId>org.openhab.addons.reactor.bundles</artifactId> | ||
| <version>3.2.0-SNAPSHOT</version> | ||
| </parent> | ||
|
|
||
| <artifactId>org.openhab.binding.ipobserver</artifactId> | ||
|
|
||
| <name>openHAB Add-ons :: Bundles :: IpObserver Binding</name> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.jsoup</groupId> | ||
| <artifactId>jsoup</artifactId> | ||
| <version>1.8.3</version> | ||
| <scope>provided</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> |
9 changes: 9 additions & 0 deletions
9
bundles/org.openhab.binding.ipobserver/src/main/feature/feature.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <features name="org.openhab.binding.ipobserver-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0"> | ||
| <repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository> | ||
| <feature name="openhab-binding-ipobserver" description="IpObserver Binding" version="${project.version}"> | ||
| <feature>openhab-runtime-base</feature> | ||
| <bundle dependency="true">mvn:org.jsoup/jsoup/1.8.3</bundle> | ||
| <bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.ipobserver/${project.version}</bundle> | ||
| </feature> | ||
| </features> |
59 changes: 59 additions & 0 deletions
59
...ver/src/main/java/org/openhab/binding/ipobserver/internal/IpObserverBindingConstants.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /** | ||
| * Copyright (c) 2010-2021 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.ipobserver.internal; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.openhab.core.thing.ThingTypeUID; | ||
|
|
||
| /** | ||
| * The {@link IpObserverBindingConstants} class defines common constants, which are | ||
| * used across the whole binding. | ||
| * | ||
| * @author Matthew Skinner - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public class IpObserverBindingConstants { | ||
| public static final String BINDING_ID = "ipobserver"; | ||
| public static final String REBOOT_URL = "/msgreboot.htm"; | ||
| public static final String LIVE_DATA_URL = "/livedata.htm"; | ||
| public static final String STATION_SETTINGS_URL = "/station.htm"; | ||
| public static final int DISCOVERY_THREAD_POOL_SIZE = 15; | ||
|
|
||
| // List of all Thing Type UIDs | ||
| public static final ThingTypeUID THING_WEATHER_STATION = new ThingTypeUID(BINDING_ID, "weatherstation"); | ||
|
|
||
| // List of all Channel ids | ||
| public static final String TEMP_INDOOR = "temperatureIndoor"; | ||
| public static final String TEMP_OUTDOOR = "temperatureOutdoor"; | ||
| public static final String INDOOR_HUMIDITY = "humidityIndoor"; | ||
| public static final String OUTDOOR_HUMIDITY = "humidityOutdoor"; | ||
| public static final String ABS_PRESSURE = "pressureAbsolute"; | ||
| public static final String REL_PRESSURE = "pressureRelative"; | ||
| public static final String WIND_DIRECTION = "windDirection"; | ||
| public static final String WIND_AVERAGE_SPEED = "windAverageSpeed"; | ||
| public static final String WIND_SPEED = "windSpeed"; | ||
| public static final String WIND_GUST = "windGust"; | ||
| public static final String WIND_MAX_GUST = "windMaxGust"; | ||
| public static final String SOLAR_RADIATION = "solarRadiation"; | ||
| public static final String UV = "uv"; | ||
| public static final String UV_INDEX = "uvIndex"; | ||
| public static final String HOURLY_RAIN_RATE = "rainHourlyRate"; | ||
| public static final String DAILY_RAIN = "rainToday"; | ||
| public static final String WEEKLY_RAIN = "rainForWeek"; | ||
| public static final String MONTHLY_RAIN = "rainForMonth"; | ||
| public static final String YEARLY_RAIN = "rainForYear"; | ||
| public static final String INDOOR_BATTERY = "batteryIndoor"; | ||
| public static final String OUTDOOR_BATTERY = "batteryOutdoor"; | ||
| public static final String RESPONSE_TIME = "responseTime"; | ||
| public static final String LAST_UPDATED_TIME = "lastUpdatedTime"; | ||
| } |
27 changes: 27 additions & 0 deletions
27
...server/src/main/java/org/openhab/binding/ipobserver/internal/IpObserverConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /** | ||
| * Copyright (c) 2010-2021 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.ipobserver.internal; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
|
|
||
| /** | ||
| * The {@link IpObserverConfiguration} class contains fields mapping thing configuration parameters. | ||
| * | ||
| * @author Matthew Skinner - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public class IpObserverConfiguration { | ||
| public String address = ""; | ||
| public int pollTime = 20; | ||
| public int autoReboot = 2000; | ||
| } |
64 changes: 64 additions & 0 deletions
64
...bserver/src/main/java/org/openhab/binding/ipobserver/internal/IpObserverDiscoveryJob.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /** | ||
| * Copyright (c) 2010-2021 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.ipobserver.internal; | ||
|
|
||
| import static org.openhab.binding.ipobserver.internal.IpObserverBindingConstants.LIVE_DATA_URL; | ||
|
|
||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jetty.client.api.ContentResponse; | ||
| import org.eclipse.jetty.client.api.Request; | ||
| import org.eclipse.jetty.http.HttpHeader; | ||
| import org.eclipse.jetty.http.HttpMethod; | ||
|
|
||
| /** | ||
| * The {@link IpObserverDiscoveryJob} class allows auto discovery of | ||
| * devices for a single IP address. This is used | ||
| * for threading to make discovery faster. | ||
| * | ||
| * @author Matthew Skinner - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public class IpObserverDiscoveryJob implements Runnable { | ||
| private IpObserverDiscoveryService discoveryClass; | ||
| private String ipAddress; | ||
|
|
||
| public IpObserverDiscoveryJob(IpObserverDiscoveryService service, String ip) { | ||
| this.discoveryClass = service; | ||
| this.ipAddress = ip; | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| if (isIpObserverDevice(this.ipAddress)) { | ||
| discoveryClass.submitDiscoveryResults(this.ipAddress); | ||
| } | ||
| } | ||
|
|
||
| private boolean isIpObserverDevice(String ip) { | ||
| Request request = discoveryClass.getHttpClient().newRequest("http://" + ip + LIVE_DATA_URL); | ||
| request.method(HttpMethod.GET).timeout(5, TimeUnit.SECONDS).header(HttpHeader.ACCEPT_ENCODING, "gzip"); | ||
| ContentResponse contentResponse; | ||
| try { | ||
| contentResponse = request.send(); | ||
| if (contentResponse.getStatus() == 200 && contentResponse.getContentAsString().contains("livedata.htm")) { | ||
| return true; | ||
| } | ||
| } catch (InterruptedException | TimeoutException | ExecutionException e) { | ||
| } | ||
| return false; | ||
| } | ||
| } |
Oops, something went wrong.