Blueutil 技术文档

1. 安装指南

通过 Homebrew 安装

1. 安装：

   brew install blueutil
   

2. 更新：

   brew update
   brew upgrade blueutil
   

3. 卸载：

   brew remove blueutil
   

通过 MacPorts 安装

1. 安装：

   sudo port install blueutil
   

2. 更新：

   sudo port selfupdate
   sudo port upgrade blueutil
   

3. 卸载：

   sudo port uninstall blueutil
   

从源码安装

1. 克隆仓库：

   git clone https://github.com/toy/blueutil.git
   cd blueutil
   

2. 构建：

   make
   

3. 安装/更新：

   git pull
   sudo make install
   

4. 卸载：

   sudo make uninstall
   

2. 项目使用说明

基本用法

• 不带参数时，输出当前蓝牙状态。
• 使用 -p 或 --power 可以获取或设置蓝牙电源状态。
• 使用 -d 或 --discoverable 可以获取或设置蓝牙的可发现状态。
• 使用 --favourites 或 --favorites 可以列出收藏的设备（macOS 12/Monterey 及以上版本返回空列表）。
• 使用 --inquiry 可以查询范围内的设备。
• 使用 --paired 可以列出已配对的设备。
• 使用 --recent 可以列出最近使用的设备。
• 使用 --connected 可以列出已连接的设备。
• 使用 --info ID 可以查看设备的详细信息。
• 使用 --is-connected ID 可以检查设备是否已连接。
• 使用 --connect ID 可以连接到设备。
• 使用 --disconnect ID 可以断开与设备的连接。
• 使用 --pair ID [PIN] 可以与设备配对。
• 使用 --unpair ID 可以取消与设备的配对。
• 使用 --add-favourite ID 可以将设备添加到收藏。
• 使用 --remove-favourite ID 可以从收藏中移除设备。
• 使用 --format FORMAT 可以更改输出格式。
• 使用 --wait-connect ID [TIMEOUT] 可以等待设备连接。
• 使用 --wait-disconnect ID [TIMEOUT] 可以等待设备断开连接。
• 使用 --wait-rssi ID OP VALUE [PERIOD [TIMEOUT]] 可以等待设备的 RSSI 值。

状态参数

• STATE 可以是以下之一：1, on, 0, off, toggle。
• ID 可以是设备的地址或名称。
• OP 可以是以下之一：>, >=, <, <=, =, != 或其等效的 gt, ge, lt, le, eq, ne。
• PERIOD 是以秒为单位的时间，默认为 1。
• TIMEOUT 是以秒为单位的时间，默认值为 0，表示没有超时。
• FORMAT 可以是以下之一：default, new-default, json, json-pretty。

3. 项目API使用文档

命令行接口 (CLI)

• blueutil [options]：不带参数时，输出当前蓝牙状态。
• -p, --power：获取或设置蓝牙电源状态。
• -d, --discoverable：获取或设置蓝牙的可发现状态。
• --favourites, --favorites：列出收藏的设备。
• --inquiry [T]：查询范围内的设备。
• --paired：列出已配对的设备。
• --recent [N]：列出最近使用的设备。
• --connected：列出已连接的设备。
• --info ID：查看设备的详细信息。
• --is-connected ID：检查设备是否已连接。
• --connect ID：连接到设备。
• --disconnect ID：断开与设备的连接。
• --pair ID [PIN]：与设备配对。
• --unpair ID：取消与设备的配对。
• --add-favourite ID：将设备添加到收藏。
• --remove-favourite ID：从收藏中移除设备。
• --format FORMAT：更改输出格式。
• --wait-connect ID [TIMEOUT]：等待设备连接。
• --wait-disconnect ID [TIMEOUT]：等待设备断开连接。
• --wait-rssi ID OP VALUE [PERIOD [TIMEOUT]]：等待设备的 RSSI 值。

退出代码

• 0：成功
• 1：一般失败
• 64：错误使用，如缺少或意外的参数
• 69：蓝牙或接口不可用
• 70：内部错误
• 71：系统错误，如内存不足
• 75：超时错误

4. 项目安装方式

通过 Homebrew 安装

brew install blueutil

通过 MacPorts 安装

sudo port install blueutil

从源码安装

1. 克隆仓库：

   git clone https://github.com/toy/blueutil.git
   cd blueutil
   

2. 构建：

   make
   

3. 安装/更新：

   git pull
   sudo make install
   

4. 卸载：

   sudo make uninstall