Skip to content

Commit 9a67d4b

Browse files
authored
Merge pull request #854 from marionbarker/working-docs
Add graphic and improve instructions for 3.2 to 3.4 update
2 parents 5a106c9 + 19f49c9 commit 9a67d4b

File tree

6 files changed

+109
-160
lines changed

6 files changed

+109
-160
lines changed

docs/browser/bb-update.md

Lines changed: 68 additions & 125 deletions
Large diffs are not rendered by default.
99.1 KB
Loading

docs/browser/prepare-app.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -101,17 +101,17 @@ If you built previously using a Mac with Xcode, you may see the XCode version in
101101

102102
#### Table with Name and Identifier
103103

104-
One Identifier was changed after v3.2.3 as noted in the table.
104+
> One Identifier was changed after v3.2.3. (`Small Status Widget` is now `Loop Widget Extension`).
105105
106106
| NAME | XCode version | IDENTIFIER |
107107
|:--|:--|:--|
108108
| `Loop` | `XC com TEAMID loopkit Loop`| `com.TEAMID.loopkit.Loop` |
109109
| `Loop Intent Extension` | XC Identifier | `com.TEAMID.loopkit.Loop.Loop-Intent-Extension` |
110110
| `Loop Status Extension` | XC Identifier | `com.TEAMID.loopkit.Loop.statuswidget` |
111-
| **v3.2** `Small Status Widget` | XC Identifier | `com.TEAMID.loopkit.Loop.SmallStatusWidget` |
112-
| **v3.4** `Loop Widget Extension` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWidgetExtension` |
111+
| `Loop Widget Extension` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWidgetExtension` |
113112
| `WatchApp` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWatch` |
114113
| `WatchAppExtension` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWatch.watchkitextension` |
114+
| **v3.2** `Small Status Widget` | XC Identifier | `com.TEAMID.loopkit.Loop.SmallStatusWidget`<br>No longer used, harmless to leave or to delete |
115115

116116
### Add `App Group` to Identifiers
117117

@@ -146,31 +146,31 @@ Look in the **`IDENTIFIER`** column to locate each Identifer. The name in the **
146146
| `Loop` | `com.TEAMID.loopkit.Loop` |
147147
| `Loop Intent Extension` | `com.TEAMID.loopkit.Loop.Loop-Intent-Extension` |
148148
| `Loop Status Extension` | `com.TEAMID.loopkit.Loop.statuswidget` |
149-
| **v3.2** `Small Status Widget` | `com.TEAMID.loopkit.Loop.SmallStatusWidget` |
150-
| **v3.4** `Loop Widget Extension` | `com.TEAMID.loopkit.Loop.LoopWidgetExtension` |
149+
| `Loop Widget Extension` | `com.TEAMID.loopkit.Loop.LoopWidgetExtension` |
151150

152151
Click on each **`IDENTIFIER`** in turn and the `Edit Your App ID Configuration` screen will open.
153152

154-
1. In the `App Services` column, scroll down to the `App Groups` row
155-
* Ensure the check box (under the `Capabilities` column) for `App Groups` is checked
156-
* If the word `Edit` shows up under `NOTES`, return using the `< All Identifiers` button at the top left
157-
* If the word `Configure` shows up, tap on it
158-
* This opens the `App Group Assignment` screen
159-
* Check the box by `Loop` *App Group* that uses your `TEAMID` in `group.com.TEAMID.loopkit.LoopGroup` and then `Continue`
153+
The example graphic below has numbered steps that match these directions:
160154

161-
If you modified settings for an **`IDENTIFIER`**, the `Save` button at the top right will become active. Click on `Save` before leaving this page - otherwise, the change does not take effect.
155+
1. Looking at the `App Services` column, scroll down to the `App Groups` row and ensure the check box (under the `Capabilities column`) for `App Groups` is checked
156+
2. If the word `Configure` shows up, tap on it
157+
* This opens the `App Group Assignment` screen
158+
* If it said `Edit` instead of `Configure` - you can click to confirm you have the correct App Group but won't need to continue or save if it is correct
159+
3. Check the box by `Loop App Group` that uses your `TEAMID` in `group.com.TEAMID.loopkit.LoopGroup`
160+
* Note that if you previously built with Xcode, the name may be different, i.e., `XC group com TEAMID loopkit LoopGroup`
161+
4. Tap `Continue`
162+
5. Tap `Save`
162163

163-
* Tap on `Save`
164-
* This opens the `Modify App Capabilities` confirmation screen
165-
* Click on `Confirm`
164+
![graphic showing selection of the correct App Group](img/update-identifier-loop-3-4.png){width="700"}
165+
{align="center"}
166166

167167
If you did not need to make changes, the `Save` button will not be active.
168168

169169
* Tap on the `< All Identifiers` button at the top left
170170

171171
The full list of Identifiers should be displayed again.
172172

173-
Repeat until the 4 Identifiers for the version you are building have the `Loop App Group` configured.
173+
Repeat until the 4 Identifiers have the `Loop App Group` configured.
174174

175175
* If you miss an identifier, the `Create Certificates` step will succeed but `Build Loop` will fail.
176176

