VisionMax (1.2.0)

Download OpenAPI specification:Download



What is VisionMax?

VisionMax is a total solution developed by MiTAC Digital Inc.

It consists of 2 parts:

  • master portal
  • fleet portal

This API document is for master and fleet portals, API documents for other components are provided in other place of service site.

  • Master portal:
    an AWS cloud server for resellers to manage their fleets and devices and drivers under the fleets.
    There is a billing service for bill history data review
  • Fleet portal:
    an AWS cloud server for fleet managers managing the fleet’s devices and drivers, including broad features like: live view, real-time and historical route data, enroll and remove devices, binding devices with certain driver, view event video, request video OTA, watch device health status and run diagnostics

Access

***You must place the API key in the HTTP header to access endpoints.***
All API endpoints of the VisionMax, except login/logout and forgot password requires an access_token
Any registered account can obtain an access token from /auth endpoint.


Camera ID

Camera ID From camera
C_F Front camera
C_I In-cabin camera
C_R Rear camera
C_E The extended cameras. Extended cameras generally refer to TVI cameras.

Camera capture mode

VisionMax defines several camera image capture modes and applies them to the filename.
Additionally, VisionMax treats the capture mode as a camera ID in some cases.

Capture mode/Camera ID From camera
C_F Front camera
C_I In-cabin camera
C_R Rear camera
C_E The extended cameras
GRID The combined video from 4TVI cameras with GRID are considered legacy
S_F_I The combined video from the front and in-cabin
2TVI cameras with S_F_I are considered legacy

Connectivity state

VisionMax defines four statuses to describe the connection status of a device.

state desc
online The device reports its location to the server in the latest 30 seconds
offline The device never sends the heartbeat signal over 20 + 3 (threshold) minutes.
standby When the device receives the acc-off(ignition off) signal, it sends a heartbeat every 20 minutes to keep the connection alive.
The device usually can accept a wakeup message at standby mode
waking_up The server sends a wake-up signal to the device. The device should be back online in a very short time.
If the device can not go back online in the next 5 seconds, its state will change to offline immediately.

Event types

event_type key display_name hook_able Default upload type
1 collision Impact video
2 parking Parking_deprecated video
3 speeding Speeding_deprecated
4 assistance Manual Event video
5 startup Start Up
6 RapidAcceleration Harsh Acceleration minor: video
moderate: video
Severe: video
7 SuddenDeceleration Harsh Braking minor: video
moderate: video
Severe: video
8 AbruptSteering Harsh Cornering minor: video
moderate: video
Severe: video
9 idling Idling
10 geofence Geofence
11 geofence in Geofence in
12 parking collision Parking Impact video
13 Engine Off Engine Off snapshot
14 Battery low Battery Low
15 Battery cut Power Outage
19 Harsh cornering Harsh cornering_deprecated
20 Harsh accelerating Harsh accelerating_deprecated
21 Nodding off Sleepy (eye closed)/Fatgiue video
22 Distraction Distracted video
27 Manual:video Manual:video video
28 Manual:snapshot Manual:snapshot
29 Manual:burst Manual:burst
30 FCWS Frontal Collision snapshot
31 Tailgating Tailgating video
32 LaneDrift Lane Departure video
33 StopAndGo Stop and Go video
34 CellPhoneUse Cell Phone Usage video
35 Yawn Yawning
36 FaceID FaceID snapshot
37 NFC clock in NFC clock in snapshot
39 Unfastened seatbelt Seat Belt Unfastened snapshot
40 Camera tampered Camera tampered video
41 Motion Detect Motion detect
47 Speed Camera Speed Camera Violation minor: snapshot
moderate: snapshot
Severe: video
48 Rolling Stop Rolling Stop video
49 Railroad Crossing Railroad Crossing Violation
50 School Zone Speed School Zone Speed Violation
51 Speed Sign Speed Sign
52 BSIS BSIS
53 ADAS failure ADAS failure
54 DMS failure DMS Off snapshot
55 ADAS recovery ADAS recovery
56 DMS recovery DMS recovery
60 end idling end idling
61 cover removed I/O Cover Removed
62 cover recovered I/O cover recovered
63 PCWS Pedestrian Collision Warning
69 custom-ext custom extended
71 lens covered Lens covered