MAVLink学习之路03_XML中定义MSG并生成C代码

MAVLink最新全套教程&＃xff1a;
1.MAVLink学习之路01_认识MAVLink
2.MAVLink学习之路02_工具下载、环境搭建
3.MAVLink学习之路03_XML中定义MSG并生成C代码
4.MAVLink学习之路04_MAVLink移植到STM32具体步骤
5.MAVLink学习之路05_MAVLink应用编程接口分析
······

该系列教程已经在我的个人微信公众号　「strongerHuang」　整理并分享。因在这里分享文章&＃xff0c;还需单独整理一遍&＃xff0c;时间有限&＃xff0c;就不再一一重复整理出来了。

所以&＃xff0c;想要查看更多相关教程&＃xff0c;关注我的个人微信公众号「strongerHuang」&＃xff0c;在公众号底部菜单&＃xff0c;或者回复【MAVLink学习之路】即可查看。

申明&＃xff1a;该文档由作者「strongerHuang」原创发布&＃xff0c;仅供个人学习使用&＃xff0c;转载请公众号联系作者授权。版权所有&＃xff0c;禁止商用。

如果你前面两篇文章掌握了&＃xff0c;说明你已经入门了。本文带你掌握如何在XML文件中定义Message&＃xff08;MSG消息&＃xff09;并生成C代码。

本文主要内容&＃xff1a;
　　　**·**如何在XML文件中定义Message&＃xff08;消息&＃xff09;
　　　**·**如何通过生成器工具生成MAVLink C代码

提示&＃xff1a;本文将结合上一篇文章提供下载的“MAVlink代码生成工具包”来讲述。

2.1 关于MSG

MAVLink的MSG消息定义在XML文件中&＃xff0c;通过生成器工具&＃xff08;Mavenerate或Mavgen&＃xff09;生成MAVLink C代码&＃xff1b;

在MAVLink协议中&＃xff0c;每一条MSG消息都具有一个ID&＃xff0c;且ID具有唯一性。MSG消息ID其实就是对应协议格式中msgid&＃xff0c;如下图&＃xff1a;

简单来说&＃xff1a;在xml中定义一条Message消息&＃xff0c;通过生成器工具就能生成该Message对应的C代码&＃xff08;一条Message也可以理解成一条通信命令&＃xff09;。

提示&＃xff1a;
在MAVLink V1版本中&＃xff0c;消息ID有效数字的范围为0到255。

其中0到149为公共消息ID&＃xff08;飞控系统共有消息&＃xff0c;一般不建议用于自定义&＃xff09;。而150到240为用于自定义消息的ID范围。

比如&＃xff0c;打开前面下载的工具包消息定义的文件夹&＃xff08;如下图&＃xff09;&＃xff0c;可以看到&＃xff1a;common.xml文件主要是一些公共消息ID范围为&＃xff1a;0到149。而其它xml文件是针对不同系统定义的消息&＃xff0c;主要集中在150到240之间。

2.2 MSG的定义方法

MAVLink的MSG消息定义在XML文件中&＃xff0c;所以遵循XML语法规则。语法很简单&＃xff08;只需要记住部分常用的就行&＃xff09;&＃xff0c;我们可以参考MAVLink定义好的xml文件。

解压上一篇文章下载**“MAVlink代码生成工具包”**&＃xff0c;打开&＃xff08;路径MAVLink \ message_definitions \ v1.0下&＃xff09;common.xml文件&＃xff0c;我们以“心跳”为例&＃xff1a;

从上图可以看出&＃xff1a;“心跳”消息包含&＃xff1a;消息ID、描述&＃xff08;注释&＃xff09;以及各项参数&＃xff08;可以理解为一个函数&＃xff0c;及函数的参数&＃xff09;。

1.《message》《/message》标签
每条消息都被定义在这样一个消息标签内。

2.id&＃61;“0”
表示此消息的id或index编号为0。

3.name&＃61;“HEARTBEAT”
该ID编号对应的名称。

4.《description》《/description》
对该消息的描述&＃xff0c;是一个非常重要&＃xff0c;但可选的领域&＃xff08;意思是可以不用定义&＃xff09;&＃xff0c;可以理解为代码的注释。

5.《field》《/field》
对消息的一个字段进行定义&＃xff0c;它类似于C语言中的一个变量&＃xff0c;可以是8,16,32和64位长度&＃xff08;有符号或无符号&＃xff09;&＃xff0c;以及浮点类型等。

