Skip to content

Commit a938a74

Browse files
sivar2311sivar2311
committed
Updated: changelog and documentation
1 parent b454578 commit a938a74

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+610
-544
lines changed

‎changelog.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Changelog
22

33
## Version 2.4.0
4+
New:
5+
- Devices
6+
- PowerSensor
7+
8+
- Examples
9+
- PowerSensor
410

511
## Version 2.3.0
612
New:

‎docs/_sinric_pro_8h_source.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@
161161
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// setResponseMessage is is just a workaround until verison 3.x.x will be released</span></div>
162162
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">void</span> setResponseMessage(String &amp;&amp;message) { responseMessageStr = message; }</div>
163163
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
164-
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="class_sinric_pro_class.html#a346ead912467405403ad23bad8da1e60"> 95</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_sinric_pro_class.html#a346ead912467405403ad23bad8da1e60">getTimestamp</a>() { <span class="keywordflow">return</span> baseTimestamp + (millis()/1000); }</div>
164+
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="class_sinric_pro_class.html#afb2be26eef972203404140612fa31326"> 95</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_sinric_pro_class.html#afb2be26eef972203404140612fa31326">getTimestamp</a>()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> baseTimestamp + (millis()/1000); }</div>
165165
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">private</span>:</div>
166166
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordtype">void</span> handleReceiveQueue();</div>
167167
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">void</span> handleSendQueue();</div>
@@ -402,7 +402,7 @@
402402
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; </div>
403403
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160; DynamicJsonDocument jsonMessage(1024);</div>
404404
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160; deserializeJson(jsonMessage, rawMessage-&gt;getMessage());</div>
405-
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160; jsonMessage[<span class="stringliteral">&quot;payload&quot;</span>][<span class="stringliteral">&quot;createdAt&quot;</span>] = <a class="code" href="class_sinric_pro_class.html#a346ead912467405403ad23bad8da1e60">getTimestamp</a>();</div>
405+
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160; jsonMessage[<span class="stringliteral">&quot;payload&quot;</span>][<span class="stringliteral">&quot;createdAt&quot;</span>] = <a class="code" href="class_sinric_pro_class.html#afb2be26eef972203404140612fa31326">getTimestamp</a>();</div>
406406
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160; signMessage(signingKey, jsonMessage);</div>
407407
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160; </div>
408408
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160; String messageStr;</div>
@@ -570,9 +570,9 @@
570570
</div><!-- doc-content -->
571571
<div class="ttc" id="aclass_sinric_pro_class_html_ac33a355adfc413d4ff36974d735115bd"><div class="ttname"><a href="class_sinric_pro_class.html#ac33a355adfc413d4ff36974d735115bd">SinricProClass::onConnected</a></div><div class="ttdeci">void onConnected(ConnectedCallbackHandler cb)</div><div class="ttdoc">Set callback function for websocket connected event.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:427</div></div>
572572
<div class="ttc" id="aclass_sinric_pro_class_html_a37c2d0658e498b1bf878f8a3d9a7c5b4"><div class="ttname"><a href="class_sinric_pro_class.html#a37c2d0658e498b1bf878f8a3d9a7c5b4">SinricProClass::handle</a></div><div class="ttdeci">void handle()</div><div class="ttdoc">Handles communication between device and SinricPro Server.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:244</div></div>
573+
<div class="ttc" id="aclass_sinric_pro_class_html_afb2be26eef972203404140612fa31326"><div class="ttname"><a href="class_sinric_pro_class.html#afb2be26eef972203404140612fa31326">SinricProClass::getTimestamp</a></div><div class="ttdeci">unsigned long getTimestamp() override</div><div class="ttdoc">Get the current timestamp.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:95</div></div>
573574
<div class="ttc" id="aclass_sinric_pro_class_html_a654bb017ca55b448d55bb36e0346f38a"><div class="ttname"><a href="class_sinric_pro_class.html#a654bb017ca55b448d55bb36e0346f38a">SinricProClass::onDisconnected</a></div><div class="ttdeci">void onDisconnected(DisconnectedCallbackHandler cb)</div><div class="ttdoc">Set callback function for websocket disconnected event.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:440</div></div>
574575
<div class="ttc" id="aclass_sinric_pro_class_html_a27a9bb7f1e8bde0f39398649493b6f93"><div class="ttname"><a href="class_sinric_pro_class.html#a27a9bb7f1e8bde0f39398649493b6f93">SinricProClass::restoreDeviceStates</a></div><div class="ttdeci">void restoreDeviceStates(bool flag)</div><div class="ttdoc">Enable / disable restore device states function.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:510</div></div>
575-
<div class="ttc" id="aclass_sinric_pro_class_html_a346ead912467405403ad23bad8da1e60"><div class="ttname"><a href="class_sinric_pro_class.html#a346ead912467405403ad23bad8da1e60">SinricProClass::getTimestamp</a></div><div class="ttdeci">unsigned long getTimestamp()</div><div class="ttdoc">Get the current timestamp.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:95</div></div>
576576
<div class="ttc" id="aclass_sinric_pro_class_html_ad84930f3c26ac3692cc885be197d39c7"><div class="ttname"><a href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">SinricProClass::DisconnectedCallbackHandler</a></div><div class="ttdeci">std::function&lt; void(void)&gt; DisconnectedCallbackHandler</div><div class="ttdoc">Callback definition for onDisconnected function.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:50</div></div>
577577
<div class="ttc" id="aclass_sinric_pro_class_html_a5df2137b8d06e894c917fd28c35c31a4"><div class="ttname"><a href="class_sinric_pro_class.html#a5df2137b8d06e894c917fd28c35c31a4">SinricProClass::operator[]</a></div><div class="ttdeci">proxy operator[](const String deviceId)</div><div class="ttdoc">operator[] is used tor create a new device instance or get an existing device instance</div><div class="ttdef"><b>Definition:</b> SinricPro.h:85</div></div>
578578
<div class="ttc" id="aclass_sinric_pro_class_html_a57722dec8f1f987f57c8fff9eed66765"><div class="ttname"><a href="class_sinric_pro_class.html#a57722dec8f1f987f57c8fff9eed66765">SinricProClass::begin</a></div><div class="ttdeci">void begin(String socketAuthToken, String signingKey, String serverURL=SINRICPRO_SERVER_URL)</div><div class="ttdoc">Initializing SinricProClass to be able to connect to SinricPro Server.</div><div class="ttdef"><b>Definition:</b> SinricPro.h:177</div></div>

