git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 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.insteon.internal.device;
  14
  15 import java.io.IOException;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Map.Entry;
  19 import java.util.concurrent.ScheduledExecutorService;
  20 import java.util.concurrent.ScheduledFuture;
  21 import java.util.concurrent.TimeUnit;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.openhab.binding.insteon.internal.driver.ModemDBEntry;
  26 import org.openhab.binding.insteon.internal.driver.Port;
  27 import org.openhab.binding.insteon.internal.message.FieldException;
  28 import org.openhab.binding.insteon.internal.message.InvalidMessageTypeException;
  29 import org.openhab.binding.insteon.internal.message.Msg;
  30 import org.openhab.binding.insteon.internal.message.MsgListener;
  31 import org.openhab.binding.insteon.internal.utils.Utils;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 /**
  36  * Builds the modem database from incoming link record messages
  37  *
  38  * @author Bernd Pfrommer - Initial contribution
  39  * @author Rob Nielsen - Port to openHAB 2 insteon binding
  40  */
  41 @NonNullByDefault
  42 public class ModemDBBuilder implements MsgListener {
  43     private static final int MESSAGE_TIMEOUT = 30000;
  44
  45     private final Logger logger = LoggerFactory.getLogger(ModemDBBuilder.class);
  46
  47     private volatile boolean isComplete = false;
  48     private Port port;
  49     private ScheduledExecutorService scheduler;
  50     private @Nullable ScheduledFuture<?> job = null;
  51     private volatile long lastMessageTimestamp;
  52     private volatile int messageCount = 0;
  53
  54     public ModemDBBuilder(Port port, ScheduledExecutorService scheduler) {
  55         this.port = port;
  56         this.scheduler = scheduler;
  57     }
  58
  59     public void start() {
  60         port.addListener(this);
  61
  62         logger.trace("starting modem db builder");
  63         startDownload();
  64         job = scheduler.scheduleWithFixedDelay(() -> {
  65             if (isComplete()) {
  66                 logger.trace("modem db builder finished");
  67                 ScheduledFuture<?> job = this.job;
  68                 if (job != null) {
  69                     job.cancel(false);
  70                 }
  71                 this.job = null;
  72             } else {
  73                 if (System.currentTimeMillis() - lastMessageTimestamp > MESSAGE_TIMEOUT) {
  74                     String s = "";
  75                     if (messageCount == 0) {
  76                         s = " No messages were received, the PLM or hub might be broken. If this continues see "
  77                                 + "'Known Limitations and Issues' in the Insteon binding documentation.";
  78                     }
  79                     logger.warn("Modem database download was unsuccessful, restarting!{}", s);
  80                     startDownload();
  81                 }
  82             }
  83         }, 0, 1, TimeUnit.SECONDS);
  84     }
  85
  86     private void startDownload() {
  87         logger.trace("starting modem database download");
  88         port.clearModemDB();
  89         lastMessageTimestamp = System.currentTimeMillis();
  90         messageCount = 0;
  91         getFirstLinkRecord();
  92     }
  93
  94     public boolean isComplete() {
  95         return isComplete;
  96     }
  97
  98     private void getFirstLinkRecord() {
  99         try {
 100             port.writeMessage(Msg.makeMessage("GetFirstALLLinkRecord"));
 101         } catch (IOException e) {
 102             logger.warn("error sending link record query ", e);
 103         } catch (InvalidMessageTypeException e) {
 104             logger.warn("invalid message ", e);
 105         }
 106     }
 107
 108     /**
 109      * processes link record messages from the modem to build database
 110      * and request more link records if not finished.
 111      * {@inheritDoc}
 112      */
 113     @Override
 114     public void msg(Msg msg) {
 115         lastMessageTimestamp = System.currentTimeMillis();
 116         messageCount++;
 117
 118         if (msg.isPureNack()) {
 119             return;
 120         }
 121         try {
 122             if (msg.getByte("Cmd") == 0x69 || msg.getByte("Cmd") == 0x6a) {
 123                 // If the flag is "ACK/NACK", a record response
 124                 // will follow, so we do nothing here.
 125                 // If its "NACK", there are none
 126                 if (msg.getByte("ACK/NACK") == 0x15) {
 127                     logger.debug("got all link records.");
 128                     done();
 129                 }
 130             } else if (msg.getByte("Cmd") == 0x57) {
 131                 // we got the link record response
 132                 updateModemDB(msg.getAddress("LinkAddr"), port, msg, false);
 133                 port.writeMessage(Msg.makeMessage("GetNextALLLinkRecord"));
 134             }
 135         } catch (FieldException e) {
 136             logger.debug("bad field handling link records {}", e.getMessage());
 137         } catch (IOException e) {
 138             logger.debug("got IO exception handling link records {}", e.getMessage());
 139         } catch (IllegalStateException e) {
 140             logger.debug("got exception requesting link records {}", e.getMessage());
 141         } catch (InvalidMessageTypeException e) {
 142             logger.warn("invalid message ", e);
 143         }
 144     }
 145
 146     private synchronized void done() {
 147         isComplete = true;
 148         logModemDB();
 149         port.removeListener(this);
 150         port.modemDBComplete();
 151     }
 152
 153     private void logModemDB() {
 154         try {
 155             logger.debug("MDB ------- start of modem link records ------------------");
 156             Map<InsteonAddress, ModemDBEntry> dbes = port.getDriver().lockModemDBEntries();
 157             for (Entry<InsteonAddress, ModemDBEntry> db : dbes.entrySet()) {
 158                 List<Msg> lrs = db.getValue().getLinkRecords();
 159                 for (Msg m : lrs) {
 160                     int recordFlags = m.getByte("RecordFlags") & 0xff;
 161                     String ms = ((recordFlags & (0x1 << 6)) != 0) ? "CTRL" : "RESP";
 162                     logger.debug("MDB {}: {} group: {} data1: {} data2: {} data3: {}", db.getKey(), ms,
 163                             toHex(m.getByte("ALLLinkGroup")), toHex(m.getByte("LinkData1")),
 164                             toHex(m.getByte("LinkData2")), toHex(m.getByte("LinkData2")));
 165                 }
 166                 logger.debug("MDB -----");
 167             }
 168             logger.debug("MDB ---------------- end of modem link records -----------");
 169         } catch (FieldException e) {
 170             logger.warn("cannot access field:", e);
 171         } finally {
 172             port.getDriver().unlockModemDBEntries();
 173         }
 174     }
 175
 176     public static String toHex(byte b) {
 177         return Utils.getHexString(b);
 178     }
 179
 180     public void updateModemDB(InsteonAddress linkAddr, Port port, @Nullable Msg m, boolean isModem) {
 181         try {
 182             Map<InsteonAddress, ModemDBEntry> dbes = port.getDriver().lockModemDBEntries();
 183             ModemDBEntry dbe = dbes.get(linkAddr);
 184             if (dbe == null) {
 185                 dbe = new ModemDBEntry(linkAddr, isModem);
 186                 dbes.put(linkAddr, dbe);
 187             }
 188             dbe.setPort(port);
 189             if (m != null) {
 190                 dbe.addLinkRecord(m);
 191                 try {
 192                     byte group = m.getByte("ALLLinkGroup");
 193                     int recordFlags = m.getByte("RecordFlags") & 0xff;
 194                     if ((recordFlags & (0x1 << 6)) != 0) {
 195                         dbe.addControls(group);
 196                     } else {
 197                         dbe.addRespondsTo(group);
 198                     }
 199                 } catch (FieldException e) {
 200                     logger.warn("cannot access field:", e);
 201                 }
 202             }
 203         } finally {
 204             port.getDriver().unlockModemDBEntries();
 205         }
 206     }
 207 }