|
| 1 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | +<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | +<head> |
| 4 | +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | +<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | +<meta name="generator" content="Doxygen 1.8.16"/> |
| 7 | +<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | +<title>SinricPro Library: src/SinricProPowerMeter.h Source File</title> |
| 9 | +<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | +<script type="text/javascript" src="jquery.js"></script> |
| 11 | +<script type="text/javascript" src="dynsections.js"></script> |
| 12 | +<link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 13 | +<script type="text/javascript" src="resize.js"></script> |
| 14 | +<script type="text/javascript" src="navtreedata.js"></script> |
| 15 | +<script type="text/javascript" src="navtree.js"></script> |
| 16 | +<script type="text/javascript"> |
| 17 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 18 | + $(document).ready(initResizable); |
| 19 | +/* @license-end */</script> |
| 20 | +<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 21 | +<script type="text/javascript" src="search/searchdata.js"></script> |
| 22 | +<script type="text/javascript" src="search/search.js"></script> |
| 23 | +<script type="text/javascript"> |
| 24 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 25 | + $(document).ready(function() { init_search(); }); |
| 26 | +/* @license-end */ |
| 27 | +</script> |
| 28 | +<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 29 | +</head> |
| 30 | +<body> |
| 31 | +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 32 | +<div id="titlearea"> |
| 33 | +<table cellspacing="0" cellpadding="0"> |
| 34 | + <tbody> |
| 35 | + <tr style="height: 56px;"> |
| 36 | + <td id="projectalign" style="padding-left: 0.5em;"> |
| 37 | + <div id="projectname">SinricPro Library |
| 38 | + </div> |
| 39 | + </td> |
| 40 | + </tr> |
| 41 | + </tbody> |
| 42 | +</table> |
| 43 | +</div> |
| 44 | +<!-- end header part --> |
| 45 | +<!-- Generated by Doxygen 1.8.16 --> |
| 46 | +<script type="text/javascript"> |
| 47 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 48 | +var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 49 | +/* @license-end */ |
| 50 | +</script> |
| 51 | + <div id="navrow1" class="tabs"> |
| 52 | + <ul class="tablist"> |
| 53 | + <li><a href="index.html"><span>Main Page</span></a></li> |
| 54 | + <li><a href="annotated.html"><span>Classes</span></a></li> |
| 55 | + <li> |
| 56 | + <div id="MSearchBox" class="MSearchBoxInactive"> |
| 57 | + <span class="left"> |
| 58 | + <img id="MSearchSelect" src="search/mag_sel.png" |
| 59 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 60 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 61 | + alt=""/> |
| 62 | + <input type="text" id="MSearchField" value="Search" accesskey="S" |
| 63 | + onfocus="searchBox.OnSearchFieldFocus(true)" |
| 64 | + onblur="searchBox.OnSearchFieldFocus(false)" |
| 65 | + onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| 66 | + </span><span class="right"> |
| 67 | + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| 68 | + </span> |
| 69 | + </div> |
| 70 | + </li> |
| 71 | + </ul> |
| 72 | + </div> |
| 73 | +</div><!-- top --> |
| 74 | +<div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 75 | + <div id="nav-tree"> |
| 76 | + <div id="nav-tree-contents"> |
| 77 | + <div id="nav-sync" class="sync"></div> |
| 78 | + </div> |
| 79 | + </div> |
| 80 | + <div id="splitbar" style="-moz-user-select:none;" |
| 81 | + class="ui-resizable-handle"> |
| 82 | + </div> |
| 83 | +</div> |
| 84 | +<script type="text/javascript"> |
| 85 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 86 | +$(document).ready(function(){initNavTree('_sinric_pro_power_meter_8h_source.html','');}); |
| 87 | +/* @license-end */ |
| 88 | +</script> |
| 89 | +<div id="doc-content"> |
| 90 | +<!-- window showing the filter options --> |
| 91 | +<div id="MSearchSelectWindow" |
| 92 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 93 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 94 | + onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 95 | +</div> |
| 96 | + |
| 97 | +<!-- iframe showing the search results (closed by default) --> |
| 98 | +<div id="MSearchResultsWindow"> |
| 99 | +<iframe src="javascript:void(0)" frameborder="0" |
| 100 | + name="MSearchResults" id="MSearchResults"> |
| 101 | +</iframe> |
| 102 | +</div> |
| 103 | + |
| 104 | +<div class="header"> |
| 105 | + <div class="headertitle"> |
| 106 | +<div class="title">SinricProPowerMeter.h</div> </div> |
| 107 | +</div><!--header--> |
| 108 | +<div class="contents"> |
| 109 | +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef _SINRICPOWERMETER_H_</span></div> |
| 110 | +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _SINRICPOWERMETER_H_</span></div> |
| 111 | +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| 112 | +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "SinricProDevice.h"</span></div> |
| 113 | +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div> |
| 114 | +<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="class_sinric_pro_power_sensor.html"> 52</a></span> <span class="keyword">class </span><a class="code" href="class_sinric_pro_power_sensor.html">SinricProPowerSensor</a> : <span class="keyword">public</span> <a class="code" href="class_sinric_pro_device.html">SinricProDevice</a> {</div> |
| 115 | +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">public</span>:</div> |
| 116 | +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="class_sinric_pro_power_sensor.html">SinricProPowerSensor</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* deviceId, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> eventWaitTime=100);</div> |
| 117 | +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// event</span></div> |
| 118 | +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">bool</span> <a class="code" href="class_sinric_pro_power_sensor.html#a6924b8cdd708ead3674671c2f5325de2">sendPowerSensorEvent</a>(<span class="keywordtype">float</span> voltage, <span class="keywordtype">float</span> current, <span class="keywordtype">float</span> power=-1f, <span class="keywordtype">float</span> apparentPower=-1f, <span class="keywordtype">float</span> reactivePower=-1f, <span class="keywordtype">float</span> factor=-1f, String cause = <span class="stringliteral">"PERIODIC_POLL"</span>);</div> |
| 119 | +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">private</span>:</div> |
| 120 | +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> };</div> |
| 121 | +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div> |
| 122 | +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> SinricProPowerSensor::SinricProPowerSensor(<span class="keyword">const</span> <span class="keywordtype">char</span>* deviceId, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> eventWaitTime) : <a class="code" href="class_sinric_pro_device.html">SinricProDevice</a>(deviceId, eventWaitTime) {}</div> |
| 123 | +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div> |
| 124 | +<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="class_sinric_pro_power_sensor.html#a6924b8cdd708ead3674671c2f5325de2"> 75</a></span> <span class="keywordtype">bool</span> <a class="code" href="class_sinric_pro_power_sensor.html#a6924b8cdd708ead3674671c2f5325de2">SinricProPowerSensor::sendPowerSensorEvent</a>(<span class="keywordtype">float</span> voltage, <span class="keywordtype">float</span> current, <span class="keywordtype">float</span> power, <span class="keywordtype">float</span> apparentPower, <span class="keywordtype">float</span> reactivePower, <span class="keywordtype">float</span> factor, String cause) {</div> |
| 125 | +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  DynamicJsonDocument eventMessage = prepareEvent(deviceId, <span class="stringliteral">"devicePowerUsage"</span>, cause.c_str());</div> |
| 126 | +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  JsonObject event_value = eventMessage[<span class="stringliteral">"payload"</span>][<span class="stringliteral">"value"</span>];</div> |
| 127 | +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">if</span> (power == -1) power = voltage * current;</div> |
| 128 | +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">if</span> (apparentPower != -1) factor = power / apparentPower;</div> |
| 129 | +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  event_value[<span class="stringliteral">"voltage"</span>] = voltage;</div> |
| 130 | +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  event_value[<span class="stringliteral">"current"</span>] = current;</div> |
| 131 | +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  event_value[<span class="stringliteral">"power"</span>] = power;</div> |
| 132 | +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  event_value[<span class="stringliteral">"apparentPower"</span>] = apparentPower;</div> |
| 133 | +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  event_value[<span class="stringliteral">"reactivePower"</span>] = reactivePower;</div> |
| 134 | +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  event_value[<span class="stringliteral">"factor"</span>] = factor;</div> |
| 135 | +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> sendEvent(eventMessage);</div> |
| 136 | +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> }</div> |
| 137 | +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> |
| 138 | +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif</span></div> |
| 139 | +</div><!-- fragment --></div><!-- contents --> |
| 140 | +</div><!-- doc-content --> |
| 141 | +<div class="ttc" id="aclass_sinric_pro_power_sensor_html"><div class="ttname"><a href="class_sinric_pro_power_sensor.html">SinricProPowerSensor</a></div><div class="ttdoc">Device to report power usage.</div><div class="ttdef"><b>Definition:</b> SinricProPowerMeter.h:52</div></div> |
| 142 | +<div class="ttc" id="aclass_sinric_pro_power_sensor_html_a6924b8cdd708ead3674671c2f5325de2"><div class="ttname"><a href="class_sinric_pro_power_sensor.html#a6924b8cdd708ead3674671c2f5325de2">SinricProPowerSensor::sendPowerSensorEvent</a></div><div class="ttdeci">bool sendPowerSensorEvent(float voltage, float current, float power=-1f, float apparentPower=-1f, float reactivePower=-1f, float factor=-1f, String cause="PERIODIC_POLL")</div><div class="ttdoc">Send PowerSensor event to SinricPro Server.</div><div class="ttdef"><b>Definition:</b> SinricProPowerMeter.h:75</div></div> |
| 143 | +<div class="ttc" id="aclass_sinric_pro_device_html"><div class="ttname"><a href="class_sinric_pro_device.html">SinricProDevice</a></div><div class="ttdoc">Base class for all device types.</div><div class="ttdef"><b>Definition:</b> SinricProDevice.h:23</div></div> |
| 144 | +<!-- start footer part --> |
| 145 | +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 146 | + <ul> |
| 147 | + <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>SinricProPowerMeter.h</b></li> |
| 148 | + <li class="footer">Generated by |
| 149 | + <a href="http://www.doxygen.org/index.html"> |
| 150 | + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li> |
| 151 | + </ul> |
| 152 | +</div> |
| 153 | +</body> |
| 154 | +</html> |
0 commit comments