luadoc.md · snailshall/IOT-POWER

# 接口列表

工具Lua环境为Lua 5.3版本，可直接使用原生自带功能。

**重要**：本软件引擎使用了腾讯的xlua框架，你可以直接调用c#的底层函数

## 增加的接口

### apiSetDevice(current,voltage,power_on)

设置电流电压和设备状态

#### 参数

#### 返回值

- boolean，设置结果，成功为true

#### 例子

```lua
--打开输出并输出4.2V，限流1.8A
local r = apiSetDevice(1800,4.2,true)
if r then print("成功设置输出！") end
```

### apiGetDevice()

获取当前设置的输出参数

#### 参数

无

#### 返回值

- number/nil，设置的电流值，单位mA，获取失败为nil
- number/nil，设置的电压值，单位V，获取失败为nil
- number/nil，设备是否打开输出，获取失败为nil

#### 例子

```lua
local c,v,power_on = apiGetDevice()
print(c,v,power_on)
```

### apiGetCV()

获取当前读到的瞬时值

#### 参数

无

#### 返回值

- number/nil，获取到的电流瞬时值，单位mA，获取失败为nil
- number/nil，获取到的电压瞬时值，单位V，获取失败为nil

#### 例子

```lua
local c,v = apiGetCV()
print(c,v)
```

### apiGetPower()

获取当前的耗电量，注意如果在波形页面清空数据，这里也会被清空

#### 参数

无

#### 返回值

- number，获取到的耗电量，单位mWh

#### 例子

```lua
local p = apiGetPower()
print(p)
```

### apiPlot(xPoints,yPoints,title,xText,yText,width,height,path)

绘制图表并保存为文件

#### 参数

#### 返回值

- boolean，保存结果，成功为true，失败为nil
- string/nil，保存失败的原因，若成功则为nil

#### 例子

```lua
apiPlot({1,2,3},{3,2,1},"测试","时间(s)","距离(m)",500,500,"D:\\1.png")
```

### apiGetSavePath(ext)

获取文件保存路径（无法在LuaTask任务、定时器回调、任务回调中使用）

#### 参数

|传入值|类型|释义|
|-|-|-|
|ext|string|保存文件的拓展名|

#### 返回值

- string/nil，保存的文件名，如果用户点了取消则为nil

#### 例子

```lua
local path = apiGetSavePath("png")
```

### apiMessageBox(title,text,ok)

弹个窗，展示简易信息（无法在LuaTask任务、定时器回调、任务回调中使用）

#### 参数

|传入值|类型|释义|
|-|-|-|
|title|string|标题|
|text|string|提示框内容|
|ok|string|可选，ok按钮内容|

#### 返回值

- 无

#### 例子

```lua
apiMessageBox("提示","即将开始xxx")
```

### apiInputBox(title,text,input,ok,no)

弹个窗，可以填写信息（无法在LuaTask任务、定时器回调、任务回调中使用）

#### 参数

|传入值|类型|释义|
|-|-|-|
|title|string|标题|
|text|string|提示框内容|
|input|string|可选，输入框内的默认内容|
|ok|string|可选，ok按钮内容|
|no|string|可选，取消按钮内容|

#### 返回值

- string/nil，用户输入的数据，如果点了取消则为nil

#### 例子

```lua
local text = apiInputBox("提示","请填写需要重复的次数")
```

### apiDialog(title,text,ok,no)

弹个窗，带是、否两个按键（无法在LuaTask任务、定时器回调、任务回调中使用）

#### 参数

|传入值|类型|释义|
|-|-|-|
|title|string|标题|
|text|string|提示框内容|
|ok|string|可选，ok按钮内容|
|no|string|可选，否按钮内容|

#### 返回值

- boolean，用户点击结果，确定为true，否为false

#### 例子

```lua
local close = apiDialog("提示","是否关闭输出？")
```

### apiDialogCancel(title,text,ok,no,cancel)

弹个窗，带是、否、取消三个按键（无法在LuaTask任务、定时器回调、任务回调中使用）

#### 参数

|传入值|类型|释义|
|-|-|-|
|title|string|标题|
|text|string|提示框内容|
|ok|string|可选，ok按钮内容|
|no|string|可选，否按钮内容|
|cancel|string|可选，取消按钮内容|

#### 返回值

- boolean/nil，用户点击结果，确定为true，否为false，取消为nil

#### 例子

```lua
local close = apiDialog("提示","是否关闭输出？")
```

snailshall/IOT-POWER

简介

发行版

贡献者

近期动态

snailshall/IOT-POWER .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

snailshall/IOT-POWER