mirror of
git://sigrok.org/libserialport
synced 2023-08-10 21:13:24 +03:00
e47c7dcbff
When built with MSVC and unicode enabled, using CreateFile gave: warning C4133: 'function': incompatible types - from 'char *' to 'LPCWSTR' CreateFile is a macro expanding to either CreateFileW if unicode mode is enabled, or CreateFileA if not. For CreateFileW, the filename is a UTF-16 string. For CreateFileA it is an 'ANSI' string, meaning 8-bit chars in the current Windows code page. We do need to stick to 8-bit strings for port names, since sp_get_port_by_name() and sp_get_port_name() are defined with char * types, and that is what we store in struct sp_port. So CreateFileA is the correct version to use. Since Windows serial port names are always just 'COM' and a digit, with a '\\.\' prefix for higher numbers, encoding is fortunately not an issue - ASCII, UTF-8 and all the Windows code pages seem to be equivalent for these characters. We should however explicitly document what the encoding of strings accepted and returned by libserialport is.
------------------------------------------------------------------------------- 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 ======== The package uses a GNU style build system and requires a Unix style shell. Windows builds can be created natively with the MinGW-w64 toolchain and MSYS2 environment, or cross-compiled using a MinGW-w64 toolchain: http://mingw-w64.sourceforge.net/ The "old" MinGW from http://mingw.org/ is not supported. Run "./autogen.sh" to generate the build system, "./configure" to setup, then "make" to build the library and "make install" to install it. 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