Serial to Socket Transmitter

Principle

The MicroEJ Serial to Socket Transmitter is a tool which transfers all bytes from a serial port to a TCP client or TCP server.

It is typically used to transfer the output traces of a testsuite executed on a device.

Use

To start transfering data from the COM8 serial port to the port 5555, execute the execTool task as followed:

./gradlew execTool --name=serialToSocketTransmitter \
  --toolProperty=serail.to.socket.comm.port="COM8" \
  --toolProperty=serail.to.socket.comm.baudrate="115200" \
  --toolProperty=serail.to.socket.server.port="5555" \
  --console plain

Run Serial to Socket Transmitter with Custom Task

To simplify the use of the Serial to Socket Transmitter, it is also possible to create a custom task in the build.gradle.kts file of your project as follows:

Import the ExecToolTask and LoadVeeTask classes:

import com.microej.gradle.tasks.ExecToolTask
import com.microej.gradle.tasks.LoadVeeTask

Create a new task of type ExecToolTask:

val loadVee = tasks.withType(LoadVeeTask::class).named("loadVee")
val mainSourceSet = project.extensions.getByType(SourceSetContainer::class).getByName(SourceSet.MAIN_SOURCE_SET_NAME)

tasks.register<ExecToolTask>("serialToSocketTransmitter") {
    group = "microej"
    veeDir.set(loadVee.flatMap { it.loadedVeeDir })
    resourcesDirectories.from(mainSourceSet.output.resourcesDir, layout.buildDirectory.dir("generated/microej-app-wrapper/resources"))
    classesDirectories.from(mainSourceSet.output.classesDirs, layout.buildDirectory.dir("generated/microej-app-wrapper/classes"))
    classpathFromConfiguration.from(project.configurations.getByName("runtimeClasspath"))

    toolName = "serialToSocketTransmitter"
    toolProperties.putAll(mapOf(
        "serail.to.socket.comm.port" to "COM8",
        "serail.to.socket.comm.baudrate" to "115200",
        "serail.to.socket.server.port" to "5555"
    ))
}

The custom task can then be executed:
```
$ ./gradlew serialToSocketTransmitter
```

Options

Serial Port

Option Name: serail.to.socket.comm.port

Default value: COM0

Description: Defines the COM port:

Windows - COM1, COM2, ..., COM*n*

Linux - /dev/ttyS0, /dev/ttyUSB0, ..., /dev/ttyS*n*, /dev/ttyUSB*n*

Baudrate

Option Name: serail.to.socket.comm.baudrate

Default value: 115200

Available values:

9600

38400

57600

115200

Description: Defines the COM baudrate.

Socket Port

Option Name: serail.to.socket.server.port

Default value: 5555

Description: Defines the TCP server port.