Skip to content

Commit c37a099

Browse files
authored
update LoopDocs for dev version 3.11.1 (#987)
1 parent 7b1003d commit c37a099

5 files changed

Lines changed: 73 additions & 33 deletions

File tree

docs/browser/build-dev-browser.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Overview
22

3-
**This page is only relevant when building the `dev` branch with a browser.**
3+
**This page is only relevant when building the `dev` (or a feature) branch with a browser.**
44

55
**For *Mac*, please see: [Build Loop `dev` with *Mac*](../build/build-dev-mac.md)**
66

@@ -28,27 +28,46 @@ The graphics on this page show the `dev` branch. If you want a different branch,
2828
* You cannot just rename your existing branch to `dev` - you must get the `dev` branch from LoopKit
2929
1. When you select the action `4. Build Loop` and then click on the `Run Workflow` dropdown, you must select `dev` there before clicking the green `Run workflow` button - see [Build `Branch`](#build-branch)
3030

31-
3231
### Check Current `Branch`
3332

3433
Your `LoopWorkspace fork` is at `https://github.com/username/LoopWorkspace` where you substitute your actual *GitHub* `username`. You need to be logged into *GitHub*. Review the graphic below as you go through the steps.
3534

3635
1. Click on the `branch` icon to display the `branches` as shown in the lower half of the graphic below:
3736
* If the `branch` you want is not listed, then continue with Step 2
3837
* Otherwise, skip ahead to [Update `Branch`](#update-branch)
39-
1. Click on the `New branch` button and follow the [Add `Branch`](#add-branch) steps
38+
1. Click on the `New branch` button
39+
* To add the `dev` branch, go to the [Add `Branch`](#add-branch) instructions
40+
* To add a feature branch, start with [Feature `Branch`](#feature-branch) before continuing with the add `branch` instructions
4041

4142
![steps to add a branch](img/add-branch-01.svg){width="700"}
4243
{align="center"}
4344

45+
### Feature `Branch`
46+
47+
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.
48+
49+
50+
``` { .bash .copy }
51+
feat/pod-keep-alive
52+
```
53+
54+
``` { .bash .copy }
55+
feat/dev-dana-medtrum
56+
```
57+
58+
``` { .bash .copy }
59+
feat/eversense
60+
```
61+
4462
### Add `Branch`
4563

4664
Each step in the list below matches with the number in the graphic. In the top half of the graphic, the left side shows the initial display and the right side shows the display after making the indicated selections:
4765

4866
1. Click on the drop down menu labeled 1 in the graphic and choose LoopKit/LoopWorkspace as show in the top right graphic
4967
2. Click on the drop down menu labeled 2 in the graphic and choose `dev`
50-
3. Click on the `Branch` name box labeled 3 in the graphic and type `dev`
51-
* The branch name in your `fork` should always match the branch name you are adding; check that you type it correctly
68+
3. Click on the `Branch` name box labeled 3 in the graphic and type `dev` or paste the feature branch name from your paste buffer
69+
* The branch name in your `fork` should always match the branch name you are adding - it is best to use a paste buffer (to minimize typographical errors)
70+
* See [Feature Branch](#feature-branch) if you need to fill your paste buffer
5271
4. Review the dialog items to make sure everything is correct and then tap on Create branch
5372

5473
![steps to add a branch continued](img/add-branch-02.svg){width="700"}

docs/build/build-dev-mac.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
The same script is used to build the `dev` branch as is used to build the `main` branch. Copy and paste this command in any terminal. Follow the instructions on the screen. Choose Build Loop and then choose `dev` branch.
1515

16-
``` { title="Copy and Paste to start the BuildLoop Script" }
16+
``` { .bash .copy title="Copy and Paste to start the BuildLoop Script" }
1717
/bin/bash -c "$(curl -fsSL \
1818
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildSelectScript.sh)"
1919
```
@@ -34,15 +34,15 @@ In the command (shown below), there is a space after the final quote, followed b
3434

3535
> This is just an example. You need to substitute the branch you desire for `other-branch`. The example below uses a continuation character to put the extra characters on a new line to make this easier to read.
3636
37-
``` { title="Replace <code>other-branch</code> with the desired branch" }
37+
``` { .bash .copy title="Replace <code>other-branch</code> with the desired branch" }
3838
/bin/bash -c "$(curl -fsSL \
3939
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoop.sh)" \
4040
- other-branch
4141
```
4242

4343
If you want to customize this custom branch. You can call the Customization Select script after you download the custom branch. This script finds the most recent download in your ~/Downloads/BuildLoop folder. If you want to customize a specific branch, first set the terminal to be in the LoopWorkspace folder for the download you want to customize.
4444

45-
``` { title="Copy and paste to start the CustomizationSelect script" }
45+
``` { .bash .copy title="Copy and paste to start the CustomizationSelect script" }
4646
/bin/bash -c "$(curl -fsSL \
4747
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/CustomizationSelect.sh)"
4848
```

docs/build/cgm.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@
1414
* *Dexcom* ONE+ (based off G7 sensor) is available in some countries
1515
- *Medtronic* sensors connected to a Loop-compatible *Medtronic* pumps
1616
- Some *Libre* sensors
17-
- Eversense XL & 365 sensors
17+
- Eversense E3 and 365 sensors
1818

1919
!!! question "FAQs"
2020

2121
- **"What about other *Libre* sensors?"**
2222
1. Only some *Libre* sensors have methods to read them directly on an iPhone
2323
2. There are more methods for Android
2424
3. See also [CGM Customization](../faqs/cgm-faqs.md#cgm-customization){: target="_blank" }
25-
- **"What about Eversense?"** Refer to [CGMs Not Supported in the *Loop* App](#cgms-not-supported-in-the-loop-app)
25+
- **"What about Eversense?"** Refer to [*Eversense* E3 and 365 CGM](#eversense-e3-and-365-cgm)
2626

2727

2828
## Continuous Glucose Monitor (CGM)
@@ -59,13 +59,15 @@ With Loop 3.4 and newer versions, some *Libre* CGM are supported.
5959
* *Libre* 3
6060
* See [CGM Customization](../faqs/cgm-faqs.md#cgm-customization){: target="_blank" }
6161

62-
## *Eversense* E3 & 365 CGM
62+
## *Eversense* E3 and 365 CGM
6363
![img/eversense.png](img/eversense.png){width="150"}
6464

6565
Both the Eversense E3 (90 days & 180 days) and the Eversense 365 (full year) transmitters are supported, on an experimental branch feat/eversense.
6666

67-
Eversense E3 & 365 are implantable continuous glucose monitoring (CGM) systems with a sensor inserted under the skin and a removable on-body transmitter that sends real-time glucose data and alerts to the *Loop* app.
68-
Unlike traditional CGMs that require frequent sensor changes, Eversense reduces insertion frequency but requires regular fingerstick calibrations.
67+
* See [Loop Development: Branches](../version/development.md#branches){: target="_blank" } for more information on how to build this branch.
68+
69+
Eversense E3 and 365 are implantable continuous glucose monitoring (CGM) systems with a sensor inserted under the skin and a removable on-body transmitter that sends real-time glucose data and alerts to the *Loop* app.
70+
Unlike traditional CGMs that require frequent sensor changes, Eversense reduces insertion frequency but requires weekly fingerstick calibrations.
6971

7072
## *Medtronic* CGM
7173
![img/enlite.png](img/enlite.png){width="150"}
@@ -87,13 +89,13 @@ The *Loop* app can download *Dexcom* Share data for use in modeling glucose. How
8789

8890
## Nightscout as a Remote CGM
8991

90-
Version 3 or later of the *Loop* app can use Nightscout as a remote source for CGM data. This requires cell or WiFi connection.
92+
The *Loop* app allows you to use Nightscout as a remote source for CGM data. This requires cell or WiFi connection.
9193

9294

9395
## CGMs Not Supported in the *Loop* App
9496

9597

96-
Currently, there are no solutions for *Eversense*, *Guardian* or *Libre 3* CGM to be used directly with the *Loop* app, but some [Uploaders](https://nightscout.github.io/uploader/uploaders/) to Nightscout are available using an Android phone. Version 3 or later of the *Loop* app allows the use of Nightscout as a CGM source.
98+
Currently, there are no solutions for *Guardian* or *Libre 3* CGM to be used directly with the *Loop* app, but some [Uploaders](https://nightscout.github.io/uploader/uploaders/) to Nightscout are available using an Android phone. Version 3 or later of the *Loop* app allows the use of Nightscout as a CGM source.
9799

98100
## Next Step
99101

docs/faqs/cgm-faqs.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The following CGM are supported by some or all versions of Loop:
44

55
* All *Dexcom* CGM (Loop 3 and later)
66
* Some *Libre* CGM (Loop 3.4 and later)
7-
* Eversense E3 & 365 (Loop 3.11 and later, via experimental branch)
7+
* Eversense E3 and 365 (Loop 3.11 and later, via an experimental feature branch)
88
* Medtronic Enlite CGM when used with a compatible pump
99
* Remote CGM (requires internet access)
1010
* *Dexcom* Share
@@ -131,7 +131,10 @@ If you prefer not to customize Loop, then you can configure [Nightscout](https:/
131131

132132
## Can I use Eversense E3 or Eversense 365?
133133

134-
Using the experimental branch, feat/eversense using Loop 3.11.0, you can make a native connection to your Eversense E3 and 365.
134+
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.
135+
136+
* See [Loop Development: Branches](../version/development.md#branches){: target="_blank" } for more information on how to build this branch.
137+
135138

136139
## Can the *Loop* app read CGM data from Nightscout?
137140

docs/version/development.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ The early history of the *Loop* app was touched on in the introductory [*LoopDoc
44

55
The [*Loop* Releases](../version/releases.md) page lists releases since version 2.0 in reverse chronological order.
66

7-
The next version of the *Loop* app is developed using branch(es), independent of the released *Loop* version, which is found in <span>the `main` branch</span>. <span>The `dev` branch</span> is used by the developers to push out changes for users to test. You should only test a development branch if you are willing to be both an active participant with the developers to monitor announcements and provide feedback and to build frequently to obtain the latest feature or bug-fix that is being tested. If you are willing to help out - this is the way the next release of *Loop* is improved.
7+
The next version of the *Loop* app is developed using branch(es), independent of the released *Loop* version, which is found in <span>the `main` branch</span>.
8+
9+
<span>The `dev` branch</span> is used by the developers to push out changes for users to test. You should only test a development branch if you are willing to be both an active participant with the developers to monitor announcements and provide feedback and to build frequently to obtain the latest feature or bug-fix that is being tested. If you are willing to help out - this is the way the next release of *Loop* is improved.
810

911
If you choose to use `dev`, you accept that this code is not released.
1012

@@ -14,7 +16,8 @@ Please read this entire page before using any version of *Loop* other than the r
1416

1517
This section provides an overview of changes to `dev` compared to `Loop v3.10.0`.
1618

17-
A few days after v3.10.0 was released, the dev branch was updated to be identical to main except for version number of 3.11.0. Work leading to the next update for `dev` is found in the `update_dev_to_3.11.1` branch.
19+
The current version of `dev` is v3.11.1.
20+
1821

1922
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.
2023

@@ -43,11 +46,10 @@ The table below lists active branches. Note that updates may occur and be announ
4346
| <div style="width:140px"> branch | version # | <div style="width:140px">last updated | comments |
4447
|:--|:--|:--|:--|
4548
| main | 3.10.0 | 10 Jan 2026 | release|
46-
| dev | 3.11.0 | 11 Jan 2026 | same as main, except version number |
47-
| [update_dev_to_3.11.1](#update-to-dev-3111) | 3.11.1 | 02 Feb 2026 | collect updates for the next version of dev <br>Details are in [PR 408](https://github.com/LoopKit/LoopWorkspace/pull/408) |
48-
| [feat/pod-keep-alive](#feature-branch-pod-keep-alive-feature)<br>- SHA `783d390` | 3.11.1 | 02 Feb 2026| - uses the OmniBLE pod-keep-alive branch to support users of iPhone 16 phones with InPlay BLE (-Atlas) DASH pods<br> - SHA for OmniBLE is `9992773`<br>**Please read [Feature Branch: Pod Keep Alive Feature](#feature-branch-pod-keep-alive-feature)** |
49-
| [feat/dev-dana-medtrum](#feature-branch-medtrum-and-dana-support) <br>- SHA `0282e18` | 3.11.1 | 02 Feb 2026 | - adds experimental support for Dana and Medtrum pumps<br>- this branch is ready for expert testers to evaluate and report back<br> - SHA for DanaKit is `dbe63ae`<br> - SHA for MedtrumKit is `f21d808` |
50-
| [feat/eversense](#feature-branch-eversense-support) <br>- SHA `41d63dd` | 3.11.0 | 24 Jan 2026 | - adds experimental support for Eversense (includes Dana and Medtrum pumps support too)<br>- this branch is ready for expert testers to evaluate and report back<br> - SHA for Eversense is `a478d8f` |
49+
| dev | 3.11.1 | 17 Feb 2026 | updates with respect to `main` include<br>[PR 408](https://github.com/LoopKit/LoopWorkspace/pull/408) |
50+
| [feat/pod-keep-alive](#feature-branch-pod-keep-alive-feature)<br>- SHA `04dc876` | 3.11.1 | 17 Feb 2026| - uses the OmniBLE pod-keep-alive branch to support users of iPhone 16 phones with InPlay BLE (-Atlas) DASH pods<br> - SHA for OmniBLE is `9992773`<br>**Please read [Feature Branch: Pod Keep Alive Feature](#feature-branch-pod-keep-alive-feature)** |
51+
| [feat/dev-dana-medtrum](#feature-branch-medtrum-and-dana-support) <br>- SHA `865110f` | 3.11.1 | 17 Feb 2026 | - adds experimental support for Dana and Medtrum pumps<br>- this branch is ready for expert testers to evaluate and report back<br> - SHA for DanaKit is `dbe63ae` (Known TBR issues)<br> - SHA for MedtrumKit is `c79a883` (TBR issues fixed) |
52+
| [feat/eversense](#feature-branch-eversense-support) <br>- SHA `84bf0c7` | 3.11.0 | 17 Feb 2026 | - adds experimental support for Eversense (includes Dana and Medtrum pumps support too)<br>- this branch is ready for expert testers to evaluate and report back<br> - SHA for Eversense is `4a40994` |
5153

5254
!!! important "Eversense Support"
5355
The Eversense CGM is now supported by the *Loop* app in a feature branch. To simplify maintenance, the branch which supports Eversense also supports the two new pumps: Dana and Medtrum.
@@ -68,24 +70,28 @@ For full instructions on building different branches, review these pages:
6870
* [Browser Build: Build a Version in Development](../browser/build-dev-browser.md#build-development-version){: target="_blank" }
6971
* [Mac Xcode: Build a Version in Development](../build/build-dev-mac.md#build-other-branches){: target="_blank" }
7072

71-
For Browser Build, use the page linked above to add the desired branch name (from the table above) to your fork. In other words, where the directions indicate the `dev` branch, you substitute the branch name of interest.
73+
#### Browser Build
74+
75+
Use the page linked above to add the desired branch name (from the table above) to your fork. In other words, where the directions indicate the `dev` branch, you substitute the branch name of interest.
76+
77+
#### Mac-Xcode Build
7278

7379
For Mac Xcode build, the lines you need to copy and paste into a Terminal window are explicitly provided below:
7480

7581

76-
``` { title="Download and build the feat/pod-keep-alive branch" }
82+
``` { .bash .copy title="Download and build the feat/pod-keep-alive branch" }
7783
/bin/bash -c "$(curl -fsSL \
7884
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoop.sh)" \
7985
- feat/pod-keep-alive
8086
```
8187

82-
``` { title="Download and build the feat/dev-dana-medtrum branch" }
88+
``` { .bash .copy title="Download and build the feat/dev-dana-medtrum branch" }
8389
/bin/bash -c "$(curl -fsSL \
8490
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoop.sh)" \
8591
- feat/dev-dana-medtrum
8692
```
8793

88-
``` { title="Download and build the feat/eversense branch" }
94+
``` { .bash .copy title="Download and build the feat/eversense branch" }
8995
/bin/bash -c "$(curl -fsSL \
9096
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoop.sh)" \
9197
- feat/eversense
@@ -179,15 +185,25 @@ While RileyLink is selected, the app is triggered by the RileyLink one minute he
179185

180186
### Feature Branch: Medtrum and Dana Support
181187

182-
**Updates are believed to have fixed the active insulin issues reported for both Dana and Medtrum, but this should be tested by experts to confirm pumps are working well with Loop.**
188+
General statement about these pump managers. These were created for use with Trio and, at the time, some of the differences between the way Loop and other OS-AID systems handle insulin accounting were not completely understood.
189+
190+
* Initially the bolusing pump event problem was pointed out and a fix provided
191+
* There was still an issue with reporting temp basal pump events
192+
* This issue was fixed for MedtrumKit on 17 Feb 2026
193+
* See the now closed MedtrumKit Issue: [Loop and Medtrum Pump Manager: Basal Delivery Accounting is Not Correct](https://github.com/jbr7rr/MedtrumKit/issues/77)
194+
* Until there is time to ensure equivalent fixes to the DanaKit repository, those using Dana with Loop should only use Dosing Strategy of Automatic Bolus - the insulin accounting will still not be perfect, but using Automatic Bolus helps
195+
196+
Anyone uses these new pump managers need to be using either one of these branches:
197+
198+
* `feat/dev-dana-medtrum`
199+
* `feat/eversense`
183200

184201
!!! important "Experts Only"
185-
Please only use the `feat/dev-dana-medtrum` branch if you are prepared to follow along in zulipchat and are willing to test an experimental branch to help test and resolve issues.
202+
Please only use an experimental branch if you are prepared to follow along in zulipchat and are willing to help test and resolve issues.
186203

187-
* Please ensure you have the latest version of this branch by synching before you build:
188-
* `feat/dev-dana-medtrum`
204+
* Please ensure you have the latest version of a given branch by synching before you build:
189205
* Mac-Xcode: type `git pull --recurse` to update an existing clone or download a fresh copy
190-
* Browser Build, the Build Loop action, with the `feat/dev-dana-medtrum` branch selected should automatically sync your fork for you
206+
* Browser Build, the Build Loop action, with the `feat/dev-dana-medtrum` or `feat/eversense` branch selected should automatically sync your fork for you
191207

192208

193209
### Feature Branch: Eversense Support

0 commit comments

Comments
 (0)