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
Martin Ling 75a280a597 configure.ac: remove broken handling for cygwin as $host_os.
I don't think these two mentions of cygwin ever did anything useful.
In fact they stop libserialport being buildable under cygwin.

The first one caused builds on cygwin to try to build windows.c,
which uses the Win32 API, not the POSIX layer provided by cygwin.

The second asserts that enumeration and port metadata are supported
on cygwin, but that isn't the case.

Without these matches for cygwin as $host_os, libserialport builds
and works just fine on old-school cygwin with the original mingw32.

The only reason that MSYS2 worked better is that it uses "msys" as
the $host_os identifier, not cygwin.
2020-02-07 14:00:35 +00:00
examples Add remaining examples to examples/README. 2020-02-07 13:59:31 +00:00
.gitignore Add Visual Studio projects and solution to build example programs. 2020-01-26 21:11:46 +01:00
AUTHORS Update AUTHORS file. 2015-05-31 18:26:53 +02:00
autogen.sh autogen.sh: Create autostuff/ dir if it does not exist 2015-08-27 11:46:06 +02:00
common.props Add project files for Visual Studio 2019. 2020-01-24 05:39:16 +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 Various Doxygen comment updates and fixes. 2015-04-19 18:16:01 +02:00
configure.ac configure.ac: remove broken handling for cygwin as $host_os. 2020-02-07 14:00:35 +00:00
COPYING Add build system. 2013-10-27 11:01:44 +00:00
debug.props Add project files for Visual Studio 2019. 2020-01-24 05:39:16 +00:00
Doxyfile Use SP_API prefix for functions in libserialport.h. 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_internal.h Fix building on Cygwin. 2020-01-26 21:21:21 +01:00
libserialport.h Formatting fix for example descriptions. 2020-02-07 13:59:31 +00:00
libserialport.pc.in FreeBSD: Add missing libusb-2.0 to pkg-config file. 2017-09-13 15:04:56 +02:00
libserialport.sln Add project files for Visual Studio 2019. 2020-01-24 05:39:16 +00:00
libserialport.vcxproj Add project files for Visual Studio 2019. 2020-01-24 05:39:16 +00:00
libserialport.vcxproj.filters Add project files for Visual Studio 2019. 2020-01-24 05:39:16 +00: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
linux.c linux: Fix compile warning on gcc 6+ for readlink() call. 2020-01-04 18:24:00 +01:00
macosx.c macosx: Fix port listing on ElCapitan. 2016-01-06 13:54:11 +00:00
Makefile.am Add example of waiting for events. 2020-01-23 04:11:45 +00:00
NEWS NEWS: Last updates for the upcoming 0.1.1 release. 2016-01-27 12:36:01 +01:00
README README: Add note on building for MSYS2/Cygwin. 2020-01-26 21:21:34 +01:00
release.props Add project files for Visual Studio 2019. 2020-01-24 05:39:16 +00:00
serialport.c unix: Fix calculation of poll() timeout in sp_wait(). 2020-02-02 09:36:52 +00:00
test_timing.c Minor whitespace- and consistency fixes. 2020-01-26 21:21:34 +01:00
timing.c windows: Fix a warning on conversion to unsigned int. 2020-01-26 21:11:46 +01:00
windows.c windows: Fix another CreateFile usage. 2020-01-26 21:11:46 +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).
- 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
========

On Windows, libserialport can be built with Visual Studio 2019 or with
the standalone MSBuild tool, using the solution and project files provided.

For other environments, the package uses a GNU style build based on autotools.

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

Windows builds can also be created using the autotools build system, using the
MinGW-w64 toolchain from http://mingw-w64.sourceforge.net/ - either natively
in Windows with the MSYS2 environment, or cross-compiling from another system.

To build from MSYS2, the following packages must be installed: autoconf,
automake-wrapper, libtool, make, and either mingw-w64-i686-gcc (for 32-bit)
or mingw-w64-x86_64-gcc (for 64-bit). Open either the "MSYS2 MinGW 32-bit" or
"MSYS2 MinGW 64-bit" command window from the Start menu and use this when
configuring and building the package. Using the "MSYS2 MSYS" shell will build
against the Cygwin compatibility layer; this works, but port enumeration and
metadata will not be available, and binaries will depend on Cygwin. The builds
produced by MinGW-w64 are normal Windows DLLs without additional dependencies.

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

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