Skip to content

Commit 4cc4f50

Browse files
authored
Merge pull request #10 from loopandlearn/update_lf_4.0
Update for LoopFollow v4.0 Release
2 parents 7d9e0b6 + bde508a commit 4cc4f50

File tree

9 files changed

+5491
-30
lines changed

9 files changed

+5491
-30
lines changed

docs/build/build-options.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,62 @@
22

33
*LoopFollow* can be built using either the Browser Build or the Mac-Xcode Build method. A paid Apple Developer account is required to use the Browser Build method. Regardless of how you build, you can customize your *LoopFollow* app’s name.
44

5-
* Browser Build: See [LoopDocs: Browser Build for Other Apps]()
5+
* Browser Build:
6+
* If you have never built, see [LoopDocs: Browser Build for Other Apps](https://loopkit.github.io/loopdocs/browser/other-apps/)
7+
* If you are a repeat builder, then you need a one-time update [Browser Build Update for *LoopFollow* v4.0](#browser-build-update-for-loopfollow-v40)
68
* Mac-Xcode: [Build *LoopFollow* Script for Mac-Xcode](#build-loopfollow-script-for-mac-xcode)
79

10+
### Browser Build Update for *LoopFollow* v4.0
11+
12+
!!! important "New Capability with LoopFollow v4.0"
13+
A new capability was added to LoopFollow regarding remote commands which **requires a one-time update** to your LoopFollow **Identifier**. Browser Build will fail until you take these steps.
14+
15+
It doesn't matter whether the person you follow uses *Loop* or *Trio*. You have to update the Identifiers or the Browser Build will fail.
16+
17+
This requires you to [Sync](#sync-your-loopfollow-fork), [Add Identifiers](#run-add-identifiers), [Create Certificates](#run-create-certificates) and [Build](#run-build-loopfollow):
18+
19+
#### Sync Your *LoopFollow* fork
20+
21+
* Go to your *LoopFollow* fork and click on the Sync button
22+
* If your browser build already failed, it already did the sync for you
23+
24+
> ![sync the fork](img/github-build-check-fork-status.svg){width="700"}
25+
26+
#### Run `Add Identifiers`
27+
28+
1. Click on the Actions tab of your *LoopFollow* repository
29+
2. On the left side, click on `2. Add Identifiers`
30+
3. On the right side, click Run Workflow to show a dropdown menu
31+
4. Tap the green button that says Run workflow.
32+
33+
> ![add identifiers](img/action-02-add-identifiers.svg){width="700"}
34+
35+
**Wait for this to complete before you create certificates.**
36+
37+
#### Run `Create Certificates`
38+
39+
1. Click on the Actions tab of your *LoopFollow* repository
40+
2. On the left side, click on `3. Create Certificates`
41+
3. On the right side, click Run Workflow to show a dropdown menu
42+
4. Tap the green button that says Run workflow.
43+
44+
> ![add identifiers](img/action-03-create-certs.svg){width="700"}
45+
46+
**Wait for this to complete before you build *LoopFollow*.**
47+
48+
#### Run `Build LoopFollow`
49+
50+
1. Click on the Actions tab of your *LoopFollow* repository
51+
2. On the left side, click on `4. Build LoopFollow`
52+
3. On the right side, click Run Workflow to show a dropdown menu
53+
4. Tap the green button that says Run workflow.
54+
55+
> ![add identifiers](img/action-04-build.svg){width="700"}
56+
57+
**Once this completes, be sure to update from TestFlight to get the updated version of *LoopFollow* on your phone.**
58+
59+
If you follow two loopers, repeat those steps for LoopFollow_Second. For three loopers, repeat for LoopFollow_Third.
60+
861

962
### Build LoopFollow Script for Mac-Xcode
1063

docs/build/img/action-02-add-identifiers.svg

Lines changed: 149 additions & 0 deletions
Loading

docs/build/img/action-03-create-certs.svg

Lines changed: 156 additions & 0 deletions
Loading

docs/build/img/action-04-build.svg

Lines changed: 4910 additions & 0 deletions
Loading

docs/build/img/github-build-check-fork-status.svg

Lines changed: 153 additions & 0 deletions
Loading

docs/remote/remote-control-overview.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,32 @@
22

33
## Remote Control Overview
44

5-
*LoopFollow* remote commands are sent directly using the [Apple Push Notification System (APNS)](#apple-push-notifications-system-apns) for all Open-Source Automated Insulin Delivery systems that support this feature. At this time, the *Loop* app and the open beta version of the *Trio* app (0.5.x or newer) support direct APNS from *LoopFollow*.
5+
*LoopFollow* remote commands are sent directly using the [Apple Push Notification System (APNS)](#apple-push-notifications-system-apns) for all Open-Source Automated Insulin Delivery systems that support this feature.
6+
7+
The *Loop* app and the open beta version of the *Trio* app (0.5.x or newer) support direct APNS from *LoopFollow*.
8+
9+
!!! warning "Browser Build Update"
10+
If you use Browser Build, follow the one-time updates needed to transition from *LoopFollow* v3.2 to *LoopFollow* v4.0:
11+
12+
* [Browser Build Update for LoopFollow v4.0](../build/build-options.md#browser-build-update-for-loopfollow-v40){: target="_blank" }
613

714
!!! tip "`Loop` Remote Control with *LoopFollow* 3.2"
815
With the release of *LoopFollow* 3.2, the remote control features accessible from LoopFollow match those available from the *LoopCaregiver* app.
916

1017
You must update to *LoopFollow* 3.2 or newer and configure remote settings in the *LoopFollow* app to use these features.
1118

19+
!!! important "Breaking Change: Trio Remote Command Users"
20+
Trio users must have matching code for LoopFollow and Trio.
21+
22+
* Trio 0.6 (or newer) requires LoopFollow 4.0 (or newer)
23+
* Trio 0.5.1.28 (or older) requires LoopFollow 3.2.11 (or older)
24+
25+
See [Trio Remote Control](trio-remote-control.md){: target="_blank" } for more information.
26+
27+
For Browser Builders:
28+
29+
* [Browser Build Update for LoopFollow v4.0](../build/build-options.md#browser-build-update-for-loopfollow-v40){: target="_blank" }
30+
1231

1332
### Changes for *LoopFollow* Remote Control of the *Loop* App
1433

@@ -17,36 +36,23 @@
1736
* *LoopFollow* no longer requires the *Nightscout* site be configured with the APNS credentials
1837
* Read access for the *Nightscout* URL is sufficient
1938
* With *LoopFollow* 3.1 and older
20-
* *Loop* remote commands are limited to Overrides, require the *Nightscout* site be configured with the APNS credentials and require a token with `careportal` access
39+
* *Loop* remote commands were limited to Overrides, required the *Nightscout* site be configured with the APNS credentials and required a token with `careportal` access
2140

2241
> With *Trio* 0.2.x, *LoopFollow* only supports temp targets and requires a token with `careportal` access. Once updated to *Trio* 0.5.x or newer, the full Trio Remote Control options are available.
2342
24-
!!! abstract "Remote Control Updates in Development"
25-
The instructions in this section depend on the version of the *Trio* app and the *LoopFollow* app.
26-
27-
* With *LoopFollow* 3.2 or newer:
28-
* Remote commands are sent directly through APNS for both the *Loop* app and the *Trio* open beta version
29-
* If you are using *Trio* 0.2.x, remote commands are routed via *Nightscout* and are limited to modifying `Temp Targets`
30-
* With *LoopFollow* 3.1 and earlier:
31-
* Using the *Loop* app:
32-
* remote commands are routed via *Nightscout*
33-
* Only Overrides can be modified using *LoopFollow* and only if *Nightscout* site has the APNS keys embedded
34-
* Using the *Trio* app
35-
* If you are using *Trio* 0.5.x or newer, remote commands are sent directly through APNS
36-
* If you are using *Trio* 0.2.x, remote commands are routed via *Nightscout*
37-
38-
> Using APNS directly from *LoopFollow* provides faster feedback about commanding.
39-
40-
> With *LoopFollow* 3.2, APNS keys will not need to be embedded in the *Nightscout* site for remote control of the *Loop* app from *LoopFollow*, which may simplify configuration for those who use a paid service for *Nightscout*.
4143

4244
### *LoopFollow* Remote Control
4345

4446
* *LoopFollow* Remote Control sends messages to the loopers phone using APNS
45-
* Requires *LoopFollow* 3.2 or newer to use with the *Loop* app (version 3.x)
46-
* Requires *Trio* 0.5 or newer for the *Trio* app
47+
* **Loop**: Requires *LoopFollow* 3.2 or newer
48+
* **Trio**: Requires matched code versions:
49+
* Trio 0.6 (or newer) requires LoopFollow 4.0 (or newer)
50+
* Trio 0.5.1.28 (or older) requires LoopFollow 3.2.11 (or older)
4751
* Commands go via APNS to the *Loop*/*Trio* phone
48-
* An immediate success or failure for sending the message to APNS is recieved
52+
* An immediate success or failure for **sending** the message to APNS is received
4953
* There still could be a communication failure between APNS and the looper's phone or the command could be rejected by the looper's app
54+
* **Trio v0.6 or newer** an APNS response is returned to *LoopFollow*
55+
* A success or failure message is pushed back to the *LoopFollow* phone from the *Trio* phone when a remote command is received and handled
5056
* The results show up in *Nightscout* after being uploaded from the *Loop*/*Trio* phone
5157
* The results are plotted or displayed in *LoopFollow* after being downloaded from the *Nightscout* URL as a new treatment
5258
* APNS keys do not need to be embedded in the *Nightscout* site

docs/remote/remote-control-trio.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,27 @@ Trio can accept remote commands from *Nightscout* or from *LoopFollow*. There ar
77
!!! warning "*Nightscout* version must be 15.0.2 or newer"
88
To properly display the OpenAPS pill with *Trio* 0.5.x (or newer), your *Nightscout* version must be 15.0.2 (or newer). If you do not see the expected treatments or pills in the *Nightscout* dashboard, follow the steps to [Configure for OpenAPS](#configure-for-openaps).
99

10-
The most powerful arrangement, for *Trio* 0.5.x (or newer), is to configure the *LoopFollow* app to use the *Trio* Remote Control (TRC) setting. This requires:
10+
The most powerful arrangement, for *Trio* 0.5.x (or newer), is to configure the *LoopFollow* app to use the *Trio* Remote Control (TRC) setting.
11+
12+
### Real-time Notifications for *Trio*
13+
14+
Starting with *LoopFollow* v4.0 and *Trio* v0.6, users of remote control are provided with real-time notifications for the results of remote commands. This requires a paired change to both *Trio* and *LoopFollow*.
15+
16+
* This change enables *Trio* to send a push notification back to the *LoopFollow* app on the originating phone, immediately informing the user whether their command (e.g., meal, bolus, override) was successfully processed or if an error occurred
17+
* This greatly improves the user experience compared to waiting for Nightscout being updated
18+
19+
!!! important "Breaking Change: *Trio* Remote Command Users"
20+
*Trio* users must have matching code for LoopFollow and *Trio*.
21+
22+
* LoopFollow v4.0 (or newer) works with *Trio* v0.6 (or newer)
23+
* LoopFollow v3.2.3 (or older) works with *Trio* v0.5.1 (or older)
24+
25+
**Question: What happens if versions are not correct?**: Remote control commands stop working.
26+
27+
**Question: If I was using Trio / LoopFollow remote control do I need to change my configuration parameters?**: No, the parameters you already set up continue to work. **BUT** you need to update the *LoopFollow* Identifiers if you use Browser Build.
28+
29+
* [Browser Build Update for LoopFollow v4.0](../build/build-options.md#browser-build-update-for-loopfollow-v40){: target="_blank" }
1130

12-
* *Trio* 0.5.x (or newer)
13-
* *LoopFollow* version 2.4.0 (or newer)
1431

1532
??? question "How does this differ from *Trio* 0.2.x? (Click to Open/Close)"
1633
*Trio* can use *Nightscout* Careportal to enter `Carb Correction`, and start and cancel `Temporary Target`.

docs/setup/lf-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,6 @@ Quick access is provided using these links once you have configured *LoopFollow*
165165

166166
* None
167167
* [*Nightscout*](../remote/remote-control-nightscout.md){: target="_blank" } (*LoopFollow* offers actions that can be done from a *Nightscout* Careportal)
168-
* [*Loop* Remote Control](../remote/remote-control-loop.md){: target="_blank" } (in development: only available with a *Loop* URL)
168+
* [*Loop* Remote Control](../remote/remote-control-loop.md){: target="_blank" }
169169
* [*Trio* Remote Control](../remote/remote-control-trio.md){: target="_blank" }: requires Trio 0.5.x or newer
170170

docs/setup/lf-setup.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,17 @@ The type of token depends on the type of remote control desired.
6969
The table below indicates the minimum token access for each type of remote control available with *LoopFollow*.
7070
When you enter your credentials, *LoopFollow* tries to reach the site and then provides the status.
7171

72-
* The *Loop* Remote Control option will be available in the `dev` branch as soon as [PR 434](https://github.com/loopandlearn/LoopFollow/pull/434) is approved and merged
72+
* The *Loop* Remote Control option requires *LoopFollow* version 3.2 or newer
7373
* The *Trio* Remote Control option requires the user be on version 0.5.x or newer of Trio
74+
* **Breaking change** on 2025-October-06
75+
* *Trio* 0.6 or newer requires *LoopFollow* 4.0 or newer
76+
* *Trio* 0.5.1.28 or older requires *LoopFollow* 3.2.11 or older
7477

7578
| *LoopFollow* Remote Type | Minimum Token Access| *LoopFollow* Status |
7679
|:--|:--|:--|
7780
| **None** | Read | OK (Read) |
7881
| ***Nightscout*** | Read & Careportal | OK (Read & Write) |
79-
| ***Loop* Remote Control** <br>- in development| Read | OK (Read) |
82+
| ***Loop* Remote Control**| Read | OK (Read) |
8083
| ***Trio* Remote Control**| Read | OK (Read) |
8184

8285
#### Add *Dexcom*
@@ -140,12 +143,26 @@ Once you’ve configured your settings, your Main screen will look as beautiful
140143

141144
### Tab Settings
142145

143-
🚧 Documentation Under Construction 🚧
146+
The user can modify which icons are displayed in the task bar at the bottom of the screen.
147+
148+
See [Toolbar Tab Settings](lf-features.md#toolbar-tab-customization){: target="_blank" } for more information.
144149

145150
### Information Display Settings
146151

147152
🚧 Documentation Under Construction 🚧
148153

154+
#### `Rec. Bolus`
155+
156+
!!! warning "LoopFollow Report of Trio Recommended Dose"
157+
It happens. We made a mistake. The `Rec. Bolus` feature for *LoopFollow* was reporting a value from the *Trio* app that was never meant to be used as a recommended bolus.
158+
159+
* With `LoopFollow` 4.0 and newer, users viewing a *Trio* URL will notice the `Rec. Bolus` display is always blank
160+
* Updates are planned for *Trio* and *LoopFollow* to provide the last recommended value from the *Trio* app
161+
* The value shown to users viewing a *Loop* URL matches what the user of the *Loop* phone would see when asking for a recommendation and is not changed in `LoopFollow` 4.0
162+
163+
**Remember: the `Rec. Bolus` values is from the last AID app update to Nightscout**
164+
165+
149166
### Remote Settings
150167

151168
🚧 Documentation Under Construction 🚧

0 commit comments

Comments
 (0)