diff --git a/README.md b/README.md index 84c73be85327037fc27656381eb2e0b8ee4de3ed..75cee617cef4cfb1aafc90f99fdef058409aa6d6 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,141 @@ # QuickRelease-SDK -#### 介绍 +## 介绍 -QuickRelease-SDK是快拆版光电吊舱对接开发工具包。 +QuickRelease-SDK 是快拆版光电吊舱对接开发工具包。该SDK为开发者提供了与快拆版光电吊舱进行通信和控制所需的完整接口,帮助开发者快速实现吊舱功能的集成与开发。 -#### 产品型号 +## 产品型号 -QuickRelease-SDK快拆版对接开发工具包适合以下产品: +QuickRelease-SDK 快拆版对接开发工具包适合以下产品: -1.TX108VB双轴单光吊舱;2.TX108IA三轴单光吊舱;3.TZ108DA三轴双光吊舱;4.TX108TF三轴三光吊舱;5.TX120VE三轴单光吊舱;6.TX120DB三轴双光吊舱;7.TZ130DA三轴双光吊舱;8.TZ130DB三轴双光吊舱;9.TZ130DF三轴双光吊舱;10.TZ130TN三轴三光吊舱;11.TZ130TL三轴三光吊舱;12.TZ130TM三轴三光吊舱;13.TX130TI三轴三光吊舱;14.TZ096FD三轴四光吊舱等。 +| 序号 | 型号 | 类型 | +|------|------|------| +| 1 | TX108VB | 双轴单光吊舱 | +| 2 | TX108IA | 三轴单光吊舱 | +| 3 | TZ108DA | 三轴双光吊舱 | +| 4 | TX108TF | 三轴三光吊舱 | +| 5 | TX120VE | 三轴单光吊舱 | +| 6 | TX120DB | 三轴双光吊舱 | +| 7 | TZ130DA | 三轴双光吊舱 | +| 8 | TZ130DB | 三轴双光吊舱 | +| 9 | TZ130DF | 三轴双光吊舱 | +| 10 | TZ130TN | 三轴三光吊舱 | +| 11 | TZ130TL | 三轴三光吊舱 | +| 12 | TZ130TM | 三轴三光吊舱 | +| 13 | TX130TI | 三轴三光吊舱 | +| 14 | TZ096FD | 三轴四光吊舱 | -更多产品系列,可以通过Issues咨询天科科技工程师。 -#### 注意事项 +更多产品系列,可以通过 Issues 咨询天科科技工程师。 +## 软件架构 - **产品硬件操作禁令** +QuickRelease-SDK 提供了完整的开发接口,主要包含以下模块: -云台类产品出厂前已完成适配搭载相机、镜头的调试,禁止自行调整云台、改动其机械结构,也不得为云台加装额外外接设备。 +- **通信协议层**:实现与吊舱的串口/网络通信 +- **控制指令集**:云台角度控制、变焦控制、拍照录像等 +- **状态反馈**:实时获取云台状态、角度信息、故障诊断等 +- **参数配置**:吊舱工作模式、图像参数等配置接口 -云台属于高精度精密结构件,禁止私自对产品进行拆解组装,否则会直接导致云台相机出现工作异常等问题。 +## 安装指南 -非经官方允许不得私自改装产品,自行改装带来的相关后果由用户自行承担。 +### 环境要求 +- 操作系统:Windows 7/10、Linux (Ubuntu 18.04+)、macOS +- 开发环境:C/C++ (推荐)、Python +- 硬件接口:串口通信或网络接口 - **调试安全要求** +### 安装步骤 -进行云台调试操作时,必须确保飞行器处于安全状态: +1. **克隆仓库** + ```bash + git clone https://gitee.com/taking-sdk/quick-release-sdk.git + ``` -禁止在存在易燃易爆风险、有无关人员尤其是儿童在场的环境下通电调试产品。 +2. **配置依赖** + 根据您的开发环境,安装相应的依赖库 -强烈建议在调试操作开始前,提前取下飞行器的螺旋桨,避免误触带来的机械伤害风险。 +3. **编译构建** + ```bash + cd quick-release-sdk + # 按照对应平台的构建说明进行编译 + ``` +4. **集成到项目** + 将生成的库文件及头文件集成到您的项目中 + +## 使用说明 + +### 基础示例 + +```c +// 初始化SDK +QuickRelease_Init(); + +// 连接吊舱设备 +int ret = QuickRelease_Connect("192.168.1.1", 9000); + +// 控制云台角度 +QuickRelease_SetGimbalAngle(pan, tilt); + +// 获取云台状态 +GimbalStatus status; +QuickRelease_GetStatus(&status); + +// 断开连接 +QuickRelease_Disconnect(); +``` + +### 注意事项 + +- 使用前请确保吊舱设备已正确连接 +- 建议在测试环境充分验证后再进行实际部署 +- 关注官方更新,及时升级SDK版本 + +## 常见问题 + +**Q: 吊舱无法连接怎么办?** +A: 检查网络/串口配置是否正确,确认设备供电正常,查看防火墙设置。 + +**Q: 控制指令无响应?** +A: 确认通信协议版本匹配,检查指令格式是否正确,查看设备日志排查问题。 + +## 贡献指南 + +欢迎提交 Issue 和 Pull Request 来帮助改进 QuickRelease-SDK。 + +1. Fork 本仓库 +2. 创建特性分支 (`git checkout -b feature/xxx`) +3. 提交更改 (`git commit -m 'Add xxx'`) +4. 推送到分支 (`git push origin feature/xxx`) +5. 创建 Pull Request + +## 安全警告 + +> ⚠️ **产品硬件操作禁令** +> +> 云台类产品出厂前已完成适配搭载相机、镜头的调试,禁止自行调整云台、改动其机械结构,也不得为云台加装额外外接设备。 +> +> 云台属于高精度精密结构件,禁止私自对产品进行拆解组装,否则会直接导致云台相机出现工作异常等问题。 +> +> 非经官方允许不得私自改装产品,自行改装带来的相关后果由用户自行承担。 + +> ⚠️ **调试安全要求** +> +> 进行云台调试操作时,必须确保飞行器处于安全状态: +> +> 禁止在存在易燃易爆风险、有无关人员尤其是儿童在场的环境下通电调试产品。 +> +> 强烈建议在调试操作开始前,提前取下飞行器的螺旋桨,避免误触带来的机械伤害风险。 + +## 许可证 + +本项目仅供学习交流使用,具体授权条款请咨询天科科技。 + +## 联系方式 + +- 问题反馈:https://gitee.com/taking-sdk/quick-release-sdk/issues +- 官方网站:http://www.taking-tech.com + +--- + +© 2024 天科科技. All rights reserved. \ No newline at end of file