FAQ
Important topics
Data Explorer
Vehicle Crash Detection
App Integration
Follow the below steps to set up vehicle crash detection in you app.
1. Integrate the Sentiance SDK
If you haven't already integrated the Sentiance SDK, follow the steps in our Getting Started guide to complete the integration. Once you have completed those steps, continue along with the steps documented below.
2. Check if Vehicle Crash Detection Is Supported
There are several reasons why vehicle crash detection may not be supported on the device. The two most common of these are:
- the feature is not enabled for your app;
- the device lacks the necessary sensors (e.g. accelerometer).
You can check to see whether vehicle crash detection is support on the device, as follows.
Android
iOS
1
Sentiance.getInstance(context).isVehicleCrashDetectionSupported(TripType.SDK_TRIP);
Copied!
1
[[SENTSDK sharedInstance] isVehicleCrashDetectionSupported:SENTTripTypeSDK];
Copied!
As the Sentiance SDK supports both automatic detections and manual trips (i.e. explicitly starting and stopping a trip), the availability of vehicle crash detection is also controlled at the level of the trip type. In the above example, we pass a trip type of
SDK_TRIP or SENTTripTypeSDK to check if the feature is available for automatic trips. To check if it's available for manually started trips, pass EXTERNAL_TRIP or SENTTripTypeExternal instead.3. Subscribe for Vehicle Crash Events
In order to be notified of vehicle crash events, you must set a listener that the SDK can invoke whenever it detects vehicle crashes.
Android
iOS
1
Sentiance.getInstance(context).setVehicleCrashListener(new VehicleCrashListener() {
2
@Override
3
public void onVehicleCrash(VehicleCrashEvent crashEvent) {
4
// Handle the vehicle crash event
5
​
6
long epochTimeMs = crashEvent.getTime();
7
Location location = crashEvent.getLocation();
8
Float speedAtImpact = crashEvent.getSpeedAtImpact();
9
Float magnitude = crashEvent.getMagnitude();
10
Float deltaV = crashEvent.getDeltaV();
11
Integer confidence = crashEvent.getConfidence();
12
}
13
});
Copied!
1
[[SENTSDK sharedInstance] setVehicleCrashHandler:^(SENTVehicleCrashEvent *crashEvent) {
2
// Handle the vehicle crash event
3
​
4
NSDate *date = crashEvent.date;
5
CLLocation *location = crashEvent.location;
6
Float32 speedAtImpact = crashEvent.speedAtImpact;
7
Float32 magnitude = crashEvent.magnitude;
8
Float32 deltaV = crashEvent.deltaV;
9
NSInteger confidence = crashEvent.confidence;
10
}];
Copied!
The crash event contains the time and location of the detected crash, in addition to a number of metrics to estimate the severity of the crash.
4. Test Your Integration
The final step is checking your integration, to make sure that your vehicle crash listener is properly set up to handle crash events. Add the following method call in your app to trigger a dummy crash event.
Android
iOS
1
Sentiance.getInstance(context).invokeDummyVehicleCrash();
Copied!
1
[[SENTSDK sharedInstance] invokeDummyVehicleCrashHandler];
Copied!
This should invoke a dummy crash event, passing it to the listener that you previously set. You can then test how your app handles the event at runtime.
Crash Report
A crash report contains contextual information pertaining to a crash event. This includes information specific to the crash i.e., time, location, speed before impact, a severity indicator and sensor data. Also, it contains user timeline information before, during, and after the crash event, as well as weather and traffic data. A single crash event produces one or more aggregative crash reports. Each new crash report is generated asynchronously as soon as new information is available on the Sentiance platform or on external data sources. So, we recommend to look for the latest file for a given crash event.
Crash reports are securely stored on Amazon S3. Reports will be generated in client-specific root folders with the following directory structure:
1
s3://sentiance-u1-crash-reports/<CLIENT_APP_ID>/<UTC_DATE>/<REPORT_ID>-<UTC_TIMESTAMP>.json.gz
Copied!
- CLIENT_APP_ID: The client app ID (e.g. 0000xxxxxxxxxxxxxxxxxxx).
- UTC_DATE: The date of the crash event in UTC timezone in
YYYY-MM-DDformat. - REPORT_ID: A unique identifier for a crash report, belonging to a single crash event.
- UTC_TIMESTAMP: Unix timestamp (UTC) in milliseconds of when the report was generated.
The procedure to access the crash report files in Amazon S3 is the same as that of offload files. Please refer to here.
A single crash report file may consist of multiple report segments. Each report segment contains different information related to the crash event.
- CRASH EVENT: This segment contains the most basic information about a crash event and is usually generated first and as soon as possible after a crash event occurs (though this may change in the subsequent reports due to the asynchronous nature of the Sentiance platform).
- TRANSPORTS: This segment contains information about one or more transports directly related to the crash event. Transports may include information like total distance traveled, trip waypoints, road types traveled, driving scores, and driving events.
- TIMELINE: This segment contains information about the user’s timeline before, during, and after a crash event. This may include either stationaries (venues/locations where the user remained static) or other transports.
- WEATHER: This segment contains information about the weather at the time and location of the crash event.
- TRAFFIC: This segment contains information about traffic conditions (traffic incidents and the traffic flow) at the time and location of the crash event.
Here you can find sample data for each of those segments:
CRASH EVENT
TRANSPORTS
TIMELINE
WEATHER
TRAFFIC
1
{
2
"reportId": "xxxx556a-XXXX-41cd-xxxx-3930936a875f",
3
"reportSegments": [
4
"INITIAL"
5
],
6
"reportTier": 3,
7
"userId": "5f3256cab1xxxxxxxxxxxxxxx",
8
"appId": "000000000xxxxxxxxxxxxxxx",
9
"correlationId": "c7a1xxxx-xxxx-xxxx-xxxx-91xxxxb144aa",
10
"sessionId": "D43DXXXX-xxxx-xxxx-xxxx-E54FCXXXX2EA",
11
"externalUserId": "abc123",
12
"processingTime": 1600439157581,
13
"crashEvent": {
14
"timestamp": 1599564413382,
15
"waypoint": {
16
"location": {
17
"latitude": 53.08163,
18
"longitude": 9.98515,
19
"horizontalAccuracy": 65,
20
"verticalAccuracy": 2,
21
"elevation": 4,
22
"provider": "GPS"
23
},
24
"timestamp": 1599564468547,
25
"base": 0,
26
"speed": -1.0,
27
"direction": -1
28
},
29
"sensorData": {
30
"type": "ACCELEROMETER",
31
"baseTimestamp": 1599564399613,
32
"baseOffsets": [
33
0,
34
40,
35
80,
36
...
37
],
38
"measurements": [
39
[
40
-0.028,
41
-0.063,
42
0.036,
43
...
44
],
45
[
46
-0.294,
47
-0.337,
48
-0.373,
49
...
50
],
51
[
52
-0.812,
53
-0.83,
54
-1.083,
55
...
56
]
57
]
58
},
59
"timezoneOffset": 120,
60
"maxMagnitude": 100,
61
"confidence": 75,
62
"severity": null,
63
"numberImpacts": null,
64
"speedAtImpact": 25.2,
65
"deltaV": 6.408,
66
"crashEventOrigin": "AUTOMATICALLY_DETECTED",
67
"roadType": "service",
68
"speedLimit": 15
69
},
70
"timelineEvents": [],
71
"weatherData": [],
72
"trafficIncidentData": [],
73
"trafficFlow": [],
74
"isSensorDataInStore": true,
75
"sensorDataReference": "8e1648ae-b866-4a34-8882-2a3ddfddf248",
76
"transportEventId": "52d0f5cxxxxxxxxxxx78ee4a6cedcc73bcad3xxxxxxxxxxxd8f63c",
77
"significantTransportMode": null,
78
"significantStationaryIds": [],
79
"atomId": null,
80
"speedBeforeImpact": null,
81
"speedAfterImpact": null,
82
"speedBeforeImpactTimestamp": null,
83
"speedAfterImpactTimestamp": null,
84
"speeding": null,
85
"speedingBeforeImpact": null,
86
"phoneHandling": null,
87
"phoneHandlingBeforeImpact": null,
88
"harshEvents": null,
89
"harshEventsBeforeImpact": null,
90
"speedingDistance": null,
91
"phoneHandlingSeconds": null,
92
"hardAccelerationTimes": null,
93
"hardBrakingTimes": null
94
}
Copied!
1
{
2
"reportId": "0a93556a-7602-41cd-ae30-3930936a875f",
3
"reportSegments": [
4
"INITIAL",
5
"TRANSPORTS"
6
],
7
"reportTier": 3,
8
"userId": "5f3256cab1xxxxxxxxxxxxxxx",
9
"appId": "000000000xxxxxxxxxxxxxxx",
10
"correlationId": "c7a1xxxx-xxxx-xxxx-xxxx-91xxxxb144aa",
11
"sessionId": "D43DXXXX-xxxx-xxxx-xxxx-E54FCXXXX2EA",
12
"externalUserId": "abc123",
13
"processingTime": 1600439159843,
14
"crashEvent": {...},
15
"timelineEvents": [
16
{
17
"timelineEventType": "com.sentiance.offloads.crash_report_aggregator.aggregated_crash_reports.AggregatedCrashReport$TimelineEvent$Transport",
18
"timelineEvent": {
19
"mode": "car",
20
"distance": 4401,
21
"waypoints": [
22
{
23
"location": {
24
"latitude": 53.08163,
25
"longitude": 9.98515,
26
"horizontalAccuracy": 65,
27
"verticalAccuracy": 2,
28
"elevation": 4,
29
"provider": "GPS"
30
},
31
"timestamp": 1599558857770
32
},
33
...
34
],
35
"trajectory": [
36
{
37
"location": {
38
"latitude": 53.08163,
39
"longitude": 9.98515,
40
"horizontalAccuracy": null,
41
"verticalAccuracy": null,
42
"elevation": null,
43
"provider": null
44
},
45
"timestamp": 1599564108000,
46
"roadType": "service",
47
"speedV2": 0,
48
"speedV2Confidence": 0.95,
49
"speedLimit": 50,
50
"distance": 50.1
51
},
52
...
53
],
54
"behaviorScores": {
55
"overall": 0.45,
56
"focus": 1,
57
"mounted": 0,
58
"hardAccel": 0.95,
59
"hardBrake": 0.95,
60
"hardEvents": 0.81,
61
"legalV2": 0.03,
62
"hardTurn": 0.6,
63
"smooth_V2": 0.51,
64
"anticipativeV2": 0.85,
65
"handheldCalling": 1,
66
"handheldCalling_duration": 0,
67
"handsfreeCalling": 0.11,
68
"handsfreeCalling_duration": 86,
69
"handlingWithoutCalling": 1,
70
"handlingWithoutCallingDuration": 0,
71
"attention": 0.7
72
},
73
"behaviorAnnotations": [
74
{
75
"behaviorAnnotationType": "com.sentiance.offloads.crash_report_aggregator.aggregated_crash_reports.AggregatedCrashReport$TimelineEvent$Transport$BehaviorAnnotation$AccelerationBehaviorAnnotation",
76
"behaviorAnnotation": {
77
"duration": 7233,
78
"accelerationType": "ACCELERATE",
79
"magnitude": 0.129,
80
"behaviorAnnotationType": "ACCELERATION",
81
"startTs": 1599564109238,
82
"endTs": 1599564116471
83
}
84
},
85
...
86
],
87
"occupantRole": "driver",
88
"timelineEventType": "TRANSPORT",
89
"eventId": "52d0f5cxxxxxxxxxxx78ee4a6cedcc73bcad3xxxxxxxxxxxd8f63c",
90
"startTs": 1599564108000,
91
"endTs": 1599564379000,
92
"analysisType": "INDEPTH"
93
}
94
}
95
],
96
"weatherData": [],
97
"trafficIncidentData": [],
98
"trafficFlow": [],
99
"isSensorDataInStore": true,
100
"sensorDataReference": "8e1648ae-b866-4a34-8882-2a3ddfddf248",
101
"transportEventId": "52d0f5cxxxxxxxxxxx78ee4a6cedcc73bcad3xxxxxxxxxxxd8f63c",
102
"significantTransportMode": true,
103
"significantStationaryIds": [],
104
"atomId": null,
105
"speedBeforeImpact": 31.4,
106
"speedAfterImpact": 35.8,
107
"speedBeforeImpactTimestamp": 1651554388852,
108
"speedAfterImpactTimestamp": 1651554382640,
109
"speeding": true,
110
"speedingBeforeImpact": true,
111
"phoneHandling": false,
112
"phoneHandlingBeforeImpact": false,
113
"harshEvents": false,
114
"harshEventsBeforeImpact": false,
115
"speedingDistance": 1.6816,
116
"phoneHandlingSeconds": 0,
117
"hardAccelerationTimes": 2,
118
"hardBrakingTimes": 0
119
}
Copied!
1
{
2
"reportId": "0a93556a-7602-41cd-ae30-3930936a875f",
3
"reportSegments": [
4
"INITIAL",
5
"TIMELINE"
6
],
7
"reportTier": 3,
8
"userId": "5f3256cab1xxxxxxxxxxxxxxx",
9
"appId": "000000000xxxxxxxxxxxxxxx",
10
"correlationId": "c7a1xxxx-xxxx-xxxx-xxxx-91xxxxb144aa",
11
"sessionId": "D43DXXXX-xxxx-xxxx-xxxx-E54FCXXXX2EA",
12
"externalUserId": "abc123",
13
"processingTime": 1600769125013,
14
"crashEvent": {...},
15
"timelineEvents": [
16
{
17
"timelineEventType": "com.sentiance.offloads.crash_report_aggregator.aggregated_crash_reports.AggregatedCrashReport$TimelineEvent$Stationary",
18
"timelineEvent": {
19
"location": {
20
"latitude": 53.08163,
21
"longitude": 9.98515,
22
"horizontalAccuracy": 65,
23
"verticalAccuracy": 2,
24
"elevation": 4,
25
"provider": "GPS"
26
},
27
"city": "Lokeren",
28
"country": "België / Belgique / Belgien",
29
"significance": "HOME",
30
"place": {
31
"name": null,
32
"categoryHierarchy": [
33
"residential"
34
],
35
"probability": null
36
},
37
"placeCandidates": [...],
38
"timelineEventType": "STATIONARY",
39
"eventId": "1e9xxxxxxxxxxxcb72279xxxxxxxxxxxxxxxxxxxxxxxxxxc444c",
40
"startTs": 1599493920000,
41
"endTs": 1599558857000,
42
"analysisType": "INDEPTH"
43
}
44
},
45
...
46
],
47
"weatherData": null,
48
"trafficIncidentData": null,
49
"trafficFlow": null,
50
"isSensorDataInStore": true,
51
"sensorDataReference": "8e1648ae-b866-4a34-8882-2a3ddfddf248",
52
"transportEventId": "52d0f5cxxxxxxxxxxx78ee4a6cedcc73bcad3xxxxxxxxxxxd8f63c",
53
"significantTransportMode": true,
54
"significantStationaryIds": [],
55
"atomId": null,
56
"speedBeforeImpact": 31.4,
57
"speedAfterImpact": 35.8,
58
"speedBeforeImpactTimestamp": 1651554388852,
59
"speedAfterImpactTimestamp": 1651554382640,
60
"speeding": true,
61
"speedingBeforeImpact": true,
62
"phoneHandling": false,
63
"phoneHandlingBeforeImpact": false,
64
"harshEvents": false,
65
"harshEventsBeforeImpact": false,
66
"speedingDistance": 1.6816,
67
"phoneHandlingSeconds": 0,
68
"hardAccelerationTimes": 2,
69
"hardBrakingTimes": 0
70
}
Copied!
1
{
2
"reportId": "0a93556a-7602-41cd-ae30-3930936a875f",
3
"reportSegments": [
4
"INITIAL",
5
"WEATHER"
6
],
7
"reportTier": 3,
8
"userId": "5f3256cab1xxxxxxxxxxxxxxx",
9
"appId": "000000000xxxxxxxxxxxxxxx",
10
"correlationId": "c7a1xxxx-xxxx-xxxx-xxxx-91xxxxb144aa",
11
"sessionId": "D43DXXXX-xxxx-xxxx-xxxx-E54FCXXXX2EA",
12
"externalUserId": "abc123",
13
"processingTime": 1600769125013,
14
"crashEvent": {...},
15
"timelineEvents": null,
16
"weatherData": [
17
{
18
"requestTime": 1599564582681,
19
"observationTime": 1599564540000,
20
"temperature": 18,
21
"feelsLike": 18,
22
"descriptions": [
23
"Overcast"
24
],
25
"windSpeed": 13,
26
"windDegree": 220,
27
"windDirection": "SW",
28
"pressure": 1027,
29
"precipitation": 0,
30
"humidity": 0.83,
31
"cloudcover": 1,
32
"uvIndex": 5,
33
"visibility": 10,
34
"isDay": true,
35
"solarAzimuthAngle": null,
36
"solarZenithAngle": null,
37
"solarGlare": null
38
},
39
...
40
],
41
"trafficIncidentData": null,
42
"trafficFlow": null,
43
"isSensorDataInStore": true,
44
"sensorDataReference": "8e1648ae-b866-4a34-8882-2a3ddfddf248",
45
"transportEventId": "52d0f5cxxxxxxxxxxx78ee4a6cedcc73bcad3xxxxxxxxxxxd8f63c",
46
"significantTransportMode": null,
47
"significantStationaryIds": [],
48
"atomId": null,
49
"speedBeforeImpact": null,
50
"speedAfterImpact": null,
51
"speedBeforeImpactTimestamp": null,
52
"speedAfterImpactTimestamp": null,
53
"speeding": null,
54
"speedingBeforeImpact": null,
55
"phoneHandling": null,
56
"phoneHandlingBeforeImpact": null,
57
"harshEvents": null,
58
"harshEventsBeforeImpact": null,
59
"speedingDistance": null,
60
"phoneHandlingSeconds": null,
61
"hardAccelerationTimes": null,
62
"hardBrakingTimes": null
63
}
Copied!
1
{
2
"reportId": "cbd23837-ee43-453d-b790-ad0dc6bde03f",
3
"reportSegments": [
4
"INITIAL",
5
"TRAFFIC"
6
],
7
"reportTier": 3,
8
"userId": "5f3256cab1xxxxxxxxxxxxxxx",
9
"appId": "000000000xxxxxxxxxxxxxxx",
10
"correlationId": "c7a1xxxx-xxxx-xxxx-xxxx-91xxxxb144aa",
11
"sessionId": "D43DXXXX-xxxx-xxxx-xxxx-E54FCXXXX2EA",
12
"externalUserId": "abc123",
13
"processingTime": 1600850025293,
14
"crashEvent": {...},
15
"timelineEvents": null,
16
"weatherData": null,
17
"trafficIncidentData": [
18
{
19
"trafficIncidents": [
20
{
21
"location": { // DEPRECATED (use locations field)
22
"latitude": 59.08163,
23
"longitude": 3.72515,
24
"horizontalAccuracy": 65,
25
"verticalAccuracy": 2,
26
"elevation": 4,
27
"provider": "GPS"
28
},
29
"incidentType": "ROAD_CLOSED",
30
"delayMagnitude": "UNDEFINED",
31
"description": "closed",
32
"cause": null, // DEPRECATED (always null now)
33
"roadsAffected": null,
34
"fromRoad": "Berkenstraat",
35
"toRoad": "Kattestraat",
36
"locations": [
37
{
38
"latitude": 59.08163,
39
"longitude": 3.72515,
40
"horizontalAccuracy": 65,
41
"verticalAccuracy": 2,
42
"elevation": 4,
43
"provider": "GPS"
44
}
45
],
46
"startTime": 1600506566818,
47
"endTime": 1600506596818
48
},
49
...
50
],
51
"requestTime": 1600506586818
52
},
53
],
54
"trafficFlow": [
55
{
56
"roadType": "LOCAL_IMPORTANT",
57
"currentSpeed": 21,
58
"freeFlowSpeed": 33,
59
"confidence": 0.8199999928474426,
60
"path": [
61
{
62
"latitude": 59.07537,
63
"longitude": 3.72688,
64
"horizontalAccuracy": null,
65
"verticalAccuracy": null,
66
"elevation": null,
67
"provider": null
68
},
69
...
70
],
71
"roadClosure": null,
72
"requestTime": 1600506586939
73
},
74
...
75
],
76
"isSensorDataInStore": true,
77
"sensorDataReference": "8e1648ae-b866-4a34-8882-2a3ddfddf248",
78
"transportEventId": "52d0f5cxxxxxxxxxxx78ee4a6cedcc73bcad3xxxxxxxxxxxd8f63c",
79
"significantTransportMode": null,
80
"significantStationaryIds": [],
81
"atomId": null,
82
"speedBeforeImpact": null,
83
"speedAfterImpact": null,
84
"speedBeforeImpactTimestamp": null,
85
"speedAfterImpactTimestamp": null,
86
"speeding": null,
87
"speedingBeforeImpact": null,
88
"phoneHandling": null,
89
"phoneHandlingBeforeImpact": null,
90
"harshEvents": null,
91
"harshEventsBeforeImpact": null,
92
"speedingDistance": null,
93
"phoneHandlingSeconds": null,
94
"hardAccelerationTimes": null,
95
"hardBrakingTimes": null
96
}
Copied!
The data model of the fields in the above sample segments of the crash report are explained in the attached file.
data-model-crash-reports.xlsx
124KB
Binary
data model - crash report
Last modified 1mo ago