Skip to content
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
Cannot retrieve contributors at this time

Welcome to OpenAPS's documentation!

This documentation supports a self-driven Do-It-Yourself (DIY) implementation of an artificial pancreas based on the OpenAPS reference design. By proceeding to use these tools or any piece within, you agree to the copyright for more information; and the full README here and release any contributors from liability, and assume full responsibility for all of your actions and outcomes related to usage of these tools or ideas.

Note: We do not recommend using a PDF version of this guide. The docs are updated continuously, and with a PDF, you will not get the freshest real-time edits. Be aware if you download a PDF that when you have Internet connectivity, we recommend instead having the docs pulled up in an Internet browser so you can refresh. This is especially true if you are working on a setup over the course of multiple days.


A Note on DIY and the "Open" Part of OpenAPS

This is a set of development tools to support a self-driven DIY implementation. Any person choosing to use these tools is solely responsible for testing and implementing these tools independently or together as a system.

The DIY part of OpenAPS is important. While formal training or experience as an engineer or a developer is not a prerequisite, a growth mindset is required to learn to work with the "building blocks" that will help you develop your OpenAPS instance. Remember as you consider this project that this is not a "set and forget" system; an OpenAPS implementation requires diligent and consistent testing and monitoring to ensure each piece of the system is monitoring, predicting, and controlling as desired. The performance and quality of your system lies solely with you.

This community of contributors believes in "paying it forward," and individuals who are implementing these tools are asked to contribute by asking questions, helping improve documentation, and contributing in other ways. Have questions? Hop into Gitter and ask anytime!



The foundation of OpenAPS safety features discussed in this documentation are 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 OpenAPS 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.

.. toctree::
   :maxdepth: 2
   :caption: Understanding OpenAPS (Overview)

   How OpenAPS works <docs/Understanding OpenAPS-Overview/how-openaps-works-overview>
   How this guide works/overview of steps <docs/Understanding OpenAPS-Overview/overview-of-build-process>
   Where to go for help <docs/Understanding OpenAPS-Overview/communication-support-channels>

.. toctree::
   :maxdepth: 2
   :caption: Gear Up

   docs/Gear Up/hardware
   Compatible Pumps <docs/Gear Up/pump>
   Compatible CGMs <docs/Gear Up/CGM>
   Get your rig parts <docs/Gear Up/edison>

.. toctree::
   :maxdepth: 2
   :caption: While You Wait For Gear

   Collect your data & prepare <docs/While You Wait For Gear/collect-data-and-prepare>
   Make Your First PR <docs/While You Wait For Gear/loops-in-progress>
   Setting up Nightscout  <docs/While You Wait For Gear/nightscout-setup>
   Understand your rig <docs/While You Wait For Gear/understanding-your-Explorer-Board-rig>
   Entering carbs & boluses </docs/While You Wait For Gear/entering-carbs-bolus>
   How OpenAPS makes decisions <docs/While You Wait For Gear/Understand-determine-basal>
   Monitoring OpenAPS <docs/While You Wait For Gear/monitoring-OpenAPS>
   Preferences and Safety Settings <docs/While You Wait For Gear/preferences-and-safety-settings>
   Understanding your wifi options <docs/While You Wait For Gear/understanding-wifi-options>

.. toctree::
   :maxdepth: 2
   :caption: Build Your Rig

   Installing OpenAPS <docs/Build Your Rig/OpenAPS-install>
   Tell us you’re looping <docs/Build Your Rig/keeping-up-to-date>

.. toctree::
   :maxdepth: 2
   :caption: Customize-Iterate

   Optimizing Your Settings <docs/Customize-Iterate/optimize-your-settings>
   Offline Looping <docs/Customize-Iterate/offline-looping-and-monitoring>
   Enable Bluetooth tethering <docs/Customize-Iterate/bluetooth-tethering-edison>
   Add more wifi to your rig <docs/Customize-Iterate/on-the-go-wifi-adding>
   Useful apps for accessing your rig </docs/Customize-Iterate/useful-mobile-apps>
   IFTTT and Pebble buttons <docs/Customize-Iterate/ifttt-integration>
   iPhone Shortcuts buttons <docs/Customize-Iterate/iPhone Shortcuts Integration>
   Autosens <docs/Customize-Iterate/autosens>
   Autotune <docs/Customize-Iterate/autotune>
   Understanding Autotune <docs/Customize-Iterate/understanding-autotune>
   oref1: SMB and UAM <docs/Customize-Iterate/oref1>
   Tips & tricks <docs/Customize-Iterate/usability-considerations>
   Update your rig in the future <docs/Customize-Iterate/update-your-rig>
   How to run again <docs/Customize-Iterate/oref0-runagain>

.. toctree::
   :maxdepth: 2
   :caption: Troubleshooting

   Troubleshooting oref0-setup <docs/Troubleshooting/oref0-setup-troubleshooting>
   General linux troubleshooting <docs/Troubleshooting/General_linux_troubleshooting>
   Pump-rig troubleshooting <docs/Troubleshooting/Pump-rig-communications-troubleshooting>
   CGM-rig troubleshooting <docs/Troubleshooting/CGM-rig-communications-troubleshooting>
   Rig-NS troubleshooting <docs/Troubleshooting/Rig-NS-communications-troubleshooting>
   Flashing and updating Jubilinux <docs/Troubleshooting/Flashing-and-updating-Jubilinux>

.. toctree::
   :maxdepth: 2
   :caption: Give Back-Pay It Forward

   Donate your data <docs/Give Back-Pay It Forward/data-commons-data-donation>
   Help others - pay it forward <docs/Give Back-Pay It Forward/contribute>

.. toctree::
   :maxdepth: 2
   :caption: Resources/Reference

   Resources <docs/Resources/index>
   For Clinicians <docs/Resources/clinician-guide-to-OpenAPS>