]>
Commit | Line | Data |
---|---|---|
f92f1f0c | 1 | ------------------------------------------------------------------------------- |
0a16d4de | 2 | libserialport: cross-platform library for accessing serial ports |
f92f1f0c | 3 | ------------------------------------------------------------------------------- |
0a16d4de ML |
4 | |
5 | libserialport is a minimal library written in C that is intended to take care | |
6 | of the OS-specific details when writing software that uses serial ports. | |
7 | ||
8 | By writing your serial code to use libserialport, you enable it to work | |
9 | transparently on any platform supported by the library. | |
10 | ||
11 | The operations that are supported are: | |
12 | ||
13 | - Port enumeration (obtaining a list of serial ports on the system). | |
e33dcf90 | 14 | - Obtaining port metadata (USB device information, Bluetooth address, etc). |
0a16d4de ML |
15 | - Opening and closing ports. |
16 | - Setting port parameters (baud rate, parity, etc). | |
17 | - Reading, writing and flushing data. | |
18 | - Obtaining error information. | |
19 | ||
20 | libserialport is an open source project released under the LGPL3+ license. | |
21 | ||
22 | Status | |
23 | ====== | |
24 | ||
25 | The library should build and work on any Windows or Unix-based system. If it | |
26 | does not, please submit a bug. | |
27 | ||
28 | Enumeration is currently only implemented on Windows, Mac OS X and Linux. On | |
6b93ede4 ML |
29 | other systems enumeration is not supported, but ports can still be opened by |
30 | name and then used. | |
0a16d4de ML |
31 | |
32 | If you know how to enumerate available ports on another OS, please submit a bug | |
33 | with this information, or better still a patch implementing it. | |
34 | ||
0a16d4de ML |
35 | Dependencies |
36 | ============ | |
37 | ||
98cac5d6 | 38 | No other libraries are required. |
0a16d4de ML |
39 | |
40 | Building | |
41 | ======== | |
42 | ||
43 | The package uses a GNU style build system and requires a Unix style shell. | |
44 | On Windows it can be built with the MinGW toolchain and MSYS environment. | |
45 | ||
46 | Run "./autogen.sh" to generate the build system, "./configure" to setup, then | |
47 | "make" to build the library and "make install" to install it. | |
48 | ||
49 | API | |
50 | === | |
51 | ||
cd5f5281 | 52 | Doxygen API documentation is included. |