openSDK V2.3 ------开发指南

openSDK SIG

目录

1 概述
2 部署方式
3 系统能力 SDK
  3.1 系统信息
    3.1.1 系统时间报时
    3.1.2 获取硬件信息
    3.1.3 获取磁盘信息
    3.1.4 获取包列表信息
    3.1.5 获取资源信息
    3.1.6 获取操作系统基础信息
    3.1.7 获取网络信息
    3.1.8 获取系统运行时信息
    3.1.9 获取当前地理信息
  3.2 电源管理
    3.2.1 锁屏设置
  3.3 文件管理
  3.4 AI 能力
    3.4.1 OCR 文字识别功能
  3.5 打印机管理
  3.6 jpeg编码
4 应用支撑 SDK
  4.1 QT 自研控件模块
    4.1.1 窗体模块
    4.1.2 对话框模块
    4.1.3 输入框模块
    4.1.4 按钮模块
    4.1.5 Bar 模块
    4.1.6 滑动条模块
    4.1.7 消息提示模块
    4.1.8 面包屑 KBreadCrumb
    4.1.9 KCommentPanel
    4.1.10 KListView
    4.1.11 KTag
    4.1.12 KTranslucentFloor
  4.2 Wayland-helper
    4.2.1 WindowManager
    4.2.2 WindowInfo
    4.2.3 UkuiStyleHelper
  4.3 应用通用功能模块
    4.3.1 日志模块
    4.3.2 系统相关模块
    4.3.3 d-bus 模块------即将废弃
    4.3.4 系统信息模块
5 基础开发 SDK
  5.1 日志
  5.2 定时器
  5.3 C 语言字符串扩展
  5.4 链表模块
  5.5 配置文件操作
  5.6 单位进制转换
  5.7 Gsettings配置
  5.8 埋点数据
  5.9 conf2配置
  

1 概述

openKylin 自研开发者套件（以下简称 openSDK）是在 openKylin 社区操作系统上，为生态建设与软件开发提供安全、可靠、快捷、稳定的开发者接口。相比于社区中其他的开发者套件或框架，openSDK 更加聚焦于解决开放麒麟桌面操作系统的兼容、适配、移植、优化等方面的问题。openSDK 当前聚焦三大模块，包括应用支撑 SDK、系统能力 SDK、基础开发 SDK，同时充分考虑 openSDK 的兼容性。

本文档旨在为开发者在 openKylin 系统上进行应用开发时，提供一种高效查阅 openSDK 接口的声明和使用方法的方式。减少开发者在使用 openSDK 时的学习成本。

SDK 的整体模块介绍如下：

2 部署方式

openKylin 社区自研开发者套件下载使用时需提前添加 openSDK 源地址，安装步骤如下：

（1）软件源：

1.0软件源

deb http://archive.build.openKylin.top/openkylin/ yangtze main cross pty

deb http://archive.build.openKylin.top/openkylin/ yangtze-security main cross pty

deb http://archive.build.openKylin.top/openkylin/ yangtze-updates main cross pty

2.0软件源

deb http://archive.build.openKylin.top/openkylin/ nile main cross pty

deb http://archive.build.openKylin.top/openkylin/ nile-security main cross pty

deb http://archive.build.openKylin.top/openkylin/ nile-updates main cross pty

deb http://archive.build.openKylin.top/openkylin/ nile-proposed main cross pty

（2）配置后更新源：

$ sudo apt update

3 系统能力 SDK

系统能力 SDK 中的每个软件包均表述了一个或一类系统能力，例如操作系统信息、硬件管理、系统内生安全策略、网络管理等；

安装命令：

$ sudo apt-get install libkysdk-system libkysdk-system-dev

3.1 系统信息

该层设计主要为应用提供与操作系统相关的功能接口，以自研、组合、封装三种方式，将与 OS 相关功能（如文件系统、硬件信息、通信等）以功能为角度重新实现；屏蔽系统差异、平台差异带来的开发复杂性与调试难度。

3.1.1 系统时间报时

当系统时间在整分或系统时间被修改时，com.kylin.kysdk.TimeServer Dbus 服务会发出报时信号。

$ sudo apt-get install libdbus-1-dev libdbus-glib-1-dev libkysdk-systime libkysdk-systime-dev

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-systime

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKSYSTIME kysdk-systime)
target_include_directories(demo PRIVATE ${KYSDKSYSTIME_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKSYSTIME_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKSYSTIME_LIBRARIES})

