Skip to content

Commit ec06ded

Browse files
authored
Update docs for major release 5.0 (#25)
1 parent 1f940d2 commit ec06ded

28 files changed

Lines changed: 2273 additions & 2560 deletions

docs/build/lf-browser-build.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ Detailed directions are found in the next sections, this is the summary of what
2929
2. `Fork` the repository to your organization
3030
3. Open your `fork` and enable Actions
3131
4. `Add Identifiers`
32+
5. Review App Identifier in Apple Developer portal
3233
6. Add the App in App Store Connect and configure TestFlight users
3334
7. `Build LoopFollow`
3435

35-
!!! tips "What About Other Actions"
36-
* You already have your organizaton configured, there is no need to run `Validate Secrets`
36+
!!! tip "What About Other Actions"
37+
* You already have your organization configured, there is no need to run `Validate Secrets`
3738
* The Build action includes a `Create Certificates` step - you can run it separately but it is not necessary
3839

3940

@@ -205,19 +206,19 @@ If you need detailed instruction, visit [Configure to Use Browser: *TestFlight*
205206

206207
### Display Name Customization for `LoopFollow`
207208

208-
> If you build `LoopFollow` for one, two or three loopers, you may choose to customize your `fork` or `forks` to insert a custom display name.
209+
If you build `LoopFollow` for one, two or three loopers, you may choose to customize your `fork` or `forks` to insert a custom display name.
209210

210-
> * Find and click on the file `LoopFollowDisplayNameConfig.xcconfig`
211-
> * Tap the pencil icon so you can edit the file
212-
> * The last line says `display_name = LoopFollow` (or `LoopFollow_Second` or `LoopFollow_Third`)
213-
> * Insert your custom name so the last line says `display_name = LF custom name`
214-
> * Click on commit changes and chose to commit directly into the `main` branch
211+
* Find and click on the file `LoopFollowDisplayNameConfig.xcconfig`
212+
* Tap the pencil icon so you can edit the file
213+
* The last line says `display_name = LoopFollow` (or `LoopFollow_Second` or `LoopFollow_Third`)
214+
* Insert your custom name so the last line says `display_name = LF custom name`
215+
* Click on commit changes and choose to commit directly into the `main` branch
215216

216-
> Continue to build as instructed below. After you install the app on your phone, iPad or Mac via *TestFlight*, that custom name is what is displayed. The prefix LF is suggested to make it easier to find the custom named `LoopFollow` app in the list of apps, but is not required.
217+
Continue to build as instructed below. After you install the app on your phone, iPad or Mac via *TestFlight*, that custom name is what is displayed. The prefix LF is suggested to make it easier to find the custom named `LoopFollow` app in the list of apps, but is not required.
217218

218219
### Build Action
219220

220-
11. Click on the Actions tab of your *LoopFollow* repository
221+
1. Click on the Actions tab of your *LoopFollow* repository
221222
2. On the left side, click on `4. Build LoopFollow`
222223
3. On the right side, click Run Workflow to show a dropdown menu
223224
4. Tap the green button that says Run workflow.
@@ -234,7 +235,7 @@ Repeat the build and install from TestFlight steps if you use LoopFollow_Second
234235

235236
Refer to the [Browser Build: Build Errors](https://loopkit.github.io/loopdocs/browser/bb-errors) to find your error.
236237

237-
Please do not remove an existing app if you have trouble building a new one. Your build error is not cause by any existing app.
238+
Please do not remove an existing app if you have trouble building a new one. Your build error is not caused by any existing app.
238239

239240
!!! Important "Removing App Warning"
240241
If you remove an app and later want to restore that app, you might not be able to.
@@ -250,7 +251,7 @@ The [LoopDocs instructions: Install on Phone](https://loopkit.github.io/loopdocs
250251

251252
For *LoopFollow* v4.0 through 4.3, you had to manually add that capability to the Identifier. Thanks to our friends at fastlane, who updated their tool, this manual action is no longer necessary.
252253

253-
## Archaic Instructions
254+
## Legacy: Updating from v3.x
254255

255256
Given that a Browser Build must be rebuilt every 90 days, the instructions here are unlikely to be required.
256257

docs/faqs/lf-faqs.md

Lines changed: 58 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,63 @@
11

2-
🚧 Documentation Under Construction 🚧
2+
!!! tip "Pro Tip: Frequent Glucose Alerts"
3+
If you are experiencing audible and visible glucose alerts every single minute, disable the *LoopFollow* > Settings > General > Persistent Notifications slider.
34

4-
<!--todo-->
5-
<!--Notes: be sure to add this info
5+
Note: this is completely different from the persistent notifications you may want enabled to see APNS messages returned from real-time responses to remote commands.
66

7-
-->
7+
- - -
88

9-
Pro Tip: If you are experiencing audible and visible glucose alerts every single minute, disable the *LoopFollow*, Settings, General Settings, Persistent Notifications slider. This is completely different from the persistent notifications that you might want enabled to see the APNS messages returned from real-time responses to remote command.
9+
## Version Compatibility
1010

11+
This section consolidates version requirements for *LoopFollow* to work with *Loop* and *Trio*, and provides historical context for how remote control has evolved.
12+
13+
### *LoopFollow* and *Loop* Compatibility
14+
15+
| Feature | Minimum Versions Required |
16+
|:--|:--|
17+
| *Loop* Remote Control via APNS | *LoopFollow* 3.2 or newer; any version of *Loop* |
18+
| Real-time APNS response from *Loop* phone | *LoopFollow* 4.6 or newer; *Loop* v3.11.1 or newer |
19+
20+
With *LoopFollow* 3.2 and newer, *Loop* remote commands include Meal, Bolus and Override control. *LoopFollow* no longer requires the *Nightscout* site to be configured with the APNS credentials — Read access for the *Nightscout* URL is sufficient.
21+
22+
With *LoopFollow* 3.1 and older, *Loop* remote commands were limited to Overrides, required the *Nightscout* site to be configured with the APNS credentials, and required a token with `careportal` access.
23+
24+
### *LoopFollow* and *Trio* Compatibility
25+
26+
!!! important "Breaking Change: *Trio* Remote Command Users"
27+
*Trio* users must have matching versions of *LoopFollow* and *Trio* for remote control to work.
28+
29+
* *Trio* 0.6 (or newer) requires *LoopFollow* 4.0 (or newer)
30+
* *Trio* 0.5.1.28 (or older) requires *LoopFollow* 3.2.11 (or older)
31+
32+
Remote control commands stop working if versions are not matched. You do **not** need to reconfigure your credentials when upgrading — your existing settings continue to work. However, *LoopFollow* Browser Build users must update their Identifiers when upgrading from v3.x: see [Legacy: Updating from v3.x](../build/lf-browser-build.md#legacy-updating-from-v3x){: target="_blank" }.
33+
34+
| Feature | Minimum Versions Required |
35+
|:--|:--|
36+
| *Trio* Remote Control via APNS | *LoopFollow* 4.0 or newer; *Trio* 0.6 or newer |
37+
| Real-time APNS response from *Trio* phone | *LoopFollow* 4.0 or newer; *Trio* 0.6 or newer |
38+
| Nightscout Careportal (Temp Targets only) | Available for all *Trio* versions |
39+
| *Nightscout* OpenAPS pill display | *Nightscout* 15.0.2 or newer with *Trio* 0.5.x or newer |
40+
41+
With *Trio* 0.2.x, *LoopFollow* only supports Temp Targets via the *Nightscout* Careportal, which requires a token with `careportal` access. Once updated to *Trio* 0.5.x or newer, the full *Trio* Remote Control options are available.
42+
43+
For those following a looper using *Trio* 0.2.x, the only remote setting option in *LoopFollow* is *Nightscout* (Careportal). With this selection:
44+
45+
* The *LoopFollow* phone sends commands to *Nightscout*, which then forwards commands to the *Trio* phone
46+
* The *Nightscout* display will be updated first
47+
* If there is an issue sending the Careportal request, it might not reach the *Trio* phone
48+
* After the next *Nightscout* download, *LoopFollow* display will reflect whether commands completed the full round trip
49+
50+
### APNS Keys Do Not Need to Be in Nightscout
51+
52+
With *LoopFollow* 3.2 and newer, the APNS credentials are entered directly in the *LoopFollow* app. They do **not** need to be embedded in the *Nightscout* site for remote control to work. This simplifies *Nightscout* configuration, especially for those using a paid *Nightscout* service.
53+
54+
The APNS credentials only need to be in *Nightscout* if you also use *Nightscout* Careportal or the *LoopCaregiver* app to send remote commands.
55+
56+
### *LoopFollow* Feature History
57+
58+
| *LoopFollow* Version | Feature Added |
59+
|:--|:--|
60+
| 3.2 | *Loop* remote commands (Meal, Bolus, Override) sent directly via APNS; APNS credentials no longer required in *Nightscout* |
61+
| 4.0 | *Trio* 0.6 remote control support; share remote configuration via QR code |
62+
| 4.3 | Separate QR codes for *Nightscout* Site, Dexcom Share, Remote Settings, and Alarm Settings |
63+
| 4.6 | Real-time APNS notifications returned from the *Loop* phone (requires *Loop* v3.11.1 or newer) |
182 KB
Loading
-133 KB
Binary file not shown.

docs/index.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,38 @@
44
It combines information from multiple other apps and provides custom alerts. It runs on iPhone, iPad or Mac devices. With newer versions, some remote control features are available for the *Loop* and *Trio* apps.
55

66
*LoopFollow* was created because using different apps as a parent or caregiver of a person with diabetes can be cumbersome.
7-
Add in the extra details from looping with an Open Source Automated Insulin Delivery (OS AID) app
7+
Add in the extra details from looping with an Open Source Automated Insulin Delivery (OS-AID) app
88
and flipping back and forth between various sources of information can be a challenge.
99
Many loopers use *LoopFollow* for themselves because of the flexible (and loud) alarm options.
1010

1111
*LoopFollow*:
1212

13-
* Displays information from a Nightscout URL or Dexcom Share account
14-
* Provides flexible alarm features with a Snooze screen
15-
* Supports *Loop* and *Trio* OS AID systems and provides remote control features
13+
* Displays information from a *Nightscout* Site or Dexcom Share account
14+
* Provides flexible alarms with a Snooze screen
15+
* Displays Treatments and Statistics (requires *Nightscout* Site)
16+
* Supports *Loop* and *Trio* OS-AID systems
17+
* Provides secure remote control (requires *Nightscout* Site and security configuration)
1618
* Supports up to 3 loopers – each with their own unique app name
1719
* Works with your Apple Watch
1820
* Runs on an iPhone, iPad or a Mac computer
1921

20-
An example of the main screen for *LoopFollow* is shown in the graphic below:
22+
#### Home
2123

22-
> ![example of main screen for *LoopFollow*](img/loopfollow-main-screen.png)
24+
An example of the Home screen for *LoopFollow* v5.0 and newer is shown in the graphic below:
25+
26+
![example of Home screen for *LoopFollow*](img/loopfollow-home-screen.png){width=400}
2327
{align="center"}
2428

29+
The toolbar at the bottom of the Home and Menu screens has 4 user-configurable icons in addition to the `Menu` icon. The icons shown in the graphic above are Home, Alarms, Snoozer and Remote.
30+
31+
#### New Features
32+
!!! tip ""
33+
New with *LoopFollow* v5.0:
34+
35+
* [Menu Screen](setup/lf-setup.md#menu-screen){: target="_blank"}
36+
* [Treatments](setup/lf-features.md#treatments){: target="_blank"}
37+
* [Statistics](setup/lf-features.md#statistics){: target="_blank"}
38+
2539
- - -
2640

2741
## Hardware Requirements
@@ -36,17 +50,23 @@ The *LoopFollow* app will run on any iPhone or iPad that supports iOS 16.6 or ne
3650

3751
### Community Support and Build Help
3852

39-
Community support for *LoopFollow* is available on [*LoopFollow*’s FaceBook page](https://www.facebook.com/groups/loopfollowlnl). Please use community support for Build problems. It is very unlikely that a new Issue needs to be opened when you are having trouble building.
53+
Community support for *LoopFollow* is available at
4054

41-
Remember, for build help with Browser Build, all we need is the *GitHub* URL to your own fork of *LoopFollow*. Just replace `docs-test` in the example below with your *GitHub* username:
55+
* [*LoopFollow* FaceBook page](https://www.facebook.com/groups/loopfollowlnl)
56+
* [*Loop and Learn* Facebook](https://www.facebook.com/groups/LOOPandLEARN)
57+
* [*Loop and Learn* Discord](https://discord.gg/KQgk3gzuYU)
4258

43-
* Example: [https://github.com/docs-test/LoopFollow/actions](https://github.com/docs-test/LoopFollow/actions)
59+
Please use community support for Build questions. **Do not ask ChatGPT or any AI system; they tend to provide incorrect answers.**
60+
61+
To get build help with Browser Build, all we need is the *GitHub* URL for your fork of *LoopFollow*. Just replace `docs-test` in the example below with your *GitHub* username:
4462

45-
If you choose not to use Facebook, you can reach out on the [*Trio* Discord server](https://discord.gg/FnwFEFUwXE) in one of the build channels.
63+
* Example: [https://github.com/docs-test/LoopFollow/actions](https://github.com/docs-test/LoopFollow/actions)
4664

4765
### Issues and Feature Requests
4866

49-
Issues and Feature Requests can be posted at [*LoopFollow* Issues](https://github.com/loopandlearn/LoopFollow/issues). Please review open issues and only open a new one if your problem or feature request is not already described. When reporting an issue, please specify the version of *LoopFollow* in which you noticed the issue.
67+
Issues and Feature Requests can be posted at [*LoopFollow* Issues](https://github.com/loopandlearn/LoopFollow/issues). Please review open issues and only open a new one if your problem or feature request is not already described. When reporting an issue, please specify the version of *LoopFollow* in which you noticed the problem.
68+
69+
It is very unlikely that a new Issue needs to be opened when you are having trouble building. See [Community Support and Build Help](#community-support-and-build-help).
5070

5171
- - -
5272

@@ -60,11 +80,4 @@ In addition, at the bottom of the Settings screen for *LoopFollow*, the version
6080

6181
## History
6282

63-
This code was originally developed by Jon Fawcett who turned over development and management to the *Loop and Learn* team.
64-
65-
We are happy to respond to bug reports or feature requests.
66-
67-
* [*Loop and Learn* Website](https://loopandlearn.org)
68-
* [*Loop and Learn* Facebook](https://www.facebook.com/groups/LOOPandLEARN)
69-
* [*Loop and Learn* YouTube Channel](https://www.youtube.com/c/loopandlearn)
70-
83+
This code was originally developed by Jon Fawcett who turned over development and management to the *Loop and Learn* team. The primary developers are parents who love their children.

docs/remote/img/app_icons.png

-190 KB
Binary file not shown.
-110 KB
Binary file not shown.
-161 KB
Binary file not shown.
-116 KB
Binary file not shown.
-328 KB
Binary file not shown.

0 commit comments

Comments
 (0)