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