Creating a unified SDK experience for Android development is essential for seamless integration, especially considering the challenges we've faced while integrating various Telpo devices. The diversity in interaction methods with accessories across different devices has proven to be a significant obstacle. Moreover, integrating products from various vendors has led to conflicts, primarily due to the use of different Serial libraries for each device.
One area of improvement is in the naming conventions. For instance, the current convention "Utils.init(this);" or "SDKUtil.getInstance(MyActivity.this).initSDK();" lacks clarity and consistency. A suggestion would be to introduce a prefix, such as "Telpo," to make SDK names more distinctive. This would contribute to a more straightforward and standardized development process.
Additionally, the requirement to manually copy .so files into folders raises questions. Providing clarification on the necessity of this step or finding alternative, more user-friendly methods for file management would greatly enhance the developer experience.
To streamline the entire process, it's crucial to produce consistent documentation that clearly outlines the integration steps. This documentation should be complemented by an easily includable .aab file, simplifying the setup for developers and minimizing potential conflicts.
Suggestions:
- Standardize SDK names by introducing a clear prefix, such as "Telpo," for better differentiation.
- Reevaluate the necessity of manually copying .so files into folders and explore more user-friendly alternatives.
- Provide comprehensive documentation accompanied by an easily includable .aar file to ensure a smoother integration process for Android developers.
- Ideally, publish SDK source code and related files on GitHub which is the global standard
I suggest following article from Google: https://developer.android.com/studio/projects/android-library