JuanFi 项目安装与使用文档

JuanFi 项目安装与使用文档

JuanFi Juanfi is an open source system for coinslot integration for mikrotik hotspot 项目地址: https://gitcode.com/gh_mirrors/ju/JuanFi

1. 项目目录结构及介绍

JuanFi/
├── JuanFi-nodemcu/
├── docs/
├── mikrotik-template/
├── release/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
└── privacy-policy-juanfi-manager

目录结构说明

• JuanFi-nodemcu/: 包含与 NodeMCU (ESP8266/ESP32) 相关的代码和配置文件。
• docs/: 包含项目的文档，如安装指南、使用说明等。
• mikrotik-template/: 包含 MikroTik 路由器的配置模板。
• release/: 包含项目的发布版本和更新日志。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被版本控制。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和基本使用说明。
• privacy-policy-juanfi-manager: 包含 JuanFi Manager 应用的隐私政策。

2. 项目的启动文件介绍

启动文件

• JuanFi-nodemcu/main.lua: 这是 NodeMCU 的主要启动文件，负责初始化硬件和连接到 MikroTik 路由器。

启动流程

1. 硬件初始化: 启动文件首先初始化 NodeMCU 的硬件，包括 WiFi 模块和串口通信。
2. 连接 MikroTik: 文件会尝试连接到预配置的 MikroTik 路由器，并进行必要的认证。
3. 启动服务: 一旦连接成功，启动文件会启动 JuanFi 的服务，包括处理硬币槽输入和生成热点代码。

3. 项目的配置文件介绍

配置文件

• JuanFi-nodemcu/config.lua: 这是主要的配置文件，包含项目的各种设置，如 MikroTik 连接信息、热点设置、硬币槽配置等。

配置文件内容

-- MikroTik 连接配置
mikrotik_ip = "192.168.1.1"
mikrotik_username = "pisonet"
mikrotik_password = "abc123"

-- 热点配置
ssid = "JuanFi Setup"
password = "admin"

-- 硬币槽配置
coin_slot_pin = 4
coin_slot_value = 100

-- 其他配置
debug_mode = true

配置说明

• mikrotik_ip: MikroTik 路由器的 IP 地址。
• mikrotik_username: 连接 MikroTik 的用户名。
• mikrotik_password: 连接 MikroTik 的密码。
• ssid: 热点的 SSID。
• password: 热点的密码。
• coin_slot_pin: 硬币槽的 GPIO 引脚。
• coin_slot_value: 每个硬币的值。
• debug_mode: 调试模式开关，设置为 true 时会输出更多调试信息。

通过以上文档，您可以了解 JuanFi 项目的目录结构、启动文件和配置文件的基本信息，帮助您更好地进行项目的安装和使用。

JuanFi Juanfi is an open source system for coinslot integration for mikrotik hotspot 项目地址: https://gitcode.com/gh_mirrors/ju/JuanFi