The lap KPIs (key performance indicators) feature in HH Data Management enables logged data to be analysed based on user-defined math expressions. To use the lap KPI feature, first the math expressions are defined using the data analysis profile. Then the logged data is associated to the runsheets. Once these two tasks have been completed the KPIs can be calculated. Once the KPIs are calculated the results are stored in the HH Data Management database and can be analysed using the main graph or the results exported using the data export features.
The logged data is added to the runsheets using attached files. The KPI calculations are performed on the server, this makes it quick and easy to recalculate the KPIs at any time after an event. For example, as the season evolves more KPIs may be developed and the KPI implementation allows for updating the calculated results for all past events if desired.
Data analysis profile
The data analysis profile view can be accessed from the admin tab of the ribbon bar:
The data analysis profile view will open:
The following items exist within the data analysis profile once it is created:
- Math channels
- Data channels
- Data channel aliases
- Custom expressions
All items are created, edited and deleted using the buttons on the ribbon bar. The items will be presented in their logical order, not in the order of the tabs in the software.
All items have checkboxes beside their definitions. These checkboxes allow the items to be disabled, meaning that they will not be included in a KPI calculation. For example if a folder is unchecked then any KPIs, math channels, constants, data channels or custom expressions defined in this folder will not be calculated.
Folders are purely an organizational construct and do not affect the functionality in any way. Items created within one folder can be referenced from another folder.
The GLOBAL-SEARCH folder is an automatically added item in the folder list that shows the items from all folders in the tables all at once. New items cannot be added when the GLOBAL-SEARCH folder is selected.
Data channels & data channel aliases
The data channel concept is used to define the channels that are available in the data file. Technically, these are not required, but they are helpful as it enables the intellisense to work when writing math channels, and it allows aliasing if a channel could have different names in different files. There are two levels; the data channel and then as children the data channel alias. The data channel is the name that will be used in HH Data Management to reference this channel, and if no aliases exist, then this name will also be the name that is searched for in the data file to locate the channel data. Data channel aliases can be used to support cases where data might have different names in different files, or simply to change the name between the data file and HH Data Management. This may be necessary if the channel name in the data file doesn't conform to the HH Data Management syntax requirements. For example, HH Data Management doesn't allow spaces in channel names, where as a lot of data logger systems do. When processing the KPIs, HH Data Management will first search for the channel using the data channel name, then iterate through the data channel aliases to find the data. In the example screenshot, for the AccX channel, the search order would be:
- G Force Long
- Longitudinal G
The constants are used to define constant values that can be used in math channels along with data channels.
One of the key points of HH Data Management is that all data is stored in a single place and this should in theory make it possible to access all relevant information about the car for each lap. For example, when running KPIs, part specifications (e.g. spring rates) and sensor offsets stored in the setup sheet or runsheet should be accessible in the math expressions. This link between the KPI system and the rest of HH Data Management is accomplished using the custom expressions. It is not possible to access the HH Data Management parameters directly in a math channel expression because there are two separate languages in HH Data Management; the KPI expression language and the math expression language and the two are not interchangeable. This is an intentional decision as the two languages are designed to accomplish two very different tasks.
When creating or editing a custom expression, a window will pop-up:
The expression name is the name that should be used when referencing this custom expression in a KPI math channel. See the single vs multiple value return types section for an explanation of the return type combobox. The scope combobox has two options; runsheet or lap. This sets the scope that the math expression can be written about. Normally this should be set to runsheet (to get setup-related information). But if the expression needs to return some info from the lap (perhaps to get fuel remaining), then the scope should be changed to lap. The unit allows the return unit of the math expression to be defined.
The scope also has a minor impact on the performance of the custom expression getting evaluated. If the lap scope is selected then the expression has to be evaluated for each lap, but if the runsheet scope is selected then the expression is only evaluated once per run.
The math channels are where the actual math for the KPIs are defined. Math channels can reference data channels, constants or custom expressions. For more information on the language used to write math channels and the functions available, please refer to the KPI expression reference section.
When creating or editing a math channel, a window will pop-up:
The return dimension and unit can be specified here.
As mentioned in the data channel section, if a channel name is used in a math expression, but not defined in the list of data channels or data channel aliases, then HH Data Management will still search the data file for a channel with this name. The channel name will be underlined in green as a notification that this is a channel name that is unknown to HH Data Management:
The KPs are the final part of defining how a lap KPI is calculated.
The name is the final name of the lap KPI parameter that will be used to store the result in HH Data Management. Therefore, the value entered for the name of the KPI must match an existing parameter on the lap definition of the appropriate type. If this isn't the case, then the KPI result will not get saved to the database.
The check lap parameter button on the ribbon can be used to automatically scan the lap definition to make sure that all required parameters exist and will give an option to automatically create them if they do not exist.
The math channel drop down allows the math channel that will be used to calculate the result for this KPI to be selected.
Selecting a row in the KPI table and then clicking the edit KPI advanced options will open a popup window:
When KPIs are calculated in HH Data Management, each lap is considered individually (and then mapped back to the laps in the database for storing the results). The advanced options allows for additional data to be loaded when the data is processed. Data from before or after the current lap can be loaded by enabling the options. This can be useful for example if calculating a straight line KPI that needs to consider the full S/F straight.
The delete KPI advanced options button can be used to remove the options for the selected KPI and reset all values back to their default.
Single vs multiple value return types
When defining math channels the return type can be specified as either single or multiple. Most standard KPIs will be single, for example, a KPI that calculates the max speed of the lap, or the % of the lap spent on full throttle. A single value per lap is generated. However, KPIs can be created that calculate multiple values per lap using gates, for example, the time spent in each corner, or the minimum speed for each corner. When a KPI is defined as having a single return type it is stored in a double parameter on the lap definition, and the name of the KPI must match the name of the lap double parameter. When a KPI is defined as having a multiple return type it is stored in a collection parameter on the lap definition. This collection then has an item for each KPI value, and the calculated value is stored in a double parameter on the lap collection item definition. When specifying the name for the KPI, it should be specified as
<lap collection parameter name>.<lap collection item double parameter>, for example
Corners is a collection on the lap definition and
vMin is a double parameter on the lap collection item definition.
To create a multiple value KPI custom expressions must be used, and this custom expression must return a list of double values. This will force all KPIs that reference this custom expression to have a return type of multiple. Generally, these custom expressions will reference a collection parameter and use the
Select function to extract a double parameter and return a list of double values. For example, a collection could be made on the track configuration definition with parameters that allow the start and end distances or GPS coordinates of each corner to be defined. Two custom expressions could then be created to get these start and end values.
|Single value per lap||Multiple values per lap|
|Stored in a double parameter on the lap definition||Stored in a collection parameter on the lap definition, in a double parameter on the lap collection item definition|
|KPI name should match name of lap double parameter||KPI name should match |
Using the KPIs in an event
There are two tasks that must be carried out for each event and car to be able to run the KPIs:
- define which data analysis profile should be used
- add the files to the runsheet
Selecting the data analysis profile
The data analysis profile to be used for each event/car is selected in the event data view.
Adding data files to the runsheets and running KPIs
The data files for each runsheet are managed using the runsheet KPI management view which can be opened from the event tab of the ribbon bar:
The runsheet KPI management view will open:
There are buttons on the ribbon bar to manage the attached files and to manually trigger KPI calculations. The KPI calculation will automatically run for each run once the file finishes uploading.
The table has one row for each run and shows the status of the last KPI calculation that was run for each run. In this example, the KPIs have run successfully, but there have been some errors:
KPIFuelConsumptionfailed to run - in this case the expression should be checked for errors
- the custom expressions
RunsheetTargetPressureFRboth failed to evaluate, so they should also be checked for errors
By default, adding the data files to the runsheet is a manual process, but it can be automated using a plugin depending on the workflow each team uses.
Once everything is set up properly the KPI calculation can finally run. The KPI calculator runs on the HH Data Management server. The server is responsible for getting the correct data analysis profile, getting the data file(s) from the runsheet, and then calculating all the KPI values, and finally writing the results back to the HH Data Management system (which then distributes the results to all users). The alignment between the laps in the data file and the laps in HH Data Management is managed by the server and simply aligns them one-to-one, i.e. the results from the first lap in the data file will be written to the first lap in HH Data Management.
The KPI calculator is designed to be able to handle large amounts of processing requests, therefore it is possible to calculate multiple KPIs at the same time (e.g. recalculating the full season of KPIs). However, at times of high load there may be a longer than normal wait, for the results to become available.
Multiple data sets
HH Data Management is capable of handling multiple data sets, for example telemetry data and logged data, or data sets from multiple loggers. Please contact email@example.com as this is not supported by default in the software as each use case is different.