（3）调用日期格式，需要添加头文件：

 #include "kysdk/kysdk-system/libkydate.h"

（1）dbus 服务名称：com.kylin.kysdk.TimeServer

（2）路径名称：/com/kylin/kysdk/Timer

（3）Interfaces：com.kylin.kysdk.TimeInterface

（4）信号：

系统时间修改信号：TimeChangeSignal

定时报时信号：TimeSignal

系统时间修改报时(自1.2.0版本启用)

系统时间整分报时(自1.2.0版本启用)

获取系统支持的日期格式(自2.0.0.0版本启用)

回收字符串列表(自2.0.0.0版本启用)

设置日期格式(自2.0.0.0版本启用)

设置 24 小时制格式(自2.0.0.0版本启用)

设置 12 小时制格式(自2.0.0.0版本启用)

获取当前的日期格式(自2.0.0.0版本启用)

获取当前的时间格式(自2.0.0.0版本启用)

获取当前星期接口(短格式)(自2.0.0.0版本启用)

获取当前星期接口(长格式)(自2.0.0.0版本启用)

获取当前秒钟接口(自2.0.0.0版本启用)

时间格式转换(自2.0.0.0版本启用)

释放由 kdk_system_tran_dateformat 返回的日期信息结构体(自2.0.0.0版本启用)

获取当前时间(自2.0.0.0版本启用)

获取当前日期(自2.0.0.0版本启用)

获取未登录时的时间,星期,日期(自2.0.0.0版本启用)

释放由 kdk_system_logn_dateinfo 返回的日期信息结构体(自2.0.0.0版本启用)

转换工具箱时间(自2.0.0.0版本启用)

监听系统时间格式修改信号(自2.0.0.0版本启用)

设置日期长格式(自2.2.3.5版本启用)

设置日期短格式(自2.2.3.5版本启用)

获取当前的长格式日期(自2.2.3.5版本启用)

获取当前的短格式日期(自2.2.3.5版本启用)

获取长格式(自2.2.3.5版本启用)

获取短格式(自2.2.3.5版本启用)

长格式转化(自2.2.3.5版本启用)

短格式转化(自2.2.3.5版本启用)

获取登录锁屏的时间,星期,长格式日期(自2.2.3.5版本启用)

时间格式转化(自2.2.3.5版本启用)

释放由kdk_system_timeformat_transform返回的时间信息结构体(自2.2.3.5版本启用)

监听日期长格式修改信号(自2.2.3.5版本启用)

监听日期短格式修改信号(自2.2.3.5版本启用)

监听时间格式修改信号(自2.2.3.5版本启用)

相对日期转为绝对日期(自2.3.0.0版本启用)

3.1.2 获取硬件信息

$ sudo apt-get install libkysdk-hardware libkysdk-hardware-dev 

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-hardware

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKHARDWARE kysdk-hardware)
target_include_directories(demo PRIVATE ${KYSDKHARDWARE_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKHARDWARE_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKHARDWARE_LIBRARIES})

3.1.2.1 获取 CPU 信息

封装 C 接口获取 CPU 信息

（1）获取硬件 CPU 信息，需要添加头文件：

#include "kysdk/kysdk-system/libkycpu.h"

获取 CPU 架构(自1.2.0版本启用)

获取 CPU 制造厂商(自1.2.0版本启用)

获取 CPU 型号(自1.2.0版本启用)

获取 CPU 额定主频(自1.2.0版本启用)

获取 CPU 核心数量(自1.2.0版本启用)

获取 CPU 对虚拟化的支持(自1.2.0版本启用)

获取CPU线程数(自1.2.0版本启用)

获取CPU最大频率(自2.3.0.0版本启用)

获取CPU最小频率(自2.3.0.0版本启用)

获取CPU运行时间(自2.3.0.0版本启用)

获取CPU插槽(自2.3.0.0版本启用)

获取CPU L1缓存（数据）(自2.3.0.0版本启用)

获取CPU L1缓存（指令）(自2.3.0.0版本启用)

获取CPU L2缓存(自2.3.0.0版本启用)

获取CPU L3缓存(自2.3.0.0版本启用)

3.1.2.2 获取网卡信息

封装 C 接口获取到网卡硬件信息。

（1）获取网卡信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkync.h"

获取系统中所有的网卡(自1.2.0版本启用)

