From e4b7ef7a0c67ca6f53ee3b7f8fe1a23f5e3b1693 Mon Sep 17 00:00:00 2001
From: Stefan Allius <stefan.allius@t-online.de>
Date: Sun, 31 Mar 2024 23:26:14 +0200
Subject: [PATCH] add more unit tests

---
 app/src/gen3plus/solarman_v5.py |  44 +++++++---
 app/tests/test_solarman.py      | 147 ++++++++++++++++++++++++++++++--
 2 files changed, 170 insertions(+), 21 deletions(-)

diff --git a/app/src/gen3plus/solarman_v5.py b/app/src/gen3plus/solarman_v5.py
index d305fc0..3e4715d 100644
--- a/app/src/gen3plus/solarman_v5.py
+++ b/app/src/gen3plus/solarman_v5.py
@@ -29,14 +29,34 @@ class SolarmanV5(Message):
         # self.id_str = id_str
         self.db = InfosG3P()
         self.switch = {
-            0x4110: self.msg_dev_ind,    # hello
-            0x1110: self.msg_dev_rsp,
-            0x4210: self.msg_data_ind,   # data every 5 minutes
-            0x1210: self.msg_data_rsp,
-            0x4310: self.msg_unknown,    # regulary after 3-6 hours
+
+            0x4210: self.msg_data_ind,   # real time data
+            0x1210: self.msg_data_rsp,   # at least every 5 minutes
+
             0x4710: self.msg_hbeat_ind,  # heatbeat
             0x1710: self.msg_hbeat_rsp,  # every 2 minutes
-            0x4810: self.msg_unknown,    # hello end
+
+            # every 3 hours comes a sync seuqence:
+            # 00:00:00  0x4110   device data     ftype: 0x02
+            # 00:00:02  0x4210   real time data  ftype: 0x01
+            # 00:00:03  0x4210   real time data  ftype: 0x81
+            # 00:00:05  0x4310   wifi data       ftype: 0x81    sub-id 0x0018: 0c   # noqa: E501
+            # 00:00:06  0x4310   wifi data       ftype: 0x81    sub-id 0x0018: 1c   # noqa: E501
+            # 00:00:07  0x4310   wifi data       ftype: 0x01    sub-id 0x0018: 0c   # noqa: E501
+            # 00:00:08  0x4810   options?        ftype: 0x01
+
+            0x4110: self.msg_dev_ind,    # device data, sync start
+            0x1110: self.msg_dev_rsp,    # every 3 hours
+
+            0x4310: self.msg_forward,    # regulary after 3-6 hours
+            0x1310: self.msg_forward,
+            0x4810: self.msg_forward,    # sync end
+            0x1810: self.msg_forward,
+
+            #
+            # AT cmd
+            0x4510: self.msg_unknown,    # from server
+            0x1510: self.msg_forward,    # from inverter
         }
 
     '''
@@ -239,6 +259,9 @@ class SolarmanV5(Message):
     def msg_unknown(self):
         logger.warning(f"Unknow Msg: ID:{int(self.control):#04x}")
         self.inc_counter('Unknown_Msg')
+        self.msg_forward()
+
+    def msg_forward(self):
         self.forward(self._recv_buffer, self.header_len+self.data_len+2)
 
     def msg_dev_ind(self):
@@ -274,7 +297,8 @@ class SolarmanV5(Message):
         dt = datetime.fromtimestamp(total)
         logger.info(f'ts: {dt.strftime("%Y-%m-%d %H:%M:%S")}')
 
-        self.__process_data(ftype & 0x7f)
+        ftype &= 0x7f  # mask bit 7  (0x80)
+        self.__process_data(ftype)
         self.forward(self._recv_buffer, self.header_len+self.data_len+2)
 
     def __process_data(self, ftype):
@@ -287,12 +311,6 @@ class SolarmanV5(Message):
         self.msg_response()
 
     def msg_hbeat_ind(self):
-        data = self._recv_buffer[self.header_len:]
-        result = struct.unpack_from('<B', data, 0)
-        ftype = result[0]  # always 0
-        if ftype != 0:
-            logger.info(f'hb frame_type:{ftype}')
-
         self.forward(self._recv_buffer, self.header_len+self.data_len+2)
 
     def msg_hbeat_rsp(self):
diff --git a/app/tests/test_solarman.py b/app/tests/test_solarman.py
index ecfb5e9..7cd11a7 100644
--- a/app/tests/test_solarman.py
+++ b/app/tests/test_solarman.py
@@ -87,6 +87,14 @@ def DeviceIndMsg(): # 0x4110
     msg += b'\x15'
     return msg
 
+@pytest.fixture
+def DeviceRspMsg():  # 0x1110
+    msg  = b'\xa5\x0a\x00\x10\x11\x10\x84' +get_sn()  +b'\x01\x01\x69\x6f\x09'
+    msg += b'\x66\x78\x00\x00\x00'               
+    msg += correct_checksum(msg)
+    msg += b'\x15'
+    return msg
+
 @pytest.fixture
 def InvalidStartByte(): # 0x4110
     msg  = b'\xa4\xd4\x00\x10\x41\x00\x01' +get_sn()  +b'\x02\xba\xd2\x00\x00'
@@ -180,6 +188,38 @@ def InverterIndMsg():  # 0x4210
     msg += b'\x15'
     return msg
 
+@pytest.fixture
+def InverterRspMsg():  # 0x1210
+    msg  = b'\xa5\x0a\x00\x10\x12\x10\x84' +get_sn()  +b'\x01\x01\x69\x6f\x09'
+    msg += b'\x66\x78\x00\x00\x00'               
+    msg += correct_checksum(msg)
+    msg += b'\x15'
+    return msg
+
+@pytest.fixture
+def UnknownMsg():  # 0x5110
+    msg  = b'\xa5\x0a\x00\x10\x51\x10\x84' +get_sn()  +b'\x01\x01\x69\x6f\x09'
+    msg += b'\x66\x78\x00\x00\x00'               
+    msg += correct_checksum(msg)
+    msg += b'\x15'
+    return msg
+
+@pytest.fixture
+def HeartbeatIndMsg():  # 0x4710
+    msg  = b'\xa5\x01\x00\x10\x47\x10\x84' +get_sn()
+    msg += b'\x00'               
+    msg += correct_checksum(msg)
+    msg += b'\x15'
+    return msg
+
+@pytest.fixture
+def HeartbeatRspMsg():  # 0x1710
+    msg  = b'\xa5\x0a\x00\x10\x17\x10\x84' +get_sn()  +b'\x00\x01\x22\x71\x09'
+    msg += b'\x66\x78\x00\x00\x00'               
+    msg += correct_checksum(msg)
+    msg += b'\x15'
+    return msg
+
 @pytest.fixture
 def ConfigTsunAllowAll():
     Config.config = {'solarman':{'enabled': True}, 'inverters':{'allow_all':True}}
@@ -190,7 +230,7 @@ def ConfigNoTsunInv1():
 
 @pytest.fixture
 def ConfigTsunInv1():
-    Config.config = {'solarman':{'enabled': True},'inverters':{'R170000000000001':{'node_id':'inv1','suggested_area':'roof'}}}
+    Config.config = {'solarman':{'enabled': True},'inverters':{'Y170000000000001':{'monitor_sn': 2070233889,'node_id':'inv1','suggested_area':'roof'}}}
 
 def test_read_message(DeviceIndMsg):
     m = MemoryStream(DeviceIndMsg, (0,))
@@ -389,7 +429,8 @@ def test_read_message_in_chunks(DeviceIndMsg):
     assert m.db.stat['proxy']['Invalid_Msg_Format'] == 0
     m.close()
 
-def test_read_message_in_chunks2(DeviceIndMsg):
+def test_read_message_in_chunks2(ConfigTsunInv1, DeviceIndMsg):
+    ConfigTsunInv1
     m = MemoryStream(DeviceIndMsg, (4,10,0))
     m.read()        # read 4 bytes, header incomplere
     assert not m.header_valid
@@ -433,9 +474,9 @@ def test_read_two_messages(ConfigTsunAllowAll, DeviceIndMsg, InverterIndMsg):
     assert m._send_buffer==b''
     # assert m._send_buffer==MsgContactResp
 
-    # m._send_buffer = bytearray(0) # clear send buffer for next test  
-    # m._init_new_client_conn()
-    # assert m._send_buffer==b'\x00\x00\x00,\x10R170000000000001\x91\x00\x08solarhub\x0fsolarhub@123456'
+    m._send_buffer = bytearray(0) # clear send buffer for next test  
+    m._init_new_client_conn()
+    assert m._send_buffer==b''
     assert m._recv_buffer==InverterIndMsg
     
     m._send_buffer = bytearray(0) # clear send buffer for next test
@@ -454,7 +495,97 @@ def test_read_two_messages(ConfigTsunAllowAll, DeviceIndMsg, InverterIndMsg):
     assert m._forward_buffer==InverterIndMsg
     assert m._send_buffer==b''
 
-    # m._send_buffer = bytearray(0) # clear send buffer for next test    
-    # m._init_new_client_conn()
-    # assert m._send_buffer==b'\x00\x00\x00,\x10R170000000000002\x91\x00\x08solarhub\x0fsolarhub@123456'
+    m._send_buffer = bytearray(0) # clear send buffer for next test    
+    m._init_new_client_conn()
+    assert m._send_buffer==b''
+    m.close()
+
+def test_unkown_message(ConfigTsunInv1, UnknownMsg):
+    ConfigTsunInv1
+    m = MemoryStream(UnknownMsg, (0,))
+    m.read()         # read complete msg, and dispatch msg
+    assert not m.header_valid  # must be invalid, since msg was handled and buffer flushed
+    assert m.msg_count == 1
+    assert m.header_len==11
+    assert m.snr == 2070233889
+    assert m.unique_id == '2070233889'
+    assert m.control == 0x5110
+    assert m.serial == 0x8410
+    assert m.data_len == 0x0a
+    assert m._recv_buffer==b''
+    assert m._send_buffer==b''
+    assert m._forward_buffer==UnknownMsg
+    assert m.db.stat['proxy']['Invalid_Msg_Format'] == 0
+    m.close()
+
+def test_device_rsp(ConfigTsunInv1, DeviceRspMsg):
+    ConfigTsunInv1
+    m = MemoryStream(DeviceRspMsg, (0,), False)
+    m.read()         # read complete msg, and dispatch msg
+    assert not m.header_valid  # must be invalid, since msg was handled and buffer flushed
+    assert m.msg_count == 1
+    assert m.header_len==11
+    assert m.snr == 2070233889
+    assert m.unique_id == '2070233889'
+    assert m.control == 0x1110
+    assert m.serial == 0x8410
+    assert m.data_len == 0x0a
+    assert m._recv_buffer==b''
+    assert m._send_buffer==b''
+    assert m._forward_buffer==DeviceRspMsg
+    assert m.db.stat['proxy']['Invalid_Msg_Format'] == 0
+    m.close()
+
+def test_inverter_rsp(ConfigTsunInv1, InverterRspMsg):
+    ConfigTsunInv1
+    m = MemoryStream(InverterRspMsg, (0,), False)
+    m.read()         # read complete msg, and dispatch msg
+    assert not m.header_valid  # must be invalid, since msg was handled and buffer flushed
+    assert m.msg_count == 1
+    assert m.header_len==11
+    assert m.snr == 2070233889
+    assert m.unique_id == '2070233889'
+    assert m.control == 0x1210
+    assert m.serial == 0x8410
+    assert m.data_len == 0x0a
+    assert m._recv_buffer==b''
+    assert m._send_buffer==b''
+    assert m._forward_buffer==InverterRspMsg
+    assert m.db.stat['proxy']['Invalid_Msg_Format'] == 0
+    m.close()
+
+def test_heartbeat_ind(ConfigTsunInv1, HeartbeatIndMsg):
+    ConfigTsunInv1
+    m = MemoryStream(HeartbeatIndMsg, (0,))
+    m.read()         # read complete msg, and dispatch msg
+    assert not m.header_valid  # must be invalid, since msg was handled and buffer flushed
+    assert m.msg_count == 1
+    assert m.header_len==11
+    assert m.snr == 2070233889
+    # assert m.unique_id == '2070233889'
+    assert m.control == 0x4710
+    assert m.serial == 0x8410
+    assert m.data_len == 0x01
+    assert m._recv_buffer==b''
+    assert m._send_buffer==b''
+    assert m._forward_buffer==HeartbeatIndMsg
+    assert m.db.stat['proxy']['Invalid_Msg_Format'] == 0
+    m.close()
+
+def test_heartbeat_rsp(ConfigTsunInv1, HeartbeatRspMsg):
+    ConfigTsunInv1
+    m = MemoryStream(HeartbeatRspMsg, (0,), False)
+    m.read()         # read complete msg, and dispatch msg
+    assert not m.header_valid  # must be invalid, since msg was handled and buffer flushed
+    assert m.msg_count == 1
+    assert m.header_len==11
+    assert m.snr == 2070233889
+    assert m.unique_id == '2070233889'
+    assert m.control == 0x1710
+    assert m.serial == 0x8410
+    assert m.data_len == 0x0a
+    assert m._recv_buffer==b''
+    assert m._send_buffer==b''
+    assert m._forward_buffer==HeartbeatRspMsg
+    assert m.db.stat['proxy']['Invalid_Msg_Format'] == 0
     m.close()