Onvif协议：IPC客户端开发之获取设备基本信息

冷不防 2022-11-20 08:06 770阅读 0赞

# 引言 #

在[Ovif入门之实现Probe命令来进行设备发现（discover)][Ovif_Probe_discover]我们已经大概知道了`ONVIF`开发的一般步骤了，而且已经可以搜索到IPC摄像头了，搜索出IPC之后，就有了IPC的  
Web Services地址，接下来就能够通过一系列的ONVIF接口访问IPC。

我们要做的第一件事情就是获取IPC摄像头的基本信息，即调用GetDeviceInformation接口。

有关GetDeviceInformation接口的描述，可以参阅devicemgmt.wsdl文档（[https://www.onvif.org/onvif/ver10/device/wsdl/devicemgmt.wsdl][https_www.onvif.org_onvif_ver10_device_wsdl_devicemgmt.wsdl]），如下图所示：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center]

> ps：一般我们进行Onvif对接，只需要扮演客户端的角色，因此我们在生成框架代码的时候可以不生成服务端代码。

# 实践 #

## 生成框架 ##

（1） 准备原材料  
创建目录`onvif-discover-devinfo`， 目录下有两个目录`bin`和`gsoap`

![在这里插入图片描述][20201027154122959.png_pic_center]

*  bin：放置gsoap编译后生成的两个工具wsdl2h , soapcpp2  
    ![在这里插入图片描述][20201028092834383.png_pic_center]
 *  gsoap：
    
     *  编译后的gsoap文件夹，其路径为 /home/oceanstar/workspace/cpp/Onvif/gsoap/share
     *  gsoap源代码（/home/oceanstar/workspace/cpp/gsoap-2.8/gsoap）下的几个文件拷到我们的gsoap目录下，dom.c ,dom.cpp， stdsoap2.c stdsoap2.h，stdsoap2.cpp  
        ![在这里插入图片描述][20201027154149714.png_pic_center]  
        （2）编写脚本`onvif_head.sh`，生成头文件

#!/bin/bash
    mkdir onvif_head
    cd onvif_head
    ../bin/wsdl2h -o onvif.h   -t ../gsoap/WS/typemap.dat \
    http://www.onvif.org/onvif/ver10/network/wsdl/remotediscovery.wsdl \
    https://www.onvif.org/onvif/ver10/device/wsdl/devicemgmt.wsdl

![在这里插入图片描述][20201027154714774.png_pic_center]

（3） 编写脚本`gen_code.sh`， 根据上面生成的头文件生成源文件

#!/bin/bash
    DIR=soap
    mkdir $DIR
    cd $DIR
     ../bin/soapcpp2 -2 -x -C ../onvif_head/onvif.h  -L -I ../gsoap/import -I ../gsoap/

*  \-C　　　　仅生成客户端client代码

执行当前脚本  
![在这里插入图片描述][20201027154936330.png_pic_center]  
报错：

wsa5.h(290): **ERROR**: service operation name clash: struct/class 'SOAP_ENV__Fault' already declared at wsa.h:278

解决： 将将gsoap源码的wsa5.h(位于gsoap\\import目录)的SOAP\_ENV\_\_Fault函数改成其他名字或者直接注释掉  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 1]  
重新执行，生成的文件如下：  
![在这里插入图片描述][20201027160327694.png_pic_center]

*  各种nsmap文件：命名空间，除了名字不一样，内容是一样的，里面的内容竟然是每一个xml文件里的Envelope字段内容。我们只需要留下一个就可以了，并将之改名为wsdd.nsmap
 *  soapC.c：指定数据结构的序列化和反序列化
 *  soapClient.c：客户端代码
 *  soapH.h：主头文件，所有客户机和服务器源代码都要包括它
 *  soapStub.h：从输入头文件（onvif.h）生成的经过修改且带命名空间前缀的头文件

## 编写代码 ##

1、为了方便，我们将所有需要的代码放到同一个目录中。我们在刚才建立的`onvif-discover-devinfo`目录下创建一个`application`目录，存放我们需要的所有代码。

*  从刚刚生成的soap目录下拷贝`wsdd.nsmap`和所有的`.c`和`.h`以及onvif\_head目录下的头文件`onvif.h`
 *  从gsoap目录下复制`stdsoap2.cpp`与`stdsoap2.h`到application下  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 2]  
    2、在`application`目录创建一个`CMakeLists.txt`文件，CMakeLists.txt文件内容如下：

