deploy: 51a149e

CAN_8h_source.html

@@ -138,14 +138,14 @@
 <div class="ttc" id="aa07803_html"><div class="ttname"><a href="https://gcc.gnu.org/onlinedocs/gcc-9.3.0/libstdc++/api/a07803.html">std::pair</a></div></div>
 <div class="ttc" id="aclassrobot_1_1types_1_1DataPoint_html"><div class="ttname"><a href="classrobot_1_1types_1_1DataPoint.html">robot::types::DataPoint</a></div><div class="ttdoc">Represents data measured using a sensor at a given time.</div><div class="ttdef"><b>Definition</b> data.h:113</div></div>
 <div class="ttc" id="anamespacecan_html"><div class="ttname"><a href="namespacecan.html">can</a></div><div class="ttdoc">Utilities for interacting with CAN devices.</div><div class="ttdef"><b>Definition</b> CAN.cpp:43</div></div>
-<div class="ttc" id="anamespacecan_html_a09de91bf58066e0b3a582701d6e1741f"><div class="ttname"><a href="namespacecan.html#a09de91bf58066e0b3a582701d6e1741f">can::unscheduleTelemetryPull</a></div><div class="ttdeci">void unscheduleTelemetryPull(deviceid_t id, telemtype_t telemType)</div><div class="ttdoc">Stop pulling the latest telemetry data from the given device.</div><div class="ttdef"><b>Definition</b> CAN.cpp:334</div></div>
-<div class="ttc" id="anamespacecan_html_a308dd5a174588199d03e8cc8f723394b"><div class="ttname"><a href="namespacecan.html#a308dd5a174588199d03e8cc8f723394b">can::getDeviceTelemetry</a></div><div class="ttdeci">robot::types::DataPoint&lt; telemetry_t &gt; getDeviceTelemetry(deviceid_t id, telemtype_t telemType)</div><div class="ttdoc">Get the latest telemetry from a CAN device.</div><div class="ttdef"><b>Definition</b> CAN.cpp:282</div></div>
-<div class="ttc" id="anamespacecan_html_a3e4a4acc87fbf8cfad2a9a9252811314"><div class="ttname"><a href="namespacecan.html#a3e4a4acc87fbf8cfad2a9a9252811314">can::sendCANPacket</a></div><div class="ttdeci">void sendCANPacket(const CANPacket &amp;packet)</div><div class="ttdoc">Send a CAN packet.</div><div class="ttdef"><b>Definition</b> CAN.cpp:265</div></div>
-<div class="ttc" id="anamespacecan_html_a60a17e1ae5b26cd35f4322028435b6cc"><div class="ttname"><a href="namespacecan.html#a60a17e1ae5b26cd35f4322028435b6cc">can::scheduleTelemetryPull</a></div><div class="ttdeci">void scheduleTelemetryPull(deviceid_t id, telemtype_t telemType, std::chrono::milliseconds period)</div><div class="ttdoc">Periodically pull the latest telemetry data from the specified CAN device asychronously.</div><div class="ttdef"><b>Definition</b> CAN.cpp:312</div></div>
-<div class="ttc" id="anamespacecan_html_a7e2b4dcc5578fd7dbc59f7ccc8f2f84c"><div class="ttname"><a href="namespacecan.html#a7e2b4dcc5578fd7dbc59f7ccc8f2f84c">can::pullDeviceTelemetry</a></div><div class="ttdeci">void pullDeviceTelemetry(deviceid_t id, telemtype_t telemType)</div><div class="ttdoc">Ping the given CAN device to send the given telemetry data.</div><div class="ttdef"><b>Definition</b> CAN.cpp:303</div></div>
-<div class="ttc" id="anamespacecan_html_a8360869b24ff9b9e905abec24857968a"><div class="ttname"><a href="namespacecan.html#a8360869b24ff9b9e905abec24857968a">can::unscheduleAllTelemetryPulls</a></div><div class="ttdeci">void unscheduleAllTelemetryPulls()</div><div class="ttdoc">Stop pulling the latest telemetry data from all currently scheduled devices.</div><div class="ttdef"><b>Definition</b> CAN.cpp:348</div></div>
-<div class="ttc" id="anamespacecan_html_a8a46628f8f55f509c3d745ba51814c80"><div class="ttname"><a href="namespacecan.html#a8a46628f8f55f509c3d745ba51814c80">can::removeDeviceTelemetryCallback</a></div><div class="ttdeci">void removeDeviceTelemetryCallback(callbackid_t id)</div><div class="ttdoc">Remove a previously registered telemetry callback.</div><div class="ttdef"><b>Definition</b> CAN.cpp:374</div></div>
-<div class="ttc" id="anamespacecan_html_ae83e4f4aad3eab06ec0d515db4112bd8"><div class="ttname"><a href="namespacecan.html#ae83e4f4aad3eab06ec0d515db4112bd8">can::initCAN</a></div><div class="ttdeci">void initCAN()</div><div class="ttdoc">Initialize the CAN interface.</div><div class="ttdef"><b>Definition</b> CAN.cpp:253</div></div>
+<div class="ttc" id="anamespacecan_html_a09de91bf58066e0b3a582701d6e1741f"><div class="ttname"><a href="namespacecan.html#a09de91bf58066e0b3a582701d6e1741f">can::unscheduleTelemetryPull</a></div><div class="ttdeci">void unscheduleTelemetryPull(deviceid_t id, telemtype_t telemType)</div><div class="ttdoc">Stop pulling the latest telemetry data from the given device.</div><div class="ttdef"><b>Definition</b> CAN.cpp:337</div></div>
+<div class="ttc" id="anamespacecan_html_a308dd5a174588199d03e8cc8f723394b"><div class="ttname"><a href="namespacecan.html#a308dd5a174588199d03e8cc8f723394b">can::getDeviceTelemetry</a></div><div class="ttdeci">robot::types::DataPoint&lt; telemetry_t &gt; getDeviceTelemetry(deviceid_t id, telemtype_t telemType)</div><div class="ttdoc">Get the latest telemetry from a CAN device.</div><div class="ttdef"><b>Definition</b> CAN.cpp:285</div></div>
+<div class="ttc" id="anamespacecan_html_a3e4a4acc87fbf8cfad2a9a9252811314"><div class="ttname"><a href="namespacecan.html#a3e4a4acc87fbf8cfad2a9a9252811314">can::sendCANPacket</a></div><div class="ttdeci">void sendCANPacket(const CANPacket &amp;packet)</div><div class="ttdoc">Send a CAN packet.</div><div class="ttdef"><b>Definition</b> CAN.cpp:266</div></div>
+<div class="ttc" id="anamespacecan_html_a60a17e1ae5b26cd35f4322028435b6cc"><div class="ttname"><a href="namespacecan.html#a60a17e1ae5b26cd35f4322028435b6cc">can::scheduleTelemetryPull</a></div><div class="ttdeci">void scheduleTelemetryPull(deviceid_t id, telemtype_t telemType, std::chrono::milliseconds period)</div><div class="ttdoc">Periodically pull the latest telemetry data from the specified CAN device asychronously.</div><div class="ttdef"><b>Definition</b> CAN.cpp:315</div></div>
+<div class="ttc" id="anamespacecan_html_a7e2b4dcc5578fd7dbc59f7ccc8f2f84c"><div class="ttname"><a href="namespacecan.html#a7e2b4dcc5578fd7dbc59f7ccc8f2f84c">can::pullDeviceTelemetry</a></div><div class="ttdeci">void pullDeviceTelemetry(deviceid_t id, telemtype_t telemType)</div><div class="ttdoc">Ping the given CAN device to send the given telemetry data.</div><div class="ttdef"><b>Definition</b> CAN.cpp:306</div></div>
+<div class="ttc" id="anamespacecan_html_a8360869b24ff9b9e905abec24857968a"><div class="ttname"><a href="namespacecan.html#a8360869b24ff9b9e905abec24857968a">can::unscheduleAllTelemetryPulls</a></div><div class="ttdeci">void unscheduleAllTelemetryPulls()</div><div class="ttdoc">Stop pulling the latest telemetry data from all currently scheduled devices.</div><div class="ttdef"><b>Definition</b> CAN.cpp:351</div></div>
+<div class="ttc" id="anamespacecan_html_a8a46628f8f55f509c3d745ba51814c80"><div class="ttname"><a href="namespacecan.html#a8a46628f8f55f509c3d745ba51814c80">can::removeDeviceTelemetryCallback</a></div><div class="ttdeci">void removeDeviceTelemetryCallback(callbackid_t id)</div><div class="ttdoc">Remove a previously registered telemetry callback.</div><div class="ttdef"><b>Definition</b> CAN.cpp:377</div></div>
+<div class="ttc" id="anamespacecan_html_ae83e4f4aad3eab06ec0d515db4112bd8"><div class="ttname"><a href="namespacecan.html#ae83e4f4aad3eab06ec0d515db4112bd8">can::initCAN</a></div><div class="ttdeci">void initCAN()</div><div class="ttdoc">Initialize the CAN interface.</div><div class="ttdef"><b>Definition</b> CAN.cpp:254</div></div>
 <div class="ttc" id="anamespacecan_html_af98139e403f1d81f1d91b55695b90ad4"><div class="ttname"><a href="namespacecan.html#af98139e403f1d81f1d91b55695b90ad4">can::telemtype_t</a></div><div class="ttdeci">telemtype_t</div><div class="ttdoc">The type of telemetries that devices can report.</div><div class="ttdef"><b>Definition</b> CANUtils.h:36</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->