loopkit / loopdocs

Loop Docs - https://loopdocs.org/

LoopKit

LoopKit is a set of tools to speed up development of your own closed-loop insulin delivery app. It is agnostic to treatment decisions and input sources.

Loop

Loop is a full-featured app built on top of LoopKit.

LoopKit provides

• Data storage and retrieval, using HealthKit and Core Data as appropriate
• Protocol types for representing data models in a flexible way
• Common calculation algorithms like Insulin On Board
• Boilerplate user interfaces like editing basal rate schedules and carb entry

LoopKit does not provide

• Treatment decisions: Your Diabetes May Vary.
• Device communications: Device-specific libraries are maintained separately.

License

LoopKit is available under the MIT license. See the LICENSE file for more info.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

loopdocs's Issues

"Remote override Step 7: Common Errors" suggests installing Dev branch of Loop

https://loopkit.github.io/loopdocs/nightscout/remote-overrides/#step-7-common-errors

Temp Override Shortcuts Not Working

Issue

After downloading the set remote override iOS shortcut from here, I found that setting the remote override from the main "Comprehensive Loop Shortcut" and "Set Remote Override only shortcut" did not work after correctly setting my website URL and api secret.

Solution

I fixed this by adding the api-secret header to the Network call for "Get contents of ProfileURL". The Cancel Override shortcut was working already because it had this set.

Notes

I'm not sure if you're the original author of the shortcut and can edit/update the link, but if you could update the shortcut as described it'd be greatly appreciated. I can't fix this and share my link because iCloud Drive is disabled on my iPhone and won't allow me to share shortcuts (major bummer).

Here's a screenshot of the issue and fix as well. Let me know if you have any questions.

Loopdocs search is too restrictive

It would be good if the Loopdocs search gave results for partial hits, not only complete words.

Example: someone who have heard about Zulip will not get results by searching only for "Zulip", they would have to know that it is called Zulipchat in Loopdocs.

https://loopkit.github.io/loopdocs/#stay-in-the-loop

Can't get code for Test Flight

Trying to up load my rebuild and haven't got a code to redeem for Test Flight

Suggestion: remove blocks with pre-populated choices for build script options

The multi line code blocks provided in step 14 (e.g. to launch the build script and choose loop master and open Xcode) seem to be the source of a lot of confusion for a lot of users who are unfamiliar with the command line. They attempt to paste the whole block and expect to be able to choose other options such as cleaning provisioning profiles. Many questions have been posted to the Looped Facebook group due to this misunderstanding.

I suggest to remove these "convenience" multi line commands from the docs and provide only the shell script line. Users should follow the instructions to choose the desired options interactively.

Update safely to iOS 15

The issue with Loop crashing when updating to iOS 15 if last built with Xcode 12.4 is described in Loopdocs. But the description might be read as “ do not install iOS 15” [period].

The text should be changed a bit with a description of what to do to safely update to iOS 15

e.g “Make sure to update MacOS first, then Xcode, then build to the phone as is. Once you made a successful build using Xcode 13, you can update the phone too. Otherwise,Loop is likely to crash and will need a rebuild and a lengthy update process of MacOS and Xcode if this was not done yet.”

Or something to that effect.

https://loopkit.github.io/loopdocs/build/updating/#when-to-update-loop

iOS 15 Warning
Any Loop app built with Xcode version prior to Xcode 12.5 will immediately fail when the phone is updated to iOS 15. If you last built Loop with Catalina do not install iOS 15.

Follow this link, Xcode version, for instructions to determine what version was used when building the Loop app currently on your phone.

https://loopkit.github.io/loopdocs/faqs/update-faqs/#how-can-i-confirm-xcode-version-i-used

DO NOT INSTALL iOS 15 if the Xcode version on your Loop build is 12D or earlier - the Loop app will immediately stop working and you will have to rebuild Loop.

Bolus may not have succeeded

