Vin-HkE

KO | EN

gitlite — search

#hacktoberfest #react #go #machine-learning #deep-learning #docker #macos #awesome #cli #kubernetes #mcp #ios #openai #open-source

(★ 55)

Custom data fields with colors, customizable alerts, instant messages, fat consumption estimations and more...

Vin-HkE 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> [!WARNING]  
> This is a beta version. Please, be patient if find any bug and report it.

# Vinapp HkE

Vin HkE is an extension implementation for Hammerhead Karroo based on Vin's CORE and the new Hammerhead SDK for its GPS devices. Tested in Hammerhead K2 and K3 devices. Vin is an Android training and planning app for cycling with more than 4 years of life and a 5-star rating on Google Play.

## HkE Installation

Install from hammerhead karoo extensios app store.

After install you can see the Vin HkE main menu.

# HkE app Navigation

### Main menu

Main menu provides access to user settings and configuration of basic functionalities of Vin HkE.

### User profile configuration

User profile | Power threshold data | Hear rate threshold data | Nutritional data
------------- | ------------- | ------------- | -------------
![](https://raw.githubusercontent.com/maduwatas/Vin-HkE/main/images/userprofileEn.png) | ![](https://raw.githubusercontent.com/maduwatas/Vin-HkE/main/images/power.png) | ![](https://raw.githubusercontent.com/maduwatas/Vin-HkE/main/images/hr.png) | ![](https://raw.githubusercontent.com/maduwatas/Vin-HkE/main/images/nutricion.png)

Some data are imported from the karoo user profile. This data is not editable, all other data can be edited within the supported values. From user profile you can edit some data and pushing Threshold button navigate to power threshold or hear rate threshold configuration page. The user's gender, weight, height and threshold data are necessary to adjust the calculations of calories burned in the activity. The nutritional data provides information on these calculations for different intensities.

### Preferences

#### Data fieds

#### Hke field titles

Some widgets in HkE have color background. You can configure if the background fill the title, and title must be rendered each time with the field, or not. Standard titles could save a little of your battery.

#### Battery saving options

##### Progress bars
Some HkE widgets include beautiful and useful progress bars to represent data. Drawing these views on the screen consumes a small amount of battery, which you can save by choosing to hide them.

##### Sensor data capture
When you start a ride, HkE starts its calculations in the background to obtain real-time data of calories, averages, normalized data... this data is required for some HkE widgets such as power, heart rate or calories. Other functionalities such as alerts, power balance or Pit board do not need these calculations. If you are using a profile without HkE widgets with the background process required, you can disable it to save a small amount of battery. If you start a ride without starting HkE background calculations and later decide choosing an HkE profile some data could not work, due background calculations would not running.
        </td>
    </tr>
</table>

#### Training options

##### CTL
Your chronic training load is a measure of your fitness that is used as a calculation parameter for HkE algorithms. If you don't know this value, you can get it from the statistics functionality of Vinapp or other training platforms. If you install vinapp and synchronize your training history CTL will be updated in a transparent way from Vinapp to HkE when starting your karoo.

##### Power smoothness
Choose the time interval, in seconds, to measure and average your power before show it in HkE widgets

##### Power average
Choose if your power average must be calculated taking account zeros or not.

##### Training system
Choose Heart rate based or Power based workouts.

##### Zone color chart
Choose the zone color chart that you prefer between karoo style or zwift.

##### Climber color chart
Choose the zone color chart you prefer between karoo style, HkE proposal, to apply in Slope HkE colored field. HkE divide zones in 0-3 (blue), 3-6 (green), 6-9 (yellow), 9-12 (brown), 12-15 (orange), 15-20 (red), > 20 purple. Select NO to fixed transparent background.
        </td>
    </tr>
</table>

### Custom fields

<img src="./images/customfields1.png" width="200" /> |

HkE allows two user fully customizable fields from HkE data fields, Grayson field and Vanesa field. Since 1.2.8 release there are two fields more, Lucy and Leonardo.

#### Layout selector

For each of them, you must select a layout with 3, 4, 5 or 6 fields and within each layout, a data field for each socket. To attach your custom fields in a Karol profile you must choose the Grayson field and/or the Vanesa field.
Tab in a box to select any available field data. Long press in a box to select a custom background color for his field.

#### Example of use

Add your customs fields, Vanesa and or Grayson, to any karoo profile just like others standard or HkE fields.

Expand the space available for your map without giving up carrying up to 8 visible data fields.

Different profiles are just to group fields together and all render the same way.

if you are a K2 user and put too many custom fields in a ride profile your debice could be freeze. To skip it select a slow refresh rate for fields group that not need instant measuring.

You can select if your customizable field groups shows titles for individual field or not, for each custom field, throuw the "Show Hke titles" selector.

### Alerts

Alert list | Create or update alert | Delete alert
------------- | ------------- | -------------
<img src="./images/alarmList.png" width="200" /> | <img src="./images/alarmDetail.png" width="200" /> | <img src="./images/borraralerta.png" width="240" />

Vin HkE allows to configure different alerts with sound warnings and pop-up texts.

Right + button opens the new alert window.

By clicking on a pre-existing alert it is possible to modify its values, not its type. Within the detail window of an alert, left red button exits without saving the changes, right green buttom aplies changes.

Existing alerts can be enabled or disabled by pressing the bell button even you are on a route. Text or thresholds changes can be aplied on route too.

To delete an alert, do long press over it and when delete icon appears, press it to delete.

The alert types available are as follow:

* Time
* Maximum pulse
* Maximum power
* Calories burned (based on kJ if there is a powermeter or based on heart rate estimation else)
* Grams of Carbohydrates burned

Time, calories or substrates alarms allows to allows configure single shot or periodic shots.

Each alert with message text can show a popup message into your rideapp screen. You can configure if the popup shows or not, how time will be show or whether you'll have to tap it to hide it.

Do you want more? Ask me!

### Pit board

Pit board management | QR | Message history | Remove message
------------- | ------------- | ------------- | ------------- 
<img src="./images/pitboard.png" width="200" /> | <img src="./images/qr.png" width="200" /> | <img src="./images/pitList.png" width="200" /> | <img src="./images/deletePitMessage.png" width="200" />

In the pit board window you can capture a QR code to obtain a link to the website from where your pit boss can manage the message board for you, while you are on the go. Add a Pit board widget to your profile to receive messages on real time while you have internet connection. Your pit boss can send you concise messages with up to 3 possible preconfigured responses. It can also send you merely informative messages, without any response available. When your pit boss sends you a message you will receive a special audible alert on your karoo. Without having to stop pedaling, you can move to your pit board widget to see what it has told you and, if applicable, send it a response. You don't need open HkE app, pit board is a widget inside your ride profile.

<p>In the pit board window you must create a own nick to your pit boss can identify your pit board in scenarios with multiple riders at same time. This nick is optional.</p>
<p>Network advice option allow disable or enable audible warnings when your database connection are lost or gain.</p>
<p>Connect buttom creates a QR code to share with your pit boss.</p>
<p>Pit board ID buttom shows your unique ID. This ID is codificated in QR code and used to authenticate sessions in pit board web app.</p>
<p>Pit history shows in a list your last received messages while riding. This history will be deleted automatically after a few days.</p>

### Vinapp Workout

Karoo workout | Vinapp library | Manual workout selection | Vinapp track library 
------------- | ------------- | ------------- | ------------- 
<img src="./images/workout.png" width="200" /> | <img src="./images/Workout1.png" width="200" /> | <img src="./images/Workout2.png" width="200" /> | <img src="./images/vinGpx.png" width="200" />

Workout widget allows to execute Vinapp workouts in your karoo rideapp. Vin HkE includes a sample workout. Vinapp is a free android app for cycling training and planing with 5 stars in google play. Installing Vinapp, HkE can sync Workout of the Day from Vinapp. User can select any of the hundreds workouts includes in Vin app library or enjoy of his multiple plans.

Once Vinapp is installed in karoo, HkE bind a service that sync workout of the day automatically. If user have not a selected plan Vinapp allows direct selection of any workouts includes in Vinapp with a simple clic on yellow hammerhead logo button and sync it in HkE.

<table border="0">
    <tr>
        <td><img src="./images/vinapp.jpg" width="400" /></td></tr>
        <tr><td><p>Vinapp can be installed in any android device with OS version 6.0 or later. In this pic you can see a tablet excuting an ERG mode workout with Vinapp-TV view. This view integrates with youtube player.</p>
              <p>This view is not available for karoo due screen size considerations.</p>
              <p>Vinapp requires an user account in order to share your data between all your devices through cloud.</p>
        </td>
    </tr>
</table>

You can decide use Vinapp directly like workout executor. Vinapp have a powerful simulator and complex workout executor that you can use in karoo. No sensor linking is necesary. Vinapp implements Karoo extensions to read data from sensors linked to karoo in a transparent way.

Vinapp can manage smart trainers to executing workouts in ERG mode or simulating your favorite traks, from gpx files or from its library. In order to Vinapp take the control of your smart trainer you must link it to Vinapp by pushing antenne button inside its workout executor, or its tracks simulator. Take the control of smart trainers is not possible thoug Extensions SDK.

Vinapp has advanced statistics to track your training loads and plan your fitness peak accordingly. Vin Hke + Vinapp is a winner combo for karoo.

You can download Vinapp apk from here: [https://github.com/maduwatas/Vin-HkE/releases/download/Vinapp/](https://github.com/maduwatas/Vin-HkE/releases/tag/Vinapp)

> [!TIP]  
To use Vinapp as workout executor or route simulator you must connect your smart trainer through bluetooh to your karoo first. Next step is to open Vinapp workout or track simulator and push antenne button. Find your smart trainer again and select it. Done, no more connections are need. Devices data gets from your karoo and vinapp controls your smart trainer to adjust its resistance. Click play and enjoy.

# Extension widgets

In your karoo's profile window you will see all the additional fields that the Vin HkE provides for your karoo. You can choose several graphic fields and a simple text field with calories burned estimated from heart rate.

For the graphic fields of power, heart rate, calories consumed and power balance, we recommend choosing the single row layout with two free fields and the Vin HkE graphic field below.

Power balance widget can be integrated with 4 additional standard fields.

For the Pit Board or workout widget you must choose a full screen graphic field.

## Calories estimated by Heart Rate

A single field with calories consumpiton estimation, hear rate based
 <p>A little of physics:</p>
       
* 1W = 1 J/s (power unit)
* If you push 250W over 4s generate 1kJ of energy
* 1cal = 4.18 J (energy units)
* 1kcal = 4.18 kJ
  
<p>Calories consumption estimation based in power outputs says that 1cal burned = 1 Joule or power output, due to how inefficient we are at producing pedaling power only a 24% of cal burned are transformed on pedaling power output. So, 1kJ = 1kcal, for all the people!! Thats is not truth, is obvious, but is accepted. </p>
<p>Training status, age, weigth, sex, ambiental enviroment... are parameters that must be taken account to an accurate algorithm. Estimating calories on heart rate though complex algorithms that take acount all these parameters is possible and HkE do it. You must configure your biometrics parameters in HkE user profile to get accurate estimations. Sex, heigth, weigth, heart rate threshold, VO2Max (estimated from FTP), maximum heart rate and training status (CTL) are the key parameters</p>
<p>To know more read here: https://www.omnicalculator.com/sports/calories-burned-by-heart-rate</p>

## VAM and VAM-W/kg

Velocità Ascensionale Media (VAM), measures the average rate of climb in a lap.

VAM = metres ascended / hour

VAM-W/kg is a estimation of your uphill performance, in W/kg, in same lap.

VAM-W/kg = VAM / Gradient factor

with

Gradient factor = 100 x 2 + (% grade / 10)

Push in lap button to reset your VAM and VAM-Wkg measurements when starting a climb.

## Graphical Power

<table border="0">
    <tr>
        <td><img src="./images/profilePower.png" width="200" /></td></tr>
        <tr><td>Complete data power widget with graphical progress bar FTP based. Instant power, average power and average interval power have graphics power bars. Power zone, normalized power, power percent relative to FTP, kJ burned, cadence (if exists) and heart rate (if exists) are secundary data for this widget.</td>
    </tr>
</table>
 | 
## Continuous Power Graph

A power graph againts elapsed time, updated every short time interval. Tap on graph to switch the time axis length between 10, 30, 60 minutes or all the activity. Power intervals changes his color based on power zone.

## Continuous heart rate Graph

A heart rate graph againts elapsed time, updated every short time interval. Tap on grapp to switch the time axis between 10, 30, 60 minutes or all the activity.

## Graphical Hear rate

<table border="0">
    <tr>
        <td><img src="./images/profileHr.png" width="200" /></td></tr>
        <tr><td><p>Complete data heart rate widget with graphical progress bar Heart rate threshold based. Instant heart rate, average heart rate and average interval heart rate have graphics power bars. Heart rate zone, calories burned , heart rate percent relative to maximun hear rate, power (if exists) and cadence (if exists) are secundary data for this widget.</p></td>
    </tr>
</table>

## Graphical Power balance

<table border="0">
    <tr>
        <td><img src="./images/profileBalance.png" width="200" /></td></tr>
        <tr><td>Power balance data for dual powermeters. This widget shows graphical progress bar for power balance left-right, pedal smoothness left-right and torque effectiveness left-right.</td>
    </tr>
</table>

## Calorie consumption

<table border="0">
    <tr>
        <td><img src="./images/profileCalories.png" width="200" /></td></tr>
        <tr><td>Complete data caloric consumption widget. Shows instant caloric consumption speed total, fat and carbohydrate. Total grams of fat and charbohydrate burned.</td>
    </tr>
</table>

## Virtual racer

<table border="0">
    <tr>
        <td><img src="./images/virtualpartner.png" width="400" /></td></tr>
        <tr><td><p>You'll Never Walk Alone!</p>
        <p>If you are one of those guys who like to compete even againts your shadow, you are in luck. With the virtual racer you will always have someone to chase or leave behind</p>
        <p>Set your opponent's instant speed using the - + buttons to the left and right of their current speed. At each moment you can see how far apart you are with the distance and time values. When you are together the virtual racer icon will be displayed in the center of the screen, it will move away from you to the left when you win and to the right when you lose.</p><p>Double tap on racer row reset the gap.</p>
              <p>Virtual racer image from <a href="https://www.flaticon.com/free-icons/cycling" title="cycling icons">Cycling icons created by kosonicon - Flaticon</a></p>
        </td>
    </tr>
</table>

## Colored fields

<table border="0">
    <tr>
        <td><img src="./images/colorinchis.png" width="200" /></td></tr>
        <tr><td><p>There are 5 colored fields.</p>
       
* HkE slope: shows elevation grade. Grade zone shows through color codes from blue to purple. You can switch between karoo standard color chart or HkE custom color chart.
* HkE power: shows power output and power zone. Power zone shows through color codes from blue to purple, based in your karoo power zones profile.
* HkE heart rate: shows hear rate output and heart rate zone. Heart rate zone shows through color codes from blue to purple, based in your karoo hear rate zones profile.
* Multiple power: shows power output, interval power average and normalized power in a single karoo field. Power zone shows, in each data, through color codes from blue to purple, based in your karoo power zones profile power data.
* Multiple heart rate: shows hear rate output and heart rate zone. Heart rate zone shows through color codes from blue to purple, based in your karoo hear rate zones profile.
        </td>
    </tr>
</table>

## Workout execution

<table border="0">
    <tr>
        <td><img src="./images/widgetWorkout.png" width="200" /></td></tr>
        <tr><td>Vinapp's workout execution screen shows you all the relevant information about your structured training. Workout execution power based or heart rate based are implemented. 
        Before starting the workout you will be able to see its graphic design. Once you start the workout, the entire screen is used to show current, previous and next goal, action buttons and power, cadence, pulse and torque data, as well as the average data in each interval. 
        The action buttons allow you to raise or lower the target in line, as well as navigate forward and backward intervals.
        Next to the target power data you will see arrow icons and color codes appear that will indicate if you are below or above the target zone.
        The screen has audible alerts of interval change.</td>
    </tr>
</table>

## Pit board

Question or message | Question answered | Remote pit board
------------- | ------------- | ------------- 
<img src="./images/pregunta.png" width="200" /> | <img src="./images/respuesta.png" width="200" /> | <img src="./images/pantallaboxes.jpg" width="200" />

This is the most special functionality of Vin HkE. By inserting this screen in your profile you can receive the messages that your team sends you while you are on route. You will be able to receive important information without having to stop. Your pit manager can send you up to 3 different options so you can respond.

I'm on pk 53, what do you need? -> WATER, WATER+GEL, NEW LEGS.

Your boss will have everything ready when you arrive. How important is it for you to know how much you get out of your rival? With the pit board your boss will be able to take time when you pass and inform you immediately as soon as your rival passes.

Pit board widget requires internet connection though wifi or simcard. If you losses connection Pit board will do automatic reconnection when it has possible. While has internet connection pit board will update in real time. In the future we work in bluetooth link for K3 though Hammerhead Companion app.

We have many ideas to improve this functionality in the future, for example Bluetooth connection throug Companion app, multiple pit box dashboards, allowing an entire team to coordinate from a tablet, a karoo-karoo connection... this has only just begun.

### Pit board configuration options

#### Connection (K3 only)
Karoo 3 users can choose if his pit board connects to our database through Companion app (bluetooth) or through wifi network. Wifi link implements a realtime connection. When network is available, rider and pit boss receive messages without any delays. Bluetooth link implements an async system to get data from database. Your karoo query every 5 minutes if there are any new message. Responses from rider to pit box are sent witouth delays, if network is available.

K2 only can connect to pit board database through wifi/gsm link, so, this options not shows, and k2 link to pit board will be wifi/gsm.

#### Network loss alert
You can choose if want network loss-gain little sound alert or not.

#### Start/stop ride messages
Your pit board can send automatic messages when you start or terminate a ride.

> [!IMPORTANT]
> When karoo starts a new activity it disable wifi by default. HkE attempts to start wifi but not always get it due operating system restrictions. You will have an advice icon when losses internet access. In the major of case you must activate wifi manually at the start of your ride.

# HkE translations
If want contribute with a translation to your language download strings.xml file and translate tags. Contact with me at this git repository or at vinagreapp@gmail.com and I will upload your file in next Vin HkE release. Thanks and happy ride!

# APK
Download Vinapp HkE here: https://github.com/maduwatas/Vin-HkE/releases/tag/latest

# SDK Implementation details

It is necessary to have the dependency on Hammerhead extensions for Vinapp HkE to work.

implementation("io.hammerhead:karoo-ext:1.x.y")

## Basic mechanics
When your karoo starts up, look in the manifests of the apps you have installed for the definition of the extension service.

Here we indicate which class must be executed to start your extension and in which file the data fields it includes are defined.

## HammerheadExtension main class
When the Vin HkE extension starts up it queries your user profile in the karoo, sets listeners for your activity status, starts collecting data from your devices and stores it in a singleton object, the DeviceHandler.

## File extension_info
In this file you indicate the data fields that your extension includes. For each field you include you must indicate a name, description and an icon. The fields in which you are only going to show a numerical value will be graphical false, the rest will be graphical true
Finally, you must indicate the typeId attribute with a **unique identifier** that will help karoo identify which view it should show when the user selects this field. For example

**typeId="custom-calories"** in the xml

class CustomCaloriesDataType(
private val karooSystem: KarooSystemService,
extension: String,
) : **DataTypeImpl(extension, "custom-calories")** in view data type class

## Views
Extension views are implemented by two classes. The Typo class collects the data and updates the view's Composable. The Composable class creates the view itself from data collected directly by its associated type.
Extensions are developed to consume composables that must be built with Glance. In my example I have used Glance only to return a container in which I insert Remoteviews developed in the classic way, that is, with xml layouts. I have taken this option because it is the one I master, but the normal thing would be to use glance. One of the problems with my approach is that you have to control the theme manually, to change the colors of the texts.

## Vinapp FIT Manager
When you start an activity, an object is also started in the Vinapp core that stores all the instant data sent by your devices in records with a FIT structure.
The FIT object can later be used in all the extensions you design without needing to establish dependencies on all the necessary devices. This way your extensions can work even if not all the data they display is being collected. That is, views can use the data collected by their associated Type or consume the DeviceHandler object provided by Vinapp.
The FIT object allows complex calculations from the collected data.

Vin-HkE

Vin-HkE 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Vin-HkE

Vin-HkE 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README