ysdb 0.2.0

YSDB Python Client SDK

YSDB SDK

目前支持 Windows、CentOS 和 Debian 环境（Debian为K2Assets的python运行环境）。

此SDK为二次开发人员提供ysdb数据库的python客户端开发接口。

ysdb提供标准C动态库，由python封装C动态库，对外提供标准python的接口SDK。用户只需要调用python的对象既可以访问ysdb数据库。

一、安装和验证

安装SDK最新版本：

pip install -U ysdb

在python代码里引用并建立到指定ysdb服务器的连接：

from ysdb.ysdbLib import RdbClient

client = RdbClient()
ret = client.connect("192.168.131.238", 30221)

以上代码若运行成功将返回下面的结果，表示连接成功：

rdbConnectOk, handle:1

二、直接使用SDK

直接使用ysdb sdk的方法，例如读取ysdb中的散点或波形数据，请参考《ysdb数据库开发接口（Python）》文档。

三、通过封装类使用SDK

昆仑数据基于ysdb原有接口做了一层封装（RdbWrapper类），去掉了不常用的参数，使得调用更方便。

目前RdbWrapper只提供个别接口的功能，未来视情况扩展。

1、写入遥控命令

基于原SDK中的login和writeCtrlDataById接口封装，用于向ysdb写入遥控命令。

接口定义

• write_ctrl_data(mode, point_id, point_value)

输入参数

参数名称	参数含义
mode	写入模式，0表示写入状态量，1表示写入模拟量
point_id	要遥控的测点ID
point_value	要写入的遥控值。mode为0时，1代表打开，0代表关闭；

返回值

• 返回1表示写入成功，非1表示写入失败
• 若connect或login失败将抛出异常

示例

from ysdb.wrapper import RdbWrapper

rdbWrapper = RdbWrapper('192.168.130.13', 30221, 'Administrator', '123')
ret = rdbWrapper.write_ctrl_data(0, 2, 1)  # 写入状态量到2号测点
ret = rdbWrapper.write_ctrl_data(1, 4, 3.0)  # 写入模拟量到4号测点

# 登录ysdb得到的token有效期为10分钟，若持续写入遥控命令，需要定期更新token
rdbWrapper.refresh_token()

2、更新token

登录ysdb得到的token有效期为10分钟，若持续调用需要token的接口，需要定期更新token。

接口定义

• refresh_token()

返回值

• 若更新成功返回token值
• 若更新失败将抛出异常