I’m using a Medtronic 715 pump with loop v2.0 on a iPhone running 13.3 - almost every time bar about 3 in the past 7 days that I have tried to bolus through the loop app I get a notification that my bolus may not have succeeded, however the bolus goes through the pump and once finished registers as IOB.

The message reads
Bolus
3.2 U bolus may not have succeeded
Invalid response during PumpMessage(Carelink, bolus, 029854, 012000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000):a9657265a9745665dd3d07a9756265a974c6556c6a6500. Check you pump before retrying.

Loop report attached

Clarify Nightscout Process in Intro

Sorry, I'm nowhere near being able to fork and use python yet.
Suggested change for 2nd sentence in https://loopkit.github.io/loopdocs/nightscout/overview/
Right now it just says that Nightscout is an app, making it sound like you just get it from the store and you're ready to go:

To set it up, you get an account on a free server and follow instructions to build the application there. Then you can access it with a web browser or the Nightscout app from the iPhone App Store. Once set up, the site can be accessed by anyone that you share your unique Nightscout URL with.

Link at bottom step 15 build loop app does not work

https://loopkit.github.io/loopdocs/build/step14/

Remember your promise though? You still owe me that you will use the Set up App section of this website now to keep proceeding safely.

Enters a 404 website

Post 2 and Post 3 links for RileyLink carrying ideas are not loading

When I click the links for Post 2 or Post 3, I get the error below.

Set this repo's URL

Should probably be https://loopkit.github.io/loopdocs/

Example:

Insulin Activity units unclear

Hi, at the page about Glucose Prediction it is unclear to me how I should interpret the units for Insulin Activity.

In the formula for
deltaBG_I[t] = ISF[t] x IA[t]
it says that Insulin Activity is in U/5min
https://loopkit.github.io/loopdocs/operation/algorithm/prediction/#total-insulin-effect-combining-boluses-and-temporary-basal-rates

In the formula for
ICE[t] = OA[t] + IA[t]
it says that Insulin Activity is in mg/dl/5min
https://loopkit.github.io/loopdocs/operation/algorithm/prediction/#dynamic-carbohydrate-absorption

Am I missing something (and can you please explain what) or is there an inconsistency in the docs?

Potential typos and clarification request for Blood Glucose Prediction

Hi, I've been reviewing the Blood Glucose Prediction page to reimplement this algorithm in python, and have some questions about some of the calculations.

1. In the Dynamic Carbohydrate Absorption section, it says that ICE[t] = OA[t] + IA[t]. Since insulin activity is negative, shouldn't this be ICE = OA - IA instead? Or put differently, ICE + IA = OA?

2. In the Retrospective Correction Effect, blood glucose velocity (BG_vel) is used to calculate the retrospective correction effect. I have two questions regarding this calculation.

   • How exactly is retrospective forecast (RF) calculated? My initial understanding was that this would simply be the first 30 minutes of the prediction Loop made 30 minutes ago. However, this definition breaks down in situations such as this.

     • At t-30 minutes: Loop makes a prediction. We use the first 30 minutes of this prediction as RF.

     • At t-20 minutes: User gives themselves an insulin bolus.

     • At t minutes: BG_vel is calculated using the difference between RF and the last 30 minutes of BG. However, while retrospective correction is supposed to capture the effects that are not modeled by insulin and carbs, this difference will also include the effects of insulin given at t-20 minutes.

     • I think there is some ambiguity regarding how RF is calculated. A more detailed description would be extremely helpful.

   • In addition, BG_vel captures how 'off' Loop's prediction is to the true BG values. If BG_vel is positive, Loop's estimations are too high. If BG_vel is negative, Loop's estimations are too low. To account for this, if BG_vel is positive we should be subtracting from Loop's estimation, and if BG_vel is negative we should be adding to Loop's estimation. However, when blending all the effects, we add the retrospective correction effects. Shouldn't we be subtracting this instead, or define BG_vel as the mean of (BG - RF)?

Error messages caused by low phone storage

Someone reported this:

The G6 app is saying it is no longer functioning properly (without explaining why), and it is suggesting deleting and reinstalling the app.

