File: test_packets.py

package info (click to toggle)
siobrultech-protocols 0.14.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 308 kB
  • sloc: python: 3,042; sh: 15; makefile: 7
file content (272 lines) | stat: -rw-r--r-- 9,567 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
import functools
import unittest

from siobrultech_protocols.gem import packets
from tests.gem.packet_test_data import assert_packet, read_packet

packet_maker = functools.partial(
    packets.Packet,
    packet_format=packets.BIN32_ABS,
    voltage=120.0,
    absolute_watt_seconds=[0] * packets.BIN32_NET.num_channels,
    device_id=123456,
    serial_number=123456,
    seconds=0,
    pulse_counts=[0] * packets.GEMPacketFormat.NUM_PULSE_COUNTERS,
    temperatures=list([0.0] * packets.GEMPacketFormat.NUM_TEMPERATURE_SENSORS),
    aux=None,
)


class TestPacketFormats(unittest.TestCase):
    def test_bin32_abs(self):
        check_packet("BIN32-ABS.bin", packets.BIN32_ABS)

    def test_bin32_net(self):
        check_packet("BIN32-NET.bin", packets.BIN32_NET)

    def test_bin48_abs(self):
        check_packet("BIN48-ABS.bin", packets.BIN48_ABS)

    def test_bin48_net(self):
        check_packet("BIN48-NET.bin", packets.BIN48_NET)

    def test_bin48_net_time(self):
        check_packet("BIN48-NET-TIME.bin", packets.BIN48_NET_TIME)

    def test_bin48_net_time_tricky(self):
        """BIN48_NET and BIN48_NET_TIME packets both have the same packet type
        code, so in order to detect the difference you must try to parse as
        BIN48_NET first, and if that fails try BIN48_NET_TIME. However, if
        the parser just checks the checksum and not the footer, it's possible
        for a BIN48_NET_TIME packet to be mistaken for a BIN48_NET. This is
        one such packet."""
        try:
            parse_packet("BIN48-NET-TIME_tricky.bin", packets.BIN48_NET)
            self.fail("Should have thrown")
        except packets.MalformedPacketException:
            pass

        check_packet("BIN48-NET-TIME_tricky.bin", packets.BIN48_NET_TIME)

    def test_ecm_1240(self):
        check_packet("ECM-1240.bin", packets.ECM_1240)

    def test_short_packet(self):
        packet = read_packet("BIN32-NET.bin")
        with self.assertRaisesRegex(
            packets.MalformedPacketException, "Packet too short."
        ):
            packets.BIN32_NET.parse(packet[:-1])

    def test_packet_with_extra_after(self):
        data = bytearray()
        data.extend(read_packet("BIN32-NET.bin"))
        data.extend(read_packet("BIN32-ABS.bin"))

        packet = packets.BIN32_NET.parse(data)
        assert_packet("BIN32-NET.bin", packet)


class TestPacketDeltaComputation(unittest.TestCase):
    def test_packet_delta_seconds(self):
        packet = parse_packet("BIN32-ABS.bin", packets.BIN32_ABS)
        self.assertEqual(997492, packet.seconds)

        self.assertEqual(997493, packet.delta_seconds(2**24 - 1))
        self.assertEqual(1000000, packet.delta_seconds(2**24 - (1000000 - 997492)))

    def test_packet_delta_pulses(self):
        packet = parse_packet("BIN48-NET-TIME_tricky.bin", packets.BIN48_NET_TIME)

        # All the pulse counts in our packets are 0, so let's fake some out
        packet.pulse_counts = [100, 200, 300, 400]

        self.assertEqual(
            [1100, 1200, 1300, 1400],
            [
                packet.delta_pulse_count(i, 2**24 - 1000)
                for i in range(0, len(packet.pulse_counts))
            ],
        )

    def test_packet_delta_aux(self):
        packet = parse_packet("ECM-1240.bin", packets.ECM_1240)

        self.assertEqual(
            [10, 3, 5, 3, 5],
            [packet.delta_aux_count(i, 60) for i in range(0, len(packet.aux))],
        )

    def test_packet_delta_absolute_watt_seconds(self):
        packet = parse_packet("BIN32-ABS.bin", packets.BIN32_ABS)
        self.assertEqual(
            [
                3123664,
                9249700,
                195388151,
                100917236,
                7139112,
                1440,
                4,
                3,
                14645520,
                111396601,
                33259670,
                38296448,
                1108415,
                2184858,
                5191049,
                1,
                71032651,
                60190845,
                47638292,
                12017483,
                36186563,
                14681918,
                69832947,
                37693,
                60941899,
                1685614,
                902,
                799182,
                302590,
                3190972,
                5,
                647375119,
            ],
            packet.absolute_watt_seconds,
        )

        self.assertEqual(
            [
                packet.absolute_watt_seconds[i] + 1000
                for i in range(0, len(packet.absolute_watt_seconds))
            ],
            [
                packet.delta_absolute_watt_seconds(i, 2**40 - 1000)
                for i in range(0, len(packet.absolute_watt_seconds))
            ],
        )

    def test_packet_delta_polarized_watt_seconds(self):
        packet = parse_packet("BIN32-NET.bin", packets.BIN32_NET)

        # Packet didn't have any negative numbers, so let's do some manual ones
        packet.polarized_watt_seconds = [
            -1600 + 100 * i for i in range(0, packet.num_channels)
        ]

        self.assertEqual(
            [
                packet.polarized_watt_seconds[i] + 1000 + 2**39
                for i in range(0, len(packet.polarized_watt_seconds))
            ],
            [
                packet.delta_polarized_watt_seconds(i, 2**39 - 1000)
                for i in range(0, len(packet.polarized_watt_seconds))
            ],
        )


