LoopPatches

README last updated on 14-Jan-2023

With the release of Loop 3.0.0, continue to use the main branch of LoopPatches.

There have been no changes to the patch code recently, it continues to work with Loop 3.

The instructions were simplified 06-Jan-2023, so please read carefully.

Thanks to community member (bjorkert) for this simplification.

You do not need to manually download LoopPatches - it is automatic
The terminal display when you paste the commands shows the curl command results
Do Not Use shortcut if this is your first time with LoopPatches. Shortcut for repeat patch users

The LoopPatches code was lightly tested, but you use them at your own risk.

There are no guardrails, so be extremely careful when you enter thresholds in iOS settings.

LoopPatches Branch Status

The LoopPatches found in the main branch of LoopPatches can be applied to the Loop-dev version as well as the released Loop 3.0.0 version from the main branch of LoopKit/LoopWorkspace.

Custom Type One: LoopPatches Overview
Feature Details
Feature Selection
Apply LoopPatches
Confirm Patches Work
- Example for Switcher Patch
- Example for Basal Lock
(Optional) Examine Code Before Building

Custom Type One: LoopPatches

LoopPatches offer several adjustments to Loop. Each is disabled by default the first time you build after adding the patches, but your selected values are maintained for subsequent builds for a given phone. Only enable the feature(s) you want to use and test. Leave the rest disabled.

Features near the bottom of the list are either not recommended or are new and require more care
The order of patches displayed under Settings does not affect the values saved from previous builds
- Those values are remembered (by name) for a given phone.

The configuration for each patch is found under the iOS Loop settings (after patch installation) in this order with these names:

Add Now Marker, Main Charts
- Display Feature
- A vertical line is presented on each of the 4 main charts on the main Loop screen
- This can be enabled or disabled (default)
Automatic Strategy Switching
- Switch Dosing Strategy from Temp Basal to Automatic Bolus at a glucose level you choose
Negative IOB Factor
- Restrict the insulin Loop doses for negative IOB to prevent rebound lows
- This feature is disabled by selecting a factor of 100% (default setting is 1.0, same as 100%)
- Note - this modifies what Loop records as IOB whenever IOB is negative
Partial Bolus Application Factor
- Adjust the percentage of recommended insulin that Loop delivers for each Automatic Bolus when that Dosing Strategy is selected
- NOT RECOMMENDED, added for convenience of people returning from FreeAPS
Basal Lock
- Prevent Loop from reducing or suspending insulin when you go over a set glucose value to assist with stubborn highs
- Basal is "locked" to be no lower than the scheduled rate (overrides are ignored)
- Use with care; meant for high glucose >250 mg/dL (13.9 mmol/L)
  - When used improperly, this can cause lows

Use caution with these features and adjust conservatively and slowly for safety.

WARNING: These patches are open source, experimental and not approved for therapy by any governmental organization.

Do not use LoopPatches if you are not an experienced Looper who has previously built Loop and understands how to customize the code.
It is your responsibility to review the code and understand the changes made.
You take full responsibility for building and running Loop Dev with the patches and do so at your own risk.
Please consult with your health care professional regarding your diabetes management.

Feature Details

DO NOT attempt to use these patches until you have read and understood the documentation for each patch. Open the Loop Patches Documentation link (below) in a new tab or window and read the documentation.

Hold down the control key and click (or right click) on the link for Loop Patches Documentation : https://www.craft.do/s/pakv8NO1oYpDgh
Select open in a new window or new tab of your browser and read about each patch provided by Jon Fawcett
New additions to the LoopPatches - provided by Marion Barker
- Add Now Marker, Main Charts: No documentation required
Then return to this page before continuing (the documentation page does not have the patch code)

Feature Selection

Use iOS Settings

After installation, each patch will be enabled or modified using the phone iOS settings.

Tap on the phone settings icon

Scroll down until you find the Loop app
Tap on Loop
The graphic below shows phone (Loop) settings: Left before the Patch, Right after the Patch

All settings can be enabled or disabled individually. Be certain that you enter appropriate values before enabling each. Please file an issue if you experience problems or have a question.

