Release Notes
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
The API documentation for the current version (8.0.0) is available here. |
[8.0.0] - 2024-10-10
Breaking changes
Android
-
The companion object (
AnylineTireTreadSdk.companion
) for calling the functions was removed to provide a better integrator experience (an example of its usage can be found here)
iOS
-
Removed the unnecessary context parameter from the SDK initialisation. The SDK can now be initialised with just the license key (an example implementation can be found here).
-
The object for calling the functions changed from
AnylineTireTreadSdk.companion
toAnylineTireTreadSdk.shared
(an example of its usage can be found here)
[7.0.0] - 2024-09-23
[6.1.0] - 2024-09-06
Added
Android
-
Added an option to pass the width of the tire when initializing the scan process to further improve the accuracy of the measurements
-
an example of how this is implemented can be found here.
-
For now this feature is meant for passenger car tires only
-
[6.0.0] - 2024-08-20
[5.2.0] - 2024-06-17
Added
-
Get
Heatmap
functionality is now available.-
Using the
AnylineTireTreadSdk.getHeatmap
function, it is now possible to retrieve a full Heatmap of the tire’s tread depths. Check the page Analytics for more details.
-
-
When initializing the scan process with a JSON config, you can now listen for possible error messages with a callback method. This is not supported when initializing via view.xml.
[5.0.0] - 2024-05-24
Please be aware of the breaking changes listed below. |
Added
-
Scan process can now be set up via a JSON configuration
-
Scan result can now easily be converted to a JSON for further processing on integrator side
-
Simple use the
toJson()
extension function in theTreadDepthResult
object
-
Removed
-
Replaced some functions of
TireTreadScanViewConfig
with a single functionwithScanConfig()
to make the setup process more streamlined.
Breaking changes
-
Removed the
Builder
from theTireTreadScanViewConfig
. The configuration can be now done directly using the fields of aTireTreadScanViewConfig
object.-
Builder.withScanSpeed
is nowtireTreadScanViewConfig.scanSpeed
-
Builder.withAdditionalContext
is nowtireTreadScanViewConfig.additionalContext
-
Builder.withMeasurementSystem
is nowtireTreadScanViewConfig.measurementSystem
-
Builder.withCustomDefaultUiConfig
is nowtireTreadScanViewConfig.defaultUiConfig
-
Builder.disableDefaultHaptic
is nowtireTreadScanViewConfig.useDefaultHaptic
-
Builder.disableDefaultUi
is nowtireTreadScanViewConfig.useDefaultUi
-
[4.2.0] - 2024-04-05
This release introduces several enhancements to the Default UI, resulting in a more accurate and intuitive scanning process. Additionally, the Default UI now supports localization and customization.
Check the Default UI specific documentation for more details.
Added
-
A new
DefaultUiConfig
class now allows fine-grained customization of the Default UI’s components.-
In the component configuration classes,
visible
properties enable you to selectively hide specific elements while keeping others visible. -
text
properties can be used to define custom texts for the components. -
Check the Default UI’s Customizing and Elements page for customization options, a detailed list of components, and their respective configuration classes.
-
[4.1.0] - 2024-03-08
This release introduces several improvements to the Default UI’s user experience and scan guidance. Additionally, it includes a new feature that allows for providing and retrieving more context for measurements. A small bug fix has also been implemented for Android.
Added
Android & iOS
-
[Default UI] Introduced a tire-shaped grid overlay to the Default UI, making it simpler to align the camera correctly with the tire’s shoulder.
-
The speed and direction to where the phone should be moved during the scan process are now guided by the tire-shaped overlay’s movement.
-
The scanning process should always be performed from the outer side to the inner side of the tire.
-
When the phone is rotated, both the overlay and the scan direction are automatically adapted.
-
-
[Default UI] Added a tooltip informing the user how to position the tire overlay to be in line with the shoulder of the tire.
-
[Additional Context] A new class
AdditionalContext
was added to enable holding more context about a specific measurement.-
This information can be provided when initializing the
TireTreadScanView
. -
If provided, its information will be returned in the measurement’s result.
-
Check the platform-specific 'scan process' documentation pages for more information.
-
-
[Scan View] The
TireTreadScanViewConfig
builder has a new.addAdditionalContext(AdditionalContext)
function, enabling you to provide more context to a measurement. -
[Result] Added a new property called
measurementInfo
(of typeMeasurementInfo
) to theTreadDepthResult
class.-
This class can be used to retrieve more information about the measurement such as
UUID
,status
andadditionalContext
(if previously provided).
-
Removed
-
[Default UI] As part of the user guidance improvements, the tooltip messages on the top of the UI were removed.
Fixed
[Android]
-
Fixed an issue where the distance feedback would continue to be played after leaving the Scan View.
-
In some specific scenarios, the
TireTreadScanView
's distance feedback would continue to be played even after ending the scan process. -
With this release, users will not experience this issue anymore, regardless of how the TireTreadScanView is implemented.
-
[4.0.0] - 2024-01-25
Please be aware of the breaking changes listed below. |
Changed
-
Default UI redesign
-
We reorganized the UI to offer a better user experience with the help of tool tips.
-
The Default UI now intercepts user touches to start and stop the scan process instead of using buttons.
-
We also updated the distance indicator to tell the user whether they have to move closer or farther away from the tire.
-
-
The
DistanceStatus
enum has a new status (UNKNOWN
on Android -unknown
on iOS), returned when no distance information is available.-
This is the case when the device’s camera was not yet able to focus on the scan target.
-
Added
-
Added a new
captureDistanceStatus
property to theTireTreadScanner
instance, of typeDistanceStatus
.-
This property can be used to check if the user has the device correctly positioned for the scan process.
-
-
Added a tooltip icon that signalises that the camera is in optimal position to start the scanning process
[3.0.1] - 2024-01-17
[3.0.0] - 2023-12-28
This major release includes many improvements in the usability and stability of the Tire Tread SDK (both for integration and usage).
Please be aware of the breaking changes below:
Breaking changes
[Android & iOS]
-
Scan →
TireTreadScanViewConfig
-
defaultUi
anddefaultHaptic
are now enabled by default. -
The
TireTreadScanViewConfig
constructor was changed to a Builder pattern, as shown below:-
TireTreadScanViewConfig.Builder().build()
- For more details and examples, check the platform-specific "Scan Process" pages.
-
-
-
Results →
getTreadDepthReportResult
:-
You no longer need to call
getTreadDepthReportResult
repeatedly until the measurement result becomes available. Just call the function on a background thread, and listen for callbacks on success and on failure. -
getTreadDepthReportResult
function is now void. -
getTreadDepthReportResult
's success callback has been renamed from Succeed to Succeeded. -
onGetTreadDepthReportResultSucceeded
callback now provides the result as aTreadDepthResult
object. -
onGetTreadDepthReportResultFailed
callback now provides the failure information as aMeasurementError
object.
-
-
Results →
TreadResultRegion
object:-
The field
confidence
was removed.
-
-
Results / PDF Report →
getTreadDepthReportPdf
function:-
This function is now void.
-
The success callback has been renamed from Succeed to Succeeded.
-
The
onGetTreadDepthReportSucceeded
callback provides the ByteArray of the PDF Report. -
The
onGetTreadDepthReportFailed
callback provides now only an Exception.
-
[Android]
-
The minimum version requirements have been increased to:
-
JDK 17
-
Gradle 8.1.0
-
compileSdk 34
-
minSdk 26
-
Compose Compiler v1.5.0
-
-
Scan →
TireTreadScanView
-
The attributes
useDefaultUi
anduseDefaultHaptic
of the TireTreadScanView have been renamed todisableDefaultUi
anddisableDefaultHaptic
respectively, with default values set tofalse
.-
Default UI and Haptic will be enabled by default, unless explicitly disabled.
-
-
Added
[2.3.0] - 2023-10-25
-
In the
TreadDepthResult
, a new field valueInch32nds is now available, containing the result in 32 seconds of an inch.
[2.2.0] - 2023-10-09
-
[Android] Added audio feedback in form of a beep when the tire is too far or too close to the camera
-
[Android] Added haptic feedback when the tire is too far or too close to the camera