import java.util.stream.Collectors;
import java.util.stream.Stream;
+import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.type.ChannelTypeUID;
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public abstract class GPSTrackerBindingConstants {
public static final String BINDING_ID = "gpstracker";
static final String CONFIG_PID = "binding." + BINDING_ID;
import java.math.BigDecimal;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
import org.openhab.core.config.core.Configuration;
import org.openhab.core.library.types.PointType;
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public class ConfigHelper {
// configuration constants
public static final String CONFIG_TRACKER_ID = "trackerId";
return (String) config.get(CONFIG_TRACKER_ID);
}
- public static PointType getRegionCenterLocation(Configuration config) {
+ public static @Nullable PointType getRegionCenterLocation(Configuration config) {
String location = (String) config.get(CONFIG_REGION_CENTER_LOCATION);
return location != null ? new PointType(location) : null;
}
import javax.measure.Unit;
import javax.measure.quantity.Length;
-import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.gpstracker.internal.config.ConfigHelper;
-import org.openhab.binding.gpstracker.internal.message.LocationMessage;
import org.openhab.binding.gpstracker.internal.message.NotificationBroker;
import org.openhab.binding.gpstracker.internal.message.NotificationHandler;
-import org.openhab.binding.gpstracker.internal.message.TransitionMessage;
+import org.openhab.binding.gpstracker.internal.message.dto.LocationMessage;
+import org.openhab.binding.gpstracker.internal.message.dto.TransitionMessage;
import org.openhab.core.config.core.Configuration;
import org.openhab.core.i18n.UnitProvider;
import org.openhab.core.library.types.PointType;
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public class TrackerHandler extends BaseThingHandler {
/**
* Trigger events
/**
* System location
*/
- private PointType sysLocation;
+ private @Nullable PointType sysLocation;
/**
* Unit provider
*/
- private UnitProvider unitProvider;
+ private @Nullable UnitProvider unitProvider;
/**
* Last message received from the tracker
*/
- private LocationMessage lastMessage;
+ private @Nullable LocationMessage lastMessage;
/**
* Constructor.
* @param unitProvider Unit provider
*/
public TrackerHandler(Thing thing, NotificationBroker notificationBroker, Set<String> regions,
- PointType sysLocation, UnitProvider unitProvider) {
+ @Nullable PointType sysLocation, @Nullable UnitProvider unitProvider) {
super(thing);
this.notificationBroker = notificationBroker;
ChannelUID systemDistanceChannelUID = new ChannelUID(thing.getUID(), CHANNEL_DISTANCE_SYSTEM_ID);
Channel systemDistance = thing.getChannel(CHANNEL_DISTANCE_SYSTEM_ID);
ChannelBuilder channelBuilder = null;
+ String sysLocationString = sysLocation == null ? "unknown" : sysLocation.toFullString();
if (systemDistance != null) {
- if (!systemDistance.getConfiguration().get(CONFIG_REGION_CENTER_LOCATION)
- .equals(sysLocation.toFullString())) {
+ if (!systemDistance.getConfiguration().get(CONFIG_REGION_CENTER_LOCATION).equals(sysLocationString)) {
logger.trace("Existing distance channel for system. Changing system location config parameter: {}",
- sysLocation.toFullString());
+ sysLocationString);
channelBuilder = callback.editChannel(thing, systemDistanceChannelUID);
Configuration configToUpdate = systemDistance.getConfiguration();
- configToUpdate.put(CONFIG_REGION_CENTER_LOCATION, sysLocation.toFullString());
+ configToUpdate.put(CONFIG_REGION_CENTER_LOCATION, sysLocationString);
channelBuilder.withConfiguration(configToUpdate);
} else {
logger.trace("Existing distance channel for system. No change.");
Configuration config = new Configuration();
config.put(ConfigHelper.CONFIG_REGION_NAME, CHANNEL_DISTANCE_SYSTEM_NAME);
- config.put(CONFIG_REGION_CENTER_LOCATION, sysLocation.toFullString());
+ config.put(CONFIG_REGION_CENTER_LOCATION, sysLocationString);
config.put(ConfigHelper.CONFIG_REGION_RADIUS, CHANNEL_DISTANCE_SYSTEM_RADIUS);
config.put(ConfigHelper.CONFIG_ACCURACY_THRESHOLD, 0);
@Override
public void handleCommand(ChannelUID channelUID, Command command) {
- if (command instanceof RefreshType && lastMessage != null) {
+ LocationMessage lastMessageLocal = lastMessage;
+ if (command instanceof RefreshType && lastMessageLocal != null) {
String channelId = channelUID.getId();
switch (channelId) {
case CHANNEL_LAST_REPORT:
- updateBaseChannels(lastMessage, CHANNEL_LAST_REPORT);
+ updateBaseChannels(lastMessageLocal, CHANNEL_LAST_REPORT);
break;
case CHANNEL_LAST_LOCATION:
- updateBaseChannels(lastMessage, CHANNEL_LAST_LOCATION);
+ updateBaseChannels(lastMessageLocal, CHANNEL_LAST_LOCATION);
break;
case CHANNEL_BATTERY_LEVEL:
- updateBaseChannels(lastMessage, CHANNEL_BATTERY_LEVEL);
+ updateBaseChannels(lastMessageLocal, CHANNEL_BATTERY_LEVEL);
break;
case CHANNEL_GPS_ACCURACY:
- updateBaseChannels(lastMessage, CHANNEL_GPS_ACCURACY);
+ updateBaseChannels(lastMessageLocal, CHANNEL_GPS_ACCURACY);
break;
default: // distance channels
@Nullable
Channel channel = thing.getChannel(channelId);
if (channel != null) {
- updateDistanceChannelFromMessage(lastMessage, channel);
+ updateDistanceChannelFromMessage(lastMessageLocal, channel);
}
}
}
* @param event Occurred event
* @param forced Force channel triggering in case the transition event is received from the mobile application.
*/
- private void triggerRegionChannel(@NonNull String regionName, @NonNull String event, boolean forced) {
+ private void triggerRegionChannel(String regionName, String event, boolean forced) {
Boolean lastState = lastTriggeredStates.get(regionName);
Boolean newState = EVENT_ENTER.equals(event);
if (!newState.equals(lastState) || forced) {
}
private double convertToMeters(double valueToConvert) {
- if (unitProvider != null) {
+ UnitProvider unitProviderLocal = unitProvider;
+ if (unitProviderLocal != null) {
@Nullable
- Unit<Length> unit = unitProvider.getUnit(Length.class);
+ Unit<Length> unit = unitProviderLocal.getUnit(Length.class);
if (unit != null && !SIUnits.METRE.equals(unit)) {
double value = ImperialUnits.YARD.getConverterTo(SIUnits.METRE).convert(valueToConvert);
logger.trace("Value converted: {}yd->{}m", valueToConvert, value);
+++ /dev/null
-/**
- * Copyright (c) 2010-2023 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.gpstracker.internal.message;
-
-import java.math.BigDecimal;
-import java.time.ZoneId;
-import java.time.ZonedDateTime;
-import java.util.Date;
-
-import org.eclipse.jdt.annotation.NonNullByDefault;
-import org.eclipse.jdt.annotation.Nullable;
-import org.openhab.core.library.types.DateTimeType;
-import org.openhab.core.library.types.DecimalType;
-import org.openhab.core.library.types.PointType;
-import org.openhab.core.library.types.QuantityType;
-import org.openhab.core.library.unit.SIUnits;
-import org.openhab.core.types.State;
-import org.openhab.core.types.UnDefType;
-
-import com.google.gson.annotations.SerializedName;
-
-/**
- * The {@link LocationMessage} is a POJO for location messages sent bz trackers.
- *
- * @author Gabor Bicskei - Initial contribution
- */
-@NonNullByDefault
-public class LocationMessage {
-
- /**
- * Message type
- */
- @SerializedName("_type")
- private String type = "";
-
- /**
- * Tracker ID used to display the initials of a user (iOS,Android/string/optional) required for http mode
- */
- @SerializedName("tid")
- private String trackerId = "";
-
- /**
- * Latitude (iOS, Android/float/meters/required)
- */
- @SerializedName("lat")
- private BigDecimal latitude = BigDecimal.ZERO;
-
- /**
- * Longitude (iOS,Android/float/meters/required)
- */
- @SerializedName("lon")
- private BigDecimal longitude = BigDecimal.ZERO;
-
- /**
- * GPS accuracy
- */
- @SerializedName("acc")
- private @Nullable BigDecimal gpsAccuracy;
-
- /**
- * Battery level (iOS,Android/integer/percent/optional)
- */
- @SerializedName("batt")
- private Integer batteryLevel = Integer.MIN_VALUE;
-
- /**
- * Timestamp at which the event occurred (iOS,Android/integer/epoch/required)
- */
- @SerializedName("tst")
- private Long timestampMillis = Long.MIN_VALUE;
-
- public String getTrackerId() {
- return trackerId.replaceAll("[^a-zA-Z0-9_]", "");
- }
-
- /**
- * Converts event timestamp onto DateTimeType
- *
- * @return Conversion result
- */
- public State getTimestamp() {
- if (timestampMillis != Long.MIN_VALUE) {
- ZonedDateTime zonedDateTime = ZonedDateTime.ofInstant(new Date(timestampMillis * 1000).toInstant(),
- ZoneId.systemDefault());
- return new DateTimeType(zonedDateTime);
- }
- return UnDefType.UNDEF;
- }
-
- /**
- * Converts tracker coordinates into PointType
- *
- * @return Conversion result
- */
- public State getTrackerLocation() {
- if (!BigDecimal.ZERO.equals(latitude) && !BigDecimal.ZERO.equals(longitude)) {
- return new PointType(new DecimalType(latitude), new DecimalType(longitude));
- }
- return UnDefType.UNDEF;
- }
-
- /**
- * Converts battery level into DecimalType
- *
- * @return Conversion result
- */
- public State getBatteryLevel() {
- if (batteryLevel != Integer.MIN_VALUE) {
- return new DecimalType(batteryLevel);
- }
- return UnDefType.UNDEF;
- }
-
- public State getGpsAccuracy() {
- if (gpsAccuracy != null) {
- return new QuantityType<>(gpsAccuracy.intValue(), SIUnits.METRE);
- }
- return UnDefType.UNDEF;
- }
-
- @Override
- public String toString() {
- return "LocationMessage [" + ("type=" + type + ", ") + ("trackerId=" + trackerId + ", ")
- + ("latitude=" + latitude + ", ") + ("longitude=" + longitude + ", ")
- + (gpsAccuracy != null ? "gpsAccuracy=" + gpsAccuracy + ", " : "")
- + ("batteryLevel=" + batteryLevel + ", ") + ("timestampMillis=" + timestampMillis) + "]";
- }
-}
import java.util.HashMap;
import java.util.Map;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.openhab.binding.gpstracker.internal.message.dto.LocationMessage;
+import org.openhab.binding.gpstracker.internal.message.dto.TransitionMessage;
+
import com.google.gson.Gson;
/**
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public class MessageUtil {
/**
* Patterns to identify incoming JSON payload.
* @param json JSON string.
* @return Parsed message POJO or null without pattern match
*/
- public LocationMessage fromJson(String json) {
+ public @Nullable LocationMessage fromJson(String json) {
for (String pattern : PATTERNS) {
Class<? extends LocationMessage> c = MESSAGE_TYPES.get(pattern);
if (c != null && json.matches(pattern)) {
import java.util.HashMap;
import java.util.Map;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.binding.gpstracker.internal.message.dto.LocationMessage;
+
/**
* Notification broker.
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public class NotificationBroker {
/**
* Handlers
import java.util.List;
import java.util.Map;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.binding.gpstracker.internal.message.dto.LocationMessage;
+import org.openhab.binding.gpstracker.internal.message.dto.TransitionMessage;
+
/**
* Handler for notification messages between trackers.
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public class NotificationHandler {
/**
* Location notifications need to be sent to the own tracker. Only the last location is saved for each tracker
if (msg instanceof TransitionMessage) {
List<TransitionMessage> transitionMessages = transitionNotifications.computeIfAbsent(trackerId,
k -> new ArrayList<>());
- transitionMessages.add((TransitionMessage) msg);
+ if (transitionMessages != null) {
+ transitionMessages.add((TransitionMessage) msg);
+ }
} else {
locationNotifications.put(trackerId, msg);
}
+++ /dev/null
-/**
- * Copyright (c) 2010-2023 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.gpstracker.internal.message;
-
-import com.google.gson.annotations.SerializedName;
-
-/**
- * TransitionMessage message POJO
- *
- * @author Gabor Bicskei - Initial contribution
- */
-public class TransitionMessage extends LocationMessage {
-
- /**
- * Event that triggered the transition (iOS,Android/string/required)
- * enter The tracker entered the defined geographical region or BLE Beacon range (iOS)
- * leave The tracker left the defined geographical region or BLE Beacon range (iOS)
- */
- @SerializedName("event")
- String event;
-
- /**
- * Name of the waypoint (iOS,Android/string/optional)
- */
- @SerializedName("desc")
- String regionName;
-
- public String getRegionName() {
- return regionName;
- }
-
- public String getEvent() {
- return event;
- }
-}
--- /dev/null
+/**
+ * Copyright (c) 2010-2023 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.gpstracker.internal.message.dto;
+
+import java.math.BigDecimal;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
+import java.util.Date;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.openhab.core.library.types.DateTimeType;
+import org.openhab.core.library.types.DecimalType;
+import org.openhab.core.library.types.PointType;
+import org.openhab.core.library.types.QuantityType;
+import org.openhab.core.library.unit.SIUnits;
+import org.openhab.core.types.State;
+import org.openhab.core.types.UnDefType;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * The {@link LocationMessage} is a POJO for location messages sent bz trackers.
+ *
+ * @author Gabor Bicskei - Initial contribution
+ */
+@NonNullByDefault
+public class LocationMessage {
+
+ /**
+ * Message type
+ */
+ @SerializedName("_type")
+ private String type = "";
+
+ /**
+ * Tracker ID used to display the initials of a user (iOS,Android/string/optional) required for http mode
+ */
+ @SerializedName("tid")
+ private String trackerId = "";
+
+ /**
+ * Altitude (iOS, Android/integer/meters/optional)
+ */
+ @SerializedName("alt")
+ private Integer altitude = Integer.MIN_VALUE;
+
+ /**
+ * Latitude (iOS, Android/float/meters/required)
+ */
+ @SerializedName("lat")
+ private BigDecimal latitude = BigDecimal.ZERO;
+
+ /**
+ * Longitude (iOS,Android/float/meters/required)
+ */
+ @SerializedName("lon")
+ private BigDecimal longitude = BigDecimal.ZERO;
+
+ /**
+ * GPS accuracy
+ */
+ @SerializedName("acc")
+ private @Nullable BigDecimal gpsAccuracy;
+
+ /**
+ * Battery level (iOS,Android/integer/percent/optional)
+ */
+ @SerializedName("batt")
+ private Integer batteryLevel = Integer.MIN_VALUE;
+
+ /**
+ * Timestamp at which the event occurred (iOS,Android/integer/epoch/required)
+ */
+ @SerializedName("tst")
+ private Long timestampMillis = Long.MIN_VALUE;
+
+ public String getTrackerId() {
+ return trackerId.replaceAll("[^a-zA-Z0-9_]", "");
+ }
+
+ /**
+ * Converts event timestamp onto DateTimeType
+ *
+ * @return Conversion result
+ */
+ public State getTimestamp() {
+ if (timestampMillis != Long.MIN_VALUE) {
+ ZonedDateTime zonedDateTime = ZonedDateTime.ofInstant(new Date(timestampMillis * 1000).toInstant(),
+ ZoneId.systemDefault());
+ return new DateTimeType(zonedDateTime);
+ }
+ return UnDefType.UNDEF;
+ }
+
+ /**
+ * Converts tracker coordinates into PointType
+ *
+ * @return Conversion result
+ */
+ public State getTrackerLocation() {
+ if (!BigDecimal.ZERO.equals(latitude) && !BigDecimal.ZERO.equals(longitude) && Integer.MIN_VALUE != altitude) {
+ return new PointType(new DecimalType(latitude), new DecimalType(longitude), new DecimalType(altitude));
+ } else if (!BigDecimal.ZERO.equals(latitude) && !BigDecimal.ZERO.equals(longitude)) {
+ return new PointType(new DecimalType(latitude), new DecimalType(longitude));
+ }
+ return UnDefType.UNDEF;
+ }
+
+ /**
+ * Converts battery level into DecimalType
+ *
+ * @return Conversion result
+ */
+ public State getBatteryLevel() {
+ if (batteryLevel != Integer.MIN_VALUE) {
+ return new DecimalType(batteryLevel);
+ }
+ return UnDefType.UNDEF;
+ }
+
+ public State getGpsAccuracy() {
+ BigDecimal gpsAccuracyLocal = gpsAccuracy;
+ if (gpsAccuracyLocal != null) {
+ return new QuantityType<>(gpsAccuracyLocal.intValue(), SIUnits.METRE);
+ }
+ return UnDefType.UNDEF;
+ }
+
+ @Override
+ public String toString() {
+ return "LocationMessage [" + ("type=" + type + ", ") + ("trackerId=" + trackerId + ", ")
+ + ("latitude=" + latitude + ", ") + ("longitude=" + longitude + ", ") + ("altitude=" + altitude + ", ")
+ + (gpsAccuracy != null ? "gpsAccuracy=" + gpsAccuracy + ", " : "")
+ + ("batteryLevel=" + batteryLevel + ", ") + ("timestampMillis=" + timestampMillis) + "]";
+ }
+}
--- /dev/null
+/**
+ * Copyright (c) 2010-2023 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.gpstracker.internal.message.dto;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * TransitionMessage message POJO
+ *
+ * @author Gabor Bicskei - Initial contribution
+ */
+public class TransitionMessage extends LocationMessage {
+
+ /**
+ * Event that triggered the transition (iOS,Android/string/required)
+ * enter The tracker entered the defined geographical region or BLE Beacon range (iOS)
+ * leave The tracker left the defined geographical region or BLE Beacon range (iOS)
+ */
+ @SerializedName("event")
+ String event;
+
+ /**
+ * Name of the waypoint (iOS,Android/string/optional)
+ */
+ @SerializedName("desc")
+ String regionName;
+
+ public String getRegionName() {
+ return regionName;
+ }
+
+ public String getEvent() {
+ return event;
+ }
+}
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.gpstracker.internal.discovery.TrackerDiscoveryService;
import org.openhab.binding.gpstracker.internal.handler.TrackerHandler;
-import org.openhab.binding.gpstracker.internal.message.LocationMessage;
import org.openhab.binding.gpstracker.internal.message.MessageUtil;
-import org.openhab.binding.gpstracker.internal.message.TransitionMessage;
+import org.openhab.binding.gpstracker.internal.message.dto.LocationMessage;
+import org.openhab.binding.gpstracker.internal.message.dto.TransitionMessage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public abstract class AbstractCallbackServlet extends HttpServlet {
private static final long serialVersionUID = -2725161358635927815L;
* @param trackerId Tracker id.
* @return Handler for tracker.
*/
- private TrackerHandler getHandlerById(String trackerId) {
- if (trackerId != null) {
- TrackerHandler handler = trackerRegistry.getTrackerHandler(trackerId);
- if (handler == null) {
- // handler was not found - adding the tracker to discovery service.
- discoveryService.addTracker(trackerId);
- } else {
- return handler;
- }
+ private @Nullable TrackerHandler getHandlerById(String trackerId) {
+ TrackerHandler handler = trackerRegistry.getTrackerHandler(trackerId);
+ if (handler == null) {
+ // handler was not found - adding the tracker to discovery service.
+ discoveryService.addTracker(trackerId);
+ } else {
+ return handler;
}
+
return null;
}
*/
package org.openhab.binding.gpstracker.internal.provider.gpslogger;
+import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.binding.gpstracker.internal.discovery.TrackerDiscoveryService;
import org.openhab.binding.gpstracker.internal.provider.AbstractCallbackServlet;
import org.openhab.binding.gpstracker.internal.provider.TrackerRegistry;
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public class GPSLoggerCallbackServlet extends AbstractCallbackServlet {
private static final long serialVersionUID = -6992472786850682196L;
*/
package org.openhab.binding.gpstracker.internal.provider.owntracks;
+import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.binding.gpstracker.internal.discovery.TrackerDiscoveryService;
import org.openhab.binding.gpstracker.internal.provider.AbstractCallbackServlet;
import org.openhab.binding.gpstracker.internal.provider.TrackerRegistry;
*
* @author Gabor Bicskei - Initial contribution
*/
+@NonNullByDefault
public class OwnTracksCallbackServlet extends AbstractCallbackServlet {
private static final long serialVersionUID = -4053305903339688036L;
projects / openhab-addons.git / commitdiff