contact trick #595

yurique · 2024-03-20T23:39:15Z

This PR introduces a new feature for those of us who are using an Apple Watch.

I don't know who to give credit for the original idea, I first heard of it in the xdripswift project: JohanDegraeve/xdripswift#481 and before that, it was implemented in OpenGlück: https://github.com/open-gluck#the-contact-trick

Here, though, the implementation and offered features are much more flexible and configurable:

Multiple contacts

We can configure multiple contacts, and then add add them all to the watch face - so we can see more information. One contact provides too little space to reliably display more than a single number and maybe an indicator. Multiple contacts help with this.

Layouts

There are two layouts that can be configured (this is debatable - we can leave just one, to make configuration simpler).

single - the main layout, where we can configure a main piece of information to display (it will take the central, largest part of the image), and - optionally - two secondary pieces: top and bottom (which will take less space and will be smaller)
split - this layout will display two pieces of information in two equally sized parts of the image - top and bottom

Rings

In addition to the above, we can configure up to two optional "large" rings that will be drawn around the image (similar to what Apple offers in its weather-related complications, or in the activity tracker complication)

A ring can be one of the following:

loop status - the well known green/yellow/red ring
iob - the fraction of current IOB relative to the max IOB
cob - the fraction of current COB relative to the max COB
iobcob - a "double" ring; left side - IOB, right side - COB

"Pieces"

Every area can be configured to display one of the following values:

current BG
eventual BG
latest delta
current trend
time of the latest BG measurement
time of the latest loop cycle
COB
IOB
ring - a small green/yellow/red ring

Extra customizations

In addition to the above, the following is configurable:

font name - either the system default or one of the fonts available on your phone
font size - the size for the primary area; secondary areas will be smaller; for all areas the font will be automatically reduced so that the displayed value fits in the designated "rectangle"
font tracking - how tight or wide the text should be
ring width - the width of the ring (in the percents of the image size)
ring gap - how much gap to leave between rings and/or the rest of the displayed elements
dark mode - this affects the color of the text, when dark mode is enabled - the text will be closed to white, when it's disabled, the text will be darker

Downsides / important to know

Unlike calendar events, the contact picture doesn't have an expiration time: so if something happens (iAPS crashes or something else) - the contact picture will stay there "forever" and will become misleading. Therefore I would recommend having one "contact" to display the time of the latest loop (that's what I'm doing myself).

Watch battery life? I haven't noticed any significant differences over the past couple of days. But I would guess constant contact updating might drain the battery a little bit faster than normal.

The white ring around the contact picture - unfortunately, that's part of the Apple's Contact complication design. It's always there - eating up precious screen estate - and no way to change it ¯_(ツ)_/¯

Screenshots

yurique · 2024-03-20T23:45:55Z

I'm going to add some details to the PR description (didn't have much time today). Also it still needs a pass or two of cleanup (for example, I suspect there are things that I put into the ContactTrickState that are not needed there, etc).

As of now, my biggest question would be this: am I doing things the right way in BaseContactTrickManager? (I copy-pasted the code from WatchManager initially, and then updated it).

Another thing is the list of things that can be useful on a watch face. I added a bunch, but I've been using iAPS for just a couple of days, so I'm just guessing. Also need to double-check that the "stale" state is rendered correctly - with -- instead of numbers, etc.

yurique · 2024-03-20T23:59:06Z

Another thing - I called the thing "Contact Trick" everywhere, which might be not the best name/label :)

Jon-b-m · 2024-03-22T12:36:57Z

I think the naming is good, it's descriptive and intuitive.
The most important element to display is really the current glucose, and the reason for why the contact trick is even needed.

After that I think green/orange/red loop. Perhaps even IOB as on option.

The loop and the IOB and the COB and all of the other loop status can all be retrieved from just the suggestion.

