Skip to content

Mobile-Telematics/telematics-open-source-app-ios

Repository files navigation

iOS Open-Source Telematics App

Description

This Telematics App is developed by Damoov and is distributed free of charge. This app can be used to create your own telematics app for iOS in few steps.

Quick Start: TelematicsSDK Integration Guide

Before you begin configuration and setup, please review the official TelematicsSDK integration guide: ➡️ TelematicsSDK Docs & Setup Instructions
This guide contains step-by-step instructions for integrating and configuring the SDK in your iOS project.

Setup Telematics App BaseConfigurator.plist and MainConfigurator.plist files

For your convenience, we have created a standard iOS files with parameters named BaseConfigurator.plist and MainConfigurator.plist, where you can specify the basic settings for your future app. Using this file, you can configure the basic parameters of your application by specifying server addresses, basic settings and links, as well as specifying several images for an individual design. Carefully study the parameters provided below for further work.

MainConfigurator.plist

Settings Key Value
configName Default Your app configuration name. Not need to change, you can use any of your choice. By default TelematicsApp_MainConfiguration
xAPIKey Your Damoov X-API-KEY for backend requests. Required!
linkSupportEmail Contact support email address for your app users.
googleApiKey Your Google Maps API key for iOS Maps integration.
muxEnvKey Your MUX environment key for video analytics integration (used with MUX SDK).
intercomApiId Your Intercom Application ID for in-app chat/support.
intercomApiKey Your Intercom API Key for in-app chat/support.
appStoreAppId Your unique APP ID for the AppStore
linkPrivacyPolicy URL to your Privacy Policy page.
linkTermsOfUse URL to your Terms of Use page.

BaseConfigurator.plist

Settings Key Value
configName Default Your app configuration name. Not need to change, you can use any of your choice. By default TelematicsApp_BaseConfiguration
userServiceRootURL Root URL for user authorization and management API
indicatorsServiceURL Basic https address to work with Indicators APIs. By default, we provide you https-address of our TEST servers for debugging. Before the release your app, you can get the addresses to enter PRODUCTION environment
driveCoinsServiceURL Basic https address to work with DriveCoins API.
leaderboardServiceURL Basic https address to work with the user leaderboard and Leaderboard API.
carServiceURL Basic https address to work with CarService API.
linkHowItWorks Link for How It Works
telematicsSettingsOS12 Link for Telematics Settings before iOS13
telematicsSettingsOS13 Link for Telematics Settings for iOS13/iOS14
mainLogoColor App logo in color style for display in app. Specifies the file name to use.
mainLogoClear App logo in transparent style for display in the app. Specifies the file name to use.
mainBackgroundImg Asset image name used in the Feed or Profile screen
additionalBackgroundImg Asset image name used in the Dashboard screen
mainTabBarNumber TabBar number, which will open first when the application starts. By default 0
dashboardTabBarNumber TabBar number, where Dashboard will open. By default 0
feedTabBarNumber TabBar number, defining what the Feed screen will be in turn in the application. By default 1
leaderboardTabBarNumber TabBar number for the Leaderboard section
rewardsTabBarNumber TabBar number for the Rewards section
profileTabBarNumber TabBar number, defining what the Profile screen will be in turn in the application. By default 2
needUserDriveDistanceForScoringKm The minimum distance required to display Indicators statistics and user scores. By default 10 km
needTripsDeleting BOOL parameter, determining if user can delete their trips
needDistanceInMiles BOOL parameter, determining use the default distance traveled in the entire application in km/miles
needAmPmTime BOOL parameter, determining use AM/PM time format in the entire application
sdkEnableELM BOOL parameter, that activates connection to ELM OBD Bluetooth devices in Telematics SDK. Default is true
needEventsReviewButton BOOL parameter, allowing to mark events on the map
enableDashboardTripRecordingMode Enable trip recording mode switch on Dashboard (BOOL)
enableDashboardStatistics Enable statistics section on Dashboard (BOOL)
enableDashboardVideo Enable video tips section on Dashboard (BOOL)
enableDashboardScoreTrend Enable score trend visualization on Dashboard (BOOL)
enableDashboardAnnualSummary Enable annual driving summary on Dashboard (BOOL)
enableDashboardEcoScore Enable eco-driving score section on Dashboard (BOOL)
enableDashboardLastTrip Enable display of last trip on Dashboard (BOOL)
enableDashboardDrivingStrakes Enable driving streaks section on Dashboard (BOOL)
enableDashboardLeaderboard Enable leaderboard section on Dashboard (BOOL)

Get Google Map API key

In the next few simple steps, we'll show you how easy it is to create access keys in the Google Cloud Console.

Step 1: After sign in your Google account open https://console.cloud.google.com/

Step 2: Create new project in Google Cloud Console: https://console.cloud.google.com/projectcreate

Step 3: Set billing for this project: https://console.cloud.google.com/projectselector/billing Note: use of maps is free

Step 4: Enable MapsSDK for iOS

Step 5: Go to the Google Maps Platform → Credentials page → Create credentials → API key.

More info here: https://developers.google.com/maps/documentation/ios-sdk

Advanced Settings

To fully understand how the Telematics SDK and all our services work, use our detailed docs and guides https://docs.damoov.com to make all the process as easy as possible.

Happy coding!

Links

Official product Web-page

Official API services web-page

Official API references

Official ZenRoad web-page

Official ZenRoad app for iOS

Official ZenRoad app for Android

Copyright © 2020-2025 DAMOOV PTE.LTD. All rights reserved.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published