In Loop, there is a message about Sqlite error / Database or disk is full.

I could not find this in Loopdocs, and I haven't seen it before. But others had, and said deleting stuff to free up space, and sometimes also reinstalling usually helps.

Disable TouchID for Bolus

Disable TouchID for Bolus instructions are out of date. Assume the code was modified since this was added to the example customizations.

https://loopkit.github.io/loopdocs/setup/build/code_customization/

Suggestion for Quiz 2: Nightscout

The wording on the question about the Loop pill's ⚠ symbol is a bit subtle. I interpreted it as meaning that the symbol indicates a red Loop (so I selected false, since it just indicates Nightscout isn't getting Loop data). I think it might be clearer to make this a multiple choice question such as:

What does a ⚠ symbol indicate in the Loop pill?

• Loop is red
• Nightscout has not received Loop data for more than 5 minutes. Loop status is otherwise unknown.
• Nightscout has not received Loop data for more than 5 minutes, and Loop is red

Possible need to update or clarify documentation

In the Setup->Install Loop->Code Customizations section the Loop Graph Hours says to modify line 157. I think it should be ~192 if memory serves.

Also the customization of "Want 1/2 of my Insulin Action Duration to show in the future?"
X-Code wouldn't accept the custom code as provided and I was not able to use the customization...

💄 Mermaid diagrams do not follow Loopdocs color scheme

The Mermaid (sequence) diagrams do not follow the LoopDocs' color scheme.
They use accent color #526cfe instead of the primary color #18A0A0 for actors, participants, steps, box borders...
This is mkdocs-material's expected behavior but is not in line with our color scheme.

@marionbarker I suggest configuring the diagrams to use the primary color for these graphical components.

Place Glucose Monitor Source into a sub menu

About once every 2 months while changing a setting (basal rate, carb ratio, etc...) I inevitably turn off my G5 transmitter button by scrolling up/down on the screen (ie, my thumb inadvertently taps the button and turns it off or turns on a different glucose source). This wipes my G5 transmitter ID, so I have to retype it.

I wanted to make a request to put all of the the Continuous Glucose Monitor sources in a sub menu to avoid this problem.

mLab cleanup link broken

This link no longer works: https://loopkit.github.io/loopdocs/nightscout/mlab_cleanup/

It is linked on this page in the first line of the paragraph:
https://loopkit.github.io/loopdocs/troubleshooting/yellow-red-loop/#resolving-frequent-red-loops

I'm not sure if a DB repair is needed anymore. I would encourage the CGMitC group to update the NS docs with the details.

Question: is there a way to save Loop data to Firebase (or something similar) so I can match it to Tidepool data?

Is there a way to push DIY Loop data to Firebase or store it in some other way where I can then access it? I want to be able to download it and analyze it in parallel with the data I get from my Tidepool API.

Expand on the workings of overrides, recommended practices, what to avoid and why.

This section is good, but often overlooked and misunderstood. Some clarification and restructuring of this part might help.

https://loopkit.github.io/loopdocs/operation/features/workout/?h=sledgehammer#how-overrides-do-not-work

A useful discussion on FB for reference:

https://www.facebook.com/groups/TheLoopedGroup/permalink/2980475585502421/

My input to the discussion above:

... [for] anyone else wondering why, and for how long the prediction might be messed up with extreme overrides:

The prediction curve is based on the ISF and CR settings in Loop at the time of a carb entry or bolus. You can turn off an override from here on out, but you won't be cancelling the override setting for the time that has already passed.

Hence, the override-modified ISF and CR at the time of your bolus or carb entry will last as long as the entry does. As we all know, insulin is modelled to last for 6 hours. And a meal last until it is observed by Loop as fully absorbed, or until it times out at 1.5 x the entered absorption time. So if you do get the prediction messed up, it can last for hours.

A typical scenario is the "sledgehammer" method described in Loopdocs: An exteme low 10 % override is activated to stop insulin delivery due to fear of a low, or even after the low happened. Then, as the situation is over, the override might be forgotten, and is still active. A bolus given at this point will be considered by Loop as having 10 x the BG lowering effect! This is a typical cause of extremely low eventual BG predictions such as -500 mg/dL (-30 mmol/L).

