mebeats 项目技术文档

mebeats 项目技术文档

1. 安装指南

1.1 环境要求

• 小米手环（支持型号：2, 3, 4, 5, 6）
• macOS 11.3.1 或更高版本

1.2 依赖安装

• 确保已安装 Go 语言环境。如果没有安装，请访问 Go 官方网站 下载并安装。

2. 项目使用说明

2.1 运行服务器

1. 克隆项目代码：

   git clone git@github.com:wuhan005/mebeats.git
   

2. 进入服务器目录：

   cd mebeats/cmd/mebeats-server
   

3. 编译并运行服务器：

   go build . && ./mebeats-server --key=<your_secret_key>
   

   服务器默认运行在 0.0.0.0:2830。

2.2 运行客户端

1. 克隆项目代码：

   git clone git@github.com:wuhan005/mebeats.git
   

2. 进入客户端目录：

   cd mebeats/cmd/mebeats-client
   

3. 编译并运行客户端：

   go build . && ./mebeats-client --addr=<mi_band_addr> --auth-key=<mi_band_auth_key> --server-addr=<mebeats_server_addr> --server-key=<your_secret_key>
   

3. 项目API使用文档

3.1 服务器API

• 端点: 0.0.0.0:2830
• 功能: 接收来自客户端的心率数据并生成相应的徽章。
• 认证: 使用 --key 参数传递的密钥进行认证。

3.2 客户端API

• 功能: 从小米手环收集心率数据，并将数据报告给服务器。
• 参数:
  • --addr: 小米手环的地址
  • --auth-key: 小米手环的认证密钥
  • --server-addr: 服务器的地址
  • --server-key: 服务器的密钥

4. 项目安装方式

4.1 克隆项目

git clone git@github.com:wuhan005/mebeats.git

4.2 编译项目

• 服务器端：

  cd mebeats/cmd/mebeats-server
  go build .
  

• 客户端：

  cd mebeats/cmd/mebeats-client
  go build .
  

4.3 运行项目

• 服务器：

  ./mebeats-server --key=<your_secret_key>
  

• 客户端：

  ./mebeats-client --addr=<mi_band_addr> --auth-key=<mi_band_auth_key> --server-addr=<mebeats_server_addr> --server-key=<your_secret_key>
  

通过以上步骤，您可以成功安装并运行 mebeats 项目，实现小米手环心率数据的实时采集与报告。