smartlock::Keypad Interface Reference

Keypad Interface. More...

import"Keypad.idl";

Classes
struct	MetaData
	Keypad Metadata. More...

Public Member Functions
MetaData	getMetaData ()
	Retrieve keypad metadata. More...
int	getPIN (out string pin)
	Retrieve last entered PIN from keypad. More...

Public Attributes
constant int	NO_ERROR = 0
	Error codes. More...
constant int	ERR_SLOT_EMPTY = 1
	no PIN present in keypad
valueobject	PINEnteredEvent: idl::Event { MetaData metaData
	PIN entered event. More...

Detailed Description

Keypad Interface.

Member Function Documentation

getMetaData()

MetaData smartlock::Keypad::getMetaData

(

)

Retrieve keypad metadata.

Returns

metadata

getPIN()

int smartlock::Keypad::getPIN

(

out string

pin

)

Retrieve last entered PIN from keypad.

PINs are cleared after 10 seconds or subsituted whenever a new PIN was entered.

Parameters

pin

PIN

Returns

NO_ERROR if OK

ERR_SLOT_EMPTY if keypad sees no PIN

Member Data Documentation

NO_ERROR

constant int smartlock::Keypad::NO_ERROR = 0

Error codes.

operation successful, no error

PINEnteredEvent

valueobject smartlock::Keypad::PINEnteredEvent

PIN entered event.

A PIN was entered on this Keypad, retrieve it by using getPIN(). MetaData of this keypad

---

The documentation for this interface was generated from the following file:

• Keypad.idl