Merge pull request #7 from k4biri/develop

Prepare Release 0.6.0

Author: superus8r

.gitignore

@@ -81,3 +81,4 @@ lint/generated/
 lint/outputs/
 lint/tmp/
 # lint/reports/
+app/src/main/res/values/api_keys.xml

.idea/misc.xml

@@ -5,6 +5,11 @@
 
  This is being done as a hobby, and for experimenting, so probably there might be some flaws; As an example, the vendor ID of Arduino is hardcoded to only work with Arduino devices, but this is my use case and please feel free to change it to match your needs.
 
+ # Build and Run
+ The app is available for free on Google Play Store (Arduino USB Terminal).
+ Otherwise, you can clone the project and run it locally.
+ Please read the **Sentry Reports** part on this page before running the project to avoid build failures. 
+ 
  ## Terminal
  A Simple terminal page which does what it is supposed to do interacting with an Arduino manually through the USB cable.
 
@@ -14,9 +19,20 @@
  ## Tests
  Under Construction
 
+ ## Sentry Reports
+ The project uses Sentry for the crash reports, if this is not needed, you can remove the following line in `AndroidManifest.xml`:
+ `<meta-data android:name="io.sentry.dsn" android:value="@string/sentry_dsn" />`
+ But if it is needed, you need to [create a Sentry dsn value](https://docs.sentry.io/platforms/android/) to put under the following path:
+ `app/src/main/res/values/api_keys.xml`
+ The file contents might look like similar to this:
+ `<?xml version="1.0" encoding="utf-8"?>
+  <resources>
+      <string name="sentry_dsn" translatable="false">YOUR_SENTRY_SPECIFIC_VALUE</string>
+  </resources>`
+ 
+ 
  ### Knows Issues
- _On Android 5.1.1, the Arduino serial output cannot be shown. (It is said that an Android internal bug is the issue!)_ This was hopefully solved using LiveData
- The Arduino output characters might be shown a bit weird in the app while skipping some characters when the message is too long. This will be fixed as I figure out the reason! Any suggestions will be appreciated. :) 
+ _Still unknown! :) 
 
  Suggestions and PRs are welcome! :)
 

README.md

@@ -3,9 +3,13 @@ apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 apply plugin: 'koin'
 
+repositories {
+    jcenter()
+}
+
 android {
     compileSdkVersion 29
-    buildToolsVersion "29.0.2"
+    buildToolsVersion "29.0.3"
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
@@ -16,8 +20,8 @@ android {
         applicationId "org.kabiri.android.usbterminal"
         minSdkVersion 23
         targetSdkVersion 29
-        versionCode 5
-        versionName "0.5.0"
+        versionCode 6
+        versionName "0.6.0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
@@ -39,6 +43,9 @@ dependencies {
     implementation 'androidx.core:core-ktx:1.2.0'
     implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
 
+    // Sentry Tracking
+    implementation 'io.sentry:sentry-android-core:2.0.2'
+
     // Koin for Android - ViewModel features
     implementation "org.koin:koin-android-viewmodel:$koin_version"
 

app/build.gradle

@@ -3,6 +3,8 @@
     package="org.kabiri.android.usbterminal">
 
     <uses-feature android:name="android.hardware.usb.host" />
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 
     <application
         android:name=".MainApplication"
@@ -13,6 +15,9 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
+
+        <meta-data android:name="io.sentry.dsn" android:value="@string/sentry_dsn" />
+
         <activity android:name=".MainActivity">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />

app/src/main/AndroidManifest.xml

@@ -1,6 +1,5 @@
 package org.kabiri.android.usbterminal
 
-import android.content.Intent
 import android.os.Bundle
 import android.text.SpannableString
 import android.text.method.ScrollingMovementMethod
@@ -10,10 +9,12 @@ import android.view.MenuInflater
 import android.view.MenuItem
 import androidx.appcompat.app.AppCompatActivity
 import androidx.lifecycle.Observer
+import io.sentry.core.Sentry
 import kotlinx.android.synthetic.main.activity_main.*
 import org.kabiri.android.usbterminal.viewmodel.MainActivityViewModel
 import org.koin.android.viewmodel.ext.android.viewModel
 
+
 class MainActivity : AppCompatActivity() {
 
     companion object {

app/src/main/java/org/kabiri/android/usbterminal/MainActivity.kt

@@ -1,12 +1,11 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-    ext.kotlin_version = '1.3.71'
+    ext.kotlin_version = '1.3.72'
     ext.koin_version = '2.1.5'
     repositories {
         google()
         jcenter()
-        
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:3.6.3'