Skip to content

Commit

Permalink
deploy: df8c162
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickelectric committed Nov 25, 2024
1 parent 002905c commit 85705ca
Show file tree
Hide file tree
Showing 43 changed files with 320 additions and 176 deletions.
77 changes: 40 additions & 37 deletions classbrping_1_1ping1d_1_1Ping1D-members.html

Large diffs are not rendered by default.

117 changes: 117 additions & 0 deletions classbrping_1_1ping1d_1_1Ping1D.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,21 @@
Message description:<br />
Set the speed of sound used for distance calculations. <a href="classbrping_1_1ping1d_1_1Ping1D.html#a1841f392c80205ccdd82e7f7d92b73d0">More...</a><br /></td></tr>
<tr class="separator:a1841f392c80205ccdd82e7f7d92b73d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4d3fdf01d8b542b344142e49600402d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#ae4d3fdf01d8b542b344142e49600402d">control_continuous_start</a> (self, id)</td></tr>
<tr class="memdesc:ae4d3fdf01d8b542b344142e49600402d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a continuous_start message to the device<br />
Message description:<br />
Command to initiate continuous data stream of profile messages. <a href="classbrping_1_1ping1d_1_1Ping1D.html#ae4d3fdf01d8b542b344142e49600402d">More...</a><br /></td></tr>
<tr class="separator:ae4d3fdf01d8b542b344142e49600402d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c5d6c60ff322b234a36a0769f77de4e"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#a1c5d6c60ff322b234a36a0769f77de4e">control_continuous_stop</a> (self, id)</td></tr>
<tr class="memdesc:a1c5d6c60ff322b234a36a0769f77de4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a continuous_stop message to the device<br />
Message description:<br />
Command to stop the continuous data stream of profile messages. <a href="classbrping_1_1ping1d_1_1Ping1D.html#a1c5d6c60ff322b234a36a0769f77de4e">More...</a><br /></td></tr>
<tr class="separator:a1c5d6c60ff322b234a36a0769f77de4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657a9fdefc76e655baa40b553ebf78d5"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#a657a9fdefc76e655baa40b553ebf78d5">control_goto_bootloader</a> (self)</td></tr>
<tr class="memdesc:a657a9fdefc76e655baa40b553ebf78d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a goto_bootloader message to the device<br />
Message description:<br />
Send the device into the bootloader. <a href="classbrping_1_1ping1d_1_1Ping1D.html#a657a9fdefc76e655baa40b553ebf78d5">More...</a><br /></td></tr>
<tr class="separator:a657a9fdefc76e655baa40b553ebf78d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classbrping_1_1device_1_1PingDevice"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classbrping_1_1device_1_1PingDevice')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classbrping_1_1device_1_1PingDevice.html">brping.device.PingDevice</a></td></tr>
<tr class="memitem:a674a7324bb82b537fca8bc0bb5c5117b inherit pub_methods_classbrping_1_1device_1_1PingDevice"><td class="memItemLeft" align="right" valign="top"><a id="a674a7324bb82b537fca8bc0bb5c5117b"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self)</td></tr>
Expand Down Expand Up @@ -280,6 +295,108 @@
<tr class="separator:aad6802dc1ab3ee8c0f409b8c22d0c7fd inherit pub_attribs_classbrping_1_1device_1_1PingDevice"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae4d3fdf01d8b542b344142e49600402d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4d3fdf01d8b542b344142e49600402d">&#9670;&nbsp;</a></span>control_continuous_start()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def brping.ping1d.Ping1D.control_continuous_start </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Send a continuous_start message to the device<br />
Message description:<br />
Command to initiate continuous data stream of profile messages. </p>
<p><br />
</p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>- The message id to stream. 1300: profile </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a1c5d6c60ff322b234a36a0769f77de4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c5d6c60ff322b234a36a0769f77de4e">&#9670;&nbsp;</a></span>control_continuous_stop()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def brping.ping1d.Ping1D.control_continuous_stop </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Send a continuous_stop message to the device<br />
Message description:<br />
Command to stop the continuous data stream of profile messages. </p>
<p><br />
</p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>- The message id to stop streaming. 1300: profile </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a657a9fdefc76e655baa40b553ebf78d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a657a9fdefc76e655baa40b553ebf78d5">&#9670;&nbsp;</a></span>control_goto_bootloader()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def brping.ping1d.Ping1D.control_goto_bootloader </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Send a goto_bootloader message to the device<br />
Message description:<br />
Send the device into the bootloader. </p>
<p>This is useful for firmware updates.<br />
</p>

</div>
</div>
<a id="aff54fad6b6b55472bd09f31da949f9f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff54fad6b6b55472bd09f31da949f9f6">&#9670;&nbsp;</a></span>get_device_id()</h2>

Expand Down
9 changes: 9 additions & 0 deletions functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,15 @@ <h3><a id="index_c"></a>- c -</h3><ul>
<li>connect_udp()
: <a class="el" href="classbrping_1_1device_1_1PingDevice.html#a5bd5bd69a8a6be1f800657ff8a03bdc4">brping.device.PingDevice</a>
</li>
<li>control_continuous_start()
: <a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#ae4d3fdf01d8b542b344142e49600402d">brping.ping1d.Ping1D</a>
</li>
<li>control_continuous_stop()
: <a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#a1c5d6c60ff322b234a36a0769f77de4e">brping.ping1d.Ping1D</a>
</li>
<li>control_goto_bootloader()
: <a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#a657a9fdefc76e655baa40b553ebf78d5">brping.ping1d.Ping1D</a>
</li>
</ul>