After each fresh build, check all the values and check behavior for any enabled patches.

All Features:

To make sure your modification of a setting is updated in Loop immediately, quit the Loop app (swipe up) and then restart
- If you do not do this, then within one Loop cycle, the values should be updated anyway
- Do not guess, make sure the feature you just changed is behaving the way you want

Automatic Switching Strategy or Basal Lock:

When modifying a threshold value: disable the feature, modify threshold and then enable
Tap on the "Threshold" row to bring up a keyboard and enter or edit a value, return when done
Make sure that value is reasonable before sliding the switch to Enabled

mmol/L Users

No patch changes are required for mmol/L users. Several users confirmed threshold values are entered in mmol/L, but please check carefully on your device.

Apply LoopPatches

Summary of Steps

Obtain a fresh download of Loop
- Build to a simulator; ensure it builds without error
Open a NEW terminal in new LoopWorkspace
Follow directions to install patches
- STOP IMMEDIATELY if you get an error
Build Loop with LoopPatches to your phone
Choose the feature(s) to enable and test each one

Fresh Download of Loop

Warning: Only apply LoopPatches to a fresh download of Loop. Once patches are applied, you cannot apply them again without taking steps that are not included in these instructions. If you have other customizations you wish to apply, those should be added after applying LoopPatches.

For each link below - remember to control-click (or right click) to open link in a new tab or window so you can return to these instructions easily.

Use the Build Select Script instructions in LoopDocs to download Loop
When building, choose to build to a simulator (not your phone) to ensure build succeeds before applying LoopPatches

If you closed your terminal after the download - you need to follow the Open New Terminal at LoopWorkspace steps before applying patches.

Otherwise, skip ahead to the LoopWorkspace Quick Access instructions.

Open New Terminal at LoopWorkspace

If you are returning to add LoopPatches and have closed your terminal from the download, you should follow these steps to open a terminal window associated with the LoopWorkspace folder of your new Loop 3 download. This will be called the LoopWorkspace Terminal Window to distinguish it from any other terminal windows you might have open.

For full directions, with graphics, refer to LoopDocs at this link: Open a Terminal in LoopWorkspace Folder.

