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
210 Commits 3 Branches 3 Tags 455 KiB
C 94.8%
M4 3.4%
Makefile 1.2%
Shell 0.5%
276ef1b92f
Go to file
Aurelien Jacobs 276ef1b92f Add SP_MODE_READ_WRITE enum value.
2014-09-20 21:24:31 +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 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 linux: remove readlinkat() dependency 2014-09-04 20:13:55 +02:00
COPYING Add build system. 2013-10-27 11:01:44 +00:00
Doxyfile doxygen: Updated Doxyfile to doxygen 1.8.6. 2014-05-04 17:56:49 +02:00
libserialport_internal.h windows: Include proper GUID defining header to fix build. 2014-09-07 18:51:04 +02:00
libserialport.h.in Add SP_MODE_READ_WRITE enum value. 2014-09-20 21:24:31 +02: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 linux_termios: fix return types to actually match returned values 2014-09-04 20:13:55 +02:00
linux_termios.h linux_termios: fix return types to actually match returned values 2014-09-04 20:13:55 +02:00
linux.c linux: remove readlinkat() dependency 2014-09-04 20:13:55 +02:00
macosx.c Fix Mac OS X build (untested). 2014-08-27 14:56:19 +02:00
Makefile.am windows: -no-undefined is required to make a DLL. 2014-09-07 19:18:22 +02:00
NEWS Tidy up and split most OS-specific code to separate files. 2014-06-11 15:10:29 +01:00
README README: Add URL to the libserialport website. 2014-09-07 19:31:23 +02:00
serialport.c Add SP_MODE_READ_WRITE enum value. 2014-09-20 21:24:31 +02: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.

Windows builds can be created natively with the MinGW-w64 toolchain and
MSYS environment, or cross-compiled using a MinGW-w64 toolchain:

  http://mingw-w64.sourceforge.net/

The "old" MinGW from http://mingw.org/ is not supported.

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.

Website
=======

http://sigrok.org/wiki/Libserialport