Expand Down
9 changes: 9 additions & 0 deletions functions_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,15 @@ <h3><a id="index_c"></a>- c -</h3><ul>
<li>connect_udp()
: <a class="el" href="classbrping_1_1device_1_1PingDevice.html#a5bd5bd69a8a6be1f800657ff8a03bdc4">brping.device.PingDevice</a>
</li>
<li>control_continuous_start()
: <a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#ae4d3fdf01d8b542b344142e49600402d">brping.ping1d.Ping1D</a>
</li>
<li>control_continuous_stop()
: <a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#a1c5d6c60ff322b234a36a0769f77de4e">brping.ping1d.Ping1D</a>
</li>
<li>control_goto_bootloader()
: <a class="el" href="classbrping_1_1ping1d_1_1Ping1D.html#a657a9fdefc76e655baa40b553ebf78d5">brping.ping1d.Ping1D</a>
</li>
</ul>


Expand Down
5 changes: 4 additions & 1 deletion search/all_1.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions search/all_2.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
var searchData=
[
['device_5fid_8',['device_id',['../classbrping_1_1ping360_1_1Ping360.html#a41913fe33f5e5262ced906cfa9b4276c',1,'brping::ping360::Ping360']]],
['dst_5fdevice_5fid_9',['dst_device_id',['../classbrping_1_1pingmessage_1_1PingMessage.html#a7c69dcc2060d2a66065a2183379a9ce6',1,'brping::pingmessage::PingMessage']]]
['device_5fid_11',['device_id',['../classbrping_1_1ping360_1_1Ping360.html#a41913fe33f5e5262ced906cfa9b4276c',1,'brping::ping360::Ping360']]],
['dst_5fdevice_5fid_12',['dst_device_id',['../classbrping_1_1pingmessage_1_1PingMessage.html#a7c69dcc2060d2a66065a2183379a9ce6',1,'brping::pingmessage::PingMessage']]]
];
2 changes: 1 addition & 1 deletion search/all_3.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['endianess_10',['endianess',['../classbrping_1_1pingmessage_1_1PingMessage.html#a3652ba749b09fac3435a4812833bfbbb',1,'brping::pingmessage::PingMessage']]]
['endianess_13',['endianess',['../classbrping_1_1pingmessage_1_1PingMessage.html#a3652ba749b09fac3435a4812833bfbbb',1,'brping::pingmessage::PingMessage']]]
];
42 changes: 21 additions & 21 deletions search/all_4.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions search/all_5.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
var searchData=
[
['handle_5fmessage_32',['handle_message',['../classbrping_1_1device_1_1PingDevice.html#a314fcae05bd01da3cddb96a60bfe6d1e',1,'brping::device::PingDevice']]],
['header_5ffield_5fnames_33',['header_field_names',['../classbrping_1_1pingmessage_1_1PingMessage.html#a1d31b10b7d992958b6a012402047a7da',1,'brping::pingmessage::PingMessage']]],
['header_5fformat_34',['header_format',['../classbrping_1_1pingmessage_1_1PingMessage.html#af13df145be31400278353c6b4a8479af',1,'brping::pingmessage::PingMessage']]],
['headerlength_35',['headerLength',['../classbrping_1_1pingmessage_1_1PingMessage.html#aaf033fd74b67fff4b12d819a7cc846f1',1,'brping::pingmessage::PingMessage']]]
['handle_5fmessage_35',['handle_message',['../classbrping_1_1device_1_1PingDevice.html#a314fcae05bd01da3cddb96a60bfe6d1e',1,'brping::device::PingDevice']]],
['header_5ffield_5fnames_36',['header_field_names',['../classbrping_1_1pingmessage_1_1PingMessage.html#a1d31b10b7d992958b6a012402047a7da',1,'brping::pingmessage::PingMessage']]],
['header_5fformat_37',['header_format',['../classbrping_1_1pingmessage_1_1PingMessage.html#af13df145be31400278353c6b4a8479af',1,'brping::pingmessage::PingMessage']]],
['headerlength_38',['headerLength',['../classbrping_1_1pingmessage_1_1PingMessage.html#aaf033fd74b67fff4b12d819a7cc846f1',1,'brping::pingmessage::PingMessage']]]
];
4 changes: 2 additions & 2 deletions search/all_6.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
var searchData=
[
['initialize_36',['initialize',['../classbrping_1_1device_1_1PingDevice.html#a70eaf1a8dc33d77c3f503d8a321e59e0',1,'brping.device.PingDevice.initialize()'],['../classbrping_1_1ping1d_1_1Ping1D.html#ac0bd084b030a45e16a3dbaf7187bb4db',1,'brping.ping1d.Ping1D.initialize()'],['../classbrping_1_1ping360_1_1Ping360.html#ad956e795361b373e967225e929858fe5',1,'brping.ping360.Ping360.initialize()']]],
['iodev_37',['iodev',['../classbrping_1_1device_1_1PingDevice.html#a53b215d7ce6b2b5e9122dcfde608f97b',1,'brping::device::PingDevice']]]
['initialize_39',['initialize',['../classbrping_1_1device_1_1PingDevice.html#a70eaf1a8dc33d77c3f503d8a321e59e0',1,'brping.device.PingDevice.initialize()'],['../classbrping_1_1ping1d_1_1Ping1D.html#ac0bd084b030a45e16a3dbaf7187bb4db',1,'brping.ping1d.Ping1D.initialize()'],['../classbrping_1_1ping360_1_1Ping360.html#ad956e795361b373e967225e929858fe5',1,'brping.ping360.Ping360.initialize()']]],
['iodev_40',['iodev',['../classbrping_1_1device_1_1PingDevice.html#a53b215d7ce6b2b5e9122dcfde608f97b',1,'brping::device::PingDevice']]]
];
Loading

0 comments on commit 85705ca

Please sign in to comment.