The short bullet list is provided here (if you don't need the instructions linked above)

Use Finder to navigate to Downloads / BuildLoop
Find the version of Loop 3 you just downloaded
Open the folder to view LoopWorkspace
Hold down the CTRL key and click (or right-click) LoopWorkspace
A menu appears - select New Terminal at Folder (near the bottom of the list)

As soon as that window opens, type pwd in the terminal and hit return. The command pwd means to print the working directory.

The response must end in LoopWorkspace and the date-time should match the fresh download. For example:

/Users/marion/Downloads/BuildLoop/Loop-230114-1645/LoopWorkspace

If the response is wrong, quit out of that terminal and try again.

Now you can skip ahead to Copy and Paste Commands.

LoopWorkspace Quick Access

If the terminal from your download is still open, you'll notice the final message says something similar to this:

Terminal Display:
To configure this terminal to LoopWorkspace folder of new download; copy and paste the following line into the terminal cd /Users/your-name-here/Downloads/BuildLoop/Loop-230114-1645/LoopWorkspace

Simply highlight the one line that starts with cd in your terminal (do not use the cd line above) and ends with LoopWorkspace; copy it (CMD-c) and then paste it (CMD-v) and hit return. Next issue the command pwd for print working directory and it should match the directory (the part that starts with /Users and ends with LoopWorkspace) in your terminal.

Copy and Paste Commands

Now that you have a new terminal window opened in the LoopWorkspace folder, you can copy and paste the following sets of commands into that terminal window. Each patch must be applied to the correct folder, so you will see change directory (cd) commands, copy from a URL (curl) that is then piped (|) into git apply commands. If you see the word error at the beginning of a line, stop and review the instructions. DO NOT CONTINUE after an error is observed.

Copy the lines below by hovering the mouse near the top right side of the text and clicking the copy icon. When you click the icon, a message that says “Copied” will appear on your screen.

cd Loop
curl https://raw.githubusercontent.com/CustomTypeOne/LoopPatches/main/LoopPatch.txt | git apply
cd ..
cd LoopKit
curl https://raw.githubusercontent.com/CustomTypeOne/LoopPatches/main/LoopkitPatch.txt | git apply
cd ..

After the text is copied, click in the LoopWorkspace Terminal Window and paste the text. (Ways to paste: CMD-V; or CNTL-click and select from menu or Edit-Paste at top of Mac screen.) Once the line is pasted, hit return. On some computers the return is not necessary but does not hurt anything. On some computers the return is required to execute the commands.

After you paste and hit return. The patches will be automatically applied and your screen should be similar to the graphic below.

There should be no error messages in response (unless there is an error). Make sure you do not see error: patch failed at the beginning of a line with various details afterwords. Be sure to only paste one time to a fresh download. A second paste will show errors.

Copy and paste the next line into the same LoopWorkspace Terminal Window. This command (xed) will open (or bring to front if already open) Xcode so you can build the code with LoopPatches applied. The . just means to open Xcode in the current LoopWorkspace location.

xed .

Optional, you can check the modified files inside Xcode using (Optional) Examine Code Before Building

Build with LoopPatches

Click on the Build Arrow to build to the simulator again
- If a window pops up asking if you want to Replace "Loop"?, click on Replace
- Confirm the build succeeded without errors
(Optional) If you want other customizations, add them now and test build to the simulator again
- Confirm the build succeeded without errors
Plug in your phone, select your phone and build to your phone

Congratulations!

So long as you did not get any errors, you have now applied the LoopPatches customization to your Loop app. Remember, these are configured under iOS -> Settings -> Loop screen. These features cannot be adjusted inside the Loop app settings screen.

Only enable the feature(s) you want to use and test. Leave the rest disabled.

Every time you build, please check the settings: refer to Use iOS Settings.

Confirm Patches Work

For each patch you enable, please confirm it works the way you expect it to work before allowing it to run "unattended". You should check this each time you build. It is too easy to miss a step and have something not operating the way you expect.

If you do not know how to confirm a feature is working, do not enable that feature.

There are no guardrails to check Threshold values entered in the patch settings. Please check entries carefully and confirm expected behavior after making a change in patch settings.

Example for Switcher Patch

Confirm that Dosing Strategy is set to Automatic Bolus and Closed Loop is enabled
Next time glucose is elevated above target, confirm that an automatic bolus is enacted
Type a value under iOS -> Settings -> Loop -> AUTOMATIC STRATEGY SWITCHING -> Switching BG Threshold that is significantly higher than your current glucose
Enable the AUTOMATIC STRATEGY SWITCHING feature
Next CGM reading should indicate that a high temp basal is enacted, instead of an automatic bolus

Now that you've confirmed the patch is working as desired:

Disable the feature
Modify the Switching BG Threshold to the desired value
Enable the feature

Loop will now automatically switch between Dosing Strategy of Temp Basal (less aggressive) when glucose is below that threshold level to a Dosing Strategy of Automatic Bolus (more aggressive) when glucose is above that threshold level.

Pay attention next time glucose is Below the threshold to ensure that only Temp Basal increases are provided.

Example for Basal Lock

Be very careful with this one. If you set the Basal Lock Threshold too low, it will prevent Loop from restricting basal and can cause low glucose.

Look for an opportunity when glucose is high, plan on focusing on your phone for 15 to 30 minutes.

Confirm that Closed Loop is enabled and Basal Lock is disabled
Next time glucose has been elevated for a while and Loop has given enough insulin that a Temp Basal of 0 U/hr is being provided (raising your correction range can make this happen sooner but be sure to restore it when done testing)
Type a value under iOS -> Settings -> Loop -> BASAL LOCK -> Basal Lock Threshold that is less than your current glucose
- Enable the BASAL LOCK feature
- Next CGM reading should indicate Loop restored scheduled basal
Immediately after that Loop cycle, raise the Basal Lock Threshold to be above your current glucose
- Next CGM reading should indicate Loop restored lower basal