检测指定网卡是否处于 UP 状态(自1.2.0版本启用)

获取系统中当前处于 link up 状态的网卡列表(自1.2.0版本启用)

获取指定网卡的物理 MAC 地址(自1.2.0版本启用)

获取指定网卡的第一个 IPv4 地址(自1.2.0版本启用)

获取指定网卡的所有 IPv4 地址(自2.0.0.0版本启用)

获取指定网卡的第一个 IPv6 地址(自1.2.0版本启用)

获取指定网卡的所有 IPv6 地址(自2.0.0.0版本启用)

获取指定网卡的有线/无线类型(自2.0.0.0版本启用)

获取指定网卡的厂商名称和设备型号(自2.0.0.0版本启用)

获取指定网卡的驱动(自2.2.3.5版本启用)

回收字符串列表(自1.2.0版本启用)

获取指定网卡的广播地址(自2.3.0.0版本启用)

获取指定网卡的子网掩码(自2.3.0.0版本启用)

获取指定网卡的掩码长度(自2.3.0.0版本启用)

获取指定网卡的连接类型(自2.3.0.0版本启用)

获取wifi名称(自2.3.0.0版本启用)

获取信号质量(连接 wifi 显示)(自2.3.0.0版本启用)

获取信号强度(连接 wifi 显示)(自2.3.0.0版本启用)

获取底噪(连接 wifi 显示)(自2.3.0.0版本启用)

获取网卡速率(自2.3.0.0版本启用)

获取指定网卡的接收包数量(自2.3.0.0版本启用)

获取指定网卡的总计接收(自2.3.0.0版本启用)

获取指定网卡的接收(错误包)(自2.3.0.0版本启用)

获取指定网卡的接收(丢弃包)(自2.3.0.0版本启用)

获取指定网卡的接收FIFO(自2.3.0.0版本启用)

获取指定网卡的分组帧错误(自2.3.0.0版本启用)

获取指定网卡的发送包数量(自2.3.0.0版本启用)

获取指定网卡的总计发送(自2.3.0.0版本启用)

获取指定网卡的发送(错误包)(自2.3.0.0版本启用)

获取指定网卡的发送(丢弃包)(自2.3.0.0版本启用)

获取指定网卡的发送FIFO(自2.3.0.0版本启用)

获取指定网卡的载波损耗(自2.3.0.0版本启用)

获取指定网卡的域(自2.3.0.0版本启用)

3.1.2.3 获取 bios 信息

封装 C 接口获取到 bios 硬件信息。

（1）获取 bios 信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkybiosinfo.h"

获取 bios 厂商信息(自2.0.0.0版本启用)

获取 bios 版本信息(自2.0.0.0版本启用)

释放内存(自2.0.0.0版本启用)

3.1.2.4 获取主板信息

封装 C 接口获取到主板硬件信息。

（1）获取主板信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkyboardinfo.h"

获取主板产品名称信息(自2.0.0.0版本启用)

获取主板生产日期(自2.0.0.0版本启用)

获取主板序列号(自2.0.0.0版本启用)

获取主板厂商信息(自2.0.0.0版本启用)

释放内存(自2.0.0.0版本启用)

3.1.2.5 获取 usb 设备信息

封装 C 接口获取到 usb 设备硬件信息。

（1）获取 usb 设备信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkyusbinfo.h"

获取所有 usb 设备信息(自2.0.0.0版本启用)

释放内存(自2.0.0.0版本启用)

3.1.2.6 获取蓝牙设备信息

封装 C 接口获取到蓝牙设备硬件信息。

（1）获取蓝牙设备信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkybluetooth.h"

获取蓝牙的设备id(自2.2.3.5版本启用)

获取蓝牙的制造商(自2.2.3.5版本启用)

获取蓝牙的设备版本(自2.2.3.5版本启用)

获取蓝牙的名称(自2.2.3.5版本启用)

获取蓝牙的地址(自2.2.3.5版本启用)

获取蓝牙的连接模式(自2.2.3.5版本启用)

获取蓝牙的连接策略(自2.2.3.5版本启用)

获取蓝牙的总线(自2.2.3.5版本启用)

获取蓝牙的SCO MTU(自2.2.3.5版本启用)

获取蓝牙的ALC MTU(自2.2.3.5版本启用)

获取蓝牙的数据包类型(自2.2.3.5版本启用)

获取蓝牙的功能(自2.2.3.5版本启用)