cmake_minimum_required(VERSION 3.16)
    project(onvif-discover)
    
    set(CMAKE_CXX_STANDARD 11)
    
    add_definitions("-Wall -g")
    aux_source_directory(. SRC_LIST)
    add_executable(onvif-discover  ${
        SRC_LIST} )

然后我们就可以用CLion打开这个工程了。

3、在`application`创建一个`build`目录，进入`build`目录之后：

cmake ..
    make

![在这里插入图片描述][20201027161919769.png_pic_center]  
4、编写客户端源码： 在`application`目录创建一个`deviceclient.cpp`，内容为

#include <assert.h>
    #include "soapH.h"
    #include "wsdd.nsmap"
    #include "soapStub.h"
    
    
    #define SOAP_ASSERT     assert
    #define SOAP_DBGLOG     printf
    #define SOAP_DBGERR     printf
    
    #define SOAP_TO         "urn:schemas-xmlsoap-org:ws:2005:04:discovery"
    #define SOAP_ACTION     "http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe"
    
    #define SOAP_MCAST_ADDR "soap.udp://239.255.255.250:3702"                       // onvif规定的组播地址
    
    #define SOAP_ITEM       ""                                                      // 寻找的设备范围
    #define SOAP_TYPES      "dn:NetworkVideoTransmitter"                            // 寻找的设备类型
    
    #define SOAP_SOCK_TIMEOUT    (10)               // socket超时时间（单秒秒）
    
    void soap_perror(struct soap *soap, const char *str)
    {
        
        if (nullptr == str) {
        
            SOAP_DBGERR("[soap] error: %d, %s, %s\n", soap->error, *soap_faultcode(soap), *soap_faultstring(soap));
        } else {
        
            SOAP_DBGERR("[soap] %s error: %d, %s, %s\n", str, soap->error, *soap_faultcode(soap), *soap_faultstring(soap));
        }
    }
    
    void* ONVIF_soap_malloc(struct soap *soap, unsigned int n)
    {
        
        void *p = nullptr;
    
        if (n > 0) {
        
            p = soap_malloc(soap, n);
                    SOAP_ASSERT(nullptr != p);
            memset(p, 0x00 ,n);
        }
        return p;
    }
    
    struct soap *ONVIF_soap_new(int timeout)
    {
        
        struct soap *soap = nullptr;                                                   // soap环境变量
    
        SOAP_ASSERT(nullptr != (soap = soap_new()));
    
        soap_set_namespaces(soap, namespaces);                                      // 设置soap的namespaces
        soap->recv_timeout    = timeout;                                            // 设置超时（超过指定时间没有数据就退出）
        soap->send_timeout    = timeout;
        soap->connect_timeout = timeout;
    
    #if defined(__linux__) || defined(__linux)                                      // 参考https://www.genivia.com/dev.html#client-c的修改：
        soap->socket_flags = MSG_NOSIGNAL;                                          // To prevent connection reset errors
    #endif
    
        soap_set_mode(soap, SOAP_C_UTFSTRING);                                      // 设置为UTF-8编码，否则叠加中文OSD会乱码
    
        return soap;
    }
    
    void ONVIF_soap_delete(struct soap *soap)
    {
        
        soap_destroy(soap);                                                         // remove deserialized class instances (C++ only)
        soap_end(soap);                                                             // Clean up deserialized data (except class instances) and temporary data
        soap_done(soap);                                                            // Reset, close communications, and remove callbacks
        soap_free(soap);                                                            // Reset and deallocate the context created with soap_new or soap_copy
    }
    
    /************************************************************************
    **函数：ONVIF_init_header
    **功能：初始化soap描述消息头
    **参数：
            [in] soap - soap环境变量
    **返回：无
    **备注：
        1). 在本函数内部通过ONVIF_soap_malloc分配的内存，将在ONVIF_soap_delete中被释放
    ************************************************************************/
    void ONVIF_init_header(struct soap *soap)
    {
        
        struct SOAP_ENV__Header *header = nullptr;
    
        SOAP_ASSERT(nullptr != soap);
    
        header = (struct SOAP_ENV__Header *)ONVIF_soap_malloc(soap, sizeof(struct SOAP_ENV__Header));
        soap_default_SOAP_ENV__Header(soap, header);
        header->wsa__MessageID = "shsuishsihsishsishsuisbjshsusisuisusi";
        header->wsa__To        = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_TO) + 1);
        header->wsa__Action    = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_ACTION) + 1);
        strcpy(header->wsa__To, SOAP_TO);
        strcpy(header->wsa__Action, SOAP_ACTION);
        soap->header = header;
    }
    
    /************************************************************************
    **函数：ONVIF_init_ProbeType
    **功能：初始化探测设备的范围和类型
    **参数：
            [in]  soap  - soap环境变量
            [out] probe - 填充要探测的设备范围和类型
    **返回：
            0表明探测到，非0表明未探测到
    **备注：
        1). 在本函数内部通过ONVIF_soap_malloc分配的内存，将在ONVIF_soap_delete中被释放
    ************************************************************************/
    void ONVIF_init_ProbeType(struct soap *soap, struct wsdd__ProbeType *probe)
    {
        
        struct wsdd__ScopesType *scope = nullptr;                                      // 用于描述查找哪类的Web服务
    
                SOAP_ASSERT(nullptr != soap);
                SOAP_ASSERT(nullptr != probe);
    
        scope = (struct wsdd__ScopesType *)ONVIF_soap_malloc(soap, sizeof(struct wsdd__ScopesType));
        soap_default_wsdd__ScopesType(soap, scope);                                 // 设置寻找设备的范围
        scope->__item = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_ITEM) + 1);
        strcpy(scope->__item, SOAP_ITEM);
    
        memset(probe, 0x00, sizeof(struct wsdd__ProbeType));
        soap_default_wsdd__ProbeType(soap, probe);
        probe->Scopes = scope;
        probe->Types  = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_TYPES) + 1);     // 设置寻找设备的类型
        strcpy(probe->Types, SOAP_TYPES);
    }
    
    void ONVIF_DetectDevice(void (*cb)(char *DeviceXAddr))
    {
        
        int i;
        int result = 0;
        unsigned int count = 0;                                                     // 搜索到的设备个数
        struct soap *soap = nullptr;                                                   // soap环境变量
        struct wsdd__ProbeType      req;                                            // 用于发送Probe消息
        struct __wsdd__ProbeMatches rep;                                            // 用于接收Probe应答
        struct wsdd__ProbeMatchType *probeMatch;
    
        SOAP_ASSERT(nullptr != (soap = ONVIF_soap_new(SOAP_SOCK_TIMEOUT)));
    
        ONVIF_init_header(soap);                                                    // 设置消息头描述
        ONVIF_init_ProbeType(soap, &req);                                           // 设置寻找的设备的范围和类型
        result = soap_send___wsdd__Probe(soap, SOAP_MCAST_ADDR, nullptr, &req);        // 向组播地址广播Probe消息
        while (SOAP_OK == result)                                                   // 开始循环接收设备发送过来的消息
        {
        
            memset(&rep, 0x00, sizeof(rep));
            result = soap_recv___wsdd__ProbeMatches(soap, &rep);
            if (SOAP_OK == result) {
        
                if (soap->error) {
        
                    soap_perror(soap, "ProbeMatches");
                } else {
                                                                    // 成功接收到设备的应答消息
                    printf("__sizeProbeMatch:%d\n",rep.wsdd__ProbeMatches->__sizeProbeMatch);
    
                    if (nullptr != rep.wsdd__ProbeMatches) {
        
                        count += rep.wsdd__ProbeMatches->__sizeProbeMatch;
                        for(i = 0; i < rep.wsdd__ProbeMatches->__sizeProbeMatch; i++) {
        
                            probeMatch = rep.wsdd__ProbeMatches->ProbeMatch + i;
                            if (nullptr != cb) {
        
                                cb(probeMatch->XAddrs);                             // 使用设备服务地址执行函数回调
                            }
                        }
                    }
                }
            } else if (soap->error) {
        
                break;
            }
        }
    
        SOAP_DBGLOG("\ndetect end! It has detected %d devices!\n", count);
    
        if (nullptr != soap) {
        
            ONVIF_soap_delete(soap);
        }
    
    }
    
    
    #define SOAP_CHECK_ERROR(result, soap, str) \
        do { \
            if (SOAP_OK != (result) || SOAP_OK != (soap)->error) { \
                soap_perror((soap), (str)); \
                if (SOAP_OK == (result)) { \
                    (result) = (soap)->error; \
                } \
                goto EXIT; \
            } \
    } while (0)
    /************************************************************************
    **函数：ONVIF_GetDeviceInformation
    **功能：获取设备基本信息
    **参数：
            [in] DeviceXAddr - 设备服务地址
    **返回：
            0表明成功，非0表明失败
    **备注：
    ************************************************************************/
    int ONVIF_GetDeviceInformation(const char *DeviceXAddr)
    {
        
        int result = 0;
        struct soap *soap = nullptr;
        _tds__GetDeviceInformation           devinfo_req;
        _tds__GetDeviceInformationResponse   devinfo_resp;
    
        SOAP_ASSERT(nullptr != DeviceXAddr);
        SOAP_ASSERT(nullptr != (soap = ONVIF_soap_new(SOAP_SOCK_TIMEOUT)));
    
    
        result = soap_call___tds__GetDeviceInformation(soap, DeviceXAddr, nullptr, &devinfo_req, devinfo_resp);
        SOAP_CHECK_ERROR(result, soap, "GetDeviceInformation");
    
    
        //dump_tds__GetDeviceInformationResponse(&devinfo_resp);
        printf("Manufacturer:%s\n",devinfo_resp.Manufacturer.c_str());
        printf("Model:%s\n",devinfo_resp.Model.c_str());
        printf("FirmwareVersion:%s\n",devinfo_resp.FirmwareVersion.c_str());
        printf("SerialNumber:%s\n",devinfo_resp.SerialNumber.c_str());
        printf("HardwareId:%s\n",devinfo_resp.HardwareId.c_str());
    
    
    
        EXIT:
    
        if (nullptr != soap) {
        
            ONVIF_soap_delete(soap);
        }
        return result;
    }
    
    void cb_discovery(char *DeviceXAddr)
    {
        
        ONVIF_GetDeviceInformation(DeviceXAddr);
    }
    
    int main(int argc, char **argv)
    {
        
        ONVIF_DetectDevice(cb_discovery);
        return 0;
    }

