freestyle_libre 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fd9090a157f212434123eaf4a17440d39a2526c
+  data.tar.gz: b3de016be7a5cc7f85b04161db8311f3e039fc8f
+SHA512:
+  metadata.gz: e47787295efa0a27c8cc2ecf7ab49bba4ad295faf2e0cdac8d8f5c4d745d0196b7d34bf296bee1ec3734c9e598e91235f388ca5cc198496b7efe6ff7a5391182
+  data.tar.gz: 654aec7785ee02ab3c34705c95bf7a6d25d985f96749310df8dfe00736e5281e732851f3a1379ba057ba3e0a8466c885f705d53573a148ac4cb7079db97f4505

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+libre.export

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bert.bruynooghe@up-nxt.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'byebug'
+gem 'dotenv'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    freestyle_libre (0.1.0)
+      hidapi (~> 0.1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.6)
+    diff-lcs (1.2.5)
+    dotenv (2.1.1)
+    ffi (1.9.18)
+    hidapi (0.1.8)
+      i18n
+      libusb (~> 0.5.1)
+    i18n (0.8.1)
+    libusb (0.5.1)
+      ffi (>= 1.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  byebug
+  dotenv
+  freestyle_libre!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bert Bruynooghe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+* FreestyleLibre
+
+This is a gem the allows accessing Abbott's FreeStyle Libre data,
+both over USB and from the export file from the official Abbott application.
+
+It is based both on the splendid work of https://github.com/Flameeyes/glucometer-protocols, and https://github.com/barkerest/hidapi
+
+Implementation is not fully complete, but it already supports all glucose measurements, both manual and automatic.
+
+Documentation is following.
+
+** Testing
+
+* make sure you have a reader with at least some valid readings
+* create a .env file with `SERIAL` and `SWVER` (if you don't, the tests will fail and you read the values form the test results)
+* export data of your reader to `libre.export` and put the file in the root of the project
+* connect your reader
+* `bundle exec rspec`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freestyle_libre"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/freestyle_libre.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freestyle_libre/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freestyle_libre"
+  spec.version       = FreestyleLibre::VERSION
+  spec.authors       = ["Bert Bruynooghe"]
+  spec.email         = ["bert@bruyooghe-polet.com"]
+
+  spec.summary       = %q{Accessing the Abbot FreeStyle Libre reader through USB}
+  spec.homepage      = "https://github.com/bertBruynooghe/freestyle_libre"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "hidapi", "~>0.1.8"
+end

data/lib/freestyle_libre.rb

@@ -0,0 +1,8 @@
+require "hidapi"
+require "freestyle_libre/version"
+require "freestyle_libre/reader"
+require 'freestyle_libre/export_file_parse_results'
+require 'freestyle_libre/record'
+
+module FreestyleLibre
+end

data/lib/freestyle_libre/export_file_parse_results.rb

@@ -0,0 +1,66 @@
+module FreestyleLibre
+  class ExportFileParseResult
+    attr_reader :patient_name, :patient_id, :auto_measurements, :manual_measurements
+
+    def initialize(export_file_path)
+      @auto_measurements = []
+      @manual_measurements = []
+      @time_changes = []
+      parse_file(export_file_path)
+    end
+
+
+    private
+
+    def parse_file(export_file_path)
+      File.open(export_file_path, "r") do |f|
+        @patient_name = f.readline.strip
+        @patient_id = f.readline.strip[2..-1]
+        @columns = f.readline.strip.split("\t")
+        while !f.eof?
+          parse_line(f.readline)
+        end
+      end
+    end
+
+    def parse_line(line)
+      tokens = line.split("\t")
+      case tokens[2]
+      when '0'
+        insert_auto_measurement(tokens)
+      when '1'
+        insert_manual_measurement(tokens)
+      when '4'
+        # fast acting insulin
+      when '5'
+        # food non-numerid
+      when '6'
+        insert_time_change(tokens)
+      else
+        puts Hash[@columns.zip(tokens)]
+      end
+    end
+
+    def insert_time_change(tokens)
+    end
+
+    def insert_auto_measurement(tokens)
+      @auto_measurements << Record.new(id: tokens[0].to_i,
+               date_time: DateTime.strptime("#{tokens[1]}", '%Y-%m-%d %H:%M'),
+               first_sensor_reading: nil,
+               sensor_runtime_minutes: nil,
+               value: tokens[3].to_i,
+               errored: false,
+               error_code: "0")
+    end
+
+    def insert_manual_measurement(tokens)
+      @manual_measurements << Record.new(id: tokens[0].to_i,
+                                            type: "2",
+                                            date_time: DateTime.strptime("#{tokens[1]}", '%Y-%m-%d %H:%M'),
+                                            value: tokens[4].to_i
+                                            #errored: false)
+                                            )
+    end
+  end
+end

data/lib/freestyle_libre/reader.rb

@@ -0,0 +1,175 @@
+require 'ostruct'
+module FreestyleLibre
+  class Reader
+    VENDOR_ID = 0x1a61
+    PRODUCT_ID = 0x3650
+    INIT_COMMAND_SEQUENCE = [0x04, 0x05, 0x15, 0x1]
+
+    # @param interface [Number] The interface number of the device; needed in case you have several readers connected
+    def initialize(interface = nil)
+      HIDAPI::SetupTaskHelper.new(VENDOR_ID, PRODUCT_ID, "abbott-freestyle-libre", interface).run
+      @device = HIDAPI::open(VENDOR_ID, PRODUCT_ID, interface)
+      raise 'device could not be opened' unless @device
+
+      INIT_COMMAND_SEQUENCE.each do |c|
+        write_report(c, '')
+        read_report
+      end
+    end
+
+    def serial
+      write_report(0x60, '$sn?')
+      read_text_command.strip
+    end
+
+    def software_version
+      write_report(0x60, '$swver?')
+      read_text_command.strip
+    end
+
+    def date_time
+      write_report(0x60, '$date?')
+      date = read_text_command.strip
+      write_report(0x60, '$time?')
+      DateTime.strptime("#{date} #{read_text_command}", '%m,%d,%y %H,%M')
+    end
+
+    def date_time=(value)
+      write_report(0x60, "$date,#{value.strftime('%-m,%-d,%y')}")
+      read_text_command
+      write_report(0x60, "$time,#{value.strftime('%H,%M')}")
+      read_text_command
+    end
+
+    def patient_name=(value)
+      write_report(0x60, "$ptname,#{value}")
+      read_text_command
+    end
+
+    def patient_name
+      write_report(0x60, '$ptname?')
+      read_text_command.strip
+    end
+
+    def patient_id=(value)
+      write_report(0x60, "$ptid,#{value}")
+      read_text_command
+    end
+
+    def patient_id
+      write_report(0x60, '$ptid?')
+      read_text_command.strip
+    end
+
+    # latest record ID ???
+    def database_record_number
+      # TODO: not sure this matches the description.
+      # We should check that by scanning the tag two times and seeing that the number of new history
+      # matches the increase of this number
+      write_report(0x60, '$dbrnum?')
+      read_text_command.gsub('DB Record Number =', '').strip.to_i
+    end
+
+    # Automatic glucose measurements
+    def history
+      write_report(0x60, '$history?')
+      read_multi.map { |record| auto_measurement(record) }
+    end
+
+    # Manual measurements and date/time changes
+    # @return [Record]
+    def arresult
+      write_report(0x60, '$arresult?')
+      read_multi.map { |record| ar(record) }.compact
+    end
+
+    def close
+      @device.close
+    end
+
+    private
+
+    def ar(record)
+      fields = record.split(',').map(&:strip)
+      case fields[1]
+      when "2"
+        manual_measurement(fields)
+      end
+    end
+
+    def manual_measurement(fields)
+      Record.new(id: fields[0].to_i,
+                     type: fields[1],
+                     date_time: parse_date_time(fields[2...7]),
+                     value: fields[12].to_i,
+                     errored: fields[28].nil? || (fields[28].to_i & 0x8000) > 0,
+                     error_code: fields[28])
+    end
+
+    def auto_measurement(record)
+      fields = record.split(',').map(&:strip)
+      Record.new(id: fields[0].to_i,
+               date_time: parse_date_time(fields[2...7]),
+               first_sensor_reading: fields[12]== "1",
+               value: fields[13].to_i,
+               sensor_runtime_minutes: fields[14].to_i,
+               errored: fields[15].nil? || (fields[15].to_i & 0x8000) > 0,
+               error_code: fields[15])
+    end
+
+    def parse_date_time(fields)
+      DateTime.new(fields[2].to_i + 2000, fields[0].to_i, fields[1].to_i,
+                               fields[3].to_i, fields[4].to_i, fields[5].to_i)
+    end
+
+    def read_multi
+      msg = ""
+      while true
+        report = read_report
+        raise "unexpected message type 0x#{report[:msg_type].to_s(16)}" unless report[:msg_type] == 0x60
+        msg += report[:msg]
+        break if report[:msg].end_with?("CMD OK\r\n")
+      end
+      result = extract_text(msg).split("\r\n")
+      record_count, checksum = result.pop.split(',')
+      raise "wrong number of records: declared #{record_count}, got result.length" unless record_count.to_i == result.length
+      validate_checksum!(result.join("\r\n")+"\r\n", checksum.to_i(16))
+      result
+    end
+
+    def read_text_command
+      report = read_report
+      raise "unexpected message type 0x#{report[:msg_type].to_s(16)}" unless report[:msg_type] == 0x60
+      extract_text(report[:msg])
+    end
+
+    def extract_text(msg)
+      msg, status = msg.split('CMD ')
+      raise "*#{status}" unless status == "OK\r\n"
+      msg, checksum = msg.split('CKSM:')
+      validate_checksum!(msg, checksum.to_i(16))
+      msg
+    end
+
+    def validate_checksum!(msg, checksum)
+      raise "checksum failed" unless checksum = msg.bytes.reduce(0){ |m, b| m + b }
+    end
+
+    def read_report
+      reading = @device.read.bytes
+      msg_type = reading.shift
+      length = reading.shift
+      return read_report if msg_type == 0x22 && length == 0x1
+      msg = reading.pack('C*')[0...length]
+      while msg.length < length
+        msg += @device.read.pack('C*')[0...(length - msg.length)]
+      end
+      {msg_type: msg_type , msg: msg}
+    end
+
+    def write_report(cmd, value)
+      value = value.bytes
+      @device.write([0x00, cmd, value.length, *value, *Array.new(61-value.length, 0x00) ])
+    end
+  end
+end

data/lib/freestyle_libre/record.rb

@@ -0,0 +1,7 @@
+module FreestyleLibre
+  class Record < OpenStruct
+    def hash
+      id
+    end
+  end
+end

data/lib/freestyle_libre/version.rb

@@ -0,0 +1,3 @@
+module FreestyleLibre
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: freestyle_libre
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bert Bruynooghe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: hidapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+description: 
+email:
+- bert@bruyooghe-polet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freestyle_libre.gemspec
+- lib/freestyle_libre.rb
+- lib/freestyle_libre/export_file_parse_results.rb
+- lib/freestyle_libre/reader.rb
+- lib/freestyle_libre/record.rb
+- lib/freestyle_libre/version.rb
+homepage: https://github.com/bertBruynooghe/freestyle_libre
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Accessing the Abbot FreeStyle Libre reader through USB
+test_files: []