File: tracker.py

package info (click to toggle)
galileo 0.5.1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 392 kB
  • ctags: 578
  • sloc: python: 3,462; xml: 23; makefile: 14
file content (346 lines) | stat: -rw-r--r-- 13,306 bytes parent folder | download | duplicates (2)
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
from ctypes import c_byte

import logging
logger = logging.getLogger(__name__)

from .dongle import CM, DM, isStatus
from .dump import Dump, DumpResponse
from .utils import a2s, a2x, i2lsba, a2lsbi

MICRODUMP = 3
MEGADUMP = 13


class Tracker(object):
    def __init__(self, Id, addrType, serviceData, RSSI, serviceUUID=None):
        self.id = Id
        self.addrType = addrType
        if serviceUUID is None:
            self.serviceUUID = a2lsbi([Id[1] ^ Id[3] ^ Id[5],
                                       Id[0] ^ Id[2] ^ Id[4]])
        else:
            self.serviceUUID = serviceUUID
        self.serviceData = serviceData
        # following three are coded somewhere here ...
        # specialMode
        # canDisplayNumber
        # colorCode
        self.RSSI = RSSI
        self.status = 'unknown'  # If we happen to read it before anyone set it

    @property
    def productId(self):
        return self.serviceData[0]

    @property
    def syncedRecently(self):
        return self.serviceData[1] != 4

    @classmethod
    def fromDiscovery(klass, data, minRSSI=-255):
        trackerId = data[:6]
        addrType = data[6]
        RSSI = c_byte(data[7]).value
        serviceDataLen = data[8]
        serviceData = data[9:9+serviceDataLen+1]  # '+1': go figure !
        sUUID = a2lsbi(data[15:17])
        serviceUUID = a2lsbi([trackerId[1] ^ trackerId[3] ^ trackerId[5],
                              trackerId[0] ^ trackerId[2] ^ trackerId[4]])
        tracker = klass(trackerId, addrType, serviceData, RSSI, sUUID)
        if not tracker.syncedRecently and (serviceUUID != sUUID):
            logger.debug("Cannot acknowledge the serviceUUID: %s vs %s",
                         a2x(i2lsba(serviceUUID, 2), ':'), a2x(i2lsba(sUUID, 2), ':'))
        logger.debug('Tracker: %s, %s, %s, %s', a2x(trackerId, ':'),
                     addrType, RSSI, a2x(serviceData, ':'))
        if RSSI < -80:
            logger.info("Tracker %s has low signal power (%ddBm), higher"
                        " chance of miscommunication",
                        a2x(trackerId, delim=""), RSSI)

        if not tracker.syncedRecently:
            logger.debug('Tracker %s was not recently synchronized',
                         a2x(trackerId, delim=""))
        if RSSI < minRSSI:
            logger.warning("Tracker %s below power threshold (%ddBm),"
                           "dropping", a2x(trackerId, delim=""), minRSSI)
            #continue
        return tracker


class FitbitClient(object):
    def __init__(self, dongle):
        self.dongle = dongle

    def disconnect(self):
        logger.info('Disconnecting from any connected trackers')

        self.dongle.ctrl_write(CM(2))
        if not isStatus(self.dongle.ctrl_read(), 'CancelDiscovery'):
            return False
        # Next one is not critical. It can happen that it does not comes
        isStatus(self.dongle.ctrl_read(), 'TerminateLink')

        self.exhaust()

        return True

    def exhaust(self):
        """ We exhaust the pipe, then we know that we have a clean state """
        logger.debug("Exhausting the communication pipe")
        goOn = True
        while goOn:
            goOn = self.dongle.ctrl_read() is not None

    def getDongleInfo(self):
        self.dongle.ctrl_write(CM(1))
        d = self.dongle.ctrl_read()
        if (d is None) or (d.INS != 8):
            return False
        self.dongle.setVersion(d.payload[0], d.payload[1])
        self.dongle.address = d.payload[2:8]
        self.dongle.flashEraseTime = a2lsbi(d.payload[8:10])
        self.dongle.firmwareStartAddress = a2lsbi(d.payload[10:14])
        self.dongle.firmwareEndAddress = a2lsbi(d.payload[14:18])
        self.dongle.ccIC = d.payload[18]
        # Not sure how the last ones fit in the last byte
