Raritan / Server Technology Xerus™ PDU JSON-RPC API
Keypad.idl
1 #ifndef __SMARTLOCK_KEYPAD_IDL__
2 #define __SMARTLOCK_KEYPAD_IDL__
3 
4 #include <Event.idl>
5 
6 /** Keypad */
7 module smartlock {
8 
9  /** Keypad Interface */
10  interface Keypad {
11 
12  /** Error codes */
13  constant int NO_ERROR = 0; ///< operation successful, no error
14  constant int ERR_SLOT_EMPTY = 1; ///< no PIN present in keypad
15 
16  /**
17  * Keypad Metadata
18  */
19  structure MetaData {
20  string id; ///< Keypad ID used in events and traps
21  string manufacturer; ///< manufacturer
22  string product; ///< product
23  string serialNumber; ///< serial number (S/N)
24  int channel; ///< one device (S/N) can provide multiple keypads
25  string position; ///< Position of the keypad.
26  ///< A string, representing the position in the 1-wire topology
27  ///< and the channel of the keypad (e.g. D1:H1:C1-1)
28  };
29 
30  /**
31  * PIN entered event
32  *
33  * A PIN was entered on this Keypad, retrieve it by using getPIN().
34  */
35  valueobject PINEnteredEvent extends idl.Event {
36  MetaData metaData; ///< MetaData of this keypad
37  };
38 
39  /**
40  * Retrieve keypad metadata.
41  *
42  * @return metadata
43  */
45 
46  /**
47  * Retrieve last entered PIN from keypad. PINs are cleared after 10
48  * seconds or subsituted whenever a new PIN was entered.
49  *
50  * @param pin PIN
51  *
52  * @return NO_ERROR if OK
53  * @return ERR_SLOT_EMPTY if keypad sees no PIN
54  */
55  int getPIN(out string pin);
56 
57  };
58 
59 }
60 
61 #endif /* __SMARTLOCK_KEYPAD_IDL__ */
Keypad Interface.
Definition: Keypad.idl:10
int getPIN(out string pin)
Retrieve last entered PIN from keypad.
MetaData getMetaData()
Retrieve keypad metadata.
Basic IDL definitions.
Definition: Event.idl:10
Keypad.
Definition: DoorAccessControl.idl:8
Keypad Metadata.
Definition: Keypad.idl:19
string manufacturer
manufacturer
Definition: Keypad.idl:21
string position
Position of the keypad.
Definition: Keypad.idl:25
string id
Keypad ID used in events and traps.
Definition: Keypad.idl:20
int channel
one device (S/N) can provide multiple keypads
Definition: Keypad.idl:24
string serialNumber
serial number (S/N)
Definition: Keypad.idl:23
string product
product
Definition: Keypad.idl:22