Skip to content

Commit

Permalink
Update Zephyer SDK documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Astarte Bot committed Nov 13, 2024
1 parent 3703eb9 commit 26ff242
Show file tree
Hide file tree
Showing 69 changed files with 494 additions and 439 deletions.
2 changes: 1 addition & 1 deletion device-sdks/zephyr/snapshot/api/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Thu Nov 7 2024 16:08:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Wed Nov 13 2024 08:20:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion device-sdks/zephyr/snapshot/api/astarte_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8923e4732262e68be4c5ac5c
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2e5d9197a3dfa3393eec53f63f41e30c.html">astarte_device_sdk</a></li><li class="navelem"><a class="el" href="astarte_8h.html">astarte.h</a></li>
<li class="footer">Generated on Thu Nov 7 2024 16:08:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Wed Nov 13 2024 08:20:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion device-sdks/zephyr/snapshot/api/astarte_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2e5d9197a3dfa3393eec53f63f41e30c.html">astarte_device_sdk</a></li><li class="navelem"><a class="el" href="astarte_8h.html">astarte.h</a></li>
<li class="footer">Generated on Thu Nov 7 2024 16:08:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Wed Nov 13 2024 08:20:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion device-sdks/zephyr/snapshot/api/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Thu Nov 7 2024 16:08:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Wed Nov 13 2024 08:20:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
14 changes: 9 additions & 5 deletions device-sdks/zephyr/snapshot/api/device_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@

<p>Device management.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="astarte_8h_source.html">astarte_device_sdk/astarte.h</a>&quot;</code><br />
<div class="textblock"><code>#include &lt;zephyr/kernel.h&gt;</code><br />
<code>#include &quot;<a class="el" href="astarte_8h_source.html">astarte_device_sdk/astarte.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="device__id_8h_source.html">astarte_device_sdk/device_id.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="individual_8h_source.html">astarte_device_sdk/individual.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="interface_8h_source.html">astarte_device_sdk/interface.h</a>&quot;</code><br />
Expand Down Expand Up @@ -203,9 +204,12 @@
<tr class="memitem:ga6639c512b2ef5365bbdda9d31dfc277e" id="r_ga6639c512b2ef5365bbdda9d31dfc277e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__results.html#gaa9ea00ca0ab1c24dd2936c25bf05689a">astarte_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__device.html#ga6639c512b2ef5365bbdda9d31dfc277e">astarte_device_connect</a> (<a class="el" href="group__device.html#ga8e6066c46bfa43d8aa10dac5bc5d16ea">astarte_device_handle_t</a> device)</td></tr>
<tr class="memdesc:ga6639c512b2ef5365bbdda9d31dfc277e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect a device to Astarte. <br /></td></tr>
<tr class="separator:ga6639c512b2ef5365bbdda9d31dfc277e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3d40df49c6119ab071b87cd40a645aad" id="r_ga3d40df49c6119ab071b87cd40a645aad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__results.html#gaa9ea00ca0ab1c24dd2936c25bf05689a">astarte_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__device.html#ga3d40df49c6119ab071b87cd40a645aad">astarte_device_disconnect</a> (<a class="el" href="group__device.html#ga8e6066c46bfa43d8aa10dac5bc5d16ea">astarte_device_handle_t</a> device)</td></tr>
<tr class="memdesc:ga3d40df49c6119ab071b87cd40a645aad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnect the Astarte device instance. <br /></td></tr>
<tr class="separator:ga3d40df49c6119ab071b87cd40a645aad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac0fdf93a511677f8d7f9e970886dff5c" id="r_gac0fdf93a511677f8d7f9e970886dff5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__results.html#gaa9ea00ca0ab1c24dd2936c25bf05689a">astarte_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__device.html#gac0fdf93a511677f8d7f9e970886dff5c">astarte_device_disconnect</a> (<a class="el" href="group__device.html#ga8e6066c46bfa43d8aa10dac5bc5d16ea">astarte_device_handle_t</a> device, k_timeout_t timeout)</td></tr>
<tr class="memdesc:gac0fdf93a511677f8d7f9e970886dff5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnect the Astarte device instance. <br /></td></tr>
<tr class="separator:gac0fdf93a511677f8d7f9e970886dff5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9dcc2121b96a3d2cc570afbf897cb0b3" id="r_ga9dcc2121b96a3d2cc570afbf897cb0b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__results.html#gaa9ea00ca0ab1c24dd2936c25bf05689a">astarte_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__device.html#ga9dcc2121b96a3d2cc570afbf897cb0b3">astarte_device_force_disconnect</a> (<a class="el" href="group__device.html#ga8e6066c46bfa43d8aa10dac5bc5d16ea">astarte_device_handle_t</a> device)</td></tr>
<tr class="memdesc:ga9dcc2121b96a3d2cc570afbf897cb0b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force a disconnection for the Astarte device instance. <br /></td></tr>
<tr class="separator:ga9dcc2121b96a3d2cc570afbf897cb0b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4800793bbb8e4b76b01c21f96eb848e0" id="r_ga4800793bbb8e4b76b01c21f96eb848e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__results.html#gaa9ea00ca0ab1c24dd2936c25bf05689a">astarte_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__device.html#ga4800793bbb8e4b76b01c21f96eb848e0">astarte_device_poll</a> (<a class="el" href="group__device.html#ga8e6066c46bfa43d8aa10dac5bc5d16ea">astarte_device_handle_t</a> device)</td></tr>
<tr class="memdesc:ga4800793bbb8e4b76b01c21f96eb848e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll data from Astarte. <br /></td></tr>
<tr class="separator:ga4800793bbb8e4b76b01c21f96eb848e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand All @@ -230,7 +234,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2e5d9197a3dfa3393eec53f63f41e30c.html">astarte_device_sdk</a></li><li class="navelem"><a class="el" href="device_8h.html">device.h</a></li>
<li class="footer">Generated on Thu Nov 7 2024 16:08:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Wed Nov 13 2024 08:20:21 for Astarte device API for Zephyr by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
3 changes: 2 additions & 1 deletion device-sdks/zephyr/snapshot/api/device_8h.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ var device_8h =
[ "astarte_device_add_interface", "group__device.html#ga93082fc0d2cd5068ca24c596de837b1f", null ],
[ "astarte_device_connect", "group__device.html#ga6639c512b2ef5365bbdda9d31dfc277e", null ],
[ "astarte_device_destroy", "group__device.html#ga31b74b5be3f495e22dfe4ff4a5a0bd21", null ],
[ "astarte_device_disconnect", "group__device.html#ga3d40df49c6119ab071b87cd40a645aad", null ],
[ "astarte_device_disconnect", "group__device.html#gac0fdf93a511677f8d7f9e970886dff5c", null ],
[ "astarte_device_force_disconnect", "group__device.html#ga9dcc2121b96a3d2cc570afbf897cb0b3", null ],
[ "astarte_device_new", "group__device.html#ga487521ab61f4fbc8d961db13d182594f", null ],
[ "astarte_device_poll", "group__device.html#ga4800793bbb8e4b76b01c21f96eb848e0", null ],
[ "astarte_device_set_property", "group__device.html#gaa7f237d00e4771ebce7ea73995aeaa20", null ],
Expand Down
Loading

0 comments on commit 26ff242

Please sign in to comment.