3.1.2.7 获取显卡设备信息

封装 C 接口获取到显卡设备硬件信息。

（1）获取显卡设备信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkydisplay.h"

获取显卡的制造商(自2.2.3.5版本启用)

获取显卡的型号(自2.2.3.5版本启用)

获取显卡的说明(自2.2.3.5版本启用)

获取显卡的物理id(自2.2.3.5版本启用)

获取显卡的总线地址(自2.2.3.5版本启用)

获取显卡的设备版本(自2.2.3.5版本启用)

获取显卡的数据宽度(自2.2.3.5版本启用)

获取显卡的频率(自2.2.3.5版本启用)

获取显卡的功能(自2.2.3.5版本启用)

获取显卡的配置(自2.2.3.5版本启用)

获取显卡的资源(自2.2.3.5版本启用)

3.1.2.8 获取显示器设备信息

封装 C 接口获取到显示器设备硬件信息。

（1）获取显示器设备信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkyedid.h"

获取显示器的当前接口(自2.2.3.5版本启用)

获取显示器的伽马值(自2.2.3.5版本启用)

获取显示器的屏幕尺寸（英寸）(自2.2.3.5版本启用)

获取显示器的最大分辨率(自2.2.3.5版本启用)

获取显示器的显示器型号(自2.2.3.5版本启用)

获取显示器的可视面积(自2.2.3.5版本启用)

获取显示器的厂商(自2.2.3.5版本启用)

获取显示器的生产日期/周(自2.2.3.5版本启用)

获取显示器的生产日期/年(自2.2.3.5版本启用)

获取是否是主显示器（是/否）(自2.2.3.5版本启用)

获取分辨率(自2.2.3.5版本启用)

获取图像高宽比(自2.2.3.5版本启用)

获取显示器edid未解析的字符串(自2.2.3.5版本启用)

用于回收字符串列表(自2.2.3.5版本启用)

3.1.2.9 获取风扇设备信息

封装 C 接口获取到风扇设备硬件信息。

（1）获取风扇设备信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkyfan.h"

获取风扇的信息(自2.2.3.5版本启用)

用于回收字符串列表(自2.2.3.5版本启用)

3.1.2.10 获取键盘、鼠标、声卡、光驱、摄像头、电源信息

封装 C 接口获取到键盘、鼠标、声卡、光驱、摄像头、电源信息。

（1）获取键盘、鼠标、声卡、光驱、摄像头、电源信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkyhw.h"

获取硬件信息(自2.2.3.5版本启用)

释放由kdk_hw_get_hwinfo返回的磁盘信息结构体(自2.2.3.5版本启用)

获取电源信息(自2.2.3.5版本启用)

释放由kdk_hw_get_powerinfo返回的磁盘信息结构体(自2.2.3.5版本启用)

3.1.3 获取磁盘信息

$ sudo apt-get install libkysdk-disk libkysdk-disk-dev 

封装 C 接口获取到磁盘硬件信息。

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-disk

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKDISK kysdk-disk)
target_include_directories(demo PRIVATE ${KYSDKDISK_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKDISK_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKDISK_LIBRARIES})

（3）获取磁盘信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkydiskinfo.h"

获取系统中所有磁盘的列表(自1.2.0版本启用)

释放由 kdk_get_disklist 返回的磁盘列表(自1.2.0版本启用)

获取系统中指定磁盘的磁盘信息(自1.2.0版本启用)

释放由 kdk_get_diskinfo 返回的磁盘信息结构体(自1.2.0版本启用)

获取系统接入所有硬盘(自2.2.3.5版本启用)

获取硬盘大小(自2.2.3.5版本启用)

获取硬盘固态版本(自2.2.3.5版本启用)

获取硬盘类型(自2.2.3.5版本启用)

获取硬盘型号(自2.2.3.5版本启用)

获取硬盘序列号(自2.2.3.5版本启用)

获取硬盘厂商(自2.2.3.5版本启用)

3.1.4 获取包列表信息

封装 C 接口获取系统中所有的包信息。

$ sudo apt-get install libkysdk-package libkysdk-package-dev

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-package

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKPACKAGE kysdk-package)
target_include_directories(demo PRIVATE ${KYSDKPACKAGE_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKPACKAGE_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKPACKAGE_LIBRARIES})

（3）获取包列表信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkypackages.h"

获取系统中所有包列表(自1.2.0版本启用)

