package serialport

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

I/O
1. Modem
Exclusive
Exceptions
Pretty print

Serial communication library

Install

dune-project

Dependency

github.com Readme Edit opam file Versions (2)

Authors

M

Mikhail Lopatin <dx3mod@bk.ru>

Maintainers

M

Mikhail Lopatin <dx3mod@bk.ru>

Sources

0.3.tar.gz

md5=75d4e9843bd11717f060a8feca148424

sha512=3fa68b03598b1fb63f2891a0cc6e5a35cabbafd4c454d7ba1d95cb880a1eb5d8684404cc558a419f4f7aff0119b41a10fb6ffde3242edde432ea91a5e429af19

doc/serialport.lwt/Serialport_lwt/index.html

Module `Serialport_lwt`Source

Sourcetype t

Interface for a opened serial port.

Source

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.

raises Not_found_port
if the port name does not exist.

raises Unix.Unix_error

Source

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.

raises Not_found_port
if the port name does not exist.

raises Unix.Unix_error

Sourceval close_communication : t -> unit Lwt.t

close ser_port close the serial port.

I/O

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

to_channels ser_port

returns
Channel abstraction pair for input/output tasks.

Modem

Sourcemodule Modem : sig ... end

Modem controls.

Exclusive

Sourceval set_exclusive : t -> bool -> unit

set_exclusive ser_port enable

raises Failure

Exceptions

Sourceexception Not_found_port of string

raise if the port name does not exist.

Pretty print

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