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
202 Commits 3 Branches 3 Tags 455 KiB
C 94.8%
M4 3.4%
Makefile 1.2%
Shell 0.5%
23ef3bf125
Go to file
Uwe Hermann 23ef3bf125 Fix Mac OS X build (untested).
2014-08-27 14:56:19 +02:00
.gitignore Ignore build leftovers. 2014-06-11 20:41:20 +02:00
AUTHORS Add the usual AUTHORS file. 2014-04-13 19:54:41 +02:00
autogen.sh
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 Compile with -pedantic. 2014-08-24 14:06:21 +01:00
COPYING
Doxyfile doxygen: Updated Doxyfile to doxygen 1.8.6. 2014-05-04 17:56:49 +02:00
libserialport_internal.h linux: Define feature macros to get required functions. 2014-08-24 14:06:21 +01:00
libserialport.h.in libserialport.h.in: remove trailing commas in enum definitions 2014-08-24 11:56:45 +01:00
libserialport.pc.in Tidy up and split most OS-specific code to separate files. 2014-06-11 15:10:29 +01:00
linux_termios.c Introduce SP_API/SP_PRIV to mark visibility of functions. 2014-07-02 14:43:32 +02:00
linux_termios.h Introduce SP_API/SP_PRIV to mark visibility of functions. 2014-07-02 14:43:32 +02:00
linux.c linux: Fix warning by marking vid, pid variables unsigned. 2014-08-24 14:08:00 +01:00
macosx.c Fix Mac OS X build (untested). 2014-08-27 14:56:19 +02:00
Makefile.am Tidy up and split most OS-specific code to separate files. 2014-06-11 15:10:29 +01:00
NEWS Tidy up and split most OS-specific code to separate files. 2014-06-11 15:10:29 +01:00
README Tidy up and split most OS-specific code to separate files. 2014-06-11 15:10:29 +01:00
serialport.c Revise debug macros to work in strict C99. 2014-08-24 14:06:21 +01:00
windows.c Fix Windows build. 2014-08-27 14:53:19 +02: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).
- Obtaining port metadata (USB device information, Bluetooth address, etc).
- 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.

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

No other libraries are required.

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.