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.io.transport.modbus;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16
  17 /**
  18  * Minimal representation of a modbus response.
  19  *
  20  * Only function code is exposed, which allows detecting MODBUS exception codes from normal codes.
  21  *
  22  * @author Sami Salonen - Initial contribution
  23  */
  24 @NonNullByDefault
  25 public interface ModbusResponse {
  26
  27     /**
  28      * Function code of the response.
  29      *
  30      * Note that in case of Slave responding with Modbus exception response, the response
  31      * function code might differ from request function code
  32      *
  33      * @return function code of the response
  34      */
  35     public int getFunctionCode();
  36 }