Skip to content

Commit fe8c18f

Browse files
authored
Merge pull request #936 from marionbarker/working-docs
Update for dev branch 3.7.6
2 parents 2c96ecf + 5b64844 commit fe8c18f

File tree

12 files changed

+238
-155
lines changed

12 files changed

+238
-155
lines changed

docs/build/build-dev-mac.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
## `BuildLoopDev` Script
1313

14+
> Choose the tip of dev when using the existing scripts. The concept of the lightly tested commit is no longer needed. Each `dev` update comes with a new dev version number after a formal review process.
15+
1416
There is a script to assist in building the `dev branch`. It gives you the option to choose the tip of the `dev branch` or to build a lightly tested commit. If you have not used the [Build Select Script](../build/build-app.md#build-select-script) to build Loop previously, you may want to review that page. The command below can be pasted into the terminal of your Mac. Read the directions in the script.
1517

1618
``` { .bash .copy title="Copy and Paste to start the BuildLoopDev script" }
@@ -43,14 +45,14 @@ You may prefer to use commands to fetch and pull the latest code without making
4345

4446
## Loop-dev Version
4547

46-
The version of code that shows up under the Loop Settings screen does not change when the `dev branch` is modified.
48+
Starting with v3.7.x, the version of code that shows up under the Loop Settings screen increments with each formal change to the `dev` branch using the pull request process. That increment might be an update to match a hotfix to `main` or might be from a new feature brought just into the `dev` branch.
4749

48-
If you need help with your app, the mentors need more information. Please issue a Loop Report when asking for help. Refer to [Support](../loop-3/settings.md#support) for how to issue a Loop Report. If you want to keep track yourself, refer to [Identify Loop-dev Version](#identify-loop-dev-version)
50+
If you need help with your app, the mentors need to know you are running a `dev` branch and the specific version that shows on your settings screen.
4951

50-
* [`Loop` Version Numbering](../version/releases.md#loop-version-numbering)
52+
For a summary of features added to the `dev` branch by version number:
5153

52-
### Identify Loop-dev Version
54+
* [Updates in `dev`](../version/development.md#updates-in-dev){: target="_blank" }
5355

54-
The version of code that shows up under the Loop Settings screen will remain fixed until Loop-dev is released. In order to identify which version of dev you have on your phone, you need the commit.
56+
For more information about version numbers:
5557

56-
The commit is identified by a 7-digit alphanumeric code. That code was also appended to the folder name of the downloaded code under Downloads/BuildLoop as shown in the graphic above. You can use finder to view the folder name after the script completes. It also appears in the Loop Report, refer to [Support](../loop-3/settings.md#support) for instructions on issuing a Loop Report. After you issue the Loop Report, look at the workspaceGitRevision number near the beginning of the report.
58+
* [`Loop` Version Numbering](../version/releases.md#loop-version-numbering){: target="_blank" }

docs/build/community.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,33 @@ Volunteers provide assistance on building and using the *Loop* app at these site
2727

2828
## Screenshots
2929

30-
Please take screenshots of your issue and include them in your posts. On an Apple computer, press ++shift+command+4++ keys at the same time and a little crosshairs tool will appear. Click-and-drag across the area you'd like to include in the screenshot. When you let go of the button, the screenshot will be saved to your desktop with a file name starting with the name `Screen Shot`. To capture an entire window, press ++shift+command+4++ keys at the same time followed by pressing ++space++ (the space bar) and then click on the window of interest.
30+
Please take screenshots of your issue and include them in your posts - unless you want Browser Build help. **For Browser Build, include your URL, not a screenshot.**
3131

32-
**Use screenshots instead of cell phone images whenever possible.** Screenshots are higher resolution and easier to read.
32+
### Help with the app
3333

34-
Take a wide screenshot (full window capture) when asking for help with settings or Xcode build errors. Nightscout and Xcode have lots of valuable information off-to-the-side that can be valuable for troubleshooters.
34+
If you are asking for help using the *Loop* app after you've already built it, take screenshots on your phone and upload to either Facebook or zulipchat along with your question.
35+
36+
If you are posting *Nightscout* graphics, use the full window from either your phone or your computer in your screenshot.
37+
38+
> [How to Find Help](../intro/loopdocs-how-to.md#how-to-find-help){: target="_blank" }
39+
40+
### Help with Browser Build
41+
42+
If you need help with building the app using a browser, copy the URL for the LoopWorkspace fork and paste it into Facebook or zulipchat along with your question.
43+
44+
> [How to Find Help](../intro/loopdocs-how-to.md#how-to-find-help){: target="_blank" }
45+
46+
### Help with Mac Build
47+
48+
If you are building with a Mac computer and need assistance, **use screenshots** from your Mac computer. Taking a cell phone photo of your Mac screen is generally insufficient.
49+
50+
Include full window capture when asking for help. The *Nightscout* and *Xcode* apps have lots of valuable information off-to-the-side that can be valuable for troubleshooters.
51+
52+
> [How to Find Help](../intro/loopdocs-how-to.md#how-to-find-help){: target="_blank" }
53+
54+
#### How to Obtain a Screenshot on a Mac
55+
56+
On an Apple computer, press ++shift+command+4++ keys at the same time and a little crosshairs tool will appear. Click-and-drag across the area you'd like to include in the screenshot. When you let go of the button, the screenshot will be saved to your desktop with a file name starting with the name `Screen Shot`. To capture an entire window, press ++shift+command+4++ keys at the same time followed by pressing ++space++ (the space bar) and then click on the window of interest.
3557

3658
## Descriptive Language
3759

@@ -56,7 +78,7 @@ The *Loop* app no longer allows you to enter your correction range in the wrong
5678
This example is not quite as old, but does refer to details from older *Loop* and *iOS* versions. It exemplifies the details needed to assist someone with a build error.
5779

5880
!!! tip "Build with Browser"
59-
If you are using the Build with Browser method, we still need descriptive details but we do not need screenshots. All that is required is to list your *GitHub* user name. The volunteers can then read your publicly available log files. (All private information is automatically redacted in those logs.)
81+
If you are using the Build with Browser method, we still need descriptive details but we do not need screenshots. All that is required is to list your *GitHub* user name. Of course it's really nice if you just paste in your URL - then we don't have to construct the link. The volunteers can then read your publicly available log files. (All private information is automatically redacted in those logs.)
6082

6183
**Bad:** "`My Loop app won't build.`" <----- What step are you on? What is the iOS on your phone? What kind of computer are you using? What macOS? What Xcode version? Have you built successfully before or is this new?
6284

@@ -72,6 +94,8 @@ Often, the best answer to your question is sending a link to the answer in *Loop
7294

7395
If you've searched the docs and read relevant info already, please include that in your post or your reply. That way you don't get linked back to the part you are confused about. And if you have already read the specific section a mentor just linked, be specific about why your problem is not addressed by that link. Or just say "I'm confused when the doc says this". Letting us know when these docs can be improved is very useful.
7496

97+
- - -
98+
7599
## Next Step
76100

77101
Now you are ready to build or continue with setting up the *Loop* app.

docs/build/phone.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,17 @@ You need a minimum version of the mobile operating software, called the *iOS*, t
3131

3232
### Compatible Device
3333

34-
All the devices listed below are currently compatible with Loop. They are separated by the available *iOS* for the phone. Those that only support *iOS* 15 or 16 may become incompatible for the next version of the *Loop* app, but can be used with `Loop version 3.4.x`.
34+
!!! warning "iPhone 16 and Omnipod DASH"
35+
At the current time, some DASH pods produced in 2025 have different chips and firmware than were used for earlier manufacturing dates.
36+
37+
* These pods, which advertise with a Bluetooth Device name of `InPlay BLE` are fully compatible with all iPhone models listed below except iPhone 16
38+
* They still work with the 16 but can be slow (seconds to minutes) to connect (and reconnect) to the *Loop* app
39+
* When the pod is not connected, neither automatic nor manual commands can be sent to the pod to modify insulin delivery
40+
* No solution to this issue is known (yet)
41+
42+
> DASH pods that advertise with a Bluetooth Device name of `TWI Board` and are fully compatible with all phones listed below.
43+
44+
All the devices listed below are currently compatible with Loop. They are separated by the available *iOS* for the phone. Those that only support *iOS* 15 or 16 may become incompatible for the next version of the *Loop* app, but can be used with `Loop version 3.6.x`.
3545

3646
These phones require *iOS* 18
3747

docs/build/pump.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
!!! info "Time Estimate"
44
- Omnipod users: 3 seconds to remember which Personal Diabetes Manager (PDM) you've been using.
55
- Medtronic users: 10 minutes to put a battery in and look at model and firmware
6+
- Dana users: 5 minutes to check your model number
67
- Other pump users: 5 days to email friends asking them to check closets for their old Medtronic pump or call your insurance to start prior authorization for Omnipod
78

89
!!! abstract "Summary"
910
- If you have a Medtronic pump, check the [Medtronic Pump Version](#check-medtronic-pump-version) list to ensure compatible model/firmware
1011
- If you use [Omnipod](#omnipod-pumps) - check which kind
12+
- If you use [Dana](#sooil-dana-pumps) - check which kind
1113

1214
!!! question "FAQs"
1315
- **"How can I find a compatible Medtronic pump?"** Refer to [Finding a Medtronic Pump](#finding-a-medtronic-pump).
@@ -23,7 +25,8 @@ These types of pumps are compatible with the *Loop* app.
2325
* [Older Medtronic pumps](pump.md#check-medtronic-pump-version)
2426
* [Omnipod Eros pumps](pump.md#omnipod-pumps)
2527
* [Omnipod DASH pumps](#omnipod-dash)
26-
* [Dana-i / DanaRS-v3](#sooil-dana-pumps) Coming soon
28+
* See caveat about [iPhone 16](phone.md#compatible-device){: target="_blank" }
29+
* [Dana-i / DanaRS-v3](#sooil-dana-pumps) (dev branch only, v3.7.5 or newer))
2730

2831
## Check Medtronic Pump Version
2932

@@ -179,24 +182,24 @@ The DASH system has the newer, slimmer locked-android Personal Diabetes Manager
179182
![img/dash.png](img/dash.png){width="750"}
180183
{align="center"}
181184

185+
[See warning about iPhone 16 with DASH](phone.md#compatible-device){: target="_blank" }.
186+
182187
### Omnipod 5
183188

184189
Loop does not support Omnipod 5 pods.
185190

186191
## Sooil Dana pumps
187192

188-
!!! warning "Future Feature Only"
189-
Sorry but the Dana pump has not landed in released code or even dev code at this time. There is a testing fork, so check out [Zulipchat Dana Pump discusion](https://loop.zulipchat.com/#narrow/stream/144182-development/topic/Dana.20i.20pump).
190-
191-
The information below is for the convenience of people reading along in zulipchat.
193+
!!! warning "You must build dev branch to use Dana pumps"
194+
The Dana pump is in dev (as of version v3.7.5) and will be in the next release. Follow the [Zulipchat Dana Pump discusion](https://loop.zulipchat.com/#narrow/channel/144182-development/topic/DanaKit.20support.20for.20Loop) if you choose to run the *Loop* app with a Dana pump.
192195

193196
**Every Dana pump has built-in BLE communications. Therefore, no RileyLink-compatible device is needed to use Dana-i / DanaRS-v3 with the *Loop* app.**
194197

195198
### Dana-i
196199

197200
The Dana-i is the latest and greatest from the Korean pump manufacturer Sooil, released in 2020.
198201

199-
The special fork (see [link](#sooil-dana-pumps) for details) works with the Dana-i. If your version of the *Loop* app not from that fork, you cannot use the Dana-i.
202+
> The *Loop* app v3.7.5 or newer (built with dev branch of `LoopWorkspace`) supports the Dana-i.
200203
201204
![Dana-i](img/dana-i.png){width="250"}
202205
{align="center"}
@@ -206,7 +209,7 @@ The special fork (see [link](#sooil-dana-pumps) for details) works with the Dana
206209
The DanaRS was first released in 2002, with firmware version v1 which is not supported at this time. Only firmware version v3 and onwards are supported with the *Loop* app.
207210
[Check here](../loop-3/add-pump.md#dana-i-danars-v3) to see how to check your firmware version.
208211

209-
The special fork (see [link](#sooil-dana-pumps) for details) works with the DanaRS-v3. If your version of the *Loop* app not from that fork, you cannot use the DanaRS-v3.
212+
> The *Loop* app v3.7.5 or newer (built with dev branch of `LoopWorkspace`) supports the DanaRS-v3.
210213
211214
![DanaRS-v3](img/danars.png){width="250"}
212215
{align="center"}

docs/build/rileylink.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
## Order a RileyLink Compatible Device
22

3-
**Not needed for DASH**
3+
**Not needed for any pump that supports direct Bluetooth BLE commands**
4+
5+
* **Dana**
6+
* **DASH**
7+
8+
**Required when using an older Medtronic pump or Omnipod Eros pods**
49

510
!!! info "Time Estimate"
6-
- 0 minutes if you plan to use a DASH Omnipod pump - you don't need one
11+
- 0 minutes if you plan to use a Dana pump or a DASH Omnipod pump - you don't need one
712
- 15-20 minutes to read about RileyLink compatible devices
813
- 15 minutes to order a device
914

@@ -13,7 +18,7 @@
1318

1419
!!! question "FAQs"
1520
- **What is a RileyLink Compatible Device?** RileyLink refers to both the communication protocol and the name of the original device. Other DIY Loopers have created [RileyLink Compatible Devices](rileylink.md#rileylink-compatible-devices) that use the RileyLink protocol. All these devices can be used interchangeably with the *Loop* app to support Eros and Medtronic use.
16-
- **Do I have to buy one?** These are open-source hardware devices, but it takes special skills to build them yourself. It is recommended you buy one (or two) if you require it. At the current time, new OrangeLink and EmaLink devices are available for purchase. There are many used devices available in the community now that many users have switched to DASH. **Not needed for DASH**
21+
- **Do I have to buy one?** These are open-source hardware devices, but it takes special skills to build them yourself. It is recommended you buy one (or two) if you require it. At the current time, new OrangeLink and EmaLink devices are available for purchase. There are many used devices available in the community now that many users have switched to DASH. **Not needed for DASH or Dana pumps**
1722
* Facebook Group where you may find used items: [Looping in a time of covid](https://www.facebook.com/groups/1087611668259945/)
1823
- **"What happens if I lose my RileyLink compatible device or walk away from it?"** Within a half hour, your pump returns to the normal scheduled basal rate
1924
- **"Can I swap out RileyLink compatible devices at any time?"** Yes, you can. You do not need to start a new pod or rebuild the *Loop* app. Tap on the pump menu in settings to search for new devices. You can swap between compatible devices.
@@ -22,7 +27,7 @@
2227

2328
## What is a RileyLink Compatible Device
2429

25-
The RileyLink compatible device is required to allow your phone to talk to compatible *Medtronic* and *Omnipod Eros* pumps. **It is not needed for *Omnipod DASH* pumps.**
30+
The RileyLink compatible device is required to allow your phone to talk to compatible *Medtronic* and *Omnipod Eros* pumps. **It is not needed for *Omnipod DASH* or Sooil Dana pumps.**
2631

2732
!!! abstract "Details for RileyLink"
2833
The RileyLink compatible device is an open-source hardware device that can bridge Bluetooth Low Energy (BLE) to the radio-frequency wireless communication used by compatible *Medtronic* and *Omnipod Eros* pumps.
@@ -38,6 +43,8 @@ Loop 3 has *Omnipod DASH* support, among other new features. When using *Omnipod
3843

3944
The RileyLink protocol defines a specific Bluetooth interface and way of opening a Sub-GHz radio channel to pumps. All RileyLink compatible devices follow the RileyLink protocol.
4045

46+
> Many Omnipod users have switched to DASH and no longer need a RileyLink device, so the demand is significantly less than it used to be. You can still buy the devices, but there are fewer options.
47+
4148
There used to be just one option, the original RileyLink. Now there are more options, so you have to make a decision. Depending on your choice, be sure to have the correct charger and cables or batteries handy and add spare compatible supplies to your diabetes go-bag.
4249

4350
- A [Comparison Chart](https://getrileylink.org/rileylink-compatible-hardware-comparison-chart?fbclid=IwAR2vHbOzla-zmM-cSp4NkOB_23k3spgnaYvCIGRcACcIQ25FJAU_7HRkH2A) is provided by the GetRileyLink organization for all the RileyLink compatible devices listed below
@@ -72,7 +79,7 @@ Sections of interest include:
7279

7380
## Waiting for your RileyLink Compatible Device
7481

75-
While you are waiting for the RileyLink compatible device to arrive, you can proceed with these build directions and can try one of the [Simulated Loop](../version/simulator.md){: target="_blank" } options. After that, unless you are using *Omnipod DASH*, you'll have to wait for your device.
82+
While you are waiting for the RileyLink compatible device to arrive, you can proceed with these build directions and can try one of the [Simulated Loop](../version/simulator.md){: target="_blank" } options. After that, unless you are using *Omnipod DASH* or Sooil Dana, you'll have to wait for your device.
7683

7784
The population of DIY loopers (Loop and Android APS) has grown enough that you might be able to find someone local to loan you their spare.
7885

0 commit comments

Comments
 (0)