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.nibeheatpump.internal.message;
  14
  15 import org.openhab.binding.nibeheatpump.internal.NibeHeatPumpException;
  16
  17 /**
  18  * The {@link NibeHeatPumpMessage} define interface for Nibe messages.
  19  *
  20  *
  21  * @author Pauli Anttila - Initial contribution
  22  */
  23 public interface NibeHeatPumpMessage {
  24
  25     /**
  26      * Procedure for encode raw data.
  27      *
  28      * @param data
  29      *            Raw data.
  30      */
  31     void encodeMessage(byte[] data) throws NibeHeatPumpException;
  32
  33     /**
  34      * Procedure for decode object to raw data.
  35      *
  36      * @return raw data.
  37      */
  38     byte[] decodeMessage();
  39
  40     /**
  41      * Procedure to covert message to hex string format. Used for
  42      * logging purposes.
  43      *
  44      */
  45     String toHexString();
  46 }