Skip to content

basics.md

Latest commit

 

History

History
86 lines (60 loc) · 4.15 KB

basics.md

File metadata and controls

86 lines (60 loc) · 4.15 KB
Raw

Introduction

The following is a general guide on the usage of flow. If you prefer a complete example, check out the code contained in the flow-samples directory.

Flow's API follows that of an actor based system, where each actor is assigned specific functions involved in serial communication. The two main actor types are the serial "manager" and serial "operators".

The manager is a singleton actor that is instantiated once per actor system, a reference to it may be obtained with IO(Serial). It is typically used to open serial ports (see following section).

Serial operators are created once per open serial port and serve as an intermediate between client code and native code dealing with serial data transmission and reception. They isolate the user from threading issues and enable the reactive dispatch of incoming data. A serial operator is said to be "associated" to its underlying open serial port.

The messages understood by flow's actors are all contained in the com.github.jodersky.flow.Serial object. They are well documented and should serve as the entry point when searching the API documentation.

#Opening a port A serial port is opened by sending an Open message to the serial manager. The response varies on the outcome of opening the underlying serial port.

  1. In case of failure, the serial manager will respond with a CommandFailed message to the original sender. The message contains details on the reason to why the opening failed.
  2. In case of success, the sender is notified with an Opened message. This message is sent from an operator actor, spawned by the serial manager. It is useful to capture the sender (=operator) of this message as all further communication with the newly opened port must pass through the operator.
val port = "/dev/ttyXXX"
val settings = SerialSettings(
  baud = 115200,
  characterSize = 8,
  twoStopBits = false,
  parity = Parity.None
)

IO(Serial) ! Serial.Open(port, settings)

def receive = {
  case CommandFailed(cmd: Open, reason: AccessDeniedException) => println("you're not allowed to open that port!")
  case CommandFailed(cmd: Open, reason) => println("could not open port for some other reason: " + reason.getMessage)
  case Opened(settings) => {
    val operator = sender
    //do stuff with the operator, e.g. context become opened(op)
  }
}

Communicating

Writing data

Writing data is as simple as sending a Write message containing data to an operator. The type of data is an instance of akka.util.ByteString:

operator ! Write(data)

To receive an acknowledgement when data has been sent (this means queued in the kernel buffer; no guarantees can be made on the actual transmission of the data), the sender may add an additional ack parameter to a Write message. The ack parameter is of type Int => Serial.Event, i.e. a function that takes the number of actual bytes written and returns an event.

case class MyPacketAck(wrote: Int) extends Serial.Event

operator ! Write(data, MyPacketAck(_))
operator ! Write(data, MyPacketAck(_))
operator ! Write(data, n => MyPacketAck(n))

def receive = {
  case MyPacketAck(x) => println("Wrote " + x + " bytes of data")
}

Receiving data

The actor that opened a serial port (refered to as the client), exclusively receives incomming messages from the operator. These messages are in the form of ByteStrings and wrapped in a Received object.

def receive = {
  case Received(data) => println("got data: " + data.toString)
}

#Closing a port A port is closed by sending a Close message to its operator:

operator ! Serial.Close

The operator will close the underlying serial port and respond with a final Closed message before terminating.

Resources and error handling

The operator has a deathwatch on the client actor that opened the port, this means that if the latter crashes, the operator closes the port and equally terminates, freeing any allocated resources.

The opposite is not true by default, i.e. if the operator crashes (this can happen for example on IO errors) it dies silently and the client is not informed. Therefore, it is recommended that the client keep a deathwatch on the operator.