Skip to content

Commit 193fb13

Browse files
authored
Update LoopDocs: Custom Edits for Omnipod uses OmnipodKit (#1078)
* update graphic and words for Browser Build * update words for Mac-Xcode build, remove unused graphic * update custom edits page for path names and line numbers * fix typos * fix typos * fix a few more left-over OmniBLE references * update table of submodules for translation tasks for OmnipodKit * incorporate reviewer comments
1 parent 8847011 commit 193fb13

8 files changed

Lines changed: 242 additions & 31670 deletions

File tree

‎docs/browser/edit-browser.md‎

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
Of course, accidents happen. No worries.
3030

3131
* Just hit the Close button
32-
* If you don't close the accidental PR yourself, it will be closed for you, but that takes time
32+
* If you don't close the accidental PR yourself, it will be closed for you, but that takes time from the *Loop* developers
3333

3434
## Overview
3535

@@ -80,8 +80,8 @@ There is some background information at the bottom of this page starting at&nbsp
8080

8181
Decide which [Version: Custom Edits](../version/code-custom-edits.md){: target="_blank" } changes you want to make. Each customization lists a Module name.
8282

83-
* DASH Pods: Use OmniBLE
84-
* Eros Pods: Use OmniKit
83+
* Any Pod Type: Use OmnipodKit which is hosted at the loopandlearn GitHub username
84+
* When you change Pod Types, this customization remains in place
8585
* Other Modules are Loop and LoopKit
8686
* Do not get confused later: LoopKit is both a username and a Module name
8787
* Refer to the [Module Table](#module-table) when directed
@@ -92,6 +92,11 @@ Decide which [Version: Custom Edits](../version/code-custom-edits.md){: target="
9292
9393
> For versions 3.6.x and newer, the customizations for `main` and `dev` are the same.
9494
95+
> For versions 3.14.2 and newer:
96+
>
97+
> * the old OmniBLE (DASH) and OmniKit (Eros) repositories are no longer used
98+
> * the new OmnipodKit (Eros, DASH and Omnipod 5) repository is used for all Omnipod support
99+
95100
## Outline of What Happens in the Module
96101

97102
!!! warning "Review Only"
@@ -162,8 +167,7 @@ This table lists all the modules referred to on the Code Customization page link
162167
| --- | --- |
163168
| <span translate="no">Loop</span> | [<span translate="no">https://github.com/LoopKit/Loop</span>](https://github.com/LoopKit/Loop) |
164169
| <span translate="no">LoopKit</span> | [<span translate="no">https://github.com/LoopKit/LoopKit</span>](https://github.com/LoopKit/LoopKit) |
165-
| <span translate="no">OmniBLE (for DASH)</span> | [<span translate="no">https://github.com/LoopKit/OmniBLE</span>](https://github.com/LoopKit/OmniBLE) |
166-
| <span translate="no">OmniKit (for Eros)</span> | [<span translate="no">https://github.com/LoopKit/OmniKit</span>](https://github.com/LoopKit/OmniKit) |
170+
| <span translate="no">OmnipodKit</span> | [<span translate="no">https://github.com/loopandlearn/OmnipodKit</span>](https://github.com/loopandlearn/OmnipodKit) |
167171

168172
Remember - you can only have a single <code>fork</code> of a given&nbsp;<span translate="no">GitHub repository</span>. If you already have a <code>fork</code>, you don't need another one; but it must be a linked to the URL listed the [Module Table](#module-table).
169173

@@ -178,8 +182,7 @@ When you&nbsp;"<span translate="no">fork a repository"</span>, the default&nbsp;
178182
| --- | --- |
179183
| <span translate="no">LoopKit/Loop</span> | <span translate="no">dev</span> |
180184
| <span translate="no">LoopKit/LoopKit</span> | <span translate="no">dev</span> |
181-
| <span translate="no">LoopKit/OmniBLE</span> | <span translate="no">dev</span> |
182-
| <span translate="no">LoopKit/OmniKit</span> | <span translate="no">main</span> |
185+
| <span translate="no">loopandlearn/OmnipodKit</span> | <span translate="no">dev</span> |
183186

184187
## Personalized Customization for this Module
185188

@@ -190,35 +193,35 @@ Navigate to the file you need to modify (using the instructions to find the line
190193

191194
Suppose you want to add this customization: [Pods: Add Extra Insulin on Insertion](../version/code-custom-edits.md#pods-add-extra-insulin-on-insertion){: target="_blank" }
192195

193-
The folder name is: ` OmniBLE/OmniBLE/OmnipodCommon`<br>
196+
The folder name is: ` OmnipodKit/OmnipodKit/OmnipodCommon`<br>
194197
The file name is: `Pod.swift`
195198

196-
So you will go to your OmniBLE fork (see [New Fork](#new-fork){: target="_blank" } if you don't have a fork yet).
199+
So you will go to your OmnipodKit fork (see [New Fork](#new-fork){: target="_blank" } if you don't have a fork yet).
197200

198-
**Ensure your fork is up-to-date.** Tap on the `Sync `ork` button if necessary.
201+
**Ensure your fork is up-to-date.** Tap on the `Sync fork` button if necessary.
199202

200-
1. Tap to select `OmniBLE` folder in that fork
203+
1. Tap to select `OmnipodKit` folder in that fork
201204
1. Tap to select `OmnipodCommon` folder in that folder
202205
1. Tap to open the `Pod.swift` file
203206
* Once the file is open, tap on the pencil icon and make your edits
204207
* When done, review the [Example GIF](#example-gif) which shows the steps needed to save your changes after you complete the edit
205208

206-
The graphic below shows the `fork` for the `OmniBLE` submodule with numbers that match the steps in the list above. If you need more detailed instructions, they are found after the graphic.
209+
The graphic below shows the `fork` for the `OmnipodKit` submodule with numbers that match the steps in the list above. If you need more detailed instructions, they are found after the graphic.
207210

208211
![example navigation to file in fork](img/navigate-submodule-omnible.svg){width="800"}
209212
{align="center"}
210213

211214
??? info "More detailed instructions (Click to open/close)"
212215
1. Check that this repository is the correct submodule and that:
213216
* Fork has your GitHub Username
214-
* Fork says it is forked from LoopKit
215-
* Fork is up to date with LoopKit
216-
* Tap on the OmniBLE folder to open the next screen
217+
* Fork says it is forked from loopandlearn (or LoopKit for other repositories)
218+
* Fork is up to date with loopandlearn
219+
* Tap on the OmnipodKit folder to open the next screen
217220
1. Check that your screen shows:
218-
* `OmniBLE/OmniBLE` at the top (current folder location)
221+
* `OmnipodKit/OmnipodKit` at the top (current folder location)
219222
* Tap on the OmnipodCommon folder to open the next screen
220223
1. Check that your screen shows:
221-
* `OmniBLE/OmniBLE/OmnipodCommon` at the top (current folder location)
224+
* `OmnipodKit/OmnipodKit/OmnipodCommon` at the top (current folder location)
222225
* Tap on the Pod.swift file to open it
223226
* Tap on the pencil icon (upper right) to start editing the file
224227
@@ -274,7 +277,9 @@ The bullets below go with Frame 2 of the [GIF](#example-gif) above:
274277
* You will be shown a screen where you create a pull request to your own <code>fork</code> (this does not go back to the original)
275278
* First review the changes (shown at the bottom) and then click on the&nbsp;"<span translate="no">Create pull request</span>"&nbsp;button
276279

277-
Between Frame 2 and 3 of the GIF, your display will look similar to the graphic below:
280+
Between Frame 2 and 3 of the GIF, your display will look similar to the graphic below
281+
282+
* This is an old figure - if you are making Pod edits, you will see OmnipodKit - not OmniBLE
278283

279284
![GitHub screen after modifying the custom branch](img/browser-customize-select-branch.png){width="750"}
280285
{align="center"}
@@ -302,11 +307,11 @@ Now your display should look like Frame 4 of the [GIF](#example-gif) above:
302307
For example:
303308

304309
```
305-
# OmniBLE: Increase insulin at insert by 0.35 U
310+
# OmnipodKit: Increase insulin at insert by 0.35 U
306311
SHA-1 = 5e9f4f407ff5544663f496d2e3a5ed8aa4f32a68
307312
```
308313

309-
Warning - that is not a valid SHA-1 for this change. Do not try to copy it and use it. You must make your own personalized changes.
314+
**Warning** - that is not a valid SHA-1 for this change. Do not try to copy it and use it. You must make your own personalized changes.
310315

311316
Later on, you will create the actual command needed to insert into build_loop_auto.yml so you can add this customization when your build the app.
312317

@@ -414,6 +419,7 @@ Refer to [Prepare customization lines](#prepare-customization-lines){: target="_
414419

415420
* extract the text from "https:" through "patch" and paste that into a new tab
416421
* this will open a browser similar to the following graphic
422+
* this graphic was prepared using the old OmniBLE repository - now the patch would be with OmnipodKit
417423

418424
![open patch at GitHub](img/browser-open-to-patch.png){width="750"}
419425
{align="center"}
@@ -426,6 +432,7 @@ Once the file is downloaded to a sensible name, make a copy (or rename it) to in
426432
* Lower file shows the renamed and edited version:
427433
* Add the name of the module to the "a" and "b" directory paths so the patch is applied to the correct folder (from LoopWorkspace)
428434
* In this example `OmniBLE/` was added in 4 places as highlighted by red rectangles
435+
* WARNING: this graphic is old - a new one would use OmnipodKit, OmniBLE is no longer used
429436

430437
![download and then edit patch for Workspace](img/prepare-workspace-patch.svg){width="750"}
431438
{align="center"}

0 commit comments

Comments
 (0)