Skip to content

Commit 224b500

Browse files
committed
tweak language
1 parent 2478393 commit 224b500

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

docs/version/development.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,17 @@ There are no differences between `dev` and `main` at this time. However, there a
2222
|:--|:--|:--|
2323
| main | 3.8.2 | release |
2424
| dev | 3.9.2 | identical to main except version number |
25-
| feat/pod-keep-alive | 3.9.3 | - identical to 3.8.2 & 3.9.2 except uses the OmniBLE pod-keep-alive branch to support users of iPhone 16 phones with InPlay BLE (-Atlas) DASH pods<br>- this really should have kept the 3.9.2 version number<br>- SHA for OmniBLE is `8c47404` |
25+
| feat/pod-keep-alive | 3.9.3 | - identical to 3.8.2 & 3.9.2 except uses the OmniBLE pod-keep-alive branch to support users of iPhone 16 phones with InPlay BLE (-Atlas) DASH pods<br>- should have maintained the 3.9.2 version number<br>- SHA for OmniBLE is `8c47404` |
2626
| release/3.8.1 | 3.8.1 | - copy of the main release at version 3.8.1 that included Dana support<br>- this branch is meant to support people already using Dana with v3.8.1 who understand how to manage the issues with that version<br>- SHA for DanaKit is `3e606b8` |
2727
| feat/dev-dana-medtrum | 3.9.1 | - identical to dev when it was at 3.9.1, with addition of experimental support for Dana and Medtrum pumps<br>- this branch will be updated as updates are available for DanaKit and MedtrumKit<br>- this branch has newer version of the Dana pump manager than release/3.8.1 but new bolus recording issues were observed with this update<br>- when an updated version of dev is merged into this branch, the version number will be similarly incremented<br>- SHA for DanaKit is `0875c1e`<br>- SHA for MedtrumKit is `a85496e` |
2828

29+
!!! question "What is SHA?"
30+
SHA-1 means Secure Hash Algorithm 1. This is used to generate an alphanumeric code to identify which version of a repository is used.
31+
32+
Each time you save a change to your&nbsp;<span translate="no">GitHub repository</span>, a unique SHA-1 is created. That identifier is used to tell *GitHub* a specific change that you want applied or identifies a specific version for that <code>repository</code>. These work for any compatible <code>fork</code> from the original&nbsp;<span translate="no">GitHub repository</span>.
33+
34+
The SHA-1 20-character value is abbreviated as SHA and typically only the first 7 or 8 characters are presented to identify the commit for a particular repository.
35+
2936
### Version Number Plan
3037

3138
Please see [`Loop` Version Numbering](releases.md#loop-version-numbering) for the current method for version numbering for the `main` and `dev` branches.
@@ -37,7 +44,7 @@ Moving forward, the version number in the feature branch will match the `dev` br
3744
* In other words, a diff between `dev` and the feature branch is just the updates added to support the feature starting with that version of `dev`
3845
* As appropriate, `dev` will be merged into the feature branch and at that time, the version number for the feature branch will also be bumped
3946
* Updates to the feature branch to support the feature will not be updated with a new version number associated with the features
40-
* When updates for the feature are added, the SHA for that submodule will be reported and can be found by examining the LoopWorkspace repository for that feature branch
47+
* When updates for the feature are added, the SHA for that submodule will be reported in the table above and can be found by examining the LoopWorkspace repository for that feature branch
4148

4249
> The version number for the `feat/pod-keep-alive` does not match the planned pattern for numbering feature branches; it should have been left at 3.9.2.
4350
@@ -51,13 +58,19 @@ For more information about using the `feat/pod-keep-alive` branch with an iPhone
5158

5259
### Feature Branch: Medtrum and Dana Support
5360

61+
!!! important "Experts Only"
62+
Please only use the feat/dev-dana-medtrum branch if you are prepared to follow along in zulipchat and are willing to test an experimental branch that has known issues.
63+
5464
The Medtrum and Dana pump managers were originally tested with the Trio app. We know that pump managers that work for Loop also work for Trio, however, the converse is not necessarily true.
5565

5666
There are differences in the way Loop and Trio manage insulin delivery. An eventual goal is to make the apps use the same protocols.
5767

5868
* Loop uses the concept of a mutable dose
59-
* a mutable dose has been requested and is treated as if it completed as requested but until it is marked isMutable=false, it if not treated as final
69+
* a mutable dose has been requested and affects reported active insulin, but is not finalized
70+
* once the dose is finalized, the reported event in the event log shows isMutable=false
71+
* an example of a mutable delivery is a bolus in progress or a temporary basal rate with a fixed duration that ends in the future
6072
* Trio has its own method for dealing with doses that are initiated but might later change
73+
* Both systems respond to reported reservoir values for pumps that allow a user to manually initiate insulin delivery on the pump, but the methods differ
6174

6275
## Older updates
6376

0 commit comments

Comments
 (0)