lockControler

来自于:APICloud 官方立即使用

模块概述

lockControler 模块封装永兴盛平板通讯协议

模块接口

setPowerTime

设置开关机时间

setPowerTime({params}, callback(ret))

params

openDate:

  • 类型:字符串类型
  • 描述:开机时间,格式yyyy-MM-dd HH:mm:ss

closeDate:

  • 类型:字符串类型
  • 描述:关机时间,格式yyyy-MM-dd HH:mm:ss

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.setPowerTime({
    openDate:‘’,
    closeDate:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

cancelPowerTimef

取消定时开关机时间

cancelPowerTimef({params}, callback(ret))

params

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.cancelPowerTimef({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

setSysTime

设置系统时间

setSysTime({params}, callback(ret))

params

date:

  • 类型:字符串类型
  • 描述:时间,格式yyyy-MM-dd HH:mm:ss

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.setSysTime({
    date:‘’,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

powerOff

立刻关机

powerOff({params}, callback(ret))

params

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.powerOff({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

reboot

重启板卡

reboot({params}, callback(ret))

params

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.reboot({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

hideBar

隐藏导航栏

hideBar({params}, callback(ret))

params

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.hideBar({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showBar

显示导航栏

showBar({params}, callback(ret))

params

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.showBar({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

screenshot

截屏,调用此接口系统会进行截屏,图片保存路径, /mnt/sdcard/Screenshots, 文件名按时间保存, 例如 Screenshot_2011-01-01-20-00-58.png

screenshot({params}, callback(ret))

params

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.screenshot({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

backlight

背光灯灯管理

backlight({params}, callback(ret))

params

open:

  • 类型:布尔类型
  • 描述:打开或关闭背光灯
  • 默认:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.backlight({
open:false,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

recovery

恢复出厂设置

recovery({params}, callback(ret))

params

enable:

  • 类型:布尔类型
  • 描述:是否恢复出厂,ture/恢复出厂设置,false/取消恢复出厂
  • 默认:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.recovery({
open:false,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

lockControl

开关锁

lockControl({params}, callback(ret))

params

open:

  • 类型:布尔类型
  • 描述:打开或关闭锁
  • 默认:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.lockControl({
open:false,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

otaupdate

OTA升级

otaupdate({params}, callback(ret))

params

path:

  • 类型:字符串类型
  • 描述:升级包路径,支持fs以及原生路径。

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:,                       //布尔类型,接口是否调用正常
}

err:

  • 类型:JSON 对象
  • 内部字段:
{

    msg: ‘’,           //字符串类型;错误信息
}

示例代码

var lockControler = api.require('lockControler');
lockControler.otaupdate({
path:‘’,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本