Merge pull request #8 from paulorb/trace

Added Trace operation

Author: paulorb

.github/badges/branches.svg

@@ -123,4 +123,16 @@ Example using a parameter as a value
   </ifEqual>
 ```
 
-Please note the **symbol** and **value** datatype needs to match.
+Please note the **symbol** and **value** datatype needs to match.
+
+
+## Trace
+
+Trace operation provides a tool for debugging, by printing (tracing) the current
+value of symbols
+
+Supported registers: **HOLDING_REGISTER**, **COIL**, **DISCRETE_INPUT**, **INPUT_REGISTER**
+
+```
+    <trace symbol="RPM_MOTOR" />
+```

.github/badges/jacoco.svg

@@ -78,7 +78,9 @@
         <csv symbol="TEMPERATURE_MOTOR4" file="test_data.csv" column="2" step="2" startRow="2" endRow="5" replay="true"/>
         <set symbol="RELAYON">1</set>
         <set symbol="RELAY_STATUS">1</set>
+        <trace symbol="RPM_MOTOR" />
         <set symbol="RPM_MOTOR">400</set>
+        <trace symbol="RPM_MOTOR" />
         <delay>1000</delay>
         <add symbol="MOTOR_SPEED1">15</add>
         <add symbol="RPM7">1</add>

docs/getting-started/operations.md

@@ -23,7 +23,7 @@ class ConfigurationParser {
     }
     private fun load(): Device? {
         try {
-            val context = JAXBContext.newInstance(Device::class.java, Set::class.java, Random::class.java, Delay::class.java, Linear::class.java, Add::class.java, Sub::class.java, Csv::class.java, IfEqual::class.java, Parameters::class.java, Parameter::class.java)
+            val context = JAXBContext.newInstance(Device::class.java, Set::class.java, Random::class.java, Delay::class.java, Linear::class.java, Add::class.java, Sub::class.java, Csv::class.java, IfEqual::class.java, Parameters::class.java, Parameter::class.java, Trace::class.java)
             val unmarshaller = context.createUnmarshaller()
             return if(fileName.isEmpty() ) {
                 val reader = StringReader(this::class.java.classLoader.getResource("configuration.xml")!!.readText())
@@ -151,6 +151,17 @@ data class Sub(
 }
 
 
+//<trace symbol="MOTOR_SPEED1"></trace>
+@XmlRootElement(name="trace")
+data class Trace(
+    @field:XmlAttribute(required = true)
+    val symbol: String,
+){
+    constructor(): this("")
+}
+
+
+
 //<add symbol="MOTOR_SPEED1">RPM_MOTOR1</add>
 @XmlRootElement(name="add")
 data class Add(

examples/configuration_simulation.xml

@@ -14,6 +14,7 @@ class PlcSimulation(
 ): BaseOperation(parameters,configurationParser.getConfiguredDevice().configuration ) {
     val linearOperations = LinearOperation()
     val csvOperations = CsvOperation()
+    var traceOperation = TraceOperation(configurationParser.getConfiguredDevice().configuration, memory, parameters)
     val addOperation = AddOperation(configurationParser.getConfiguredDevice().configuration, memory, parameters)
     val setOperation = SetOperation(configurationParser.getConfiguredDevice().configuration, memory, parameters)
     val subOperation = SubOperation(configurationParser.getConfiguredDevice().configuration, memory, parameters)
@@ -83,6 +84,10 @@ class PlcSimulation(
                 ifEqual(element, configuration, memory)
             }
 
+            is Trace -> {
+                traceOperation.traceOperation(element)
+            }
+
             else -> throw UnsupportedOperationException("Unknown simulation step type")
         }
     }

src/main/kotlin/ConfigurationParser.kt

@@ -0,0 +1,70 @@
+package operations
+
+import Configuration
+import EnvironmentVariables
+import PlcMemory
+import Trace
+import org.slf4j.LoggerFactory
+import java.util.concurrent.CancellationException
+
+class TraceOperation(
+    private val configuration: Configuration, private val memory: PlcMemory, environmentVariables: EnvironmentVariables
+
+) : BaseOperation(environmentVariables, configuration) {
+    companion object {
+        val logger = LoggerFactory.getLogger("TraceOperation")
+    }
+
+    fun traceOperation(element: Trace) {
+        var valueToTrace : String = ""
+        var variable = configuration.registers.getVarConfiguration(element.symbol)
+        if (variable == null) {
+            TraceOperation.logger.error("Symbol ${element.symbol} not found during Trace execution")
+            throw CancellationException("Error - Trace")
+        } else {
+            when (variable.addressType) {
+
+                AddressType.HOLDING_REGISTER -> {
+                    //get the current value
+
+                    if (variable.datatype == "FLOAT32") {
+                        var currentValue = memory.readHoldingRegister(variable.address.toInt(), 2)
+                        if (currentValue.isEmpty()) {
+                            SubOperation.logger.error("Trace Operation - Unable to get value of ${element.symbol} address ${variable.address} ")
+                            throw CancellationException("Error - Trace")
+                        }
+                        val intValue = ((currentValue[1].toInt() shl 16) or (currentValue[0].toInt() and 0xFFFF))
+                        val currentFloatValue = java.lang.Float.intBitsToFloat(intValue)
+                        valueToTrace = currentValue.toString()
+                    } else {
+                        var currentValue = memory.readHoldingRegister(variable.address.toInt(), 1)
+                        if (currentValue.isEmpty()) {
+                            SubOperation.logger.error("Trace Operation - Unable to get value of ${element.symbol} address ${variable.address} ")
+                            throw CancellationException("Error - Add")
+                        }
+                        valueToTrace =  currentValue.first().toInt().toString()
+                    }
+                }
+
+                AddressType.INPUT_REGISTER -> {
+                    val currentValue = memory.readInputRegister(variable.address.toInt(), 1)
+                    valueToTrace = currentValue.first().toString()
+                }
+
+                AddressType.COIL -> {
+                    val currentValue = memory.readCoilStatus(variable.address.toInt(), 1)
+                    valueToTrace = currentValue.first().toString()
+                }
+
+                AddressType.DISCRETE_INPUT -> {
+                    val currentValue = memory.readInputStatus(variable.address.toInt(), 1)
+                    valueToTrace = currentValue.first().toString()
+                }
+
+            }
+            TraceOperation.logger.info("TRACE - Symbol: ${element.symbol} Value: $valueToTrace")
+
+        }
+    }
+
+}