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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: peripheral Module 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 PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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');
/* @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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">peripheral Module Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Peripheral Devices.
<a href="#details">More...</a></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="structperipheral_1_1Address__4__0__0.html">Address_4_0_0</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">peripheral device position based address <a href="structperipheral_1_1Address__4__0__0.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="structperipheral_1_1DeviceID__4__0__0.html">DeviceID_4_0_0</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">peripheral device identification <a href="structperipheral_1_1DeviceID__4__0__0.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">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceperipheral_1_1DeviceManager__3__0__2.html">DeviceManager_3_0_2</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral Device Manager. <a href="interfaceperipheral_1_1DeviceManager__3__0__2.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">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceperipheral_1_1DeviceSlot__2__0__3.html">DeviceSlot_2_0_3</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral Device Slot. <a href="interfaceperipheral_1_1DeviceSlot__2__0__3.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">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceperipheral_1_1DoorHandleControllerPackage__1__0__1.html">DoorHandleControllerPackage_1_0_1</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceperipheral_1_1G2Production__4__0__0.html">G2Production_4_0_0</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceperipheral_1_1Package__1__0__1.html">Package_1_0_1</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="structperipheral_1_1PackageInfo__2__0__1.html">PackageInfo_2_0_1</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral device package information. <a href="structperipheral_1_1PackageInfo__2__0__1.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="structperipheral_1_1PosElement.html">PosElement</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">peripheral device position element, list forms position <a href="structperipheral_1_1PosElement.html#details">More...</a><br /></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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a9ad7bdf5476bfadd050f845b22dddc1e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceperipheral.html#a9ad7bdf5476bfadd050f845b22dddc1e">PortType</a> { <a class="el" href="namespaceperipheral.html#a9ad7bdf5476bfadd050f845b22dddc1ea358f3667bb0d63f2427e7fb5728fdc07">ONEWIRE_ONBOARD</a>,
<a class="el" href="namespaceperipheral.html#a9ad7bdf5476bfadd050f845b22dddc1ea80b604a9ac59ad82561855d98c89d766">ONEWIRE_DEV_PORT</a>,
<a class="el" href="namespaceperipheral.html#a9ad7bdf5476bfadd050f845b22dddc1ea609cb04846265710e4a35ce7c1bd38fe">ONEWIRE_HUB_PORT</a>,
<a class="el" href="namespaceperipheral.html#a9ad7bdf5476bfadd050f845b22dddc1ea722610127bcaf77fbe029a0a0a951ba0">ONEWIRE_CHAIN_POS</a>
}</td></tr>
<tr class="memdesc:a9ad7bdf5476bfadd050f845b22dddc1e"><td class="mdescLeft"> </td><td class="mdescRight">peripheral device port types <a href="namespaceperipheral.html#a9ad7bdf5476bfadd050f845b22dddc1e">More...</a><br /></td></tr>
<tr class="separator:a9ad7bdf5476bfadd050f845b22dddc1e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a1ce8ecd2ccbe8d1b264b7f0a22b98743"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceperipheral.html#a1ce8ecd2ccbe8d1b264b7f0a22b98743">Device_3_0_2</a></td></tr>
<tr class="memdesc:a1ce8ecd2ccbe8d1b264b7f0a22b98743"><td class="mdescLeft"> </td><td class="mdescRight">A peripheral device is the collection of. <a href="#a1ce8ecd2ccbe8d1b264b7f0a22b98743">More...</a><br /></td></tr>
<tr class="separator:a1ce8ecd2ccbe8d1b264b7f0a22b98743"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bde9f429b8d65f686ac23663ecaa76b"><td class="memItemLeft" align="right" valign="top"><a id="a1bde9f429b8d65f686ac23663ecaa76b"></a>
vector< <a class="el" href="structperipheral_1_1PosElement.html">PosElement</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceperipheral.html#a1bde9f429b8d65f686ac23663ecaa76b">position</a></td></tr>
<tr class="memdesc:a1bde9f429b8d65f686ac23663ecaa76b"><td class="mdescLeft"> </td><td class="mdescRight">Position within 1-wire topo. <br /></td></tr>
<tr class="separator:a1bde9f429b8d65f686ac23663ecaa76b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b5b14f7ef35c91fdec9a142752c19fd"><td class="memItemLeft" align="right" valign="top"><a id="a8b5b14f7ef35c91fdec9a142752c19fd"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceperipheral.html#a8b5b14f7ef35c91fdec9a142752c19fd">packageClass</a></td></tr>
<tr class="memdesc:a8b5b14f7ef35c91fdec9a142752c19fd"><td class="mdescLeft"> </td><td class="mdescRight">physical package identifier <br /></td></tr>
<tr class="separator:a8b5b14f7ef35c91fdec9a142752c19fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4df15591fb36536bf344a32cdaa8ad22"><td class="memItemLeft" align="right" valign="top"><a id="a4df15591fb36536bf344a32cdaa8ad22"></a>
<a class="el" href="interfacesensors_1_1Sensor__4__0__3.html">sensors::Sensor_4_0_3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceperipheral.html#a4df15591fb36536bf344a32cdaa8ad22">device</a></td></tr>
<tr class="memdesc:a4df15591fb36536bf344a32cdaa8ad22"><td class="mdescLeft"> </td><td class="mdescRight">device reference <br /></td></tr>
<tr class="separator:a4df15591fb36536bf344a32cdaa8ad22"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Peripheral Devices. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a9ad7bdf5476bfadd050f845b22dddc1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ad7bdf5476bfadd050f845b22dddc1e">◆ </a></span>PortType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceperipheral.html#a9ad7bdf5476bfadd050f845b22dddc1e">peripheral::PortType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>peripheral device port types </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9ad7bdf5476bfadd050f845b22dddc1ea358f3667bb0d63f2427e7fb5728fdc07"></a>ONEWIRE_ONBOARD </td><td class="fielddoc"><p>a built in, inaccessible port </p>
</td></tr>
<tr><td class="fieldname"><a id="a9ad7bdf5476bfadd050f845b22dddc1ea80b604a9ac59ad82561855d98c89d766"></a>ONEWIRE_DEV_PORT </td><td class="fielddoc"><p>a 1-wire port on the device </p>
</td></tr>
<tr><td class="fieldname"><a id="a9ad7bdf5476bfadd050f845b22dddc1ea609cb04846265710e4a35ce7c1bd38fe"></a>ONEWIRE_HUB_PORT </td><td class="fielddoc"><p>a port on a Hub </p>
</td></tr>
<tr><td class="fieldname"><a id="a9ad7bdf5476bfadd050f845b22dddc1ea722610127bcaf77fbe029a0a0a951ba0"></a>ONEWIRE_CHAIN_POS </td><td class="fielddoc"><p>a chain position </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a1ce8ecd2ccbe8d1b264b7f0a22b98743"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ce8ecd2ccbe8d1b264b7f0a22b98743">◆ </a></span>Device_3_0_2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject peripheral::Device_3_0_2</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div><div class="line"> DeviceID_4_0_0 deviceID</div></div><!-- fragment -->
<p>A peripheral device is the collection of. </p>
<ul>
<li>device identification</li>
<li>device position</li>
<li>a flag indicating actuator type</li>
<li>device referencedevice identification </li>
</ul>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
