demo-api

1 概述

demo_api 示例提供了使用数字字符选择执行功能来演示 Xvisio 设备和对应的 SDK API 的基本功能以及执行功能对应的示例代码。

2 构建和运行

2.1 Linux/Ubuntu

2.1.1 Cmake 构建

1. 首先需要在 Linux/Ubuntu 主机上安装 Xvisio SDK，可以参考 SDK 安装指南。
2. 启动终端并导航到 demo-api 安装路径 "/usr/share/xvsdk/demo-api" ，或者复制 "/usr/share/xvsdk/demo-api" 到工作目录后导航到“demo-api"目录。
   cp -r /usr/share/xvsdk/demo-api <path_to_work>
cp -r /usr/share/xvsdk/pipe_srv <path_to_work>
cd <path_to_work>/demo-api
3. Cmake生成 Makefile
   mkdir build
cd build
cmake ..
4. 构建
   make
   构建成功会生成名称叫‘demo-api’的可执行二进制程序。

2.1.2 运行

1. 使用 USB 线连接 xvisio 设备和 Ubunut 主机。

2. 查看 USB 设备状态，在任意位置打开终端输入：
   lsusb
   观察终端输出usb状态信息，其中 VID:PID 为"040e:f408" ,设备名为"MCCI XVisio vSLAM" 的USB 设备即为 Xvisio 设备。
   通过 Xvisio 设备的 USB Bus 号和对应的总线的 hub 类型来确认当前设备枚举是 USB3.0 或USB2.0 。
   请确保 Xvisio 设备的正确枚举
   以上描述见下图：
   

3. 启动终端并导航到 <path_to_work>/demo-api/build 目录
   ./demo-api
   执行这一步前需要确保程序已成功构建并生成了‘demo-api’的可执行二进制程序。

4. 在相同位置打开另一个终端输入程序名称并回车:
   ./pipe_srv
   pipe_srv 和 demo-api 必须在同一目录下打开。
   打开成功后，终端会输出功能菜单打印，如下：
   pipe server recv has already exist
pipe server send has already exist
wait for client connect....
pipe server get send handle: 3
pipe server get recv handle: 4
ready handle: send:3,recv:4


Demo
------------------------------
1 : Init SDK and get IMU
2 : Stop get IMU, start slam, get 6dof
....
0 : exit program
------------------------------
enter select:

5. 执行菜单功能
   pipe-srv的终端上输入对应数字字符后回车 ，执行相应功能，并观察demo-api终端输出结果。
   功能菜单描述

2.2 Windows10/11

2.2.1 构建

1. 首先需要在 Windows 主机上安装 Xvisio SDK，可以参考 SDK 安装指南。
2. 安装 SDK 成功后，进入安装目录里的 demo-api 示例目录,例如:C:\Program Files\xvsdk\samples\demo-api 。
3. visual studio 编译

• 需要预装visual studio，目前支持2017和2019两个版本,点击进入官网2019版本下载页面
• 需要预装cmake,点击下载后安装。

4. cmake 生成 sln 文件

• 启动 windows powershell 工具并导航到安装目录下 demo-api 目录。
• 根据当前的 visual studio 版本执行对应的生成工程命令:

  版本	cmake 命令
  VS2019 64位	cmake -G "Visual Studio 16 2019" -A x64
  VS2019 32位	cmake -G "Visual Studio 16 2019" -A Win32
  VS2017 64位	cmake -G "Visual Studio 15 2017" -A x64
  VS2017 32位	cmake -G "Visual Studio 15 2017" -A Win32

• dmeo-api 目录里会生成 demo-api.sln 文件
• 使用 visual studio 打开 demo-api.sln
• 构建(生成) 解决方案中 demo-api 项目，构建成功会在对应目录中生成 demo-api.exe 。

2.2.2 运行

1. 使用 USB 线连接 xvisio 设备和 Windows 主机。
2. 使用 USB 连接 Xvisio 设备到 PC，如果 Xvisio 设备连接正常，那么通常会有3个设备枚举，可以通过系统的设备管理器查看设备状态：
   
   请检查"VSC interface"设备状态、照相机设备"XVisio vSLAM"状态、"USB Composite Device"状态。如果状态异常请检查 USB线、Xvisio设备固件是否正常以及 Windows 主机 USB 状态是否满足要求，或者请联系 Xvisio FAE 人员寻求支持。
3. 启动 windows powershell 工具并导航到安装目录下 bin 目录，输入程序名称并回车:
   ./demo-api.exe
   
4. 打开成功后，powershell 窗口会输出功能菜单打印.
5. 执行菜单功能
   powershell 窗口上输入对应数字字符后回车 ，执行相应功能，并观察 powershell 窗口输出运行结果。
   功能菜单描述