获取系统中指定包的版本号(自1.2.0版本启用)

检测指定包名的软件包是否正确安装(自1.2.0版本启用)

回收由kdk_package_get_packagelist()返回的结构体(自1.2.0版本启用)

3.1.5 获取资源信息

封装 C 接口获取到内存、swap 分区、cpu 的使用率等资源信息。

$ sudo apt-get install libkysdk-proc libkysdk-proc-dev 

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-proc

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKPROC kysdk-proc)
target_include_directories(demo PRIVATE ${KYSDKPROC_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKPROC_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKPROC_LIBRARIES})

（3）获取包列表信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkyrtinfo.h"
 #include "kysdk/kysdk-system/libkyprocess.h"

获取系统中物理内存总大小(自1.2.0版本启用)

获取物理内存使用率(自1.2.0版本启用)

获取物理内存使用大小(自1.2.0版本启用)

获取实际可用的物理内存大小(自1.2.0版本启用)

获取实际空闲的物理内存大小(自1.2.0版本启用)

获取所有应用申请的虚拟内存总量(自1.2.0版本启用)

获取系统中 Swap 分区总大小(自1.2.0版本启用)

获取 Swap 分区使用率(自1.2.0版本启用)

获取 Swap 分区使用量(自1.2.0版本启用)

获取 Swap 分区空闲大小(自1.2.0版本启用)

获取 CPU 瞬时使用率(自1.2.0版本启用)

获取操作系统开机时长(自1.2.0版本启用)

获取共享内存大小(自2.3.0.0版本启用)

获取高速缓存大小(自2.3.0.0版本启用)

获取数据缓存大小(自2.3.0.0版本启用)

获取交换缓存区大小(自2.3.0.0版本启用)

获取活跃的缓冲文件大小(自2.3.0.0版本启用)

获取不活跃的缓冲文件大小(自2.3.0.0版本启用)

获取脏页大小(自2.3.0.0版本启用)

获取映射大小(自2.3.0.0版本启用)

获取内核数据结构缓存大小(自2.3.0.0版本启用)

获取指定进程的 CPU 使用率(自2.0.0.0版本启用)

获取指定进程的内存占用率(自2.0.0.0版本启用)

获取指定进程的进程状态(自2.0.0.0版本启用)

获取指定进程的端口号占用(自2.0.0.0版本启用)

获取指定进程的启动时间(自2.0.0.0版本启用)

获取指定进程的运行时间(自2.0.0.0版本启用)

获取指定进程的 cpu 时间(自2.0.0.0版本启用)

获取指定进程的 Command(自2.0.0.0版本启用)

获取指定进程的属主(自2.0.0.0版本启用)

获取指定进程的信息(自2.0.0.0版本启用)

获取系统中所有进程的信息(自2.0.0.0版本启用)

回收字符串列表(自2.0.0.0版本启用)

获取某一进程的名称(自2.2.3.5版本启用)

获取某一进程的id(自2.2.3.5版本启用)

3.1.6 获取操作系统基础信息

封装 C 接口获取系统名称、版本号、激活信息等。

$ sudo apt-get install libkysdk-sysinfo libkysdk-sysinfo-dev 

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-sysinfo

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKSYSINFO kysdk-sysinfo)
target_include_directories(demo PRIVATE ${KYSDKSYSINFO_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKSYSINFO_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKSYSINFO_LIBRARIES})

（3）获取操作系统信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkysysinfo.h"

获取操作系统架构信息(自1.2.0版本启用)

获取操作系统名称(自1.2.0版本启用)

获取操作系统版本号(自1.2.0版本启用)

获取操作系统激活状态(自1.2.0版本启用)

获取操作系统服务序列号(自1.2.0版本启用)

获取内核版本号(自1.2.0版本启用)

获取当前登录用户的用户名(自1.2.0版本启用)
注：2.3.0.0版本后修改为系统当前登录的用户名，跟应用程序的启动用户没有关系，root用户启动的应用程序调用这个接口也不会返回root。

获取当前登录用户的登录时间(自2.3.0.0版本启用)

获取操作系统项目编号名(自1.2.0版本启用)

获取操作系统项目子编号名(自1.2.1版本启用)

获取操作系统产品标识码(自1.2.1版本启用)

获取操作系统宿主机的虚拟机类型(自1.2.0版本启用)

获取操作系统宿主机的云平台类型(自1.2.0版本启用)

