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.openthermgateway.internal;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16
  17 /**
  18  * The {@link CodeType} field is not part of OpenTherm specification, but added by OpenTherm Gateway.
  19  * It can be any of the following:
  20  *
  21  * T: Message received from the thermostat
  22  * B: Message received from the boiler
  23  * R: Request sent to the boiler
  24  * A: Response returned to the thermostat
  25  * E: Parity or stop bit error
  26  *
  27  * @author Arjen Korevaar - Initial contribution
  28  * @author James Melville - Introduced code filtering functionality
  29  */
  30 @NonNullByDefault
  31 public enum CodeType {
  32     /**
  33      * Message received from the thermostat
  34      */
  35     T,
  36     /**
  37      * Message received from the boiler
  38      */
  39     B,
  40     /**
  41      * Request sent to the boiler from OTGW, only present if value modified by OTGW
  42      */
  43     R,
  44     /**
  45      * Response returned to the thermostat from OTGW, only present if value modified by OTGW
  46      */
  47     A,
  48     /**
  49      * Parity or stop bit error
  50      */
  51     E
  52 }