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.loxone.internal;
  14
  15 /**
  16  * Configuration of a Loxone Miniserver ({@link LxServerHandler})
  17  *
  18  * @author Pawel Pieczul - Initial contribution
  19  *
  20  */
  21 public class LxBindingConfiguration {
  22     /**
  23      * Host address or IP of the Miniserver
  24      */
  25     public String host;
  26     /**
  27      * Port of HTTP web service of the Miniserver
  28      */
  29     public int port;
  30     /**
  31      * Port of HTTPS web service of the Miniserver
  32      */
  33     public int httpsPort;
  34     /**
  35      * User name used to log into the Miniserver
  36      */
  37     public String user;
  38     /**
  39      * Password used to log into the Miniserver
  40      */
  41     public String password;
  42     /**
  43      * Authentication token acquired from the Miniserver
  44      */
  45     public String authToken;
  46     /**
  47      * Time in seconds between binding initialization and first connection attempt
  48      */
  49     public int firstConDelay;
  50     /**
  51      * Time in seconds between sending two consecutive keep-alive messages
  52      */
  53     public int keepAlivePeriod;
  54     /**
  55      * Time in seconds between failed websocket connect attempts
  56      */
  57     public int connectErrDelay;
  58     /**
  59      * Time to wait for Miniserver response to a request sent from the binding
  60      */
  61     public int responseTimeout;
  62     /**
  63      * Time in seconds between user login error as a result of wrong name/password or no authority and next connection
  64      * attempt
  65      */
  66     public int userErrorDelay;
  67     /**
  68      * Time in seconds between connection close (as a result of some communication error) and next connection attempt
  69      */
  70     public int comErrorDelay;
  71     /**
  72      * Websocket client's max binary message size in kB
  73      */
  74     public int maxBinMsgSize;
  75     /**
  76      * Websocket client's max text message size in kB
  77      */
  78     public int maxTextMsgSize;
  79     /**
  80      * Authentication method (0-auto, 1-hash, 2-token)
  81      */
  82     public int authMethod;
  83     /**
  84      * WebSocket connection type (0-auto, 1-HTTPS, 2-HTTP)
  85      */
  86     public int webSocketType;
  87 }