Merge pull request #7 from strykeforce/fix/pid-display-precision

Display PID parameters with 4 sig. digits

Author: jhh

build.gradle

@@ -1,10 +1,10 @@
 plugins {
 
-    id "org.jetbrains.kotlin.jvm" version "1.3.11"
+    id "org.jetbrains.kotlin.jvm" version "1.3.20"
     id "idea"
 }
 
-version = "19.1.3"
+version = "19.2.0"
 
 repositories {
     jcenter()

gradle.properties

@@ -1,5 +1,5 @@
 kotlin.code.style=official
-kotlin_version = 1.3.11
+kotlin_version = 1.3.20
 junit_version = 5.2.0
 koin_version = 1.0.2
-thirdcoast_version = 19.1.0
+thirdcoast_version = 19.1.2

src/main/kotlin/org/strykeforce/thirdcoast/Readers.kt

@@ -4,7 +4,7 @@ import org.jline.reader.EndOfFileException
 import org.jline.reader.LineReader
 import org.jline.reader.UserInterruptException
 import org.jline.terminal.Terminal
-import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT
+import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT_4
 import org.strykeforce.thirdcoast.command.MenuCommand
 import org.strykeforce.thirdcoast.command.prompt
 import kotlin.math.roundToInt
@@ -25,7 +25,7 @@ fun LineReader.readDouble(
 ): Double {
     val buffer =
         if (truncate && default == Math.floor(default)) default.roundToInt().toString()
-        else DOUBLE_FORMAT.format(default)
+        else DOUBLE_FORMAT_4.format(default)
     return try {
         val line = this.readLine(prompt, null, buffer).trim()
         if (line.isEmpty()) throw EndOfFileException()

src/main/kotlin/org/strykeforce/thirdcoast/command/Command.kt

@@ -103,7 +103,7 @@ abstract class AbstractCommand(
 
     protected fun formatMenu(value: Int) = formatMenu(value.toString())
 
-    protected fun formatMenu(value: Double) = formatMenu(DOUBLE_FORMAT.format(value))
+    protected fun formatMenu(value: Double, format: String = DOUBLE_FORMAT_3) = formatMenu(format.format(value))
 
     protected fun formatMenu(value: String) =
         "$tomlMenu: ${AttributedString(value, AttributedStyle.DEFAULT.foreground(AttributedStyle.YELLOW)).toAnsi()}"

src/main/kotlin/org/strykeforce/thirdcoast/command/Parameter.kt

@@ -6,7 +6,8 @@ import org.jline.reader.LineReader
 import org.jline.terminal.Terminal
 import org.strykeforce.thirdcoast.*
 
-const val DOUBLE_FORMAT = "%7.3f"
+const val DOUBLE_FORMAT_3 = "%7.3f"
+const val DOUBLE_FORMAT_4 = "%8.4f"
 
 private val logger = KotlinLogging.logger {}
 

src/main/kotlin/org/strykeforce/thirdcoast/talon/TalonParameterCommand.kt

@@ -8,6 +8,7 @@ import net.consensys.cava.toml.TomlTable
 import org.koin.standalone.inject
 import org.strykeforce.thirdcoast.command.AbstractCommand
 import org.strykeforce.thirdcoast.command.Command
+import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT_4
 import org.strykeforce.thirdcoast.device.TalonService
 import org.strykeforce.thirdcoast.talon.TalonParameter.Enum.*
 
@@ -28,10 +29,10 @@ class TalonParameterCommand(
             val config = talonService.activeConfiguration
             val slot = talonService.activeSlot
             return when (param.enum) {
-                SLOT_P -> formatMenu(slot.kP)
-                SLOT_I -> formatMenu(slot.kI)
-                SLOT_D -> formatMenu(slot.kD)
-                SLOT_F -> formatMenu(slot.kF)
+                SLOT_P -> formatMenu(slot.kP, DOUBLE_FORMAT_4)
+                SLOT_I -> formatMenu(slot.kI, DOUBLE_FORMAT_4)
+                SLOT_D -> formatMenu(slot.kD, DOUBLE_FORMAT_4)
+                SLOT_F -> formatMenu(slot.kF, DOUBLE_FORMAT_4)
                 SLOT_I_ZONE -> formatMenu(slot.integralZone)
                 SLOT_ALLOWABLE_ERR -> formatMenu(slot.allowableClosedloopError)
                 SLOT_MAX_I_ACCUM -> formatMenu(slot.maxIntegralAccumulator)

src/test/kotlin/org/strykeforce/thirdcoast/ReadersTest.kt

@@ -11,7 +11,8 @@ import org.junit.jupiter.api.Test
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.ValueSource
 import org.strykeforce.thirdcoast.command.Command
-import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT
+import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT_3
+import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT_4
 import org.strykeforce.thirdcoast.command.MenuCommand
 
 internal class ReadersTest {
@@ -59,7 +60,7 @@ internal class ReadersTest {
 
         @Test
         fun `read default`() {
-            whenever(reader.readLine(any(), isNull(), eq(DOUBLE_FORMAT.format(27.67)))).thenReturn(" ")
+            whenever(reader.readLine(any(), isNull(), eq(DOUBLE_FORMAT_4.format(27.67)))).thenReturn(" ")
             assertThat(reader.readDouble(default = 27.67)).isEqualTo(27.67)
         }
 

src/test/kotlin/org/strykeforce/thirdcoast/talon/TalonParameterCommandTest.kt

@@ -17,7 +17,7 @@ import org.koin.standalone.inject
 import org.koin.test.KoinTest
 import org.koin.test.declare
 import org.strykeforce.thirdcoast.command.Command
-import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT
+import org.strykeforce.thirdcoast.command.DOUBLE_FORMAT_4
 import org.strykeforce.thirdcoast.device.TalonService
 
 internal class TalonParameterCommandTest : KoinTest {
@@ -31,7 +31,7 @@ internal class TalonParameterCommandTest : KoinTest {
         private val talon: TalonSRX = mock()
 
         private val reader: LineReader = mock {
-            on { readLine(any(), isNull(), eq(DOUBLE_FORMAT.format(0.0))) } doReturn "27.67"
+            on { readLine(any(), isNull(), eq(DOUBLE_FORMAT_4.format(0.0))) } doReturn "27.67"
             on { readLine(any(), isNull(), eq("0")) } doReturn "27"
         }
 
@@ -51,7 +51,7 @@ internal class TalonParameterCommandTest : KoinTest {
             param = "SLOT_P"
         """.trimIndent()
             val command = TalonParameterCommand(null, "foo", Toml.parse(toml))
-            assertThat(AttributedString.stripAnsi(command.menu)).isEqualTo("foo: ${DOUBLE_FORMAT.format(0.0)}")
+            assertThat(AttributedString.stripAnsi(command.menu)).isEqualTo("foo: ${DOUBLE_FORMAT_4.format(0.0)}")
         }
 
         @Test