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.doorbird.internal.config;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17
  18 /**
  19  * The {@link DoorbellConfig} class contains fields mapping thing configuration parameters
  20  * for doorbell thing types.
  21  *
  22  * @author Mark Hilbush - Initial contribution
  23  */
  24 @NonNullByDefault
  25 public class DoorbellConfiguration {
  26     /**
  27      * Hostname or IP address of doorbell
  28      */
  29     public @Nullable String doorbirdHost;
  30
  31     /**
  32      * User ID used for API requests
  33      */
  34     public @Nullable String userId;
  35
  36     /**
  37      * Password used in API requests, and to decrypt doorbird events
  38      */
  39     public @Nullable String userPassword;
  40
  41     /**
  42      * Rate at which image channel will be updated
  43      */
  44     public @Nullable Integer imageRefreshRate;
  45
  46     /**
  47      * Delay to set doorbell channel OFF after doorbell event
  48      */
  49     public @Nullable Integer doorbellOffDelay;
  50
  51     /**
  52      * Delay to set motion channel OFF after motion event
  53      */
  54     public @Nullable Integer motionOffDelay;
  55
  56     /**
  57      * Number of images in doorbell and motion montages
  58      */
  59     public @Nullable Integer montageNumImages;
  60
  61     /**
  62      * Scale factor for montages
  63      */
  64     public @Nullable Integer montageScaleFactor;
  65 }