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.enocean.internal.messages;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.binding.enocean.internal.EnOceanException;
  17
  18 /**
  19  *
  20  * @author Daniel Weber - Initial contribution
  21  */
  22 @NonNullByDefault
  23 public class ESP3Packet {
  24
  25     private static byte[] crc8Table = new byte[] { (byte) 0x00, (byte) 0x07, (byte) 0x0e, (byte) 0x09, (byte) 0x1c,
  26             (byte) 0x1b, (byte) 0x12, (byte) 0x15, (byte) 0x38, (byte) 0x3f, (byte) 0x36, (byte) 0x31, (byte) 0x24,
  27             (byte) 0x23, (byte) 0x2a, (byte) 0x2d, (byte) 0x70, (byte) 0x77, (byte) 0x7e, (byte) 0x79, (byte) 0x6c,
  28             (byte) 0x6b, (byte) 0x62, (byte) 0x65, (byte) 0x48, (byte) 0x4f, (byte) 0x46, (byte) 0x41, (byte) 0x54,
  29             (byte) 0x53, (byte) 0x5a, (byte) 0x5d, (byte) 0xe0, (byte) 0xe7, (byte) 0xee, (byte) 0xe9, (byte) 0xfc,
  30             (byte) 0xfb, (byte) 0xf2, (byte) 0xf5, (byte) 0xd8, (byte) 0xdf, (byte) 0xd6, (byte) 0xd1, (byte) 0xc4,
  31             (byte) 0xc3, (byte) 0xca, (byte) 0xcd, (byte) 0x90, (byte) 0x97, (byte) 0x9e, (byte) 0x99, (byte) 0x8c,
  32             (byte) 0x8b, (byte) 0x82, (byte) 0x85, (byte) 0xa8, (byte) 0xaf, (byte) 0xa6, (byte) 0xa1, (byte) 0xb4,
  33             (byte) 0xb3, (byte) 0xba, (byte) 0xbd, (byte) 0xc7, (byte) 0xc0, (byte) 0xc9, (byte) 0xce, (byte) 0xdb,
  34             (byte) 0xdc, (byte) 0xd5, (byte) 0xd2, (byte) 0xff, (byte) 0xf8, (byte) 0xf1, (byte) 0xf6, (byte) 0xe3,
  35             (byte) 0xe4, (byte) 0xed, (byte) 0xea, (byte) 0xb7, (byte) 0xb0, (byte) 0xb9, (byte) 0xbe, (byte) 0xab,
  36             (byte) 0xac, (byte) 0xa5, (byte) 0xa2, (byte) 0x8f, (byte) 0x88, (byte) 0x81, (byte) 0x86, (byte) 0x93,
  37             (byte) 0x94, (byte) 0x9d, (byte) 0x9a, (byte) 0x27, (byte) 0x20, (byte) 0x29, (byte) 0x2e, (byte) 0x3b,
  38             (byte) 0x3c, (byte) 0x35, (byte) 0x32, (byte) 0x1f, (byte) 0x18, (byte) 0x11, (byte) 0x16, (byte) 0x03,
  39             (byte) 0x04, (byte) 0x0d, (byte) 0x0a, (byte) 0x57, (byte) 0x50, (byte) 0x59, (byte) 0x5e, (byte) 0x4b,
  40             (byte) 0x4c, (byte) 0x45, (byte) 0x42, (byte) 0x6f, (byte) 0x68, (byte) 0x61, (byte) 0x66, (byte) 0x73,
  41             (byte) 0x74, (byte) 0x7d, (byte) 0x7a, (byte) 0x89, (byte) 0x8e, (byte) 0x87, (byte) 0x80, (byte) 0x95,
  42             (byte) 0x92, (byte) 0x9b, (byte) 0x9c, (byte) 0xb1, (byte) 0xb6, (byte) 0xbf, (byte) 0xb8, (byte) 0xad,
  43             (byte) 0xaa, (byte) 0xa3, (byte) 0xa4, (byte) 0xf9, (byte) 0xfe, (byte) 0xf7, (byte) 0xf0, (byte) 0xe5,
  44             (byte) 0xe2, (byte) 0xeb, (byte) 0xec, (byte) 0xc1, (byte) 0xc6, (byte) 0xcf, (byte) 0xc8, (byte) 0xdd,
  45             (byte) 0xda, (byte) 0xd3, (byte) 0xd4, (byte) 0x69, (byte) 0x6e, (byte) 0x67, (byte) 0x60, (byte) 0x75,
  46             (byte) 0x72, (byte) 0x7b, (byte) 0x7c, (byte) 0x51, (byte) 0x56, (byte) 0x5f, (byte) 0x58, (byte) 0x4d,
  47             (byte) 0x4a, (byte) 0x43, (byte) 0x44, (byte) 0x19, (byte) 0x1e, (byte) 0x17, (byte) 0x10, (byte) 0x05,
  48             (byte) 0x02, (byte) 0x0b, (byte) 0x0c, (byte) 0x21, (byte) 0x26, (byte) 0x2f, (byte) 0x28, (byte) 0x3d,
  49             (byte) 0x3a, (byte) 0x33, (byte) 0x34, (byte) 0x4e, (byte) 0x49, (byte) 0x40, (byte) 0x47, (byte) 0x52,
  50             (byte) 0x55, (byte) 0x5c, (byte) 0x5b, (byte) 0x76, (byte) 0x71, (byte) 0x78, (byte) 0x7f, (byte) 0x6A,
  51             (byte) 0x6d, (byte) 0x64, (byte) 0x63, (byte) 0x3e, (byte) 0x39, (byte) 0x30, (byte) 0x37, (byte) 0x22,
  52             (byte) 0x25, (byte) 0x2c, (byte) 0x2b, (byte) 0x06, (byte) 0x01, (byte) 0x08, (byte) 0x0f, (byte) 0x1a,
  53             (byte) 0x1d, (byte) 0x14, (byte) 0x13, (byte) 0xae, (byte) 0xa9, (byte) 0xa0, (byte) 0xa7, (byte) 0xb2,
  54             (byte) 0xb5, (byte) 0xbc, (byte) 0xbb, (byte) 0x96, (byte) 0x91, (byte) 0x98, (byte) 0x9f, (byte) 0x8a,
  55             (byte) 0x8D, (byte) 0x84, (byte) 0x83, (byte) 0xde, (byte) 0xd9, (byte) 0xd0, (byte) 0xd7, (byte) 0xc2,
  56             (byte) 0xc5, (byte) 0xcc, (byte) 0xcb, (byte) 0xe6, (byte) 0xe1, (byte) 0xe8, (byte) 0xef, (byte) 0xfa,
  57             (byte) 0xfd, (byte) 0xf4, (byte) 0xf3 };
  58
  59     public static final int ESP3_HEADER_LENGTH = 4;
  60     private static final int ESP3_SYNC_BYTE_LENGTH = 1;
  61     private static final int ESP3_CRC3_HEADER_LENGTH = 1;
  62     private static final int ESP3_CRC8_DATA_LENGTH = 1;
  63
  64     public static final int ESP3_RORG_LENGTH = 1;
  65     public static final int ESP3_SENDERID_LENGTH = 4;
  66     public static final int ESP3_STATUS_LENGTH = 1;
  67
  68     public static final byte ESP3_SYNC_BYTE = 0x55;
  69
  70     protected BasePacket basePacket;
  71
  72     public ESP3Packet(BasePacket basePacket) {
  73         this.basePacket = basePacket;
  74     }
  75
  76     private byte calcCRC8(byte data[], int offset, int length) {
  77         byte output = 0;
  78         for (int i = offset; i < offset + length; i++) {
  79             int index = (output ^ data[i]) & 0xff;
  80             output = crc8Table[index];
  81         }
  82         return (byte) (output & 0xff);
  83     }
  84
  85     public byte[] serialize() throws EnOceanException {
  86         try {
  87             byte[] payload = basePacket.getPayload();
  88             byte[] optionalPayload = basePacket.getOptionalPayload();
  89
  90             byte[] result = new byte[ESP3_SYNC_BYTE_LENGTH + ESP3_HEADER_LENGTH + ESP3_CRC3_HEADER_LENGTH
  91                     + payload.length + optionalPayload.length + ESP3_CRC8_DATA_LENGTH];
  92
  93             result[0] = ESP3_SYNC_BYTE;
  94             result[1] = (byte) ((payload.length >> 8) & 0xff);
  95             result[2] = (byte) (payload.length & 0xff);
  96             result[3] = (byte) (optionalPayload.length & 0xff);
  97             result[4] = basePacket.getPacketType().getValue();
  98             result[5] = calcCRC8(result, ESP3_SYNC_BYTE_LENGTH, ESP3_HEADER_LENGTH);
  99
 100             System.arraycopy(payload, 0, result, 6, payload.length);
 101
 102             for (int i = 0; i < optionalPayload.length; i++) {
 103                 result[6 + payload.length + i] = (byte) (optionalPayload[i] & 0xff);
 104             }
 105
 106             result[6 + payload.length + optionalPayload.length] = calcCRC8(result, 6,
 107                     payload.length + optionalPayload.length);
 108
 109             return result;
 110         } catch (Exception e) {
 111             throw new EnOceanException(e.getMessage());
 112         }
 113     }
 114
 115     public static boolean checkCRC8(byte data[], int length, byte crc8) {
 116         byte output = 0;
 117         for (int i = 0; i < length; i++) {
 118             int index = (output ^ data[i]) & 0xff;
 119             output = crc8Table[index];
 120         }
 121         return output == crc8;
 122     }
 123 }