diff --git a/docs/browser/build-dev-browser.md b/docs/browser/build-dev-browser.md index 74aeca1f409..eccdb99896e 100644 --- a/docs/browser/build-dev-browser.md +++ b/docs/browser/build-dev-browser.md @@ -47,16 +47,8 @@ Your `LoopWorkspace fork` is at `https://github.com/username/LoopWorkspace` wher If you're building `dev`, you can skip ahead to [Add `Branch`](#add-branch). If you're building a feature branch, copy the branch name into your paste buffer to minimize typographical errors. -``` { .bash .copy title="Add Dana and Medtrum pumps to dev branch" } -feat/dev-dana-medtrum -``` - -``` { .bash .copy title="Add Dana and Medtrum pumps, Eversense CGM to dev branch" } -feat/eversense -``` - -``` { .bash .copy title="Add Dana, Medtrum and All Omnipod Types, Eversense CGM to dev branch" } -feat/omnipodkit +``` { .bash .copy title="Branch to Add Dana Pump Support" } +feat/all-managers ``` ### Add `Branch` diff --git a/docs/build/cgm.md b/docs/build/cgm.md index 0001c173f13..012133a602e 100644 --- a/docs/build/cgm.md +++ b/docs/build/cgm.md @@ -62,7 +62,7 @@ With Loop 3.4 and newer versions, some *Libre* CGM are supported. ## *Eversense* E3 and 365 CGM {width="150"} -Both the Eversense E3 (90 days & 180 days) and the Eversense 365 (full year) transmitters are supported, on an experimental branch feat/eversense. +Both the Eversense E3 (90 days & 180 days) and the Eversense 365 (full year) transmitters are supported, on the `dev` branch with v3.14.2. * See [Loop Development: Branches](../version/development.md#branches){: target="_blank" } for more information on how to build this branch. diff --git a/docs/build/pump.md b/docs/build/pump.md index b7849486bd3..73c1a132d6f 100644 --- a/docs/build/pump.md +++ b/docs/build/pump.md @@ -26,12 +26,12 @@ These types of pumps are compatible with the *Loop* app. * [Older Medtronic pumps](pump.md#check-medtronic-pump-version) * [Omnipod Eros pumps](pump.md#omnipod-pumps) * [Omnipod DASH pumps](#omnipod-dash) - * See caveat about [iPhone 16](phone.md#compatible-device){: target="_blank" } + * See caveat about [iPhone 16 and 17e](phone.md#compatible-device){: target="_blank" } +* [Medtrum Touchcare Nano](#medtrum-nano) (included in `dev` branch, planned for next release) -You must build a special branch to test these pumps. Please only test if you are willing to update frequently, pay close attention and return to open loop as needed. +You must build a special branch to test some pumps. Please only test if you are willing to update frequently, pay close attention and return to open loop as needed. -* [Dana-i / DanaRS-v3](#sooil-dana-pumps) (new pump manager, work in progress) -* [Medtrum Touchcare Nano](#medtrum-nano) (new pump manager, work in progress) +* [Dana-i / DanaRS-v3](#sooil-dana-pumps) (new pump manager, work in progress, included in `feat/all-managers` branch) ## Check Medtronic Pump Version @@ -196,7 +196,7 @@ Loop does not support Omnipod 5 pods. ## Sooil Dana pumps !!! warning "You must build a feature branch to use Dana pumps" - Dana is supported in both of [these feature branches](../version/development.md#feature-branch-dana-and-medtrum-support){: target="_blank" }, `feat/dev-dana-medtrum` or `feat/eversense`. + Dana is supported in [`feat/all-managers` feature branch](../version/development.md#feature-branch-featall-managers){: target="_blank" }. * You must follow [zulipchat DanaKit topic](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/DanaKit.20Troubleshooting/with/547829260) @@ -224,14 +224,7 @@ The DanaRS was first released in 2002, with firmware version v1 which is not sup ## Medtrum Nano -!!! warning "You must build a feature branch to use Medtrum pumps" - Medtrum Nano is supported in both of [these feature branches](../version/development.md#feature-branch-dana-and-medtrum-support){: target="_blank" }, `feat/dev-dana-medtrum` or `feat/eversense`. - - * You must follow [zulipchat Medtrum channel](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/Medtrum.20Nano.20-.20pumps.20for.20development.20use/with/481836247) - - Read this section in LoopDocs: - - * [Medtrum Nano](../loop-3/add-pump.md#medtrum-nano){: target="_blank" } +Medtrum support was added to the `dev` branch in version 3.14.2, and will be included in the next release. !!! info "All versions are supported!" Both 200U (MD0201 & MD8201) and 300U (MD8301) version are supported with the correct version of the *Loop* app. diff --git a/docs/faqs/cgm-faqs.md b/docs/faqs/cgm-faqs.md index 1e90f18d88c..dfae64ec901 100644 --- a/docs/faqs/cgm-faqs.md +++ b/docs/faqs/cgm-faqs.md @@ -131,10 +131,7 @@ If you prefer not to customize Loop, then you can configure [Nightscout](https:/ ## Can I use Eversense E3 or Eversense 365? -Using the experimental branch, feat/eversense using Loop 3.11.0 or newer, you can make a native connection to your Eversense E3 or 365. - -* See [Loop Development: Branches](../version/development.md#branches){: target="_blank" } for more information on how to build this branch. - +With `dev` branch, 3.14.2 and later, Eversense is included in the Loop build. ## Can the *Loop* app read CGM data from Nightscout? diff --git a/docs/intro/overview-intro.md b/docs/intro/overview-intro.md index d74c65afe1e..c7239dc5c49 100644 --- a/docs/intro/overview-intro.md +++ b/docs/intro/overview-intro.md @@ -98,3 +98,6 @@ Here are development history links to other resources for you to explore. * How the Omnipod Eros pods were cracked to work with Loop: * [Insulin Pumps, Decapped Chips and Software Defined Radios](https://medium.com/@ps2) written by Loop developer Pete Schwamb * [Deep Dip Teardown of Tubeless Insulin Pump](https://arxiv.org/ftp/arxiv/papers/1709/1709.06026.pdf) by Sergei Skorobogatov + +* What role does *Tidepool* play in *Loop* development? + * Please see [Relationship with *Tidepool Loop*](../version/development.md#relationship-with-tidepool-loop){: target="_blank" } diff --git a/docs/loop-3/add-cgm.md b/docs/loop-3/add-cgm.md index d787f24ad7f..aab9ce02b3a 100644 --- a/docs/loop-3/add-cgm.md +++ b/docs/loop-3/add-cgm.md @@ -15,7 +15,7 @@ Loop can be connected to the following CGMs: * [Dexcom G7 or ONE+](#dexcom-g7-or-one) * [Libre](#libre) **(Loop 3.4 and later)** * Only some Libre sensors are supported; some have encryption that limits DIY use - * [Eversense E3/365](#eversense-e3365) **Experimental branch only** + * [Eversense E3/365](#eversense-e3365) **`dev` branch, v3.14.2** * [Minimed Enlite CGM](#medtronic-enlite-cgm) * Medtronic Pump only * **You must [add the Medtronic pump](add-pump.md) first** @@ -158,6 +158,8 @@ With Eversense added to *Loop* you get direct connection to your transmitter for The *Loop* app does not have glucose notification features, at this time. You can enable the on-transmitter notification within the *Loop* app so the transmitter will vibrate to alert you of an issue. +The Eversense implementation for Loop (and other OS-AID systems) enables you to upload your readings through the Eversense system and to use the Eversense NOW app. You can invite people to follow your CGM values. + Review the graphic and text below for the steps to add the Eversense CGM. Note the middle screen of that graphic is only shown for the 365 transmitter. The E3 does not require a login step. {width="750"} @@ -184,10 +186,7 @@ If you are having trouble with connecting to the Eversense, try these steps. #### Important Information -!!! warning "You must build feat/eversense branch to use the Eversense CGM" - The Eversense CGM is in feat/eversense (as of version v3.11.0) and is experimental as of now. - - This branch adds the [EversenseKit](https://github.com/loopandlearn/EversenseKit) repository to the *Loop* app. +!!! warning "You must build the `dev` branch to use the Eversense CGM" !!! important "Wait till initialization phase is completed" During the initialization phase after insertion of a new sensor, the glucose reading might be incorrect. diff --git a/docs/loop-3/add-pump.md b/docs/loop-3/add-pump.md index e4dcc76f735..7732479ee15 100644 --- a/docs/loop-3/add-pump.md +++ b/docs/loop-3/add-pump.md @@ -17,10 +17,10 @@ Loopers can choose from multiple pumps and a simulator: * Please refer to [Compatible Pump](../build/pump.md#check-medtronic-pump-version) for additional details * Omnipod * Omnipod DASH -* [All Omnipod Types](../version/development.md#feature-branch-omnipodkit-pump-manager){: target="_blank" } (available with `feat/omnipodkit` feature branch) +* [All Omnipod Types](../version/development.md#transition-to-omnipodkit){: target="_blank" } (available with `dev` v3.14.2) * Dana-i / DanaRS-v3 (**work-in-progress; new pump manager, use with care**) * Note: DanaRS-v1 or any Dana Korean versions are not supported -* Medtrum Nano patch pump (**work-in-progress; new pump manager, use with care**) +* Medtrum Nano patch pump (available in `dev` branch, v3.14.2) * Insulin Pump Simulator !!! info "Omnipod Terms" @@ -56,7 +56,7 @@ Here is an overview of the different steps for adding each pump. Before changin #### Other Pumps -> These are new pump managers that can be built using one of [two feature branches](../version/development.md#feature-branch-dana-and-medtrum-support){: target="_blank" }, `feat/dev-dana-medtrum` or `feat/eversense`. +> These are new pump managers that can be built using the `dev` branch for Medtrum or a [feature branch for Dana](../version/development.md#status-for-dana-support){: target="_blank" }. * [Dana-i / DanaRS-v3](#dana-i-danars-v3) * [Medtrum Nano](#medtrum-nano) @@ -250,13 +250,15 @@ The Medtronic status and commands available are shown in the [Pump Settings](med ### Dana is a New Pump Manager -**WARNING: Dana support in Loop is a work-in-progress; this is one of several new pump managers.** +**WARNING: Dana support in Loop is a work-in-progress.** ### Before Testing Dana -You must build a feature branch to get Dana support in Loop. You can use either one of two feature branches: `feat/dev-dana-medtrum` or `feat/eversense`. +You must build a feature branch to get Dana support in Loop -* Please refer to information summarized at [Feature Branch: Dana and Medtrum Support](../version/development.md#feature-branch-dana-and-medtrum-support){: target="_blank" }. +* `feat/all-managers`. + +* Please refer to information summarized at [Status for Dana Support](../version/development.md#status-for-dana-support){: target="_blank" }. ### When Testing Dana @@ -375,16 +377,9 @@ Therefore, it is important to check if your CGM provides a heartbeat. If it does ### Medtrum is a New Pump Manager -**WARNING: Medtrum support in Loop is a work-in-progress; this is one of several new pump managers.** - -You must build a feature branch to get Medtrum support in Loop. You can use either one of two feature branches: `feat/dev-dana-medtrum` or `feat/eversense`. - -* Please refer to information summarized at [Feature Branch: Dana and Medtrum Support](../version/development.md#feature-branch-dana-and-medtrum-support){: target="_blank" }. - - -### When Testing Medtrum Nano +**Medtrum is available in `dev` branch, v3.14.2.** -* Please do not use Medtrum Nano with Loop unless you are willing to test and communicate with [developers on zulipchat in the Medtrum channel](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/Medtrum.20Nano.20-.20pumps.20for.20development.20use/with/481836247) +You must build the `dev` branch to get Medtrum support in Loop. ### Confirm Patch and Pump Base are Compatible diff --git a/docs/loop-3/dana.md b/docs/loop-3/dana.md index 31b36d99a6c..a34d6be4cbf 100644 --- a/docs/loop-3/dana.md +++ b/docs/loop-3/dana.md @@ -16,9 +16,8 @@ ### Testing Dana with the *Loop* App -* The branch needed to get Dana in *Loop* is: `feat/dev-dana-medtrum` +* The branch needed to get Dana in *Loop* is: `feat/all-managers` * This branch is subject to rapid updates - * If you also want to use the Eversense CGM, the `feat/eversense` branch provides support for Dana and Medtrum along with the Eversense CGM * Please refer to the [zulipchat Loop-dev development channel](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/Loop-dev.20Status/with/515372445) before building this branch. diff --git a/docs/loop-3/eversense.md b/docs/loop-3/eversense.md index ee33afdf7dd..d28d0c98982 100644 --- a/docs/loop-3/eversense.md +++ b/docs/loop-3/eversense.md @@ -6,13 +6,9 @@ Please review the [EversenseKit Issues](https://github.com/bastiaanv/EversenseKit/issues) page for open issues reported for the EversenseKit CGM Manager. -## Testing Eversense with the *Loop* App +## Using Eversense with the *Loop* App -* The branch needed to get Eversense in *Loop* is: `feat/eversense` - * This branch is subject to rapid updates - * This branch provides support for Dana and Medtrum along with the Eversense CGM - -* Please refer to the [zulipchat Loop-dev development channel](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/Loop-dev.20Status/with/515372445) before building this branch. +Eversense support was added to the `dev` branch in version 3.14.2. ## Eversense 365 Screen diff --git a/docs/loop-3/medtrum.md b/docs/loop-3/medtrum.md index 42773ccfadf..b4464c1b04f 100644 --- a/docs/loop-3/medtrum.md +++ b/docs/loop-3/medtrum.md @@ -8,20 +8,12 @@ ## Medtrum Nano Pump -The Medtrum Nano Pump is supported using the *Loop* app built with a feature branch. See [Feature Branches](../version/development.md#how-to-build-feature-branches){: target="_blank" } for building instructions. +The Medtrum Nano Pump support was added to the `dev` branch in version 3.14.2. * The pump patch is designed to be changed every 3 days * The pump base is reusable - do not accidentally discard the base after removing the patch * Versions 200U (MD0201 & MD8201) and 300U (MD8301) are supported -### Testing Medtrum with the *Loop* App - -* The branch needed to get Medtrum in *Loop* is: `feat/dev-dana-medtrum` - * This branch is subject to rapid updates - * If you also want to use the Eversense CGM, the `feat/eversense` branch provides support for Dana and Medtrum along with the Eversense CGM - -* Please refer to the [zulipchat Loop-dev development channel](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/Loop-dev.20Status/with/515372445) before building this branch. - - - - ## Medtrum Nano Screen diff --git a/docs/loop-3/settings.md b/docs/loop-3/settings.md index 4447ddf6b98..cc5ba079569 100644 --- a/docs/loop-3/settings.md +++ b/docs/loop-3/settings.md @@ -160,11 +160,8 @@ The information about the pump section is detailed on several different pages. F * [Add or Modify Pump](add-pump.md) * [Omnipod or Omnipod DASH](omnipod.md) Status and Commands * [Medtronic](medtronic.md) Status and Commands - -There are several new pump managers available when you [build a feature branch](../version/development.md#feature-branch-dana-and-medtrum-support){: target="_blank" }: - -* [Dana Pumps](dana.md) -* [Medtrum Pumps](medtrum.md) +* [Medtrum Pumps](medtrum.md) requires `dev` branch +* [Dana Pumps](dana.md) requires a feature branch: [Status for Dana Support](../version/development.md#status-for-dana-support){: target="_blank" }: ### [CGM Settings](add-cgm.md) diff --git a/docs/troubleshooting/dana-faq.md b/docs/troubleshooting/dana-faq.md index 04c87fbb33c..ae849b56938 100644 --- a/docs/troubleshooting/dana-faq.md +++ b/docs/troubleshooting/dana-faq.md @@ -10,13 +10,9 @@ ## Branch for Dana -You may choose one of two feature branches to get Dana in Loop +You must build the `feat/all-managers` branch to get support for Dana. -* `feat/dev-dana-medtrum`: adds support for Dana and Medtrum pumps -* `feat/eversense`: adds support for the Eversense CGM in addition to the Dana and Medtrum pumps - - -These branches are subject to rapid updates. Any updates to Dana and Medtrum pumps are found in both branches. +This branch is subject to rapid updates. ## Q: How long should the Dana pump last on a battery? diff --git a/docs/version/development.md b/docs/version/development.md index e6433246f70..2cb1906eadc 100644 --- a/docs/version/development.md +++ b/docs/version/development.md @@ -6,12 +6,29 @@ The [*Loop* Releases](releases.md){: target="_blank"} page lists releases since The current released version of the *Loop* app is always in the `main` branch of the LoopWorkspace repository. + +### Relationship with *Tidepool Loop* + +*Tidepool Loop* is an independent version of *Loop*. *Tidepool Loop* started with *Loop* code, added safety features, and additional FDA approved device integrations. Much of the *Tidepool Loop* improvements are also published as open source, which volunteers in the community are free to incorporate back into *Loop*. The device integrations for *Tidepool Loop* are generally closed source when required by device manufacturers. + +* In 2019, the non-profit *Tidepool* organization partnered with the JAEB Foundation to review outcomes from volunteers using *Loop* + * *Tidepool* successfully submitted *Tidepool Loop* to the Federal Drug Administration as an approved automated insulin delivery system + * *Tidepool Loop* is available now, please see their website for more information: [*Tidepool Loop*](https://www.tidepool.org/tidepool-loop) +* In 2022, some of the *Tidepool* open-source code was brought into the *Loop* project by dedicated volunteers and eventually released as *Loop* 3 + * The traditional OS-AID process of community volunteers providing updates continued throughout +* In 2026, volunteers are once-again bringing in upgrades from *Tidepool* open-source code, laying the foundation for what will be *Loop* 4. + * Look for upcoming information about `next-dev` branch - it is awesome, but still being tested + * If you are interested, follow along in [zulipchat: Loop next-dev Status](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/Loop.20next-dev.20Status/with/600761707) + +### Development Branches and Breaking Changes + The next version of the *Loop* app is developed using branches. * The `dev` branch is used by the developers to push out changes for users to test before that code is released - * Sometimes there are breaking changes in `dev` - * A breaking change is when you can build the `dev` branch over your existing app, but cannot leave the `dev` branch without deleting your app from your phone - * It's been a few years since this happened (when we went from Loop 2 to Loop 3), but it will be happening again soon with an upcoming merge from Tidepool + * Sometimes there are breaking changes + * A breaking change is when you can build the new branch over your existing app, but cannot go backwards without deleting your app from your phone + * We are bringing in updates for Tidepool in a special branch `next-dev` + * Note that you might be able to go backward to `main` or `dev` from `next-dev` but it is not guaranteed * In addition there are specific feature branches that enable users to test new pump and cgm managers or features for existing managers before they are added to the `dev` branch * You should only test a development or feature branch if you are willing to be an active participant with the developers: * [Monitor announcements in zulipchat](https://loop.zulipchat.com/#narrow/channel/144182-development) @@ -25,7 +42,25 @@ Please read this entire page before using any version of *Loop* other than the r This section provides an overview of changes to `dev` compared to the current release: `Loop v3.14.0`. -The current version of `dev` is v3.14.1. It is functionally identical the released code. The only difference is we added an alert you must acknowledge if you are running the `dev` branch. +The current version of `dev` is v3.14.2. This has some very significant changes - please read the bullets and the Omnipod warning. + +* The Medtrum Nano 200 U / 300 U pump manager is added to the dev branch and will be in the next release +* The Eversense E3 and 365 sensor CGM manager is added to the dev branch and will be in the next release +* The unified OmnipodKit pump manager, which controls either Classic (Eros) or DASH pods, is added to the dev branch and will be in the next release + * The OmniBLE and OmniKit single-pod-type pump managers were removed from the dev branch + +!!! important "Omnipod Users cannot return to v3.14.0 after building v3.14.2 without replacing their Pod" + The new unified Omnipod Pump Manager, OmnipodKit, is the only Omnipod pump manager available in v3.14.2. + + If you are running a Pod, you can install v3.14.2 over v3.14.0 or earlier and the Pod control will automatically transition to the OmnipodKit Pump Manager. + + If you are running a Pod with v3.14.2, but reinstall 3.14.0 or earlier over it, there will not be an OmnipodKit Pump Manager available so you lose contact with your Pod. + + * If this happens to you: **install v3.14.2 on your phone and control will be restored**. + +For those on the Dana pump. You need to keep building a feature branch, but the name of the branch changed. The old one is still available but has been removed from LoopDocs. + +Please see [Table of Retired Branches](#table-of-retired-branches) for up to date information about what branch you need to build for Dana support. Please check the [development channel in zulipchat](https://loop.zulipchat.com/#narrow/channel/144182-development) for notifications when an update to the `dev` branch is expected so you will be prepared. Do this **before** you install a `dev` build from TestFlight. @@ -36,7 +71,7 @@ In addition to the main and dev branches, which are tightly controlled and only * The `update_dev_to_M.m.#` is where the next version of dev is tested before becoming part of `dev` and later being released as `main` * The branches starting with `feat/` have one or more special features, like support for new pumps, CGM or the new universal pump manager for all types of Omnipods -The graphic below shows the `main` and `dev` branches along with some feature branches and an update branch. +The graphic below shows the `main` and `dev` branches along with some feature branches and an update branch. This is a snapshot in time and no longer reflects the current status. Always check [Table of Active Branches](#table-of-active-branches). > {width="750"} {align="center"} @@ -47,22 +82,21 @@ The graphic below shows the `main` and `dev` branches along with some feature br * There are also feature branches for items like new pumps and new CGMs: * The feature branches typically spin off of `dev`, but if a `updates_dev_to_ . . .` branch is in work, it is merged into the feature branches as items get included -#### Table of Active Branches +### Table of Active Branches + +The table below lists active branches. -The table below lists active branches. Note that updates may occur and be announced in zulipchat a day or two before updates propogate to *LoopDocs*. +* Note that updates may occur and be announced in zulipchat a day or two before updates propagate to *LoopDocs* +* Anyone using a feature branch needs to be alert and check zulipchat regularly +* For example, while preparing for v3.14.2, older feature branches were retired + * Check the [Table of Retired Branches](#table-of-retired-branches) to get the support you need. |