The better approach to stop insulin delivery is to use a very high target instead. As long as it is higher than the predicted eventual BG, Loop will reduce or stop basal delivery. Pick a really high target, and Loop will surely zero-temp.

I hope that makes things a little clearer, as the warning against wreaking havoc with the prediction might be a little abstract.

Here is the relevant section in Loopdocs, by the way. It is already described pretty well, but since this is often misunderstood or overlooked, perhaps it could be made even clearer. I have been thinking about suggesting a change, but don't know when I'll get around to that.

https://loopkit.github.io/loopdocs/operation/features/workout/?h=sledgehammer#how-overrides-do-not-work

NaN

I can't loop. Getting a green circle, and the app can tell my pump to bolus, but it won't predict glucose and will not give me a basal rate (adjustment). I changed the pump battery and that worked for an hour, then everything reverted to not working. The only other abnormality is I briefly get an exclamation point near the CGM readout. I have turned everything on and off multiple times.

I am near the end of the sensor (8.5) days. Is that possibly responsible? Should I just change it? Any other fixes? I miss my looping!

Dead link / 404

Dead link / 404

https://loopkit.github.io/loopdocs/operation/algorithm/overview/temp_basal

This link is found here:
https://loopkit.github.io/loopdocs/operation/algorithm/overview/#overview

Add Loop Follow to Loop Notifications

I just ran into LoopFollow and it seems to be one of the few apps with completely adjustable, and silencable blood sugar alarms that are more customizable than Sugarmate.

It's a shame I couldn't have seen this immediately from the docs. Could we mention LoopFollow (repo link ) under the "Remote Notifications" section of the Loop Notifications page?

Install Xcode from .xip download

I tested an alternative approach when updating to Xcode 13:

When logged into the Apple Developer website, you can download Xcode as an .xip file. This is a compressed file that you extract by double-clicking it similarly to a .zip file.

After extracting the file in Finder, drag and drop it into the Applications folder, and the installation will begin. You will be asked to replace or keep the old one. You should replace it so you don't end up with several versions of Xcode.

After installing, you can delete the .xip file.

This process takes a little time for each step:

1. Download Xcode .xip
2. Extract .xip
3. Install Xcode into Applications

But the total amount of time is insignificant compared to the App Store update/install.

You still need a lot of space for the download/extract/install steps.

Direct link for Xcode 13:
https://download.developer.apple.com/Developer_Tools/Xcode_13/Xcode_13.xip

The link was found here:
https://developer.apple.com/download/all/

One of many guides for Xcode .xip install:
https://www.freecodecamp.org/news/how-to-download-and-install-xcode/

Perhaps this is something to include in Loopdocs? I have seen people get failing App Store update after 24 hours. That is a lot of wasted time!

Feature- temporary settings option

Add an option for temporary plan (for limited time as decided by user) with new settings- ISF,basal, correction range , etc..

Explain TestFlight process in more detail

For various reasons it can be useful to distribute Loop via TestFlight (testing multiple versions, installing quickly on new phones without access to a Mac, etc.), though it carries drawbacks (90-day expiry, hypothetical risks that the App Store process takes a dislike to the whole thing, etc).

Nonetheless this process has been documented well by the xdripswift project: https://xdrip4ios.readthedocs.io/en/latest/install/personal_testflight/ and though the focus of this document is different (providing builds for a larger user group) the steps involved are exactly the same and can be followed to achieve the same result (I verified them today).

I'd suggest it might be useful to outline why TestFlight might be useful to Loop developers if not all loopers, some of the drawbacks, and to shamelessly gratefully replicate the bulk of those instructions here.

Recent Loop chats have highlighted that there are unique philosophical issues around the DIY nature of Loop and building for others, so this page could be a useful place to elaborate - but that's perhaps a more nebulous secondary goal.

Single command for cloning and launch of Xcode for LoopWorkspace build, without using the script

