librs232 with CMake Support

librs232 is a multiplatform library for serial communications over RS-232 using Lua.

History

• Original development until 2018, repository now in archive mode: https://github.com/ynezz/librs232

• Improvements for Windows and further development until 2021: https://github.com/srdgame/librs232

  • Windows. Use overlapped IO model.

  • Windows. Support detect break/parity error.

  • Windows. Implement rs232_in_queue_clear.

  • Windows. Fix using static variables to support multithreading.

  • Windows. rs232_read wait at least one byte (like in POSIX version).

  • Basic tests on Travis/Appveyor.

  • Lua. Export rs232_in_queue_clear / rs232_in_queue functions.

  • Lua. Add more Lua way module.

• This repository: Same as srdgame's repository, but with CMake build intrastructure on top with focus on Windows builds.

Lua binding

local rs232 = require "rs232"

local p, e = rs232.port('COM1',{
  baud         = '_9600';
  data_bits    = '_8';
  parity       = 'NONE';
  stop_bits    = '_1';
  flow_control = 'OFF';
  rts          = 'ON';
})

p:open()
print(p:write('AT\r\n'))
print(p:read(64, 5000))
p:close()

Building and Installing librs232

Prerequisites

librs232 with CMake Support relies on an installation of Lua with CMake Support. The same toolchain which has been used with Lua with CMake Support is required. librs232 gets all necessary path, header and library information from CMake liblua package data and will be installed automatically into the right directory locations - no hassle with package.path settings anymore.

Notice: Present GNU autoconf build structure originates from original librs232 source code and is not used within the context of the CMake-based build infrastructure. Simply ignore it.

Build and Install

Open Developer Command Prompt for VS 2022 and change drive and directory. Download and unpack sources or simply clone this repository:

c:
cd c:\Temp
git clone https://github.com/KritzelKratzel/librs232
cd librs232

CMake strongly encourages out-of-source builds.

mkdir build
cd build
cmake .. -G "Visual Studio 17 2022" -A <arch>
cmake --build . --config Release
cmake --install . --config Release

Replace <arch> with your desired architecture. Available architectures with selected Visual Studio 17 2022 generator are Win32, x64, ARM and ARM64. A librs232 example file is available in <lua_install_dir>/share/doc/librs232 after install.

Sync this fork with srdgame's librs232 repository

Open Git Bash and execute ./SyncFork.sh.

John Doe@DESKTOP-1HK25HF MINGW64 /c/misc/librs232 (master)
$ ./SyncFork.sh
Original remote repo found.
Already on 'master'
Your branch is up to date with 'origin/master'.
From github.com:KritzelKratzel/librs232
 * branch            master     -> FETCH_HEAD
Already up to date.
Already up to date.
Everything up-to-date
John Doe@DESKTOP-1HK25HF MINGW64 /c/misc/librs232 (master)

Improvements and open points

Over the years librs232 has seen a larger number of forks of which only a few where merged back into ynezz's or srdgame's repository. The following list suggests changes to be implemented into this repository. All list items were collected during a manual compare-across-forks analysis. Some of them might address the same type of improvement, but from a different perspective.

• Add baud rate 230400 as of https://github.com/srdgame/librs232/compare/master...GerHobbelt:librs232:master
• Posix: Implement send break using tcsendbreak() as of https://github.com/srdgame/librs232/compare/master...urutva:librs232:master
• Implemented: posix: add missing free in rs232_init as of https://github.com/srdgame/librs232/compare/master...speakinghedge:librs232:master
• Implement function win32GetAnyComport() as of https://github.com/srdgame/librs232/compare/master...jjonethal:librs232:master
• Implemented:luaL_reg vs. luaL_Reg in bindings/lua/luars232.c as of https://github.com/srdgame/librs232/compare/master...jjonethal:librs232:master
• Convert the representation of ports from light userdata to full userdata objects to be compatible with LuaJIT as of https://github.com/srdgame/librs232/compare/master...vitex:librs232:master
• Misc stuff as of https://github.com/srdgame/librs232/compare/master...RangelReale:librs232:master