[emotiva] Improve logging, retry job, static typing and type inferenc…

…e. (openhab#17596) * Add and improve logging when trying to map channel change to Emotiva Control Commands. * Improve logging of notifications and keep alive job. * Improve checking of retry job status. * Improve static typing of previous state. * Use type inference in selected places. Signed-off-by: Espen Fossen <espenaf@junta.no> Signed-off-by: Ciprian Pascu <contact@ciprianpascu.ro>
cipianpascu · Jan 2, 2025 · 29cca2c · 29cca2c
1 parent 7a45a61
commit 29cca2c
Show file tree

Hide file tree

Showing 32 changed files with 358 additions and 220 deletions.
diff --git a/...g.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaBindingConstants.java b/...g.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaBindingConstants.java
@@ -52,9 +52,6 @@ public class EmotivaBindingConstants {
      */
     static final int DEFAULT_KEEP_ALIVE_IN_MILLISECONDS = 7500;
 
-    /** State name for storing keepAlive timestamp messages */
-    public static final String LAST_SEEN_STATE_NAME = "no-channel#last-seen";
-
     /**
      * Default Emotiva device considered list in milliseconds.
      * {@link org.openhab.binding.emotiva.internal.dto.ControlDTO}

diff --git a/...ding.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaCommandHelper.java b/...ding.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaCommandHelper.java
@@ -94,7 +94,7 @@ public static String getMenuPanelColumnLabel(int column) {
 
     public static String updateProgress(double progressPercentage) {
         final int width = 30;
-        StringBuilder sb = new StringBuilder();
+        var sb = new StringBuilder();
 
         sb.append("[");
         int i = 0;

diff --git a/...g.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaProcessorHandler.java b/...g.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaProcessorHandler.java
diff --git a/...ing.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaProcessorState.java b/...ing.emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaProcessorState.java
@@ -20,6 +20,7 @@
 import static org.openhab.binding.emotiva.internal.protocol.EmotivaControlCommands.band_fm;
 import static org.openhab.binding.emotiva.internal.protocol.EmotivaControlCommands.channel_1;
 
+import java.time.Instant;
 import java.util.Collections;
 import java.util.EnumMap;
 import java.util.HashMap;
@@ -44,6 +45,7 @@ public class EmotivaProcessorState {
     private EnumMap<EmotivaControlCommands, String> sourcesMainZone;
     private EnumMap<EmotivaControlCommands, String> sourcesZone2;
     private final EnumMap<EmotivaSubscriptionTags, String> modes;
+    private Instant lastSeen = Instant.EPOCH;
 
     private EnumMap<EmotivaControlCommands, String> tunerChannels = new EnumMap<>(
             Map.ofEntries(Map.entry(channel_1, channel_1.getLabel()),
@@ -146,4 +148,12 @@ public void updateModes(EmotivaSubscriptionTags tag, String value) {
     public void removeChannel(String channel) {
         channelStateMap.remove(channel);
     }
+
+    public void updateLastSeen(Instant instant) {
+        lastSeen = instant;
+    }
+
+    public Instant getLastSeen() {
+        return lastSeen;
+    }
 }
diff --git a/...motiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaUdpBroadcastService.java b/...motiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaUdpBroadcastService.java
@@ -73,7 +73,7 @@ public EmotivaUdpBroadcastService(String broadcastAddress) throws IllegalArgumen
      */
     public Optional<DiscoveryResult> discoverThings() {
         try {
-            final DatagramPacket receivePacket = new DatagramPacket(new byte[MAX_PACKET_SIZE], MAX_PACKET_SIZE);
+            final var receivePacket = new DatagramPacket(new byte[MAX_PACKET_SIZE], MAX_PACKET_SIZE);
             // No need to call close first, because the caller of this method already has done it.
 
             discoverSocket = new DatagramSocket(
@@ -82,7 +82,7 @@ public Optional<DiscoveryResult> discoverThings() {
 
             byte[] emotivaPingDTO = xmlUtils.marshallEmotivaDTO(new EmotivaPingDTO(PROTOCOL_V3.name()))
                     .getBytes(Charset.defaultCharset());
-            final DatagramPacket discoverPacket = new DatagramPacket(emotivaPingDTO, emotivaPingDTO.length, broadcast,
+            final var discoverPacket = new DatagramPacket(emotivaPingDTO, emotivaPingDTO.length, broadcast,
                     EmotivaBindingConstants.DEFAULT_PING_PORT);
 
             DatagramSocket localDatagramSocket = discoverSocket;
@@ -146,7 +146,7 @@ public void closeDiscoverSocket() {
      */
     private Optional<DiscoveryResult> thingDiscovered(DatagramPacket packet) {
         final String ipAddress = packet.getAddress().getHostAddress();
-        String udpResponse = new String(packet.getData(), 0, packet.getLength() - 1, StandardCharsets.UTF_8);
+        final var udpResponse = new String(packet.getData(), 0, packet.getLength() - 1, StandardCharsets.UTF_8);
 
         Object object;
         try {
@@ -159,8 +159,7 @@ private Optional<DiscoveryResult> thingDiscovered(DatagramPacket packet) {
         if (object instanceof EmotivaTransponderDTO answerDto) {
             logger.trace("Processing Received '{}' with '{}' ", EmotivaTransponderDTO.class.getSimpleName(),
                     udpResponse);
-            final ThingUID thingUid = new ThingUID(
-                    THING_PROCESSOR + AbstractUID.SEPARATOR + ipAddress.replace(".", ""));
+            final var thingUid = new ThingUID(THING_PROCESSOR + AbstractUID.SEPARATOR + ipAddress.replace(".", ""));
             final DiscoveryResult discoveryResult = DiscoveryResultBuilder.create(thingUid)
                     .withThingType(THING_PROCESSOR).withProperty("ipAddress", ipAddress)
                     .withProperty("controlPort", answerDto.getControl().getControlPort())

diff --git a/...motiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaUdpReceivingService.java b/...motiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaUdpReceivingService.java
@@ -150,7 +150,7 @@ private void listenUnhandledInterruption() throws InterruptedException {
         final DatagramSocket localReceivingSocket = receivingSocket;
         while (localListener != null && localReceivingSocket != null && receivingSocket != null) {
             try {
-                final DatagramPacket answer = new DatagramPacket(new byte[MAX_PACKET_SIZE], MAX_PACKET_SIZE);
+                final var answer = new DatagramPacket(new byte[MAX_PACKET_SIZE], MAX_PACKET_SIZE);
 
                 listenerNotifyActive = true;
                 localReceivingSocket.receive(answer); // receive packet (blocking call)
@@ -193,8 +193,8 @@ private void handleReceivedData(DatagramPacket answer, Consumer<EmotivaUdpRespon
         executorService.execute(() -> {
             if (answer.getAddress() != null && answer.getLength() > 0) {
                 logger.trace("Received data on port '{}'", answer.getPort());
-                EmotivaUdpResponse emotivaUdpResponse = new EmotivaUdpResponse(
-                        new String(answer.getData(), 0, answer.getLength()), answer.getAddress().getHostAddress());
+                var emotivaUdpResponse = new EmotivaUdpResponse(new String(answer.getData(), 0, answer.getLength()),
+                        answer.getAddress().getHostAddress());
                 localListener.accept(emotivaUdpResponse);
             }
         });

diff --git a/....emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaUdpSendingService.java b/....emotiva/src/main/java/org/openhab/binding/emotiva/internal/EmotivaUdpSendingService.java
@@ -128,8 +128,8 @@ private void handleReceivedData(DatagramPacket answer, Consumer<EmotivaUdpRespon
         executorService.execute(() -> {
             if (answer.getAddress() != null && answer.getLength() > 0) {
                 logger.trace("Received data on port '{}'", answer.getPort());
-                EmotivaUdpResponse emotivaUdpResponse = new EmotivaUdpResponse(
-                        new String(answer.getData(), 0, answer.getLength()), answer.getAddress().getHostAddress());
+                var emotivaUdpResponse = new EmotivaUdpResponse(new String(answer.getData(), 0, answer.getLength()),
+                        answer.getAddress().getHostAddress());
                 localListener.accept(emotivaUdpResponse);
             }
         });
@@ -183,17 +183,17 @@ public void send(String msg) throws IOException {
 
         final InetAddress ipAddress = InetAddress.getByName(this.ipAddress);
         byte[] buf = msg.getBytes(Charset.defaultCharset());
-        DatagramPacket packet = new DatagramPacket(buf, buf.length, ipAddress, sendingControlPort);
+        var packet = new DatagramPacket(buf, buf.length, ipAddress, sendingControlPort);
 
         // make sure we are not interrupted by a disconnect while sending this message
         synchronized (this) {
             DatagramSocket localDatagramSocket = this.sendingSocket;
-            final DatagramPacket answer = new DatagramPacket(new byte[MAX_PACKET_SIZE], MAX_PACKET_SIZE);
+            final var answer = new DatagramPacket(new byte[MAX_PACKET_SIZE], MAX_PACKET_SIZE);
             final Consumer<EmotivaUdpResponse> localListener = listener;
             if (localDatagramSocket != null && !localDatagramSocket.isClosed()) {
                 localDatagramSocket.setSoTimeout(DEFAULT_UDP_SENDING_TIMEOUT);
                 localDatagramSocket.send(packet);
-                logger.debug("Sending successful");
+                logger.trace("Successfully sending to {}:{}", ipAddress, sendingControlPort);
 
                 localDatagramSocket.receive(answer);
 
@@ -209,4 +209,8 @@ public void send(String msg) throws IOException {
             }
         }
     }
+
+    public boolean isConnected() {
+        return sendingSocket != null;
+    }
 }
diff --git a/....emotiva/src/main/java/org/openhab/binding/emotiva/internal/InputStateOptionProvider.java b/....emotiva/src/main/java/org/openhab/binding/emotiva/internal/InputStateOptionProvider.java
@@ -82,7 +82,7 @@ public void setThingHandler(ThingHandler handler) {
                 for (EmotivaSubscriptionTags modeKey : modeKeys) {
                     options.add(new StateOption(modeKey.name(), modes.get(modeKey)));
                 }
-                logger.debug("Updated '{}' with '{}'", CHANNEL_MODE, options);
+                logger.trace("Updating OH channel '{}' with state options '{}'", CHANNEL_MODE, options);
                 setStateOptions(channel.getUID(), options);
             }
         }
@@ -100,7 +100,7 @@ private void setStateOptionsForSource(Channel channel, List<StateOption> options
                 options.add(new StateOption(sourceKey.name(), sourceKey.getLabel()));
             }
         }
-        logger.debug("Updated '{}' with '{}'", channel.getUID().getId(), options);
+        logger.trace("Updating OH channel '{}' with state options '{}'", channel.getUID().getId(), options);
         setStateOptions(channel.getUID(), options);
     }
 }
diff --git a/...ing.emotiva/src/main/java/org/openhab/binding/emotiva/internal/dto/EmotivaCommandDTO.java b/...ing.emotiva/src/main/java/org/openhab/binding/emotiva/internal/dto/EmotivaCommandDTO.java
@@ -71,7 +71,7 @@ public EmotivaCommandDTO(EmotivaControlCommands commandName, String value, Strin
      * @return EmotivaCommandDTO with ack=yes always added
      */
     public static EmotivaCommandDTO fromTypeWithAck(EmotivaControlCommands command) {
-        EmotivaCommandDTO emotivaCommandDTO = new EmotivaCommandDTO(command);
+        var emotivaCommandDTO = new EmotivaCommandDTO(command);
         emotivaCommandDTO.setAck(DEFAULT_CONTROL_ACK_VALUE);
         return emotivaCommandDTO;
     }
@@ -82,7 +82,7 @@ public static EmotivaCommandDTO fromTypeWithAck(EmotivaControlCommands command)
      * @return EmotivaCommandDTO with ack=yes always added
      */
     public static EmotivaCommandDTO fromTypeWithAck(EmotivaControlCommands command, String value) {
-        EmotivaCommandDTO emotivaCommandDTO = new EmotivaCommandDTO(command);
+        var emotivaCommandDTO = new EmotivaCommandDTO(command);
         if (value != null) {
             emotivaCommandDTO.setValue(value);
         }
@@ -99,7 +99,7 @@ public static EmotivaCommandDTO fromType(EmotivaSubscriptionTags command) {
     }
 
     public static EmotivaCommandDTO fromTypeWithAck(EmotivaSubscriptionTags command) {
-        EmotivaCommandDTO emotivaCommandDTO = new EmotivaCommandDTO(command);
+        var emotivaCommandDTO = new EmotivaCommandDTO(command);
         emotivaCommandDTO.setAck(DEFAULT_CONTROL_ACK_VALUE);
         return emotivaCommandDTO;
     }

diff --git a/...a/src/main/java/org/openhab/binding/emotiva/internal/protocol/EmotivaControlCommands.java b/...a/src/main/java/org/openhab/binding/emotiva/internal/protocol/EmotivaControlCommands.java
@@ -230,7 +230,7 @@ public static EnumMap<EmotivaControlCommands, String> getCommandsFromType(Emotiv
         EnumMap<EmotivaControlCommands, String> commands = new EnumMap<>(EmotivaControlCommands.class);
         for (EmotivaControlCommands value : values()) {
             if (value.getCommandType().equals(filter)) {
-                StringBuilder sb = new StringBuilder(value.name());
+                var sb = new StringBuilder(value.name());
                 sb.setCharAt(0, Character.toUpperCase(value.name().charAt(0)));
                 commands.put(value, sb.toString());
             }