As a continuation of a discussion on FB today regarding request for translation of the build script.

@cyoung1024 requested translation of the build script, based on experience with french-speaking users, and @jonfawcett suggested using a few commands chained like this:

cd ~/Downloads
git clone --branch=master --recurse-submodules https://github.com/LoopKit/LoopWorkspace
cd ./LoopWorkspace
xed ./Loop.xcworkspace

The above works, but upon a second attempt, it will yield the error
fatal: destination path 'LoopWorkspace' already exists and is not an empty directory.

Below is a possible solution, heavily inspired by the build script
(naming the folder by date-hour-minute-second might be excessive, but was useful during testing...)

cd ~/Downloads
mkdir ~/Downloads/Loop-$(date +'%y%m%d-%H%M%S')
cd ~/Downloads/Loop-$(date +'%y%m%d-%H%M%S')
git clone --branch=master --recurse-submodules https://github.com/LoopKit/LoopWorkspace
cd ./LoopWorkspace
xed .

If attaching a "Copy-button" to the above, there is really no need for the script during building of Loop. And the need for translation will also be gone. And the utility script commands are already described in Loopdocs for execution by command line.

The script is just fine, of course, but apparently translation is an issue there.

iOS 1.31.1 Health App UI changed

https://kdisimone.github.io/looptips/data/health/

Browse to:

"You can always check your HealthKit settings for by opening the Health App, clicking on Sources at the bottom bar, and then clicking on the app's name you are interested in, for example Loop."

Follow those instructions. They don't work with iOS 1.13.1. To wit:

1. Click on the heart-in-a-white-square app icon on a running iPhone.
2. Observe: "Summary", [profile picture] at the top. At the "bottom bar", observe two icons, "[heart], sub-title "Summary",, [four square boxes, like the Windows icon] "Browse".

Scrolling through the whole page, looking for the word "Sources" shows nothing. It does show "Apps" but that leads to a nasty marketing black hole.

Dead Link on Yellow/Red Loop Page

On the Operate -> Troubleshoot -> Yellow/Red Loop page, under "Bluetooth/RL issues", the "Status Screen for Bluetooth" link (in the fifth bullet point) directs to a 404 error page.

Page on LoopDocs with bad link: https://loopkit.github.io/loopdocs/troubleshooting/yellow-red-loop/#bluetoothrl-issues
Link on the page that isn't working: https://loopkit.github.io/loopdocs/setup/loop-settings/rileylink_menu/#device

Operation couldn’t be completed- Share client share error

No need for homebrew / carthage

While waiting for PR 209 to be resolved and merged, I'm continuing work on updating content in the marionbarker fork. That fork is consistent with the updates of PR 209. Once that gets merged, then I'll start formal PR for these changes.

In the meantime, if reviewers would examine these pages and provide feedback here or by sending me a PM via zulipchat or facebook, I'd appreciate it.

https://marionbarker.github.io/loopdocs

List of pages with updated content (as of March 10, 2021):

• Menu structure modified: Step 7 is now titled Skip Step 7
• Build App: Step 2 - updated to add iPhone 12 and suggest turn off automatic update of phones
• Build App: Step 7 - explains removal on this step
• Build App: Step 9 - added simulator download instructions
• Build App: Oh Dear! Build Errors? - removed some carthage/homebrew steps, indicate when/how to remove carthage, minor edits
• Build App: Customize Your Loop (updated for v2.2.4)
• Set up App: Displays: Updated for v2.2.4
• Operate: Troublehoot: Red Loop, add database cleanup link, replace "mLab" with generic term
• Nightscout: New User - add link to the ENABLE list of Loop vars
• Nightscout: Existing User - link to new NS update directions instead of having instructions here

The link to the loopdocs sandbox listed above are in sync with github.com marionbarker loopdocs mdb-update-merge branch.

Supplemental info for direct download of Xcode

https://loopkit.github.io/loopdocs/build/updating/#direct-download-of-xcode

