File: interfaceproduction_1_1Production.html

package info (click to toggle)
raritan-json-rpc-sdk 3.6.1%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 41,748 kB
  • sloc: cs: 162,629; perl: 85,818; python: 24,275; javascript: 5,937; makefile: 21
file content (158 lines) | stat: -rw-r--r-- 8,143 bytes parent folder | download
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
<!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: production::Production 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 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&amp;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&amp;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="namespaceproduction.html">production</a></li><li class="navelem"><a class="el" href="interfaceproduction_1_1Production.html">Production</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interfaceproduction_1_1Production-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">production::Production Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Methods used during production.  
 <a href="interfaceproduction_1_1Production.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="Production_8idl_source.html">Production.idl</a>&quot;;</code></p>
<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:af3b1bc44fa67e48c24c9de5b5cf57a6b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceproduction_1_1Production.html#af3b1bc44fa67e48c24c9de5b5cf57a6b">enterFactoryConfigMode</a> (in string password)</td></tr>
<tr class="memdesc:af3b1bc44fa67e48c24c9de5b5cf57a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enter factory configuration mode.  <a href="#af3b1bc44fa67e48c24c9de5b5cf57a6b">More...</a><br /></td></tr>
<tr class="separator:af3b1bc44fa67e48c24c9de5b5cf57a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3063c3085b4d2d32cde65845ca854e10"><td class="memItemLeft" align="right" valign="top"><a id="a3063c3085b4d2d32cde65845ca854e10"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceproduction_1_1Production.html#a3063c3085b4d2d32cde65845ca854e10">leaveFactoryConfigMode</a> ()</td></tr>
<tr class="memdesc:a3063c3085b4d2d32cde65845ca854e10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Leave factory configuration mode. <br /></td></tr>
<tr class="separator:a3063c3085b4d2d32cde65845ca854e10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac87385d51cba886a441ae0b30ca19494"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceproduction_1_1Production.html#ac87385d51cba886a441ae0b30ca19494">isFactoryConfigModeEnabled</a> ()</td></tr>
<tr class="memdesc:ac87385d51cba886a441ae0b30ca19494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether device is in factory configuration mode.  <a href="#ac87385d51cba886a441ae0b30ca19494">More...</a><br /></td></tr>
<tr class="separator:ac87385d51cba886a441ae0b30ca19494"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Methods used during production. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af3b1bc44fa67e48c24c9de5b5cf57a6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3b1bc44fa67e48c24c9de5b5cf57a6b">&#9670;&nbsp;</a></span>enterFactoryConfigMode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int production::Production::enterFactoryConfigMode </td>
          <td>(</td>
          <td class="paramtype">in string&#160;</td>
          <td class="paramname"><em>password</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enter factory configuration mode. </p>
<p>This mode unlocks several features which should only be available during production, e.g. the RS485 address assignment or sensor calibration. Factory configuration mode will be enabled until the next reboot or until <a class="el" href="interfaceproduction_1_1Production.html#a3063c3085b4d2d32cde65845ca854e10" title="Leave factory configuration mode. ">leaveFactoryConfigMode</a> is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">password</td><td>Password required to enter factory config mdoe.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the password is wrong </dd></dl>

</div>
</div>
<a id="ac87385d51cba886a441ae0b30ca19494"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac87385d51cba886a441ae0b30ca19494">&#9670;&nbsp;</a></span>isFactoryConfigModeEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean production::Production::isFactoryConfigModeEnabled </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check whether device is in factory configuration mode. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if factory configuration mode is enabled </dd></dl>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="Production_8idl_source.html">Production.idl</a></li>
</ul>
</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>