TC²-BBS Meshtastic 项目安装与使用教程
1. 项目目录结构及介绍
TC2-BBS-mesh/
├── docker/
│ └── ...
├── examples/
│ └── ...
├── command_handlers.py
├── config_init.py
├── db_admin.py
├── db_operations.py
├── example_config.ini
├── fortunes.txt
├── js8call_integration.py
├── mesh-bbs.service
├── message_processing.py
├── requirements.txt
├── server.py
├── utils.py
├── README.md
└── LICENSE
目录结构介绍
docker/
: Docker 相关文件,包含 Docker 配置和示例。examples/
: 项目示例文件,包含一些示例代码和配置。command_handlers.py
: 命令处理模块,负责处理用户输入的命令。config_init.py
: 配置初始化模块,负责初始化项目的配置。db_admin.py
: 数据库管理模块,负责数据库的创建和管理。db_operations.py
: 数据库操作模块,负责数据库的读写操作。example_config.ini
: 示例配置文件,用户可以参考此文件进行配置。fortunes.txt
: 存储随机格言的文件,用于“Fortune Teller”功能。js8call_integration.py
: JS8Call 集成模块,负责与 JS8Call 进行通信。mesh-bbs.service
: systemd 服务文件,用于在系统启动时自动运行项目。message_processing.py
: 消息处理模块,负责处理和分发消息。requirements.txt
: 项目依赖文件,列出了项目所需的所有 Python 包。server.py
: 项目的主启动文件,负责启动整个 BBS 系统。utils.py
: 工具模块,包含一些通用的工具函数。README.md
: 项目说明文件,包含项目的详细介绍和使用说明。LICENSE
: 项目许可证文件,说明项目的开源许可证类型。
2. 项目启动文件介绍
server.py
server.py
是 TC²-BBS Meshtastic 项目的主启动文件。它负责初始化系统配置、启动消息处理模块、命令处理模块等,并监听用户输入和设备通信。
主要功能
- 初始化系统配置。
- 启动消息处理模块。
- 启动命令处理模块。
- 监听用户输入和设备通信。
启动命令
python server.py
命令行参数
$ python server.py --help
3. 项目配置文件介绍
example_config.ini
example_config.ini
是项目的示例配置文件。用户可以参考此文件进行配置,并将其重命名为 config.ini
。
配置文件结构
[interface]
type = serial
# port = /dev/ttyUSB0
# hostname = 192.168.x.x
[sync]
bbs_nodes = f53f4abc,f3abc123
配置项说明
[interface]
: 接口配置部分。type
: 接口类型,可以是serial
或tcp
。port
: 串口设备路径(仅在type = serial
时使用)。hostname
: TCP 主机地址(仅在type = tcp
时使用)。
[sync]
: 同步配置部分。bbs_nodes
: 需要同步消息和公告的其他 BBS 节点列表,用逗号分隔。
配置文件使用
- 将
example_config.ini
重命名为config.ini
。 - 根据实际需求编辑
config.ini
文件。 - 保存并关闭文件。
通过以上步骤,您可以成功配置 TC²-BBS Meshtastic 项目,并启动 BBS 系统。