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.

[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 the TireTreadScanner instance, of type DistanceStatus.

    • This property can be used to check if the user has the device correctly positioned for the scan process.

Breaking Changes

  • To offer a more streamlined experience, we removed some of the classes:

    • Color

    • ATDSideButton on iOS

    • DistanceFeedbackView

    • ScanGuideView

    • ScanSideButtonsView

[3.0.1] - 2024-01-17

Fixed

[Android]

  • Fixed a crash that happened when aborting a scan that wasn’t started yet.

    • Aborting a scan process before starting it would result in crash due to an unitialized property.

    • The SDK will not crash anymore when aborting scans before their initialization.

[iOS]

  • Fixed a crash that happened when the ProximaNova-Bold font was not available.

    • When using the DefaultUI without the ProximaNova-Bold font available in the Application, the SDK would crash.

    • The SDK’s DefaultUI will not crash anymore when this font is not available.

[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 and defaultHaptic 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 a TreadDepthResult object.

    • onGetTreadDepthReportResultFailed callback now provides the failure information as a MeasurementError 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.

[iOS]

  • Increase minimum iOS version requirement to 16.4.

[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 and useDefaultHaptic of the TireTreadScanView have been renamed to disableDefaultUi and disableDefaultHaptic respectively, with default values set to false.

      • Default UI and Haptic will be enabled by default, unless explicitly disabled.

Added

[Android & iOS]

  • Audio feedback can now be played by the SDK together with the vibration feedback. For more details and examples, check the platform-specific "Scan Process" pages.

[Android]

  • start, stop, and abort buttons, to SDK’s default UI.

  • capture distance info to SDK’s default UI.

  • capture progress bar, distance feedback, and upload screen to the default UI.

Improved

[Android]

  • Scan is now automatically aborted when the activity containing the TireTreadScanView enters the onPause state.

[iOS]

  • Greatly improve the stability and responsiveness of the SDK.

Fixed

[iOS]

  • Torch sometimes was not activated when starting a scan.

  • Crash when Haptic Engine was not available.

[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

[2.1.4] - 2023-10-05

Fixed

  • [iOS] useDefaultUi when false is showing black screen

  • [iOS] scan can start even when focus dot has not yet been added

  • [iOS] start/stop button state not updating correctly

[2.1.3] - 2023-08-24

Changed

  • More scan process and image quality improvements

[2.1.2] - 2023-08-24

Changed

  • [Android] Improve scan process and image quality

[2.1.0] - 2023-08-04

Added

  • [Android] Distance info in the default UI

  • [Android] Provide vibration feedback

[2.1.0] - 2023-07-20

This is the first release for iOS

[2.0.0] - 2023-06-27

  • Major rewrite of the SDK (available only for Android)