Skip to content

Commit b61e74f

Browse files
committed
update for release 3.10.0
1 parent 5d892e3 commit b61e74f

File tree

6 files changed

+165
-99
lines changed

6 files changed

+165
-99
lines changed

docs/browser/automatic.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ The instructions provided for building with a browser include settings to automa
44

55
## Manual Action for Automatic Build
66

7-
!!! important "Automatic Build Requires Manual Action"
7+
!!! warning "Browser Build for *Loop* Disabled?"
8+
We do not know why, but GitHub is disabling the Build Loop Action for LoopWorkspace even though the repository is not stale.
9+
10+
If this is happening to you, see [What Manual Action is Required?](#what-manual-action-is-required).
11+
12+
* The automatic build actions should occur every Sunday
13+
* The automatic build using the same code works for all OS-AID apps except for *Loop*
14+
* See this [GitHub Discussion topic for details](https://github.com/orgs/community/discussions/181236)
15+
16+
??? tip "Stale Repositoriy Always Requires Manual Action (Click to Open Close)"
817
*GitHub* automatically **disables actions** that run according to a schedule if the repository in question is **inactive**.
918

1019
What does that mean?
1120

1221
* **inactive** means stable code (no new commit within the last 60 days)
1322
* **disables actions** means the Build Action shows up as disabled
1423

15-
!!! warning "Browser Build Disabled"
16-
We do not know why, but GitHub is disabling the Build Loop Action for LoopWorkspace even though the repository is not stale.
17-
18-
* The automatic build actions should occur every Sunday
19-
* The automatic build using the same code works for all OS-AID apps except for *Loop*
20-
* See this [GitHub Discussion topic for details](https://github.com/orgs/community/discussions/181236)
21-
2224
### What Manual Action is Required?
2325

2426
For any repository that shows the build action disabled, you should enable the action and do a manual build.
@@ -27,6 +29,7 @@ For any repository that shows the build action disabled, you should enable the a
2729
* Check that *TestFlight* has a new build of the *Loop* (or other) app
2830
* If not, go to your repository to see if the build action is disabled
2931
* If necessary, enable the build action at your repository as shown in the graphic below and then launch a manual build
32+
* If you are building any branch other than the default branch for your `fork`, don't forget to select that branch as part of Step 5 in the graphic below
3033

3134
![fix a disabled build state](img/build-disabled-fix.png )
3235

docs/loop-3/features.md

Lines changed: 58 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22

33
This page discusses some features new with Loop 3.
44

5+
- - -
6+
57
## Remote Carb / Bolus
68

7-
Loop 3 has a Remote Carb and Remote Bolus feature to enable remote caregivers to better assist the person who needs support managing with Loop. This requires the Loop user have a Nightscout site. Please review these pages:
9+
There are 2 ways to send remote commands:
10+
11+
* [Remote Control with *LoopFollow*](#remote-control-with-loopfollow)
12+
* [Remote Control with LoopCaregiver or Nighstcout](#remote-control-with-loopcaregiver-or-nightscout)
813

9-
* [Remote Overview](../nightscout/remote-overview.md)
10-
* [Remote Configuration](../nightscout/remote-config.md)
11-
* [Remote Commands](../nightscout/remote-commands.md)
12-
* [Remote Errors](../nightscout/remote-errors.md)
13-
* [<span translate="no">LoopCaregiver</span> App](../nightscout/loop-caregiver.md)
14+
The remote features were originally developed in coordination with the development of *LoopCaregiver* and updates to *Nightscout* were added at that time to support these remote features. Subsequent to that, [LoopFollow]() added code to directly send *Apple* push notifications to the *Loop* app, so offers a separate path for providing remote control for caregivers.
1415

1516
!!! warning "WARNING"
1617

17-
You will be using this feature at your own risk, like any other Loop code you build. It is very important you completely read and re-read the links listed above before getting started.
18+
You will be using this feature at your own risk, like any other Loop code you build. It is very important you completely read and re-read the links listed below before getting started.
1819

1920
Be aware:
2021

@@ -23,6 +24,37 @@ Loop 3 has a Remote Carb and Remote Bolus feature to enable remote caregivers to
2324
* There is no published limit, but consider limiting it to 1 or 2 per hour
2425
* When on cellular data, there may be further limitations to protect your data usage
2526

27+
The *Apple* limits on push notifications will limit *LoopFollow*, *LoopCaregiver* and direct use of the *Nightscout* `careportal`.
28+
29+
### Remote Control with *LoopFollow*
30+
31+
The *LoopFollow* app is very popular with caregivers and with people who use OS-AID for themselves because of the overview display and extensive, flexible alarm features. This can only be used on an iOS device: an iPhone, iPad or Mac. You can have copies of *LoopFollow* on multiple devices and share responsibility with multiple caregivers. So be careful in your usage.
32+
33+
Please refer to:
34+
35+
* [LoopFollowDocs](https://loopfollowdocs.org/)
36+
* [LoopFollowDocs: Remote Control](https://loopfollowdocs.org/remote/remote-control-overview/)
37+
38+
39+
### Remote Control with *LoopCaregiver* or *Nightscout*
40+
41+
Loop 3 supports Remote Carb and Remote Bolus feature to enable remote caregivers to better assist the person who needs support managing with Loop. This requires the Loop user have a Nightscout site. Please review these pages housed in *LoopDocs*:
42+
43+
* [Remote Overview](../nightscout/remote-overview.md){: target="_blank" }
44+
* [Remote Configuration](../nightscout/remote-config.md){: target="_blank" }
45+
* [Remote Commands](../nightscout/remote-commands.md){: target="_blank" }
46+
* [Remote Errors](../nightscout/remote-errors.md){: target="_blank" }
47+
* [<span translate="no">LoopCaregiver</span> App](../nightscout/loop-caregiver.md){: target="_blank" }
48+
49+
### Remote Control of More than One Person
50+
51+
You can use the same *Apple* push notification credentials to support more than one person.
52+
53+
* Each person must have their own unique *Nightscout* URL
54+
* For LoopFollow, each person has their own app and you can personalize that app with their name and icon
55+
* Refer to [LoopFollowDocs: Multiple People]()
56+
* For LoopCaregiver, each person is added to the same *LoopCaregiver* app and you switch between people in the app
57+
2658
## **New with Loop 3.4.0**
2759

2860
Additional details about the 3.4.0 release are found here: [Version: Releases: 3.4.0](../version/releases.md#loop-v340){: target="_blank" }
@@ -220,3 +252,22 @@ With Loop 3, the "old" method still works, but there is a new method for enterin
220252
* Tap on `Log Dose` to record or `Cancel` to quit
221253

222254
![entering non-pump insulin into Loop](img/non-pump-insulin.svg){width="500"}
255+
256+
## New with Loop v3.10.0
257+
258+
### Live Activity
259+
260+
Live Activity was added to Loop with [Loop PR 2919](https://github.com/LoopKit/Loop/pull/2191#issuecomment-3565473537). Many people have been using this as a customization. If you used the customization - you need to stop selecting `live_activity` as a customization or your build will fail.
261+
262+
* The configuration for the Live Activity widget on the lock screen is found under Loop, Settings, Notifications, Live Activity
263+
* You must also enable Live Activity under iPhone settings, Loop, tap on Live Activites and enable Allow Live Activites and More Frequent Update
264+
265+
##### Requirements for Live Activities
266+
267+
* The dynamic island is only available for iPhone versions 14 pro and newer; but Live Activity on the Lock Screen is supported for older phones running iOS 16 or newer
268+
* iOS 18 and watchOS 10 or newer are required for Live Activity to appear in the Smart Stack on the Apple Watch
269+
* iOS 26 or newer is required to have Live Activity appear in the CarPlay view
270+
271+
### ToDo
272+
273+
Add Live Activity Documentation

docs/version/development.md

Lines changed: 36 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ Please read this entire page before using any version of *Loop* other than the r
1212

1313
## Updates in `dev`
1414

15-
This section provides an overview of changes to `dev` compared to `Loop 3.8.x`.
16-
15+
This section provides an overview of changes to `dev` compared to `Loop v3.10.0`.
16+
17+
A few days after v3.10.0 is released, a new version of dev that is identical to main except for version number will also be updated.
18+
1719
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.
1820

19-
This section summarizes differences found in the`dev` branch, version 3.9.4, compared to `main`. In addition, there are some feature branches.
21+
This section summarizes differences found in the`dev` branch compared to `main`. In addition, there are some feature branches.
2022

2123
??? tip "Updates in Progress (Click to open/close)"
2224
* Sometimes there is a work-in-progress branch, `update_dev_to_M.m.#` used to collect new items in preparation for the next `dev` branch. This allows people to test and comment on the updates before they land in the `dev` branch.
@@ -25,10 +27,10 @@ This section summarizes differences found in the`dev` branch, version 3.9.4, com
2527

2628
| <div style="width:140px"> branch | version # | <div style="width:140px">last updated | comments |
2729
|:--|:--|:--|:--|
28-
| main | 3.8.2 | 31 Oct 2025<br>07 Dec 2025 | release<br>Browser Build hot-fix same version |
29-
| dev | 3.9.4 | 31 Dec 2025 | v3.9.3 Add Live Activity<br>v3.9.4 Add Omnipod updates, Purge excessive log file storage, Add CAGE and IAGE to Minimed UI screen, Improve Browser Build, Update to fastlane 2.230.0, Update translations <br>See [v3.9.4 `dev`](#v394-dev) |
30-
| [feat/pod-keep-alive](#feature-branch-pod-keep-alive-feature)<br>- SHA `5eba785` | 3.9.4 | 31 Dec 2025 | - 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 `41dd40e`<br>**Please read [Feature Branch: Pod Keep Alive Feature](#feature-branch-pod-keep-alive-feature)** |
31-
| [feat/dev-dana-medtrum](#feature-branch-medtrum-and-dana-support) <br>- SHA `6a8d0c6` | 3.9.4 | 02 Jan 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 `bad8fad`<br> - SHA for MedtrumKit is ` 8e9d9f7` |
30+
| main | 3.10.0 | TBD Jan 2026 | release|
31+
| dev | 3.11.0 | TBD Jan 2026 | same as main, except version number |
32+
| [feat/pod-keep-alive](#feature-branch-pod-keep-alive-feature)<br>- SHA `52106b8` | 3.9.5 | 07 Jan 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 `61e3ef9`<br>**Please read [Feature Branch: Pod Keep Alive Feature](#feature-branch-pod-keep-alive-feature)** |
33+
| [feat/dev-dana-medtrum](#feature-branch-medtrum-and-dana-support) <br>- SHA `ca0463d` | 3.9.5 | 08 Jan 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 `bad8fad`<br> - SHA for MedtrumKit is ` 0905638` |
3234

3335
??? question "What is SHA? (Click to Open/Close)"
3436
SHA-1 means Secure Hash Algorithm 1. This is used to generate an alphanumeric code to identify which version of a repository is used.
@@ -37,70 +39,6 @@ This section summarizes differences found in the`dev` branch, version 3.9.4, com
3739

3840
The SHA-1 20-character value is abbreviated as SHA and typically only the first 7 or 8 characters are presented to identify the commit for a particular repository.
3941

40-
41-
### v3.9.4 `dev`
42-
43-
#### Minimum Requirements
44-
45-
!!! important "Minimum Requirements"
46-
**Although the build will succeed for iOS 15 and 16 devices, not all features are supported**
47-
48-
* Please update your phone hardware to something that supports iOS 18 or iOS 26
49-
* Be sure your build is 3.8.2 or newer before updating your phone to iOS 26
50-
* See [Compatible Device](../build/phone.md#compatible-device){: target="_blank" }
51-
52-
For iOS 16 and older not all features for Live Activity / Dynamic Island / CarPlay features are supported; and for iOS 15 even more features are not supported, including some translations.
53-
54-
#### Differences between `main` and `dev`
55-
56-
The `dev` branch labeled v3.9.4 includes these updates with respect to the `main` branch
57-
58-
* Live Activity, Dynamic Island and CarPlay: see [Live Activities](#live-activities)
59-
60-
* OmniBLE and OmniKit:
61-
* handle cases where a pod was discarded rather than deactivated more accurately
62-
* ensure completion for acknowledgeAlert
63-
* LibreTransmitter: reduce the log size
64-
* LoopKit: automatically purge log files to prevent excessive on-phone storage
65-
* MinimedKit: add CAGE and IAGE to pump settings view
66-
* New translations
67-
* Use fastlane 2.230.0 (for browser build)
68-
69-
#### Live Activities
70-
71-
Live Activity was added to Loop with this [Loop PR 2919](https://github.com/LoopKit/Loop/pull/2191#issuecomment-3565473537). Many people have been using this as a customization. If you used the customization - you need to stop selecting `live_activity` as a customization or your build will fail.
72-
73-
* The configuration for the Live Activity widget on the lock screen is found under Loop, Settings, Notifications, Live Activity
74-
* You must also enable Live Activity under iPhone settings, Loop, tap on Live Activites and enable Allow Live Activites and More Frequent Update
75-
76-
##### Requirements for Live Activities
77-
78-
* The dynamic island is only available for iPhone versions 14 pro and newer; but Live Activity on the Lock Screen is supported for older phones running iOS 16 or newer
79-
* iOS 18 and watchOS 10 or newer are required for Live Activity to appear in the Smart Stack on the Apple Watch
80-
* iOS 26 or newer is required to have Live Activity appear in the CarPlay view
81-
82-
83-
84-
### PR Links for `dev` Updates
85-
86-
The details of the additions to the `dev` branch for v3.9.4 are found in LoopWorkspace Pull Request 367:
87-
88-
* [Update dev to 3.9.4](https://github.com/LoopKit/LoopWorkspace/pull/367)
89-
90-
The details of the additions to the `dev` branch for v3.9.3 are found in LoopWorkspace Pull Request 358:
91-
92-
* [Update dev to 3.9.3](https://github.com/LoopKit/LoopWorkspace/pull/358)
93-
94-
95-
#### Mac-Xcode Builders
96-
97-
One change with v3.9.3 and newer is to modify the Build Order selected in Xcode from the deprecated `Manual Order` to the preferred `Dependency Order`.
98-
99-
* If you start with a fresh download - this will not affect you
100-
* If you update an existing clone on your computer with the `git pull --recurse` command, you will need to perform a `Product: Clean Build Folder` in Xcode, close the workspace in Xcode and reopen it
101-
* If there are still build errors, then quit out of Xcode, issue the following command and try again
102-
* `rm -rf ~/Library/Developer/Xcode/DerivedData`
103-
10442
### How to Build Feature Branches
10543

10644
For full instructions on building different branches, review these pages:
@@ -222,6 +160,15 @@ While RileyLink is selected, the app is triggered by the RileyLink one minute he
222160

223161
## Older updates
224162

163+
### Updates from v3.8 to v3.10
164+
165+
The updates developed in the `dev` branch before the release of v3.10.0 are found in these PR.
166+
167+
* [Update dev to 3.9.5](https://github.com/LoopKit/LoopWorkspace/pull/394)
168+
* [Update dev to 3.9.4](https://github.com/LoopKit/LoopWorkspace/pull/367)
169+
* [Update dev to 3.9.3](https://github.com/LoopKit/LoopWorkspace/pull/358)
170+
171+
225172
### Updates from v3.6 to v3.8
226173

227174
The updates developed in the `dev` branch before the release of v3.8.0, are provided in reverse chronological order.
@@ -336,12 +283,12 @@ This forum has several streams of conversations (`streams`) depending on interes
336283
![img/zulipchat.png](img/zulipchat.png){width="650"}
337284
{align="center"}
338285

339-
You can also go directly to the git commit history for each of the branches if you'd like.
286+
You can also go directly to the git commit history for each of the branches if you'd like. Note that `LoopWorkspace` is the card-catalog for all the books (repositories) used by Loop.
340287

341-
- [`Loop` **`main`** branch: git commit history](https://github.com/LoopKit/Loop/commits/main)
342-
- [`Loop` **`dev`** branch: git commit history](https://github.com/LoopKit/Loop/commits/dev)
288+
- [`LoopWorkspace` **`main`** branch: git commit history](https://github.com/LoopKit/LoopWorkspace/commits/main)
289+
- [`LoopWorkspace` **`dev`** branch: git commit history](https://github.com/LoopKit/LoopWorkspace/commits/dev)
343290

344-
If you click on the commit, you can see exactly what changes to the code were made. It's an interesting learning experience. In red is the old code, and in green is the updated code. The line numbers and file names of the edited code are also there to help.
291+
If you click on the commit, you can see exactly what changes to the code were made. It's an interesting learning experience. In red is the old code, and in green is the updated code. The line numbers and file names of the edited code are also there to help.)
345292

346293
![img/commit.png](img/commit.png){width="550"}
347294
{align="center"}
@@ -361,13 +308,23 @@ You can choose to watch the `repository` so that you get emails when new `Issues
361308

362309
Another useful thing if you'll be on `dev` branches undergoing a lot of active change...know how *Loop* works and where to look for additional information about what you are seeing. For example, if you see an IOB value that looks odd, you should know to look at the insulin deliveries stored in the *Health* app.
363310

364-
### Generate an Issue Report
311+
### Generate an Issue Report and a Critical Event Log
312+
313+
!!! tip "Issue Report vs Loop Issue"
314+
The action in the *Loop* app where you select `Issue Report` generates a human-readable LoopReport file that you can share which has a lot of useful information.
315+
316+
The `Loop Issue` mentioned in [Watch the `Loop Repository` and `Issues List`](#watch-the-loop-repository-and-issues-list) is a website at GitHub where known Issues with the *Loop* app are kept in permanent storage.
317+
318+
The names are similar, but the activity is quite different.
365319

366-
Know how to generate an `Issue Report` when you see a problem so you can provide that if asked. An `Issue Report` is a log file generated by the *Loop* app that has a lot of information the developers can parse to figure out what *Loop* was doing when you were having a problem.
320+
Know how to generate an `Issue Report` and `Export a Critical Event Log` when you see a problem so you can provide that if asked.
367321

368-
* `Loop Settings` and then scroll almost to the bottom and select `Issue Report`
322+
* An `Issue Report` is a log file generated by the *Loop* app that has a lot of information the developers can parse to figure out what *Loop* was doing when you were having a problem. Some items go back 84 hours (pump and cgm messages), others are limited to a few hours (decision arrays) and some items are overall status (build version number and phone model / iOS).
323+
* A `Critical Event Log` contains a zip of 7 individual zips. Each zip is for one day and contains the complete set of data used for Loop decision making. The event log goes back 7 full days.
369324

370-
Do not confuse this with reporting an issue with *Loop*. That is done by logging into *GitHub* and going to the [`Issue` page](https://github.com/LoopKit/Loop/issues) to report a new issue. You can read about existing issues without logging in, but to report a new one, you must log in to *GitHub*.
325+
To issue these reports
326+
* `Loop Settings` and then scroll almost to the bottom and select `Issue Report` and share
327+
* `Loop Settings` and then scroll almost to the bottom and select `Export a Critical Event Log` and share
371328

372329
### Create a Debug Report
373330

docs/version/img/app-version.jpg

-15 KB
Binary file not shown.

docs/version/img/app-version.png

16.9 KB
Loading

0 commit comments

Comments
 (0)