-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[solarman] Added LSE-3 (LAN Stick Logger) Support (#17559)
Raw LAN Modbus for LSE-3 Use raw Modbus for LAN Stick an V5 for Wifi Stick. Unchecked for Wifi V5 Protocol, Checked for LAN Raw Protocol. Signed-off-by: Peter Kretz peter.kretz@kretz-net.de
- Loading branch information
Showing
10 changed files
with
398 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
...olarman/src/main/java/org/openhab/binding/solarman/internal/modbus/ISolarmanProtocol.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /** | ||
| * Copyright (c) 2010-2024 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.solarman.internal.modbus; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.openhab.binding.solarman.internal.modbus.exception.SolarmanException; | ||
|
|
||
| /** | ||
| * @author Peter Kretz - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public interface ISolarmanProtocol { | ||
|
|
||
| Map<Integer, byte[]> readRegisters(SolarmanLoggerConnection solarmanLoggerConnection, byte mbFunctionCode, | ||
| int firstReg, int lastReg) throws SolarmanException; | ||
| } |
31 changes: 31 additions & 0 deletions
31
...n/src/main/java/org/openhab/binding/solarman/internal/modbus/SolarmanProtocolFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /** | ||
| * Copyright (c) 2010-2024 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.solarman.internal.modbus; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.openhab.binding.solarman.internal.SolarmanLoggerConfiguration; | ||
|
|
||
| /** | ||
| * @author Peter Kretz - Added RAW Modbus for LAN Stick | ||
| */ | ||
| @NonNullByDefault | ||
| public class SolarmanProtocolFactory { | ||
|
|
||
| public static ISolarmanProtocol CreateSolarmanProtocol(SolarmanLoggerConfiguration solarmanLoggerConfiguration) { | ||
| if (solarmanLoggerConfiguration.getRawLanMode()) { | ||
| return new SolarmanRawProtocol(solarmanLoggerConfiguration); | ||
| } else { | ||
| return new SolarmanV5Protocol(solarmanLoggerConfiguration); | ||
| } | ||
| } | ||
| } |
163 changes: 163 additions & 0 deletions
163
...arman/src/main/java/org/openhab/binding/solarman/internal/modbus/SolarmanRawProtocol.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /** | ||
| * Copyright (c) 2010-2024 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.solarman.internal.modbus; | ||
|
|
||
| import java.nio.ByteBuffer; | ||
| import java.nio.ByteOrder; | ||
| import java.util.Arrays; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.openhab.binding.solarman.internal.SolarmanLoggerConfiguration; | ||
| import org.openhab.binding.solarman.internal.modbus.exception.SolarmanConnectionException; | ||
| import org.openhab.binding.solarman.internal.modbus.exception.SolarmanException; | ||
| import org.openhab.binding.solarman.internal.modbus.exception.SolarmanProtocolException; | ||
|
|
||
| /** | ||
| * @author Catalin Sanda - Initial contribution | ||
| * @author Peter Kretz - Added RAW Modbus for LAN Stick | ||
| */ | ||
| @NonNullByDefault | ||
| public class SolarmanRawProtocol implements ISolarmanProtocol { | ||
| private final SolarmanLoggerConfiguration solarmanLoggerConfiguration; | ||
|
|
||
| public SolarmanRawProtocol(SolarmanLoggerConfiguration solarmanLoggerConfiguration) { | ||
| this.solarmanLoggerConfiguration = solarmanLoggerConfiguration; | ||
| } | ||
|
|
||
| public Map<Integer, byte[]> readRegisters(SolarmanLoggerConnection solarmanLoggerConnection, byte mbFunctionCode, | ||
| int firstReg, int lastReg) throws SolarmanException { | ||
| byte[] solarmanRawFrame = buildSolarmanRawFrame(mbFunctionCode, firstReg, lastReg); | ||
| byte[] respFrame = solarmanLoggerConnection.sendRequest(solarmanRawFrame); | ||
| if (respFrame.length > 0) { | ||
| byte[] modbusRespFrame = extractModbusRawResponseFrame(respFrame, solarmanRawFrame); | ||
| return parseRawModbusReadHoldingRegistersResponse(modbusRespFrame, firstReg, lastReg); | ||
| } else { | ||
| throw new SolarmanConnectionException("Response frame was empty"); | ||
| } | ||
| } | ||
|
|
||
| protected byte[] extractModbusRawResponseFrame(byte @Nullable [] responseFrame, byte[] requestFrame) | ||
| throws SolarmanException { | ||
| if (responseFrame == null || responseFrame.length == 0) { | ||
| throw new SolarmanProtocolException("No response frame"); | ||
| } else if (responseFrame.length < 13) { | ||
| throw new SolarmanProtocolException("Response frame is too short"); | ||
| } else if (responseFrame[0] != (byte) 0x03) { | ||
| throw new SolarmanProtocolException("Response frame has invalid starting byte"); | ||
| } | ||
|
|
||
| return Arrays.copyOfRange(responseFrame, 6, responseFrame.length); | ||
| } | ||
|
|
||
| protected Map<Integer, byte[]> parseRawModbusReadHoldingRegistersResponse(byte @Nullable [] frame, int firstReg, | ||
| int lastReg) throws SolarmanProtocolException { | ||
| int regCount = lastReg - firstReg + 1; | ||
| Map<Integer, byte[]> registers = new HashMap<>(); | ||
| int expectedFrameDataLen = 2 + 1 + regCount * 2; | ||
| if (frame == null || frame.length < expectedFrameDataLen) { | ||
| throw new SolarmanProtocolException("Modbus frame is too short or empty"); | ||
| } | ||
|
|
||
| for (int i = 0; i < regCount; i++) { | ||
| int p1 = 3 + (i * 2); | ||
| ByteBuffer order = ByteBuffer.wrap(frame, p1, 2).order(ByteOrder.BIG_ENDIAN); | ||
| byte[] array = new byte[] { order.get(), order.get() }; | ||
| registers.put(i + firstReg, array); | ||
| } | ||
|
|
||
| return registers; | ||
| } | ||
|
|
||
| /** | ||
| * Builds a SolarMAN Raw frame to request data from firstReg to lastReg. | ||
| * Frame format is based on | ||
| * <a href="https://github.com/StephanJoubert/home_assistant_solarman/issues/247">Solarman RAW Protocol</a> | ||
| * Request send: | ||
| * Header 03e8: Transaction identifier | ||
| * Header 0000: Protocol identifier | ||
| * Header 0006: Message length (w/o CRC) | ||
| * Payload 01: Slave ID | ||
| * Payload 03: Read function | ||
| * Payload 0003: 1st register address | ||
| * Payload 006e: Nb of registers to read | ||
| * Trailer 3426: CRC-16 ModBus | ||
| * | ||
| * @param mbFunctionCode | ||
| * @param firstReg - the start register | ||
| * @param lastReg - the end register | ||
| * @return byte array containing the Solarman Raw frame | ||
| */ | ||
| protected byte[] buildSolarmanRawFrame(byte mbFunctionCode, int firstReg, int lastReg) { | ||
| byte[] requestPayload = buildSolarmanRawFrameRequestPayload(mbFunctionCode, firstReg, lastReg); | ||
| byte[] header = buildSolarmanRawFrameHeader(requestPayload.length); | ||
|
|
||
| return ByteBuffer.allocate(header.length + requestPayload.length).put(header).put(requestPayload).array(); | ||
| } | ||
|
|
||
| /** | ||
| * Builds a SolarMAN Raw frame Header | ||
| * Frame format is based on | ||
| * <a href="https://github.com/StephanJoubert/home_assistant_solarman/issues/247">Solarman RAW Protocol</a> | ||
| * Request send: | ||
| * Header 03e8: Transaction identifier | ||
| * Header 0000: Protocol identifier | ||
| * Header 0006: Message length (w/o CRC) | ||
| * | ||
| * @param payloadSize th | ||
| * @return byte array containing the Solarman Raw frame header | ||
| */ | ||
| private byte[] buildSolarmanRawFrameHeader(int payloadSize) { | ||
| // (two byte) Denotes the start of the Raw frame. Always 0x03 0xE8. | ||
| byte[] transactionId = new byte[] { (byte) 0x03, (byte) 0xE8 }; | ||
|
|
||
| // (two bytes) – Always 0x00 0x00 | ||
| byte[] protocolId = new byte[] { (byte) 0x00, (byte) 0x00 }; | ||
|
|
||
| // (two bytes) Payload length | ||
| byte[] messageLength = ByteBuffer.allocate(Short.BYTES).order(ByteOrder.BIG_ENDIAN) | ||
| .putShort((short) payloadSize).array(); | ||
|
|
||
| // Append all fields into the header | ||
| return ByteBuffer.allocate(transactionId.length + protocolId.length + messageLength.length).put(transactionId) | ||
| .put(protocolId).put(messageLength).array(); | ||
| } | ||
|
|
||
| /** | ||
| * Builds a SolarMAN Raw frame payload | ||
| * Frame format is based on | ||
| * <a href="https://github.com/StephanJoubert/home_assistant_solarman/issues/247">Solarman RAW Protocol</a> | ||
| * Request send: | ||
| * Payload 01: Slave ID | ||
| * Payload 03: Read function | ||
| * Payload 0003: 1st register address | ||
| * Payload 006e: Nb of registers to read | ||
| * Trailer 3426: CRC-16 ModBus | ||
| * | ||
| * @param mbFunctionCode | ||
| * @param firstReg - the start register | ||
| * @param lastReg - the end register | ||
| * @return byte array containing the Solarman Raw frame payload | ||
| */ | ||
| protected byte[] buildSolarmanRawFrameRequestPayload(byte mbFunctionCode, int firstReg, int lastReg) { | ||
| int regCount = lastReg - firstReg + 1; | ||
| byte[] req = ByteBuffer.allocate(6).put((byte) 0x01).put(mbFunctionCode).putShort((short) firstReg) | ||
| .putShort((short) regCount).array(); | ||
| byte[] crc = ByteBuffer.allocate(Short.BYTES).order(ByteOrder.LITTLE_ENDIAN) | ||
| .putShort((short) CRC16Modbus.calculate(req)).array(); | ||
|
|
||
| return ByteBuffer.allocate(req.length + crc.length).put(req).put(crc).array(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.