2.3 Android

注意：

1. demo-api 工具只能在安装了 root 版本 SDK 的 android 设备运行。所以本节的介绍只对 root 版本的 SDK 介绍。
2. 本文选择 linux 平台为编译平台为例来介绍。

2.3.1 构建

1. 安装NDK

• 下载
  可以从此链接NDK下载,推荐选择r21e版本，请选择适合您的 linux 或 windows 开发平台的 NDK 软件包并下载。本文选择 linux 平台为例介绍。
• 解压
  unzip android-ndk-r21e-linux-x86_64.zip
• 设置环境变量
  sudo gedit ~/.bashrc
  在文件末尾添加
  export ANDROID_NDK_ROOT=/path_from_yours/android-ndk-r21e/
export NDK=${ANDROID_NDK_ROOT}
export PATH=${PATH}:$NDK
  其中“/path_from_yours/android-ndk-r21e/”替换成 NDK 解压的绝对路径。
  sourc ~/.bashrc
• 检查设置
  ndk-build -v
  版本信息正确，无报错。

2. 下载 SDK

• 获取最新安装包:,请选择下载目录下压缩包:xvsdk_3.2.x-xxxxxxxx_android.zip 。
• 解压xvsdk_3.2.x-xxxxxxxx_android.zip，并进入解压后文件夹。

3. 编译
   cd android/jni/
ndk-build
   会编译出 “Android.mk” 里所有 link 的example 程序。
   编译成功无报错，android/libs/目录下的arm64-v8a会生成可编译好的可执行程序。

2.3.2 运行

1. 首先需要在 android 主机上安装 Xvisio SDK，可以参考 SDK 安装指南中的 "Android SDK(root 版本)的安装介绍"。
2. ADB 连接 android 设备到主机，确保adb环境正常,确保 Android 设备具备 remount 权限,确保 push 目录的存在性，这里的示例目录为 "/data/test/" 。
3. push sdk
   启动终端并导航到sdk解压文件夹内的 android/libs/ 目录，执行:
   adb root
adb remount
   如果 remount 失败，可以执行:
   adb disable-verity
adb reboot
adb root
adb remount
   如果仍然失败请联系 Android 设备供应商寻求支持
   arm64位示例:
   adb push arm64-v8a /data/test/
   arm32位示例:
   adb push armeavi-v7a /data/test/
4. 运行demo-api程序：

• 启动终端并执行：
  adb shell
cd /data/test/arm64-v8a/
LD_LIBRARY_PATH=./ ./demo-api
• 启动另一个终端,运行pipe_srv：
  adb shell
cd /data/test/arm64-v8a/
LD_LIBRARY_PATH=./ ./pipe_srv
• pipe_srv 和 demo-api 必须在同一目录下启动。
  启动成功后，终端会输出功能菜单打印，如下：
  pipe server recv has already exist
pipe server send has already exist
wait for client connect....
pipe server get send handle: 3
pipe server get recv handle: 4
ready handle: send:3,recv:4


Demo
------------------------------
1 : Init SDK and get IMU
2 : Stop get IMU, start slam, get 6dof
....
0 : exit program
------------------------------
enter select:

5. 执行菜单功能
   pipe-srv的终端上输入对应数字字符后回车 ，执行相应功能，并观察demo-api终端输出结果。
   功能菜单描述

3 代码介绍

3.1 目录

3.2 文件

3.3 代码解析和介绍

demo-api.cpp 文件 main(....) 函数为入口函数：

int main( int argc, char* argv[] ) try{....}

meun_main[]数组为预设定的功能菜单：

static const char meun_main[] = { ....}

while 循环来等待输入字符命令解析 ,

while (cond) {

Windows平台不使用管道，通过输入字符 'm' 来停止已运行的功能，并输出菜单

#ifdef _WIN32
std::cin >> cCmd;
if (cCmd == "m")
{
if (device)
{
//stop all running items
if (device->display())
{
device->display()->close();
}
if (device->orientationStream())
{
//device->orientationStream()->stop();
device->orientationStream()->unregisterCallback(imuId);
} ....

非 Windows 平台等待管道命令:

#else
cmd = requestCmdAllPlatform(meun_main, sizeof(meun_main));
#endif

解析命令:

switch (cmd) {
case 1:
{
....
}
break;
case 3:
case 22:
case 28:
case 36:
....

每个 case 里执行对应序列号的菜单功能，菜单功能描述见第 4 节.

4 功能菜单描述

功能菜单描述：

←  C/C++
←  Xvisio SDK 文档主页