summaryrefslogtreecommitdiffstats
path: root/glucometerutils/drivers/fsprecisionneo.py
blob: 909fed8af79be8660966c30892744b1e50b6b80d (plain) (blame)
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
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for FreeStyle Precision Neo devices.

This driver may also work with FreeStyle Optium Neo devices, but it is currently
untested.

Supported features:
    - get readings;
    - get and set date and time;
    - get serial number and software version;
    - get and set patient name.

Expected device path: /dev/hidraw9 or similar HID device. Optional when using
HIDAPI.

Further information on the device protocol can be found at

https://protocols.glucometers.tech/abbott/freestyle-precision-neo

"""

import collections
import datetime

from glucometerutils import common
from glucometerutils.support import freestyle

# The type is a string because it precedes the parsing of the object.
_TYPE_GLUCOSE_READING = "7"
_TYPE_KETONE_READING = "9"

_NeoReading = collections.namedtuple(
    "_NeoReading",
    (
        "type",  # 7 = blood glucose, 9 = blood ketone
        "id",
        "month",
        "day",
        "year",  # year is two-digits
        "hour",
        "minute",
        "unknown2",
        "value",
        # Extra trailing and so-far-unused fields; so discard them:
        # * for blood glucose: 10 unknown trailing fields
        #'unknown3', 'unknown4', 'unknown5', 'unknown6', 'unknown7',
        #'unknown8', 'unknown9', 'unknown10', 'unknown11', 'unknown12',
        # * for blood ketone: 2 unknown trailing fields
        #'unknown3', 'unknown4',
    ),
)


class Device(freestyle.FreeStyleHidDevice):
    """Glucometer driver for FreeStyle Precision Neo devices."""

    USB_PRODUCT_ID = 0x3850

    def get_meter_info(self):
        """Return the device information in structured form."""
        return common.MeterInfo(
            "FreeStyle Precision Neo",
            serial_number=self.get_serial_number(),
            version_info=("Software version: " + self._get_version(),),
            native_unit=self.get_glucose_unit(),
            patient_name=self.get_patient_name(),
        )

    def get_glucose_unit(self):  # pylint: disable=no-self-use
        """Returns the glucose unit of the device."""
        return common.Unit.MG_DL

    def get_readings(self):
        """Iterate through the reading records in the device."""
        for record in self._get_multirecord(b"$result?"):
            cls = None
            if record and record[0] == _TYPE_GLUCOSE_READING:
                cls = common.GlucoseReading
            elif record and record[0] == _TYPE_KETONE_READING:
                cls = common.KetoneReading
            else:
                continue

            # Build a _reading object by parsing each of the entries in the raw
            # record
            values = []
            for value in record:
                if value == "HI":
                    value = float("inf")
                values.append(int(value))
            raw_reading = _NeoReading._make(values[: len(_NeoReading._fields)])

            timestamp = datetime.datetime(
                raw_reading.year + 2000,
                raw_reading.month,
                raw_reading.day,
                raw_reading.hour,
                raw_reading.minute,
            )

            if record and record[0] == _TYPE_KETONE_READING:
                value = freestyle.convert_ketone_unit(raw_reading.value)
            else:
                value = raw_reading.value

            yield cls(timestamp, value)

    def zero_log(self):
        raise NotImplementedError