AI 编程支持
本文档介绍如何使用 AI 辅助工具(如 CodeBuddy、Codex、Cursor 等)快速开发机器人插件。
准备工作
使用 AI 编程前,需要准备参考文档:
- SDK 文档:https://dev.sh-agilebot.com/docs/sdk/knowledge/docs.txt
- 插件开发文档:https://dev.sh-agilebot.com/docs/extension/knowledge/docs.txt
提示:如果您使用的 AI Agent 无法很好地读取 URL,建议将以上两个 txt 文档下载到本地项目目录中,然后在 prompt 中引用本地文件路径。
示例 Prompt
以下是一个完整的示例,用于创建一个显示机器人状态的通用服务插件:
阅读以下文档,写一个通用服务插件,包含前端页面,显示机器人的当前位置、坐标系编号、伺服状态等信息。
参考资料:
SDK文档:https://dev.sh-agilebot.com/docs/sdk/knowledge/docs.txt
插件文档:https://dev.sh-agilebot.com/docs/extension/knowledge/docs.txt如果使用本地文档,可以修改为:
阅读以下文档,写一个通用服务插件,包含前端页面,显示机器人的当前位置、坐标系编号、伺服状态等信息。
参考资料:
SDK文档:./docs/sdk_docs.txt
插件文档:./docs/extension_docs.txt使用技巧
- 明确需求:清晰描述要实现的功能
- 提供上下文:引用相关文档和示例
- 分步实现:复杂功能可以分步骤让 AI 生成
注意事项
- AI 生成的代码需要经过验证和测试
- 确保代码符合项目编码规范
- 涉及机器人控制的代码必须进行安全审查