Skip to content

Commit 7855715

Browse files
committed
Porting AndroidAPS wiki to openaps/AndroidAPSdocs repo
Porting AndroidAPS wiki content as of june 10, 2018 to openaps/AndroidAPSdocs repo
1 parent d217d0b commit 7855715

File tree

117 files changed

+3169
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+3169
-0
lines changed

.DS_Store

8 KB
Binary file not shown.

docs/.DS_Store

10 KB
Binary file not shown.

docs/CZ/Instrukce-v-češtině.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
...
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
**This software is part of a DIY solution and is not a product, but
2+
requires YOU to read, learn and understand the system including how to use it.
3+
It is not something that does all your diabetes management for you, but
4+
allows you to improve your diabetes and your quality of life
5+
if you're willing to put in the time required. Don't rush into it,
6+
but allow yourself time to learn. You alone are responsible for what
7+
you do with it.**
8+
9+
## Hardware requirements
10+
11+
- A Roche Accu-Chek Combo (any firmware, they all work)
12+
- A Smartpix or Realtyme device together with the 360 Configuration
13+
Software to configure the pump.
14+
Roche sends out Smartpix devices and the configuration software
15+
free of charge to their customers upon request.
16+
- A compatible phone: An Android phone with a phone running LineageOS 14.1 (formerly CyanogenMod) or Android 8.1 (Oreo). The LineageOS 14.1 has to be a recent version from at least June 2017 since the change needed to pair the Combo pump was only introduced at that time. A list of phones can be found in the [AAPS Phones](https://docs.google.com/spreadsheets/d/1gZAsN6f0gv6tkgy9EBsYl0BQNhna0RDqA9QGycAqCQc/edit#gid=698881435) document.
17+
Please be aware that this is not complete list and reflects personal user experience. You are encouraged to also enter your experience and thereby help others (these projects are all about paying it forward).
18+
19+
- Be aware that while Android 8.1 allows communicating with the Combo, there are still issues with AAPS on 8.1.
20+
For advanced users, it is possible to perform the pairing on a rooted phone and transfer it to another rooted
21+
phone to use with ruffy/AAPS, which must also be rooted. This allows using phones with Android < 8.1 but
22+
has not been widely tested: https://github.com/gregorybel/combo-pairing/blob/master/README.md
23+
24+
## Limitations
25+
26+
- Extended bolus and multiwave bolus are not supported (see [[Extended Carbs]] instead)
27+
- Only one basal profile is supported.
28+
- Setting a basal profile other than 1 on the pump, or delivering extended boluses or multiwave
29+
boluses from the pump interferes with TBRs and forces the loop into low-suspend only mode for 6 hours
30+
as the the loop can't run safely under these conditions.
31+
- It's currently not possible to set the time and date on the pump, so daylight saving times
32+
changes have to be performed manually (you may disable the phone's automatic clock update in the evening and
33+
change it back in the morning together with the pump clock to avoid an alarm during the night).
34+
- Currently only basal rates in the range of 0.05 to 10 U/h are supported. This also applies when modifying
35+
a profile, e.g. when increasing to 200%, the highest basal rate must not exceed 5 U/h since it will be
36+
doubled. Similarly, when reducing to 50%, the lowest basal rate must be at least 0.10 U/h.
37+
- If the loop requests a running TBR to be cancelled the Combo will set a TBR of 90% or 110%
38+
for 15 minutes instead. This is because cancelling a TBR causes an alert on the pump which
39+
causes a lot of vibrations.
40+
- Occasionally (every couple of days or so) AAPS might fail to automatically cancel
41+
a TBR CANCELLED alert, which the user then needs to deal with (by pressing the refresh button in AAPS
42+
to transfer the warning to AAPS or confirming the alert on the pump).
43+
- Bluetooth connection stability varies with different phones, causing "pump unrechable" alerts,
44+
where no connection to the pump is established anymore. If that error occurs, make sure Bluetooth
45+
is enabled, press the Refresh button in the Combo tab to see if this was caused by an intermitted
46+
issue and if still no connection is established, reboot the phone which should usually fix this.
47+
There is another issue were a restart doesn't help but a button on the pump must be pressed (which
48+
resets the pump's Bluetooth), before the pump accepts connections from the phone again. There is very
49+
little that can be done to remedy either of those issues at this point. So if you see those errors
50+
frequently your only option at this time is to get another phone that's known to work well with
51+
AndroidAPS and the Combo (see above).
52+
- Issuing a bolus from the pump will be not always be detected in time (checked for whenever AAPS connects to the pump), and might take up to 20 minutes in the worst case. Boluses on the pump are always checked before a high TBR or a bolus issued by AAPS but due to the limitations AAPS will then refuse to issue the TBR/Bolus as it was calculated under false premises. (-> Don't bolus from the Pump! See chapter *Usage*)
53+
- Setting a TBR on the pump is to be avoided since the loop assumes control of TBRs. Detecting a new TBR on the pump might take up to 20 minutes and the TBR's effect will only be accounted from the moment it is detected, so in the worst case there might be 20 minutes of a TBR that is not reflected in IOB.
54+
55+
## Setup
56+
57+
- Configure the pump using 360 config software. If you do not have the software, please contact your Accu-Chek hotline. They usually send registered users a CD with the "360° Pump Configuration Software" and a SmartPix USB-infrared connection device (the Realtyme device also works if you have that).
58+
- Required (marked green in screenshots):
59+
- Set/leave the menu configuration as "Standard", this will show only the supported
60+
menus/actions on the pump and hide those which are unsupported (extended/multiwave bolus,
61+
multiple basal rates), which cause the loop functionality to be restricted when used because
62+
it's not possible to run the loop in a safe manner when used.
63+
- Verify the _Quick Info Text_ is set to "QUICK INFO" (without the quotes, found under _Insulin Pump Options_).
64+
- Set TBR _Maximum Adjustment_ to 500%
65+
- Disable _Signal End of Temporary Basal Rate_
66+
- Set TBR _Duration increment_ to 15 min
67+
- Enable Bluetooth
68+
- Recommended (marked blue in screenshots)
69+
- Set low cartridge alarm to your liking
70+
- Configure a max bolus suited for your therapy to protect against bugs in the software
71+
- Similarly, configure maximum TBR duration as a safeguard. Allow at least 3 hours, since
72+
the option to disconnect the pump for 3 hours sets a 0% for 3 hours.
73+
- Enable key lock on the pump to prevent bolusing from the pump, esp. when the
74+
pump was used before and quick bolusing was a habit.
75+
- Set display timeout and menu timeout to the minimum of 5.5 and 5 respectively. This allows the AAPS to
76+
recover more quickly from error situations and reduces the amount of vibrations that can occur during
77+
such errors
78+
79+
![](https://github.com/MilosKozak/AndroidAPS/blob/combo/documentation/images/combo-menu-settings.png)
80+
![](https://github.com/MilosKozak/AndroidAPS/blob/combo/documentation/images/combo-pump-options-settings.png)
81+
![](https://github.com/MilosKozak/AndroidAPS/blob/combo/documentation/images/combo-tbr-settings.png)
82+
![](https://github.com/MilosKozak/AndroidAPS/blob/combo/documentation/images/combo-bolus-settings.png)
83+
![](https://github.com/MilosKozak/AndroidAPS/blob/combo/documentation/images/combo-insulin-settings.png)
84+
85+
- Install AndroidAPS as described in the [AndroidAPS wiki](http://wiki.AndroidAPS.org) and use the `combo` branch.
86+
- Make sure to read the wiki to understand how to setup AndroidAPS.
87+
- Select the MDI plugin in AndroidAPS, not the Combo plugin at this point to avoid the Combo
88+
plugin from interfering with ruffy during the pairing process.
89+
- Follow the link http://ruffy.AndroidAPS.org and clone ruffy via git. Use the same branch as you use for
90+
AndroidAPS, right now that's the `combo` branch, later on there will be the regular `master` and `dev` branches.
91+
- Install ruffy and use it to pair the pump. If it doesn't work after multiple attempts, switch to the `pairing` branch, pair the pump and then switch back the original branch.
92+
If the pump is already paired and can be controlled via ruffy, installing the `combo` branch is sufficient.
93+
Note that the pairing processing is somewhat fragile (but only has to be done once)
94+
and may need a few attempts; quickly acknowledge prompts and when starting over, remove the pump device
95+
from the Bluetooth settings beforehand. Another option to try is to go to the Bluetooth menu after
96+
initiating the pairing process (this keeps the phone's Bluetooth discoverable as long as the menu is displayed)
97+
and switch back to ruffy after confirming the pairing on the pump, when the pump displays the authorization code.
98+
If you're unsuccessful in pairing the pump (say after 10 attempts), try waiting up to 10s before confirming the pairing on the pump (when the name of the phone is displayed on the pump). If you have configured the menu timeout to be 5s above, you need to increase it again. Some users reported they needed to do this.
99+
- When AAPS is using ruffy, the ruffy app can't be used. The easiest way is to just
100+
reboot the phone after the pairing process and let AAPS start ruffy in the background.
101+
- If the pump is completely new, you need to do one bolus on the pump, so the pump creates a first history entry.
102+
- Before enabling the Combo plugin in AAPS make sure your profile is set up
103+
correctly and activated(!) and your basal profile is up to date as AAPS will sync the basal profile
104+
to the pump. Then activate the Combo plugin. Press the _Refresh_ button on the Combo tab to initialize the
105+
pump.
106+
- To verify your setup, with the pump **disconnected**, use AAPS to set a TBR of 500% for 15 min and issue a bolus. The pump should now have a TBR running and the bolus in the history. AAPS should also show the active TBR and delivered bolus.
107+
108+
## Usage
109+
110+
- Keep in mind that this is not a product, esp. in the beginning the user needs to monitor and understand the system,
111+
its limitations and how it can fail. It is strongly advised NOT to use this system when the person
112+
using it is not able to fully understand the system.
113+
- Read the OpenAPS documentation https://openaps.org to understand the loop algorithm AndroidAPS
114+
is based upon.
115+
- Read the wiki to learn about and understand AndroidAPS http://wiki.AndroidAPS.org
116+
- This integration uses the same functionality which the meter provides that comes with the Combo.
117+
The meter allows to mirror the pump screen and forwards button presses to the pump. The connection
118+
to the pump and this forwarding is what the ruffy app does. A `scripter` components reads the screen
119+
and automates entering boluses, TBRs etc and making sure inputs are processed correctly.
120+
AAPS then interacts with the scripter to apply loop commands and to administer boluses.
121+
This mode has some restrictions: it's comparatively slow (but well fast enough for what it is used for),
122+
and setting a TBR or giving a bolus causes the pump to vibrate.
123+
- The integration of the Combo with AndroidAPS is designed with the assumption that all inputs are
124+
made via AndroidAPS. Boluses entered on the pump directly will be detected by AAPS, but it can take
125+
up to 20 min before AndroidAPS becomes aware of such a bolus. Reading boluses delivered directly on
126+
the pump is a safety feature and not meant to be regularly used (the loop requires knowledge of carbs
127+
consumed, which can't be entered on the pump, which is another reason why all inputs should be done
128+
in AndroidAPS).
129+
- Don't set or cancel a TBR on the pump. The loop assumes control of TBR and cannot work reliably otherwise, since it's not possible to determine the start time of a TBR that was set by the user on the pump.
130+
- The pump's first basal rate profile is read on application start and is updated by AAPS.
131+
The basal rate should not be manually changed on the pump, but will be detected and corrected as a safety
132+
measure (don't rely on safety measures by default, this is meant to detect an unintended change on the pump).
133+
- It's recommended to enable key lock on the pump to prevent bolusing from the pump, esp. when the
134+
pump was used before and using the "quick bolus" feature was a habit.
135+
Also, with keylock enabled, accidentally pressing a key will NOT interrupt active communication
136+
between AAPS and pump.
137+
- When a BOLUS/TBR CANCELLED alert starts on the pump during bolusing or setting a TBR, this is
138+
caused by a disconnect between pump and phone, which happens from time to time. AAPS will try to reconnect and confirm the alert
139+
and then retry the last action (boluses are NOT retried for safety reasons). Therefore,
140+
such an alarm can be ignored as AAPS will confirm it automatically, usually within 30s (cancelling it is not problem, but will lead to the currently
141+
active action to have to wait till the pump's display turns off before it can reconnect to the
142+
pump). If the pump's alarm continues, automatic corfirmation failed, in which case the user
143+
needs to confirm the alarm manually.
144+
- When a low cartridge or low battery alarm is raised during a bolus, they are confirmed and shown
145+
as a notification in AAPS. If they occur while no connection is open to the pump, going to the
146+
Combo tab and hitting the Refresh button will take over those alerts by confirming them and
147+
show a notification in AAPS.
148+
- When AAPS fails to confirm a TBR CANCELLED alert, or one is raised for a different reason,
149+
hitting Refresh in the Combo tab establishes a connection, confirms the alert and shows
150+
a notification for it in AAPS. This can safely be done, since those alerts are benign - an
151+
appropriate TBR will be set again during the next loop iteration.
152+
- For all other alerts raised by the pump: connecting to the pump will show the alert message in
153+
the Combo tab, e.g. "State: E4: Occlusion" as well as showing a notification on the main screen.
154+
An error will raise an urgent notification. AAPS never confirms serious errors on the pump,
155+
but let's the pump vibrate and ring to make sure the user is informed of a critical situation
156+
that needs action.
157+
- After pairing, ruffy should not be used directly (AAPS will start in the background as needed),
158+
since using ruffy at AAPS at the same time is not supported.
159+
- If AAPS crashes (or is stopped from the debugger) while AAPS and the pump were communicating (using
160+
ruffy), it might be necessary to force close ruffy. Restarting AAPS will start ruffy again.
161+
Restarting the phone is also an easy way to resolve this if you don't know how to force kill
162+
an app.
163+
- Don't press any buttons on the pump while AAPS communicates with the pump (Bluetooth logo is
164+
shown on the pump).

docs/Configuration/BG-Source.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
**For users of Dexcom:**<Br>
2+
_If using xdrip…_<br>
3+
* If not already set up then download [xdrip](https://github.com/NightscoutFoundation/xDrip) and follow instructions on nightscout ([G4 without share](http://www.nightscout.info/wiki/welcome/nightscout-with-xdrip-wireless-bridge), [G4 share](http://www.nightscout.info/wiki/welcome/nightscout-with-xdrip-and-dexcom-share-wireless), [G5](http://www.nightscout.info/wiki/welcome/nightscout-with-xdrip-and-dexcom-share-wireless/xdrip-with-g5-support)).
4+
* In xdrip go to Settings > Interapp Compatibility > Broadcast Data Locally and select ON.
5+
* In xdrip go to Settings > Interapp Compatibility > Accept Treatments and select OFF.
6+
* If you want to be able to use AndroidAPS to calibrate then in xdrip go to Settings > Interapp Compatibility > Accept Calibrations and select ON. You may also want to review the options in Settings > Less Common Settings > Advanced Calibration Settings.
7+
* Select xdrip in ConfigBuilder (setting in AndroidAPS).
8+
9+
_If using Dexcom G5 App..._<Br>
10+
* Just dev.
11+
* Download the apk from [here](https://github.com/dexcomapp/dexcomapp), just this versions works whether mg/dl or mmol/l.
12+
* Deinstall original Dexcom app, if not allready done.
13+
* Select Dexcom G5 App in ConfigBuilder
14+
15+
_If using OTG cable ('traditional' Nightscout)…_<br>
16+
* If not already set up then download Nightscout Uploader app from the Play Store and follow instructions on [Nightscout](http://www.nightscout.info/wiki/welcome/basic-requirements).
17+
* In AndroidAPS Preferences enter your nightscout website and API secret.
18+
* Select NSClient in ConfigBuilder (setting in AndroidAPS).
19+
20+
21+
**For users of Libre:**<br>
22+
23+
_If using xdrip..._<br>
24+
* If not already set up then download xdrip and follow instructions on [LimiTTEer](https://github.com/JoernL/LimiTTer), [Libre Alarm](https://github.com/pimpimmi/LibreAlarm/wiki) or [BlueReader](https://unendlichkeit.net/wordpress/?p=680&lang=en)([Hardware](https://bluetoolz.de/wordpress/)).
25+
* In xdrip go to Settings > Interapp Compatibility > Broadcast Data Locally and select ON.
26+
* In xdrip go to Settings > Interapp Compatibility > Accept Treatments and select OFF.
27+
* If you want to be able to use AndroidAPS to calibrate then in xdrip go to Settings > Interapp Compatibility > Accept Calibrations and select ON. You may also want to review the options in Settings > Less Common Settings > Advanced Calibration Settings.
28+
* Select xdrip in ConfigBuilder (setting in AndroidAPS).
29+
30+
_If using Glimp..._<br>
31+
* If not already set up then download Glimp and follow instructions on [nightscout](http://www.nightscout.info/wiki/welcome/nightscout-for-libre).
32+
* Select Glimp in ConfigBuilder (setting in AndroidAPS).
33+
34+
**For users of MM640g or MM630g:**<br>
35+
* If not already set up then download [600SeriesAndroidUploaer](http://pazaan.github.io/600SeriesAndroidUploader/) and follow instructions on [nightscout](http://www.nightscout.info/wiki/welcome/nightscout-and-medtronic-640g).
36+
* In 600 Series Uploader go to Settings > Send to xdrip+ and select ON (tick).
37+
* Select MM640g in ConfigBuilder (setting in AndroidAPS).
38+
39+
40+
**For users of other CGM uploaded to nightscout:**<br>
41+
If you have any other CGM set up that sends your data to [Nightscout](http://www.nightscout.info) then<br>
42+
* In AndroidAPS Preferences enter your nightscout website and API secret.
43+
* Select NSClient in ConfigBuilder (setting in AndroidAPS).

0 commit comments

Comments
 (0)