I notice some confusion in the forums regarding direct download of Xcode. Perhaps we need some additional info to clarify the process.

When installing the extracted Xcode app by dragging into the Applications folder, there is a prompt asking "An item named “Xcode” already exists in this location. Do you want to replace it with the one you’re moving?" (Keep Both / Stop / Replace)

The user should select "Replace" here to avoid ending up with two different versions of Xcode. This may create other issues, e.g. when using the script to open Xcode (xed .) I could not see any issues with two copies of the same version of Xcode, but perhaps with different versions it will be an issue. It will take up space anyways.

Finally, the user can delete the .xip file when done.

When choosing Replace, App Store will not know about the current .xip install. If visiting App Store, there is no option to update Xcode, but it will be possible to download again. This would also lead to duplicate Xcode. Perhaps worth mentioning.

Adding some other potential screenshots:
Extracting .xip:

Extracted Xcode:

Duplicate Xcode (by extracting the same .xip twice. Might look different if the first version was from App Store)

🐛 Regression: Copy to Code button missing since `mkdocs-material` upgrade

The copy-to-code button is now opt-in in mkdocs-material 9+.
It is missing since we upgraded mkdocs-material dependency to version 9.0.12 (commit 6320be8).

Loop quit unexpectedly

Hi,

My loop app crashes anytime I leave it on too long. If I open it for a minute (not quite long enough to crash the app) my phone will get very hot and begin to show signs of low memory for running other apps. I caught the error message in Xcode:

---

Details

The app “Loop” on ThePhone quit unexpectedly.
Domain: IDEDebugSessionErrorDomain
Code: 10
Failure Reason: Message from debugger: Terminated due to memory issue
User Info: {
DVTErrorCreationDateKey = "2022-10-13 13:08:42 +0000";
IDERunOperationFailingWorker = DBGLLDBLauncher;
}

Analytics Event: com.apple.dt.IDERunOperationWorkerFinished : {
"device_model" = "iPhone14,4";
"device_osBuild" = "15.6.1 (19G82)";
"device_platform" = "com.apple.platform.iphoneos";
"launchSession_schemeCommand" = Run;
"launchSession_state" = 2;
"launchSession_targetArch" = arm64;
"operation_duration_ms" = 125128;
"operation_errorCode" = 10;
"operation_errorDomain" = IDEDebugSessionErrorDomain;
"operation_errorWorker" = DBGLLDBLauncher;
"operation_name" = IDEiPhoneRunOperationWorkerGroup;
"param_consoleMode" = 0;
"param_debugger_attachToExtensions" = 0;
"param_debugger_attachToXPC" = 1;
"param_debugger_type" = 5;
"param_destination_isProxy" = 0;
"param_destination_platform" = "com.apple.platform.iphoneos";
"param_diag_MainThreadChecker_stopOnIssue" = 0;
"param_diag_MallocStackLogging_enableDuringAttach" = 0;
"param_diag_MallocStackLogging_enableForXPC" = 1;
"param_diag_allowLocationSimulation" = 1;
"param_diag_gpu_frameCapture_enable" = 0;
"param_diag_gpu_shaderValidation_enable" = 0;
"param_diag_gpu_validation_enable" = 0;
"param_diag_memoryGraphOnResourceException" = 0;
"param_diag_queueDebugging_enable" = 1;
"param_diag_runtimeProfile_generate" = 0;
"param_diag_sanitizer_asan_enable" = 0;
"param_diag_sanitizer_tsan_enable" = 0;
"param_diag_sanitizer_tsan_stopOnIssue" = 0;
"param_diag_sanitizer_ubsan_stopOnIssue" = 0;
"param_diag_showNonLocalizedStrings" = 0;
"param_diag_viewDebugging_enabled" = 1;
"param_diag_viewDebugging_insertDylibOnLaunch" = 1;
"param_install_style" = 0;
"param_launcher_UID" = 2;
"param_launcher_allowDeviceSensorReplayData" = 0;
"param_launcher_kind" = 0;
"param_launcher_style" = 0;
"param_launcher_substyle" = 0;
"param_runnable_appExtensionHostRunMode" = 0;
"param_runnable_productType" = "com.apple.product-type.application";
"param_runnable_swiftVersion" = "5.6.1";
"param_runnable_type" = 2;
"param_testing_launchedForTesting" = 0;
"param_testing_suppressSimulatorApp" = 0;
"param_testing_usingCLI" = 0;
"sdk_canonicalName" = "iphoneos15.5";
"sdk_osVersion" = "15.5";
"sdk_variant" = iphoneos;
}

