Merge branch 'serial-connector'

Author: J0B10

build.sbt

@@ -57,6 +57,9 @@ libraryDependencies ++= Seq(
 resolvers += "jcenter-bintray" at "http://jcenter.bintray.com"
 libraryDependencies += "net.dv8tion" % "JDA" % "4.ALPHA.0_82"
 
+//Serial Communication
+libraryDependencies += "com.fazecast" % "jSerialComm" % "[2.0.0,3.0.0)"
+
 // ---------------------------------------------------------------------------------------------------------------------
 // PLUGIN FRAMEWORK DEFINITIONS
 // ---------------------------------------------------------------------------------------------------------------------

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/serial/SerialConnector.scala

@@ -0,0 +1,100 @@
+package org.codeoverflow.chatoverflow.requirement.service.serial
+
+import java.io.{InputStream, PrintStream}
+
+import com.fazecast.jSerialComm.{SerialPort, SerialPortInvalidPortException}
+import org.codeoverflow.chatoverflow.WithLogger
+import org.codeoverflow.chatoverflow.connector.Connector
+
+/**
+  * The serial connector allows to communicate with a device connected to the pcs serial port (like an Arduino)
+  *
+  * @param sourceIdentifier r the unique source identifier to identify this connector
+  */
+class SerialConnector(override val sourceIdentifier: String) extends Connector(sourceIdentifier) with WithLogger {
+
+  override protected var optionalCredentialKeys: List[String] = List("baudRate")
+  override protected var requiredCredentialKeys: List[String] = List("port")
+
+  private var serialPort: Option[SerialPort] = None
+  private var out: Option[PrintStream] = None
+  private var in: Option[InputStream] = None
+  private val serialPortInputListener = new SerialPortInputListener
+
+  /**
+    * @throws java.lang.IllegalStateException if the serial port is not available yet
+    * @return print stream that outputs to the port
+    */
+  @throws(classOf[IllegalStateException])
+  def getPrintStream: PrintStream = {
+    if (serialPort.isEmpty)  throw new IllegalStateException("Serial port is not available yet")
+    out.get
+  }
+
+  /**
+    * @throws java.lang.IllegalStateException if the serial port is not available yet
+    * @return a inputstream that receives all data from the port
+    */
+  @throws(classOf[IllegalStateException])
+  def getInputStream: InputStream = {
+    if (serialPort.isEmpty)  throw new IllegalStateException("Serial port is not available yet")
+    in.get
+  }
+
+  /**
+    * Adds a new input listener that receives all data
+    * @param listener a listener that handles incoming data in a byte array
+    * @throws java.lang.IllegalStateException if the serial port is not available yet
+    */
+  @throws(classOf[IllegalStateException])
+  def addInputListener(listener: Array[Byte] => Unit): Unit = {
+    if (serialPort.isEmpty)  throw new IllegalStateException("Serial port is not available yet")
+    serialPortInputListener.addDataAvailableListener(_ => {
+      val buffer = new Array[Byte](serialPort.get.bytesAvailable())
+      serialPort.get.readBytes(buffer, buffer.length) //FIXME DOES IT CRASH?
+      listener(buffer)
+    })
+  }
+
+  /**
+    * Opens a connection with the serial port
+    */
+  override def start(): Boolean = {
+    //TODO Test if connector is working this way or if it requires an actor
+    try {
+      serialPort = Some(SerialPort.getCommPort(credentials.get.getValue("port").get))
+      credentials.get.getValue("baudRate") match {
+        case Some(baudRate) if baudRate.matches("\\s*\\d+\\s*") => serialPort.get.setBaudRate(baudRate.trim.toInt)
+        case Some(ivalidBaudrate) =>
+          logger error s"Invalid baud rate: $ivalidBaudrate"
+          return false
+        case None => //Do nothing
+      }
+      logger info s"Waiting for serial port to open..."
+      if (serialPort.get.openPort(1000)) {
+        Thread.sleep(1500)//Sleep to wait for
+        serialPort.get.setComPortTimeouts(SerialPort.TIMEOUT_READ_SEMI_BLOCKING, 0, 0)
+        out = Some(new PrintStream(serialPort.get.getOutputStream, true, "US-ASCII"))
+        in = Some(serialPort.get.getInputStream)
+        serialPort.get.addDataListener(serialPortInputListener)
+        logger info "Opened serial port!"
+        true
+      } else {
+        logger error s"Could not open serial port $sourceIdentifier"
+        false
+      }
+    } catch {
+      case e: SerialPortInvalidPortException =>
+        logger error s"Source identifier $sourceIdentifier is invalid: ${e.getMessage}"
+        false
+    }
+  }
+
+  /**
+    * Closes the connection with the port
+    */
+  override def stop(): Boolean = {
+    serialPort.foreach(_.closePort())
+    true
+  }
+}

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/serial/SerialPortInputListener.scala

@@ -0,0 +1,20 @@
+package org.codeoverflow.chatoverflow.requirement.service.serial
+
+import com.fazecast.jSerialComm.{SerialPort, SerialPortDataListener, SerialPortEvent}
+
+import scala.collection.mutable.ListBuffer
+
+class SerialPortInputListener extends SerialPortDataListener {
+
+  private val listeners = ListBuffer[SerialPortEvent => Unit]()
+
+  override def getListeningEvents: Int = SerialPort.LISTENING_EVENT_DATA_AVAILABLE
+
+  override def serialEvent(event: SerialPortEvent): Unit = {
+    if (event.getEventType == SerialPort.LISTENING_EVENT_DATA_AVAILABLE) {
+      listeners.foreach(listener => listener(event))
+    }
+  }
+
+  def addDataAvailableListener(listener: SerialPortEvent => Unit): Unit = listeners += listener
+}

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/serial/impl/SerialInputImpl.scala

@@ -0,0 +1,36 @@
+package org.codeoverflow.chatoverflow.requirement.service.serial.impl
+
+import java.io.InputStream
+import java.nio.charset.StandardCharsets
+import java.util.function.Consumer
+
+import org.codeoverflow.chatoverflow.WithLogger
+import org.codeoverflow.chatoverflow.api.io.input.SerialInput
+import org.codeoverflow.chatoverflow.registry.Impl
+import org.codeoverflow.chatoverflow.requirement.InputImpl
+import org.codeoverflow.chatoverflow.requirement.service.serial.SerialConnector
+
+import scala.collection.mutable.ListBuffer
+
+@Impl(impl = classOf[SerialInput], connector = classOf[SerialConnector])
+class SerialInputImpl extends InputImpl[SerialConnector] with SerialInput with WithLogger {
+
+  private val stringListeners = ListBuffer[Consumer[String]]()
+  private val byteListeners = ListBuffer[Consumer[Array[Byte]]]()
+
+  override def start(): Boolean = {
+    sourceConnector.get.addInputListener(onIncomingData)
+    true
+  }
+
+  private def onIncomingData(bytes: Array[Byte]): Unit = {
+    byteListeners.foreach(l => l.accept(bytes))
+    stringListeners.foreach(l => l.accept(new String(bytes, StandardCharsets.US_ASCII)))
+  }
+
+  override def registerStringListener(consumer: Consumer[String]): Unit = stringListeners += consumer
+
+  override def registerDataListener(consumer: Consumer[Array[Byte]]): Unit = byteListeners += consumer
+
+  override def getInputStream: InputStream = sourceConnector.get.getInputStream
+}

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/serial/impl/SerialOutputImpl.scala

@@ -0,0 +1,17 @@
+package org.codeoverflow.chatoverflow.requirement.service.serial.impl
+
+import java.io.PrintStream
+
+import org.codeoverflow.chatoverflow.WithLogger
+import org.codeoverflow.chatoverflow.api.io.output.SerialOutput
+import org.codeoverflow.chatoverflow.registry.Impl
+import org.codeoverflow.chatoverflow.requirement.OutputImpl
+import org.codeoverflow.chatoverflow.requirement.service.serial.SerialConnector
+
+@Impl(impl = classOf[SerialOutput], connector = classOf[SerialConnector])
+class SerialOutputImpl extends OutputImpl[SerialConnector] with SerialOutput with WithLogger {
+
+  override def start(): Boolean = true
+
+  override def getPrintStream: PrintStream = sourceConnector.get.getPrintStream
+}