Skip to content

Commit 2a007ad

Browse files
marionbarkermarionbarker
authored
Merge pull request #15 from loopandlearn/working-docs
Reorder the QR code instructions
2 parents 0f6aa38 + abefad2 commit 2a007ad

5 files changed

Lines changed: 140 additions & 83 deletions

File tree

docs/setup/img/export-settings.png renamed to docs/remote/img/export-settings.png

File renamed without changes.

docs/setup/img/import-from-qr-code.PNG renamed to docs/remote/img/import-from-qr-code.png

File renamed without changes.

docs/setup/img/import-settings.png renamed to docs/remote/img/import-settings.png

File renamed without changes.

‎docs/remote/remote-control-overview.md‎

Lines changed: 127 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,6 @@ The *Loop* app and the open beta version of the *Trio* app (0.5.x or newer) supp
1111

1212
* [Browser Build Update for LoopFollow v4.0](../build/build-options.md#browser-build-update-for-loopfollow-v40){: target="_blank" }
1313

14-
!!! tip "`Loop` Remote Control with *LoopFollow* 3.2"
15-
With the release of *LoopFollow* 3.2, the remote control features accessible from LoopFollow match those available from the *LoopCaregiver* app.
16-
17-
You must update to *LoopFollow* 3.2 or newer and configure remote settings in the *LoopFollow* app to use these features.
18-
1914
!!! important "Breaking Change: Trio Remote Command Users"
2015
Trio users must have matching code for LoopFollow and Trio.
2116

@@ -28,47 +23,14 @@ The *Loop* app and the open beta version of the *Trio* app (0.5.x or newer) supp
2823

2924
* [Browser Build Update for LoopFollow v4.0](../build/build-options.md#browser-build-update-for-loopfollow-v40){: target="_blank" }
3025

31-
32-
### Changes for *LoopFollow* Remote Control of the *Loop* App
33-
34-
* With *LoopFollow* 3.2 and newer
35-
* *Loop* remote commands from *LoopFollow* include Meal, Bolus and Override control
36-
* *LoopFollow* no longer requires the *Nightscout* site be configured with the APNS credentials
37-
* Read access for the *Nightscout* URL is sufficient
38-
* With *LoopFollow* 3.1 and older
39-
* *Loop* remote commands were limited to Overrides, required the *Nightscout* site be configured with the APNS credentials and required a token with `careportal` access
40-
41-
> With *Trio* 0.2.x, *LoopFollow* only supports temp targets and requires a token with `careportal` access. Once updated to *Trio* 0.5.x or newer, the full Trio Remote Control options are available.
42-
43-
44-
### *LoopFollow* Remote Control
45-
46-
* *LoopFollow* Remote Control sends messages to the loopers phone using APNS
47-
* **Loop**: Requires *LoopFollow* 3.2 or newer
48-
* **Trio**: Requires matched code versions:
49-
* Trio 0.6 (or newer) requires LoopFollow 4.0 (or newer)
50-
* Trio 0.5.1.28 (or older) requires LoopFollow 3.2.11 (or older)
51-
* Commands go via APNS to the *Loop*/*Trio* phone
52-
* An immediate success or failure for **sending** the message to APNS is received
53-
* There still could be a communication failure between APNS and the looper's phone or the command could be rejected by the looper's app
54-
* **Trio v0.6 or newer** an APNS response is returned to *LoopFollow*
55-
* A success or failure message is pushed back to the *LoopFollow* phone from the *Trio* phone when a remote command is received and handled
56-
* The results show up in *Nightscout* after being uploaded from the *Loop*/*Trio* phone
57-
* The results are plotted or displayed in *LoopFollow* after being downloaded from the *Nightscout* URL as a new treatment
58-
* APNS keys do not need to be embedded in the *Nightscout* site
59-
* This simplifies configuration of *Nightscout*, especially for those who use a paid service for *Nightscout*
60-
* For those following a looper using *Trio* 0.2.x, the only option for the Remote Setting is *Nightscout*, which uses Careportal
61-
* With this selection, the *LoopFollow* phone sends commands to *Nightscout*, which then sends commands to the *Trio* phone
62-
* For that reason, the *Nightscout* display will be updated first
63-
* If there is an issue sending the careportal request from *Nightscout*, it might not make it to the *Trio* phone
64-
* After the next download from *Nightscout*, the display will update if commands do or do not make it through the full round trip
65-
6626
- - -
6727

6828
## *LoopFollow* Remote Options
6929

7030
> With the release of *LoopFollow* 3.2, remote options for the *Loop* app are updated.
7131
32+
> With the release of *LoopFollow* 4.0, you can [share remote control configuration](#export-remote-settings-with-qr-code) using a QR code.
33+
7234
The graphic below shows the Remote Settings screen for *LoopFollow*. You must first enter a *Nightscout* URL before any remote options are offered and then only the option suitable for that *Nightscout* site can be selected.
7335

7436
* When following someone running Loop, the options are None or [Loop Remote Control](remote-control-loop.md){: target="_blank" }
@@ -79,15 +41,88 @@ The graphic below shows the Remote Settings screen for *LoopFollow*. You must fi
7941
![LoopFollow remote options - all types](img/lf-remote-options_3.2.svg){width="600"}
8042
{align="center"}
8143

82-
83-
8444
### Critical Configuration Information
8545

86-
If you plan to use *LoopFollow* Remote Control with a looper using the *Loop* app version 3.x or the *Trio* app version 0.5 or newer, continue to the next section for instructions to find or create your keys [*Apple* Push Notifications System (APNS)](#apple-push-notifications-system-apns).
46+
If you plan to use *LoopFollow* Remote Control with a looper using the *Loop* app version 3.x or the *Trio* app version 0.5 or newer, and you don't have your APNS key information recorded or configured, see the instructions in [*Apple* Push Notifications System (APNS)](#apple-push-notifications-system-apns).
8747

8848
If your looper is using *Trio* 0.2.x, use this link for configuration:
8949

90-
* [*Nightscout* Remote Control](remote-control-nightscout.md)
50+
* [*Nightscout* Remote Control](remote-control-nightscout.md){: target="_blank" }
51+
52+
- - -
53+
54+
## Loop Follow Remote Control Configuration
55+
56+
If you are configuring Remote Control for the first time, follow the appropriate directions for either Loop or Trio:
57+
58+
* [Configure Remote Control for Loop](remote-control-loop.md#configure-loopfollow-for-remote-control){: target="_blank" }
59+
* [Configure Remote Control for Trio](remote-control-trio.md#configure-loopfollow-for-remote-control){: target="_blank" }
60+
61+
If you are configuring a second phone to use remote control, you can transfer the settings from one phone to another.
62+
63+
### Export Remote Settings with QR Code
64+
65+
To share your remote settings with another device, follow the directions in this section to generate the QR code. Then follow the directions in [Import from QR Code](#import-from-qr-code) to read the code on the other device.
66+
67+
!!! important "QR Code Contains Secret Information"
68+
Never share your QR code as a screenshot online or send it to someone that is not supposed to have access to remote capabilities for your looper.
69+
70+
If in doubt revoke access to the key at [https://developer.apple.com/account/resources/authkeys/list](https://developer.apple.com/account/resources/authkeys/list) and generate a new one.
71+
72+
To show the QR Code, go into Remote settings on the phone that is already configured for remote control. Click the button Export Remote Settings as QR Code and the QR code will show on screen.
73+
74+
> This process works for both Loop Remote Control and for Trio Remote Control, with the generated QR Code specific to the app that is being followed.
75+
76+
![Export settings](img/export-settings.png){width="600"}
77+
{align="center"}
78+
79+
### Import from QR Code
80+
81+
!!! tip "Setting up a Second Device for Remote Control"
82+
With version 4.0 and newer, you can set up a second device with all the Nightscout and Remote Control Settings by scanning a QR code from a LoopFollow device that is already configured.
83+
84+
Do **not** use this option if the person using the second device only needs to monitor with LoopFollow.
85+
86+
**If a follower only needs to monitor and get alarms**
87+
88+
* Do **not** use the QR code
89+
* Enter the Nightscout URL with token as described in [Add Nightscout](../setup/lf-setup.md#add-nightscout){: target="_blank" }
90+
91+
92+
You can scan a QR code from a LoopFollow device that is already configured to get the settings for Nightscout URL, Token and all remote settings. This process works for both Loop and for Trio, with the QR Code specific to the app that is being followed.
93+
94+
> **Only do this for another caregiver who needs the same Nightscout and remote control capabilities.**
95+
96+
There are different directions depending on whether the target phone already has the Nightscout URL entered or not:
97+
98+
* [Nightscout URL Configured](#nightscout-url-configured)
99+
* [Nightscout URL Not Configured](#nightscout-url-not-configured)
100+
101+
#### Nightscout URL Configured
102+
103+
With a device that already has the Nightscout address set, go to the Settings: Remote Control screen. you must select "None" to reveal the "Import Remote Settings from QR Code" button.
104+
105+
Clicking that will take you to the remote screen where you can use the button Import Remote Settings from QR Code.
106+
107+
Use the Camera to scan a QR Code from the other phone.
108+
109+
This will import the Nightscout URL, token and remote settings.
110+
111+
![Import remote settings](img/import-from-qr-code.png){width="300"}
112+
{align="center"}
113+
114+
#### Nightscout URL Not Configured
115+
116+
With a device that does not have a Nightscout address set, there will be a button in Settings named Import Settings.
117+
118+
![Import settings](img/import-settings.png){width="600"}
119+
{align="center"}
120+
121+
Clicking that will take you to the remote screen where you can use the button Import Remote Settings from QR Code.
122+
123+
Use the Camera to scan a QR Code from the other phone.
124+
125+
This will import the Nightscout URL, token and remote settings.
91126

92127
- - -
93128

@@ -188,3 +223,51 @@ Depending on the selection you made, continue to one of these pages for more inf
188223
* [*Loop* Remote Control](remote-control-loop.md)
189224
* [*Trio* Remote Control](remote-control-trio.md)
190225
* [*Nightscout* Remote Control](remote-control-nightscout.md) (`Trio 0.2.x only`)
226+
227+
## Background Information
228+
229+
There has been a lot of recent changes to remote control with LoopFollow.
230+
231+
The historical notes are in this section.
232+
233+
234+
!!! tip "`Loop` Remote Control with *LoopFollow* 3.2"
235+
With the release of *LoopFollow* 3.2, the remote control features accessible from LoopFollow match those available from the *LoopCaregiver* app.
236+
237+
You must update to *LoopFollow* 3.2 or newer and configure remote settings in the *LoopFollow* app to use these features.
238+
239+
240+
### Changes for *LoopFollow* Remote Control of the *Loop* App
241+
242+
* With *LoopFollow* 3.2 and newer
243+
* *Loop* remote commands from *LoopFollow* include Meal, Bolus and Override control
244+
* *LoopFollow* no longer requires the *Nightscout* site be configured with the APNS credentials
245+
* Read access for the *Nightscout* URL is sufficient
246+
* With *LoopFollow* 3.1 and older
247+
* *Loop* remote commands were limited to Overrides, required the *Nightscout* site be configured with the APNS credentials and required a token with `careportal` access
248+
249+
> With *Trio* 0.2.x, *LoopFollow* only supports temp targets and requires a token with `careportal` access. Once updated to *Trio* 0.5.x or newer, the full Trio Remote Control options are available.
250+
251+
252+
### *LoopFollow* Remote Control
253+
254+
* *LoopFollow* Remote Control sends messages to the loopers phone using APNS
255+
* **Loop**: Requires *LoopFollow* 3.2 or newer
256+
* **Trio**: Requires matched code versions:
257+
* Trio 0.6 (or newer) requires LoopFollow 4.0 (or newer)
258+
* Trio 0.5.1.28 (or older) requires LoopFollow 3.2.11 (or older)
259+
* Commands go via APNS to the *Loop*/*Trio* phone
260+
* An immediate success or failure for **sending** the message to APNS is received
261+
* There still could be a communication failure between APNS and the looper's phone or the command could be rejected by the looper's app
262+
* **Trio v0.6 or newer** an APNS response is returned to *LoopFollow*
263+
* A success or failure message is pushed back to the *LoopFollow* phone from the *Trio* phone when a remote command is received and handled
264+
* The results show up in *Nightscout* after being uploaded from the *Loop*/*Trio* phone
265+
* The results are plotted or displayed in *LoopFollow* after being downloaded from the *Nightscout* URL as a new treatment
266+
* APNS keys do not need to be embedded in the *Nightscout* site
267+
* This simplifies configuration of *Nightscout*, especially for those who use a paid service for *Nightscout*
268+
* For those following a looper using *Trio* 0.2.x, the only option for the Remote Setting is *Nightscout*, which uses Careportal
269+
* With this selection, the *LoopFollow* phone sends commands to *Nightscout*, which then sends commands to the *Trio* phone
270+
* For that reason, the *Nightscout* display will be updated first
271+
* If there is an issue sending the careportal request from *Nightscout*, it might not make it to the *Trio* phone
272+
* After the next download from *Nightscout*, the display will update if commands do or do not make it through the full round trip
273+

‎docs/setup/lf-setup.md‎

Lines changed: 13 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,6 @@ Tap on the Gear/Settings Icon (⚙️) in the tab bar to get to the Settings scr
3030

3131
- - -
3232

33-
!!! note "Setting up a second device"
34-
With version 4.0 and newer, You can set up a second device by scanning a QR code from another LoopFollow user. See this section [Import from QR Code](#import-from-qr-code).
35-
36-
- - -
37-
3833
### Settings Screen
3934

4035
The full lists of Settings is shown in the composite graphic below.
@@ -58,16 +53,21 @@ You provide *LoopFollow* with information about the person you are following. At
5853

5954
The graphic below shows the display when you tap on the *Nightscout* Settings row. For more information about tokens, keep reading the details below the graphic.
6055

61-
To simplify setup, you can copy your *Nightscout* URL (including the token) from the [Admin Tools in *Nightscout*](https://nightscout.github.io/nightscout/admin_tools/#subjects-and-roles). When pasted into *LoopFollow* URL row, the app will automatically extract and fill in both the URL and token.
56+
!!! tip "Setting up a Second Device for Remote Control"
57+
With version 4.0 and newer, you can set up a second device with all the Nightscout and Remote Control Settings by scanning a QR code from a LoopFollow device that is already configured.
58+
59+
* See this section [Import from QR Code](../remote/remote-control-overview.md#import-from-qr-code){: target="_blank" }.
60+
61+
Do **not** use that option if the person using the second device only needs to monitor with LoopFollow.
62+
63+
When adding the Nightscout information to monitor, you can copy your *Nightscout* URL (including the token) from the [Admin Tools in *Nightscout*](https://nightscout.github.io/nightscout/admin_tools/#subjects-and-roles). When pasted into *LoopFollow* URL row, the app will automatically extract and fill in both the URL and token.
6264

6365
![enter nightscout credentials](img/lf-data-source-ns.svg){width="300"}
6466
{align="center"}
6567

6668
!!! tip "*Nightscout* Access"
6769
It is possible to have your *Nightscout* site readable by the world, in which case you do not need to add a token. If you choose to do that, just ignore references to entering the token. The status will show up as `OK (Read)`.
6870

69-
The only exception is if you choose to use *LoopFollow* [*Nightscout* Remote Control](../remote/remote-control-nightscout.md){: target="_blank" }. In that case, you must have a token with careportal access.
70-
7171
For more information about tokens with *Nightscout*, refer to [Admin Tools in *Nightscout*](https://nightscout.github.io/nightscout/admin_tools/#subjects-and-roles).
7272

7373
The type of token depends on the type of remote control desired.
@@ -83,9 +83,9 @@ When you enter your credentials, *LoopFollow* tries to reach the site and then p
8383
| *LoopFollow* Remote Type | Minimum Token Access| *LoopFollow* Status |
8484
|:--|:--|:--|
8585
| **None** | Read | OK (Read) |
86-
| ***Nightscout*** | Read & Careportal | OK (Read & Write) |
8786
| ***Loop* Remote Control**| Read | OK (Read) |
8887
| ***Trio* Remote Control**| Read | OK (Read) |
88+
| ***Nightscout***<br>Trio 0.2 or older | Read & Careportal | OK (Read & Write) |
8989

9090
#### Add *Dexcom*
9191

@@ -134,25 +134,6 @@ Once you’ve configured your settings, your Main screen will look as beautiful
134134

135135
🚧 Documentation Under Construction 🚧
136136

137-
#### Import from QR Code
138-
139-
When setting up LoopFollow for another caregiver that will use the same nightscout and remote control capabilities, you can scan a QR code from the other phone to get the settings for Nightscout URL, Token and all remote settings.
140-
141-
If you already setup Nightscout and want to share the remote commands capabilities, read this section [Export Remote Settings with QR Code](#export-remote-settings-with-qr-code).
142-
143-
With a device that does not have a Nightscout address set, there will be a button in Settings named Import Settings.
144-
145-
![Import settings](img/import-settings.png){width="300"}
146-
{align="center"}
147-
148-
Clicking that will take you to the remote screen where you can use the button Import Remote Settings from QR Code.
149-
150-
Use the Camera to scan a QR Code from the other phone.
151-
152-
This will populate the Nightscout URL, token and remote settings.
153-
154-
155-
156137
### Background Refresh Settings
157138

158139
🚧 Documentation Under Construction 🚧
@@ -189,19 +170,12 @@ See [Toolbar Tab Settings](lf-features.md#toolbar-tab-customization){: target="_
189170

190171
### Remote Settings
191172

192-
🚧 Documentation Under Construction 🚧
193-
194-
#### Export Remote Settings with QR Code
195-
196-
To share your remote settings with another device, see the [Import from QR Code](#import-from-qr-code) section.
173+
Detailed instructions for configuring a phone for remote control are found on the [Remote Control Overview](../remote/remote-control-overview.md){: target="_blank" } page.
197174

198-
To show the QR Code, go into Remote settings and click the button Export Remote Settings as QR Code and the QR code will show on screen
199-
200-
![Export settings](img/export-settings.png){width="300"}
201-
{align="center"}
175+
If you are configuring a second device and already have one device configured for remote control, be sure to review:
202176

203-
!!! important "QR Code Contains Secret Information"
204-
Never share your QR code as a screenshot online or send it to someone that is not supposed to have access to remote capabilities for your looper. If in doubt revoke access to the key at [https://developer.apple.com/account/resources/authkeys/list](https://developer.apple.com/account/resources/authkeys/list)
177+
* [Export Remote Settings with QR Code](../remote/remote-control-overview.md#export-remote-settings-with-qr-code){: target="_blank" }
178+
* [Import from QR Code](../remote/remote-control-overview.md#import-from-qr-code){: target="_blank" }
205179

206180
### Alarms
207181

0 commit comments

Comments
 (0)