diff --git a/开始贡献/openKylin+SDK开发指南V2.0.md b/开始贡献/openKylin+SDK开发指南V2.0.md index bfd3cedf..c65b491d 100644 --- a/开始贡献/openKylin+SDK开发指南V2.0.md +++ b/开始贡献/openKylin+SDK开发指南V2.0.md @@ -843,333 +843,144 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev |--------------------|----------------|------------------------------------------------------------------------------------------------------------|------------| | 获取资源信息 | C | extern int kdk_rti_get_uptime(unsigned int *day, unsigned int *hour, unsigned int *min, unsigned int *sec) | 获取操作系统开机时长 | | | | 参数说明 | 返回值说明 | | -| | | day：开机天数
hour小时数，该数值一定 < 24
min：分钟数，该数值一定 < 60
sec：秒数，该数值一定 < 60
int 返回0表示成功，返回非零表示失败 | +| | | day：开机天数
hour小时数，该数值一定 < 24
min：分钟数，该数值一定 < 60
sec：秒数，该数值一定 < 60 | int 返回0表示成功，返回非零表示失败 | 获取指定进程的 CPU 使用率 -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 资 | C | extern float | 获 取 指 定 进 程 | | -| | | | | | -| > 源信息 | | k | > 的 CPU 使用率 | | -| | | dk_get_process_cpu | | | -| | | _usage_percent(int | | | -| | | | | | -| | | proc_num) | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | proc_num ： 进 程 | > float CPU 使用率 | | -| | | | | | -| | | > 号 | | | -+----------+------------+--------------------+--------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|--------------------------------------------------------------|---------------| +| 获取资源信息 | C | extern float kdk_get_process_cpu_usage_percent(int proc_num) | 获取指定进程的CPU使用率 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | float CPU使用率 | + 获取指定进程的内存占用率 -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 资 | C | extern float | > 获取指定进程 | | -| | | | > 的内存占用率 | | -| > 源信息 | | k | | | -| | | dk_get_process_mem | | | -| | | _usage_percent(int | | | -| | | | | | -| | | proc_num) | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | proc_num ： 进 程 | > float 内存占用率 | | -| | | | | | -| | | > 号 | | | -+----------+------------+--------------------+--------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|--------------------------------------------------------------|--------------| +| 获取资源信息 | C | extern float kdk_get_process_mem_usage_percent(int proc_num) | 获取指定进程的内存占用率 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | float 内存占用率 | + 获取指定进程的进程状态 -``` -+----------+------------+--------------------+-------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+===================+===+ -| 获 取 资 | C | extern char\* | 获取指定进程 | | -| | | kdk_get_ | | | -| > 源信息 | | process_status(int | 的进程状态 | | -| | | | | | -| | | proc_num) | | | -+----------+------------+--------------------+-------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+-------------------+---+ -| | | proc_num ： 进 程 | > char\* 进程状态 | | -| | | | | | -| | | > 号 | | | -+----------+------------+--------------------+-------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|---------------------------------------------------|-------------| +| 获取资源信息 | C | extern char* kdk_get_process_status(int proc_num) | 获取指定进程的进程状态 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | char* 进程状态 | + 获取指定进程的端口号占用 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|-----------------------------------------------|--------------| +| 获取资源信息 | C | extern int kdk_get_process_port(int proc_num) | 获取指定进程的端口号占用 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | char* 使用的端口号 | -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 资 | C | extern int | > 获取指定进程 | | -| | | kdk_ge | > 的端口号占用 | | -| > 源信息 | | t_process_port(int | | | -| | | proc_num) | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ - -+---+---+-------------------+-----------------------+---+ -| | | proc_num ： 进 程 | > char\* 使用的端口号 | | -| | | | | | -| | | > 号 | | | -+---+---+-------------------+-----------------------+---+ -``` 获取指定进程的启动时间 - -``` -+----------+------------+--------------------+-------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+===================+===+ -| 获 取 资 | C | extern char\* | 获取指定进程 | | -| | | kdk_get_proc | | | -| > 源信息 | | ess_start_time(int | 的启动时间 | | -| | | | | | -| | | proc_num) | | | -+----------+------------+--------------------+-------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+-------------------+---+ -| | | proc_num ： 进 程 | > char\* 启动时间 | | -| | | | | | -| | | > 号 | | | -+----------+------------+--------------------+-------------------+---+ -``` - +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|-------------------------------------------------------|-------------| +| 获取资源信息 | C | extern char* kdk_get_process_start_time(int proc_num) | 获取指定进程的启动时间 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | char* 启动时间 | 获取指定进程的运行时间 -``` -+----------+------------+--------------------+-------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+===================+===+ -| 获 取 资 | C | extern char\* | 获取指定进程 | | -| | | kdk_get_proc | | | -| > 源信息 | | ess_start_time(int | 的启动时间 | | -| | | | | | -| | | proc_num) | | | -+----------+------------+--------------------+-------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+-------------------+---+ -| | | proc_num ： 进 程 | > char\* 启动时间 | | -| | | | | | -| | | > 号 | | | -+----------+------------+--------------------+-------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|-------------------------------------------------------|-------------| +| 获取资源信息 | C | extern char* kdk_get_process_start_time(int proc_num) | 获取指定进程的启动时间 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | char* 启动时间 | + 获取指定进程的 cpu 时间 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|-----------------------------------------------------|--------------| +| 获取资源信息 | C | extern char* kdk_get_process_cpu_time(int proc_num) | 获取指定进程的cpu时间 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | char* cpu时间 | -``` -+----------+------------+--------------------------------------------+--------------+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | -+==========+============+============================================+==============+ -| 获 取 资 | C | extern char\* kdk_get_process_cpu_time(int | 获取指定进程 | -| | | | | -| > 源信息 | | proc_num) | 的 cpu 时间 | -+----------+------------+--------------------------------------------+--------------+ - -+---+---+-------------------+-------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+===+===+===================+===================+===+ -| | | proc_num ： 进 程 | > char\* cpu 时间 | | -| | | | | | -| | | > 号 | | | -+---+---+-------------------+-------------------+---+ -``` 获取指定进程的 Command -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 资 | C | extern char\* | > 获取指定进程 的 | | -| | | kdk_get_p | > Command | | -| > 源信息 | | rocess_command(int | | | -| | | | | | -| | | proc_num) | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | proc_num ： 进 程 | > char\* Command | | -| | | | | | -| | | > 号 | | | -+----------+------------+--------------------+--------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取资源信息 | C | extern char* kdk_get_process_command(int proc_num) | 获取指定进程的Command | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | char* Command | + 获取指定进程的属主 -``` -+----------+------------+----------------------------------------+---------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+========================================+===============+===+ -| 获 取 资 | C | extern char\* kdk_get_process_user(int | 获取指定进程 | | -| | | | | | -| > 源信息 | | proc_num) | 的属主 | | -+----------+------------+----------------------------------------+---------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+----------------------------------------+---------------+---+ -| | | proc_num ： 进 程 | > char\* 属主 | | -| | | | | | -| | | > 号 | | | -+----------+------------+----------------------------------------+---------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|---------------|------|--------------------------------------------------------------------------|-------------------------------------------------------------------------| +| 获取资源信息 | C | extern char* kdk_get_process_user(int proc_num) | 获取指定进程的属主 | +| | | 参数说明 | 返回值说明 | | +| | | proc_num：进程号 | char* 属主 | | + 获取指定进程的CPU使用率 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取资源信息 | C | extern float kdk_procname_get_process_cpu_usage_percent(char *proc_name) | 获取指定进程的CPU使用率 | +| | | 参数说明 | 返回值说明 | | +| | | proc_name 进程名 | float CPU使用率 | | + 获取指定进程的信息 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取资源信息 | C | extern char** kdk_procname_get_process_infomation(char *proc_name) | 获取指定进程的信息 | +| | | 参数说明 | 返回值说明 | | +| | | proc_name 进程名 | char** 进程的信息列表，以NULL表示结尾，由alloc生成，需要被kdk_proc_freeall回收；若获取出错，返回NULL； | | + 获取进程所有信息 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取资源信息 | C | char** kdk_get_process_all_information() | 获取进程所有信息 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char** 进程所有信息列表，，以NULL表示结尾，由alloc生成，需要被kdk_proc_freeall回收；若获取出错，返回NULL； | | + 回收字符串列表 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取资源信息 | C | extern inline void kdk_proc_freeall(char **ptr) | 回收字符串列表 | +| | | 参数说明 | 返回值说明 | | +| | | ptr：字符串列表 | 无 | - 获取指定进程的 CPU 使用率 - - -``` -+----------+------------+------+--------+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | -+----------+------------+------+--------+ - -+----------+---+------------------------+------------------------+---+ -| 获 取 资 | C | extern float | > 获取指定进程 的 CPU | | -| | | | > 使用率 | | -| > 源信息 | | kdk_procname_get_pr | | | -| | | ocess_cpu_usage_percen | | | -| | | | | | -| | | t(char \*proc_name) | | | -+==========+===+========================+========================+===+ -| | | > 参数说明 | > 返回值说明 | | -+----------+---+------------------------+------------------------+---+ -| | | proc_name 进 程 | > float CPU 使用率 | | -| | | | | | -| | | > 名 | | | -+----------+---+------------------------+------------------------+---+ -``` - - - 获取指定进程的信息 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 资 | C | extern char\*\* | 获取指定进程 | | -| | | | | | -| > 源信息 | | kdk_ | 的信息 | | -| | | procname_get_proce | | | -| | | ss_infomation(char | | | -| | | | | | -| | | \*proc_name) | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | proc_name 进 程 | char\*\* 进 程 的 | | -| | | | 信 息 列 | | -| | | > 名 | | | -| | | | 表 ， 以 NULL 表 | | -| | | | 示 结 | | -| | | | | | -| | | | 尾，由 alloc | | -| | | | 生成，需要 | | -| | | | | | -| | | | > 被 | | -| | | | > kdk_proc_freeall | | -| | | | > 回 | | -| | | | | | -| | | | 收 | | -| | | | ；若获取出错，返回 | | -| | | | | | -| | | | > NULL； | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 获取进程所有信息 - -``` - -+----------+------------+--------------------------------------------+--------------+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | -+==========+============+============================================+==============+ -| 获 取 资 | C | char\*\* kdk_get_process_all_information() | 获取进程所有 | -| | | | | -| | | | 信息 | -+----------+------------+--------------------------------------------+--------------+ - -+----------+---+------------+--------------------------+---+ -| > 源信息 | | > 参数说明 | > 返回值说明 | | -+==========+===+============+==========================+===+ -| | | > 无 | char\*\* 进程所有信息列 | | -| | | | | | -| | | | 表，，以 NULL 表示结 | | -| | | | | | -| | | | 尾，由 alloc 生成，需要 | | -| | | | | | -| | | | > 被 kdk_proc_freeall 回 | | -| | | | | | -| | | | 收；若获取出错，返回 | | -| | | | | | -| | | | > NULL； | | -+----------+---+------------+--------------------------+---+ - -``` - - 回收字符串列表 - - -``` -+----------+------------+--------------------+------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+==================+===+ -| 获 取 资 | C | extern inline void | 回 收 字符 串 列 | | -| | | kdk | | | -| > 源信息 | | _proc_freeall(char | > 表 | | -| | | \*\*ptr) | | | -+----------+------------+--------------------+------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+------------------+---+ -| | | > ptr：字符串列表 | > 无 | | -+----------+------------+--------------------+------------------+---+ -``` - ### **3.1.5** 获取操作系统基础信息 封装 C 接口获取系统名称、版本号、激活信息等。 + +``` +-----------------------------------------------------------------+ | > \$ sudo apt-get install libkysdk-sysinfo libkysdk-sysinfo-dev | +-----------------------------------------------------------------+ +``` + （1）CMakeLists.txt 构建项目 - aux_source_directory(. SOURCESCODE) + +``` +aux_source_directory(. SOURCESCODE) include_directories(.) @@ -1188,6 +999,8 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev \${GLIBC_LIB} \${DBUS_LIB} \${DBUS_GLIB_LIB}) target_link_libraries(kysysinfo-test kysysinfo) +``` + （2）获取操作系统信息，需要添加头文件： @@ -1195,380 +1008,97 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev 获取操作系统架构信息 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------------------------------------------------------|----------------------------------------------------------------------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_architecture() | 获取系统架构信息 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* 系统架构，例：x86_64 | | -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern char\* | 获取系统架构信 | | -| | | kdk_system_ | | | -| 统 基 础 | | get_architecture() | > 息 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | char\* 系 统 架 构 | | -| | | | ， 例 ： | | -| | | | | | -| | | | > x86_64 | | -+----------+------------+--------------------+--------------------+---+ -``` + 获取操作系统名称 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_systemName() | 获取操作系统名称 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* 系统名称，例：Kylin | | + + 获取操作系统版本号 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_version(bool verbose) | 获取系统版本号 | +| | | 参数说明 | 返回值说明 | | +| | | verbose：0获取简略版本号，1获取详细版本号 | char* 系统版本号，例：系统简略版本：xxxx桌面操作系统；系统详细版本：Desktop-V10-Professional-Release-Build1-210203 | + + 获取内核版本号 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_kernelVersion() | 获取内核版本号 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* | 内核版本号 | | + + 获取当前登录用户的用户名 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_eUser() | 获取当前登录用户的用户名（Effect User） | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* 成功返回字符串，失败返回NULL。返回的字符串需要被 free 释放 | | + + 获取操作系统项目编号名 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_projectName() | 获取操作系统项目编号名 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* 成功返回字符串，失败返回NULL。返回的字符串需要被 free 释放 | | + + 获取操作系统项目子编号名 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_projectSubName() | 获取操作系统项目子编号名 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* 成功返回字符串，失败返回NULL。返回的字符串需要被 free 释放 | | + + 获取操作系统产品标识码 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern unsigned int kdk_system_get_productFeatures() | 获取操作系统产品标识码 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | unsigned int 返回标志码
0000：信息异常
0001：仅PC特性
0010：仅平板特性
0011：支持平板与PC特性 | + + 获取操作系统宿主机的虚拟机类型 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_hostVirtType() | 获取操作系统宿主机的虚拟机类型 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* 获取失败返回NULL，获取成功返回一个字符串，字符串内容如下：
[none, qemu, kvm, zvm, vmware,hyper-v, orcale virtualbox, xen, bochs, uml,parallels,bhyve,qnx,arcn,openvz,lxc,lxc-libvirt,systemd-nspawn,docker,podman,rkt,wsl] | + + 获取操作系统宿主机的云平台类型 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char* kdk_system_get_hostCloudPlatform() | 获取操作系统宿主机的云平台类型 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char* 获取失败返回NULL，获取成功返回一个字符串，字符串内容如下：
[none, huawei] | + + 判断当前操作系统是否为专用机系统 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern bool kdk_system_is_zyj(void) | 判断当前镜像系统否为专用机系统 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | bool
true代表是
false代表不是 | + + 获取系统分辨率信息 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern char** kdk_system_get_resolving_power() | 获取系统分辨率信息 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char** 分辨率信息列表，以NULL表示结尾，由alloc生成，需要被kdk_resolving_freeall回收；若获取出错，返回NULL； | | + + 回收字符串列表 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern inline void kdk_resolving_freeal(char **ptr) | 回收字符串列表 | +| | | 参数说明 | 返回值说明 | | +| | | ptr：字符串列表 | 无 | - 获取操作系统名称 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern char\* | 获取操作系统名 | | -| | | kdk_syste | | | -| 统 基 础 | | m_get_systemName() | > 称 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | char\* 系 统 名 称 | | -| | | | ， 例 ： | | -| | | | | | -| | | | > Kylin | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 获取操作系统版本号 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern char\* | 获取系统版本 | | -| | | kdk_syste | | | -| 统 基 础 | | m_get_version(bool | > 号 | | -| | | | | | -| > 信息 | | verbose) | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | verbose：0 获取 | > char\* 系 统 版 | | -| | | | > 本 号 ， | | -| | | 简略版本号，1 | | | -| | | | 例： | | -| | | 获取详细版本号 | 系统简略版本：xxxx | | -| | | | | | -| | | | 桌面 | | -| | | | 操作系统；系统详细 | | -| | | | | | -| | | | > 版 本 ： | | -| | | | > Desktop-V10- | | -| | | | > | | -| | | | > Professional- | | -| | | | > | | -| | | | > Release-Build1- | | -| | | | > | | -| | | | > 210203 | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 获取内核版本号 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern char\* | 获取内核版本 | | -| | | kdk_system_g | | | -| 统 基 础 | | et_kernelVersion() | > 号 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | > char\* | | -| | | | > 内核版本号 | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 获取当前登录用户的用户名 - - -``` -+----------+------------+--------------------------------------+--------------+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | -+==========+============+======================================+==============+ -| 获 取 系 | C | extern char\* kdk_system_get_eUser() | 获取当前登录 | -+----------+------------+--------------------------------------+--------------+ - -+----------+---+------------+-----------------------+---+ -| 统 基 础 | | | 用户的用户名 | | -| | | | | | -| > 信息 | | | > （ Effect | | -| | | | > | | -| | | | > User） | | -+==========+===+============+=======================+===+ -| | | > 参数说明 | > 返回值说明 | | -+----------+---+------------+-----------------------+---+ -| | | > 无 | char\* 成功 返回字 符 | | -| | | | | | -| | | | 串 ， 失 败 返 回 | | -| | | | | | -| | | | NULL 。 返回 的 字符 | | -| | | | | | -| | | | > 串需要被 free 释放 | | -+----------+---+------------+-----------------------+---+ -``` - - - 获取操作系统项目编号名 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern char\* | 获取操作系统 | | -| | | kdk_system | | | -| 统 基 础 | | _get_projectName() | > 项目编号名 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | char\* 成功 返回字 | | -| | | | 符 | | -| | | | | | -| | | | 串 ， 失 败 返 回 | | -| | | | | | -| | | | NULL 。 返回 的 | | -| | | | 字符 | | -| | | | | | -| | | | > 串需要被 free | | -| | | | > 释放 | | -+----------+------------+--------------------+--------------------+---+ - -``` - - 获取操作系统项目子编号名 - - -``` -+----------+------------+--------------------+--------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+==============+===+ -| 获 取 系 | C | extern char\* | 获取操作系统 | | -| | | kdk_system_ge | | | -| 统 基 础 | | t_projectSubName() | 项目子编号名 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------+---+ - -+---+---+------+-----------------------+---+ -| | | > 无 | char\* 成功 返回字 符 | | -| | | | | | -| | | | 串 ， 失 败 返 回 | | -| | | | | | -| | | | NULL 。 返回 的 字符 | | -| | | | | | -| | | | > 串需要被 free 释放 | | -+---+---+------+-----------------------+---+ -``` - -> 获取操作系统产品标识码 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern unsigned | 获取操作系统 | | -| | | int | | | -| 统 基 础 | | | > 产品标识码 | | -| | | kdk_system_get | | | -| > 信息 | | _productFeatures() | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | unsigned int | | -| | | | 返回标志 | | -| | | | | | -| | | | > 码 | | -| | | | > | | -| | | | > 0000：信息异常 | | -| | | | > | | -| | | | > 0001：仅 PC 特性 | | -| | | | > | | -| | | | > 0010：仅平板特性 | | -| | | | | | -| | | | 0011 ： 支 持 平 | | -| | | | 板 与 | | -| | | | | | -| | | | > PC 特性 | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 获取操作系统宿主机的虚拟机类型 - - -``` -+----------+------------+--------------------+--------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+==============+===+ -| 获 取 系 | C | extern char\* | 获取操作系统 | | -| | | kdk_system_ | | | -| 统 基 础 | | get_hostVirtType() | 宿主机的虚拟 | | -| | | | | | -| > 信息 | | | > 机类型 | | -+----------+------------+--------------------+--------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------+---+ - -+---+---+------+--------------------------+---+ -| | | > 无 | char\* 获取 失败返 回 | | -| | | | | | -| | | | NULL ， 获取 成 功返 | | -| | | | | | -| | | | 回一个字符串，字符 | | -| | | | | | -| | | | > 串内容如下： | | -| | | | | | -| | | | \[none, qemu, kvm, zvm, | | -| | | | | | -| | | | vmware,hyper-v, orcale | | -| | | | | | -| | | | virtualbox, xen, bochs, | | -| | | | | | -| | | | > uml,parallels,bhyve,qn | | -| | | | > | | -| | | | > x,arcn,openvz,lxc,lxc- | | -| | | | > | | -| | | | > libvirt,systemd- | | -| | | | | | -| | | | nspawn,docker,podman | | -| | | | | | -| | | | > ,rkt,wsl\] | | -+---+---+------+--------------------------+---+ -``` - - - 获取操作系统宿主机的云平台类型 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern char\* | 获取操作系统 | | -| | | | | | -| 统 基 础 | | kdk_system_get_h | 宿主机的云平 | | -| | | ostCloudPlatform() | | | -| > 信息 | | | > 台类型 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | char\* | | -| | | | 获取失败返回 | | -| | | | | | -| | | | NULL ， 获取 成 | | -| | | | 功返 | | -| | | | | | -| | | | 回一个字符串，字符 | | -| | | | | | -| | | | > 串内容如下： | | -| | | | > | | -| | | | > \[none, huawei\] | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 判断当前操作系统是否为专用机系统 - - -``` - +----------+------------+-------------------------------------+------------------+---+ - | > 子模块 | > 编程语言 | 声明 | > 描述 | | - +==========+============+=====================================+==================+===+ - | 获 取 系 | C | extern bool kdk_system_is_zyj(void) | 判断当前镜像 | | - | | | | | | - | 统 基 础 | | | 系统否为专用 | | - | | | | | | - | > 信息 | | | > 机系统 | | - +----------+------------+-------------------------------------+------------------+---+ - | | | > 参数说明 | > 返回值说明 | | - +----------+------------+-------------------------------------+------------------+---+ - | | | > 无 | > bool | | - | | | | > | | - | | | | > true 代表是 | | - | | | | > | | - | | | | > false 代表不是 | | - +----------+------------+-------------------------------------+------------------+---+ -``` - - - 获取系统分辨率信息 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern char\*\* | 获取系统分辨 | | -| | | kdk_system_get | | | -| 统 基 础 | | _resolving_power() | > 率信息 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | char\*\* | | -| | | | 分辨率信息列 | | -| | | | | | -| | | | 表，以 NULL 表示结 | | -| | | | | | -| | | | 尾 ， 由 alloc 生 | | -| | | | 成 ， | | -| | | | | | -| | | | > 需 要 被 | | -| | | | > | | -| | | | > kdk | | -| | | | _resolving_freeall | | -| | | | | | -| | | | 回收；若获取出错， | | -| | | | | | -| | | | > 返回 NULL； | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 回收字符串列表 - - -``` -+----------+------------+------+--------+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | -+----------+------------+------+--------+ - -+----------+---+----------------------------------------------+------------------+---+ -| 获 取 系 | C | extern inline void kdk_resolving_freeal(char | 回 收 字符 串 列 | | -| | | | | | -| 统 基 础 | | \*\*ptr) | > 表 | | -| | | | | | -| > 信息 | | | | | -+==========+===+==============================================+==================+===+ -| | | > 参数说明 | > 返回值说明 | | -+----------+---+----------------------------------------------+------------------+---+ -| | | > ptr：字符串列表 | > 无 | | -+----------+---+----------------------------------------------+------------------+---+ -``` ### **3.1.6** 获取网络信息 @@ -1576,160 +1106,55 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev 获取网络连接状态 -``` -+----------+-------------+-----------------+-----------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+=============+=================+=================+===+ -| 获 取 系 | > dbus 接口 | > bus: system | 获取网络连接 | | -| | | > bus | | | -| 统 基 础 | | > | > 状态。 | | -| | | > name : | | | -| > 信息 | | > | | | -| | | org.freedesktop | | | -| | | .NetworkManager | | | -| | | > | | | -| | | > path: | | | -| | | > | | | -| | | org.freedesktop | | | -| | | .NetworkManager | | | -| | | > | | | -| | | > method: | | | -| | | > state()-\>int | | | -| | | > arg0; | | | -+----------+-------------+-----------------+-----------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+-------------+-----------------+-----------------+---+ -| | | > 无 | > int | | -| | | | > 网络连接状态 | | -+----------+-------------+-----------------+-----------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------------------------------------------------------|------------------------------------| +| 获取系统基础信息 | dbus接口 | bus: system bus | +| name : org.freedesktop.NetworkManager | +| path: org.freedesktop.NetworkManager | +| method: state()->int arg0; | 获取网络连接状态。 | +| | +| | | 参数说明 | 返回值说明 | | +| | | 无 | int 网络连接状态 | | +| | +获取网络端口状态 +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern int kdk_net_get_port_stat(int port); | 获取端口状态 | +| | | 参数说明 | 返回值说明 | | +| | | port 端口号 | int 端口状态 | +| FREE：0 | +| TCP_ESTABLISHED:1 TCP_SYN_SENT:2 TCP_SYN_RECV:3 TCP_FIN_WAIT1:4 TCP_FIN_WAIT2:5 TCP_TIME_WAIT:6 TCP_CLOSE:7 TCP_CLOSE_WAIT:8 TCP_LAST_ACL:9 TCP_LISTEN:10 TCP_CLOSING:11 | | +| | +| | +| | - 获取网络端口状态 + 获取多个网络端口状态 | +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | int kdk_net_get_multiple_port_stat(int start, int end, int *result) | 获取[start,end]的端口状态 | +| | | 参数说明 | 返回值说明 | | +| | | start 开始端口号 | +| end 结束端口号 | +| result 具有足够空间的int数组。接受端口状态 | 成功返回0 | +| 失败返回 端口状态 | | +| | + 获取默认网关 | +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern prouteMapList kdk_net_get_route(); | 获取默认网关 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | prouteMapList 网管信息，具体信息自取，失败返回NULL | | +| | -``` -+----------+------------+----------------------------+--------------+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | -+==========+============+============================+==============+ -| 获 取 系 | C | extern int | 获取端口状态 | -| | | kdk_net_get_port_stat(int | | -| | | port); | | -+----------+------------+----------------------------+--------------+ + 获取防火墙状态 | +| 子模块 | 编程语言 | 声明 | 描述 | +|--------|------|----------------------------------------------------|----------------| +| 获取系统基础信息 | C | extern pChain kdk_net_get_iptable_rules() | 获取防火墙信息 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | pChain 防火墙信息，具体信息自取，失败返回NULL | -+----------+---+---------------+--------------------+---+ -| 统 基 础 | | > 参数说明 | > 返回值说明 | | -| | | | | | -| > 信息 | | | | | -+==========+===+===============+====================+===+ -| | | > port 端口号 | > int 端口状态 | | -| | | | > | | -| | | | > FREE：0 | | -| | | | | | -| | | | TCP_ESTABLISHED:1 | | -| | | | | | -| | | | > TCP_SYN_SENT:2 | | -| | | | > | | -| | | | > TCP_SYN_RECV:3 | | -| | | | > | | -| | | | > TCP_FIN_WAIT1:4 | | -| | | | > | | -| | | | > TCP_FIN_WAIT2:5 | | -| | | | > | | -| | | | > TCP_TIME_WAIT:6 | | -| | | | > | | -| | | | > TCP_CLOSE:7 | | -| | | | > | | -| | | | > TCP_CLOSE_WAIT:8 | | -| | | | > | | -| | | | > TCP_LAST_ACL:9 | | -| | | | > | | -| | | | > TCP_LISTEN:10 | | -| | | | > | | -| | | | > TCP_CLOSING:11 | | -+----------+---+---------------+--------------------+---+ -``` - - - 获取多个网络端口状态 - - -``` -+----------+------------+--------------------+-------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+===================+===+ -| 获 取 系 | C | int | 获取\[start,end\] | | -| | | kdk_net_get_mult | | | -| 统 基 础 | | iple_port_stat(int | > 的端口状态 | | -| | | start, int | | | -| > 信息 | | | | | -| | | end, int \*result) | | | -+----------+------------+--------------------+-------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+-------------------+---+ - -+---+---+-----------------------+---------------------+---+ -| | | > start 开始端口号 | > 成功返回 0 | | -| | | > | > | | -| | | > end 结束端口号 | > 失败返回 端口状态 | | -| | | | | | -| | | result 具有足够空间的 | | | -| | | | | | -| | | int 数组。接受端口状 | | | -| | | | | | -| | | > 态 | | | -+---+---+-----------------------+---------------------+---+ -``` - - - 获取默认网关 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern | 获取默认网关 | | -| | | prouteMapList | | | -| 统 基 础 | | kd | | | -| | | k_net_get_route(); | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | prouteMapList | | -| | | | 网管信 | | -| | | | | | -| | | | 息，具体信息自取， | | -| | | | | | -| | | | > 失败返回 NULL | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 获取防火墙状态 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C | extern pChain | 获取防火墙信 | | -| | | kdk_net_g | | | -| 统 基 础 | | et_iptable_rules() | > 息 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | pChain | | -| | | | 防火墙信息， | | -| | | | | | -| | | | 具体信息自取，失败 | | -| | | | | | -| | | | > 返回 NULL | | -+----------+------------+--------------------+--------------------+---+ -``` ### **3.1.7** 获取系统运行时信息 @@ -1767,96 +1192,42 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev 获取瞬时网速 +| 子模块 | 编程语言 | 声明 | 描述 | +|----------|------|---------------------------------------------------------------------|-----------| +| 获取系统基础信息 | C++ | RealTimeInfo::float kdk_real_get_net_speed(); | 获取瞬时网速 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | float | +| 瞬时网速 | | +| | +| | -``` -+----------+------------+--------------------+--------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+==============+===+ -| 获 取 系 | C++ | R | 获取瞬时网速 | | -| | | ealTimeInfo::float | | | -| 统 基 础 | | kdk_rea | | | -| | | l_get_net_speed(); | | | -| > 信息 | | | | | -+----------+------------+--------------------+--------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------+---+ -| | | > 无 | > float | | -| | | | > | | -| | | | > 瞬时网速 | | -+----------+------------+--------------------+--------------+---+ -``` + 获取cpu温度 +| 子模块 | 编程语言 | 声明 | 描述 | +|----------|------|---------------------------------------------------------------------|-----------| +| 获取系统基础信息 | C++ | RealTimeInfo::float kdk_real_get_cpu_temperatu(); | 获取瞬时cpu温度 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | float | +| cpu瞬时温度 | | +| | + 获取硬盘温度 +| 子模块 | 编程语言 | 声明 | 描述 | +|----------|------|---------------------------------------------------------------------|-----------| +| 获取系统基础信息 | C++ | RealTimeInfo::float kdk_real_get_disk_temperatu(const char * name); | 获取瞬时硬盘温度 | +| | | 参数说明 | 返回值说明 | | +| | | name：硬盘绝对路径 | float | +| 指定硬盘瞬时温度 | | +| | - 获取 cpu 温度 + 获取磁盘转速 +| 子模块 | 编程语言 | 声明 | 描述 | +|----------|------|---------------------------------------------------------------------|-----------| +| 获取系统基础信息 | C++ | RealTimeInfo::int kdk_real_get_disk_rate(const char *name); | 获取磁盘转速 | +| | | 参数说明 | 返回值说明 | | +| | | name：硬盘绝对路径 | int | +| 指定磁盘转速 | -``` -+----------+------------+-------------------------------+----------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+===============================+================+===+ -| 获 取 系 | C++ | RealTimeInfo::float | 获取瞬时 cpu | | -| | | | | | -| 统 基 础 | | kdk_real_get_cpu_temperatu(); | > 温度 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+-------------------------------+----------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+-------------------------------+----------------+---+ -| | | > 无 | > float | | -| | | | > | | -| | | | > cpu 瞬时温度 | | -+----------+------------+-------------------------------+----------------+---+ -``` - - - 获取硬盘温度 - - -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 获 取 系 | C++ | R | 获取瞬时硬盘 | | -| | | ealTimeInfo::float | | | -| 统 基 础 | | | > 温度 | | -| | | kdk_real_get_di | | | -| > 信息 | | sk_temperatu(const | | | -| | | char \* | | | -| | | | | | -| | | name); | | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > | > float | | -| | | name：硬盘绝对路径 | > | | -| | | | > 指定硬盘瞬时温度 | | -+----------+------------+--------------------+--------------------+---+ -``` - - - 获取磁盘转速 - - -``` -+----------+------------+--------------------+--------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+==============+===+ -| 获 取 系 | C++ | RealTimeInfo::int | 获取磁盘转速 | | -| | | kdk_real_g | | | -| 统 基 础 | | et_disk_rate(const | | | -| | | | | | -| > 信息 | | char \*name); | | | -+----------+------------+--------------------+--------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------+---+ - -+---+---+----------------------+----------------+---+ -| | | > name：硬盘绝对路径 | > int | | -| | | | > | | -| | | | > 指定磁盘转速 | | -+---+---+----------------------+----------------+---+ -``` - ### **3.1.8** 获取当前地理信息 @@ -1887,25 +1258,12 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev 获取本机地理位置 -``` -+----------+------------+-----------------------------------+--------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+===================================+==============+===+ -| 获 取 系 | C | extern char \*kdk_loaction_get(); | 获取本机的地 | | -| | | | | | -| 统 基 础 | | | > 理位置 | | -| | | | | | -| > 信息 | | | | | -+----------+------------+-----------------------------------+--------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+-----------------------------------+--------------+---+ +| 子模块 | 编程语言 | 声明 | 描述 | +|----------|------|----------------------------------|----------------| +| 获取系统基础信息 | C | extern char *kdk_loaction_get(); | 获取本机的地理位置 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | 描述地理位置的json字符串 | -+---+---+------+---------------------+---+ -| | | > 无 | 描述地理位置的 json | | -| | | | | | -| | | | > 字符串 | | -+---+---+------+---------------------+---+ -``` ## **3.2** 电源管理 @@ -1919,48 +1277,24 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev 设置禁止锁屏 -``` -+-----------------+----------+-----------------+-----------------+---+ -| > 子模块 | 编程语言 | 声明 | > 描述 | | -+=================+==========+=================+=================+===+ -| > 电源管 理模块 | C++ | > uint32_t | > 设 置 禁 止 | | -| | | > kd | > 锁屏 | | -| | | k_set_inhibit_l | | | -| | | ockscreen(const | | | -| | | | | | -| | | char \*appName | | | -| | | , const char | | | -| | | \*reason) | | | -+-----------------+----------+-----------------+-----------------+---+ -| | | > 参数说明\ | > 返回值说明 0: | | -| | | > a | > 失败\ | | -| | | ppName：应用名\ | > \>0: 成功 | | -| | | > rea | | | -| | | son：禁止锁屏原 | | | -| | | > 因 | | | -+-----------------+----------+-----------------+-----------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|---------------|-------|--------------------------------------------------------------------------------|--------| +| 电源管理模块 | C++ | uint32_t kdk_set_inhibit_lockscreen(const char *appName , const char *reason) | 设置禁止锁屏 | +| | +| | | 参数说明 | 返回值说明 | +| | | appName：应用名
reason：禁止锁屏原因 | 0: 失败
>0: 成功 | + 取消禁止锁屏 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 电源管理模块 | C++ | int kdk_un_inhibit_lockscreen(uint32_t flag) | 取消禁止锁屏 | +| | +| | | 参数说明 |返回值说明 | +| | | flag：禁止锁屏接口的返回值 | 0: 成功
-1: 失败 | -``` -+-----------------+----------+------------------+------------------+ -| > 子模块 | 编程语言 | 声明 | > 描述 | -+=================+==========+==================+==================+ -| > 电源管 理模块 | C++ | > int | > 取 消 禁 止 | -| | | > kd | > 锁屏 | -| | | k_un_inhibit_loc | | -| | | kscreen(uint32_t | | -| | | > flag) | | -+-----------------+----------+------------------+------------------+ - -+---+---+-------------------------------+-----------------------+---+ -| | | > 参数说明\ | > 返回值说明 0: 成功\ | | -| | | > flag：禁止锁屏接口 的返回值 | > -1: 失败 | | -+---+---+-------------------------------+-----------------------+---+ -``` ## **3.3** 文件管理 @@ -1976,50 +1310,15 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev ``` -``` -+----------------------------------------+----------------------------+ -| 声明 | 描述 | -+========================================+============================+ -| QStringList | 增加需要监听的文件路径，对 | -| addWatchTargetRecursive(QString url, | | -| | 于目录，默认启用递归监听子 | -| FileWatcherType type = PERIODIC, int | | -| attr = | > 目录 | -| | | -| OPEN\|CLOSE\|MODIFY\|DELETE, int | | -| maxdepth = 5, | | -| | | -| > int recurType = DIR\|REGULAR); | | -+----------------------------------------+----------------------------+ -| > QStringList | > 增加需要监听的文件列表 | -| > | | -| > a | | -| ddWatchTargetListRecursive(QStringList | | -| > urlList, | | -| | | -| FileWatcherType type = PERIODIC, int | | -| attr = | | -| | | -| OPEN\|CLOSE\|MODIFY\|DELETE, int | | -| maxdepth = 5, | | -| | | -| > int recurType = DIR\|REGULAR); | | -+----------------------------------------+----------------------------+ -| > QStringList | 从监听列表中移除指定的文件 | -| > removeWatchTargetRecursive(QString | | -| > | | -| > url, int maxdepth = 5, int recurType | | -| > = ALLFILE); | | -+----------------------------------------+----------------------------+ +| 声明 | 描述 | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| QStringList addWatchTargetRecursive(QString url, FileWatcherType type = PERIODIC, int attr = OPEN|CLOSE|MODIFY|DELETE, int maxdepth = 5, int recurType = DIR|REGULAR); | 增加需要监听的文件路径，对于目录，默认启用递归监听子目录 | | +| QStringList addWatchTargetListRecursive(QStringList urlList, FileWatcherType type = PERIODIC, int attr = OPEN|CLOSE|MODIFY|DELETE, int maxdepth = 5, int recurType = DIR|REGULAR); | 增加需要监听的文件列表 | | +| QStringList removeWatchTargetRecursive(QString url, int maxdepth = 5, int recurType = ALLFILE); | 从监听列表中移除指定的文件 | | +| void clearWatchList(); | 清空监听列表 | | +| void pauseWatcher(); | 暂停文件监听 | | +| void restartWatcher(); | 恢复文件监听 | -+--------------------------+----------------+ -| > void clearWatchList(); | > 清空监听列表 | -+==========================+================+ -| > void pauseWatcher(); | > 暂停文件监听 | -+--------------------------+----------------+ -| > void restartWatcher(); | > 恢复文件监听 | -+--------------------------+----------------+ -``` ## **3.4** AI 能力 @@ -2036,61 +1335,24 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev 获取文字框 -``` -+--------+----------+----------------------+----------------------+---+ -| 子模块 | 编 程 语 | > 声明 | > 描述 | | -| | | | | | -| | > 言 | | | | -+========+==========+======================+======================+===+ -| > OCR | > C++ | > Std::vec | > 获取文字框 | | -| | | tor\\>\> | | | -| | | > | | | -| 别功能 | | > kdk::k | | | -| | | dkOCR::getRect(const | | | -| | | > std::string | | | -| | | > | | | -| | | > &imagePath) | | | -+--------+----------+----------------------+----------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+--------+----------+----------------------+----------------------+---+ -| | | String 图 片 文 | Vector\ 件路径 | | | -| | | | > nt\> | | -| | | | | | -| | | | 文字 | | -| | | | 框点的坐标矩阵、以及 | | -| | | | | | -| | | | > 文字框的个数 | | -+--------+----------+----------------------+----------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|--------------------|------|-----------------------------------------------------------------------------------------------|----------------------------------| +| OCR文字识别功能 | C++ | Std::vector>> kdk::kdkOCR::getRect(const std::string &imagePath) | 获取文字框 | +| | | 参数说明 | 返回值说明 | | +| | | String 图片文件路径 | Vector | +| 文字框点的坐标矩阵、以及文字框的个数 | + 获取文字内容 +| 子模块 | 编程语言 | 声明 | 描述 | +|---------------------|-------------------------|--------------------------------------------------------------------------------|--------| +| OCR文字识别功能 | C++ | Std::vector>>getCls(const std::string &imagePath,int nums) | 获取文字内容 | +| | | 参数说明 | 返回值说明 | | +| | | String 图片文件路径 | +| Int nums 同时处理的文字栈个数 | Vector图片中的文字字符串 | -``` -+----------+----------+----------------------+----------------+ -| > 子模块 | 编程语言 | 声明 | 描述 | -+==========+==========+======================+================+ -| OCR 文 | C++ | Std::vecto | 获 取 文 字 内 | -| | | r\\>\>getCls(const | > 容 | -| | | | | -| | | std::string | | -| | | &imagePath,int nums) | | -+----------+----------+----------------------+----------------+ - -+--------+---+-------------------------+-------------------------+---+ -| > 功能 | | > 参数说明 | > 返回值说明 | | -+========+===+=========================+=========================+===+ -| | | > String 图片文件 路径\ | > Vector\ 图 | | -| | | > Int nums 同时处 | > 片 中 的 文字字符串 | | -| | | > 理的文字栈个数 | | | -+--------+---+-------------------------+-------------------------+---+ - -``` ## **3.5** 打印机管理 @@ -2101,240 +1363,89 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev 获取系统打印机列表 -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 打 印 机 | C | extern char\*\* | 获取打印机列 | | -| | | kdk_p | | | -| > 管理 | | rinter_get_list(); | > 表 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | char \*\* | | -| | | | 系统打印机列 | | -| | | | | | -| | | | > 表 | | -+----------+------------+--------------------+--------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------|-----------------| +| 打印机管理 | C | extern char** kdk_printer_get_list(); | 获取打印机列表 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char ** 系统打印机列表 | | +| | + 获取系统可用打印机列表 - 获取系统可用打印机列表 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern char** kdk_printer_get _availablelist(); | 获取可用打印机列表 | +| | | 参数说明 | 返回值说明 | | +| | | 无 | char ** 系统打印机列表 | | +| | + 设置打印参数 -``` -+----------+------------+--------------------+--------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+====================+===+ -| 打 印 机 | C | extern char\*\* | 获取可用打印 | | -| | | kdk_printer_get | | | -| > 管理 | | \_availablelist(); | > 机列表 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------------+---+ -| | | > 无 | char \*\* | | -| | | | 系统打印机列 | | -| | | | | | -| | | | > 表 | | -+----------+------------+--------------------+--------------------+---+ -``` +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern void kdk_printer_set_options(int number_up,const char *media,const char *number_up_layout,const char *sides); | 设置打印参数 | +| | | 参数说明 | 返回值说明 | | +| | | number_up：一张纸打印几页 | +| media：纸张类型 | +| number_up_layout：cups属性，如lrtb | +| sides：单面one-sided，双面（长边翻转）：two_sided_long_dege | +| 双面（短边翻转）： | +| two_sided_short_dege | 无 | | +| | + 打印文件 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern int kdk_printer_print_local_file(const char *printername, char *filepath); | 打印文件 | +| | | 参数说明 | 返回值说明 | | +| | | printername: 打印机名 | +| filepath：打印文件绝对路径 | int 打印作业的id | | +| | - 设置打印参数 + 取消打印作业 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern int kdk_printer_cancel_all_jobs(const char *printername); | 取消打印作业 | +| | | 参数说明 | 返回值说明 | | +| | | printername：打印机名 | int | +| 成功：0 | +| 失败：-1 | | +| | + 获取打印机状态 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern int kdk_printer_get_status(const char *printername); | 获取打印机状态 | +| | | 参数说明 | 返回值说明 | | +| | | printername，打印机名 | 打印机状态码 | | +| | -``` -+----------+------------+-----------------------------------------+--------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+=========================================+==============+===+ -| 打 印 机 | C | extern void kdk_printer_set_options(int | 设置打印参数 | | -| | | | | | -| > 管理 | | number_up,const char \*media,const char | | | -| | | | | | -| | | \*number_up_layout,const char \*sides); | | | -+----------+------------+-----------------------------------------+--------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+-----------------------------------------+--------------+---+ -| | | number_up ： 一 张 纸 | > 无 | | -| | | | | | -| | | > 打印几页 | | | -| | | > | | | -| | | > media：纸张类型 | | | -| | | > | | | -| | | > number_up_layout ： | | | -| | | > | | | -| | | > cups 属性，如 lrtb | | | -| | | > | | | -| | | > sides ： 单 面 one- | | | -| | | | | | -| | | sided，双面（长边翻 | | | -| | | | | | -| | | > 转 ） ： | | | -| | | > | | | -| | | > two_sided_long_dege | | | -| | | > | | | -| | | > 双面（短边翻转）： | | | -| | | > | | | -| | | > two_sided_short_dege | | | -+----------+------------+-----------------------------------------+--------------+---+ -``` + 从url中解析下载的文件名 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern void kdk_printer_get_filename(const char *url, char *filename); | 从url解析下载的文件名 | +| | | 参数说明 | 返回值说明 | | +| | | url，下载链接 | | | +| | | filename，解析出来的文件名 | | | +| | + 获取当前打印任务状态 - 打印文件 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern int kdk_printer_get_job_status(const char *printername, int jobid); | 获取当前打印任务状态 | +| | | 参数说明 | 返回值说明 | | +| | | printername，打印机名 | 打印任务状态码 | | +| | + 下载网络文件到本地 +| 子模块 | 编程语言 | 声明 | 描述 | +|-----------------|-------|-----------------------------------------------|--------| +| 打印机管理 | C | extern int kdk_printer_print_download_remote_file(const char *url, const char *filepath); | 下载网络文件到本地 | +| | | 参数说明 | 返回值说明 | | +| | | url，网络文件 | 下载状态码 | | +| | | filepath，要保存的文件路径，用户自定义 | -``` -+----------+------------+------------------------------+------------+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | -+==========+============+==============================+============+ -| 打 印 机 | C | extern int | > 打印文件 | -| | | kdk_pr | | -| > 管理 | | inter_print_local_file(const | | -| | | | | -| | | char \*printername, char | | -| | | \*filepath); | | -+----------+------------+------------------------------+------------+ - -+---+---+-----------------------+---------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+===+===+=======================+=====================+===+ -| | | printername: 打印机名 | > int 打印作业的 id | | -| | | | | | -| | | filepath：打印文件绝 | | | -| | | | | | -| | | > 对路径 | | | -+---+---+-----------------------+---------------------+---+ -``` - - - 取消打印作业 - - -``` -+----------+------------+--------------------+--------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+==============+===+ -| 打 印 机 | C | extern int | 取消打印作业 | | -| | | kdk_printer_can | | | -| > 管理 | | cel_all_jobs(const | | | -| | | | | | -| | | char | | | -| | | \*printername); | | | -+----------+------------+--------------------+--------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+--------------+---+ -| | | printername ： 打 | > int | | -| | | 印 机 | > | | -| | | | > 成功：0 | | -| | | > 名 | > | | -| | | | > 失败：-1 | | -+----------+------------+--------------------+--------------+---+ -``` - - - 获取打印机状态 - - -``` -+----------+------------+--------------------+----------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+================+===+ -| 打 印 机 | C | > extern int | 获 取 打 印 机 | | -| | | > kdk_printe | | | -| > 管理 | | r_get_status(const | > 状态 | | -| | | > char | | | -| | | | | | -| | | \*printername); | | | -+----------+------------+--------------------+----------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+----------------+---+ -| | | printername ， 打 | > 打印机状态码 | | -| | | 印 机 | | | -| | | | | | -| | | > 名 | | | -+----------+------------+--------------------+----------------+---+ -``` - - - 从 url 中解析下载的文件名 - - -``` -+----------+------------+--------------------+---------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+===============+===+ -| 打 印 机 | C | extern void | 从 url 解析下 | | -| | | kdk_printer_ | | | -| > 管理 | | get_filename(const | > 载的文件名 | | -| | | char | | | -| | | | | | -| | | \*url, char | | | -| | | \*filename); | | | -+----------+------------+--------------------+---------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+---------------+---+ -| | | > url，下载链接 | | | -+----------+------------+--------------------+---------------+---+ -| | | fi | | | -| | | lename，解析出来的 | | | -| | | | | | -| | | > 文件名 | | | -+----------+------------+--------------------+---------------+---+ - -``` - - 获取当前打印任务状态 - - -``` -+----------+------------+--------------------+------------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+==================+===+ -| 打 印 机 | C | extern int | 获 取 当 前 打 | | -| | | kdk_printer_ge | | | -| > 管理 | | t_job_status(const | > 印任务状态 | | -| | | char | | | -| | | | | | -| | | \*printername, int | | | -| | | jobid); | | | -+----------+------------+--------------------+------------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+------------------+---+ -| | | printername ， 打 | > 打印任务状态码 | | -| | | 印 机 | | | -| | | | | | -| | | > 名 | | | -+----------+------------+--------------------+------------------+---+ -``` - - - 下载网络文件到本地 - - -``` -+----------+------------+--------------------+----------------+---+ -| > 子模块 | > 编程语言 | 声明 | > 描述 | | -+==========+============+====================+================+===+ -| 打 印 机 | C | extern int | 下 载 网 络 文 | | -| | | | | | -| > 管理 | | kdk_prin | > 件到本地 | | -| | | ter_print_download | | | -| | | _remote_file(const | | | -| | | | | | -| | | char \*url, const | | | -| | | char \*filepath); | | | -+----------+------------+--------------------+----------------+---+ -| | | > 参数说明 | > 返回值说明 | | -+----------+------------+--------------------+----------------+---+ -| | | > url，网络文件 | > 下载状态码 | | -+----------+------------+--------------------+----------------+---+ -| | | fi | | | -| | | lepath，要保存的文 | | | -| | | | | | -| | | > | | | -| | | 件路径，用户自定义 | | | -+----------+------------+--------------------+----------------+---+ -```