"The Vehicle Connect application is a sample app developed using the Android Vehicle Connect SDK. It showcases the API interfaces used to perform remote operations on vehicles and related components. Developers can use this sample as a reference for building their own remote operation applications.
- Getting Started
- How to contribute
- Built with Dependencies
- Code of Conduct
- Authors
- Security Contact Information
- Support
- Troubleshooting
- Note
- License
- Announcements
Take clone of the project using the command (git clone https://github.com/eclipse-ecsp/androidVehicleConnectApp.git) and setup android studio and load the project. This app demonstrate the use of vehicleConnectSDK functions. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
The list of tools required to build and run the project:
- Java 1.8
- Android Studio
- Download the app source code and open the application using Android studio
- You can find the app’s source code, including how it interacts with the SDK APIs. This can be reused as a reference for developing your own remote operations features.
- Set up your own server and deploy the required APIs using appropriate server-side components. Once deployed, update the server details in the environment configuration file located at: app/src/main/assets/environment_file.json to run the application properly.
- The Vehicle Connect SDK uses the OAuth library for its login flow. It is important to ensure that the URL scheme defined in the SDK's manifest file matches the Redirect URL specified in the application's environment_file.json file. Consistency between these values is essential for the authentication flow to function correctly.
Check the Coding Guideline document: Android Coding Guidelines.pdf Use android lint for code warnings and errors
Clone the project from GitHub, open it in Android Studio, run a Gradle sync, and then perform a rebuild process. Generate the APK or AAB file using Android Studio, and install the APK on an Android device running Android 7.0 (API level 24) or higher. Navigate through the application screens to explore the vehicle features supported by the Vehicle Connect SDK.
- VehicleConnectSDK - Vehicle Connect SDK library
- Retrofit- For network operation Management
- Android Lint tool - Coding convention and style guide
Please read CONTRIBUTING.md for details on our contribution guidelines, and the process for submitting pull requests to us.
Please read CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.
Check here the list of contributors who participated in this project.
Please read SECURITY.md to raise any security related issues.
Contact the project developers via the project's "dev" list - ecsp-dev
Please read CONTRIBUTING.md for details on how to raise an issue and submit a pull request to us.
License scanning for third-party libraries in the application excludes Firebase library dependencies. As Firebase libraries are not open source, they are rejected by the scanning tool. Consequently, these dependencies were removed from the dependency collection list prior to initiating the license scan.
Firebase libraries are utilized to implement the notification flow within the application.
This project is licensed under the Apache-2.0 License - see the LICENSE file for details.
All updates to this library are present in our releases page. For the versions available, see the tags on this repository.