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

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