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 java.util.Arrays;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.openhab.core.util.HexUtils;
  19
  20 /**
  21  * Immutable {@link ModbusRegisterArray} implementation
  22  *
  23  * @author Sami Salonen - Initial contribution
  24  */
  25 @NonNullByDefault
  26 public class ModbusRegisterArray {
  27
  28     private final byte[] bytes;
  29
  30     public ModbusRegisterArray(byte... bytes) {
  31         if (bytes.length % 2 != 0) {
  32             throw new IllegalArgumentException();
  33         }
  34         this.bytes = Arrays.copyOf(bytes, bytes.length);
  35     }
  36
  37     /**
  38      * Construct plain <code>ModbusRegisterArray</code> array from register values
  39      *
  40      * @param registerValues register values, each <code>int</code> corresponding to one register
  41      * @return
  42      */
  43     public ModbusRegisterArray(int... registerValues) {
  44         bytes = new byte[registerValues.length * 2];
  45         for (int registerIndex = 0; registerIndex < registerValues.length; registerIndex++) {
  46             int register = registerValues[registerIndex] & 0xffff;
  47             // hi-byte
  48             bytes[registerIndex * 2] = (byte) (register >> 8);
  49             // lo byte
  50             bytes[registerIndex * 2 + 1] = (byte) register;
  51         }
  52     }
  53
  54     /**
  55      * Get register index i as unsigned integer
  56      *
  57      * @param i register index
  58      * @return register value interpreted as unsigned integer (big-endian byte ordering)
  59      */
  60     public int getRegister(int i) {
  61         int hi = bytes[i * 2] & 0xff;
  62         int lo = bytes[i * 2 + 1] & 0xff;
  63         return ((hi << 8) | lo) & 0xffff;
  64     }
  65
  66     /**
  67      * Return bytes representing the registers
  68      *
  69      *
  70      * Index 0: hi-byte of 1st register
  71      * Index 1: low-byte of 1st register
  72      * Index 3: hi-byte of 2nd register
  73      * Index 4: low-byte of 2nd register
  74      * ...
  75      *
  76      * @return set of bytes
  77      */
  78     public byte[] getBytes() {
  79         return bytes;
  80     }
  81
  82     /**
  83      * Get number of registers stored in this instance
  84      *
  85      * @return
  86      */
  87     public int size() {
  88         return bytes.length / 2;
  89     }
  90
  91     @Override
  92     public String toString() {
  93         if (bytes.length == 0) {
  94             return "ModbusRegisterArray(<empty>)";
  95         }
  96         return new StringBuilder(bytes.length).append("ModbusRegisterArray(").append(toHexString()).append(')')
  97                 .toString();
  98     }
  99
 100     /**
 101      * Get register data as a hex string
 102      *
 103      * For example, 04 45 00 00
 104      *
 105      * @return string representing the bytes of the register array
 106      */
 107     public String toHexString() {
 108         if (size() == 0) {
 109             return "";
 110         }
 111         return HexUtils.bytesToHex(getBytes());
 112     }
 113 }