wheellog/companion.garmin

A WheelLog companion for Garmin smartwatches

⌚️ Companion.Garmin

This app has reached a stale point. Now it will not be updated by the dev. If you want to continue development - contact me on Telegram.

A WheelLog companion for Garmin smartwatches

This app is a rebuild from ground-up of an original Garmin app. I made this app to be with better UI, alarms working, and full support of new watches and their features.

Download from Garmin ConnectIQ Store

🔤 Important

License: GPLv3

Changelog: here

❤️ Support

If you feel like you want to support me, and buy me a coffee, there is a place for that! Or using Patreon: https://www.patreon.com/ggoraa

🏞 Screenshots

🛠 Development/Building

I use a build system called kumitateru, and here is a list of commands you can use:

./kumitateru build - assembles a release .iq file

./kumitateru build --target <device> - builds for a specific device

./kumitateru run --target <device> - runs the app in a simulator

🌍 Translations

You can contribute to translations here: https://poeditor.com/join/project?hash=WUAV6h3bxB

companion.garmin's Issues

Add option for setting the theme to white(white background and black text)

Add sounds on some actions, like connecting, alarm trigger, wheel battery low, and so on

I just need to add Attention.playTone(TONE_SUCCESS); to mailHandler

Speed numbers, such as "0.2", will be drawn(on speed dial) and displayed(on speed number) as "2", omitting "0." part

It's the issue with conversion from Number to Float and in reverse. I should track down where this issue lies

And, also a solution: we need to return from the app server endpoint the speed number, but in String format. So, it will be displayed as a String, ommitting issues such as displaying "0.20000" instead of just "0.2", and for speed dial this string will be converted to float, and then we will get our result: dial data will be more accurate, and we will have a speed number like "7.4" before 10 km/h (or for you fellow Americans mph)

Add an option to display PWM data on speed arc(leaving speed on speed number)

Create centralised place for runtime cache

It will be in AppSettings, which will be renamed to AppStorage

Place the page indicator in details view to the right

Self-explanatory

Make a system for retrieving a port number from the server at any time

This can be used in situations such as when the server is started before the companion is opened, or user had exited the companion and the opened it again. On every startup the companion can send a request for the port number, but if nothing returned, then the companion will wait until a port number is ready. That's how i see it

Add options for home screen arcs display style

There can be two types - like now, with background of arcs being the same size as the foreground, or like in old companion, with background arcs being very thin compared to foreground arcs

Add option to leave backlight enabled when the app is opened

For this i need to use the Attention module from Toybox to continuously set the backlight to enabled state. But this won't be available for watches with backlight burn-in protection

Move the project structure to kumitateru

Basically kumitateru is a build system for CIQ projects, which simplifies creating and managing them.
When it will be ready for use, I will migrate this project to it.

Screen change animation when entering theme chooser is wrong

Move the page indicator back to the left

Bc the system version of an indicator is also on the left, so it will look more natutal

Implement horn system

It will just use onStart() function to then execute a function in webServerApiInstance to send an action execution request to the phone

Arcs on the home screen do not update when data has changed

This is the issue with some arc parameters. I thought that giving variable name through XML will have a reference to that variable, but no, it is just getting data from it and forgetting about it. So what we need, is a .setValues() function for ArcRenderer class, and calling it from the onUpdate() function. This will fix the issue

[1.2.0] App dies instantly when enabled showing pwm instead of speed

Change places for label and value for details

Like in Wheellog/Wheellog.Android#193

Screen scroll (not sure it is an issue or a feature)

Compared to the v2.3 the screen does not scroll into the first page after the last one, and also does not scroll to the last page if scrolling up from the first page.

Add support for American measurement system (miles, Fahrenheit)

When you first enter the details view, it will show null for some time until updating

I just need to gather details data after connection, so there will be no null displayed. That's how I want to fix dis issue

Make CI work

So I can easily download & install the SDK, generate a dev key, and run monkeyc with ease. But the issue is: I can't use monkeyc, because I also need device files for monkeyc to reference to and compile the app for that device. And also one more issue: I literately can't do it. I was trying to find where da hec this folder with ConnectIQ SDK lies, so I can't put there that folder with device files. When I will figure it out, I will add CI back. For now - deleting

