-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathlwp3_dissector.lua
920 lines (821 loc) · 34.2 KB
/
lwp3_dissector.lua
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
-- Wireshark dissector for LEGO Wireless Protocol v3
-- Copyright (C) 2018,2021 David Lechner <[email protected]>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License along
-- with this program; if not, write to the Free Software Foundation, Inc.,
-- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-- Usage:
--
-- Start from the command line: wireshark -X lua_script:lwp3_dissector.lua
--
-- Or place file in "Personal Lua Plugins" directory found under Help (menu) >
-- About Wireshark > Folders (tab). Then after the file has been placed there,
-- Analyze (menu) > Reload Lua Plugins.
---- Protocol: declare the names we will see in Wireshark ---
local lwp3_proto = Proto("LWP3", "LEGO Wireless Protocol v3 Hub Service")
-- Common Message Header
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#common-message-header
lwp3_proto.fields.msg_len = ProtoField.uint16("lwp3.msg_len", "Message length", base.DEC)
lwp3_proto.fields.hub_id = ProtoField.uint8("lwp3.hub_id", "Hub ID", base.HEX)
lwp3_proto.fields.msg_type = ProtoField.uint8("lwp3.msg_type", "Message Type", base.HEX)
-- Hub Property Message
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-property-message-format
lwp3_proto.fields.property = ProtoField.uint8("lwp3.property", "Property", base.HEX)
lwp3_proto.fields.operation = ProtoField.uint8("lwp3.operation", "Property Operation", base.HEX)
-- Hub Property Payload
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-property-payload
lwp3_proto.fields.hub_prop_adv_name = ProtoField.string("lwp3.hub_prop.adv_name", "Advertising Name")
lwp3_proto.fields.hub_prop_btn_state = ProtoField.int8("lwp3.hub_prop.btn_state", "Button State", base.DEC)
lwp3_proto.fields.hub_prop_fw_ver = ProtoField.string("lwp3.hub_prop.fw_ver", "Firmware Version")
lwp3_proto.fields.hub_prop_hw_ver = ProtoField.string("lwp3.hub_prop.hw_ver", "Hardware Version")
lwp3_proto.fields.hub_prop_rssi = ProtoField.int8("lwp3.hub_prop.rssi", "RSSI", base.DEC)
lwp3_proto.fields.hub_prop_batt_pct = ProtoField.int8("lwp3.hub_prop.batt_pct", "Battery Percent", base.DEC)
lwp3_proto.fields.hub_prop_batt_type = ProtoField.uint8("lwp3.hub_prop.batt_type", "Battery Type", base.HEX)
lwp3_proto.fields.hub_prop_mfg = ProtoField.string("lwp3.hub_prop.mfg", "Manufacturer")
lwp3_proto.fields.hub_prop_radio_ver = ProtoField.string("lwp3.hub_prop.radio_ver", "Radio Firmware Version")
lwp3_proto.fields.hub_prop_lwp_ver = ProtoField.string("lwp3.hub_prop.lwp_ver", "LEGO Wireless Protocol Version")
lwp3_proto.fields.hub_prop_sys_type_id = ProtoField.uint8("lwp3.hub_prop.sys_type_id", "System Type ID", base.HEX)
lwp3_proto.fields.hub_prop_hw_net_id = ProtoField.uint8("lwp3.hub_prop.hw_net_id", "Hardware Network ID", base.DEC)
lwp3_proto.fields.hub_prop_bd_addr = ProtoField.ether("lwp3.hub_prop.bd_addr", "Bluetooth Address")
lwp3_proto.fields.hub_prop_loader_bd_addr = ProtoField.ether("lwp3.hub_prop.loader_bd_addr", "Bootloader Bluetooth Address")
lwp3_proto.fields.hub_prop_hw_net_fam = ProtoField.uint8("lwp3.hub_prop.hw_net_fam", "Hardware Network Family", base.HEX)
lwp3_proto.fields.hub_prop_unknown_10 = ProtoField.uint8("lwp3.hub_prop.unknown_10", "unknown", base.HEX)
lwp3_proto.fields.hub_prop_unknown_11 = ProtoField.uint8("lwp3.hub_prop.unknown_11", "unknown", base.HEX)
lwp3_proto.fields.hub_prop_volume = ProtoField.uint8("lwp3.hub_prop.volume", "Volume", base.DEC)
lwp3_proto.fields.hub_prop_unknown_13 = ProtoField.uint8("lwp3.hub_prop.unknown_13", "unknown", base.HEX)
lwp3_proto.fields.hub_prop_unknown_14 = ProtoField.uint32("lwp3.hub_prop.unknown_14", "unknown", base.DEC)
lwp3_proto.fields.hub_prop_unknown_15 = ProtoField.uint32("lwp3.hub_prop.unknown_15", "unknown", base.DEC)
-- Hub Actions
lwp3_proto.fields.hub_action = ProtoField.uint8("lwp3.hub_action", "Action", base.HEX)
-- Hub Alerts
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-alerts
lwp3_proto.fields.hub_alert_type = ProtoField.uint8("lwp3.hub_alert.type", "Alert Type", base.HEX)
lwp3_proto.fields.hub_alert_op = ProtoField.uint8("lwp3.hub_alert.op", "Alert Operation", base.HEX)
lwp3_proto.fields.hub_alert_payload = ProtoField.uint8("lwp3.hub_alert.payload", "Alert Payload", base.HEX)
-- Hub Attached I/O
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-attached-i-o
lwp3_proto.fields.hub_io_port_id = ProtoField.uint8("lwp3.hub_io.port_id", "Port ID", base.HEX)
lwp3_proto.fields.hub_io_event = ProtoField.uint8("lwp3.hub_io.event", "Event", base.HEX)
lwp3_proto.fields.hub_io_type_id = ProtoField.uint16("lwp3.hub_io.type_id", "IO Type ID", base.HEX)
lwp3_proto.fields.hub_io_hw_ver = ProtoField.string("lwp3.hub_io.hw_ver", "Hardware Version")
lwp3_proto.fields.hub_io_sw_ver = ProtoField.string("lwp3.hub_io.sw_ver", "Software Version")
lwp3_proto.fields.hub_io_port_id_a = ProtoField.uint8("lwp3.hub_io.port_id_a", "Port ID A", base.HEX)
lwp3_proto.fields.hub_io_port_id_b = ProtoField.uint8("lwp3.hub_io.port_id_b", "Port ID B", base.HEX)
-- Generic Error
lwp3_proto.fields.error_code = ProtoField.uint8("lwp3.error_code", "Error Code", base.HEX)
-- Firmware commands
lwp3_proto.fields.safety_string = ProtoField.string("lwp3.safety_string", "Safety String")
-- Port commands
lwp3_proto.fields.port_id = ProtoField.uint8("lwp3.port_id", "Port ID", base.DEC)
lwp3_proto.fields.port_mode = ProtoField.uint8("lwp3.port_mode", "Mode", base.DEC)
lwp3_proto.fields.port_delta_interval = ProtoField.uint32("lwp3.port_delta_interval", "Delta Interval", base.DEC)
lwp3_proto.fields.port_notification_enabled = ProtoField.uint8("lwp3.port_notification_enabled", "Notification Enabled", base.DEC)
lwp3_proto.fields.port_data = ProtoField.bytes("lwp3.port_data", "Data", base.SPACE)
lwp3_proto.fields.port_startup_and_completion = ProtoField.uint8("lwp3.port_startup_and_completion", "Startup and Completion", base.HEX)
lwp3_proto.fields.port_output_subcommand = ProtoField.uint8("lwp3.port_output_subcommand", "Subcommand", base.HEX)
lwp3_proto.fields.port_payload = ProtoField.bytes("lwp3.port_payload", "Payload", base.SPACE)
lwp3_proto.fields.port_info_type = ProtoField.uint8("lwp3.port_info_type", "Info Type", base.HEX)
lwp3_proto.fields.port_feedback = ProtoField.uint8("lwp3.port_feedback", "Feedback", base.HEX)
---- Enmerations: lookup tables for enum values ----
-- property operations are used by Hub Property (0x01) messages
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-property-operation
local operations = {
[0x01] = "Set",
[0x02] = "Enable Updates",
[0x03] = "Disable Updates",
[0x04] = "Reset",
[0x05] = "Request Update",
[0x06] = "Update",
}
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#system-type-and-device-number
local system_types = {
[0x0] = "LEGO Wedo 2.0",
[0x1] = "LEGO Duplo",
[0x2] = "LEGO System",
[0x3] = "LEGO System",
}
local device_numbers = {
[0x00] = "WeDo Hub",
[0x20] = "Duplo Train",
[0x40] = "Boost Hub",
[0x41] = "2 Port Hub",
[0x42] = "2 Port Handset",
[0x80] = "Technic Medium Hub",
[0x81] = "Technic Large Hub",
[0x83] = "Technic Small Hub",
}
-- IO Type ID
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#io-type-id
local type_ids = {
[0x0000] = "None",
[0x0001] = "Medium Motor",
[0x0002] = "Train Motor",
[0x0003] = "Unknown",
[0x0004] = "Unknown",
[0x0005] = "Unknown",
[0x0006] = "Unknown",
[0x0007] = "Unknown",
[0x0008] = "Lights",
[0x0009] = "Unknown",
[0x000A] = "Unknown",
[0x000B] = "Unknown",
[0x000C] = "Unknown",
[0x000D] = "Unknown",
[0x000E] = "Unknown",
[0x000F] = "Unknown",
[0x0010] = "Unknown",
[0x0011] = "Unknown",
[0x0012] = "Unknown",
[0x0013] = "Unknown",
[0x0014] = "Hub Battery Voltage",
[0x0015] = "Hub Battery Current",
[0x0016] = "Hub Piezo Buzzer",
[0x0017] = "Hub Status Light",
[0x0018] = "Unknown",
[0x0019] = "Unknown",
[0x001A] = "Unknown",
[0x001B] = "Unknown",
[0x001C] = "Unknown",
[0x001D] = "EV3 Color Sensor",
[0x001E] = "EV3 Ultrasonic Sensor",
[0x001F] = "Unknown",
[0x0020] = "EV3 Gyro Sensor",
[0x0021] = "EV3 Infrared Sensor",
[0x0022] = "WeDo 2.0 Tilt Sensor",
[0x0023] = "WeDo 2.0 Motion Sensor",
[0x0024] = "WeDo 2.0 Generic Sensor",
[0x0025] = "BOOST Color and Distance Sensor",
[0x0026] = "BOOST Interactive Motor",
[0x0027] = "BOOST Move Hub Built-in Motor",
[0x0028] = "BOOST Move Hub Built-in Tilt Sensor",
[0x0029] = "DUPLO Train Motor",
[0x002A] = "DUPLO Train Piezo Buzzer",
[0x002B] = "DUPLO Train Color Sensor",
[0x002C] = "DUPLO Train Speed",
[0x002E] = "Technic Large Linear Motor",
[0x002F] = "Technic XL Linear Motor",
[0x0030] = "SPIKE Medium Angular Motor",
[0x0031] = "SPIKE Large Angular Motor",
[0x0032] = "Unknown",
[0x0033] = "Unknown",
[0x0034] = "Unknown",
[0x0035] = "Unknown",
[0x0036] = "Powered Up hub IMU gesture",
[0x0037] = "Powered Up hub buttons (Handset)",
[0x0038] = "Powered Up hub Bluetooth RSSI",
[0x0039] = "Powered Up hub IMU accelerometer",
[0x003A] = "Powered Up hub IMU gyro",
[0x003B] = "Powered Up hub IMU position",
[0x003C] = "Powered Up hub IMU temperature",
[0x003D] = "SPIKE Color sensor",
[0x003E] = "SPIKE Ultrasonic sensor",
[0x003F] = "SPIKE Force sensor",
[0x0040] = "Unknown",
[0x0041] = "Unknown",
[0x0042] = "Unknown",
[0x0043] = "Unknown",
[0x0044] = "Unknown",
[0x0045] = "Unknown",
[0x0046] = "Mario Unknown",
[0x0047] = "Mario IMU",
[0x0048] = "Unknown",
[0x0049] = "Mario Color Barcode",
[0x004A] = "Mario Pants",
[0x004B] = "Technic Medium Angular Motor, gray",
[0x004C] = "Technic Large Angular motor, gray",
[0x004D] = "Unknown",
[0x004E] = "Unknown",
[0x004F] = "Unknown",
[0x0050] = "Unknown",
[0x0051] = "Unknown",
[0x0052] = "Unknown",
[0x0053] = "Unknown",
[0x0054] = "Unknown",
[0x0055] = "Mario Unknown",
[0x0056] = "Unknown",
[0x0057] = "Unknown",
[0x0058] = "Unknown",
[0x0059] = "Unknown",
[0x005A] = "Unknown",
[0x005B] = "Unknown",
[0x005C] = "Unknown",
[0x005D] = "Unknown",
[0x005E] = "Unknown",
[0x005F] = "Unknown",
}
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#lst-net
local last_network_ids = {
[0] = "Unknown",
[251] = "DEFAULT 1, Locked",
[252] = "DEFAULT 2, NOT Locked",
[253] = "DEFAULT 3, RSSI Dependent",
[254] = "DEFAULT 4, DISABLE H/W Network",
[255] = "DON’T CARE - NOT Implemented",
}
local error_code = {
[0x01] = "ACK",
[0x02] = "NACK",
[0x03] = "Buffer Overflow",
[0x04] = "Timeout",
[0x05] = "Command NOT recognized",
[0x06] = "Invalid use (e.g. parameter error(s)",
[0x07] = "Overcurrent",
[0x08] = "Internal ERROR",
}
---- generic helper functions -----
--- join_flags joins the text representation of bit flags with a delimiter.
-- @param value the value containg bit flags
-- @param map a table mapping bit flags to strings
-- @param delimiter a string that will inserted inbetween the text values
-- @return a string like
function join_flags(value, map, delimeter)
local list = {}
for k, v in pairs(map) do
if bit32.band(value, k) ~= 0 then
table.insert(list, v)
end
end
return table.concat(list, delimeter)
end
---- Value parsers: parse single values and add them to the tree ----
-- parses a string
function parse_string(range, offset, subtree, field)
local range = range:range(offset, range:len() - offset)
local value = range:string()
subtree:add_le(field, range, value)
end
-- parses a 1-byte signed integer
function parse_int8(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_int()
subtree:add_le(field, range, value)
end
-- parses a 1-byte unsigned integer
function parse_uint8(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_uint()
subtree:add_le(field, range, value)
end
-- parses a 2-byte unsigned integer
function parse_uint16(range, offset, subtree, field)
local range = range:range(offset, 2)
local value = range:le_uint()
subtree:add_le(field, range, value)
end
-- parses a 4-byte unsigned integer
function parse_uint32(range, offset, subtree, field)
local range = range:range(offset, 4)
local value = range:le_uint()
subtree:add_le(field, range, value)
end
-- parses a 4-byte version number and format's it using LEGO's weird 0.0.00.0000 format
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#version-number-encoding
function parse_version(range, offset, subtree, field)
local bcd = range:range(offset + 3, 1):le_uint()
local major = bit32.rshift(bcd, 4)
local minor = bit32.band(bcd, 0xf)
bcd = range:range(offset + 2, 1):le_uint()
local bug_fix = bit32.rshift(bcd, 4) * 10 + bit32.band(bcd, 0xf)
bcd = range:range(offset + 1, 1):le_uint()
local build = bit32.rshift(bcd, 4) * 1000 + bit32.band(bcd, 0xf) * 100
bcd = range:range(offset, 1):le_uint()
build = build + bit32.rshift(bcd, 4) * 10 + bit32.band(bcd, 0xf)
local value = string.format("%d.%d.%02d.%04d", major, minor, bug_fix, build)
subtree:add_le(field, range:range(offset, 4), value)
end
-- parses a 2-byte version number in BCD format
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#lwp-version-number-encoding
function parse_lwp_version(range, offset, subtree, field)
local major = range:range(offset + 1, 1):le_uint()
local minor = range:range(offset, 1):le_uint()
local value = string.format("%x.%02x", major, minor)
subtree:add_le(field, range:range(offset, 2), value)
end
-- parses a 1-byte unsigned integer as a Battery Type
function parse_batt_type(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_uint()
local batt_type_tree = subtree:add_le(field, range, value)
local batt_type = {
[0x00] = "Normal",
[0x01] = "Rechargeable",
}
batt_type_tree:append_text(" (" .. batt_type[value] .. ")")
end
-- parses a 1-byte unsigned integer as a Network ID
function parse_net_id(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_uint()
local net_id_tree = subtree:add_le(field, range, value)
net_id_tree:append_text(" (" .. last_network_ids[value] .. ")")
end
-- parses a 6-byte Bluetooth address
function parse_bd_addr(range, offset, subtree, field)
local range = range:range(offset, 6)
local value = range:ether()
subtree:add_le(field, range, value)
end
-- parses a 1-byte device id
function parse_sys_type_id(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_int()
local sys_type_id_tree = subtree:add_le(field, range, value)
sys_type_id_tree:append_text(" (" .. device_numbers[value] .. ")")
end
-- parses a 1-byte port id
function parse_port_id(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_int()
local port_id_tree = subtree:add_le(field, range, value)
end
-- parses a 2-byte type id
function parse_type_id(range, offset, subtree, field)
local range = range:range(offset, 2)
local value = range:le_int()
local type_id_tree = subtree:add_le(field, range, value)
type_id_tree:append_text(" (" .. type_ids[value] .. ")")
end
-- parses a 1-byte info type
function parse_port_info_type(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_uint()
local tree = subtree:add_le(field, range, value)
local info_type = {
[0x00] = "Port Value",
[0x01] = "Mode Info",
[0x02] = "Possible Mode Combinations",
}
tree:append_text(" (" .. info_type[value] .. ")")
end
-- parses a 1-byte port output feedback
function parse_port_feedback(range, offset, subtree, field)
local range = range:range(offset, 1)
local value = range:le_uint()
local tree = subtree:add_le(field, range, value)
local feedback = {
[0x01] = "Buffer Empty + Command In Progress",
[0x02] = "Buffer Empty + Command Completed",
[0x04] = "Current Command(s) Discarded",
[0x08] = "Idle",
[0x10] = "Busy/Full",
}
tree:append_text(" (" .. join_flags(value, feedback, "|") .. ")")
end
---- Message parsers: parse the data of specific message types ----
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-property-reference
local hub_properties = {
[0x01] = {
name = "Advertising Name",
field = lwp3_proto.fields.hub_prop_adv_name,
parse_update_payload = parse_string,
},
[0x02] = {
name = "Button",
field = lwp3_proto.fields.hub_prop_btn_state,
parse_update_payload = parse_uint8,
},
[0x03] = {
name = "FW Version",
field = lwp3_proto.fields.hub_prop_fw_ver,
parse_update_payload = parse_version,
},
[0x04] = {
name = "HW Version",
field = lwp3_proto.fields.hub_prop_hw_ver,
parse_update_payload = parse_version,
},
[0x05] = {
name = "RSSI",
field = lwp3_proto.fields.hub_prop_rssi,
parse_update_payload = parse_int8,
},
[0x06] = {
name = "Battery Voltage",
field = lwp3_proto.fields.hub_prop_batt_pct,
parse_update_payload = parse_uint8,
},
[0x07] = {
name = "Battery Type",
field = lwp3_proto.fields.hub_prop_batt_type,
parse_update_payload = parse_batt_type,
},
[0x08] = {
name = "Manufacturer Name",
field = lwp3_proto.fields.hub_prop_mfg,
parse_update_payload = parse_string,
},
[0x09] = {
name = "Radio Firmware Version",
field = lwp3_proto.fields.hub_prop_radio_ver,
parse_update_payload = parse_string,
},
[0x0A] = {
name = "LEGO Wireless Protocol Version",
field = lwp3_proto.fields.hub_prop_lwp_ver,
parse_update_payload = parse_lwp_version,
},
[0x0B] = {
name = "System Type ID",
field = lwp3_proto.fields.hub_prop_sys_type_id,
parse_update_payload = parse_sys_type_id,
},
[0x0C] = {
name = "H/W Network ID",
field = lwp3_proto.fields.hub_prop_hw_net_id,
parse_update_payload = parse_net_id,
},
[0x0D] = {
name = "Primary MAC Address",
field = lwp3_proto.fields.hub_prop_bd_addr,
parse_update_payload = parse_bd_addr,
},
[0x0E] = {
name = "Secondary MAC Address",
field = lwp3_proto.fields.hub_prop_loader_bd_addr,
parse_update_payload = parse_bd_addr,
},
[0x0F] = {
name = "Hardware Network Family",
field = lwp3_proto.fields.hub_prop_hw_net_fam,
parse_update_payload = parse_uint8,
},
[0x10] = {
name = "unknown",
field = lwp3_proto.fields.hub_prop_unknown_10,
parse_update_payload = parse_uint8,
},
[0x11] = {
name = "unknown",
field = lwp3_proto.fields.hub_prop_unknown_11,
parse_update_payload = parse_uint8,
},
[0x12] = {
name = "Volume level",
field = lwp3_proto.fields.hub_prop_volume,
parse_update_payload = parse_uint8,
},
[0x13] = {
name = "unknown",
field = lwp3_proto.fields.hub_prop_unknown_13,
parse_update_payload = parse_uint8,
},
[0x14] = {
name = "unknown",
field = lwp3_proto.fields.hub_prop_unknown_14,
parse_update_payload = parse_uint32,
},
[0x15] = {
name = "unknown",
field = lwp3_proto.fields.hub_prop_unknown_15,
parse_update_payload = parse_uint32,
},
}
-- Parses a hub property (0x01) message
function parse_hub_prop(range, subtree)
local prop_range = range:range(0, 1)
local prop = prop_range:le_uint()
local prop_tree = subtree:add_le(lwp3_proto.fields.property, prop_range, prop)
local prop_info = hub_properties[prop]
prop_tree:append_text(" (" .. prop_info.name .. ")")
local operation_range = range:range(1, 1)
local operation = operation_range:le_uint()
local operation_tree = subtree:add_le(lwp3_proto.fields.operation, operation_range, operation)
operation_tree:append_text(" (" .. operations[operation] .. ")")
-- set (0x01) and update (0x06) have payload
if operation == 0x01 or operation == 0x06 then
prop_info.parse_update_payload(range, 2, subtree, prop_info.field)
end
end
-- Parses a hub action (0x02) message
function parse_hub_action(range, subtree)
local action_range = range:range(0, 1)
local action_value = action_range:le_uint()
local action_tree = subtree:add_le(lwp3_proto.fields.hub_action, action_range, action_value)
local hub_action = {
[0x01] = "Switch Off Hub",
[0x02] = "Disconnect",
[0x03] = "VCC Port Control On",
[0x04] = "VCC Port Control Off",
[0x05] = "Activate BUSY Indication",
[0x06] = "Reset BUSY Indication",
[0x30] = "Hub Will Switch Off",
[0x31] = "Hub Will Disconnect",
[0x32] = "Hub Will Go Into Boot Mode",
}
action_tree:append_text(" (" .. hub_action[action_value] .. ")")
end
-- Parses a hub alert (0x03) message
function parse_hub_alert(range, subtree)
local alert_type_range = range:range(0, 1)
local alert_type = alert_type_range:le_uint()
local alert_type_tree = subtree:add_le(lwp3_proto.fields.hub_alert_type, alert_type_range, alert_type)
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#alert-type
local alert_types = {
[0x01] = "Low Voltage",
[0x02] = "High Current",
[0x03] = "Low Signal Strength",
[0x04] = "Over Power Condition",
}
alert_type_tree:append_text(" (" .. alert_types[alert_type] .. ")")
local alert_op_range = range:range(1, 1)
local alert_op = alert_op_range:le_uint()
local alert_op_tree = subtree:add_le(lwp3_proto.fields.hub_alert_op, alert_op_range, alert_op)
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#al-op
local alert_ops = {
[0x01] = "Enable Updates",
[0x02] = "Disable Updates",
[0x03] = "Request Updates",
[0x04] = "Update",
}
alert_op_tree:append_text(" (" .. alert_ops[alert_op] .. ")")
-- payload only exists in Downstream messages
if range:len() <= 2 then
return
end
local alert_payload_range = range:range(2, 1)
local alert_payload = alert_payload_range:le_uint()
local alert_payload_tree = subtree:add_le(lwp3_proto.fields.hub_alert_payload, alert_payload_range, alert_payload)
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#al-pay
local alert_payloads = {
[0x00] = "Status OK",
[0xFF] = "Alert!",
}
alert_payload_tree:append_text(" (" .. alert_payloads[alert_payload] .. ")")
end
-- Parses a Hub Attached I/O (0x04) message
function parse_hub_attached_io(range, subtree)
parse_port_id(range, 0, subtree, lwp3_proto.fields.hub_io_port_id)
local event_range = range:range(1, 1)
local event = event_range:le_uint()
local event_tree = subtree:add_le(lwp3_proto.fields.hub_io_event, event_range, event)
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#event
local events = {
[0x00] = "Detached I/O",
[0x01] = "Attached I/O",
[0x02] = "Attached Virtual I/O",
}
event_tree:append_text(" (" .. events[event] .. ")")
if event == 0x01 or event == 0x02 then
parse_type_id(range, 2, subtree, lwp3_proto.fields.hub_io_type_id)
end
if event == 0x01 then
parse_version(range, 4, subtree, lwp3_proto.fields.hub_io_hw_ver)
parse_version(range, 8, subtree, lwp3_proto.fields.hub_io_sw_ver)
end
if event == 0x02 then
parse_port_id(range, 4, subtree, lwp3_proto.fields.hub_io_port_id_a)
parse_port_id(range, 5, subtree, lwp3_proto.fields.hub_io_port_id_b)
end
end
-- Parses hub error (0x05) message
function parse_error(range, subtree)
local cmd_type_range = range:range(0, 1)
local cmd_type = cmd_type_range:le_uint()
local cmd_tree = subtree:add_le(lwp3_proto.fields.msg_type, cmd_type_range, cmd_type)
local cmd_info = msg_types[cmd_type] and msg_types[cmd_type].name or "Unknown"
cmd_tree:append_text(" (" .. cmd_info .. ")")
local err_code_range = range:range(1, 1)
local err_code = err_code_range:le_uint()
local err_tree = subtree:add_le(lwp3_proto.fields.error_code, err_code_range, err_code)
err_tree:append_text(" (" .. error_code[err_code] .. ")")
end
-- Parses a Go Into Boot Mode (0x10) message
function parse_fw_boot_mode(range, subtree)
parse_string(range, 0, subtree, lwp3_proto.fields.safety_string)
end
-- Parses a Port Information Request (0x21) message
function parse_port_info_req(range, subtree)
parse_port_id(range, 0, subtree, lwp3_proto.fields.port_id)
parse_port_info_type(range, 1, subtree, lwp3_proto.fields.port_info_type)
end
-- Parses a Port Input Format Setup (Single) (0x41) message
function parse_port_setup_single(range, subtree)
parse_port_id(range, 0, subtree, lwp3_proto.fields.port_id)
parse_uint8(range, 1, subtree, lwp3_proto.fields.port_mode)
parse_uint32(range, 2, subtree, lwp3_proto.fields.port_delta_interval)
parse_uint8(range, 2, subtree, lwp3_proto.fields.port_notification_enabled)
end
-- Parses a Port Value (Single) (0x45) message
function parse_port_val_single(range, subtree)
parse_port_id(range, 0, subtree, lwp3_proto.fields.port_id)
-- TODO: The interpretation of this data depends on previous messages
-- received. There could also be additional ports in the same message.
local data_range = range(1)
local data_tree = subtree:add(lwp3_proto.fields.port_data, data_range)
data_tree:append_text(" (" .. data_range:len() .. " bytes)")
end
-- Parses a Port Input Format (Single) (0x47) message
function parse_port_fmt_single(range, subtree)
parse_port_id(range, 0, subtree, lwp3_proto.fields.port_id)
parse_uint8(range, 1, subtree, lwp3_proto.fields.port_mode)
parse_uint32(range, 2, subtree, lwp3_proto.fields.port_delta_interval)
parse_uint8(range, 2, subtree, lwp3_proto.fields.port_notification_enabled)
end
-- Parses a Port Output Command (0x81) message
function parse_port_out_cmd(range, subtree)
parse_port_id(range, 0, subtree, lwp3_proto.fields.port_id)
-- startup and completion
local sc_range = range:range(1, 1)
local sc_value = sc_range:le_uint()
local sc_tree = subtree:add_le(lwp3_proto.fields.port_startup_and_completion, sc_range, sc_value)
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#st-comp
local startup = {
[0x0] = "Buffer if necessary",
[0x1] = "Execute immediately",
}
local completion = {
[0x0] = "No action",
[0x1] = "Command feedback",
}
sc_tree:append_text(" (Startup: " .. startup[bit32.rshift(sc_value, 4)] .. ", Completion: " .. completion[bit32.band(sc_value, 0xf)] .. ")")
-- subcommand
local subcommand_range = range:range(2, 1)
local subcommand_value = subcommand_range:le_uint()
local subcommand_tree = subtree:add_le(lwp3_proto.fields.port_output_subcommand, subcommand_range, subcommand_value)
local subcommand = {
[0x01] = "StartPower(Power)",
[0x02] = "StartPower(Power1, Power2)",
[0x05] = "SetAccTime (Time, ProfileNo)",
[0x06] = "SetDecTime (Time, ProfileNo)",
[0x07] = "StartSpeed (Speed, MaxPower, UseProfile)",
[0x08] = "StartSpeed (Speed1, Speed2, MaxPower, UseProfile)",
[0x09] = "StartSpeedForTime (Time, Speed, MaxPower, EndState, UseProfile)",
[0x0A] = "StartSpeedForTime (Time, Speed, MaxPower, EndState, UseProfile)",
[0x0B] = "StartSpeedForDegrees(Degrees, Speed, MaxPower, EndState, UseProfile)",
[0x0C] = "StartSpeedForDegrees(Degrees, SpeedL, SpeedR, MaxPower, EndState, UseProfile)",
[0x0D] = "GotoAbsolutePosition(AbsPos, Speed, MaxPower, EndState, UseProfile)",
[0x0E] = "GotoAbsolutePosition(AbsPos1, AbsPos2, Speed, MaxPower, EndState, UseProfile)",
[0x50] = "WriteDirect(Byte[0],Byte[0 + n])",
[0x51] = "WriteDirectModeData()",
}
subcommand_tree:append_text(" (" .. subcommand[subcommand_value] .. ")")
-- payload
if subcommand_value == 0x51 then
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#encoding-of-writedirectmodedata-0x81-0x51
parse_uint8(range, 3, subtree, lwp3_proto.fields.port_mode)
local payload_range = range(4)
local payload_tree = subtree:add(lwp3_proto.fields.port_payload, payload_range)
payload_tree:append_text(" (" .. payload_range:len() .. " bytes)")
else
-- TODO: The payload could be interpreted further based on the subcommand.
local payload_range = range(3)
local payload_tree = subtree:add(lwp3_proto.fields.port_payload, payload_range)
payload_tree:append_text(" (" .. payload_range:len() .. " bytes)")
end
end
-- Port Output Command Feedback (0x82) message
function parse_port_out_cmd_feedback(range, subtree)
parse_port_id(range, 0, subtree, lwp3_proto.fields.port_id)
parse_port_feedback(range, 1, subtree, lwp3_proto.fields.port_feedback)
-- additional ports are optional
if range:len() > 2 then
parse_port_id(range, 2, subtree, lwp3_proto.fields.port_id)
parse_port_feedback(range, 3, subtree, lwp3_proto.fields.port_feedback)
end
if range:len() > 4 then
parse_port_id(range, 4, subtree, lwp3_proto.fields.port_id)
parse_port_feedback(range, 5, subtree, lwp3_proto.fields.port_feedback)
end
end
---- message types: table of possible message types and subcommands ----
-- https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#message-types
msg_types = {
[0x01] = {
name = "Hub Property",
parse_msg = parse_hub_prop,
},
[0x02] = {
name = "Hub Actions",
parse_msg = parse_hub_action,
},
[0x03] = {
name = "Hub Alterts",
parse_msg = parse_hub_alert,
},
[0x04] = {
name = "Hub Attached I/O",
parse_msg = parse_hub_attached_io,
},
[0x05] = {
name = "Generic Error Messages",
parse_msg = parse_error,
},
[0x08] = {
name = "H/W Network Commands",
parse_msg = parse_hw_network_cmd,
},
[0x10] = {
name = "F/W Update - Go Into Boot Mode",
parse_msg = parse_fw_boot_mode,
},
[0x11] = {
name = "F/W Update Lock memory",
parse_msg = parse_fw_lock_mem,
},
[0x12] = {
name = "F/W Update Lock Status Request",
parse_msg = parse_fw_lock_stat_req,
},
[0x13] = {
name = "F/W Lock Status",
parse_msg = parse_fw_lock_stat,
},
[0x21] = {
name = "Port Information Request",
parse_msg = parse_port_info_req,
},
[0x22] = {
name = "Port Mode Information Request",
parse_msg = parse_port_mode_info_req,
},
[0x41] = {
name = "Port Input Format Setup (Single)",
parse_msg = parse_port_setup_single,
},
[0x42] = {
name = "Port Input Format Setup (CombinedMode)",
parse_msg = parse_port_setup_combo,
},
[0x43] = {
name = "Port Information",
parse_msg = parse_port_info,
},
[0x44] = {
name = "Port Mode Information",
parse_msg = parse_port_mode_info,
},
[0x45] = {
name = "Port Value (Single)",
parse_msg = parse_port_val_single,
},
[0x46] = {
name = "Port Value (CombinedMode)",
parse_msg = parse_port_val_combo,
},
[0x47] = {
name = "Port Input Format (Single)",
parse_msg = parse_port_fmt_single,
},
[0x48] = {
name = "Port Input Format (CombinedMode)",
parse_msg = parse_port_fmt_combo,
},
[0x61] = {
name = "Virtual Port Setup",
parse_msg = parse_virt_port_setup,
},
[0x81] = {
name = "Port Output Command",
parse_msg = parse_port_out_cmd,
},
[0x82] = {
name = "Port Output Command Feedback",
parse_msg = parse_port_out_cmd_feedback,
},
}
---- Dissector: the entry point for the dissector ----
function lwp3_proto.dissector(buffer, pinfo, tree)
if buffer:len() == 0 then
return
end
pinfo.cols.protocol = lwp3_proto.name
-- TODO: could also set pinfo.cols.info
local subtree = tree:add(lwp3_proto, buffer())
-- message length can be 8 or 16 bits
local msg_len_range = buffer(0, 1)
local msg_len = msg_len_range:le_uint()
local offset = 1
if bit32.band(msg_len, 0x80) ~= 0 then
local extra = buffer(1, 1):le_uint()
msg_len = bit32.band(msg_len, 0x80) + extra * 128
msg_len_range = buffer(0, 2)
offset = 2
end
subtree:add_le(lwp3_proto.fields.msg_len, msg_len_range, msg_len)
local hub_id_range = buffer(offset, 1)
local hub_id = hub_id_range:le_uint()
local hub_id_tree = subtree:add_le(lwp3_proto.fields.hub_id, hub_id_range, hub_id)
local msg_type_range = buffer(offset + 1, 1)
local msg_type = msg_type_range:le_uint()
local msg_tree = subtree:add_le(lwp3_proto.fields.msg_type, msg_type_range, msg_type)
local msg_info = msg_types[msg_type]
msg_tree:append_text(" (" .. msg_info.name .. ")")
msg_info.parse_msg(buffer(offset + 2), subtree)
end
bluetooth_table = DissectorTable.get("bluetooth.uuid")
-- LWP3 Hub characteristic UUID
bluetooth_table:add("00001624-1212-efde-1623-785feabcd123", lwp3_proto)
-- some times the UUID is cached so Wireshark doesn't pick it up so we need to
-- add an entry for GATT handles as well
bluetooth_gatt_table = DissectorTable.get("btatt.handle")
bluetooth_gatt_table:add(0x0012, lwp3_proto)