mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
feat: Desktop USB serial transport (#4836)
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
This commit is contained in:
James Rich
GitHub
parent
06c990026f
commit
59408ef46e
19 changed files with 457 additions and 37 deletions
|
|
@ -0,0 +1,158 @@
|
|||
/*
|
||||
* Copyright (c) 2026 Meshtastic LLC
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package org.meshtastic.core.network
|
||||
|
||||
import co.touchlab.kermit.Logger
|
||||
import com.fazecast.jSerialComm.SerialPort
|
||||
import com.fazecast.jSerialComm.SerialPortTimeoutException
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.Job
|
||||
import kotlinx.coroutines.isActive
|
||||
import kotlinx.coroutines.launch
|
||||
import org.meshtastic.core.network.radio.StreamInterface
|
||||
import org.meshtastic.core.repository.RadioInterfaceService
|
||||
|
||||
/**
|
||||
* JVM-specific implementation of [RadioTransport] using jSerialComm. Uses [StreamInterface] for START1/START2 packet
|
||||
* framing.
|
||||
*/
|
||||
class SerialTransport(
|
||||
private val portName: String,
|
||||
private val baudRate: Int = DEFAULT_BAUD_RATE,
|
||||
service: RadioInterfaceService,
|
||||
) : StreamInterface(service) {
|
||||
private var serialPort: SerialPort? = null
|
||||
private var readJob: Job? = null
|
||||
|
||||
/** Attempts to open the serial port and starts the read loop. Returns true if successful, false otherwise. */
|
||||
fun startConnection(): Boolean {
|
||||
return try {
|
||||
val port = SerialPort.getCommPort(portName) ?: return false
|
||||
port.setComPortParameters(baudRate, DATA_BITS, SerialPort.ONE_STOP_BIT, SerialPort.NO_PARITY)
|
||||
port.setComPortTimeouts(SerialPort.TIMEOUT_READ_SEMI_BLOCKING, READ_TIMEOUT_MS, 0)
|
||||
if (port.openPort()) {
|
||||
serialPort = port
|
||||
port.setDTR()
|
||||
port.setRTS()
|
||||
super.connect() // Sends WAKE_BYTES and signals service.onConnect()
|
||||
startReadLoop(port)
|
||||
true
|
||||
} else {
|
||||
false
|
||||
}
|
||||
} catch (@Suppress("TooGenericExceptionCaught") e: Exception) {
|
||||
Logger.e(e) { "Serial connection failed" }
|
||||
false
|
||||
}
|
||||
}
|
||||
|
||||
@Suppress("CyclomaticComplexMethod")
|
||||
private fun startReadLoop(port: SerialPort) {
|
||||
readJob =
|
||||
service.serviceScope.launch(Dispatchers.IO) {
|
||||
val input = port.inputStream
|
||||
val buffer = ByteArray(READ_BUFFER_SIZE)
|
||||
try {
|
||||
var reading = true
|
||||
while (isActive && port.isOpen && reading) {
|
||||
try {
|
||||
val numRead = input.read(buffer)
|
||||
if (numRead == -1) {
|
||||
reading = false
|
||||
} else if (numRead > 0) {
|
||||
for (i in 0 until numRead) {
|
||||
readChar(buffer[i])
|
||||
}
|
||||
}
|
||||
} catch (_: SerialPortTimeoutException) {
|
||||
// Expected timeout when no data is available
|
||||
} catch (e: kotlinx.coroutines.CancellationException) {
|
||||
throw e
|
||||
} catch (@Suppress("TooGenericExceptionCaught") e: Exception) {
|
||||
if (isActive) {
|
||||
Logger.e(e) { "Serial read IOException: ${e.message}" }
|
||||
} else {
|
||||
Logger.d { "Serial read interrupted by cancellation: ${e.message}" }
|
||||
}
|
||||
reading = false
|
||||
}
|
||||
}
|
||||
} catch (e: kotlinx.coroutines.CancellationException) {
|
||||
throw e
|
||||
} catch (@Suppress("TooGenericExceptionCaught") e: Exception) {
|
||||
if (isActive) {
|
||||
Logger.e(e) { "Serial read loop outer error: ${e.message}" }
|
||||
} else {
|
||||
Logger.d { "Serial read loop outer interrupted by cancellation: ${e.message}" }
|
||||
}
|
||||
} finally {
|
||||
try {
|
||||
input.close()
|
||||
} catch (_: Exception) {
|
||||
// Ignore errors during input stream close
|
||||
}
|
||||
try {
|
||||
if (port.isOpen) {
|
||||
port.closePort()
|
||||
}
|
||||
} catch (_: Exception) {
|
||||
// Ignore errors during port close
|
||||
}
|
||||
if (isActive) {
|
||||
onDeviceDisconnect(true)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
override fun sendBytes(p: ByteArray) {
|
||||
serialPort?.takeIf { it.isOpen }?.outputStream?.write(p)
|
||||
}
|
||||
|
||||
override fun flushBytes() {
|
||||
serialPort?.takeIf { it.isOpen }?.outputStream?.flush()
|
||||
}
|
||||
|
||||
override fun keepAlive() {
|
||||
// Not specifically needed for raw serial unless implemented
|
||||
}
|
||||
|
||||
private fun closePortResources() {
|
||||
serialPort?.takeIf { it.isOpen }?.closePort()
|
||||
serialPort = null
|
||||
}
|
||||
|
||||
override fun close() {
|
||||
readJob?.cancel()
|
||||
readJob = null
|
||||
closePortResources()
|
||||
super.close()
|
||||
}
|
||||
|
||||
companion object {
|
||||
private const val DEFAULT_BAUD_RATE = 115200
|
||||
private const val DATA_BITS = 8
|
||||
private const val READ_BUFFER_SIZE = 1024
|
||||
private const val READ_TIMEOUT_MS = 100
|
||||
|
||||
/**
|
||||
* Discovers and returns a list of available serial ports. Returns a list of the system port names (e.g.,
|
||||
* "COM3", "/dev/ttyUSB0").
|
||||
*/
|
||||
fun getAvailablePorts(): List<String> = SerialPort.getCommPorts().map { it.systemPortName }
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
/*
|
||||
* Copyright (c) 2026 Meshtastic LLC
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package org.meshtastic.core.network
|
||||
|
||||
import com.fazecast.jSerialComm.SerialPort
|
||||
import io.mockk.mockk
|
||||
import org.meshtastic.core.repository.RadioInterfaceService
|
||||
import org.meshtastic.core.repository.RadioTransport
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertFalse
|
||||
import kotlin.test.assertNotNull
|
||||
import kotlin.test.assertTrue
|
||||
|
||||
class SerialTransportTest {
|
||||
private val mockService: RadioInterfaceService = mockk(relaxed = true)
|
||||
|
||||
@Test
|
||||
fun testJSerialCommIsAvailable() {
|
||||
val ports = SerialPort.getCommPorts()
|
||||
assertNotNull(ports, "Serial ports array should not be null")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testSerialTransportImplementsRadioTransport() {
|
||||
val transport: RadioTransport = SerialTransport("dummyPort", service = mockService)
|
||||
assertTrue(transport is SerialTransport, "Transport should be a SerialTransport")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testGetAvailablePorts() {
|
||||
val ports = SerialTransport.getAvailablePorts()
|
||||
assertNotNull(ports, "Available ports should not be null")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testConnectToInvalidPortFailsGracefully() {
|
||||
val transport = SerialTransport("invalid_port_name", 115200, mockService)
|
||||
val connected = transport.startConnection()
|
||||
assertFalse(connected, "Connecting to an invalid port should return false")
|
||||
transport.close()
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue