JavaScript 接口 API 文档

概述

本文档描述了迪加悬浮框中 JavaScript 与迪加的交互。

悬浮窗中js均通过 diplus.接口名称 调用，例如
diplus.getVal('左转向灯',true)

接口列表

1. 获取单个参数值

接口名称：getVal
描述：根据自动化名称获取对应的值。
请求方法：JavaScript 调用
请求参数：

参数名	类型	是否必填	示例值	说明
name	string	是	"左转向灯"	自动化参数名
status	boolean	是	true	是否转为状态文本

响应数据：
参数值

错误码：

正常返回字符串，无错误码

2. 获取迪加参数

接口名称：getDiPars
描述：获取迪加参数(支持迪加{}[]格式)。
请求方法：JavaScript 调用
请求参数：

参数名	类型	是否必填	示例值	说明
text	string	是	"{左转向灯}"	[左转向灯]表示取状态描述，{左转向灯}表示获取数值，注意[]和{}的转义

响应数据：
字符串

3. 发送小迪指令

接口名称：sendCmd
描述：发送小迪指令。
请求方法：JavaScript 调用
请求参数：

参数名	类型	是否必填	示例值	说明
cmd	string	是	"延迟1秒,播报你好"	小迪指令，支持逗号分隔多个

响应数据：无

4. 关闭操作

接口名称：close
描述：关闭浮动框。
请求方法：JavaScript 调用
请求参数：无
响应数据：无

5. 设置位置

接口名称：setXY
描述：设置窗口的坐标位置。
请求方法：JavaScript 调用
请求参数：

参数名	类型	是否必填	示例值	说明
x	int	是	100	X 坐标
y	int	是	200	Y 坐标

响应数据：
true/false

6. 设置尺寸

接口名称：setWH
描述：设置窗口的宽度和高度。
请求方法：JavaScript 调用
请求参数：

参数名	类型	是否必填	示例值	说明
w	int	是	1024	宽度值
h	int	是	768	高度值

响应数据：
true/false

7. 获取窗口位置和尺寸

接口名称：getX / getY / getW / getH
描述：获取窗口的坐标位置和尺寸信息。
请求方法：JavaScript 调用
请求参数：无

响应数据：
数值

说明：

getX: 返回 X 坐标（失败返回 -1）

getY: 返回 Y 坐标（失败返回 -1）

getW: 返回宽度（失败返回 -1）

getH: 返回高度（失败返回 -1）

8. 获取全部配置

接口名称：getConfs
描述：获取所有配置信息。
请求方法：JavaScript 调用
请求参数：无
响应数据：
json格式

9. 设置配置项

接口名称：setConf
描述：设置指定配置项的值。
请求方法：JavaScript 调用
请求参数：

参数名	类型	是否必填	示例值	说明
key	string	是	"BootCmd"	配置项键名
val	string	是	"播报开机"	配置项值

响应数据：
true/false

10. 获取应用版本信息

接口名称：getAppVersionName
描述：获取当前应用的版本名称。
请求方法：JavaScript 调用
请求参数：无
响应数据：
版本信息，如1.0.0

错误处理：异常时返回 "Unknown"

11. 获取应用版本号

接口名称：getAppVersion
描述：获取当前应用的版本号。
请求方法：JavaScript 调用
请求参数：无
响应数据：
版本号，如127

错误处理：异常时返回 0

错误处理机制

返回数值的接口：异常时返回 -1 或 0

返回字符串的接口：异常时返回 "Unknown"

返回布尔值的接口：异常时返回 false

调用方应根据返回的默认值判断接口调用是否成功。

js接口

JavaScript 接口 API 文档#

概述#

接口列表#

1. 获取单个参数值#

2. 获取迪加参数#

3. 发送小迪指令#

4. 关闭操作#

5. 设置位置#

6. 设置尺寸#

7. 获取窗口位置和尺寸#

8. 获取全部配置#

9. 设置配置项#

10. 获取应用版本信息#

11. 获取应用版本号#

错误处理机制#

JavaScript 接口 API 文档

概述

接口列表

1. 获取单个参数值

2. 获取迪加参数

3. 发送小迪指令

4. 关闭操作

5. 设置位置

6. 设置尺寸

7. 获取窗口位置和尺寸

8. 获取全部配置

9. 设置配置项

10. 获取应用版本信息

11. 获取应用版本号

错误处理机制