package serialport

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Serialport_lwt`Source

Sourcetype t

Interface for a opened serial port.

val open_communication : 
  ?switch:Lwt_switch.t ->
  ?exclusive:bool ->
  opts:Port_options.t ->
  string ->
  t Lwt.t

open_communication ?switch ?exclusive ~opts port_name open the serial port using the specified opts configuration.

val with_open_communication : 
  ?exclusive:bool ->
  opts:Port_options.t ->
  string ->
  (t -> 'a Lwt.t) ->
  'a Lwt.t

with_open_communication ?exclusive ~opts port_name callback similar to open_communication but with an auto-closing mechanism.

Sourceval close_communication : t -> unit Lwt.t

close ser_port close the serial port.

Sourceval to_channels : t -> Lwt_io.input_channel * Lwt_io.output_channel

to_channels ser_port

Sourcemodule Modem : sig ... end

Modem controls.

Sourceval set_exclusive : t -> bool -> unit

set_exclusive ser_port enable

Sourceexception Not_found_port of string

raise if the port name does not exist.

Sourceval pp : Lwt_fmt.formatter -> t -> unit Lwt.t