I therefore don't think we need all of the other stuff or imported modules here, as we don't need to enact anything (don't need to communicate with pump), just retrieve the last suggestion.

Jon-b-m · 2024-03-22T12:39:16Z

I suggest to start small, then we/you eventually can add stuff later.

yurique · 2024-03-22T12:48:10Z

Thank you for your thoughts on this, Jon!

I ended up setting up BG+trend+IOB on one contact and green/orange/red loop+last loop time on the second one - and it does seem to work well:

I suggest to start small, then we/you eventually can add stuff later.

Sounds good! I'll be removing things/imports (later today, hopefully).

I also need to tweak the rendering a little bit, some things end up too small under certain circumstances - too hard to see inside a small circle.

yurique · 2024-03-22T12:55:01Z

I think last loop time is important because the contact picture doesn't have an expiration time, unlike calendar events - so if something happens (iAPS crashes or something else) - the contact picture will stay there "forever" and will become misleading.

In fact, that's the biggest downside of this approach (and a risk), even though it hasn't happened a single time over the past two days of me running it. I think I should add some warning/description about this in the settings view.

yurique · 2024-03-23T00:12:24Z

@Jon-b-m I pushed some tweaks-and-cleanups - removed most of the imports and subscriptions in the manager, dropped part of the "state" and tweaked the rendering a little bit.

I will need to try it "live" to see if it looks good/is readable on the watch, but otherwise it all should be in a more or less decent state.

yurique · 2024-03-23T01:42:39Z

FreeAPS/Sources/Modules/Base/BaseProvider.swift

@@ -11,6 +11,7 @@ class BaseProvider: Provider, Injectable {
    @Injected() var deviceManager: DeviceDataManager!
    @Injected() var storage: FileStorage!
    @Injected() var bluetoothProvider: BluetoothStateManager!
+    @Injected() var contactTrickManager: ContactTrickManager!


not sure if I should have added this here - it's referenced from the ContactTrick.Provider when contacts are saved

yurique · 2024-03-23T01:43:08Z

FreeAPS/Sources/Services/ContactTrick/ContactTrickManager.swift

+    private func renderContacts() {
+        contacts.forEach { renderContact($0) }
+        workItem = DispatchWorkItem(block: {
+            print("in updateContact, no updates received for more than 5 minutes")


haven't looked yet into how to log things like this correctly

yurique · 2024-03-23T01:44:27Z

FreeAPS/Sources/Services/ContactTrick/ContactTrickManager.swift

+    SuggestionObserver,
+    SettingsObserver
+{
+    func glucoseDidUpdate(_: [BloodGlucose]) {


not sure if it's necessary to subscribe to glucose updates, or if subscribing to suggestions is enough

I guess BG can also be retrieved from the suggestion, instead of asking self.coreDataStorage.fetchGlucose(...)

but not trend or delta 🤔

yurique · 2024-03-23T01:46:43Z

FreeAPS/Sources/Services/ContactTrick/ContactTrickManager.swift

+    private var glucoseFormatter: NumberFormatter {
+        let formatter = NumberFormatter()
+        formatter.numberStyle = .decimal
+        formatter.locale = Locale(identifier: "en_US")


I added the locale explicitly here in order to make it print decimal separators as points (.) not commas (,), because It looked weird-ish on the complication, but it doesn't seem right to override the locale like this 🤔

I removed it.

yurique · 2024-03-23T01:57:03Z

FreeAPS/Sources/Modules/Settings/View/SettingsRootView.swift

@@ -61,6 +61,9 @@ extension Settings {
                    Text("Dynamic ISF").navigationLink(to: .dynamicISF, from: self)
                } header: { Text("Extra Features") }

+                Section {
+                    Text("Contact trick").navigationLink(to: .contactTrick, from: self)


right now the Contact Trick section is located in the main settings view, right above the Debug options - not sure what's the right place for it

yurique · 2024-03-23T02:24:46Z

FreeAPS/Sources/Services/ContactTrick/ContactTrickManager.swift

+        DispatchQueue.main.asyncAfter(deadline: .now() + 5 * 60 + 15, execute: workItem!)
+    }
+
+    private func renderContact(_ entry: ContactTrickEntry) {


these larger functions are straight copy-pastes from the WatchManager, it probably deserves a refactoring but I don't feel qualified for that :)

yurique · 2024-03-23T02:26:02Z

FreeAPS/Sources/Services/ContactTrick/ContactPicture.swift

+        fontTracking: FontTracking,
+        color: Color
+    ) {
+//        guard let context = UIGraphicsGetCurrentContext() else {


commented out - just some stuff to help debugging, to be deleted

yurique · 2024-03-23T02:28:40Z

FreeAPS/Sources/Services/ContactTrick/ContactTrickManager.swift

+        processQueue.async {
+            let readings = self.coreDataStorage.fetchGlucose(interval: DateFilter().twoHours)
+            let glucoseValues = self.glucoseText(readings)
+            self.state.glucose = glucoseValues.glucose


self.state doesn't have to be an instance field in this class - I could create a new one every time and pass it along into renderContacts() - but it was done like this in WatchManager so I kept it the same

yurique · 2024-03-23T02:37:56Z

I was observing something just now - the ring was green (in the app), last update was 3 min ago, but on the contact picture it was yellow (and 8 minutes ago) - I did "force" the refresh of the contact, so it seems like my code was getting a wrong time of the latest cycle somehow?

self.state.lastLoopDate = self.apsManager.lastLoopDate

(it got fixed with the next cycle, so I didn't have a chance to investigate more)

Jon-b-m · 2024-03-23T09:59:37Z

I was observing something just now - the ring was green (in the app), last update was 3 min ago, but on the contact picture it was yellow (and 8 minutes ago) - I did "force" the refresh of the contact, so it seems like my code was getting a wrong time of the latest cycle somehow?
self.state.lastLoopDate = self.apsManager.lastLoopDate
(it got fixed with the next cycle, so I didn't have a chance to investigate more)

You don’t need APSmanager for this. Everything can be retrieved from suggestion. suggestion.timestamp

Jon-b-m · 2024-03-23T10:09:06Z

I will take a closer look at this PR next week, I hope. As soon as I’m done with some other iAPS work. Thank you!

yurique · 2024-03-23T11:21:43Z

You don’t need APSmanager for this. Everything can be retrieved from suggestion. suggestion.timestamp

Aha! Very good! :)

yurique · 2024-03-23T11:35:51Z

Another thing I'm observing today - the contact pictures on the watch face are displaying the pictures from 5 hours ago, even though the contact manager was updating the contacts without problems. Tapping on the complication opens the contact - the picture is up-to-date there, as well as when looking at the contact on the phone. Not sure what has happened. Locking/unlocking the watch fixed it.

yurique · 2024-03-23T12:21:05Z

I had to restart the watch to fix it. The contact pictures on the watch were not updating, or updating but with a very long delay.

yurique · 2024-03-29T01:00:14Z

A quick update: I haven't seen any issues with contacts being out of date on the watch face since the last time I mentioned it here - works like a clock.
I suspect it might have been due to the bug I had in the code - there is a task that is scheduled to run 5+ minutes after the last update (if no other updates received), and somehow I managed to delete the line that would cancel the previously scheduled task when needed. So after a while, the contacts update would end up running a LOT.

…e using core data anyways

# Conflicts: # FreeAPS.xcodeproj/project.pbxproj

Jon-b-m · 2024-05-07T22:19:50Z

Now merged into dev via another branch, as I had to make some small edits after testing. Thank you @yurique

yurique added 5 commits March 21, 2024 00:25

contact trick wip

606c132

contact trick continued

9a2a405

contact trick fix crash in settings

de5447f

tweaks

bb44a44

empty settings/contact_trick.json

b1e268b

yurique mentioned this pull request Mar 20, 2024

contact trick #594

Closed

some tweaks and cleanups

74443b9

yurique marked this pull request as ready for review March 23, 2024 00:23

yurique commented Mar 23, 2024

View reviewed changes

tweaks

7d515c8

yurique commented Mar 23, 2024

View reviewed changes

yurique added 2 commits March 23, 2024 03:06

un-mess up project.pbxproj

0f0075d

Merge branch 'dev' into feature/contact-trick-dev

d4c6b7b

yurique commented Mar 23, 2024

View reviewed changes

no APSManager, more detailed error logging when updating contacts

89744f3

yurique mentioned this pull request Mar 24, 2024

adding the "contact trick" JohanDegraeve/xdripswift#505

Merged

yurique added 2 commits March 27, 2024 17:56

refactoring, add missing scheduled task cancellation

8712eff

Merge branch 'dev' into feature/contact-trick-dev

6cf0c45

yurique and others added 9 commits April 12, 2024 17:17

refactoring, tweaks to image rendering

255482d

revert to using glucose from core data (not suggestion), since we'r…

47fada4

…e using core data anyways

Merge branch 'dev' into feature/contact-trick-dev

5ca9224

# Conflicts: # FreeAPS.xcodeproj/project.pbxproj

Merge branch 'dev' into feature/contact-trick-dev

cacee4f

Merge branch 'dev' into feature/contact-trick-dev

942e8e3

Merge branch 'dev' into feature/contact-trick-dev

baf9119

remove the inner ring

269a69d

Merge branch 'dev' into feature/contact-trick-dev

a43d351

Merge branch 'dev' into feature/contact-trick-dev

275b20a

Jon-b-m closed this May 7, 2024

flyingpie101 mentioned this pull request May 8, 2024

Feature Request: Using the Apple Contacts Watch complication to Display BG loopandlearn/LoopFollow#293

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

contact trick #595

contact trick #595

yurique commented Mar 20, 2024 •

edited

Loading

yurique commented Mar 20, 2024 •

edited

Loading

yurique commented Mar 20, 2024

Jon-b-m commented Mar 22, 2024

Jon-b-m commented Mar 22, 2024

yurique commented Mar 22, 2024 •

edited

Loading

yurique commented Mar 22, 2024

yurique commented Mar 23, 2024 •

edited

Loading

yurique Mar 23, 2024

yurique Mar 23, 2024 •

edited

Loading

yurique Mar 23, 2024

yurique Mar 23, 2024

yurique Mar 23, 2024

yurique Mar 23, 2024

yurique Apr 12, 2024

yurique Mar 23, 2024

yurique Mar 23, 2024 •

edited

Loading

yurique Mar 23, 2024

yurique Mar 23, 2024

yurique commented Mar 23, 2024 •

edited

Loading

Jon-b-m commented Mar 23, 2024

Jon-b-m commented Mar 23, 2024

yurique commented Mar 23, 2024

yurique commented Mar 23, 2024

yurique commented Mar 23, 2024

yurique commented Mar 29, 2024 •

edited

Loading

Jon-b-m commented May 7, 2024

contact trick #595

contact trick #595

Conversation

yurique commented Mar 20, 2024 • edited Loading

Multiple contacts

Layouts

Rings

"Pieces"

Extra customizations

Downsides / important to know

yurique commented Mar 20, 2024 • edited Loading

yurique commented Mar 20, 2024

Jon-b-m commented Mar 22, 2024

Jon-b-m commented Mar 22, 2024

yurique commented Mar 22, 2024 • edited Loading

yurique commented Mar 22, 2024

yurique commented Mar 23, 2024 • edited Loading

Choose a reason for hiding this comment

yurique Mar 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yurique Mar 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yurique commented Mar 23, 2024 • edited Loading

Jon-b-m commented Mar 23, 2024

Jon-b-m commented Mar 23, 2024

yurique commented Mar 23, 2024

yurique commented Mar 23, 2024

yurique commented Mar 23, 2024

yurique commented Mar 29, 2024 • edited Loading

Jon-b-m commented May 7, 2024

yurique commented Mar 20, 2024 •

edited

Loading

yurique commented Mar 20, 2024 •

edited

Loading

yurique commented Mar 22, 2024 •

edited

Loading

yurique commented Mar 23, 2024 •

edited

Loading

yurique Mar 23, 2024 •

edited

Loading

yurique Mar 23, 2024 •

edited

Loading

yurique commented Mar 23, 2024 •

edited

Loading

yurique commented Mar 29, 2024 •

edited

Loading