-
Notifications
You must be signed in to change notification settings - Fork 0
/
Ricezione_notifiche.py
1199 lines (1044 loc) · 45.4 KB
/
Ricezione_notifiche.py
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
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
from __future__ import print_function
"""Bluetooth Low Energy Python interface"""
import sys
import datetime
import os
import time
import subprocess
import binascii
import select
import struct
import signal
import math
import sys
from collections import namedtuple
from struct import *
def preexec_function():
# Ignore the SIGINT signal by setting the handler to the standard
# signal handler SIG_IGN.
signal.signal(signal.SIGINT, signal.SIG_IGN)
Debugging = False
script_path = os.path.join(os.path.abspath(os.path.dirname(__file__)))
helperExe = os.path.join(script_path, "bluepy-helper")
SEC_LEVEL_LOW = "low"
SEC_LEVEL_MEDIUM = "medium"
SEC_LEVEL_HIGH = "high"
ADDR_TYPE_PUBLIC = "public"
ADDR_TYPE_RANDOM = "random"
def DBG(*args):
if Debugging:
msg = " ".join([str(a) for a in args])
print(msg)
class BTLEException(Exception):
"""Base class for all Bluepy exceptions"""
def __init__(self, message, resp_dict=None):
self.message = message
# optional messages from bluepy-helper
self.estat = None
self.emsg = None
if resp_dict:
self.estat = resp_dict.get('estat',None)
if isinstance(self.estat,list):
self.estat = self.estat[0]
self.emsg = resp_dict.get('emsg',None)
if isinstance(self.emsg,list):
self.emsg = self.emsg[0]
def __str__(self):
msg = self.message
if self.estat or self.emsg:
msg = msg + " ("
if self.estat:
msg = msg + "code: %s" % self.estat
if self.estat and self.emsg:
msg = msg + ", "
if self.emsg:
msg = msg + "error: %s" % self.emsg
msg = msg + ")"
return msg
class BTLEInternalError(BTLEException):
def __init__(self, message, rsp=None):
BTLEException.__init__(self, message, rsp)
class BTLEDisconnectError(BTLEException):
def __init__(self, message, rsp=None):
BTLEException.__init__(self, message, rsp)
class BTLEManagementError(BTLEException):
def __init__(self, message, rsp=None):
BTLEException.__init__(self, message, rsp)
class BTLEGattError(BTLEException):
def __init__(self, message, rsp=None):
BTLEException.__init__(self, message, rsp)
class UUID:
def __init__(self, val, commonName=None):
'''We accept: 32-digit hex strings, with and without '-' characters,
4 to 8 digit hex strings, and integers'''
if isinstance(val, int):
if (val < 0) or (val > 0xFFFFFFFF):
raise ValueError(
"Short form UUIDs must be in range 0..0xFFFFFFFF")
val = "%04X" % val
elif isinstance(val, self.__class__):
val = str(val)
else:
val = str(val) # Do our best
val = val.replace("-", "")
if len(val) <= 8: # Short form
val = ("0" * (8 - len(val))) + val + "00001000800000805F9B34FB"
self.binVal = binascii.a2b_hex(val.encode('utf-8'))
if len(self.binVal) != 16:
raise ValueError(
"UUID must be 16 bytes, got '%s' (len=%d)" % (val,
len(self.binVal)))
self.commonName = commonName
def __str__(self):
s = binascii.b2a_hex(self.binVal).decode('utf-8')
return "-".join([s[0:8], s[8:12], s[12:16], s[16:20], s[20:32]])
def __eq__(self, other):
return self.binVal == UUID(other).binVal
def __cmp__(self, other):
return cmp(self.binVal, UUID(other).binVal)
def __hash__(self):
return hash(self.binVal)
def getCommonName(self):
s = AssignedNumbers.getCommonName(self)
if s:
return s
s = str(self)
if s.endswith("-0000-1000-8000-00805f9b34fb"):
s = s[0:8]
if s.startswith("0000"):
s = s[4:]
return s
class Service:
def __init__(self, *args):
(self.peripheral, uuidVal, self.hndStart, self.hndEnd) = args
self.uuid = UUID(uuidVal)
self.chars = None
self.descs = None
def getCharacteristics(self, forUUID=None):
if not self.chars: # Unset, or empty
self.chars = [] if self.hndEnd <= self.hndStart else self.peripheral.getCharacteristics(self.hndStart, self.hndEnd)
if forUUID is not None:
u = UUID(forUUID)
return [ch for ch in self.chars if ch.uuid==u]
return self.chars
def getDescriptors(self, forUUID=None):
if not self.descs:
# Grab all descriptors in our range, except for the service
# declaration descriptor
all_descs = self.peripheral.getDescriptors(self.hndStart+1, self.hndEnd)
# Filter out the descriptors for the characteristic properties
# Note that this does not filter out characteristic value descriptors
self.descs = [desc for desc in all_descs if desc.uuid != 0x2803]
if forUUID is not None:
u = UUID(forUUID)
return [desc for desc in self.descs if desc.uuid == u]
return self.descs
def __str__(self):
return "Service <uuid=%s handleStart=%s handleEnd=%s>" % (self.uuid.getCommonName(),
self.hndStart,
self.hndEnd)
class Characteristic:
# Currently only READ is used in supportsRead function,
# the rest is included to facilitate supportsXXXX functions if required
props = {"BROADCAST": 0b00000001,
"READ": 0b00000010,
"WRITE_NO_RESP":0b00000100,
"WRITE": 0b00001000,
"NOTIFY": 0b00010000,
"INDICATE": 0b00100000,
"WRITE_SIGNED": 0b01000000,
"EXTENDED": 0b10000000,
}
propNames = {0b00000001 : "BROADCAST",
0b00000010 : "READ",
0b00000100 : "WRITE NO RESPONSE",
0b00001000 : "WRITE",
0b00010000 : "NOTIFY",
0b00100000 : "INDICATE",
0b01000000 : "WRITE SIGNED",
0b10000000 : "EXTENDED PROPERTIES",
}
def __init__(self, *args):
(self.peripheral, uuidVal, self.handle, self.properties, self.valHandle) = args
self.uuid = UUID(uuidVal)
self.descs = None
def read(self):
return self.peripheral.readCharacteristic(self.valHandle)
def write(self, val, withResponse=False):
return self.peripheral.writeCharacteristic(self.valHandle, val, withResponse)
def getDescriptors(self, forUUID=None, hndEnd=0xFFFF):
if not self.descs:
# Descriptors (not counting the value descriptor) begin after
# the handle for the value descriptor and stop when we reach
# the handle for the next characteristic or service
self.descs = []
for desc in self.peripheral.getDescriptors(self.valHandle+1, hndEnd):
if desc.uuid in (0x2800, 0x2801, 0x2803):
# Stop if we reach another characteristic or service
break
self.descs.append(desc)
if forUUID is not None:
u = UUID(forUUID)
return [desc for desc in self.descs if desc.uuid == u]
return self.descs
def __str__(self):
return "Characteristic <%s>" % self.uuid.getCommonName()
def supportsRead(self):
if (self.properties & Characteristic.props["READ"]):
return True
else:
return False
def supportsNotify(self):
if (self.properties & Characteristic.props["NOTIFY"]):
return True
else:
return False
def propertiesToString(self):
propStr = ""
for p in Characteristic.propNames:
if (p & self.properties):
propStr += Characteristic.propNames[p] + " "
return propStr
def getHandle(self):
return self.valHandle
class Descriptor:
def __init__(self, *args):
(self.peripheral, uuidVal, self.handle) = args
self.uuid = UUID(uuidVal)
def __str__(self):
return "Descriptor <%s>" % self.uuid.getCommonName()
def read(self):
return self.peripheral.readCharacteristic(self.handle)
def write(self, val, withResponse=False):
self.peripheral.writeCharacteristic(self.handle, val, withResponse)
class DefaultDelegate:
def __init__(self):
pass
def handleNotification(self, cHandle, data):
DBG("Notification:", cHandle, "sent data", binascii.b2a_hex(data))
#ottenimento ora corrente
time = datetime.datetime.now()
print("\t\tora:",time)
time_formato_matlab = time.strftime ("%H%M%S.%f")
#occorre capire quale caratteristica è relativa alla notifica ricevuta
#se l'handle "cHandle" passato a handleNotification è quello corrispondente a temperatura e pressione
if (cHandle == handle_temp_press):
#salvataggio del pacchetto ricevuto in una variabile ausiliaria
temp_press_value = data
print("\t\tValore ricevuto temperatura e pressione: ",str(binascii.hexlify(temp_press_value), 'ascii').upper())
#scomposizione del pacchetto ricevuto in timestamp (2 byte), pressione (4 byte) e temperatura (2 byte)
timestamp1, pressione, temperatura = unpack('<Hlh', temp_press_value)
print ("\t\tTimestamp: {}\n\t\tPressione: {} mbar\n\t\tTemperatura: {} °C".format(timestamp1, pressione/100, temperatura/10))
try:
file_temp_press_matlab = open(nome_file_temp_press_matlab, 'a+')
file_temp_press_matlab.write("{}\t{}\t{}\t{}\n".format(timestamp1, time_formato_matlab, pressione/100, temperatura/10))
file_temp_press_matlab.close()
except IOError:
print ("Errore di I/O sul file.")
#se l'handle "cHandle" passato a handleNotification è quello corrispondente a accelerometro, giroscopio e magnetometro
if (cHandle == handle_acc_gyr_magn):
#salvataggio del pacchetto ricevuto in una variabile ausiliaria
acc_gyr_magn_value = data
print("\t\tValore ricevuto accelerometro, giroscopio e magnetometro: ",str(binascii.hexlify(acc_gyr_magn_value), 'ascii').upper())
#scomposizione del pacchetto ricevuto in timestamp (2 byte), accelerometro, giroscopio e magnetometro
#sui tre assi (2 byte con segno per ogni asse)
timestamp2, acc_x, acc_y, acc_z, gyr_x, gyr_y, gyr_z, magn_x, magn_y, magn_z = unpack('<Hhhhhhhhhh', acc_gyr_magn_value)
#decodifica dei dati
#accelerometro (unità di misura: g) con fondo scala +/- 2 g e poichè ricevuti dal bluetooth in mg divido per 1000 per trovare g
acc_x = acc_x / 1000
acc_y = acc_y / 1000
acc_z = acc_z / 1000
#dati del giroscopio (unità di misura: dps) da dividere per 10 secondo il file "Getting started with the BlueST protocol and SDK.pdf"
#perchè sono ricevuti in decimi di grado divido per 10 per trovare i gradi
#fondo scala +/- 2000 dps
gyr_x = gyr_x / 10
gyr_y = gyr_y / 10
gyr_z = gyr_z / 10
#magnetometro (unità di misura: μT) con range +/- 50 Gauss e fondo scala pari a ??????,
#i dati ricevuti sono espressi in milligauss, poichè 1 G = 100 μT, i valori sono infine moltiplicati per 100 ed espressi in μT
#fondo scala +/- 50 gauss
magn_x = magn_x / 1000 * 100
magn_y = magn_y / 1000 * 100
magn_z = magn_z / 1000 * 100
print("\t\tTimestamp: {}\n\t\tAccx: {} g\n\t\tAccy: {} g\n\t\tAccz: {} g\n\t\tGyrx: {} dps\n\t\tGyry: {} dps\n\t\tGyrz: {} dps\n\t\tMagnx: {} μT\n\t\tMagny: {} μT\n\t\tMagnz: {} μT\n"
.format(timestamp2, acc_x, acc_y, acc_z, gyr_x, gyr_y, gyr_z, magn_x, magn_y, magn_z))
#apertura dei file necessari a MATLAB
try:
file_accelerometro_matlab = open (nome_file_accelerometro_matlab, 'a+')
file_giroscopio_matlab = open (nome_file_giroscopio_matlab, 'a+')
file_magnetometro_matlab = open (nome_file_magnetometro_matlab, 'a+')
#scrittura dei file necessari a MATLAB
file_accelerometro_matlab.write ("{}\t{}\t{}\t{}\t{}\n".format(timestamp2, time_formato_matlab, acc_x, acc_y, acc_z))
file_giroscopio_matlab.write ("{}\t{}\t{}\t{}\t{}\n".format(timestamp2, time_formato_matlab, gyr_x, gyr_y, gyr_z))
file_magnetometro_matlab.write ("{}\t{}\t{}\t{}\t{}\n".format(timestamp2, time_formato_matlab, magn_x, magn_y, magn_z))
#chiusura dei file necessari a MATLAB
file_accelerometro_matlab.close()
file_giroscopio_matlab.close()
file_magnetometro_matlab.close()
except IOError:
print ("Errore di I/O sul file.")
#se l'handle "cHandle" passato a handleNotification è quello corrispondente al sensor fusion compact
if (cHandle == handle_sensor_fusion_compact):
#salvataggio del pacchetto ricevuto in una variabile ausiliaria
sensor_fusion_compact = data
print("\t\tValore ricevuto sensor fusion compact: ",str(binascii.hexlify(sensor_fusion_compact), 'ascii').upper())
#scomposizione del pacchetto ricevuto in timestamp (2 byte) e altri 9 dati da 2 byte ciascuno secondo il file "Getting started with the BlueST protocol and SDK.pdf"
timestamp3, qi1, qj1, qk1, qi2, qj2, qk2, qi3, qj3, qk3 = unpack('<Hhhhhhhhhh', sensor_fusion_compact)
#decodifica dei dati secondo il file "Getting started with the BlueST protocol and SDK.pdf"
qi1 = qi1 / 10000
qj1 = qj1 / 10000
qk1 = qk1 / 10000
qi2 = qi2 / 10000
qj2 = qj2 / 10000
qk2 = qk2 / 10000
qi3 = qi3 / 10000
qj3 = qj3 / 10000
qk3 = qk3 / 10000
print("\t\tTimestamp: {}\n\t\tQi1: {} \n\t\tQj1: {} \n\t\tQk1: {} \n\t\tQi2: {} \n\t\tQj2: {} \n\t\tQk2: {} \n\t\tQi3: {} \n\t\tQj3: {} \n\t\tQk3: {} \n\t\t"
.format(timestamp3, qi1,qj1,qk1, qi2, qj2, qk2, qi3, qj3, qk3))
#scrittura sul file che registra i dati del sensor fusion necessari a MATLAB
try:
file_sensor_fusion = open(nome_file_sensor_fusion_matlab, 'a+')
file_sensor_fusion.write("{}\t{}\t{}\t{}\t{}\t{}\t{}\t{}\t{}\t{}\t{}\n".format(timestamp3, time_formato_matlab, qi1,qj1,qk1, qi2, qj2, qk2, qi3, qj3, qk3))
file_sensor_fusion.close()
except IOError:
print ("Errore di I/O sul file.")
#se l'handle "cHandle" passato a handleNotification è quello corrispondente al sensor fusion compact
if (cHandle == handle_pitch_roll):
#salvataggio del pacchetto ricevuto in una variabile ausiliaria
newvalue = data
print("\t\tValore ricevuto caratteristica pitch e roll: ",str(binascii.hexlify(newvalue), 'ascii').upper())
#scomposizione del pacchetto ricevuto in timestamp (2 byte) e altri 2 dati da 2 byte ciascuno secondo il file "Getting started with the BlueST protocol and SDK.pdf"
timestamp4, pitch, roll = unpack('<Hhh', newvalue)
#conversione da radianti a gradi
pitch = pitch / 8192 * 180 / math.pi
roll = roll / 8192 * 180 / math.pi
print("\t\tTimestamp: {}\n\t\tPitch: {} °\n\t\tRoll: {} °\n\t\t".format(timestamp4, pitch, roll))
#scrittura sul file che registra i dati del pitch e roll necessari a MATLAB
try:
file_pitch_roll = open(nome_file_pitch_roll_matlab, 'a+')
file_pitch_roll.write("{}\t{}\t{}\t{}\n".format(timestamp4, time_formato_matlab, pitch, roll))
file_pitch_roll.close()
except IOError:
print ("Errore di I/O sul file.")
def handleDiscovery(self, scanEntry, isNewDev, isNewData):
DBG("Discovered device", scanEntry.addr)
class ScanDelegate(DefaultDelegate): #bluepy functions which receive Bluetooth messages asynchronously
#- such as notifications, indications, and advertising data - pass this information
#to the user by calling methods on a ‘delegate’ object.
def __init__(self): #To be useful, the delegate object will be from a class created by the user.
#Bluepy’s DefaultDelegate is a base class for this - you should override some or
#all of the methods here with your own application-specific code.
DefaultDelegate.__init__(self)
def handleDiscovery(self, dev, isNewDev, isNewData): #handleDiscovery is an instance method called when advertising data is received from an LE
#device while a Scanner object is active.
if isNewDev: #isNewDev is true if the device (as identified by its MAC address) has not been seen before by the scanner
if (dev.addr == devAddr):
print ("Trovato nuovo dispositivo con mac-address: ", dev.addr)
elif isNewData: #isNewData is true if new or updated advertising data is available.
if (dev.addr == devAddr):
print("Nuovi dati ricevuti dal dispositivo con mac-address: ", dev.addr)
class BluepyHelper:
def __init__(self):
self._helper = None
self._poller = None
self._stderr = None
self.delegate = DefaultDelegate()
def withDelegate(self, delegate_):
self.delegate = delegate_
return self
def _startHelper(self,iface=None):
if self._helper is None:
DBG("Running ", helperExe)
self._stderr = open(os.devnull, "w")
args=[helperExe]
if iface is not None: args.append(str(iface))
self._helper = subprocess.Popen(args,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=self._stderr,
universal_newlines=True,
preexec_fn = preexec_function)
self._poller = select.poll()
self._poller.register(self._helper.stdout, select.POLLIN)
def _stopHelper(self):
if self._helper is not None:
DBG("Stopping ", helperExe)
self._poller.unregister(self._helper.stdout)
self._helper.stdin.write("quit\n")
self._helper.stdin.flush()
self._helper.wait()
self._helper = None
if self._stderr is not None:
self._stderr.close()
self._stderr = None
def _writeCmd(self, cmd):
if self._helper is None:
raise BTLEInternalError("Helper not started (did you call connect()?)")
DBG("Sent: ", cmd)
self._helper.stdin.write(cmd)
self._helper.stdin.flush()
def _mgmtCmd(self, cmd):
self._writeCmd(cmd + '\n')
rsp = self._waitResp('mgmt')
if rsp['code'][0] != 'success':
self._stopHelper()
raise BTLEManagementError("Failed to execute management command '%s'" % (cmd), rsp)
@staticmethod
def parseResp(line):
resp = {}
for item in line.rstrip().split('\x1e'):
(tag, tval) = item.split('=')
if len(tval)==0:
val = None
elif tval[0]=="$" or tval[0]=="'":
# Both symbols and strings as Python strings
val = tval[1:]
elif tval[0]=="h":
val = int(tval[1:], 16)
elif tval[0]=='b':
val = binascii.a2b_hex(tval[1:].encode('utf-8'))
else:
raise BTLEInternalError("Cannot understand response value %s" % repr(tval))
if tag not in resp:
resp[tag] = [val]
else:
resp[tag].append(val)
return resp
def _waitResp(self, wantType, timeout=None):
while True:
if self._helper.poll() is not None:
raise BTLEInternalError("Helper exited")
if timeout:
fds = self._poller.poll(timeout*1000)
if len(fds) == 0:
DBG("Select timeout")
return None
rv = self._helper.stdout.readline()
DBG("Got:", repr(rv))
if rv.startswith('#') or rv == '\n' or len(rv)==0:
continue
resp = BluepyHelper.parseResp(rv)
if 'rsp' not in resp:
raise BTLEInternalError("No response type indicator", resp)
respType = resp['rsp'][0]
if respType in wantType:
return resp
elif respType == 'stat':
if 'state' in resp and len(resp['state']) > 0 and resp['state'][0] == 'disc':
self._stopHelper()
raise BTLEDisconnectError("Device disconnected", resp)
elif respType == 'err':
errcode=resp['code'][0]
if errcode=='nomgmt':
raise BTLEManagementError("Management not available (permissions problem?)", resp)
elif errcode=='atterr':
raise BTLEGattError("Bluetooth command failed", resp)
else:
raise BTLEException("Error from bluepy-helper (%s)" % errcode, resp)
elif respType == 'scan':
# Scan response when we weren't interested. Ignore it
continue
else:
raise BTLEInternalError("Unexpected response (%s)" % respType, resp)
def status(self):
self._writeCmd("stat\n")
return self._waitResp(['stat'])
class Peripheral(BluepyHelper):
def __init__(self, deviceAddr=None, addrType=ADDR_TYPE_PUBLIC, iface=None):
BluepyHelper.__init__(self)
self._serviceMap = None # Indexed by UUID
(self.deviceAddr, self.addrType, self.iface) = (None, None, None)
if isinstance(deviceAddr, ScanEntry):
self._connect(deviceAddr.addr, deviceAddr.addrType, deviceAddr.iface)
elif deviceAddr is not None:
self._connect(deviceAddr, addrType, iface)
def setDelegate(self, delegate_): # same as withDelegate(), deprecated
return self.withDelegate(delegate_)
def __enter__(self):
return self
def __exit__(self, type, value, traceback):
self.disconnect()
def _getResp(self, wantType, timeout=None):
if isinstance(wantType, list) is not True:
wantType = [wantType]
while True:
resp = self._waitResp(wantType + ['ntfy', 'ind'], timeout)
if resp is None:
return None
respType = resp['rsp'][0]
if respType == 'ntfy' or respType == 'ind':
hnd = resp['hnd'][0]
data = resp['d'][0]
if self.delegate is not None:
self.delegate.handleNotification(hnd, data)
if respType not in wantType:
continue
return resp
def _connect(self, addr, addrType=ADDR_TYPE_PUBLIC, iface=None):
if len(addr.split(":")) != 6:
raise ValueError("Expected MAC address, got %s" % repr(addr))
if addrType not in (ADDR_TYPE_PUBLIC, ADDR_TYPE_RANDOM):
raise ValueError("Expected address type public or random, got {}".format(addrType))
self._startHelper(iface)
self.addr = addr
self.addrType = addrType
self.iface = iface
if iface is not None:
self._writeCmd("conn %s %s %s\n" % (addr, addrType, "hci"+str(iface)))
else:
self._writeCmd("conn %s %s\n" % (addr, addrType))
rsp = self._getResp('stat')
while rsp['state'][0] == 'tryconn':
rsp = self._getResp('stat')
if rsp['state'][0] != 'conn':
self._stopHelper()
raise BTLEDisconnectError("Failed to connect to peripheral %s, addr type: %s" % (addr, addrType), rsp)
def connect(self, addr, addrType=ADDR_TYPE_PUBLIC, iface=None):
if isinstance(addr, ScanEntry):
self._connect(addr.addr, addr.addrType, addr.iface)
elif addr is not None:
self._connect(addr, addrType, iface)
def disconnect(self):
if self._helper is None:
return
# Unregister the delegate first
self.setDelegate(None)
self._writeCmd("disc\n")
self._getResp('stat')
self._stopHelper()
def discoverServices(self):
self._writeCmd("svcs\n")
rsp = self._getResp('find')
starts = rsp['hstart']
ends = rsp['hend']
uuids = rsp['uuid']
nSvcs = len(uuids)
assert(len(starts)==nSvcs and len(ends)==nSvcs)
self._serviceMap = {}
for i in range(nSvcs):
self._serviceMap[UUID(uuids[i])] = Service(self, uuids[i], starts[i], ends[i])
return self._serviceMap
def getState(self):
status = self.status()
return status['state'][0]
@property
def services(self):
if self._serviceMap is None:
self._serviceMap = self.discoverServices()
return self._serviceMap.values()
def getServices(self):
return self.services
def getServiceByUUID(self, uuidVal):
uuid = UUID(uuidVal)
if self._serviceMap is not None and uuid in self._serviceMap:
return self._serviceMap[uuid]
self._writeCmd("svcs %s\n" % uuid)
rsp = self._getResp('find')
if 'hstart' not in rsp:
raise BTLEGattError("Service %s not found" % (uuid.getCommonName()), rsp)
svc = Service(self, uuid, rsp['hstart'][0], rsp['hend'][0])
if self._serviceMap is None:
self._serviceMap = {}
self._serviceMap[uuid] = svc
return svc
def _getIncludedServices(self, startHnd=1, endHnd=0xFFFF):
# TODO: No working example of this yet
self._writeCmd("incl %X %X\n" % (startHnd, endHnd))
return self._getResp('find')
def getCharacteristics(self, startHnd=1, endHnd=0xFFFF, uuid=None):
cmd = 'char %X %X' % (startHnd, endHnd)
if uuid:
cmd += ' %s' % UUID(uuid)
self._writeCmd(cmd + "\n")
rsp = self._getResp('find')
nChars = len(rsp['hnd'])
return [Characteristic(self, rsp['uuid'][i], rsp['hnd'][i],
rsp['props'][i], rsp['vhnd'][i])
for i in range(nChars)]
def getDescriptors(self, startHnd=1, endHnd=0xFFFF):
self._writeCmd("desc %X %X\n" % (startHnd, endHnd) )
# Historical note:
# Certain Bluetooth LE devices are not capable of sending back all
# descriptors in one packet due to the limited size of MTU. So the
# guest needs to check the response and make retries until all handles
# are returned.
# In bluez 5.25 and later, gatt_discover_desc() in attrib/gatt.c does the retry
# so bluetooth_helper always returns a full list.
# This was broken in earlier versions.
resp = self._getResp('desc')
ndesc = len(resp['hnd'])
return [Descriptor(self, resp['uuid'][i], resp['hnd'][i]) for i in range(ndesc)]
def readCharacteristic(self, handle):
self._writeCmd("rd %X\n" % handle)
resp = self._getResp('rd')
return resp['d'][0]
def _readCharacteristicByUUID(self, uuid, startHnd, endHnd):
# Not used at present
self._writeCmd("rdu %s %X %X\n" % (UUID(uuid), startHnd, endHnd))
return self._getResp('rd')
def writeCharacteristic(self, handle, val, withResponse=False):
# Without response, a value too long for one packet will be truncated,
# but with response, it will be sent as a queued write
cmd = "wrr" if withResponse else "wr"
self._writeCmd("%s %X %s\n" % (cmd, handle, binascii.b2a_hex(val).decode('utf-8')))
return self._getResp('wr')
def setSecurityLevel(self, level):
self._writeCmd("secu %s\n" % level)
return self._getResp('stat')
def unpair(self):
self._mgmtCmd("unpair")
def pair(self):
self._mgmtCmd("pair")
def setMTU(self, mtu):
self._writeCmd("mtu %x\n" % mtu)
return self._getResp('stat')
def waitForNotifications(self, timeout):
resp = self._getResp(['ntfy','ind'], timeout)
return (resp != None)
def _setRemoteOOB(self, address, address_type, oob_data, iface=None):
if self._helper is None:
self._startHelper(iface)
self.addr = address
self.addrType = address_type
self.iface = iface
cmd = "remote_oob " + address + " " + address_type
if oob_data['C_192'] is not None and oob_data['R_192'] is not None:
cmd += " C_192 " + oob_data['C_192'] + " R_192 " + oob_data['R_192']
if oob_data['C_256'] is not None and oob_data['R_256'] is not None:
cmd += " C_256 " + oob_data['C_256'] + " R_256 " + oob_data['R_256']
if iface is not None:
cmd += " hci"+str(iface)
self._writeCmd(cmd)
def setRemoteOOB(self, address, address_type, oob_data, iface=None):
if len(address.split(":")) != 6:
raise ValueError("Expected MAC address, got %s" % repr(address))
if address_type not in (ADDR_TYPE_PUBLIC, ADDR_TYPE_RANDOM):
raise ValueError("Expected address type public or random, got {}".format(address_type))
if isinstance(address, ScanEntry):
return self._setOOB(address.addr, address.addrType, oob_data, address.iface)
elif address is not None:
return self._setRemoteOOB(address, address_type, oob_data, iface)
def getLocalOOB(self, iface=None):
if self._helper is None:
self._startHelper(iface)
self.iface = iface
self._writeCmd("local_oob\n")
if iface is not None:
cmd += " hci"+str(iface)
resp = self._getResp('oob')
if resp is not None:
data = resp.get('d', [''])[0]
if data is None:
raise BTLEManagementError(
"Failed to get local OOB data.")
if ord(data[0]) != 8 or ord(data[1]) != 0x1b:
raise BTLEManagementError(
"Malformed local OOB data (address).")
address = data[2:8]
address_type = data[8:9]
if ord(data[9]) != 2 or ord(data[10]) != 0x1c:
raise BTLEManagementError(
"Malformed local OOB data (role).")
role = data[11:12]
if ord(data[12]) != 17 or ord(data[13]) != 0x22:
raise BTLEManagementError(
"Malformed local OOB data (confirm).")
confirm = data[14:30]
if ord(data[30]) != 17 or ord(data[31]) != 0x23:
raise BTLEManagementError(
"Malformed local OOB data (random).")
random = data[32:48]
if ord(data[48]) != 2 or ord(data[49]) != 0x1:
raise BTLEManagementError(
"Malformed local OOB data (flags).")
flags = data[50:51]
return {'Address' : ''.join(["%02X" % ord(c) for c in address]),
'Type' : ''.join(["%02X" % ord(c) for c in address_type]),
'Role' : ''.join(["%02X" % ord(c) for c in role]),
'C_256' : ''.join(["%02X" % ord(c) for c in confirm]),
'R_256' : ''.join(["%02X" % ord(c) for c in random]),
'Flags' : ''.join(["%02X" % ord(c) for c in flags]),
}
def __del__(self):
self.disconnect()
class ScanEntry:
addrTypes = { 1 : ADDR_TYPE_PUBLIC,
2 : ADDR_TYPE_RANDOM
}
FLAGS = 0x01
INCOMPLETE_16B_SERVICES = 0x02
COMPLETE_16B_SERVICES = 0x03
INCOMPLETE_32B_SERVICES = 0x04
COMPLETE_32B_SERVICES = 0x05
INCOMPLETE_128B_SERVICES = 0x06
COMPLETE_128B_SERVICES = 0x07
SHORT_LOCAL_NAME = 0x08
COMPLETE_LOCAL_NAME = 0x09
TX_POWER = 0x0A
SERVICE_SOLICITATION_16B = 0x14
SERVICE_SOLICITATION_32B = 0x1F
SERVICE_SOLICITATION_128B = 0x15
SERVICE_DATA_16B = 0x16
SERVICE_DATA_32B = 0x20
SERVICE_DATA_128B = 0x21
PUBLIC_TARGET_ADDRESS = 0x17
RANDOM_TARGET_ADDRESS = 0x18
APPEARANCE = 0x19
ADVERTISING_INTERVAL = 0x1A
MANUFACTURER = 0xFF
dataTags = {
FLAGS : 'Flags',
INCOMPLETE_16B_SERVICES : 'Incomplete 16b Services',
COMPLETE_16B_SERVICES : 'Complete 16b Services',
INCOMPLETE_32B_SERVICES : 'Incomplete 32b Services',
COMPLETE_32B_SERVICES : 'Complete 32b Services',
INCOMPLETE_128B_SERVICES : 'Incomplete 128b Services',
COMPLETE_128B_SERVICES : 'Complete 128b Services',
SHORT_LOCAL_NAME : 'Short Local Name',
COMPLETE_LOCAL_NAME : 'Complete Local Name',
TX_POWER : 'Tx Power',
SERVICE_SOLICITATION_16B : '16b Service Solicitation',
SERVICE_SOLICITATION_32B : '32b Service Solicitation',
SERVICE_SOLICITATION_128B : '128b Service Solicitation',
SERVICE_DATA_16B : '16b Service Data',
SERVICE_DATA_32B : '32b Service Data',
SERVICE_DATA_128B : '128b Service Data',
PUBLIC_TARGET_ADDRESS : 'Public Target Address',
RANDOM_TARGET_ADDRESS : 'Random Target Address',
APPEARANCE : 'Appearance',
ADVERTISING_INTERVAL : 'Advertising Interval',
MANUFACTURER : 'Manufacturer',
}
def __init__(self, addr, iface):
self.addr = addr
self.iface = iface
self.addrType = None
self.rssi = None
self.connectable = False
self.rawData = None
self.scanData = {}
self.updateCount = 0
def _update(self, resp):
addrType = self.addrTypes.get(resp['type'][0], None)
if (self.addrType is not None) and (addrType != self.addrType):
raise BTLEInternalError("Address type changed during scan, for address %s" % self.addr)
self.addrType = addrType
self.rssi = -resp['rssi'][0]
self.connectable = ((resp['flag'][0] & 0x4) == 0)
data = resp.get('d', [''])[0]
self.rawData = data
# Note: bluez is notifying devices twice: once with advertisement data,
# then with scan response data. Also, the device may update the
# advertisement or scan data
isNewData = False
while len(data) >= 2:
sdlen, sdid = struct.unpack_from('<BB', data)
val = data[2 : sdlen + 1]
if (sdid not in self.scanData) or (val != self.scanData[sdid]):
isNewData = True
self.scanData[sdid] = val
data = data[sdlen + 1:]
self.updateCount += 1
return isNewData
def _decodeUUID(self, val, nbytes):
if len(val) < nbytes:
return None
bval=bytearray(val)
rs=""
# Bytes are little-endian; convert to big-endian string
for i in range(nbytes):
rs = ("%02X" % bval[i]) + rs
return UUID(rs)
def _decodeUUIDlist(self, val, nbytes):
result = []
for i in range(0, len(val), nbytes):
if len(val) >= (i+nbytes):
result.append(self._decodeUUID(val[i:i+nbytes],nbytes))
return result
def getDescription(self, sdid):
return self.dataTags.get(sdid, hex(sdid))
def getValue(self, sdid):
val = self.scanData.get(sdid, None)
if val is None:
return None
if sdid in [ScanEntry.SHORT_LOCAL_NAME, ScanEntry.COMPLETE_LOCAL_NAME]:
try:
# Beware! Vol 3 Part C 18.3 doesn't give an encoding. Other references
# to 'local name' (e.g. vol 3 E, 6.23) suggest it's UTF-8 but in practice
# devices sometimes have garbage here. See #259, #275, #292.
return val.decode('utf-8')
except UnicodeDecodeError:
bbval = bytearray(val)
return ''.join( [ (chr(x) if (x>=32 and x<=127) else '?') for x in bbval ] )
elif sdid in [ScanEntry.INCOMPLETE_16B_SERVICES, ScanEntry.COMPLETE_16B_SERVICES]:
return self._decodeUUIDlist(val,2)
elif sdid in [ScanEntry.INCOMPLETE_32B_SERVICES, ScanEntry.COMPLETE_32B_SERVICES]:
return self._decodeUUIDlist(val,4)
elif sdid in [ScanEntry.INCOMPLETE_128B_SERVICES, ScanEntry.COMPLETE_128B_SERVICES]:
return self._decodeUUIDlist(val,16)
else:
return val
def getValueText(self, sdid):
val = self.getValue(sdid)
if val is None:
return None
if sdid in [ScanEntry.SHORT_LOCAL_NAME, ScanEntry.COMPLETE_LOCAL_NAME]:
return val
elif isinstance(val, list):
return ','.join(str(v) for v in val)
else:
return binascii.b2a_hex(val).decode('ascii')
def getScanData(self):
'''Returns list of tuples [(tag, description, value)]'''
return [ (sdid, self.getDescription(sdid), self.getValueText(sdid))
for sdid in self.scanData.keys() ]
class Scanner(BluepyHelper):
def __init__(self,iface=0):
BluepyHelper.__init__(self)
self.scanned = {}
self.iface=iface
self.passive=False
def _cmd(self):
return "pasv" if self.passive else "scan"
def start(self, passive=False):
self.passive = passive
self._startHelper(iface=self.iface)
self._mgmtCmd("le on")
self._writeCmd(self._cmd()+"\n")
rsp = self._waitResp("mgmt")
if rsp["code"][0] == "success":
return
# Sometimes previous scan still ongoing
if rsp["code"][0] == "busy":
self._mgmtCmd(self._cmd()+"end")
rsp = self._waitResp("stat")
assert rsp["state"][0] == "disc"
self._mgmtCmd(self._cmd())
def stop(self):
self._mgmtCmd(self._cmd()+"end")
self._stopHelper()
def clear(self):
self.scanned = {}
def process(self, timeout=10.0):
if self._helper is None:
raise BTLEInternalError(
"Helper not started (did you call start()?)")
start = time.time()
while True:
if timeout:
remain = start + timeout - time.time()
if remain <= 0.0:
break
else:
remain = None
resp = self._waitResp(['scan', 'stat'], remain)
if resp is None:
break
respType = resp['rsp'][0]
if respType == 'stat':
# if scan ended, restart it
if resp['state'][0] == 'disc':
self._mgmtCmd(self._cmd())
elif respType == 'scan':
# device found
addr = binascii.b2a_hex(resp['addr'][0]).decode('utf-8')
addr = ':'.join([addr[i:i+2] for i in range(0,12,2)])
if addr in self.scanned:
dev = self.scanned[addr]
else:
dev = ScanEntry(addr, self.iface)
self.scanned[addr] = dev
isNewData = dev._update(resp)
if self.delegate is not None:
self.delegate.handleDiscovery(dev, (dev.updateCount <= 1), isNewData)
else:
raise BTLEInternalError("Unexpected response: " + respType, resp)
def getDevices(self):
return self.scanned.values()
def scan(self, timeout=10, passive=False):
self.clear()
self.start(passive=passive)
self.process(timeout)
self.stop()
return self.getDevices()