‎docs/_sinric_pro_config_8h_source.html

+18-17
Original file line numberDiff line numberDiff line change
@@ -132,29 +132,30 @@
132132
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
133133
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// Version Configuration</span></div>
134134
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_MAJOR 2</span></div>
135-
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_MINOR 3</span></div>
135+
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_MINOR 4</span></div>
136136
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_REVISION 0</span></div>
137137
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION STR(SINRICPRO_VERSION_MAJOR) &quot;.&quot; STR(SINRICPRO_VERSION_MINOR) &quot;.&quot; STR(SINRICPRO_VERSION_REVISION)</span></div>
138138
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
139139
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// Server Configuration</span></div>
140140
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define SINRICPRO_SERVER_URL &quot;ws.sinric.pro&quot;</span></div>
141141
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define SINRICPRO_SERVER_PORT 80</span></div>
142-
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
143-
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">// UDP Configuration</span></div>
144-
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define UDP_MULTICAST_IP IPAddress(224,9,9,9)</span></div>
145-
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define UDP_MULTICAST_PORT 3333</span></div>
146-
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
147-
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// WebSocket Configuration</span></div>
148-
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define WEBSOCKET_PING_INTERVAL 300000</span></div>
149-
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define WEBSOCKET_PING_TIMEOUT 10000</span></div>
150-
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define WEBSOCKET_RETRY_COUNT 2</span></div>
151-
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
152-
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// LeakyBucket Configuration</span></div>
153-
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#define BUCKET_SIZE 10</span></div>
154-
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define DROP_OUT_TIME 60000</span></div>
155-
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#define DROP_IN_TIME 1000u</span></div>
156-
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
157-
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif</span></div>
142+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define SINRICPRO_SERVER_SSL_PORT 443</span></div>
143+
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
144+
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">// UDP Configuration</span></div>
145+
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define UDP_MULTICAST_IP IPAddress(224,9,9,9)</span></div>
146+
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define UDP_MULTICAST_PORT 3333</span></div>
147+
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
148+
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// WebSocket Configuration</span></div>
149+
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define WEBSOCKET_PING_INTERVAL 300000</span></div>
150+
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define WEBSOCKET_PING_TIMEOUT 10000</span></div>
151+
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#define WEBSOCKET_RETRY_COUNT 2</span></div>
152+
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
153+
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// LeakyBucket Configuration</span></div>
154+
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define BUCKET_SIZE 10</span></div>
155+
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#define DROP_OUT_TIME 60000</span></div>
156+
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define DROP_IN_TIME 1000u</span></div>
157+
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
158+
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#endif</span></div>
158159
</div><!-- fragment --></div><!-- contents -->
159160
</div><!-- doc-content -->
160161
<!-- start footer part -->

0 commit comments

Comments
 (0)