aboutsummaryrefslogtreecommitdiff
path: root/flow-main/src/main/scala/com/github/jodersky/flow/SerialSettings.scala
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2013-08-04 22:01:24 +0200
committerJakob Odersky <jodersky@gmail.com>2013-08-04 22:01:24 +0200
commit10c5c4e68d027e6bbabaad17381c79df24401027 (patch)
tree00b980f9cbe4e66eee265de36d8abb57614af514 /flow-main/src/main/scala/com/github/jodersky/flow/SerialSettings.scala
parent9efeb44063001d4df0fb7a665a52bfcc52d5a290 (diff)
downloadakka-serial-10c5c4e68d027e6bbabaad17381c79df24401027.tar.gz
akka-serial-10c5c4e68d027e6bbabaad17381c79df24401027.tar.bz2
akka-serial-10c5c4e68d027e6bbabaad17381c79df24401027.zip
group serial settings in class, cosmetic changes & documentation
Diffstat (limited to 'flow-main/src/main/scala/com/github/jodersky/flow/SerialSettings.scala')
-rw-r--r--flow-main/src/main/scala/com/github/jodersky/flow/SerialSettings.scala11
1 files changed, 11 insertions, 0 deletions
diff --git a/flow-main/src/main/scala/com/github/jodersky/flow/SerialSettings.scala b/flow-main/src/main/scala/com/github/jodersky/flow/SerialSettings.scala
new file mode 100644
index 0000000..a3bc5e4
--- /dev/null
+++ b/flow-main/src/main/scala/com/github/jodersky/flow/SerialSettings.scala
@@ -0,0 +1,11 @@
+package com.github.jodersky.flow
+
+/**
+ * Groups settings used in communication over a serial port.
+ * @param port name of serial port
+ * @param baud baud rate to use with serial port
+ * @param characterSize size of a character of the data sent through the serial port
+ * @param twoStopBits set to use two stop bits instead of one
+ * @param parity type of parity to use with serial port
+ */
+case class SerialSettings(port: String, baud: Int, characterSize: Int = 8, twoStopBits: Boolean = false, parity: Parity.Parity = Parity.None) \ No newline at end of file