Self Check Driver

About

The CaRool Self Check Driver provides a simple way to get a vehicle tyres wear diagnosis.

Iframe Integration

The CaRool Self Check Driver can be integrated through an iFrame by loading your version of the Tyre Scanner with this url: https://<your-company>.ca-rool.com/#/diagnosis

Prerequisites

To use our Self Check Driver you need to

• Provide camera access to the iFrame thanks to this tag

<iframe allow=camera>

• add the following meta tag for a correct rendering

<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no">

• The Self Check Driver application will automatically adapt his size to the available space given by the iframe. Therefor our advice is to use dynamic sizing for the iframe like 'flex css' and avoid fixed sizing for better integration.

Pass data to Self Check Driver

Query Parameters

You can pass data to the Self Check Driver using query parameters. Warning all query parameters must be encoded to be properly used.

Parameters	Value	Comments
license	String	License with any of the validated country format
licenseCountryCode	String	ISO 3166-1 - alpha 2 code (eg: fr) - Used to ensure license format is correct
embedded	Boolean	Set this value to true to set the application as ‘embedded’ and disable various UI features
externalId	String - Max 100 chars	Any 100 chars id that you might receive back at the end of the scanning process
mileage	Number - [0 - 1 000 000]	Vehicle mileage
phone	String	User phone with international format (eg: +33612345678)
email	String	User valid email
postcode	Number	User postcode, used for winter law specific checks

URL Path

The default URL to access your version of the Self Check Driver is has follows https://<your-company>.ca-rool.com/#/diagnosis

However you can add some option to this url:

Parameters	Value	Comments	Example
campaign	String	If you need to manage a campaign for a specific link	https://<your-company>.ca-rool.com/#/diagnosis/<campaign>
subcompany	String	If you need to manage subcompany with dedicated configuration	https://<your-company>.ca-rool.com/#/diagnosis/company/<subcompany>

Get data from Self Check Driver

To be notified about what is happening inside the Self Check Driver you can listen for events.

<script type="text/javascript">
    window.addEventListener('message', (message) => {
        if (message.data.type === 'onFinished') {
            console.log('onFinished', message.data.data)
        }
        if (message.data.type === 'onError') {
            console.log('onError', message.data.error)
        }
        if (message.data.type === 'onStarted') {
            console.log('onError', message.data.data)
        }
    });
</script>

Structures

Messages Structures

{
  type: string,
  data: {
    action: string,
    data: object,
    error: string
  }
}

type	Comments
onFinished	Occurs when an action finished
onError	Occurs when an error happened
onStarted	Occurs when an action is loaded

action	Comments
analysis	Occurs when something happens during the analysis process
landing	Occurs when the landing view is opened. Extra data : {step: number}
license	Occurs when the license view is opened
postcode	Occurs when the postcode view is opened
tutorial	Occurs when the tutorial view is opened
photoshoot	Occurs when the photoshoot view is opened and at every photoshoot step changes. Extra data : {step: {position: number, type: 'WEAR' OR 'REFERENCE'}}
send	Occurs when the send view is opened
send_success	Occurs when the user has sent his analysis with success

error	Comments
Upload error	The analysis couldn't be finished due to upload error

Customisation

Your version of the Self Check Driver can be fully customized to your need. Below you can find the list of options to communicate to the CaRool Team if you want another behavior than the default one.
If you need extra customisation which is not in the list below please contact us.

Configuration	Options
Theming	A primary and secondary colors can be used to fully customised the UI of your Self Check Driver
Logo	Your logo (svg) and favicon (ico, png) can be used
Font	Customized font ( normal and bold )
Email Identification	Ask for users email as a way to get his diagnosis
Phone Identification	Ask for users phone as a way to get his diagnosis
Phone Countries	The list of supported phone countries
Languages	Supported languages
Banner	Marketing content (svg) displayed when the user open the app
Winter Law	Show in the report whether or not tyres are compabible with winter law (All 3PMSF)
License Countries	The list of authorized license countries
Not supported Image	Custom Not Supported image for the 'browser not supported' page

Understand the PDF report

All information displayed in the customer report are explained below. If you have any additional question, please contact us.

Reason	Label
Tyre > 6mm	Very good tread depth
Tyre > 4mm	Good tread height
Tyre > 3mm	Tread low, replacement to be planned
Tyre < 3mm	Worn tyre, limited tread height, risk of aquaplaning
Tyre at 1.6mm and below	Worn tyre - Wear indicator reached
Cut detected	Presence of a cut in the sidewall
Hernia detected	Presence of a hernia in the sidewall
Object detected	Presence of an object on the tread
Cut detected	Presence of cracks in the rubber
Tyre age >= 10 years	Tyre age over 10 years, ageing of the rubber
Difference on the axel	Brands / Seasons / Dimensions / Patterns different on the axle
Recommendation if tyre is new and without issue	Next check 6 months or 6,000 miles (or kms elsewhere)
Recommendation if tyre is in good condition and without issue	Next check 6 months or 3,000 miles (or kms elsewhere)
Recommendation if tyre is almost worn and without issue	Next check 6months or 3,000 miles at the latest (or kms elsewhere)
Recommendation if tyre is worn and without issue	Change recommended
Recommendation if tyre has an issue that require change	Change recommended
Recommendation if tyre has an issue that require control	To be checked by a specialist