diff --git a/docs/build/lf-browser-build.md b/docs/build/lf-browser-build.md index 93a3894..2311867 100644 --- a/docs/build/lf-browser-build.md +++ b/docs/build/lf-browser-build.md @@ -29,11 +29,12 @@ Detailed directions are found in the next sections, this is the summary of what 2. `Fork` the repository to your organization 3. Open your `fork` and enable Actions 4. `Add Identifiers` +5. Review App Identifier in Apple Developer portal 6. Add the App in App Store Connect and configure TestFlight users 7. `Build LoopFollow` -!!! tips "What About Other Actions" - * You already have your organizaton configured, there is no need to run `Validate Secrets` +!!! tip "What About Other Actions" + * You already have your organization configured, there is no need to run `Validate Secrets` * The Build action includes a `Create Certificates` step - you can run it separately but it is not necessary @@ -205,19 +206,19 @@ If you need detailed instruction, visit [Configure to Use Browser: *TestFlight* ### Display Name Customization for `LoopFollow` -> 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. +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. -> * Find and click on the file `LoopFollowDisplayNameConfig.xcconfig` -> * Tap the pencil icon so you can edit the file -> * The last line says `display_name = LoopFollow` (or `LoopFollow_Second` or `LoopFollow_Third`) -> * Insert your custom name so the last line says `display_name = LF custom name` -> * Click on commit changes and chose to commit directly into the `main` branch +* Find and click on the file `LoopFollowDisplayNameConfig.xcconfig` +* Tap the pencil icon so you can edit the file +* The last line says `display_name = LoopFollow` (or `LoopFollow_Second` or `LoopFollow_Third`) +* Insert your custom name so the last line says `display_name = LF custom name` +* Click on commit changes and choose to commit directly into the `main` branch -> 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. +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. ### Build Action -11. Click on the Actions tab of your *LoopFollow* repository +1. Click on the Actions tab of your *LoopFollow* repository 2. On the left side, click on `4. Build LoopFollow` 3. On the right side, click Run Workflow to show a dropdown menu 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 Refer to the [Browser Build: Build Errors](https://loopkit.github.io/loopdocs/browser/bb-errors) to find your error. -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. +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. !!! Important "Removing App Warning" 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 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. -## Archaic Instructions +## Legacy: Updating from v3.x Given that a Browser Build must be rebuilt every 90 days, the instructions here are unlikely to be required. diff --git a/docs/faqs/lf-faqs.md b/docs/faqs/lf-faqs.md index e4a0ff2..c7e628d 100644 --- a/docs/faqs/lf-faqs.md +++ b/docs/faqs/lf-faqs.md @@ -1,10 +1,63 @@ -🚧 Documentation Under Construction 🚧 +!!! tip "Pro Tip: Frequent Glucose Alerts" + If you are experiencing audible and visible glucose alerts every single minute, disable the *LoopFollow* > Settings > General > Persistent Notifications slider. - - +- - - -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. +## Version Compatibility +This section consolidates version requirements for *LoopFollow* to work with *Loop* and *Trio*, and provides historical context for how remote control has evolved. + +### *LoopFollow* and *Loop* Compatibility + +| Feature | Minimum Versions Required | +|:--|:--| +| *Loop* Remote Control via APNS | *LoopFollow* 3.2 or newer; any version of *Loop* | +| Real-time APNS response from *Loop* phone | *LoopFollow* 4.6 or newer; *Loop* v3.11.1 or newer | + +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. + +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. + +### *LoopFollow* and *Trio* Compatibility + +!!! important "Breaking Change: *Trio* Remote Command Users" + *Trio* users must have matching versions of *LoopFollow* and *Trio* for remote control to work. + + * *Trio* 0.6 (or newer) requires *LoopFollow* 4.0 (or newer) + * *Trio* 0.5.1.28 (or older) requires *LoopFollow* 3.2.11 (or older) + + 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" }. + +| Feature | Minimum Versions Required | +|:--|:--| +| *Trio* Remote Control via APNS | *LoopFollow* 4.0 or newer; *Trio* 0.6 or newer | +| Real-time APNS response from *Trio* phone | *LoopFollow* 4.0 or newer; *Trio* 0.6 or newer | +| Nightscout Careportal (Temp Targets only) | Available for all *Trio* versions | +| *Nightscout* OpenAPS pill display | *Nightscout* 15.0.2 or newer with *Trio* 0.5.x or newer | + +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. + +For those following a looper using *Trio* 0.2.x, the only remote setting option in *LoopFollow* is *Nightscout* (Careportal). With this selection: + +* The *LoopFollow* phone sends commands to *Nightscout*, which then forwards commands to the *Trio* phone +* The *Nightscout* display will be updated first +* If there is an issue sending the Careportal request, it might not reach the *Trio* phone +* After the next *Nightscout* download, *LoopFollow* display will reflect whether commands completed the full round trip + +### APNS Keys Do Not Need to Be in Nightscout + +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. + +The APNS credentials only need to be in *Nightscout* if you also use *Nightscout* Careportal or the *LoopCaregiver* app to send remote commands. + +### *LoopFollow* Feature History + +| *LoopFollow* Version | Feature Added | +|:--|:--| +| 3.2 | *Loop* remote commands (Meal, Bolus, Override) sent directly via APNS; APNS credentials no longer required in *Nightscout* | +| 4.0 | *Trio* 0.6 remote control support; share remote configuration via QR code | +| 4.3 | Separate QR codes for *Nightscout* Site, Dexcom Share, Remote Settings, and Alarm Settings | +| 4.6 | Real-time APNS notifications returned from the *Loop* phone (requires *Loop* v3.11.1 or newer) | diff --git a/docs/img/loopfollow-home-screen.png b/docs/img/loopfollow-home-screen.png new file mode 100644 index 0000000..aa1b002 Binary files /dev/null and b/docs/img/loopfollow-home-screen.png differ diff --git a/docs/img/loopfollow-main-screen.png b/docs/img/loopfollow-main-screen.png deleted file mode 100644 index fd893f0..0000000 Binary files a/docs/img/loopfollow-main-screen.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index be73170..2bce6ee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,24 +4,38 @@ 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. *LoopFollow* was created because using different apps as a parent or caregiver of a person with diabetes can be cumbersome. -Add in the extra details from looping with an Open Source Automated Insulin Delivery (OS AID) app +Add in the extra details from looping with an Open Source Automated Insulin Delivery (OS-AID) app and flipping back and forth between various sources of information can be a challenge. Many loopers use *LoopFollow* for themselves because of the flexible (and loud) alarm options. *LoopFollow*: -* Displays information from a Nightscout URL or Dexcom Share account -* Provides flexible alarm features with a Snooze screen -* Supports *Loop* and *Trio* OS AID systems and provides remote control features +* Displays information from a *Nightscout* Site or Dexcom Share account +* Provides flexible alarms with a Snooze screen +* Displays Treatments and Statistics (requires *Nightscout* Site) +* Supports *Loop* and *Trio* OS-AID systems + * Provides secure remote control (requires *Nightscout* Site and security configuration) * Supports up to 3 loopers – each with their own unique app name * Works with your Apple Watch * Runs on an iPhone, iPad or a Mac computer -An example of the main screen for *LoopFollow* is shown in the graphic below: +#### Home -> ![example of main screen for *LoopFollow*](img/loopfollow-main-screen.png) +An example of the Home screen for *LoopFollow* v5.0 and newer is shown in the graphic below: + +![example of Home screen for *LoopFollow*](img/loopfollow-home-screen.png){width=400} {align="center"} +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. + +#### New Features +!!! tip "" + New with *LoopFollow* v5.0: + + * [Menu Screen](setup/lf-setup.md#menu-screen){: target="_blank"} + * [Treatments](setup/lf-features.md#treatments){: target="_blank"} + * [Statistics](setup/lf-features.md#statistics){: target="_blank"} + - - - ## Hardware Requirements @@ -36,17 +50,23 @@ The *LoopFollow* app will run on any iPhone or iPad that supports iOS 16.6 or ne ### Community Support and Build Help -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. +Community support for *LoopFollow* is available at -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: +* [*LoopFollow* FaceBook page](https://www.facebook.com/groups/loopfollowlnl) +* [*Loop and Learn* Facebook](https://www.facebook.com/groups/LOOPandLEARN) +* [*Loop and Learn* Discord](https://discord.gg/KQgk3gzuYU) -* Example: [https://github.com/docs-test/LoopFollow/actions](https://github.com/docs-test/LoopFollow/actions) +Please use community support for Build questions. **Do not ask ChatGPT or any AI system; they tend to provide incorrect answers.** + +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: -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. +* Example: [https://github.com/docs-test/LoopFollow/actions](https://github.com/docs-test/LoopFollow/actions) ### Issues and Feature Requests -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. +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. + + 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). - - - @@ -60,11 +80,4 @@ In addition, at the bottom of the Settings screen for *LoopFollow*, the version ## History -This code was originally developed by Jon Fawcett who turned over development and management to the *Loop and Learn* team. - -We are happy to respond to bug reports or feature requests. - -* [*Loop and Learn* Website](https://loopandlearn.org) -* [*Loop and Learn* Facebook](https://www.facebook.com/groups/LOOPandLEARN) -* [*Loop and Learn* YouTube Channel](https://www.youtube.com/c/loopandlearn) - +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. diff --git a/docs/remote/img/app_icons.png b/docs/remote/img/app_icons.png deleted file mode 100644 index ed70671..0000000 Binary files a/docs/remote/img/app_icons.png and /dev/null differ diff --git a/docs/remote/img/import-from-qr-code.png b/docs/remote/img/import-from-qr-code.png deleted file mode 100644 index 95b1af5..0000000 Binary files a/docs/remote/img/import-from-qr-code.png and /dev/null differ diff --git a/docs/remote/img/import-settings.png b/docs/remote/img/import-settings.png deleted file mode 100644 index a9d8b63..0000000 Binary files a/docs/remote/img/import-settings.png and /dev/null differ diff --git a/docs/remote/img/lf-settings-screen.png b/docs/remote/img/lf-settings-screen.png deleted file mode 100644 index 154b4ed..0000000 Binary files a/docs/remote/img/lf-settings-screen.png and /dev/null differ diff --git a/docs/remote/img/lf-trc-empty-debug.jpg b/docs/remote/img/lf-trc-empty-debug.jpg deleted file mode 100644 index af85f5e..0000000 Binary files a/docs/remote/img/lf-trc-empty-debug.jpg and /dev/null differ diff --git a/docs/remote/remote-control-loop.md b/docs/remote/remote-control-loop.md index c223c23..8311c09 100644 --- a/docs/remote/remote-control-loop.md +++ b/docs/remote/remote-control-loop.md @@ -5,10 +5,9 @@ This option is available for remote control of a *Loop* phone using *LoopFollow* * *Loop* Remote Control with Real-Time Notifications * Remote control with *LoopFollow* includes adding remote carbs, enacting remote bolus, and starting and canceling Overrides * The *LoopFollow* phone sends directly through APNS to the *Loop* phone - * The *Loop* phone, if it gets the APNS message, returns an APNS response with success or error message for carb or bolus commands + * The *Loop* phone, if it gets the APNS message, returns an APNS response with success or error message for carb or bolus commands for *Loop* version v3.11.1 or newer * The override commands do not get an APNS message returned - ### Quick Access The bullets below take you to the indicated topics. @@ -75,10 +74,6 @@ Example messages are highlighted by red rectangles in the composite below for re |:-:|:-:| | ![ remote bolus current](img/lf-lrc-bolus.png){width="300"} | ![ remote bolus older than 12 minutes](img/lf-lrc-bolus-old.png){width="300"} | - -! -{align=center} - !!! tip "Make sure *Loop* information is up to date" The insulin amount is filled out with the last recommended bolus that *LoopFollow* downloaded from the *Nightscout* site, which in turn was uploaded from the *Loop* phone. @@ -203,7 +198,7 @@ The Remote Settings row in the *LoopFollow* Settings screen is used to select th {align="center"} !!! question "The *Loop* Remote Control option is not available" - The `Loop Remote Control` option is only available in *LoopFollow* if you have already entered a [*Nightscout* URL](../setup/lf-setup.md#add-nightscout){: target="_blank" } with a default profile recognized as a *Loop* profile. + The `Loop Remote Control` option is only available in *LoopFollow* if you have already entered a [*Nightscout* Site](../setup/lf-setup.md#setup-nightscout){: target="_blank" } with a default profile recognized as a *Loop* profile. ### Guardrails diff --git a/docs/remote/remote-control-nightscout.md b/docs/remote/remote-control-nightscout.md index 554c11a..2f5b415 100644 --- a/docs/remote/remote-control-nightscout.md +++ b/docs/remote/remote-control-nightscout.md @@ -27,7 +27,7 @@ For *Loop* careportal access, your *Nightscout* site must be configured with App * [*LoopDocs*: Remote Overview](https://loopkit.github.io/loopdocs/nightscout/remote-overview/) -Then once you add the Nightscout URL with at least a careportal token to *LoopFollow* and choose *Nightscout* for the *LoopFollow* Remote Settings, you have the option to set or cancel overrides for the *Loop* app. +Then once you add the *Nightscout* Site with at least a careportal token to *LoopFollow* and choose *Nightscout* for the *LoopFollow* Remote Settings, you have the option to set or cancel overrides for the *Loop* app. The graphic below shows what the screen looks like when you tap the `Remote` option from the toolbar of *LoopFollow*. diff --git a/docs/remote/remote-control-overview.md b/docs/remote/remote-control-overview.md index edb1715..9d05439 100644 --- a/docs/remote/remote-control-overview.md +++ b/docs/remote/remote-control-overview.md @@ -28,15 +28,7 @@ ## *LoopFollow* Remote Options -> With the release of *LoopFollow* 3.2, remote options for the *Loop* app were updated to send directly to the *Loop* phone via APNS - -> With the release of *LoopFollow* 4.0, you can [share remote control configuration](#export-remote-settings-with-qr-code) using a QR code. - -> With the release of *LoopFollow* 4.3, [multiple QR codes are provided which are separated by function](../setup/lf-setup.md#importexport-settings){: target="_blank" } so you can share Nightscout URL, Dexcom Share and Alarm Settings without sharing Remote Control Configurations. - -> With the release of *LoopFollow* 4.6, return messages sent from the *Loop* phone are displayed as notifications (requires *Loop* v3.11.1 or newer) - -* Keep checking back on this page, the remote capability is under development and there may be new features for you to read about. +For a full summary of version requirements and feature history, see [Version Compatibility](../faqs/lf-faqs.md#version-compatibility){: target="_blank" }. The graphic below shows the Remote Settings screen for *LoopFollow*. You must first enter a *Nightscout* URL before any remote options are offered and then only the option suitable for that *Nightscout* site can be selected. @@ -76,7 +68,7 @@ To share your remote settings with another device, follow the directions in this If in doubt revoke access to the key at [https://developer.apple.com/account/resources/authkeys/list](https://developer.apple.com/account/resources/authkeys/list) and generate a new one. -To show the QR Code, go into Remote settings on the phone that is already configured for remote control. Click the button Import/Export Settings and then choose Export Remote Settings. (The graphic below is out of date). You can access this same function by going to Settings->Import/Export Settings directly. +To show the QR Code, go into Remote settings on the phone that is already configured for remote control. Click the button Import/Export Settings and then choose Export Remote Settings. You can access this same function by going to Settings->Import/Export Settings directly. > This process works for both Loop Remote Control and for Trio Remote Control. @@ -88,18 +80,18 @@ To show the QR Code, go into Remote settings on the phone that is already config !!! tip "Setting up a Second Device for Remote Control" With version 4.3 and newer, you can set up a second device using a selection of QR codes from a LoopFollow phone that is already configured. - You can share Nightscout URL, Dexcom Share and Alarm Settings if someone only needs to follow the looper. + You can share *Nightscout* Site, Dexcom Share and Alarm Settings if someone only needs to follow the looper. You can share Remote Control Configurations if someone needs to send remote commands. **If a follower only needs to monitor and get alarms** * Do **not** use the QR code for Remote Control Settings -* Limit the sharing to the other QR codes for Nightscout URL, Dexcom Share and Alarm Settings +* Limit the sharing to the other QR codes for *Nightscout* Site, Dexcom Share and Alarm Settings This process works for both Loop and for Trio. -For more information: see [Import/Export Settings](../setup/lf-setup.md#importexport-settings){ target="_blank" } +For more information: see [Import/Export Settings](../setup/lf-setup.md#importexport){ target="_blank" } - - - @@ -145,7 +137,7 @@ With *LoopFollow* 3.2 and newer, the config vars will not need to be embedded in If you do not have APNS credentials, you need to create a key and grant it access to the  Apple Push Notification Service (APNS). -> Note - these directions are copied from *LoopDocs* so it suggests you name the key *Nightscout*. It is probably best to stick with that naming for APNS keys whether you are using *Loop* or *Trio*. +> It is recommended to name the key *Nightscout* for APNS keys, whether you are using *Loop* or *Trio*. !!! info "Reminder" This only works with the **paid** Apple Developer ID. @@ -201,50 +193,4 @@ Depending on the selection you made, continue to one of these pages for more inf * [*Trio* Remote Control](remote-control-trio.md) * [*Nightscout* Remote Control](remote-control-nightscout.md) (`Trio 0.2.x only`) -## Background Information - -There has been a lot of recent changes to remote control with LoopFollow. - -The historical notes are in this section. - - -!!! tip "`Loop` Remote Control with *LoopFollow* 3.2" - With the release of *LoopFollow* 3.2, the remote control features accessible from LoopFollow match those available from the *LoopCaregiver* app. - - You must update to *LoopFollow* 3.2 or newer and configure remote settings in the *LoopFollow* app to use these features. - - -### Changes for *LoopFollow* Remote Control of the *Loop* App - -* With *LoopFollow* 3.2 and newer - * *Loop* remote commands from *LoopFollow* include Meal, Bolus and Override control - * *LoopFollow* no longer requires the *Nightscout* site be configured with the APNS credentials - * Read access for the *Nightscout* URL is sufficient -* With *LoopFollow* 3.1 and older - * *Loop* remote commands were limited to Overrides, required the *Nightscout* site be configured with the APNS credentials and required a token with `careportal` access - -> 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. - - -### *LoopFollow* Remote Control - -* *LoopFollow* Remote Control sends messages to the loopers phone using APNS - * **Loop**: Requires *LoopFollow* 3.2 or newer - * **Trio**: Requires matched code versions: - * Trio 0.6 (or newer) requires LoopFollow 4.0 (or newer) - * Trio 0.5.1.28 (or older) requires LoopFollow 3.2.11 (or older) - * Commands go via APNS to the *Loop*/*Trio* phone - * An immediate success or failure for **sending** the message to APNS is received - * 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 - * **Trio v0.6 or newer** an APNS response is returned to *LoopFollow* - * A success or failure message is pushed back to the *LoopFollow* phone from the *Trio* phone when a remote command is received and handled - * The results show up in *Nightscout* after being uploaded from the *Loop*/*Trio* phone - * The results are plotted or displayed in *LoopFollow* after being downloaded from the *Nightscout* URL as a new treatment - * APNS keys do not need to be embedded in the *Nightscout* site - * This simplifies configuration of *Nightscout*, especially for those who use a paid service for *Nightscout* -* For those following a looper using *Trio* 0.2.x, the only option for the Remote Setting is *Nightscout*, which uses Careportal - * With this selection, the *LoopFollow* phone sends commands to *Nightscout*, which then sends commands to the *Trio* phone - * For that reason, the *Nightscout* display will be updated first - * If there is an issue sending the careportal request from *Nightscout*, it might not make it to the *Trio* phone - * After the next download from *Nightscout*, the display will update if commands do or do not make it through the full round trip diff --git a/docs/remote/remote-control-trio.md b/docs/remote/remote-control-trio.md index bcbb125..05cdac0 100644 --- a/docs/remote/remote-control-trio.md +++ b/docs/remote/remote-control-trio.md @@ -3,7 +3,7 @@ Trio can accept remote commands from *Nightscout* or from *LoopFollow*. There are a variety of options, but the final control of whether remote commands will be enacted rests with the *Trio* user. They can enable or disable remote control. !!! warning "*Nightscout* version must be 15.0.2 or newer" - 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). + 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 Nightscout for Trio (OpenAPS)](#configure-nightscout-for-trio-openaps). 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. @@ -148,7 +148,7 @@ The Remote Settings row in the *LoopFollow* Settings screen is used to select th {align="center"} !!! question "The *Trio* Remote Control option is not available" - The `Trio Remote Control` option is only available in *LoopFollow* if you have already entered a [*Nightscout* URL](../setup/lf-setup.md#add-nightscout){: target="_blank" } with a default profile recognized as a *Trio* profile. Review [Troubleshooting](#troubleshooting) for possible reasons for not seeing the option. + The `Trio Remote Control` option is only available in *LoopFollow* if you have already entered a [*Nightscout* Site](../setup/lf-setup.md#setup-nightscout){: target="_blank" } with a default profile recognized as a *Trio* profile. Review [Troubleshooting](#troubleshooting) for possible reasons for not seeing the option. * *Nightscout* option * Remote control with *LoopFollow* is limited to starting and canceling Temp Targets @@ -221,7 +221,7 @@ When you select *Trio* Remote Control as the Remote Type in the *LoopFollow* app ### APNS Key ID -If you previously configured remote control with the *Loop* app, you already have an *Apple* Push Notification System (APNS) Key ID and Key. These were added to the config vars in your *Nightscout* site. See [Existing APNS](remote-control-overview.md#existing-apns){: target="_blank" }. The value of the `LOOP_APNS_KEY_ID` goes here. Be sure to read the [Configure for OpenAPS](#configure-for-openaps) section about steps to make *Nightscout* and *LoopFollow* work with Trio. +If you previously configured remote control with the *Loop* app, you already have an *Apple* Push Notification System (APNS) Key ID and Key. These were added to the config vars in your *Nightscout* site. See [Existing APNS](remote-control-overview.md#existing-apns){: target="_blank" }. The value of the `LOOP_APNS_KEY_ID` goes here. Be sure to read the [Configure Nightscout for Trio (OpenAPS)](#configure-nightscout-for-trio-openaps) section about steps to make *Nightscout* and *LoopFollow* work with Trio. If you have never created an APNS (or have lost the credentials), follow the directions in [New APNS](remote-control-overview.md#new-apns){: target="_blank" } and copy the APNS Key ID into *LoopFollow* and save the value in your Secrets Reference file. @@ -252,11 +252,11 @@ If you took those steps and still have missing rows, return to [Configure *LoopF This section covers known troubleshooting issues: -* *Nightscout* not displaying *Trio* data: [Configure for OpenAPS](#configure-for-openaps) +* *Nightscout* not displaying *Trio* data: [Configure Nightscout for Trio (OpenAPS)](#configure-nightscout-for-trio-openaps) * Was able to select *Trio* Remote Control in *LoopFollow* but it is no longer working: [Stop *Nightscout* access from other apps](#stop-nightscout-uploads-from-other-apps) * Cannot select *Trio* Remote Control in *LoopFollow*: [Update Profile](#update-profile) -### Configure for OpenAPS +### Configure Nightscout for Trio (OpenAPS) The *Nightscout* version must be 15.0.2 (or newer) to properly display the OpenAPS pill with *Trio* 0.5.x (or newer). Check your revision: *Nightscout* URL, Menu, scroll to bottom and examine the About section. @@ -293,7 +293,7 @@ To force a profile to update to *Nightscout*, go to the *Trio* app and toggle Al Once the user has toggled "Allow Uploading to Nightscout", *LoopFollow* needs to be refreshed (pull down glucose value to refresh) or re-started in order to fetch the correct information. *LoopFollow* will refresh eventually, but most users are impatient. -If the Debug Info in *LoopFollow* is missing a Device Token or a Bundle ID, as shown on the left side of the graphic, you need to make sure the *Loop* app is no longer uploading to *Nightscout* and force the profile to update. +If the Debug Info in *LoopFollow* is missing a Device Token or a Bundle ID, as shown on the left side of the graphic, you need to make sure any previous AID app (*Loop*, *iAPS*) is no longer uploading to *Nightscout* and force the profile to update. ![LoopFollow debug info indicates a problem](img/lf-force-ns-profile.svg){width=600} {align=center} diff --git a/docs/setup/img/import-from-qr-code.jpg b/docs/setup/img/import-from-qr-code.jpg deleted file mode 100644 index 1cb9e7f..0000000 Binary files a/docs/setup/img/import-from-qr-code.jpg and /dev/null differ diff --git a/docs/setup/img/lf-alarms-example.svg b/docs/setup/img/lf-alarms-example.svg new file mode 100644 index 0000000..0daa841 --- /dev/null +++ b/docs/setup/img/lf-alarms-example.svg @@ -0,0 +1,384 @@ + +image/svg+xml diff --git a/docs/setup/img/lf-alarms-screen.png b/docs/setup/img/lf-alarms-screen.png new file mode 100644 index 0000000..994dfbc Binary files /dev/null and b/docs/setup/img/lf-alarms-screen.png differ diff --git a/docs/setup/img/lf-alarms.svg b/docs/setup/img/lf-alarms.svg new file mode 100644 index 0000000..5a56f31 --- /dev/null +++ b/docs/setup/img/lf-alarms.svg @@ -0,0 +1,345 @@ + +image/svg+xml diff --git a/docs/setup/img/lf-feature-statistics.svg b/docs/setup/img/lf-feature-statistics.svg new file mode 100644 index 0000000..9dcee3c --- /dev/null +++ b/docs/setup/img/lf-feature-statistics.svg @@ -0,0 +1,465 @@ + +image/svg+xml diff --git a/docs/setup/img/lf-menu.svg b/docs/setup/img/lf-menu.svg new file mode 100644 index 0000000..2cde8a2 --- /dev/null +++ b/docs/setup/img/lf-menu.svg @@ -0,0 +1,263 @@ + +image/svg+xml diff --git a/docs/setup/img/lf-settings-alarms.svg b/docs/setup/img/lf-settings-alarms.svg new file mode 100644 index 0000000..5f74700 --- /dev/null +++ b/docs/setup/img/lf-settings-alarms.svg @@ -0,0 +1,391 @@ + +image/svg+xml diff --git a/docs/setup/img/lf-settings.svg b/docs/setup/img/lf-settings.svg index f4e7e70..17ad032 100644 --- a/docs/setup/img/lf-settings.svg +++ b/docs/setup/img/lf-settings.svg @@ -1,8 +1,8 @@ + transform="translate(-865,128)"> diff --git a/docs/setup/img/lf-tab-configuration.png b/docs/setup/img/lf-tab-configuration.png new file mode 100644 index 0000000..10a58a9 Binary files /dev/null and b/docs/setup/img/lf-tab-configuration.png differ diff --git a/docs/setup/img/lf-tab-custom-instructions.svg b/docs/setup/img/lf-tab-custom-instructions.svg deleted file mode 100644 index 91df219..0000000 --- a/docs/setup/img/lf-tab-custom-instructions.svg +++ /dev/null @@ -1,1960 +0,0 @@ - -image/svg+xml diff --git a/docs/setup/img/lf-tab-custom.svg b/docs/setup/img/lf-tab-custom.svg deleted file mode 100644 index 5904e63..0000000 --- a/docs/setup/img/lf-tab-custom.svg +++ /dev/null @@ -1,276 +0,0 @@ - -image/svg+xml diff --git a/docs/setup/img/lf-treatments-screen.png b/docs/setup/img/lf-treatments-screen.png new file mode 100644 index 0000000..ca83ae1 Binary files /dev/null and b/docs/setup/img/lf-treatments-screen.png differ diff --git a/docs/setup/lf-features.md b/docs/setup/lf-features.md index af7d1da..e04cf3a 100644 --- a/docs/setup/lf-features.md +++ b/docs/setup/lf-features.md @@ -1,69 +1,76 @@ +## *LoopFollow* Features -🚧 Documentation Under Construction 🚧 +Most features and the settings that control them are self-explanatory and documented within the app. Some documentation is provided below. + +- - - - - +When you select the Alarms Feature, the initial screen will be blank. By tapping on the plus sign upper right, you can add as many alarms as desired. There is quick access to the overall [Alarm Settings](lf-setup.md#alarms) by tapping the gear icon on this screen. -## *LoopFollow* Features +The graphic below shows a few typical alarms that might be chosen. + +![example alarm screen](img/lf-alarms-screen.png){width="350"} +{align="center"} + +When you tap on a given alarm, you can customize the settings in a number of ways. An example for the Low BG Alert is shown below. Once you customize and alarm, you can enable or disable it quickly while maintaining your custom settings. + +![alarms can be customized](img/lf-alarms-example.svg){width="700"} +{align="center"} + +The graphic below shows the many types of alarms that are available with *LoopFollow*. -Most features are self-explanatory. Use the [Settings Screen](lf-setup.md#settings-screen){: target="_blank" } to navigate to the appropriate section to adjust the app settings. +![alarms to select](img/lf-alarms.svg){width="700"} +{align="center"} -Some features require more explanation. - - - -## Toolbar Tab Customization +## Snoozer -The toolbar or tab bar at the bottom of the *LoopFollow* screen is used for rapid access to specific features. This navigation feature can support up to 5 tabs, but there are 6 options that could be placed there. With version 3.1 and newer, the tabs displayed are customizable. +🚧 Documentation Under Construction 🚧 -??? tip "Historical Tabs (Click to open/close)" - Historically the 5 tabs were: +- - - - * tab 1: Home - * tab 2: Alarms or Remote Control - * tab 3: Snoozer - * tab 4: Nightscout site - * tab 5: Settings +## Remote Control with *LoopFollow* - The updated design is that tabs 2 and 4 are optional and tab 5 can be either settings or the … More icon. +Do not skip the overview page if you have not yet configured *LoopFollow* for Remote Control. -The new arrangement is: +* [Remote Control Overview](../remote/remote-control-overview.md) -* tab 1: Home -* tab 2: Configurable -* tab 3: Snoozer -* tab 4: Configurable -* tab 5: Configurable (Settings or … More) +There are separate pages for the 3 different remote control options. (No page is provided if `None` is selected). +Quick access is provided using these links once you have configured *LoopFollow* for Remote Control: -### Instructions for Tab Selection +* None +* [*Nightscout*](../remote/remote-control-nightscout.md){: target="_blank" } (*LoopFollow* offers actions that can be done from a *Nightscout* Careportal) +* [*Loop* Remote Control](../remote/remote-control-loop.md){: target="_blank" } +* [*Trio* Remote Control](../remote/remote-control-trio.md){: target="_blank" }: requires Trio 0.5.x or newer -After choosing the Tab Selection row from *LoopFollow* Settings, these tab options can be placed as desired in your choice of tab 2, tab 4, the … More Menu or Hidden. -* Alarms -* Remote -* Nightscout site +- - - -> If you tap cancel in upper left - no changes are saved. +## Treatments -> Once you tap `Apply` in upper right, your toolbar is updated. +The treatments screen displays all treatments downloaded from the Nightscout Site with user-selectable filters on treatment type. -> ![Instructions for tab customization](img/lf-tab-custom-instructions.svg){width="350"} +![example treatments screen](img/lf-treatments-screen.png){width=700} {align="center"} -### Example Tab Choices +- - - + +## Statistics + -To clarify the selection process, the graphic below shows 3 choices for Tab Settings on the left, with the resultant toolbar on the right. +The Statistics screen displays a variety of plots and values. This requires an associated Nightscout Site. If the Nightscout site is limited in the days of data, it will be noticeable in the Data Availability metric on the first row. -![Several tab selections](img/lf-tab-custom.svg){width="700"} +![example treatments screen](img/lf-feature-statistics.svg){width=700} {align="center"} - - - -## Background Refresh Settings +## Background Refresh *LoopFollow* has traditionally provided an option to play a silent audio as a trick to allow it to wake up when in the background or when the phone is locked. This has several drawbacks including battery drain and limited reliability. @@ -152,19 +159,3 @@ You’re ready to monitor your glucose data directly on your Apple Watch! 🚧 import graphics from lnl 🚧 -- - - - -## Remote Control with *LoopFollow* - -Do not skip the overview page if you have not yet configured *LoopFollow* for Remote Control. - -* [Remote Control Overview](../remote/remote-control-overview.md) - -There are separate pages for the 3 different remote control options. (No page is provided if `None` is selected). -Quick access is provided using these links once you have configured *LoopFollow* for Remote Control: - -* None -* [*Nightscout*](../remote/remote-control-nightscout.md){: target="_blank" } (*LoopFollow* offers actions that can be done from a *Nightscout* Careportal) -* [*Loop* Remote Control](../remote/remote-control-loop.md){: target="_blank" } -* [*Trio* Remote Control](../remote/remote-control-trio.md){: target="_blank" }: requires Trio 0.5.x or newer - diff --git a/docs/setup/lf-setup.md b/docs/setup/lf-setup.md index 973949c..2817c93 100644 --- a/docs/setup/lf-setup.md +++ b/docs/setup/lf-setup.md @@ -1,17 +1,3 @@ -🚧 Documentation Under Construction 🚧 - - - - -While this website is under construction, you can find missing information in three places: - -* [*Loop and Learn* website: *LoopFollow* page](https://www.loopandlearn.org/loop-follow/) -* [LoopDocs website: Build Other Apps page](https://loopkit.github.io/loopdocs/browser/other-apps/) -* [Trio Docs: Loop Follow Remote Control Configuration page](https://triodocs.org/configuration/settings/features/remote-control/) - - ## Initial Configuration After you build *LoopFollow* the first time, you are asked a few questions (your initial choices can always be modified later): @@ -29,23 +15,71 @@ You will then be presented with a home screen as shown below. Tap on the "Setup Nightscout" button or "Setup Dexcom Share" button to enter your credentials for your preferred service. -Tap on the … More icon, at bottom right, and then choose Settings to get to the Settings screen. +For more information about how to configure your data source, refer to these sections: -!!! note "Tab Customization" - With version 3.1 and newer, you can modify what icons show up in the tab bar. - - If you prefer the Gear/Settings Icon (βš™οΈ) in the tab bar, follow the directions in [Toolbar Tab Customization](lf-features.md#toolbar-tab-customization){: target="_blank" }. +* [Setup Nightscout](#setup-nightscout) +* [Setup Dexcom](#setup-dexcom) + +Once a Data Source is entered, you have access to a variety of *LoopFollow* features. + +The default settings are a fine place to start. As you learn to use *LoopFollow*, you can explore the adjustable Settings and Features. - - - -### Settings Screen +## Home -The full lists of Settings is shown in the composite graphic below. +The home screen provides a dashboard of important information. -* The `Information Display Settings` and `Remote Settings` rows are only available with [Nightscout Credentials](#add-nightscout). +* Supports Glucose display when Dexcom is available but Nightscout is not +* Supports Information Display from *Loop* and *Trio* when Nightscout Site is provided + * *Loop* & *Trio*: common features like status, basal, bolus, carbs and eventual glucose forecast + * *Loop*: *Loop* specific features like Profile Name, remote control + * *Trio*: *Trio* specific features like Autosens, TDD, remote control (with *Trio* 0.5.x and newer) +Once you’ve configured your settings, your Home screen will look as beautiful as the example below! -> ![Setting for LoopFollow v 3.1](img/lf-settings.svg){width="700"} +![overview graphic of home screen](img/lf-table-overview.png){width="700"} +{align="center"} + +- - - + +## Toolbar + +The toolbar (tab bar) at the bottom of the Home and Menu screens is configurable using [Settings: Tab](#tab). Four icons are displayed at a time β€” choose from the options below. The features that can be selected are: + +| Name | Description | +|:--|:--| +| Home | Plots and summary display | +| Alarms | Select and configure Alarms | +| Remote | Send remote commands to an OS-AID app (*Loop* or *Trio*), requires Nightscout and secure configuration | +| Nightscout | Display your Nightscout Site | +| Snoozer | Allows quick "snooze" of alarms, great screen for night use or monitoring | +| Treatments | Display Treatments, selectable by type | +| Statistics | Display Statistics for up to 90 days, requires Nightscout Site | + + +## Menu Screen + +The following graphic shows the menu screen. The menu can always be reached using the right button of the toolbar on the Home and Menu screens. + +* The features on this screen are described on the [*LoopFollowDocs* Features page](lf-features.md){: target="_blank" } +* Settings, Logging and Build Information are covered below +* [Support & Community](../index.md#community-support-and-build-help){: target="_blank" } are discussed on the *LoopFollowDocs* home page + + +![Menu screen for *LoopFollow*](img/lf-menu.svg){width=400} +{align="center"} + +- - - + +## Settings Screen + +The Settings Screen is accessed by tapping on the Menu icon and selecting the Settings row. + +* The `Information Display` and `Remote` rows are only available with [Nightscout Credentials](#setup-nightscout). + + +![Settings screen for LoopFollow](img/lf-settings.svg){width="350"} {align="center"} ### *LoopFollow* Data Source @@ -54,18 +88,18 @@ The full lists of Settings is shown in the composite graphic below. You provide *LoopFollow* with information about the person you are following. At least one of these must be entered: -* [*Nightscout* URL](#add-nightscout) -* [*Dexcom* Share credentials](#add-dexcom) +* [*Nightscout* URL](#setup-nightscout) +* [*Dexcom* Share credentials](#setup-dexcom) -#### Add *Nightscout* +#### Setup *Nightscout* -The graphic below shows the display when you tap on the *Nightscout* Settings row. For more information about tokens, keep reading the details below the graphic. +The graphic below shows the display when you tap on the *Nightscout* row. For more information about tokens, keep reading the details below the graphic. When adding the Nightscout information to monitor, you can copy your *Nightscout* URL (including the token) from the [Admin Tools in *Nightscout*](https://nightscout.github.io/nightscout/admin_tools/#subjects-and-roles). When pasted into *LoopFollow* URL row, the app will automatically extract and fill in both the URL and token. !!! note "Setting up a second device" - With version 4.3 and newer, You can set up a second device by scanning a QR code from another LoopFollow user. See this section [Import/Export Settings](#importexport-settings). + With version 4.3 and newer, You can set up a second device by scanning a QR code from another LoopFollow user. See this section [Import/Export](#importexport). ![enter nightscout credentials](img/lf-data-source-ns.png){width="300"} @@ -80,12 +114,7 @@ The type of token depends on the type of remote control desired. The table below indicates the minimum token access for each type of remote control available with *LoopFollow*. When you enter your credentials, *LoopFollow* tries to reach the site and then provides the status. -* The *Loop* Remote Control option requires *LoopFollow* version 3.2 or newer - * With LoopFollow 4.6 and later, the ability to get direct success or failure responses back to the LoopFollow phone is enhanced but requires Loop version 3.11.1 or newer -* The *Trio* Remote Control option requires the user be on version 0.5.x or newer of Trio - * **Breaking change** on 2025-October-06 - * *Trio* 0.6 or newer requires *LoopFollow* 4.0 or newer - * *Trio* 0.5.1.28 or older requires *LoopFollow* 3.2.11 or older +For a full summary of version requirements for *Loop* and *Trio* remote control, see [Version Compatibility](../faqs/lf-faqs.md#version-compatibility){: target="_blank" }. | *LoopFollow* Remote Type | Minimum Token Access| *LoopFollow* Status | |:--|:--|:--| @@ -94,83 +123,161 @@ When you enter your credentials, *LoopFollow* tries to reach the site and then p | ***Trio* Remote Control**| Read | OK (Read) | | ***Nightscout***
Trio 0.2 or older | Read & Careportal | OK (Read & Write) | -#### Add *Dexcom* +#### Setup *Dexcom* -The graphic below shows the display when you tap on the *Dexcom* Settings row. +The graphic below shows the display when you tap on the *Dexcom* row. > The *Dexcom* Share credentials are optional, but can be useful when the *Nightscout* URL is unavailable. !!! note "Setting up a second device" - With version 4.3 and newer, You can set up a second device by scanning a QR code from another LoopFollow user. See this section [Import/Export Settings](#importexport-settings). + With version 4.3 and newer, You can set up a second device by scanning a QR code from another LoopFollow user. See this section [Import/Export](#importexport). - - - ![enter dexcom credentials](img/lf-data-source-dexcom.png){width="300"} {align="center"} -- - - - -## The Toolbar - -The toolbar (tab bar) at the bottom of the screen is now configurable for rapid access to the items of your choice. The items that can be selected are: - -* [Home](#home) -* [Alarms](#alarms) -* Snoozer -* [Remote](#remote-settings) -* Nightscout -* Settings - -See [Toolbar Tab Customization](lf-features.md#toolbar-tab-customization){: target="_blank" } - - - -## Home +### Display Settings -The home screen provides a dashboard of important information. +There are a number of display options the user can configure to customize the appearance of the plots, tables and navigation tabs. These are summarized in the table below along with quick links to a more detailed description. -* Supports Glucose display when Dexcom is available but Nightscout is not -* Supports Information Display from *Loop* and *Trio* when Nightscout URL is provided - * *Loop* & *Trio*: common features like status, basal, bolus, carbs and eventual glucose forecast - * *Loop*: *Loop* specific features like Profile Name, remote control - * *Trio*: *Trio* specific features like Autosens, TDD, remote control (with *Trio* 0.5.x and newer) +* The `Information Display` row is only displayed with [Nightscout Credentials](#setup-nightscout). -Once you’ve configured your settings, your Main screen will look as beautiful as the example below! -![overview graphic of home screen](img/lf-table-overview.png){width="700"} -{align="center"} +| Name | Description | Link | +|:--|:--|:--| +| General | Adjust settings that affect the general app behavior | [General](#general) | +| Graph | Adjust settings that affect the plots on the Home screen | [Graph](#graph) | +| Information Display | Select which items to display in the Home screen Information Table
Requires Nightscout Data Source | [Information Display](#information-display) | +| Tab | Configure the toolbar displayed on the Home and Menu screens |[Tab](#tab) | -- - - +### App Settings -## App Settings +There are a number of application settings the user can configure. These are summarized in the table below along with quick links to a more detailed description. -🚧 Documentation Under Construction 🚧 +* The `Remote` row is only displayed with [Nightscout Credentials](#setup-nightscout). -### Background Refresh Settings -🚧 Documentation Under Construction 🚧 +| Name | Description | Link | +|:--|:--|:--| +| Background Refresh | Configure to keep *LoopFollow* always alive or allow it to sleep and thus conserve phone battery | [Background Refresh](lf-features.md#background-refresh){: target="_blank" } | +| Import/Export | Share configurations among Caregiver phones | [Import/Export](#importexport) | +| Remote | Configure for secure remote control
Requires Nightscout Data Source | [Remote Control Overview](../remote/remote-control-overview.md){: target="_blank" } | -### General Settings +### Other Settings -🚧 Documentation Under Construction 🚧 +There are a few more sections on the Settings screen. These are summarized in the table below along with quick links to a more detailed description. -### Graph Settings Settings +| Name | Description | Link | +|:--|:--|:--| +| Alarms | Control overall alarm behavior; individual alarms are configured in the Alarms feature | [Alarms](#alarms) | +| Calendar | Configure calendar updates for CarPlay | [Calendar](#calendar) | +| Contact | Configure real-time glucose updates on Apple Watch | [Contact](#contact) | +| Advanced | Control which data is downloaded from Nightscout and adjust graph options | [Advanced](#advanced) | -🚧 Documentation Under Construction 🚧 +- - - -### Tab Settings +## Settings Details + +### General + +These settings are accessed through the General row in the Settings screen. + +| Name | Description | +|:--|:--| +| Display App Badge | When enabled
- current glucose is displayed with app icon
- select a Background Refresh option or badge will be stale. | +| Persistent Notification | Typically disabled
When enabled, glucose is reported with every update | +| Appearance | Choose Light, Dark or System for appearance | +| Display Stats | When enabled, statistics for the last 24 hours are displayed on Home screen | +| Use IFCC A1C | When enabled, display estimated A1C using mmol/mol units | +| Display Small Graph | When enabled, a full history graph is displayed under the main plot. The history is determined by the Number of Days Back chosen in the Graph screen | +| Color BG Text | When enabled, use colors to highlight low, in-range and high values | +| Keep Screen Active | When enabled, override the auto-lock setting
This works whether the phone is plugged in or not, so be sure to lock screen manually| +| Show Display Name | When enabled, the app name is shown on the Home screen
Very useful if more than one person is being followed| +| Snoozer Emoji | When enabled, the snoozer screen shows emojis in addition to glucose values | +| Force Portrait Mode | When enabled, aspect ratio is not affected by phone orientation | +| Time Zone Override | When enabled, another row is displayed
Select the time zone for the T1D who is being followed | +| Speak BG | When enabled, glucose is spoken aloud in selected language
Options are available to limit this but see also Persistent Notification | + + +### Graph + +These settings are accessed through the Graph row in the Settings screen. + +| Name | Description | +|:--|:--| +| Display Dots | Enable or Disable | +| Display Lines | Enable or Disable | +| Show DIA Lines | Enable or Disable | +| Show -30 min Line | Enable or Disable, with respect to carb entry | +| Show -90 min Line | Enable or Disable, with respect to carb entry | +| Show Midnight Lines | Enable or Disable | +| Show Calibration | Enable or Disable | +| Show Carb Absorption | Enable or Disable | +| Treatments on Small Graph | Enable or Disable | +| Height | Select height of small Graph | +| Hours of Prediction | Select prediction extent on main plot | +| Min Basal | clamp the minimum displayed range for basal rate plot | +| Min BG Scale | clamp the minimum displayed range for glucose scale | +| Low BG Line | Choose glucose level to display as low | +| High BG Line | Choose glucose level to display as high | +| Show Days Back | Affects the small graph display and adjusts fetch from Nightscout Site | + +### Information Display + +These items can be chosen for display on the Home screen. A Nightscout Site is required and must be accessible or the table is blank. + +> A lower case `loop` is used to denote a `closed-loop` cycle for both `Trio` and `Loop`. + +!!! note "" + The order of rows in the Settings: Information Display screen is reflected in the Information Table on your Home screen. + + * The order in the table below is the order in the LoopFollow code + * You can drag the rows up and down to suit your preferred order + +| Name | Description | `Loop` / `Trio` / Both | +|:--|:--|:-:| +| IOB | Active Insulin, also known as Insulin on Board | Both | +| COB | Active Carbohydrates, also known as Carbs on Board | Both | +| Basal | Current Basal Rate running on the pump | Both | +| Override | Sensitivity (if not 100%) and Target (for `Loop`)
Name (for `Trio`)| Both | +| Battery | Battery level on the OS-AID Phone
*Trio* indicates if currently plugged in | Both | +| Pump | Reservoir Level | Both | +| Pump Battery | Battery level on pumps that report levels | Both | +| SAGE | Sensor Age | Both | +| CAGE | Cannula Age | Both | +| Rec. Bolus | Recommended bolus
from last `loop` | Both | +| Min/Max | Minimum and maximum values for glucose from current OS-AID forecast | Both | +| Carbs today | Total grams of Carbs since Midnight | Both | +| Autosens | `Trio`: autosens value | `Trio` | +| Profile | Named Profile
`Loop` requires Profile Customization | Both | +| Target | Correction Range used by OS-AID | Both | +| ISF | Insulin Sensitivity Factor in therapy settings with modification if appropriate | Both | +| CR | Carbohydrate Ratio in therapy settings with modification if appropriate | Both | +| Updated | Time of last `loop` | `Trio` | +| TDD | Total Daily Dose in the last 24 hours | `Trio` | +| IAGE | Insulin Age | Both | + +### Tab The user can modify which icons are displayed in the task bar at the bottom of the screen. -See [Toolbar Tab Settings](lf-features.md#toolbar-tab-customization){: target="_blank" } for more information. +In the Settings screen, select Tab. Drag any of the options up or down to your preferred configuration. + +![tab customization](img/lf-tab-configuration.png){width=400} +{align="center"} -### Import/Export Settings + +### Import/Export When setting up LoopFollow for another caregiver that will use some or all of the same configuration settings, you can export or scan a QR code to transfer settings between phones. -* Nightscout URL and token -* Dexcom Share Settings -* Remote Configuration Settings +* Nightscout Site and token +* Dexcom Share +* Remote Configuration * Alarms @@ -191,7 +298,7 @@ To export settings, select one of the options for * Export Remote Settings * Export Alarm Settings -![Import settings](img/import-settings.png){width="300"} +![Export settings](img/import-settings.png){width="300"} {align="center"} Export Nightscout Settings, Export Dexcom Share Settings and Export Remote Settings will show a QR code directly that you can scan with the receiving phone. @@ -216,26 +323,7 @@ When the QR code is accepted, you will see a screen indicating what type of sett ![Import confirmation](img/lf-import-confirm.svg){width="600"} {align=center} -### Information Display Settings - -🚧 Documentation Under Construction 🚧 - -#### `Rec. Bolus` - -!!! warning "LoopFollow Report of Trio Recommended Dose" - It happens. We made a mistake. In versions before 4.0, the `Rec. Bolus` feature displayed by *LoopFollow* was a value from the *Trio* app that was never meant to be used as a recommended bolus. - - But the mistake has been fixed and an appropriate `Rec. Bolus` is back. - - Make sure you have these version of code before using the recommended bolus. And pay attention to the warnings about how long since that recommendation was calculated by Trio. - - * LoopFollow 4.3 or newer - * Trio 0.6.0.16 or newer - - **Remember: the `Rec. Bolus` value is from the last AID app update to Nightscout** - - -### Remote Settings +### Remote Detailed instructions for configuring a phone for remote control are found on the [Remote Control Overview](../remote/remote-control-overview.md){: target="_blank" } page. @@ -244,19 +332,15 @@ If you are configuring a second device and already have one device configured fo * [Export Remote Settings with QR Code](../remote/remote-control-overview.md#export-remote-settings-with-qr-code){: target="_blank" } * [Import from QR Code](../remote/remote-control-overview.md#import-from-qr-code){: target="_blank" } -### Alarms - -🚧 Documentation Under Construction 🚧 -### Alarm Settings - -🚧 Documentation Under Construction 🚧 +### Alarms -- - - +The Alarms settings allow you to control the behavior of all active alarms. Individual alarms are selected and configured with the [Alarms Feature](lf-features.md#alarms). -## Integrations +* One nice feature you may want to enable is the Volume Buttons Snooze Alarms option. -🚧 Documentation Under Construction 🚧 +![overall alarm settings](img/lf-settings-alarms.svg){width="350"} +{align="center"} ### Calendar @@ -271,9 +355,7 @@ For more detailed instructions, see [Real-Time Watch Updates using Contact](lf-f - - - -## Advanced Settings - -🚧 Documentation Under Construction 🚧 +### Advanced Allows you to choose what information to download from Nightscout and to modify your graph @@ -292,25 +374,22 @@ Allows you to choose what information to download from Nightscout and to modify ## Logging LoopFollow logs activity to a file that can be viewed within the app, and can be shared via email, a Notes file or Facebook messenger if needed. The log can be filtered and searched. This will aid in troubleshooting and diagnostics. -Normally, the debug log option is disabled. The log debug option is found in the Advanced Settings section. If the logs seem verbose, check that setting. + +Normally, the debug log option is disabled. The log debug option is found in the Advanced section. If the logs seem verbose, check that setting. ### View Log -🚧 Documentation Under Construction 🚧 +When you select View Log, you see the entire log but can also filter for particular types of activities. ### Share Logs -🚧 Documentation Under Construction 🚧 - -- - - - -## *LoopFollow* Facebook Group +When you choose Share Logs, you can send the log to device or app of your choice. -Tapping on this row takes you to the *LoopFollow* Facebook Group where you can review posts and ask for assistance. +The log is named `LoopFollow YYYY-MM-DD`. - - - ## Build Information -This section reports the `Version` you are using, indicates the `Latest Version`. In addition, it reports when this app will expire, when it was build and provides details of the branch name and commit identifier. +This section reports the `Version` you are using, indicates the `Latest Version`. In addition, it reports when this app will expire, when it was built and provides details of the branch name and commit identifier.