class TestPacketAverageComputation(unittest.TestCase):
    def test_packet_average_power_no_time_passed(self):
        packet_a = packet_maker(
            absolute_watt_seconds=[10] * packets.BIN32_ABS.num_channels,
        )
        self.assertEqual(packet_a.get_average_power(0, packet_a), 0)

    def test_packet_average_power(self):
        packet_a = packet_maker(
            absolute_watt_seconds=[10] * packets.BIN32_ABS.num_channels,
        )
        packet_b = packet_maker(
            absolute_watt_seconds=[20] * packets.BIN32_ABS.num_channels,
            seconds=10,
        )
        self.assertEqual(packet_a.get_average_power(0, packet_b), 1.0)
        self.assertEqual(packet_b.get_average_power(0, packet_a), 1.0)

    def test_packet_average_power_net_metering_mixed(self):
        packet_a = packet_maker(
            absolute_watt_seconds=[10] * packets.BIN32_NET.num_channels,
            packet_format=packets.BIN32_NET,
            polarized_watt_seconds=[0] * packets.BIN32_NET.num_channels,
        )
        packet_b = packet_maker(
            absolute_watt_seconds=[40] * packets.BIN32_NET.num_channels,
            packet_format=packets.BIN32_NET,
            polarized_watt_seconds=[10] * packets.BIN32_NET.num_channels,
            seconds=10,
        )
        self.assertEqual(packet_a.get_average_power(0, packet_b), 1.0)
        self.assertEqual(packet_b.get_average_power(0, packet_a), 1.0)

    def test_produced_power(self):
        packet_a = packet_maker(
            absolute_watt_seconds=[0] * packets.BIN32_NET.num_channels,
            packet_format=packets.BIN32_NET,
            polarized_watt_seconds=[0] * packets.BIN32_NET.num_channels,
        )
        packet_b = packet_maker(
            absolute_watt_seconds=[10] * packets.BIN32_NET.num_channels,
            packet_format=packets.BIN32_NET,
            polarized_watt_seconds=[10] * packets.BIN32_NET.num_channels,
            seconds=10,
        )
        self.assertEqual(packet_a.get_average_power(0, packet_b), -1.0)
        self.assertEqual(packet_b.get_average_power(0, packet_a), -1.0)

    def test_pulse_rate(self):
        packet_a = packet_maker(
            pulse_counts=[0] * packets.BIN32_ABS.NUM_PULSE_COUNTERS,
        )
        packet_b = packet_maker(
            pulse_counts=[15] * packets.BIN32_ABS.NUM_PULSE_COUNTERS,
            seconds=10,
        )
        self.assertEqual(packet_a.get_average_pulse_rate(0, packet_b), 1.5)
        self.assertEqual(packet_b.get_average_pulse_rate(0, packet_a), 1.5)

    def test_pulse_rate_no_time_passed(self):
        packet_a = packet_maker(
            pulse_counts=[0] * packets.BIN32_ABS.NUM_PULSE_COUNTERS,
        )
        self.assertEqual(packet_a.get_average_pulse_rate(0, packet_a), 0)

    def test_aux_rate(self):
        packet_a = packet_maker(
            packet_format=packets.ECM_1240, aux=[0] * packets.ECM_1240.num_aux_channels
        )
        packet_b = packet_maker(
            packet_format=packets.ECM_1240,
            aux=[15] * packets.ECM_1240.num_aux_channels,
            seconds=10,
        )
        self.assertEqual(packet_a.get_average_aux_rate_of_change(0, packet_b), 1.5)
        self.assertEqual(packet_b.get_average_aux_rate_of_change(0, packet_a), 1.5)

    def test_aux_rate_no_time_passed(self):
        packet_a = packet_maker(
            packet_format=packets.ECM_1240, aux=[0] * packets.ECM_1240.num_aux_channels
        )
        self.assertEqual(packet_a.get_average_aux_rate_of_change(0, packet_a), 0)


def check_packet(packet_file_name: str, packet_format: packets.PacketFormat):
    packet = parse_packet(packet_file_name, packet_format)

    assert_packet(packet_file_name, packet)

    raw_data = packet_format.format(packet)
    reparsed_packet = packet_format.parse(raw_data)

    assert_packet(packet_file_name, reparsed_packet)


def parse_packet(packet_file_name: str, packet_format: packets.PacketFormat):
    return packet_format.parse(read_packet(packet_file_name))


if __name__ == "__main__":
    unittest.main()