1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan / Server Technology Xerus™ PDU JSON-RPC API: smartlock::KeypadManager Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan / Server Technology Xerus™ PDU JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesmartlock.html">smartlock</a></li><li class="navelem"><a class="el" href="interfacesmartlock_1_1KeypadManager.html">KeypadManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="interfacesmartlock_1_1KeypadManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">smartlock::KeypadManager Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="interfacesmartlock_1_1Keypad.html" title="Keypad Interface.">Keypad</a> Manager Interface.
<a href="interfacesmartlock_1_1KeypadManager.html#details">More...</a></p>
<p><code>import"<a class="el" href="KeypadManager_8idl_source.html">KeypadManager.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadAttachedEvent.html">KeypadAttachedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="interfacesmartlock_1_1Keypad.html" title="Keypad Interface.">Keypad</a> attached event. <a href="structsmartlock_1_1KeypadManager_1_1KeypadAttachedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadDetachedEvent.html">KeypadDetachedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="interfacesmartlock_1_1Keypad.html" title="Keypad Interface.">Keypad</a> detached event. <a href="structsmartlock_1_1KeypadManager_1_1KeypadDetachedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadEvent.html">KeypadEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="interfacesmartlock_1_1Keypad.html" title="Keypad Interface.">Keypad</a> base event. <a href="structsmartlock_1_1KeypadManager_1_1KeypadEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadSettings.html">KeypadSettings</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadSettingsChangedEvent.html">KeypadSettingsChangedEvent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aecc2d69e1434b503d239e51882c63289"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="interfacesmartlock_1_1Keypad.html">Keypad</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1KeypadManager.html#aecc2d69e1434b503d239e51882c63289">getKeypads</a> ()</td></tr>
<tr class="memdesc:aecc2d69e1434b503d239e51882c63289"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the list of connected keypads. <a href="interfacesmartlock_1_1KeypadManager.html#aecc2d69e1434b503d239e51882c63289">More...</a><br /></td></tr>
<tr class="separator:aecc2d69e1434b503d239e51882c63289"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d9c42206b5b65edb48055d50777e059"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacesmartlock_1_1Keypad.html">Keypad</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1KeypadManager.html#a4d9c42206b5b65edb48055d50777e059">getKeypadById</a> (in string keypadId)</td></tr>
<tr class="memdesc:a4d9c42206b5b65edb48055d50777e059"><td class="mdescLeft"> </td><td class="mdescRight">Get keypad for a specific id. <a href="interfacesmartlock_1_1KeypadManager.html#a4d9c42206b5b65edb48055d50777e059">More...</a><br /></td></tr>
<tr class="separator:a4d9c42206b5b65edb48055d50777e059"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e3623e4aef07bdaef8054094030c283"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1KeypadManager.html#a0e3623e4aef07bdaef8054094030c283">setKeypadSettings</a> (in string position, in <a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadSettings.html">KeypadSettings</a> setting)</td></tr>
<tr class="memdesc:a0e3623e4aef07bdaef8054094030c283"><td class="mdescLeft"> </td><td class="mdescRight">Set settings for a keypad. <a href="interfacesmartlock_1_1KeypadManager.html#a0e3623e4aef07bdaef8054094030c283">More...</a><br /></td></tr>
<tr class="separator:a0e3623e4aef07bdaef8054094030c283"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bdd93ed48e564392014e7ede96e4d01"><td class="memItemLeft" align="right" valign="top">map< string, <a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadSettings.html">KeypadSettings</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1KeypadManager.html#a7bdd93ed48e564392014e7ede96e4d01">getAllKeypadSettings</a> ()</td></tr>
<tr class="memdesc:a7bdd93ed48e564392014e7ede96e4d01"><td class="mdescLeft"> </td><td class="mdescRight">Get settings for all keypads. <a href="interfacesmartlock_1_1KeypadManager.html#a7bdd93ed48e564392014e7ede96e4d01">More...</a><br /></td></tr>
<tr class="separator:a7bdd93ed48e564392014e7ede96e4d01"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="interfacesmartlock_1_1Keypad.html" title="Keypad Interface.">Keypad</a> Manager Interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a7bdd93ed48e564392014e7ede96e4d01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bdd93ed48e564392014e7ede96e4d01">◆ </a></span>getAllKeypadSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">map<string, <a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadSettings.html">KeypadSettings</a>> smartlock::KeypadManager::getAllKeypadSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get settings for all keypads. </p>
<dl class="section return"><dt>Returns</dt><dd>Map of settings by keypad position (see <a class="el" href="structsmartlock_1_1Keypad_1_1MetaData.html" title="Keypad Metadata.">Keypad::MetaData</a>) </dd></dl>
</div>
</div>
<a id="a4d9c42206b5b65edb48055d50777e059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d9c42206b5b65edb48055d50777e059">◆ </a></span>getKeypadById()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacesmartlock_1_1Keypad.html">Keypad</a> smartlock::KeypadManager::getKeypadById </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>keypadId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get keypad for a specific id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keypadId</td><td>keypad id</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="interfacesmartlock_1_1Keypad.html" title="Keypad Interface.">Keypad</a> with given id or null </dd></dl>
</div>
</div>
<a id="aecc2d69e1434b503d239e51882c63289"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecc2d69e1434b503d239e51882c63289">◆ </a></span>getKeypads()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="interfacesmartlock_1_1Keypad.html">Keypad</a>> smartlock::KeypadManager::getKeypads </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the list of connected keypads. </p>
<dl class="section return"><dt>Returns</dt><dd>Keypads list </dd></dl>
</div>
</div>
<a id="a0e3623e4aef07bdaef8054094030c283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e3623e4aef07bdaef8054094030c283">◆ </a></span>setKeypadSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int smartlock::KeypadManager::setKeypadSettings </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structsmartlock_1_1KeypadManager_1_1KeypadSettings.html">KeypadSettings</a> </td>
<td class="paramname"><em>setting</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set settings for a keypad. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>position of keypad (see <a class="el" href="structsmartlock_1_1Keypad_1_1MetaData.html" title="Keypad Metadata.">Keypad::MetaData</a>) </td></tr>
<tr><td class="paramname">settings</td><td>new settings for keypad</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if OK </dd>
<dd>
ERR_INVALID_PARAMS if any setting is invalid </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="KeypadManager_8idl_source.html">KeypadManager.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
