Serial

Type Members

trait AckEvent extends Event

Ack for a write.
sealed trait Command extends Message

Messages that are sent to the serial port.
case class CommandFailed(command: Command, reason: Throwable) extends Product with Serializable
sealed trait DataBits extends AnyRef
sealed trait Event extends Message

Messages received from the serial port.
sealed trait FlowControl extends AnyRef
sealed trait ManagerCommand extends Command

Command that may be sent to the manager actor.
sealed trait Message extends AnyRef

Messages used by the serial IO.
case class Open(handler: ActorRef, port: String, baudRate: Int, dataBits: DataBits = DataBits8, parity: Parity = NoParity, stopBits: StopBits = OneStopBit, flowControl: FlowControl = NoFlowControl) extends ManagerCommand with Product with Serializable

Open a serial port.
Open a serial port. Response: Opened | CommandFailed
case class Opened(port: String) extends Event with Product with Serializable

Serial port is now open.
Serial port is now open. Communication is handled by the operator actor. The sender of the Open message will now receive incoming communication from the serial port.
sealed trait OperatorCommand extends Command

Command that may be sent to the operator actor.
sealed trait Parity extends AnyRef
case class Ports(ports: Vector[String]) extends Event with Product with Serializable

Available serial ports.
case class Received(data: ByteString) extends Event with Product with Serializable

Data was received on the serial port.
class SerialException extends Exception
sealed trait StopBits extends AnyRef
case class Write(data: ByteString, ack: AckEvent = NoAck) extends OperatorCommand with Product with Serializable

Write data on the serial port.
Write data on the serial port. Response: ack (if ack != NoAck)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Close extends OperatorCommand with Product with Serializable

Request that the operator should close the port.
Request that the operator should close the port. Response: Closed
object Closed extends Event with Product with Serializable

The port was closed.
The port was closed. Either by request or by an external event (i.e. unplugging)
object DataBits5 extends DataBits
object DataBits6 extends DataBits
object DataBits7 extends DataBits
object DataBits8 extends DataBits
object EvenParity extends Parity
object ListPorts extends ManagerCommand with Product with Serializable

List all available serial ports.
List all available serial ports. Response: Ports | CommandFailed
object MarkParity extends Parity
object NoAck extends AckEvent

Special ack event (is not sent).
object NoFlowControl extends FlowControl
object NoParity extends Parity
object OddParity extends Parity
object OneAndHalfStopBits extends StopBits
object OneStopBit extends StopBits
object RtsFlowControl extends FlowControl
object SpaceParity extends Parity
object TwoStopBits extends StopBits
object XonXoffFlowControl extends FlowControl
def apply(system: ActorSystem): SerialExt

Definition Classes
ExtensionId
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createExtension(system: ExtendedActorSystem): SerialExt

Definition Classes
Serial → ExtensionId
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def equals(other: Any): Boolean

Definition Classes
ExtensionId → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(system: ActorSystem): SerialExt

Definition Classes
ExtensionId
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def hashCode(): Int

Definition Classes
ExtensionId → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lookup(): Serial.type

Definition Classes
Serial → ExtensionIdProvider
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package io

object Serial extends ExtensionId[SerialExt] with ExtensionIdProvider

Type Members

trait AckEvent extends Event

sealed trait Command extends Message

case class CommandFailed(command: Command, reason: Throwable) extends Product with Serializable

sealed trait DataBits extends AnyRef

sealed trait Event extends Message

sealed trait FlowControl extends AnyRef

sealed trait ManagerCommand extends Command

sealed trait Message extends AnyRef

case class Open(handler: ActorRef, port: String, baudRate: Int, dataBits: DataBits = DataBits8, parity: Parity = NoParity, stopBits: StopBits = OneStopBit, flowControl: FlowControl = NoFlowControl) extends ManagerCommand with Product with Serializable

case class Opened(port: String) extends Event with Product with Serializable

sealed trait OperatorCommand extends Command

sealed trait Parity extends AnyRef

case class Ports(ports: Vector[String]) extends Event with Product with Serializable

case class Received(data: ByteString) extends Event with Product with Serializable

class SerialException extends Exception

sealed trait StopBits extends AnyRef

case class Write(data: ByteString, ack: AckEvent = NoAck) extends OperatorCommand with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Close extends OperatorCommand with Product with Serializable

object Closed extends Event with Product with Serializable

object DataBits5 extends DataBits

object DataBits6 extends DataBits

object DataBits7 extends DataBits

object DataBits8 extends DataBits

object EvenParity extends Parity

object ListPorts extends ManagerCommand with Product with Serializable

object MarkParity extends Parity

object NoAck extends AckEvent

object NoFlowControl extends FlowControl

object NoParity extends Parity

object OddParity extends Parity

object OneAndHalfStopBits extends StopBits

object OneStopBit extends StopBits

object RtsFlowControl extends FlowControl

object SpaceParity extends Parity

object TwoStopBits extends StopBits

object XonXoffFlowControl extends FlowControl

def apply(system: ActorSystem): SerialExt

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def createExtension(system: ExtendedActorSystem): SerialExt

final def eq(arg0: AnyRef): Boolean

final def equals(other: Any): Boolean

def finalize(): Unit

def get(system: ActorSystem): SerialExt

final def getClass(): Class[_]

final def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def lookup(): Serial.type

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from ExtensionIdProvider

Inherited from ExtensionId[SerialExt]

Inherited from AnyRef

Inherited from Any

Ungrouped