Difference between revisions of "Libserialport"

From sigrok
Jump to navigation Jump to search
m
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:libserialport}}
{{DISPLAYTITLE:libserialport}}
'''libserialport''' 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.
'''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.


It is licensed under the terms of the GNU Lesser General Public License, version 3 or later.
It is licensed under the terms of the '''GNU Lesser General Public License, version 3 or later'''.


'''''Note:''' While libserialport is hosted on sigrok.org (and sigrok uses libserialport), this is a completely independent library that can be used by other projects as well. The libserialport library does '''not''' depend on any sigrok related libraries or projects.''
'''''Note:''' While libserialport is hosted on sigrok.org (and sigrok uses libserialport), this is a completely independent library that can be used by other projects as well. The libserialport library does '''not''' depend on any sigrok related libraries or projects.''
Line 10: Line 10:
* Linux
* Linux
* Mac OS X
* Mac OS X
* FreeBSD
* Windows
* Windows
* Android
* Android
Line 34: Line 35:
  $ '''sudo make install'''
  $ '''sudo make install'''


Note: There are no dependencies (i.e., no other libraries are needed to build/use libserialport).
'''Note:''' There are no dependencies (i.e., no other libraries are needed to build/use libserialport).


== Debugging ==
== Debugging ==

Revision as of 15:39, 28 April 2018

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.

It is licensed under the terms of the GNU Lesser General Public License, version 3 or later.

Note: While libserialport is hosted on sigrok.org (and sigrok uses libserialport), this is a completely independent library that can be used by other projects as well. The libserialport library does not depend on any sigrok related libraries or projects.

Supported operating systems

  • Linux
  • Mac OS X
  • FreeBSD
  • Windows
  • Android

API documentation

You can browse the API documentation of the library online.

Distribution packages

See Downloads.

Getting the code

$ git clone git://sigrok.org/libserialport

You can also browse the source code via gitweb.

Building from source

$ ./autogen.sh
$ ./configure
$ make
$ sudo make install

Note: There are no dependencies (i.e., no other libraries are needed to build/use libserialport).

Debugging

To examine problems related to libserialport, verbose debug output can be enabled by setting the environment variable LIBSERIALPORT_DEBUG to any value.