update version, add readme

barnhill · Oct 12, 2022 · f2209b6 · f2209b6
1 parent df33563
commit f2209b6
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -9,14 +9,20 @@ 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.1.0'
+implementation 'com.pnuema.android:obd:1.2.0'
 ```
 
-### Contribution guidelines ###
+Code:
+```
+val pid = PID(ObdModes.MODE_01, "01")
+val command = OBDCommand(pid)
+command.run(bluetoothSocket.inputStream, bluetoothSocket.outputStream)
 
-TODO
+Log.d("PID", "${pid.description} : ${pid.calculatedResult}")
+Log.d("PID Formatted Result", command.formattedResult)
+```
 
 ### Who do I talk to? ###
 

diff --git a/gradle.properties b/gradle.properties
@@ -25,7 +25,7 @@ org.gradle.caching=true
 android.disableAutomaticComponentCreation=true
 
 GROUP=com.pnuema.android
-VERSION_NAME=1.1.0
+VERSION_NAME=1.2.0
 
 POM_NAME=Android OBD Library
 POM_ARTIFACT_ID=obd

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.1.0"
+version = "1.2.0"
 group = "com.pnuema.android"
 
 ext {

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
      *