docs/operation/features/notifications.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,35 +18,38 @@ When you tap on the Learn More button, another screen appears. The only option a
1818

1919
## Loop App Expiration Notification
2020

21-
Profile expiration notification was added with Loop 2.2.5.
21+
### Expiration on Settings Screen
2222

23-
With Loop 3.4 and later, apps installed using GitHub Browser Build method report and alert the user for the TestFlight expiration date. Instead of Profile Expires Soon, the modal alert with say "TestFlight Expires Soon". There is no change to the alert system for apps built with Mac-Xcode method.
23+
At any time, you can tap on Settings and scroll to the bottom of the screen to see when your app will expire.
2424

25-
![Notification display when near the Loop App expiration date](img/loop-app-expiration-warning.png){width="350"}
26-
{align="center"}
27-
28-
* When fewer than 20 days remain until profile or testflight expiration, you'll get a notification when you open the app but no more frequently than every 2 days
29-
* When fewer than 24 hours remain, you'll get a notification when you open the app, once every hour at most
30-
* Simply tap on the `More Info` button of the notification for more information
31-
* Mac-Xcode: [LoopDocs Updating](../../build/updating.md)
32-
* GitHub: [LoopDocs GitHub Update](../../browser/bb-update.md)
25+
The graphic below shows the Settings display for a *TestFlight* build (version 3.3 or newer):
3326

34-
### Free (7-day) Loop App Expiration Notification
27+
![expiration warning on settings for testflight example](img/expiration-warning-testflight.svg){width="300"}
28+
{align="center"}
3529

36-
The expiration notification pattern is the same as for the Paid Loop App. You may want to add an [Expiration Notification Customization](../../version/code-custom-edits.md#expiration-notification-customization) to modify the first appearance and frequency of the notification.
30+
### Expiration Alert
3731

32+
Notification before an app expires is reported using this protocol:
3833

39-
## Loop App Expiration Date
34+
* When fewer than 20 days remain, you'll get an alert when you open the app but no more frequently than every 2 days
35+
* When fewer than 24 hours remain, you'll get an alert when you open the app, once every hour at most
36+
* Simply tap on the `More Info` button of the alert for more information
37+
* Build with *Mac*: [Update/Rebuild with *Mac*](../../build/updating.md){: target="_blank" }
38+
* Build with Browser: [Update/Rebuild with Browser](../../browser/bb-update.md){: target="_blank" }
4039

41-
#### For Loop 3.4 and newer versions
40+
The graphic below show an example expiration alert for a *Mac* build:
4241

43-
The testflight expiration data is provided, instead of the profile expiration data, when the app was built using GitHub Browser Build method. When the app was built with Mac-Xcode, the date shown continues to be the profile experation date.
42+
![Notification display when near the Loop App expiration date](img/loop-app-expiration-warning.png){width="350"}
43+
{align="center"}
4444

45-
See the [TestFlight or App Profile](../../loop-3/settings.md#testflight-or-app-profile) section at the bottom of the Loop Settings screen.
45+
> Notification when app expires is available in these versions or newer:
46+
>
47+
> * Build with *Mac*: version 2.2.5 or newer
48+
> * Build with Browser: version 3.3 or newer
4649
47-
#### For Loop 3.2.x and newer versions
50+
### Free (7-day) Loop App Expiration Alert
4851

49-
The provisioning profile expiration date is found in the that settings section at the bottom of the Loop Settings screen. This is useful for Mac-Xcode built apps, but may be misleading for GitHub Broswer build method.
52+
The expiration notification pattern is the same as for the Paid Loop App. You may want to add an [Expiration Notification Customization](../../version/code-custom-edits.md#expiration-notification-customization) to modify the first appearance and frequency of the notification.
5053

5154
## Omnipod Beeps
5255

@@ -114,6 +117,8 @@ This mostly happens when the connection is lost for a longer period of time betw
114117

115118
If Loop detects that a bolus was not able to be delivered, it will provide a notification. Bolus failures are usually due to stale pump data. Try fetching recent history from the RileyLink menu to update pump data. Loop will also notify of partial bolus deliveries.
116119

120+
**Remember: Carbs are saved when you tap `Save and Bolus` following a meal entry - even if the bolus fails.**
121+
117122
![img/loop-bolus-failure.png](img/loop-bolus-failure.png){width="250"}
118123
{align="center"}
119124

docs/version/releases.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,13 @@ This was a patch that fixed errors with the Browser Build. No other changes were
3131

3232
* [Link to release notes for Loop 3.4.1](https://github.com/LoopKit/Loop/releases/tag/v3.4.1){: target="_blank" }
3333

34-
3534
### Loop v3.4.0
3635

3736
*Loop* v3.4.0 was released on 13 July 2024.
3837

3938
* [Link to release notes for Loop 3.4.0](https://github.com/LoopKit/Loop/releases/tag/v3.4.0){: target="_blank" }
39+
* There are some one-time update steps required for those who Build with Browser:
40+
* [Update from 3.2.x to 3.4](../browser/bb-update.md#update-from-32x-to-34){: target="_blank" }
4041

4142
#### Summary of Important New Features
4243

0 commit comments

Comments
 (0)