Skip to content

Commit

Permalink
Update generated docs for ff5008d
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Apr 25, 2024
1 parent 5e62518 commit bb105ba
Show file tree
Hide file tree
Showing 25 changed files with 40 additions and 40 deletions.
2 changes: 1 addition & 1 deletion main/int/calibratecommand_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@
<div class="ttc" id="aclassCalibrationService_html_a301f5b733cacbebbf24459639f04af52"><div class="ttname"><a href="classCalibrationService.html#a301f5b733cacbebbf24459639f04af52">CalibrationService::calibrateTemperature</a></div><div class="ttdeci">bool calibrateTemperature(const float ambientTemperature)</div><div class="ttdoc">Calibrates the Pokit device's temperature to ambientTemperature.</div><div class="ttdef"><b>Definition</b> <a href="calibrationservice_8cpp_source.html#l00070">calibrationservice.cpp:70</a></div></div>
<div class="ttc" id="aclassCalibrationService_html_a9d2d21992939b86c2dbf9ae65b52a59d"><div class="ttname"><a href="classCalibrationService.html#a9d2d21992939b86c2dbf9ae65b52a59d">CalibrationService::temperatureCalibrated</a></div><div class="ttdeci">void temperatureCalibrated()</div><div class="ttdoc">This signal is emitted when the Temperature characteristic has been written succesfully.</div></div>
<div class="ttc" id="aclassDeviceCommand_html"><div class="ttname"><a href="classDeviceCommand.html">DeviceCommand</a></div><div class="ttdoc">The AbstractCommand class extends AbstractCommand to add a PokitDevice instance.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8h_source.html#l00015">devicecommand.h:16</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a2bbf2dc9bb0ba85a2bf29263746c7b57"><div class="ttname"><a href="classDeviceCommand.html#a2bbf2dc9bb0ba85a2bf29263746c7b57">DeviceCommand::device</a></div><div class="ttdeci">PokitDevice * device</div><div class="ttdoc">Pokit Bluetooth device (if any) this command inerracts with.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8h_source.html#l00026">devicecommand.h:26</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a2bbf2dc9bb0ba85a2bf29263746c7b57"><div class="ttname"><a href="classDeviceCommand.html#a2bbf2dc9bb0ba85a2bf29263746c7b57">DeviceCommand::device</a></div><div class="ttdeci">PokitDevice * device</div><div class="ttdoc">Pokit Bluetooth device (if any) this command interracts with.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8h_source.html#l00026">devicecommand.h:26</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a906fd97d832be0e8d2ba1c917fba41db"><div class="ttname"><a href="classDeviceCommand.html#a906fd97d832be0e8d2ba1c917fba41db">DeviceCommand::serviceDetailsDiscovered</a></div><div class="ttdeci">virtual void serviceDetailsDiscovered()</div><div class="ttdoc">Handles service detail discovery events.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8cpp_source.html#l00331">devicecommand.cpp:331</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_ae619166395b5651f1316fd5336d9fa2c"><div class="ttname"><a href="classDeviceCommand.html#ae619166395b5651f1316fd5336d9fa2c">DeviceCommand::disconnect</a></div><div class="ttdeci">void disconnect(int exitCode=EXIT_SUCCESS)</div><div class="ttdoc">Disconnects the underlying Pokit device, and sets exitCode to be return to the OS once the disconnect...</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8cpp_source.html#l00042">devicecommand.cpp:42</a></div></div>
<div class="ttc" id="aclassPokitDevice_html_abb2eafe232090e82ea1a69e38ebab49e"><div class="ttname"><a href="classPokitDevice.html#abb2eafe232090e82ea1a69e38ebab49e">PokitDevice::calibration</a></div><div class="ttdeci">CalibrationService * calibration()</div><div class="ttdoc">Returns a pointer to a CalibrationService instance that uses this device's controller for access.</div><div class="ttdef"><b>Definition</b> <a href="pokitdevice_8cpp_source.html#l00117">pokitdevice.cpp:117</a></div></div>
Expand Down
4 changes: 2 additions & 2 deletions main/int/classCalibrateCommand.html
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@
<tr class="separator:ac8bafb6db670b3c127ab59130584274f inherit pro_static_methods_classAbstractCommand"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classDeviceCommand"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classDeviceCommand')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classDeviceCommand.html">DeviceCommand</a></td></tr>
<tr class="memitem:a2bbf2dc9bb0ba85a2bf29263746c7b57 inherit pro_attribs_classDeviceCommand" id="r_a2bbf2dc9bb0ba85a2bf29263746c7b57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPokitDevice.html">PokitDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDeviceCommand.html#a2bbf2dc9bb0ba85a2bf29263746c7b57">device</a> { nullptr }</td></tr>
<tr class="memdesc:a2bbf2dc9bb0ba85a2bf29263746c7b57 inherit pro_attribs_classDeviceCommand"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pokit Bluetooth device (if any) this command inerracts with. <br /></td></tr>
<tr class="memdesc:a2bbf2dc9bb0ba85a2bf29263746c7b57 inherit pro_attribs_classDeviceCommand"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pokit Bluetooth device (if any) this command interracts with. <br /></td></tr>
<tr class="separator:a2bbf2dc9bb0ba85a2bf29263746c7b57 inherit pro_attribs_classDeviceCommand"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a792b3771a02cb7f4aff6335045b705bf inherit pro_attribs_classDeviceCommand" id="r_a792b3771a02cb7f4aff6335045b705bf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDeviceCommand.html#a792b3771a02cb7f4aff6335045b705bf">exitCodeOnDisconnect</a> { EXIT_FAILURE }</td></tr>
<tr class="memdesc:a792b3771a02cb7f4aff6335045b705bf inherit pro_attribs_classDeviceCommand"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit code to return on device disconnection. <br /></td></tr>
Expand Down Expand Up @@ -627,7 +627,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aca9b6661db8a9d95ce5bc866
<div class="ttc" id="aclassCalibrateCommand_html_a56afc1351c17bb715a06d72839a57a4e"><div class="ttname"><a href="#a56afc1351c17bb715a06d72839a57a4e">CalibrateCommand::service</a></div><div class="ttdeci">CalibrationService * service</div><div class="ttdoc">Bluetooth service this command interracts with.</div><div class="ttdef"><b>Definition</b> <a href="calibratecommand_8h_source.html#l00028">calibratecommand.h:28</a></div></div>
<div class="ttc" id="aclassCalibrateCommand_html_afaf2c6153a3d409c06318dc809df1c78"><div class="ttname"><a href="#afaf2c6153a3d409c06318dc809df1c78">CalibrateCommand::temperatureCalibrated</a></div><div class="ttdeci">void temperatureCalibrated()</div><div class="ttdoc">Handles CalibrationService::temperatureCalibrated events, by outputting the result and exiting.</div><div class="ttdef"><b>Definition</b> <a href="calibratecommand_8cpp_source.html#l00099">calibratecommand.cpp:99</a></div></div>
<div class="ttc" id="aclassCalibrationService_html_a9d2d21992939b86c2dbf9ae65b52a59d"><div class="ttname"><a href="classCalibrationService.html#a9d2d21992939b86c2dbf9ae65b52a59d">CalibrationService::temperatureCalibrated</a></div><div class="ttdeci">void temperatureCalibrated()</div><div class="ttdoc">This signal is emitted when the Temperature characteristic has been written succesfully.</div></div>
<div class="ttc" id="aclassDeviceCommand_html_a2bbf2dc9bb0ba85a2bf29263746c7b57"><div class="ttname"><a href="classDeviceCommand.html#a2bbf2dc9bb0ba85a2bf29263746c7b57">DeviceCommand::device</a></div><div class="ttdeci">PokitDevice * device</div><div class="ttdoc">Pokit Bluetooth device (if any) this command inerracts with.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8h_source.html#l00026">devicecommand.h:26</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a2bbf2dc9bb0ba85a2bf29263746c7b57"><div class="ttname"><a href="classDeviceCommand.html#a2bbf2dc9bb0ba85a2bf29263746c7b57">DeviceCommand::device</a></div><div class="ttdeci">PokitDevice * device</div><div class="ttdoc">Pokit Bluetooth device (if any) this command interracts with.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8h_source.html#l00026">devicecommand.h:26</a></div></div>
<div class="ttc" id="aclassPokitDevice_html_abb2eafe232090e82ea1a69e38ebab49e"><div class="ttname"><a href="classPokitDevice.html#abb2eafe232090e82ea1a69e38ebab49e">PokitDevice::calibration</a></div><div class="ttdeci">CalibrationService * calibration()</div><div class="ttdoc">Returns a pointer to a CalibrationService instance that uses this device's controller for access.</div><div class="ttdef"><b>Definition</b> <a href="pokitdevice_8cpp_source.html#l00117">pokitdevice.cpp:117</a></div></div>
<div class="ttc" id="aqobject_html_connect"><div class="ttname"><a href="https://doc.qt.io/qt-5/qobject.html#connect">QObject::connect</a></div><div class="ttdeci">QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)</div></div>
</div><!-- fragment -->
Expand Down
8 changes: 4 additions & 4 deletions main/int/classDeviceCommand.html
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a2bbf2dc9bb0ba85a2bf29263746c7b57" id="r_a2bbf2dc9bb0ba85a2bf29263746c7b57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPokitDevice.html">PokitDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bbf2dc9bb0ba85a2bf29263746c7b57">device</a> { nullptr }</td></tr>
<tr class="memdesc:a2bbf2dc9bb0ba85a2bf29263746c7b57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pokit Bluetooth device (if any) this command inerracts with. <br /></td></tr>
<tr class="memdesc:a2bbf2dc9bb0ba85a2bf29263746c7b57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pokit Bluetooth device (if any) this command interracts with. <br /></td></tr>
<tr class="separator:a2bbf2dc9bb0ba85a2bf29263746c7b57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a792b3771a02cb7f4aff6335045b705bf" id="r_a792b3771a02cb7f4aff6335045b705bf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a792b3771a02cb7f4aff6335045b705bf">exitCodeOnDisconnect</a> { EXIT_FAILURE }</td></tr>
<tr class="memdesc:a792b3771a02cb7f4aff6335045b705bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit code to return on device disconnection. <br /></td></tr>
Expand Down Expand Up @@ -753,7 +753,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#acde5a41e646a23c5485b67cf
<div class="ttc" id="aclassAbstractPokitService_html_aa0e323c5e2380709c5a5fde18520ae3f"><div class="ttname"><a href="classAbstractPokitService.html#aa0e323c5e2380709c5a5fde18520ae3f">AbstractPokitService::setPokitProduct</a></div><div class="ttdeci">void setPokitProduct(const PokitProduct product)</div><div class="ttdoc">Sets the current Pokit product.</div><div class="ttdef"><b>Definition</b> <a href="abstractpokitservice_8cpp_source.html#l00110">abstractpokitservice.cpp:110</a></div></div>
<div class="ttc" id="aclassAbstractPokitService_html_af67cbea4294ba0a77dcd9540b29528ff"><div class="ttname"><a href="classAbstractPokitService.html#af67cbea4294ba0a77dcd9540b29528ff">AbstractPokitService::serviceDetailsDiscovered</a></div><div class="ttdeci">void serviceDetailsDiscovered()</div><div class="ttdoc">This signal is emitted when the Pokit service details have been discovered.</div></div>
<div class="ttc" id="aclassDeviceCommand_html_a28461c0fe3f2b3398c74298b3df70b93"><div class="ttname"><a href="#a28461c0fe3f2b3398c74298b3df70b93">DeviceCommand::controllerError</a></div><div class="ttdeci">virtual void controllerError(const QLowEnergyController::Error error)</div><div class="ttdoc">Handles controller error events.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8cpp_source.html#l00292">devicecommand.cpp:292</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a2bbf2dc9bb0ba85a2bf29263746c7b57"><div class="ttname"><a href="#a2bbf2dc9bb0ba85a2bf29263746c7b57">DeviceCommand::device</a></div><div class="ttdeci">PokitDevice * device</div><div class="ttdoc">Pokit Bluetooth device (if any) this command inerracts with.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8h_source.html#l00026">devicecommand.h:26</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a2bbf2dc9bb0ba85a2bf29263746c7b57"><div class="ttname"><a href="#a2bbf2dc9bb0ba85a2bf29263746c7b57">DeviceCommand::device</a></div><div class="ttdeci">PokitDevice * device</div><div class="ttdoc">Pokit Bluetooth device (if any) this command interracts with.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8h_source.html#l00026">devicecommand.h:26</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a525ae4429c2b9a325bad62678409fb5b"><div class="ttname"><a href="#a525ae4429c2b9a325bad62678409fb5b">DeviceCommand::deviceDisconnected</a></div><div class="ttdeci">virtual void deviceDisconnected()</div><div class="ttdoc">Handles devics disconnection events.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8cpp_source.html#l00305">devicecommand.cpp:305</a></div></div>
<div class="ttc" id="aclassDeviceCommand_html_a8f890b3a7389d158ad8fd06aa54035b3"><div class="ttname"><a href="#a8f890b3a7389d158ad8fd06aa54035b3">DeviceCommand::getService</a></div><div class="ttdeci">virtual AbstractPokitService * getService()=0</div><div class="ttdoc">Returns a Pokit service object for the derived command class.</div></div>
<div class="ttc" id="aclassDeviceCommand_html_a906fd97d832be0e8d2ba1c917fba41db"><div class="ttname"><a href="#a906fd97d832be0e8d2ba1c917fba41db">DeviceCommand::serviceDetailsDiscovered</a></div><div class="ttdeci">virtual void serviceDetailsDiscovered()</div><div class="ttdoc">Handles service detail discovery events.</div><div class="ttdef"><b>Definition</b> <a href="devicecommand_8cpp_source.html#l00331">devicecommand.cpp:331</a></div></div>
Expand Down Expand Up @@ -1373,10 +1373,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2bbf2dc9bb0ba85a2bf29263
</table>
</div><div class="memdoc">

