Welcome to the AAPS documentation
Android APS (AAPS) is an open source app for people living with insulin-dependent diabetes. It is an artificial pancreas system (APS) which runs on Android smartphones. AAPS uses an openAPS software algorithm and aims to do what a real pancreas does: keep blood sugar levels within healthy limits by using automated insulin dosing. To use AAPS you need three compatible devices: an Android phone, a FDA/CE approved insulin pump, and a continuous glucose meter (CGM).
This documentation explains how to setup and use AAPS. You can navigate through the AAPS documentation either through the menu on the left (and the handy „Search docs“ function), or by using the index at the bottom of this page.
Overview of the AAPS documentation („The docs“)
Under „Getting Started“, the Introduction explains the general concept of what an artificial pancreas system (APS) is designed to do. It outlines the background of looping in general, why AAPS was developed, compares AAPS to other systems, and addresses safety. It gives suggestions about how to talk to your clinical team about AAPS, explains why you need to build the AAPS app yourself rather than just downloading it, and gives an overview of the typical connectivity of an AAPS system. It also addresses accessibility, and who is likely to benefit from AAPS.
Preparing for AAPS gives more detail about safety considerations, and the phones, CGMs (Continuous Glucose Monitors) and insulin pumps which are compatible with AAPS. It gives an overview of the process you will go through, and provides an approximate timeline for gaining full functionality of AAPS. This section gets you technically prepared to assemble your AAPS setup as quickly and efficiently as possible.
Now that you have a solid understanding of the process, you can start assembling your AAPS loop. The Setting up AAPS section contains step-by-step instructions to do this. It covers choosing and setting up your reporting server (Nightscout or Tidepool) so you can review and share your data, getting your computer ready for building the AAPS app, building the AAPS app and transferring the AAPS app to your phone. It also covers setting up the AAPS app using the setup Wizard, linking it with your CGM app, and either a real or virtual insulin pump, as well as linking AAPS to your reporting server. You then progress through the objectives, which will help you to optimise your settings as you unlock the full functionality of the AAPS app.
The Remote control and Following section highlights a real strength of AAPS, which is that there are a wide range of possibilities for remotely sending commands to, or simply following the data from AAPS. This is equally useful for carers who want to use AAPS for minors, and for adults with diabetes who either want to monitor their sugars (and other metrics) more conveniently than just on their phone (on a watch, in the car etc.), or wish to have significant others to also monitor the data. This section also provides guidance for using Android auto so you can view glucose levels in the car.
The subsection Where to go for help? should help direct you to the best places to go to find help depending upon your levels of experience with AAPS. This is very important so that you don’t feel left out, especially at the beginning, and so that you can get in touch with others as quickly as possible, clarify questions and solve the usual pitfalls as quickly as possible. Experience shows that a lot of people are already using AAPS successfully, but everyone has a question at some point that they couldn’t solve on their own. Due to the large number of users, the response times to questions are usually very quick, typically only a few hours. Don’t worry about asking for help, there is no such thing as a dumb question! We encourage users of any/all levels of experience to ask as many questions as they feel is necessary to help get them up and running safely.
In the subsection Glossary we have compiled a list of the acronyms (or short-term names) used throughout AAPS. For example, where to go to find out what the terms ISF or TT, stand for in in the more common (longer) terms.
Since the requirements are very different from anything you might have set up in the past, we recommend that you really follow the instructions, step-by-step the first few times you build the app, so that you have a stronger sense of how the app building process is supposed to behave when all directions are followed exactly. Please remember to take your time. Later this will go very quickly when you build the app again for a new version. That way you will have a greater chance of noticing when something doesn’t going as planned before too many steps are out of line. It is important to save the your keystore file (.jks file used to sign your app) in a safe place, so that you can always use that exact same keystore file and password each and every time you are asked to create a new updated version of AAPS, as this file is what makes sure that each new version of the app „remembers“ all the information that you have provided to it in previous versions of the app and thus ensure that the updates will go as smoothly as possible. On average, you can assume that there will be one new version and 2-3 required updates per year. This number is based on experience and may change in the future. But we do want to at least give you a general guideline on what to expect. When you are more experienced at building updated AAPS app versions all the steps that are required in building an updated app will only take 15-30 minutes, on average. However, in the beginning there can be a rather steep learning curve as these steps are not always considered intuitive by new users! So do not get frustrated if you find that it takes half a day or a whole day with some help from the community before you are finally finished with the update process. If you find that you are getting very frustrated just take a short break, and oftentimes; after a stroll around the block or two…you’ll find that you are better able to approach the problem again.
We have also compiled a list of questions and answers to most of the typical errors that are likely to occur the first few updates located within the FAQs section; as well as within „How to install AAPS?“ that provides additional information in the subsection „Troubleshooting“.
The subsection Component Setup explains how to properly integrate each of the various different separate component parts into AAPS, as well as how to set them up to work as seamlessly as possible together. All components are listed under the separate sections: CGM/FGM, xDrip Settings, Pumps, Phones, Nightscout setup, and Smartwatches. The sensor (BG) values and control of the insulin pump are particularly important information to understand. The subsection Configuration describes the best pump configurations to use in AAPS.
This is followed by a particularly important subsection AAPS Usage, in which you are slowly introduced to the full usage of what AAPS has to offer via a safe and carefully calibrated step-by-step gradual process designed to make sure that you/your child are thoroughly familiar and comfortable navigating all the different levels and menu configurations before graduating on the next phase, each commonly referred to as the next Objective, until you are have enough experience to begin using the more advanced options available within the app. These Objectives are specially designed in such a way that will gradually unlock more possibilities of AAPS and switch from Open Loop to Closed Loop.
After that there is a subsection General Hints with e.g. information on how to deal with the crossing of time zones as well as knowing what to do during the Spring Forward - Fall Back daylight saving time changes which will occur twice a year while using AAPS.
There is a subsection for the clinicians who have expressed interest in open source artificial pancreas technology such as AAPS, or for patients who want to share such information with their clinicians.
Finally, in the subsection How to help? we would like to provide you with information so that you are able to suggest small or larger changes to the documentation yourself and work together with us on the documentation. We further need support for translation of the documentation. It also very helpful for everyone if you could provide links to the corresponding documentation (or screenshots of where the links are located within the Documentation if you are not familiar with how to send a link) when answering questions from other users. That way the correct information can easily be located again should other users also be trying to find answers to the same types of questions in the future.
Interested in getting started with AAPS? Read more about AAPS in the Introduction.
SAFETY NOTICE
The safety of AAPS relies on the safety features of your hardware (phone, pump, CGM). Only use a fully functioning FDA/CE approved insulin pump and CGM. Do not use broken, modified or self-built insulin pumps or CGM receivers. Only use original consumable supplies (inserters, cannulas and insulin reservoirs) approved by the manufacturer for use with your pump and CGM. Using untested or modified supplies can cause inaccuracy and insulin dosing errors, resulting in significant risk to the user.
Do not use AAPS if you take SGLT-2 inhibitors (gliflozins), as they lower blood sugar levels. You increase the risk diabetic ketoacidosis (DKA) due to reduced insulin delivery and hypoglycemia due to lowered blood sugar levels.
Disclaimer
All information and code described here is for informational and educational purposes only. Use Nightscout and AAPS at your own risk, and do not use the information or code to make medical decisions. Nightscout currently makes no attempt at HIPAA privacy compliance.
Use of code from github.com is without warranty or formal support of any kind. Please review this repository’s LICENSE for details.
All product and company names, trademarks, servicemarks, registered trademarks, and registered servicemarks are the property of their respective holders. Their use is for information purposes and does not imply any affiliation with or endorsement by them.
AAPS has no association with, and is not endorsed by: SOOIL, Dexcom, Accu-Chek, Roche Diabetes Care, Insulet or Medtronic.
AAPS Documentation Index
- Introduction to AAPS
- What is an “Artificial Pancreas System”?
- What does hybrid closed loop mean?
- How and why did looping start?
- What is Android APS (AAPS)?
- What are the basic components of AAPS?
- What are the advantages of the AAPS system?
- Specific advantages include:
- 1) Safety built-in
- 1) Hardware flexibility
- 2) Highly customisable, with wide parameters
- 3) Remote monitoring
- 4) Remote control
- 5) No commercial constraints, due to open application interfaces
- 6) Detailed app interface
- 7) Accessibility and affordability
- 8) Support
- 9) Predictability, transparency and safety
- 10) Access to advanced features through development (dev) modes including full closed loop
- 11) Ability to contribute yourself to further improvements
- Specific advantages include:
- How does AAPS compare to MDI and open looping?
- How does AAPS compare to other looping systems?
- Does AAPS use artificial intelligence or any learning algorithm?
- Which system is right for me or my dependant?
- Is it safe to use open-source systems like AAPS?
- How can I approach discussing AAPS with my clinical team?
- Why can’t I just download AAPS and use it straight away?
- What is the connectivity of the AAPS system?
- How does AAPS get continually developed and improved?
- Who can benefit from AAPS?
- What benefits can I get from AAPS?
- Preparing for AAPS
- Setting up the reporting server
- Building AAPS
- Transferring and Installing AAPS
- Setup Wizard
- Step-wise guide to the AAPS Setup Wizard
- Welcome message
- License agreement
- Required permissions
- Master password
- Fabric upload
- Units (mg/dl <-> mmol/dL)
- Display settings
- Synchronization with the reporting server and more
- Patient name
- Patient type
- Used insulin
- Blood sugar source
- Profile
- Insulin pump
- APS algorithm
- APS mode
- Sensitivity detection
- Start Objective 1
- Step-wise guide to the AAPS Setup Wizard
- Change AAPS configuration
- Completing the objectives
- Objective 1: Setting up visualization and monitoring, analysing basals and ratios
- Objective 2: Learn how to control AAPS
- Objective 3: Prove your knowledge
- Objective 4: Starting on an open loop
- Objective 5: Understanding your open loop, including its temp basal recommendations
- Objective 6: Starting to close the loop with Low Glucose Suspend
- Objective 7: Tuning the closed loop, raising maxIOB above 0 and gradually lowering BG targets
- Objective 8: Adjust basals and ratios if needed, and then enable autosens
- Objective 9: Enabling additional oref1 features for daytime use, such as super micro bolus (SMB)
- Objective 10: Automation
- Objective 11: Enabling additional features for daytime use, such as Dynamic Senstivity plugin (DynISF).
- Go back in objectives
- Objectives in Android APS before version 3.0
- Remote control
- Considerations when setting up remote control of AAPS for a child
- SMS Commands
- SMS command safety
- Different types of SMS commands
- SMS commands tables
- Authentication or not?
- How to set up SMS commands
- Let’s get started!
- First steps using SMS commands
- Additional safety notes on SMS commands
- Delivering mealtime boluses through SMS commands
- SMS commands troubleshooting and FAQ
- Q: What can’t we do with SMS commands?
- Q: What happens if I change my mind about a command I have just sent?
- Q. Why am I getting multiple SMS texts of the same message?
- Q. I’ve just set up SMS commands and I am now getting far too many text messages. Can I reduce the frequency, or make them stop?
- Q. Why are SMS commands not working on my Samsung phone?
- Q. How can I fix issues with the Android Messages App?
- AAPSClient
- Nightscout
- 4) Smartwatches
- General advantages of using smartwatches with AAPS
- Specific advantages for parents/carers using AAPS
- Different types of Smartwatch-AAPS interactions
- Before you buy a smartwatch…
- Option 1) Standalone Watch running AAPS
- Option 2) AAPS on watch, for remote control of AAPS on a phone
- Troubleshooting
- Option 3) AAPSClient on a watch for remote control of AAPS on a phone
- Option 4) Limited Nightscout (and other options) on a watch - Fitbit watches
- Option 5) Monitoring of AAPS (full profile data, or glucose-only) where AAPS is running on a phone.
- Following-only
- Android auto
- Release notes
- Android version and AAPS version
- WearOS version
- Version 3.2.0.0 dedicated to @Philoul
- Version 3.1.0
- Version 3.0.0
- Version 2.8.2
- Version 2.8.1.1
- Version 2.8.0
- Version 2.7.0
- Version 2.6.1.4
- Version 2.6.1.3
- Version 2.6.1.2
- Version 2.6.1.1
- Version 2.6.1
- Version 2.6.0
- Version 2.5.1
- Version 2.5.0
- Version 2.3
- Version 2.2.2
- Version 2.2
- Version 2.1
- Version 2.0
- Update to a new version or branch
- Troubleshooting
- Dev branch
- Dedicated Google account for AAPS (optional)
- How to set up a dedicated Google account for AAPS
- Go to https://account.google.com
- Enter your NEW dedicated account details:
- Enter your persona:
- Choose your NEW email address & password
- Enter a phone number which can receive the SMS verification
- Enter the recovery email address
- Finish setting up the account
- Customize the new profile display
- Open the Gmail website on both windows to configure the new account
- In the new Gmail account (bottom window), open Gmail settings…
- Setup forwarding…
- Verify the forwarded email address
- Archive forwarded emails in the new dedicated Gmail account (bottom window)
- How to set up a dedicated Google account for AAPS
- CGM/FGM
- xDrip Settings
- Basic settings for all CGM & FGM systems
- Use AAPS to calibrate in xDrip+
- Dexcom G6
- Libre 1
- Libre 2 patched app
- Pump choices
- Phones
- Smartwatch
- AAPS screens
- The Homescreen
- Bolus Wizard
- Action tab
- Insulin Profile
- Pump Status
- Care Portal
- Loop, AMA / SMB
- Profile
- Treatment
- BG Source - xDrip+, BYODA…
- NSClient
- OpenAPS features
- Autosens
- Super Micro Bolus (SMB)
- Max U/h a temp basal can be set to (OpenAPS “max-basal”)
- Maximum total IOB OpenAPS can’t go over (OpenAPS „max-iob“)
- Enable AMA Autosens
- Enable SMB
- Enable SMB with high temp targets
- Enable SMB always
- Enable SMB with COB
- Enable SMB with temp targets
- Enable SMB after carbs
- Max minutes of basal to limit SMB to
- Enable UAM
- High temp-target raises sensitivity
- Low temp-target lowers sensitivity
- Advanced Settings
- Advanced Meal Assist (AMA)
- Overview of hard-coded limits
- Dynamic ISF
- COB calculation
- Sensitivity detection
- Profile switch
- Temp-targets
- What are Temp-Targets and where can I set and configure them?
- Where can I select a Temp-Target?
- Where can I change the default Temp-Target and override with my own preferences?
- How do I cancel a Temp-Target?
- How do I select a “Default-Temp-Targets”
- Hypo Temp-Target
- Activity Temp-Target
- Eating soon Temp-Target
- How do I turn off SMB during Temp-Targets?
- Custom Temp-Target
- Extended carbs
- Automation
- What is an Automation?
- How Automation can help
- Key considerations before starting with Automations
- When can I start using Automation?
- Where are Automations located in AAPS?
- How can I set up an Automation?
- Safety limits
- Correct use of negative values
- Automation Conditions
- Action
- The order of the automations in the list matters
- How to delete Automation rules
- Examples of Automations
- Automation Logs
- Troubleshooting
- Alternatives to Automations
- Autotune (dev only)
- Careportal (discontinued)
- Open Humans Uploader
- Automation with 3rd party apps
- Custom Watchface reference document
- Custom Watchface Format
- JSON Structure
- How to build/design your first Watchface
- Advanced features
- Key and KeyValue reference
- Exchange Site Custom Watchfaces
- Timezone traveling with pumps
- Time adjustment daylight savings time (DST)
- Accessing logfiles
- Accu-Chek Combo tips for basic usage
- Export/Import Settings
- xDrip engineering mode
- FAQ for loopers
- General
- AAPS settings
- APS algorithm
- Other settings
- Frequent questions on Discord and their answers…
- My problem is not listed here.
- My problem is not listed here but I found the solution
- AAPS stops everyday around the same time.
- How to organize my backups ?
- I have problems, errors building the app.
- I’m stuck on an objective and need help.
- How to reset the password in AAPS v2.8.x ?
- How to reset the password in AAPS v3.x
- My link/pump/pod is unresponsive (RL/OL/EmaLink…)
- Build error: file name too long
- Alert: Running dev version. Closed loop is disabled
- Where can I find settings files?
- How to configure battery savings?
- Pump unreachable alerts several times a day or at night.
- Where can I delete treatments in AAPS v3 ?
- Configuring and Using the AAPSClient remote app
- I have a red triangle / AAPS won’t enable closed loop / Loops stays in LGS / I have a yellow triangle
- Can I move an active DASH Pod to other hardware?
- Procedure I follow in this:
- How do I import settings from earlier versions of AAPS into AAPS v3 ?
- Useful resources to read before you start
- Where to go for help
- Docs updates & changes
- February 2022
- January 2022
- December 2021
- November 2021
- October 2021
- September 2021
- June 2021
- April 2021
- March 2021
- February 2021
- January 2021
- December 2020
- October 2020
- September 2020
- June 2020
- May 2020
- April 2020
- March 2020
- February 2020
- January 2020
- December 2019
- November 2019
- October 2019
- September 2019
- August 2019
- For Clinicians
- The steps for building a DIY Closed Loop:
- How A DIY Closed Loop Works
- How data is gathered:
- How does it know what to do?
- Examples of AAPS algorithm decision making:
- Here are examples of the purple prediction lines, and how they might differ:
- Here are examples of different time frames that influence the needed adjustments to insulin delivery:
- Scenario 1 - Zero Temp for safety
- Scenario 2 - Zero temp for safety
- Scenario 3 - More insulin needed
- Scenario 4 - Low temping for safety
- Optimizing settings and making changes
- OpenAPS
- Summary
- How to help
- How to translate the app and docs
- How to edit the docs
- General
- Code syntax
- Style Guide
- Contents
- 1. English language writing tips
- Use language that is appropriate for the reader
- Privacy/licensing concerns:
- Keep sentences short, get to the point
- Don’t be afraid to give instructions
- Mostly use active verbs, rather than passive verbs
- Avoid nominalisations
- Use lists where appropriate
- Mythbusting
- Optimising writing style by purpose
- 2. AAPS-specific writing/updating notes
- 3. Useful References
- State of translations