Minecraft Compass项目API接口详解与技术指南

项目概述

Minecraft Compass是一个为Minecraft游戏设计的智能指南针设备项目，它通过硬件设备与Web服务的结合，为玩家提供精确的方向指引功能。该项目包含多种实用API接口，允许开发者或用户通过HTTP请求与设备进行交互，实现IP查询、设备控制、参数配置等功能。

基础功能接口

设备IP查询

接口路径：/ip

请求方法：GET

功能说明：获取设备当前的IP地址，用于网络调试和连接确认。

响应示例：

192.168.1.100

技术要点：

• 返回纯文本格式的IP地址
• 适用于快速获取设备网络状态
• 常用于设备初次连接时的网络验证

设备重启控制

接口路径：/restart

请求方法：POST

功能说明：远程重启设备，适用于配置变更后需要重启生效的场景。

注意事项：

• 执行后设备将立即重启
• 无返回内容，仅通过状态码确认执行结果
• 建议在配置变更后使用

设备信息管理

固件信息查询

接口路径：/info

请求方法：GET

功能说明：获取设备的详细固件信息，包括版本号、构建信息等。

响应字段解析：

字段名	类型	说明
buildVersion	String	固件版本号
gitCommit	String	代码提交哈希
model	String	设备型号(0:标准版,1:GPS版)
gpsStatus	String	GPS模块状态
sensorStatus	String	传感器状态

典型应用场景：

• 设备故障排查
• 版本兼容性检查
• 功能支持情况确认

WiFi配置管理

接口路径：/wifi

GET方法：获取当前保存的WiFi配置

POST方法：设置新的WiFi配置（旧版接口为/setWiFi）

参数说明：

参数	必填	说明
ssid	是	WiFi网络名称
password	是	WiFi密码

注意事项：

• 设置新WiFi会导致设备重启
• 新版接口更推荐使用/wifi
• 密码以明文传输，确保在安全网络中使用

游戏功能接口

出生点管理

接口路径：/spawn

功能说明：管理Minecraft游戏中的出生点坐标。

GET方法：获取当前设置的出生点坐标

响应示例：

{
  "latitude": 39.9042,
  "longitude": 116.4074
}

POST方法：设置新的出生点坐标

参数要求：

• latitude：纬度值（浮点数）
• longitude：经度值（浮点数）

应用场景：

• 游戏基地位置标记
• 重要地点坐标保存
• 多人游戏集合点设置

方向指示控制

指针颜色设置：/pointColors

方法：

• GET：获取当前指针颜色配置
• POST：设置指针颜色

参数说明：

• spawnColor：出生点指针颜色（十六进制）
• southColor：指南针指针颜色（十六进制）

方位角设置：/setAzimuth

功能：手动设置设备方位角（0-360度）

典型应用：

• 自定义指针颜色主题
• 设备校准调试
• 特殊方向指示需求

设备显示控制

亮度调节

接口路径：/brightness

GET方法：获取当前亮度值（0-255）

POST方法：设置新的亮度值

参数：

• brightness：亮度整数值

注意事项：

• 值超出范围会返回400错误
• 适合根据环境光线调整显示效果

帧索引控制（调试用）

接口路径：/setIndex

功能：调试接口，用于控制显示的帧索引

参数：

• index：帧索引值
• color：可选颜色值

高级配置管理

接口路径：/advancedConfig

功能说明：管理设备的高级配置参数

GET方法：获取当前配置

响应字段：

• model：设备型号
• serverMode：服务模式（0:WiFi,1:BLE）

POST方法：更新配置

应用场景：

• 设备模式切换
• 功能模块启用/禁用
• 系统级参数调整

最佳实践建议

1. 安全使用建议：

   • 在可信网络环境中使用API
   • 敏感操作后及时断开连接
   • 避免频繁调用重启接口

2. 开发调试技巧：

   • 先查询设备信息确认兼容性
   • 使用GET方法验证当前配置
   • 变更后确认设备响应

3. 性能优化：

   • 合并相关配置请求
   • 合理设置请求间隔
   • 优先使用新版接口

4. 错误处理：

   • 检查状态码确认操作结果
   • 参数错误会返回400状态
   • 未定义接口返回404

通过合理使用这些API接口，开发者可以充分发挥Minecraft Compass设备的潜力，实现个性化的游戏辅助功能。建议从查询类接口开始熟悉，逐步尝试配置类操作，最终实现完整的自定义功能集成。