16 Star 76 Fork 20

lilong/OpenVisa

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
LGPL-3.0

OpenVisa

[TOC]

简介

测试测量仪器通信库,包含TCP,Serial Port,USB,VXI11, HiSLIP等通信协议。 API文档:https://llongww.gitee.io/openvisa

由于gitee page服务已关闭,暂时无法提供在线帮助文档,请克隆仓库后,打开doc/index.html 查看离线API文档。

现在已发布基于OpenVisa的应用程序:OpenVisaApplication,可访问地址 https://gitee.com/llongww/OpenVisaApplication 获取。

一、编写本项目的目的

  1. 常用的NI-VISA是一个商业软件,并没有多少开源免费软件可以替代;
  2. 我只是想要简简单单地和设备通信而已,受够了每次安装我们的软件,都要携带几个G的通信库安装包。

二、开发计划

  • TCP socket Ascii通信
  • 串口 Ascii通信
  • USBTMC
  • VXI-11
  • HiSLIP
  • GPIB

由于个人精力原因,上述开发仅实现了基本通信功能,并未实现全功能VISA,如VISA的Event等功能,虽然未来计划是跨平台的,但目前部分功能仅实现了Windows端。

三、编译

本项目基于C++20标准编写,在VS2022下编译通过。

1. 第三方库

  • boost
  • libusb

我并没有太多时间来验证各版本的boost和libusb是否存在编译问题,我用的boost版本为 1.78.0,libusb库为1.0.25,如果使用其它版本的第三方库出现问题时,可以给我反馈。

2. 环境变量设置

  • 添加 BOOST_ROOT 变量,并设置值为 BOOST库根目录,比如:C:\local\boost_1_78_0
  • 添加 BOOST_LIBRARYDIR 变量,并设置值为 BOOST lib库所在目录,比如:%BOOST_ROOT%\lib64-msvc-14.3
  • 添加 BOOST_INCLUDEDIR 变量,并设置值为 BOOST 头文件目录,比如 %BOOST_ROOT%

3. CMake设置

如果libusb的目录与OpenVisa在同级目录中,一般来说下述变量将会自动查找

  • 设置 LIBUSB_INCLUDEDIR 为 libusb.h 头文件所在目录的上一级,比如 libusb.h 的所在目录为:F:\3rd\libusb\libusb\libusb.h,则将 LIBUSB_INCLUDEDIR 设为 F:/3rd/libusb

  • 设置LIBUSB_INCLUDEDIR 后一般情况下lib和dll的路径将会自动查找如果没有自动查找,则设置如下变量

  • 设置 LIBUSB_DEBUG_LIBRARY 为Debug模式下的 libusb-1.0.lib 文件所在的路径,如:F:/3rd/libusb/x64/Debug/dll/libusb-1.0.lib

  • 设置 LIBUSB_RELEASE_LIBRARY 为Release模式下的 libusb-1.0.lib 文件所在的路径,如:F:/3rd/libusb/x64/Release/dll/libusb-1.0.lib

  • 设置 LIBUSB_DEBUG_DLL 为Debug模式下的 libusb-1.0.dll 文件所在的路径,如:F:/3rd/libusb/x64/Debug/dll/libusb-1.0.dll

  • 设置 LIBUSB_RELEASE_DLL 为Release模式下的 libusb-1.0.dll 文件所在的路径,如:F:/3rd/libusb/x64/Release/dll/libusb-1.0.dll

如果编译时没有找到 libusb.h,请检查LIBUSB_INCLUDEDIR的设置是否正确,如果编译动态库时出现链接错误,请检查LIBUSB_LIBRARY

**注意:**如果修改了LIBUSB_USE_STATIC变量,请删除cmake缓存重新构建,否则可能产生错误。

四、使用

1. TCP Raw Socket

OpenVisa::Object visa;
visa.connect(OpenVisa::Address<OpenVisa::AddressType::RawSocket>("192.168.0.111", 9999));
// or visa.connect("TCPIP::192.168.0.111::9999::SOCKET");
visa.send("*IDN?");
std::cout << visa.readAll();

2. 串口