6.type&＃61;“uint8_t”
将此字段定义为8位无符号整数。数组的定义如下&＃xff1a;type&＃61;“uint8_t[5]”。可以理解为一个函数参数的数据类型。

**7.name &＃61; “type” **
该字段的名称&＃xff0c;可以理解为一个函数参数的名称。

8.Type of the MAV
字段说明&＃xff0c;可以理解为函数参数的注释。

上面文字描述可能理解起来比较困难&＃xff0c;看下图心跳消息对应生成的C代码&＃xff1a;

以上举例&＃xff0c;只是提供其中一个函数接口&＃xff0c;其实还会生成更多与该消息相关的接口、结构体等。

上面2.2节在xml中定义消息明白了&＃xff0c;这节enum&＃xff08;枚举&＃xff09;的定义就很容易理解了&＃xff0c;原理一样。

枚举和消息只是内容有所差异&＃xff0c;定义原理都类似。枚举包含&＃xff1a;枚举名称&＃xff0c;成员&＃xff08;元素&＃xff09;名称&＃xff0c;成员值等。

枚举的定义就不详细描述出来&＃xff0c;提供枚举xml定义和生成C代码&＃xff0c;相信你一看就能明白。

提示&＃xff1a;
关于消息定义&＃xff0c;更多的内容可以参看&＃xff1a;
http://qgroundcontrol.org/mavlink/create_new_mavlink_message

上面第二章节在xml文件中定义好了MSG消息和enum枚举&＃xff0c;那么&＃xff0c;就需要通过生成器工具生成我们最终需要的代码&＃xff08;我主要讲述生成C代码&＃xff09;。

MAVLink项目提供有生成器有两种&＃xff1a;Mavgenerate&＃xff08;GUI&＃xff09;和Mavgen&＃xff08;命令行&＃xff09;&＃xff1b;

使用生成器工具前提需要搭建好环境&＃xff0c;请参考&＃xff1a;MAVLink学习之路02_工具下载、环境搭建

3.1 Mavgenerate生成C代码

这个工具使用方法很简单&＃xff0c;环境搭建好之后&＃xff0c;解压下载工具包&＃xff0c;在当前路径下输入命令“python mavgenerate.py”&＃xff0c;或者双击mavgenerate.py即可打开&＃xff1a;

3.2 Mavgen生成C代码

Mavgen生成器是一个通过命令实现的工具&＃xff0c;命令很简单&＃xff0c;比如&＃xff1a;python -m pymavlink.tools.mavgen --lang&＃61;C --wire-protocol&＃61;1.0 --output&＃61;generated/include/mavlink/v1.0 message_definitions/v1.0/common.xml 命令的具体描述请看下图&＃xff1a;

3.3 关于生成器几点提示

1.Mavgen支持的语言及版本

2.路径
因为命令行生成器支持相对路径&＃xff0c;建议将xml文件拷贝到如下路径&＃xff1a;MAVLink\message_definitions\v1.0

3.命令语法和选项说明

初学者不用深入理解&＃xff0c;只需要知道如何生成C代码即可&＃xff08;参考我上面提供的哪一条命令&＃xff09;。

关于生成器工具更多的内容可以参考&＃xff1a;
https://mavlink.io/en/getting_started/generate_libraries.html

1.因IAR各种IDE针对的处理器差异较大&＃xff0c;所以关于节点选项的配置差异也较大。本文讲述关于EWSTM8的许多节点选项可能在其他IDE中没有。
2.版权所有&＃xff0c;禁止商用。
3.该文档由作者「strongerHuang」原创发布&＃xff0c;仅供个人学习使用&＃xff0c;转载请公众号联系作者授权。

为了方便大家平时公交、地铁、外出办事也能用手机随时随地查看该教程&＃xff0c;该系列教程已更新于我的个人微信公众号　「strongerHuang」&＃xff0c;关注微信公众号回复【MAVLink学习之路】即可查看。

我的微信公众号&＃xff08;ID&＃xff1a;strongerHuang&＃xff09;还在分享STM8、STM32、Keil、IAR、FreeRTOS、UCOS、RT-Thread、CANOpen、Modbus…等更多精彩内容&＃xff0c;如果想查看更多内容&＃xff0c;可以关注我的微信公众号。