判断当前操作系统是否为专用机系统(自1.2.0版本启用)

获取系统分辨率信息(自2.0.0.0版本启用)

回收字符串列表(自2.0.0.0版本启用)

获取显示系统硬件版本类别(自2.1.1.0版本启用)

获取系统版本号/补丁版本号(自1.2.1版本启用)

获取系统开机时间(自2.2.3.5版本启用)

获取系统关机时间(自2.2.3.5版本启用)

获取整机制造商(自2.2.3.5版本启用)

获取整机型号(自2.2.3.5版本启用)

获取整机序列号(自2.2.3.5版本启用)

获取主机名(自2.2.3.5版本启用)

获取操作系统位数(自2.2.3.5版本启用)

获取操作系统构建时间(自2.2.3.5版本启用)

获取总线信息(自2.2.3.5版本启用)

释放由kdk_hw_get_pci_info返回的pci总线信息结构体(自2.2.3.5版本启用)

获取应用场景(自2.2.3.5版本启用)

获取系统中文件描述符数(自2.3.0.0版本启用)

获取系统中进程数(自2.3.0.0版本启用)

获取系统中线程数(自2.3.0.0版本启用)

获取CPU负载均衡(自2.3.0.0版本启用)

3.1.7 获取网络信息

封装 C 接口获取到网络信息。

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-net

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKNET kysdk-net)
target_include_directories(demo PRIVATE ${KYSDKNET_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKNET_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKNET_LIBRARIES})

（3）获取网络信息，需要添加头文件：

 #include "kysdk/kysdk-system/libkynetinfo.h"

（1）dbus 服务名称：org.freedesktop.NetworkManager

（2）路径名称：/org/freedesktop/NetworkManager

（3）Interfaces：org.freedesktop.NetworkManager

获取网络连接状态

获取网络端口状态(自2.0.0.0版本启用)

获取多个网络端口状态(自2.0.0.0版本启用)

获取默认网关(自2.0.0.0版本启用)

获取防火墙信息(自2.0.0.0版本启用)

获取子网信息(自2.2.3.5版本启用)

获取进程对应端口(自2.2.3.5版本启用)

获取所有UP状态的端口号(自2.2.3.5版本启用)

获取hosts配置(自2.2.3.5版本启用)

获取hosts配置的域名映射(自2.2.3.5版本启用)

获取DNS配置文件(自2.2.3.5版本启用)

用于回收字符串列表(自2.2.3.5版本启用)

释放由kdk_net_get_route返回的网关信息结构体(自2.0.0.0版本启用)

释放由kdk_net_get_iptable_rules返回的防火墙信息结构体(自2.0.0.0版本启用)

3.1.8 获取系统运行时信息

封装C接口获取网速、cpu 温度、硬盘温度等。

$ sudo apt-get install libkysdk-realtime libkysdk-realtime-dev

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-realtime

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKREALTIME kysdk-realtime)
target_include_directories(demo PRIVATE ${KYSDKREALTIME_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKREALTIME_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKREALTIME_LIBRARIES})

（2）获取操作系统运行时信息，需要添加头文件：

#include "kysdk/kysdk-system/libkyrealtimeinfo.h"

获取上传的瞬时网速(自2.0.0.0版本启用)

获取cpu温度(自2.0.0.0版本启用)

获取磁盘温度(自2.0.0.0版本启用)

获取磁盘转速(自2.0.0.0版本启用)

获取下载的瞬时网速信息(自2.2.3.5版本启用)

3.1.9 获取当前地理信息

封装 C 接口获取当前 ip 地址地理信息。

$ sudo apt-get install libkysdk-location libkysdk-location-dev

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-location

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKLOCATION kysdk-location)
target_include_directories(demo PRIVATE ${KYSDKLOCATION_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKLOCATION_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKLOCATION_LIBRARIES})

（3）获取 IP 地址地理信息，需要添加头文件：

#include "kysdk/kysdk-system/libkylocation.h"

获取本机地理位置(自2.0.0.0版本启用)

3.2 电源管理

该层设计主要为应用电源管理接口。

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-powermanagement

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKPOWER kysdk-powermanagement)
target_include_directories(demo PRIVATE ${KYSDKPOWER_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKPOWER_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKPOWER_LIBRARIES})

（3）电源管理，需要添加头文件：

#include "kysdk/kysdk-system/libkylockscreen.h"

3.2.1 锁屏设置

