#2.7.4 implemented volumeDefault

to SmartSpeaker and TV

Author: sivar2311

changelog.md

@@ -1,9 +1,14 @@
 # Changelog
+## Version 2.7.4
+- New
+  - Speaker & TV `onAdjustVolume` callback changed:
+    The new format is `bool onAdjustVolume(const String &deviceId, int &volumeDelta, bool volumeDefault);`
+    `volumeDefault`: `false` if the user specified the amount by which to change the volume; otherwise `true`
+
 ## Version 2.7.3
 Fixed
 - `.c_str()` for AppKey, AppSecret and DeviceId return now a valid `const char*`
 
-
 ## Version 2.7.2
 Fixed:
 - The examples are now located in subfolders if more than one example is provided

docs/_sinric_pro_8h_source.html

@@ -120,15 +120,15 @@
 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160; </div>
 <div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_sinric_pro_air_quality_sensor.html">   17</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_sinric_pro_air_quality_sensor.html">SinricProAirQualitySensor</a> :  <span class="keyword">public</span> <a class="code" href="class_sinric_pro_device.html">SinricProDevice</a> {</div>
 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;  <span class="keyword">public</span>:</div>
-<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;      <a class="code" href="class_sinric_pro_air_quality_sensor.html">SinricProAirQualitySensor</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>
+<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;      <a class="code" href="class_sinric_pro_air_quality_sensor.html">SinricProAirQualitySensor</a>(<span class="keyword">const</span> DeviceId &amp;deviceId);</div>
 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    String getProductType() { <span class="keywordflow">return</span> SinricProDevice::getProductType() + String(<span class="stringliteral">&quot;AIR_QUALITY_SENSOR&quot;</span>); }</div>
 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160; </div>
 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="comment">// event</span></div>
 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="class_sinric_pro_air_quality_sensor.html#a3836e4dca79c1563fcdae880bb368323">sendAirQualityEvent</a>(<span class="keywordtype">int</span> pm1=0, <span class="keywordtype">int</span> pm2_5=0, <span class="keywordtype">int</span> pm10=0, String cause = <span class="stringliteral">&quot;PERIODIC_POLL&quot;</span>);</div>
 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;  <span class="keyword">private</span>:</div>
 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;};</div>
 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