编译运行，发现

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 3]

错误： 401错误是表示没有权限

原因： 调用ONVIF接口，市面上有些IPC要求必须携带用户名、密码认证信息（如大华IPC），而有些IPC则不需要携带认证信息。

解决： 为了让测试顺利通过，可以先通过WEB浏览器登录后台，关闭鉴权，如下图所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 4]

成功的打印  
![在这里插入图片描述][20201027164741707.png_pic_center]

[大华摄像头怎么开启ONVIF][ONVIF]

[Ovif_Probe_discover]: https://blog.csdn.net/zhizhengguan/article/details/109288107
[https_www.onvif.org_onvif_ver10_device_wsdl_devicemgmt.wsdl]: https://www.onvif.org/onvif/ver10/device/wsdl/devicemgmt.wsdl
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/25af73a8ab654c7bb6b74ecee24f4666.png
[20201027154122959.png_pic_center]: https://img-blog.csdnimg.cn/20201027154122959.png#pic_center
[20201028092834383.png_pic_center]: https://img-blog.csdnimg.cn/20201028092834383.png#pic_center
[20201027154149714.png_pic_center]: https://img-blog.csdnimg.cn/20201027154149714.png#pic_center
[20201027154714774.png_pic_center]: https://img-blog.csdnimg.cn/20201027154714774.png#pic_center
[20201027154936330.png_pic_center]: https://img-blog.csdnimg.cn/20201027154936330.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20201027160108137.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg==,size_16,color_FFFFFF,t_70#pic_center
[20201027160327694.png_pic_center]: https://img-blog.csdnimg.cn/20201027160327694.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20201027160952826.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg==,size_16,color_FFFFFF,t_70#pic_center
[20201027161919769.png_pic_center]: https://img-blog.csdnimg.cn/20201027161919769.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20201027164007492.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg==,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg_size_16_color_FFFFFF_t_70_pic_center 4]: https://img-blog.csdnimg.cn/20201027164638535.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXpoZW5nZ3Vhbg==,size_16,color_FFFFFF,t_70#pic_center
[20201027164741707.png_pic_center]: https://img-blog.csdnimg.cn/20201027164741707.png#pic_center
[ONVIF]: https://www.jimay.com/support/731.html