封装 C++接口提供锁屏设置能力。

设置禁止锁屏(自1.2.0版本启用)

取消禁止锁屏(自1.2.0版本启用)

3.3 文件管理

该模块设计主要为开发者监控文件系统中文件变化，提供接口定义；减少

系统版本间由于部分文件系统变化而导致的差异；

安装方式：

 $ sudo apt install libkysdk-filesystem libkysdk-filesystem-dev

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-filesystem

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKFILESYSTEM kysdk-filesystem)
target_include_directories(demo PRIVATE ${KYSDKFILESYSTEM_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKFILESYSTEM_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKFILESYSTEM_LIBRARIES})

（3）文件管理，需要添加头文件：

#include "kysdk/kysdk-system/libkyfilewatcher.hpp"
#include "kysdk/kysdk-system/libkyfilewatcher_global.hpp"

3.4 AI 能力

该层设计主要为应用提供 AI 识别功能接口，为 OS 增加 OCR 文字识别功能；屏蔽需

引入 AI 功能带来的开发复杂性与调试难度。

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-ocr

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKOCR kysdk-ocr)
target_include_directories(demo PRIVATE ${KYSDKOCR_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKOCR_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKOCR_LIBRARIES})

（3）OCR 文字识别功能，需要添加头文件：

#include "kysdk/kysdk-system/libkyocr.hpp"

3.4.1 OCR 文字识别功能

封装 C++接口提供 OCR 文字识别功能。

获取文字框(自1.2.0版本启用)

获取文字内容(自1.2.0版本启用)

3.5 打印机管理

$ sudo apt-get install libkysdk-hardware libkysdk-hardware-dev 

该层主要为应用提供打印机管理接口，可以实现打印任务的下发，打印方式，打印任

务的取消。

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-hardware

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKHARDWARE kysdk-hardware)
target_include_directories(demo PRIVATE ${KYSDKHARDWARE_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKHARDWARE_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKHARDWARE_LIBRARIES})

（3）获取打印机信息，需要添加头文件：

#include "kysdk/kysdk-system/libkyprinter.h"

获取系统打印机列表(自2.0.0.0版本启用)

获取本地的所有可用打印机(打印机处于idle状态)(自2.0.0.0版本启用)

设置打印参数(自2.0.0.0版本启用)

打印文件(自2.0.0.0版本启用)

取消打印作业(自2.0.0.0版本启用)

获取打印机状态(状态不是实时更新)(自2.0.0.0版本启用)

从url中解析下载的文件名(自2.0.0.0版本启用)

获取当前打印任务状态(自2.0.0.0版本启用)

下载网络文件到本地(自2.0.0.0版本启用)

用于回收字符串列表(自2.2.3版本启用)

3.6 jpeg编码

$ sudo apt-get install libkysdk-imageproc libkysdk-imageproc-dev 

该层主要为应用提供jpeg编码器接口，可以实现初始化jpeg编码器，将rgb格式的纯字符内容的图片编码成jpg图片，释放编码器内存。

构建 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-imageproc

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKIMAGE kysdk-imageproc)
target_include_directories(demo PRIVATE ${KYSDKIMAGE_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKIMAGE_LIBRARY_DIRS})
target_link_libraries(demo PRIVATE ${KYSDKIMAGE_LIBRARIES})

（3）获取jpeg编码器信息，需要添加头文件：

#include "kysdk/kysdk-system/libkyimageproc.h"

初始化jpeg编码器(自2.3.0.0版本启用)

jpeg图编码接口(自2.3.0.0版本启用)

释放编码器内存(自2.3.0.0版本启用)

4 应用支撑 SDK

openSDK 应用支撑层中，所有的包均为向图形化应用提供图形化开发功能，例如图形化控件、主题风格等；该层通常与某个特定的开发框架有所绑定 ， 如 QT 、 GTK ； 应 用 支 撑层 SDK 安装时需安装 两个虚包：libkysdk-application、libkysdk-applications-dev，其他包按照功能分类生成多个实包，比如：QT 控件类： libkysdk-qtwidgets，wayland 显示协议兼容接口 libkysdk-waylandhelper，应用通用模块 libkysdk-kabase 等。

安装命令：

$ sudo apt install libkysdk-applications libkysdk-applications-dev

4.1 QT 自研控件模块

QT 自研控件模块 kysdk-qtwidgets 属于 kysdk-application 的子模块，安装方式如下：

