mirrors
/
libserialport
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
360 Commits 1 Branch 3 Tags 488 KiB
C 94.8%
M4 3.4%
Makefile 1.2%
Shell 0.5%
Go to file
Martin Ling 9ddf08588d Add example of how to configure a port. 2020-01-23 03:56:34 +00:00
examples Add example of how to configure a port. 2020-01-23 03:56:34 +00:00
.gitignore Use a static header file, not dependent on autoconf. 2020-01-23 03:35:47 +00:00
AUTHORS Update AUTHORS file. 2015-05-31 18:26:53 +02:00
COPYING Add build system. 2013-10-27 11:01:44 +00:00
Doxyfile Use SP_API prefix for functions in libserialport.h. 2020-01-23 03:35:47 +00:00
Makefile.am Add example of how to configure a port. 2020-01-23 03:56:34 +00:00
NEWS NEWS: Last updates for the upcoming 0.1.1 release. 2016-01-27 12:36:01 +01:00
README README: Add link to bug tracker. 2017-12-17 18:15:56 +01:00
autogen.sh autogen.sh: Create autostuff/ dir if it does not exist 2015-08-27 11:46:06 +02: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 Various Doxygen comment updates and fixes. 2015-04-19 18:16:01 +02:00
configure.ac Use a static header file, not dependent on autoconf. 2020-01-23 03:35:47 +00:00
freebsd.c use readdir() instead of the deprecated readir_r() 2016-10-14 23:58:22 +02:00
libserialport.h Add example of how to configure a port. 2020-01-23 03:56:34 +00:00
libserialport.pc.in FreeBSD: Add missing libusb-2.0 to pkg-config file. 2017-09-13 15:04:56 +02:00
libserialport_internal.h windows: Don't try to include <unistd.h>. 2020-01-23 03:35:47 +00:00
linux.c linux: Fix compile warning on gcc 6+ for readlink() call. 2020-01-04 18:24:00 +01:00
linux_termios.c Linux: fix for alpha where BOTHER is not defined. 2017-03-19 12:16:49 +00:00
linux_termios.h Build: Include config.h first in all source files 2015-09-13 20:04:31 +02:00
macosx.c macosx: Fix port listing on ElCapitan. 2016-01-06 13:54:11 +00:00
serialport.c windows: Loop over WriteFile() if write size exceeds limit. 2020-01-23 03:35:47 +00:00
test_timing.c Add test program for timing functions. 2020-01-23 03:35:47 +00:00
timing.c Move timing routines to separate file. 2020-01-20 04:33:24 +00:00
windows.c windows: wc_to_utf8: use some clearer variable names. 2020-01-23 03:35:47 +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).
- 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 implemented on Windows, Mac OS X, FreeBSD 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
MSYS2 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.

It can also be viewed online at:

  http://sigrok.org/api/libserialport/unstable/

Bug reports
===========

You can report bugs for libserialport at https://sigrok.org/bugzilla.

Mailing list
============

 https://lists.sourceforge.net/lists/listinfo/sigrok-devel

IRC
===

You can find the developers in the #sigrok IRC channel on Freenode.

Website
=======

http://sigrok.org/wiki/Libserialport