Merge pull request #4 from barnhill/cleanup

barnhill · web-flow · commit 9437e7085ac6 · 2022-10-11T21:58:35.000-05:00
Cleanup and update dependencies
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![AndroidOBD CI](https://github.com/barnhill/AndroidOBD/workflows/AndroidOBD%20CI/badge.svg) [![API](https://img.shields.io/badge/API-17%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=17)
+![AndroidOBD CI](https://github.com/barnhill/AndroidOBD/workflows/AndroidOBD%20CI/badge.svg) [![API](https://img.shields.io/badge/API-24%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=24)
 
 ## Android OBD Library
 
@@ -9,14 +9,28 @@ This project offers a developer friendly interface to communicate with ELM 327 O
 
 ### Usage ###
 
-To use:
+Add Dependency:
 ```Gradle
-implementation 'com.pnuema.android:obd:1.0.4'
+implementation 'com.pnuema.android:obd:1.2.0'
 ```
 
-### Contribution guidelines ###
+Code:
+```
+//Request MODE 1, PID 0C - RPM
+val pid = PID(ObdModes.MODE_01, "0C")
+val command = OBDCommand(pid)
+command.run(bluetoothSocket.inputStream, bluetoothSocket.outputStream)
+
+Log.d("PID", "${pid.description} : ${pid.calculatedResult}")
+Log.d("PID Formatted Result", command.formattedResult)
+```
 
-TODO
+```
+//Clear DTCs - NonPermanent
+val pid = PID(ObdModes.MODE_04) //Clear DTCs
+val command = OBDCommand(pid)
+command.run(bluetoothSocket.inputStream, bluetoothSocket.outputStream)
+```
 
 ### Who do I talk to? ###
 
diff --git a/build.gradle b/build.gradle
@@ -3,22 +3,22 @@ apply plugin: "com.vanniktech.maven.publish"
 
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 wrapper {
-    gradleVersion = '7.4'
+    gradleVersion = '7.5.1'
 }
 
 buildscript {
-    ext.kotlin_version = '1.6.10'
+    ext.kotlin_version = '1.7.10'
     repositories {
         google()
         mavenCentral()
         mavenLocal()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.0.4'
+        classpath 'com.android.tools.build:gradle:7.2.2'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
-        classpath "org.jetbrains.dokka:dokka-gradle-plugin:$kotlin_version"
-        classpath 'com.vanniktech:gradle-maven-publish-plugin:0.18.0'
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.6.0"
+        classpath 'com.vanniktech:gradle-maven-publish-plugin:0.20.0'
     }
 }
 
diff --git a/gradle.properties b/gradle.properties
@@ -18,12 +18,14 @@
 # org.gradle.parallel=true
 
 android.enableJetifier=true
-org.gradle.jvmargs=-Xmx2548M -Dkotlin.daemon.jvm.options\="-Xmx2548M"
+org.gradle.jvmargs=-Xmx1548M -Dkotlin.daemon.jvm.options\="-Xmx2548M"
 android.useAndroidX=true
 org.gradle.caching=true
 
+android.disableAutomaticComponentCreation=true
+
 GROUP=com.pnuema.android
-VERSION_NAME=1.0.4
+VERSION_NAME=1.2.0
 
 POM_NAME=Android OBD Library
 POM_ARTIFACT_ID=obd
@@ -40,4 +42,7 @@ POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt
 POM_LICENCE_DIST=repo
 POM_DEVELOPER_ID=barnhill
 POM_DEVELOPER_NAME=Brad Barnhill
-POM_DEVELOPER_URL=https://github.com/barnhill/
+POM_DEVELOPER_URL=https://github.com/barnhill/
+
+SONATYPE_HOST=DEFAULT
+RELEASE_SIGNING_ENABLED=true
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
diff --git a/gradlew.bat b/gradlew.bat
diff --git a/obd/build.gradle b/obd/build.gradle
@@ -5,7 +5,7 @@ apply plugin: 'kotlinx-serialization'
 apply plugin: 'org.jetbrains.dokka'
 apply plugin: "com.vanniktech.maven.publish"
 
-version = "1.0.4"
+version = "1.2.0"
 group = "com.pnuema.android"
 
 ext {
@@ -16,11 +16,11 @@ ext {
 }
 
 android {
-    compileSdkVersion 31
+    compileSdkVersion 33
 
     defaultConfig {
-        minSdkVersion 17
-        targetSdkVersion 31
+        minSdkVersion 24
+        targetSdkVersion 33
         versionCode 1
         versionName version
     }
@@ -39,13 +39,12 @@ android {
 
     kotlinOptions {
         jvmTarget = JavaVersion.VERSION_11.toString()
-        useIR = true
     }
 }
 
 dependencies {
-    implementation 'com.udojava:EvalEx:2.6'
-    implementation 'org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.0'
+    implementation 'com.udojava:EvalEx:2.7'
+    implementation 'org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2'
     implementation "androidx.startup:startup-runtime:1.1.1"
 }
 
diff --git a/obd/src/main/java/com/pnuema/android/obd/ObdInitializer.kt b/obd/src/main/java/com/pnuema/android/obd/ObdInitializer.kt
@@ -8,7 +8,7 @@ import com.pnuema.android.obd.statics.ObdLibrary
 @Suppress("unused") //inited in the manifest
 class ObdInitializer: Initializer<Context> {
     override fun create(context: Context): Context {
-        ObdLibrary.init(context as? Application ?: error("ObdLibrary could not be initialized"))
+        ObdLibrary.init(context as Application)
         return context
     }
 
diff --git a/obd/src/main/java/com/pnuema/android/obd/commands/BaseObdCommand.kt b/obd/src/main/java/com/pnuema/android/obd/commands/BaseObdCommand.kt
@@ -10,12 +10,17 @@
  * License for the specific language governing permissions and limitations under
  * the License.
  */
+@file:Suppress("unused")
+
 package com.pnuema.android.obd.commands
 
 import com.pnuema.android.obd.models.PID
 import com.pnuema.android.obd.statics.PersistentStorage
-import java.io.*
-import java.util.*
+import java.io.BufferedReader
+import java.io.IOException
+import java.io.InputStream
+import java.io.InputStreamReader
+import java.io.OutputStream
 import kotlin.system.measureTimeMillis
 
 /**
@@ -41,7 +46,7 @@ abstract class BaseObdCommand {
 
         private fun readPersistent() {
             if (mPid.isPersistent && PersistentStorage.containsPid(mPid)) {
-                mPid.calculatedResult = PersistentStorage.getElement(mPid)?.calculatedResult?:0f
+                mPid.calculatedResult = PersistentStorage.getElement(mPid)?.calculatedResult ?: 0f
                 mPid.calculatedResultString = PersistentStorage.getElement(mPid)?.calculatedResultString
                 mPid.data = PersistentStorage.getElement(mPid)?.data
             }
@@ -98,7 +103,7 @@ abstract class BaseObdCommand {
      *
      * @param other the ObdCommand to copy.
      */
-    constructor(other: BaseObdCommand) : this(other.cmd) {}
+    constructor(other: BaseObdCommand) : this(other.cmd)
 
     /**
      * This method exists so that for each command, there must be a method that is
@@ -168,18 +173,10 @@ abstract class BaseObdCommand {
     private fun fillBuffer() {
         // read string each two chars
         buffer.clear()
-        val data = rawData ?: return
-        var begin = 0
-        var end = 2
-        while (end <= data.length) {
+        rawData?.chunked(2)?.forEach {
             try {
-                buffer.add(Integer.decode("0x" + data.substring(begin, end)))
-            } catch (e: NumberFormatException) {
-                break
-            }
-
-            begin = end
-            end += 2
+                buffer.add(Integer.decode("0x$it"))
+            } catch (e: NumberFormatException) { return }
         }
     }
 
diff --git a/obd/src/main/java/com/pnuema/android/obd/commands/OBDCommand.kt b/obd/src/main/java/com/pnuema/android/obd/commands/OBDCommand.kt
@@ -10,6 +10,8 @@
  * License for the specific language governing permissions and limitations under
  * the License.
  */
+@file:Suppress("unused")
+
 package com.pnuema.android.obd.commands
 
 import android.util.Log
diff --git a/obd/src/main/java/com/pnuema/android/obd/enums/ObdModes.kt b/obd/src/main/java/com/pnuema/android/obd/enums/ObdModes.kt
@@ -19,6 +19,7 @@ import java.lang.Long.parseLong
  *
  * @author Brad Barnhill
  */
+@Suppress("unused")
 enum class ObdModes constructor(val value: Char) {
     /**
      * This mode returns the common values for some sensors
@@ -73,7 +74,5 @@ enum class ObdModes constructor(val value: Char) {
     val intValue: Int
         get() = parseLong(value.toString(), 16).toInt()
 
-    override fun toString(): String {
-        return value.toString()
-    }
+    override fun toString(): String = value.toString()
 }
diff --git a/obd/src/main/java/com/pnuema/android/obd/enums/ObdProtocols.kt b/obd/src/main/java/com/pnuema/android/obd/enums/ObdProtocols.kt
@@ -17,6 +17,7 @@ package com.pnuema.android.obd.enums
  *
  * @author Brad Barnhill
  */
+@Suppress("unused")
 enum class ObdProtocols constructor(val value: Char) {
 
     /**
diff --git a/obd/src/main/java/com/pnuema/android/obd/models/DTC.kt b/obd/src/main/java/com/pnuema/android/obd/models/DTC.kt
@@ -10,6 +10,8 @@
  * License for the specific language governing permissions and limitations under
  * the License.
  */
+@file:Suppress("unused")
+
 package com.pnuema.android.obd.models
 
 import com.pnuema.android.obd.enums.ObdModes
@@ -33,7 +35,7 @@ data class DTC (
      * @return DTC object with the mode set. (returns object for method chaining support)
      */
     fun setMode(mode: ObdModes): DTC {
-        this.mode = "0" + mode.value
+        this.mode = "0${mode.value}"
 
         return this
     }
diff --git a/obd/src/main/java/com/pnuema/android/obd/models/PID.kt b/obd/src/main/java/com/pnuema/android/obd/models/PID.kt
@@ -50,6 +50,10 @@ data class PID (
     var retrievalTime: Long = 0
     var isPersistent: Boolean = false
 
+    constructor(mode: ObdModes, pid: String = ""): this() {
+        setModeAndPID(mode, pid)
+    }
+
     /**
      * Sets the mode of the PID
      *
diff --git a/obd/src/main/java/com/pnuema/android/obd/statics/DTCUtils.kt b/obd/src/main/java/com/pnuema/android/obd/statics/DTCUtils.kt
@@ -24,6 +24,7 @@ import java.io.IOException
  *
  * @author Brad Barnhill
  */
+@Suppress("unused")
 object DTCUtils {
     val dtcList: List<DTC>
         @Throws(IOException::class)
diff --git a/obd/src/main/java/com/pnuema/android/obd/statics/FileUtils.kt b/obd/src/main/java/com/pnuema/android/obd/statics/FileUtils.kt
@@ -21,30 +21,17 @@ object FileUtils {
     @Throws(IOException::class)
     fun readFromFile(fileName: String): String {
         val returnString = StringBuilder()
-        var fIn: InputStream? = null
-        var isr: InputStreamReader? = null
-        var input: BufferedReader? = null
 
-        try {
-            fIn = ObdLibrary.getResourceFileInputStream(fileName)
+        val fIn = ObdLibrary.getResourceFileInputStream(fileName)
+            ?: error("Could not read resource files. ObdLibrary not initialized.")
 
-            if (fIn == null) {
-                error("Could not read resource files. ObdLibrary not initialized.")
-            }
-
-            isr = InputStreamReader(fIn)
-            input = BufferedReader(isr)
-            var line = input.readLine()
-            while (line != null) {
-                returnString.append(line)
-                line = input.readLine()
-            }
-        } finally {
-            try {
-                isr?.close()
-                fIn?.close()
-                input?.close()
-            } catch (ignored: Exception) {
+        InputStreamReader(fIn).use { isr ->
+            BufferedReader(isr).use { input ->
+                var line = input.readLine()
+                while (line != null) {
+                    returnString.append(line)
+                    line = input.readLine()
+                }
             }
         }
 
diff --git a/obd/src/main/java/com/pnuema/android/obd/statics/ObdLibrary.kt b/obd/src/main/java/com/pnuema/android/obd/statics/ObdLibrary.kt
@@ -20,7 +20,7 @@ import java.io.InputStream
  *
  * @author Brad Barnhill
  */
-object ObdLibrary {
+internal object ObdLibrary {
     fun init(applicationContext: Application) {
         this.applicationContext = applicationContext
     }
diff --git a/obd/src/main/java/com/pnuema/android/obd/statics/PIDUtils.kt b/obd/src/main/java/com/pnuema/android/obd/statics/PIDUtils.kt
diff --git a/obd/src/main/java/com/pnuema/android/obd/statics/PersistentStorage.kt b/obd/src/main/java/com/pnuema/android/obd/statics/PersistentStorage.kt

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import com.pnuema.android.obd.statics.ObdLibrary`
`8`	`8`	`@Suppress("unused") //inited in the manifest`
`9`	`9`	`class ObdInitializer: Initializer<Context> {`
`10`	`10`	`override fun create(context: Context): Context {`
`11`		`- ObdLibrary.init(context as? Application ?: error("ObdLibrary could not be initialized"))`
	`11`	`+ ObdLibrary.init(context as Application)`
`12`	`12`	`return context`
`13`	`13`	`}`
`14`	`14`