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

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