-<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;SinricProAirQualitySensor::SinricProAirQualitySensor(<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>
+<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;SinricProAirQualitySensor::SinricProAirQualitySensor(<span class="keyword">const</span> DeviceId &amp;deviceId) : <a class="code" href="class_sinric_pro_device.html">SinricProDevice</a>(deviceId) {}</div>
 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160; </div>
 <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="class_sinric_pro_air_quality_sensor.html#a3836e4dca79c1563fcdae880bb368323">   40</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="class_sinric_pro_air_quality_sensor.html#a3836e4dca79c1563fcdae880bb368323">SinricProAirQualitySensor::sendAirQualityEvent</a>(<span class="keywordtype">int</span> pm1, <span class="keywordtype">int</span> pm2_5, <span class="keywordtype">int</span> pm10, String cause) {</div>
 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  DynamicJsonDocument eventMessage = prepareEvent(deviceId, <span class="stringliteral">&quot;airQuality&quot;</span>, cause.c_str());</div>
@@ -147,7 +147,7 @@
 </div><!-- doc-content -->
 <div class="ttc" id="aclass_sinric_pro_air_quality_sensor_html_a3836e4dca79c1563fcdae880bb368323"><div class="ttname"><a href="class_sinric_pro_air_quality_sensor.html#a3836e4dca79c1563fcdae880bb368323">SinricProAirQualitySensor::sendAirQualityEvent</a></div><div class="ttdeci">bool sendAirQualityEvent(int pm1=0, int pm2_5=0, int pm10=0, String cause=&quot;PERIODIC_POLL&quot;)</div><div class="ttdoc">Sending air quality to SinricPro server.</div><div class="ttdef"><b>Definition:</b> SinricProAirQualitySensor.h:40</div></div>
 <div class="ttc" id="aclass_sinric_pro_air_quality_sensor_html"><div class="ttname"><a href="class_sinric_pro_air_quality_sensor.html">SinricProAirQualitySensor</a></div><div class="ttdoc">Device to report air quality events.</div><div class="ttdef"><b>Definition:</b> SinricProAirQualitySensor.h:17</div></div>
-<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>
+<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:24</div></div>
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>

docs/_sinric_pro_air_quality_sensor_8h_source.html

@@ -120,7 +120,7 @@
 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160; </div>
 <div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_sinric_pro_blinds.html">   22</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_sinric_pro_blinds.html">SinricProBlinds</a> :  <span class="keyword">public</span> <a class="code" href="class_sinric_pro_device.html">SinricProDevice</a> {</div>
 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;  <span class="keyword">public</span>:</div>
-<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      <a class="code" href="class_sinric_pro_blinds.html">SinricProBlinds</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>
+<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      <a class="code" href="class_sinric_pro_blinds.html">SinricProBlinds</a>(<span class="keyword">const</span> DeviceId &amp;deviceId);</div>
 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    String getProductType() { <span class="keywordflow">return</span> SinricProDevice::getProductType() + String(<span class="stringliteral">&quot;BLIND&quot;</span>); }</div>
 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
 <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="class_sinric_pro_blinds.html#a191ba7fd2f28b1892bc8ba7374089285">   40</a></span>&#160;    <span class="keyword">typedef</span> std::function&lt;bool(<span class="keyword">const</span> String&amp;, <span class="keywordtype">int</span>&amp;)&gt; <a class="code" href="class_sinric_pro_blinds.html#a191ba7fd2f28b1892bc8ba7374089285">SetPositionCallback</a>;</div>
@@ -132,34 +132,34 @@
 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160; </div>
 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="class_sinric_pro_blinds.html#afd759f3d5859aee024c587a596378f46">sendPositionEvent</a>(<span class="keywordtype">int</span> position, String cause = <span class="stringliteral">&quot;PHYSICAL_INTERACTION&quot;</span>);</div>
 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="comment">// handle</span></div>
-<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keywordtype">bool</span> handleRequest(<span class="keyword">const</span> <span class="keywordtype">char</span>* deviceId, <span class="keyword">const</span> <span class="keywordtype">char</span>* action, JsonObject &amp;request_value, JsonObject &amp;response_value) <span class="keyword">override</span>;</div>
+<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keywordtype">bool</span> handleRequest(<span class="keyword">const</span> DeviceId &amp;deviceId, <span class="keyword">const</span> <span class="keywordtype">char</span>* action, JsonObject &amp;request_value, JsonObject &amp;response_value) <span class="keyword">override</span>;</div>
 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="keyword">private</span>:</div>
 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <a class="code" href="class_sinric_pro_blinds.html#a191ba7fd2f28b1892bc8ba7374089285">SetPositionCallback</a> setPositionCallback; </div>
 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <a class="code" href="class_sinric_pro_blinds.html#a4f6fdf591b948dc44154c33df5b8fb97">AdjustPositionCallback</a> adjustPositionCallback;</div>
 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;};</div>
 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
-<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;SinricProBlinds::SinricProBlinds(<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>
+<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;SinricProBlinds::SinricProBlinds(<span class="keyword">const</span> DeviceId &amp;deviceId) : <a class="code" href="class_sinric_pro_device.html">SinricProDevice</a>(deviceId),</div>
 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  setPositionCallback(nullptr),</div>
 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  adjustPositionCallback(nullptr) {</div>
 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;}</div>
 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160; </div>
-<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keywordtype">bool</span> SinricProBlinds::handleRequest(<span class="keyword">const</span> <span class="keywordtype">char</span>* deviceId, <span class="keyword">const</span> <span class="keywordtype">char</span>* action, JsonObject &amp;request_value, JsonObject &amp;response_value) {</div>
-<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="keywordflow">if</span> (strcmp(deviceId, this-&gt;deviceId) != 0) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
+<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keywordtype">bool</span> SinricProBlinds::handleRequest(<span class="keyword">const</span> DeviceId &amp;deviceId, <span class="keyword">const</span> <span class="keywordtype">char</span>* action, JsonObject &amp;request_value, JsonObject &amp;response_value) {</div>
+<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="keywordflow">if</span> (deviceId != this-&gt;deviceId) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <span class="keywordflow">if</span> (SinricProDevice::handleRequest(deviceId, action, request_value, response_value)) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
 <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160; </div>
 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  <span class="keywordtype">bool</span> success = <span class="keyword">false</span>;</div>
 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  String actionString = String(action);</div>
 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160; </div>
 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  <span class="keywordflow">if</span> (actionString == <span class="stringliteral">&quot;setRangeValue&quot;</span> &amp;&amp; setPositionCallback) {</div>
 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keywordtype">int</span> position = request_value[<span class="stringliteral">&quot;rangeValue&quot;</span>] | 0;</div>
-<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    success = setPositionCallback(String(deviceId), position);</div>
+<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    success = setPositionCallback(deviceId, position);</div>
 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    response_value[<span class="stringliteral">&quot;rangeValue&quot;</span>] = limitValue(position, 0, 100);</div>
 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    <span class="keywordflow">return</span> success;</div>
 <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  }</div>
 <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160; </div>
 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;  <span class="keywordflow">if</span> (actionString == <span class="stringliteral">&quot;adjustRangeValue&quot;</span> &amp;&amp; adjustPositionCallback) {</div>
 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    <span class="keywordtype">int</span> positionDelta = request_value[<span class="stringliteral">&quot;rangeValueDelta&quot;</span>] | 0;</div>
-<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    success = adjustPositionCallback(String(deviceId), positionDelta);</div>
+<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    success = adjustPositionCallback(deviceId, positionDelta);</div>
 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    response_value[<span class="stringliteral">&quot;rangeValue&quot;</span>] = limitValue(positionDelta, 0, 100);</div>
 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="keywordflow">return</span> success;</div>
 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  }</div>
@@ -192,7 +192,7 @@
 <div class="ttc" id="aclass_sinric_pro_blinds_html_afd759f3d5859aee024c587a596378f46"><div class="ttname"><a href="class_sinric_pro_blinds.html#afd759f3d5859aee024c587a596378f46">SinricProBlinds::sendPositionEvent</a></div><div class="ttdeci">bool sendPositionEvent(int position, String cause=&quot;PHYSICAL_INTERACTION&quot;)</div><div class="ttdoc">Send setPosition event to update actual position on SinricPro Server.</div><div class="ttdef"><b>Definition:</b> SinricProBlinds.h:128</div></div>
 <div class="ttc" id="aclass_sinric_pro_blinds_html_a5e67c0c58e46d4e0ad1b811df1119cde"><div class="ttname"><a href="class_sinric_pro_blinds.html#a5e67c0c58e46d4e0ad1b811df1119cde">SinricProBlinds::onSetPosition</a></div><div class="ttdeci">void onSetPosition(SetPositionCallback cb)</div><div class="ttdoc">Set callback function for setPosition request.</div><div class="ttdef"><b>Definition:</b> SinricProBlinds.h:105</div></div>
 <div class="ttc" id="aclass_sinric_pro_blinds_html_a02b6fde78fad6ca77d5b14286199bad9"><div class="ttname"><a href="class_sinric_pro_blinds.html#a02b6fde78fad6ca77d5b14286199bad9">SinricProBlinds::onAdjustPosition</a></div><div class="ttdeci">void onAdjustPosition(AdjustPositionCallback cb)</div><div class="ttdoc">Set callback function for adjustPosition request.</div><div class="ttdef"><b>Definition:</b> SinricProBlinds.h:116</div></div>
-<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>
+<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:24</div></div>
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>