Serial
Related Doc:
package flow
A message extending this trait is to be viewed as a command, an out-bound message issued by the client to flow's API.
A command has failed.
A new port (i.e.
A new port (i.e. file) has been detected.
the absolute file name of the connected port
A message extending this trait is to be viewed as an event, an in-bound message issued by flow to the client.
Base trait for any flow-related messages.
Open a new serial port.
Open a new serial port.
Send this command to the serial manager to request the opening of a serial port. The manager will
attempt to open a serial port with the specified parameters and, if successful, create a SerialOperator actor associated to the port.
The operator actor acts as an intermediate to the underlying native serial port, dealing with threading issues and dispatching messages.
In case the port is successfully opened, the operator will respond with an Opened message.
In case the port cannot be opened, the manager will respond with a CommandFailed message.
name of serial port to open
settings of serial port to open
maximum read and write buffer sizes
A port has been successfully opened.
A port has been successfully opened.
Event sent by a port operator, indicating that a serial port was successfully opened. The sender of this message is the operator associated to the given serial port.
name of opened serial port
Data has been received.
Data has been received.
Event sent by an operator, indicating that data was received on the operator's serial port.
data received on the port
Stop receiving notifications about a previously watched directory.
Stop receiving notifications about a previously watched directory.
the directory to unwatch
Watch a directory for new ports.
Watch a directory for new ports.
Send this command to the manager to get notifications when a new port (i.e. file) is created in
the given directory.
In case the given directory cannot be watched, the manager responds with a CommandFailed message.
Note: the sender is also notified of currently existing ports.
the directory to watch
don't get notified of already existing ports
Connected
Unwatch
Write data to a serial port.
Write data to a serial port.
Send this command to an operator to write the given data to its associated serial port. An acknowledgment may be set, in which case it is sent back to the sender on a successful write. Note that a successful write does not guarantee the actual transmission of data through the serial port, it merely guarantees that the data has been stored in the operating system's kernel buffer, ready to be transmitted.
data to be written to port
acknowledgment sent back to sender once data has been enqueued in kernel for sending (the acknowledgment is a function 'number of bytes written => event')
Request closing of port.
Request closing of port.
Send this command to an operator to close its associated port. The operator will respond
with a Closed message upon closing the serial port.
A port has been closed.
A port has been closed.
Event sent from operator, indicating that its port has been closed.
Special type of acknowledgment that is not sent back.
Defines messages used by flow's serial IO layer.