用户手册 STM32 电机控制 SDK v5.0 入门指南 引言 STM32 微控制器提供工业标准 Arm Cortex -M 内核的性能, 可运行矢量控制 (VC) 或磁场定向控制 (FOC) 模式, 广泛应用于空调 家用电器 无人机 建筑和工业自动化 医疗和电动自行车等高性能驱动的应用领域 STM32 电机控制软件开发套件 (MC SDK) 是 STMicroelectronics 电机控制生态系统的一部分, 该生态系统为电机控制应用提供广泛的硬件和软件解决方案 根据所应用的软件许可协议, 它被引用为 X-CUBE-MCSDK 或 X-CUBE-MCSDK-FUL 它包括 : 用于永磁同步电机 (PMSM) 磁场定向控制的 ST MC FOC 固件库 ST MC 工作站软件工具是一个用于配置 MC SDK 固件库参数的图形用户界面, 包括 ST 电机分析仪工具 (MP) STM32 电机控制软件开发套件可用于评估 STM32 微控制器在驱动 STM32 生态系统中单个或两个三相永磁同步电机的性能 ST MC 工作站软件工具可在 PC 上运行 在配置 STM32 MC FOC 固件库时, 它减少了设计时间和精力 通过其图形用户界面, 它可以生成应用程序所需的所有配置文件, 以及实时监视和调整一些 FOC 算法变量 此外,ST MC 工作站还与 STM32CubeMX 连接, 以充分利用其生态系统并定制嵌入式应用程序 2018 年 10 月 UM2374 Rev 1 [English Rev 1] 1/24 www.st.com 1
目录 UM2374 目录 1 概述....................................................... 5 2 电机控制生态系统设置........................................ 6 2.1 软件工具设置............................................... 6 2.2 硬件设置................................................... 7 3 入门....................................................... 8 3.1 硬件连接................................................... 8 3.2 电机分析................................................... 8 3.3 MC 项目生成............................................... 13 3.4 电机控制项目编译........................................... 18 3.5 MC 嵌入式应用程序下载...................................... 18 3.6 旋转电机的控制与监控....................................... 19 4 使用须知和限制条件......................................... 22 版本历史........................................................... 23 2/24 UM2374 Rev 1 [English Rev 1]
表格索引 表格索引 表 1. 缩略语列表.............................................................. 5 表 2. 文档版本历史........................................................... 23 表 3. 中文文档版本历史........................................................ 23 UM2374 Rev 1 [English Rev 1] 3/24 3
图片索引 UM2374 图片索引 图 1. ST MC 工作站 - 图标和安装文件夹树.......................................... 8 图 2. ST MC 工作站 - GUI 展开顶视图.............................................. 8 图 3. ST 电机分析仪 - GUI....................................................... 9 图 4. ST 电机分析仪 - 硬件设置列表示例............................................ 10 图 5. ST 电机分析仪 - SM-PMSM 参数示例......................................... 11 图 6. ST 电机分析仪 - I-PMSM 参数示例............................................ 11 图 7. ST 电机分析仪 - 测量结果.................................................. 12 图 8. ST 电机分析仪 - 保存 窗口................................................. 13 图 9. ST MC 工作站 - 新项目 窗口............................................... 14 图 10. ST MC 工作站 - 新项目信息 窗口............................................ 14 图 11. ST MC 工作站 - 项目设置.................................................. 15 图 12. ST MC 工作站 - 项目设置 窗口.............................................. 15 图 13. ST MC 工作站 - 项目生成 按钮.............................................. 16 图 14. ST MC 工作站 - 工作区选择................................................. 16 图 15. ST MC 工作站 - 项目生成 创建信息.......................................... 17 图 16. IDE - MC 项目视图示例.................................................... 18 图 17. ST MC 工作站 - 电机监控 按钮.............................................. 19 图 18. ST MC 工作站 - 电机监控 GUI.............................................. 20 图 19. ST MC 工作站 - 使用电机控制与监控......................................... 21 4/24 UM2374 Rev 1 [English Rev 1]
概述 1 概述 MC SDK 用于开发基于 Arm Cortex -M 处理器的 STM32 32 位微控制器上运行的电机控制应用程序 表 1 给出了相关的缩略语定义, 帮助您更好地理解本文档 表 1. 缩略语列表 缩略语 说明 GUI 图形用户界面 IDE 集成开发环境 FOC 磁场定向控制 FW 固件 MC 电机控制 MC WB 电机控制工作站 (STMicroelectronics 软件工具 ) MP 电机分析仪 (STMicroelectronics 软件工具 ) PMSM PWM SDK VC 永磁同步电机脉冲宽度调制软件开发套件矢量控制 有关 ST MC 工作站的更多信息, 请登录 www.st.com, 查看 STM32 电机控制 SDK v5.0 工具用户手册 (UM2380) UM2374 Rev 1 [English Rev 1] 5/24 23
电机控制生态系统设置 UM2374 2 电机控制生态系统设置 ST 电机控制生态系统环境包括 : 一台运行所需 MC 软件工具的 PC 第三方 IDE 第三方 ANSI C 编译器 JTAG/SWD 接口, 具有调试和编程能力 STMicroelectronics 应用板, 支持其中一个 STM32 微控制器 它驱动功率板, 具有以下特性 : PWM 输出至门极驱动器 ADC 通道, 以测量电流 DC 总线电压 三相 PMSM 电机 电源 有关详细信息, 请登录 www.st.com, 查看 STM32 电机控制软件开发套件 (MC SDK) 数据摘要 (DB3548) 和版本说明 2.1 软件工具设置 STMicroelectronics 电机控制生态系统运行于装有 Windows 7 的 PC 确保已正确安装下列 PC 软件工具 : ST MC 工作站 (v5.0.0 或更高版本 ) STM32CubeMX(v4.24.0 或更高版本 ) ST-LINK/V2(v4.0.0 或更高版本 ) 任何支持的 IDE: 用于 Arm (v7.80.4) 的 IAR Embedded Workbench Keil MDK 工具 (v5.24.2 或更高版本 ) Ac6 系统工作站 (v2.3.0 或更高版本 ) (a) 请参阅对应的用户手册, 以便正确安装 STMicroelectronics 文档可在 www.st.com 网站上获得 : STM32 电机控制 SDK v5.0 工具用户手册 (UM2380) 用于 STM32 配置和初始化 C 代码生成的 STM32CubeMX 用户手册 (UM1718) STM32 ST-LINK 实用工具软件说明用户手册 (UM0892) a. SDK v5.0 不支持 Ac6 工具框架, 但后续版本支持 6/24 UM2374 Rev 1 [English Rev 1]
电机控制生态系统设置 2.2 硬件设置 STMicroelectronics 应用板与 PC 的连接需要 USB A 型连接器 有关 USB 连接线的详细信息, 请参阅应用板的说明 每个 STMicroelectronics 应用板均提供专用的说明卡, 以便正确安装 有关详细信息, 请参见 www.st.com 网站的应用板用户手册 选中的硬件可以是以下三种设置之一 : 完整的 MC 套件 完整的逆变器板之一 任何 STM32 评估板与包含 MC 连接器的 ST 评估功率板之一相结合 UM2374 Rev 1 [English Rev 1] 7/24 23
入门 UM2374 3 入门 警告 : 检查应用板是否正确配置, 以适用于电机控制应用, 并提供预期的输入电压 注 : 请参阅相关硬件的用户手册, 以设置正确的配置 电压范围 串行通信功能和编程 / 调试接口 3.1 硬件连接 如果与 USB 线不同, 请在 PC 和 STMicroelectronics 应用板以及 JTAG/SWD 编程线之间连接一条 USB 线 3.2 电机分析 可通过以下方式启动 ST MC 工作站软件工具 : 点击其图标 直接从安装文件夹树运行图 1 介绍了启动 ST MC 工作站的两种方法 图 1. ST MC 工作站 - 图标和安装文件夹树 可通过以下方式打开 ST 电机分析仪 : 如图 2 所述, 使用 ST MC 工作站 GUI 的专用按钮进行启用 如图 1 所述, 直接从安装文件夹树运行图 2. ST MC 工作站 - GUI 展开顶视图 8/24 UM2374 Rev 1 [English Rev 1]
入门 注 : 点击选择板按钮, 显示支持的板列表, 如图 3 所示, 并选择 STMicroelectronics 应用板设置 图 4 第 10 页显示了本列表的示例 ST 电机分析仪工具仅可用于支持的设置列表中的 ST 硬件 图 3. ST 电机分析仪 - GUI UM2374 Rev 1 [English Rev 1] 9/24 23
入门 UM2374 图 4. ST 电机分析仪 - 硬件设置列表示例 点击以选中 STMicroelectronics 硬件设置, 并配置 ST 电机分析仪工具 例如, 图 4 显示了带有 NUCLEO-F302R8 和 X-NUCLEO-IHM07M1 的 P-NUCLEO-IHM001 电机控制 Nucleo 包 选择硬件设置后, 使用电机信息填写参数字段 : 电机极对数 ( 必填字段 ) 电机最大速度 ( 可选字段 ) 默认情况下,ST 电机分析仪工具会搜索与电机和所用硬件设置相匹配的最大允许速度 电机允许的最大电流 ( 可选字段 ) 默认情况下, 它是指硬件设置可提供的最大峰值电流 硬件设置使用的标称 DC 母线电压 ( 可选字段 ) 默认情况下, 它是指电源电压, 既可以是低压应用的母线电压 ( 直流电压 ), 也可以是高压应用的 RMS 值 ( 交流电压 ) 磁性内置型 ( 必填字段 ) 默认选择 SM-PMSM 如图 6 第 11 页所示, 仅当选择 I-PMSM 内置时的 Ld/Lq 比率 ( 必填字段 ) 10/24 UM2374 Rev 1 [English Rev 1]
入门 图 5 提供了 P-NUCLEO-IHM001 硬件设置随附的 BR2804-1700KV-1 电机的示例值 图 5. ST 电机分析仪 - SM-PMSM 参数示例 图 6. ST 电机分析仪 - I-PMSM 参数示例 注 : 点击图 3:ST 电机分析仪 - GUI 第 9 页所示的 连接 按钮 当应用板是新的或已擦除时, 按下 升级固件 按钮会自动将正确的固件加载到微控制器中如果无法执行编程过程, 请检查 JTAG/SWD 编程线如果执行编程过程但电机分析仪无法与应用板通信, 请检查串行通信连接 UM2374 Rev 1 [English Rev 1] 11/24 23
入门 UM2374 建立连接后, 按下开始分析按钮, 启动电机分析仪, 如图 7 所示 成功完成分析后, 所有电机测量结果均以绿色或橙色显示, 如图 7 所示 显示红色时, 检查硬件设置并重新启动电机分析序列 图 7. ST 电机分析仪 - 测量结果 单击保存 按钮 ( 参见图 7), 存储电机测量值, 以便以后用于 ST MC 工作站软件工具 图 8 第 13 页显示此时出现的菜单 : 输入已分析电机的名称 ( 例如 BR2804-1700KV-1) 提供有关已分析电机的详细信息, 例如在 12 Vdc 下具有 7 对极的三相电机 12/24 UM2374 Rev 1 [English Rev 1]
入门 图 8. ST 电机分析仪 - 保存 窗口 单击断开 按钮, 停止使用 ST 电机分析仪工具并关闭窗口 3.3 MC 项目生成 可通过以下方式启动 ST MC 工作站软件工具 : 如图 1 第 8 页所示, 点击其图标或直接从安装文件夹树运行, 或者, 如图 2 第 8 页所示, 回到 ST MC 工作站 GUI 点击新项目按钮 显示后, 在 新项目 窗口中提供硬件设置信息, 如图 9 第 14 页所示 : 1. 选择 应用程序类型 2. 勾选 单电机 或 双电机 复选框 3. 选择 ST 硬件设置板 : 如果 ST 板是完整的逆变器板 ( 带有功率器件和控制电子设备的单板 ), 请选择 逆变器 组合框, 从下拉列表中选择 逆变器 选项 如果使用了诸如 P-NUCLEO-IHM001 的 ST MC 套件, 请选择 MC 套件组合框, 从下拉列表中选择 套件 选项 如果系统由与功率评估板关联的控制评估板组成, 请选择 功率和控制 组合框, 从下拉列表中选择 控制板 和 功率板 4. 从下拉列表中选择已分析的电机 5. 点击 确定 按钮, 导入所需的所有硬件设置 UM2374 Rev 1 [English Rev 1] 13/24 23
入门 UM2374 图 9. ST MC 工作站 - 新项目 窗口 几秒钟后, 将显示新项目信息窗口, 可以在该窗口中检查电机工作条件, 如图 10 所示 图 10. ST MC 工作站 - 新项目信息 窗口 14/24 UM2374 Rev 1 [English Rev 1]
入门 点击图 11 所示的 输出文件夹选项 按钮, 打开 项目设置 窗口 图 11. ST MC 工作站 - 项目设置 注 : 选择常用的工具链 /IDE, 如图 12 所示 ( 默认 EWARM) 点击 确定 按钮 仅可修改工具链 /IDE (a) 图 12. ST MC 工作站 - 项目设置 窗口 a. SDK v5.0 不支持 TrueSTUDIO 和 SW4STM32 框架工具, 但后续版本支持 UM2374 Rev 1 [English Rev 1] 15/24 23
入门 UM2374 点击图 13 所示的 生成 按钮, 生成 MC 项目 生成 MC 项目需要数秒钟时间 图 13. ST MC 工作站 - 项目生成 按钮 注 : 对于新项目, 在生成项目之前, 出现一个配置对应工作区设置的窗口, 如图 14 所示 选择工作区目录, 点击 确定 按钮 这个步骤可能需要等待几秒钟 图 14. ST MC 工作站 - 工作区选择 16/24 UM2374 Rev 1 [English Rev 1]
入门 信息 / 错误 / 警告区介绍了关于项目生成进度的信息, 如图 15 所示 图 15. ST MC 工作站 - 项目生成 创建信息 注 : 请勿关闭 ST MC 工作站软件工具 在电机控制时还需要进一步使用该工具 UM2374 Rev 1 [English Rev 1] 17/24 23
入门 UM2374 3.4 电机控制项目编译 注意 : 可从 IDE 或者通过双击工作区文件, 运行 MC 项目 显示如图 16 所示的窗口 在 IAR Embedded Workbench for Arm v7.80.4 中,C 编译器优化必须设置为速度 图 16. IDE - MC 项目视图示例 3.5 MC 嵌入式应用程序下载 注意 : 在 IDE 下载嵌入式应用程序至目标板中 如果已经正确安装 ST/LINK, 这就是最直接的操作方法 确保将 ST/LINK 配置为 IDE 中默认的调试 / 编程工具 18/24 UM2374 Rev 1 [English Rev 1]
入门 3.6 旋转电机的控制与监控 使用 ST MC 工作站软件工具执行旋转电机的控制和监控 点击图 17 所示的监控按钮 图 17. ST MC 工作站 - 电机监控 按钮 UM2374 Rev 1 [English Rev 1] 19/24 23
入门 UM2374 控制和监控的 GUI, 如图 18 所示 检查通信链路设置, 必要时进行配置, 并点击 连接 按钮 图 18. ST MC 工作站 - 电机监控 GUI 20/24 UM2374 Rev 1 [English Rev 1]
入门 连接结果如图 19 中所示 一旦建立连接 : 点击启动电机按钮, 旋转电机 监控电机速度 点击停止电机按钮, 停止电机图 19. ST MC 工作站 - 使用电机控制与监控 注 : 如果出现故障 : - 检查原因 - 解决问题 - 点击 故障确认 按钮 - 点击 启动电机 按钮, 再次旋转电机 UM2374 Rev 1 [English Rev 1] 21/24 23
使用须知和限制条件 UM2374 4 使用须知和限制条件 电机分析算法旨在用于快速评估 ST MC 解决方案 它可以用于驱动任何三相 PMSM, 无需使用特定仪器或具备特殊技能 尽管测量结果的精确性不如适当的仪器工具,ST 电机分析仪测量结果在以下情况下得到优化 ( 图 7:ST 电机分析仪 - 测量结果第 12 页中绿色字体 ): 定子电阻大于 1 Ω 定子电感大于 1 mh 此外, 务必根据电机特性, 选择适当的硬件 例如, 电机的最大电流应当尽可能与应用板的最大电流相匹配 ST 电机分析仪仅可用于兼容的 STMicroelectronics 评估板 警告 : 使用 ST 电机分析仪工具, 查看支持的系统列表 22/24 UM2374 Rev 1 [English Rev 1]
版本历史 版本历史 表 2. 文档版本历史 日期版本变更 2018 年 3 月 6 日 1 初始版本 表 3. 中文文档版本历史 日期版本变更 2018 年 10 月 15 日 1 中文初始版本 UM2374 Rev 1 [English Rev 1] 23/24 23
重要通知 - 请仔细阅读 意法半导体公司及其子公司 ( ST ) 保留随时对 ST 产品和 / 或本文档进行变更 更正 增强 修改和改进的权利, 恕不另行通知 买方在订货之前应获取关于 ST 产品的最新信息 ST 产品的销售依照订单确认时的相关 ST 销售条款 买方自行负责对 ST 产品的选择和使用, ST 概不承担与应用协助或买方产品设计相关的任何责任 ST 不对任何知识产权进行任何明示或默示的授权或许可 转售的 ST 产品如有不同于此处提供的信息的规定, 将导致 ST 针对该产品授予的任何保证失效 ST 和 ST 徽标是 ST 的商标 所有其他产品或服务名称均为其各自所有者的财产 本文档中的信息取代本文档所有早期版本中提供的信息 本文档的中文版本为英文版本的翻译件, 仅供参考之用 ; 若中文版本与英文版本有任何冲突或不一致, 则以英文版本为准 2018 STMicroelectronics - 保留所有权利 24/24 UM2374 Rev 1 [English Rev 1]