Add menu wrapping

when you reach the last screen, and click down, you get "wrapped" back to the first screen

Bottom text

If select distance shows travel time.
If select travel time shows travel time.

When you spam horn button, app will crash

Fix is also easy, we need to migrate from server action execution to normal BLE request action execution. But the server endpoint to horn trigger will still be there, bc why not, it wont break anything

Move communication to full non-normal-BLE style

So this is how i want to do it:
Add a special picker to the menu, where you need to input the port number, which WheelLog.Android will show. Then they will easily communicate :D

Vibrate and beep every 15 seconds when connection with the app/wheel was lost

Make the speed/battery/temperature arcs look like "segmented", just like in WheelLog.Android

This can be easily implemented. The ArcRenderer class, which is used to render arcs on the Home Screen, will also generate lines, that will go from the center of the arc to the borders. I see the implementation like this

Add a page indicator to details view

It will be on the edge of the screen, and segments will fill an entire left edge of the screen

Add options to change when main arc will be colored in yellow or red colors depending on PWM

I mean, we can add an option to change these values, so you can set yellow from 80% PWM, and red from 90% if you are speedy as f*ck, and 60% yellow and 80% red if you are a casual rider. That's how I see it

[yay first ever bug] In Russian language text below speed text is just squares

if it is squares, then there are no glyphs in the font available to render them. The easiest solution is to use the system font, so ill use it

After entering third page in details view app crashes

Can be fixed easily: we just add a special screen, which will block the view and just show "Waiting for WheelLog to connect...", and that's basically it. It just won't allow to get to the third screen before connection.

If you re-enable watch connection while the companion is in "connected" state(waiting screen is off), companion just exits

The fix will be easy, we just need to place an if statement for "if was connected before, do not pop a view from a stack"

If you rush to the third page in details right after you first entered details, app crashes

This issue is actually related to #5, because the cause and the result is the same. Fix is very easy, I just need to initialise the rideTime variable in WheelData.

FAILURE_DURING_TRANSFER. oh fuck, Garmin didn't fix dis

Well, FAILURE_DURING_TRANSFER happens just every time android phone starts to send messages to the watch. But for the record, it does send some messages, but when the phone turns off( I mean, goes to sleep mode) it just stops. And you can't make any sends again. You just need to completely stop Garmin Connect Mobile to make it work again. Fuck, we need to do a big workaround: a web server. A local web server on the phone side and doing requests to that web server from the watch side. Btw, I will still use normal communications for sending data to the phone, for e.g. to trigger horn.

Rant Alert

I just hate Garmin for not fixing THIS 4 YEAR OLD BUG ARE YOU KIDDING ME

Rework the logic for showing & hiding the Waiting for connection... screen

I want to move the logic to the very start of the app, even before home view is initiated. And for going back to home view you will just call WatchUi.switchToView and that's it

Can't build for vivoactive 4 and 4s

We just need to fix icon resolution

Show a message in bottom subtitle for some actions, like connect and reconnect

Make fonts the same as in WheelLog

I just need to port that font to FNT format, and we are good to go

Add options to completely customise Home Screen

This applies to main, left, and right arcs, and bottom subtitle(when wheel connected)

Implement alarms system

There will be a special timer, which will check every 200 ms the alarms variable in WheelData, and then it will vibrate&beep

Update an menu item for choosing what to display on the main arc

just replace the confirmation with a custom menu

Some strings are that big that they are getting cut

I need to retranslate these, so they will be smaller

Allow build for fenix chronos

We just need to adapt icon size for this device

Add an option to change data update speed

By default this app uses 400 ms intervals between updates. But this can be an issue, when you connect your intercom, wheel, smart speaker, and a watch, all at the same time. Bluetooth traffic will be flooded, and a ton of requests will be lost, so the app will disconnect. So I can present a setting to change data transfer speed: fast, medium, and slow. Fast is, again, 400 ms, medium is 1s, slow is 1.5s. This should fix the issue.

"Waiting for connection with WheelLog..." screen reappears when you go to details and then go back to home screen

Will be very easy to fix