智能门锁接口(初稿).doc

智能门锁Firmware 二次开发SDK接口（初稿）
一、 概述
智能门锁Firmware二次开发SDK接口，指的是在智能门锁生产厂家成熟的产品基础上，产品的Firmware中定义出一些软件接口，形成二次开发的软件SDK包，供客户做二次开发，以实现客户自定义的功能，或改变原产品的一些具体功能。
接口函数分为一般函数和事件函数两种。一般函数接口，函数体是在SDK包中定义的，由二次开发的上层应用来调用；事件函数接口，函数体公开，在SDK包中调用，二次开发可以修改代码，以实现事件的响应及处理。
注：以下，除注明是事件函数接口外，均为一般函数接口。
二、 接口
【函数原型】 1
void StateChangeEvent(unsigned char state)
【输入参数】
state锁的状态值。状态值指各检测开关，如锁舌检测开关、反锁检测开关等的状态（指对应的检测开关的状态，即开或关）值。
按位表示：
bit0 锁舌检测开关
bit1 反锁检测开关
bit2 门开合检测开关
…
【返回值】 无
【说明】
事件函数，当锁的状态有改变时被调用。二次开发客户可在此函数体中编写代码，实现事件响应。

【函数原型】 2
unsigned char GetState()
【输入参数】 无
【返回值】
锁的状态值。状态值的定义参考【函数原型】1的参数state。
【说明】
查询锁的当前状态。

【函数原型】 3
void LockKeyboard()
【输入参数】 无
【返回值】 无
【说明】
锁住键盘。关闭键盘及背光，此时按键无反应。

【函数原型】 4
void UnlockKeyboard()
【输入参数】 无
【返回值】 无
【说明】
键盘解锁。打开键盘及背光功能。
查询锁的当前状态。

【函数原型】 5
void LockRF()
【输入参数】 无
【返回值】 无
【说明】
锁住RF刷卡响应。关闭射频，使刷卡无反应。

【函数原型】 6
void UnlockRF()
【输入参数】 无
【返回值】 无
【说明】
RF解锁，刷卡功能正常。

【函数原型】 7
int Open(unsigned char type)
【输入参数】
type 开锁类型。1：打开锁舌；2：打开锁舌和反锁闩；
【返回值】
返回开锁是否成功，0表示成功，-1表示失败。
【说明】
开锁。

【函数原型】 8
void KeyPressEvent(char keyValue)
【输入参数】
keyValue 按键值（ASCII码）
【返回值】 无
【说明】
事件函数，当有按键时被调用。

【函数原型】 9
void CardOnEventunsigned char *cardID)
【输入参数】
cardID 卡ID数据指针，数据长度为4字节。
【返回值】 无
【说明】
事件函数，当选择一张卡时调用。

【函数原型】 10
int Authentication(unsigned char section, unsigned char *keyA, unsigned char *keyB)
【输入参数】
section 操作扇区，0-15。
*keyA/*keyB 密钥参数指针，数据长度都为6字节。
【返回值】
0表示验证成功，-1表示验证失败。
【说明】
对指定的扇区进行密钥认证。

【函数原型】 11
int Read(unsigned char block, unsigned char *data)
【输入参数】
block 块，0-3。
*data 数据块指针，数据长度16字节。
【返回值】
0表示读取成功，-1表示失败。
【说明】
读取当前已认证的扇区的指定块。

【函数原型】 12
int Write(unsigned char block, unsigned char *data)
【输入参数】
block 块，0-3。
*data 数据块指针，数据长度16字节。
【返回值】
0表示写入成功，-1表示失败。
【说明】
写入当前已认证的扇区的指定块。

【函数原型】 13
void BLOn()
【输入参数】 无
【返回值】 无
【说明】
打开背光。

【函数原型】 14
void BLOff()
【输入参数】 无
【返回值】 无
【说明】
关闭背光。

【函数原型】 15
void Tick()
【输入参数】 无
【返回值】 无
【说明】
事件函数，每100ms系统唤醒时调用。

【函数原型】 16
void Alarm(unsigned char type)
【输入参数】
type 类型。
1：开锁成功提示
2：操作成功提示
3：操作失败提示
4：门未锁好提示
5：门开着提示
6：严重警告警报
…
【返回值】 无
【说明】
声光警示。

【函数原型】 17
unsigned char* GetDateTime()
【输入参数】 无
【返回值】
时间数据的指针。时间数据格式：2字节年值、1字节月值、1字节日值、1字节时值（24小时制）、1字节分值、1字节秒值，共7字节。
【说明】
返回当前实时时钟的年月日时分秒值。

【函数原型】 18
int SetDateTime(unsigned char *data)
【输入参数】
*data 数据块指针，数据长度7字节，分别为2字节年值、1字节月值、1字节日值、1字节时值（24小时制）、1字节分值、1字节秒值。
【返回值】
0表示设置成功，-1表示失败。
【说明】
设置当前的日期及时间。

【函数原型】 19
int SetLevel(unsigned char level)
【输入参数】
level CPU运行效能级别。
1：正常；
2：高速运行；
…
【返回值】 无
【说明】
设置当前的CPU运行效能级别。