diff --git a/docs/build/build-options.md b/docs/build/build-options.md index a95184d..bcdb325 100644 --- a/docs/build/build-options.md +++ b/docs/build/build-options.md @@ -4,7 +4,7 @@ * Browser Build: * If you have never built, see [*LoopFollow* Browser Build](lf-browser-build.md) - * If you are updating from v5.x or older, you need follow the one-time steps to [Update to *LoopFollow* v6.x](lf-browser-build.md#update-to-loopfollow-v6x){: target="_blank" } + * If you are updating from v5.x or older, you need follow the one-time steps to [Update to *LoopFollow* v6](lf-browser-build.md#update-to-loopfollow-v6){: target="_blank" } * Mac-Xcode: [Build *LoopFollow* Script for Mac-Xcode](#build-loopfollow-script-for-mac-xcode) ### Build *LoopFollow* Script for Mac-Xcode diff --git a/docs/build/lf-browser-build.md b/docs/build/lf-browser-build.md index 66db66c..a0a327f 100644 --- a/docs/build/lf-browser-build.md +++ b/docs/build/lf-browser-build.md @@ -54,7 +54,7 @@ You start by opening a browser using the URL from the table below. Most people o | LoopFollow_Second | [https://github.com/loopandlearn/LoopFollow_Second](https://github.com/loopandlearn/LoopFollow_Second) | | LoopFollow_Third | [https://github.com/loopandlearn/LoopFollow_Third](https://github.com/loopandlearn/LoopFollow_Third) | -??? tips "LoopFollow Display Name Customization (Click to Open/Close)" +??? tip "LoopFollow Display Name Customization (Click to Open/Close)" * Would you like the name of your LoopFollow app to be personalized? * Do you have more than one Looper, so you are using LoopFollow_Second or LoopFollow_Third? * The 3 LoopFollow repositories enable you to customize the name shown on your phone @@ -139,7 +139,7 @@ The `Add Identifier`  Action  should su New builders - just continue with the instructions as provided on this page. -### Update to *LoopFollow* v6.x +### Update to *LoopFollow* v6 !!! important "Updating LoopFollow to version 6.0 and newer" This information admonition is for existing builders who need to update. diff --git a/docs/faqs/glossary.md b/docs/faqs/glossary.md index 19c26db..6bf8559 100644 --- a/docs/faqs/glossary.md +++ b/docs/faqs/glossary.md @@ -75,9 +75,9 @@ When Google Translate is selected: **Loop and Learn**  (Loop and Learn): A support group with mentors and developers who support the OS-AID community -**Loop**  (Loop): With a capital L, Loop is one of several do-it-yourself artifical pancreas systems +**Loop**  (Loop): With a capital L, Loop is one of several do-it-yourself artificial pancreas systems -**LoopFollow**  (LoopFollow): LoopFollow combines custom alerts and display from many open-source apps such as Loop, Trio and Nigthscout +**LoopFollow**  (LoopFollow): LoopFollow combines custom alerts and display from many open-source apps such as Loop, Trio and Nightscout **Match-Secrets**  (Match-Secrets): a private repository you must create in your github account, stores keys required to build with github Build Actions diff --git a/docs/faqs/lf-faqs.md b/docs/faqs/lf-faqs.md index dba71db..1507fd8 100644 --- a/docs/faqs/lf-faqs.md +++ b/docs/faqs/lf-faqs.md @@ -4,7 +4,7 @@ You need to modify your iPhone settings to make the banners persistent. In iPhone Settings, select Notifications, then Apps and then *LoopFollow*. -For the banner style, select Persistent. Then each notification remains visibile until you swipe up. +For the banner style, select Persistent. Then each notification remains visible until you swipe up. This also means that the current banner might be out of date if you haven't looked at your phone for a while. diff --git a/docs/faqs/lf-history.md b/docs/faqs/lf-history.md index db82206..c890fbc 100644 --- a/docs/faqs/lf-history.md +++ b/docs/faqs/lf-history.md @@ -2,6 +2,25 @@ ## New Feature Highlights +!!! tip "" + New with *LoopFollow* v6.2: + + * [WebSocket](../setup/lf-setup.md#websocket){: target="_blank" }, enabled by default, allows near real-time updates from Nightscout + * [Show Yesterday's BG](../setup/lf-setup.md#graph){: target="_blank" } can be enabled using Settings: Graph + * [Information Display](../setup/lf-setup.md#information-display){: target="_blank" } supports large fonts; when needed, the label and value are split into two rows + * Remote Quick Pick buttons are now available for [Loop](../remote/remote-control-loop.md#quick-pick-boluses-and-meals){: target="_blank" } and [Trio](../remote/remote-control-trio.md#quick-pick-boluses-and-meals){: target="_blank" } + * Handle glucose duplicates to fix delta glucose always showing zero + * Fix glucose history being truncated when multiple apps upload to the same account + * Improve auto-restart for Live Activity + * Suppress an audible banner that could sound during silent Live Activity renewal + * Improve handling of profiles from Nightscout, including a new Run Diagnostics button in Remote Settings that detects common remote-command failures + * Debug logging is now on by default, and Share Logs prompts for a short problem description that is bundled with the logs + * Trio Updates: + * Trio Remote Control is the only option offered for Trio (Nightscout option is removed) + * Trio forecast cone display truncated to match Trio method + * Trio forecast lines match Trio colors + * Trio Override / Temp Target display colors match Trio colors + !!! tip "" New with *LoopFollow* v6.0 and v6.1: @@ -36,6 +55,14 @@ The feature history is summarized below in reverse chronological order. - - - +## 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. + +The APNS credentials only need to be in *Nightscout* if you also use *Nightscout* Careportal or the *LoopCaregiver* app to send remote commands. + +- - - + ## 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. @@ -83,7 +110,11 @@ With *LoopFollow* 3.1 and older, *Loop* remote commands were limited to Override | 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. +#### Very Old Configurations + +The information below is of historical interest only. + +With *Trio* 0.2.x, *LoopFollow* only supported Temp Targets via the *Nightscout* Careportal, which required 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: @@ -92,9 +123,3 @@ For those following a looper using *Trio* 0.2.x, the only remote setting option * 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. - diff --git a/docs/index.md b/docs/index.md index 482a6c8..47b681f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,9 +30,9 @@ The toolbar at the bottom of the Home and Menu screens has 4 user-configurable i #### New Features -The released version of *LoopFollow* is 6.1.0 and is built with the `main` branch. +The released version of *LoopFollow* is 6.2.0 and is built with the `main` branch. -See [New Feature Hightlights](faqs/lf-history.md#new-feature-highlights){: target="_blank" } +See [New Feature Highlights](faqs/lf-history.md#new-feature-highlights){: target="_blank" } - - - diff --git a/docs/remote/img/lf-lrc-selection.png b/docs/remote/img/lf-lrc-selection.png deleted file mode 100644 index e189a0e..0000000 Binary files a/docs/remote/img/lf-lrc-selection.png and /dev/null differ diff --git a/docs/remote/img/lf-nightscout.png b/docs/remote/img/lf-nightscout.png deleted file mode 100644 index 0b4be24..0000000 Binary files a/docs/remote/img/lf-nightscout.png and /dev/null differ diff --git a/docs/remote/img/lf-ns-remote-loop-details.png b/docs/remote/img/lf-ns-remote-loop-details.png deleted file mode 100644 index 2364c83..0000000 Binary files a/docs/remote/img/lf-ns-remote-loop-details.png and /dev/null differ diff --git a/docs/remote/img/lf-ns-remote-loop.png b/docs/remote/img/lf-ns-remote-loop.png deleted file mode 100644 index b517c7c..0000000 Binary files a/docs/remote/img/lf-ns-remote-loop.png and /dev/null differ diff --git a/docs/remote/img/lf-quick-pick-bolus.png b/docs/remote/img/lf-quick-pick-bolus.png new file mode 100644 index 0000000..348c2e4 Binary files /dev/null and b/docs/remote/img/lf-quick-pick-bolus.png differ diff --git a/docs/remote/img/lf-quick-pick-carbs.png b/docs/remote/img/lf-quick-pick-carbs.png new file mode 100644 index 0000000..a28cbd1 Binary files /dev/null and b/docs/remote/img/lf-quick-pick-carbs.png differ diff --git a/docs/remote/img/lf-quick-pick-meal.png b/docs/remote/img/lf-quick-pick-meal.png new file mode 100644 index 0000000..a0fa18a Binary files /dev/null and b/docs/remote/img/lf-quick-pick-meal.png differ diff --git a/docs/remote/img/lf-remote-options-loop.png b/docs/remote/img/lf-remote-options-loop.png new file mode 100644 index 0000000..aa3df5c Binary files /dev/null and b/docs/remote/img/lf-remote-options-loop.png differ diff --git a/docs/remote/img/lf-remote-options-trio.png b/docs/remote/img/lf-remote-options-trio.png new file mode 100644 index 0000000..2caf63a Binary files /dev/null and b/docs/remote/img/lf-remote-options-trio.png differ diff --git a/docs/remote/img/lf-remote-options_3.2.svg b/docs/remote/img/lf-remote-options_3.2.svg deleted file mode 100644 index 87ec0de..0000000 --- a/docs/remote/img/lf-remote-options_3.2.svg +++ /dev/null @@ -1,2235 +0,0 @@ - -image/svg+xmlLoop Follow with URL fromLoopTrio diff --git a/docs/remote/img/lf-trc-selection.jpg b/docs/remote/img/lf-trc-selection.jpg deleted file mode 100644 index f114b7a..0000000 Binary files a/docs/remote/img/lf-trc-selection.jpg and /dev/null differ diff --git a/docs/remote/remote-control-loop.md b/docs/remote/remote-control-loop.md index 12246ad..0d49e59 100644 --- a/docs/remote/remote-control-loop.md +++ b/docs/remote/remote-control-loop.md @@ -82,6 +82,48 @@ Example messages are highlighted by red rectangles in the composite below for re If the last update was more than 12 minutes ago, that line is not prefilled. +### Quick-Pick Boluses and Meals + +!!! info "Available in *LoopFollow* 6.2 and newer" + +To save a step when sending a remote command, *LoopFollow* shows **Quick-Pick** +buttons at the top of the Bolus and Carbs screens. Each button fills in the +amounts from one of your recent entries with a single tap. + +* **Quick-Pick Boluses** appear on the Bolus screen and fill in an insulin amount. +* **Quick-Pick Meals** appear on the Carbs screen and fill in **carbs only**. + +| Quick-Pick Boluses | Quick-Pick Meals | +|:--:|:--:| +| ![Quick-Pick Boluses on the remote Bolus screen](img/lf-quick-pick-bolus.png){width="300"} | ![Quick-Pick Meals on the remote Carbs screen](img/lf-quick-pick-carbs.png){width="300"} | + +Tapping a button only **fills in** the fields — nothing is sent until you review +the values and tap **Send Bolus** / **Send Carbs**, exactly as with a manual entry. +Guardrails still apply. + +#### How the suggestions are chosen + +Every bolus or carb entry you successfully send is stored **locally on your +phone**. When you open a remote screen, that history is scored to surface the +most relevant options for the current moment, considering: + +* **Time of day** — entries sent around this time of day score higher +* **Day of week** — weekday and weekend patterns are kept separate +* **Recency** — older entries gradually fade out + +Up to five buttons are shown, and the Quick-Pick section is hidden entirely +until you have history to draw from. So if you usually send the same breakfast +on weekday mornings, that entry tends to appear as an option on weekday mornings. + +!!! note + The history is private to the device and stored in *LoopFollow* only. + *Nightscout* cannot tell remote entries apart from manual ones, so it is not + used as a source — a freshly installed or reset phone starts with no + Quick-Pick suggestions until you send a few commands. + +Tap the :material-information-outline: info icon next to **Quick-Pick Boluses** +or **Quick-Pick Meals** in the app for a short in-screen explanation. + ### Overrides ***More info coming soon!*** @@ -181,7 +223,7 @@ You can see the danger of sending duplicate bolus/carbs so be careful. If a remo 2. The carbs, when accepted, will cause the app to respond to the carbs 3. In this case, the prediction includes both carbs and bolus - ❗️ Remember - you must wait pause at least 30 seconds between remote commands or the One-Time-Password (OTP) will be rejected as having already been used. + ❗️ Remember - you must wait at least 30 seconds between remote commands or the One-Time-Password (OTP) will be rejected as having already been used. ❗️ *Apple* can decide to limit the number of APNS commands it services. Make your remote requests count. @@ -194,7 +236,7 @@ You can see the danger of sending duplicate bolus/carbs so be careful. If a remo The Remote Settings row in the *LoopFollow* Settings screen is used to select the type of remote access you wish to use. -![LoopFollow remote settings type](img/lf-lrc-selection.png){width="300"} +![LoopFollow remote settings type](img/lf-remote-options-loop.png){width="300"} {align="center"} !!! question "The *Loop* Remote Control option is not available" diff --git a/docs/remote/remote-control-nightscout.md b/docs/remote/remote-control-nightscout.md deleted file mode 100644 index 9638434..0000000 --- a/docs/remote/remote-control-nightscout.md +++ /dev/null @@ -1,74 +0,0 @@ -## Remote Control with Nightscout - -!!! warning "Nightscout Remote Control will be removed" - With the update of Trio main to version 0.7.0, Remote Control with Nightscout is no longer needed and will be removed as an option from *LoopFollow*. - -You must configure *LoopFollow* and the *Nightscout* URL to use remote commands. -Please review the [Remote Control Overview](remote-control-overview.md) if terms on this page are not familiar. - -* *Nightscout* Remote Command in *LoopFollow* makes the standard Careportal options easily available from inside the *LoopFollow* app - * With this selection, the *LoopFollow* phone sends commands to *Nightscout* which then sends commands to the *Loop*/*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 *Loop*/*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 - -Please read the appropriate section on this page. - -* [*LoopFollow* & Careportal with the *Loop* App](#loopfollow-careportal-with-the-loop-app) -* [*LoopFollow* & Careportal with the *Trio* App](#loopfollow-careportal-with-the-trio-app) - -- - - - -## *LoopFollow* & Careportal with the *Loop* App - -!!! important "Not Available for *LoopFollow* 3.2" - This option is not available with *LoopFollow* 3.2 or newer versions. It was replaced with [`Loop Remote Control`](remote-control-loop.md){: target="_blank" }. - - This section will remain in the documents for while for people still running earlier versions of *LoopFollow*. - -For *Loop* careportal access, your *Nightscout* site must be configured with Apple Push Notification System (APNS) credentials as fully explained in LoopDocs. - -* [*LoopDocs*: Remote Overview](https://loopkit.github.io/loopdocs/nightscout/remote-overview/) - -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*. - -![remote screen for Loop with Nightscout option selected](img/lf-ns-remote-loop.png){width="300"} -{align="center"} - -At least one override (or saved preset) must be uploaded from the *Loop* phone to *Nightscout* before this option works. - -![details of override screen for Loop with Nightscout option selected](img/lf-ns-remote-loop-details.png){width="300"} -{align="center"} - -Only one override can be active at a time. If one is active, you can cancel it. Or if you want to change overrides, you can select a new one, which automatically cancels the old one. - -- - - - -## *LoopFollow* & Careportal with the *Trio* App - -!!! warning "Important" - The ability for the *Trio* app to be remotely controlled will be **disabled** when `Enable Remote Control` is turned OFF on the *Trio* phone. This is for the protection of the *Trio* user, so that they **always** are the primary controller of their insulin dosing app. - - For more details, see [*Trio* Remote Control](https://triodocs.org/configuration/settings/features/remote-control/#trio-remote-control). - -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. - -The use of remote control with *Nightscout*, for entry of Carb Correction and Temporary Targets when Careportal is authenticated, is available with *Trio* 0.2.x and newer and *LoopFollow* 2.4.0 and newer. However, the *LoopFollow* implementation only supports Temp Target start and cancel. - -| *Nightscout* URL or App | Options| -|:--|:--| -| ***Careportal*** | Carb Correction
Temporary Target
Temporary Target Cancel | - - -🚧 Graphics Under Construction 🚧 - -If you select *Nightscout* as the Remote Control Type for *LoopFollow*, this enables Temporary Targets to be set and disabled from *LoopFollow*. - -> This is the only remote option that works for *Trio* 0.2.x when using *LoopFollow*. - -![LoopFollow remote options - all types](img/lf-nightscout.png){width="300"} -{align="center"} - -- - - diff --git a/docs/remote/remote-control-overview.md b/docs/remote/remote-control-overview.md index f19add2..95fc1a0 100644 --- a/docs/remote/remote-control-overview.md +++ b/docs/remote/remote-control-overview.md @@ -10,14 +10,6 @@ > The return APNS message is only available for a meal or bolus entry. -!!! important "Breaking Change: Trio Remote Command Users" - Trio users must have matching code for LoopFollow and Trio. - - * 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) - - See [Trio Remote Control](remote-control-trio.md){: target="_blank" } for more information. - - - - ## *LoopFollow* Remote Options @@ -27,20 +19,21 @@ For a full summary of version requirements and feature history, see [Version Com 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. * When following someone running Loop, the options are None or [Loop Remote Control](remote-control-loop.md){: target="_blank" } -* When following someone running Trio, the options are None or: - * Trio 0.5.x and newer: [Trio Remote Control](remote-control-trio.md){: target="_blank" } - * Trio 0.2.x: [Nightscout Remote Control](remote-control-nightscout.md#loopfollow-careportal-with-the-trio-app){: target="_blank" } +* When following someone running Trio, the options are None or [Trio Remote Control](remote-control-trio.md){: target="_blank" } -![LoopFollow remote options - all types](img/lf-remote-options_3.2.svg){width="600"} -{align="center"} +!!! note "*Nightscout* Careportal Remote Commands Removed" + As of *LoopFollow* 6.2, *Nightscout* remote commands are no longer supported in *LoopFollow*. Remote control is now exclusively via direct APNS to the *Loop* or *Trio* app. -### Critical Configuration Information -If you plan to use *LoopFollow* Remote Control with a looper using the *Loop* app version 3.x or the *Trio* app version 0.5 or newer, and you don't have your APNS key information recorded or configured, see the instructions in [*Apple* Push Notifications System (APNS)](#apple-push-notifications-system-apns). +| **Following *Loop*** | **Following *Trio*** | +|:--:|:--:| +| ![Loop remote control options](img/lf-remote-options-loop.png){width="300"} | ![Loop remote control options](img/lf-remote-options-trio.png){width="300"} | + -If your looper is using *Trio* 0.2.x, use this link for configuration: -* [*Nightscout* Remote Control](remote-control-nightscout.md){: target="_blank" } +### Critical Configuration Information + +If you plan to use *LoopFollow* Remote Control with a looper using the *Loop* app version 3.x or the *Trio* app version 0.5 or newer, and you don't have your APNS key information recorded or configured, see the instructions in [*Apple* Push Notifications System (APNS)](#apple-push-notifications-system-apns). - - - @@ -103,8 +96,8 @@ For more information: see [Import/Export Settings](../setup/lf-setup.md#importex 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. -* For *Loop*, these keys must be added to Nightscout for you to use the Careportal feature -* For *Trio*, these keys do not need to be added to Nightscout to use the Careportal feature +* For *Loop*, these keys must be added to Nightscout for you to use the Careportal feature with Nightscout +* For *Trio*, these keys do not need to be added to Nightscout to use the Careportal feature with Nightscout If you do not have existing APNS Keys, skip ahead to [New APNS](#new-apns). @@ -189,6 +182,5 @@ The other remote credential are entered as described in the appropriate link. * [*Loop* Remote Control](remote-control-loop.md) * [*Trio* Remote Control](remote-control-trio.md) -* [*Nightscout* Remote Control](remote-control-nightscout.md) (`Trio 0.2.x only`) diff --git a/docs/remote/remote-control-trio.md b/docs/remote/remote-control-trio.md index 79bc119..08b31d1 100644 --- a/docs/remote/remote-control-trio.md +++ b/docs/remote/remote-control-trio.md @@ -1,11 +1,14 @@ ## Remote Control Overview -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. +*Trio* accepts remote commands from *LoopFollow* via direct APNS. The final control of whether remote commands will be enacted rests with the *Trio* user — they can enable or disable remote control. + +!!! note "*Nightscout* Careportal Remote Commands Removed" + As of *LoopFollow* 6.2, *Nightscout* remote commands are no longer supported in *LoopFollow*. Use *Trio* Remote Control (TRC) below. !!! 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 Nightscout for Trio (OpenAPS)](#configure-nightscout-for-trio-openaps). + To properly display the OpenAPS pill with *Trio*, 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. +- - - ### Real-time Notifications for *Trio* @@ -14,27 +17,7 @@ Starting with *LoopFollow* v4.0 and *Trio* v0.6, users of remote control are pro * 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 * This greatly improves the user experience compared to waiting for Nightscout being updated -!!! important "Breaking Change: *Trio* Remote Command Users" - *Trio* users must have matching code for LoopFollow and *Trio*. - - * LoopFollow v4.0 (or newer) works with *Trio* v0.6 (or newer) - * LoopFollow v3.2.3 (or older) works with *Trio* v0.5.1 (or older) - - **Question: What happens if versions are not correct?**: Remote control commands stop working. - - **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. - - -??? question "How does this differ from *Trio* 0.2.x? (Click to Open/Close)" - *Trio* can use *Nightscout* Careportal to enter `Carb Correction`, and start and cancel `Temporary Target`. - - * This was available in *Trio* 0.2.x and continues to be available in *Trio* 0.5.x (or newer). - * See [*Nightscout* Remote Control](remote-control-nightscout.md#loopfollow-careportal-with-the-trio-app){: target="_blank" } - - *Trio* 0.2.x supported other remote options (using announcements via Careportal). - - * Those options were replaced by the more secure *Trio* Remote Control for *Trio* 0.5.x (or newer) - * **Using announcements to provide remote control of the *Trio* phone is no longer supported** +- - - ### Quick Access @@ -98,6 +81,53 @@ When entering meals and choosing to schedule the meal, any bolus included in the ***More info coming soon!*** +### Quick-Pick Boluses and Meals + +!!! info "Available in *LoopFollow* 6.2 and newer" + +To save a step when sending a remote command, *LoopFollow* shows **Quick-Pick** +buttons at the top of the Bolus and Meal screens. Each button fills in the +amounts from one of your recent entries with a single tap. + +* **Quick-Pick Boluses** appear on the Bolus screen and fill in an insulin amount. +* **Quick-Pick Meals** appear on the Meal screen and fill in carbs, and — when + enabled in [Meal Settings](#meal-settings) — fat, protein, and the meal bolus. + +| Quick-Pick Boluses | Quick-Pick Meals | +|:--:|:--:| +| ![Quick-Pick Boluses on the remote Bolus screen](img/lf-quick-pick-bolus.png){width="300"} | ![Quick-Pick Meals on the remote Meal screen](img/lf-quick-pick-meal.png){width="300"} | +{align="center"} + +Tapping a button only **fills in** the fields — nothing is sent until you review +the values and tap **Send Bolus** / **Send Meal**, exactly as with a manual entry. +Guardrails still apply. + +#### How the suggestions are chosen + +Every bolus or meal you successfully send is stored **locally on your phone**. +When you open a remote screen, that history is scored to surface the most +relevant options for the current moment, considering: + +* **Time of day** — entries sent around this time of day score higher +* **Day of week** — weekday and weekend patterns are kept separate +* **Recency** — older entries gradually fade out + +Up to five buttons are shown, and the Quick-Pick section is hidden entirely +until you have history to draw from. So if you usually send the same breakfast +on weekday mornings, that entry tends to appear as an option on weekday mornings. + +A bolus that was part of a meal is stored with that meal, so it does **not** +appear among your standalone Quick-Pick Boluses. + +!!! note + The history is private to the device and stored in *LoopFollow* only. + *Nightscout* cannot tell remote entries apart from manual ones, so it is not + used as a source — a freshly installed or reset phone starts with no + Quick-Pick suggestions until you send a few commands. + +Tap the :material-information-outline: info icon next to **Quick-Pick Boluses** +or **Quick-Pick Meals** in the app for a short in-screen explanation. + ### Temp Target ***More info coming soon!*** @@ -110,8 +140,6 @@ When entering meals and choosing to schedule the meal, any bolus included in the ## Configure *Trio* Phone for Remote Control -> The graphics displayed on this page are associated with *Trio* version 0.5.x or newer. The same setting is available in older version of *Trio* but in a different location in the menu structure. - **Default:** _OFF_ Remote control must be enabled on the *Trio* phone or no remote information is accepted by the *Trio* phone. @@ -154,26 +182,20 @@ The `SHARED SECRET` should be copied from the *Trio* phone and added to the [`Sh The Remote Settings row in the *LoopFollow* Settings screen is used to select the type of remote access you wish to use. -![LoopFollow remote settings type](img/lf-trc-selection.jpg){width="300"} +![LoopFollow remote settings type](img/lf-remote-options-trio.png){width="300"} {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* 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 - * Available with *Trio* 0.2.x and newer * *Trio* Remote Control option * Remote control with *LoopFollow* includes adding remote carbs, enacting remote bolus, and starting and canceling Temp Targets and Overrides - * Requires *Trio* 0.5.x (or newer) and *LoopFollow* 2.4.x (or newer) * Continue with [Configure *LoopFollow* *Trio* Remote Control](#configure-loopfollow-trio-remote-control) to finish the configuration process - - - ## Configure *LoopFollow* *Trio* Remote Control -> This is supported for *Trio* 0.5.x (or newer) when using *LoopFollow* 2.4.0 (or newer). - ### Meal Settings The user can decide to enable or disable two features independently. @@ -270,7 +292,7 @@ This section covers known troubleshooting issues: ### 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. +The *Nightscout* version must be 15.0.2 (or newer) to properly display the OpenAPS pill. Check your revision: *Nightscout* URL, Menu, scroll to bottom and examine the About section. If you transitioned from the *Loop* app, you must make some modifications to *Nightscout* before you will be successful viewing your *Trio* data in your *Nightscout* site. @@ -296,9 +318,6 @@ In addition to this step, you may need to force the profile (from Trio) to uploa ### Update Profile -!!! warning "Must on *Trio* 0.5.x (or newer)" - If you are on *Trio* 0.2.x, you might see the option for *Trio* Remote Control in *LoopFollow* Remote Settings, but you can't use it. See [Use *LoopFollow* *Nightscout* Remote Control](remote-control-nightscout.md#loopfollow-careportal-with-the-trio-app). - If you were previously running the *Loop* app or the *iAPS* app, [Stop *Nightscout* upload](#stop-nightscout-uploads-from-other-apps) from those apps and then force the profile to update. To force a profile to update to *Nightscout*, go to the *Trio* app and toggle Allow Uploading to Nightscout off (disable) and then enable it again. diff --git a/docs/setup/lf-features.md b/docs/setup/lf-features.md index e04cf3a..b2723ae 100644 --- a/docs/setup/lf-features.md +++ b/docs/setup/lf-features.md @@ -13,7 +13,7 @@ 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. +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 an 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"} @@ -23,6 +23,53 @@ The graphic below shows the many types of alarms that are available with *LoopFo ![alarms to select](img/lf-alarms.svg){width="700"} {align="center"} +### Alarm Types Reference + +The table below lists every alarm type available in *LoopFollow*, organized by group. + +#### Glucose + +| Alarm | Description | +|:--|:--| +| Low BG Alert | Alerts when BG goes below a limit | +| High BG Alert | Alerts when BG rises above a limit | +| Fast Drop Alert | Rapid downward BG trend | +| Fast Rise Alert | Rapid upward BG trend | +| Missed Reading Alert | No CGM data for a configurable number of minutes | +| Temporary Alert | One-time BG limit alert (above and/or below) | + +#### Insulin / Food + +| Alarm | Description | +|:--|:--| +| IOB Alert | High insulin-on-board | +| COB Alert | High carbs-on-board | +| Missed Bolus Alert | Carbs entered without a matching bolus | +| Future Carbs Alert | Reminder when future carbs are due | +| Rec. Bolus | Recommended bolus issued | + +#### Device / System + +| Alarm | Description | +|:--|:--| +| Low Battery | Phone battery low | +| Battery Drop | Phone battery drops quickly within a monitoring window | +| Pump Insulin Alert | Reservoir level low | +| Pump Battery Alert | Pump battery low | +| Pump Change Alert | Pump change due | +| Sensor Change Alert | Sensor change due | +| Not Looping Alert | Loop hasn't completed within a configurable number of minutes | +| Looping app expiration | Looping-app build is expiring soon | + +#### Override / Target + +| Alarm | Description | +|:--|:--| +| Override Started | An override just started | +| Override Ended | An override ended | +| Temp Target Started | A temp target started | +| Temp Target Ended | A temp target ended | + - - - @@ -38,13 +85,14 @@ Do not skip the overview page if you have not yet configured *LoopFollow* for Re * [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). +There are separate pages for the 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 +* [*Loop* Remote Control](../remote/remote-control-loop.md){: target="_blank" } +* [*Trio* Remote Control](../remote/remote-control-trio.md){: target="_blank" } + +> As of *LoopFollow* 6.2, *Nightscout* remote commands are no longer supported in *LoopFollow*. - - - diff --git a/docs/setup/lf-setup.md b/docs/setup/lf-setup.md index e9be940..a1ece31 100644 --- a/docs/setup/lf-setup.md +++ b/docs/setup/lf-setup.md @@ -34,7 +34,7 @@ The home screen provides a dashboard of important information. * 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) + * *Trio*: *Trio* specific features like Autosens, TDD, remote control Once you’ve configured your settings, your Home screen will look as beautiful as the example below! @@ -99,7 +99,7 @@ The graphic below shows the display when you tap on the *Nightscout* row. For mo 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](#importexport). + 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"} @@ -110,8 +110,7 @@ When adding the Nightscout information to monitor, you can copy your *Nightscout For more information about tokens with *Nightscout*, refer to [Admin Tools in *Nightscout*](https://nightscout.github.io/nightscout/admin_tools/#subjects-and-roles). -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*. +If your Nightscout site is protected, which is recommended, you need to create a **readable** token to use with *LoopFollow*. When you enter your credentials, *LoopFollow* tries to reach the site and then provides the status. For a full summary of version requirements for *Loop* and *Trio* remote control, see [Version Compatibility](../faqs/lf-history.md#version-compatibility){: target="_blank" }. @@ -121,7 +120,12 @@ For a full summary of version requirements for *Loop* and *Trio* remote control, | **None** | Read | OK (Read) | | ***Loop* Remote Control**| Read | OK (Read) | | ***Trio* Remote Control**| Read | OK (Read) | -| ***Nightscout***
Trio 0.2 or older | Read & Careportal | OK (Read & Write) | + +##### WebSocket + +Below the URL and Token rows, the *Nightscout* setup screen has an **Enable WebSocket** toggle. When enabled, *LoopFollow* opens a live connection to your *Nightscout* server while the app is in the foreground, so new readings, treatments, and device status arrive within seconds of being posted to *Nightscout* — close to real-time. The status row underneath the toggle shows whether the connection is *Connecting…*, *Connected*, *Disconnected*, or in *Error*. + +When *LoopFollow* moves to the background, the WebSocket disconnects and the app falls back to its normal scheduled polling so the persistent connection doesn't drain the battery. The connection is re-established automatically when you return to the app. If the connection drops while you are still in the foreground, normal polling resumes immediately as a safety net. #### Setup *Dexcom* @@ -130,7 +134,7 @@ 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](#importexport). + 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). - - - @@ -219,6 +223,7 @@ These settings are accessed through the Graph row in the Settings screen. | Show Midnight Lines | Enable or Disable | | Show Calibration | Enable or Disable | | Show Carb Absorption | Enable or Disable | +| Show Yesterday's BG | When enabled, yesterday's glucose is overlaid on the main graph as a dimmed gray line, time-shifted 24 hours so it aligns with the same clock time today, for visual comparison
*Nightscout* only (Dexcom Share does not return enough history); default off | | Treatments on Small Graph | Enable or Disable | | Height | Select height of small Graph | | Hours of Prediction | Select prediction extent on main plot | @@ -326,7 +331,7 @@ CV is reported as a percentage and is independent of the glucose unit. ### Tabs -The user can modify which icons are displayed in the task bar at the bottom of the screen. +The user can modify which icons are displayed in the tab bar at the bottom of the screen. In the Settings screen, select Tabs. Drag any of the options up or down to your preferred configuration. @@ -408,11 +413,11 @@ Details about creating APN credentials are found in the [Remote Control Overview The Live Activity feature for *LoopFollow* has the following requirements or it will not update reliably and should not be used. -* Background Refresh must be enabled +* **APN Credentials** must be entered +* **Background Refresh** must be enabled * Typically caregivers use Silent Tunes to keep the app alive in the background * If background refresh is not working, the app notifies the user and they should assume Live Activity is also not refreshing -* APN Credentials must be entered -* Live Activity must be enabled +* **Live Activity** must be enabled #### Live Activity Options @@ -421,9 +426,37 @@ The Live Activity screen allows the following selections: * Enable Live Activity (slider) * Restart Live Activity (manual button if needed) * Grid Slots for Live Activity - * There are 4 slots available - * There are over 20 options to choose from for the 4 slots + * There are 4 slots available, plus 1 additional slot for the small widget (CarPlay / Watch Smart Stack) * The options are the same as are found in the [Information Display](#information-display) + * Each option can only appear in one slot at a time + * The default slots are: IOB (top left), COB (bottom left), Projected BG (top right), Empty (bottom right) + +The following options are available for each grid slot: + +| Option | Description | +|:--|:--| +| Empty | Leave the slot blank | +| Delta | Change in glucose since previous reading | +| Projected BG | Projected glucose value | +| Min/Max | Minimum and maximum values from the current OS-AID forecast | +| IOB | Insulin on Board | +| COB | Carbs on Board | +| Rec. Bolus | Recommended bolus from last loop | +| Autosens | Autosens value (*Trio* only) | +| TDD | Total Daily Dose in the last 24 hours (*Trio* only) | +| Basal | Current basal rate | +| Pump | Reservoir level | +| Pump Battery | Pump battery level | +| Battery | Phone battery level | +| Target | Correction range used by OS-AID | +| ISF | Insulin Sensitivity Factor | +| CR | Carbohydrate Ratio | +| SAGE | Sensor Age | +| CAGE | Cannula Age | +| IAGE | Insulin Age | +| Carbs today | Total grams of carbs since midnight | +| Override | Active override information | +| Profile | Named profile | ### Remote @@ -477,7 +510,7 @@ Allows you to choose what information to download from Nightscout and to modify 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 section. If the logs seem verbose, check that setting. +The debug log option is enabled by default so that detailed information is available if you need to ask for help. The setting is found in the Advanced section and can be turned off if the logs seem too verbose. ### View Log @@ -485,9 +518,11 @@ When you select View Log, you see the entire log but can also filter for particu ### Share Logs -When you choose Share Logs, you can send the log to device or app of your choice. +When you choose Share Logs, *LoopFollow* first asks you to describe the problem — what time it happened, what you did, and what you expected to happen that didn't. A short description makes it much easier for someone to help. + +After you tap **Share**, the description is saved to a small notice file (with the current date, app version, and build identifier) and the iOS share sheet opens with that file together with today's and yesterday's log files. You can then send everything to the device or app of your choice. Leaving the description empty is allowed; the notice file simply records that no description was provided. -The log is named `LoopFollow YYYY-MM-DD`. +The log files are named `LoopFollow YYYY-MM-DD`. - - - diff --git a/includes/glossary.txt b/includes/glossary.txt index f5700f8..9a88ee2 100644 --- a/includes/glossary.txt +++ b/includes/glossary.txt @@ -31,8 +31,8 @@ *[JSON]: JavaScript Object Notation; a standard data interchange format that is text-based and human readable *[macOS]: operating system for Mac computer *[Loop and Learn]: A support group with mentors and developers who support the OS-AID community -*[Loop]: With a capital L, Loop is one of several do-it-yourself artifical pancreas systems -*[LoopFollow]: LoopFollow combines custom alerts and display from many open-source apps such as Loop, Trio and Nigthscout +*[Loop]: With a capital L, Loop is one of several do-it-yourself artificial pancreas systems +*[LoopFollow]: LoopFollow combines custom alerts and display from many open-source apps such as Loop, Trio and Nightscout *[Match-Secrets]: a private repository you must create in your github account, stores keys required to build with github Build Actions *[MTB]: Manual Temporary Basal: user initiated temporary basal, Omnipod Common feature *[MDT]: common abbreviation for Medtronic pumps diff --git a/mkdocs.yml b/mkdocs.yml index b95d215..8ffb643 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -192,7 +192,6 @@ nav: - 'Remote Control Overview': 'remote/remote-control-overview.md' - 'Loop Remote Control': 'remote/remote-control-loop.md' - 'Trio Remote Control': 'remote/remote-control-trio.md' - - 'Nightscout Remote Control': 'remote/remote-control-nightscout.md' - Build: - 'LoopFollow Build': 'build/build-options.md' - 'LoopFollow Browser Build': 'build/lf-browser-build.md'