OpenVisa::Object visa;
auto& attr = visa.attribute();
attr.setBaudRate(115200);
attr.setDataBits(OpenVisa::DataBits::Data8);
attr.setFlowControl(OpenVisa::FlowControl::None);
attr.setParity(OpenVisa::Parity::None);
attr.setStopBits(OpenVisa::StopBits::One)
visa.connect(OpenVisa::Address<OpenVisa::AddressType::SerialPort>("COM3"));
// or visa.connect("ASRL3::INSTR");
visa.send("*IDN?");
std::cout << visa.readAll();

3. USB

OpenVisa::Object visa;
visa.connect(OpenVisa::Address<OpenVisa::AddressType::USB>(0x0a69, 0x0651, "0000000000001"));
// or visa.connect("USB::0x0A69::0x0651::0000000000001::INSTR");
visa.send("*IDN?");
std::cout << visa.readAll();

注意:如果安装过NI-VISA驱动库,我们无法访问NI-VISA的驱动,可以尝试安装这个驱动:https://pan.baidu.com/s/1onVU5vPZAHbREZ_zEVLA0A,提取码9dmy,或者使用Zadig将驱动程序替换为WinUSB。

4. VXI-11

OpenVisa::Object visa;
visa.connect(OpenVisa::Address<OpenVisa::AddressType::VXI11>("192.168.0.111", "inst0"));
// or visa.connect("TCPIP::192.168.0.111::INSTR");
visa.send("*IDN?");
std::cout << visa.readAll();

5. HiSLIP

OpenVisa::Object visa;
visa.connect(OpenVisa::Address<OpenVisa::AddressType::HiSLIP>("192.168.0.111", "hislip0"));
// or visa.connect("TCPIP::192.168.0.111::hislip0");
visa.send("*IDN?");
std::cout << visa.readAll();

6. 设备枚举

// 枚举所有串口设备
auto ports = OpenVisa::Object::listSerialPorts();
for(const auto& port : ports)
{
    std::cout << port << std::endl;
}
// 枚举所有USB设备
auto usbs = OpenVisa::Object::listUSB();
for(const auto& usb : usbs)
{
    std::cout << OpenVisa::Object::toVisaAddressString(usb) << std::endl;
}

7. 终结符(TermChars)

  • 与C语言Visa不同,C语言Visa仅支持单个字符的终结符,OpenVisa可以支持多个字符的终结符;

  • 目前OpenVisa没有将发送和接收的终结符分开,他们都由Object::Attribute::terminalChars决定;

  • 默认情况下OpenVisa的终结符为'\n',如果Object::send和Object::query方法发送的数据末尾不含终结符,OpenVisa将会为发送的数据自动添加终结符,该行为由Object::Attribute::autoAppendTerminalChars属性决定;

  • 默认情况下OpenVisa的Object::query和Object::readAll方法接收数据时,将会等待直到收到终结符为止,否则将超时,该行为由Object::Attribute::terminalCharsEnable属性决定。

7.1 如果需要与设备进行二进制通信时,可以关闭终结符,例如:

OpenVisa::Object visa;
auto& attr = visa.attribute();
attr.setAutoAppendTerminalChars(false);
attr.setTerminalCharsEnable(false);

7.2 如果设备的发送和接收的终结符不同,那么请将终结符属性设为接收时的终结符,并关闭发送时自动附加终结符属性,例如:

// 发送终结符为\n,接收终结符为#
OpenVisa::Object visa;
//... connect
auto& attr = visa.attribute();
attr.setAutoAppendTerminalChars(false);
attr.setTerminalChars("#");
//...
auto idn = visa.query("*IDN?\n");

五、参考

GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

About

测试测量仪器通信库,不依赖于NI-VISA等其他VISA库,已实现TCP,Serial Port,USB,VXI11,HiSLIP等通信协议。 expand collapse
C++ and 3 more languages
LGPL-3.0
Cancel

Releases (27)

All

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
C++
1
https://gitee.com/llongww/OpenVisa.git
git@gitee.com:llongww/OpenVisa.git
llongww
OpenVisa
OpenVisa
master

Search