mirror of
git://sigrok.org/libserialport
synced 2023-08-10 21:13:24 +03:00
86 lines
2.5 KiB
Plaintext
86 lines
2.5 KiB
Plaintext
-------------------------------------------------------------------------------
|
|
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.
|
|
|
|
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
|
|
|