From 46804ae9f17233cc2055a7f03eaac3c85ca0d52b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Elio=20Petten=C3=B2?= Date: Mon, 17 Apr 2017 17:15:10 +0100 Subject: All drivers: move documentation of features from README to docstring. This allows the drivers to keep up to date with what they support and need. Should make Issue #9 easier to solve. Also merge the dependency list with the list of supported devices, so that you don't have to join the two tables in your head. --- README | 50 +++++++++++++------------------------------------- 1 file changed, 13 insertions(+), 37 deletions(-) (limited to 'README') diff --git a/README b/README index 050dcaa..d5085b7 100644 --- a/README +++ b/README @@ -19,43 +19,19 @@ Please see the following table for the driver for each device that is known and supported; the following table will provide further information on each of the devices. -| Manufacturer | Model Name | Driver | -| --- | --- | --- | -| LifeScan | OneTouch Ultra 2 | `otultra2` | -| LifeScan | OneTouch Ultra Easy | `otultraeasy` | -| LifeScan | OneTouch Ultra Mini | `otultraeasy` | -| LifeScan | OneTouch Verio (USB) | `otverio2015` | -| LifeScan | OneTouch Select Plus | `otverio2015` | -| Abbott | FreeStyle InsuLinx | `fsinsulinx` | -| Abbott | FreeStyle Libre | `fslibre` | -| Abbott | FreeStyle Optium | `fsoptium` | -| Abbott | FreeStyle Precision Neo | `fsprecisionneo` | -| Roche | Accu-Chek Mobile | `accuchek_reports` | -| SD Biosensor | SD CodeFree | `sdcodefree` | - -### Driver features - -| Driver | Information | Time | Record comments | Memory Reset | -| --- | --- | --- | --- | --- | -| `otultra2` | serialno, swver, unit | get and set | yes | yes | -| `otultraeasy` | serialno, swver, unit | get and set | not supported by device | yes | -| `otverio2015` | serialno, swver | get and set | no | yes | -| `fsinsulinx` | serialno, swver | get and set | no | not supported by device | -| `fslibre` | serialno, swver | get and set | yes | not supported by device | -| `fsoptium` | serialno, swver, unit | get and set | not supported by device | not supported by device | -| `fsprecisionneo` | serialno, swver | get and set | not supported by device | not supported by device | -| `accuchek_reports` | serialno, unit | no | yes | not supported by device | -| `sdcodefree` | none | set only | pre-/post-meal notes | not supported by device | - -### Driver dependencies - -| Driver | Dependencies | -| --- | --- | -| `otultra2` | [pyserial] | -| `otultraeasy` | [pyserial] | -| `otverio2015` | [python-scsi] | -| `fsoptium` | [pyserial] | -| `sdcodefree` | [pyserial] | +| Manufacturer | Model Name | Driver | Dependencies | +| --- | --- | --- | --- | +| LifeScan | OneTouch Ultra 2 | `otultra2` | [pyserial] | +| LifeScan | OneTouch Ultra Easy | `otultraeasy` | [pyserial] | +| LifeScan | OneTouch Ultra Mini | `otultraeasy` | [pyserial] | +| LifeScan | OneTouch Verio (USB) | `otverio2015` | [python-scsi] | +| LifeScan | OneTouch Select Plus | `otverio2015` | [python-scsi] | +| Abbott | FreeStyle InsuLinx | `fsinsulinx` | | +| Abbott | FreeStyle Libre | `fslibre` | | +| Abbott | FreeStyle Optium | `fsoptium` | [pyserial] | +| Abbott | FreeStyle Precision Neo | `fsprecisionneo` | | +| Roche | Accu-Chek Mobile | `accuchek_reports` | | +| SD Biosensor | SD CodeFree | `sdcodefree` | [pyserial] | [pyserial]: https://pythonhosted.org/pyserial/ [python-scsi]: https://github.com/rosjat/python-scsi -- cgit v1.2.3