sudo apt install libkysdk-qtwidgets libkysdk-qtwidgets-dev

根据不同项目类型，可参考以下 demo：

（1）.pro 文件构建项目

qt 项目.pro 文件中增加：

CONFIG += link_pkgconfig
PKGCONFIG += kysdk-qtwidgets

（2）CMakeLists.txt 构建项目

cmake_minimum_required(VERSION 3.5)
find_package(Qt5 COMPONENTS Widgets REQUIRED)
find_package(PkgConfig REQUIRED)
pkg_check_modules(KYSDKQTWIDGETS_PKG kysdk-qtwidgets)
target_include_directories(demo PRIVATE ${KYSDKQTWIDGETS_PKG_INCLUDE_DIRS})
target_link_directories(demo PRIVATE ${KYSDKQTWIDGETS_PKG_LIBRARY_DIRS})
target_link_libraries(demo Qt5::Widgets ${KYSDKQTWIDGETS_PKG_LIBRARIES})

在具体项目中，需在代码中引入对应的头文件以及命名空间，如：

#include "kwidget.h"
using namespace kdk;

部分控件用到翻译文件，可以在 main()函数中加载翻译文件，目前支持中

文、藏文、英文三种语言，翻译文件已经编进动态库中，加载方式如下：

int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
    QTranslator trans;
    QString locale = QLocale::system().name();
    if(locale == "zh_CN")
    {
        if(trans.load(":/translations/gui_zh_CN.qm"))
        {
            a.installTranslator(&trans);
        }
    }
    if(locale == "bo_CN")
    {
        if(trans.load(":/translations/gui_bo_CN.qm"))
        {
            a.installTranslator(&trans);
        }
    }
    Widget w;
    w.show();
    return a.exec();
}

4.1.1 窗体模块

4.1.1.1 基础窗体

功能描述：KWidget，继承自 QWidget,支持响应主题背景切换，响应图标主

题切换，标题颜色响应窗口激活状态，窗口按钮样式符合 ukui3.1 的设计风格，

分 为 四 个 组 成 部 分 iconBar,windowButtonBar,sideBar,baseBar 。

iconBar,windowButtonBar 默认高度为 40px，sideBar 默认宽度为 200px。

VerticalType：上下结构

HorizontalType：左右结构

MixedType：过渡结构

4.1.1.2 KBubbleWidget

功能描述：KBubbleWidget，继承自 QWidget，是一个带有气泡尾部的窗

体，可以指定气泡尾部的尺寸、显示方向和显示位置，还可以设置窗体的圆

角、毛玻璃以及透明度。自 2.0.0.0 版本启用。

TailDirection：气泡尾部的显示方向

TailLocation：指定气泡尾部的显示位置

4.1.2 对话框模块

4.1.2.1 基础对话框

功能描述：KDialog，继承自 QDialog 支持响应主题背景切换，相应图标主

题切换，窗口按钮样式符合 ukui3.1 的设计风格，标题颜色响应窗口激活状态。

4.1.2.2 关于对话框

功能描述：KAboutDialog，包含的主要内容有：应用图标，应用名称，版本

号，团队邮箱以及具体的应用描述，注意，默认应用描述是不显示的。可以通

过 setBodyTextVisible(bool)控制其是否需要显示。

4.1.2.3 输入对话框

功能描述：输入对话框 KInputDialog，继承自 QDialog，参考 QInputDialog

源码，对子控件布局以及样式进行了调整，功能同 QInputDialog。

(1)QString KInputDialog::getText(QWidget *parent,const QString &label,

QLineEdit::EchoMode mode, const QString &text,bool *ok,

Qt::WindowFlags flags, Qt::InputMethodHints inputMethodHints)

文本输入对话框，同 QInputDialog

(2)QString KInputDialog::getMultiLineText(QWidget *parent,const QString&label,

const QString &text, bool *ok, Qt::WindowFlags flags,

Qt::InputMethodHints inputMethodHints)

多行文本输入框，同 QInputDialog

(3)

int KInputDialog::getInt(QWidget *parent,const QString &label, int value,
int min, int max, int step, bool *ok, Qt::WindowFlags flags)

整型数字输入对话框，同 QInputDialog

(3)

double KInputDialog::getDouble(QWidget *parent,const QString &label,
double value, double minValue, double maxValue, 
int decimals, bool *ok, Qt::WindowFlags flags)