projects / libserialport.git / blame
| 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 | ||
| a24671ad UH |
28 | Enumeration is currently implemented on Windows, Mac OS X, FreeBSD and Linux. |
| 29 | On other systems enumeration is not supported, but ports can still be opened | |
| 30 | by 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. | |
| a46ee5b4 UH |
44 | |
| 45 | Windows builds can be created natively with the MinGW-w64 toolchain and | |
| f11a67ed | 46 | MSYS2 environment, or cross-compiled using a MinGW-w64 toolchain: |
| a46ee5b4 UH |
47 | |
| 48 | http://mingw-w64.sourceforge.net/ | |
| 49 | ||
| 50 | The "old" MinGW from http://mingw.org/ is not supported. | |
| 0a16d4de ML |
51 | |
| 52 | Run "./autogen.sh" to generate the build system, "./configure" to setup, then | |
| 53 | "make" to build the library and "make install" to install it. | |
| 54 | ||
| 55 | API | |
| 56 | === | |
| 57 | ||
| cd5f5281 | 58 | Doxygen API documentation is included. |
| eb82be98 | 59 | |
| cd71af4b UH |
60 | It can also be viewed online at: |
| 61 | ||
| 62 | http://sigrok.org/api/libserialport/unstable/ | |
| 63 | ||
| eb82be98 UH |
64 | Website |
| 65 | ======= | |
| 66 | ||
| 67 | http://sigrok.org/wiki/Libserialport | |
| 68 |