#        self.dongle.hardwareRevision = d.payload[19]
#        self.dongle.revision = d.payload[19]
        return True

    def discover(self, uuid, service1=0xfb00, write=0xfb01, read=0xfb02,
                 minRSSI=-255, minDuration=4000):
        """\
        The uuid is a mask on the service (characteristics ?) we understand
        service1 parameter is unused (at lease for the 'One')
        read and write are the uuid of the characteristics we use for
        transmission and reception.
        """
        logger.debug('Discovering for UUID %s: %s', uuid,
                     ', '.join(hex(s) for s in (service1, write, read)))
        data = i2lsba(uuid.int, 16)
        for i in (service1, write, read, minDuration):
            data += i2lsba(i, 2)
        self.dongle.ctrl_write(CM(4, data))
        amount = 0
        while True:
            # Give the dongle 100ms margin
            d = self.dongle.ctrl_read(minDuration + 100)
            if d is None: break
            elif isStatus(d, None, False):
                # We know this can happen almost any time during 'discovery'
                logger.info('Ignoring message: %s' % a2s(d.payload))
                continue
            elif d.INS == 2:
                # Last instruction of a discovery sequence has INS==1
                break
            elif (d.INS != 3) or (len(d.payload) < 17):
                logger.error('payload unexpected: %s', d)
                break
            yield Tracker.fromDiscovery(d.payload, minRSSI)
            amount += 1

        if d != CM(2, [amount]):
            logger.error('%d trackers discovered, dongle says %s', amount, d)
        # tracker found, cancel discovery
        self.dongle.ctrl_write(CM(5))
        d = self.dongle.ctrl_read()
        if isStatus(d, 'StartDiscovery', False):
            # We had not received the 'StartDiscovery' yet
            d = self.dongle.ctrl_read()
        isStatus(d, 'CancelDiscovery')

    def setPowerLevel(self, level):
        # This is quite weird as in the log I took this from, they send:
        # 020D05 (level5), but as the length is 02, I believe the 05 is not
        # even acknowledged by the dongle ...
        self.dongle.ctrl_write(CM(0xd, [level]))
        r = self.dongle.ctrl_read()
        if r != CM(0xFE):
            return False
        return True

    def establishLink(self, tracker):
        if self.dongle.establishLinkEx:
            return self.establishLinkEx(tracker)
        self.dongle.ctrl_write(CM(6, tracker.id + [tracker.addrType] +
                                  i2lsba(tracker.serviceUUID, 2)))
        d = self.dongle.ctrl_read()
        if d == CM(0xff, [2, 3]):
            # Our detection based on the dongle version is not perfect :(
            logger.warning("Older tracker %d.%d also needs EstablishLinkEx",
                           self.dongle.major, self.dongle.minor)
            self.dongle.establishLinkEx = True
            return self.establishLinkEx(tracker)
        elif not isStatus(d, 'EstablishLink'):
            return False
        d = self.dongle.ctrl_read(5000)
        if d != CM(4, [0]):
            logger.error('Unexpected message: %s', d)
            return False
        # established, waiting for service discovery
        # - This one takes long
        if not isStatus(self.dongle.ctrl_read(8000),
                        'GAP_LINK_ESTABLISHED_EVENT'):
            return False
        # This one can also take some time (Charge tracker)
        d = self.dongle.ctrl_read(5000)
        if d != CM(7):
            logger.error('Unexpected 2nd message: %s', d)
            return False
        return True

    def establishLinkEx(self, tracker):
        """ First heard from in #236 """
        nums = [6, 6, 0, 200]  # Looks familiar ?
        data = tracker.id + [tracker.addrType]
        for n in nums:
            data.extend(i2lsba(n, 2))
        self.dongle.ctrl_write(CM(0x12, data))
        if not isStatus(self.dongle.ctrl_read(), 'EstablishLinkEx'):
            return False
        d = self.dongle.ctrl_read(5000)
        if d != CM(4, [0]):
            logger.error('Unexpected message: %s', d)
            return False
        if not isStatus(self.dongle.ctrl_read(),
                        'GAP_LINK_ESTABLISHED_EVENT'):
            return False
        d = self.dongle.ctrl_read()
        if d != CM(7):
            logger.error('Unexpected 2nd message: %s', d)
            return False
        return True

    def toggleTxPipe(self, on):
        """ `on` is a boolean that dictate the status of the pipe
        :returns: a boolean about the successful execution
        """
        self.dongle.ctrl_write(CM(8, [int(on)]))
        d = self.dongle.data_read(5000)
        return d == DM([0xc0, 0xb])

    def initializeAirlink(self, tracker=None):
        """ :returns: a boolean about the successful execution """
        nums = [10, 6, 6, 0, 200]
        #nums = [1, 8, 16, 0, 200]
        #nums = [1034, 6, 6, 0, 200]
        data = []
        for n in nums:
            data.extend(i2lsba(n, 2))
        #data = data + [1]
        self.dongle.data_write(DM([0xc0, 0xa] + data))
        if not self.dongle.establishLinkEx:
            # Not necessary when using establishLinkEx
            d = self.dongle.ctrl_read(10000)
            if d != CM(6, data[-6:]):
                logger.error("Unexpected message: %s != %s", d, CM(6, data[-6:]))
                return False
        d = self.dongle.data_read()
        if d is None:
            return False
        if d.data[:2] != [0xc0, 0x14]:
            logger.error("Wrong header: %s", a2x(d.data[:2]))
            return False
        if (tracker is not None) and (d.data[6:12] != tracker.id):
            logger.error("Connected to wrong tracker: %s", a2x(d.data[6:12]))
            return False
        logger.debug("Connection established: %d, %d",
                     a2lsbi(d.data[2:4]), a2lsbi(d.data[4:6]))
        return True

    def displayCode(self):
        """ :returns: a boolean about the successful execution """
        logger.debug('Displaying code on tracker')
        self.dongle.data_write(DM([0xc0, 6]))
        r = self.dongle.data_read()
        return (r is not None) and (r.data == [0xc0, 2])

    def getDump(self, dumptype=MEGADUMP):
        """ :returns: a `Dump` object or None """
        logger.debug('Getting dump type %d', dumptype)

        # begin dump of appropriate type
        self.dongle.data_write(DM([0xc0, 0x10, dumptype]))
        r = self.dongle.data_read()
        if r and (r.data[:3] != [0xc0, 0x41, dumptype]):
            logger.error("Tracker did not acknowledged the dump type: %s", r)
            return None

        dump = Dump(dumptype)
        # Retrieve the dump
        d = self.dongle.data_read()
        if d is None:
            return None
        dump.add(d.data)
        while d.data[0] != 0xc0:
            d = self.dongle.data_read()
            if d is None:
                return None
            dump.add(d.data)
        # Analyse the dump
        if not dump.isValid():
            logger.error('Dump not valid')
            return None
        logger.debug("Dump done, length %d, transportCRC=0x%04x, esc1=0x%02x,"
                     " esc2=0x%02x", dump.len, dump.crc.final(), dump.esc[0],
                     dump.esc[1])
        return dump

    def uploadResponse(self, response):
        """ 4 and 6 are magic values here ...
        :returns: a boolean about the success of the operation.
        """
        dumptype = 4  # ???
        self.dongle.data_write(DM([0xc0, 0x24, dumptype] + i2lsba(len(response), 6)))
        d = self.dongle.data_read()
        if d != DM([0xc0, 0x12, dumptype, 0, 0]):
            logger.error("Tracker did not acknowledged upload type: %s", d)
            return False

        CHUNK_LEN = 20
        response = DumpResponse(response, CHUNK_LEN)

        for i, chunk in enumerate(response):#range(0, len(response), CHUNK_LEN):
            self.dongle.data_write(DM(chunk))
            # This one can also take some time (Charge HR tracker)
            d = self.dongle.data_read(20000)
            expected = DM([0xc0, 0x13, (((i+1) % 16) << 4) + dumptype, 0, 0])
            if d != expected:
                logger.error("Wrong sequence number: %s, expected: %s", d, expected)
                return False

        self.dongle.data_write(DM([0xc0, 2]))
        # Next one can be very long. He is probably erasing the memory there
        d = self.dongle.data_read(60000)
        if d != DM([0xc0, 2]):
            logger.error("Unexpected answer from tracker: %s", d)
            return False

        return True

    def terminateAirlink(self):
        """ contrary to ``initializeAirlink`` """

        self.dongle.data_write(DM([0xc0, 1]))
        d = self.dongle.data_read()
        if d != DM([0xc0, 1]):
            return False
        return True

    def ceaseLink(self):
        """ contrary to ``establishLink`` """

        self.dongle.ctrl_write(CM(7))
        if not isStatus(self.dongle.ctrl_read(5000), 'TerminateLink'):
            return False

        d = self.dongle.ctrl_read(3000)
        if (d is None) or (d.INS != 5):
            # Payload can be either 0x16 or 0x08
            return False
        if not isStatus(self.dongle.ctrl_read(), 'GAP_LINK_TERMINATED_EVENT'):
            return False
        if not isStatus(self.dongle.ctrl_read()):
            # This one doesn't always return '22'
            return False
        return True