431 lines
17 KiB
Go
431 lines
17 KiB
Go
package plugin
|
||
|
||
import (
|
||
"encoding/binary"
|
||
"encoding/hex"
|
||
"net"
|
||
"testing"
|
||
|
||
"github.com/evcc-io/evcc/util"
|
||
"github.com/stretchr/testify/assert"
|
||
"github.com/stretchr/testify/require"
|
||
)
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Real captured frames (marcelblijleven/goodwe tests/sample/ + discussion #27411)
|
||
// ---------------------------------------------------------------------------
|
||
//
|
||
// All frames are verbatim UDP datagrams received from real inverters.
|
||
// In the per-register protocol each PDU fetches exactly one value; the
|
||
// response payload starts at offset 0.
|
||
//
|
||
// Register map summary:
|
||
//
|
||
// Family Reading Register Count Decode Expected (captures below)
|
||
// DT power 0x75AF 2 int32be GW3000-DNS-30=1972W GW17K-DT=12470W
|
||
// DT energy 0x75C1 2 uint32be GW17K-DT=29984.4kWh GW6000-DT=13350.2kWh
|
||
// ES pv 0x7506 2 int32be
|
||
// ES grid 0x750C 2 int32be
|
||
// ES battery 0x7512 2 int32be
|
||
// ES soc 0x750E 1 uint16be
|
||
// ET pv 0x8941 2 int32be GW10K-ET=831W
|
||
// ET grid 0x8943 2 int32be GW10K-ET=-3W GW25K-ET=1511W GW29K9-ET=-5403W
|
||
// ET battery 0x896E 2 int32be GW10K-ET=-2512W (charging)
|
||
// ET energy 0x8977 2 uint32be GW10K-ET=6085.3kWh GW25K-ET=160.3kWh
|
||
// ET soc 0x908F 1 uint16be GW10K-ET=68% GW25K-ET=100%
|
||
//
|
||
// Note: these captures are full block-read responses used to verify the
|
||
// per-register values at offset 0 of what the inverter would return for
|
||
// a targeted single-register read. The payload bytes at the register's
|
||
// offset within the block are identical to what a per-register read returns.
|
||
|
||
const (
|
||
// DT family (source byte 0x7F, block PDU READ 73 @ 0x7594)
|
||
capGW3000DNS30 = `aa557f03921a020e0e301007cf005f053b000b00000000ffffffffffffffffffffffffffffffffffff08eeffffffff0056ffffffff1387ffffffff000007b40001000000000000000007a600000002ffffffff03e7ffff011bffffffff00140000a9f9000013ff0006ffffffffffffffffffffffffffffffffffffffffffffffffffff0e05ffffffffffff013e000000030cdaffff00393eb0`
|
||
capGW17kDT = `aa557f03921805140a23371518006912930094ffffffffffffffffffffffffffffffff102210130fff093f094f094500b000af00af138a138a138a000030b600010000000000000000000000000000000000000000ffff01c9ffffffff012500049344000020a500010000000000000000ffffffffffffffffffffffffffffffff0222184a0c4600000004000003a300f7000400000064b2f2`
|
||
capGW20kAUDT = `aa557f0392160a1513172a0f4100440dbc0047ffffffffffffffffffffffffffffffff0f2d0f4d0f6908d508bc08eb0048004a00471384138413850000135d000100000000000000000000000000cd0000000003e7ffff016cffffffff00c60000a8280000047300200000000000000000ffffffffffffffffffffffffffffffff0000174b0bad000000040000044b00000004000000696b04`
|
||
capGW6000DT = `aa557f039215081f0c03020c88001f0ca90020ffffffffffffffffffffffffffffffffffffffffffff08d008f90906001b001a001b1386138613860000072b0001000000000000ffffffffffffffffffffffff0000ffff019dffffffff003c0002097e0000210300140000ffff0000ffff0000ffff0000ffffffffffffffffffff0000177c0beeffffffff00cf016302f00000000000649f03`
|
||
|
||
// ET family (source byte 0xF7, block PDU READ 125 @ 0x891C)
|
||
capGW10kET = `aa55f703fa1508160b0b0c0cfe00330000069f0cfe0035000006e100000000000000000000000000000000000002020959000f138700000150096f000d13870000011f096b000b1387000000ce00010000033ffffffffd000000000000000009560006138600010000006b096d000913880001000000bd096c00021387000100000000000000e000000050000000e9000001380000020a000401fe0000024b00001f640fb209eeff9efffff63000030000002000010000000000000000edb50000007d0000b8520000241e00620000024400000001588a007400006bbd003500005f65001d0005000000010000000000000000000107000800000209ee000055ae`
|
||
capGW25kET = `aa55f703fa170c030e07071cd3000e000004091cd30000000003d51d82000d000000001d82000000000000000002020905001d13830000024d0906001b1385000002290900002a138500000323000100000799000005e7000004d7000008d308f7001e138300000000003408fc0012138500000000000f08f6002013850000000001580000002c0000001000000153000001980000001a000701ce000001ae00001e350f1a0868000000000000000200000020000100000000000000000643000000930000056100000184001d00000094000a000000ac000200000391006e000002b800000004000000000000000000000000000002040180000200008f005ece`
|
||
capGW29k9ET = `aa55f703fa1801110e310e1aad000f000001de1aad0000000002a7168d001200000186168d000000000000000202020909001d1387000002470919001b1387000002350920001d13850000024b0001000006c7ffffeae500000133000007b708fb00071386000000000015090b0007138800000000000509190006138500000000002500000287000002800000028b0000004200001ba0000100f1000000cd00001db40eda0000ffff0000000000000000002000010000000000000000b237000000090000af6100000497000c0000005700000001a39e01b600000000000000000000000000060000000000000000000000000000020400ce00000000030064b6`
|
||
|
||
// ET battery info (source byte 0xF7, block PDU READ 24 @ 0x9088)
|
||
capGW10kETBattery = `aa55f7033000ff01000001015e001900190000004400630005000001010000000000000000000000000000000000000000000000006447`
|
||
capGW25kETBattery = `aa55f7033000ff0137000100e600000028000000640064000400000105000000000316000000000000000000000000000000000000dc7a`
|
||
)
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// buildPDU tests
|
||
// ---------------------------------------------------------------------------
|
||
|
||
func TestBuildPDU_DTpower(t *testing.T) {
|
||
// DT power: register 0x75AF, count 2 → READ 2 @ 0x75AF
|
||
got := buildPDU(0x75AF, 2)
|
||
assert.Equal(t, []byte{0x7f, 0x03, 0x75, 0xaf, 0x00, 0x02}, got)
|
||
}
|
||
|
||
func TestBuildPDU_ETgrid(t *testing.T) {
|
||
// ET grid: register 0x8943, count 2
|
||
got := buildPDU(0x8943, 2)
|
||
assert.Equal(t, []byte{0x7f, 0x03, 0x89, 0x43, 0x00, 0x02}, got)
|
||
}
|
||
|
||
func TestBuildPDU_SoC(t *testing.T) {
|
||
// ET SoC: register 0x908F, count 1 (U16)
|
||
got := buildPDU(0x908F, 1)
|
||
assert.Equal(t, []byte{0x7f, 0x03, 0x90, 0x8f, 0x00, 0x01}, got)
|
||
}
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// stripAA55Header tests
|
||
// ---------------------------------------------------------------------------
|
||
|
||
func TestStripAA55Header_DT(t *testing.T) {
|
||
// DT source byte = 0x7F
|
||
payload, err := stripAA55Header(mustHex(t, capGW3000DNS30))
|
||
require.NoError(t, err)
|
||
assert.Equal(t, 146, len(payload))
|
||
}
|
||
|
||
func TestStripAA55Header_ET(t *testing.T) {
|
||
// ET source byte = 0xF7 — must also be accepted
|
||
payload, err := stripAA55Header(mustHex(t, capGW10kET))
|
||
require.NoError(t, err)
|
||
assert.Equal(t, 250, len(payload))
|
||
}
|
||
|
||
func TestStripAA55Header_BadMagic(t *testing.T) {
|
||
_, err := stripAA55Header([]byte{0xFF, 0x55, 0x7F, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x00, 0x00})
|
||
require.Error(t, err)
|
||
}
|
||
|
||
func TestStripAA55Header_Short(t *testing.T) {
|
||
_, err := stripAA55Header([]byte{0xAA, 0x55, 0x7F, 0x03, 0x10, 0x01, 0x02})
|
||
require.Error(t, err)
|
||
assert.Contains(t, err.Error(), "short")
|
||
}
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// decodeAt tests
|
||
// ---------------------------------------------------------------------------
|
||
|
||
func TestDecodeAt_Int32BE_Positive(t *testing.T) {
|
||
payload := make([]byte, 4)
|
||
binary.BigEndian.PutUint32(payload, uint32(int32(1972)))
|
||
v, err := decodeAt(payload, 0, "int32be")
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, 1972.0, v, 0)
|
||
}
|
||
|
||
func TestDecodeAt_Int32BE_Negative(t *testing.T) {
|
||
payload := make([]byte, 4)
|
||
v32 := int32(-2512)
|
||
binary.BigEndian.PutUint32(payload, uint32(v32))
|
||
v, err := decodeAt(payload, 0, "int32be")
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, -2512.0, v, 0)
|
||
}
|
||
|
||
func TestDecodeAt_Uint32BE(t *testing.T) {
|
||
payload := make([]byte, 4)
|
||
binary.BigEndian.PutUint32(payload, 43513)
|
||
v, err := decodeAt(payload, 0, "uint32be")
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, 43513.0, v, 0)
|
||
}
|
||
|
||
func TestDecodeAt_Uint16BE(t *testing.T) {
|
||
payload := make([]byte, 2)
|
||
binary.BigEndian.PutUint16(payload, 68)
|
||
v, err := decodeAt(payload, 0, "uint16be")
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, 68.0, v, 0)
|
||
}
|
||
|
||
func TestDecodeAt_Int16BE_Negative(t *testing.T) {
|
||
payload := make([]byte, 2)
|
||
v16 := int16(-300)
|
||
binary.BigEndian.PutUint16(payload, uint16(v16))
|
||
v, err := decodeAt(payload, 0, "int16be")
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, -300.0, v, 0)
|
||
}
|
||
|
||
func TestDecodeAt_TooShort(t *testing.T) {
|
||
_, err := decodeAt([]byte{0x00}, 0, "int32be")
|
||
require.Error(t, err)
|
||
}
|
||
|
||
func TestDecodeAt_UnknownType(t *testing.T) {
|
||
_, err := decodeAt(make([]byte, 4), 0, "float32")
|
||
require.Error(t, err)
|
||
}
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// modbusCRC16 tests
|
||
// ---------------------------------------------------------------------------
|
||
|
||
func TestModbusCRC16_DTPdu(t *testing.T) {
|
||
// DT power PDU 7f 03 75 af 00 02 → CRC d1 ba
|
||
pdu := buildPDU(0x75AF, 2)
|
||
crc := modbusCRC16(pdu)
|
||
// Verify round-trip: CRC is 2 bytes and deterministic
|
||
assert.Len(t, crc, 2)
|
||
assert.Equal(t, crc, modbusCRC16(pdu), "CRC must be deterministic")
|
||
}
|
||
|
||
func TestModbusCRC16_ETPdu(t *testing.T) {
|
||
// ET grid PDU 7f 03 89 43 00 02 → CRC is 2 bytes
|
||
pdu := buildPDU(0x8943, 2)
|
||
crc := modbusCRC16(pdu)
|
||
assert.Len(t, crc, 2)
|
||
assert.Equal(t, crc, modbusCRC16(pdu))
|
||
}
|
||
|
||
func TestModbusCRC16_KnownValue(t *testing.T) {
|
||
// The original block-read DT PDU 7f 03 75 94 00 49 → CRC d5 c2
|
||
// This is a known-good value verified against real hardware.
|
||
pdu, err := parsePDUHex("7f0375940049")
|
||
require.NoError(t, err)
|
||
assert.Equal(t, []byte{0xd5, 0xc2}, modbusCRC16(pdu))
|
||
}
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Real-capture register value tests
|
||
//
|
||
// These verify that extracting bytes at the register's offset within a
|
||
// block-read capture gives the same value a per-register read would return
|
||
// at offset 0. This is the core correctness guarantee for the register map.
|
||
// ---------------------------------------------------------------------------
|
||
|
||
// TestDT_Power verifies DT power register (0x75AF = block offset 54).
|
||
func TestDT_Power_GW3000DNS30(t *testing.T) {
|
||
assertBlockOffset(t, capGW3000DNS30, 54, "int32be", 1.0, 1972.0)
|
||
}
|
||
|
||
func TestDT_Power_GW17K(t *testing.T) {
|
||
assertBlockOffset(t, capGW17kDT, 54, "int32be", 1.0, 12470.0)
|
||
}
|
||
|
||
func TestDT_Power_GW20KAU(t *testing.T) {
|
||
assertBlockOffset(t, capGW20kAUDT, 54, "int32be", 1.0, 4957.0)
|
||
}
|
||
|
||
// TestDT_Energy verifies DT energy register (0x75C1 = block offset 90).
|
||
func TestDT_Energy_GW17K(t *testing.T) {
|
||
assertBlockOffset(t, capGW17kDT, 90, "uint32be", 0.1, 29984.4)
|
||
}
|
||
|
||
func TestDT_Energy_GW6000(t *testing.T) {
|
||
assertBlockOffset(t, capGW6000DT, 90, "uint32be", 0.1, 13350.2)
|
||
}
|
||
|
||
// TestDT_Energy_GW20KAU verifies energy for GW20KAU-DT.
|
||
func TestDT_Energy_GW20KAU(t *testing.T) {
|
||
assertBlockOffset(t, capGW20kAUDT, 90, "uint32be", 0.1, 4304.8)
|
||
}
|
||
|
||
// TestET_PV verifies ET pv register (0x8941 = block offset 74).
|
||
func TestET_PV_GW10K(t *testing.T) {
|
||
assertBlockOffset(t, capGW10kET, 74, "int32be", 1.0, 831.0)
|
||
}
|
||
|
||
// TestET_Grid verifies ET grid register (0x8943 = block offset 78).
|
||
func TestET_Grid_GW10K_TinyExport(t *testing.T) {
|
||
assertBlockOffset(t, capGW10kET, 78, "int32be", 1.0, -3.0)
|
||
}
|
||
|
||
func TestET_Grid_GW25K_Importing(t *testing.T) {
|
||
assertBlockOffset(t, capGW25kET, 78, "int32be", 1.0, 1511.0)
|
||
}
|
||
|
||
func TestET_Grid_GW29K9_Exporting(t *testing.T) {
|
||
assertBlockOffset(t, capGW29k9ET, 78, "int32be", 1.0, -5403.0)
|
||
}
|
||
|
||
// TestET_Battery verifies ET battery register (0x896E = block offset 164).
|
||
// Negative = charging.
|
||
func TestET_Battery_GW10K_Charging(t *testing.T) {
|
||
assertBlockOffset(t, capGW10kET, 164, "int32be", 1.0, -2512.0)
|
||
}
|
||
|
||
// TestET_Energy verifies ET energy register (0x8977 = block offset 182).
|
||
func TestET_Energy_GW10K(t *testing.T) {
|
||
assertBlockOffset(t, capGW10kET, 182, "uint32be", 0.1, 6085.3)
|
||
}
|
||
|
||
func TestET_Energy_GW25K(t *testing.T) {
|
||
assertBlockOffset(t, capGW25kET, 182, "uint32be", 0.1, 160.3)
|
||
}
|
||
|
||
// TestET_SoC verifies ET SoC register (0x908F = battery info block offset 14).
|
||
func TestET_SoC_GW10K(t *testing.T) {
|
||
assertBlockOffset(t, capGW10kETBattery, 14, "uint16be", 1.0, 68.0)
|
||
}
|
||
|
||
func TestET_SoC_GW25K(t *testing.T) {
|
||
assertBlockOffset(t, capGW25kETBattery, 14, "uint16be", 1.0, 100.0)
|
||
}
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Integration tests — end-to-end FloatGetter via mock UDP server
|
||
// ---------------------------------------------------------------------------
|
||
|
||
// TestFloatGetter_DT_Power verifies the full query/decode pipeline using the
|
||
// GW17K-DT real capture sliced to just the power register bytes: 12470 W.
|
||
func TestFloatGetter_DT_Power(t *testing.T) {
|
||
// Simulate what the inverter returns for READ 2 @ 0x75AF:
|
||
// a 4-byte payload containing the value at block offset 54.
|
||
response := singleRegResponse(t, capGW17kDT, 54, 4, 0x7f)
|
||
p := &AA55UDP{
|
||
log: util.NewLogger("test"),
|
||
conn: mockConn(t, response),
|
||
pdu: buildPDU(0x75AF, 2),
|
||
decode: "int32be",
|
||
scale: 1.0,
|
||
}
|
||
getter, err := p.FloatGetter()
|
||
require.NoError(t, err)
|
||
val, err := getter()
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, 12470.0, val, 0.5)
|
||
}
|
||
|
||
// TestFloatGetter_DT_Energy verifies scale 0.1: 299844 × 0.1 = 29984.4 kWh.
|
||
func TestFloatGetter_DT_Energy(t *testing.T) {
|
||
response := singleRegResponse(t, capGW17kDT, 90, 4, 0x7f)
|
||
p := &AA55UDP{
|
||
log: util.NewLogger("test"),
|
||
conn: mockConn(t, response),
|
||
pdu: buildPDU(0x75C1, 2),
|
||
decode: "uint32be",
|
||
scale: 0.1,
|
||
}
|
||
getter, err := p.FloatGetter()
|
||
require.NoError(t, err)
|
||
val, err := getter()
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, 29984.4, val, 0.001)
|
||
}
|
||
|
||
// TestFloatGetter_ET_PV verifies ET pv power: GW10K-ET = 831 W.
|
||
func TestFloatGetter_ET_PV(t *testing.T) {
|
||
response := singleRegResponse(t, capGW10kET, 74, 4, 0xf7)
|
||
p := &AA55UDP{
|
||
log: util.NewLogger("test"),
|
||
conn: mockConn(t, response),
|
||
pdu: buildPDU(0x8941, 2),
|
||
decode: "int32be",
|
||
scale: 1.0,
|
||
}
|
||
getter, err := p.FloatGetter()
|
||
require.NoError(t, err)
|
||
val, err := getter()
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, 831.0, val, 0.5)
|
||
}
|
||
|
||
// TestFloatGetter_ET_Battery verifies charging battery: GW10K-ET = -2512 W.
|
||
func TestFloatGetter_ET_Battery(t *testing.T) {
|
||
response := singleRegResponse(t, capGW10kET, 164, 4, 0xf7)
|
||
p := &AA55UDP{
|
||
log: util.NewLogger("test"),
|
||
conn: mockConn(t, response),
|
||
pdu: buildPDU(0x896E, 2),
|
||
decode: "int32be",
|
||
scale: 1.0,
|
||
}
|
||
getter, err := p.FloatGetter()
|
||
require.NoError(t, err)
|
||
val, err := getter()
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, -2512.0, val, 0.5)
|
||
}
|
||
|
||
// TestFloatGetter_ET_SoC verifies SoC: GW10K-ET = 68%.
|
||
func TestFloatGetter_ET_SoC(t *testing.T) {
|
||
response := singleRegResponse(t, capGW10kETBattery, 14, 2, 0xf7)
|
||
p := &AA55UDP{
|
||
log: util.NewLogger("test"),
|
||
conn: mockConn(t, response),
|
||
pdu: buildPDU(0x908F, 1),
|
||
decode: "uint16be",
|
||
scale: 1.0,
|
||
}
|
||
getter, err := p.FloatGetter()
|
||
require.NoError(t, err)
|
||
val, err := getter()
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, 68.0, val, 0.5)
|
||
}
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Test helpers
|
||
// ---------------------------------------------------------------------------
|
||
|
||
func mustHex(t *testing.T, s string) []byte {
|
||
t.Helper()
|
||
b, err := hex.DecodeString(s)
|
||
require.NoError(t, err)
|
||
return b
|
||
}
|
||
|
||
// assertBlockOffset extracts bytes at offset within a block-read capture and
|
||
// asserts the decoded value matches expected. This verifies that the register
|
||
// address arithmetic is correct: the bytes the inverter would return for a
|
||
// single-register read are identical to the bytes at the register's offset
|
||
// within the block.
|
||
func assertBlockOffset(t *testing.T, capHex string, offset int, decode string, scale, expected float64) {
|
||
t.Helper()
|
||
payload, err := stripAA55Header(mustHex(t, capHex))
|
||
require.NoError(t, err)
|
||
v, err := decodeAt(payload, offset, decode)
|
||
require.NoError(t, err)
|
||
assert.InDelta(t, expected, v*scale, 0.05)
|
||
}
|
||
|
||
// singleRegResponse builds the AA55 response frame that an inverter would
|
||
// return for a single-register read, by slicing the value bytes out of a
|
||
// real block-read capture at the given offset.
|
||
// src is the inverter source byte (0x7f for DT, 0xf7 for ET).
|
||
func singleRegResponse(t *testing.T, capHex string, offset, valueBytes int, src byte) []byte {
|
||
t.Helper()
|
||
blockPayload, err := stripAA55Header(mustHex(t, capHex))
|
||
require.NoError(t, err)
|
||
require.GreaterOrEqual(t, len(blockPayload), offset+valueBytes)
|
||
|
||
value := blockPayload[offset : offset+valueBytes]
|
||
frame := []byte{0xAA, 0x55, src, 0x03, byte(valueBytes)}
|
||
frame = append(frame, value...)
|
||
frame = append(frame, 0x00, 0x00) // CRC not validated by stripAA55Header
|
||
return frame
|
||
}
|
||
|
||
// mockConn starts a UDP server that responds with response to every packet,
|
||
// and returns a *net.UDPConn already dialled at that server.
|
||
func mockConn(t *testing.T, response []byte) *net.UDPConn {
|
||
t.Helper()
|
||
srv, err := net.ListenPacket("udp4", "127.0.0.1:0")
|
||
require.NoError(t, err)
|
||
t.Cleanup(func() { srv.Close() })
|
||
|
||
go func() {
|
||
buf := make([]byte, 512)
|
||
for {
|
||
_, addr, err := srv.ReadFrom(buf)
|
||
if err != nil {
|
||
return
|
||
}
|
||
_, _ = srv.WriteTo(response, addr)
|
||
}
|
||
}()
|
||
|
||
addr, err := net.ResolveUDPAddr("udp4", srv.LocalAddr().String())
|
||
require.NoError(t, err)
|
||
conn, err := net.DialUDP("udp4", nil, addr)
|
||
require.NoError(t, err)
|
||
t.Cleanup(func() { conn.Close() })
|
||
return conn
|
||
}
|