1
0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
libserialport (sometimes abbreviated as "sp") is a minimal, cross-platform shared library written in C that is intended to take care of the OS-specific details when writing software that uses serial ports. http://sigrok.org/wiki/Libserialport
Go to file
Uwe Hermann 1d5d2a166f Temporarily disable USE_TERMIOX code (breaks the lib).
On some systems the use of the code enabled by USE_TERMIOX leads to a
non-working sp_open() which breaks all functionality provided by the lib.

Thus, temporarily disable that code until the details are investigated.

This has been tested with a serial port DMM and the OLS logic analyzer
on an x86 64bit Linux system with kernel version 3.11. The code compiles
fine but doesn't work at runtime. The configure output included:

checking for struct termios2... yes
checking for struct termiox... yes

The root cause for the problem is that the ioctl(fd, TCGETX, data) call in
get_flow() returns -1 ("Invalid argument"), which in turn lets sp_open()
return SP_ERR_FAIL.
2013-11-22 16:44:19 +01:00
.gitignore Ignore linux_termios leftovers. 2013-11-22 02:24:04 +01:00
AUTHORS Add build system. 2013-10-27 11:01:44 +00:00
autogen.sh Add build system. 2013-10-27 11:01:44 +00:00
configure.ac Support non-standard flow control modes on Linux. 2013-11-21 11:52:41 +00:00
COPYING Add build system. 2013-10-27 11:01:44 +00:00
Doxyfile Add doxygen documentation. 2013-11-19 02:17:38 +00:00
libserialport.h.in Minor cosmetics. 2013-11-22 16:10:55 +01:00
libserialport.pc.in Use new project URL. 2013-11-15 11:36:14 +01:00
linux_termios.c Minor cosmetics. 2013-11-22 16:10:55 +01:00
linux_termios.h Add missing #include guards. 2013-11-22 11:59:12 +01:00
Makefile.am Support custom baudrates on Linux. 2013-11-21 11:51:08 +00:00
NEWS Add build system. 2013-10-27 11:01:44 +00:00
README Add doxygen documentation. 2013-11-19 02:17:38 +00:00
serialport.c Temporarily disable USE_TERMIOX code (breaks the lib). 2013-11-22 16:44:19 +01:00

-------------------------------------------------------------------------------
libserialport: cross-platform library for accessing serial ports
-------------------------------------------------------------------------------

libserialport is a minimal library written in C that is intended to take care
of the OS-specific details when writing software that uses serial ports.

By writing your serial code to use libserialport, you enable it to work
transparently on any platform supported by the library.

The operations that are supported are:

- Port enumeration (obtaining a list of serial ports on the system).
- Opening and closing ports.
- Setting port parameters (baud rate, parity, etc).
- Reading, writing and flushing data.
- Obtaining error information.

libserialport is an open source project released under the LGPL3+ license.

Status
======

The library should build and work on any Windows or Unix-based system. If it
does not, please submit a bug.

Enumeration is currently only implemented on Windows, Mac OS X and Linux. On
other systems enumeration will return no results, but ports can still be opened
by name and then used.

If you know how to enumerate available ports on another OS, please submit a bug
with this information, or better still a patch implementing it.

Future
======

Future versions will add additional API calls for obtaining metadata about a
port, e.g. for USB devices the USB VID and PID of the underlying device.

Dependencies
============

On Linux, libudev is required. On other systems no other libraries are required.

The libudev dependency could be eliminated in favour of direct sysfs queries at
the cost of some brevity. This is not currently a priority but if you feel like
doing this feel free to submit a patch.

Building
========

The package uses a GNU style build system and requires a Unix style shell.
On Windows it can be built with the MinGW toolchain and MSYS environment.

Run "./autogen.sh" to generate the build system, "./configure" to setup, then
"make" to build the library and "make install" to install it.

API
===

Doxygen API documentation is included.