Overview

Welcome to the Anyline Tire Tread SDK Documentation!

The Anyline Tire Tread SDK is a mobile SDK that allows you to scan and measure tire treads, based on cloud technology.

Requirements

Device

To use the Anyline Tire Tread SDK, you will need a device that meets the following requirements:

  • Operational system:

    • Android 8.0+ (Oreo) - API level 26+

    • iOS 16.4+

  • Stable internet connection

  • 'Flash' capability

  • Decent camera functionality (recommended: ≥ 720p and adequate auto focus)

Environment

Your development/application environment is required to have at least the following tools and versions (or newer) available:

  • JDK 17

  • Gradle 8.1.0

    • id 'com.android.application' version '8.1.0' apply false

  • Kotlin 1.8.22

    • id 'org.jetbrains.kotlin.android' version '1.8.22' apply false

  • compileSdk 34

    • android { compileSdk 34 …​

  • minSdk 26

    • …​ minSdk 26 …​

  • Compose Compiler 1.5.0

    • …​ composeOptions { kotlinCompilerExtensionVersion = "1.4.8" } …​

For Kotlin <> Compose version compatiblity, refer to the Compose to Kotlin Compatibility Map page.

Implementation

At minimum, implementing the Anyline Tire Tread SDK will require two steps:

1. Anyline Tire Tread SDK initialization

The AnylineTireTreadSdk's' function init/doInit is responsible for initializing the Anyline Tire Tread SDK with your License Key. It needs to be called only once during your application lifetime, before running any other Anyline Tire Tread SDK-related tasks.

2. TireTreadScanView implementation

The TireTreadScanView is an UI element that can be added as a subview to your page.

This view handles the camera access and provides functions for you to start and end the scan process, as well as the "distance information" to guide the scan process.

Check the Getting Started section to begin.