<p>Pokit Bluetooth device (if any) this command inerracts with. </p>
<p>Pokit Bluetooth device (if any) this command interracts with. </p>

<p class="definition">Definition at line <a class="el" href="devicecommand_8h_source.html#l00026">26</a> of file <a class="el" href="devicecommand_8h_source.html">devicecommand.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 26</span>{ <span class="keyword">nullptr</span> }; <span class="comment">///&lt; Pokit Bluetooth device (if any) this command inerracts with.</span></div>
<div class="fragment"><div class="line"><span class="lineno"> 26</span>{ <span class="keyword">nullptr</span> }; <span class="comment">///&lt; Pokit Bluetooth device (if any) this command interracts with.</span></div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="devicecommand_8cpp_source.html#l00340">deviceDiscovered()</a>, <a class="el" href="devicecommand_8cpp_source.html#l00392">deviceDiscoveryFinished()</a>, <a class="el" href="flashledcommand_8cpp_source.html#l00086">FlashLedCommand::deviceLedFlashed()</a>, <a class="el" href="setnamecommand_8cpp_source.html#l00092">SetNameCommand::deviceNameWritten()</a>, <a class="el" href="devicecommand_8cpp_source.html#l00042">disconnect()</a>, <a class="el" href="calibratecommand_8cpp_source.html#l00069">CalibrateCommand::getService()</a>, <a class="el" href="dsocommand_8cpp_source.html#l00169">DsoCommand::getService()</a>, <a class="el" href="flashledcommand_8cpp_source.html#l00057">FlashLedCommand::getService()</a>, <a class="el" href="infocommand_8cpp_source.html#l00060">InfoCommand::getService()</a>, <a class="el" href="loggerfetchcommand_8cpp_source.html#l00042">LoggerFetchCommand::getService()</a>, <a class="el" href="loggerstartcommand_8cpp_source.html#l00136">LoggerStartCommand::getService()</a>, <a class="el" href="loggerstopcommand_8cpp_source.html#l00032">LoggerStopCommand::getService()</a>, <a class="el" href="metercommand_8cpp_source.html#l00148">MeterCommand::getService()</a>, <a class="el" href="setnamecommand_8cpp_source.html#l00064">SetNameCommand::getService()</a>, <a class="el" href="settorchcommand_8cpp_source.html#l00065">SetTorchCommand::getService()</a>, <a class="el" href="statuscommand_8cpp_source.html#l00059">StatusCommand::getService()</a>, <a class="el" href="statuscommand_8cpp_source.html#l00089">StatusCommand::outputDeviceStatus()</a>, <a class="el" href="metercommand_8cpp_source.html#l00204">MeterCommand::outputReading()</a>, <a class="el" href="loggerfetchcommand_8cpp_source.html#l00089">LoggerFetchCommand::outputSamples()</a>, <a class="el" href="dsocommand_8cpp_source.html#l00243">DsoCommand::outputSamples()</a>, <a class="el" href="infocommand_8cpp_source.html#l00075">InfoCommand::serviceDetailsDiscovered()</a>, <a class="el" href="loggerstartcommand_8cpp_source.html#l00181">LoggerStartCommand::settingsWritten()</a>, <a class="el" href="loggerstopcommand_8cpp_source.html#l00059">LoggerStopCommand::settingsWritten()</a>, <a class="el" href="calibratecommand_8cpp_source.html#l00099">CalibrateCommand::temperatureCalibrated()</a>, and <a class="el" href="settorchcommand_8cpp_source.html#l00093">SetTorchCommand::torchStatusWritten()</a>.</p>

Expand Down
Loading

0 comments on commit bb105ba

Please sign in to comment.