mirror/libserialport
mirror/libserialport
1
0
Fork 0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity
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
124 Commits 3 Branches 3 Tags 455 KiB
C 94.8%
M4 3.4%
Makefile 1.2%
Shell 0.5%
b251be4b26
Go to file
Martin Ling b251be4b26 Turn off all the fancy termios features.
2013-11-25 17:55:37 +00: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
config-fields Add generator program for configuration accessor headers. 2013-11-23 20:45:09 +00:00
config-header.py Add generator program for configuration accessor headers. 2013-11-23 20:45:09 +00:00
config-pattern Add generator program for configuration accessor headers. 2013-11-23 20:45:09 +00:00
configure.ac Use common 3-digit package version number. 2013-11-22 16:44:29 +01: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 Make configuration structure opaque. 2013-11-23 20:43:13 +00: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 Makefile.am: Add missing linux_termios.h. 2013-11-22 20:28:20 +01:00
NEWS Add build system. 2013-10-27 11:01:44 +00:00
README Return SP_ERR_SUPP from sp_list_ports() on unsupported platforms. 2013-11-23 11:57:17 +00:00
serialport.c Turn off all the fancy termios features. 2013-11-25 17:55:37 +00:00

README 

-------------------------------------------------------------------------------
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 is not supported, 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.