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
|
<!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: zigbee::ZigbeeDevice 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="namespacezigbee.html">zigbee</a></li><li class="navelem"><a class="el" href="interfacezigbee_1_1ZigbeeDevice.html">ZigbeeDevice</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="#pub-attribs">Public Attributes</a> |
<a href="interfacezigbee_1_1ZigbeeDevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">zigbee::ZigbeeDevice Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Zigbee Device.
<a href="interfacezigbee_1_1ZigbeeDevice.html#details">More...</a></p>
<p><code>import"<a class="el" href="ZigbeeDevice_8idl_source.html">ZigbeeDevice.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="structzigbee_1_1ZigbeeDevice_1_1ClusterDataEvent.html">ClusterDataEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Cluster Value Changed Event. <a href="structzigbee_1_1ZigbeeDevice_1_1ClusterDataEvent.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="structzigbee_1_1ZigbeeDevice_1_1ClusterValue.html">ClusterValue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Cluster Value. <a href="structzigbee_1_1ZigbeeDevice_1_1ClusterValue.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="structzigbee_1_1ZigbeeDevice_1_1MetaData.html">MetaData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Device <a class="el" href="structzigbee_1_1ZigbeeDevice_1_1MetaData.html" title="Device MetaData.">MetaData</a>. <a href="structzigbee_1_1ZigbeeDevice_1_1MetaData.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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a945e9b1084548c1fbdb81755c3fadb3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structzigbee_1_1ZigbeeDevice_1_1MetaData.html">MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacezigbee_1_1ZigbeeDevice.html#a945e9b1084548c1fbdb81755c3fadb3a">getMetaData</a> ()</td></tr>
<tr class="memdesc:a945e9b1084548c1fbdb81755c3fadb3a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve Dongle <a class="el" href="structzigbee_1_1ZigbeeDevice_1_1MetaData.html" title="Device MetaData.">MetaData</a>. <a href="interfacezigbee_1_1ZigbeeDevice.html#a945e9b1084548c1fbdb81755c3fadb3a">More...</a><br /></td></tr>
<tr class="separator:a945e9b1084548c1fbdb81755c3fadb3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a767406864e5a0dd83d3740e7616792d3"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structzigbee_1_1ZigbeeDevice_1_1ClusterValue.html">ClusterValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacezigbee_1_1ZigbeeDevice.html#a767406864e5a0dd83d3740e7616792d3">getClusterValues</a> ()</td></tr>
<tr class="memdesc:a767406864e5a0dd83d3740e7616792d3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the last cluster values Needed for battery voltage (only reported all 12h) <a href="interfacezigbee_1_1ZigbeeDevice.html#a767406864e5a0dd83d3740e7616792d3">More...</a><br /></td></tr>
<tr class="separator:a767406864e5a0dd83d3740e7616792d3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab1ec97f26ff6ad9fb58843aa31c37fb1"><td class="memItemLeft" align="right" valign="top"><a id="ab1ec97f26ff6ad9fb58843aa31c37fb1"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacezigbee_1_1ZigbeeDevice.html#ab1ec97f26ff6ad9fb58843aa31c37fb1">CLUSTER_BASIC</a> = 0x0000</td></tr>
<tr class="memdesc:ab1ec97f26ff6ad9fb58843aa31c37fb1"><td class="mdescLeft"> </td><td class="mdescRight">Supported Cluster Types defined by zigbee alliance in the zigbee cluster library specification. <br /></td></tr>
<tr class="separator:ab1ec97f26ff6ad9fb58843aa31c37fb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2a4786e95d890ba0bab0c48841a32ea"><td class="memItemLeft" align="right" valign="top"><a id="ac2a4786e95d890ba0bab0c48841a32ea"></a>
constant int </td><td class="memItemRight" valign="bottom"><b>CLUSTER_POWER_CONFIGURATION</b> = 0x0001</td></tr>
<tr class="separator:ac2a4786e95d890ba0bab0c48841a32ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2773ed8ddac8e58ee68959ab8f3d1fb2"><td class="memItemLeft" align="right" valign="top"><a id="a2773ed8ddac8e58ee68959ab8f3d1fb2"></a>
constant int </td><td class="memItemRight" valign="bottom"><b>CLUSTER_RSSI</b> = 0x000B</td></tr>
<tr class="separator:a2773ed8ddac8e58ee68959ab8f3d1fb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15b1814b6ba64ce46f25e7c089cb232d"><td class="memItemLeft" align="right" valign="top"><a id="a15b1814b6ba64ce46f25e7c089cb232d"></a>
constant int </td><td class="memItemRight" valign="bottom"><b>CLUSTER_CONTACT_CLOSURE</b> = 0x000F</td></tr>
<tr class="separator:a15b1814b6ba64ce46f25e7c089cb232d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a764cecef7b49cf01fc4eab2629ad3f28"><td class="memItemLeft" align="right" valign="top"><a id="a764cecef7b49cf01fc4eab2629ad3f28"></a>
constant int </td><td class="memItemRight" valign="bottom"><b>CLUSTER_TEMPERATURE</b> = 0x0402</td></tr>
<tr class="separator:a764cecef7b49cf01fc4eab2629ad3f28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52d1a11ae56c7aeb7ab524103342a9fd"><td class="memItemLeft" align="right" valign="top"><a id="a52d1a11ae56c7aeb7ab524103342a9fd"></a>
constant int </td><td class="memItemRight" valign="bottom"><b>CLUSTER_HUMIDITY</b> = 0x0405</td></tr>
<tr class="separator:a52d1a11ae56c7aeb7ab524103342a9fd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Zigbee Device. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a767406864e5a0dd83d3740e7616792d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a767406864e5a0dd83d3740e7616792d3">◆ </a></span>getClusterValues()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structzigbee_1_1ZigbeeDevice_1_1ClusterValue.html">ClusterValue</a>> zigbee::ZigbeeDevice::getClusterValues </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the last cluster values Needed for battery voltage (only reported all 12h) </p>
<dl class="section return"><dt>Returns</dt><dd>list of all cluster values currently reported </dd></dl>
</div>
</div>
<a id="a945e9b1084548c1fbdb81755c3fadb3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a945e9b1084548c1fbdb81755c3fadb3a">◆ </a></span>getMetaData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structzigbee_1_1ZigbeeDevice_1_1MetaData.html">MetaData</a> zigbee::ZigbeeDevice::getMetaData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve Dongle <a class="el" href="structzigbee_1_1ZigbeeDevice_1_1MetaData.html" title="Device MetaData.">MetaData</a>. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structzigbee_1_1ZigbeeDevice_1_1MetaData.html" title="Device MetaData.">MetaData</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="ZigbeeDevice_8idl_source.html">ZigbeeDevice.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>
|