System Information

macOS Version 12.5 (Build 21G72)
Xcode 13.4.1 (20504) (Build 13F100)
Timestamp: 2022-10-13T06:08:42-07:00

Please let me know if there is any more information I can provide to help debug this issue.

Homebrew/carthage

Homebrew/carthage installation section can be removed, or moved somewhere else as a reference, since the build phase auto-sets those up now.

Suggestions for Loop docs

Hi. The Loop docs are really clear and useful. I was easily able to set up Loop. Thanks. Along the way, I noticed the following three small things that the doc authors might be interested in considering for the next version of the docs.

1. Could mention Dexcom G4 CGM via Nightscout Share Server (https://github.com/dabear/NightscoutShareServer) in the following places:

• Requirements > CGM
• Build > Installing
• Build > Configuration > CGM Selection

2. Could update references to the old "Minimum BG guard" in a few places:

• Use > Carb entries
• Use > Bolus
• Algorithm > Overview (in text and images)
• Algorithm > Temp basal adjustments (in text and images)

3. Could update references to the old "Target range" in a few places:

• Algorithm > Overview (in text and images)
• Algorithm > Temp basal adjustments (in text and images)
• Algorithm > Bolus recommendations (in text and images)

Custom app icon location is different in LoopWorkspace

Building from workspace, the folder for app icons is a little different from what is shown in Loopdocs, based on the zip build.

It is found here:
LoopWorkspace/AdditionalAssets.xcassets/CustomLoopIcon.appiconset

https://loopkit.github.io/loopdocs/build/code_customization/#loop-logo

If the change to workspace is permanent, this should eventually be updated too, but but perhaps not top priority.

Flag that homebrew and carthage steps can be skipped

WIth the carthage problem in Jan 2021, the master, AB and dev branches of Loop and LoopWorkspace have been modified so that users do not need homebrew or carthage installed. Since there are a few forks that may still require this code, it may be best to leave the instructions in loopdocs for a bit, but perhaps add a big banner that the step can be skipped. There have been several new Loopers following the docs and running into problems.

Block OTA iOS Update | Document Workaround

Example(s):

1. https://loopkit.github.io/loopdocs/build/updating/ - Section: iOS 15 Warning - Check Before You Update

2. https://loopkit.github.io/loopdocs/build/step2/#turn-off-automatic-updates

Multiple times throughout the documentation, the user is reminded about the risk associated with updating iOS. Obviously turning off automatic updates is a good first step. For something a bit more restrictive (i.e. for those of us with dated hardware on the Macbook side & who cannot build against the latest iOS) you can install a configuration profile that'll disable OTA updates. This restriction is reversible by removing the profile.

Reference: https://ios.cfw.guide/blocking-updates/

Profile Hotlink: https://cydia.ichitaso.com/no-ota15.mobileconfig

Video: https://www.youtube.com/watch?v=cBv9lW1zX1g

This was helpful for our family, but I did want to explore if this is worth sharing / incorporating into documentation. If other people seem to be fine without it, we can disregard this issue.

Thanks!

-ZVD

Phrasing suggestions for quiz

The quiz posted on the Looped group is a fantastic training tool for new (and old) users. I think it would be great to keep it available under the Announcements section, or even have a link to it somewhere on LoopDocs - maybe even on the home page so new users can get a sense of how much they may need to learn, and it also serves as a bit of a primer on what sort of information is available in the docs.

However, at least a couple of people seemed to get tripped up by the phrasing of some of the questions. Suggested rewording:

1. When you get a red Loop, one of the easiest first troubleshooting steps is to....
   change to...
   When you get a red Loop, the first troubleshooting step should be to....

("one of the easiest" can somewhat subjective - for instance, if the RileyLink isn't quite as accessible as the phone, it may be easier for someone to restart the Loop app first. Hence my suggestion to simply to just "the first troubleshooting step")

2. When you want to understand Loop's decisions about temp basal adjustments and boluses, you should be looking at (may select multiple):
   change to...
   When you want to understand Loop's decisions about temp basal adjustments and boluses, you should at a minimum be looking at (may select multiple):

(Although I did know the correct answer, I still answered "all of the above" because COB, IOB, and Override do go into the Predicted Glucose Curve - and part of understanding Loops decisions COULD include understanding how the prediction curve is generated, which requires looking at the other items. Hence my suggestion to add "at a minimum" as a sort of hint.

3. More of a comment, not necessarily a suggestion - Regarding bolusing with no CGM data, I overlooked the "just like normal". Maybe add "without any additional steps"?

🗑️ Deprecation Warnings when running Github Action `publish.yml`

Running the github action publish.yml generates the following deprecation warnings:

• Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16

  deploy
  Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: 
  JamesIves/[email protected].
  For more information see: 
  

  https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.
• The set-output command is deprecated and will be disabled soon

  deploy
  The `set-output` command is deprecated and will be disabled soon. 
  Please upgrade to using Environment Files. 
  For more information see: 
  

  https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Avoid Low Power Mode

I could not find any mention of the usual advice to avoid Low Power Mode in Loopdocs.

Perhaps it was just my search that failed? If not, perhaps it should be added.

From https://support.apple.com/en-us/HT205234

Low Power Mode reduces or affects these features:

• Email fetch
• Background app refresh
• Automatic downloads
• Some visual effects
• Auto-Lock (defaults to 30 seconds)
• iCloud Photos (temporarily paused)
• 5G (except for video streaming)

Clarify "preferred source" is for MM Only

Two places in the docs say to set your Preferred Source setting in the Loop app to Event History. A number of us have lost time trying to find it on our Omnipod apps. If someone would add "(Minimed Only)" in those places to clarify, it would help.
Thanks.
(Maybe one day I'll be able to set up to modify documentation but I'm still too new, just got Nightscout running today after several false starts...)

Error regarding missing command line tools when using build script

Error message from build script reported on FB:

Trying to Build Select Script BUT getting this message in Terminal and Xcode isn't opening at the end of the process:
" xcode-select: error: tool 'xed' requires Xcode, but active developer directory '/Library/Developer/CommandLineTools' is a command line tools instance "

Sorry, I can't find this error in the LoopDocs.

A suggestion to search for "command line tools" in Loopdocs helped this user.

A possible candidate to be added to build errors?

Dead link on the Grey circle trouble shooting page

Hello:

First time contributor. I had a grey circle issue for the past two days.

Under "Set Up App > Loop Displays there is the below comment. When I clicked on the link, it is dead. Thank you.

A grey circle indicates the Loop is warming up and hasn’t yet completed its initial loop. When the Loop is first activated, it may take about 15-20 minutes to complete the first Loop, and the grey circle will be displayed. It needs CGM data to be gathered, so be patient. When it finally completes its first loop, the circle will turn green. If you can't get your grey loop to turn green, please see the Grey Loop troubleshooting page for tips.

Please Clarify Open Loop Page

See this issue opened by Nuddel69: LoopKit/Loop#1827

This is a loopdocs issue, not a code issue. Continuing the conversation here.

What is "delivery glags?"

Is the word 'glags' a typo? It doesn't google. It's found here

If it is actually a term, please provide a definition or better still use a lay-person's word.

Thanks!

Wrong release date in Loop v2.0 section

Page: https://loopkit.github.io/loopdocs/faqs/branch-faqs/
Section : Loop v2.0
On December 31, 2020, Loop released Loop v2.0
--> Assume it is 2019 :)