Welcome to the AAPS documentation
AAPS is an open source app for people living with insulin-dependent diabetes that acts as an artificial pancreas system (APS) on Google Android smartphones. It uses an openAPS software algorithm which aims to do what a living pancreas does: keeping blood sugar levels within healthy limits by using automated insulin dosing (AID). Additionally, you need a supported and FDA/CE approved insulin pump, and a continuous glucose meter.
Interested? Read more about AAPS in the introduction.
Warning
IMPORTANT SAFETY NOTICE
The foundation of AAPS safety features discussed in this documentation is built on the safety features of the hardware used to build your system. It is critically important that you only use a tested, fully functioning FDA or CE approved insulin pump and CGM for closing an automated insulin dosing loop. Hardware or software modifications to these components can cause unexpected insulin dosing, causing significant risk to the user. If you find or get offered broken, modified or self-made insulin pumps or CGM receivers, do not use these for creating an AAPS system.
Additionally, it is equally important to only use original supplies such as inserters, cannulas and insulin containers approved by the manufacturer for use with your pump or CGM. Using untested or modified supplies can cause CGM inaccuracy and insulin dosing errors. Insulin is highly dangerous when misdosed - please do not play with your life by hacking with your supplies.
Last not least, you must not take SGLT-2 inhibitors (gliflozins) as they incalculably lower blood sugar levels. The combination with a system that lowers basal rates in order to increase BG is especially dangerous as due to the gliflozin this rise in BG might not happen and a dangerous state of lack of insulin can happen.
Note
Disclaimer and Warning
All information, thought, and code described here is intended for informational and educational purposes only. Nightscout currently makes no attempt at HIPAA privacy compliance. Use Nightscout and AAPS at your own risk, and do not use the information or code to make medical decisions.
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.
Please note - this project has no association with and is not endorsed by: SOOIL, Dexcom, Accu-Chek, Roche Diabetes Care, Insulet or Medtronic.
How to read the documentation?
We have provided this subsection of the documentation especially for those who are new to concept of Do-It-Yourself-APS (Artificial-Pancreas-Systems) in order to best show how to get acquainted with the information we consider to be the most important, especially in terms of understanding the reasons behind the “limits” set in place when you are first beginning your AAPS journey. These safety limits have been developed over many years by observations of the inadvertent mistakes that new users are most likely to make when first learning to set up, build, and then successfully loop with AAPS - as most often those mistakes occur simply because the user was so excited to get started using the system that they may have forgotten to sit down and dedicate the time needed to understand the information within this documentation thoroughly. We have all been there!
Certainly the approach, “read everything” has merit and is certainly true. However, it is not uncommon for newcomers to quickly become overwhelmed by the sheer volume and variety of new information that they are expected to understand all at once! So these next few subsections are meant to lay out the most important foundations of the knowledge necessary to successfully run your own chosen setup with as few hiccups as is possible. New users can refer back to this guide when they run into aspects of the system they are not yet familiar with; and to remind themselves where to go within the Documentation in order to locate more in-depth information, as needed. It is also important to lay out the capabilities of AAPS in an up-front manner, as sometimes it can be disappointing to discover in the middle of reading the documentation that certain necessary tools are currently not available for use (due to constraints on which types of insulin pumps or CGMs are available in some countries vs. other countries etc.) or simply offers less/different functionality than first assumed. Finally, it is important to acknowledge that many experience-related aspects inside this documentation only become pertinent as you begin to use AAPS in real-time. Just as it is nearly impossible to learn to play a sport perfectly just by reading about the rules, it takes a combination of first learning the foundations of the rules for safely operating AAPS and then committing the time learning how best to apply those rules as you navigate through the steps of looping with AAPS.
The Getting started subsection is a must read to understand the general concept of what an artificial pancreas system is designed to do; and is especially pertinent for users of AAPS.
The subsection What do I need? specifies the CGMs (Continuous Glucose Monitors) and insulin pumps which are are available for use with AAPS. This subsection is important to understand so that your AAPS system can be assembled and built correctly the first time around and will function well in real world situations.
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. The nice thing is, however, that 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 requesting help, as 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. Just try it out please.
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.
For parents who want to build AAPS for their children, we recommend the subsection AAPS for children , as there you will find more advanced information specifically tailored for learning the extra steps necessary in order to remotely control your child’s AAPS app as well as a more comprehensive safety profile as compared to adults. You need to be able to support your children and understand the all the advanced concepts that AAPS offers to help you succeed.
Now that you have a solid understanding of the concepts that AAPS uses, know where to go for the the necessary tools to build your APS and are familiar with where to get help in case of an emergency, it is the right time to start building the app! The subsection How to install AAPS? shows you this in detail. 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 By the way, 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.
Change language
Home
- Introduction
- 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?
Getting started
- Preparing
- Safety first
- What is a closed loop system
- What is a closed loop system with AAPS
- 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
What do I need
How to Install AAPS
- Building the APK
- Build yourself instead of download
- Important notes
- Recommended specification of computer for building apk file
- Overview
- Step by step walkthrough
- Install git (if you don’t have it)
- Install Android Studio
- Set git path in preferences
- Download AAPS code
- Download Android SDK
- Generate signed APK
- Transfer APK to smartphone
- Troubleshooting
- Update to a new version or branch
- Troubleshooting
- Hints and Checks after update to AAPS 3.0
- Checks after update to AAPS 2.7
- Install git
- Troubleshooting Android Studio
- Release notes
- Android version and AAPS version
- WearOS version
- Version 3.2.0
- 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
- Dev branch
Component Setup
Configuration
- Config builder
- Preferences
AAPS Usage
- AAPS screens
- The Homescreen
- Bolus Wizard
- Action tab
- Insulin Profile
- Pump Status
- Care Portal
- Loop, AMA / SMB
- Profile
- Treatment
- BG Source - xDrip+, BYODA…
- NSClient
- 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: Additional Features such as DynamicISF
- Go back in objectives
- Objectives in Android APS before version 3.0
- 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)
- DynamicISF
- Overview of hard-coded limits
- COB calculation
- Sensitivity detection
- Profile switch
- Temp-targets
- Extended carbs
- Automation
- Autotune (dev only)
- Careportal (discontinued)
- Open Humans Uploader
- Automation with 3rd party apps
- Android auto
General Hints
- 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
AAPS for children
Full Closed Loop
Troubleshooting
FAQ
- 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 NSClient 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 ?
Glossary
Where to go for help
- 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
- 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 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
Note
Disclaimer And Warning
All information, thought, and code described here is intended for informational and educational purposes only. Nightscout currently makes no attempt at HIPAA privacy compliance. Use Nightscout and AAPS at your own risk, and do not use the information or code to make medical decisions.
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.
Please note - this project has no association with and is not endorsed by: SOOIL, Dexcom, Accu-Chek, Roche Diabetes Care or Medtronic