RXTX 中文文档
项目简介
这是 RXTX 库的中文文档仓库。RXTX 是一个为 Java 提供跨平台串行端口(Serial Port)和并行端口(Parallel Port)访问的开源库。
💡 什么是串口? 串口是计算机上一种传统的通信接口(如 COM1、COM2),常用于连接单片机、仪器仪表、工业设备等。RXTX 让 Java 程序能够与这些设备通信。
如何访问文档
在线访问
文档已部署到 GitHub Pages,您可以通过以下链接访问:
本地访问
克隆仓库:
bashgit clone https://github.com/YeatsLiao/wiki.git cd wiki启动本地预览:
- 安装依赖:
npm install,启动预览:npm run docs:dev - 本系列位于
docs/translations/rxtx/目录
- 安装依赖:
文档内容
入门
| 文档 | 说明 |
|---|---|
| 📖 项目简介 | RXTX 是什么、支持平台、许可证概览 |
| 🚀 安装指南 | 构建、安装、常见问题 FAQ(26 条) |
| 🔌 串口使用教程 | 查找端口、权限配置、Java 代码示例 |
参考
| 文档 | 说明 |
|---|---|
| 🔧 移植指南 | 向新平台移植 RXTX 的方法 |
| 🖥️ 支持的构建主机 | 各平台构建兼容性矩阵 |
| 📋 变更日志 | v0.1 → v2.2 完整历史 |
| ❓ 常见问题 | 常见问题及解答 |
| 🛠️ 开发指南 | 开发者参考资料 |
| 📥 下载资源 | 源代码和预编译二进制包 |
关于
| 文档 | 说明 |
|---|---|
| 👥 贡献者名单 | 所有参与 RXTX 开发的开发者 |
| ⚖️ 许可证摘要 | LGPL v2.1 + 受控接口例外说明 |
| 📜 完整许可证 | GNU LGPL v2.1 全文中文翻译 |
项目特点
- 跨平台支持:支持 Linux、Windows、Mac OS、Solaris、FreeBSD、HP-UX 等多种操作系统
- 完整 CommAPI 实现:遵循 Sun 的 Java Communications API(简称 CommAPI)规范,提供
gnu.io包的实现 - 串口和并口支持:同时支持 RS232 串口通信和并口打印
- 事件通知:支持串口事件监听(数据到达、载波检测、线路状态变化等)
- 流控支持:支持硬件流控(RTS/CTS)和软件流控(XON/XOFF)
- LGPL 许可证:基于 GNU LGPL v2.1 开源发布,允许在各种项目中免费使用
官方资源
- 官方网站:http://www.rxtx.org
- 源码仓库:https://github.com/rxtx/rxtx
- 邮件列表:Majordomo@hex.linuxgrrls.org(发送 "subscribe rxtx" 订阅)
- 官方 Wiki:http://rxtx.qbang.org/wiki/(由 RXTX 用户和开发者维护)
- 原始 RXTX 网站:http://users.frii.com/jarvi/rxtx/(大部分信息已迁移到 Wiki)
社区
RXTX 拥有活跃的社区,欢迎用户和开发者参与:
- 项目使用 RXTX:有许多项目在使用 RXTX 库,包括工业控制系统、嵌入式设备通信、科学仪器接口等
- 贡献方式:
- 提交代码到 GitHub 仓库
- 在邮件列表中分享经验和解决方案
- 改进文档和翻译
- 报告 bug 和提出新功能建议
项目历史
- RXTX 是一个历史悠久的开源项目,为 Java 提供串口和并口访问能力
- 最初由 Trent Jarvi 等人创建
- 目前在 GitHub 上活跃维护
- 当 2.2 版本发布时,官方 Wiki 将成为 RXTX 的主页
翻译说明
- 基于 RXTX 2.2(development 分支)
- 许可证以英文原版为准
- 欢迎提交 Issue 改进翻译
本项目由 YeatsLiao 维护。