其他分享
首页 > 其他分享> > RCS/NML工程入门-三步使用

RCS/NML工程入门-三步使用

作者：互联网



RCS/NML工程入门－三步使用


撰写人：李峻翔
特别鸣谢：刘伯凯
版本：V1.2_20200928

第一步、RCS安装
第二步、配置ＮＭＬ文件（configuration file）
第三步、程序中调用ＮＭＬ库函数
编写C++NMLmessage
主程序采用NML进行消息传递
NML-demo
三模块双机通信
NML常见报错和解决思路TOC

NML是RCS库中的一部分，NML英文全称是neutral message language。它是由美国国家标准与技术研究院（NIST,National Institute of Standard and Technology）针对分布式通信而设计的一种通信协议与方式。
无人车开发过程中，使用ＮＭＬ通信，并不需要对ＮＭＬ了解很深。由于目前可参考的资料并不多，建议使用尽量采用现成模板，直接套用即可。但是，由于不知道基本运行原理，容易在遇到问题时束手无策。出于该目的， 笔者将经验总结，以供参考。
简单的说来，程序中要使用NML通信，只需要以下简单的三步。

第一步、RCS安装

参考文件：https://www.nist.gov/el/intelligent-systems-division-73500/networked-control-systems-group/rcs-library-installation
以下方法针对的是Ubuntu系统，如果是windows系统或者遇到了安装困难可以参加附件中的word文档。

  1. 确认依赖环境：boost（常用版本有1.54,1.55和1.58）和Java，如果没有Java，需要按以下步骤安装java。(其实安装java的过程即把安装包解压到合适的位置，之后建立软连接)
    update-alternatives --install /usr/bin/java
    java /opt/jdk1.7.0_79/bin/java 300
    update-alternatives --install
    /usr/bin/javac javac /opt/jdk1.7.0_79/bin/javac 300
    update-alternatives --install /usr/bin/jar
    jar /opt/jdk1.7.0_79/bin/jar 300
  2. 下载RCS安装包/获取团队现成安装包：
    http://www.isd.mel.nist.gov/projects/rcslib/rcslib-2014.04.29.tar.gz
  3. 解压安装包
  4. 直接在解压包下执行下列语句，安装位置会在/usr/local/lib
cd rcslib-2014.04.29(对应安装包名字)

./configure -enable-ALLJAVA
[修改Makefile中的prefix选项为 /opt/rcslib/build，此处将生成lib与include]
make 
[注意在Ubuntu 18.04中会报“unable to find string literal operator”错误，
需要在该文件(cms_xml_up.cc)中定位到此语句，并将该语句中“”引号的前后各加一个空格:xmlXsdType(xsdNs,\space "xsd:" \space X)]
make check
make install(可能需要root权限)

第二步、配置ＮＭＬ文件（configuration file）

以下部分是对ＮＭＬ官方文档的说明和一些实践中经验的补充。不同于官方文档，我们直接以我们车上的ＮＭＬ（bin/UGVAuto.nml）为模板，来说明。如果想使用，建议直接用模板修改，而不要从头到尾写。
ＮＭＬ配置文件主要包括四个部分，分别是：注释，消息，进程，server。
1.注释
注释以'#'开头，我们可以看到有一行以#开头，如下：
# Name Type Host size neut RPC# buffer# MP . . .
这就是注释。
为了更好的表示消息的写法，特意加了该注释。

2.消息(buffer)
消息对应在src/message里面的文件，只有定义了消息的头文件，才能够被其他程序调用。只有此处配置正确，才能保证消息的正常收发。
对于代表buffer的.hh文件，可用Makefile文件对message进行修改和编译，每次修改.hh文件都需要重新编译，编译生成新的/Test/lib/libTest.a文件。
Message名称都以n结尾，如MessageAn.hh MessageBn.hh MessageCn.hh等。这是在message文件夹里的Makefile中约定的，方便统一管理。而在.nml配置文件中，我们将后缀n略去。
消息以Ｂ开头，我们以现有模板的注释行为例，一一介绍该如何编写和定义消息。
# Buffers
# Name Type Host size neut RPC# buffer# MP . . .
B MessageA SHMEM 172.23.100.205 1024 0 * 1001 * 50001 bsem=5421 TCP=5421 xdr

这里要注意的是，如果用了两个不同的nml文件，如果有共同的buffer，后面的[Type-spec data]必须是一致的，否则无法通信。

3.进程(Process)
进程以Ｐ开头。
# Name Buffer Type Host Ops server timeout master cnum
# ModuleA
P ModuleA MessageA LOCAL 172.23.100.205 R 0 0.1 1 1 waitformaster

