sugar-wifi-conf 项目教程

sugar-wifi-conf 项目教程

sugar-wifi-conf A BLE service on raspberry pi for wifi configuration and wireless control. 使用微信小程序随时随地设置树莓派wifi连接，控制树莓派 项目地址: https://gitcode.com/gh_mirrors/su/sugar-wifi-conf

1. 项目目录结构及介绍

sugar-wifi-conf/
├── github/workflows/
├── idea/
├── characteristics/
├── image/
├── sugar-wifi-miniapp/
├── template/
├── web-bluetooth-client/
├── .gitignore
├── LICENSE
├── README.cn_zh.md
├── README.md
├── config.js
├── custom_config.json
├── index.js
├── install.sh
├── package.json
├── run.sh
├── sugar-uuid.js
├── sugarwificonfig.sh
├── sugarwificonfig.sh.bak
├── wificonfig.sh
└── wificonfig.sh.bak

目录结构介绍

• github/workflows/: 存放GitHub Actions的工作流配置文件。
• idea/: 存放与IDE相关的配置文件。
• characteristics/: 存放与BLE特性相关的文件。
• image/: 存放项目相关的图片资源。
• sugar-wifi-miniapp/: 存放微信小程序的源代码。
• template/: 存放项目模板文件。
• web-bluetooth-client/: 存放Web Bluetooth客户端的源代码。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.cn_zh.md: 项目中文介绍文档。
• README.md: 项目英文介绍文档。
• config.js: 项目配置文件。
• custom_config.json: 自定义配置文件。
• index.js: 项目入口文件。
• install.sh: 项目安装脚本。
• package.json: Node.js项目配置文件。
• run.sh: 项目运行脚本。
• sugar-uuid.js: 生成UUID的工具文件。
• sugarwificonfig.sh: 配置WiFi的脚本文件。
• sugarwificonfig.sh.bak: sugarwificonfig.sh的备份文件。
• wificonfig.sh: WiFi配置脚本文件。
• wificonfig.sh.bak: wificonfig.sh的备份文件。

2. 项目启动文件介绍

index.js

index.js 是项目的入口文件，负责初始化BLE服务并启动WiFi配置服务。以下是该文件的主要功能：

• 初始化BLE服务。
• 配置WiFi连接。
• 获取WiFi名称和IP地址等信息。
• 执行自定义的Shell命令。

run.sh

run.sh 是一个启动脚本，用于在树莓派上启动sugar-wifi-conf服务。该脚本会将服务添加到/etc/rc.local中，以便在系统启动时自动运行。

3. 项目配置文件介绍

config.js

config.js 是项目的核心配置文件，包含了BLE服务的UUID和其他相关配置。以下是该文件的主要内容：

• Service UUID: BLE服务的UUID。
• Characteristics: 定义了BLE服务的特性，如读取设备模型、WiFi名称、IP地址等。

custom_config.json

custom_config.json 是一个自定义配置文件，允许用户自定义BLE广播的数据和执行的Shell命令。以下是该文件的示例内容：

{
  "info": [
    {
      "label": "CPU Temp",
      "command": "vcgencmd measure_temp | cut -d = -f 2 | awk '{printf \"%s \", $1}'",
      "interval": 5
    },
    {
      "label": "CPU Load",
      "command": "top -bn1 | grep load | awk '{printf \"%2f%%\", $(NF-2)}'",
      "interval": 1
    }
  ],
  "commands": [
    {
      "label": "ls",
      "command": "ls"
    },
    {
      "label": "shutdown",
      "command": "shutdown"
    }
  ]
}

package.json

package.json 是Node.js项目的配置文件，包含了项目的依赖、脚本和其他元数据。以下是该文件的主要内容：

• dependencies: 项目依赖的Node.js模块。
• scripts: 定义了项目的启动、测试等脚本。

通过以上介绍，您可以更好地理解和使用sugar-wifi-conf项目。

sugar-wifi-conf A BLE service on raspberry pi for wifi configuration and wireless control. 使用微信小程序随时随地设置树莓派wifi连接，控制树莓派 项目地址: https://gitcode.com/gh_mirrors/su/sugar-wifi-conf