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

   1 /**
   2  * Copyright (c) 2010-2022 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.powermax.internal.message;
  14
  15 import java.util.ArrayList;
  16 import java.util.Calendar;
  17 import java.util.EventObject;
  18 import java.util.GregorianCalendar;
  19 import java.util.HashMap;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.concurrent.ConcurrentLinkedQueue;
  23 import java.util.concurrent.ScheduledExecutorService;
  24 import java.util.concurrent.TimeUnit;
  25
  26 import org.eclipse.jdt.annotation.NonNullByDefault;
  27 import org.eclipse.jdt.annotation.Nullable;
  28 import org.openhab.binding.powermax.internal.connector.PowermaxConnector;
  29 import org.openhab.binding.powermax.internal.connector.PowermaxSerialConnector;
  30 import org.openhab.binding.powermax.internal.connector.PowermaxTcpConnector;
  31 import org.openhab.binding.powermax.internal.state.PowermaxArmMode;
  32 import org.openhab.binding.powermax.internal.state.PowermaxPanelSettings;
  33 import org.openhab.binding.powermax.internal.state.PowermaxPanelType;
  34 import org.openhab.binding.powermax.internal.state.PowermaxState;
  35 import org.openhab.binding.powermax.internal.state.PowermaxStateEvent;
  36 import org.openhab.binding.powermax.internal.state.PowermaxStateEventListener;
  37 import org.openhab.core.common.ThreadPoolManager;
  38 import org.openhab.core.i18n.TimeZoneProvider;
  39 import org.openhab.core.io.transport.serial.SerialPortManager;
  40 import org.openhab.core.types.Command;
  41 import org.openhab.core.util.HexUtils;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 /**
  46  * A class that manages the communication with the Visonic alarm system
  47  *
  48  * Visonic does not provide a specification of the RS232 protocol and, thus,
  49  * the binding uses the available protocol specification given at the domoticaforum
  50  * http://www.domoticaforum.eu/viewtopic.php?f=68&t=6581
  51  *
  52  * @author Laurent Garnier - Initial contribution
  53  */
  54 @NonNullByDefault
  55 public class PowermaxCommManager implements PowermaxMessageEventListener {
  56
  57     private static final int DEFAULT_TCP_PORT = 80;
  58     private static final int TCP_CONNECTION_TIMEOUT = 5000;
  59     private static final int DEFAULT_BAUD_RATE = 9600;
  60     private static final int WAITING_DELAY_FOR_RESPONSE = 750;
  61     private static final long DELAY_BETWEEN_SETUP_DOWNLOADS = TimeUnit.SECONDS.toMillis(45);
  62
  63     private final Logger logger = LoggerFactory.getLogger(PowermaxCommManager.class);
  64
  65     private final ScheduledExecutorService scheduler;
  66
  67     private final TimeZoneProvider timeZoneProvider;
  68
  69     /** The object to store the current settings of the Powermax alarm system */
  70     private final PowermaxPanelSettings panelSettings;
  71
  72     /** Panel type used when in standard mode */
  73     private final PowermaxPanelType panelType;
  74
  75     private final boolean forceStandardMode;
  76     private final boolean autoSyncTime;
  77
  78     private final List<PowermaxStateEventListener> listeners = new ArrayList<>();
  79
  80     /** The serial or TCP connecter used to communicate with the Powermax alarm system */
  81     private final PowermaxConnector connector;
  82
  83     /** The last message sent to the the Powermax alarm system */
  84     private @Nullable PowermaxBaseMessage lastSendMsg;
  85
  86     /** The message queue of messages to be sent to the the Powermax alarm system */
  87     private ConcurrentLinkedQueue<PowermaxBaseMessage> msgQueue = new ConcurrentLinkedQueue<>();
  88
  89     /** The time in milliseconds the last download of the panel setup was requested */
  90     private long lastTimeDownloadRequested;
  91
  92     /** The boolean indicating if the download of the panel setup is in progress or not */
  93     private boolean downloadRunning;
  94
  95     /** The time in milliseconds used to set time and date */
  96     private long syncTimeCheck;
  97
  98     /**
  99      * Constructor for Serial Connection
 100      *
 101      * @param sPort the serial port name
 102      * @param panelType the panel type to be used when in standard mode
 103      * @param forceStandardMode true to force the standard mode rather than trying using the Powerlink mode
 104      * @param autoSyncTime true for automatic sync time
 105      * @param serialPortManager the serial port manager
 106      * @param threadName the prefix name of threads to be created
 107      */
 108     public PowermaxCommManager(String sPort, PowermaxPanelType panelType, boolean forceStandardMode,
 109             boolean autoSyncTime, SerialPortManager serialPortManager, String threadName,
 110             TimeZoneProvider timeZoneProvider) {
 111         this.panelType = panelType;
 112         this.forceStandardMode = forceStandardMode;
 113         this.autoSyncTime = autoSyncTime;
 114         this.timeZoneProvider = timeZoneProvider;
 115         this.panelSettings = new PowermaxPanelSettings(panelType);
 116         this.scheduler = ThreadPoolManager.getScheduledPool(threadName + "-sender");
 117         this.connector = new PowermaxSerialConnector(serialPortManager, sPort.trim(), DEFAULT_BAUD_RATE,
 118                 threadName + "-reader");
 119     }
 120
 121     /**
 122      * Constructor for TCP connection
 123      *
 124      * @param ip the IP address
 125      * @param port TCP port number; default port is used if value <= 0
 126      * @param panelType the panel type to be used when in standard mode
 127      * @param forceStandardMode true to force the standard mode rather than trying using the Powerlink mode
 128      * @param autoSyncTime true for automatic sync time
 129      * @param serialPortManager
 130      * @param threadName the prefix name of threads to be created
 131      */
 132     public PowermaxCommManager(String ip, int port, PowermaxPanelType panelType, boolean forceStandardMode,
 133             boolean autoSyncTime, String threadName, TimeZoneProvider timeZoneProvider) {
 134         this.panelType = panelType;
 135         this.forceStandardMode = forceStandardMode;
 136         this.autoSyncTime = autoSyncTime;
 137         this.timeZoneProvider = timeZoneProvider;
 138         this.panelSettings = new PowermaxPanelSettings(panelType);
 139         this.scheduler = ThreadPoolManager.getScheduledPool(threadName + "-sender");
 140         this.connector = new PowermaxTcpConnector(ip.trim(), port > 0 ? port : DEFAULT_TCP_PORT, TCP_CONNECTION_TIMEOUT,
 141                 threadName + "-reader");
 142     }
 143
 144     /**
 145      * Add event listener
 146      *
 147      * @param listener the listener to be added
 148      */
 149     public synchronized void addEventListener(PowermaxStateEventListener listener) {
 150         listeners.add(listener);
 151         connector.addEventListener(this);
 152     }
 153
 154     /**
 155      * Remove event listener
 156      *
 157      * @param listener the listener to be removed
 158      */
 159     public synchronized void removeEventListener(PowermaxStateEventListener listener) {
 160         connector.removeEventListener(this);
 161         listeners.remove(listener);
 162     }
 163
 164     /**
 165      * Connect to the Powermax alarm system
 166      *
 167      * @return true if connected or false if not
 168      */
 169     public void open() throws Exception {
 170         connector.open();
 171         lastSendMsg = null;
 172         msgQueue = new ConcurrentLinkedQueue<>();
 173     }
 174
 175     /**
 176      * Close the connection to the Powermax alarm system.
 177      *
 178      * @return true if connected or false if not
 179      */
 180     public boolean close() {
 181         connector.close();
 182         lastTimeDownloadRequested = 0;
 183         downloadRunning = false;
 184         return isConnected();
 185     }
 186
 187     /**
 188      * @return true if connected to the Powermax alarm system or false if not
 189      */
 190     public boolean isConnected() {
 191         return connector.isConnected();
 192     }
 193
 194     /**
 195      * @return the current settings of the Powermax alarm system
 196      */
 197     public PowermaxPanelSettings getPanelSettings() {
 198         return panelSettings;
 199     }
 200
 201     /**
 202      * Process and store all the panel settings from the raw buffers
 203      *
 204      * @param PowerlinkMode true if in Powerlink mode or false if in standard mode
 205      *
 206      * @return true if no problem encountered to get all the settings; false if not
 207      */
 208     public boolean processPanelSettings(boolean powerlinkMode) {
 209         return panelSettings.process(powerlinkMode, panelType, powerlinkMode ? syncTimeCheck : 0);
 210     }
 211
 212     /**
 213      * @return a new instance of PowermaxState
 214      */
 215     public PowermaxState createNewState() {
 216         return new PowermaxState(panelSettings, timeZoneProvider);
 217     }
 218
 219     /**
 220      * @return the last message sent to the Powermax alarm system
 221      */
 222     public synchronized @Nullable PowermaxBaseMessage getLastSendMsg() {
 223         return lastSendMsg;
 224     }
 225
 226     @Override
 227     public void onNewMessageEvent(EventObject event) {
 228         PowermaxMessageEvent messageEvent = (PowermaxMessageEvent) event;
 229         PowermaxBaseMessage message = messageEvent.getMessage();
 230
 231         if (logger.isDebugEnabled()) {
 232             logger.debug("onNewMessageReceived(): received message 0x{} ({})",
 233                     HexUtils.bytesToHex(message.getRawData()),
 234                     (message.getReceiveType() != null) ? message.getReceiveType()
 235                             : String.format("%02X", message.getCode()));
 236         }
 237
 238         if (forceStandardMode && message instanceof PowermaxPowerlinkMessage) {
 239             message = new PowermaxBaseMessage(message.getRawData());
 240         }
 241
 242         PowermaxState updateState = message.handleMessage(this);
 243
 244         if (updateState == null) {
 245             updateState = createNewState();
 246         }
 247
 248         updateState.lastMessageTime.setValue(System.currentTimeMillis());
 249
 250         byte[] buffer = updateState.getUpdateSettings();
 251         if (buffer != null) {
 252             panelSettings.updateRawSettings(buffer);
 253         }
 254         if (!updateState.getUpdatedZoneNames().isEmpty()) {
 255             for (Integer zoneIdx : updateState.getUpdatedZoneNames().keySet()) {
 256                 panelSettings.updateZoneName(zoneIdx, updateState.getUpdatedZoneNames().get(zoneIdx));
 257             }
 258         }
 259         if (!updateState.getUpdatedZoneInfos().isEmpty()) {
 260             for (Integer zoneIdx : updateState.getUpdatedZoneInfos().keySet()) {
 261                 panelSettings.updateZoneInfo(zoneIdx, updateState.getUpdatedZoneInfos().get(zoneIdx));
 262             }
 263         }
 264
 265         PowermaxStateEvent newEvent = new PowermaxStateEvent(this, updateState);
 266
 267         // send message to event listeners
 268         listeners.forEach(listener -> listener.onNewStateEvent(newEvent));
 269     }
 270
 271     @Override
 272     public void onCommunicationFailure(String message) {
 273         close();
 274         listeners.forEach(listener -> listener.onCommunicationFailure(message));
 275     }
 276
 277     /**
 278      * Compute the CRC of a message
 279      *
 280      * @param data the buffer containing the message
 281      * @param len the size of the message in the buffer
 282      *
 283      * @return the computed CRC
 284      */
 285     public static byte computeCRC(byte[] data, int len) {
 286         long checksum = 0;
 287         for (int i = 1; i < (len - 2); i++) {
 288             checksum = checksum + (data[i] & 0x000000FF);
 289         }
 290         checksum = 0xFF - (checksum % 0xFF);
 291         if (checksum == 0xFF) {
 292             checksum = 0;
 293         }
 294         return (byte) checksum;
 295     }
 296
 297     /**
 298      * Send an ACK for a received message
 299      *
 300      * @param msg the received message object
 301      * @param ackType the type of ACK to be sent
 302      *
 303      * @return true if the ACK was sent or false if not
 304      */
 305     public synchronized boolean sendAck(PowermaxBaseMessage msg, byte ackType) {
 306         int code = msg.getCode();
 307         byte[] rawData = msg.getRawData();
 308         byte[] ackData;
 309         if ((code >= 0x80) || ((code < 0x10) && (rawData[rawData.length - 3] == 0x43))) {
 310             ackData = new byte[] { 0x0D, ackType, 0x43, 0x00, 0x0A };
 311         } else {
 312             ackData = new byte[] { 0x0D, ackType, 0x00, 0x0A };
 313         }
 314
 315         if (logger.isDebugEnabled()) {
 316             logger.debug("sendAck(): sending message {}", HexUtils.bytesToHex(ackData));
 317         }
 318         boolean done = sendMessage(ackData);
 319         if (!done) {
 320             logger.debug("sendAck(): failed");
 321         }
 322         return done;
 323     }
 324
 325     /**
 326      * Send a message to the Powermax alarm panel to change arm mode
 327      *
 328      * @param armMode the arm mode
 329      * @param pinCode the PIN code. A string of 4 characters is expected
 330      *
 331      * @return true if the message was sent or false if not
 332      */
 333     public boolean requestArmMode(PowermaxArmMode armMode, String pinCode) {
 334         logger.debug("requestArmMode(): armMode = {}", armMode.getShortName());
 335
 336         boolean done = false;
 337         if (!armMode.isAllowedCommand()) {
 338             logger.debug("Powermax alarm binding: requested arm mode {} rejected", armMode.getShortName());
 339         } else if (pinCode.length() != 4) {
 340             logger.debug("Powermax alarm binding: requested arm mode {} rejected due to invalid PIN code",
 341                     armMode.getShortName());
 342         } else {
 343             try {
 344                 byte[] dynPart = new byte[3];
 345                 dynPart[0] = armMode.getCommandCode();
 346                 dynPart[1] = (byte) Integer.parseInt(pinCode.substring(0, 2), 16);
 347                 dynPart[2] = (byte) Integer.parseInt(pinCode.substring(2, 4), 16);
 348
 349                 done = sendMessage(new PowermaxBaseMessage(PowermaxSendType.ARM, dynPart), false, 0, true);
 350             } catch (NumberFormatException e) {
 351                 logger.debug("Powermax alarm binding: requested arm mode {} rejected due to invalid PIN code",
 352                         armMode.getShortName());
 353             }
 354         }
 355         return done;
 356     }
 357
 358     /**
 359      * Send a message to the Powermax alarm panel to change PGM or X10 zone state
 360      *
 361      * @param action the requested action. Allowed values are: OFF, ON, DIM, BRIGHT
 362      * @param device the X10 device number. null is expected for PGM
 363      *
 364      * @return true if the message was sent or false if not
 365      */
 366     public boolean sendPGMX10(Command action, @Nullable Byte device) {
 367         logger.debug("sendPGMX10(): action = {}, device = {}", action, device);
 368
 369         boolean done = false;
 370
 371         Map<String, Byte> codes = new HashMap<>();
 372         codes.put("OFF", (byte) 0x00);
 373         codes.put("ON", (byte) 0x01);
 374         codes.put("DIM", (byte) 0x0A);
 375         codes.put("BRIGHT", (byte) 0x0B);
 376
 377         Byte code = codes.get(action.toString());
 378         if (code == null) {
 379             logger.debug("Powermax alarm binding: invalid PGM/X10 command: {}", action);
 380         } else if ((device != null) && ((device < 1) || (device >= panelSettings.getNbPGMX10Devices()))) {
 381             logger.debug("Powermax alarm binding: invalid X10 device id: {}", device);
 382         } else {
 383             int val = (device == null) ? 1 : (1 << device);
 384             byte[] dynPart = new byte[3];
 385             dynPart[0] = code;
 386             dynPart[1] = (byte) (val & 0x000000FF);
 387             dynPart[2] = (byte) (val >> 8);
 388
 389             done = sendMessage(new PowermaxBaseMessage(PowermaxSendType.X10PGM, dynPart), false, 0);
 390         }
 391         return done;
 392     }
 393
 394     /**
 395      * Send a message to the Powermax alarm panel to bypass a zone or to not bypass a zone
 396      *
 397      * @param bypass true to bypass the zone; false to not bypass the zone
 398      * @param zone the zone number (first zone is number 1)
 399      * @param pinCode the PIN code. A string of 4 characters is expected
 400      *
 401      * @return true if the message was sent or false if not
 402      */
 403     public boolean sendZoneBypass(boolean bypass, byte zone, String pinCode) {
 404         logger.debug("sendZoneBypass(): bypass = {}, zone = {}", bypass ? "true" : "false", zone);
 405
 406         boolean done = false;
 407
 408         if (pinCode.length() != 4) {
 409             logger.debug("Powermax alarm binding: zone bypass rejected due to invalid PIN code");
 410         } else if ((zone < 1) || (zone > panelSettings.getNbZones())) {
 411             logger.debug("Powermax alarm binding: invalid zone number: {}", zone);
 412         } else {
 413             try {
 414                 int val = (1 << (zone - 1));
 415
 416                 byte[] dynPart = new byte[10];
 417                 dynPart[0] = (byte) Integer.parseInt(pinCode.substring(0, 2), 16);
 418                 dynPart[1] = (byte) Integer.parseInt(pinCode.substring(2, 4), 16);
 419                 int i;
 420                 for (i = 2; i < 10; i++) {
 421                     dynPart[i] = 0;
 422                 }
 423                 i = bypass ? 2 : 6;
 424                 dynPart[i++] = (byte) (val & 0x000000FF);
 425                 dynPart[i++] = (byte) ((val >> 8) & 0x000000FF);
 426                 dynPart[i++] = (byte) ((val >> 16) & 0x000000FF);
 427                 dynPart[i++] = (byte) ((val >> 24) & 0x000000FF);
 428
 429                 done = sendMessage(new PowermaxBaseMessage(PowermaxSendType.BYPASS, dynPart), false, 0, true);
 430                 if (done) {
 431                     done = sendMessage(new PowermaxBaseMessage(PowermaxSendType.BYPASSTAT), false, 0);
 432                 }
 433             } catch (NumberFormatException e) {
 434                 logger.debug("Powermax alarm binding: zone bypass rejected due to invalid PIN code");
 435             }
 436         }
 437         return done;
 438     }
 439
 440     /**
 441      * Send a message to set the alarm time and date using the system time and date
 442      *
 443      * @return true if the message was sent or false if not
 444      */
 445     public boolean sendSetTime() {
 446         logger.debug("sendSetTime()");
 447
 448         boolean done = false;
 449
 450         if (autoSyncTime) {
 451             GregorianCalendar cal = new GregorianCalendar();
 452             if (cal.get(Calendar.YEAR) >= 2000) {
 453                 logger.debug("sendSetTime(): sync time {}",
 454                         String.format("%02d/%02d/%04d %02d:%02d:%02d", cal.get(Calendar.DAY_OF_MONTH),
 455                                 cal.get(Calendar.MONTH) + 1, cal.get(Calendar.YEAR), cal.get(Calendar.HOUR_OF_DAY),
 456                                 cal.get(Calendar.MINUTE), cal.get(Calendar.SECOND)));
 457
 458                 byte[] dynPart = new byte[6];
 459                 dynPart[0] = (byte) cal.get(Calendar.SECOND);
 460                 dynPart[1] = (byte) cal.get(Calendar.MINUTE);
 461                 dynPart[2] = (byte) cal.get(Calendar.HOUR_OF_DAY);
 462                 dynPart[3] = (byte) cal.get(Calendar.DAY_OF_MONTH);
 463                 dynPart[4] = (byte) (cal.get(Calendar.MONTH) + 1);
 464                 dynPart[5] = (byte) (cal.get(Calendar.YEAR) - 2000);
 465
 466                 done = sendMessage(new PowermaxBaseMessage(PowermaxSendType.SETTIME, dynPart), false, 0);
 467
 468                 cal.set(Calendar.MILLISECOND, 0);
 469                 syncTimeCheck = cal.getTimeInMillis();
 470             } else {
 471                 logger.info(
 472                         "Powermax alarm binding: time not synchronized; please correct the date/time of your openHAB server");
 473                 syncTimeCheck = 0;
 474             }
 475         } else {
 476             syncTimeCheck = 0;
 477         }
 478         return done;
 479     }
 480
 481     /**
 482      * Send a message to the Powermax alarm panel to get all the event logs
 483      *
 484      * @param pinCode the PIN code. A string of 4 characters is expected
 485      *
 486      * @return true if the message was sent or false if not
 487      */
 488     public boolean requestEventLog(String pinCode) {
 489         logger.debug("requestEventLog()");
 490
 491         boolean done = false;
 492
 493         if (pinCode.length() != 4) {
 494             logger.debug("Powermax alarm binding: requested event log rejected due to invalid PIN code");
 495         } else {
 496             try {
 497                 byte[] dynPart = new byte[3];
 498                 dynPart[0] = (byte) Integer.parseInt(pinCode.substring(0, 2), 16);
 499                 dynPart[1] = (byte) Integer.parseInt(pinCode.substring(2, 4), 16);
 500
 501                 done = sendMessage(new PowermaxBaseMessage(PowermaxSendType.EVENTLOG, dynPart), false, 0, true);
 502             } catch (NumberFormatException e) {
 503                 logger.debug("Powermax alarm binding: requested event log rejected due to invalid PIN code");
 504             }
 505         }
 506         return done;
 507     }
 508
 509     /**
 510      * Start downloading panel setup
 511      *
 512      * @return true if the message was sent or the sending is delayed; false in other cases
 513      */
 514     public synchronized boolean startDownload() {
 515         if (downloadRunning) {
 516             return false;
 517         } else {
 518             lastTimeDownloadRequested = System.currentTimeMillis();
 519             downloadRunning = true;
 520             return sendMessage(PowermaxSendType.DOWNLOAD);
 521         }
 522     }
 523
 524     /**
 525      * Act the exit of the panel setup
 526      */
 527     public synchronized void exitDownload() {
 528         downloadRunning = false;
 529     }
 530
 531     public void retryDownloadSetup(int remainingAttempts) {
 532         long now = System.currentTimeMillis();
 533         if ((remainingAttempts > 0) && !isDownloadRunning() && ((lastTimeDownloadRequested == 0)
 534                 || ((now - lastTimeDownloadRequested) >= DELAY_BETWEEN_SETUP_DOWNLOADS))) {
 535             // We wait at least 45 seconds before each retry to download the panel setup
 536             logger.debug("Powermax alarm binding: try again downloading setup");
 537             startDownload();
 538         }
 539     }
 540
 541     public void getInfosWhenInStandardMode() {
 542         sendMessage(PowermaxSendType.ZONESNAME);
 543         sendMessage(PowermaxSendType.ZONESTYPE);
 544         sendMessage(PowermaxSendType.STATUS);
 545     }
 546
 547     public void sendRestoreMessage() {
 548         sendMessage(PowermaxSendType.RESTORE);
 549     }
 550
 551     /**
 552      * @return true if a download of the panel setup is in progress
 553      */
 554     public boolean isDownloadRunning() {
 555         return downloadRunning;
 556     }
 557
 558     /**
 559      * @return the time in milliseconds the last download of the panel setup was requested or 0 if not yet requested
 560      */
 561     public long getLastTimeDownloadRequested() {
 562         return lastTimeDownloadRequested;
 563     }
 564
 565     /**
 566      * Send an ENROLL message
 567      *
 568      * @return true if the message was sent or the sending is delayed; false in other cases
 569      */
 570     public boolean enrollPowerlink() {
 571         return sendMessage(new PowermaxBaseMessage(PowermaxSendType.ENROLL), true, 0);
 572     }
 573
 574     /**
 575      * Send a message or delay the sending if time frame for receiving response is not ended
 576      *
 577      * @param msgType the message type to be sent
 578      *
 579      * @return true if the message was sent or the sending is delayed; false in other cases
 580      */
 581     public boolean sendMessage(PowermaxSendType msgType) {
 582         return sendMessage(new PowermaxBaseMessage(msgType), false, 0);
 583     }
 584
 585     /**
 586      * Delay the sending of a message
 587      *
 588      * @param msgType the message type to be sent
 589      * @param waitTime the delay in seconds to wait
 590      *
 591      * @return true if the sending is delayed; false in other cases
 592      */
 593     public boolean sendMessageLater(PowermaxSendType msgType, int waitTime) {
 594         return sendMessage(new PowermaxBaseMessage(msgType), false, waitTime);
 595     }
 596
 597     private synchronized boolean sendMessage(@Nullable PowermaxBaseMessage msg, boolean immediate, int waitTime) {
 598         return sendMessage(msg, immediate, waitTime, false);
 599     }
 600
 601     /**
 602      * Send a message or delay the sending if time frame for receiving response is not ended
 603      *
 604      * @param msg the message to be sent
 605      * @param immediate true if the message has to be send without considering timing
 606      * @param waitTime the delay in seconds to wait
 607      * @param doNotLog true if the message contains data that must not be logged
 608      *
 609      * @return true if the message was sent or the sending is delayed; false in other cases
 610      */
 611     @SuppressWarnings("PMD.CompareObjectsWithEquals")
 612     private synchronized boolean sendMessage(@Nullable PowermaxBaseMessage msg, boolean immediate, int waitTime,
 613             boolean doNotLog) {
 614         if ((waitTime > 0) && (msg != null)) {
 615             logger.debug("sendMessage(): delay ({} s) sending message (type {})", waitTime, msg.getSendType());
 616             // Don't queue the message
 617             PowermaxBaseMessage msgToSendLater = new PowermaxBaseMessage(msg.getRawData());
 618             msgToSendLater.setSendType(msg.getSendType());
 619             scheduler.schedule(() -> {
 620                 sendMessage(msgToSendLater, false, 0);
 621             }, waitTime, TimeUnit.SECONDS);
 622             return true;
 623         }
 624
 625         if (msg == null) {
 626             msg = msgQueue.peek();
 627             if (msg == null) {
 628                 logger.debug("sendMessage(): nothing to send");
 629                 return false;
 630             }
 631         }
 632
 633         // Delay sending if time frame for receiving response is not ended
 634         long delay = WAITING_DELAY_FOR_RESPONSE - (System.currentTimeMillis() - connector.getWaitingForResponse());
 635
 636         PowermaxBaseMessage msgToSend = msg;
 637
 638         if (!immediate) {
 639             msgToSend = msgQueue.peek();
 640             if (msgToSend != msg) {
 641                 logger.debug("sendMessage(): add message in queue (type {})", msg.getSendType());
 642                 msgQueue.offer(msg);
 643                 msgToSend = msgQueue.peek();
 644             }
 645             if ((msgToSend != msg) && (delay > 0)) {
 646                 return true;
 647             } else if ((msgToSend == msg) && (delay > 0)) {
 648                 if (delay < 100) {
 649                     delay = 100;
 650                 }
 651                 logger.debug("sendMessage(): delay ({} ms) sending message (type {})", delay, msgToSend.getSendType());
 652                 scheduler.schedule(() -> {
 653                     sendMessage(null, false, 0);
 654                 }, delay, TimeUnit.MILLISECONDS);
 655                 return true;
 656             } else {
 657                 msgToSend = msgQueue.poll();
 658             }
 659         }
 660
 661         if (logger.isDebugEnabled()) {
 662             logger.debug("sendMessage(): sending {} message {}", msgToSend.getSendType(),
 663                     doNotLog ? "***" : HexUtils.bytesToHex(msgToSend.getRawData()));
 664         }
 665         boolean done = sendMessage(msgToSend.getRawData());
 666         if (done) {
 667             lastSendMsg = msgToSend;
 668             connector.setWaitingForResponse(System.currentTimeMillis());
 669
 670             if (!immediate && (msgQueue.peek() != null)) {
 671                 logger.debug("sendMessage(): delay sending next message (type {})", msgQueue.peek().getSendType());
 672                 scheduler.schedule(() -> {
 673                     sendMessage(null, false, 0);
 674                 }, WAITING_DELAY_FOR_RESPONSE, TimeUnit.MILLISECONDS);
 675             }
 676         } else {
 677             logger.debug("sendMessage(): failed");
 678         }
 679
 680         return done;
 681     }
 682
 683     /**
 684      * Send a message to the Powermax alarm panel
 685      *
 686      * @param data the data buffer containing the message to be sent
 687      *
 688      * @return true if the message was sent or false if not
 689      */
 690     private boolean sendMessage(byte[] data) {
 691         boolean done = false;
 692         if (isConnected()) {
 693             data[data.length - 2] = computeCRC(data, data.length);
 694             connector.sendMessage(data);
 695             done = connector.isConnected();
 696         } else {
 697             logger.debug("sendMessage(): aborted (not connected)");
 698         }
 699         return done;
 700     }
 701 }