Skip to content

Commit

Permalink
Updated Rust doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@lupyuen
lupyuen committed Aug 5, 2019
1 parent cfc459d commit 00cf06e
Show file tree
Hide file tree
Showing 6,473 changed files with 62,013 additions and 81,794 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion docs/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Apache Mynewt Sensor Network Application for STM32 Blue Pill with ESP8266 and nRF24L01 (includes Geolocation)

[View Rust Documentation](rust/mylib)
[View Rust Documentation](rust/app)
16 changes: 11 additions & 5 deletions docs/rust/aliases.js
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
var ALIASES = {};
ALIASES["aligned"] = {};
ALIASES["app"] = {};
ALIASES["as_slice"] = {};
ALIASES["bare_metal"] = {};
ALIASES["cortex_m"] = {};
ALIASES["cstr_core"] = {};
ALIASES["cty"] = {};
ALIASES["macros"] = {};
ALIASES["generic_array"] = {};
ALIASES["memchr"] = {};
ALIASES["proc_macro2"] = {};
ALIASES["quote"] = {};
ALIASES["syn"] = {};
ALIASES["unicode_xid"] = {};
ALIASES["mynewt"] = {};
ALIASES["stable_deref_trait"] = {};
ALIASES["typenum"] = {};
ALIASES["vcell"] = {};
ALIASES["volatile_register"] = {};
8 changes: 0 additions & 8 deletions docs/rust/aligned/trait.Alignment.html
View file

This file was deleted.

3 changes: 3 additions & 0 deletions docs/rust/app/all.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="List of all items in this crate"><meta name="keywords" content="rust, rustlang, rust-lang"><title>List of all items in this crate</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../app/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span>
</span>
<span class='in-band'>List of all items</span></h1><h3 id='Functions'>Functions</h3><ul class='functions docblock'><li><a href='app_network/fn.send_sensor_data.html'>app_network::send_sensor_data</a></li><li><a href='app_sensor/fn.convert_sensor_data.html'>app_sensor::convert_sensor_data</a></li><li><a href='app_sensor/fn.handle_sensor_data.html'>app_sensor::handle_sensor_data</a></li><li><a href='app_sensor/fn.start_sensor_listener.html'>app_sensor::start_sensor_listener</a></li><li><a href='fn.main.html'>main</a></li><li><a href='fn.panic.html'>panic</a></li></ul><h3 id='Statics'>Statics</h3><ul class='statics docblock'><li><a href='app_sensor/static.SENSOR_DEVICE.html'>app_sensor::SENSOR_DEVICE</a></li></ul><h3 id='Constants'>Constants</h3><ul class='constants docblock'><li><a href='app_sensor/constant.SENSOR_POLL_TIME.html'>app_sensor::SENSOR_POLL_TIME</a></li><li><a href='app_sensor/constant.TEMP_SENSOR_KEY.html'>app_sensor::TEMP_SENSOR_KEY</a></li><li><a href='app_sensor/constant.TEMP_SENSOR_TYPE.html'>app_sensor::TEMP_SENSOR_TYPE</a></li></ul></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "app";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
11 changes: 11 additions & 0 deletions docs/rust/app/app_network/fn.send_sensor_data.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `send_sensor_data` fn in crate `app`."><meta name="keywords" content="rust, rustlang, rust-lang, send_sensor_data"><title>app::app_network::send_sensor_data - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../app/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../index.html'>app</a>::<wbr><a href='index.html'>app_network</a></p><script>window.sidebarCurrent = {name: 'send_sensor_data', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/app/app_network.rs.html#50-88' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>app</a>::<wbr><a href='index.html'>app_network</a>::<wbr><a class="fn" href=''>send_sensor_data</a></span></h1><pre class='rust fn'>pub fn send_sensor_data(val: &amp;<a class="struct" href="../../mynewt/hw/sensor/struct.SensorValue.html" title="struct mynewt::hw::sensor::SensorValue">SensorValue</a>) -&gt; <a class="type" href="../../mynewt/result/type.MynewtResult.html" title="type mynewt::result::MynewtResult">MynewtResult</a>&lt;()&gt;</pre><div class='docblock'><p>Compose a CoAP JSON message with the Sensor Key (field name) and Value in <code>val</code>
and send to the CoAP server. The message will be enqueued for transmission by the CoAP / OIC
Background Task so this function will return without waiting for the message to be transmitted.
Return <code>Ok()</code> if successful, <code>SYS_EAGAIN</code> if network is not ready yet.
For the CoAP server hosted at thethings.io, the CoAP payload should be encoded in JSON like this:</p>
<pre><code class="language-json">{&quot;values&quot;:[
{&quot;key&quot;:&quot;device&quot;, &quot;value&quot;:&quot;0102030405060708090a0b0c0d0e0f10&quot;},
{&quot;key&quot;:&quot;t&quot;, &quot;value&quot;:1715}
]}
</code></pre>
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "app";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Loading

0 comments on commit 00cf06e

Please sign in to comment.