Dev 2.2.7

Doxyfile

@@ -829,7 +829,8 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = C:\Users\Boris\.platformio\lib\esp8266-esp32-sdk\src
+INPUT                  = C:\Users\Boris\.platformio\lib\esp8266-esp32-sdk\src \
+                         README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

README.md

@@ -1,13 +1,13 @@
 
 # SinricPro (ESP8266 / ESP32 SDK)
-## Version 2.2.6
+## Version 2.2.7
 ## Installation
 
 ### VS Code & PlatformIO:
 1. Install [VS Code](https://code.visualstudio.com/)  
 2. Install [PlatformIO](https://platformio.org/platformio-ide)  
 3. Install **SinricPro** library by using [Library Manager](https://docs.platformio.org/en/latest/librarymanager/)  
-4. Use included [platformio.ini](https://github.com/sinricpro/esp8266-esp32-sdk/blob/master/pio-examples/switch/platformio.ini) files from [examples](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples) to ensure that all dependent libraries will installed automaticly.
+4. Use included [platformio.ini](examples/platformio/platformio.ini) file from examples to ensure that all dependent libraries will installed automaticly.
 
 ![sinricpro library manager](https://raw.githubusercontent.com/sinricpro/images/master/platformio-install-sinricpro.png)
 
@@ -28,13 +28,7 @@
 ---
 
 ## Examples
-|PlatformIO|Arduino|
-|:--:|:--:|
-| [Switch](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/switch) |[Switch](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/Switch)|
-| [Doorbell](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/doorbell)|[Doorbell](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/doorbell)|
-| - | [Lock](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/GarageDoor)|
-| [TemperatureSensor](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/temperaturesensor) |[TemperatureSensor](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/temperaturesensor)|
-| [TV](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/tv) | [TV](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/tv)
+See [examples](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples) on GitHub
 
 ---
 
@@ -127,5 +121,5 @@ Example 1
 ---
 
 # Full user documentation
-Please see full user documentation here https://sinricpro.github.io/esp8266-esp32-sdk
+Please see here for [full user documentation](https://sinricpro.github.io/esp8266-esp32-sdk)
 

changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## Version 2.2.7
+
+New:
+- Examples
+  - Dimmable Switch
+  - Light
+  - Speaker
+
+Updated:
+- User documentation
+  - added SinricPro.onConnected() / SinricPro.onDisconnected()
+
+Fixed:
+- Examples
+  - Some examples didn't use BAUD_RATE
+
 ## Version 2.2.6
 
 New:

doc-examples/callbacks.cpp

@@ -367,4 +367,12 @@ bool onSelectInput(const String &deviceId, String &input) {
   Serial.printf("Device %s input changed to %s\r\n", deviceId.c_str(), input.c_str());
   return true;
 }
-//! [onSelectInput]
+//! [onSelectInput]
+
+//! [onConnected]
+  SinricPro.onConnected([](){ Serial.printf("Connected to SinricPro\r\n"); }); 
+//! [onConnected]
+
+//! [onDisconnected]
+  SinricPro.onDisconnected([](){ Serial.printf("Disconnected from SinricPro\r\n"); });
+//! [onDisconnected]

docs/_sinric_pro_config_8h_source.html

@@ -133,7 +133,7 @@
 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">// Version Configuration</span></div>
 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_MAJOR     2</span></div>
 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_MINOR     2</span></div>
-<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_REVISION  6</span></div>
+<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#define SINRICPRO_VERSION_REVISION  7</span></div>
 <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>
 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160; </div>
 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">// Server Configuration</span></div>

docs/class_sinric_pro_class-members.html

@@ -118,7 +118,11 @@
 <p>This is the complete list of members for <a class="el" href="class_sinric_pro_class.html">SinricProClass</a>, including all inherited members.</p>
 <table class="directory">
   <tr class="even"><td class="entry"><a class="el" href="class_sinric_pro_class.html#a57722dec8f1f987f57c8fff9eed66765">begin</a>(String socketAuthToken, String signingKey, String serverURL=SINRICPRO_SERVER_URL)</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a> typedef</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a> typedef</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_sinric_pro_class.html#a37c2d0658e498b1bf878f8a3d9a7c5b4">handle</a>()</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_sinric_pro_class.html#ac33a355adfc413d4ff36974d735115bd">onConnected</a>(ConnectedCallbackHandler cb)</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_sinric_pro_class.html#a654bb017ca55b448d55bb36e0346f38a">onDisconnected</a>(DisconnectedCallbackHandler cb)</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_sinric_pro_class.html#a5df2137b8d06e894c917fd28c35c31a4">operator[]</a>(const String deviceId)</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_sinric_pro_class.html#a27a9bb7f1e8bde0f39398649493b6f93">restoreDeviceStates</a>(bool flag)</td><td class="entry"><a class="el" href="class_sinric_pro_class.html">SinricProClass</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->

docs/class_sinric_pro_class.html

@@ -111,6 +111,7 @@
 
 <div class="header">
   <div class="summary">
+<a href="#pub-types">Public Types</a> &#124;
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="class_sinric_pro_class-members.html">List of all members</a>  </div>
   <div class="headertitle">
@@ -123,6 +124,15 @@
 
 <p>Inherits SinricProInterface.</p>
 <table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
+Public Types</h2></td></tr>
+<tr class="memitem:a4d7d8547a83d53c20cbd9aa7768e99f5"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; void(void)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a></td></tr>
+<tr class="memdesc:a4d7d8547a83d53c20cbd9aa7768e99f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback definition for onConnected function.  <a href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">More...</a><br /></td></tr>
+<tr class="separator:a4d7d8547a83d53c20cbd9aa7768e99f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad84930f3c26ac3692cc885be197d39c7"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; void(void)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a></td></tr>
+<tr class="memdesc:ad84930f3c26ac3692cc885be197d39c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback definition for onDisconnected function.  <a href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">More...</a><br /></td></tr>
+<tr class="separator:ad84930f3c26ac3692cc885be197d39c7"><td class="memSeparator" colspan="2">&#160;</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:a57722dec8f1f987f57c8fff9eed66765"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a57722dec8f1f987f57c8fff9eed66765">begin</a> (String socketAuthToken, String signingKey, String serverURL=SINRICPRO_SERVER_URL)</td></tr>
@@ -131,6 +141,12 @@
 <tr class="memitem:a37c2d0658e498b1bf878f8a3d9a7c5b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a37c2d0658e498b1bf878f8a3d9a7c5b4">handle</a> ()</td></tr>
 <tr class="memdesc:a37c2d0658e498b1bf878f8a3d9a7c5b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles communication between device and <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> Server.  <a href="class_sinric_pro_class.html#a37c2d0658e498b1bf878f8a3d9a7c5b4">More...</a><br /></td></tr>
 <tr class="separator:a37c2d0658e498b1bf878f8a3d9a7c5b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac33a355adfc413d4ff36974d735115bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#ac33a355adfc413d4ff36974d735115bd">onConnected</a> (<a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a> cb)</td></tr>
+<tr class="memdesc:ac33a355adfc413d4ff36974d735115bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set callback function for websocket connected event.  <a href="class_sinric_pro_class.html#ac33a355adfc413d4ff36974d735115bd">More...</a><br /></td></tr>
+<tr class="separator:ac33a355adfc413d4ff36974d735115bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a654bb017ca55b448d55bb36e0346f38a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a654bb017ca55b448d55bb36e0346f38a">onDisconnected</a> (<a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a> cb)</td></tr>
+<tr class="memdesc:a654bb017ca55b448d55bb36e0346f38a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set callback function for websocket disconnected event.  <a href="class_sinric_pro_class.html#a654bb017ca55b448d55bb36e0346f38a">More...</a><br /></td></tr>
+<tr class="separator:a654bb017ca55b448d55bb36e0346f38a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a27a9bb7f1e8bde0f39398649493b6f93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sinric_pro_class.html#a27a9bb7f1e8bde0f39398649493b6f93">restoreDeviceStates</a> (bool flag)</td></tr>
 <tr class="memdesc:a27a9bb7f1e8bde0f39398649493b6f93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable / disable restore device states function.  <a href="class_sinric_pro_class.html#a27a9bb7f1e8bde0f39398649493b6f93">More...</a><br /></td></tr>
 <tr class="separator:a27a9bb7f1e8bde0f39398649493b6f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -140,7 +156,54 @@
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>The main class of this library, handling communication between <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> Server and your devices. </p>
-</div><h2 class="groupheader">Member Function Documentation</h2>
+</div><h2 class="groupheader">Member Typedef Documentation</h2>
+<a id="a4d7d8547a83d53c20cbd9aa7768e99f5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4d7d8547a83d53c20cbd9aa7768e99f5">&#9670;&nbsp;</a></span>ConnectedCallbackHandler</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef std::function&lt;void(void)&gt; <a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Callback definition for onConnected function. </p>
+<p>Gets called when device is connected to <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> server </p><dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">void</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
+
+</div>
+</div>
+<a id="ad84930f3c26ac3692cc885be197d39c7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad84930f3c26ac3692cc885be197d39c7">&#9670;&nbsp;</a></span>DisconnectedCallbackHandler</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef std::function&lt;void(void)&gt; <a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Callback definition for onDisconnected function. </p>
+<p>Gets called when device is disconnected from <a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a> server </p><dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">void</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
 <a id="a57722dec8f1f987f57c8fff9eed66765"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a57722dec8f1f987f57c8fff9eed66765">&#9670;&nbsp;</a></span>begin()</h2>
 
@@ -222,6 +285,68 @@ <h1><a class="anchor" id="handle"></a>
 </div><!-- fragment --> 
 </div>
 </div>
+<a id="ac33a355adfc413d4ff36974d735115bd"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac33a355adfc413d4ff36974d735115bd">&#9670;&nbsp;</a></span>onConnected()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void onConnected </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5">ConnectedCallbackHandler</a>&#160;</td>
+          <td class="paramname"><em>cb</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Set callback function for websocket connected event. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">cb</td><td>Function pointer to a <code>ConnectedCallbackHandler</code> function </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5" title="Callback definition for onConnected function.">ConnectedCallbackHandler</a> </dd></dl>
+<h1><a class="anchor" id="onConnected"></a>
+Example-Code</h1>
+<div class="fragment"><div class="line">  <a class="code" href="class_sinric_pro.html">SinricPro</a>.onConnected([](){ Serial.printf(<span class="stringliteral">&quot;Connected to SinricPro\r\n&quot;</span>); }); </div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a654bb017ca55b448d55bb36e0346f38a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a654bb017ca55b448d55bb36e0346f38a">&#9670;&nbsp;</a></span>onDisconnected()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void onDisconnected </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7">DisconnectedCallbackHandler</a>&#160;</td>
+          <td class="paramname"><em>cb</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Set callback function for websocket disconnected event. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">cb</td><td>Function pointer to a <code>DisconnectedCallbackHandler</code> function </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7" title="Callback definition for onDisconnected function.">DisconnectedCallbackHandler</a> </dd></dl>
+<h1><a class="anchor" id="onDisconnected"></a>
+Example-Code</h1>
+<div class="fragment"><div class="line">  <a class="code" href="class_sinric_pro.html">SinricPro</a>.onDisconnected([](){ Serial.printf(<span class="stringliteral">&quot;Disconnected from SinricPro\r\n&quot;</span>); });</div>
+</div><!-- fragment -->
+</div>
+</div>
 <a id="a5df2137b8d06e894c917fd28c35c31a4"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a5df2137b8d06e894c917fd28c35c31a4">&#9670;&nbsp;</a></span>operator[]()</h2>
 

docs/class_sinric_pro_class.js

@@ -5,8 +5,12 @@ var class_sinric_pro_class =
     [ "Define callback routine(s)", "index.html#autotoc_md13", null ],
     [ "In setup()", "index.html#autotoc_md14", null ],
     [ "In loop()", "index.html#autotoc_md15", null ],
+    [ "ConnectedCallbackHandler", "class_sinric_pro_class.html#a4d7d8547a83d53c20cbd9aa7768e99f5", null ],
+    [ "DisconnectedCallbackHandler", "class_sinric_pro_class.html#ad84930f3c26ac3692cc885be197d39c7", null ],
     [ "begin", "class_sinric_pro_class.html#a57722dec8f1f987f57c8fff9eed66765", null ],
     [ "handle", "class_sinric_pro_class.html#a37c2d0658e498b1bf878f8a3d9a7c5b4", null ],
+    [ "onConnected", "class_sinric_pro_class.html#ac33a355adfc413d4ff36974d735115bd", null ],
+    [ "onDisconnected", "class_sinric_pro_class.html#a654bb017ca55b448d55bb36e0346f38a", null ],
     [ "operator[]", "class_sinric_pro_class.html#a5df2137b8d06e894c917fd28c35c31a4", null ],
     [ "restoreDeviceStates", "class_sinric_pro_class.html#a27a9bb7f1e8bde0f39398649493b6f93", null ]
 ];