freestyle-hid-1.0.0

25 files changed, 1589 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0817712
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+#
+# SPDX-License-Identifier: 0BSD
+
+*~
+*.pyc
+*.so
+/*.egg-info/
+/.vscode/settings.json
+/build/
+/dist/
+/venv
+/src/*.c
diff --git a/.mergify.yml b/.mergify.yml
new file mode 100644
index 0000000..929e63b
--- /dev/null
+++ b/.mergify.yml
@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: 0BSD
+
+pull_request_rules:
+  - name: Automatic merge on approval
+    conditions:
+      - "#approved-reviews-by>=1"
+      - "status-success=Travis CI - Pull Request"
+      - "status-success=pre-commit"
+    actions:
+      merge:
+        method: rebase
+  - name: Automatic merge from Flameeyes
+    conditions:
+      - "author=Flameeyes"
+      - "status-success=Travis CI - Pull Request"
+      - "status-success=pre-commit"
+    actions:
+      merge:
+        method: rebase
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..d2e03ea
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: 0BSD
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.5.1
+    hooks:
+      - id: isort
+        additional_dependencies:
+          - toml
+-   repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    - id: black
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.3
+    hooks:
+    - id: flake8
+-   repo: https://github.com/fsfe/reuse-tool
+    rev: latest
+    hooks:
+    - id: reuse
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..a537672
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# This is the list of freestyle-hid authors for copyright purposes.
+#
+# This does not necessarily list everyone who has contributed code, since in
+# some cases, their employer may be the copyright holder.  To see the full list
+# of contributors, see the revision history in source control.
+Anders Hammarquist
+Andreas Sandberg
+André Caldas
+Arkadiusz Bulski
+Benjamin Schäfer
+Christos Arvanitis
+Diego Elio Pettenò
+Dorian Scholz
+Jim Sifferle
+L. Guruprasad
+Leonard Lausen
+Mathieu Grivois
+Muhammad Kaisar Arkhan
+Naokazu Terada
+Noel Cragg
+Red Daly
+Ryan Jarvis
+Samuel Martin
+Warren Moore
+Wesley T. Honeycutt
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/LICENSES/0BSD.txt b/LICENSES/0BSD.txt
new file mode 100644
index 0000000..e9d84ae
--- /dev/null
+++ b/LICENSES/0BSD.txt
@@ -0,0 +1,12 @@
+Copyright (C) 2006 by Rob Landley <rob@landley.net>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt
new file mode 100644
index 0000000..527a83a
--- /dev/null
+++ b/LICENSES/Apache-2.0.txt
@@ -0,0 +1,208 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION,
+AND DISTRIBUTION
+
+   1. Definitions.
+
+
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution
+as defined by Sections 1 through 9 of this document.
+
+
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct
+or indirect, to cause the direction or management of such entity, whether
+by contract or otherwise, or (ii) ownership of fifty percent (50%) or more
+of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions
+granted by this License.
+
+
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that
+is included in or attached to the work (an example is provided in the Appendix
+below).
+
+
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative
+Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative
+Works thereof, that is intentionally submitted to Licensor for inclusion in
+the Work by the copyright owner or by an individual or Legal Entity authorized
+to submit on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication
+sent to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor
+for the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently incorporated
+within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable copyright license to reproduce, prepare
+Derivative Works of, publicly display, publicly perform, sublicense, and distribute
+the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License,
+each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Work, where such license applies only to those patent claims
+licensable by such Contributor that are necessarily infringed by their Contribution(s)
+alone or by combination of their Contribution(s) with the Work to which such
+Contribution(s) was submitted. If You institute patent litigation against
+any entity (including a cross-claim or counterclaim in a lawsuit) alleging
+that the Work or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such litigation
+is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and
+in Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source
+form of the Work, excluding those notices that do not pertain to any part
+of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy
+of the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part
+of the Derivative Works; within the Source form or documentation, if provided
+along with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works
+that You distribute, alongside or as an addendum to the NOTICE text from the
+Work, provided that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction,
+or distribution of Your modifications, or for any such Derivative Works as
+a whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without
+any additional terms or conditions. Notwithstanding the above, nothing herein
+shall supersede or modify the terms of any separate license agreement you
+may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to
+in writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR
+A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness
+of using or redistributing the Work and assume any risks associated with Your
+exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether
+in tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to
+in writing, shall any Contributor be liable to You for damages, including
+any direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the possibility
+of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such obligations,
+You may act only on Your own behalf and on Your sole responsibility, not on
+behalf of any other Contributor, and only if You agree to indemnify, defend,
+and hold each Contributor harmless for any liability incurred by, or claims
+asserted against, such Contributor by reason of your accepting any such warranty
+or additional liability. END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own identifying
+information. (Don't include the brackets!) The text should be enclosed in
+the appropriate comment syntax for the file format. We also recommend that
+a file or class name and description of purpose be included on the same "printed
+page" as the copyright notice for easier identification within third-party
+archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+
+you may not use this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+
+distributed under the License is distributed on an "AS IS" BASIS,
+
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+See the License for the specific language governing permissions and
+
+limitations under the License.
diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt
new file mode 100644
index 0000000..204b93d
--- /dev/null
+++ b/LICENSES/MIT.txt
@@ -0,0 +1,19 @@
+MIT License Copyright (c) <year> <copyright holders>
+
+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 (including the next
+paragraph) 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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d991f02
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+<!--
+SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Python library to interact with Abbott FreeStyle devices
+
+This repository includes a library and some tools to interact with Abbott
+FreeStyle devices that use their
+[shared HID protocol](https://protocols.glucometers.tech/abbott/shared-hid-protocol.html).
+
+## Tools
+
+There are a number of tools that interact with either the devices or with
+USB session captures that are installed together when selecting the `tools`
+extra:
+
+ * `freestyle-hid-console` allows sending direct text messages to a compatible
+   device on the console;
+ * `freestyle-extract-chatter` can produce a "chatter" file based on a capture
+   of an USB session, either from Linux or Windows.
+ * `freestyle-encrypted-setup-extract` is an experimental tool to extract the
+   encryption parameters of devices using the encrypted protocol (e.g. Libre2).
+
+## Development
+
+If you want to contribute code, please note that the target language
+is Python 3.7, and that the style to follow is for the most part PEP8
+compatible.
+
+To set up your development environment follow these guidelines:
+
+```shell
+$ git clone https://github.com/glucometers-tech/freestyle-hid.git
+$ cd glucometerutils
+$ python3 -m venv --python=python3.7
+$ . venv/bin/activate
+$ pip install -e .[dev,tools]
+$ pre-commit install
+```
diff --git a/data/known-commands.txt b/data/known-commands.txt
new file mode 100644
index 0000000..be3f9f0
--- /dev/null
+++ b/data/known-commands.txt
@@ -0,0 +1,48 @@
+$getrmndrst,0
+$getrmndr,0
+$rmdstrorder?
+$actthm?
+$wktrend?
+$gunits?
+$clktyp?
+$alllang?
+$lang?
+$inslock?
+$actinscal?
+$iobstatus?
+$foodunits?
+$svgsdef?
+$corsetup?
+$insdose?
+$inslog?
+$inscalsetup?
+$carbratio?
+$svgsratio?
+$mlcalget,3
+$cttype?
+$bgdrop?
+$bgtrgt?
+$bgtgrng?
+$ntsound?
+$btsound?
+$custthm?
+$taglang?
+$tagsenbl?
+$tagorder?
+$result?
+$gettags,2,2
+$frststrt?
+$marketlev?
+$brandname?
+$uom?
+$temp?
+$cksm?
+$vrom?
+$sn?
+$serlnum?
+$history?
+$ptname?
+$swver?
+$date?
+$time?
+$ptid?
diff --git a/data/known-commands.txt.license b/data/known-commands.txt.license
new file mode 100644
index 0000000..cb8b1db
--- /dev/null
+++ b/data/known-commands.txt.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+
+SPDX-License-Identifier: 0BSD
diff --git a/freestyle_hid/__init__.py b/freestyle_hid/__init__.py
new file mode 100644
index 0000000..41dce11
--- /dev/null
+++ b/freestyle_hid/__init__.py
@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: © 2020 The freestyle-hid Authors
+# SPDX-License-Identifier: Apache-2.0
+
+from ._exceptions import *  # noqa: F403,F401
+from ._session import Session  # noqa: F403,F401
diff --git a/freestyle_hid/_exceptions.py b/freestyle_hid/_exceptions.py
new file mode 100644
index 0000000..38a822d
--- /dev/null
+++ b/freestyle_hid/_exceptions.py
@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: © 2020 The freestyle-hid Authors
+# SPDX-License-Identifier: Apache-2.0
+
+
+class HIDError(Exception):
+    """Errors related to the HID access process."""
+
+
+class ConnectionError(Exception):
+    """Errors related to Session establishment."""
+
+
+class ChecksumError(Exception):
+    """Errors related to the transmission checksums."""
+
+
+class CommandError(Exception):
+    """Errors related to the command stream."""
diff --git a/freestyle_hid/_hidwrapper.py b/freestyle_hid/_hidwrapper.py
new file mode 100644
index 0000000..a82bd4c
--- /dev/null
+++ b/freestyle_hid/_hidwrapper.py
@@ -0,0 +1,66 @@
+# SPDX-FileCopyrightText: © 2020 The freestyle-hid Authors
+# SPDX-License-Identifier: Apache-2.0
+"""HID wrappers to access files with either hidraw or cython-hidapi."""
+
+import abc
+import pathlib
+from typing import BinaryIO, Optional, Union
+
+try:
+    import hid
+except ImportError:
+    hid = None
+
+from ._exceptions import HIDError
+
+
+class HidWrapper(abc.ABC):
+
+    _handle: Union[BinaryIO, "hid.device"]
+
+    def write(self, report: bytes) -> None:
+        if len(report) > 65:
+            raise HIDError(f"Invalid report length {len(report)}.")
+
+        written = self._handle.write(report)
+        if written < 0:
+            raise HIDError(f"Invalid write ({written}).")
+
+    @abc.abstractmethod
+    def read(self, size: int = 64) -> bytes:
+        pass
+
+    @staticmethod
+    def open(
+        device_path: Optional[pathlib.Path], vendor_id: int, product_id: Optional[int]
+    ) -> "HidWrapper":
+        if device_path:
+            return HidRaw(device_path)
+        else:
+            assert product_id is not None
+            return HidApi(vendor_id, product_id)
+
+
+class HidRaw(HidWrapper):
+    def __init__(self, device_path: pathlib.Path) -> None:
+        if not device_path.exists():
+            raise ValueError(f"Path {device_path} does not exists.")
+
+        self._handle = device_path.open("w+b")
+
+    def read(self, size: int = 64) -> bytes:
+        return self._handle.read(size)
+
+
+class HidApi(HidWrapper):
+    _handle: "hid.device"
+
+    def __init__(self, vendor_id: int, product_id: int) -> None:
+        if hid is None:
+            raise ValueError("cython-hidapi not found.")
+
+        self._handle = hid.device()
+        self._handle.open(vendor_id, product_id)
+
+    def read(self, size: int = 64) -> bytes:
+        return bytes(self._handle.read(size, timeout_ms=0))
diff --git a/freestyle_hid/_session.py b/freestyle_hid/_session.py
new file mode 100644
index 0000000..7529ef3
--- /dev/null
+++ b/freestyle_hid/_session.py
@@ -0,0 +1,264 @@
+# SPDX-FileCopyrightText: © 2013 The freestyle-hid Authors
+# SPDX-License-Identifier: Apache-2.0
+
+import csv
+import logging
+import pathlib
+import re
+from typing import AnyStr, Callable, Iterator, Optional, Sequence, Tuple
+
+import construct
+
+from ._exceptions import ChecksumError, CommandError
+from ._hidwrapper import HidWrapper
+
+ABBOTT_VENDOR_ID = 0x1A61
+
+_INIT_COMMAND = 0x01
+_INIT_RESPONSE = 0x71
+
+_KEEPALIVE_RESPONSE = 0x22
+_UNKNOWN_MESSAGE_RESPONSE = 0x30
+
+_ENCRYPTION_SETUP_COMMAND = 0x14
+_ENCRYPTION_SETUP_RESPONSE = 0x33
+
+_ALWAYS_UNENCRYPTED_MESSAGES = (
+    _INIT_COMMAND,
+    0x04,
+    0x05,
+    0x06,
+    0x0C,
+    0x0D,
+    _ENCRYPTION_SETUP_COMMAND,
+    0x15,
+    _ENCRYPTION_SETUP_RESPONSE,
+    0x34,
+    0x35,
+    _INIT_RESPONSE,
+    _KEEPALIVE_RESPONSE,
+)
+
+
+def _create_matcher(
+    message_type: int, content: Optional[bytes]
+) -> Callable[[Tuple[int, bytes]], bool]:
+    def _matcher(message: Tuple[int, bytes]) -> bool:
+        return message[0] == message_type and (content is None or content == message[1])
+
+    return _matcher
+
+
+_is_init_reply = _create_matcher(_INIT_RESPONSE, b"\x01")
+_is_keepalive_response = _create_matcher(_KEEPALIVE_RESPONSE, None)
+_is_unknown_message_error = _create_matcher(_UNKNOWN_MESSAGE_RESPONSE, b"\x85")
+_is_encryption_missing_error = _create_matcher(_ENCRYPTION_SETUP_RESPONSE, b"\x15")
+_is_encryption_setup_error = _create_matcher(_ENCRYPTION_SETUP_RESPONSE, b"\x14")
+
+_FREESTYLE_MESSAGE = construct.Struct(
+    hid_report=construct.Const(0, construct.Byte),
+    message_type=construct.Byte,
+    command=construct.Padded(
+        63,  # command can only be up to 62 bytes, but one is used for length.
+        construct.Prefixed(construct.Byte, construct.GreedyBytes),
+    ),
+)
+
+_FREESTYLE_ENCRYPTED_MESSAGE = construct.Struct(
+    hid_report=construct.Const(0, construct.Byte),
+    message_type=construct.Byte,
+    command=construct.Padded(
+        63,  # command can only be up to 62 bytes, but one is used for length.
+        construct.GreedyBytes,
+    ),
+)
+
+_TEXT_COMPLETION_RE = re.compile(b"CMD (?:OK|Fail!)")
+_TEXT_REPLY_FORMAT = re.compile(
+    b"^(?P<message>.*)CKSM:(?P<checksum>[0-9A-F]{8})\r\n"
+    b"CMD (?P<status>OK|Fail!)\r\n$",
+    re.DOTALL,
+)
+
+_MULTIRECORDS_FORMAT = re.compile(
+    "^(?P<message>.+\r\n)(?P<count>[0-9]+),(?P<checksum>[0-9A-F]{8})\r\n$", re.DOTALL
+)
+
+
+def _verify_checksum(message: AnyStr, expected_checksum_hex: AnyStr) -> None:
+    """Calculate the simple checksum of the message and compare with expected.
+
+    Args:
+      message: (str) message to calculate the checksum of.
+      expected_checksum_hex: hexadecimal string representing the checksum
+        expected to match the message.
+
+    Raises:
+      InvalidChecksum: if the message checksum calculated does not match the one
+        received.
+    """
+    expected_checksum = int(expected_checksum_hex, 16)
+    if isinstance(message, bytes):
+        all_bytes = (c for c in message)
+    else:
+        all_bytes = (ord(c) for c in message)
+
+    calculated_checksum = sum(all_bytes)
+
+    if expected_checksum != calculated_checksum:
+        raise ChecksumError(
+            f"Invalid checksum, expected {expected_checksum}, calculated {calculated_checksum}"
+        )
+
+
+class Session:
+    def __init__(
+        self,
+        product_id: Optional[int],
+        device_path: Optional[pathlib.Path],
+        text_message_type: int,
+        text_reply_message_type: int,
+    ) -> None:
+        self._handle = HidWrapper.open(device_path, ABBOTT_VENDOR_ID, product_id)
+
+        self._text_message_type = text_message_type
+        self._text_reply_message_type = text_reply_message_type
+
+    def connect(self):
+        """Open connection to the device, starting the knocking sequence."""
+        self.send_command(_INIT_COMMAND, b"")
+        response = self.read_response()
+        if not _is_init_reply(response):
+            raise ConnectionError(
+                f"Connection error: unexpected message %{response[0]:02x}:{response[1].hex()}"
+            )
+
+    def send_command(self, message_type: int, command: bytes, encrypted: bool = False):
+        """Send a raw command to the device.
+
+        Args:
+          message_type: The first byte sent with the report to the device.
+          command: The command to send out the device.
+        """
+        if encrypted:
+            assert message_type not in _ALWAYS_UNENCRYPTED_MESSAGES
+            meta_construct = _FREESTYLE_ENCRYPTED_MESSAGE
+        else:
+            meta_construct = _FREESTYLE_MESSAGE
+
+        usb_packet = meta_construct.build(
+            {"message_type": message_type, "command": command}
+        )
+
+        logging.debug(f"Sending packet: {usb_packet!r}")
+        self._handle.write(usb_packet)
+
+    def read_response(self, encrypted: bool = False) -> Tuple[int, bytes]:
+        """Read the response from the device and extracts it."""
+        usb_packet = self._handle.read()
+
+        logging.debug(f"Read packet: {usb_packet!r}")
+
+        assert usb_packet
+        message_type = usb_packet[0]
+
+        if not encrypted or message_type in _ALWAYS_UNENCRYPTED_MESSAGES:
+            message_length = usb_packet[1]
+            message_end_idx = 2 + message_length
+            message_content = usb_packet[2:message_end_idx]
+        else:
+            message_content = usb_packet[1:]
+
+        # hidapi module returns a list of bytes rather than a bytes object.
+        message = (message_type, bytes(message_content))
+
+        # There appears to be a stray number of 22 01 xx messages being returned
+        # by some devices after commands are sent. These do not appear to have
+        # meaning, so ignore them and proceed to the next. These are always sent
+        # unencrypted, so we need to inspect them before we decide what the
+        # message content is.
+        if _is_keepalive_response(message):
+            return self.read_response(encrypted=encrypted)
+
+        if _is_unknown_message_error(message):
+            raise CommandError("Invalid command")
+
+        if _is_encryption_missing_error(message):
+            raise CommandError("Device encryption not initialized.")
+
+        if _is_encryption_setup_error(message):
+            raise CommandError("Device encryption initialization failed.")
+
+        return message
+
+    def send_text_command(self, command: bytes) -> str:
+        """Send a command to the device that expects a text reply."""
+        self.send_command(self._text_message_type, command)
+
+        # Reply can stretch multiple buffers
+        full_content = b""
+        while True:
+            message_type, content = self.read_response()
+
+            logging.debug(
+                f"Received message: type {message_type:02x} content {content.hex()}"
+            )
+
+            if message_type != self._text_reply_message_type:
+                raise CommandError(
+                    f"Message type {message_type:02x}: content does not match expectations: {content!r}"
+                )
+
+            full_content += content
+
+            if _TEXT_COMPLETION_RE.search(full_content):
+                break
+
+        match = _TEXT_REPLY_FORMAT.search(full_content)
+        if not match:
+            raise CommandError(repr(full_content))
+
+        message = match.group("message")
+        _verify_checksum(message, match.group("checksum"))
+
+        if match.group("status") != b"OK":
+            raise CommandError(repr(message) or "Command failed")
+
+        # If there is anything in the response that is not ASCII-safe, this is
+        # probably in the patient name. The Windows utility does not seem to
+        # validate those, so just replace anything non-ASCII with the correct
+        # unknown codepoint.
+        return message.decode("ascii", "replace")
+
+    def query_multirecord(self, command: bytes) -> Iterator[Sequence[str]]:
+        """Queries for, and returns, "multirecords" results.
+
+        Multirecords are used for querying events, readings, history and similar
+        other data out of a FreeStyle device. These are comma-separated values,
+        variable-length.
+
+        The validation includes the general HID framing parsing, as well as
+        validation of the record count, and of the embedded records checksum.
+
+        Args:
+          command: The text command to send to the device for the query.
+
+        Returns:
+          A CSV reader object that returns a record for each line in the
+          reply buffer.
+        """
+        message = self.send_text_command(command)
+        logging.debug(f"Received multirecord message:\n{message}")
+        if message == "Log Empty\r\n":
+            return iter(())
+
+        match = _MULTIRECORDS_FORMAT.search(message)
+        if not match:
+            raise CommandError(message)
+
+        records_str = match.group("message")
+        _verify_checksum(records_str, match.group("checksum"))
+
+        logging.debug(f"Received multi-record string: {records_str}")
+
+        return csv.reader(records_str.split("\r\n"))
diff --git a/freestyle_hid/py.typed b/freestyle_hid/py.typed
new file mode 100644
index 0000000..311e481
--- /dev/null
+++ b/freestyle_hid/py.typed
@@ -0,0 +1,2 @@
+# SPDX-FileCopyrightText: © 2020 The freestyle-hid Authors
+# SPDX-License-Identifier: Apache-2.0
diff --git a/freestyle_hid/tools/__init__.py b/freestyle_hid/tools/__init__.py
new file mode 100644
index 0000000..3e0558f
--- /dev/null
+++ b/freestyle_hid/tools/__init__.py
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: 0BSD
diff --git a/freestyle_hid/tools/encrypted_setup_extractor.py b/freestyle_hid/tools/encrypted_setup_extractor.py
new file mode 100644
index 0000000..dfe8229
--- /dev/null
+++ b/freestyle_hid/tools/encrypted_setup_extractor.py
@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+#
+# SPDX-FileCopyrightText: © 2019 The usbmon-tools Authors
+# SPDX-FileCopyrightText: © 2019 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+import sys
+from typing import BinaryIO, Sequence
+
+import click
+import click_log
+import construct
+import usbmon
+import usbmon.pcapng
+
+logger = logging.getLogger()
+click_log.basic_config(logger)
+
+
+_SERIAL_NUMBER_RESPONSE_TYPE = 0x06
+_ENCRYPTION_SETUP_REQ_TYPE = 0x14
+_ENCRYPTION_SETUP_RESP_TYPE = 0x33
+
+
+_START_AUTHORIZE_CMD = 0x11
+_CHALLENGE_CMD = 0x16
+_CHALLENGE_RESPONSE_CMD = 0x17
+
+
+_ABBOTT_VENDOR_ID = 0x1A61
+_LIBRE2_PRODUCT_ID = 0x3950
+
+_SERIAL_NO = construct.Struct(
+    message_type=construct.Const(_SERIAL_NUMBER_RESPONSE_TYPE, construct.Byte),
+    length=construct.Const(14, construct.Byte),
+    serial_number=construct.PaddedString(13, "ascii"),
+    termination=construct.Const(0, construct.Byte),
+)
+
+_CHALLENGE = construct.Struct(
+    message_type=construct.Const(_ENCRYPTION_SETUP_RESP_TYPE, construct.Byte),
+    length=construct.Const(16, construct.Byte),
+    subcmd=construct.Const(_CHALLENGE_CMD, construct.Byte),
+    challenge=construct.Bytes(8),
+    iv=construct.Bytes(7),
+)
+
+_CHALLENGE_RESPONSE = construct.Struct(
+    message_type=construct.Const(_ENCRYPTION_SETUP_REQ_TYPE, construct.Byte),
+    length=construct.Const(26, construct.Byte),
+    subcmd=construct.Const(_CHALLENGE_RESPONSE_CMD, construct.Byte),
+    challenge_response_encrypted=construct.Bytes(16),
+    const=construct.Const(1, construct.Byte),
+    mac=construct.Bytes(8),
+)
+
+
+@click.command()
+@click_log.simple_verbosity_option(logger, "--vlog")
+@click.option(
+    "--device-address",
+    help=(
+        "Device address (busnum.devnum) of the device to extract capture"
+        " of. If none provided, device descriptors will be relied on."
+    ),
+)
+@click.argument(
+    "pcap-files",
+    type=click.File(mode="rb"),
+    nargs=None,
+)
+def main(*, device_address: str, pcap_files: Sequence[BinaryIO]):
+    if sys.version_info < (3, 7):
+        raise Exception("Unsupported Python version, please use at least Python 3.7.")
+
+    for pcap_file in pcap_files:
+        session = usbmon.pcapng.parse_stream(pcap_file, retag_urbs=False)
+
+        if not device_address:
+            for descriptor in session.device_descriptors.values():
+                if (
+                    descriptor.vendor_id == _ABBOTT_VENDOR_ID
+                    and descriptor.product_id == _LIBRE2_PRODUCT_ID
+                ):
+                    if device_address and device_address != descriptor.address:
+                        raise Exception(
+                            "Multiple Libre2 devices present in capture, please"
+                            " provide a --device-address flag."
+                        )
+                    device_address = descriptor.address
+        else:
+            device_address = descriptor.address
+
+        if device_address in session.device_descriptors:
+            descriptor = session.device_descriptors[device_address]
+            assert descriptor.vendor_id == _ABBOTT_VENDOR_ID
+            assert descriptor.product_id == _LIBRE2_PRODUCT_ID
+
+        serial_number = "UNKNOWN"
+        challenge = "UNKNOWN"
+        iv = "UNKNOWN"
+        encrypted_challenge = "UNKNOWN"
+        mac = "UNKNOWN"
+
+        for first, second in session.in_pairs():
+            # Ignore stray callbacks/errors.
+            if not first.type == usbmon.constants.PacketType.SUBMISSION:
+                continue
+
+            if not first.address.startswith(f"{device_address}."):
+                # No need to check second, they will be linked.
+                continue
+
+            if first.xfer_type == usbmon.constants.XferType.INTERRUPT:
+                pass
+            elif (
+                first.xfer_type == usbmon.constants.XferType.CONTROL
+                and not first.setup_packet
+                or first.setup_packet.type == usbmon.setup.Type.CLASS  # type: ignore
+            ):
+                pass
+            else:
+                continue
+
+            if first.direction == usbmon.constants.Direction.OUT:
+                packet = first
+            else:
+                assert second is not None
+                packet = second
+
+            if not packet.payload:
+                continue
+
+            assert len(packet.payload) >= 2
+
+            message_type = packet.payload[0]
+
+            if message_type == _SERIAL_NUMBER_RESPONSE_TYPE:
+                obj = _SERIAL_NO.parse(packet.payload)
+                serial_number = obj.serial_number
+            elif (
+                message_type == _ENCRYPTION_SETUP_RESP_TYPE
+                and packet.payload[2] == _CHALLENGE_CMD
+            ):
+                obj = _CHALLENGE.parse(packet.payload)
+                challenge = obj.challenge.hex()
+                iv = obj.iv.hex()
+            elif (
+                message_type == _ENCRYPTION_SETUP_REQ_TYPE
+                and packet.payload[2] == _CHALLENGE_RESPONSE_CMD
+            ):
+                obj = _CHALLENGE_RESPONSE.parse(packet.payload)
+                encrypted_challenge = obj.challenge_response_encrypted.hex()
+                mac = obj.mac.hex()
+
+        print(f"{serial_number},{challenge},{iv},{encrypted_challenge},{mac}")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/freestyle_hid/tools/extract_chatter.py b/freestyle_hid/tools/extract_chatter.py
new file mode 100755
index 0000000..a77a0ec
--- /dev/null
+++ b/freestyle_hid/tools/extract_chatter.py
@@ -0,0 +1,233 @@
+#!/usr/bin/env python3
+#
+# SPDX-FileCopyrightText: © 2019 The usbmon-tools Authors
+# SPDX-FileCopyrightText: © 2020 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+import sys
+import textwrap
+from typing import BinaryIO
+
+import click
+import click_log
+import construct
+import usbmon
+import usbmon.chatter
+import usbmon.pcapng
+
+logger = logging.getLogger()
+click_log.basic_config(logger)
+
+_KEEPALIVE_TYPE = 0x22
+
+_UNENCRYPTED_TYPES = (
+    0x01,
+    0x04,
+    0x05,
+    0x06,
+    0x0C,
+    0x0D,
+    0x14,
+    0x15,
+    0x33,
+    0x34,
+    0x35,
+    0x71,
+    _KEEPALIVE_TYPE,
+)
+
+_ENCRYPTION_SETUP_TYPES = (0x14, 0x33)
+
+_START_AUTHORIZE_CMD = 0x11
+_CHALLENGE_CMD = 0x16
+_CHALLENGE_RESPONSE_CMD = 0x17
+_CHALLENGE_ACCEPTED_CMD = 0x18
+
+_ABBOTT_VENDOR_ID = 0x1A61
+_LIBRE2_PRODUCT_ID = 0x3950
+
+_ENCRYPTED_MESSAGE = construct.Struct(
+    message_type=construct.Byte,
+    encrypted_message=construct.Bytes(64 - 1 - 4 - 4),
+    sequence_number=construct.Int32ul,
+    mac=construct.Int32ul,
+)
+
+
+@click.command()
+@click_log.simple_verbosity_option(logger, "--vlog")
+@click.option(
+    "--device-address",
+    help=(
+        "Device address (busnum.devnum) of the device to extract capture"
+        " of. If none provided, device descriptors will be relied on."
+    ),
+)
+@click.option(
+    "--encrypted-protocol / --no-encrypted-protocol",
+    default=False,
+    help=(
+        "Whether to expect encrypted protocol in the capture."
+        " Ignored if the device descriptors are present in the capture."
+    ),
+)
+@click.option(
+    "--verbose-encryption-setup / --no-verbose-encryption-setup",
+    default=False,
+    help=(
+        "Whether to parse encryption setup commands and printing their component"
+        " together with the raw messsage."
+    ),
+)
+@click.option(
+    "--print-keepalive / --no-print-keepalive",
+    default=False,
+    help=(
+        "Whether to print the keepalive messages sent by the device. "
+        "Keepalive messages are usually safely ignored."
+    ),
+)
+@click.argument(
+    "pcap-file",
+    type=click.File(mode="rb"),
+)
+def main(
+    *,
+    device_address: str,
+    encrypted_protocol: bool,
+    verbose_encryption_setup: bool,
+    print_keepalive: bool,
+    pcap_file: BinaryIO,
+) -> None:
+    if sys.version_info < (3, 7):
+        raise Exception("Unsupported Python version, please use at least Python 3.7.")
+
+    session = usbmon.pcapng.parse_stream(pcap_file, retag_urbs=False)
+
+    if not device_address:
+        for descriptor in session.device_descriptors.values():
+            if descriptor.vendor_id == _ABBOTT_VENDOR_ID:
+                if device_address and device_address != descriptor.address:
+                    raise Exception(
+                        "Multiple Abbott device present in capture, please"
+                        " provide a --device-address flag."
+                    )
+                device_address = descriptor.address
+
+    if device_address not in session.device_descriptors:
+        logging.warning(
+            f"Unable to find device {device_address} in the capture's descriptors."
+            " Assuming non-encrypted protocol.",
+        )
+    else:
+        descriptor = session.device_descriptors[device_address]
+        assert descriptor.vendor_id == _ABBOTT_VENDOR_ID
+
+        if descriptor.product_id == _LIBRE2_PRODUCT_ID:
+            encrypted_protocol = True
+
+    for first, second in session.in_pairs():
+        # Ignore stray callbacks/errors.
+        if not first.type == usbmon.constants.PacketType.SUBMISSION:
+            continue
+
+        if not first.address.startswith(f"{device_address}."):
+            # No need to check second, they will be linked.
+            continue
+
+        if first.xfer_type == usbmon.constants.XferType.INTERRUPT:
+            pass
+        elif (
+            first.xfer_type == usbmon.constants.XferType.CONTROL
+            and not first.setup_packet
+            or first.setup_packet.type == usbmon.setup.Type.CLASS  # type: ignore
+        ):
+            pass
+        else:
+            continue
+
+        if first.direction == usbmon.constants.Direction.OUT:
+            packet = first
+        else:
+            assert second is not None
+            packet = second
+
+        if not packet.payload:
+            continue
+
+        assert len(packet.payload) >= 2
+
+        message_type = packet.payload[0]
+
+        if message_type == _KEEPALIVE_TYPE and not print_keepalive:
+            continue
+
+        message_metadata = []
+
+        if encrypted_protocol and message_type not in _UNENCRYPTED_TYPES:
+            # With encrypted communication, the length of the message is also encrypted,
+            # and all the packets use the full 64 bytes. So instead, we extract what
+            # metadata we can.
+            parsed = _ENCRYPTED_MESSAGE.parse(packet.payload)
+            message_metadata.extend(
+                [f"SEQUENCE_NUMBER={parsed.sequence_number}", f"MAC={parsed.mac:04x}"]
+            )
+
+            message_type_str = f"x{message_type:02x}"
+            message = parsed.encrypted_message
+        elif verbose_encryption_setup and message_type in _ENCRYPTION_SETUP_TYPES:
+            message_length = packet.payload[1]
+            message_end_idx = 2 + message_length
+            message = packet.payload[2:message_end_idx]
+
+            if message[0] == _START_AUTHORIZE_CMD:
+                message_metadata.append("START_AUTHORIZE")
+            elif message[0] == _CHALLENGE_CMD:
+                message_metadata.append("CHALLENGE")
+                challenge = message[1:9]
+                iv = message[9:16]
+                message_metadata.append(f"CHALLENGE={challenge.hex()}")
+                message_metadata.append(f"IV={iv.hex()}")
+            elif message[0] == _CHALLENGE_RESPONSE_CMD:
+                message_metadata.append("CHALLENGE_RESPONSE")
+                encrypted_challenge = message[1:17]
+                challenge_mac = message[18:26]
+                message_metadata.append(
+                    f"ENCRYPTED_CHALLENGE={encrypted_challenge.hex()}"
+                )
+                message_metadata.append(f"MAC={challenge_mac.hex()}")
+            elif message[0] == _CHALLENGE_ACCEPTED_CMD:
+                message_metadata.append("CHALLENGE_ACCEPTED")
+
+            message_metadata.append(f"RAW_LENGTH={message_length}")
+            message_type_str = f" {message_type:02x}"
+        else:
+            message_length = packet.payload[1]
+            message_metadata.append(f"LENGTH={message_length}")
+            message_end_idx = 2 + message_length
+            message_type_str = f" {message_type:02x}"
+            message = packet.payload[2:message_end_idx]
+
+        if message_metadata:
+            metadata_string = "\n".join(
+                textwrap.wrap(
+                    " ".join(message_metadata), width=80, break_long_words=False
+                )
+            )
+            print(metadata_string)
+
+        print(
+            usbmon.chatter.dump_bytes(
+                packet.direction,
+                message,
+                prefix=f"[{message_type_str}]",
+                print_empty=True,
+            ),
+            "\n",
+        )
+
+
+if __name__ == "__main__":
+    main()
diff --git a/freestyle_hid/tools/hid_console.py b/freestyle_hid/tools/hid_console.py
new file mode 100755
index 0000000..b3b3fee
--- /dev/null
+++ b/freestyle_hid/tools/hid_console.py
@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: © 2019 The freestyle-hid Authors
+# SPDX-License-Identifier: Apache-2.0
+"""CLI tool to send messages through FreeStyle HID protocol."""
+
+import logging
+import pathlib
+import sys
+from typing import Optional
+
+import click
+import click_log
+
+import freestyle_hid
+
+logger = logging.getLogger()
+click_log.basic_config(logger)
+
+
+@click.command()
+@click_log.simple_verbosity_option(logger, "--vlog")
+@click.option(
+    "--text-command-type",
+    "-c",
+    type=int,
+    default=0x60,
+    help="Message type for text commands sent to the device.",
+)
+@click.option(
+    "--text-reply-type",
+    "-r",
+    type=int,
+    default=0x60,
+    help="Message type for text replies received from the device.",
+)
+@click.option(
+    "--product-id",
+    "-p",
+    type=int,
+    help="Optional product ID (in alternative to the device path)",
+)
+@click.argument(
+    "device-path",
+    type=click.Path(exists=True, dir_okay=False, writable=True, allow_dash=False),
+    callback=lambda ctx, param, value: pathlib.Path(value) if value else None,
+    required=False,
+)
+def main(
+    *,
+    text_command_type: int,
+    text_reply_type: int,
+    product_id: Optional[int],
+    device_path: Optional[pathlib.Path],
+):
+    if not product_id and not device_path:
+        raise click.UsageError(
+            "One of --product-id or DEVICE_PATH need to be provided."
+        )
+
+    session = freestyle_hid.Session(
+        product_id, device_path, text_command_type, text_reply_type
+    )
+
+    session.connect()
+
+    while True:
+        if sys.stdin.isatty():
+            command = input(">>> ")
+        else:
+            command = input()
+            print(f">>> {command}")
+
+        try:
+            print(session.send_text_command(bytes(command, "ascii")))
+        except freestyle_hid.CommandError as error:
+            print(f"! {error!r}")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/freestyle_hid/tools/py.typed b/freestyle_hid/tools/py.typed
new file mode 100644
index 0000000..311e481
--- /dev/null
+++ b/freestyle_hid/tools/py.typed
@@ -0,0 +1,2 @@
+# SPDX-FileCopyrightText: © 2020 The freestyle-hid Authors
+# SPDX-License-Identifier: Apache-2.0
diff --git a/mypy.ini b/mypy.ini
new file mode 100644
index 0000000..50f219f
--- /dev/null
+++ b/mypy.ini
@@ -0,0 +1,15 @@
+; SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+;
+; SPDX-License-Identifier: 0BSD
+
+[mypy]
+python_version = 3.7
+
+[mypy-click_log]
+ignore_missing_imports = True
+
+[mypy-construct]
+ignore_missing_imports = True
+
+[mypy-hid]
+ignore_missing_imports = True
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..e6eedfe
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: 0BSD
+
+# NOTE: you have to use single-quoted strings in TOML for regular expressions.
+# It's the equivalent of r-strings in Python.  Multiline strings are treated as
+# verbose regular expressions by Black.  Use [ ] to denote a significant space
+# character.
+
+[build-system]
+requires = [
+  'setuptools >= 42',
+  'wheel',
+  'setuptools_scm[toml]>=3.4',
+]
+
+[tool.black]
+line-length = 88
+target-version = ['py37']
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+# These settings ensure that black and isort don't disagree on the imports.
+line_length = 88
+multi_line_output = 3
+include_trailing_comma = true
+
+known_first_party = ['glucometerutils']
+known_third_party = ['construct', 'hidapi', 'pyscsi', 'serial', 'usbmon']
+
+[tool.setuptools_scm]
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..0861c2a
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,60 @@
+# SPDX-FileCopyrightText: 2013 The freestyle-hid Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+[metadata]
+name = freestyle-hid
+description = Python implementation of the HID protocol used by Abbott FreeStyle devices
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/glucometers-tech/freestyle-hid
+author = Diego Elio Pettenò
+author_email = flameeyes@flameeyes.com
+license = Apache-2.0
+license_files =
+    AUTHORS
+    LICENSE
+    LICENSES/*
+classifiers =
+    Development Status :: 4 - Beta
+    Environment :: Console
+    Intended Audience :: Developers
+    Intended Audience :: Developers
+    License :: OSI Approved :: Apache Software License
+    Operating System :: OS Independent
+    Programming Language :: Python
+    Programming Language :: Python :: 3
+    Topic :: Scientific/Engineering :: Medical Science Apps.
+keywords =
+    glucometer
+    diabetes
+    freestyle
+    abbott
+
+[options]
+packages = find:
+install_requires =
+    construct
+python_requires = ~= 3.7
+
+[options.extras_require]
+hidapi =
+    hidapi
+tools =
+    click
+    click_log
+dev =
+    mypy
+    pre-commit
+    setuptools_scm
+
+[options.entry_points]
+console_scripts =
+    freestyle-hid-console = freestyle_hid.tools.hid_console:main [tools]
+    freestyle-encrypted-setup-extract = freestyle_hid.tools.encrypted_setup_extract:main [tools]
+    freestyle-extract-chatter = freestyle_hid.tools.extract_chatter:main [tools]
+
+[flake8]
+max-line-length = 88
+# Ignore long line errors, black takes care of them.
+extend-ignore = E501
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..f21ec9f
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+#
+# SPDX-FileCopyrightText: © 2013 The freestyle-hid Authors
+# SPDX-License-Identifier: 0BSD
+
+# Ensure it's present.
+import setuptools_scm  # noqa: F401
+from setuptools import setup
+
+setup()