Skip to content

Commit

Permalink
Merge pull request #821 from marionbarker/working-docs
Browse files Browse the repository at this point in the history
Updates for Widgets, Apple Vision Pro and LoopCaregiver App Group
  • Loading branch information
marionbarker authored Apr 24, 2024
2 parents 443300c + eabf0c2 commit 4d6f5d0
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 22 deletions.
24 changes: 23 additions & 1 deletion docs/gh-actions/gh-first-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@ You do not need to add a bank account or fill out tax forms if you are only usin
## Create Loop App in App Store Connect

??? abstract "Section Summary (click to open/close)"
If you have created a Loop app in App Store Connect before, skip ahead to [Create Certificates](#create-certificates).
If you have created a Loop app in App Store Connect before, make sure you [Remove Apple Vision Pro](#remove-apple-vision-pro) and then skip ahead to [Create Certificates](#create-certificates).

1. Click on the link [apps list](https://appstoreconnect.apple.com/apps){: target="_blank" } to open App Store Connect and click the blue "plus" icon to create a New App.
* Select "iOS".
Expand All @@ -1052,6 +1052,8 @@ You do not need to add a bank account or fill out tax forms if you are only usin

You do not need to fill out the next form. That is for submitting to the app store.

[Remove Apple Vision Pro](#remove-apple-vision-pro) from the app you just created.

[<span class="loop-bigger">:material-skip-forward:</span>](#create-certificates) To skip the detailed instructions, click on [Create Certificates](#create-certificates).

If you have created a `Loop app` in *App Store Connect* before, skip ahead to [Create Certificates](#create-certificates).
Expand All @@ -1065,6 +1067,10 @@ If you have previously used some kind of remote build, like `diawi` or `TestFlig
![app store connect with deleted apps](img/01-app-store-connect.png){width="600"}
{align="center"}

1. There might be a blue banner present at this time. If not, it will show up after you have at least one app.
* The information banner refers to "iOS Apps on Apple Vision Pro"
* You must wait until you have an app before you can edit the capabilities for the app - this will happen after the next step

1. Click the `Add Apps` button or the blue "plus" icon (:material-plus-circle:{: .appstoreconnect } ) and select `New App` as shown in the graphic below

![choose to add a new app](img/new-app-in-store.png){width="300"}
Expand All @@ -1091,6 +1097,22 @@ If you have previously used some kind of remote build, like `diawi` or `TestFlig
* Instead, go back and put the correct value into the `TEAMID` *Secret* and follow the steps in [Delete Identifiers](#delete-identifiers)
1. Click `Create` but do not fill out the next form. That is for submitting to the app store and you will not be doing that.

### Remove Apple Vision Pro

It is now time to edit the availability of your app on Apple Vision Pro. If you skip this step, you will get an annoying email telling you Apple Vision Pro is not supported by your app.

* First click to return to the main [App Store Connect](https://appstoreconnect.apple.com/apps){: target="_blank" } and click on "Edit Availability" for **iOS Apps on Apple Vision Pro**.

![Edit Availability for Apple Vision Pro](img/apple-vision-pro.png){width="600"}
{align="center"}

* This opens a new screen. By default, all your apps have Apple Vision Pro selected. Tap on the None button and then save to remove this.
* If you later create a new app, you will need to perform the same task for the new app<br><br>

![remove Availability for Apple Vision Pro](img/remove-apple-vision-pro.png){width="600"}
{align="center"}


You are done with this activity and can close the browser tab. It's time to head back to your *GitHub* account and [Create Certificates](#create-certificates)

### Find My Loop
Expand Down
27 changes: 19 additions & 8 deletions docs/gh-actions/gh-other-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,21 +275,25 @@ The `Edit Your App ID Configuration` screen will open.
* This opens the `App Group Assignment` screen
* Check the box by `LoopCaregiver` *App Group* that uses your `TEAMID` in `group.com.TEAMID.loopkit.LoopCaregiver`
* If the box by `Loop App Group` is checked, you should uncheck it
* Your screen should be similar to the graphic below
* If you made any changes, tap `Continue`, otherwise, tap `Cancel`

If you modified settings for an *identifier*, the `Save` button at the top right will become active. Click on `Save` before leaving this page - otherwise, the change does not take effect.
![select the loopcaregiver app group](img/lcg-app-group.png){width="600"}
{align="center"}

2. If you modified settings for an *identifier*, the `Save` button at the top right will become active. Click on `Save` before leaving this page - otherwise, the change does not take effect.

* Tap on `Save`
* This opens the `Modify App Capabilities` confirmation screen
* Click on `Confirm`
* Tap on `Save`
* This opens the `Modify App Capabilities` confirmation screen
* Click on `Confirm`

If you did not need to make changes, the `Save` button will not be active.
3. If you did not need to make changes, the `Save` button will not be active.

* Tap on the `< All Identifiers` button at the top left
* Tap on the `< All Identifiers` button at the top left

The full list of Identifiers should be displayed again.
4. The full list of Identifiers should be displayed again.

Continue down the list until every identifier in the table below has the `App Group` for `LoopCaregiver App Group` added to it. (DO NOT SELECT the `Loop App Group`) If you miss any, the *GitHub* action to `3. Create Certificates` will succeed but the *GitHub* action to `4. Build LoopCaregiver` will fail.
5. Continue down the list until every identifier in the table below has the `App Group` for `LoopCaregiver App Group` added to it. (DO NOT SELECT the `Loop App Group`) If you miss any, the *GitHub* action to `3. Create Certificates` will succeed but the *GitHub* action to `4. Build LoopCaregiver` will fail.

| `NAME` | `IDENTIFIER` |
|-------|------------|
Expand All @@ -301,6 +305,11 @@ Continue down the list until every identifier in the table below has the `App Gr

## Create App in App Store Connect

!!! abstract "Same procedure as for the *Loop* app"
You will follow the same procedure as you did with the *Loop* app.

You will also want to edit your new app once you create it to [Remove Apple Vision Pro](gh-first-time.md#remove-apple-vision-pro){: target="_blank" }.

You will be following the directions below to create an App in App Store Connect if you don't already have one.

This requires you to provide some information. Examine the table below for the bundle ID associated with your app.
Expand Down Expand Up @@ -338,6 +347,8 @@ This requires you to provide some information. Examine the table below for the b

1. Click Create but do not fill out the next form. That is for submitting to the app store and you will not be doing that.

1. Edit your new app to [Remove Apple Vision Pro](gh-first-time.md#remove-apple-vision-pro){: target="_blank" }

You are done with this activity. Before you close this browser window, note the *TestFlight* tab at the top of the page. You'll be using that tab after you complete the next two actions.

## Create Certificates
Expand Down
Binary file added docs/gh-actions/img/apple-vision-pro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gh-actions/img/lcg-app-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gh-actions/img/remove-apple-vision-pro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/operation/features/img/loop-g7-widgets.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 21 additions & 13 deletions docs/operation/features/widget.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,39 @@
## Loop 3
## Widgets

Loop 3 uses the new-style widget is in process. There are a lot of updates with widgets. With the advent of iOS 16, you can add widgets that show up on the lock screen without need to swipe to view. There is work in progress on this - please be patient.
The *Loop* app uses the new-style widgets. With the advent of iOS 16 and 17, you can add widgets that show up on the lock screen without need to swipe to view. But only some widgets can do this and there is very limited space for those lock screen widgets. You can add more widgets to the Today View, where you do need to swipe right from the Home View or Lock Screen.

## Old-Style Loop Widget

Loop 2.2.x and FreeAPS both include an old-style widget.
> The released code, `main` branch, version 3.2.x does not work with these widgets. The fix is in the `dev` branch and will be part of the version 3.4 release.
With older versions of iOS, the widget is available in the Today view of your iPhone. Swipe right on your iPhone home screen and your widgets will be available. The Loop widget may be at the bottom of your widget list. Scroll down to the bottom of the screen and press the `edit` button. That opens an "Add Widgets" screen. If you hold and drag the three horizontal lines on the Loop widget row, you can drag it up to the order you'd like it to appear on your widget list.

![img/widget_bar.png](img/widget_bar.png){width="600"}
{align="center"}
The example graphic below shows the *Loop* widget using the `dev` branch on the top row, with the *LoopCaregiver* widget next to a [Scriptable widget](https://niepi.org/2020/10/25/ios-14-nightscout-widget/){: target="_blank" } that is fed from my Nightscout site on the middle row. Below that is the Dexcom G7 widget next to a weather widget. This Today View requires a swipe right from the Lock Screen or the Home screen. The scriptable widget is also on my lock screen. The update rate for these widgets is similar to watch complications, some will grey out when stale. If they are greyed out, tap on them to go to the app directly.

With newer version of iOS, the old-style widgets cannot be moved to the top of the screen. The example graphic below shows the new-style Dexcom G6 widget above the old-style Loop 3 widget.
The Scriptable widget includes the time of the last update, 11:25 am, so is 11 minutes old at the current time of 11:36 am.

![widget on lock screen, dex above, loop below](../../loop-3/img/dex-loop-3-widget.svg){width="300"}
![widget on lock screen, dex above, loop below](img/loop-g7-widgets.jpg){width="300"}
{align="center"}

!!! info "New to Loop or never added a widget before"

* There is a difference in behavior between "new-style" Widgets and "old-style" Widgets
* New-Style Widgets: always appear at the top of your Today View, can be changed by long-pressing on one and then dragging around, or can be added with the &plus; button in edit mode
* Old-Style Widgets, like that available with Loop: use a different method to install
* Old-Style Widgets used a different method to install and should be removed from your screen
* Make sure your phone is unlocked, then swipe from the Home Screen to get to Today View
* You can't edit the screen if you start from a locked phone
* Start the Edit mode (where all of the icons are shaking), either by long-pressing on one of the new-style widgets, or by scrolling all the way to the bottom of Today View and pressing Edit.
* Scroll all the way to the bottom again to find and select the button labeled "Customize"
* Now you can configure (add, remove, rearrange) the "old-style" widgets for your screen.
* The Loop widget should appear in the list available there.

Experienced Looper who already had a widget should not need to modify anything to see it.

## Old-Style Loop Widget

Leave this here so you can see if you have an old-style widget.

With newer versions of iOS, the old-style widgets cannot be moved to the top of the screen. Please convert to the new-style widgets.

With older versions of iOS, the widget is available in the Today view of your iPhone. Swipe right on your iPhone home screen and your widgets will be available. The Loop widget may be at the bottom of your widget list. Scroll down to the bottom of the screen and press the `edit` button. That opens an "Add Widgets" screen. If you hold and drag the three horizontal lines on the Loop widget row, you can drag it up to the order you'd like it to appear on your widget list.

![img/widget_bar.png](img/widget_bar.png){width="600"}
{align="center"}

![widget on lock screen, dex above, loop below](../../loop-3/img/dex-loop-3-widget.svg){width="300"}
{align="center"}

0 comments on commit 4d6f5d0

Please sign in to comment.