4.Server
Server是一种特殊的进程，其写法与进程类似。在/src/server下可用Makefile文件对server进行修改和编译，每次修改.cc文件都需要重新编译，编译生成新的/Test/bin/*svr 文件。

#Server
# Name Buffer Type Host 0ps server timeout master cnum
P ServerAsvr MessageA LOCAL 172.23.100.210 RW 1 0.1 1 51
注意：
server的Type都是LOCAL，Host是server程序所在主机地址。Ops一般为RW操作，server为1，master为1即可。

第三步、程序中调用ＮＭＬ库函数

这一部分，介绍内容分为两部分：一是如何使用C++来编写NMLmessage，二是主程序中如何使用NML来通信。

编写C++NMLmessage

NML message存放在src文件夹下，通常与应用程序在同一级目录下。这种目录结构能够最小化修改文件目录。


message文件夹内需要copy以下几个基本的文件：
-Makefile
-NMLmsgExn2.cc
-NMLmsgExn.hh
-CommonDefinitionX可用可不用，如果不用，则对应将头文件中的引用注释即可。
其中，

clean:
    -\rm -f *.o lib*.a lib*.so lib*.la *.lib *.ddll
// Prevent Multiple Inclusion
#ifndef MESSAGEAN_HH
#define MESSAGEAN_HH
// Include Files
#include "rcs.hh"     // Common RCS definitions
#include "NMLmsgExn.hh"
#include "CommonDefinitionX.hh"

定义MESSAGEA_MSG_TYPE.

// Define the integer type ids.
#define MESSAGEA_MSG_TYPE 40101

接下来则是消息的定义，可以根据自己的需要，自定义一些数据结构：

struct UserType{
    int int_array[2];
    std::string v_str;
};
// Define the NML Message Classes
class MESSAGEA_MSG : public NMLmsgEx
{
public:
    //Constructor
    MESSAGEA_MSG();
    // CMS Update Function
    void update(CMS *);
    // Place custom variables here.
    char v_char;
    double v_double;
    UserType usertype_data;
};
// Declare NML format function
extern int MessageAFormat(NMLTYPE, void *, CMS *);
#endif     // MESSAGEAN_HH

主程序采用NML进行消息传递

  1. NML通信模块启用
    在主程序中需要引用使用的NMLmessage的头文件。此外，在启用NML时使用，使用以下语句： 
    set_rcs_print_destination(RCS_PRINT_TO_STDOUT);
nml_start();
    在程序通信结束后，需要清空和关闭NML： 
    nml_cleanup();
  2. NML通信类的初始化
    NML的使用建立在NML通信类的基础上，初始化NML通信类采用以下命令，但需要已经写好nml配置文件，关于配置文件的要求，可以参见“配置ＮＭＬ文件（configuration file）”一节：
    NML * MESSAGE_CHANNEL = new NML(formatFunction,"buffer", "process", "config.nml");
    其中，参数buffer对应配置文件中B的名称，process对应P的名称，config.nml对应nml的文件名。
    formatFunction一般在nml message文件的最后有同名的定义。
    如果配置文件中Process对应的master为1，NML 通信类初始化后，才会启动buffer的master。
  3. NML通信消息的初始化
    针对写消息的模块，采用 
    Message_data = new MESSAGEA_MSG;
    针对读消息的模块，采用 
    Message_data = (MESSAGEC_MSG *) MESSAGE_CHANNEL->get_address();
    需要注意的是，接收的buffer，不需要重新new MESSAGEA_MSG。发送的Buffer，需要在构造函数中new MESSAGEA_MSG开辟新空间。
  4. 消息读写
    消息读采用以下命令判断接收是否正常，如果正常，可以直接使用buffer中定义变量： 
    MESSAGE_CHANNEL ->blocking_read(0.2)
    消息写采用以下命令： 
    MESSAGE_CHANNEL ->write(Message_data)

NML-demo

三模块双机通信

（written by Bokai Liu）
下载地址：
https://gitee.com/drshawn/RCS-Tutorial/tree/master/HelloWorldModule
该程序在两台计算机上运行，有三个模块，分别为(计算机1)模块A，模块B和(计算机2)模块C。
程序运行流程为：
模块B(发送消息A,B)--->模块A(接收消息A,B,并进行处理，发送消息C)。
模块A(发送消息C)--->模块C(接收消息C)。

NML常见报错和解决思路

(Welcome to update and supplement)

参考文献：
https://www.nist.gov/el/intelligent-systems-division-73500/networked-control-systems-group/nml-programmers-guide-c



来自为知笔记(Wiz)

附件列表

 

标签：文件,buffer,server,master,消息,NML,RCS,三步
来源： https://www.cnblogs.com/AIpower/p/13780410.html